在linux下使用CMake構建應用程序

本文介紹了一個跨平臺的自動化構建系統 CMake 在 linux 上的使用方法。 CMake 是一個比 automake 更加容易使用的工具，可以使程序員從複雜的編譯鏈接過程當中解脫出來。文中經過一些例子介紹使用 CMake 處理多源文件目錄的方法、查找並使用其餘開發包的方法以及生成 debug 版和 release 版程序的方法。

CMake簡介

CMake 是一個跨平臺的自動化建構系統,它使用一個名爲 CMakeLists.txt 的文件來描述構建過程,能夠產生標準的構建文件,如 Unix 的 Makefile 或Windows Visual C++ 的 projects/workspaces 。文件 CMakeLists.txt 須要手工編寫,也能夠經過編寫腳本進行半自動的生成。CMake 提供了比 autoconfig 更簡潔的語法。在 linux 平臺下使用 CMake 生成 Makefile 並編譯的流程以下:

1.編寫CmakeLists.txt文件。

2.執行命令你過「cmake PATH」或者「ccmake PATH」生成Makefile（PATH是CMakeLists.txt所在的目錄）。

3.使用make命令進行編譯。

 

第一個工程

現假設咱們的項目中只有一個源文件main.cpp

清單1 源文件main.cpp

#include<iostream>

int main()
{
 std::cout<<"hello world!"<<std::endl;
 return 0;          
}

爲了構建該項目,咱們須要編寫文件 CMakeLists.txt 並將其與 main.cpp 放在 同一個目錄下:

清單2 CMakeLists.txt

PROJECT(main)
CMAKE_MINIMUM_REQUIRED(VERSION 2.6)
AUX_SOURCE_DIRECTORY(. DIR_SRCS)
ADD_EXECUTABLE(main ${DIR_SRCS})

CMakeLists.txt 的語法比較簡單,由命令、註釋和空格組成,其中命令是不區分大小寫的，符號「#」後面的內容被認爲是註釋。命令由命令名稱、小括號和參數組成，參數之間使用空格進行間隔。例如對於清單2的 CMakeLists.txt 文件:第一行是一條命令,名稱是 PROJECT ,參數是 main ,該命令表示項目的名稱是 main 。第二行的命令限定了 CMake 的版本。第三行使用命令 AUX_SOURCE_DIRECTORY 將當前目錄中的源文件名稱賦值給變量 DIR_SRCS 。 CMake 手冊中對命令 AUX_SOURCE_DIRECTORY 的描述以下:

aux_source_directory(<dir> <variable>)

該命令會把參數 <dir> 中全部的源文件名稱賦值給參數 <variable> 。 第四行使用命令 ADD_EXECUTABLE 指示變量 DIR_SRCS 中的源文件須要編譯 成一個名稱爲 main 的可執行文件。

完成了文件 CMakeLists.txt 的編寫後須要使用 cmake 或 ccmake 命令生成Makefile 。 ccmake 與命令 cmake 的不一樣之處在於 ccmake 提供了一個圖形化的操做界面。cmake 命令的執行方式以下:

cmake [options] <path-to-source>

這裏咱們進入了 main.cpp 所在的目錄後執行 「cmake .」 後就能夠獲得 Makefile 並使用 make 進行編譯,以下圖所示。

處理多源文件目錄的方法

CMake 處理源代碼分布在不一樣目錄中的狀況也十分簡單。現假設咱們的源代碼分佈狀況以下:

其中 src 目錄下的文件要編譯成一個連接庫。

第一步，項目主目錄中的 CMakeLists.txt

在目錄 step2 中建立文件 CMakeLists.txt 。文件內容以下

清單 3 目錄 step2 中的 CMakeLists.txt

PROJECT(main)
CMAKE_MINIMUM_REQUIRED(VERSION 2.6) 
ADD_SUBDIRECTORY( src )
AUX_SOURCE_DIRECTORY(. DIR_SRCS)
ADD_EXECUTABLE(main ${DIR_SRCS}  )
TARGET_LINK_LIBRARIES( main Test )

