cmake add_subdirectory 详解

在 CMake 中，add_subdirectory 命令用于向当前项目添加一个子目录，并且使得 CMake 在构建过程中进入该子目录继续处理其中的 CMakeLists.txt 文件。这个命令通常用于管理项目中的多个模块或子项目。
基本语法

add_subdirectory(source_dir [binary_dir] [EXCLUDE_FROM_ALL])

• source_dir: 指定要添加的子目录的路径。
• binary_dir: 指定要生成的二进制文件的路径。如果未指定，将使用默认的二进制文件目录（即在构建目录下的 source_dir 子目录）。
• EXCLUDE_FROM_ALL: 可选参数，如果设置，则将该子目录排除在 make all 或 build 目标之外。

示例

以下是几个使用 add_subdirectory 命令的示例：
1. 添加单个子目录
假设我们有如下的项目结构：

project_root/
├── CMakeLists.txt (主项目的 CMakeLists.txt)
└── sub_project/
    ├── CMakeLists.txt (子项目的 CMakeLists.txt)
    └── source_code.cpp

project_root/CMakeLists.txt:

cmake_minimum_required(VERSION 3.10)
project(MainProject)

# 添加子目录
add_subdirectory(sub_project)

# 主项目的其他设置

在这个示例中，add_subdirectory 命令将 sub_project 子目录添加到主项目中。CMake 会进入 sub_project 目录并继续处理其下的 CMakeLists.txt 文件。

2. 添加多个子目录
可以在主项目的 CMakeLists.txt 文件中多次使用 add_subdirectory 命令来添加多个子目录。
project_root/CMakeLists.txt:

cmake_minimum_required(VERSION 3.10)
project(MainProject)

# 添加多个子目录
add_subdirectory(module1)
add_subdirectory(module2)
add_subdirectory(module3)

3. 使用 binary_dir 参数指定二进制目录

cmake_minimum_required(VERSION 3.10)
project(MainProject)

# 添加子目录，并指定二进制目录
add_subdirectory(libs/maths /maths_build)

# 在主项目中使用该库
add_executable(my_program main.cpp)
target_link_libraries(my_program maths)

在这个示例中，我们将 libs/maths 目录添加为子目录，并指定了二进制目录为 /maths_build。这样可以将编译产生的中间文件和库文件分开存放，保持项目结构清晰。

注意事项

• 子目录的作用域: add_subdirectory 命令会在当前的 CMake 执行上下文中添加子目录。子目录中的变量、函数等定义将会影响到当前的 CMake 运行环境。
• 二进制目录的使用: 指定 binary_dir 参数可以帮助在构建过程中保持清晰的输出目录结构，特别是在管理多个子项目或模块时尤为有用。
• 排除子目录: 使用 EXCLUDE_FROM_ALL 参数可以在生成项目时排除指定的子目录，这在某些情况下可以避免不必要的构建。

结论
add_subdirectory 命令是 CMake 中管理项目结构的重要工具，允许将项目划分为多个模块或子项目，并进行统一的构建管理。通过合理使用 add_subdirectory 命令，可以使得 CMake 项目的结构更加清晰和可维护。