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。还将自动添加对检查命令的 result variable 参数指定的名称的定义。

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 模块。