الصنف TracePoint في روبي

من موسوعة حسوب

يوفر الصنف TracePoint وظائف Kernel.set_trace_func على شكل واجهة برمجية كائنية (Object-Oriented API).

مثال

يمكننا استخدام المتعقبات (كائنات الصنف TracePoint) لجمع المعلومات بخصوص الاستثناءات:

trace = TracePoint.new(:raise) do |tp|
    p [tp.lineno, tp.event, tp.raised_exception]
end
#=> #<TracePoint:disabled>
trace.enable
#=> false
0 / 0
#=> [5, :raise, #<ZeroDivisionError: divided by 0>]‎

الأحداث

إذا لم تحدِّد نوع الأحداث التي تريد الاستماع إليها، فسيشمل المتعقب TracePoint جميع الأحداث المتاحة.

ملحوظة: لا تعتمد على مجموعة الأحداث الحالية، إذ أن هذه القائمة عرضةٌ للتغيير. بدلًا من ذلك، يُنصَح بتحديد نوع الأحداث التي تريد استخدامها.

لترشيح الأحداث التي تريد تعقبها، يمكنك تمرير أي من الخيارات التالية كوسيط events:

  • :line - تنفيذ التعليمات البرمجية في سطر جديد.
  • :class - بدء تعريف صنف أو وحدة.
  • :end - إنهاء تعريف صنف أو وحدة.
  • :call - استدعاء تابع من توابع روبي.
  • ‎‎:return - العودة من تابع من توابع روبي.
  • :c_call - استدعاء برنامج (routine) من لغة C.
  • :c_return - العودة من روتين من لغة C.
  • :raise - إطلاق استثناء.
  • :b_call - ربط الحدث ببداية الكتلة البرمجية.
  • :b_return - ربط الحدث بنهاية الكتلة البرمجية.
  • :thread_begin - ربط الحدث ببداية مهمة فرعية.
  • :thread_end - ربط الحدث ينهاية مهمة فرعية.
  • :fiber_switch - ربط الحدث بتبديل (switch) الألياف.

توابع الصنف العامة

new

ينشئ متعقبًا جديدًا غير مفعَّل افتراضيًّا.

stat

يُعيد المعلومات الداخلية للمتعقب.

trace

ينشِّط التعقب تلقائيًا وهو ملائم للتابع new.

توابع النسخة العامة

binding

يُعيد كائن الربط (binding object) الذي تم إنشاؤه من الحدث.

callee_id

يُعيد اسم الاستدعاء الخاص بالتابع الذي يتم استدعاؤه.

defined_class

يُعيد صنف أو وحدة التابع المُستدعى.

disable

يعطل التعقب.

enable

يفعِّل التعقب.

enabled?‎

يتحقق من الوضع الحالي للتعقب.

event

يعيد نوع الحدث التي يجري تعقبه.

inspect

يُعيد سلسلة نصية تحتوي حالة الكائن TracePoint الذي استُدعي معه وفق صيغة قابلة للقراءة.

lineno

يعيد رقم سطر الحدث التي يجري تعقبه.

method_id

يعيد الاسم المعطى ساعة تعريف التابع المُستدعى.

path

يعيد مسار الملف الجاري تنفيذه.

raised_exception

يعيد قيمة الاستثناء الذي تم إطلاقه في الحدث raise:.

return_value

يُعيد قيمة الحدث ‎:return و c_return و b_return.

self

يُعيد كائن التعقب (trace object) الذي تم إنشاؤه من الحدث.

مصادر