cmake_language

在 3.18 版本中新增。

对 CMake 命令执行元操作。

概要

cmake_language(CALL <command> [<arg>...])
cmake_language(EVAL CODE <code>...)
cmake_language(DEFER <options>... CALL <command> [<arg>...])
cmake_language(SET_DEPENDENCY_PROVIDER <command> SUPPORTED_METHODS <methods>...)
cmake_language(GET_MESSAGE_LOG_LEVEL <out-var>)
cmake_language(EXIT <exit-code>)

简介

此命令将对内置的 CMake 命令或通过 macro() 或 function() 命令创建的命令执行元操作。

cmake_language 不会引入新的变量或策略范围。

调用命令

cmake_language(CALL <command> [<arg>...])

调用指定名称的 <command> 并传递给定的参数（如果有）。例如，代码

set(message_command "message")
cmake_language(CALL ${message_command} STATUS "Hello World!")

等价于

message(STATUS "Hello World!")

注意

为确保代码一致性，以下命令不被允许：

• if / elseif / else / endif

• block / endblock

• while / endwhile

• foreach / endforeach

• function / endfunction

• macro / endmacro

评估代码

cmake_language(EVAL CODE <code>...)

将 <code>... 评估为 CMake 代码。

例如，以下代码：

set(A TRUE)
set(B TRUE)
set(C TRUE)
set(condition "(A AND B) OR C")

cmake_language(EVAL CODE "
  if (${condition})
    message(STATUS TRUE)
  else()
    message(STATUS FALSE)
  endif()"
)

等价于

set(A TRUE)
set(B TRUE)
set(C TRUE)
set(condition "(A AND B) OR C")

file(WRITE ${CMAKE_CURRENT_BINARY_DIR}/eval.cmake "
  if (${condition})
    message(STATUS TRUE)
  else()
    message(STATUS FALSE)
  endif()"
)

include(${CMAKE_CURRENT_BINARY_DIR}/eval.cmake)

延迟调用

3.19 版本新增。

cmake_language(DEFER <options>... CALL <command> [<arg>...])

调度对指定 <command> 的调用，并传递给定的参数（如果有），以便在稍后执行。默认情况下，延迟调用就像写在当前目录的 CMakeLists.txt 文件的末尾一样执行，只是它们甚至在 return() 调用之后也会运行。参数中的变量引用在延迟调用执行时进行评估。

选项包括

DIRECTORY <dir>

将调用安排在给定目录的末尾，而不是当前目录的末尾。<dir> 可以引用源目录或其对应的二进制目录。相对路径被视为相对于当前源目录。

给定的目录必须是 CMake 已知的，可以是顶级目录或由 add_subdirectory() 添加的目录。此外，给定的目录必须尚未完成处理。这意味着它可以是当前目录或其某个祖先目录。

ID <id>

为延迟调用指定一个标识。<id> 不得为空，且不得以大写字母 A-Z 开头。<id> 只有在使用 ID_VAR 获取 ID 的早期调用自动生成时，才能以下划线 (_) 开头。

ID_VAR <var>

指定一个变量来存储延迟调用的标识。如果未给定 ID <id>，则将生成一个新的标识，并且生成的 ID 将以下划线 (_) 开头。

可以检索当前调度的延迟调用列表：

cmake_language(DEFER [DIRECTORY <dir>] GET_CALL_IDS <var>)

这将把延迟调用 ID 的分号分隔列表存储在 <var> 中。这些 ID 针对调用被延迟到的目录范围（即它们将执行的位置），这可能与它们创建的范围不同。可以使用 DIRECTORY 选项来指定要检索调用 ID 的范围。如果未给定该选项，则将返回当前目录范围的调用 ID。

可以通过其 ID 检索特定调用的详细信息：

cmake_language(DEFER [DIRECTORY <dir>] GET_CALL <id> <var>)

这将把分号分隔列表存储到 <var> 中，其中第一个元素是要调用的命令的名称，其余元素是其未评估的参数（其中包含的 ; 字符是字面包含的，无法与多个参数区分）。如果多个调用调度了相同的 ID，则会检索第一个。如果在指定的 DIRECTORY 范围（或未给定 DIRECTORY 选项时的当前目录范围）中没有调度给定 ID 的调用，则此变量将存储一个空字符串。

延迟调用可以通过其 ID 取消：

cmake_language(DEFER [DIRECTORY <dir>] CANCEL_CALL <id>...)

