CMAKE的使用詳解

一、      基本使用

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

從原始碼安裝則執行命令：./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檔案；

八、      FAQ

1）  怎樣獲得一個目錄下的所有原始檔

>> aux_source_directory(<dir> <variable>)

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

2）  怎樣指定專案編譯目標

>>  project命令指定

3）  怎樣新增動態庫和靜態庫

>> target_link_libraries命令新增即可

4）  怎樣在執行CMAKE時列印訊息

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

>> 注意大小寫

5）  怎樣指定標頭檔案與庫檔案路徑

>> include_directories與link_directories

>>可以多次呼叫以設定多個路徑

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

6）  怎樣區分debug、release版本

>>建立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

7）  怎樣設定條件編譯

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

>> 使用option command，eg：

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

IF(DEBUG_mode)

    add_definitions(-DDEBUG)

ENDIF()

>> 使其生效的方法：首先cmake生成makefile，然後make edit_cache編輯編譯選項；Linux下會開啟一個文字框，可以更改，該完後再make生成目標檔案——emacs不支援make edit_cache；

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

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

8）  怎樣新增編譯巨集定義

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

9）  怎樣新增編譯依賴項

用於確保編譯目標專案前依賴項必須先構建好

>>add_dependencies

10）        怎樣指定目標檔案目錄

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

>> SET_TARGET_PROPERTIES(ss7gw PROPERTIES

                      RUNTIME_OUTPUT_DIRECTORY "${BIN_DIR}")

11）        很多資料夾，難道需要把每個資料夾編譯成一個庫檔案？

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

12）        怎樣設定依賴的cmake版本

>>cmake_minimum_required(VERSION 2.6)

13）        相對路徑怎麼指定

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

14）        怎樣設定編譯中間檔案的目錄

>> TBD

15）        怎樣在IF語句中使用字串或數字比較

>>數字比較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

ENDIF()

16）        更改h檔案時是否只編譯必須的cpp檔案

>> 是

17）        機器上安裝了VC7和VC8，CMAKE會自動搜尋編譯器，但是怎樣指定某個版本？

>> TBD

18）        怎樣根據OS指定編譯選項

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

19）        能否自動執行某些編譯前、後命令？

>> 可以，TBD

20）        怎樣列印make的輸出

make VERBOSE=1

參考文獻：

[1] CMake_Tutorial.pdf

[2] CMake使用總結，http://blog.csdn.net/keensword007/archive/2008/07/16/2663235.aspx

[3] http://www.cmake.org/

[4] 安裝包中文件

[5] Andrej Cedilnik，HOWTO: Cross-Platform Software Development Using CMake，October, 2003

[6] Cjacker，CMake實踐.PDF