1.4 詞法和語法

在開始本節的學習之前，我們先總結一下之前所瞭解到的CMake基本詞法和命令。

CMake命令通常使用如下的格式：

1. COMMAND( ARG1 ARG2 … )

複製程式碼 命令關鍵字之後使用括號來包含所有的引數；各個引數之間使用空格或者換行符分隔；而引數通常有以下幾種形式：

變數，以${MY_VAIRABLE}的形式表達，其儲存型別為字串型別，但是可以根據具體命令的要求自動轉換為布林型、整型或者浮點型別。變數可以出現在字串中，也可以實現“內省”。變數有使用者自定義和系統內建兩種，使用者自定義變數使用SET命令設定；而系統變數由系統自動賦值，例如${PROJECT_SOURCE_DIR}。

列舉量，例如ADD_LIBRARY可以設定要生成的連結庫為SHARED或者STATIC，還可以設定為MODULE（外掛，可動態呼叫，但不作為其他工程的依賴），除此之外的賦值都是不能被識別的。

值，也就是任意的字串內容，它可以用來指示要編譯的原始碼檔名，也可以表達一段文字提示資訊，或者表達特定的功能。值可以使用引號進行標識，多數情況下也可以不用。

前文中我們已經瞭解到的命令列舉如下，此外這裡還簡要地介紹了另一些可能在各類CMake工程中遇到的命令及其語法格式。CMake部分命令的語法歌是十分複雜，這裡僅僅介紹它的某一種實現形式，建議讀者閱讀CMake的幫助文件以獲取更多資訊。

括號中為該命令的一個或多個引數項，其中使用“[…]”包含的項表示可忽略項，使用“…|…”分隔的項表示只能選擇其中一項。

ADD_CUSTOM_COMMAND(
    TARGET name 
    PRE_BUILD|PRE_LINK|POST_BUILD 
    COMMAND cmd1 [COMMAND cmd2 …] )：
為目標工程name新增一個或多個新的自定義的編譯規則cmd1，cmd2等，執行時機可以選擇編譯前，連結前或者編譯後。它的作用相當於Visual Studio工程的“Custom Build Step”屬性。

ADD_CUSTOM_TARGET（ name COMMAND cmd1 [COMMAND cmd2 …] ）：
新增一個名為name的編譯目標，並指定一個或多個自定義的命令cmd1，cmd2等。注意ADD_CUSTOM_COMMAND與這個命令的區別：前者是針對一個已有的子工程進行自定義編譯規則的設定；後者則是建立一個新的自定義的目標工程，例如一個專用於將已生成檔案拷貝到指定資料夾的INSTALL工程；以及與之作用截然相反的UNINSTALL工程。

ADD_DEFINITIONS( -DMACRO1 –DMACRO2 … )：
新增-D預編譯巨集定義，可以一次新增多個。

ADD_EXECUTABLE( name [WIN32]
                    source1 source2 … )：
指定一個名為name的可執行程式工程，其原始檔為source1，source2等，此外還可以追加一個列舉量WIN32，表示此程式為Win32程式，使用WinMain作為程式入口。

ADD_LIBRARY( name [STATIC|SHARED|MODULE]
                source1 source2 … )：
指定一個名為name的連結庫工程，其原始檔為source1，source2等，此外還可以指示該工程的生成結果為靜態庫（STATIC），動態庫（SHARED）還是模組（MODULE）。

ADD_SUBDIRECTORY( dir )：
指示下一級CMake指令碼所在位置位於dir子目錄。

CMAKE_MINIMUM_REQUIRED( VERSION major[.minor[.patch]] )：
指示當前指令碼所需的CMake版本，不能低於版本號major.minor.patch。

CONFIGURE_FILE( infile outfile )：
將檔案infile複製到outfile的位置，同時執行其中變數的自動配置和更替，即，將infile中所有形同“${VAR}”和“@

[email protected]”的變數替換為對應的內容，並拷貝到outfile中，而這個新生成的outfile檔案也可以在之後的指令碼程式碼中得以使用。

FIND_LIBRARY( ${var}
                NAMES name1 [name2 …]
                PATHS path1 [path2 …]
                PATH_SUFFIXES suffix1 [suffix2 …] )：
