PROJECT_SOURCE_DIR 和 CMAKE_SOURCE_DIR

PROJECT_SOURCE_DIR 和 CMAKE_SOURCE_DIR对比

在 CMake 中，PROJECT_SOURCE_DIR和CMAKE_SOURCE_DIR是两个非常重要的变量，它们都指向项目的源代码目录，但在多项目(子项目或多个 CMakeLists.txt 文件)的情况下，它们的值有所不同。

CMAKE_SOURCE_DIR

• 定义：CMAKE_SOURCE_DIR 指向最顶层的 CMakeLists.txt 文件所在的目录，即整个项目的根目录。
• 用途：这个变量在整个项目构建过程中保持不变，无论当前处理的是哪个 CMakeLists.txt 文件。它非常适合用于定义整个项目范围内的源代码路径。

PROJECT_SOURCE_DIR

• 定义：PROJECT_SOURCE_DIR 指向包含最近一次调用 project() 命令的 CMakeLists.txt 文件的目录。
• 用途：在包含多个子项目的情况下，每个子项目(每次调用 project() 命令)都会重新设置 PROJECT_SOURCE_DIR。这使得每个子项目可以有自己独立的源代码目录路径。

示例

比如说，我们有以下项目结构：

/MyProject (根目录)
|-- CMakeLists.txt       # 最顶层的 CMakeLists.txt
|-- lib
|   |-- CMakeLists.txt   # lib 目录的 CMakeLists.txt
|       project()        # 定义了一个子项目
|-- app
    |-- CMakeLists.txt   # app 目录的 CMakeLists.txt
        project()        # 定义了另一个子项目

最顶层CMakeLists.txt内容如图

子文件夹app下的CMakeLists.txt

子文件夹lib下的CMakeLists.txt

然后我们在项目根路径下执行以下指令

mkdir build
cd build
cmake ..

终端输出如图

我们可以从终端输出的Message信息看到，在整个项目构建过程中，无论当前处理的是哪个CMakeLists.txt，${CMAKE_SOURCE_DIR}这个变量保持不变，是项目的根路径。

每个子项目每次调用 project() 命令后，都会重新设置 ${PROJECT_SOURCE_DIR}。这使得每个子项目可以有自己独立的源代码目录路径。