Fonctions

Mise à jour : Debian 11.2 - Bullseye

Les fonctions sont des séquences de commandes bash réutilisables, généralement utilisées dans les scripts, mais pouvant être également utilisées en ligne de commande.

Sommaire

1 - Syntaxe

Une fonction doit-être définie (déclaration et contenu) avant son appel. Elle peut ensuite être appelée plusieurs fois. La définition est identique en ligne de commande et dans un script

• La fonction peut-être déclarée

• soit par la commande "function" suivie de son nom

function bonjour
....

• soit par son nom suivi par ()

bonjour()
....

• Le contenu de la fonction suit la déclaration et est compris entre accolades { }

• sur une ligne, par exemple - Noter l'utilisation du point virgule avant l'accolade de fermeture
  

function bonjour { echo Bonjour; }

• ou plusieurs lignes, par exemple
  

function bonjour { 
      echo Bonjour
}

2 - Liste des fonctions

• Pour vérifier la présence d'une fonction
  

$ declare -F bonjour
bonjour

• Pour vérifier le contenu d'une fonction

$ declare -f bonjour
bonjour () 
{ 
    echo Bonjour
}

• Pour obtenir la liste de toutes les fonctions disponibles, y compris celles créés par d'autres programmes

$ declare -F |head
declare -f __expand_tilde_by_ref
declare -f __get_cword_at_cursor_by_ref
declare -f __grub_dir
declare -f __grub_get_last_option
declare -f __grub_get_options_from_help
declare -f __grub_get_options_from_usage
declare -f __grub_list_menuentries
declare -f __grub_list_modules
declare -f __grubcomp
declare -f __ltrim_colon_completions

3 - Utilisation

3.1 - Utilisation

Une fois la fonction déclarée et définie, pour lancer son exécution, l'appeler par son nom

• Exemple : Fonction bonjour ci-dessus
  

$ bonjour
Bonjour

3.2 - Paramètres en entrée

• Une fonction peut utiliser des paramètres passés en argument, de la même façon qu'un script
• Exemple
  

$ function bonjour { echo Bonjour $1; }

Exécution :

$ bonjour toto
Bonjour toto

$ bonjour titi
Bonjour titi

3.3 - Variables externes

• Les variables définies dans le script ou la session bash appelante sont disponibles dans la fonction
  

$ function Demo { echo $Valeur; }

$ Valeur=10

$ Demo
10

$ Valeur=abcde

$ Demo
abcde

• Les variables définies dans la fonction sont disponibles depuis le script ou la session bash appelante. Si la variable du script a le même nom qu'une variable existante dans le script ou la session bash appelante, celle-ci sera modifiée lors de l'exécution du script
  

$ Variable=0

$ function Demo { Variable=36; }

$ Demo
$ echo $Variable
36

3.4 - Variables locales

• Les variables définies localement dans la fonction ne sont pas accessibles depuis le script ou la session bash appelante. Si la variable du script a le même nom qu'une variable existante dans le script ou la session bash appelante, celle-ci ne sera pas modifiée par l'exécution du script
  

$ Variable=0

$ function Demo { local Variable=36; }

$ Demo
$ echo $Variable
0

3.5 - Variable de sortie

• Une fonction n'est pas prévue pour fournir directement un résultat. Une solution consiste à passer par l'affichage (fonction echo) du résultat souhaité
  

• Dans l'exemple suivant, on demande à la fonction d'afficher le double d'une valeur passée en paramètre
  
• Définition de la fonction

$ function calcul { var=$((2*$1)); echo $var; }

# ou bien

$ function calcul { echo $((2*$1)); }

• Exemple d'utilisation pour afficher le résultat
  

$ calcul 10
20

• ou bien pour définir une variable
  

$ X=$(calcul 10)

$ echo $X
20

• Ceci suppose qu'aucun autre message (erreur ou autre) n'est délivré par la fonction