try_compile

尝试构建一些代码。

尝试编译整个项目

try_compile(<compileResultVar> PROJECT <projectName>
            SOURCE_DIR <srcdir>
            [BINARY_DIR <bindir>]
            [TARGET <targetName>]
            [LOG_DESCRIPTION <text>]
            [NO_CACHE]
            [NO_LOG]
            [CMAKE_FLAGS <flags>...]
            [OUTPUT_VARIABLE <var>])

在 3.25 版本中新增。

尝试构建项目。构建成功在 <compileResultVar> 中返回 TRUE,构建失败返回 FALSE

在此形式中,<srcdir> 应包含一个完整的 CMake 项目,其中包含 CMakeLists.txt 文件和所有源文件。此命令运行后,<bindir><srcdir> 不会被删除。指定 <targetName> 以构建特定目标,而不是 allALL_BUILD 目标。其他选项的含义见下文。

3.24 版本变更: 描述平台设置的 CMake 变量,以及 CMAKE_TRY_COMPILE_PLATFORM_VARIABLES 变量列出的那些变量,会被传播到项目的构建配置中。参见策略 CMP0137。以前这仅由源文件签名完成。

3.26 版本新增: 如果未指定 NO_LOG 选项,此命令会记录一个configure-log try_compile 事件

3.30 版本新增: 如果 PROPAGATE_TOP_LEVEL_INCLUDES_TO_TRY_COMPILE 全局属性设置为 true,则 CMAKE_PROJECT_TOP_LEVEL_INCLUDES 会传播到项目的构建配置中。

此命令支持 CMake 3.25 之前的替代签名。建议使用上述签名以提高清晰度。

try_compile(<compileResultVar> <bindir> <srcdir>
            <projectName> [<targetName>]
            [CMAKE_FLAGS <flags>...]
            [OUTPUT_VARIABLE <var>])

尝试编译源文件

try_compile(<compileResultVar>
            [SOURCES_TYPE <type>]
            <SOURCES <srcfile...>                 |
             SOURCE_FROM_CONTENT <name> <content> |
             SOURCE_FROM_VAR <name> <var>         |
             SOURCE_FROM_FILE <name> <path>       >...
            [LOG_DESCRIPTION <text>]
            [NO_CACHE]
            [NO_LOG]
            [CMAKE_FLAGS <flags>...]
            [COMPILE_DEFINITIONS <defs>...]
            [LINK_OPTIONS <options>...]
            [LINK_LIBRARIES <libs>...]
            [LINKER_LANGUAGE <lang>]
            [OUTPUT_VARIABLE <var>]
            [COPY_FILE <fileName> [COPY_FILE_ERROR <var>]]
            [<LANG>_STANDARD <std>]
            [<LANG>_STANDARD_REQUIRED <bool>]
            [<LANG>_EXTENSIONS <bool>]
            )

在 3.25 版本中新增。

尝试从一个或多个源文件构建可执行文件或静态库。二进制类型由变量 CMAKE_TRY_COMPILE_TARGET_TYPE 确定。构建成功在 <compileResultVar> 中返回布尔值 true,构建失败返回布尔值 false(除非指定了 NO_CACHE,否则缓存)。

在此形式中,必须提供一个或多个源文件。此外,SOURCES 和/或 SOURCE_FROM_* 必须在其他关键字之前。

如果 CMAKE_TRY_COMPILE_TARGET_TYPE 未设置或设置为 EXECUTABLE,则源文件必须包含 main 的定义,CMake 将创建一个 CMakeLists.txt 文件以将源文件构建为可执行文件。如果 CMAKE_TRY_COMPILE_TARGET_TYPE 设置为 STATIC_LIBRARY,则将构建静态库,并且不需要 main 的定义。对于可执行文件,生成的 CMakeLists.txt 文件将包含类似以下内容

add_definitions(<expanded COMPILE_DEFINITIONS from caller>)
include_directories(${INCLUDE_DIRECTORIES})
link_directories(${LINK_DIRECTORIES})
add_executable(cmTryCompileExec <srcfile>...)
target_link_options(cmTryCompileExec PRIVATE <LINK_OPTIONS from caller>)
target_link_libraries(cmTryCompileExec ${LINK_LIBRARIES})

CMake 会为每个 try_compile 操作在 ${CMAKE_BINARY_DIR}/CMakeFiles/CMakeScratch 下自动生成一个具有未指定名称的唯一目录。除非将 --debug-trycompile 传递给 cmake,否则这些目录会自动清理。任何 cmake 执行开始时,也会无条件清理先前运行中的此类目录。