相對於清單 2，該文件添加了下面的內容: 第三行，使用命令 ADD_SUBDIRECTORY 指明本項目包含一個子目錄 src 。第六行，使用命令 TARGET_LINK_LIBRARIES 指明可執行文件 main 須要鏈接一個名爲Test的連接庫 。

第二步，子目錄中的 CmakeLists.txt

在子目錄 src 中建立 CmakeLists.txt。文件內容以下:

清單 4. 目錄 src 中的 CmakeLists.txt

AUX_SOURCE_DIRECTORY(. DIR_TEST1_SRCS)
ADD_LIBRARY ( Test ${DIR_TEST1_SRCS})

在該文件中使用命令 ADD_LIBRARY 將 src 目錄中的源文件編譯爲共享庫。

第三步，執行 cmake

至此咱們完成了項目中全部 CMakeLists.txt 文件的編寫,進入目錄 step2 中依次執行命令 「cmake .」 和 「make」 獲得結果以下:

圖3. 處理多源文件目錄時 cmake 的執行結果

在執行 cmake 的過程當中,首先解析目錄 step2 中的 CMakeLists.txt ,當程序執行命令 ADD_SUBDIRECTORY( src ) 時進入目錄 src 對其中的 CMakeLists.txt 進行解析。

在工程中查找並使用其餘程序庫的方法

在項目的根目錄中建立目錄 cmake/modules/ ，在 cmake/modules/ 下建立文件 Findlibdb_cxx.cmake ，內容以下：

清單 5. 文件 Findlibdb_cxx.cmake

MESSAGE(STATUS "Using bundled Findlibdb.cmake...")
 FIND_PATH(
   LIBDB_CXX_INCLUDE_DIR
   db_cxx.h 
   /usr/include/ 
   /usr/local/include/ 
   )
 
 FIND_LIBRARY(
 LIBDB_CXX_LIBRARIES NAMES  db_cxx
 PATHS /usr/lib/ /usr/local/lib/
  )

文件 Findlibdb_cxx.cmake 的命名要符合規範: FindlibNAME.cmake ,其中NAME 是函數庫的名稱。Findlibdb_cxx.cmake 的語法與 CMakeLists.txt 相同。這裏使用了三個命令： MESSAGE ， FIND_PATH 和 FIND_LIBRARY 。

• 命令 MESSAGE 會將參數的內容輸出到終端。
• 命令 FIND_PATH 指明頭文件查找的路徑，原型以下：
find_path(<VAR> name1 [path1 path2 ...]) 該命令在參數 path* 指示的目錄中查找文件 name1 並將查找到的路徑保存在變量 VAR 中。清單5第3－8行的意思是在 /usr/include/ 和 /usr/local/include/ 中查找文件db_cxx.h ,並將db_cxx.h 所在的路徑保存在 LIBDB_CXX_INCLUDE_DIR中。
• 命令 FIND_LIBRARY 同 FIND_PATH 相似,用於查找連接庫並將結果保存在變量中。清單5第10－13行的意思是在目錄 /usr/lib/ 和 /usr/local/lib/ 中尋找名稱爲 db_cxx 的連接庫,並將結果保存在 LIBDB_CXX_LIBRARIES。

第二步, 項目的根目錄中的 CmakeList.txt

在項目的根目錄中建立 CmakeList.txt ：

清單 6. 能夠查找連接庫的 CMakeList.txt

