CMake是一個跨平臺的安裝(編譯)工具,能夠用簡單的語句來描述全部平臺的安裝(編譯過程)。他可以輸出各類各樣的makefile或者project文件,能測試編譯器所支持的C++特性,相似UNIX下的automake。php
CMake的全部的語句都寫在一個叫:CMakeLists.txt的文件中。當CMakeLists.txt文件肯定後,能夠用ccmake命令對相關 的變量值進行配置。這個命令必須指向CMakeLists.txt所在的目錄。配置完成以後,應用cmake命令生成相應的makefile(在Unix like系統下)或者 project文件(指定用window下的相應編程工具編譯時)。html
其基本操做流程爲:mysql
其中directory爲CMakeList.txt所在目錄;linux
CMake的執行就是這麼簡單,其難點在於如何編寫CMakeLists.txt文件,下面結合例子簡單介紹CMakeLists.txt的編寫,看下面這個CMakeLists.txtios
或者用下面這個CMakeLists.txtc++
這是一個測試數學函數的程序的CMakeLists.txt,"#"後面爲註釋的內容,CMake的命令所有爲大寫程序員
第2行指定生成的工程名爲test_mathsql
第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:
/src/a.c
/include/a.h
#ifndef A_FILE_HEADER_INC
將CMakeLists.txt放在當前目錄下,執行CMakeLists.txt
便可生成可執行文件,在目錄/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)
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
>> 使用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
ENDIF()
>> 是
>> TBD
>> IF( APPLE ); IF( UNIX ); IF( WIN32 )
>> 能夠,TBD
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
=================================================================在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
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 的描述以下:
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 進行編譯,以下圖所示。
圖 1. camke 的運行結果
處理多源文件目錄的方法
CMake 處理源代碼分佈在不一樣目錄中的狀況也十分簡單。現假設咱們的源代碼分佈狀況以下:
其中 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 的執行結果
在工程中查找並使用其餘程序庫的方法
在開發軟件的時候咱們會用到一些函數庫,這些函數庫在不一樣的系統中安裝的位置可能不一樣,編譯的時候須要首先找到這些軟件包的頭文件以及連接庫所在的目錄以便生成編譯選項。例如一個須要使用博克利數據庫項目,須要頭文件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...") 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
1 PROJECT(main) 2 CMAKE_MINIMUM_REQUIRED(VERSION 2.6) 3 SET(CMAKE_SOURCE_DIR .) 4 5 SET(CMAKE_CXX_FLAGS_DEBUG "$ENV{CXXFLAGS} -O0 -Wall -g -ggdb") 6 SET(CMAKE_CXX_FLAGS_RELEASE "$ENV{CXXFLAGS} -O3 -Wall") 7 8 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") |