Exemple CMake

Cet article utilise un exemple complet de projet C++ pour démontrer comment utiliser CMake afin de construire à partir de zéro un projet contenant à la fois des fichiers exécutables et des fichiers de bibliothèque.

Le projet d'exemple comprend un programme principal et une bibliothèque personnalisée, couvrant le cycle de vie complet d'une construction CMake.


Préparation du projet

Avant de commencer la construction, créez d'abord les fichiers du projet et comprenez la structure du projet.

Structure du projet

Le projet d'exemple comprend un fichier source de programme principal, un fichier source de bibliothèque et un fichier d'en-tête de bibliothèque. La structure des répertoires est la suivante :

MyProject/
├── CMakeLists.txt          # CMake 配置文件
├── src/
│   ├── main.cpp            # 主程序源文件
│   └── mylib.cpp           # 库源文件
└── include/
    └── mylib.h             # 库头文件
Fichier Objectif Description
CMakeLists.txt Fichier de configuration CMake Définit les règles de construction, les cibles et les dépendances du projet
src/main.cpp Fichier source du programme principal Contient la fonction main(), le point d'entrée du programme
src/mylib.cpp Fichier source de la bibliothèque Implémentation des fonctionnalités de la bibliothèque personnalisée
include/mylib.h Fichier d'en-tête de la bibliothèque Déclare l'interface publique de la bibliothèque que le programme principal doit inclure et utiliser

Fichier de configuration CMakeLists.txt

Créez un fichier CMakeLists.txt dans le répertoire racine MyProject et écrivez le contenu suivant :

Exemple

# Chemin du fichier : MyProject/CMakeLists.txt

# Spécifiez la version minimale de CMake (doit être placée sur la première ligne du fichier)
cmake_minimum_required(VERSION 3.10)

# Définissez le nom du projet et le numéro de version
project(MyProject VERSION 1.0)

# Définissez la norme C++ sur C++11 et exigez que le compilateur l'applique
set(CMAKE_CXX_STANDARD 11)
set(CMAKE_CXX_STANDARD_REQUIRED ON)

# Ajoutez un chemin de recherche global pour les fichiers d'en-tête
include_directories(${PROJECT_SOURCE_DIR}/include)

# Créez la cible de bibliothèque MyLib (fichier source : src/mylib.cpp)
add_library(MyLib src/mylib.cpp)

# Créer une cible exécutable MyExecutable (fichier source : src/main.cpp)
add_executable(MyExecutable src/main.cpp)

# Lier la bibliothèque MyLib à l'exécutable MyExecutable
target_link_libraries(MyExecutable MyLib)

Le rôle de chaque directive dans le fichier de configuration est le suivant :

Directive Fonction Point clé
cmake_minimum_required(VERSION 3.10) Spécifier la version minimale de CMake Doit être placé tout en haut du fichier ; les versions inférieures à celle-ci provoqueront une erreur
project(MyProject VERSION 1.0) Définir le nom et la version du projet Le numéro de version définit des variables telles que PROJECT_VERSION
set(CMAKE_CXX_STANDARD 11) Spécifier la norme C++ Utiliser avec CMAKE_CXX_STANDARD_REQUIRED pour garantir son application
include_directories(...) Ajouter un chemin de recherche de fichiers d'en-tête Permet au compilateur de trouver les fichiers d'en-tête dans include/
add_library(MyLib ...) Créer une cible de bibliothèque Lorsqu'aucun type n'est spécifié, BUILD_SHARED_LIBS détermine si elle est statique ou dynamique
add_executable(MyExecutable ...) Créer une cible exécutable Le nom de la cible sera utilisé comme nom du fichier exécutable final généré
target_link_libraries(...) Lier la bibliothèque à l'exécutable MyExecutable liera automatiquement MyLib lors de la compilation

Chaque add_executable et add_library définit unecible de compilation (Target).Le concept de cibles est le cœur de CMake—les commandes suivantes telles que target_include_directories, target_link_libraries, etc., sont toutes organisées autour des cibles.


Étapes détaillées de compilation

Une fois CMakeLists.txt en place, compilez et exécutez le projet en suivant les six étapes suivantes.

Aperçu global du processus :

Étape Opération Commande
1 Créer CMakeLists.txt Écrire manuellement le fichier de configuration
2 Créer le répertoire de build mkdir build && cd build
3 Configurer le projet cmake ..
4 Compiler le projet makeoucmake --build .
5 Exécuter l'exécutable ./MyExecutable
6 Nettoyer les fichiers de build make clean

Créer le fichier CMakeLists.txt

