什麼是CMake

CMake

CMake是一個跨平臺的安裝（編譯）工具，可以用簡單的語句來描述所有平臺的安裝(編譯過程)。他能夠輸出各種各樣的makefile或者project檔案，能測試編譯器所支援的C++特性,類似UNIX下的automake。只是 CMake 的組態檔取名為 CMakeLists.txt。Cmake 並不直接建構出最終的軟體，而是產生標準的建構檔（如 Unix 的 Makefile 或 Windows Visual C++ 的 projects/workspaces），然後再依一般的建構方式使用。這使得熟悉某個整合開發環境（IDE）的開發者可以用標準的方式建構他的軟體，這種可以使用各平臺的原生建構系統的能力是 CMake 和 SCons 等其他類似系統的區別之處。

Make

make工具是一個簡化編譯工作程式，有了它我們可以進行所謂的“自動化編譯”，極大地提高了軟體開發的效率。make工具相當於一個Shell，通過解釋Makefile的中的命令進行工作。大多數IDE都有這個工具，比如：Visual C++的nmake，Linux下GNU的make。
make工具最主要也是最基本的功能就是通過makefile檔案來描述源程式之間的相互關係並自動維護編譯工作。而makefile 檔案需要按照某種語法進行編寫，檔案中需要說明如何編譯各個原始檔並連線生成可執行檔案，並要求定義原始檔之間的依賴關係。

直白點說就是，CMake用來生成makefile或者是工程檔案，make是用來解釋makefile的。
以Linux平臺下使用gcc編譯為例，我們想要編譯原始檔可以直接在命令列中執行gcc test.c -o test

之類的命令，可是檔案多了，工程複雜，而且檔案不時的還會變，每次這樣輸多麻煩。
這個時候make就有了用武之地，寫個makefile，以後編譯就直接make解釋下makefile，根據makefile來執行編譯命令。這樣在linux上是很好，在windows上或者其他平臺上怎麼辦呢？
這時候就到cmake出馬了，構建工程的時候，不在寫makefile，而寫CMakeLists.txt。需要編譯的時候，先用Cmake解釋CMakeLists.txt。如果在Windows平臺上，設定編譯器是VS，CMake就生成一個VS的工程，然後用VS來執行編譯專案。如果是在Linux平臺上，編譯器是gcc，CMake就生成makefile，然後用make來解釋makefile編譯專案。
如圖，分別為原始目錄、在Linux下選擇gcc為編譯工具生成的工程檔案和在WIndows下選用Visual Studio為編譯器生成的工程檔案：

cmake執行後會在cmake執行時所在的目錄生成許多檔案，根據cmake執行目錄是否與原始檔同目錄，將構建方式分為兩種：

• out-of-source build，構建輸出檔案與原始檔放到不同目錄中；
• in-source build ：構建輸出檔案與原始檔放到相同目錄中。

一般選擇out-of-source方式，可以在專案目錄下建立一個build檔案，然後進入build下，執行cmake ../，使生成的檔案都在build資料夾下，以便後期清理。

示例

為了編譯與演示方便，示例全部在Linux下進行。

Hello, CMake！

CMake最簡單的例項，目錄結構如下：

main.c檔案：

 #include <stdio.h>

int main(int argc, char *argv[])
{
    printf("Hello, CMake!\r\n");

    return 0;
}

CMakeLists.txt檔案

 # 版本限定
CMAKE_MINIMUM_REQUIRED(VERSION 2.8)                      
# 專案名稱
PROJECT(Test1)
# 新增原始檔列表變數
SET(SRC_LIST main.cpp)
# 列印編譯目錄和專案目錄路徑
MESSAGE(STATUS "This is SOURCE dir " ${PROJECT_SOURCE_DIR})
# 生成可執行檔案
ADD_EXECUTABLE(HelloCMake ${SRC_LIST})

然後進入專案目錄，依次執行（需要確保linux下安裝了gcc、make等）：

mkdir build
cd build
cmake ../

此時，build資料夾內容如下：

。然後鍵入make命令，即解析了Makefile檔案，build目錄下的內容變為：

可以看到，生成了一個HelloCMake的可執行檔案，鍵入./HelloCMake可以執行HelloCMake檔案。
bash執行輸出過程如下：

同一目錄多個原始檔

在實際使用中，很少會出現這麼簡單的情況，往往在一個資料夾中會存在多個原始檔要求編譯，目錄如下，這時候只需要在SET後面加上需要編譯的原始檔就可以了。

CMakeLists.txt檔案：

# 版本限定
CMAKE_MINIMUM_REQUIRED(VERSION 2.8)                      
# 專案名稱
PROJECT(Test2)
# 新增原始檔列表變數
SET(SRC_LIST Stupid.cpp main.cpp)
# 列印編譯目錄和專案目錄路徑
MESSAGE(STATUS "This is BINARY dir " ${PROJECT_BINARY_DIR})
MESSAGE(STATUS "This is SOURCE dir " ${PROJECT_SOURCE_DIR})
# 生成可執行檔案
ADD_EXECUTABLE(Test2 ${SRC_LIST})

