printf

استخدمت لغات البرمجة المبكرة مثل فورتران عبارات خاصة ذات بنية مختلفة عن العمليات الحسابية الأخرى لإنشاء أوصاف التنسيق. ^{[ 1 ]} في هذا المثال، يتم تحديد التنسيق على السطر601ويشير الأمر PRINT^{[ a ]} إليه برقم السطر:

PRINT 601 , IA , IB , AREA 601 FORMAT ( 4 H A = , I5 , 5 H B = , I5 , 8 H AREA = , F10 . 2 , 13 H SQUARE UNITS )

بموجب هذا:

• 4Hيشير إلى سلسلة من 4 أحرف" A= " ( Hيعني حقل هوليريث )؛
• I5يشير إلى حقل عدد صحيح بعرض 5؛
• F10.2يشير إلى حقل ذي فاصلة عائمة بعرض 10 مع رقمين بعد الفاصلة العشرية.

قد يبدو الناتج مع وسائط الإدخال 100، 200و ، 1500.25كما يلي:

أ = ١٠٠ ب = ٢٠٠ المساحة = ١٥٠٠.٢٥ وحدة مربعة

ظهرت لغة BCPL عام 1967. ^{[ 2 ]} تضمنت مكتبتها writefروتينًا يشبه أي استدعاء دالة آخر. ^{[ 3 ]} يبدو تطبيقها كمثال على ذلك:

WRITEF("%I2-QUEENS PROPLEM HAS %I5 SOLUTIONS*N", NUMQUEENS, COUNT) 

بموجب هذا:

• %I2يشير إلى عدد صحيح بعرض 2 (يتم عكس ترتيب عرض ونوع حقل مواصفات التنسيق مقارنةً بـ C printf)؛
• %I5يشير إلى عدد صحيح بعرض 5؛
• *Nهو تسلسل هروب في لغة BCPL يمثل حرف سطر جديد (الذي تستخدم لغة C تسلسل الهروب الخاص به ).\n

كان لدى لغة ALGOL 68 أيضًا واجهة برمجة تطبيقات للدوال، ولكنها استخدمت صيغة خاصة للتنسيق:

printf (( $ "Color " g ", number1 " 6d " , " ", number2 " 4zd " , "", hex " 16r2d " , "", float " -d.2d " , " ", unsigned value " -3d ." l$ " , "red" , 123456 , 89 , BIN 255 , 3.14 , 250 ));

يُبسّط استخدام صيغة الدوال العادية للطباعة اللغة، ويسمح بتنفيذ الطباعة ضمن اللغة نفسها. في معظم اللغات الحديثة في تلك الحقبة، لا تُعدّ عمليات الإدخال والإخراج جزءًا من الصيغة. ومع ذلك، لم يكن يتم عادةً التحقق من التنسيق للتأكد من مطابقته لنوع (أو حتى عدد) القيم المراد طباعتها. ^{[ 4 ]}

في عام 1973، printfتم تضمينها كروتين مكتبة C القياسية كجزء من الإصدار 4 من يونكس . ^{[ 5 ]}

في عام 1990، أُدرج أمر printfshell ، المصمم على غرار دالة مكتبة C القياسية، مع نظام التشغيل 4.3BSD-Reno . ^{[ 6 ]} وفي عام 1991، أُدرج أمر آخر مع GNU shellutils (التي أصبحت الآن جزءًا من GNU Core Utilities )، ويختلف بناء جملة (الخيارات، الوسائط، إلخ) أمر shell هذا عن دالة لغة C، على سبيل المثال: لا يستخدم "قسم التنسيق" الوسائط الموضعية ^{[ 7 ]} مع رمز "$" (n$) بنفس طريقة الدالة.printfprintf()

str = "AA BB CC" # سلسلة نصية بسيطة بثلاثة حقولتعيين -- $str # تحويل الحقول إلى معلمات موضعيةprintf "%s " $2 $3 $1 ; echo # في لغة C، تستخدم دالة printf() الرمز 2$ 3$..# مطبوعات: BB CC AA