Créez le fichier CMakeLists.txt dans le répertoire racine de MyProject ; son contenu a été fourni dans les instructions de configuration de la section précédente.

C'est le point de départ de toute la compilation CMake ; toutes les règles de compilation sont définies dans ce fichier.

Créer le répertoire de build

Pour garder le répertoire du code source propre, il est recommandé d'utiliserOut-of-sourcel'approche de compilation out-of-source—créez un répertoire de build séparé sous la racine du projet.

Ouvrez un terminal et accédez au répertoire MyProject :

# 创建构建目录
mkdir build

# 进入构建目录(后续所有操作都在此目录执行)
cd build

Ajoutez le répertoire build au fichier .gitignore pour éviter de valider les artefacts de build dans le contrôle de version.

Configurer le projet

Exécutez CMake dans le répertoire build pour générer les fichiers du système de build (par ex., Makefile) adaptés à la plateforme actuelle.

..Indiquez le répertoire source contenant CMakeLists.txt.

# 在 build 目录中运行 CMake 配置
cmake ..

CMake affichera les résultats de configuration, en montrant le compilateur détecté et l'état de la configuration. Si tout se passe bien, vous verrez une sortie semblable à ce qui suit :

-- The CXX compiler identification is GNU 11.4.0
-- Detecting CXX compiler ABI info - done
-- Configuring done
-- Generating done
-- Build files have been written to: /path/to/MyProject/build

Si des erreurs se produisent pendant la configuration (comme un compilateur manquant ou une version de CMake trop ancienne), CMake s'arrêtera et indiquera la raison précise de l'erreur. Après avoir résolu le problème correspondant, relancezcmake ..et c'est tout.

Compiler le projet

Une fois les fichiers de build générés, utilisez la commande de build correspondante pour compiler le projet.

Par défaut, CMake génère des Makefiles sur les systèmes de type Unix, vous pouvez donc utiliser directement la commande make.

# 在 build 目录中编译项目
make

Une fois la compilation terminée, l'exécutable MyExecutable et le fichier de bibliothèque libMyLib.a seront générés dans le répertoire build.

Vous pouvez également utiliser la commande de build générique multiplateforme :

# cmake --build . 会自动调用正确的底层构建工具
cmake --build .

Exécuter l'exécutable

Après une compilation réussie, exécutez l'exécutable généré directement dans le répertoire de compilation.

# 运行编译生成的可执行文件
./MyExecutable

# 预期输出示例
Hello from EXAMPLE! This is MyLib speaking.

Nettoyer les fichiers de build

L'opération clean supprime les fichiers intermédiaires (fichiers .o, etc.) et les fichiers cibles générés lors de la compilation, ce qui libère de l'espace disque.

Utilisez la commande make clean :

# 删除编译产生的中间文件和目标文件
make clean

Supprimez manuellement le répertoire de compilation :

Si aucune règle clean n'est définie, vous pouvez simplement supprimer tout le répertoire de compilation.

# 回到项目根目录,删除 build 目录
cd ..
rm -rf build

Supprimer tout le répertoire de compilation est la méthode de nettoyage la plus complète. Pour la prochaine compilation, relancez simplement mkdir build && cd build && cmake .. && make pour repartir de zéro.


Notes

Assurez-vous que les chemins des fichiers source sont corrects.Les chemins des fichiers source dans add_executable et add_library sont relatifs au répertoire où se trouve CMakeLists.txt. Si les chemins sont incorrects, l'étape de configuration de CMake ne signalera pas d'erreur, mais la compilation se plaindra que les fichiers sont introuvables.

Les noms de cibles sont sensibles à la casse.MyLib et mylib sont des cibles différentes. Les noms de cibles référencés dans target_link_libraries doivent correspondre exactement aux noms de cibles définis dans add_library.

Une reconfiguration est nécessaire après avoir modifié CMakeLists.txt.Si vous n'avez modifié que des fichiers source, exécutez simplement make ; mais si vous avez modifié CMakeLists.txt (par exemple en ajoutant de nouveaux fichiers ou en modifiant les options de compilation), vous devez relancer cmake .. ou exécuter directement cmake --build . (il détectera automatiquement les changements de configuration).

Pour les utilisateurs débutants, il est recommandé de commencer par un projet simple.Commencez par faire fonctionner l'ensemble du processus de compilation avec un seul exécutable, puis ajoutez progressivement des bibliothèques, des dépendances externes et des options de compilation personnalisées. Ajouter trop de choses à la fois rendra le dépannage des erreurs plus difficile.

Autres extensions