^ [[validation_motifs|Chapitre précédent]] ^ [[programmez_avec_le_langage_c|Sommaire principal]] ^ [[parametres_arguments|Chapitre suivant]] ^

====== Créer des fonctions ======

===== Programmation impérative et procédurale =====

Jusque maintenant, vous avez écrit du code impératif : les instructions sont exécutées une par une, dans l'ordre où elles apparaissent dans le code.

<code cpp main.cpp>
#include <iostream>

int main() {
    std::cout << "A" << std::endl;
    std::cout << "B" << std::endl;
    std::cout << "C" << std::endl;
    std::cout << "D" << std::endl;
}
</code>

affiche :

<code>
A
B
C
D
</code>

{{ :functions.png |}}

En programmation procédurale, une suite d'instructions est placée dans une procédure (on parle de "fonction" en C++) pour pouvoir être appelé plusieurs fois.

Le code suivant créé une fonction ''f'' qui contient 2 instructions et est appelée 2 fois.

<code cpp main.cpp>
#include <iostream>

void f() {
    std::cout << "  1" << std::endl;
    std::cout << "  2" << std::endl;
}

int main() {
    std::cout << "A" << std::endl;
    f();
    std::cout << "B" << std::endl;
    f();
    std::cout << "C" << std::endl;
}
</code>

affiche :

<code>
A
  1
  2
B
  1
  2
C
</code>

{{ :function2.png |}}

Pour suivre le déroulement d'un tel programme :

  * on commence par le début de main (comme en impératif) ;
  * on exécute instruction par instruction (comme en impératif) ;
  * quand on arrive à un appel de fonction, on exécute les instructions de la fonction une par une ;
  * quand on arrive à la fin de la fonction, on retourne au code qui a appelé la fonction et on reprend l'exécution des instructions une par une.

<note>En réalité, les instructions dans un code C++ impératif cachent souvent des appels à des fonctions. C'est par exemple le cas des opérateurs de flux ''<<'' et de ''std::endl''. De fait, la distinction entre programmation impérative et procédurale est purement pédagogique, un code sera généralement procédurale, même si vous n'écrivez pas explicitement des fonctions.</note>

Ce type de programmation est encore relativement simple à suivre, il suffit de lire les instructions une par une. La difficulté vient si vous avez beaucoup de fonctions, il est pénible d'arrêter la lecture toutes les 2 lignes pour aller lire une autre partie de code. (Essayez de lire un livre et d'aller consulter un dictionnaire tous les 2 phrases, vous comprendrez).

En pratique, cela ne sera pas nécessaire si vous écrivez correctement vos fonctions, en leur donnant un nom explicite. Avec le nom de la fonction, vous pourrez comprendre ce qu'elle fait et continuer la lecture du code, sans devoir aller lire les instructions dans la fonction appelée.

Et en fait, c'est ce que vous faite depuis le début de ce cours. Vous avez déjà utilisé des fonctions, comme par exemple les algorithmes de la bibliothèque standard. Dans le code suivant :

<code cpp>
std::vector<int> v { 1, 8, 3, 5, 2, 9 };
std::sort(begin(v), end(v));
std::cout << v.front() << std::endl;
</code>

Lorsque vous lisez la ligne avec ''std::sort'', vous comprenez que le tableau est trié et que vous affichez ensuite le premier élément. Vous n'avez pas besoin d'aller lire le code de cette fonction pour comprendre que ce code va afficher la valeur "1" (première valeur du tableau après le tri).

C'est une règle générale qu'il faut retenir quand vous créez une fonction : il faut pouvoir (idéalement) la comprendre et l'utiliser sans devoir aller lire le code de la fonction ou la documentation. (Le nom de la fonction et des paramètres doit être la première documentation).

Un autre exemple de fonction que vous connaissez bien maintenant : la fonction ''main'' :

<code cpp>
int main() {}
</code>


===== Pourquoi créer des fonctions ? =====

<note>**À rédiger...**

Savoir utiliser des fonctions ne consiste pas seulement à connaitre les syntaxes pour écrire et utiliser des fonctions. L'objectif est avant tout de savoir décomposer une problématique complexe en sous-problématiques de plus en plus simples, de façon à arriver à des solutions connues ou facilement implémentables.

{{ :function.png |}}

