cmake使用方法詳解cmake 簡介

    CMake的所有的語句都寫在一個叫:CMakeLists.txt的檔案中。當CMakeLists.txt檔案确定後,可以用ccmake指令對相關 的變量值進行配置。這個指令必須指向CMakeLists.txt所在的目錄。配置完成之後,應用cmake指令生成相應的makefile（在Unix like系統下）或者 project檔案（指定用window下的相應程式設計工具編譯時）。

    其基本操作流程為：

$> ccmake directory

$> cmake directory

$> make

  其中directory為CMakeList.txt所在目錄；

第一條語句用于配置編譯選項，如VTK_DIR目錄 ，一般這一步不需要配置，直接執行第二條語句即可，但當出現錯誤時，這裡就需要認為配置了，這一步才真正派上用場；

第二條指令用于根據CMakeLists.txt生成Makefile檔案；

第三條指令用于執行Makefile檔案，編譯程式，生成可執行檔案；

CMake的執行就是這麼簡單，其難點在于如何編寫CMakeLists.txt檔案，下面結合例子簡單介紹CMakeLists.txt的編寫，看下面這個CMakeLists.txt

#project name

PROJECT(test_math)

#head file path

INCLUDE_DIRECTORIES(

include

)

#source directory

AUX_SOURCE_DIRECTORY(src DIR_SRCS)

#set environment variable

