在Linux下如何使用CMake編譯程序

CMake是開源、跨平臺(tái)的構(gòu)建工具，可以讓我們通過編寫簡單的配置文件去生成本地的Makefile，這個(gè)配置文件是獨(dú)立于運(yùn)行平臺(tái)和編譯器的，這樣就不用親自去編寫Makefile了，而且配置文件可以直接拿到其它平臺(tái)上使用，無需修改，非常方便。

本文主要講述在Linux下如何使用CMake來編譯我們的程序。

一 環(huán)境搭建

我使用的是ubuntu18.04，安裝cmake使用如下命令：

安裝完成后，在終端下輸入:

查看cmake版本

這樣cmake就安裝好了。

二 簡單入門

首先讓我們從最簡單的代碼入手，先來體驗(yàn)下cmake是如何操作的。

2.1 項(xiàng)目結(jié)構(gòu)

2.2 示例源碼

打開終端，輸入：

編寫main.c，如下：

然后在main.c同級(jí)目錄下編寫CMakeLists.txt，內(nèi)容如下：

2.3 運(yùn)行查看

在終端下切到main.c所在的目錄下，然后輸入以下命令運(yùn)行cmake：

輸出結(jié)果如下：

ps:此時(shí)，建議留意一下這個(gè)文件夾下多生成的文件都有哪些。

可以看到成功生成了Makefile，還有一些cmake運(yùn)行時(shí)自動(dòng)生成的文件。

然后在終端下輸入make：

可以看到執(zhí)行cmake生成的Makefile可以顯示進(jìn)度，并帶顏色。再看下目錄下的文件：

可以看到我們需要的可執(zhí)行文件main也成功生成了！

然后運(yùn)行main：

運(yùn)行成功！

PS：如果想重新生成main，輸入make clean就可以刪除main這個(gè)文件。然后重新make就行。 需要注意的是：我希望你著重看一下這時(shí)候這個(gè)文件夾下都有哪些文件。

三 編譯多個(gè)源文件

3.1 在同一個(gè)目錄下有多個(gè)源文件

3.1.1 簡單版本

接下來進(jìn)入稍微復(fù)雜的例子：在同一個(gè)目錄下有多個(gè)源文件。

3.1.1.1 項(xiàng)目結(jié)構(gòu)

3.1.1.2 示例代碼

首先刪除之前的文件：

在之前的目錄下添加2個(gè)文件，testFunc.c和testFunc.h:

添加完后整體文件結(jié)構(gòu)如下：

testFunc.c

testFunc.h

修改main.c，調(diào)用testFunc.h里聲明的函數(shù)func()：

main.c

修改CMakeLists.txt，在add_executable的參數(shù)里把testFunc.c加進(jìn)來:

CMakeLists.txt

3.1.1.3 運(yùn)行查看

然后運(yùn)行查看：

運(yùn)行成功！

可以類推，如果在同一目錄下有多個(gè)源文件，那么只要在add_executable里把所有源文件都添加進(jìn)去就可以了。

但是如果有一百個(gè)源文件，再這樣做就有點(diǎn)坑了，無法體現(xiàn)cmake的優(yōu)越性。 因此cmake提供了一個(gè)命令可以把指定目錄下所有的源文件存儲(chǔ)在一個(gè)變量中，這個(gè)命令就是

第一個(gè)參數(shù)dir是指定目錄，第二個(gè)參數(shù)var是用于存放源文件列表的變量。

接下來寫個(gè)進(jìn)階版的demo使用一下這個(gè)變量。

3.1.2 進(jìn)階版本

3.1.2.1 項(xiàng)目結(jié)構(gòu)

3.1.2.2 示例源碼

刪除無關(guān)文件

創(chuàng)建文件：

testFunc1.c

testFunc1.h

再修改main.c，調(diào)用testFunc1.h里聲明的函數(shù)func1()：

main.c

修改CMakeLists.txt：

CMakeLists.txt

使用aux_source_directory把當(dāng)前目錄下的源文件存列表存放到變量SRC_LIST里;

