顶层CMake与公共编译选项

本节讲两个文件：

1. 顶层 CMakeLists.txt
2. cmake/ProjectOptions.cmake

这两个文件决定了整个工程的基本身份和公共编译规则。

1.顶层 CMakeLists.txt

本模板的顶层文件如下：

cmake_minimum_required(VERSION 3.25)

project(cmake_template VERSION 1.0.0 LANGUAGES C CXX)

include(GNUInstallDirs)

include("${CMAKE_CURRENT_LIST_DIR}/cmake/ProjectOptions.cmake")

add_subdirectory(src)

顶层 CMakeLists.txt 的原则是：只做总控，不堆具体业务和第三方依赖。

2.cmake_minimum_required

cmake_minimum_required(VERSION 3.25)

作用：

1. 指定项目需要的最低 CMake 版本。
2. 告诉 CMake 使用对应版本的策略行为。
3. 太老的 CMake 会直接报错，不会继续配置。

可以填什么：

cmake_minimum_required(VERSION 3.20)
cmake_minimum_required(VERSION 3.25)
cmake_minimum_required(VERSION 3.28)

选择建议：

教学模板建议不要无限追新。只要满足当前写法即可。

3.project

project(cmake_template VERSION 1.0.0 LANGUAGES C CXX)

作用：

1. 设置项目名。
2. 设置项目版本。
3. 声明项目使用哪些语言。
4. 初始化一批 CMake 变量。

3.1.项目名

project(cmake_template)

项目名会影响这些变量：

本模板在 src/CMakeLists.txt 中使用：

add_executable(${PROJECT_NAME}
  ${CMAKE_CURRENT_SOURCE_DIR}/main.cpp
)

所以最终可执行文件名就是：

cmake_template

如果把项目名改成：

project(robot_app VERSION 1.0.0 LANGUAGES C CXX)

最终可执行文件就会变成：

robot_app

3.2.VERSION

VERSION 1.0.0

项目版本号。

可以填什么：

VERSION 0.1.0
VERSION 1.0.0
VERSION 2.3.4

CMake 会生成这些变量：

以后如果做安装包、导出 CMake package、生成版本头文件，这些变量会很有用。

3.3.LANGUAGES

LANGUAGES C CXX

声明项目启用哪些语言。

常见值：

如果项目只有 C++，也可以写：

project(cmake_template VERSION 1.0.0 LANGUAGES CXX)

