CheckIncludeFiles

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

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

include(CheckIncludeFiles)

命令

此模块提供以下命令

check_include_files

检查一次一个或多个头文件是否存在，并且可以一起包含在 C 或 C++ 代码中。

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

参数为

<includes>

要检查的头文件的分号分隔列表。

<variable>

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

LANGUAGE <language>

3.11 版本新增。

如果设置了，指定的 <language> 编译器将用于执行检查。可接受的值为 C 和 CXX。如果未给出此选项，则将在启用 C 编译器时使用 C 编译器。如果未启用 C 编译器，则将在启用 C++ 编译器时使用 C++ 编译器。

影响检查的变量

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

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

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)

另请参阅