Installer et configurer une bibliothèque dans un projet

Les bibliothèques peuvent être comparées à des boites à outils. En effet, celles-ci apportent des fonctionnalités supplémentaires que le programmeur va pouvoir utiliser pour réaliser son projet. Imaginons que vous souhaitiez afficher une image dans une fenêtre. Le langage C, ou même C++ en lui-même ne propose rien pour faire une telle chose. Sachant que d'autres programmeurs ont déjà travaillé dessus, il est préférable de réutiliser ce qu'ils ont fait plutôt que de perdre du temps à le refaire. Pour cela, une bibliothèque qui se spécialise dans l'affichage d'images nous fournira toutes les fonctions nécessaires pour lire une image et pour l'afficher. Au lieu d'effectuer les appels aux fonctions bas niveau comme fopen(), fread(), ou autres, il suffira d'appeler une fonction de la bibliothèque, qui lira directement le fichier sans même que l'on se préoccupe des détails.

L'autre bonne nouvelle, c'est que ce que vous voulez faire a sûrement été déjà réalisé et donc, qu'il existe une bibliothèque répondant à vos besoins.

Revoyons rapidement les étapes de la création d'un programme :

Les fichiers source (les fichiers .c/.cpp/…) sont d'abord lus par le préprocesseur qui ne s'occupera que de traiter les commandes #XXX (#define, #ifdef…) pour produire un fichier source où ces directives ont été exécutées.

Ensuite, le compilateur transforme le source en un fichier intermédiaire (.o/.obj), compilé, mais qui n'est pas exécutable. Le langage utilisé est spécifique au compilateur. Pour valider votre code, le compilateur a besoin de connaître tous les symboles que vous utilisez. Le nom d'une fonction, autant que le nom d'une variable sont des symboles. Si vous utilisez une fonction qui est inconnue, il va vous le faire savoir avec un message d'erreur. En effet, pour lui, si la fonction est inconnue, il est incapable de traiter le symbole et donc, incapable de compiler le code. En C et C++, les fichiers .h/.hpp permettent de déclarer les symboles au compilateur et donc de lui dire : « cette fonction existe, voici les paramètres qu'elles acceptent, le type de valeur qu'elle retourne ».

Finalement, l'éditeur de liens prend les fichiers objets du programme pour les assembler et produire un exécutable. Ici, le code de toutes les fonctions doit être présent et sera inséré dans le programme. Si le code des fonctions que vous utilisez n'est pas dans vos fichiers objets, il va les chercher dans les bibliothèques que vous lui aurez indiquées. S'il ne trouve toujours pas la fonction, il ne peut pas continuer (le programme est incomplet) et l'édition des liens échouera.

Ainsi, pour pouvoir rajouter une bibliothèque à un projet, il faut :

• les fichiers d'entêtes (.h/.hpp) décrivant les fonctions utilisables pour le compilateur ;
• les fichiers de code compilé de la bibliothèque (.a/.so/.lib) pour l'éditeur de liens ;
• les fichiers pour l'exécution (.so/.dll).

La bibliothèque statique sera compilée avec le programme et directement intégrée dans l'exécutable final. Il n'y aura donc pas besoin de .so/.dll lors de l'exécution. L'avantage de la compilation statique est de rendre l'exécutable indépendant (il peut fonctionner sur n'importe quelle plateforme compatible, sans pour autant nécessiter l'installation de la bibliothèque), toutefois, il est, de par ce fait, plus lourd et vous ne pourrez pas mettre à jour les bibliothèques sur lesquelles il repose, sans le recompiler.

La bibliothèque dynamique fera que l'exécutable ira chercher les fonctions à exécuter dans des fichiers séparés (.so/.dll). L'exécutable sera plus léger et les bibliothèques pourront être mises à jour sans recompiler l'exécutable. De plus, une bibliothèque peut être chargée à la volée (durant l'exécution d'un programme) et ainsi fournir des fonctionnalités en plus, si elle est présente : les systèmes de modules ou ajouts sont souvent implémentés sous la forme de bibliothèques chargées lorsque nécessaires.