然后在add_executable里調(diào)用SRC_LIST（注意調(diào)用變量時(shí)的寫法）。

3.1.2.3 運(yùn)行查看

再次執(zhí)行cmake和make，并運(yùn)行main:

可以看到運(yùn)行成功了。

aux_source_directory()也存在弊端，它會(huì)把指定目錄下的所有源文件都加進(jìn)來，可能會(huì)加入一些我們不需要的文件，此時(shí)我們可以使用set命令去新建變量來存放需要的源文件，如下：

3.2 在不同目錄下有多個(gè)源文件

一般來說，當(dāng)程序文件比較多時(shí)，我們會(huì)進(jìn)行分類管理，把代碼根據(jù)功能放在不同的目錄下，這樣方便查找。那么這種情況下如何編寫CMakeLists.txt呢？

3.2.1 項(xiàng)目結(jié)構(gòu)

我們把之前的源文件整理一下（新建2個(gè)目錄test_func和test_func1）：

整理好后整體文件結(jié)構(gòu)如下：

把之前的testFunc.c和testFunc.h放到test_func目錄下，testFunc1.c和testFunc1.h則放到test_func1目錄下。

3.2.2 示例源碼

其中，CMakeLists.txt和main.c在同一目錄下，內(nèi)容修改成如下所示：

這里出現(xiàn)了一個(gè)新的命令：include_directories。

該命令是用來向工程添加多個(gè)指定頭文件的搜索路徑，路徑之間用空格分隔。

因?yàn)閙ain.c里include了testFunc.h和testFunc1.h，如果沒有這個(gè)命令來指定頭文件所在位置，就會(huì)無法編譯。當(dāng)然，也可以在main.c里使用include來指定路徑，如下

只是這種寫法不好看。 另外，我們使用了2次aux_source_directory，因?yàn)樵次募植荚?個(gè)目錄下，所以添加2次。

3.2.2 運(yùn)行查看

四 項(xiàng)目級(jí)的組織結(jié)構(gòu)

正規(guī)一點(diǎn)來說，一般會(huì)把源文件放到src目錄下，把頭文件放入到include文件下，生成的對(duì)象文件放入到build目錄下，最終輸出的可執(zhí)行程序文件會(huì)放到bin目錄下，這樣整個(gè)結(jié)構(gòu)更加清晰。

4.1 項(xiàng)目結(jié)構(gòu)

讓我們把前面的文件再次重新組織下：

4.2 示例源碼

修改CMakeLists.txt：

CMakeLists.txt

add_subdirectory：這個(gè)語句的作用是增加編譯子目錄。其基本語法格式是：

一共有三個(gè)參數(shù)，后兩個(gè)是可選參數(shù).

• source_dir 源代碼目錄

指定一個(gè)包含CMakeLists.txt和代碼文件所在的目錄，該目錄可以是絕對(duì)路徑，也可以是相對(duì)路徑，對(duì)于后者相對(duì)路徑的起點(diǎn)是CMAKE_CURRENT_SOURCE_DIR。此外，如果子目錄再次包含的CMakeLists.txt，則將繼續(xù)處理里層的CMakeLists.txt，而不是繼續(xù)處理當(dāng)前源代碼。

• binary_dir 二進(jìn)制代碼目錄

這個(gè)目錄是可選的，如果指定，cmake命令執(zhí)行后的輸出文件將會(huì)存放在此處，若沒有指定，默認(rèn)情況等于source_dir沒有進(jìn)行相對(duì)路徑計(jì)算前的路徑，也就是CMAKE_BINARY_DIR。

• EXCLUDE_FROM_ALL標(biāo)記

這個(gè)標(biāo)志是可選的，如果傳遞了該參數(shù)表示新增加的子目錄將會(huì)排除在ALL目錄之外（可能是make系統(tǒng)中的make all？），表示這個(gè)目錄將從IDE的工程中排除。用戶必須顯式在子文件這個(gè)編譯目標(biāo)（手動(dòng)cmake之類的）。指定了這個(gè)文件夾，表示這個(gè)文件夾是獨(dú)立于源工程的，這些函數(shù)是有用但是不是必要的，比如說我們一系列的例子。

