CMake實戰教程（二）

前言

從上一篇的文章中，相信大家也瞭解了CMake這個東西，但是呢它不是隻是看一下就能會的，這種東西還是要實踐才能學會，那麼如果你已經實踐過了，就會體會到上一篇文章在實際中使用到底是多麼的難搞，比如：

• 生成很多垃圾文件，這是我的第一個體會…
• 需要手動去指定編譯的文件
• 無法指定編譯器，編譯選項等等很多東西…
• 如果有子目錄也不能完全適用…
• 以及一些其他的問題…

總的來說就是在真正項目中壓根就沒法適用的工程，那爲什麼我要寫呢，因爲那是我學習的過程，總不能一口吞下一個大胖子是不是，接下來的一系列文章我就會讓CMake變得能在實際中使用，越來越自動化，更方便構建。。。

外部構建

第一個問題，在運行cmake .後會產生很多垃圾文件，那麼我們可以讓它在一個build目錄下去編譯，生成的垃圾文件放在這個目錄下就好了，不需要的時候直接清除即可。

可能有人會問，它不能像Makefile一樣直接make clean 或者make distclean清除編譯的垃圾文件嗎，我當時學的時候也谷歌過，但是，很遺憾沒有，使用我才讓它產生的垃圾文件放在build目錄下，其實不能說是垃圾文件，只不過是一些中間文件，記錄某些東西的，我用不上它，所以認爲是垃圾…僅此而已。

對此官方的解釋是：

CMakeLists.txt 可以執行腳本並通過腳本生成一些臨時文件，但是卻沒有辦法來跟蹤這些臨時文件到底是哪些，因此，沒有辦法提供一個可靠的 clean 方案。

那怎麼辦呢？很簡單，從CMake的語法我們就知道，它在構建的時候指定了PATH，也就是頂層CMakeLists.txt 入口的路徑。

cmake PATH

那麼很顯然，它可以是相對路徑而不是絕對路徑，畢竟點‘.’ 表示當前路徑， 點點‘..’ 表示上一級路徑，那麼我們可以新建一個build目錄，然後在build目錄下去運行：

cmake ..

這在CMake中稱之爲外部構建（out-of-source build），而 CMake 強烈推薦的就是外部構建！

我自己也寫了個build的腳本，內容非常簡單，主要做兩件事：

1. 創建一個build目錄（存在就不會重新創建的）
2. 進入build目錄
3. 然後外部構建cmake
4. 生成Makefile文件後運行make命令編譯

#!/bin/bash

mkdir -p build
cd build
cmake ..
make

因此在編譯的時候直接運行這個腳本即可，生成的內容全部都在build目錄下。

• 這是原始目錄

.
├── build.sh
├── CMakeLists.txt
└── main.c

0 directories, 3 files

編譯後在build目錄下生成很多文件，包括 Makefile、section2(可執行程序)等

CMakeCache.txt  CMakeFiles  cmake_install.cmake  Makefile  section2

補充一點，如果你想看到cmake生成的垃圾文件比你源碼還多的時候，你就會愛死外部構建這種騷操作了~

自動查找源碼

不得不說，cmake是個很好的自動化構建工具，既然是自動化，那麼很的東西都是自動的，比如查找源碼，cmake就提供查找源碼的命令：

aux_source_directory(<dir> <variable>)

它的主要作用就是：查找在某個路徑下的所有源文件，注意，是所有源碼文件，當你的目錄下有很多個源碼文件的時候，他就主動去查找了，哦，當然，它也只會查找源碼文件，比如*.c 、 *.cpp 、*.cc啦，反正只要是源碼就可以了，但是什麼txt 、 *.h文件這些它是不會記錄下來的。

• dir ： 指定的目錄（可以是絕對路徑也可以是相對路徑）
• variable：將輸出結果列表儲存在指定的<variable>變量中。

反正這個命令就很方便，我在某個目錄下有啥源碼文件，我都會被記錄到<variable>變量，然後在CMake直接使用即可。當然後續也有其他的命令去找源碼文件，一口吃不了一個大胖子，先了解這個先，後續慢慢學習~

變量

在CMake中，變量是十分常見的，我正在就簡單講解下基本的語法吧：

定義變量常用的函數是：

set(VARIABLE_NAME VARIABLE)