此命令支持 CMake 3.25 之前的替代签名。建议使用上述签名以提高清晰度。

try_compile(<compileResultVar> <bindir> <srcfile|SOURCES srcfile...>
            [CMAKE_FLAGS <flags>...]
            [COMPILE_DEFINITIONS <defs>...]
            [LINK_OPTIONS <options>...]
            [LINK_LIBRARIES <libs>...]
            [OUTPUT_VARIABLE <var>]
            [COPY_FILE <fileName> [COPY_FILE_ERROR <var>]]
            [<LANG>_STANDARD <std>]
            [<LANG>_STANDARD_REQUIRED <bool>]
            [<LANG>_EXTENSIONS <bool>]
            )

在此版本中,try_compile 将使用 <bindir>/CMakeFiles/CMakeTmp 进行操作,所有此类文件将自动清理。为了调试,可以将 --debug-trycompile 传递给 cmake 以避免此清理。但是,多个连续的 try_compile 操作,如果给定相同的 <bindir>,将重用此单个输出目录,因此您一次只能调试一个此类 try_compile 调用。建议使用较新的签名来简化多个 try_compile 操作的调试。

选项

上述签名的选项是

CMAKE_FLAGS <flags>...

指定形如 -DVAR:TYPE=VALUE 的标志,以传递给用于驱动测试构建的 cmake(1) 命令行。上述示例展示了变量 COMPILE_DEFINITIONSINCLUDE_DIRECTORIESLINK_DIRECTORIESLINK_LIBRARIESLINK_OPTIONS 的值是如何使用的。编译器选项可以像 CMAKE_FLAGS -DCOMPILE_DEFINITIONS=-Werror 这样传递。

COMPILE_DEFINITIONS <defs>...

指定 -Ddefinition 参数以传递给生成测试项目中的 add_definitions()

COPY_FILE <fileName>

将构建的可执行文件或静态库复制到给定的 <fileName>

COPY_FILE_ERROR <var>

COPY_FILE 之后使用,以将尝试复制文件时遇到的任何错误消息捕获到变量 <var> 中。

LINK_LIBRARIES <libs>...

指定要在生成项目中链接的库。库列表可以引用系统库和调用项目中的导入目标

如果指定了此选项,则传递给 CMAKE_FLAGS 选项的任何 -DLINK_LIBRARIES=... 值将被忽略。

3.29 版本新增: 还支持导入库的别名目标。

LINK_OPTIONS <options>...

3.14 版新增。

指定链接步骤选项以传递给 target_link_options() 或设置生成项目中的 STATIC_LIBRARY_OPTIONS 目标属性,具体取决于 CMAKE_TRY_COMPILE_TARGET_TYPE 变量。

LINKER_LANGUAGE <lang>

在版本 3.29 中添加。

指定生成项目的 LINKER_LANGUAGE 目标属性。当使用具有不同语言的多个源文件时,将其设置为包含程序入口点(例如 main)的源文件的语言。

LOG_DESCRIPTION <text>

3.26 版新增。

指定检查目的的非空文本描述。这记录在 cmake-configure-log(7) 条目中。

NO_CACHE

在 3.25 版本中新增。

<compileResultVar> 将存储在普通变量中,而不是缓存条目中。

<compileResultVar> 通常会被缓存,以便可以使用简单模式来避免在后续执行 CMake 时重复测试

if(NOT DEFINED RESULTVAR)
  # ...(check-specific setup code)...
  try_compile(RESULTVAR ...)
  # ...(check-specific logging and cleanup code)...
endif()

如果防护变量和结果变量不相同(例如,如果测试是更大检查的一部分),NO_CACHE 可能有助于避免将中间结果变量泄露到缓存中。

NO_LOG

3.26 版新增。

不为此调用记录 cmake-configure-log(7) 条目。

OUTPUT_VARIABLE <var>

将构建过程的输出存储在给定变量中。

SOURCE_FROM_CONTENT <name> <content>

在 3.25 版本中新增。

<content> 写入操作目录中名为 <name> 的文件。当文件内容是动态指定时,这可以用来绕过单独编写源文件的需要。指定的 <name> 不允许包含路径组件。

SOURCE_FROM_CONTENT 可以指定多次。

SOURCE_FROM_FILE <name> <path>

在 3.25 版本中新增。

<path> 复制到操作目录中名为 <name> 的文件。这可用于将文件合并到操作目录中,如果已存在的源文件(即作为项目源存储库中的独立文件)需要引用由 SOURCE_FROM_* 创建的其他文件,这可能很有用。(否则,SOURCES 通常更方便。)指定的 <name> 不允许包含路径组件。