上述方式雖然可行，但是如果原始檔過多，CMakeLists.txt檔案編寫起來也是一件很吃力的事情，這時候，可以用aux_source_directory來解決這個問題。aux_source_directory可以遍歷指定資料夾的下原始檔，將它們統一複製給一個變數，然後進行編譯。

CMakeLists.txt檔案2：

# 版本限定
CMAKE_MINIMUM_REQUIRED(VERSION 2.8)                      
# 專案名稱
project(Test3)

# 遍歷當前目錄所有的原始檔，賦值給test3src
aux_source_directory(. test3src)
message(STATUS "src file : " ${test3src})
# 生成可執行檔案
add_executable(Test3 ${test3src})

不同目錄下的多個原始檔

為了使原始碼更為清晰，原始碼往往會根據不同的功能，將程式碼放在不同的資料夾下，結構如圖：

這時候CmakeLists.txt檔案又該如何編寫呢？答案如下：

# 版本限定
CMAKE_MINIMUM_REQUIRED(VERSION 2.8)                      
# 專案名稱
project(Test3)

# 遍歷當前目錄所有的原始檔，賦值給test3src
aux_source_directory(. main)
aux_source_directory(./stupid stupid)
set(test4src ${main} ${stupid})
message(STATUS "src file : " ${test4src})

# 生成可執行檔案
add_executable(Test4 ${test4src})

編譯動態庫與靜態庫

在前面的示例中，我們都是直接生成了可執行檔案，而更多的時候，我們需要生成的不是可執行檔案，而是一個可以讓複用的庫檔案，這時候只需要將add_executable(Name ${srcTemp})修改為add_library(Name ${srcTemp})就可以了。add_library可以在中間增加一個引數表示動態庫或靜態庫，預設無引數為靜態庫。

# 版本限定
cmake_minimum_required(VERSION 2.8)

# 遍歷當前目錄所有的原始檔，賦值給STUPID_SRC
aux_source_directory(. STUPID_SRC)
# 編譯STUPID_SRC為靜態庫
add_library(stupid STATIC ${STUPID_SRC})
# 編譯STUPID_SRC為動態庫
# add_library(stupid SHARED ${STUPID_SRC})

庫檔案和標頭檔案匯出到指定位置

編譯出的庫檔案是要使用的，而庫檔案的使用一般需要庫檔案和標頭檔案。雖然可以編譯出庫後自己整理庫檔案和標頭檔案，但是終歸是一件麻煩事，尤其是工程比較龐大的時候。這時候，我們可以使用INSTALL來將庫檔案和標頭檔案匯出到指定位置。

# 版本限定
CMAKE_MINIMUM_REQUIRED(VERSION 2.8)
SET(OUTPUT ${CMAKE_CURRENT_BINARY_DIR})
AUX_SOURCE_DIRECTORY(. STUPID_SRC)
# 設定庫檔案輸出目錄
# SET(LIBRARY_OUTPUT_PATH ${LIB_DIRS})
# 建立動態庫
ADD_LIBRARY(stupid SHARED ${STUPID_SRC})
# 匯出動態庫
INSTALL(TARGETS stupid DESTINATION ${OUTPUT}/libs)
# 匯出標頭檔案
INSTALL(DIRECTORY . DESTINATION ${OUTPUT}/include/stupid 
    FILES_MATCHING PATTERN "*.h")

然後進入專案目錄/build/ 目錄下，依次執行：

cmake ../
make 
make install

即可在build下生成以下結構：

include為標頭檔案目錄，其中包含了stupid/stupid.h檔案。libs為庫檔案目錄，其中包含了libstupid.so檔案。

使用動態庫/靜態庫

在上一個示例中，我們生成並匯出了動態庫，現在來使用它。複製出上個示例匯出的libs及include資料夾，形成以下結構：

CMakeLists.txt檔案內容如下：

# 版本限定
CMAKE_MINIMUM_REQUIRED(VERSION 2.8)                      
# 專案名稱
PROJECT(Test8)
# 遍歷當前目錄所有的原始檔，賦值給test3src
AUX_SOURCE_DIRECTORY(. main)
MESSAGE(STATUS "src file : " ${main})
# 指定庫檔案搜尋目錄，必須為絕對路徑
LINK_DIRECTORIES(${PROJECT_SOURCE_DIR}/libs)
# 生成可執行檔案
ADD_EXECUTABLE(Test8 ${main})
# 指定標頭檔案目錄
INCLUDE_DIRECTORIES(./include)
# 指定目標需要連線的庫
TARGET_LINK_LIBRARIES(Test8 stupid)