CheckCXXSymbolExists

此模块提供了一个命令来检查 C++ 符号是否存在。

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

include(CheckCXXSymbolExists)

命令

此模块提供以下命令

check_cxx_symbol_exists

检查符号是否作为函数、变量或预处理器宏存在于 C++ 中

check_cxx_symbol_exists(<symbol> <headers> <variable>)

此命令检查在包含指定的头文件 <headers> 后，符号 <symbol> 是否可用，并将结果存储在内部缓存变量 <variable> 中。可以使用 分号分隔的列表 将多个头文件指定为一个字符串。

如果头文件将符号定义为宏，则认为该符号可用并假定其工作正常。如果符号被声明为函数或变量，检查还会确保它能够成功链接（即，符号必须存在于链接的库或对象文件中）。

类型、枚举值或 C++ 模板等符号不受支持。对于这些情况，请考虑使用 CheckTypeSize 或 CheckSourceCompiles 模块。

此命令旨在检查 C++ 中的符号。对于 C 符号，请使用 CheckSymbolExists 模块。

注意

此命令对于（可能）重载的函数符号不可靠。由于无法可靠地预测系统环境中的给定函数是否会被定义为重载函数，或者在其他系统上是重载函数，或者将来会变成重载函数，因此通常建议使用 CheckSourceCompiles 模块来检查任何函数符号（除非确定被检查的函数在其他系统上不是重载的，或者将来也不会是重载的）。

影响检查的变量

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

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 中新增。

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

示例

以下示例演示了如何使用此模块检查预处理器宏 SEEK_SET 和 C++ 函数 std::fopen()（来自 <cstdio> 头文件）的存在。

include(CheckCXXSymbolExists)

# Check for macro SEEK_SET
check_cxx_symbol_exists(SEEK_SET "cstdio" HAVE_SEEK_SET)

# Check for function std::fopen
check_cxx_symbol_exists(std::fopen "cstdio" HAVE_STD_FOPEN)

另请参阅