# 5.2 配置時運行自定義命令
**NOTE**:*此示例代碼可以在 https://github.com/dev-cafe/cmake-cookbook/tree/v1.0/chapter-05/recipe-02 中找到。該示例在CMake 3.5版(或更高版本)中是有效的,并且已經在GNU/Linux、macOS和Windows上進行過測試。*
運行CMake生成構建系統,從而指定原生構建工具必須執行哪些命令,以及按照什么順序執行。我們已經了解了CMake如何在配置時運行許多子任務,以便找到工作的編譯器和必要的依賴項。本示例中,我們將討論如何使用`execute_process`命令在配置時運行定制化命令。
## 具體實施
第3章第3節中,我們已經展示了`execute_process`查找Python模塊NumPy時的用法。本例中,我們將使用`execute_process`命令來確定,是否存在特定的Python模塊(本例中為Python CFFI),如果存在,我們在進行版本確定:
1. 對于這個簡單的例子,不需要語言支持:
```cmake
cmake_minimum_required(VERSION 3.5 FATAL_ERROR)
project(recipe-02 LANGUAGES NONE)
```
2. 我們要求Python解釋器執行一個簡短的代碼片段,因此,需要使用`find_package`來查找解釋器:
```cmake
find_package(PythonInterp REQUIRED)
```
3. 然后,調用`execute_process`來運行一個簡短的Python代碼段;下一節中,我們將更詳細地討論這個命令:
```cmake
# this is set as variable to prepare
# for abstraction using loops or functions
set(_module_name "cffi")
execute_process(
COMMAND
${PYTHON_EXECUTABLE} "-c" "import ${_module_name}; print(${_module_name}.__version__)"
OUTPUT_VARIABLE _stdout
ERROR_VARIABLE _stderr
OUTPUT_STRIP_TRAILING_WHITESPACE
ERROR_STRIP_TRAILING_WHITESPACE
)
```
4. 然后,打印結果:
```cmake
if(_stderr MATCHES "ModuleNotFoundError")
message(STATUS "Module ${_module_name} not found")
else()
message(STATUS "Found module ${_module_name} v${_stdout}")
endif()
```
5. 下面是一個配置示例(假設Python CFFI包安裝在相應的Python環境中):
```shell
$ mkdir -p build
$ cd build
$ cmake ..
-- Found PythonInterp: /home/user/cmake-cookbook/chapter-05/recipe-02/example/venv/bin/python (found version "3.6.5")
-- Found module cffi v1.11.5
```
## 工作原理
`execute_process`命令將從當前正在執行的CMake進程中派生一個或多個子進程,從而提供了在配置項目時運行任意命令的方法。可以在一次調用`execute_process`時執行多個命令。但請注意,每個命令的輸出將通過管道傳輸到下一個命令中。該命令接受多個參數:
* WORKING_DIRECTORY,指定應該在哪個目錄中執行命令。
* RESULT_VARIABLE將包含進程運行的結果。這要么是一個整數,表示執行成功,要么是一個帶有錯誤條件的字符串。
* OUTPUT_VARIABLE和ERROR_VARIABLE將包含執行命令的標準輸出和標準錯誤。由于命令的輸出是通過管道傳輸的,因此只有最后一個命令的標準輸出才會保存到OUTPUT_VARIABLE中。
* INPUT_FILE指定標準輸入重定向的文件名
* OUTPUT_FILE指定標準輸出重定向的文件名
* ERROR_FILE指定標準錯誤輸出重定向的文件名
* 設置OUTPUT_QUIET和ERROR_QUIET后,CMake將靜默地忽略標準輸出和標準錯誤。
* 設置OUTPUT_STRIP_TRAILING_WHITESPACE,可以刪除運行命令的標準輸出中的任何尾隨空格
* 設置ERROR_STRIP_TRAILING_WHITESPACE,可以刪除運行命令的錯誤輸出中的任何尾隨空格。
有了這些了解這些參數,回到我們的例子當中:
```cmake
set(_module_name "cffi")
execute_process(
COMMAND
${PYTHON_EXECUTABLE} "-c" "import ${_module_name}; print(${_module_name}.__version__)"
OUTPUT_VARIABLE _stdout
ERROR_VARIABLE _stderr
OUTPUT_STRIP_TRAILING_WHITESPACE
ERROR_STRIP_TRAILING_WHITESPACE
)
if(_stderr MATCHES "ModuleNotFoundError")
message(STATUS "Module ${_module_name} not found")
else()
message(STATUS "Found module ${_module_name} v${_stdout}")
endif()
```
該命令檢查`python -c "import cffi; print(cffi.__version__)"`的輸出。如果沒有找到模塊,`_stderr`將包含`ModuleNotFoundError`,我們將在if語句中對其進行檢查。本例中,我們將打印`Module cffi not found`。如果導入成功,Python代碼將打印模塊的版本,該模塊通過管道輸入`_stdout`,這樣就可以打印如下內容:
```cmake
message(STATUS "Found module ${_module_name} v${_stdout}")
```
## 更多信息
本例中,只打印了結果,但實際項目中,可以警告、中止配置,或者設置可以查詢的變量,來切換某些配置選項。
代碼示例會擴展到多個Python模塊(如Cython),以避免代碼重復。一種選擇是使用`foreach`循環模塊名,另一種方法是將代碼封裝為函數或宏。我們將在第7章中討論這些封裝。
第9章中,我們將使用Python CFFI和Cython。現在的示例,可以作為有用的、可重用的代碼片段,來檢測這些包是否存在。
- 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 留下評論——讓其他讀者知道你的想法