本模板保留 C CXX，是为了允许 src/*.c 和 src/*.cpp 都能参与构建。

4.include(GNUInstallDirs)

include(GNUInstallDirs)

作用：加载 GNU 风格的安装目录变量。

常用变量：

为什么不用手写：

install(TARGETS app DESTINATION bin)
install(TARGETS lib DESTINATION lib)

因为不同 Linux 发行版可能使用 lib 或 lib64。用 GNUInstallDirs 后，CMake 会根据系统习惯设置。

模板中的使用示例：

install(TARGETS ${PROJECT_NAME}
  RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
)

库安装：

install(TARGETS ${PREFIX}_src_lib
  LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
  ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
  RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
)

头文件安装：

install(DIRECTORY "${CMAKE_CURRENT_LIST_DIR}/inc/"
  DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
)

5.include("${CMAKE_CURRENT_LIST_DIR}/cmake/ProjectOptions.cmake")

include("${CMAKE_CURRENT_LIST_DIR}/cmake/ProjectOptions.cmake")

作用：读取另一个 CMake 文件。

5.1.include(...)

include 会在当前作用域执行指定的 CMake 脚本。

可以写：

include(GNUInstallDirs)
include(cmake/ProjectOptions.cmake)
include("${CMAKE_CURRENT_LIST_DIR}/cmake/ProjectOptions.cmake")

区别：

5.2.CMAKE_CURRENT_LIST_DIR

表示当前正在处理的 CMake 文件所在目录。

在顶层 CMakeLists.txt 中，它就是项目根目录。

所以：

"${CMAKE_CURRENT_LIST_DIR}/cmake/ProjectOptions.cmake"

表示：

项目根目录/cmake/ProjectOptions.cmake

6.add_subdirectory(src)

add_subdirectory(src)

作用：进入 src 子目录，继续读取 src/CMakeLists.txt。

可以填什么：

add_subdirectory(src)
add_subdirectory(test)
add_subdirectory(third_party/some_lib)

常见写法：

add_subdirectory(<源码目录>)

也可以指定构建目录：

add_subdirectory(src src_build)

但一般不需要。

顶层只写：

add_subdirectory(src)

表示具体的可执行文件、库、依赖，都交给 src 下面的 CMake 文件管理。

7.cmake/ProjectOptions.cmake

本模板内容如下：

set(CMAKE_CXX_STANDARD 17)
set(CMAKE_CXX_STANDARD_REQUIRED ON)
set(CMAKE_CXX_EXTENSIONS OFF)

set(CMAKE_C_STANDARD 11)
set(CMAKE_C_STANDARD_REQUIRED ON)
set(CMAKE_C_EXTENSIONS OFF)

set(CMAKE_EXPORT_COMPILE_COMMANDS ON)

add_library(project_options INTERFACE)
target_compile_features(project_options INTERFACE cxx_std_17)

add_library(project_warnings INTERFACE)
target_compile_options(project_warnings INTERFACE
  -Wall
  -Wextra
  -Wpedantic
)

这个文件只放项目公共选项，不放 Eigen、OpenCV 等第三方依赖。

8.CMAKE_CXX_STANDARD

set(CMAKE_CXX_STANDARD 17)

设置默认 C++ 标准。

常见值：

本模板使用 C++17：

set(CMAKE_CXX_STANDARD 17)

如果想用 C++20：

set(CMAKE_CXX_STANDARD 20)
target_compile_features(project_options INTERFACE cxx_std_20)

注意两个地方最好一起改。

9.CMAKE_CXX_STANDARD_REQUIRED

set(CMAKE_CXX_STANDARD_REQUIRED ON)

作用：要求编译器必须支持指定的 C++ 标准。

可以填什么：

模板建议写 ON。否则你以为在用 C++17，实际编译器可能退回旧标准，错误会更隐蔽。

10.CMAKE_CXX_EXTENSIONS

set(CMAKE_CXX_EXTENSIONS OFF)

作用：控制是否使用编译器扩展标准。

可以填什么：

Linux-only 项目也建议先写 OFF，这样代码更接近标准 C++。

11.C 标准相关选项

set(CMAKE_C_STANDARD 11)
set(CMAKE_C_STANDARD_REQUIRED ON)
set(CMAKE_C_EXTENSIONS OFF)

含义和 C++ 对应选项类似。

常见 C 标准：

如果项目没有 .c 文件，也可以只启用 C++：

project(cmake_template VERSION 1.0.0 LANGUAGES CXX)

然后删除 C 标准相关设置。

12.CMAKE_EXPORT_COMPILE_COMMANDS

set(CMAKE_EXPORT_COMPILE_COMMANDS ON)

作用：生成 compile_commands.json。

可以填：

这个选项在 CMakePresets.json 中也写了：

"CMAKE_EXPORT_COMPILE_COMMANDS": "ON"

两个地方都写不冲突。preset 的好处是 IDE 和命令行都能明确看到这个配置；ProjectOptions.cmake 的好处是即使不用 preset，也默认开启。

13.add_library(project_options INTERFACE)

add_library(project_options INTERFACE)

创建一个 interface target。

INTERFACE target 没有源码，不会生成 .a 或 .so。它只用来携带编译特性、宏定义、include 路径、链接依赖等"使用要求"。

add_library 常见类型：

本模板用：

project_options

保存 C++ 标准要求。

14.target_compile_features

target_compile_features(project_options INTERFACE cxx_std_17)

作用：声明使用这个 target 的目标需要 C++17。

可以填什么：

为什么这里又写了一遍 C++17？

set(CMAKE_CXX_STANDARD 17)

是全局默认值。

target_compile_features(project_options INTERFACE cxx_std_17)

是目标级要求。现代 CMake 更推荐用目标级要求，因为它能随着 target 链接关系传播。

15.add_library(project_warnings INTERFACE)

add_library(project_warnings INTERFACE)

创建一个专门保存 warning 选项的 interface target。

这样每个 target 可以选择是否链接：

target_link_libraries(my_target
  PRIVATE
    project_warnings
)

16.target_compile_options

target_compile_options(project_warnings INTERFACE
  -Wall
  -Wextra
  -Wpedantic
)

作用：给目标添加编译选项。

本模板选项：

常见可追加选项：

不建议模板默认加 -Werror。因为不同编译器、不同第三方头文件可能产生不同 warning，初学阶段容易被卡住。

17.PUBLIC、PRIVATE、INTERFACE 的直觉

后面的 CMake 文件会大量出现：

PUBLIC
PRIVATE
INTERFACE

它们控制"属性是否传递给使用者"。

例如：

target_link_libraries(lib1_src_lib
  PUBLIC
    project_options
  PRIVATE
    project_warnings
)

含义：

1. lib1_src_lib 自己需要 project_options。
2. 链接 lib1_src_lib 的目标也会得到 project_options。
3. project_warnings 只用于编译 lib1_src_lib 自己，不强迫下游也开启相同 warning。