try_run

尝试编译然后运行一些代码。

尝试编译并运行源文件

try_run(<runResultVar> <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>...]
        [COMPILE_OUTPUT_VARIABLE <var>]
        [COPY_FILE <fileName> [COPY_FILE_ERROR <var>]]
        [<LANG>_STANDARD <std>]
        [<LANG>_STANDARD_REQUIRED <bool>]
        [<LANG>_EXTENSIONS <bool>]
        [RUN_OUTPUT_VARIABLE <var>]
        [RUN_OUTPUT_STDOUT_VARIABLE <var>]
        [RUN_OUTPUT_STDERR_VARIABLE <var>]
        [WORKING_DIRECTORY <var>]
        [ARGS <args>...]
        )

在 3.25 版本中添加。

尝试从一个或多个源文件构建可执行文件。构建成功返回 TRUE，构建失败返回 FALSE 在 <compileResultVar> 中。如果构建成功，这将运行可执行文件并将退出代码存储在 <runResultVar> 中。如果可执行文件已构建，但运行失败，则 <runResultVar> 将设置为 FAILED_TO_RUN。有关适用于这两个命令的选项的文档，以及有关如何构建测试项目来构建源文件的信息，请参见命令 try_compile()。

必须提供一个或多个源文件。此外， SOURCES 和/或 SOURCE_FROM_* 之一必须位于其他关键字之前。

在 3.26 版本中添加： 如果不指定 NO_LOG 选项，此命令会记录一个 configure-log try_run 事件。

对于早于 3.25 的 CMake，此命令支持另签名。建议使用上面推荐清晰的签名。

try_run(<runResultVar> <compileResultVar>
        <bindir> <srcfile|SOURCES srcfile...>
        [CMAKE_FLAGS <flags>...]
        [COMPILE_DEFINITIONS <defs>...]
        [LINK_OPTIONS <options>...]
        [LINK_LIBRARIES <libs>...]
        [LINKER_LANGUAGE <lang>]
        [COMPILE_OUTPUT_VARIABLE <var>]
        [COPY_FILE <fileName> [COPY_FILE_ERROR <var>]]
        [<LANG>_STANDARD <std>]
        [<LANG>_STANDARD_REQUIRED <bool>]
        [<LANG>_EXTENSIONS <bool>]
        [RUN_OUTPUT_VARIABLE <var>]
        [OUTPUT_VARIABLE <var>]
        [WORKING_DIRECTORY <var>]
        [ARGS <args>...]
        )

选项

try_run 的特定选项是

COMPILE_OUTPUT_VARIABLE <var>

在给定的变量中报告编译步骤构建输出。

OUTPUT_VARIABLE <var>

在给定的变量中报告编译构建输出和运行可执行文件的输出。此选项存在于传统原因并且仅受旧 try_run 签名支持。优先 COMPILE_OUTPUT_VARIABLE 和 RUN_OUTPUT_VARIABLE。

RUN_OUTPUT_VARIABLE <var>

在给定的变量中报告运行可执行文件的输出。

RUN_OUTPUT_STDOUT_VARIABLE <var>

在 3.25 版本中添加。

在给定的变量中报告运行可执行文件的 stdout 输出。

RUN_OUTPUT_STDERR_VARIABLE <var>

在 3.25 版本中添加。

在给定的变量中报告运行可执行文件的 stderr 输出。

WORKING_DIRECTORY <var>

在 3.20 版本中添加。

在指定的目录中运行可执行文件。如果未指定 WORKING_DIRECTORY，该可执行文件将在 <bindir> 或当前构建目录中运行。

ARGS <args>...

在运行可执行文件时传递给该可执行文件的其他参数。

其他行为设置

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

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

  • 对于单配置生成器，这将在测试项目中设置 CMAKE_BUILD_TYPE。

交叉编译时的行为

在版本 3.3 中添加：在运行交叉编译的二进制文件时使用 CMAKE_CROSSCOMPILING_EMULATOR。

交叉编译时，在第一步中编译的可执行文件通常无法在构建主机上运行。 try_run 命令检查 CMAKE_CROSSCOMPILING 变量以检测 CMake 是否处于交叉编译模式。如果是，它仍将尝试编译可执行文件，但除非 CMAKE_CROSSCOMPILING_EMULATOR 变量已设置，否则它不会尝试运行该可执行文件。它会创建缓存变量，这些变量必须由用户填写或在某些 CMake 脚本文件中的预设值填写为该可执行文件在实际目标平台上运行后的结果。这些缓存条目为

<runResultVar>

如果将在目标平台上运行可执行文件，则退出代码。

<runResultVar>__TRYRUN_OUTPUT

如果将在目标平台上运行可执行文件，则显示来自 stdout 和 stderr 的输出。这仅在使用 RUN_OUTPUT_VARIABLE 或 OUTPUT_VARIABLE 选项时创建。

为了让跨编译项目变得更轻松，仅在真正需要时才使用 try_run。如果使用 try_run，仅在真正需要时才使用 RUN_OUTPUT_STDOUT_VARIABLE、RUN_OUTPUT_STDERR_VARIABLE、RUN_OUTPUT_VARIABLE 或 OUTPUT_VARIABLE 选项。使用它们需要在跨编译时将缓存变量手动设置为可执行文件的输出。您还可以使用 if() 块检查 CMAKE_CROSSCOMPILING 变量，为这种情况提供一个易于预设的替代方法来“保护”对 try_run 的调用。