CMake入門-04-自定義編譯選項

工做環境

• 系統：macOS Mojave 10.14.6
• CMake: Version 3.15.0-rc4

Hello,World! - 自定義編譯選項

CMake 容許爲項目增長編譯選項，從而能夠根據用戶的環境和需求選擇最合適的編譯方案。

例如，能夠將 MathFunctions 庫設爲一個可選的庫，若是該選項爲 ON ，就使用該庫定義的數學函數來進行運算。不然就調用標準庫中的數學函數庫。

(0) 初始化項目

$ mkdir hello
$ cd hello
$ mkdir math build
$ touch CMakeLists.txt main.cpp math/MathFunctions.h math/MathFunctions.cpp math/CMakeLists.txt
$ tree
.
├── build
├── CMakeLists.txt
├── main.cpp
└── math
    ├── CMakeLists.txt
    ├── MathFunctions.cpp
    └── MathFunctions.h

• math/MathFunctions.h

int power(int base, int exponent);

• math/MathFunctions.cpp

#include <stdio.h>
#include <stdlib.h>
#include "MathFunctions.h"

int power(int base, int exponent) {
    int result = base;
    int i;

    if (exponent == 0) {
        return 1;
    }

    for(i = 1; i < exponent; ++i){
        result = result * base;
    }
    return result;
}

• main.cpp

#include <iostream>
#include "MathFunctions.h"

using namespace std;

int main(int argc, char const *argv[]) {
  printf("%s power(2,3)=%d \n", "Hello,World!", power(2, 3));
  return 0;
}

• CMakeLists.txt

# CMake 最低版本號要求
cmake_minimum_required(VERSION 3.15.0)

# 項目名
project(hello)

# 查找當前目錄下的全部源文件，並將名稱保存到 SRC_LIST 變量
aux_source_directory(. SRC_LIST)
# 查找 math 目錄下的全部源文件，並將名稱保存到 MATH_SRC_LIST 變量
# aux_source_directory(${PROJECT_SOURCE_DIR}/math MATH_SRC_LIST)

# 添加 math 子目錄 (math 目錄裏必須有 CMakeLists.txt)，這樣 math 目錄下的 CMakeLists.txt 文件和源代碼也會被處理
add_subdirectory(math)

# 添加頭文件路徑
include_directories(${PROJECT_SOURCE_DIR}/math)

# 指定生成目標
add_executable(hello ${SRC_LIST} ${MATH_SRC_LIST})

# 添加連接庫
target_link_libraries(hello MathFunctions)

• math/CMakeLists.txt

# 查找當前目錄下的全部源文件，並將名稱保存到 DIR_LIB_SRCS 變量
aux_source_directory(. DIR_LIB_SRCS)

# 生成連接庫
add_library (MathFunctions ${DIR_LIB_SRCS})

(1) 修改根目錄 CMakeLists.txt

cmake_minimum_required(VERSION 3.15.0)

# 項目名
project(hello)

# 查找當前目錄下的全部源文件，並將名稱保存到 SRC_LIST 變量
aux_source_directory(. SRC_LIST)


# 加入一個配置頭文件，用於處理 CMake 對源碼的設置
configure_file (
  "${PROJECT_SOURCE_DIR}/config.h.in"
  "${PROJECT_SOURCE_DIR}/config.h"
)

# 是否使用本身的 MathFunctions 庫
# 這裏設置的變量 USE_MYMATH、中間的提示文字、默認值，在 ccmake 命令中會展現
option (USE_MYMATH
  "Use provided math implementation"
  ON
)

# 是否加入 MathFunctions 庫
if (USE_MYMATH)
  # 添加頭文件路徑
  include_directories ("${PROJECT_SOURCE_DIR}/math")
  # 添加 math 子目錄 (math 目錄裏必須有 CMakeLists.txt)
  add_subdirectory (math)
  set (EXTRA_LIBS ${EXTRA_LIBS} MathFunctions)
endif (USE_MYMATH)



