CheckCXXSourceRuns

此模块提供了一个命令，用于检查 C++ 源文件是否可以被构建和运行。

在 CMake 项目中加载此模块，使用

include(CheckCXXSourceRuns)

命令

此模块提供以下命令

check_cxx_source_runs

检查一次给定的 C++ 源代码是否能够编译并链接成一个可执行文件，并且可以后续运行。

check_cxx_source_runs(<code> <variable>)

在 <code> 中提供的 C++ 源代码必须至少包含一个 main() 函数。检查结果存储在由 <variable> 指定的内部缓存变量中。如果代码成功构建并以退出码 0 运行，则表示成功，并用布尔值 true 指示。如果构建或运行失败，则表示失败，并用布尔值 false 指示，例如空字符串或错误消息。

影响检查的变量

在调用此命令之前，可以设置以下变量来修改检查的运行方式

CMAKE_REQUIRED_FLAGS

一个空格分隔的字符串，包含传递给编译器的附加标志。 分号分隔的列表 将不起作用。 CMAKE_<LANG>_FLAGS 的内容及其相关的特定配置变量 CMAKE_<LANG>_FLAGS_<CONFIG> 会在内容之前自动添加到编译器命令中。

CMAKE_REQUIRED_DEFINITIONS

一个 分号分隔的列表，包含编译器定义，每个定义的形式为 -DFOO 或 -DFOO=bar。还会自动添加一个用于检查命令结果变量参数所指定名称的定义。

CMAKE_REQUIRED_INCLUDES

一个 分号分隔的列表，包含传递给编译器的头文件搜索路径。这些将是唯一使用的头文件搜索路径； INCLUDE_DIRECTORIES 目录属性的内容将被忽略。

CMAKE_REQUIRED_LINK_OPTIONS

3.14 版新增。

一个 分号分隔的列表，包含添加到链接命令的选项（有关更多详细信息，请参阅 try_compile()）。

CMAKE_REQUIRED_LIBRARIES

一个 分号分隔的列表，包含添加到链接命令的库。这些可以是系统库的名称，也可以是 导入的目标（有关更多详细信息，请参阅 try_compile()）。

CMAKE_REQUIRED_LINK_DIRECTORIES

在版本 3.31 中添加。

一个 分号分隔的列表，包含传递给链接器的库搜索路径（有关更多详细信息，请参阅 try_compile()）。

CMAKE_REQUIRED_QUIET

版本 3.1 中新增。

如果此变量评估为布尔真值，则与检查关联的所有状态消息都将被抑制。

示例

以下示例演示了如何检查 C++ 标准库是否正常工作以及 std::vector 在运行时是否可用。如果源文件成功编译、链接和运行，则内部缓存变量 HAVE_WORKING_STD_VECTOR 将被设置为布尔值 true。代码使用 括号参数 提供，以便更轻松地处理嵌入式引号。

include(CheckCXXSourceRuns)

check_cxx_source_runs([[
  #include <iostream>
  #include <vector>

  int main()
  {
    std::vector<int> v = {1, 2, 3};
    if (v.size() != 3) return 1;
    std::cout << "Vector works correctly." << std::endl;
    return 0;
  }
]] HAVE_WORKING_STD_VECTOR)

另请参阅