Native (Delphi) callbacks in .NET (C#) COM assembly

I’ve posted the English version of this article in codeproject.com

نشرت النسخة الانكليزية لهذا المقال في موقع codeproject.com

مقدمة

لنفترض لدينا الحالة التالية:

-    تريد كتابة إجراء في بيئة الدوت نت و تريد أن تجعله متاحاً للغات البرمجة الأصلية (native) مثل دلفي.
-    هذا الاجراء يأخذ تابع منادى (callback) كأحد بارامتراته/التابع في هذه الحالة سيكون مكتوباً بلغة أصلية كدلفي/.
-    تريد استدعاء تابع الدوت نت هذا من برنامج دلفي.

قبل البدء

بداية ما هو التابع المنادى (callback function) وبالمناسبة هذه هي ترجمتي لأني لم أجد ترجمة عربية أخرى معتمدة لهذا المصطلح الانكليزي. حسب الويكيبديا التابع المنادى هو عبارة عن مرجعية لقطعة من النص المصدري يمرر كمتحول إلى نص مصدري آخر. وهذه التقنية شائعة جداً في لغات البرمجة الأصلية مثل سي بلس بلس و دلفي. أما في دوت نت فالتقنية الأقرب لهذا المفهوم هي تقنية التفويض  delegate. إن التعامل مع هذا النوع من التوابع قد يكون سهلاً عندما نبقى ضمن نطاق اللغات الأصلية مثل سي و دلفي وعندما يبقى استخدامها وتبادلها ضمن النطاق نفسه، لكن كيف يمكن تمرير مرجعية لنص مصدري موجود في الذاكرة الحقيقية إلى نص مصدري آخر موجود في الذاكرة المدارة و هي هنا بيئة الدوت نت؟ هذا ما سأحاول تبيانه في هذا المقال.

أمرٌ آخر سيواجهنا في السيناريو السابق و هو كيف نجعل تابع دوت نت متاحاً لاستخدامه في لغات البرمجة الأصلية، من المعروف أن هذا الأمر يمكن تحقيقه عن طريق جعل مكتبة الدوت نت .net assembly متاحة لعناصر الكوم COM-visible وهنا لابد من الآخذ بعين الاعتبار الخطوات التالية:

•    تسجيل مكتبة الدوت نت كعنصر كوم COM.
•    إضافة المكتبة إلى ذاكرة المكتبات العامة GAC  (Global Assembly Cache) في حال أردنا استدعاء المكتبة من مسارات مختلفة.
•    يجب إعطاء المكتبة اسماً فريداً (قوياً) في حال أردنا إضافتها إلى ال GAC.

قسم الدوت نت

سأستخدم فيجوال ستديو 2010 و سي شارب لبناء هذا القسم.
في فيجوال ستوديو قم بإنشاء مشروع مكتبة صنف جديد و سمّها  CSDemoLibrary.
من ضمن خصائص المشروع وفي مربع معلومات المكتبة assembly information قم بتفعيل خيار COM-Visible.

2

نحن بحاجة إلى إعطاء المكتبة اسماً فريداً إذا كنا سنضيفها إلى الـ GAC لاستخدامها من مسارات مختلفة –يمكنك تجاهل هذه الخطوة إذا كنت ستحفظ هذه المكتبة في نفس المسار لتطبيق دلفي- ولإعطاء المكتبة هذا الاسم الفريد:
في خصائص المشروع ومن لسان التبويب signing اختر(Sign The Assembly)   ثم من القائمة المنسدلة اختر جديد و ليكن اسم الملف CSDemoLibrary.

3

ولأننا نريد تمرير مؤشر من برنامج دلفي إلى هذه المكتبة فهناك خطوة إضافية لابد منها وهي (السماح بالشيفرة غير الآمنة) unsafe code وذلك بتفعيل الخيار (Allow unsafe Code) في لسان التبويب Build مزيد من المعلومات عن المؤشرات في الدوت نت في مقالي السابق

1

الآن أصبحنا جاهزين لكتابة الكود، احذف الصنف الافتراضي في المشروع و أضف صنف جديد و سمّه MyClass.
من أجل التبسيط سوف نعتمد في هذا المثال تابع منادى بسيط يأخذ بارامترين فقط.. في دلفي سيكون شكل هذا التابع كما يلي:

procedure callback(intParam: Integer; strParam: pChar); stdcall;

المكافئ لهذا التابع في الدوت نت سيكون تفويض delegate يأخذ الشكل التالي:

public delegate void NativeCallback(Int32 intParam, [MarshalAs(UnmanagedType.LPWStr)] string strParam);

لقد استخدمت وسم [MarshalAs(UnmanagedType.LPWStr)] للبارمتر النصي لتحويله إلى يونيكود عند تبادله مع اللغات الأصلية native ويمكنك إغفال هذا الوسم في حال أردت التعامل مع الـ Ansistring لكن عندها يجب تغيير نوع البارمتر النصي في تابع الدلفي ليصبح PAnsichar.
الآن نستطيع كتابة تابع الدوت نت، مع مراعاة أننا يجب أن نجعل الصنف MyClass متاحاً لـ COM وذلك بوسمه بالوسم  ComVisible(true)  مع نص guid جديد وبما أنه سيكون فريداً سيشكل ما يشبه البصمة الخاصة بعنصر الكوم هذا. الأمر الآخر المهم هنا ولكون هذا التابع سيتعامل مع المؤشرات فيجب وسمه بالوسم unsafe (راجع مقالي السابق) وفي مايلي النص الكامل للصنف MyClass:

using System;
using System.Runtime.InteropServices;
using System.Threading;

namespace CSDemoLibrary
{
    public delegate void NativeCallback(Int32 intParam, [MarshalAs(UnmanagedType.LPWStr)] string strParam);
   
    [ComVisible(true),
    GuidAttribute("3A65D04A-3F2F-4CB3-B65A-8D402B8C64CE")]
    public class MyClass
    {
       
        public unsafe int Process(
            int intValue,
            Int32 callbackPointer,
            int intParam,
            string strParam)
        {
            IntPtr ptr = new IntPtr(callbackPointer);
            NativeCallback callbackMethod = (NativeCallback)Marshal.GetDelegateForFunctionPointer(ptr, typeof(NativeCallback));
           
            callbackMethod(intParam, strParam);
            Thread.Sleep(1000);
           
            callbackMethod(25, "المرحلة الأولى");
            Thread.Sleep(1000);
            callbackMethod(50, "المرحلة الثانية");
            Thread.Sleep(1000);
            callbackMethod(75, "المرحلة الثالثة");
            Thread.Sleep(1000);
            callbackMethod(100, "المرحلة الرابعة");

            return intValue * 10;
        }
    }
}

في النص السابق: التابع Process يحاكي عملية تستغرق فترة طويلة من الزمن (مثل جلب كمية كبيرة من البيانات من الانترنت)  مع إعلام التطبيق الطالب بشكل مستمر بحالة العملية أو بمقدار التقدم. في مثالنا هذا ومن أجل التبسيط فقط سنقوم بتوقيف التنفيذ لمدة ثانية واحدة في كل مرة وذلك لمحاكاة عملية تستغرق وقتاً طويلاً و تعيد في نهايتها رقم كنتيجة للعملية. في الكود السابق لدينا callbackPointer هو مؤشر للتابع المنادى، ولدينا (intParam, strParam) هي بارامترات ذلك التابع، هذين البارامترين يمكن استخدامهما كقيم ابتدائية وفي معظم السيناريوهات لن يكون هناك حاجة لقيم ابتدائية ولكني ابقيت عليهم هنا لشرح كيفية تمرير بارامترات التوابع من البيئة الأصلية إلى تابع الدوت نت.
GetDelegateForFunctionPointer هو المفتاح في هذه المسألة كلها حيث يقوم هذا التابع بتحويل مؤشر لتابع أصلي إلى التفويض delegate المكافئ له وهناك مزيد من العلومات عن هذا التابع يمكن أن تجدها هنا

تسجيل مكتبة الدوت نت

لتجنب اشكالية المسارات في الدوس سأستخدم هنا (Visual Studio Command Prompt) وهناك اختصار لهذه الاداة تجده في المسار التالي:

(start menu-> All programs-> Microsoft Visual Studio 2010-> Visual Studio Tools)

باستخدام هذه الاداة يمكنك تسجيل مكتبة الدوت نت كعنصر كوم باتباع الخطوات التالية:

شغل Visual Studio Command Prompt /as administrator/ وانتقل إلى المجلد الذي يحتوي المكتبة CSDemoLibrary.dll باستخدام تعليمات الدوس.
إذا كنت ستستخدم CSDemoLibrary.dll من نفس مسار برنامج دلفي فقط فلا داعي لاضافة المكتبة الى GAC فيما عدا ذلك يجب إضافة المكتبة الى الـ GAC ولتحقيق هذا سنستخدم الاداة gacutil مع البارامتر –i كمايلي:

gacutil -i CSDemoLibrary.dll

لتسجيل المكتبة كعنصر COM سنستخدم أداة regasm كما يلي:

regasm CSDemoLibrary.dll

ملاحظة:
لإزالة المكتبة من الـ GAC نستخدم الأمر التالي:

gacutil -u CSDemoLibrary

لإلغاء تسجيل المكتبة نستخدم الامر:

regasm -u CSDemoLibrary.dll

قسم الدلفي:

سأستخدم في هذا القسم دلفي 2010.
في دلفي 2010 انشئ مشروع تطبيق VCL جديد   
أضف (TLabel, TButton, TGauge) إلى النموذج الرئيسي

4

في الكود خلف النموذج الرئيسي أضف ComObj إلى قسم uses 
الآن لنقوم بانشاء تابع بسيط في دلفي سيكون هو التابع المنادى الذي سنرسله (بالأحرى نرسل مرجعيته) إلى مكتبة الدوت نت لتقوم بدورها باستدعاءه لإظهار وتحديث حالة العملية للمستخدم.

procedure callback(intParam: Integer; strParam: pChar); stdcall;
Begin
  Form2.Gauge1.Progress := intParam;
  Form2.lbMessage.Caption := strParam;
  Application.ProcessMessages;
End;

سأستخدم في هذه المشروع تقنية الاسناد المتأخر (late binding) في انشاء عنصر الكوم، لذلك سنغير كود الضغط على الـ btnProcess ليصبح كمايلي:

procedure TForm2.btnProcessClick(Sender: TObject);
var
  oleObject: OleVariant;
begin
  try
    oleObject := CreateOleObject('CSDemoLibrary.MyClass');
    ShowMessage('النتيجة= ' + IntToStr(oleObject.Process(10, LongInt(@callback), 0, 'القيمة الابتدائية')));
  except on E: Exception do
    ShowMessage('COM Error: ' + #13 + #10 + e.Message);
  end;
end;

وبهذا يصبح لدينا تطبيق دلفي يستدعي عملية طويلة في الدوت نت التي بدورها تقوم بتنبيه تطبيق دلفي حول حالة العملية و مقدار التقدم الحاصل باستخدام التابع المنادى المكتوب في دلفي.

5_a

المرفقات:

مراجع

http://en.wikipedia.org/wiki/Callback_%28computer_programming%29
http://edn.embarcadero.com/article/32754
http://msdn.microsoft.com/en-us/library/system.runtime.interopservices.marshal.getdelegateforfunctionpointer%28v=vs.85%29.aspx

Comments

سلمت يداك لم

سلمت يداك Big Grin
لم أجد زر Like فأدرجتها كتعليق

Re: سلمت يداك

المدونة مدونتك أخي زاهر Smile أنتم أصحاب البيت و نحن الزوار . شكرأ لمرورك العبق مجدداً Wink

استفسار

سلمت يداك أخي الكريم .. المدونة رائعة وأكثر من مفيدة .. استفدت منها في ما كنت أبحث عنه لأيام .. ولكن بقيت لدي مشكلة لم أجد حلها بعد .. وهي كيفية ادراج ملف ال
config
التابع للمكتبة ..

مثلا لدي مكتبة
X.dll
و
X.dll.config

Re:استفسار

مرحباً بك، أنا سعيد أن المدونة أعجبتك، بالنسبة لسؤالك، برغم أن إضافة ملف config لمكاتب الدوت النت هو أمر (غير محبذ) لكنه ممكن في حال الضرورة مع مراعاة أن استخراج الاعدادت المحفوظة فيه يتطلب اسلوباً مختلفاً عن الاسلوب التقليدي المتعارف عليه وهذا مثال عن ذلك:

Configuration dllConfig = ConfigurationManager.OpenExeConfiguration(Assembly.GetExecutingAssembly().Location); string strConn = dllConfig.ConnectionStrings.ConnectionStrings["myConnectionString"].ConnectionString;

طبعاً في هذه الحالة يجب أن تتأكد من وجود ملف ال config مع ملف ال dll ضمن نفس المسار. أتمنى أن يساعدك هذا الجواب المختصر على حل المشكلة ومرحباً بك مجدداً.

Post new comment

The content of this field is kept private and will not be shown publicly.
  • Web page addresses and e-mail addresses turn into links automatically.
  • Allowed HTML tags: <a> <em> <strong> <cite> <code> <ul> <ol> <li> <dl> <dt> <dd>
  • Lines and paragraphs break automatically.
  • Tables will be rendered with different styles for even and odd rows if supported.
  • Textual smileys will be replaced with graphical ones.
  • You may quote other posts using [quote] tags.
  • You can highlight code with any of the following tags: <code>, <cpp>, <cs>, <delphi>, <xml>

More information about formatting options

CAPTCHA
This question is for testing whether you are a human visitor and to prevent automated spam submissions.
Image CAPTCHA
Copy the characters (respecting upper/lower case) from the image.
Syndicate content