CMAKE_CURRENT_FUNCTION_LIST_DIR

在 3.17 版本中添加。

当在 function() 内部执行代码时,此变量包含定义当前函数的列表文件的完整目录。

在 CMake 中,模块通常使用一些额外的文件,例如在替换 CMake 变量后要复制的模板,这是一种非常常见的做法。在这种情况下,函数需要知道如何在不依赖于函数被调用的位置的情况下定位这些文件。如果没有 CMAKE_CURRENT_FUNCTION_LIST_DIR,执行此操作的代码通常会使用以下模式

set(_THIS_MODULE_BASE_DIR "${CMAKE_CURRENT_LIST_DIR}")

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

在函数内部使用 CMAKE_CURRENT_FUNCTION_LIST_DIR 消除了对额外变量的需求,否则该变量在函数范围之外是可见的。上面的示例可以用更简洁和更健壮的形式编写

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

另请参阅 CMAKE_CURRENT_FUNCTIONCMAKE_CURRENT_FUNCTION_LIST_FILECMAKE_CURRENT_FUNCTION_LIST_LINECMAKE_CURRENT_LIST_DIR