في عام 2004، صدرت جافا 5.0 (1.5)، والتي وسّعت الفئة java.io.PrintStream، مضيفةً دالةً تُسمى printf()تعمل بشكلٍ مشابهٍ لدالةٍ printf()في لغة C. وبالتالي، لطباعة سلسلة نصية مُنسّقة إلى دفق الإخراج القياسي، يتم استخدام هذه الدالة System.out.printf(). وقد أضافت جافا لاحقًا هذه الدالة formatإلى فئة السلاسل النصية الخاصة بها java.lang.String. ^{[ 8 ]}

إن الحاجة إلى القيام بشيء ما حيال مجموعة المشاكل الناتجة عن نقص سلامة النوع قد دفعت إلى محاولة جعل المترجمات printfعلى دراية بذلك.

يُتيح خيار -Wformatمجموعة مُترجمات GNU (GCC) إجراء فحوصات أثناء الترجمةprintf للاستدعاءات، مما يمكّن المُترجم من اكتشاف مجموعة فرعية من الاستدعاءات غير الصالحة (وإصدار تحذير أو خطأ، وإنهاء عملية الترجمة، وفقًا لما تحدده علامات أخرى). ^{[ 9 ]}

لأن المترجم يفحص printfمحددات التنسيق، فإن هذه الميزة توسع بشكل فعال التحليل الثابت في لغة C ليشمل جوانب التنسيق.

أضافت لغة C++ دعمًا للإدخال والإخراج باستخدام عامل التشغيل << لتجنب مشاكل الأمان في دالة printf. ^{[ 10 ]} يعتمد هذا على نوع الوسائط لتحديد الكود المراد تنفيذه لطباعتها، متجنبًا بذلك الأعطال المحتملة مع سلاسل التنسيق. مع ذلك، قد يكون بناء الجملة مطولًا (خاصةً عند ضبط خيارات مثل الدقة)، ولذا تبقى دالة printf متاحة في C++ وغالبًا ما تُستخدم بدلًا منها.

أضافت لغة C++20 واجهة برمجة تطبيقات جديدة تستخدم سلسلة نصية تتكون من نص حرفي وعناصر نائبة متبوعة بالقيم المراد طباعتها. ^{[ 11 ]} تستخدم سلسلة التنسيق أقواسًا معقوفة بدلًا من علامات النسبة المئوية، استنادًا إلى الصيغة المستخدمة في مكتبة بايثون القياسية : ^{[ 11 ] [ 12 ]}

std::format("The hex value of {} is {:x}.",name,value)

يُوصى باستخدام مكتبة fmtlib الخاصة بفيكتور زفيروفيتش ^{[ 11 ] [ 13 ]} ، والتي تُحوّل أنواع السلاسل والوسائط إلى كائن تنسيق مُحسَّن أثناء الترجمة، مما يضمن سلامة النوع واكتشاف أخطاء بناء الجملة أثناء الترجمة. قدّمت لغة C++23 الدالتين و اللتين جمعتا بين التنسيق والإخراج، وبالتالي تُعدّان بديلاً وظيفياً لـ . ^{[ 14 ]} من الممكن إنشاء مُترجم من سلسلة printf % إلى كائن التنسيق نفسه ^{[ 15 ]،} وهذا من شأنه أن يُنتج دالة printf آمنة النوع ، ولكن لم يُضَف هذا إلى المواصفات. لم يُقدَّم أي تحديث مُماثل لدالة scanf ، على الرغم من اقتراح تحديث مُستند إلى مكتبة scnlib . ^{[ 16 ]}std::print()std::println()printf() 

تستطيع هذه الدوال (بالإضافة إلى ذلك std::to_chars) طباعة الأعداد العشرية بدقة باستخدام أقل عدد ممكن من الأرقام اللاحقة، وهي ميزة كانت تفتقر إليها دالة printf لفترة طويلة . ومن الميزات المفيدة الأخرى أنها تتجاهل الإعدادات المحلية .