01 PROJECT(main)
02 CMAKE_MINIMUM_REQUIRED(VERSION 2.6)
03 SET(CMAKE_SOURCE_DIR .)
04 SET(CMAKE_MODULE_PATH ${CMAKE_ROOT}/Modules ${CMAKE_SOURCE_DIR}/cmake/modules) 
05 AUX_SOURCE_DIRECTORY(. DIR_SRCS)
06 ADD_EXECUTABLE(main ${DIR_SRCS})
0708 FIND_PACKAGE( libdb_cxx REQUIRED)
09 MARK_AS_ADVANCED(
10 LIBDB_CXX_INCLUDE_DIR
11 LIBDB_CXX_LIBRARIES
12 )
13 IF (LIBDB_CXX_INCLUDE_DIR AND LIBDB_CXX_LIBRARIES)
14 MESSAGE(STATUS "Found libdb libraries")
15    INCLUDE_DIRECTORIES(${LIBDB_CXX_INCLUDE_DIR})
16     MESSAGE( ${LIBDB_CXX_LIBRARIES} )
17     TARGET_LINK_LIBRARIES(main ${LIBDB_CXX_LIBRARIES}18 )
19 ENDIF (LIBDB_CXX_INCLUDE_DIR AND LIBDB_CXX_LIBRARIES)

在該文件中第4行表示到目錄 ./cmake/modules 中查找 Findlibdb_cxx.cmake ,8-19 行表示查找連接庫和頭文件的過程。第8行使用命令 FIND_PACKAGE 進行查找,這條命令執行後 CMake 會到變量 CMAKE_MODULE_PATH 指示的目錄中查找文件 Findlibdb_cxx.cmake 並執行。第13-19行是條件判斷語句,表示若是 LIBDB_CXX_INCLUDE_DIR 和 LIBDB_CXX_LIBRARIES 都已經被賦值,則設置編譯時到 LIBDB_CXX_INCLUDE_DIR 尋找頭文件而且設置可執行文件 main 須要與連接庫 LIBDB_CXX_LIBRARIES 進行鏈接。

第三步，執行 cmake

完成 Findlibdb_cxx.cmake 和 CMakeList.txt 的編寫後在項目的根目錄依次執行 「cmake . 」 和 「make 」 能夠進行編譯,結果以下圖所示：

使用 cmake 生成 debug 版和 release 版的程序

在 Visual Studio 中咱們能夠生成 debug 版和 release 版的程序,使用 CMake 咱們也能夠達到上述效果。debug 版的項目生成的可執行文件須要有調試信息而且不須要進行優化,而 release 版的不須要調試信息但須要優化。這些特性在 gcc/g++ 中是經過編譯時的參數來決定的,若是將優化程度調到最高須要設置參數-O3,最低是 -O0 即不作優化;添加調試信息的參數是 -g -ggdb ,若是不添加這個參數,調試信息就不會被包含在生成的二進制文件中。

CMake 中有一個變量 CMAKE_BUILD_TYPE ,能夠的取值是 Debug Release RelWithDebInfo 和 MinSizeRel。當這個變量值爲 Debug 的時候,CMake 會使用變量 CMAKE_CXX_FLAGS_DEBUG 和 CMAKE_C_FLAGS_DEBUG 中的字符串做爲編譯選項生成 Makefile ,當這個變量值爲 Release 的時候,工程會使用變量 CMAKE_CXX_FLAGS_RELEASE 和 CMAKE_C_FLAGS_RELEASE 選項生成 Makefile。

現假設項目中只有一個文件 main.cpp ,下面是一個能夠選擇生成 debug 版和 release 版的程序的 CMakeList.txt ：

清單 7

 PROJECT(main)
2 CMAKE_MINIMUM_REQUIRED(VERSION 2.6)
3 SET(CMAKE_SOURCE_DIR .)
45 SET(CMAKE_CXX_FLAGS_DEBUG "$ENV{CXXFLAGS} -O0 -Wall -g -ggdb")
6 SET(CMAKE_CXX_FLAGS_RELEASE "$ENV{CXXFLAGS} -O3 -Wall")
78 AUX_SOURCE_DIRECTORY(. DIR_SRCS)
9 ADD_EXECUTABLE(main ${DIR_SRCS})

