CheckCompilerFlag¶
3.19 版本新增。
此模块提供了一个命令，用于检查编译器是否支持给定的标志。
在 CMake 项目中加载此模块，使用
include(CheckCompilerFlag)
命令¶
此模块提供以下命令
- check_compiler_flag¶
检查一次编译器是否支持给定的标志
check_compiler_flag(<lang> <flag> <variable>)
此命令会检查一次
<lang>编译器是否接受<flag>并且不产生诊断消息。检查结果将存储在由<variable>指定的内部缓存变量中。参数为
<lang>用于检查的编译器的语言。支持的语言包括：
C、CXX、CUDA、Fortran、HIP、ISPC、OBJC、OBJCXX和Swift。版本 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。还将自动添加对检查命令的 result variable 参数指定的名称的定义。
CMAKE_REQUIRED_INCLUDES要传递给编译器的头文件搜索路径的分号分隔列表。这些将是唯一使用的头文件搜索路径；将忽略
INCLUDE_DIRECTORIES目录属性的内容。
CMAKE_REQUIRED_LINK_OPTIONS3.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 编译器中禁用与 strlen() C 函数相关的优化。检查结果存储在内部缓存变量 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模块用于检查链接器标志是否被编译器支持。