SET(TEST_MATH

${DIR_SRCS}

#set extern libraries

SET(LIBRARIES

libm.so

#add executable file

ADD_EXECUTABLE(../bin/bin ${TEST_MATH})

#add link library

TARGET_LINK_LIBRARIES(../bin/bin ${LIBRARIES})

            或者用下面這個CMakeLists.txt

#project name  

PROJECT(test_math)  

add_definitions("-Wall -lpthread -g")  

#head file path  

INCLUDE_DIRECTORIES(  

include  

)  

#source directory  

AUX_SOURCE_DIRECTORY(src DIR_SRCS)  

#set environment variable  

SET(TEST_MATH  

${DIR_SRCS}  

#set extern libraries  

SET(LIBRARIES  

libm.so  

# set output binary path  

SET(EXECUTABLE_OUTPUT_PATH ${PROJECT_BINARY_DIR}/bin)  

SET(FS_BUILD_BINARY_PREFIX "Yfs")  

#add executable file  

ADD_EXECUTABLE(${FS_BUILD_BINARY_PREFIX}sqrt ${TEST_MATH})  

#add link library  

TARGET_LINK_LIBRARIES(${FS_BUILD_BINARY_PREFIX}sqrt ${LIBRARIES})  

 這是一個測試數學函數的程式的CMakeLists.txt，"#"後面為注釋的内容，CMake的指令全部為大寫

第2行指定生成的工程名為test_math

第4行指定頭檔案目錄為include

第8行指定源檔案目錄為src，并将其指派給環境變量DIR_SRCS

第10行設定環境變量TEST_MATH的值為環境變量DIR_SRCS的值，此處用于顯示如何用環境變量對環境變量進行指派

第14行将數學函數庫指派給環境變量LIBRARIES，當然，可以不用這個環境變量，而在後面直接使用該庫名

第18行用于指定生成檔案，将環境變量TEST_MATH目錄下的所有檔案編譯生成../bin目錄下的可執行檔案bin

第20行指定../bin/bin執行時的連結庫為環境變量LIBRARIES的值－libm.so

下面給出源檔案

/src/main.c:

#include<stdio.h>

#include"../include/a.h"

int main()

{

    double b=25.0;

    double a=0.0;

    a=get_sqrt(b);

    return 0;

}

/src/a.c

double get_sqrt(double var1)

    return sqrt(var1);

/include/a.h

 #ifndef  A_FILE_HEADER_INC

#define  A_FILE_HEADER_INC

#include<math.h>

double get_sqrt(double var1);

#endif

将CMakeLists.txt放在目前目錄下，執行CMakeLists.txt

$> cmake .

即可生成可執行檔案，在目錄/bin下的bin檔案，好了運作看其效果是否和所想一樣。

====================

補充：

安裝：下載下傳二進制包後可直接解壓使用

從源碼安裝則執行指令：./bootstrap; make; make install——嘗試執行bootstrap失敗

使用：cmake dir_path，生成工程檔案或makefile檔案

out-of-source build，與in-source build相對，即将編譯輸出檔案與源檔案放到不同目錄中；

1，依賴CMakeLists.txt檔案，項目主目标一個，主目錄中可指定包含的子目錄；

2，在項目CMakeLists.txt中使用project指定項目名稱，add_subdirectory添加子目錄

3，子目錄CMakeLists.txt将從父目錄CMakeLists.txt繼承設定（TBD，待檢驗）

1.       #注釋

2.       變量：使用set指令顯式定義及指派，在非if語句中，使用${}引用，if中直接使用變量名引用；後續的set指令會清理變量原來的值；

3.       command (args ...)  #指令不分大小寫，參數使用空格分隔，使用雙引号引起參數中空格

4.       set(var a;b;c) <=> set(var a b c)  #定義變量var并指派為a;b;c這樣一個string list

5.       Add_executable(${var}) <=> Add_executable(a b c)   #變量使用${xxx}引用

6.       條件語句：

if(var) #var 非empty 0 N No OFF FALSE... #非運算使用NOT

       …

else()/elseif() … endif(var)

7.       循環語句

Set(VAR a b c)

Foreach(f ${VAR})       …Endforeach(f)

8.       循環語句

WHILE() … ENDWHILE()

CMAKE_C_COMPILER：指定C編譯器

CMAKE_CXX_COMPILER：

CMAKE_C_FLAGS：編譯C檔案時的選項，如-g；也可以通過add_definitions添加編譯選項

EXECUTABLE_OUTPUT_PATH：可執行檔案的存放路徑

LIBRARY_OUTPUT_PATH：庫檔案路徑

CMAKE_BUILD_TYPE:：build 類型(Debug, Release, ...)，CMAKE_BUILD_TYPE=Debug

BUILD_SHARED_LIBS：Switch between shared and static libraries

内置變量的使用：

>> 在CMakeLists.txt中指定，使用set

>> cmake指令中使用，如cmake -DBUILD_SHARED_LIBS=OFF

project (HELLO)   #指定項目名稱，生成的VC項目的名稱；

>>使用${HELLO_SOURCE_DIR}表示項目根目錄

include_directories：指定頭檔案的搜尋路徑，相當于指定gcc的-I參數

>> include_directories (${HELLO_SOURCE_DIR}/Hello)  #增加Hello為include目錄

link_directories：動态連結庫或靜态連結庫的搜尋路徑，相當于gcc的-L參數

       >> link_directories (${HELLO_BINARY_DIR}/Hello)     #增加Hello為link目錄

add_subdirectory：包含子目錄

       >> add_subdirectory (Hello)

add_executable：編譯可執行程式，指定編譯，好像也可以添加.o檔案

       >> add_executable (helloDemo demo.cxx demo_b.cxx)   #将cxx編譯成可執行檔案——

add_definitions：添加編譯參數

>> add_definitions(-DDEBUG)将在gcc指令行添加DEBUG宏定義；

>> add_definitions( “-Wall -ansi –pedantic –g”)

target_link_libraries：添加連結庫,相同于指定-l參數

>> target_link_libraries(demo Hello) #将可執行檔案與Hello連接配接成最終檔案demo

add_library:

>> add_library(Hello hello.cxx)  #将hello.cxx編譯成靜态庫如libHello.a

add_custom_target:

message( status|fatal_error, “message”):

set_target_properties( ... ): lots of properties... OUTPUT_NAME, VERSION, ....

link_libraries( lib1 lib2 ...): All targets link with the same set of libs

1，CMAKE生成的makefile能夠處理好.h檔案更改時隻編譯需要的cpp檔案；

>> aux_source_directory(<dir> <variable>)

>> 将dir中所有源檔案（不包括頭檔案）儲存到變量variable中，然後可以add_executable (ss7gw ${variable})這樣使用。

>>  project指令指定

>> target_link_libraries指令添加即可

>> message([SEND_ERROR | STATUS | FATAL_ERROR] "message to display" ...)

>> 注意大小寫

>> include_directories與link_directories

>>可以多次調用以設定多個路徑

>> link_directories僅對其後面的targets起作用

>>建立debug/release兩目錄，分别在其中執行cmake -DCMAKE_BUILD_TYPE=Debug（或Release），需要編譯不同版本時進入不同目錄執行make即可；

Debug版會使用參數-g；Release版使用-O3 –DNDEBUG

>> 另一種設定方法——例如DEBUG版設定編譯參數DDEBUG

IF(DEBUG_mode)

    add_definitions(-DDEBUG)

ENDIF()

在執行cmake時增加參數即可，例如cmake -D DEBUG_mode=ON

例如debug版設定編譯選項DEBUG，并且更改不應改變CMakelist.txt

>> 使用option command，eg：

option(DEBUG_mode "ON for debug or OFF for release" ON)

>> 局限：這種方法不能直接設定生成的makefile，而是必須使用指令在make前設定參數；對于debug、release版本，相當于需要兩個目錄，分别先cmake一次，然後分别make edit_cache一次；

>> 期望的效果：在執行cmake時直接通過參數指定一個開關項，生成相應的makefile——可以這樣做，例如cmake –DDEBUGVERSION=ON

>> 使用add_definitions指令，見指令部分說明

用于確定編譯目标項目前依賴項必須先建構好

>>add_dependencies

>> 建立一個新的目錄，在該目錄中執行cmake生成Makefile檔案，這樣編譯結果會儲存在該目錄——類似

>> SET_TARGET_PROPERTIES(ss7gw PROPERTIES

                      RUNTIME_OUTPUT_DIRECTORY "${BIN_DIR}")

>> 可以不在子目錄中使用CMakeList.txt，直接在上層目錄中指定子目錄

>>cmake_minimum_required(VERSION 2.6)

>> ${projectname_SOURCE_DIR}表示根源檔案目錄，${ projectname _BINARY_DIR}表示根二進制檔案目錄？

>> TBD

>>數字比較LESS、GREATER、EQUAL，字串比STRLESS、STRGREATER、STREQUAL，

>> Eg：

set(CMAKE_ALLOW_LOOSE_LOOP_CONSTRUCTS ON)

set(AAA abc)

IF(AAA STREQUAL abc)

    message(STATUS "true")   #應該列印true

>> 是

>> IF( APPLE ); IF( UNIX ); IF( WIN32 )

>> 可以，TBD

make VERBOSE=1

[1] CMake_Tutorial.pdf

[4] 安裝包中文檔

[6] Cjacker，CMake實踐.PDF

=================================================================

    CMake 簡介

    1.編寫 CmakeLists.txt。

    2.執行指令 “cmake PATH” 或者 “ccmake PATH” 生成 Makefile ( PATH 是 CMakeLists.txt 所在的目錄 )。

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

    第一個工程

    現假設我們的項目中隻有一個源檔案 main.cpp

    清單 1 源檔案 main.cpp

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

    清單 2 CMakeLists.txt

    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 處理源代碼分布在不同目錄中的情況也十分簡單。現假設我們的源代碼分布情況如下:

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

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

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

    清單 3 目錄 step2 中的 CMakeLists.txt

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

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

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

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

    在該檔案中使用指令 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

 01 MESSAGE(STATUS "Using bundled Findlibdb.cmake...")

02 

03 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})

07 

08 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 生成 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

    第 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"的執行結果

    這個結果說明生成的 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"的執行結果

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