Development/Tutorials/CMake (fr)

Introduction

CMake lit des fichiers de script et produit des fichiers natifs pour la plateforme sur laquelle il a été lancé. Il peut créer des Makefile GNU, ou des projets KDevelop, XCode ou Visual Studio.

CMake est un logiciel libre sous license BSD. Il est développé par Kitware Inc..

Vosu trouverez plus d'informations relatives à CMake sur la page principale sur CMake de ce site.

Pourquoi utiliser CMake ?

CMake est un outil officiel de KDE 4, suite à un choix effectué en Mars 2006, principalement pour ses qualités techniques par rapport aux précédents outils de KDE, tels automake ou unsermake :

• CMake est développé indépendemment de KDE , et peut être utilisé dans d'autres projets que celui-ci.
• La durée de compilation est plus courte, notemment grâce à la non-utilisation de libtools
• Le build des fichiers est plus facile à écrire

Comment compiler KDE avec CMake ?

Télécharger et installer CMake

Linux, BSD, et autres systèmes Unix

Cliquez ici pour télécharger la dernière version de CMake.

Une fois le téléchargement terminé, désarchivez et compilez-le :

$ mkdir cmake-build
$ cd cmake-build
$ ../bootstrap
$ make
$ make install

Par défaut, CMake sera installé dans /usr/local, alors assurez-vous d'avoir /usr/local/bin dans votre répertoire d'exécution ($PATH). Pour changer ce répertoire (exemple : /usr sous Debian), ajoutez l'option '--prefix=PATH' à la commande boostrap.

Lisez ces instructions si vous voulez utiliser la version en cours de dévloppement.

Windows

Cliquez ici pour télécharger la dernière version de CMake.

Une fois téléchargé, lancez l'installeur de CMake.

Lisez ces instructions si vous voulez utiliser la version en cours de dévloppement.

Lancer CMake

Linux, BSD, et autres systèmes Unix

Vous devez lancer CMake pour générer les ficheirs de build pour votre système. Les builds in-source et out-of-source sont supportés par CMake, mais actuellement, les builds in-sources sont empêchés par l'implémentation de KDE.

En supposant que vous avez kdelibs/ dans ~/src/kdelibs/ (utilisez $ locate kdelibs/ au besoin), utilisez ces commandes :

$ ls
kdelibs/
$ mkdir kdelibs-build
$ cd kdelibs-build
$ cmake ../kdelibs

Ceci générera les Makefiles pour construire kdelibs/ dans kdelibs-build/.

Windows

Vous devez lancer CMake pour générer les ficheirs de build pour votre système. Les builds in-source et out-of-source sont supportés par CMake, mais actuellement, les builds in-sources sont empêchés par l'implémentation de KDE.

En supposant que vous avez kdelibs\ dans c:\daten\kde4, utilisez ces commandes : So, let's say you have kdelibs\ in c:\daten\kde4, then do the following:

c:\daten\kde4> cd kdelibs\win
c:\daten\kde4> cmake
c:\daten\kde4> make 
c:\daten\kde4> make install
c:\daten\kde4> cd ..
c:\daten\kde4> mkdir kdelibs-build
c:\daten\kde4> cd kdelibs-build
c:\daten\kde4\kdelibs-build> cmake ..\kdelibs

Ceci générera les Makefiles pour construire kdelibs\ dans kdelibs-build\. Lisez la page KDE sous Windows pour plus d'informations sur la compilation de KDE sous Windows.

Fichies de projet KDevelop 3

Si vous préférez utiliser des fichiers de projet pour KDevelop 3 (qui sont simplement des Makefiles accompagnés de quelques données pour KDevelop), lancez-le de cette façon :

$ cmake ../kdelibs -GKDevelop3

Utilisez 'cmake -h' pour savoir quels générateurs CMake support ainsi que ses autres options.

CMake et Qt4

Pour trouver le réperoire de Qt4, CMake cherche qmake dans le répertoire d'exécution. CMake n'utilisez pas la variable d'environnement QTDIR. Assurez-vous d'abord que qmake se trouve dans le répertoire d'exécution qui vous utilisez.

Aller plus loin

Une fois que CMake a terminé, il va créer un fichier nommé "CMakeCache.txt". Ce fichier contient tous les paramètres que CMake a détecté sur votre système. si vous voulez lancer CMake avec un autre générateur ou que vous voulez que CMake refasse la détection, supprimez ce fichier.

Si CMake ne trouve pas quelque chose, mais que vous savez où il est, vous pouvez lui dire manuellement où ceci se trouve. CMake utilise des variables pour stocker ses informations. Ces variables sont situées dans le fichier mentionné ci-dessus : CMakeCache.txt. Il existe trois manières de configurer ces variables :

