CheckCSourceRuns

此模块提供了一个命令,用于检查 C 源代码是否可以构建和运行。

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

include(CheckCSourceRuns)

命令

此模块提供以下命令

check_c_source_runs

检查一次给定的 C 源代码是否编译并链接成一个可执行文件,然后可以运行该可执行文件

check_c_source_runs(<code> <variable>)

<code> 中提供的 C 源代码必须至少包含一个 main() 函数。检查结果存储在由 <variable> 指定的内部缓存变量中。如果代码构建并以退出代码 0 运行,则通过布尔真值表示成功。构建或运行失败通过布尔假值表示,例如空字符串或错误消息。

影响检查的变量

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

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

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

示例

以下示例演示了如何使用此模块检查 C 源代码在运行时是否受支持和可操作。检查结果存储在内部缓存变量 HAVE_NORETURN 中。

include(CheckCSourceRuns)

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

另请参阅