CMake add_subdirectory()函数

add_subdirectory() 是 CMake 中的一个函数，用于向 CMake 工程中添加一个子目录。这个函数接受一个参数，即子目录的路径，它会在当前 CMakeLists.txt 文件中的对应位置包含子目录中的 CMakeLists.txt 文件，并执行其中的命令。这样可以将工程分解为多个模块，各模块的 CMakeLists.txt 文件可以单独管理，提高了工程的可维护性。

---

20230816

CMake的add_subdirectory()函数

CMake的add_subdirectory()函数是一个重要的功能，用于添加源代码树的子目录，并在那个子目录中处理CMakeLists.txt文件。这使得项目的组织和管理变得更为容易和高效。

函数语法

add_subdirectory(source_dir [binary_dir] [EXCLUDE_FROM_ALL])

• source_dir: 需要添加的子目录名称。
• binary_dir: 指定构建此目录的二进制文件输出位置。如果没有指定，默认将在当前构建目录下创建与源目录同名的目录。
• EXCLUDE_FROM_ALL: 该选项将禁止所有该子目录下的目标被默认构建。

如何使用add_subdirectory()

add_subdirectory()函数可以用来将一个大型项目分解成更小、更易管理的部分。例如，一个项目可能有一个主要的CMakeLists.txt文件和多个子目录，每个子目录都有自己的CMakeLists.txt文件。以下是一个简单的项目结构示例：

project/
|-- CMakeLists.txt
|-- subdirectory1/
|   |-- CMakeLists.txt
|   `-- source_files...
|-- subdirectory2/
|   |-- CMakeLists.txt
|   `-- source_files...
`-- ...

在主CMakeLists.txt文件中，可以使用add_subdirectory()函数添加这些子目录：

cmake_minimum_required(VERSION 3.10)
project(my_project)

add_subdirectory(subdirectory1)
add_subdirectory(subdirectory2)
...

在上述情况下，当CMake处理主CMakeLists.txt文件时，它会找到并处理每个子目录中的CMakeLists.txt文件。这样可以保持主CMakeLists.txt文件的清洁，将各个子模块的构建逻辑放在各自的子目录中。

示例：使用add_subdirectory()编译库

考虑一种情况，你正在编写一个项目，其中包含一个库（假设名为my_lib）和一个可执行文件（假设名为my_exec）。你可能希望把库的源代码放在一个子目录中，然后在主目录中编译可执行文件。

你的项目结构可能如下：

project/
|-- CMakeLists.txt
|-- main.cpp
`-- my_lib/
    |-- CMakeLists.txt
    `-- my_lib.cpp

在my_lib/CMakeLists.txt中，你可能有以下内容：

add_library(my_lib my_lib.cpp)

在主CMakeLists.txt文件中，你需要添加my_lib子目录，并链接my_lib库以编译my_exec：

cmake_minimum_required(VERSION 3.10)
project(my_project)

add_subdirectory(my_lib)

add_executable(my_exec main.cpp)
target_link_libraries(my_exec my_lib)

这里，通过在主CMakeLists.txt文件中调用add_subdirectory(my_lib)，CMake会进入my_lib子目录并处理其中的CMakeLists.txt文件。然后在主目录中，你可以引用在子目录中定义的目标（在这种情况下是my_lib库），并将其链接到你的可执行文件。

注意事项

尽管add_subdirectory()函数可以使项目的组织变得更加清晰，但也需要注意一些问题。首先，必须确保每个子目录中的CMakeLists.txt文件正确地定义了所有的目标和属性。此外，尽管add_subdirectory()可以嵌套调用，但过度使用可能导致项目结构变得复杂难以理解。

参考资料

在这里插入图片描述

• CMake Documentation: add_subdirectory
• Modern CMake
• Effective Modern CMake