Premiers pas avec CMake et la compilation de KDE4

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, des projets KDevelop, XCode ou Visual Studio.

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

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

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 que automake ou unsermake :

• CMake est développé indépendamment de KDE et peut être utilisé dans d'autres projets que celui-ci ;
• la durée de compilation est plus faible, notamment grâce à la non-utilisation de libtools ;
• le fichier CMake est plus facile à écrire.

III-A. Télécharger et installer CMake▲

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

III-B. Lancer CMake▲

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

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

$ cmake ../kdelibs -GKDevelop3

III-C. Vaiables d'environnement▲

III-D. Aller plus loin▲

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)

find_library(X11_XTest_LIB Xtst ${X11_LIB_SEARCH_PATH})

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 bibliothèques dans CMakeList.txt. Le même fichier source peut être utilisé dans différents projets, il sera compilé pour chacun des projets. La part la plus importante du langage de CMake est les variables :

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

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 diverses 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.

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 bibliothèques de développement qui sont utilisées dans votre programme. Par exemple, si vous voulez utiliser libtidy-devel, le nom de fichier de la bibliothèque 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 fonctionnera pas.

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 bibliothèques de KDE installent également des modules dans /share/apps/cmake/modules/. Les fichiers s'y trouvant seront utilisés en priorité, avant ceux du dossier des modules globaux au système. 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.

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

$ cd src/mykooltool/$ am2cmake --kde4

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

Il se peut que vous deviez :

• 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érifications de type 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 sont ceux qui doivent être convertis manuellement pour CMake.

Merci à Thibaut Cuvelier et Claude Leloup pour leur relecture !