CheckLibraryExists

检查函数是否存在于系统库或指定的库中,仅检查一次。

check_library_exists
check_library_exists(<library> <function> <location> <variable>)

检查库 <library> 是否存在于给定的位置 <location> 并且拥有指定的 <function> 函数。结果存储在内部缓存变量 <variable> 中。如果 <location> 是空字符串,则搜索默认目录。

推荐使用 CheckSymbolExistsCheckSourceCompiles 模块,而不是此模块,以便更可靠地检测函数在库中是否可用。

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

CMAKE_REQUIRED_FLAGS

传递给编译器的附加标志字符串。该字符串必须是空格分隔的——;-列表 将不起作用。CMAKE_<LANG>_FLAGS 及其相关的配置特定变量的内容会自动添加到编译器命令中,在 CMAKE_REQUIRED_FLAGS 的内容之前。

CMAKE_REQUIRED_DEFINITIONS

一个 ;-列表,包含编译器定义的列表,格式为 -DFOO-DFOO=bar。还将自动添加由 <resultVar> 指定的名称的定义。

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 版本中添加。

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

示例

此模块可用于执行所谓的健全性检查,以验证指定的库是否提供预期的功能,并且确实是被定位的正确库。

例如,要检查 curl 库是否存在于默认路径中,并且是否具有 curl_easy_perform 函数

include(CheckLibraryExists)
check_library_exists(curl curl_easy_perform "" HAVE_LIBRARY_CURL)

要检查库是否存在于特定的非标准位置,并且是否具有指定的函数

include(CheckLibraryExists)
check_library_exists(curl curl_easy_perform "/opt/curl/lib" HAVE_LIBRARY_CURL)

此外,还可以使用 导入库(例如,来自 find_package() 调用)

find_package(CURL)

# ...

if(TARGET CURL::libcurl)
  include(CheckLibraryExists)
  check_library_exists(CURL::libcurl curl_easy_perform "" HAVE_LIBRARY_CURL)
endif()