CMake:检测外部库---自定义find模块
导言
上一篇,我们了解了CMake
其中一种自定义检测外部库的方式,本篇将展示通过编写一个find
模块来定位系统上的ZeroMQ
库,以便能够在非Unix
操作系统上检测该库。
项目结构
.
├── CMakeLists.txt
├── FindZeroMQ.cmake
├── zmq_client.cpp
└── zmq_server.cpp
项目地址:
https://gitee.com/jiangli01/tutorials/tree/master/cmake-tutorial/chapter3/06
注:相关cpp源码与上一篇相同。
CMakeLists.txt
CMakeLists.txt
cmake_minimum_required(VERSION 3.10 FATAL_ERROR)
project(test_zmq LANGUAGES CXX)
set(CMAKE_CXX_STANDARD 11)
set(CMAKE_CXX_EXTENSIONS OFF)
set(CMAKE_CXX_STANDARD_REQUIRED ON)
set(CMAKE_PREFIX_PATH /opt/zmq)
list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR})
find_package(ZeroMQ REQUIRED)
add_executable(hw_server zmq_server.cpp)
target_include_directories(hw_server
PRIVATE ${ZeroMQ_INCLUDE_DIRS}
)
target_link_libraries(hw_server
PRIVATE ${ZeroMQ_LIBRARIES}
)
add_executable(hw_client zmq_client.cpp)
target_include_directories(hw_client
PRIVATE ${ZeroMQ_INCLUDE_DIRS}
)
target_link_libraries(hw_client
PRIVATE ${ZeroMQ_LIBRARIES}
)
list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR})
这行代码是用于在CMake
中向CMAKE_MODULE_PATH
变量中添加一个目录的路径。通常,CMAKE_MODULE_PATH
用于存放自定义的CMake
模块文件,这些模块文件可以在项目的CMakeLists.txt
文件中通过include
等命令来使用。
具体而言,这行代码的作用是将${CMAKE_CURRENT_SOURCE_DIR}
添加到CMAKE_MODULE_PATH中。${CMAKE_CURRENT_SOURCE_DIR}
表示当前CMakeLists.txt
所在的目录,即源代码目录。这样做的目的是为了告诉CMake
在这个目录中查找自定义的CMake模块。
这样CMake
就可以找到,我们自定义的FindZeroMQ.cmake
模块。
此示例的主CMakeLists.txt
在使用FindZeroMQ.cmake
时,与上一篇中使用的CMakeLists.txt
不同。这个模块使用find_path
和find_library
CMake
内置命令,搜索ZeroMQ
头文件和库,并使用find_package_handle_standard_args
设置相关变量。
FindZeroMQ.cmake
if(NOT ZeroMQ_ROOT)
set(ZeroMQ_ROOT "$ENV{ZeroMQ_ROOT}")
endif()
if(NOT ZeroMQ_ROOT)
find_path(_ZeroMQ_ROOT NAMES include/zmq.h)
else()
set(_ZeroMQ_ROOT "${ZeroMQ_ROOT}")
endif()
find_path(ZeroMQ_INCLUDE_DIRS NAMES zmq.h HINTS ${_ZeroMQ_ROOT}/include)
if(ZeroMQ_INCLUDE_DIRS)
set(_ZeroMQ_H ${ZeroMQ_INCLUDE_DIRS}/zmq.h)
function(_zmqver_EXTRACT _ZeroMQ_VER_COMPONENT _ZeroMQ_VER_OUTPUT)
set(CMAKE_MATCH_1 "0")
set(_ZeroMQ_expr "^[ \\t]*#define[ \\t]+${_ZeroMQ_VER_COMPONENT}[ \\t]+([0-9]+)$")
file(STRINGS "${_ZeroMQ_H}" _ZeroMQ_ver REGEX "${_ZeroMQ_expr}")
string(REGEX MATCH "${_ZeroMQ_expr}" ZeroMQ_ver "${_ZeroMQ_ver}")
set(${_ZeroMQ_VER_OUTPUT} "${CMAKE_MATCH_1}" PARENT_SCOPE)
endfunction()
_zmqver_EXTRACT("ZMQ_VERSION_MAJOR" ZeroMQ_VERSION_MAJOR)
_zmqver_EXTRACT("ZMQ_VERSION_MINOR" ZeroMQ_VERSION_MINOR)
_zmqver_EXTRACT("ZMQ_VERSION_PATCH" ZeroMQ_VERSION_PATCH)
# We should provide version to find_package_handle_standard_args in the same format as it was requested,
# otherwise it can't check whether version matches exactly.
if(ZeroMQ_FIND_VERSION_COUNT GREATER 2)
set(ZeroMQ_VERSION "${ZeroMQ_VERSION_MAJOR}.${ZeroMQ_VERSION_MINOR}.${ZeroMQ_VERSION_PATCH}")
else()
# User has requested ZeroMQ version without patch part => user is not interested in specific patch =>
# any patch should be an exact match.
set(ZeroMQ_VERSION "${ZeroMQ_VERSION_MAJOR}.${ZeroMQ_VERSION_MINOR}")
endif()
if(NOT ${CMAKE_C_PLATFORM_ID} STREQUAL "Windows")
find_library(ZeroMQ_LIBRARIES
NAMES zmq HINTS
${_ZeroMQ_ROOT}/lib
${_ZeroMQ_ROOT}/lib/x86_64-linux-gnu
)
else()
find_library(ZeroMQ_LIBRARIES
NAMES libzmq
"libzmq-mt-${ZeroMQ_VERSION_MAJOR}_${ZeroMQ_VERSION_MINOR}_${ZeroMQ_VERSION_PATCH}"
"libzmq-${CMAKE_VS_PLATFORM_TOOLSET}-mt-${ZeroMQ_VERSION_MAJOR}_${ZeroMQ_VERSION_MINOR}_${ZeroMQ_VERSION_PATCH}"
libzmq_d
"libzmq-mt-gd-${ZeroMQ_VERSION_MAJOR}_${ZeroMQ_VERSION_MINOR}_${ZeroMQ_VERSION_PATCH}"
"libzmq-${CMAKE_VS_PLATFORM_TOOLSET}-mt-gd-${ZeroMQ_VERSION_MAJOR}_${ZeroMQ_VERSION_MINOR}_${ZeroMQ_VERSION_PATCH}"
HINTS
${_ZeroMQ_ROOT}/lib
)
endif()
endif()
include(FindPackageHandleStandardArgs)
find_package_handle_standard_args(ZeroMQ
FOUND_VAR
ZeroMQ_FOUND
REQUIRED_VARS
ZeroMQ_INCLUDE_DIRS
ZeroMQ_LIBRARIES
VERSION_VAR
ZeroMQ_VERSION
)
if(NOT ZeroMQ_ROOT)
set(ZeroMQ_ROOT "$ENV{ZeroMQ_ROOT}")
endif()
如果ZeroMQ_ROOT
变量没有被设置,就尝试从环境变量中获取该路径并设置到ZeroMQ_ROOT
变量中。这样的设计可以让我们在不修改CMakeLists.txt
文件的情况下,通过设置环境变量来指定ZeroMQ库的路径。
if(NOT ZeroMQ_ROOT)
find_path(_ZeroMQ_ROOT NAMES include/zmq.h)
else()
set(_ZeroMQ_ROOT "${ZeroMQ_ROOT}")
endif()
find_path(ZeroMQ_INCLUDE_DIRS NAMES zmq.h HINTS ${_ZeroMQ_ROOT}/include)
用于查找ZeroMQ
库的头文件路径,并将路径存储在变量ZeroMQ_INCLUDE_DIRS
中。首先检查是否定义了ZeroMQ_ROOT
变量,如果未定义,则尝试在系统路径中查找zmq.h
头文件;如果已定义,则直接使用ZeroMQ_ROOT
变量的值。
set(_ZeroMQ_H ${ZeroMQ_INCLUDE_DIRS}/zmq.h)
function(_zmqver_EXTRACT _ZeroMQ_VER_COMPONENT _ZeroMQ_VER_OUTPUT)
set(CMAKE_MATCH_1 "0")
set(_ZeroMQ_expr "^[ \\t]*#define[ \\t]+${_ZeroMQ_VER_COMPONENT}[ \\t]+([0-9]+)$")
file(STRINGS "${_ZeroMQ_H}" _ZeroMQ_ver REGEX "${_ZeroMQ_expr}")
string(REGEX MATCH "${_ZeroMQ_expr}" ZeroMQ_ver "${_ZeroMQ_ver}")
set(${_ZeroMQ_VER_OUTPUT} "${CMAKE_MATCH_1}" PARENT_SCOPE)
endfunction()
_zmqver_EXTRACT("ZMQ_VERSION_MAJOR" ZeroMQ_VERSION_MAJOR)
_zmqver_EXTRACT("ZMQ_VERSION_MINOR" ZeroMQ_VERSION_MINOR)
_zmqver_EXTRACT("ZMQ_VERSION_PATCH" ZeroMQ_VERSION_PATCH)
如果成功找到头文件,则将ZeroMQ_INCLUDE_DIRS
设置为其位置。我们继续通过使用字符串操作和正则表达式,寻找相应版本的ZeroMQ
库。
if(ZeroMQ_FIND_VERSION_COUNT GREATER 2)
set(ZeroMQ_VERSION "${ZeroMQ_VERSION_MAJOR}.${ZeroMQ_VERSION_MINOR}.${ZeroMQ_VERSION_PATCH}")
else()
set(ZeroMQ_VERSION "${ZeroMQ_VERSION_MAJOR}.${ZeroMQ_VERSION_MINOR}")
endif()
为find_package_handle_standard_args
准备ZeroMQ_VERSION
变量。
if(NOT ${CMAKE_C_PLATFORM_ID} STREQUAL "Windows")
find_library(ZeroMQ_LIBRARIES
NAMES
zmq
HINTS
${_ZeroMQ_ROOT}/lib
${_ZeroMQ_ROOT}/lib/x86_64-linux-gnu
)
else()
find_library(ZeroMQ_LIBRARIES
NAMES
libzmq
"libzmq-mt-${ZeroMQ_VERSION_MAJOR}_${ZeroMQ_VERSION_MINOR}_${ZeroMQ_VERSION_PATCH}"
"libzmq-${CMAKE_VS_PLATFORM_TOOLSET}-mt-${ZeroMQ_VERSION_MAJOR}_${ZeroMQ_VERSION_MINOR}_${ZeroMQ_VERSION_PATCH}"
libzmq_d
"libzmq-mt-gd-${ZeroMQ_VERSION_MAJOR}_${ZeroMQ_VERSION_MINOR}_${ZeroMQ_VERSION_PATCH}"
"libzmq-${CMAKE_VS_PLATFORM_TOOLSET}-mt-gd-${ZeroMQ_VERSION_MAJOR}_${ZeroMQ_VERSION_MINOR}_${ZeroMQ_VERSION_PATCH}"
HINTS
${_ZeroMQ_ROOT}/lib
)
endif()
使用find_library
命令搜索ZeroMQ
库。因为库的命名有所不同,这里我们需要区分Unix
的平台和Windows
平台。
include(FindPackageHandleStandardArgs)
find_package_handle_standard_args(ZeroMQ
FOUND_VAR
ZeroMQ_FOUND
REQUIRED_VARS
ZeroMQ_INCLUDE_DIRS
ZeroMQ_LIBRARIES
VERSION_VAR
ZeroMQ_VERSION
)
最后,包含了标准FindPackageHandleStandardArgs.cmake
,并调用相应的CMake
命令。如果找到所有需要的变量,并且版本匹配,则将ZeroMQ_FOUND
变量设置为TRUE
。
附录
find-module
通常遵循特定的模式:
-
检查用户是否为所需的包提供了自定义位置。
-
使用
find_
家族中的命令搜索所需包的必需组件,即头文件、库、可执行程序等等。我们使用find_path
查找头文件的完整路径,并使用find_library
查找库。CMake
还提供find_file
、find_program
和find_package
。这些命令的参数示意如下:
find_path(<VAR> NAMES name PATHS paths)
如果搜索成功,<VAR>
将保存搜索结果;如果搜索失败,则会设置为<VAR>-NOTFOUND
。NAMES
和PATHS
分别是CMake
应该查找的文件的名称和搜索应该指向的路径。
初步搜索的结果中,可以提取版本号。本例中,ZeroMQ
头文件包含库版本,可以使用字符串操作和正则表达式提取库版本信息。
最后,调用find_package_handle_standard_args
命令。处理find_package
命令的REQUIRED
、QUIET
和版本参数,并设置ZeroMQ_FOUND
变量。
总结:有四种方式可用于找到依赖包。
- 使用由包供应商提供
CMake
文件<package>Config.cmake
,<package>ConfigVersion.cmake
和<package>Targets.cmake
,通常会在包的标准安装位置查找。 - 无论是由
CMake
还是第三方提供的模块,为所需包使用find-module
。 - 使用
pkg-config
,如本篇的示例所示。 - 如果这些都不可行,那么编写自己的
find
模块。
这四种可选方案按相关性进行了排序,每种方法也都有其挑战。
目前,并不是所有的包供应商都提供CMake
的Find
文件,不过正变得越来越普遍。因为导出CMake
目标,使得第三方代码很容易使用它所依赖的库和/或程序附加的依赖。
从一开始,Find-module
就一直是CMake
中定位依赖的主流手段。但是,它们中的大多数仍然依赖于设置依赖项使用的变量,比如Boost_INCLUDE_DIRS
、PYTHON_INTERPRETER
等等。这种方式很难在第三方发布自己的包时,确保依赖关系被满足。
使用pkg-config
的方法可以很好地进行适配,因为它已经成为Unix
系统的标准。然而,也由于这个原因,它不是一个完全跨平台的方法。此外,如CMake
文档所述,在某些情况下,用户可能会意外地覆盖检测包,并导致pkg-config
提供不正确的信息。
最后的方法是编写自己的查找模块脚本,就像本示例中那样。这是可行的,并且依赖于FindPackageHandleStandardArgs.cmake
。然而,编写一个全面的查找模块脚本绝非易事,需要考虑很多可能性。