CMake學(xué)習(xí)記錄

CMkae主要的開關(guān)選項

1，CMAKE_ALLOW_LOOSE_LOOP_CONSTRUCTS

用來控制 IF ELSE 語句的書寫方式。

2甸私，BUILD_SHARED_LIBS

這個開關(guān)用來控制默認的庫編譯方式，如果不進行設(shè)置飞傀，使用 ADD_LIBRARY 并沒有指定庫類型的情況下皇型，默認編譯生成的庫都是靜態(tài)庫。

如果 SET(BUILD_SHARED_LIBS ON)后砸烦，默認生成的為動態(tài)庫弃鸦。

３，CMAKE_C_FLAGS

設(shè)置 C 編譯選項幢痘，也可以通過指令ADD_DEFINITIONS()添加唬格。

4，CMAKE_CXX_FLAGS

設(shè)置 C++編譯選項，也可以通過指令 ADD_DEFINITIONS()添加购岗。

PROJECT_SOURCE_DIR 和 CMAKE_SOURCE_DIR 的區(qū)別

Example：
There is a difference between these variables. CMAKE_SOURCE_DIR does indeed refer to the folder where the top-level CMakeLists.txt is defined.

However, PROJECT_SOURCE_DIR refers to the folder of the CMakeLists.txt containing the most recent project() command.

For example, say you have a top-level project called Outer and this contains a subdirectory with its own project called Inner.

Outer's CMakeLists.txt has:

project(Outer)
add_subdirectory(Inner)

and Inner's:

project(Inner)

Then in both of these CMakeLists files, CMAKE_SOURCE_DIR will refer to Outer's source dir. But while PROJECT_SOURCE_DIR for Outer is also this same dir, this is not the case for Inner. Inner's PROJECT_SOURCE_DIR is the subdirectory containing its CMakeLists.txt.

This difference applies to all PROJECT_<var> vs CMAKE_<var> variables.

總結(jié)：CMAKE_SOURCE_DIR指代頂層CMakeList.txt所在的目錄汰聋，而PROJECT_SOURCE_DIR則指代出現(xiàn)project()的最近的CMakeList.txt所在的目錄

CMake 自定義變量的方式

主要有隱式定義和顯式定義兩種，舉一個隱式定義的例子喊积，就是 PROJECT 指令烹困，他會隱式的定義<projectname>_BINARY_DIR 和<projectname>_SOURCE_DIR 兩個變量。

而顯式定義的例子注服，可以使用 SET 指令韭邓，就可以構(gòu)建一個自定義變量了。

CMake中常見環(huán)境變量的含義：

1溶弟，PROJECT_BINARY_DIR

如果是 in source 編譯女淑，這個變量指得就是工程頂層目錄，如果是 out-of-source 編譯辜御，指的是工程編譯發(fā)生的目錄鸭你。另外 <projectname>_BINARY_DIR 和 CMAKE_BINARY_DIR 跟這個變量指代的內(nèi)容是一致的。

2擒权，PROJECT_SOURCE _DIR

不論采用何種編譯方式袱巨，都是工程頂層目錄。也就是在 in source 編譯時碳抄，他跟 PROJECT_BINARY_DIR 等變量一致愉老。另外 <projectname>_SOURCE_DIR 和 CMAKE_SOURCE_DIR 跟這個變量指代的內(nèi)容是一致的。

３剖效，CMAKE_CURRENT_SOURCE_DIR

指的是當(dāng)前處理的 CMakeLists.txt 所在的路徑嫉入。

４，CMAKE_CURRRENT_BINARY_DIR

如果是 in-source 編譯璧尸，它跟 CMAKE_CURRENT_SOURCE_DIR 一致咒林，如果是 out-ofsource 編譯，他指的是 target 編譯目錄爷光。使用 ADD_SUBDIRECTORY(src bin) 可以更改這個變量的值垫竞。

５，CMAKE_CURRENT_LIST_FILE

輸出調(diào)用這個變量的 CMakeLists.txt 的完整路徑蛀序。

６欢瞪，CMAKE_CURRENT_LIST_LINE

輸出這個變量所在的行。

7徐裸，CMAKE_MODULE_PATH

這個變量用來定義自己的 .cmake 模塊所在的路徑引有。如果你的工程比較復(fù)雜，有可能會自己編寫一些 cmake 模塊倦逐，這些 cmake 模塊是隨你的工程發(fā)布的譬正，為了讓 cmake 在處理CMakeLists.txt 時找到這些模塊宫补，你需要通過 SET 指令，將自己的 .cmake 模塊路徑設(shè)置一下曾我。比如

SET(CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake)

這時候你就可以通過 INCLUDE指令來調(diào)用自己的模塊了粉怕。

８，EXECUTABLE_OUTPUT_PATH 和 LIBRARY_OUTPUT_PATH

前者用來重新定義目標二進制可執(zhí)行文件的存放位置抒巢，后者用來重新定義目標鏈接庫文件的存放位置贫贝。

9，PROJECT_NAME

返回通過 PROJECT 指令定義的項目名稱蛉谜。

CMake 指令記錄