SOURCE_FROM_VAR <name> <var>

在 3.25 版本中新增。

<var> 的内容写入操作目录中名为 <name> 的文件。这与 SOURCE_FROM_CONTENT 相同,但内容来自指定的 CMake 变量,而不是直接获取,当通过包装 try_compile 的函数传递参数时,这可能很有用。指定的 <name> 不允许包含路径组件。

SOURCE_FROM_VAR 可以指定多次。

SOURCES_TYPE <type>

版本 3.28 新增。

源文件可以使用 SOURCES_TYPE 参数进行分类。一旦指定,所有后续指定的源文件都将视为该类型,直到给出另一个 SOURCES_TYPE。可用类型有

NORMAL

源文件不会添加到生成项目中的任何 FILE_SET 中。

CXX_MODULE

版本 3.28 新增。

源文件被添加到生成项目中类型为 CXX_MODULESFILE_SET 中。

源文件的默认类型是 NORMAL

<LANG>_STANDARD <std>

版本 3.8 新增。

指定生成项目的 C_STANDARDCXX_STANDARDOBJC_STANDARDOBJCXX_STANDARDCUDA_STANDARD 目标属性。

<LANG>_STANDARD_REQUIRED <bool>

版本 3.8 新增。

指定生成项目的 C_STANDARD_REQUIREDCXX_STANDARD_REQUIREDOBJC_STANDARD_REQUIREDOBJCXX_STANDARD_REQUIREDCUDA_STANDARD_REQUIRED 目标属性。

<LANG>_EXTENSIONS <bool>

版本 3.8 新增。

指定生成项目的 C_EXTENSIONSCXX_EXTENSIONSOBJC_EXTENSIONSOBJCXX_EXTENSIONSCUDA_EXTENSIONS 目标属性。

其他行为设置

3.4 版本新增: 如果设置,以下变量将传递到生成的 try_compile CMakeLists.txt 中,以使用默认值初始化编译目标属性

3.14 版本变更: 如果 CMP0083 设置为 NEW,为了在链接时获得正确行为,必须在使用 try_compile 命令之前调用 CheckPIESupported 模块中的 check_pie_supported() 命令。

某些策略在生成的测试项目中根据需要自动设置,以遵循调用项目的状态

4.0 版本新增: CMP0181 策略的当前设置将传播到生成的测试项目。

设置变量 CMAKE_TRY_COMPILE_CONFIGURATION 以选择构建配置

  • 对于多配置生成器,这会选择要构建的配置。

  • 对于单配置生成器,这会在测试项目中设置 CMAKE_BUILD_TYPE

3.6 版本新增: 设置 CMAKE_TRY_COMPILE_TARGET_TYPE 变量以指定用于源文件签名的目标类型。

3.6 版本新增: 设置 CMAKE_TRY_COMPILE_PLATFORM_VARIABLES 变量以指定必须传播到测试项目的变量。此变量仅用于工具链文件,并且仅在源文件形式的 try_compile() 命令中有效,而不适用于给定整个项目的情况。

3.8 版本变更: 如果 CMP0067 设置为 NEW,或者使用了任何 <LANG>_STANDARD<LANG>_STANDARD_REQUIRED<LANG>_EXTENSIONS 选项,则语言标准变量有效

它们的值用于在生成的项目中设置相应的目标属性(除非被显式选项覆盖)。

3.14 版本变更: 对于 Green Hills MULTI 生成器,GHS 工具集和目标系统定制缓存变量也会传播到测试项目中。

3.24 版本新增: 可以设置 CMAKE_TRY_COMPILE_NO_PLATFORM_VARIABLES 变量以禁用将平台变量传递到测试项目中。

3.25 版本新增: 如果 CMP0141 设置为 NEW,则可以使用 CMAKE_MSVC_DEBUG_INFORMATION_FORMAT 指定 MSVC 调试信息格式。

3.30 版本新增: 如果 PROPAGATE_TOP_LEVEL_INCLUDES_TO_TRY_COMPILE 全局属性设置为 true,则在使用整个项目签名时,CMAKE_PROJECT_TOP_LEVEL_INCLUDES 将传播到测试项目的构建配置中。

4.0 版本新增: 如果 CMP0184 设置为 NEW,则可以使用 CMAKE_MSVC_RUNTIME_CHECKS 来指定启用的 MSVC 运行时检查。

另请参阅