CheckCXXSourceCompiles¶

本模块提供了一个命令，用于检查C++源代码是否可以构建。

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

include(CheckCXXSourceCompiles)

命令¶

此模块提供以下命令

check_cxx_source_compiles¶

检查给定的C++源代码是否可以构建

check_cxx_source_compiles(<code> <variable> [FAIL_REGEX <regexes>...])

此命令检查一次在 <code> 中提供的源代码是否可以编译（并链接成可执行文件）。检查结果存储在由 <variable> 指定的内部缓存变量中。

参数为

<code>: 要检查的 C++ 源代码。这必须是一个完整的程序，如同写入包含主体块的文件中一样。源代码中使用的所有符号都应像往常一样在其对应的头文件中声明。
<variable>: 内部缓存变量的变量名，用于存储检查结果，成功为布尔真，失败为布尔假。
FAIL_REGEX <regexes>...: 如果提供了一个或多个正则表达式模式，则通过检查编译器输出中是否有任何内容与任何指定的正则表达式匹配来确定失败。

影响检查的变量

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

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 中新增。

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

CMAKE_TRY_COMPILE_TARGET_TYPE: 在内部，try_compile()命令用于执行检查，此变量控制其创建的目标类型。如果此变量设置为EXECUTABLE（默认值），则检查将编译并链接测试源代码作为可执行程序。如果设置为STATIC_LIBRARY，则测试源代码只编译而不链接。

示例¶

以下示例演示了如何检查 C++ 编译器是否支持特定的语言特性。在本例中，检查验证编译器是否支持 C++11 lambda 表达式。结果存储在内部缓存变量 HAVE_CXX11_LAMBDAS 中。

include(CheckCXXSourceCompiles)

check_cxx_source_compiles("
  int main()
  {
    auto lambda = []() { return 42; };
    return lambda();
  }
" HAVE_CXX11_LAMBDAS)

另请参阅¶

有关检查源代码是否可以构建的更通用命令，请参阅CheckSourceCompiles模块。
有关检查源代码是否可以构建和运行的命令，请参阅CheckSourceRuns模块。