الصنف `ARGF` في روبي

الصنف ARGF هو مجرى (stream) صُمِّم ليُستخدَم في الملفات البرمجية (scritps) التي تُعالج الملفات المُمرَّرة إليها على شكل وسائط في سطر الأوامر (command-line arguments)، أو المُمرَّرة عبر مجرى الدخل القياسي (STDIN).

تُخزَّن الوسائط المُمرَّرة للملف البرمجي في المصفوفة ARGV، إذ يخزَّن وسيط واحد في كل عنصر. تفترض ARGF أنّ الوسائط التي ليست أسماء ملفات (filenames) قد أزيلت من ARGV. انظر الشيفرة التالية مثلًا:

$ ruby argf.rb --verbose file1 file2

ARGV  #=> ["--verbose", "file1", "file2"]
option = ARGV.shift #=> "--verbose"
ARGV  #=> ["file1", "file2"]

يمكنك الآن استخدام ARGF للعمل مع سلسلة من كل هذه الملفات المسماة (named files). على سبيل المثال، ستعيد العبارة ARGF.read محتويات الملف file1 متبوعةً بمحتويات الملف file2.

بعد قراءة أحد الملفات الموجودة في ARGV، تزيل ARGF هذا الملف من المصفوفة. بناءً على ذلك، ستصبح ARGV فارغةً بعد قراءة جميع الملفات.

يمكنك تعديل ARGV بنفسك للتحكم في عملها. إن أزلت مثلًا ملفًا من ARGV، فستتجاهله ARGF؛ وإذا أضفت ملفات إلى ARGV، فستُعامل كما لو أنها مُرِّرت في سطر الأوامر. تفحَّص مثلًا الشيفرة التالية:

ARGV.replace ["file1"]
ARGF.readlines # في مصفوفة file1 إعادة محتويات الملف
ARGV           #=> []
ARGV.replace ["file2", "file3"]
ARGF.read      # file3 والملف file2 إعادة محتويات الملف

إن كانت ARGV فارغةً، فستتصرّف وكأنّها تحتوي مجرى الدخل القياسي (STDIN)، أي البيانات المُرسلة عبر أنبوب (piped) إلى ملفك البرمجي (script). إليك مثلًا هذا المثال البسيط:

$ echo "glark" | ruby -e 'p ARGF.read'
"glark\n"

التوابع العامة (Public Instance Methods)

`argv`

يعيد التابع argv المصفوفة ARGV التي تحوي الوسائط المُمرّرة إلى ملفك البرمجي (script)، إذ يخزَّن في كلِّ عنصر من عناصرها وسيطٌ واحدٌ.

`binmode?‎`

يتحقق التابع binmode?‎ إذا تمت قراءة المجرى ARGF في الوضع الثنائي (binary mode).

`binmode`

يفعِّل التابع binmode الوضع الثنائي (binary mode) للمجرى ARGF.

`bytes`

التابع bytes هو اسم بديل مهمل (deprecated) للتابع each_byte.

`chars`

التابع chars هو اسم بديل مهمل (deprecated) للتابع each_char.

`close?‎`

يتحقق التابع close?‎ إن أُغلِق الملف الحالي أم لا

`close`

يغلق التابع close الملف الحالي ويتخطاه إلى الملف التالي في ARGV. إن لم تتبقَ ملفات أخرى لفتحها، فسيكتفي التابع بإغلاق الملف الحالي. انتبه إلى أنَّ مجرى الدخل القياسي (STDIN) لن يُغلَق أبدًا.

`codepoints`

التابع codepoints هو اسم بديل مهمل (deprecated) للتابع each_codepoints.

`each`

التابع each هو اسم بديل مهمل (deprecated) للتابع each_line.

`each_line`

يعيد التابع each_line قيمة قابلة للعد (enumerator) تتكرر (iterates) عبر كل سطر (الذي يفصل بالفاصلة الممرَّرة) من كل ملف من الملفات الموجودة في ARGV. في حال تمرير كتلة برمجية للتابع each_line، فسيُمرّر كل سطر بدوره إلى تلك الكتلة، وإلا فستعاد قيمة قابلة للعد (enumerator).

`eof?‎`

يتحقق التابع eof?‎ إذا بلغ الملف الحالي نهايته في ARGF؛ أي أنّه لم تعد هناك أي بيانات لقراءتها.

`external_encoding`

يعيد التابع external_encoding الترميز الخارجي (external encoding) للملفات المقروءة من ARGF على شكل كائن من النوع Encoding.

`file`

يعيد التابع file الملف الحالي على شكل كائن من النوع IO أو File.

`filename`

يعيد التابع filename اسم الملف الحالي.

`fileno`