صيغة مُحدِّد التنسيق هي:

%[ parameter ][ flags ][ width ][. precision ][ length ] type

حقل المعلمة اختياري. في حال تضمينه، فإن مطابقة المحددات بالقيم لا تتم بشكل تسلسلي. القيمة العدديةنيحدد هذا الخيار قيمة المعامل رقم n. هذا امتداد لمعيار POSIX ، وليس معيار C99 .

يُتيح هذا الحقل استخدام القيمة نفسها عدة مرات في سلسلة التنسيق بدلاً من تمرير القيمة عدة مرات. إذا تضمن مُحدِّد ما هذا الحقل، فيجب أن تتضمنه المُحدِّدات اللاحقة أيضاً.

على سبيل المثال،

printf ( "%2$d %2$#x; %1$d %1$#x" , 16 , 17 );

المخرجات:17 0x11؛ 16 0x10

يُعد هذا الحقل مفيدًا جدًا لترجمة الرسائل إلى لغات طبيعية مختلفة تستخدم ترتيبات كلمات مختلفة .

في واجهة برمجة تطبيقات ويندوز ، يتم دعم هذه الميزة عبر وظيفة مختلفة printf_p.

يمكن أن يحتوي حقل العلامات على صفر أو أكثر من (بأي ترتيب):

يُحدد حقل العرض الحد الأدنى لعدد الأحرف المطلوب إخراجها. إذا أمكن تمثيل القيمة بعدد أحرف أقل، فسيتم إضافة مسافات إلى يسارها بحيث يكون الناتج هو عدد الأحرف المحدد. أما إذا تطلبت القيمة عددًا أكبر من الأحرف، فسيكون الناتج أطول من العرض المحدد. ولا يتم اقتطاع أي قيمة.

على سبيل المثال، يحدد عرضًا قدره 3 ويُخرجprintf("%3d",12);12مع ترك مسافة على اليسار لإخراج 3 أحرف. يُخرج الاستدعاءprintf("%3d",1234);1234وهو عبارة عن 4 أحرف لأن هذا هو الحد الأدنى للعرض لتلك القيمة على الرغم من أن العرض المحدد هو 3.

إذا تم حذف حقل العرض، فسيكون الناتج هو الحد الأدنى لعدد الأحرف للقيمة.

إذا تم تحديد الحقل على أنه *، فسيتم قراءة قيمة العرض من قائمة القيم في الاستدعاء. ^{[ 17 ]} على سبيل المثال، المخرجاتprintf("%*d",3,10);10(<space>10) حيث المعامل الثاني، 3، هو العرض (يتطابق مع *) و 10هو القيمة المراد تسلسلها (يتطابق مع d).

على الرغم من أنها ليست جزءًا من حقل العرض، إلا أن الصفر البادئ يُفسر على أنه علامة الحشو الصفري المذكورة أعلاه، ويتم التعامل مع القيمة السالبة على أنها القيمة الموجبة بالاقتران مع -علامة المحاذاة إلى اليسار المذكورة أعلاه أيضًا.

يمكن استخدام حقل العرض لتنسيق القيم كجدول (إخراج جدولي). ولكن، لا تتم محاذاة الأعمدة إذا كانت أي قيمة أكبر من العرض المحدد. على سبيل المثال، لاحظ أن قيمة السطر الأخير (1234) لا يتناسب مع العمود الأول بعرض 3 وبالتالي فإن العمود غير محاذٍ.

 1 1 12 12 123 123 1234 123

