CheckCompilerFlag

3.19 版本新增。

此模块提供一个命令,用于检查编译器是否支持给定的标志。

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

include(CheckCompilerFlag)

命令

此模块提供以下命令

check_compiler_flag

检查编译器是否支持给定的标志(仅检查一次)

check_compiler_flag(<lang> <flag> <variable>)

此命令检查一次 <lang> 编译器是否接受 <flag> 且不产生诊断消息。检查结果存储在由 <variable> 指定的内部缓存变量中。

参数为

<lang>

用于检查的编译器的语言。支持的语言有:CCXXCUDAFortranHIPISPCOBJCOBJCXXSwift

版本 3.21 新增:支持 HIP 语言。

版本 3.26 新增:支持 Swift 语言。

<flag>

要检查的编译器标志。可以使用分号分隔列表将多个标志作为字符串在一个参数中指定。

<variable>

内部缓存变量的变量名,用于存储检查结果,成功为布尔真,失败为布尔假。

成功结果仅表示编译器在给定该标志时未报告错误。该标志是否有任何效果或是否达到预期效果,不在此模块的范围之内。

注意

由于底层的 try_compile() 命令也使用来自 CMAKE_<LANG>_FLAGS 等变量的标志,这些变量中未知或不支持的标志可能会导致此检查出现假阴性。

影响检查的变量

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

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

示例

以下示例演示如何使用此模块检查 C 编译器标志 -fno-optimize-strlen 的支持情况,该标志在 GCC 和 Clang 编译器中禁用与 C 函数 strlen() 相关的优化。检查结果存储在内部缓存变量 HAVE_FNO_OPTIMIZE_STRLEN 中,并使用 target_compile_options() 命令有条件地启用该标志。$<COMPILE_LANGUAGE:...> 生成器表达式确保该标志仅添加到 C 源文件。

include(CheckCompilerFlag)
check_compiler_flag(C -fno-optimize-strlen HAVE_FNO_OPTIMIZE_STRLEN)

if(HAVE_FNO_OPTIMIZE_STRLEN)
  target_compile_options(
    example
    PRIVATE $<$<COMPILE_LANGUAGE:C>:-fno-optimize-strlen>
  )
endif()

另请参阅

  • CheckLinkerFlag 模块用于检查链接器标志是否受编译器支持。