CheckSourceCompiles

在版本 3.19 中添加。

检查给定语言的源代码是否可以构建一次。

check_source_compiles

check_source_compiles(<lang> <code> <resultVar>
                      [FAIL_REGEX <regex1> [<regex2>...]]
                      [SRC_EXT <extension>])

检查一次 <code> 中提供的源代码是否可以构建成代码语言 <lang>。结果存储在 <resultVar> 指定的内部缓存变量中，成功为布尔变量 true，失败为布尔变量 false。

如果提供了 FAIL_REGEX，那么通过检查编译器输出中的任何内容是否与指定的任何正则表达式匹配来确定失败。

默认情况下，测试源文件将获得与所请求语言匹配的文件扩展名。可以使用 SRC_EXT 选项用 .<extension> 代替覆盖此选项。

C 示例检查编译器是否支持 noreturn 属性

set(CMAKE_TRY_COMPILE_TARGET_TYPE "STATIC_LIBRARY")

check_source_compiles(C
"#if !__has_c_attribute(noreturn)
#error \"No noreturn attribute\"
#endif"
HAVE_NORETURN)

Fortran 示例检查编译器是否支持 pure 过程属性

set(CMAKE_TRY_COMPILE_TARGET_TYPE "STATIC_LIBRARY")

check_source_compiles(Fortran
"pure subroutine foo()
end subroutine"
HAVE_PURE)

在内部，try_compile() 用于编译源代码。如果 CMAKE_TRY_COMPILE_TARGET_TYPE 设置为 EXECUTABLE（默认值），则源代码将作为可执行程序编译和链接。如果设置 STATIC_LIBRARY，则将编译源代码但不链接。在任何情况下，都必须照常声明所有函数。

另请参阅 check_source_runs() 以运行已编译的源代码。

在调用 check_source_compiles() 之前设置以下任意变量可以影响编译和链接命令

CMAKE_REQUIRED_FLAGS

要传递给编译器的附加标志的字符串。字符串必须以空格分隔 - ;-list 将不起作用。 CMAKE_<LANG>_FLAGS 及其关联的特定配置的变量的内容在 CMAKE_REQUIRED_FLAGS 的内容之前自动添加到编译器命令中。

CMAKE_REQUIRED_DEFINITIONS

;-list，形式为 -DFOO 或 -DFOO=bar 的编译器定义。还将自动添加 <resultVar> 指定的名称的定义。

CMAKE_REQUIRED_INCLUDES

;-list 的头文件搜索路径传给编译器。这些将成为唯一使用过的头文件搜索路径--INCLUDE_DIRECTORIES 目录属性中的内容将被忽略。

CMAKE_REQUIRED_LINK_OPTIONS

在 3.14 版本中新增。

;-list 的选项加到链接命令（参见 try_compile() 了解更多详情）。

CMAKE_REQUIRED_LIBRARIES

;-list 的库加到链接命令。这些库可以是系统库的名称，也可以是 导入的 target（参见 try_compile() 了解更多详情）。

CMAKE_REQUIRED_LINK_DIRECTORIES

在 3.31 版本中新增。

;-list 的搜索路径加到链接器（参见 try_compile() 了解更多详情）。

CMAKE_REQUIRED_QUIET

在 3.1 版本中新增。

如果该变量计算为布尔真值，将禁止与检查相关的所有状态消息。