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。还会自动添加一个定义，用于检查命令的结果变量参数中指定的名称。

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 函数 fopen() 是否存在于 <stdio.h> 头文件中

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)

另请参阅