يعيد التابع fileno عددًا صحيحًا يمثل واصف الملف العددي (numeric file descriptor) للملف الحالي. إن لم يكن هنالك ملف، فسيُطلَق الخطأ ArgumentError.

`getbyte`

يجلب التابع getbyte بايتًا واحدًا (8 بتّات) من المجرى ARGF.

`getc`

يجلب التابع getc المحرف التالي من المجرى ARGF.

`gets`

يجلب التابع gets السطر التالي من الملف الحالي في المجرى ARGF.

`inplace_mode = ext`

يضبط التابع inplace_mode عند استدعائه بالشكل inplace_mode = ext امتداد اسم الملف بوضعية التعديل الموضعي (in-place editing mode) إلى السلسلة النصية ext المعطاة. تضاف هذه القيمة المعطاة إلى أسماء كل الملفات التي يتم تعديلها، ويُحفَظ الملف المُعدَّل تحت هذا الاسم الجديد.

`inplace_mode`

يعيد التابع inplace_mode امتداد الملف المضاف إلى أسماء الملفات المُعدَّلة وفق وضع التعديل الموضعي (in-place edit mode).

`inspect`

يعد التابع inspect اسمًا بديلًا للتابع to_s.

`internal_encoding`

يعيد التابع internal_encoding الترميز الداخلي (internal encoding) للسلاسل النصية المقروءة من المجرى ARGF على شكل كائن من النوع Encoding.

`lineno = integer`

يعيِّن التابع lineno عند استدعائه بالشكل lineno = integer رقم السطر الحالي للمجرى ARGF ككُل.

`lineno`

يجلب التابع lineno رقم السطر الحالي للمجرى ARGF ككُل.

`lines`

يعدُّ التابع lines اسمًا بديلًا مهملًا (deprecated) للتابع each_line.

`path`

يعيد التابع path اسم الملف الحالي.

`pos = position`

ينقل التابع pos عند استدعائه بالشكل pos = position المؤشِّر إلى المكان position (المعطى بالبايت) في المجرى ARGF.

`pos`

يعيد التابع pos موضع المؤشِّر الحالي في الملف الحالي في المجرى ARGF.

`print`

يطبع التابع print الكائن أو الكائنات المُمرَّرة إليه على المجرى ios (اختصارًا للعبارة Input Output Stream).

`printf`

يطبع التابع printf الكائن أو الكائنات الممرَّرة إليه على المجرى ios (اختصارًا للعبارة Input Output Stream) بعد تنسيقها بشكل معين. للمزيد من المعلومات حول المعاملات المستعملة في عملية التنسيق (أي المستعملة مع الوسيط format_string).

`putc`

يكتب التابع putc محرفًا واحدًا على المجرى ios (اختصارًا للعبارة Input Output Stream).

`puts`

يكتب التابع puts الكائن أو الكائنات المُمرَّرة إليه على المجرى ios (اختصارًا للعبارة Input Output Stream) ثمَّ يضيف سطرًا جديدًا في النهاية إن لم تحتوِ تلك الكائنات المعطاة على محرف سطرٍ جديدٍ.

`read`

يقرأ التابع read عددًا محددًا من البايتات من المجرى ARGF.

`readbyte`

يقرأ التابع readbyte البايت التالي من المجرى ARGF ثمَّ يعيده على شكل عدد صحيح (integer).

`readchar`

يقرأ التابع readchar المحرف التالي من المجرى ARGF ثم يعيده على شكل سلسلة نصية

`readline`

يقرأ التابع readline السطر التالي من الملف الحالي في المجرى ARGF.

`readlines`

يقرأ التابع readlines الملف الحالي في المجرى ARGF بشكل كامل.

`readpartial`

يقرأ التابع readpartial عددًا من البايتات لا يتجاوز قيمةً حديةً عليا من المجرى ARGF.

`read_nonblock`

يقرأ التابع read_nonblock عددًا من البايتات لا يتجاوز قيمةً حديَّةً عليا من المجرى ARGF في وضع عدم الحجز (non-blocking mode).

`rewind`

يُرجِع التابع rewind المؤشر إلى بداية الملف الحالي عند بداية المدخلات (input) ويعيد تعيين رقم السطر ARGF.lineno إلى القيمة 0.

`seek`

يحرِّك التابع seek المؤشِّر الحالي في المجرى ARGF إلى موقع محدد.

`set_encoding`

يضبط التابع set_encoding الترميز الداخلي والخارجي المستعمل مع السلاسل النصية المقروءة من المجرى ARGF.

`skip`

يتخطى التابع skip الملف الحالي إلى الملف التالي ويجعله هو الملفَّ الحالي في المجرى ARGF. وفي حال لم يكن هنالك أية ملفات متبقية، فلن يكون لهذا التابع أي تأثير.