CheckFunctionExists

此模块提供了一个命令，用于检查 C 函数是否存在。

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

include(CheckFunctionExists)

命令

此模块提供以下命令

check_function_exists

检查 C 函数是否可以从系统库中链接一次

check_function_exists(<function> <variable>)

此命令检查系统库是否提供了 <function>，并将结果存储在内部缓存变量 <variable> 中。

注意

由于以下原因，建议使用 CheckSymbolExists 或 CheckSourceCompiles，而不是此命令：

  • check_function_exists() 无法检测在头文件中内联或定义为预处理器宏的函数。

  • check_function_exists() 由于调用约定不匹配，无法检测 Win32 API 的 32 位版本中的任何内容。

  • check_function_exists() 仅验证链接，不验证函数是否在系统头文件中声明。

影响检查的变量

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

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

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

示例

示例：基本用法

在以下示例中，执行检查以确定链接器是否识别 C 函数 fopen()，结果存储在 HAVE_FOPEN 内部缓存变量中

include(CheckFunctionExists)

check_function_exists(fopen HAVE_FOPEN)

示例：缺少声明

如上所述，首选使用 CheckSymbolExists 模块来检查 C 函数，因为它还会验证函数是否已声明或定义为宏。在以下示例中，此模块用于检查函数可能未在系统头文件中声明的边缘情况。例如，在 macOS 上，fdatasync() 函数可能在 C 库中可用，但其声明未在 unistd.h 系统头文件中提供。

CMakeLists.txt
include(CheckFunctionExists)
include(CheckSymbolExists)

check_symbol_exists(fdatasync "unistd.h" HAVE_FDATASYNC)

# Check if fdatasync() is available in the C library.
if(NOT HAVE_FDATASYNC)
  check_function_exists(fdatasync HAVE_FDATASYNC_WITHOUT_DECL)
endif()

在这种情况下，项目可以在缺少声明时提供自己的声明

example.c
#ifdef HAVE_FDATASYNC_WITHOUT_DECL
  extern int fdatasync(int);
#endif

另请参阅