取消定義變量是

unset(VARIABLE_NAME )

• VARIABLE_NAME ： 變量名字
• VARIABLE：變量的值

變量的的值始終是string（字符串）類型，變量名字是區分大小寫的，一般變量命名還是正常點比較好，別搞太多亂七八糟的特殊符號，只要數字、字母，下劃線"_" 、橫線"-"就差不多了，變量的作用域也是有全局與局部之分，與C語言、Java都差不多，我也不多說了。我的例程中全局變量是全部大寫，局部變量是全小寫的，也是比較好區分。

變量引用的形式爲${variable_name}，變量引用被變量的值替換，或者如果變量沒有被設置，則由空字符串替換。變量引用可以嵌套，例如${outer_${inner_variable}veriable}；環境變量引用的形式爲$ENV{VARIABLE}，並在相同的上下文中作爲正常變量引用。

打印日誌

在CMake構建的時候，你可能不知道某些變量是啥內容，那麼就在終端打印出來看看就好了，這根我們寫代碼中的printf函數差不多，給直接打一串字符串出來瞧瞧…

message([<mode>] "message to display" ...)

首先呢，<mode>是指定消息的類型：

• (無) = 重要消息；
• STATUS = 非重要消息；
• WARNING = CMake 警告, 會繼續執行；
• AUTHOR_WARNING = CMake 警告 (dev), 會繼續執行；
• SEND_ERROR = CMake 錯誤, 繼續執行，但是會跳過生成的步驟；
• FATAL_ERROR = CMake 錯誤, 終止所有處理過程；

正常情況下我都是輸出一些狀態信息——STATUS，打印個變量啦，打印下代碼的執行順序啦等等…

後面就是有些字符串信息了，變量在這裏直接引用就好，畢竟變量本身就是字符串…

section3

給出個實例代碼：
當前目錄存在2個c文件，分別是main.c、power.c就是簡單計算x的y次方，純粹是個demo，我自己也懶得寫，並不是因爲代碼有多高深，所以這代碼我是從網上找的，來自潘偉洲大神的cmake測試代碼：https://github.com/wzpan/cmake-demo。

• main.c

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

int main(int argc, char *argv[])
{
    if (argc < 3){
        printf("Usage: %s base exponent \n", argv[0]);
        return 1;
    }
    double base = atof(argv[1]);
    int exponent = atoi(argv[2]);
    double result = power(base, exponent);
    printf("%g ^ %d is %g\n", base, exponent, result);
    return 0;
}

• power.c

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

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

    return result;
}

然後就是CMakeLists.txt文件：

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

# 項目信息
project (section3)

# 查找當前目錄下的所有源文件
# 並將名稱保存到 DIR_SRCS 變量
aux_source_directory(. DIR_SRCS)

# 指定生成目標
add_executable(section3 ${DIR_SRCS})

相比於上一篇文章，我這個CMakeLists.txt文件只是添加了aux_source_directory命令去自動掃描當前目錄下的源碼文件，並且保存到DIR_SRCS 變量中，僅此而已！！

然後在add_executable命令中，用${DIR_SRCS}變量代替指定的源碼文件source1 source2 ... sourceN，當然你也可以打印一下${DIR_SRCS}變量到底保存了什麼，如果不出意外的話，它保存的就是./main.c; ./power.c，表示的是當前目錄下的main.c、power.c這兩個文件，而分號代表它是一個list，後續會講解怎麼去提取list的內容…

message(STATUS "${DIR_SRCS}")

然後用外部構建的方式去編譯代碼：

jie@pc:~/github/cmake/section3$ ./build.sh 
-- The C compiler identification is GNU 7.4.0
-- The CXX compiler identification is GNU 7.4.0
-- Check for working C compiler: /usr/bin/cc
-- Check for working C compiler: /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: /usr/bin/c++
-- Check for working CXX compiler: /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: /home/jie/github/cmake/section3/build
Scanning dependencies of target section3
[ 33%] Building C object CMakeFiles/section3.dir/main.c.o
[ 66%] Building C object CMakeFiles/section3.dir/power.c.o
[100%] Linking C executable section3
[100%] Built target section3

很明顯生成了正確可執行文件~

代碼下載

https://github.com/jiejieTop/cmake

未完待續…