# 1.4 用條件句控制編譯
**NOTE**:*這個示例代碼可以在 https://github.com/dev-cafe/cmake-cookbook/tree/v1.0/chapter-01/recipe-04 找到,其中有一個C++示例。該配置在CMake 3.5版(或更高版本)測試有效的,并且已經在GNU/Linux、macOS和Windows上進行了測試。*
目前為止,看到的示例比較簡單,CMake執行流是線性的:從一組源文件到單個可執行文件,也可以生成靜態庫或動態庫。為了確保完全控制構建項目、配置、編譯和鏈接所涉及的所有步驟的執行流,CMake提供了自己的語言。本節中,我們將探索條件結構`if-else- else-endif`的使用。
**NOTE**: *CMake語言相當龐雜,由基本的控制結構、特定于CMake的命令和使用新函數模塊化擴展語言的基礎設施組成。完整的概覽可以在這里找到: https://cmake.org/cmake/help/latest/manual/cmake-language.7.html*
## 具體實施
從與上一個示例的的源代碼開始,我們希望能夠在不同的兩種行為之間進行切換:
1. 將` Message.hpp`和`Message.cpp`構建成一個庫(靜態或動態),然后將生成庫鏈接到`hello-world`可執行文件中。
2. 將`Message.hpp`,`Message.cpp`和`hello-world.cpp`構建成一個可執行文件,但不生成任何一個庫。
讓我們來看看如何使用`CMakeLists.txt`來實現:
1. 首先,定義最低CMake版本、項目名稱和支持的語言:
```cmake
cmake_minimum_required(VERSION 3.5 FATAL_ERROR)
project(recipe-04 LANGUAGES CXX)
```
2. 我們引入了一個新變量`USE_LIBRARY`,這是一個邏輯變量,值為`OFF`。我們還打印了它的值:
```cmake
set(USE_LIBRARY OFF)
message(STATUS "Compile sources into a library? ${USE_LIBRARY}")
```
3. CMake中定義`BUILD_SHARED_LIBS`全局變量,并設置為`OFF`。調用`add_library`并省略第二個參數,將構建一個靜態庫:
```cmake
set(BUILD_SHARED_LIBS OFF)
```
4. 然后,引入一個變量`_sources`,包括`Message.hpp`和`Message.cpp`:
```cmake
list(APPEND _sources Message.hpp Message.cpp)
```
5. 然后,引入一個基于`USE_LIBRARY`值的`if-else`語句。如果邏輯為真,則` Message.hpp`和`Message.cpp`將打包成一個庫:
```cmake
if(USE_LIBRARY)
# add_library will create a static library
# since BUILD_SHARED_LIBS is OFF
add_library(message ${_sources})
add_executable(hello-world hello-world.cpp)
target_link_libraries(hello-world message)
else()
add_executable(hello-world hello-world.cpp ${_sources})
endif()
```
6. 我們可以再次使用相同的命令集進行構建。由于`USE_LIBRARY`為`OFF`, `hello-world`可執行文件將使用所有源文件來編譯。可以通過在GNU/Linux上,運行`objdump -x`命令進行驗證。
##工作原理
我們介紹了兩個變量:`USE_LIBRARY`和`BUILD_SHARED_LIBS`。這兩個變量都設置為`OFF`。如CMake語言文檔中描述,邏輯真或假可以用多種方式表示:
* 如果將邏輯變量設置為以下任意一種:`1`、`ON`、`YES`、`true`、`Y`或非零數,則邏輯變量為`true`。
* 如果將邏輯變量設置為以下任意一種:`0`、`OFF`、`NO`、`false`、`N`、`IGNORE、NOTFOUND`、空字符串,或者以`-NOTFOUND`為后綴,則邏輯變量為`false`。
`USE_LIBRARY`變量將在第一個和第二個行為之間切換。`BUILD_SHARED_LIBS`是CMake的一個全局標志。因為CMake內部要查詢`BUILD_SHARED_LIBS`全局變量,所以`add_library`命令可以在不傳遞`STATIC/SHARED/OBJECT`參數的情況下調用;如果為`false`或未定義,將生成一個靜態庫。
這個例子說明,可以引入條件來控制CMake中的執行流。但是,當前的設置不允許從外部切換,不需要手動修改`CMakeLists.txt`。原則上,我們希望能夠向用戶開放所有設置,這樣就可以在不修改構建代碼的情況下調整配置,稍后將展示如何做到這一點。
**NOTE**:*`else()`和`endif()`中的`()`,可能會讓剛開始學習CMake代碼的同學感到驚訝。其歷史原因是,因為其能夠指出指令的作用范圍。例如,可以使用`if(USE_LIBRARY)…else(USE_LIBRARY)…endif(USE_LIBIRAY)`。這個格式并不唯一,可以根據個人喜好來決定使用哪種格式。*
**TIPS**:*`_sources`變量是一個局部變量,不應該在當前范圍之外使用,可以在名稱前加下劃線。*
- 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 留下評論——讓其他讀者知道你的想法