# 3.9 檢測外部庫:Ⅰ. 使用pkg-config
**NOTE**:*此示例代碼可以在 https://github.com/dev-cafe/cmake-cookbook/tree/v1.0/chapter-03/recipe-09 中找到,包含一個C的示例。該示例在CMake 3.6版(或更高版本)中是有效的,并且已經在GNU/Linux、macOS和Windows上進行過測試。https://github.com/dev-cafe/cmake-cookbook/tree/v1.0/chapter-03/recipe-09 中也有一個適用于CMake 3.5的示例。*
目前為止,我們已經討論了兩種檢測外部依賴關系的方法:
* 使用CMake自帶的`find-module`,但并不是所有的包在CMake的`find`模塊都找得到。
* 使用` <package>Config.cmake`, ` <package>ConfigVersion.cmake `和`<package>Targets.cmake`,這些文件由軟件包供應商提供,并與軟件包一起安裝在標準位置的cmake文件夾下。
如果某個依賴項既不提供查找模塊,也不提供供應商打包的CMake文件,該怎么辦?在這種情況下,我們只有兩個選擇:
* 依賴`pkg-config`程序,來找到系統上的包。這依賴于包供應商在`.pc`配置文件中,其中有關于發行包的元數據。
* 為依賴項編寫自己的`find-package`模塊。
本示例中,將展示如何利用CMake中的`pkg-config`來定位ZeroMQ消息庫。下一個示例中,將編寫一個find模塊,展示如何為ZeroMQ編寫屬于自己`find`模塊。
## 準備工作
我們構建的代碼來自ZeroMQ手冊 http://zguide.zeromq.org/page:all 的示例。由兩個源文件`hwserver.c`和`hwclient.c`組成,這兩個源文件將構建為兩個獨立的可執行文件。執行時,它們將打印“Hello, World”。
## 具體實施
這是一個C項目,我們將使用C99標準,逐步構建`CMakeLists.txt`文件:
1. 聲明一個C項目,并要求符合C99標準:
```cmake
cmake_minimum_required(VERSION 3.6 FATAL_ERROR)
project(recipe-09 LANGUAGES C)
set(CMAKE_C_STANDARD 99)
set(CMAKE_C_EXTENSIONS OFF)
set(CMAKE_C_STANDARD_REQUIRED ON)
```
2. 使用CMake附帶的find-module,查找`pkg-config`。這里在`find_package`中傳遞了`QUIET`參數。只有在沒有找到`pkg-config`時,CMake才會報錯:
```cmake
find_package(PkgConfig REQUIRED QUIET)
```
3. 找到`pkg-config`時,我們將使用`pkg_search_module`函數,以搜索任何附帶包配置`.pc`文件的庫或程序。該示例中,我們查找ZeroMQ庫:
```cmake
pkg_search_module(
ZeroMQ
REQUIRED
libzeromq libzmq lib0mq
IMPORTED_TARGET
)
```
4. 如果找到ZeroMQ庫,則打印狀態消息:
```cmake
if(TARGET PkgConfig::ZeroMQ)
message(STATUS "Found ZeroMQ")
endif()
```
5. 然后,添加兩個可執行目標,并鏈接到ZeroMQ。這將自動設置包括目錄和鏈接庫:
```cmake
add_executable(hwserver hwserver.c)
target_link_libraries(hwserver PkgConfig::ZeroMQ)
add_executable(hwclient hwclient.c)
target_link_libraries(hwclient PkgConfig::ZeroMQ)
```
6. 現在,我們可以配置和構建示例:
```shell
$ mkdir -p build
$ cd build
$ cmake ..
$ cmake --build .
```
7. 在終端中,啟動服務器,啟動時會輸出類似于本例的消息:
```shell
Current 0MQ version is 4.2.2
```
8. 然后,在另一個終端啟動客戶端,它將打印如下內容:
```shell
Connecting to hello world server…
Sending Hello 0…
Received World 0
Sending Hello 1…
Received World 1
Sending Hello 2…
...
```
## 工作
當找到`pkg-config`時, CMake需要提供兩個函數,來封裝這個程序提供的功能:
* `pkg_check_modules`,查找傳遞列表中的所有模塊(庫和/或程序)
* `pkg_search_module`,要在傳遞的列表中找到第一個工作模塊
與`find_package`一樣,這些函數接受`REQUIRED`和`QUIET`參數。更詳細地說,我們對`pkg_search_module`的調用如下:
```cmake
pkg_search_module(
ZeroMQ
REQUIRED
libzeromq libzmq lib0mq
IMPORTED_TARGET
)
```
這里,第一個參數是前綴,它將用于命名存儲搜索ZeroMQ庫結果的目標:`PkgConfig::ZeroMQ`。注意,我們需要為系統上的庫名傳遞不同的選項:`libzeromq`、`libzmq`和`lib0mq`。這是因為不同的操作系統和包管理器,可為同一個包選擇不同的名稱。
**NOTE**:*`pkg_check_modules`和`pkg_search_module`函數添加了`IMPORTED_TARGET`選項,并在CMake 3.6中定義導入目標的功能。3.6之前的版本,只定義了變量`ZeroMQ_INCLUDE_DIRS`(用于include目錄)和`ZeroMQ_LIBRARIES`(用于鏈接庫),供后續使用。*
- Introduction
- 前言
- 第0章 配置環境
- 0.1 獲取代碼
- 0.2 Docker鏡像
- 0.3 安裝必要的軟件
- 0.4 測試環境
- 0.5 上報問題并提出改進建議
- 第1章 從可執行文件到庫
- 1.1 將單個源文件編譯為可執行文件
- 1.2 切換生成器
- 1.3 構建和鏈接靜態庫和動態庫
- 1.4 用條件句控制編譯
- 1.5 向用戶顯示選項
- 1.6 指定編譯器
- 1.7 切換構建類型
- 1.8 設置編譯器選項
- 1.9 為語言設定標準
- 1.10 使用控制流
- 第2章 檢測環境
- 2.1 檢測操作系統
- 2.2 處理與平臺相關的源代碼
- 2.3 處理與編譯器相關的源代碼
- 2.4 檢測處理器體系結構
- 2.5 檢測處理器指令集
- 2.6 為Eigen庫使能向量化
- 第3章 檢測外部庫和程序
- 3.1 檢測Python解釋器
- 3.2 檢測Python庫
- 3.3 檢測Python模塊和包
- 3.4 檢測BLAS和LAPACK數學庫
- 3.5 檢測OpenMP的并行環境
- 3.6 檢測MPI的并行環境
- 3.7 檢測Eigen庫
- 3.8 檢測Boost庫
- 3.9 檢測外部庫:Ⅰ. 使用pkg-config
- 3.10 檢測外部庫:Ⅱ. 自定義find模塊
- 第4章 創建和運行測試
- 4.1 創建一個簡單的單元測試
- 4.2 使用Catch2庫進行單元測試
- 4.3 使用Google Test庫進行單元測試
- 4.4 使用Boost Test進行單元測試
- 4.5 使用動態分析來檢測內存缺陷
- 4.6 預期測試失敗
- 4.7 使用超時測試運行時間過長的測試
- 4.8 并行測試
- 4.9 運行測試子集
- 4.10 使用測試固件
- 第5章 配置時和構建時的操作
- 5.1 使用平臺無關的文件操作
- 5.2 配置時運行自定義命令
- 5.3 構建時運行自定義命令:Ⅰ. 使用add_custom_command
- 5.4 構建時運行自定義命令:Ⅱ. 使用add_custom_target
- 5.5 構建時為特定目標運行自定義命令
- 5.6 探究編譯和鏈接命令
- 5.7 探究編譯器標志命令
- 5.8 探究可執行命令
- 5.9 使用生成器表達式微調配置和編譯
- 第6章 生成源碼
- 6.1 配置時生成源碼
- 6.2 使用Python在配置時生成源碼
- 6.3 構建時使用Python生成源碼
- 6.4 記錄項目版本信息以便報告
- 6.5 從文件中記錄項目版本
- 6.6 配置時記錄Git Hash值
- 6.7 構建時記錄Git Hash值
- 第7章 構建項目
- 7.1 使用函數和宏重用代碼
- 7.2 將CMake源代碼分成模塊
- 7.3 編寫函數來測試和設置編譯器標志
- 7.4 用指定參數定義函數或宏
- 7.5 重新定義函數和宏
- 7.6 使用廢棄函數、宏和變量
- 7.7 add_subdirectory的限定范圍
- 7.8 使用target_sources避免全局變量
- 7.9 組織Fortran項目
- 第8章 超級構建模式
- 8.1 使用超級構建模式
- 8.2 使用超級構建管理依賴項:Ⅰ.Boost庫
- 8.3 使用超級構建管理依賴項:Ⅱ.FFTW庫
- 8.4 使用超級構建管理依賴項:Ⅲ.Google Test框架
- 8.5 使用超級構建支持項目
- 第9章 語言混合項目
- 9.1 使用C/C++庫構建Fortran項目
- 9.2 使用Fortran庫構建C/C++項目
- 9.3 使用Cython構建C++和Python項目
- 9.4 使用Boost.Python構建C++和Python項目
- 9.5 使用pybind11構建C++和Python項目
- 9.6 使用Python CFFI混合C,C++,Fortran和Python
- 第10章 編寫安裝程序
- 10.1 安裝項目
- 10.2 生成輸出頭文件
- 10.3 輸出目標
- 10.4 安裝超級構建
- 第11章 打包項目
- 11.1 生成源代碼和二進制包
- 11.2 通過PyPI發布使用CMake/pybind11構建的C++/Python項目
- 11.3 通過PyPI發布使用CMake/CFFI構建C/Fortran/Python項目
- 11.4 以Conda包的形式發布一個簡單的項目
- 11.5 將Conda包作為依賴項發布給項目
- 第12章 構建文檔
- 12.1 使用Doxygen構建文檔
- 12.2 使用Sphinx構建文檔
- 12.3 結合Doxygen和Sphinx
- 第13章 選擇生成器和交叉編譯
- 13.1 使用CMake構建Visual Studio 2017項目
- 13.2 交叉編譯hello world示例
- 13.3 使用OpenMP并行化交叉編譯Windows二進制文件
- 第14章 測試面板
- 14.1 將測試部署到CDash
- 14.2 CDash顯示測試覆蓋率
- 14.3 使用AddressSanifier向CDash報告內存缺陷
- 14.4 使用ThreadSaniiser向CDash報告數據爭用
- 第15章 使用CMake構建已有項目
- 15.1 如何開始遷移項目
- 15.2 生成文件并編寫平臺檢查
- 15.3 檢測所需的鏈接和依賴關系
- 15.4 復制編譯標志
- 15.5 移植測試
- 15.6 移植安裝目標
- 15.7 進一步遷移的措施
- 15.8 項目轉換為CMake的常見問題
- 第16章 可能感興趣的書
- 16.1 留下評論——讓其他讀者知道你的想法