第 5 和 6 行設置了兩個變量 CMAKE_CXX_FLAGS_DEBUG 和 CMAKE_CXX_FLAGS_RELEASE, 這兩個變量是分別用於 debug 和 release 的編譯選項。 編輯 CMakeList.txt 後須要執行 ccmake 命令生成 Makefile 。在進入項目的根目錄,輸入 "ccmake ." 進入一個圖形化界面,以下圖所示：

圖 5. ccmake 的界面

按照界面中的提示進行操做,按 "c" 進行 configure ,這時界面中顯示出了配置變量 CMAKE_BUILD_TYPE 的條目。以下圖所示：

圖 6. 執行了 configure 之後 ccmake 的界面

下面咱們首先生成 Debug 版的 Makefile ：將變量 CMAKE_BUILD_TYPE 設置爲 Debug ,按 "c" 進行 configure ，按 "g" 生成 Makefile 並退出。這時執行命令 find * | xargs grep "O0" 後結果以下:

清單 8 find * | xargs grep "O0"的執行結果

CMakeFiles/main.dir/flags.make:CXX_FLAGS = -O0 -Wall -g -ggdb 
CMakeFiles/main.dir/link.txt:/usr/bin/c++ -O0 -Wall -g -ggdb 
CMakeFiles/main.dir/main.cpp.o -o main -rdynamic 
CMakeLists.txt:SET(CMAKE_CXX_FLAGS_DEBUG "$ENV{CXXFLAGS} -O0 -Wall -g -ggdb")

這個結果說明生成的 Makefile 中使用了變量 CMAKE_CXX_FLAGS_DEBUG 做爲編譯時的參數。

下面咱們將生成 Release 版的 Makefile ：再次執行命令 "ccmake ." 將變量CMAKE_BUILD_TYPE 設置爲 Release ,生成 Makefile 並退出。執行命令 find * | xargs grep "O0" 後結果以下：

清單 9 find * | xargs grep "O0"的執行結果

CMakeLists.txt:SET(CMAKE_CXX_FLAGS_DEBUG "$ENV{CXXFLAGS} -O0 -Wall -g -ggdb")

而執行命令 find * | xargs grep "O3" 後結果以下:

清單 10. find * | xargs grep "O3"的執行結果

CMakeCache.txt:CMAKE_CXX_FLAGS_RELEASE:STRING=-O3 -DNDEBUG
CMakeCache.txt:CMAKE_C_FLAGS_RELEASE:STRING=-O3 -DNDEBUG
CMakeFiles/main.dir/flags.make:CXX_FLAGS = -O3 -Wall 
CMakeFiles/main.dir/link.txt:/usr/bin/c++ -O3 -Wall 
CMakeFiles/main.dir/main.cpp.o -o main -rdynamic 
CMakeLists.txt:SET(CMAKE_CXX_FLAGS_RELEASE "$ENV{CXXFLAGS} -O3 -Wall")

這兩個結果說明生成的 Makefile 中使用了變量 CMAKE_CXX_FLAGS_RELEASE 做爲編譯時的參數。這兩個結果說明生成的 Makefile 中使用了變量 CMAKE_CXX_FLAGS_RELEASE 做爲編譯時的參數。這兩個結果說明生成的 Makefile 中使用了變量 CMAKE_CXX_FLAGS_RELEASE 做爲編譯時的參數。這兩個結果說明生成的 Makefile 中使用了變量 CMAKE_CXX_FLAGS_RELEASE 做爲編譯時的參數。

參考資料

• 要了解 CMake, 請參考其官方網站：http://www.cmake.org/。
• 維基百科中對 CMake 也有很是詳細的說明，具體請參考：http://zh.wikipedia.org/wiki/CMake。
• 在 developerWorks Linux 專區 尋找爲 Linux 開發人員（包括 Linux 新手入門）準備的更多參考資料，查閱咱們 最受歡迎的文章和教程。
• 在 developerWorks 上查閱全部 Linux 技巧 和 Linux 教程。

 https://cmake.org/Wiki/CMake:How_To_Find_Libraries

http://blog.csdn.net/dbzhang800/article/details/6329314