add_subdirectory 這個(gè)命令用于添加源文件子目錄，同時(shí)還可以指定中間二進(jìn)制和目標(biāo)二進(jìn)制的生成路徑。EXCLUDE_FROM_ALL將會(huì)將這個(gè)目錄從編譯中排除，如工程的例子需要等待其他編譯完成后再進(jìn)行單獨(dú)的編譯。通常子目錄應(yīng)該包含自己的project()命令，這樣以來整個(gè)編譯命令將會(huì)產(chǎn)生各自的目標(biāo)文件。如果把CMakeLists.txt與VS IDE比較，總的CMakeLists.txt就相當(dāng)于解決方案，子CMakeLists.txt就相當(dāng)于在解決方案下的工程文件。還有一個(gè)需要注意的是，如果編譯父CMakeLists時(shí)依賴了子CMakeLists.txt中的源文件，那么該標(biāo)志將會(huì)被覆蓋（也就是也會(huì)處理），以滿足編譯任務(wù)。

這里指定src目錄下存放了源文件，當(dāng)執(zhí)行cmake時(shí)，就會(huì)進(jìn)入src目錄下去找src目錄下的CMakeLists.txt，所以在src目錄下也建立一個(gè)CMakeLists.txt，內(nèi)容如下:

src/CMakeLists.txt

這里的set其實(shí)是和前面的一樣，只是EXECUTABLE_OUTPUT_PATH是個(gè)系統(tǒng)自帶的預(yù)定義變量，其意義如下：

• EXECUTABLE_OUTPUT_PATH ：目標(biāo)二進(jìn)制可執(zhí)行文件的存放位置
• PROJECT_SOURCE_DIR：工程的根目錄

所以，這里set的意思是把存放elf文件的位置設(shè)置為工程根目錄下的bin目錄。（cmake有很多預(yù)定義變量，詳細(xì)的可以網(wǎng)上搜索一下）

添加好以上這2個(gè)CMakeLists.txt后，整體文件結(jié)構(gòu)如下：

4.3 運(yùn)行查看

下面來運(yùn)行cmake，不過這次先讓我們切到build目錄下:

這樣Makefile會(huì)在build目錄下生成，二進(jìn)制程序會(huì)在bin目錄下生成，然后運(yùn)行可執(zhí)行程序：

這里解釋一下為什么在build目錄下運(yùn)行cmake？
還記得在第一個(gè)例子里我讓你著重看一下cmake和make之后會(huì)生成什么文件嗎？這個(gè)過程中會(huì)生成很多文件，但是可惜的是跟我們的運(yùn)行并沒有什么關(guān)系，因此，如果能把編譯隔離在某個(gè)文件夾，這樣cmake的時(shí)候所有的中間文件都將在這個(gè)目錄下生成，刪除的時(shí)候也很好刪除，非常方便。如果不這樣做，cmake運(yùn)行時(shí)生成的附帶文件就會(huì)跟源碼文件混在一起，這樣會(huì)對(duì)程序的目錄結(jié)構(gòu)造成污染。
另外一種寫法：
前面的工程使用了2個(gè)CMakeLists.txt，最外層的CMakeLists.txt用于掌控全局，使用add_subdirectory來控制其它目錄下的CMakeLists.txt的運(yùn)行。

上面的例子也可以只使用一個(gè)CMakeLists.txt，把最外層的CMakeLists.txt內(nèi)容改成如下

CMakeLists.txt

同時(shí)，還要把src目錄下的CMakeLists.txt刪除。

然后正常編譯運(yùn)行就可以。

五 動(dòng)態(tài)庫和靜態(tài)庫的編譯控制

有時(shí)只需要編譯出動(dòng)態(tài)庫和靜態(tài)庫，然后等著讓其它程序去使用。讓我們看下這種情況該如何使用cmake。

5.1 生成庫文件

5.1.1 項(xiàng)目結(jié)構(gòu)

