CheckIncludeFile

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

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

include(CheckIncludeFile)

命令

此模块提供以下命令

check_include_file

检查 C 代码中是否可以包含头文件

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

此命令检查给定的 <include> 头文件是否存在并且可以在 C 源文件中包含。检查结果存储在一个名为 <variable> 的内部缓存变量中。可选的第三个参数可用于向检查添加额外的编译标志（或使用下面的 CMAKE_REQUIRED_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 中新增。

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

版本 3.12 新增: CMAKE_REQUIRED_LIBRARIES 变量，如果策略 CMP0075 设置为 NEW。

示例

示例：检查 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（单一 Unix 规范）特性（值 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_files(ucontext.h HAVE_UCONTEXT_H)
cmake_pop_check_state()

另请参阅