CMake学习记录

CMkae主要的开关选项

1，CMAKE_ALLOW_LOOSE_LOOP_CONSTRUCTS

用来控制 IF ELSE 语句的书写方式。

2，BUILD_SHARED_LIBS

这个开关用来控制默认的库编译方式，如果不进行设置，使用 ADD_LIBRARY 并没有指定库类型的情况下，默认编译生成的库都是静态库。

如果 SET(BUILD_SHARED_LIBS ON)后，默认生成的为动态库。

３，CMAKE_C_FLAGS

设置 C 编译选项，也可以通过指令ADD_DEFINITIONS()添加。

4，CMAKE_CXX_FLAGS

设置 C++编译选项，也可以通过指令 ADD_DEFINITIONS()添加。

PROJECT_SOURCE_DIR 和 CMAKE_SOURCE_DIR 的区别

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.

总结：CMAKE_SOURCE_DIR指代顶层CMakeList.txt所在的目录，而PROJECT_SOURCE_DIR则指代出现project()的最近的CMakeList.txt所在的目录

CMake 自定义变量的方式

主要有隐式定义和显式定义两种，举一个隐式定义的例子，就是 PROJECT 指令，他会隐式的定义<projectname>_BINARY_DIR 和<projectname>_SOURCE_DIR 两个变量。

而显式定义的例子，可以使用 SET 指令，就可以构建一个自定义变量了。

CMake中常见环境变量的含义：

1，PROJECT_BINARY_DIR

如果是 in source 编译，这个变量指得就是工程顶层目录，如果是 out-of-source 编译，指的是工程编译发生的目录。另外 <projectname>_BINARY_DIR 和 CMAKE_BINARY_DIR 跟这个变量指代的内容是一致的。

2，PROJECT_SOURCE _DIR

不论采用何种编译方式，都是工程顶层目录。也就是在 in source 编译时，他跟 PROJECT_BINARY_DIR 等变量一致。另外 <projectname>_SOURCE_DIR 和 CMAKE_SOURCE_DIR 跟这个变量指代的内容是一致的。

３，CMAKE_CURRENT_SOURCE_DIR

指的是当前处理的 CMakeLists.txt 所在的路径。

４，CMAKE_CURRRENT_BINARY_DIR

如果是 in-source 编译，它跟 CMAKE_CURRENT_SOURCE_DIR 一致，如果是 out-ofsource 编译，他指的是 target 编译目录。使用 ADD_SUBDIRECTORY(src bin) 可以更改这个变量的值。

５，CMAKE_CURRENT_LIST_FILE

输出调用这个变量的 CMakeLists.txt 的完整路径。

６，CMAKE_CURRENT_LIST_LINE

输出这个变量所在的行。

7，CMAKE_MODULE_PATH

这个变量用来定义自己的 .cmake 模块所在的路径。如果你的工程比较复杂，有可能会自己编写一些 cmake 模块，这些 cmake 模块是随你的工程发布的，为了让 cmake 在处理CMakeLists.txt 时找到这些模块，你需要通过 SET 指令，将自己的 .cmake 模块路径设置一下。比如

SET(CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake)

这时候你就可以通过 INCLUDE指令来调用自己的模块了。

８，EXECUTABLE_OUTPUT_PATH 和 LIBRARY_OUTPUT_PATH

前者用来重新定义目标二进制可执行文件的存放位置，后者用来重新定义目标链接库文件的存放位置。

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 ...])
指令功能：使用指定的源文件将可执行文件添加到项目中
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} 读取环境变量 VAR

include 指令

include指令一般用于语句的复用，也就是说，如果有一些语句需要在很多CMakeLists.txt文件中使用，为避免重复编写，可以将其写在.cmake文件中，然后在需要的CMakeLists.txt文件中进行include操作就行了。

include指令的结构为：

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

虽然，有不少的可选参数，但是一般情况下，都是直接写：

include(file|module)

注意，为了使CMakeLists.txt能够找到该文件，需要指定文件完整路径(绝对路径或相对路径)，当然如果指定了CMAKE_MODULE_PATH，就可以直接include该目录下的.cmake文件了。

.cmake 文件里包含了一些 cmake 命令和一些宏/函数，当CMakeLists.txt包含该 .cmake 文件时，当编译运行时，该 .cmake 里的一些命令就会在该包含处得到执行，并且在包含以后的地方能够调用该 .cmake 里的一些宏和函数。

宏和函数的定义

关键字：cmake 的宏是MACRO，函数是function。它们的用法是：

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

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

宏和函数的区别：

其实和C/C++里面宏和函数之间的区别差不多，宏就是字符串替换，函数就是使用变量，在命令中途可以对改变量进行修改。

Example：

首先创建一个 CMakeLists.txt：

cmake_minimum_required(VERSION 3.0)
include(test.cmake)

在同目录下创建文件 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 ..

运行后的输出结果是：

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

从这里可以看出，宏实现的仅仅是字符串替换，宏定义的过程中是无法进行修改的，而函数却是可以的。