这将取消在指定 DIRECTORY 范围（如果未指定 DIRECTORY 选项，则为当前目录范围）内与任何给定 ID 匹配的所有延迟调用。未知 ID 会被静默忽略。

延迟调用示例

例如，以下代码：

cmake_language(DEFER CALL message "${deferred_message}")
cmake_language(DEFER ID_VAR id CALL message "Canceled Message")
cmake_language(DEFER CANCEL_CALL ${id})
message("Immediate Message")
set(deferred_message "Deferred Message")

打印

Immediate Message
Deferred Message

Canceled Message 永远不会打印，因为其命令被取消了。deferred_message 变量引用直到调用站点才被评估，因此可以在调度延迟调用后设置它。

为了在调度延迟调用时立即评估变量引用，请使用 cmake_language(EVAL) 包装它。但是，请注意参数将在延迟调用中重新评估，尽管可以通过使用括号参数来避免这种情况。例如

set(deferred_message "Deferred Message 1")
set(re_evaluated [[${deferred_message}]])
cmake_language(EVAL CODE "
  cmake_language(DEFER CALL message [[${deferred_message}]])
  cmake_language(DEFER CALL message \"${re_evaluated}\")
")
message("Immediate Message")
set(deferred_message "Deferred Message 2")

也打印

Immediate Message
Deferred Message 1
Deferred Message 2

依赖提供者

在 3.24 版本中添加。

注意

此功能的高级介绍可以在使用依赖项指南中找到。

cmake_language(SET_DEPENDENCY_PROVIDER <command> SUPPORTED_METHODS <methods>...)

当调用 find_package() 或 FetchContent_MakeAvailable() 时，该调用可能会转发给依赖提供者，然后提供者有机会满足请求。如果请求是提供者设置时指定的 <methods> 之一，CMake 将调用提供者的 <command> 并带有一组特定于方法的参数。如果提供者未能满足请求，或者提供者不支持请求的方法，或者未设置提供者，则将使用内置的 find_package() 或 FetchContent_MakeAvailable() 实现以通常方式满足请求。

设置提供者时，可以为 <methods> 指定以下一个或多个值：

FIND_PACKAGE

提供者命令接受 find_package() 请求。

FETCHCONTENT_MAKEAVAILABLE_SERIAL

提供者命令接受 FetchContent_MakeAvailable() 请求。它期望每个依赖项一次一个地提供给提供者命令，而不是一次提供整个列表。

在任何时间点只能设置一个提供者。如果调用 cmake_language(SET_DEPENDENCY_PROVIDER) 时已设置提供者，则新提供者将替换之前设置的提供者。当调用 cmake_language(SET_DEPENDENCY_PROVIDER) 时，指定的 <command> 必须已经存在。作为特例，为 <command> 提供空字符串且不提供 <methods> 将丢弃任何之前设置的提供者。

依赖提供者只能在处理 CMAKE_PROJECT_TOP_LEVEL_INCLUDES 变量指定的文件之一时设置。因此，依赖提供者只能作为对 project() 的第一次调用的一部分进行设置。在此上下文之外调用 cmake_language(SET_DEPENDENCY_PROVIDER) 将导致错误。

3.30 版本新增： 如果依赖提供者还希望在对 try_compile() 的整个项目调用中启用，则可以设置 PROPAGATE_TOP_LEVEL_INCLUDES_TO_TRY_COMPILE 全局属性。

注意

依赖提供者的选择应始终由用户控制。为了方便，项目可以选择提供一个文件，用户可以在其 CMAKE_PROJECT_TOP_LEVEL_INCLUDES 变量中列出，但使用此类文件应始终是用户的选择。

提供者命令

提供者定义了一个单独的 <command> 来接受请求。命令的名称应特定于该提供者，而不是其他提供者也可能使用的过于通用的名称。这使得用户可以在自己的自定义提供者中组合不同的提供者。推荐的形式是 xxx_provide_dependency()，其中 xxx 是提供者特定部分（例如 vcpkg_provide_dependency()、conan_provide_dependency()、ourcompany_provide_dependency() 等）。

xxx_provide_dependency(<method> [<method-specific-args>...])

由于某些方法期望在调用范围内设置某些变量，因此提供者命令通常应作为宏而不是函数来实现。这确保它不会引入新的变量范围。

CMake 传递给依赖提供者的参数取决于请求的类型。第一个参数始终是方法，并且它将始终是设置提供者时指定的 <methods> 之一。

FIND_PACKAGE

<method-specific-args> 将是传递给请求依赖项的 find_package() 调用的所有内容。因此，这些 <method-specific-args> 的第一个参数将始终是依赖项的名称。对于此方法，依赖项名称区分大小写，因为 find_package() 也将其视为区分大小写。

如果提供者命令满足了请求，它必须设置与 find_package() 期望设置的变量相同的变量。对于名为 depName 的依赖项，如果提供者满足了请求，它必须将 depName_FOUND 设置为 true。如果提供者返回而未设置此变量，CMake 将假定请求未满足，并将回退到内置实现。

如果提供者需要在其处理过程中调用内置的 find_package() 实现，它可以通过将 BYPASS_PROVIDER 关键字作为其中一个参数来完成。

FETCHCONTENT_MAKEAVAILABLE_SERIAL

<method-specific-args> 将是传递给与请求的依赖项对应的 FetchContent_Declare() 调用的所有内容，但以下情况除外：

• 如果 SOURCE_DIR 或 BINARY_DIR 不属于原始声明的参数，它们将以其默认值添加。

• 如果 FETCHCONTENT_TRY_FIND_PACKAGE_MODE 设置为 NEVER，则将省略任何 FIND_PACKAGE_ARGS。

• 总是省略 OVERRIDE_FIND_PACKAGE 关键字。

<method-specific-args> 的第一个参数始终是依赖项的名称。对于此方法，依赖项名称不区分大小写，因为 FetchContent 也将其视为不区分大小写。

如果提供者满足请求，它应该调用 FetchContent_SetPopulated()，并将依赖项的名称作为第一个参数传递。该命令的 SOURCE_DIR 和 BINARY_DIR 参数只应在提供者以与内置 FetchContent_MakeAvailable() 命令完全相同的方式提供依赖项的源目录和构建目录时才给定。

如果提供者返回时未为指定依赖项调用 FetchContent_SetPopulated()，CMake 将假定请求未满足，并将回退到内置实现。

请注意，对于此方法，空参数可能很重要（例如，GIT_SUBMODULES 关键字后面的空字符串）。因此，如果将这些参数转发到另一个命令，则必须格外小心，以避免这些参数被静默丢弃。

如果设置了 FETCHCONTENT_SOURCE_DIR_<uppercaseDepName>，则依赖提供者将永远不会看到此方法对 <depName> 依赖项的请求。当用户设置此类变量时，他们明确地覆盖了获取该依赖项的位置，并承担了其覆盖版本满足该依赖项的任何要求并与项目中其他使用该依赖项的内容兼容的责任。根据 FETCHCONTENT_TRY_FIND_PACKAGE_MODE 的值以及是否将 OVERRIDE_FIND_PACKAGE 选项提供给 FetchContent_Declare()，设置 FETCHCONTENT_SOURCE_DIR_<uppercaseDepName> 也可能阻止依赖提供者看到对 find_package(depName) 调用的请求。

提供者示例

第一个示例只拦截 find_package() 调用。如果外部工具知道该依赖项，提供者命令将运行该工具并将相关工件复制到提供者特定目录。然后，它依赖内置实现来查找这些工件。FetchContent_MakeAvailable() 调用不会通过提供者。

mycomp_provider.cmake

# Always ensure we have the policy settings this provider expects
cmake_minimum_required(VERSION 3.24)

set(MYCOMP_PROVIDER_INSTALL_DIR ${CMAKE_BINARY_DIR}/mycomp_packages
  CACHE PATH "The directory this provider installs packages to"
)
# Tell the built-in implementation to look in our area first, unless
# the find_package() call uses NO_..._PATH options to exclude it
list(APPEND CMAKE_MODULE_PATH ${MYCOMP_PROVIDER_INSTALL_DIR}/cmake)
list(APPEND CMAKE_PREFIX_PATH ${MYCOMP_PROVIDER_INSTALL_DIR})

macro(mycomp_provide_dependency method package_name)
  execute_process(
    COMMAND some_tool ${package_name} --installdir ${MYCOMP_PROVIDER_INSTALL_DIR}
    COMMAND_ERROR_IS_FATAL ANY
  )
endmacro()

cmake_language(
  SET_DEPENDENCY_PROVIDER mycomp_provide_dependency
  SUPPORTED_METHODS FIND_PACKAGE
)

用户通常会像这样使用上面的文件

cmake -DCMAKE_PROJECT_TOP_LEVEL_INCLUDES=/path/to/mycomp_provider.cmake ...

下一个示例演示了一个接受两种方法但只处理一个特定依赖项的提供者。它强制使用 FetchContent 提供 Google Test，但将所有其他依赖项留给 CMake 的内置实现来完成。它接受几个不同的名称，这演示了如何解决项目硬编码不寻常或不希望的方式将此特定依赖项添加到构建中的问题。该示例还演示了如何使用 list() 命令来保留可能被 FetchContent_MakeAvailable() 调用覆盖的变量。

mycomp_provider.cmake

cmake_minimum_required(VERSION 3.24)

# Because we declare this very early, it will take precedence over any
# details the project might declare later for the same thing
include(FetchContent)
FetchContent_Declare(
  googletest
  GIT_REPOSITORY https://github.com/google/googletest.git
  GIT_TAG        e2239ee6043f73722e7aa812a459f54a28552929 # release-1.11.0
)

# Both FIND_PACKAGE and FETCHCONTENT_MAKEAVAILABLE_SERIAL methods provide
# the package or dependency name as the first method-specific argument.
macro(mycomp_provide_dependency method dep_name)
  if("${dep_name}" MATCHES "^(gtest|googletest)$")
    # Save our current command arguments in case we are called recursively
    list(APPEND mycomp_provider_args ${method} ${dep_name})

    # This will forward to the built-in FetchContent implementation,
    # which detects a recursive call for the same thing and avoids calling
    # the provider again if dep_name is the same as the current call.
    FetchContent_MakeAvailable(googletest)

    # Restore our command arguments
    list(POP_BACK mycomp_provider_args dep_name method)

    # Tell the caller we fulfilled the request
    if("${method}" STREQUAL "FIND_PACKAGE")
      # We need to set this if we got here from a find_package() call
      # since we used a different method to fulfill the request.
      # This example assumes projects only use the gtest targets,
      # not any of the variables the FindGTest module may define.
      set(${dep_name}_FOUND TRUE)
    elseif(NOT "${dep_name}" STREQUAL "googletest")
      # We used the same method, but were given a different name to the
      # one we populated with. Tell the caller about the name it used.
      FetchContent_SetPopulated(${dep_name}
        SOURCE_DIR "${googletest_SOURCE_DIR}"
        BINARY_DIR "${googletest_BINARY_DIR}"
      )
    endif()
  endif()
endmacro()

cmake_language(
  SET_DEPENDENCY_PROVIDER mycomp_provide_dependency
  SUPPORTED_METHODS
    FIND_PACKAGE
    FETCHCONTENT_MAKEAVAILABLE_SERIAL
)

最后一个示例演示了如何修改 find_package() 调用的参数。它强制所有此类调用都带上 QUIET 关键字。它使用 BYPASS_PROVIDER 关键字来防止对同一依赖项递归调用提供者命令。

mycomp_provider.cmake

cmake_minimum_required(VERSION 3.24)

macro(mycomp_provide_dependency method)
  find_package(${ARGN} BYPASS_PROVIDER QUIET)
endmacro()

cmake_language(
  SET_DEPENDENCY_PROVIDER mycomp_provide_dependency
  SUPPORTED_METHODS FIND_PACKAGE
)

获取当前消息日志级别

在 3.25 版本中新增。

cmake_language(GET_MESSAGE_LOG_LEVEL <output_variable>)

将当前的 message() 日志级别写入给定的 <output_variable>。

有关可能的日志级别，请参阅 message()。

当前消息日志级别可以使用 cmake(1) 程序的 --log-level 命令行选项或使用 CMAKE_MESSAGE_LOG_LEVEL 变量进行设置。

如果命令行选项和变量都设置了，则命令行选项优先。如果两者都没有设置，则返回默认日志级别。

终止脚本

在版本 3.29 中添加。

cmake_language(EXIT <exit-code>)

终止当前 cmake -P 脚本并以 <exit-code> 退出。

此命令仅在脚本模式下有效。如果在该上下文之外使用，将导致致命错误。

<exit-code> 应为非负数。如果 <exit-code> 为负数，则行为未定义（例如，在 Windows 上，错误代码 -1 变为 0xffffffff，在 Linux 上变为 255）。退出代码超过 255 可能不受底层 shell 或平台支持，并且某些 shell 可能会特殊解释超过 125 的值。因此，建议只指定范围在 0 到 125 之间的 <exit-code>。