首先按照如下重新組織文件，只留下testFunc.h和TestFunc.c

我們會(huì)在build目錄下運(yùn)行cmake，并把生成的庫文件存放到lib目錄下。

5.1.2 示例源碼

CMakeLists.txt

這里又出現(xiàn)了新的命令和預(yù)定義變量:

• add_library: 生成動(dòng)態(tài)庫或靜態(tài)庫(第1個(gè)參數(shù)指定庫的名字；第2個(gè)參數(shù)決定是動(dòng)態(tài)還是靜態(tài)，如果沒有就默認(rèn)靜態(tài)；第3個(gè)參數(shù)指定生成庫的源文件)
• set_target_properties: 設(shè)置最終生成的庫的名稱，還有其它功能，如設(shè)置庫的版本號(hào)等
• LIBRARY_OUTPUT_PATH: 庫文件的默認(rèn)輸出路徑，這里設(shè)置為工程目錄下的lib目錄

PS：前面使用set_target_properties重新定義了庫的輸出名稱，如果不使用set_target_properties也可以，那么庫的名稱就是add_library里定義的名稱，只是連續(xù)2次使用add_library指定庫名稱時(shí)（第一個(gè)參數(shù)），這個(gè)名稱不能相同，而set_target_properties可以把名稱設(shè)置為相同，只是最終生成的庫文件后綴不同（一個(gè)是.so，一個(gè)是.a），這樣相對(duì)來說會(huì)好看點(diǎn)。

5.1.3 運(yùn)行查看

5.2 鏈接庫文件

既然我們已經(jīng)生成了庫，那么就進(jìn)行鏈接測(cè)試下。

5.2.1 項(xiàng)目結(jié)構(gòu)

重新建一個(gè)工程目錄，然后把上節(jié)生成的庫拷貝過來，然后在在工程目錄下新建src目錄和bin目錄，在src目錄下添加一個(gè)main.c，整體結(jié)構(gòu)如下：

5.2.2 示例源碼

main.c

CMakeLists.txt

這里出現(xiàn)2個(gè)新的命令，

• find_library: 在指定目錄下查找指定庫，并把庫的絕對(duì)路徑存放到變量里，其第一個(gè)參數(shù)是變量名稱，第二個(gè)參數(shù)是庫名稱，第三個(gè)參數(shù)是HINTS，第4個(gè)參數(shù)是路徑，其它用法可以參考cmake文檔
• target_link_libraries: 把目標(biāo)文件與庫文件進(jìn)行鏈接

使用find_library的好處是在執(zhí)行cmake …時(shí)就會(huì)去查找?guī)焓欠翊嬖?，這樣可以提前發(fā)現(xiàn)錯(cuò)誤，不用等到鏈接時(shí)。

5.2.3 運(yùn)行查看

cd到build目錄下，然后運(yùn)行cmake … && make，最后進(jìn)入到bin目錄下查看，發(fā)現(xiàn)main已經(jīng)生成，運(yùn)行之：

