cmake CMAKE_CURRENT_SOURCE_DIR和CMAKE_CURRENT_LIST_DIR的区别

在 CMake 中,CMAKE_CURRENT_LIST_DIRCMAKE_CURRENT_SOURCE_DIR 都是指代当前 CMake 文件所在的路径,但它们的含义和用途有所不同:

  1. CMAKE_CURRENT_LIST_DIR

    • 表示 当前处理的 CMake 文件 (例如 CMakeLists.txt)所在的目录路径。
    • 这个变量的值是相对当前 CMake 文件的位置。如果你的 CMake 文件包含其他的子目录或 include() 语句,它将为每一个被处理的 CMake 文件指向不同的路径。
    • 用法场景:当你需要知道某个特定 CMake 文件的位置时使用,尤其是当项目中有多个 CMake 文件或模块时。

    例如:

    cmake 复制代码
    message("Current CMake file directory: ${CMAKE_CURRENT_LIST_DIR}")
  2. CMAKE_CURRENT_SOURCE_DIR

    • 表示 当前 CMake 处理的源代码目录,即当前作用域的源代码根目录。
    • 当你在 CMake 构建过程中进入子目录时,CMAKE_CURRENT_SOURCE_DIR 会一直指向当前 CMake 配置的源目录,即调用 add_subdirectory() 时传递的路径。
    • 这个变量在整个 CMake 配置过程中是相对一致的,并不随当前处理的 CMake 文件改变。

    例如:

    cmake 复制代码
    message("Current source directory: ${CMAKE_CURRENT_SOURCE_DIR}")

主要区别:

  • CMAKE_CURRENT_LIST_DIR 更加局部,跟当前处理的 CMake 文件位置相关。
  • CMAKE_CURRENT_SOURCE_DIR 则是全局性更强,指代整个 CMake 配置过程中的当前源代码目录。

例子:

假设项目结构如下:

复制代码
project/
├── CMakeLists.txt
├── src/
│   └── CMakeLists.txt
└── build/

src/CMakeLists.txt 中:

  • CMAKE_CURRENT_LIST_DIR 会是 project/src,因为这是当前 CMakeLists.txt 文件所在的目录。
  • CMAKE_CURRENT_SOURCE_DIR 会是 project,即项目的根目录。

通过理解这些差异,你可以更灵活地在 CMake 文件中引用路径,确保正确地处理文件路径和源代码目录。


好的,我来试试用更简单的方式解释一下!

CMAKE_CURRENT_LIST_DIR

  • 意思 :它指的是当前正在被 CMake 处理的那个 文件 所在的文件夹。
  • 举个例子 :如果你在 src/CMakeLists.txt 里使用了 CMAKE_CURRENT_LIST_DIR,它会返回 src 文件夹的路径。
  • 重点 :这个变量是跟你 当前正在处理的 CMake 文件 相关的,不是整个项目的源代码目录。

CMAKE_CURRENT_SOURCE_DIR

  • 意思 :它指的是当前 CMake 项目在构建时的 源代码目录 ,即你最开始运行 cmake 命令时传入的那个目录。
  • 举个例子 :如果你在 src/CMakeLists.txt 里使用了 CMAKE_CURRENT_SOURCE_DIR,它会返回你整个项目的根目录路径,也就是包含 srcCMakeLists.txt 的上级目录。
  • 重点 :这个变量是跟你的 整个项目的源代码目录 相关的,跟你当前在哪个文件夹都没有关系。

再举个简单的例子:

假设你的项目结构是这样的:

复制代码
my_project/
├── CMakeLists.txt
├── src/
│   └── CMakeLists.txt
└── build/
  • 如果你在 src/CMakeLists.txt 里面写了:

    cmake 复制代码
    message("Current list dir: ${CMAKE_CURRENT_LIST_DIR}")

    输出会是:/path/to/my_project/src(即 src 文件夹的路径)。

  • 如果你在 src/CMakeLists.txt 里面写了:

    cmake 复制代码
    message("Current source dir: ${CMAKE_CURRENT_SOURCE_DIR}")

    输出会是:/path/to/my_project(即整个项目的根目录路径)。

总结:

  • CMAKE_CURRENT_LIST_DIR当前正在处理的 CMake 文件 所在的目录有关。
  • CMAKE_CURRENT_SOURCE_DIR整个项目的源代码根目录 有关。

没问题!我再解释一下,尽量更简单一些。

源代码根目录

"源代码根目录"指的是你整个 CMake 项目最上层的那个文件夹,也就是你在命令行运行 cmake 的地方,或者你在 CMake 中配置项目时指定的那个目录。

假设你的项目文件夹结构是这样:

复制代码
my_project/            ← 这是整个项目的根目录
├── CMakeLists.txt     ← 这是根目录下的 CMake 配置文件
├── src/
│   └── CMakeLists.txt ← 这是 src 文件夹里的 CMake 配置文件
└── build/

这里:

  • my_project/ 就是 整个项目的源代码根目录 ,也就是你放 CMake 配置文件(CMakeLists.txt)和源代码文件的顶层目录。

