這一章我們將從一個通用常規工程的角度來看一個 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 目錄下。