建设部监理工程师网站,居然之家装修公司官网,著名室内设计师,软件下载网站哪个好用CMake:检测外部库---自定义find模块 导言项目结构CMakeLists.txt附录 导言
上一篇#xff0c;我们了解了CMake其中一种自定义检测外部库的方式#xff0c;本篇将展示通过编写一个find模块来定位系统上的ZeroMQ库#xff0c;以便能够在非Unix操作系统上检测该库。
项目结构… CMake:检测外部库---自定义find模块 导言项目结构CMakeLists.txt附录 导言
上一篇我们了解了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_serverPRIVATE ${ZeroMQ_INCLUDE_DIRS}
)target_link_libraries(hw_serverPRIVATE ${ZeroMQ_LIBRARIES}
)add_executable(hw_client zmq_client.cpp)target_include_directories(hw_clientPRIVATE ${ZeroMQ_INCLUDE_DIRS}
)target_link_libraries(hw_clientPRIVATE ${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 cant 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_LIBRARIESNAMES libzmqlibzmq-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_dlibzmq-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(ZeroMQFOUND_VARZeroMQ_FOUNDREQUIRED_VARSZeroMQ_INCLUDE_DIRSZeroMQ_LIBRARIESVERSION_VARZeroMQ_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_LIBRARIESNAMESzmqHINTS${_ZeroMQ_ROOT}/lib${_ZeroMQ_ROOT}/lib/x86_64-linux-gnu)
else()find_library(ZeroMQ_LIBRARIESNAMESlibzmqlibzmq-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_dlibzmq-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(ZeroMQFOUND_VARZeroMQ_FOUNDREQUIRED_VARSZeroMQ_INCLUDE_DIRSZeroMQ_LIBRARIESVERSION_VARZeroMQ_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文件packageConfig.cmake packageConfigVersion.cmake和packageTargets.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。然而编写一个全面的查找模块脚本绝非易事需要考虑很多可能性。
