【软件开发】CMake 学习笔记

【软件开发】CMake 学习笔记

CMake 指令

https://cmake.org/cmake/help/latest/manual/cmake.1.html

1
2
3
4
# 将目标位置的CMakeLists生成为原生构建系统的项目
cmake <path>
# 编译已生成的原生构建系统的项目
cmake --build <path>

CMakeLists 指令

核心指令

通常必不可少的指令。

1
2
3
4
5
6
7
8
# 描述CMake的最低支持版本（顶层CMake文件必带）
cmake_minimum_required(VERSION <version>)
# 创建一个项目
project(<projectName>)
# 添加一个子目录（子目录需要带有CMakeLists）
add_subdirectory(<source_dir>)
# 寻找一个模块（带有特定配置文件的目录将会被识别为模块，可当成项目使用）
find_package(<packageName> CONFIG REQUIRED)

环境指令

用于描述开发环境

1
2
3
4
5
6
7
8
9
# 设置所需的C++标准库版本（需在指定项目输出前使用）
set(CMAKE_CXX_STANDARD <version>)
set(CMAKE_CXX_STANDARD_REQUIRED True)
# 添加全局附加包含目录
include_directories(<headerDir>...)
# 添加全局附加库
link_libraries({<projectName>|<libFile>...})
# 添加全局编译选项
add_compile_options(<option>...)

项目指令

针对单个项目的信息描述指令。

描述项目输出（必须要设置）

1
2
3
4
5
6
# 输出为可执行文件
add_executable(<projectName> <sourceFile>...)
# 输出为静态/动态库文件
add_library(<projectName> [STATIC|SHARED] <sourceFile>...)
# 特殊的没有输出的项目
add_custom_target(<projectName> SOURCES <sourceFile>...)

描述项目环境（指定完项目输出后才可用）

1
2
3
4
5
6
7
8
# 添加附加包含目录
target_include_directories(<projectName> {PUBLIC|PRIVATE} <headerDir>...)
# 添加附加库
target_link_libraries(<projectName> {PUBLIC|PRIVATE} {<projectName>|<libFile>...})
# 添加编译选项
target_compile_options(<option>...)
# 分类到vs中的解决方案文件夹（3.26之前需先打开 USE_FOLDERS 功能）
set_target_properties(<projectName> PROPERTIES FOLDER <folderName>)

  • 依赖项传递

    • PUBLIC：使用该选项添加引用，引用的头文件将传染给使用该项目的其他项目。
    • PRIVATE：引用不具备传染性，其他使用该项目的项目可能要再次添加头文件引用。

    除非项目已经将引用的库完全封装，希望后续的使用者不要再直接调用该引用的库时才该用PRIVATE，否则应设置为PUBLIC。

  • 全局项目设置

    部分指令如果去除target_前缀和部分参数，可转为对所有项目的设置的指令。

逻辑指令

通过逻辑运算控制代码执行。

1
2
3
4
5
6
# 定义一个宏函数
macro(<macroName>) \ endmacro()
# 确认文件是否存在
if(EXISTS <inputPath>) \ endif()
# 遍历变量列表
foreach(<outVar> <inputVarList>) \ endforeach()

其他指令

工具指令

一些功能性的实用指令。

1
2
3
4
5
6
7
8
9
10
11
# 设置开发中的环境变量
set(<variableName> <variableValue>)

# 从环境变量列表中去除指定项
list(REMOVE_ITEM <inputVars> <value> [<value> ...])

# 在vs中将指定文件分类到与文件系统一致的筛选器结构，而不是默认筛选器。
source_group(TREE <fileRootDir> FILES <inputFile>...)

# 复制并修改文件到指定位置。自动替换文件中的环境变量值（@<var>@）并自动移入当前CMakeLists的构建目录。
configure_file(<inputFile> <outputFile>)

cmake_path

计算路径相关信息

1
2
3
4
# 获取父目录地址
cmake_path(GET <path-var> PARENT_PATH <out-var>)
# 获取文件名
cmake_path(GET <path-var> FILENAME <out-var>)

file

文件相关处理，如统计复制等。

1
2
3
4
5
# 获取{当前目录|包括子目录}的满足glob通配符的文件并将其路径打包在一个环境变量中
file({GLOB | GLOB_RECURSE} <outputVarName> <inputFile>...)

# 复制文件夹到指定位置
file(COPY <sourceDir> DESTINATION <destinationDir>)

环境变量

仅写出部分通常只读的变量，需用户配置的变量见“环境指令”章节。

项目相关

  • <projectName>_VERSION_MAJOR：声明项目时额外提供的主版本号。
  • <projectName>_VERSION_MINOR：声明项目时额外提供的次版本号。

目录相关

  • PROJECT_BINARY_DIR：上次调用project()的 CMakeLists 对应的构建目录。
  • PROJECT_SOURCE_DIR：上次调用project()的 CMakeLists 对应的源目录。

注意：add_subdirectory()不会影响以上两条变量的值。

  • CMAKE_SOURCE_DIR：顶级 CMakeLists 的源目录。
  • CMAKE_BINARY_DIR：顶级 CMakeLists 的构建目录。
  • CMAKE_CURRENT_SOURCE_DIR：当前 CMakeLists 的源目录。
  • CMAKE_CURRENT_BINARY_DIR：当前 CMakeLists 的构建目录。

CMakePresets

https://cmake.org/cmake/help/latest/manual/cmake-presets.7.html

“CMakePresets.json”是 CMake 的配置文件，存放在项目的根目录中，用于配置一些 CMake 构建选项。

示例内容如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
  //CMakePresets所用的版本
  "version": 6,
  //定义生成配置。可定义多个，然后在构建指令中指明。
  "configurePresets": [
    {
      //配置名称
      "name": "default",
      //所用的生成器，用于将CMake项目转为原生项目
      "generator": "Visual Studio 17 2022",
      //生成输出目录（构建目录）
      "binaryDir": "${sourceDir}/build",
      //配置CMake缓存变量（一种长期存储的环境变量，存在CMakeCache.txt文件中）
      "cacheVariables": {
        //构建中使用的一些构建工具，由cmake语言写成
        "CMAKE_TOOLCHAIN_FILE": "$env{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake"
      }
    }
  ]
}

配置完毕后生成时通过添加--preset选项，如cmake --preset=<presetName>指令使用。

使用技巧

参考资料

个人研究 > 软件开发
【软件开发】CMake 学习笔记
https://bdffzi-blog.pages.dev/posts/2795034225.html
作者
BDFFZI
发布于
2024年7月16日
许可协议