在 CMake 中，如何找到包含文件的目录？

Question

假设我的项目的CMakeLists.txt 包含foo.cmake：

include(foo)

在foo.cmake，我想知道foo.cmake的路径。
我该怎么做？

注意CMAKE_CURRENT_LIST_DIR 给出了包含CMakeLists.txt 的目录，而不是包含foo.cmake 的目录，因此不是我想要的。

当然，foo.cmake 可能包含在多个项目中（即多个CMakeLists.txt 文件）。

Answer 1

人们报告了关于 CMAKE_CURRENT_LIST_DIR 行为方式的看似矛盾的事实。现在我知道了混乱的原因：

首先，在我的 Linux 环境中：

$ cd /path/to/home  
$ mkdir cmake-test  
$ cd cmake-test  
$ mkdir source  
$ mkdir source/subdirectory  
$ mkdir build  

我创建了这两个文件：

$ cat source/CMakeLists.txt  
include(subdirectory/foo.cmake)  

$ cat source/subdirectory/foo.cmake  
message("CMAKE_CURRENT_LIST_DIR is ${CMAKE_CURRENT_LIST_DIR}")  

Fraser 和 Robert Dailey 报告的 CMake 工作原理：

$ cd build  
$ cmake ../source  
CMAKE_CURRENT_LIST_DIR is /path/to/home/cmake-test/source/subdirectory  
[...]  

但是，我在 foo.cmake 中添加了一个函数，我从 CMakeLists.txt 调用它：

$ cat ../source/subdirectory/foo.cmake  
message("CMAKE_CURRENT_LIST_DIR is ${CMAKE_CURRENT_LIST_DIR}")  
function(bar)  
    message("CMAKE_CURRENT_LIST_DIR in bar() is ${CMAKE_CURRENT_LIST_DIR}")  
endfunction()  

$ cat ../source/CMakeLists.txt  
include(subdirectory/foo.cmake)  
bar()  

然后：

$ cmake ../source  
CMAKE_CURRENT_LIST_DIR is /path/to/home/cmake-test/source/subdirectory  
CMAKE_CURRENT_LIST_DIR in bar() is /path/to/home/cmake-test/source  
[...]  

因此，在包含 foo.cmake 和调用 bar() 时， foo.cmake 中的 CMAKE_CURRENT_LIST_DIR 的值是不一样的。这是根据CMAKE_CURRENT_LIST_DIR的规范。

这是从 bar() 中访问 foo.cmake 目录的一种可能解决方案：

$ cat ../source/subdirectory/foo.cmake  
set(DIR_OF_FOO_CMAKE ${CMAKE_CURRENT_LIST_DIR})  
function(bar)  
    message("DIR_OF_FOO_CMAKE in bar() is ${DIR_OF_FOO_CMAKE}")  
endfunction()  

之后我得到了我正在寻找的行为：

$ cmake ../source  
DIR_OF_FOO_CMAKE in bar() is /path/to/home/cmake-test/source/subdirectory  
[...]  

Answer 2

见CMAKE_CURRENT_LIST_DIR:

当前正在处理的列表文件的完整目录。

当 CMake 处理项目中的列表文件时，此变量将 始终设置为当前列表文件所在的目录 正在处理 (CMAKE_CURRENT_LIST_FILE) 的位置。值有 动态范围。当 CMake 开始处理源文件中的命令时 它将这个变量设置为这个文件所在的目录。 当 CMake 完成处理来自文件的命令时，它会恢复 以前的值。因此，宏内部变量的值或 function 是调用最底部条目的文件的目录 在调用堆栈上，而不是包含宏的文件的目录 或函数定义。

示例

我有以下结构：

C:\Work\cmake-test\CMakeLists.txt
C:\Work\cmake-test\subfolder\test.cmake

在我的CMakeLists.txt:

include( subfolder/test.cmake )

在我的test.cmake：

message( "Current dir: ${CMAKE_CURRENT_LIST_DIR}" )

我从C:\Work\cmake-test 运行 CMake 时得到的结果是：

当前目录：C:/Work/cmake-test/subfolder

Answer 3

在 CMake 3.17 中，have a new variable 可用，称为CMAKE_CURRENT_FUNCTION_LIST_DIR，可以在函数内部使用。它在函数定义之外是未定义的。

function(foo)
  configure_file(
    "${CMAKE_CURRENT_FUNCTION_LIST_DIR}/some.template.in"
    some.output
  )
endfunction()

在 CMake 3.17 之前，CMAKE_CURRENT_FUNCTION_LIST_DIR 功能必须通过以下解决方法近似于 CMAKE_CURRENT_LIST_DIR，取自 CMake 文档：

set(_THIS_MODULE_BASE_DIR "${CMAKE_CURRENT_LIST_DIR}")

function(foo)
  configure_file(
    "${_THIS_MODULE_BASE_DIR}/some.template.in"
    some.output
  )
endfunction()

Answer 4

include() 命令首先在 ${CMAKE_MODULE_PATH} 中搜索模块，然后在 CMake Modules 目录中搜索。

因此您可以使用if(EXISTS ${CMAKE_MODULE_PATH}/foo.cmake) 和if(EXISTS ${CMAKE_ROOT}/Modules/foo.cmake) 检查文件是否存在。