CMAKE的使用
Version 1.0
2009-3-18
一、 基本使用
安裝：下載二進制包後可直接解壓使用
從源碼安裝則執行命令：./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
[4] 安裝包中文檔
[5] Andrej Cedilnik，HOWTO: Cross-Platform Software Development Using CMake，October, 2003
[6] Cjacker，CMake實踐.PDF