Regrouper les variables globales dans un seul fichier header en C

Mise à jour du 1er juillet 2014 : je viens de publier un article expliquant pourquoi la technique expliquée ci-dessous est mauvaise. Je vous déconseille de l’utiliser. Lisez *ici*  pourquoi.

On répète très souvent dans les cours de langage C qu’il est mal d’utiliser des variables globales. Je ne suis pas là pour débattre de ce sujet ; chacun se fera son avis et aura ses raisons si ce n’est pas déjà fait. Il existe néanmoins des cas où il est impossible de ne pas utiliser de telles variables : dans des routines d’interruption de micro-contrôleur par exemple. Elles ne prennent pas de paramètre et ne renvoient rien. Si vous voulez modifier et sauvegarder des données d’une exécution à l’autre et que cette information soit accessible hors de cette routine, vous n’aurez pas d’autre solution que d’utiliser des variables globales. Comme par hasard, j’ai découvert la technique dont je viens vous parler aujourd’hui au cours d’un projet sur micro-contrôleur PIC de Microchip.

Quand plusieurs modules = fichiers partagent des variables globales, on déclare les variables « normalement » dans l’un des fichiers sources et on les déclare avec le mot clé extern dans les autres. C’est la méthode offrant la gestion la plus fine du partage des variables puisqu’on ne déclarera avec extern que les variables nécessaires dans le fichier courant. On évite ainsi de rendre visible dans un module une variable inutile, qu’on pourrait modifier par erreur. Cette technique induit une certaine redondance et une dispersion des déclarations ; si vous avez 10 fichiers utilisant un tableau d’entiers et que vous souhaitez modifier la taille de ce tableau, il faut modifier la déclaration dans les 10 fichiers, avec le risque d’en oublier ou de se tromper. Vous pouvez légitimement avoir envie de regrouper les déclarations dans un fichier d’en-tête que vous incluriez là où vous en avez besoin.

Il faut quand même être franc : si vous souhaitez garder la finesse des déclarations externes, il est peu probable qu’un seul fichier d’en-tête suffise. Cela signifierait que tous les fichiers utilisent toutes les variables globales considérées. Plusieurs cas de figures:

1. ô magie vous êtes dans ce cas et un fichier convient !
2. ô mon dieu vous êtes un gros bourrin et vous mettez toutes les variables globales du programme dans un seul fichier !
3. ô compromis vous utilisez quelques fichiers d’inclusion, en regroupant les variables par thème, en perdant un peu en finesse mais pas trop.
4. ô ça ne le fait pas et vous restez à la méthode de base.

La première idée est de regrouper uniquement les déclarations externes dans un fichier d’en-tête et de laisser les déclarations normales dans l’un des fichiers sources. On peut faire encore mieux en mettant toutes les déclarations dans le même fichier et un #define dans l’un des fichiers sources. Petit exemple de principe :

Fichier ressources.h : il regroupe les déclarations normales et externes des variables globales.

#ifndef RESSOURCES_H
#define RESSOURCES_H

#ifdef VAR_GLOBALES
    int VAR_1=1;
    char VAR_2[]="deux";
#else
    extern int VAR_1;
    extern char VAR_2[];
#endif
#endif

Fichier main.c : on n’y connait pas les variables globales, les en-têtes des modules donnent la connaissance des fonctions d’affichage.

#include "afficherInt.h"
#include "afficherString.h"

int main(void)
{
    afficherInt();
    afficherString();
    return 0;
}

Module 1 : fichier afficherInt.c : ce module contiendra la déclaration normales des variables grâce au #define qui va bien. Aucun autre module ne doit contenir le même #define sous peine de déclaration multiple des variables.

 // La ligne importante est la suivante /!\
#define VAR_GLOBALES
#include "ressources.h"
#include  

void afficherInt(void)
{
    printf("VAR_1 = %d\n",VAR_1);
}

En-tête : fichier afficherInt.h

#ifndef AFFICHER_INT_H
#define AFFICHER_INT_H
void afficherInt(void);
#endif

Module 2 : fichier afficherString.c : les variables y seront externes

#include "ressources.h"
#include 

void afficherString(void)
{
    printf("VAR_2 = %s\n",VAR_2);
}

En-tête : fichier afficherString.h

#ifndef AFFICHER_STRING_H
#define AFFICHER_STRING_H
void afficherString(void);
#endif