CheckIncludeFileCXX

此模块提供了一个用于检查 C++ 头文件的命令。

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

include(CheckIncludeFileCXX)

命令

此模块提供以下命令

check_include_file_cxx

检查一次头文件是否存在并可在 C++ 代码中包含

check_include_file_cxx(<include> <variable> [<flags>])

参数为

<include>

要检查的头文件名。

<variable>

用于存储检查结果的变量名。此变量将被创建为内部缓存变量。

<flags>

(可选) 一个 分号分隔的列表，包含要添加到检查中的其他编译标志。或者，也可以使用下面的 CMAKE_REQUIRED_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_OPTIONS

3.14 版新增。

要添加到链接命令的选项的分号分隔列表（有关更多详细信息，请参阅 try_compile()）。

CMAKE_REQUIRED_LIBRARIES

要添加到链接命令的库的分号分隔列表。这些可以是系统库的名称，也可以是 导入的目标（有关更多详细信息，请参阅 try_compile()）。

CMAKE_REQUIRED_LINK_DIRECTORIES

在版本 3.31 中添加。

要传递给链接器的库搜索路径的分号分隔列表（有关更多详细信息，请参阅 try_compile()）。

CMAKE_REQUIRED_QUIET

版本 3.1 中新增。

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

3.12 版本新增: 当策略 CMP0075 设置为 NEW 时，新增了 CMAKE_REQUIRED_LIBRARIES 变量。

示例

检查 C++23 头文件 <stdfloat> 是否存在，并将检查结果存储在 HAVE_STDFLOAT_HEADER 缓存变量中。

include(CheckIncludeFileCXX)

check_include_file_cxx(stdfloat HAVE_STDFLOAT_HEADER)

另请参阅