CMake 保姆级教程

CMake 是一个跨平台的构建工具，用于生成适合不同平台和编译器的构建系统文件（如 Makefile 或 Visual Studio 项目文件）。
在 Windows 下使用 CMake 构建项目时，CMake 会根据 CMakeLists.txt 文件生成适合 Windows 的构建系统文件（如 Visual Studio 项目文件）。以下是 Windows 下使用 CMake 的基本规则和步骤：

https://subingwen.cn/cmake/CMake-primer/#1-CMake%E6%A6%82%E8%BF%B0

---

1. CMakeLists.txt 文件的基本结构

CMakeLists.txt 是 CMake 的配置文件，用于定义项目的构建规则。以下是一个简单的示例：

# 指定 CMake 的最低版本要求（不是必须的，这个version需要比本地使用的低就行）
cmake_minimum_required(VERSION 3.10)

# 定义项目名称和使用的编程语言(不写默认情况支持所有语言)  project(<PROJECT-NAME> [<language-name>...]) 
project(MyProject CXX)

# 添加可执行文件目标 add_executable(可执行程序名 所有源文件名称.cpp)
add_executable(MyProgram main.cpp utils.cpp)

# 添加编译选项
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -O2")

# 添加库文件（如果需要）
target_link_libraries(MyProgram some_library)

# 注释单行行(# )    注释多行CMake 使用 #[[ ]] 形式进行块注释
#[[ 这是一个 CMakeLists.txt 文件。
这是一个 CMakeLists.txt 文件
这是一个 CMakeLists.txt 文件]]

set使用

定义变量

# 假设有很多.cpp文件，这些.cpp文件名需要被反复使用，每次都直接将它们的名字写出来很麻烦，此时可以定义一个变量，将文件名对应的字符串存储起来
# SET 指令的语法是：VAR：变量名   VALUE：变量值
set (var value)
set(SRC_LIST add.c  div.c   main.c  mult.c  sub.c)

# 取值 ${变量名}
add_executable(app  ${SRC_LIST})   # 生成可执行程序

指定使用的C++标准

# 在编写C++程序的时候，可能会用到C++11、C++14、C++17、C++20等新特性，那么就需要在编译的时候在编译命令中制定出要使用哪
#增加-std=c++11
set(CMAKE_CXX_STANDARD 11)
#增加-std=c++14
set(CMAKE_CXX_STANDARD 14)
#增加-std=c++17
set(CMAKE_CXX_STANDARD 17)

指定输出的路径

# 定义一个变量用于存储一个绝对路径
set(HOME /home/robin/Linux/Sort)   
# 拼接好的路径值设置给CMAKE_RUNTIME_OUTPUT_DIRECTORY 宏，设置可执行程序输出目录
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${HOME}/bin)

# 设置库文件的输出目录
set(CMAKE_LIBRARY_OUTPUT_DIRECTORY "D:/learn/C++/test/code/lib")

# 设置静态库文件的输出目录
set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY "D:/learn/C++/test/code/lib")


# 定义可执行文件
add_executable(MyProgram main.cpp)
# 为特定目标设置输出目录
set_target_properties(MyProgram PROPERTIES
    RUNTIME_OUTPUT_DIRECTORY "D:/learn/C++/test/code/bin"
)

搜索文件

如果一个项目里边的源文件很多，在编写CMakeLists.txt文件的时候不可能将项目目录的各个文件一一罗列出来，这样太麻烦也不现实。所以，在CMake中为我们提供了搜索文件的命令，可以使用file命令。

# GLOB: 将指定目录下搜索到的满足条件的所有文件名生成一个列表，并将其存储到变量中。
# GLOB_RECURSE：递归搜索指定目录，将搜索到的满足条件的文件名生成一个列表，并将其存储到变量中