I-D-1. Organisation des fichiers▲

I-D-2. S'y retrouver dans les fichiers à télécharger▲

Afin que votre projet soit organisé et facilement distribuable, nous allons créer les dossiers suivants :

• lib : pour les fichiers des bibliothèques (.a/.so/.lib) ;
• include : pour les fichiers d'entêtes (notamment, ceux de la SDL) ;
• src : pour vos fichiers de code source.

Cette organisation permet d'éviter que vous ayez à installer (ou faire installer) la bibliothèque sur chacun des postes que vous utiliserez : elle est intégrée dans le projet. De plus, l'installation de la bibliothèque dans les répertoires des éditeurs n'est pas recommandée (même si certains sites font de cette façon :(), notamment, car vous forcez l'utilisateur recevant votre projet à installer lui-même la bibliothèque et à reconfigurer le projet, mais aussi, parce que cela entraîne des oublis. D'autant plus que sous Windows, il n'y a pas d'emplacement déterminé pour mettre les bibliothèques.

Ce qui nous donne l'arborescence suivante :

/
include
– Nom bibliothèque 1
– – …
– – tous les fichiers .h de la première bibliothèque
– – …
– Nom bibliothèque 2
– – …
– – tous les fichiers .h de la deuxième bibliothèque
– – …
– …
lib
– libXXX.so (dynamique) ou libXXX.a (statique) (pour Linux)
– libXXX.lib (pour Windows) ou libXXX*.a (pour MinGW)
– …
src
– main.c
XXX.dll (pour Windows)
les fichiers de projets (.cbp (pour Code::Blocks), .sln (pour Visual Studio)…)

Lorsque vous voulez distribuer le code de votre projet, il suffit de compresser le dossier et c'est tout. L'utilisateur à qui vous donnez votre projet n'aura qu'à décompresser le fichier et il pourra directement l'utiliser.

La mise en place d'une bibliothèque se fait en trois étapes :

• spécification d'un nouveau répertoire de fichiers d'entêtes pour le compilateur ;
• spécification d'un nouveau répertoire de fichiers de bibliothèques pour l'éditeur de liens ;
• spécification des fichiers de bibliothèques à utiliser.

II-B-1. GCC/G++ en ligne de commande▲

II-B-2. Code::Blocks▲

Dans votre projet Code::Blocks, dans les options de compilation (« build options ») :

Ensuite, pensez bien à sélectionner votre projet dans son intégralité et non pas l'une des cibles (par défaut « debug » ou « release »), cela permettra d'appliquer la configuration à l'intégralité du projet et de ne pas avoir de problème lors d'un changement de cible :

Maintenant, vous pouvez ajouter le répertoire des fichiers d'entêtes dans l'onglet « répertoires de recherche » (« search directories »), sous onglet « compilateur » (« compiler »). Cliquez sur le bouton « ajouter » (« Add ») et tapez : ./include puis « OK ».

Il faut maintenant faire de même pour le répertoire des bibliothèques, dans le sous-onglet « Éditeur de liens » (« Linker »), ajoutez ./lib :

Finalement, vous pouvez rajouter les bibliothèques, dans l'onglet « paramètres de l'éditeur de liens » (« Linker settings ») :

libXXX.so est un exemple. Vous devez rajouter les noms des fichiers présents dans le dossier lib.

Votre projet est finalement prêt pour utiliser la bibliothèque.

II-B-3. Visual Studio▲

Dans les propriétés du projet « Projet » → « Propriétés » (« Project » → « Properties ») :

Cliquez sur « Propriétés de la configuration » (« Configuration Properties ») afin de déplier l'arborescence et de déverrouiller les deux options en haut de la fenêtre. Sélectionnez la configuration « Toutes plateformes » (« All Configurations ») afin que vos modifications s'appliquent sur la cible « Debug » et la cible « Release » :

Dans le menu C/C++, il est conseillé de changer l'entrée « Niveau d'avertissement » (« Warning Level ») du niveau 3 au niveau 4 afin que le compilateur vous renvoie le maximum d'informations sur votre code et ses possibles erreurs.