يُحدد حقل الدقة عادةً الحد الأقصى للناتج، وفقًا لنوع التنسيق. بالنسبة للأنواع العددية ذات الفاصلة العائمة ، يُحدد عدد الأرقام على يمين الفاصلة العشرية التي يجب تقريب الناتج إليها؛ وبالنسبة %gللأنواع الأخرى ، %Gيُحدد العدد الإجمالي للأرقام المعنوية (قبل وبعد الفاصلة العشرية، باستثناء الأصفار البادئة واللاحقة) التي يجب التقريب إليها. أما بالنسبة لنوع السلسلة النصية ، فيُحدد عدد الأحرف التي يجب إخراجها، وبعدها يتم اقتطاع السلسلة.

يمكن حذف حقل الدقة، أو استخدام قيمة عددية صحيحة، أو قيمة ديناميكية عند تمريرها كوسيط إضافي عند الإشارة إليها بعلامة النجمة ( **). على سبيل المثال، المخرجاتprintf("%.*s",3,"abcdef");أبجد.

يمكن حذف حقل الطول أو أن يكون أيًا مما يلي:

ظهرت خيارات الطول الخاصة بالمنصة قبل الاستخدام الواسع النطاق لامتدادات ISO C99، بما في ذلك:

يتضمن معيار ISO C99 inttypes.hملف رأس يحتوي على عدد من وحدات الماكرو للبرمجة عبر المنصات المختلفةprintf . على سبيل المثال: يحدد تنسيقًا عشريًا لعدد صحيح مُوقّع 64 بت . بما أن وحدات الماكرو تُقيّم إلى سلسلة نصية حرفية ، ويقوم المُصرّف بدمج السلاسل النصية المتجاورة، فإن التعبير يُترجم إلى سلسلة نصية واحدة.printf("%"PRId64,t);"%"PRId64

تتضمن وحدات الماكرو ما يلي:

يمكن أن يكون حقل النوع أيًا مما يلي:

تتمثل إحدى الطرق الشائعة للتعامل مع التنسيق باستخدام نوع بيانات مخصص في تنسيق قيمة نوع البيانات المخصص في سلسلة نصية ، ثم استخدام المحدد لتضمين القيمة المتسلسلة في رسالة أكبر.%s

تتيح بعض الدوال الشبيهة بـ printf إمكانية توسيع اللغة المصغرة القائمة على أحرف الهروب ، مما يسمح للمبرمج باستخدام دالة تنسيق محددة للأنواع غير المدمجة. إحدى هذه الدوال هي دالة glibc ( التي أصبحت مهملة الآن ) . ومع ذلك، نادرًا ما تُستخدم نظرًا لتعارضها مع التحقق الثابت من سلاسل التنسيق . وهناك أيضًا دوال Vstr المخصصة للتنسيق ، والتي تسمح بإضافة أسماء تنسيق متعددة الأحرف.register_printf_function()

تتضمن بعض التطبيقات (مثل خادم Apache HTTP ) دالة مشابهة لدالة printf، وتُدمج فيها امتدادات. مع ذلك، تميل جميع هذه التطبيقات إلى مواجهة نفس المشاكل التي register_printf_function()تواجهها التطبيقات الأخرى.

تدعم دالة نواة لينكسprintk عدة طرق لعرض هياكل النواة باستخدام المواصفات العامة، وذلك بإضافة أحرف تنسيق إضافية. ^{[ 21 ]} على سبيل المثال، تطبع عنوان IPv4 بصيغة عشرية منقطة. يتيح هذا التحقق الثابت من سلسلة التنسيق (للجزء ) على حساب التوافق الكامل مع دالة printf العادية.%p%pI4%p

يتم تجاهل وسائط القيمة الزائدة، ولكن إذا احتوى نص التنسيق على عدد من مُحدِّدات التنسيق يفوق عدد وسائط القيمة المُمرَّرة، فسيكون السلوك غير مُحدَّد. بالنسبة لبعض مُترجمات لغة C، يؤدي وجود مُحدِّد تنسيق إضافي إلى استهلاك قيمة حتى في حال عدم وجود قيمة، مما يسمح بهجوم نص التنسيق . عمومًا، في لغة C، تُمرَّر الوسائط على المكدس . إذا تم تمرير عدد قليل جدًا من الوسائط، فقد تتمكن دالة printf من القراءة بعد نهاية إطار المكدس، مما يسمح للمهاجم بقراءة المكدس.