• donner à CMake la valeur correcte via la ligne de commande : cmake ../kdelibs -DNOM_DE_LA_VARIABLE=valeur
• utiliser ccmake, qui fourni un GUI basé sur curse pour éditer les variables CMake (lancez : ccmake ../kdelibs)
• éditer directement le fichier CMakeCache.txt (déconseillé)

Vous pouvez lancer "ccmake ../kdelibs" au moins une fois, dans le but d'avoir une idée des variables que CMake utilise. Appuyez sur "T" pour voir également les variables "avancées".

Variables en ligne de commande

Quelques variables en ligne de commande de cmake que vous pouvez être amené(e) à modifier :

• CMAKE_INSTALL_PREFIX: cmake ../kdelibs -DCMAKE_INSTALL_PREFIX=/opt/kde4 qui est l'équivalent de ./configure --prefix=/opt/kde4
• CMAKE_BUILD_TYPE: pour choisir le type de build que vous désirez. Vous pouvez choisir entre "debugfull", "Debug", "Profile", "RelWithDebInfo" et "Release". Le build par défaut est "RelWithDebInfo". Référez-vous à la page sur les types de builds de CMake pour plus d'informations.
• KDE4_BUILD_TESTS=ON: créer des Makefile avec des programmes de test du build et fourni aussi des cibles 'test'.
• KDE4_TEST_OUTPUT=xml: Tests utilisant la le framework QTestLib pour créer des fichiers de log en XML.
• KDE4_DISABLE_MULTIMEDIA=ON: Construit KDE sans aucun support multimédia (audio et vidéo).
• BUILD_foo=OFF: désactive les build pour le projet dans le répertoire 'foo'.
• WITH_foo: il y a différentes options, par exemple WITH_CUPS ou WITH_Jasper. Si vous voulez les désactiver, cmake n'ira rien chercher dans ce paquet. Si ils sont activés, cmake tentera de les trouver. Si il n'y arrive pas, ajustez les variables comme décrit plus haut.

Vaiables d'environnement

Si vous avez des heades et des bibliothèques installés dans des chemins non-standards, que cmake ne peut trouver, modifiez les variables d'environnement suivantes. Elles peuvent être très utiles, par exemple si vous voulez installer kdesupport dans ~/install/kdesupport. Voci quelques conventions de nommage, qui ne marcherotn pas comme argument dans avec la command cmake :

• CMAKE_INCLUDE_PATH, par exemple : CMAKE_INCLUDE_PATH=/sw/include
• CMAKE_LIBRARY_PATH, par exemple : CMAKE_LIBRARY_PATH=/sw/lib
• CMAKE_PROGRAM_PATH, par exemple : CMAKE_LIBRARY_PATH=/sw/bin

With CMake 2.6.0 and above the same effect can be achieved by setting just one variable:

• CMAKE_PREFIX_PATH, eg. export CMAKE_PREFIX_PATH=/sw

Pour plus d'informations, vous pouvez consulter la page de ce wiki sur CMake

Aller plus loin

Si cmake finit avec "Generating done" et c'est qu'il n'y a eu aucune erreur, alors que si il finit avec "Configuring done" c'est qu'il y en a eu, et que vous devez les corriger. Une fois que cmake a fini de s'exécuter, lancez votre outil de build (par exemple make, KDevelop, XCode, ou MSVC), compilez-le, et attentez que ce soit fini. A ce moment, lancez "make install".

Si vous avez une erreur dans ce genre :

CMake Error: This project requires some variables to be set,
and cmake can not find them.
Please set the following variables:
X11_XTest_LIB (ADVANCED)

il se peut qu'il vous manque une bibliothèque (ou toute autre dépendance). Pour savoir laquelle, cherchez dans cmake/modules directory pour savoir quelle variable cmake n'arrive pas à trouver. Dans l'exemple précédent, il s'agit de

find_library(X11_XTest_LIB Xtst ${X11_LIB_SEARCH_PATH})

Donc, la bibliothèque manquante est Xtst. Vous devez la trouver (peut-être en installant la bibliothèque libXtst-devel), et relancez cmake.

Utiliser CMake pour une petite application

Voici le plus simple CMakeLists.txt possible :

add_executable(hello main.cpp)

