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。检查命令的结果变量参数指定的名称的定义也会自动添加。

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)

另请参阅