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>)

这将在 <var> 中存储一个分号分隔的列表，其中包含延迟调用 id。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) 时已设置提供程序，则新提供程序将替换先前设置的提供程序。指定的 <command> 在调用 cmake_language(SET_DEPENDENCY_PROVIDER) 时必须已存在。作为特殊情况，为 <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()，并将依赖项的名称作为第一个参数传递。仅当提供程序以与内置的 FetchContent_MakeAvailable() 命令完全相同的方式提供依赖项的源目录和构建目录时，才应向该命令提供 SOURCE_DIR 和 BINARY_DIR 参数。

如果提供程序返回时未针对命名的依赖项调用 FetchContent_SetPopulated()，则 CMake 将假定请求未满足，并将回退到内置实现。

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

如果设置了 FETCHCONTENT_SOURCE_DIR_<uppercaseDepName>，则依赖项提供程序将永远不会看到针对此方法的 <depName> 依赖项的请求。当用户设置此类变量时，他们会显式覆盖从哪里获取该依赖项，并承担其覆盖版本满足该依赖项的任何要求并与项目中使用它的任何其他内容兼容的责任。根据 FETCHCONTENT_TRY_FIND_PACKAGE_MODE 的值以及是否为 FetchContent_Declare() 提供了 OVERRIDE_FIND_PACKAGE 选项，设置 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()。

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

如果命令行选项和变量都已设置，则命令行选项优先。如果两者均未设置，则返回默认日志记录级别。

终止脚本¶

在 3.29 版本中加入。

cmake_language(EXIT <exit-code>)¶

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

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

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

cmake_language¶

概要¶

简介¶

调用命令¶

评估代码¶

延迟调用¶

延迟调用示例¶

依赖项提供程序¶

提供程序命令¶

提供程序示例¶

获取当前消息日志级别¶

终止脚本¶

目录

上一主题

下一主题

本页