CheckSymbolExists

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

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

include(CheckSymbolExists)

命令

此模块提供以下命令

check_symbol_exists

检查符号是作为函数、变量还是 C 中的预处理器宏存在一次

check_symbol_exists(<symbol> <headers> <variable>)

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

如果头文件将符号定义为宏，则认为该符号可用且能够正常工作。如果符号被声明为函数或变量，该检查还会确保它能够成功链接（即，该符号必须存在于已链接的库或对象文件中）。编译器内建函数可能无法被检测到，因为它们不总是可链接或在头文件中明确声明。

类型、枚举值或编译器内建函数等符号无法识别。对于这些情况，请考虑使用 CheckTypeSize 或 CheckSourceCompiles 模块。

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

影响检查的变量

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

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

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

示例

以下示例演示了如何使用此模块检查 <stdio.h> 头文件中的预处理器宏 SEEK_SET 和 C 函数 fopen() 的存在。

include(CheckSymbolExists)

# Check for macro SEEK_SET
check_symbol_exists(SEEK_SET "stdio.h" HAVE_SEEK_SET)

# Check for function fopen
check_symbol_exists(fopen "stdio.h" HAVE_FOPEN)

另请参阅