CMake 的两个变量

  1. CMAKE_CURRENT_SOURCE_DIR

    • 这个变量指的是 CMake 正在处理的 CMake 文件所在的目录
    • 如果你在 my_project/src/CMakeLists.txt 里用这个变量,它返回的就是 my_project/(根目录),因为你在根目录下运行 cmake
  2. CMAKE_CURRENT_LIST_DIR

    • 这个变量指的是 当前 CMake 文件所在的目录
    • 如果你在 src/CMakeLists.txt 里用这个变量,它返回的就是 my_project/src,因为你在 src 文件夹里有一个 CMake 文件。

举个简单例子:

假设你有这样一个项目:

复制代码
my_project/
├── CMakeLists.txt
├── src/
│   └── CMakeLists.txt
└── build/
  • 如果你在 my_project/src/CMakeLists.txt 中写:

    cmake 复制代码
    message("CMAKE_CURRENT_SOURCE_DIR: ${CMAKE_CURRENT_SOURCE_DIR}")

    输出会是:/path/to/my_project,也就是整个项目的根目录。

  • 如果你在 my_project/src/CMakeLists.txt 中写:

    cmake 复制代码
    message("CMAKE_CURRENT_LIST_DIR: ${CMAKE_CURRENT_LIST_DIR}")

    输出会是:/path/to/my_project/src,也就是 src 文件夹的路径。

关键点:

  • CMAKE_CURRENT_SOURCE_DIR 是你 整个项目 的源代码根目录,通常就是你运行 cmake 命令的那个目录(比如 my_project/)。
  • CMAKE_CURRENT_LIST_DIR 是当前 处理的 CMake 文件 所在的目录,比如你当前在 src/CMakeLists.txt 中,它就是 my_project/src

你说得对,我最后的描述有些不准确,感谢你指出来!让我来纠正一下:

正确的解释:

  1. CMAKE_CURRENT_SOURCE_DIR

    • 意思 :它指的是 当前 CMake 处理的源代码目录 ,即你在运行 cmake 命令时指定的那个目录。这个目录通常是项目的根目录,或者是某个子目录(如果你在子目录里运行了 cmake)。
    • 举个例子 :如果你在 my_project/(整个项目的根目录)运行 cmakeCMAKE_CURRENT_SOURCE_DIR 就会是 my_project/,即源代码的根目录。
  2. CMAKE_CURRENT_LIST_DIR

    • 意思 :它指的是 当前正在被处理的 CMake 文件 所在的目录。也就是说,如果你在 src/CMakeLists.txt 里,它就是 my_project/src/,如果你在 my_project/CMakeLists.txt 里,它就是 my_project/
    • 举个例子 :如果你在 my_project/src/CMakeLists.txt 文件中用 CMAKE_CURRENT_LIST_DIR,它会返回 my_project/src/。这是因为这个变量是基于当前 CMake 文件所在位置的。

正确的区别总结:

  • CMAKE_CURRENT_SOURCE_DIR 是基于 CMake 配置源代码时的起始目录 ,一般来说,这个目录会是项目的根目录,或者是你运行 cmake 命令时指定的目录。
  • CMAKE_CURRENT_LIST_DIR 是基于 当前 CMake 文件所在的目录 ,也就是你正在处理的那个 CMakeLists.txt 文件的目录。

例子再梳理一遍:

假设项目结构如下:

复制代码
my_project/              ← 项目的根目录
├── CMakeLists.txt       ← 项目的 CMake 配置文件
├── src/                 ← 源代码目录
│   └── CMakeLists.txt   ← src 下的 CMake 配置文件
└── build/               ← 构建目录
  • CMAKE_CURRENT_SOURCE_DIR

    • 如果你在 my_project/src/CMakeLists.txt 里用它,返回的就是 my_project/(项目根目录)。
    • 如果你在 my_project/CMakeLists.txt 里用它,返回的也是 my_project/(项目根目录)。
  • CMAKE_CURRENT_LIST_DIR

    • 如果你在 my_project/src/CMakeLists.txt 里用它,返回的就是 my_project/src/src 文件夹的路径)。
    • 如果你在 my_project/CMakeLists.txt 里用它,返回的就是 my_project/(项目根目录)。
相关推荐
niuTaylor2 天前
从入门到精通:CMakeLists.txt 完全指南
linux·服务器·cmake
lemontree19452 天前
Ubuntu18.04 升级最新版本Cmake
cmake·ubuntu18.04
binary思维3 天前
CMake使用教程
cmake
mahuifa4 天前
(7)VTK C++开发示例 --- 使用交互器
c++·vtk·cmake·3d开发
___波子 Pro Max.4 天前
CMake execute_process用法详解
cmake
EstrangedZ6 天前
vcpkg缓存问题研究
c语言·c++·缓存·cmake·vcpkg
无畏烧风11 天前
[CMake] CMakePresets.json简单使用
cmake
mahuifa11 天前
(2)VTK C++开发示例 --- 绘制多面锥体
c++·vtk·cmake·3d开发
___波子 Pro Max.13 天前
CMake中add_custom_command用法详解
cmake
信必诺20 天前
CMake —— 2、cmake在windows与linux下动态链接库编译与链接实例(附:过程代码与CMakeLists.txt)
windows·ubuntu·cmake·动态链接库·linux\