CMake基础入门指南（1）

最新推荐文章于 2024-10-13 11:38:49 发布

Crazy learner

最新推荐文章于 2024-10-13 11:38:49 发布

阅读量527

点赞数 16

分类专栏： C++与python编程文章标签： c++ 服务器 linux cmake

本文链接：https://blog.csdn.net/weixin_52734695/article/details/141104141

版权

C++与python编程专栏收录该内容

53 篇文章 1 订阅

订阅专栏

一、CMake基础概念

在使用CMake之前，我们需要了解以下几个基本概念：

CMakeLists.txt: CMake的配置文件，通常放置在项目的根目录中，用于定义项目的构建规则。
目标（Target）: 可以是可执行文件、库文件或自定义命令等，CMake通过目标来组织构建。
生成器（Generator）: CMake可以生成多种构建系统，如Makefile、Ninja、Visual Studio工程文件等。

二、基本的CMakeLists.txt

下面是一个最简单的CMakeLists.txt的例子：

# 1. 声明CMake的最低版本要求
cmake_minimum_required(VERSION 3.10)

# 2. 定义项目名称和版本
project(MyProject VERSION 1.0)

# 3. 添加可执行文件
add_executable(MyExecutable main.cpp)

代码说明：
cmake_minimum_required：指定CMake的最低版本要求，确保构建环境的兼容性。
project：定义项目名称和版本。MyProject是项目的名字，VERSION 1.0是项目的版本号。
add_executable：告诉CMake要生成一个可执行文件，这里指定了源文件main.cpp。

三、添加库文件

通常情况下，我们的项目不仅包含可执行文件，还会包含库文件。CMake支持两种库：静态库和共享库。

静态库

静态库在链接时会将库的代码直接嵌入到可执行文件中。创建静态库的CMake代码如下：

# 1. 添加静态库
add_library(MyStaticLibrary STATIC library.cpp)

# 2. 将静态库链接到可执行文件
target_link_libraries(MyExecutable PRIVATE MyStaticLibrary)

代码说明：
**add_library：**创建一个静态库。STATIC关键字表示创建静态库，library.cpp是库的源文件。
target_link_libraries：将静态库链接到可执行文件MyExecutable。PRIVATE表示链接关系只对当前目标有效。

共享库

共享库（动态库）在运行时动态加载。创建共享库的CMake代码如下：

# 1. 添加共享库
add_library(MySharedLibrary SHARED library.cpp)

# 2. 将共享库链接到可执行文件
target_link_libraries(MyExecutable PRIVATE MySharedLibrary)

代码说明：
SHARED关键字表示创建共享库，其他部分与静态库相同。

四、使用CMake配置选项

CMake允许我们通过选项来控制构建过程中的行为。可以使用option()命令定义配置选项。例如，添加一个用于控制是否启用调试模式的选项：

# 1. 定义选项，默认值为OFF
option(ENABLE_DEBUG "Enable debugging" OFF)

# 2. 根据选项设置编译选项
if(ENABLE_DEBUG)
    message(STATUS "Debugging enabled")
    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -g")
else()
    message(STATUS "Debugging disabled")
endif()

代码说明：
option：定义一个选项，ENABLE_DEBUG是选项名称，Enable debugging是选项的描述，OFF是默认值。
**if()**语句：根据选项的值来执行不同的操作。如果启用了调试模式，就会添加调试标志-g。

五、组织项目结构

随着项目规模的扩大，可能需要将代码划分为多个目录。CMake允许我们将子目录纳入构建系统。假设项目结构如下：

MyProject/
│
├── src/
│   ├── main.cpp
│   └── library.cpp
│
├── include/
│   └── library.h
│
└── CMakeLists.txt

顶层CMakeLists.txt

cmake_minimum_required(VERSION 3.10)
project(MyProject VERSION 1.0)

# 1. 包含子目录
add_subdirectory(src)

# 2. 设置头文件目录
include_directories(${CMAKE_SOURCE_DIR}/include)

src/CMakeLists.txt

# 1. 添加库
add_library(MyLibrary library.cpp)

# 2. 添加可执行文件
add_executable(MyExecutable main.cpp)

# 3. 链接库
target_link_libraries(MyExecutable PRIVATE MyLibrary)

代码说明：
add_subdirectory：包含子目录src，这样CMake会处理src目录中的CMakeLists.txt。
include_directories：设置头文件目录include，使项目中的代码可以找到library.h。

六、生成与构建

在编写好CMakeLists.txt后，可以使用以下命令生成和构建项目。

1. 创建构建目录

mkdir build
cd build

2. 运行CMake

cmake ..

3. 构建项目

cmake --build .

代码说明：
mkdir build：创建一个单独的构建目录，避免污染源代码目录。
cmake …：在构建目录中运行CMake，…表示上级目录（即源码目录）。
cmake --build .：在当前目录中执行构建操作。

七、总结

CMake是一种强大的构建工具，支持跨平台、多种生成器的项目构建。通过定义简单的CMakeLists.txt文件，你可以轻松组织和管理项目的构建流程。本文介绍了CMake的基础用法，包括创建可执行文件、静态库、共享库以及如何使用选项控制构建过程。希望这些内容能帮助你快速上手CMake，为你的项目构建提供助力。