CheckIncludeFiles

此模块提供一个命令，用于检查一个或多个 C/C++ 头文件。

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

include(CheckIncludeFiles)

命令

此模块提供以下命令

check_include_files

检查一次一个或多个头文件是否可以一起包含在源代码中

check_include_files(<includes> <variable> [LANGUAGE <language>])

此命令检查一次给定的头文件 <includes> 列表是否存在，并且可以一起包含在一个 C 或 C++ 源文件中。检查结果存储在一个名为 <variable> 的内部缓存变量中。将 <includes> 参数指定为以分号分隔的头文件名列表。

如果设置了 LANGUAGE，将使用指定的编译器执行检查。可接受的值是 C 和 CXX。如果未设置，如果启用了 C 编译器，将使用 C 编译器。如果 C 编译器未启用，如果启用了 C++ 编译器，将使用 C++ 编译器。

影响检查的变量

在调用此命令之前，可以设置以下变量来修改检查的运行方式

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 头文件并将检查结果存储在缓存变量中

include(CheckIncludeFiles)

check_include_files(sys/socket.h HAVE_SYS_SOCKET_H)

if(HAVE_SYS_SOCKET_H)
  # The <net/if.h> header on Darwin and BSD-like systems is not self-contained
  # and also requires <sys/socket.h>
  check_include_files("sys/socket.h;net/if.h" HAVE_NET_IF_H)
else()
  check_include_files(net/if.h HAVE_NET_IF_H)
endif()

可以使用 LANGUAGE 选项指定要使用的编译器。例如，当项目中同时启用了 C 和 CXX 语言时，检查多个 C++ 头文件

include(CheckIncludeFiles)

check_include_files("header_1.hpp;header_2.hpp" HAVE_HEADERS LANGUAGE CXX)

另请参阅