试运行

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

尝试编译和运行源文件

try_run(<runResultVar> <compileResultVar>
        <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”，构建失败在“<compileResultVar>”中返回“FALSE”。如果构建成功，这将运行可执行文件并将退出代码存储在“<runResultVar>”中。如果可执行文件已构建，但未能运行，则“<runResultVar>”将设置为“FAILED_TO_RUN”。请参阅命令 try_compile() 以获取这两个命令共有的选项的文档，以及有关如何构建测试项目以构建源文件的信息。

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

在 3.26 版本加入: 如果未指定 NO_LOG 选项，此命令会记录 configure-log try_run 事件。

此命令支持 CMake 3.25 之前的备用签名。为清楚起见，建议使用上面的签名。

try_run(<runResultVar> <compileResultVar>
        <bindir> <srcfile|SOURCES srcfile...>
        [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>]
        [OUTPUT_VARIABLE <var>]
        [WORKING_DIRECTORY <var>]
        [ARGS <args>...]
        )

try_run 特有的选项是：

COMPILE_OUTPUT_VARIABLE <var>

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

OUTPUT_VARIABLE <变量>

报告编译构建输出和在给定变量中运行可执行文件的输出。此选项的存在是出于遗留原因，并且仅受旧的 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() 块“保护”对 try_run` 的调用，检查 CMAKE_CROSSCOMPILING 变量，并为这种情况提供易于预设的替代方案。