搜尋一個外部的連結庫檔案，並將結果的全路徑儲存到var變數中。要搜尋的連結庫檔名字可能是name1，name2等；搜尋路徑為path1，path2等；此外還可以指定路徑的字尾詞為suffix1，suffix2等。因此，系統將嘗試在path1/suffix1，path1/suffix2，path2/suffix1，path2/suffix2這些目錄中搜索名為name1或name2的連結庫檔案，並將結果（路徑和檔名）儲存到var中。

FIND_PACKAGE( name )：
在指定的模組目錄中搜索一個名為Find<name>.cmake（例如，FindOSG.cmake）的CMake指令碼模組檔案，執行其中的內容，以圖搜尋到指定的外部依賴庫標頭檔案和庫檔案位置。

FIND_PATH( ${var}
            NAMES name1 [name2 …]
            PATHS path1 [path2 …]
            PATH_SUFFIXES suffix1 [suffix2 …] )：
搜尋一個包含name1，name2等檔案的目錄，並將此路徑（不包含檔名）儲存到var變數中，搜尋路徑為path1，path2等；此外還可以指定路徑的字尾詞為suffix1，suffix2等。通常可以使用此命令來確認外部標頭檔案的依賴路徑。

FIND_PROGRAM( ${var}
                 NAMES name1 [name2 …]
                 PATHS path1 [path2 …]
                 PATH_SUFFIXES suffix1 [suffix2 …] )：
搜尋一個外部的可執行程式，並將結果的全路徑儲存到var變數中。要搜尋的程式名字可能是name1，name2等；搜尋路徑為path1，path2等；此外還可以指定路徑的字尾詞為suffix1，suffix2等。

INCLUDE( file )：
在當前檔案中包含另一個CMake指令碼檔案的內容。

INCLUDE_DIRECTORIES( dir1 dir2 … )：
指定編譯器搜尋標頭檔案的依賴路徑，可以新增多個。

INSTALL( TARGETS proj1 proj2
         RUNTIME DESTINATION runtime_dir
         LIBRARY DESTINATION library_dir
         ARCHIVE DESTINATION archive_dir)：
這只是此命令的一種語法格式，安裝目標工程proj1，proj2等到指定的資料夾。其中，可執行檔案安裝到RUNTIME DESTINATION指定的runtime_dir目錄；動態連結庫安裝到LIBRARY DESTINATION指定的library_dir目錄；靜態連結庫安裝到ARCHIVE DESTINATION指定的archive_dir目錄。如果需要安裝標頭檔案或者資料檔案，則通常使用INSTALL( FILES … DESTINATION … )的形式。

LINK_DIRECTORIES( dir1 dir2 … )：
設定外部依賴庫的搜尋路徑。

MESSAGE( [SEND_ERROR|STATUS|FATAL_ERROR] “text” … )：
在控制檯或者對話方塊輸出一行或多行除錯資訊文字text，列舉量用於控制資訊的型別（錯誤，狀態顯示，致命錯誤）。

OPTION( ${var} “text” value )：
向用戶提供一個可選項，提示資訊為text，初始值為value，並將最終的結果傳遞到var變數中。在CMake-GUI中它將以配置選項的方式出現。

PROJECT( name )：
設定整個工程的名稱為name。

SET( variable value
     [CACHE FILEPATH|PATH|STRING|BOOL “text”] )：
定義一個使用者自定義變數variable，取值為value。此外還可以使用CACHE關鍵字，允許使用者在CMake-GUI中修改變數的值，修改方式包括檔案對話方塊（FILEPATH），目錄對話方塊（PATH），編輯框（STRING）或者複選框（BOOL），並使用text作為提示資訊。

SET_TARGET_PROPERTIES( name PROPERTIES prop value )：
設定名為name的工程的屬性，這裡主要可選的prop屬性包括PROJECT_LABEL， DEBUG_POSTFIX，OUTPUT_NAME等等，value為設定值。

TARGET_LINK_LIBRARIES( name
                           lib1 lib2 …
                           [debug|optimized] lib1 lib2 … )：
指定工程name所用的依賴庫，並可以使用debug和optimized關鍵字分別指定DEBUG與RELEASE版本所用的一個或多個依賴庫。