set 指令
語法：SET(VAR [VALUE] [CACHE TYPE DOCSTRING [FORCE]])
指令功能：用來顯式的定義變量
例子：SET (SRC_LST main.c other.c)
說明：用變量代替值稚晚，例子中定義一個 SRC_LST 用來代替后面的字符串。

aux_source_directory 指令
語法：aux_source_directory(<dir> <variable>)
指令功能：在目錄中查找所有源文件型诚，收集指定目錄中所有源文件的名稱客燕，并將列表存儲在提供的<variable>中
Example: aux_source_directory(common DE_UT_COMMON_SRCS)

add_executable 指令
語法：add_executable(<name> [WIN32] [MACOSX_BUNDLE][EXCLUDE_FROM_ALL] source1 [source2 ...])
指令功能：使用指定的源文件將可執(zhí)行文件添加到項目中
Example: add_executable(de_ut_tests ${DE_UT_SRCS} ${DE_UT_TESTS})

add_library 指令
語法：add_library(<name> [STATIC | SHARED | MODULE] [EXCLUDE_FROM_ALL] [source1] [source2] [...])
指令功能：將指定的源文件生成鏈接文件，然后添加到項目中去

target_link_libraries 指令
語法：target_link_libraries(<target> [item1] [item2] [...] [[debug|optimized|general] <item>] ...)
指令功能：將目標文件與庫文件進行鏈接狰贯，<target>目標文件一般是通過add_executable() 和 add_library()指令生成的

$ENV{VAR}指令

語法：$ENV{VAR} 讀取環(huán)境變量 VAR

include 指令

include指令一般用于語句的復(fù)用也搓，也就是說，如果有一些語句需要在很多CMakeLists.txt文件中使用涵紊，為避免重復(fù)編寫傍妒，可以將其寫在.cmake文件中，然后在需要的CMakeLists.txt文件中進行include操作就行了摸柄。

include指令的結(jié)構(gòu)為：

include(<file|module> [OPTIONAL] [RESULT_VARIABLE <var>][NO_POLICY_SCOPE])

雖然颤练，有不少的可選參數(shù)，但是一般情況下驱负，都是直接寫：

include(file|module)

注意昔案，為了使CMakeLists.txt能夠找到該文件，需要指定文件完整路徑(絕對路徑或相對路徑)电媳，當(dāng)然如果指定了CMAKE_MODULE_PATH，就可以直接include該目錄下的.cmake文件了庆亡。

.cmake 文件里包含了一些 cmake 命令和一些宏/函數(shù)匾乓，當(dāng)CMakeLists.txt包含該 .cmake 文件時，當(dāng)編譯運行時又谋，該 .cmake 里的一些命令就會在該包含處得到執(zhí)行拼缝，并且在包含以后的地方能夠調(diào)用該 .cmake 里的一些宏和函數(shù)。

宏和函數(shù)的定義

關(guān)鍵字：cmake 的宏是MACRO彰亥，函數(shù)是function咧七。它們的用法是：

macro(<name> [arg1 [arg2 [arg3 ...]]])
  COMMAND1(ARGS ...)            # 命令語句
  COMMAND2(ARGS ...)
  ...
endmacro()

function(<name> [arg1 [arg2 [arg3 ...]]])
  COMMAND1(ARGS ...)            # 命令語句
  COMMAND2(ARGS ...)
  ...
function()

宏和函數(shù)的區(qū)別：

其實和C/C++里面宏和函數(shù)之間的區(qū)別差不多，宏就是字符串替換任斋，函數(shù)就是使用變量继阻，在命令中途可以對改變量進行修改。

Example：

首先創(chuàng)建一個 CMakeLists.txt：

cmake_minimum_required(VERSION 3.0)
include(test.cmake)

在同目錄下創(chuàng)建文件 test.cmake：

set(var "ABC")

macro(Moo arg)
  message("arg = ${arg}")
  set(arg "abc")
  message("# After change the value of arg.")
  message("arg = ${arg}")
endmacro()
message("=== Call macro ===")
Moo(${var})

function(Foo arg)
  message("arg = ${arg}")
  set(arg "abc")
  message("# After change the value of arg.")
  message("arg = ${arg}")
endfunction()
message("=== Call function ===")
Foo(${var})

運行 cmake：

mkdir build && cd build
cmake ..

運行后的輸出結(jié)果是：

-- The C compiler identification is GNU 5.4.0
-- The CXX compiler identification is GNU 5.4.0
-- Check for working C compiler: /usr/bin/cc
-- Check for working C compiler: /usr/bin/cc -- works
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Detecting C compile features
-- Detecting C compile features - done
-- Check for working CXX compiler: /usr/bin/c++
-- Check for working CXX compiler: /usr/bin/c++ -- works
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- Detecting CXX compile features
-- Detecting CXX compile features - done
=== Call macro ===
arg = ABC
# After change the value of arg.
arg = ABC
=== Call function ===
arg = ABC
# After change the value of arg.
arg = abc
-- Configuring done
-- Generating done
-- Build files have been written to: /home/yngzmiao/test/build

從這里可以看出，宏實現(xiàn)的僅僅是字符串替換瘟檩，宏定義的過程中是無法進行修改的抹缕，而函數(shù)卻是可以的。