CheckCSourceCompiles

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

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

include(CheckCSourceCompiles)

命令

此模块提供以下命令

check_c_source_compiles

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

check_c_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。还会自动添加一个定义,用于检查命令的结果变量参数所指定的名称。

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,则测试源代码将编译但不链接。

示例

检查包含SSE2内在函数的C源代码是否可以编译和链接

include(CheckCSourceCompiles)

check_c_source_compiles("
  #include <emmintrin.h>
  int main(void)
  {
    __m128d a = _mm_setzero_pd();
    (void)a;
    return 0;
  }
" PROJECT_HAVE_SSE2_INTRINSICS)

另请参阅

  • 有关检查源代码是否可以构建的更通用命令,请参阅CheckSourceCompiles模块。

  • 有关检查源代码是否可以构建和运行的模块,请参阅CheckSourceRuns模块。