一、CMake 基本指令

1. ADD_DEFINITIONS

給編譯增加參數定義，如向 C/C++編譯器添加-D 參數，例:

ADD_DEFINITIONS(-DENABLE_DEBUG -DABC123)，多個參數使用空格分割。

宏定義 #ifdef ENABLE_DEBUG #endif 會讓上面指令生效。

2. ADD_DEPENDENCIES

增加 make 里編譯依賴關系。

ADD_DEPENDENCIES(target-name depend-target1 depend-target2 ...)

兩個target有依賴關系時，使用此指令可以自動按順序編譯依賴，最后再連接目標。

3.ADD_EXECUTABLE

定義可執行文件的指令：

ADD_EXECUTABLE(hello main.cpp)

4.ADD_LIBRARY

調用其它庫，語法：

add_library( [STATIC | SHARED | MODULE]
            [EXCLUDE_FROM_ALL]
            source1 [source2 ...])

• 其中表示鏈接庫文件的名字，全局唯一；庫的源文件可指定，也可用target_sources()后續指定。

• 庫的類型： STATIC(靜態庫)、SHARED(動態庫)、MODULE(模塊庫)之一；如果不設置，也可以通過全局的 BUILD_SHARED_LIBS 來指定。

  windows下，如果dll沒有export任何信息，則不能使用SHARED，要標識為MODULE。

添加的庫會被輸出到以下幾個目錄：

• ARCHIVE_OUTPUT_DIRECTORY
• LIBRARY_OUTPUT_DIRECTORY
• RUNTIME_OUTPUT_DIRECTORY
• 設置EXCLUDE_FROM_ALL，可使這個library排除在all之外，即必須明確點擊生成才會生成。

5. ADD_SUBDIRECTORY

ADD_SUBDIRECTORY(source_dir [binary_dir] [EXCLUDE_FROM_ALL])

這個指令用于向當前工程添加存放源文件的子目錄，并可以指定中間二進制和目標二進制存放的位置。

• EXCLUDE_FROM_ALL 參數的含義是將這個子目錄的所有target排除在all target列表之外，這樣當執行make時，這個子目錄的所有target就不會被編譯。

6. CMAKE_MINIMUM_REQUIRED

CMAKE_MINIMUM_REQUIRED(VERSION versionNumber [FATAL_ERROR])

檢查cmake的版本，要求最低版本為versionNumber。例如 CMAKE_MINIMUM_REQUIRED(VERSION 2.5 FATAL_ERROR) 。

7. INCLUDE_DIRECTORIES

INCLUDE_DIRECTORIES([AFTER|BEFORE] [SYSTEM] dir1 [dir2 ...])

指定頭文件的搜索路徑。

例：

include_directories(/usr/local/include)

來讓庫文件搜索以/usr/local/include為基礎，然后在main函數前寫上：

#include “opencv/cv.h"

8. LINK_DIRECTORIES

LINK_DIRECTORIES(directory1 directory2 ...)

添加需要鏈接的庫文件目錄，相當于g++命令的-L選項的作用。 該指令有時候不一定需要，因為find_package和find_library指令可以得到庫文件的絕對路徑。

一般自己寫的動態庫文件放在自己新建的目錄下時，可以用該指令定位，如：

LINK_DIRECTORIES("/home/my/mylib/bin/mylibs")

9. LINK_LIBRARIES

LINK_LIBRARIES(library1 library2 ...)

添加需要鏈接的庫文件路徑，注意這里是全路徑，要用在add_executable之前。示例：

LINK_LIBRARIES("/home/my/mylib/bin/mylibs/aaa.so")

10. TARGET_LINK_LIBRARIES

TARGET_LINK_LIBRARIES(target library1

為庫或二進制可執行文件添加庫鏈接，要用在add_executable之后。 上述指令中的target是指通過add_executable()和add_library()指令生成已經創建的目標文件。示例：

TARGET_LINK_LIBRARIES(myProject hello)，連接libhello.so庫
TARGET_LINK_LIBRARIES(myProject libhello.a)

11. PKG_CHECK_MODULES

pkg_check_modules(

pkg_check_modules 是 CMake 自己的 pkg-config 模塊 的一個用來簡化的封裝：你不用再檢查 CMake 的版本，加載合適的模塊，檢查是否被加載，等等，參數和傳給 find_package 的一樣：先是待返回變量的前綴，然后是包名（pkg-config 的）。這樣就定義了_INCLUDE_DIRS和其他的這類變量，后續的用法就與 find_package 一致。

二、 CMake的宏、模塊、函數

1. 宏 macro定義：

macro( [arg1 [arg2 [arg3 ...]]])
...
endmacro([name])

2. function定義：

function( [arg1 [arg2 [arg3 ...]]])
...
endfunction([name])

函數和宏都有默認內部變量可以使用：

調用示例：

# 定義函數
Function(myfunction ag1 ag2)
message(STATUS "function ag is " ${ag1})
message(STATUS "function ag is " ${ag2})
endfunction(myfunction)


# 定義宏
macro(mymacro ag1 ag2)
message(STATUS "macro ag is " ${ag1})
message(STATUS "macro ag is " ${ag2})
endmacro(mymacro)

# 調用函數
myfunction(1 2 3)
message(STATUS "\\n")

# 調用宏
mymacro(1 2 3)

要注意的是 宏的ARGN、ARGV等內部變量不能直接在if、foreach(…IN LISTS…)等邏輯語句中使用。

二、模塊

1. 模塊說明

CMakeLists.txt和**.cmake結尾的文件可以用來作為CMake的模塊文件，用來封裝一些函數功能，再使用include(**.cmake)方式引用。

cmake系統本身內置了一些預定義的模塊，如FindCURL模塊。

預定義模塊可以通過FIND_PACKAGE指令來引用。

2. 模塊定義示例

根目錄的主Cmake文件定義

# CMake 最低版本號要求
cmake_minimum_required (VERSION 2.8)

# 項目工程名
project (example)
message(STATUS "root This is BINARY dir " ${PROJECT_BINARY_DIR})
message(STATUS "root This is SOURCE dir " ${PROJECT_SOURCE_DIR})

# 添加子目錄
ADD_SUBDIRECTORY(subDirectory)

子模塊定義

創建

subDirectory/CMakeLists.txt，內容如下：

# 打印信息
message(STATUS "src This is BINARY dir " ${PROJECT_BINARY_DIR})
message(STATUS "src This is SOURCE dir " ${PROJECT_SOURCE_DIR})

set(EXECUTABLE_OUTPUT_PATH ${PROJECT_BINARY_DIR}/bin)

# CMAKE_SOURCE_DIR 是cmake內置變量，工程根目錄的CMakeLists.txt文件路徑
SET(ROOT_DIR ${CMAKE_SOURCE_DIR})

# 構建可執行程序
ADD_EXECUTABLE(example main.cpp)

# 查找指定的庫,CURL是
FIND_PACKAGE(CURL)