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

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

CMAKE_REQUIRED_DEFINITIONS

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

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 版本中加入。

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