file(GLOB/GLOB_RECURSE 变量名 要搜索的文件路径和文件类型) 
file(GLOB SRC ${CMAKE_CURRENT_SOURCE_DIR}/*.cpp)   # CMAKE_CURRENT_SOURCE_DIR 这个存储路径就是cmakefile.txt所在的路径
# file(GLOB MAIN_SRC ${CMAKE_CURRENT_SOURCE_DIR}/src/*.cpp)
# file(GLOB MAIN_HEAD ${CMAKE_CURRENT_SOURCE_DIR}/include/*.h)

指定头文件

如果头文件所在目录发生改变，不需要把引用该头文件所有的.cpp都进行修改，只需要需要对应的cmake文件

include_directories(headpath)
include_directories(${PROJECT_SOURCE_DIR}/include)

通过CMake 制作库文件（动态库/静态库）

制作静态库

add_library(库名称 STATIC 源文件1 [源文件2] ...) 

制作动态库

add_library(库名称 SHARED 源文件1 [源文件2] ...) 
# 设置动态库生成路径
set(EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/lib)

# 设置动态库/静态库生成路径
set(LIBRARY_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/lib)

链接库

链接静态库

link_libraries(<static lib> [<static lib>...])

• 参数1：指定出要链接的静态库的名字
  可以是全名 libxxx.a 也可以是掐头（lib）去尾（.a）之后的名字 xxx

链接动态库

---

2. Windows 下的 CMake 使用步骤

(1) 安装 CMake

• 从 CMake 官网 下载并安装 CMake。
• 确保将 CMake 添加到系统环境变量中，以便在命令行中使用。

(2) 创建构建目录

在项目根目录下（CMakeLists.txt文件所在路径），创建一个构建目录（例如 build），用于存放生成的构建文件：

mkdir build
cd build

(3) 生成构建系统文件（执行cmake进行编译）

使用 CMake 生成适合 Windows 的构建系统文件。以下是几种常见的方式：

• 生成 Visual Studio 项目文件：

  cmake -G "Visual Studio 17 2022" ..
  

  这里的 "Visual Studio 17 2022" 是生成器的名称，可以根据你的 Visual Studio 版本调整。

• 指定平台（x64 或 x86）：
  如果需要指定目标平台（如 64 位或 32 位），可以使用 -A 参数：

  cmake -G "Visual Studio 17 2022" -A x64 ..
  

(4) 构建项目

生成构建系统文件后，可以使用以下命令构建项目：

• 使用 Visual Studio 构建：
  打开生成的 .sln 文件，使用 Visual Studio 进行构建。

• 使用 CMake 命令行构建：

  cmake --build . --config Release
  

  这里的 --config Release 指定构建类型为 Release，也可以改为 Debug。

---

3. CMakeLists.txt 的常用规则

(1) 添加源文件

# 手动指定源文件
add_executable(MyProgram main.cpp utils.cpp)

# 自动查找所有 .cpp 文件
file(GLOB SOURCES "src/*.cpp")
add_executable(MyProgram ${SOURCES})

(2) 添加头文件目录

# 添加头文件目录
include_directories(include)

# 或者使用 target_include_directories（推荐）
target_include_directories(MyProgram PUBLIC include)

(3) 链接库文件

# 链接静态库或动态库
target_link_libraries(MyProgram some_library)

# 查找并链接系统库（如 OpenGL）
find_package(OpenGL REQUIRED)
target_link_libraries(MyProgram OpenGL::GL)

(4) 设置编译选项

# 设置全局编译选项
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -O2")

# 设置目标特定的编译选项
target_compile_options(MyProgram PRIVATE -Wall -O2)

(5) 设置输出目录

# 设置可执行文件的输出目录
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)

# 设置库文件的输出目录
set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)

(6) 添加子目录

如果项目包含多个子项目，可以使用 add_subdirectory：

add_subdirectory(subproject)

---

4. Windows 下的注意事项

(1) 路径分隔符

在 Windows 下，路径分隔符是反斜杠 \，但在 CMake 中建议使用正斜杠 /，因为 CMake 会自动处理路径。

(2) 生成器选择

Windows 下常用的生成器包括：

• Visual Studio 17 2022：生成 Visual Studio 项目文件。
• MinGW Makefiles：生成适用于 MinGW 的 Makefile。

(3) 动态链接库

在 Windows 下，动态链接库（DLL）的使用需要注意：

• 确保 DLL 文件在运行时可以被找到（可以将其放在可执行文件目录中）。
• 使用 target_link_libraries 链接库时，CMake 会自动处理导入库（.lib 文件）。

(4) 调试与发布配置

CMake 支持多配置生成器（如 Visual Studio），可以通过 --config 参数指定构建类型：

cmake --build . --config Debug   # 调试模式
cmake --build . --config Release # 发布模式

---

5. 示例：完整的 CMakeLists.txt

以下是一个完整的 CMakeLists.txt 示例：

cmake_minimum_required(VERSION 3.10)
project(MyProject CXX)

# 添加头文件目录
include_directories(include)

# 添加源文件
file(GLOB SOURCES "src/*.cpp")

# 生成可执行文件
add_executable(MyProgram ${SOURCES})

# 链接库文件
target_link_libraries(MyProgram some_library)

# 设置编译选项
target_compile_options(MyProgram PRIVATE -Wall -O2)

# 设置输出目录
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)

---

6. 总结

• 在 Windows 下使用 CMake 时，可以通过 -G 参数指定生成器（如 Visual Studio）。
• CMakeLists.txt 文件定义了项目的构建规则，包括源文件、头文件、库文件和编译选项。
• 使用 cmake --build 可以方便地构建项目。

通过合理配置 CMakeLists.txt，可以在 Windows 下高效地管理和构建项目。