Il sert à créer un exécutable "hello" (ou "hello.exe" sous Windows") à partir du fichier source main.cpp. Vous pouvez mettre à la fois des fichiers C et C++ si besoin est. Vous pouvez également mettre différents exécutables et librairies dans CMakeList.txt. Le même fichier source peut être utilisé dans différents projets, et il sera compilé pour chacun des projets. La part la plus important du langage de CMake est les variables :

set( MY_SOURCES main.cpp widget.cpp)
message(STATUS "my sources: ${MY_SOURCES}")

Donc, utilisez la commande SET() pour définir la valeur d'une variable. Si vous mettez plus d'une chaîne de caractères, la variable sera une liste. Une liste est une liste de chaînes séparées par des virgules. Si vous voulez un seul élément, la variable n'aura que cet élément pour valeur. Pour avoir la valeur d'une variable, utilisez : ${NOM_DE_LA_VARIABLE}. Vous pouvez parcourir une liste en utilisant FOREACH() :

foreach(next_ITEM ${MY_SOURCES})
   message(STATUS "next item: ${next_ITEM}")
endforeach(next_ITEM ${MY_SOURCES})

Les commandes de CMake sont sensibles à la casse, de même que les noms de variables ou de paramètres.

Vous pouvez aussi tester divers choses :

if (UNIX)
   message(STATUS "This is UNIX (including OS X and CygWin)")
endif (UNIX)

if (MSVC)
   set(MY_SRCS ${MY_SRCS} winextra.cpp)
endif (MSVC)

Dans ce second exemple, on ajoute un élément dans une liste.

Dans le wiki de CMake, il y a également un tutoriel pour utiliser CMake dans la compilation de KDE4. Sa lecture est recommandée.

Utiliser CMake dans le cadre de KDE4

Voici un CMakeList.txt basique pour construire un petit projet KDE4 :

project( kde4project )
find_package( KDE4 REQUIRED )
include_directories( ${KDE4_INCLUDES} )

set( KDE4ProjectSources kde4mainapp.cpp someclass.cpp someotherclass.cpp )

kde4_add_executable( kde4project ${KDE4ProjectSources} )

target_link_libraries( kde4project ${KDE4_KDEUI_LIBS} ${KDE4_KPARTS_LIBS} )

install( TARGETS kde4project  ${INSTALL_TARGETS_DEFAULT_ARGS} )

target_link_libraries contient les librairies de développement qui sont utilisées dans votre programme. Par exemple, si vous voulez utiliser libtidy-devel, le nom de fichier de la librairie est probablement /usr/local/lib/libtidy.a. Vous pouvez alors ajouter -ltidy à la commande d'appel de gcc. Dans ce cas, ajoutez tidy dans target_link_libraries. Si possible, utilisez les variables et macros prédéfinies, telles que ${KDE4_KDEUI_LIBS}.

install (TARGETS est l'endroit où les fichiers obtenus seront installés. Si vous n'avez pas cette ligne, make install ne sera pas possible.

Les variables, macros, et autres informations utiles spécifiques à KDE peuvent être trouvées sur la page des modules pour CMake.

Scripts pour CMake

CMake peut être étendu avec des scripts. CMake a par défaut un certain nombre de scripts ; sous Unix ils sont installés dans /usr/local/share/CMake/Modules/. Les librairies de KDE installent également des modules dans share/apps/cmake/modules/. Les fichiers s'y trouvant seront utilisé en priorité, devant ceux du dossier des modules globaux au système. Pour plus d'informations sur comment détecter les paquets qui se trouvent dans les fichiers FindFOO.cmake, cliquez ici. Vous pouvez également écrire des macros pour CMake. Elles sont puissantes et peuvent être requises pour construire certains logiciels, mais elles ne sont pas faites pour remplacer un langage de programmation.

Convertir des logiciels de KDE basés sur autotools vers CMake

Dans kdesdk/cmake/ vous pouvez trouver le script am2cmake. Il s'agit d'un script Ruby, il est donc requis que Ruby soit installé sur votre système. Lancez am2cmake dans le dossier principal de vos sources :

$ cd src/mykooltool/
$ am2cmake --kde4

N'oubliez pas l'option "--kde4", car sinon, les fichiers générés ne seront pas adaptés à un logiciel pour KDE. Les fichiers convertis son 'susceptibles' de fonctionner tels quels, mais les projets complexes requierent quelques modifications supplémentaires.

Il se peut que vous ayez à :

• ajouter des répertoires d'include en utilisant INCLUDE_DIRECTORIES()
• ajouter des bibliothèques de link en utilisant TARGET_LINK_LIBRARIES()
• ajouter des switch de compilation en utilisant ADD_DEFINITIONS()
• ajouter des vérification "configure" ; lisez comment effectuer des vérifications de la plateforme et comment trouver les logiciels déjà installés.
• un fichier AdditionalInfo.txt est créé. Il vous permettra de voir tous les *.in et *.in.in de votre projet. Les noms de fichier dans ce fichier sont ceux qui doivent être convertis manuellement pour CMake.
• take special care of former libtool convenience libraries. They are not supported by cmake, instead there will be a file ConvenienceLibs.cmake created. In this file you will find for every convenience lib a variable, which contains all source files of this convenience lib. For the targets which linked to this convenience lib, just add the variable to the sources.