CheckIncludeFile

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

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

include(CheckIncludeFile)

命令

此模块提供以下命令

check_include_file

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

check_include_file(<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 头文件

检查 C 头文件 <unistd.h> 是否存在，并将检查结果存储在 HAVE_UNISTD_H 缓存变量中。

include(CheckIncludeFile)

check_include_file(unistd.h HAVE_UNISTD_H)

示例：独立检查

在下面的示例中，此模块与 CMakePushCheckState 模块结合使用，以临时修改必需的编译定义（通过 CMAKE_REQUIRED_DEFINITIONS）并验证 C 头文件 <ucontext.h> 是否可用。结果存储在内部缓存变量 HAVE_UCONTEXT_H 中。

例如，在 macOS 上，ucontext API 已被弃用，除非定义了某些功能宏，否则头文件可能会被隐藏。特别是，定义 _XOPEN_SOURCE（不带值）可以在不启用更广泛的 POSIX 或 SUS（Single Unix Specification）功能（值为 500 或更高）的情况下公开必要的符号。

include(CheckIncludeFile)
include(CMakePushCheckState)

cmake_push_check_state(RESET)
  if(CMAKE_SYSTEM_NAME STREQUAL "Darwin")
    set(CMAKE_REQUIRED_DEFINITIONS -D_XOPEN_SOURCE)
  endif()

  check_include_file(ucontext.h HAVE_UCONTEXT_H)
cmake_pop_check_state()

另请参阅