Une solution sera généralement implémentée sous forme d'une fonction, qui aura idéalement les qualités suivantes :

  * courte : en quelques lignes (quelques lignes a quelques dizaines de lignes) ;
  * simple a implémenter : qui utilise au maximum d'autres fonctions, en particulier des classes et algorithmes de la bibliothèques standard ;
  * compréhensible : à partir du nom de la fonction et des paramètres (et de la documentation), n'importe qui peut comprendre ce que fait la fonction ;
  * générique : la fonction peut être utilisée avec de nombreux types de données ;
  * testable : il est facile d’écrire des tests permettant de vérifier le comportement d'une fonction.

exemple de démarche partant d'une problématique en solutions simples
</note>


===== Syntaxe de base =====

Une fonction est définie par :

  * des informations en entrée et sortie
  * un nom identifiant la fonction
  * une bloc d'instructions

<code>
PARAMETRE_SORTIE NOM_FONCTION (PARAMETRES_ENTREE) {
    INSTRUCTIONS
}
</code>

<note>**Un peu de vocabulaire**

La **signature** d'une fonction est le nom d'une fonction et la liste des types des paramètres. Une **déclaration** de fonction est une fonction sans implémentation (sans le bloc d'instruction, qui est remplacé par un point-virgule final). La définition d'une fonction est la fonction complète avec l’implémentation.

<code>
void f(int);      // déclaration
void f(int) { ... }  // définition
</code>

Une déclaration ne sert qu'a "dire" (déclarer) au compilateur qu'un identifiant existe, alors qu'une définition explique à quoi correspond un identifiant (ce qu'il est, comment il est définit).

Une même fonction peut avoir plusieurs déclarations, mais ne peut avoir qu'une seule définition (ODR, //One Definition Rule//).

A noter la similarite entre la syntaxe pour declarer une fonction et l'initialisation d'une variable avec des parentheses :

<code cpp>
int x(int);  // un type = declaration d'une fonction
int y(123);  // une valeur = definition d'une variable
int z();     // rien = fonction ou variable ?
</code>

La derniere syntaxe correspond en fait a la declaration d'une fonction, qui ne prend aucun parametre et retourne un entier. Le probleme est que cette syntaxe est regulierement confondue avec une initialisation par defaut d'une variable. Ce qui produira bien sur une erreur de compilation lorsque vous esserez d'utiliser une fonction comme si c'etait une variable.
</note>

Les paramètres en entrées et sortie seront détaillés ensuite. S'il n'y a pas d'information à passer, il est possible de ne pas avoir de paramètre en entrée et d'utiliser ''void'' comme paramètre de sortie (qui signifie "pas d'information" dans ce cas).

<code>
void NOM_FONCTION () {
    INSTRUCTIONS
}
</code>

Le nom de la fonction suit les mêmes règles que les noms des variables :

  * lettres, chiffres et le caractère ''_''
  * majuscule ou minuscule
  * ne commence pas par un chiffre
  * (ne commence pas par ''_'' : ceci n'est pas une interdiction du langage, un nom peut commencer par ''_'', mais c'est généralement réservé à la STL. Donc a éviter en général)

Par exemple :

<code>
void f() {}
void g() {}
void h() {}
void foo() {}
void bar() {}

void une_fonction_quelconque() {}
void UneAutreFonction() {}

void uNeFoNcTiOnPaSlIsIbLe() {}

void f1() {}
void f2() {}
</code>

Note : dans ces codes, ''{}'' indique un bloc d'instructions... sans instructions. Donc ces fonctions ne font rien, ce sont juste des exemples pour présenter la syntaxe.


Tous ces noms de fonction sont valides. La première liste de noms ("f", "g", etc. jusqu’à "bar") ne sont pas explicite, donc impossible de savoir ce qu'elles font sans lire leur code. Ce sont donc de mauvais noms en général (mais utilisé souvent comme des codes d'explication, pour nommer des fonctions qui n'ont pas d'autre utilité que d'expliquer quelque chose ou pour lequel le nom importe peu. Ne pas utiliser dans des codes réels).

Les 2 fonctions suivantes "une_fonction_quelconque" et "UneAutreFonction" ont des noms plus explicite. Notez l'utilisation des ''_'' et majuscule pour faciliter la lecture. Forme à préférer dans vos codes, avec des noms explicites.

La suivante est un exemple de fonction valide, mais peu lisible à cause de la mauvaise utilisation des majuscules.

Les 2 dernières utilisent un nom avec un numéro. C'est également un exemple de nom peu explicite, à éviter dans un code réel.

Exemple de noms invalides :

<code>
void 123f() {}          // commence par un chiffre
void une&fonction() {}  // caractère illégal
</code>

===== Appel de fonction =====