# 指定生成目標
add_executable(hello ${SRC_LIST} ${MATH_SRC_LIST})

# 添加連接庫
target_link_libraries(hello ${EXTRA_LIBS})

• configure_file 命令用於加入一個配置頭文件 config.h，這個文件由 CMake 從 config.h.in 生成，經過這樣的機制，將能夠經過預約義一些參數和變量來控制代碼生成。
• option 命令添加了一個 USE_MYMATH 選項，而且默認值爲 ON。
• 根據 USE_MYMATH 變量的值來決定是否使用咱們本身編寫的 MathFunctions 庫。

(2) 修改 main.cpp 文件

#include <iostream>
#include "config.h"

#ifdef USE_MYMATH
  // 若是定義了 USE_MYMATH，導入 "MathFunctions.h"
  #include "MathFunctions.h"
#else
  // 若是 USE_MYMATH 未定義，導入 <cmath>
  #include <cmath>
#endif

using namespace std;

int main(int argc, char const *argv[]) {

  #ifdef USE_MYMATH
    printf("Here define USE_MYMATH \n");
    printf("%s power(2,3)=%d \n", "Hello,World!", power(2, 3));
  #else
    printf("Here undefine USE_MYMATH \n");
    printf("%s power(2,3)=%f \n", "Hello,World!", pow(2, 3));
  #endif

  return 0;
}

(3) 新建 config.h.in 文件

#cmakedefine USE_MYMATH

• 這樣 CMake 會自動根據 config.h.in 配置文件中的設置自動生成 config.h 文件。

(4) 編譯 & 運行

• cmake 命令編譯

$ cd Desktop/hello/build

# cmake 指定 USE_MYMATH=ON
$ cmake -DUSE_MYMATH=ON ..
-- The C compiler identification is AppleClang 10.0.1.10010046
-- The CXX compiler identification is AppleClang 10.0.1.10010046
-- Check for working C compiler: /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/cc
-- Check for working C compiler: /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/cc -- works
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Detecting C compile features
-- Detecting C compile features - done
-- Check for working CXX compiler: /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/c++
-- Check for working CXX compiler: /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/c++ -- works
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- Detecting CXX compile features
-- Detecting CXX compile features - done
-- Configuring done
-- Generating done
-- Build files have been written to: /Users/staff/Desktop/hello/build

$  make
Scanning dependencies of target MathFunctions
[ 25%] Building CXX object math/CMakeFiles/MathFunctions.dir/MathFunctions.cpp.o
[ 50%] Linking CXX static library libMathFunctions.a
[ 50%] Built target MathFunctions
Scanning dependencies of target hello
[ 75%] Building CXX object CMakeFiles/hello.dir/main.cpp.o
[100%] Linking CXX executable hello
[100%] Built target hello

# 這裏輸出的 」Here define USE_MYMATH「
$ ./hello
Here define USE_MYMATH
Hello,World! power(2,3)=8

# cmake 指定 USE_MYMATH=OFF
$ cmake -DUSE_MYMATH=OFF ..
-- Configuring done
-- Generating done
-- Build files have been written to: /Users/staff/Desktop/hello/build

$ make
Scanning dependencies of target hello
[ 50%] Building CXX object CMakeFiles/hello.dir/main.cpp.o
[100%] Linking CXX executable hello
[100%] Built target hello

# 這裏輸出的 」Here undefine USE_MYMATH「
$ ./hello
Here undefine USE_MYMATH
Hello,World! power(2,3)=8.000000

• ccmake 命令編譯

$ cd Desktop/hello/build
$ ccmake ..

能夠看到 USE_MYMATH 選項

• 鍵盤的方向鍵能夠在不一樣的選項間切換
• 按下 enter 鍵能夠修改該選項
• 修改完成後能夠按下 c 選項完成配置，以後再按 g 鍵確認生成 Makefile
• ccmake 的其餘操做能夠參考窗口下方給出的指令提示

---

相關參考：
CMake 官方網站
CMake 入門實戰

聯繫做者：