CheckCXXCompilerFlag

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

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

include(CheckCXXCompilerFlag)

命令

此模块提供以下命令

check_cxx_compiler_flag

检查C++编译器是否支持给定标志（仅检查一次）

check_cxx_compiler_flag(<flag> <variable>)

此命令仅检查一次 <flag> 是否被 CXX 编译器接受，且不产生诊断消息。多个标志可以在一个参数中以 分号分隔的列表 字符串形式指定。

检查结果存储在由 <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++编译器标志 -fsycl。检查结果存储在内部缓存变量 HAVE_FSYCL_FLAG 中，并使用 target_compile_options() 命令有条件地启用该标志。$<COMPILE_LANGUAGE:...> 生成器表达式确保该标志仅添加到 CXX 源文件。

include(CheckCXXCompilerFlag)
check_cxx_compiler_flag(-fsycl HAVE_FSYCL_FLAG)

if(HAVE_FSYCL_FLAG)
  target_compile_options(
    example
    PRIVATE $<$<COMPILE_LANGUAGE:CXX>:-fsycl>
  )
endif()

另请参阅

• 有关检查编译器标志是否受支持的更通用命令，请参见 CheckCompilerFlag 模块。