Pour appeler une fonction qui ne prend pas d'arguments et qui ne retourne pas d'information, vous pouvez l'appeler directement en utilisant son nom et des parentheses vides. Vous avez utilise cette syntaxe de nombreuses fois, par exemple pour la fonction ''size'' de ''std::string'' ou la fonction ''clear'' de ''std::vector''.

<code>
nom_fonction();
</code>

Par exemple :

<code cpp>
#include <iostream>

void f() {
    std::cout << "hello, world" << std::endl;
}

int main() {
    f();
}
</code>

affiche :

<code>
hello, world
</code>

Le compilateur lit le code dans l'ordre où il est écrit, donc, comme pour les variables, vous ne pouvez pas utiliser une fonction avant qu'elle ne soit définie. Le code suivant est donc invalide, même si la fonction existe :

<code cpp>
int main() {
    f();
}

void f() {}
</code>

affiche le message d'erreur suivant :

<code>
main.cpp:2:5: error: use of undeclared identifier 'f'
    f();
    ^
</code>

Ce qui signifie "utilisation d'un identifiant non déclaré" (sous entendant "non déclaré dans le code qui précède la ligne de code qui utilise cet identifiant).

Il est possible de déclarer une fonction et de la définir plus tard, en utilisant une déclaration anticipée (//forward declaration//), vous verrez cela dans la suite de ce cours.

Vous pouvez appeler plusieurs fois une même fonction (comme vu dans le second code) ou appeler une fonction depuis une autre fonction. (C'est d'ailleurs ce que vous faites quand vous appeler une fonction quelconque depuis la fonction ''main'').

<code cpp>
void g() {}

void f() { g(); } // f appelle g

int main() {
    f();
    f();  // plusieurs appels de la fonction f
}
</code>

Une fonction qui est définie dans une autre fonction est appelée une fonction imbriquée (//nested function//). En C++, à part le cas particulier des fonctions lambdas que vous verrez ensuite, une fonction ne peut pas être imbriquée dans une autre fonction.

<code cpp>
void f() { 
    void g(); // déclaration d'une fonction imbriquée : erreur
}
</code>

Les fonctions doivent être déclarées dans un espace de noms - qui sera vu dans le chapitre sur la création de bibliothèques - ou dans une classe - qui sera vu dans la partie programmation orientée objet. Quand vous déclarer une fonction directement en dehors de la fonction ''main'', comme vous le faites depuis le début de ce chapitre, vous les déclarez en fait dans un espace de noms global et anonyme. Cela sera également vu bientôt.

Un cas particulier de fonction qui appelle une fonction : il est possible d’écrire une fonction qui s'appelle elle même. Le code suivant est valide (tout au moins en termes de syntaxe) :

<code cpp>
void f() {
    f();  // f appelle f
}
</code>

Un code qui s'appelle lui-même est appelle un code récursif. C'est une approche intéressante pour résoudre de très nombreuses problématiques. Vous verrez dans les exercices et compléments quelques exemples d'algorithmes récursifs.

Cependant, le code précédent est trop simpliste et produira un crash a l’exécution du programme. La raison est très simple : la fonction f va appeler la fonction f qui va appeler la fonction f qui va appeler la fonction f... et ainsi de suite, a l'infini. Ou plus précisément, puisqu'un ordinateur n'a pas des capacités infinies, jusqu’à ce que les ressources allouées au programme soient toutes utilisées et que le programme crash.


===== Variable locale à une fonction =====

Un petit rappel sur les notions de portée et de durée de vie. Pour le moment, vous n'avez utilise que des variables locales à une fonction. Une telle fonction est déclarée dans un bloc dans une fonction (dans la fonction ''main'' jusque maintenant, mais c'est valide pour n'importe quelle fonction que vous pouvez créer). Cette variable est utilisable a partir du moment ou elle est définie et jusqu’à la fin du bloc.

<code cpp>
{
    int i {};  // définition d'une variable i
    ...
}              // fin de portée de la variable i
</code>

Les notions de portée (//scope//) et durée de vie (//lifetime//) sont très proches (pour le moment) :

  * la portée est quand la variable est utilisable dans le code ;
  * la durée de vie est quand la variable existe en mémoire de l'ordinateur.

Pour des variables locales, la portée et la durée de vie d'une variable sont les mêmes, mais vous verrez qu'il existe une autre catégorie de variables (les variables dynamiques), dont la portée et la durée de vie peuvent être différentes.

<note>**Variables globales**

Il existe en fait une troisième catégorie : les variables globales, qui ont généralement une portée globale (accessible n'importe ou dans le programme - c'est par exemple le cas de ''std::cout'') et une durée de vie permanente (création au lancement du programme et destruction lorsque le programme se termine).

L'utilisation des variables globales est problématique en termes de conception et d'utilisation, elles doivent être évitée au maximum. C'est a dire toujours, sauf quand vous avez de très bonnes justifications pour ne pas respecter cette régle.
</note>

Pour terminer ce rappel, les variables sont accessible dans le même bloc où elles sont définies et dans les blocs enfants, mais pas dans les blocs parents ou les blocs qui n'ont pas de relation hiérarchique.

<code>
int main() {
    {
        int i {};
        {
            std::cout << i << std::endl; // ok, bloc enfant
        }
        std::cout << i << std::endl;     // ok, même bloc
    }
    std::cout << i << std::endl;         // erreur, bloc parent
    {
        std::cout << i << std::endl;     // erreur, bloc indépendant
    }
}
</code>

Cette notion est très importante à comprendre lorsque vous appelez des fonctions : les variables locales dans ces fonctions sont détruites à la fin de la fonction. Si vous appelez plusieurs fois une fonction, les variables locales sont créées puis détruites à chaque appel. Il n'est pas possible de transmettre des informations entre les différents appels via des variables locales.

Considérez par exemple le code suivant.

<code>
#include <iostream>

void f() {
   int i;   // volontairement non initialisée
   std::cout << i << std::endl;
   i = 123;
   std::cout << i << std::endl;
}

int main() {
    f();
    f();
}
</code>

Si vous dérouler les appels de fonction, vous pourriez penser que le code sera le suivant (en copiant-collant le code de la fonction ''f'' a la place des appels de fonction) :

<code>
#include <iostream>
int main() {
   int i;   // volontairement non initialisée
   std::cout << i << std::endl;
   i = 123;
   std::cout << i << std::endl;
   
   // int i;
   std::cout << i << std::endl;
   i = 123;
   std::cout << i << std::endl;
}
</code>

Et donc vous pouvez vous attendre a ce que le programme affiche :

<code>
xxx // une valeur aléatoire quelconque, puisque i n'est pas initialise
123
123
123
</code>

Mais il faut bien comprendre que ce qui se passe en réalité est que chaque appel de fonction va créer une nouvelle variable locale puis la détruire. Donc même si le nom est le même, c'est comme si la variable était différente. Un code plus correct serait celui ci :

<code>
#include <iostream>
int main() {
   int i_1;   // volontairement non initialisée
   std::cout << i_1 << std::endl;
   i_1 = 123;
   std::cout << i_1 << std::endl;
   
   int i_2;   // volontairement non initialisée
   std::cout << i_2 << std::endl;
   i_2 = 123;
   std::cout << i_2 << std::endl;
}
</code>

Avec ce code, vous comprenez bien qu'il n'y a pas de raison que les deux appels a la fonction f possèdent la même valeur dans ''i''. Faites bien attention a cela.

<note>**Garantie des comportements**

En fait, si vous exécutez le code proposé, vous obtiendrez probablement :

<code>
0
123
123
123
</code>

La raison est que le compilateur peut optimiser au mieux le programme génère a partir de votre code et peut donc utiliser le même emplacement en mémoire entre les deux appels de fonction, ce qui donnera l'impression que la valeur de ''i'' est transmise.

Mais bien sur, sur un code plus complexe, le comportement pourra être différent. La norme C++ ne garantie pas que le comportement du programme sera de toujours afficher une valeur aléatoire si la variable n'est pas initialisée ou d'afficher une valeur différente entre deux appels de fonction.

Il est parfois possible d’écrire des codes de tests, pour comprendre le comportement d'un code. Mais cela ne permet pas de savoir si c'est un comportement spécifique a votre compilateur ou si c'est un comportement garantie par la norme C++.

Il est préférable d’écrire du code dont le comportement est garantie par la norme (et donc éviter par exemple les "undefined behavior", même s'ils peuvent parfois avoir le comportement attendu), pour avoir un code le plus portable possible. (Même si vous n’êtes pas a l’abri qu'un compilateur particulier ne respecte pas la norme C++ sur certains points, cela peut arriver. Mais c'est suffisamment rare, surtout pour les syntaxes de bases vues dans ce cours).
</note>

^ [[validation_motifs|Chapitre précédent]] ^ [[programmez_avec_le_langage_c|Sommaire principal]] ^ [[parametres_arguments|Chapitre suivant]] ^