CMake 入門2 —— 一個鏈接動態庫的簡單工程

這一章我們將從一個通用常規工程的角度來看一個 CMake 工程的常用阻止結構。先來看看工程目錄結構:

.
├── CMakeLists.txt
├── build
├── include
│   └── mylib.h
├── lib
│   ├── libmylib.a
└── src
    └── main.cpp

我們有 4 個文件夾,1 個 CMakeLists.txt 文件。

  • build 是用來存放使用 CMake 編譯時所產生的中間文件。
  • include 存放我們源碼所需要依賴的頭文件。
  • lib 存放我們工程所需依賴的外部動態庫。
  • src 存放我們的源碼文件。

本章節的目的是,通過編寫 CMakeLists.txt 來組織編譯流程:編譯 map.cpp,其中使用了 mylib.h 中聲明的方法,方法定義在 libmylib.a 中,因此還需要鏈接 libmylib.a

準備工作

我們需要先編譯出 libmylib.a
mylib.h 文件內容如下:

int myadd(int a, int b);
void myprint(int s);

mylib.cpp 文件內容如下:

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

int myadd(int a, int b) {
    return a + b;
}

void myprint(int s) {
    std::cout << s << std::endl;
}

將它們兩個放在同一個目錄下,使用命令 gcc -c mylib.cpp -o mylib.o 編譯出目標文件(只是編譯,沒有鏈接,也就是引用的外部頭文件中的方法將沒有實現),然后用命令 ar rcv libmylib.a mylib.o 將目標文件 mylib.o 打包成動態庫 libmylib.a

libmylib.a 放在 lib 目錄下,這樣我們就完成了準備工作。

編寫 CMakeLists.txt

先看下最后的 CMakeLists.txt

cmake_minimum_required(VERSION 3.0)
project(hello)
include_directories(${CMAKE_CURRENT_LIST_DIR}/include)
aux_source_directory(${CMAKE_CURRENT_LIST_DIR}/src hello_src)
link_directories(${CMAKE_CURRENT_LIST_DIR}/lib)
add_executable(${PROJECT_NAME} ${hello_src})
target_link_libraries(${PROJECT_NAME} libmylib.a)

set(CMAKE_CXX_COMPILER "clang++")   # 顯式指定所使用的 C++ 編譯器
set(CMAKE_CXX_FLAGS "-std=c++11")   # c++11
set(CMAKE_CXX_FLAGS "-g")   # 調試信息
set(CMAKE_CXX_FLAGS "-Wall")    # 開啟所有警告

set(CMAKE_CXX_FLAGS_DEBUG "-O0")    # 調試包不優化
set(CMAKE_CXX_FLAGS_RELEASE "-O2 -DNDEBUG") # release 包優化
最低版本要求

cmake_minimum_required(VERSION 3.0),通過這條代碼指定該 CMakeLists.txt 中所使用的語法向下兼容到 3.0 版本。

給工程起個名字

project(hello),將工程名字設置為 hello。該方法將同時設置 CMake 的全局變量 ${PROJECT_NAME}

讓 CMake 找到工程所需頭文件

include_directories(${CMAKE_CURRENT_LIST_DIR}/include)。其中 ${CMAKE_CURRENT_LIST_DIR}CMake 自帶變量,表示正在執行的 CMake 文件所在目錄。

  • 注意這個命令所接受的參數是目錄路徑,該目錄下的所有頭文件都將被搜索到。因此,如果工程是一個對外發布的庫,那么比較好的實踐是 將其對外接口的頭文件都放在統一的 include 文件夾中。這樣,使用者只用 include 該頭文件目錄即可。
  • 該命令所添加的頭文件搜索路徑同樣將向下傳遞到子 CMakeLists.txt 的頭文件搜索路徑中。
  • 該命令不遞歸搜索文件。
讓 CMake 找到工程所需源文件

aux_source_directory(${CMAKE_CURRENT_LIST_DIR}/src hello_src)。第一個參數代表包含源文件的目錄,不會遞歸搜索目錄。將搜索到的源碼文件(*.h, *.hpp 等結尾的頭文件不會被搜索在內)路徑會保存到變量 ${hello_src} 中。

官方文檔上說,像這種自動搜索的命令(包括 file(GLOB_RECURSE ...) 等)會有一個問題:搜索的結果只會在運行 cmake 時被更新。因此,如果在源碼文件路徑下新增了一個源碼文件的話,make 并不會編譯這個新增的源碼文件。需要再次調用 cmake 進行搜索。

讓 CMake 找到庫文件

link_directories(${CMAKE_CURRENT_LIST_DIR}/lib)。和 include_directories 一樣,cmake 將在該目錄下搜索需要鏈接的動態庫。

告訴 CMake 我的構建目標

add_executable(${PROJECT_NAME} ${hello_src})。第一個參數是構建出來的可執行文件的名字,第二個參數是一個所有需要編譯的源碼文件 List,這里我們使用了 aux_source_directory 中所設置的變量 ${hello_src}。這條函數會生成名為 ${hello_src} 的可執行文件。

告訴 CMake 我要鏈接的庫文件

target_link_libraries(${PROJECT_NAME} libmylib.a)。如果寫了上面的 link_directories,那么這條函數就只用寫庫名就可以了。這里的庫名可以使用 libmylib.a 這樣的全名,也可以是 mylib 這樣的只用按規則指定文件名。如果使用 mylib,那么會優先搜索 libmylib.a,其次搜索 libmylib.so

傳遞 FLAGS 給 C++ 編譯器

如果 main.cpp 中用到了 C++11,那么就需要在生成的 Makefile 中告訴編譯器啟動 C++11

set(CMAKE_CXX_COMPILER "clang++")   # 顯式指定所使用的 C++ 編譯器
set(CMAKE_CXX_FLAGS "-std=c++11")   # c++11
set(CMAKE_CXX_FLAGS "-g")   # 調試信息
set(CMAKE_CXX_FLAGS "-Wall")    # 開啟所有警告

set(CMAKE_CXX_FLAGS_DEBUG "-O0")    # 調試包不優化
set(CMAKE_CXX_FLAGS_RELEASE "-O2 -DNDEBUG") # release 包優化

開始構建

CMake 入門1 —— CMake Hello World 中一樣,我們在 build 文件夾中執行 cmake ..,生成 Makefile 后執行 make,即可得到可執行文件 hello

hello 會生成在 build 文件夾下,如果想該自定義一個生成路徑,那么可以使用 set(EXECUTABLE_OUTPUT_PATH ${CMAKE_CURRENT_LIST_DIR}/bin),該命令會在 CMakeLists.txt 所在目錄下自動創建一個 bin 文件夾。make 所生成的可執行文件將放在 bin 目錄下。

?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,461評論 6 532
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,538評論 3 417
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,423評論 0 375
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,991評論 1 312
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,761評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,207評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,268評論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,419評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,959評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,782評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,983評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,528評論 5 359
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,222評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,653評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,901評論 1 286
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,678評論 3 392
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,978評論 2 374

推薦閱讀更多精彩內容