CMake中PROJECT_SOURCE_DIR是在哪里定义的？它与CMAKE_SOURCE_DIR有何区别？

Question

**CMake中PROJECT_SOURCE_DIR与CMAKE_SOURCE_DIR的区别及定义位置** 在CMake中，`PROJECT_SOURCE_DIR`是在调用`project()`命令时自动定义的，表示当前项目的根源码目录。它仅在使用`project()`命令后才可用，并且对于每个顶层项目或子项目，其值会重新定义为对应的源码根目录。 而`CMAKE_SOURCE_DIR`是CMake内置变量，始终指向最顶层CMakeLists.txt所在的目录，无论是否调用了`project()`命令，它的值在整个配置过程中保持不变。 两者的区别在于：`PROJECT_SOURCE_DIR`是项目相关的，适用于当前作用域的项目源码目录；而`CMAKE_SOURCE_DIR`是全局的，始终指向整个构建树的顶层源码目录。 常见问题：如果在一个子目录中访问`PROJECT_SOURCE_DIR`和`CMAKE_SOURCE_DIR`，它们可能指向不同的目录。理解这一点有助于正确组织文件路径和构建逻辑。

Answer 1

1. 基础概念：CMake中的PROJECT_SOURCE_DIR与CMAKE_SOURCE_DIR

CMake是一个功能强大的构建工具，它通过一系列变量来管理源码目录和构建过程。其中，PROJECT_SOURCE_DIR和CMAKE_SOURCE_DIR是两个非常重要的内置变量。

• PROJECT_SOURCE_DIR: 当调用project()命令时，CMake会自动定义该变量，表示当前项目（即调用了project()命令的作用域）的源码根目录。
• CMAKE_SOURCE_DIR: 这是一个全局变量，始终指向最顶层的CMakeLists.txt所在的目录，无论是否调用了project()命令。

例如，假设我们有一个如下结构的项目：

    project_root/
    ├── CMakeLists.txt
    └── src/
        └── CMakeLists.txt
    

2. 变量定义位置与作用范围

在CMake中，这两个变量的定义位置和作用范围有显著区别：

变量名	定义位置	作用范围
PROJECT_SOURCE_DIR	调用project()命令后自动定义	仅限于当前项目或子项目的源码根目录
CMAKE_SOURCE_DIR	始终存在，无需显式定义	整个构建树的顶层源码目录

如果在src/CMakeLists.txt中访问这些变量：

3. 示例分析：变量值的变化

以下是一个具体的例子，展示如何使用这两个变量：

# 顶层 CMakeLists.txt
cmake_minimum_required(VERSION 3.10)
project(MyProject)

message("CMAKE_SOURCE_DIR: ${CMAKE_SOURCE_DIR}")
message("PROJECT_SOURCE_DIR: ${PROJECT_SOURCE_DIR}")

add_subdirectory(src)

# src/CMakeLists.txt
message("CMAKE_SOURCE_DIR in src: ${CMAKE_SOURCE_DIR}")
message("PROJECT_SOURCE_DIR in src: ${PROJECT_SOURCE_DIR}")
    

运行结果可能如下：

CMAKE_SOURCE_DIR: /path/to/project_root
PROJECT_SOURCE_DIR: /path/to/project_root
CMAKE_SOURCE_DIR in src: /path/to/project_root
PROJECT_SOURCE_DIR in src: /path/to/project_root/src
    

4. 深入理解：常见问题与解决方案

在实际开发中，可能会遇到以下问题：

1. 问题: 在一个子目录中访问PROJECT_SOURCE_DIR和CMAKE_SOURCE_DIR时，它们可能指向不同的目录。
2. 原因: PROJECT_SOURCE_DIR随着project()命令的作用域变化，而CMAKE_SOURCE_DIR始终保持不变。
3. 解决方案: 明确区分两者的用途，根据具体需求选择合适的变量。例如，若需要引用顶层目录的文件，应使用CMAKE_SOURCE_DIR；若需要引用当前项目的文件，则使用PROJECT_SOURCE_DIR。

此外，可以通过流程图更直观地理解两者的关系：

mermaid
graph TD;
    A[项目根目录] --project()--> B[当前项目源码目录];
    C[CMAKE_SOURCE_DIR] --> A;
    D[PROJECT_SOURCE_DIR] --> B;