天天看點
傳回

使用CMake工具生成makefile檔案

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

 
1 #include<iostream>
2 
3 int main()
4 {
5     std::cout<<"Hello word!"<<std::endl;
6     return 0;
7 }

為了建構該項目,我們需要編寫檔案 CMakeLists.txt 并将其與 main.cpp 放在 同一個目錄下:

清單 2 CMakeLists.txt

 
1 PROJECT(main)
2 CMAKE_MINIMUM_REQUIRED(VERSION 2.6)
3 AUX_SOURCE_DIRECTORY(. DIR_SRCS)
4 ADD_EXECUTABLE(main ${DIR_SRCS})

CMakeLists.txt 的文法比較簡單,由指令、注釋和空格組成,其中指令是不區分大小寫的,符号"#"後面的内容被認為是注釋。指令由指令名稱、小括号和參數組成,參數之間使用空格進行間隔。例如對于清單2的 CMakeLists.txt 檔案:第一行是一條指令,名稱是 PROJECT ,參數是 main ,該指令表示項目的名稱是 main 。第二行的指令限定了 CMake 的版本。第三行使用指令 AUX_SOURCE_DIRECTORY 将目前目錄中的源檔案名稱指派給變量 DIR_SRCS 。 CMake 手冊中對指令 AUX_SOURCE_DIRECTORY 的描述如下:

該指令會把參數 <dir> 中所有的源檔案名稱指派給參數 <variable> 。 第四行使用指令 ADD_EXECUTABLE 訓示變量 DIR_SRCS 中的源檔案需要編譯 成一個名稱為 main 的可執行檔案。

完成了檔案 CMakeLists.txt 的編寫後需要使用 cmake 或 ccmake 指令生成Makefile 。 ccmake 與指令 cmake 的不同之處在于 ccmake 提供了一個圖形化的操作界面。cmake 指令的執行方式如下:

這裡我們進入了 main.cpp 所在的目錄後執行 “cmake .” 後就可以得到 Makefile 并使用 make 進行編譯,如下圖所示。

圖 1. camke 的運作結果
使用CMake工具生成makefile檔案

回頁首

處理多源檔案目錄的方法

CMake 

處理源代碼分

布在不同目錄中的情況也十分簡單。現假設我們的源代碼

分布情況如下

:
圖 2. 源代碼分布情況
使用CMake工具生成makefile檔案

其中 src 目錄下的檔案要編譯成一個連結庫。

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

在目錄 step2 中建立檔案 CMakeLists.txt 。檔案内容如下:

清單 3 目錄 step2 中的 CMakeLists.txt 
1 PROJECT(main)
2 CMAKE_MINIMUM_REQUIRED(VERSION 2.6) 
3 ADD_SUBDIRECTORY( src )
4 AUX_SOURCE_DIRECTORY(. DIR_SRCS)
5 ADD_EXECUTABLE(main ${DIR_SRCS}  )
6 TARGET_LINK_LIBRARIES( main Test )

相對于清單 2，該檔案添加了下面的内容: 第三行，使用指令 ADD_SUBDIRECTORY 指明本項目包含一個子目錄 src 。第六行，使用指令 TARGET_LINK_LIBRARIES 指明可執行檔案 main 需要連接配接一個名為Test的連結庫 。

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

在子目錄 src 中建立 CmakeLists.txt。檔案内容如下:

清單 4. 目錄 src 中的 CmakeLists.txt 
1 AUX_SOURCE_DIRECTORY(. DIR_TEST1_SRCS)
2 ADD_LIBRARY ( Test ${DIR_TEST1_SRCS})

在該檔案中使用指令 ADD_LIBRARY 将 src 目錄中的源檔案編譯為共享庫。

第三步，執行 cmake

至此我們完成了項目中所有 CMakeLists.txt 檔案的編寫,進入目錄 step2 中依次執行指令 “cmake .” 和 “make” 得到結果如下:

圖3. 處理多源檔案目錄時 cmake 的執行結果
使用CMake工具生成makefile檔案

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

回頁首

在工程中查找并使用其他程式庫的方法

在開發軟體的時候我們會用到一些函數庫,這些函數庫在不同的系統中安裝的位置可能不同,編譯的時候需要首先找到這些軟體包的頭檔案以及連結庫所在的目錄以便生成編譯選項。例如一個需要使用博克利資料庫項目,需要頭檔案db_cxx.h 和連結庫 libdb_cxx.so ,現在該項目中有一個源代碼檔案 main.cpp ，放在項目的根目錄中。

第一步，程式庫說明檔案

在項目的根目錄中建立目錄 cmake/modules/ ，在 cmake/modules/ 下建立檔案 Findlibdb_cxx.cmake ，内容如下：

清單 5. 檔案 Findlibdb_cxx.cmake 
01 MESSAGE(STATUS "Using bundled Findlibdb.cmake...")
0203 FIND_PATH(
04   LIBDB_CXX_INCLUDE_DIR
05   db_cxx.h 
06   /usr/include/ 
07   /usr/local/include/ 
08   )
09 
10 FIND_LIBRARY(
11   LIBDB_CXX_LIBRARIES NAMES  db_cxx
12   PATHS /usr/lib/ /usr/local/lib/
13   )

檔案 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 ” 可以進行編譯,結果如下圖所示：

圖 4. 使用其他程式庫時 cmake 的執行結果
使用CMake工具生成makefile檔案

回頁首

使用 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 
1 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 的界面
使用CMake工具生成makefile檔案

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

圖 6. 執行了 configure 以後 ccmake 的界面
使用CMake工具生成makefile檔案

下面我們首先生成 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 作為編譯時的參數。

Linux makefile cmake 跨平台 自動化
上一篇: 希爾排序 算法
下一篇: CMake手冊詳解：（一）開始篇

繼續閱讀