CMake

轉自：HaHack以及netnote

Makefile:概述

概述

什麼是makefile？或許不少Winodws的程序員都不知道這個東西，由於那些Windows的集成開發環境(integrated development environment, IDE)都爲你作了這個工做，但我以爲要做一個好的和professional的程序員，makefile仍是要懂。這就好像如今有這麼多的HTML的編輯器，但若是你想成爲一個專業人士，你仍是要了解HTML的標識的含義。特別在Unix下的軟件編譯，你就不能不本身寫makefile了，會不會寫makefile，從一個側面說明了一我的是否具有完成大型工程的能力。

由於，makefile關係到了整個工程的編譯規則。一個工程中的源文件不可勝數，而且按類型、功能、模塊分別放在若干個目錄中，makefile定義了一系列的規則來指定，哪些文件須要先編譯，哪些文件須要後編譯，哪些文件須要從新編譯，甚至於進行更復雜的功能操做，由於makefile就像一個 Shell腳本同樣，其中也能夠執行操做系統的命令。

makefile帶來的好處就是——「自動化編譯」，一旦寫好，只須要一個make命令，整個工程徹底自動編譯，極大的提升了軟件開發的效率。 make是一個命令工具，是一個解釋makefile中指令的命令工具，通常來講，大多數的IDE都有這個命令，好比：Delphi的make， Visual C++的nmake，Linux下GNU的make。可見，makefile都成爲了一種在工程方面的編譯方法。

如今講述如何寫makefile的文章比較少，這是我想寫這篇文章的緣由。固然，不一樣廠商的make各不相同，也有不一樣的語法，但其本質都是在 「文件依賴性」上作文章，這裏，我僅對GNU的make進行講述，個人環境是RedHat Linux 8.0，make的版本是3.80。畢竟，這個 make是應用最爲普遍的，也是用得最多的。並且其仍是最遵循於IEEE 1003.2-1992 標準的（POSIX.2）。

在這篇文檔中，將以C/C++的源碼做爲咱們基礎，因此必然涉及一些關於C/C++的編譯的知識，相關於這方面的內容，還請各位查看相關的編譯器的文檔。這裏所默認的編譯器是UNIX下的GCC和CC。

關於程序的編譯和連接

在此，我想多說關於程序編譯的一些規範和方法，通常來講，不管是C、C++、仍是pas，首先要把源文件編譯成中間代碼文件，在Windows下也就是 .obj 文件，UNIX下是 .o 文件，即 Object File，這個動做叫作編譯（compile）。而後再把大量的 Object File合成執行文件，這個動做叫做連接（link）。

編譯時，編譯器須要的是語法的正確，函數與變量的聲明的正確。對於後者，一般是你須要告訴編譯器頭文件的所在位置（頭文件中應該只是聲明，而定義應該放在C/C++文件中），只要全部的語法正確，編譯器就能夠編譯出中間目標文件。通常來講，每一個源文件都應該對應於一箇中間目標文件（O文件或是 OBJ文件）。

連接時，主要是連接函數和全局變量，因此，咱們可使用這些中間目標文件（O文件或是OBJ文件）來連接咱們的應用程序。連接器並無論函數所在的源文件，只管函數的中間目標文件（Object File），在大多數時候，因爲源文件太多，編譯生成的中間目標文件太多，而在連接時須要明顯地指出中間目標文件名，這對於編譯很不方便，因此，咱們要給中間目標文件打個包，在Windows下這種包叫「庫文件」（Library File)，也就是 .lib 文件，在UNIX下，是Archive File，也就是 .a 文件。

總結一下，源文件首先會生成中間目標文件，再由中間目標文件生成執行文件。在編譯時，編譯器只檢測程序語法，和函數、變量是否被聲明。若是函數未被聲明，編譯器會給出一個警告，但能夠生成Object File。而在連接程序時，連接器會在全部的Object File中找尋函數的實現，若是找不到，那到就會報連接錯誤碼（Linker Error），在VC下，這種錯誤通常是：Link 2001錯誤，意思說是說，連接器未能找到函數的實現。你須要指定函數的Object File.

 

什麼是 CMake

All problems in computer science can be solved by another level of indirection.

David Wheeler

你或許聽過好幾種 Make 工具，例如 GNU Make ，QT 的 qmake ，微軟的 MS nmake，BSD Make（pmake），Makepp，等等。這些 Make 工具遵循着不一樣的規範和標準，所執行的 Makefile 格式也千差萬別。這樣就帶來了一個嚴峻的問題：若是軟件想跨平臺，必需要保證可以在不一樣平臺編譯。而若是使用上面的 Make 工具，就得爲每一種標準寫一次 Makefile ，這將是一件讓人抓狂的工做。

CMake就是針對上面問題所設計的工具：它首先容許開發者編寫一種平臺無關的 CMakeList.txt 文件來定製整個編譯流程，而後再根據目標用戶的平臺進一步生成所需的本地化 Makefile 和工程文件，如 Unix 的 Makefile 或 Windows 的 Visual Studio 工程。從而作到「Write once, run everywhere」。顯然，CMake 是一個比上述幾種 make 更高級的編譯配置工具。一些使用 CMake 做爲項目架構系統的知名開源項目有 VTK、ITK、KDE、OpenCV、OSG 等 ^[1]。

圖 1 CMake

在 linux 平臺下使用 CMake 生成 Makefile 並編譯的流程以下：

1. 編寫 CMake 配置文件 CMakeLists.txt 。
2. 執行命令 cmake PATH 或者 ccmake PATH 生成 Makefile ¹  。其中， PATH 是 CMakeLists.txt 所在的目錄。                                          1 ccmake 和 cmake 的區別在於前者提供了一個交互式的界面。                        
3. 使用 make 命令進行編譯。

 

CMake的使用

1、基本使用

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

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

使用：cmake dir_path，生成工程文件或makefile文件

2、概念

out-of-source build，與in-source build相對，即將編譯輸出文件與源文件放到不一樣目錄中；

3、基本結構

1，依賴CMakeLists.txt文件，項目主目標一個，主目錄中可指定包含的子目錄；

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

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

4、語法

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()

5、內部變量

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

6、命令

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

7、說明

1，CMAKE生成的makefile可以處理好.h文件更改時只編譯須要的cpp文件；

8、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