تقوم بعض المترجمات، مثل مجموعة مترجمات جنو ، بفحص سلاسل التنسيق الخاصة بالدوال الشبيهة بـ printf بشكل ثابت، وتُصدر تحذيرات بشأن المشاكل (عند استخدام العلامات أو ). كما يُصدر GCC تحذيرات بشأن الدوال المُعرَّفة من قِبل المستخدم والتي تُشبه printf إذا تم تطبيق "تنسيق" غير قياسي على الدالة.-Wall-Wformat__attribute__

غالبًا ما تكون سلسلة التنسيق عبارة عن سلسلة نصية حرفية ، مما يسمح بالتحليل الثابت لاستدعاء الدالة. مع ذلك، يمكن أن تكون سلسلة التنسيق قيمة لمتغير ، مما يسمح بالتنسيق الديناميكي، ولكنه يُعرّض النظام أيضًا لثغرة أمنية تُعرف باستغلال سلسلة التنسيق غير المُتحكّم بها .

على الرغم من أنها دالة إخراج ظاهريًا، إلا printfأنها تسمح بالكتابة إلى موقع ذاكرة محدد بواسطة وسيط عبر . يمكن استخدام هذه الوظيفة لهجمات حقن التعليمات البرمجية دون انتهاك سلامة تدفق التحكم . ^{[ 22 ]}%n

يُؤدي مُحدِّد التنسيق أيضًا إلى جعل البرنامج كاملًا تورينجيًا عن طريق الخطأ حتى مع مجموعة وسائط سليمة التكوين. ^{[ 22 ]} لعبة إكس أو مكتوبة بسلسلة التنسيق هي الفائزة في مسابقة IOCCC السابعة والعشرين . ^{[ 23 ]}%nprintf

تتضمن المتغيرات printfفي مكتبة C القياسية ما يلي: fprintfإخراج البيانات إلى ملف بدلاً من الإخراج القياسي.

sprintfيكتب إلى مخزن مؤقت للسلاسل النصية بدلاً من الإخراج القياسي.

snprintfيوفر مستوى من الأمان sprintfلأن المتصل يوفر طولًا n وهو طول مخزن الإخراج بالبايت (بما في ذلك مساحة لحرف null اللاحق).

asprintfتُوفّر هذه الدالة الأمان من خلال قبول وسيطة سلسلة نصية ( ) char**. تقوم الدالة بتخصيص مخزن مؤقت بحجم كافٍ لاحتواء النص المنسق، ثم تُخرج المخزن المؤقت عبر هذه الوسيطة.

لكل دالة من دوال هذه العائلة، بما في ذلك دالة printf، يوجد أيضًا شكل بديل يقبل va_listوسيطًا واحدًا بدلًا من قائمة متغيرة من الوسائط. عادةً ما تبدأ هذه الأشكال البديلة بالحرف "v". على سبيل المثال: vprintf, vfprintf, vsprintf.

بشكل عام، تُرجع الدوال الشبيهة بـ printf عدد البايتات المُخرجة أو -1 للإشارة إلى الفشل. ^{[ 24 ]}

تتضمن القائمة التالية لغات برمجة بارزة توفر (مباشرةً أو عبر مكتبة قياسية) وظائف مماثلة أو مشابهة لوظائف printf في لغة C. ويُستثنى من ذلك اللغات التي تستخدم سلاسل تنسيق تختلف عن الأسلوب المذكور في هذه المقالة (مثل AMPL و Elixir )، واللغات التي ترث تنفيذها من آلة جافا الافتراضية (JVM) أو بيئة أخرى (مثل Clojure و Scala )، واللغات التي لا تملك تنفيذًا أصليًا قياسيًا لوظيفة printf ولكنها تحتوي على مكتبات خارجية تحاكي سلوكها (مثل JavaScript ).