عرض مصدر Bash/introduction to functions

<noinclude>{{DISPLAYTITLE:مقدمة إلى الدوال في Bash}}</noinclude>
== ما هي الدوال؟ ==
دوال الصدفة طريقة لتجميع أوامر من أجل تنفيذها لاحقًا باستخدام اسم واحد للمجموعة ككل أو روتين، ويجب أن يكون اسم الروتين فريدًا لا يتكرر في الصدفة أو الشيفرة النصية، وتُنفَّذ كل الأوامر التي تكوِّن الدالة مثل الأوامر العادية تمامًا.

تُنفَّذ قائمة الأوامر المرتبطة باسم دالة حين تُستدعى تلك الدالة كأمر بسيط، وتُنفَّذ الدالة داخل الصدفة التي صُرِّح عنها فيها، فلا تُفتح عملية جديدة لتفسير الأوامر. وستظهر الأوامر الخاصة المُضمَّنة قبل دوال الصدفة أثناء البحث عن الأوامر، والأوامر الخاصة المُضمَّنة هي:<syntaxhighlight lang="bash">
break, :, ., continue, eval, exec, exit, export, readonly, return, set, shift, trap, unset.
</syntaxhighlight>

== القواعد التركيبية للدوال Functions Syntax ==
تستخدم الدوال إحدى هاتين القاعدتين:<syntaxhighlight lang="bash">
function FUNCTION { COMMANDS; }
</syntaxhighlight>أو<syntaxhighlight lang="bash">
FUNCTION () { COMMANDS; }
</syntaxhighlight>تلك القاعدتين تحددان دالة للصدفة اسمها FUNCTION، ولا يشترط استخدام أمر <code>function</code> لكن إن لم تستخدمه فستحتاج إلى القوسين () كما ترى في القاعدة الثانية.<blockquote>'''أخطاء شائعة'''</blockquote><blockquote>يجب أن تفصل مسافة بين القوسين المعقوفين <code>{ }</code> ومحتوى الدالة بينهما، وإلا سيُفسَّر محتوى الدالة خطأً، وكذلك يجب أن ينتهي محتوى الدالة بفاصلة منقوطة <code>;</code> أو سطر جديد.</blockquote>

== المعامِلات الموضعية في الدوال ==
تشبه الدوالُ شيفراتٍ مصغَّرة، إذ يمكنها قبول معامِلات (parameters) واستخدام متغيرات لا يمكن استخدامها خارج الدوال عبر أمر <code>local</code>، كما يمكنها إعادة قِيَم إلى الصدفة التي استدعتها.

ولدى الدوال نظام لتفسير المعامِلات الموضعية رغم أن المعامِلات الموضعية التي تُمرَّر إلى الدالة ليست كتلك التي تُمرَّر إلى أمر أو شيفرة نصية. وحين تُنفَّذ الدالة فإن وسائطها تصير معامِلات موضعية أثناء تنفيذها، ويُحدَّث المعامِل الخاص <code>#</code> الذي يتوسع إلى عدد المعامِلات الموضعية ليعكس التغير الحادث.

لا يتغير المعامل الموضعي <code>0</code>، ويُضبط متغير <code>FUNCNAME</code> إلى اسم الدالة أثناء تنفيذها. وإن نُفِّذَ أمر <code>return</code> في دالة فإن الدالة تُتم تنفيذها ثم يُنفَّذ الأمر الذي بعد استدعاء الدالة. وتعود قيَم المعاملات الموضعية والمعامل الخاص <code>#</code> بعد تمام تنفيذ دالة إلى القيم التي كانت عليها قبل تنفيذ الدالة، وإن تم تمرير وسيط عددي إلى <code>return</code> فإن تلك الحالة يتم إرجاعها. إليك مثالًا بسيطًا:<syntaxhighlight lang="bash">
[ahmad@ahmadpc ~/test] cat showparams.sh
#!/bin/bash                                                                          

echo "This script demonstrates function arguments."
echo                                                                            

echo "Positional parameter 1 for the script is $1."
echo                                                                            

test ()
{
echo "Positional parameter 1 in the function is $1."
RETURN_VALUE=$?
echo "The exit code of this function is $RETURN_VALUE."
}                                                                        

test other_param

[ahmad@ahmadpc ~/test] ./showparams.sh parameter1
This script demonstrates function arguments.

Positional parameter 1 for the script is parameter1.

Positional parameter 1 in the function is other_param.
The exit code of this function is 0.

[ahmad@ahmadpc ~/test]
</syntaxhighlight>لاحظ أن قيمة الإعادة أو رمز الخروج للدالة يُخزَّن غالبًا في متغير من أجل فحصه (probed) لاحقًا، وتستخدم شيفرات init في نظامك تقنية فحص متغير <code>RETVAL</code> في اختبار شرطي كهذا:<syntaxhighlight lang="bash">
if [ $RETVAL -eq 0 ]; then
        <start the daemon>


</syntaxhighlight>أو كما في المثال التالي من شيفرة <code>‎/etc/init.d/amd</code> حيث تُستخدم مزايا تهيئة bash:<syntaxhighlight lang="bash">
[ $RETVAL = 0 ] && touch /var/lock/subsys/amd
</syntaxhighlight>لا تُنفَّذ الأوامر التي بعد <code>&&</code> إلا في حالة نجاح الاختبار، وهي طريقة أقصر للتعبير عن <code>if/then/if</code>. ويُستخدم رمز الإعادة للدالة كرمز خروج من الشيفرة كلها، وسترى شيفرات init كثيرة تنتهي بشيء مثل <code>exit $RETVAL</code>.

== عرض الدوال Displaying Functions ==
يمكن عرض كل الدوال المعروفة للصدفة الحالية باستخدام أمر <code>set</code> بدون خيارات، إذ تبقى الدوال بعد استخدامها ما لم يُستخدم أمر <code>unset</code> لإزالتها، كما يعرض أمر <code>which</code> الدوال أيضًا:<syntaxhighlight lang="bash">
[ahmad@ahmadpc ~] which zless
zless is a function
zless ()
{
   zcat "$@" | "$PAGER"
}
[ahmad@ahmadpc ~] echo $PAGER
less
</syntaxhighlight>هذا مثال عن الدالة التي تُهيأ في ملفات إعدادات موارد الصدفة الخاصة بالمستخدم، وبشكل عام فإن الدوال أكثر مرونة من الأوامر البديلة وتوفِّر طريقة بسيطة وسهلة لتهيئة بيئة المستخدم. إليك واحدة لمستخدمي DOS:<syntaxhighlight lang="bash">
dir ()
{
   ls -F --color=auto -lF --color=always "$@" | less -r
}

</syntaxhighlight>

== انظر أيضًا ==
* [[Bash/conditional statements|البُنى الشرطية في Bash]]

* [[Bash/Bash environment|بيئة Bash]]

== مصادر ==
* [http://tldp.org/LDP/Bash-Beginners-Guide/html/sect_11_01.html <span>دليل Bash للمبتدئين،</span> صفحة مقدمة إلى الدوال.]
[[تصنيف:Bash]]
[[تصنيف:Bash functions]]