CheckSourceCompiles

在 3.19 版本加入.

检查给定的源代码是否编译并链接到可执行文件中。

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

检查 <code> 中提供的源代码是否可以编译为所请求语言的源文件并链接为可执行文件。结果将存储在由“<resultVar>”指定的内部缓存变量中,布尔值为真表示成功,布尔值为假表示失败。如果提供了“FAIL_REGEX”,则通过检查编译器输出中的任何内容是否与任何指定的正则表达式匹配来确定失败。

默认情况下,测试源文件将被赋予与请求的语言相匹配的文件扩展名。 SRC_EXT 选项可用于用 .<extension> 覆盖它。

<code> 必须包含一个有效的主程序。例如:

check_source_compiles(C
"#include <stdlib.h>
#include <stdnoreturn.h>
noreturn void f(){ exit(0); }
int main(void) { f(); return 1; }"
HAVE_NORETURN)

check_source_compiles(Fortran
"program test
error stop
end program"
HAVE_ERROR_STOP)

底层检查由 try_compile() 命令执行。在调用 check_source_compiles() 之前设置以下任何变量可以影响编译和链接命令:

CMAKE_REQUIRED_FLAGS

要传递给编译器的附加标志。请注意 CMAKE_<LANG>_FLAGS 的内容及其关联的特定于配置的变量会自动添加到编译器命令中的 CMAKE_REQUIRED_FLAGS 内容之前。

CMAKE_REQUIRED_DEFINITIONS

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

CMAKE_REQUIRED_INCLUDES

传递给编译器的标头搜索路径的 ;-list。这些将是 try_compile() 使用的唯一标题搜索路径,即 INCLUDE_DIRECTORIES 目录属性的内容将被忽略。

CMAKE_REQUIRED_LINK_OPTIONS

A ;-list 要添加到链接命令的选项(有关更多详细信息,请参阅 try_compile())。

CMAKE_REQUIRED_LIBRARIES

A ;-list 要添加到链接命令的库。这些可以是系统库的名称,也可以是 Imported Targets <Imported Targets>`(有关详细信息,请参阅 :command:`try_compile)。

CMAKE_REQUIRED_QUIET

如果此变量的计算结果为布尔真值,则将抑制与检查相关的所有状态消息。

检查只执行一次,结果缓存在名为 <resultVar> 的变量中。每次后续 CMake 运行都将重新使用此缓存值,而不是再次执行检查,即使 <code> 更改也是如此。为了强制重新评估检查,必须从缓存中手动删除由 <resultVar> 命名的变量。