Dans le menu C/C++, rajoutez ./include pour l'entrée « Répertoires d'inclusion supplémentaires » (« Additional Include Directories ») :

Dans le menu « Éditeur de liens » (« Linker »), ajoutez ./lib pour l'entrée « Répertoires de bibliothèques supplémentaires » (« Additional Library Directories ») :

Dans le sous-menu « Entrée » (« Input »), pour l'entrée « Dépendances supplémentaires » (« Additional Dependencies »), insérez « libXXX.lib » :

libXXX.lib est un exemple. Vous devez rajouter les noms des fichiers présents dans le dossier lib.

Pour valider chaque modification des propriétés, cliquez sur le bouton « Appliquer » (« Apply »).

Afin que vous puissiez copier votre projet d'un répertoire à un autre et que Visual Studio continue de trouver les fichiers, il est recommandé d'utiliser des chemins relatifs (par exemple : ./lib et ./include).

Vous devriez maintenant pouvoir compiler le projet utilisant la bibliothèque.

II-B-4. Xcode▲

II-B-5. Qt Creator (QMake)▲

INCLUDEPATH += ./include

LIBS += -L./lib

LIBS += -lXXX

II-B-6. Eclipse CDT▲

Dans Eclipse CDT, vous pouvez accéder aux propriétés du projet en passant par le menu « Projet » → « Propriétés » (« Project » → « Properties »), ou en faisant un clic droit sur votre projet puis « Propriétés » (« Properties ») :

Afin de modifier toutes les configurations en une seule fois, vous devez choisir la configuration « Toutes les configurations » (« All configurations ») :

Ensuite, vous devez accéder par l'arborescence sur la gauche à « Compilation C/C++ » → « Paramètres » (« C/C++ Build » → « Settings »).

Dans l'onglet « Paramètrages des outils » (« Tool Settings »), vous devez sélectionner « Entêtes » (« Includes ») pour ajouter le dossier des fichiers d'entêtes :

La configuration du dossier des bibliothèques et des bibliothèques à inclure dans votre projet se trouve dans l'entrée « Bibliothèques » (« Libraries ») :

Afin d'obtenir le chemin sous la forme « "${workspace_loc:/${ProjName}/lib}" » il suffit de cliquer sur le bouton « Workspace » lors de l'ajout d'un répertoire et de sélectionner le répertoire voulu du workspace comme le montrent ces captures d'écrans :

Pour finir, il suffit de valider toutes les fenêtres de configuration et votre projet est prêt.

II-B-7. CMake▲

FindPackage(XXX)

include_directories(./include)

link_directories(./lib)

target_link_libraries(
    executable
    XXX)

II-B-8. Autotools▲

AC_CHECK_LIB([XXX], [functionXXX], [AC_SUBST(LIBDL,-lXXX)])

AC_SEARCH_LIBS(functionXXX, XXX, [], [ 
    AC_MSG_ERROR([XXX est introuvable]) 
])

exec_CFLAGS=-I./include

exec_CPPFLAGS=-I./include

exec_LDADD=-L./lib -lXXX

L'erreur « Implicit declaration of function… » apparaît lorsque vous n'avez pas rajouté le fichier d'entêtes dans votre code source à l'aide d'un #include. En effet, comme tout autre programme, il faut inclure le fichier d'entêtes dans le code pour avoir accès aux fonctions (sinon, le compilateur ne connaît pas ces symboles).

L'erreur « undefined reference » (référence indéfinie) indique que l'éditeur de liens ne trouve pas une fonction. Cela arrive si :

• vous n'avez pas ajouté la bibliothèque contenant la fonction mentionnée par l’éditeur de lien au projet (ou il manque une autre bibliothèque, Google pourra vous aider à trouver de laquelle dont il s'agit, en recherchant « undefined reference le_nom_de_la_fonction ») ;
• si le fichier de la bibliothèque n'est pas trouvé ou qu'il n'est pas lu (il n'est pas lu, lorsqu'il n'est pas compatible avec votre compilateur).