ps：在lib目錄下有testFunc的靜態(tài)庫和動(dòng)態(tài)庫，find_library(TESTFUNC_LIB testFunc
…默認(rèn)是查找動(dòng)態(tài)庫，如果想直接指定使用動(dòng)態(tài)庫還是靜態(tài)庫，可以寫成find_library(TESTFUNC_LIBlibtestFunc.so …或者find_library(TESTFUNC_LIB libtestFunc.a …

ps： 查看elf文件使用了哪些庫，可以使用readelf -d ./xx來查看 例：readelf -d ./main

六 條件編譯

有時(shí)編譯程序時(shí)想添加一些編譯選項(xiàng)，如-Wall，-std=c++11等，就可以使用add_compile_options來進(jìn)行操作。 這里以一個(gè)簡單程序來做演示。

6.1 簡單程序

6.1.1 項(xiàng)目結(jié)構(gòu)

6.1.2 示例代碼

main.cpp

CMakeLists.txt

6.1.3 運(yùn)行查看

然后cd到build目錄下，執(zhí)行cmake … && make命令，就可以在bin目錄下得到main的可執(zhí)行文件

6.2 添加編譯選項(xiàng)

有時(shí)希望在編譯代碼時(shí)只編譯一些指定的源碼，可以使用cmake的option命令，主要遇到的情況分為2種：

1. 本來要生成多個(gè)bin或庫文件，現(xiàn)在只想生成部分指定的bin或庫文件
2. 對(duì)于同一個(gè)bin文件，只想編譯其中部分代碼（使用宏來控制）

6.2.1 生成部分指定bin或庫文件

6.2.1.1 項(xiàng)目結(jié)構(gòu)

假設(shè)我們現(xiàn)在的工程會(huì)生成2個(gè)bin文件，main1和main2，項(xiàng)目結(jié)構(gòu)如下：

6.2.1.2 示例源碼

CMakeLists.txt

這里使用了option命令，其第一個(gè)參數(shù)是這個(gè)option的名字，第二個(gè)參數(shù)是字符串，用來描述這個(gè)option是來干嘛的，第三個(gè)是option的值，ON或OFF，也可以不寫，不寫就是默認(rèn)OFF。

然后編寫src目錄下的CMakeLists.txt，如下：

src/CMakeLists.txt

注意，這里使用了if-else來根據(jù)option來決定是否編譯main2.c,其中main1.c和main2.c的內(nèi)容如下:

main1.c

main1.c

6.2.1.3 運(yùn)行查看

然后cd到build目錄下輸入cmake … && make就可以只編譯出main1，如果想編譯出main2，就把MYDEBUG設(shè)置為ON，再次輸入cmake … && make重新編譯。

每次想改變MYDEBUG時(shí)都需要去修改CMakeLists.txt，有點(diǎn)麻煩，其實(shí)可以通過cmake的命令行去操作，例如我們想把MYDEBUG設(shè)置為OFF，先cd到build目錄，然后輸入cmake … -DMYDEBUG=ON，這樣就可以編譯出main1和main2 （在bin目錄下）

6.2.2 編譯部分代碼

假設(shè)我們有個(gè)main.c，其內(nèi)容如下：

main.c

可以通過定義宏來控制打印的信息，我們CMakeLists.txt內(nèi)容如下:

這里把option的名字保持和main.c里的宏名稱一致，這樣更加直觀，也可以選擇不同的名字。通過與add_definitions()的配合，就可以控制單個(gè)bin文件的打印輸出了。

整體工程結(jié)構(gòu)如下：

cd到build目錄下執(zhí)行cmake … && make，然后到bin目錄下執(zhí)行./main，可以看到打印為空，

接著分別按照下面指令去執(zhí)行，然后查看打印效果，

• cmake … -DWWW1=ON -DWWW2=OFF && make
• cmake … -DWWW1=OFF -DWWW2=ON && make
• cmake … -DWWW1=ON -DWWW2=ON && make

這里有個(gè)小坑要注意下：假設(shè)有2個(gè)options叫A和B，先調(diào)用cmake設(shè)置了A，下次再調(diào)用cmake去設(shè)置B，如果沒有刪除上次執(zhí)行cmake時(shí)產(chǎn)生的緩存文件，那么這次雖然沒設(shè)置A，也會(huì)默認(rèn)使用A上次的option值。

所以如果option有變化，要么刪除上次執(zhí)行cmake時(shí)產(chǎn)生的緩存文件，要么把所有的option都顯式的指定其值。

總結(jié)

以上是自己學(xué)習(xí)CMake的一點(diǎn)學(xué)習(xí)記錄，通過簡單的例子讓大家入門CMake，學(xué)習(xí)的同時(shí)也閱讀了很多網(wǎng)友的博客。CMake的知識(shí)點(diǎn)還有很多，具體詳情可以在網(wǎng)上搜索。總之，CMake可以讓我們不用去編寫復(fù)雜的Makefile，并且跨平臺(tái)，是個(gè)非常強(qiáng)大并值得一學(xué)的工具。