2019-08-13 12:58:56

cmake学习笔记(一)

参考链接： CMake文档;CMake使用教程;Modern CMake

CMake链接

CMake文档

思维导图

点击查看思维导图

1 安装

1.1 Windows安装

网址：https://cmake.org/download/

1.2 macOS安装

网址：https://cmake.org/download/，下载CMake，并正常安装
安装完成之后，使用以下指令创建/usr/local/bin下的CMake的软连接
- sudo "/Applications/CMake.app/Contents/bin/cmake-gui" --install
- 注意：执行此命令的时候确保CMake处于关闭状态重新打开Terminal，即可正常使用 CMake 的各种指令了，也可以在应用程序列表中使用带 GUI 的 CMake 工具。

1.3 Linux安装

网址：https://cmake.org/download/，下载对应版本的CMake（32位或者64位）
将下载的安装包上传到Linux服务器，比如:/root
输入以下命令进行解压
- tar -zxvf cmake-3.13.0-rc1-Linux-x86_64.tar.gz
- 注意：后面是官网下载的对应版本的名字
把解压后的目录改名为：cmake
- mv cmake-3.10.0-rc4-Linux-x86_64 cmake
- 设置环境变量
  - 使用指令vi .bash_profile来设置环境变量，找到PATH=$PATH:$....这一行，后面添加CMake安装目录里面的bin目录的地址
  - 如果是在/root目录安装的CMake，那添加的目录就是：/root/cmake/bin
- 安装完毕，环境变量设置成功之后，命令行输入：cmake –version检测是否安装成功
  - 输出：cmake version 3.13，表示安装成功

2 使用CMake生成项目

2.1 使用Windows或者Linux生成项目

进入项目目录（CMakeLists.txt所在目录），新建一个build文件夹，因为CMake会产生很多自己的中间文件。
执行：cmake ../ 就会在build目录产生项目文件，windows下面默认产生vs的项目。
如果要产生其他编译器的makefile，就需要使用-G指定编译器
- cmake -G "MinGW Makefiles" ../
- 可以使用cmake –help 来查看使用的编译器的名字
- 生成项目工程文件或者makefile之后，就可以使用对应的编译器来编译项目

2.2 使用macOS生成项目

mac下基本操作和windows、Linux相同，不过cmake命令使用的是：cmake .. （没有右斜杠）

注意：（默认已经配置好环境变量）

3 CMake命令行选项的设置

3.1 指定构建系统生成器：-G

使用：-G 命令可以指定编译器，当前平台支持的编译器名称可以通过帮助手册查看：cmake –help，例如： cmake -G "Visual Studio 15 2017" ../ 使用vs2017构建工程

3.2CMakeCache.txt文件

当cmake第一次运行一个空的构建的时候，他就会创建一个CMakeCache.txt文件，文件里面存放了一些可以用来制定工程的设置，比如：变量、选项等
对于同一个变量，如果Cache文件里面有设置，那么CMakeLists文件里就会优先使用Cache文件里面的同名变量。
CMakeLists里面通过设置了一个Cache里面没有的变量，那就将这个变量的值写入到Cache里面

例子：

//变量var的值被设置成1024，如果变量var在Cache中已经存在，该命令不会覆盖cac he里面的值

SET(var 1024)
//如果var在Cache中存在，就优先使用Cache里面的值，如果不存在，就将该值写入Cache里面​
   
SET(var 1024..CACHE..)
//无论Cache里面是否存在，都始终使用该值
   
SET(var..CACHE..FORCE)

3.3 添加变量到Cache文件中：-D

注意：-D后面不能有空格，例如：cmake -DCMAKE_BUILD_TYPE:STRING=Debug

3.4 从Cache文件中删除变量：-U

此选项和-D功能相反，从Cache文件中删除变量，支持使用*和？通配符

3.5 CMake命令行模式：-E

CMake提供了很多和平台无关的命令，在任何平台都可以使用：chdir, copy,copy_if_different等可以使用：cmake -E help进行查询

3.6 打印运行的每一行CMake

命令行选项中：--trace，将打印运行的每一行CMake，例如windows下执行: cmake –trace ..
命令：--trace-source="filename"就会打印出有关filename的执行

3.7 设置编译参数

add_definitions（-DENABLED），当在CMake里面添加该定义的时候，如果代码里面定义了#ifdef ENABLED #endif相关的片段，此时代码里面这一块代码就会生效
add_definitions( “-Wall -ansi –pedantic –g”)：该命令现已经被取代，使用： add_compile_definitions(WITH_OPENCV2)

3.8 设置默认值命令：option

option命令可以帮助我们设置一个自定义的宏，如下：

option(MY-MESSAGE “this is my message” ON)
第一个参数就是我们要设置的默认值的名字
第二个参数是对值的解释，类似于注释
第三个值是这个默认值的值，如果没有声明，CMake默认的是OFF
使用：设置好之后我们在命令行去使用的时候，也可以去给他设定值：cmake -DMY-MESSAGE=on ../
注意：使用的时候我们应该在值的前面加“D”
这条命令可将MY-MESSAGE的值设置为on，通过这个值我们可以去触发相关的判断

4 CMake基础知识简介

4.1 最低版本

每个CMakeList.txt中第一行都会写cmake_minimum_required(VERSION X.X)来指定cmake的最低版本，设置cmake版本必须大于X.X，也可以使用cmake_minimum_required(VERSION X.X...Y.Y)来设置cmake的版本范围。

4.1.1 判断cmake版本

#检查当前版本是否小鱼3.12是，则更新版本号变量,否则设置版本为3.12

if(${CMAKE_VERSION} VERSION_LESS 3.12)
    cmake_policy(VERSION ${CMAKE_MAJOR_VERSION}.${CMAKE_MINOR_VERSION})
else()
    cmake_policy(VERSION 3.12)
endif()

现在可以使用cmake_minimum_required(VERSION 2.8.3)检查cmake的最小版本

4.2 设置项目名称

cmake中使用 project(MyProject[C] [C++]) 不过后面的语言参数经常省略，默认支持所有语言。

执行project()函数就是定义了一个项目名称，并且会生成两个变量_BINARY_DIR和_SOURCE_DIR和PROJECT_BINARY_DIR者两个变量是cmake中预定义的变量。变量是否相同，关键在于是内部构建还是外部构建：

内部构建： cmake ./ && make
外部构建：mkdir build && cd build && cmake ../ && make 当cmake在外部构建时，产生的中间文件和可执行文件并不在同一目录，因此PROJECT_BINARY_DIR和_BINARY_DIR内容相同，内部构建的时候指向CMakeLists.txt文件的目录，外部构建的，指向target编译的目录。此外：PROJECT_SOURCE_DIR和_SOURCE_DIR无论内部构建还是外部构建，指向的内容都是一样的，都指向工程的根目录

4.3 生成可执行文件

语法：add_executable(exename srcname)

exename:生成的可执行文件的名字
srcname:以来的源文件

生成exe的名字，并且指出需要的源文件。获取文件路径中的所有源文件：aux_sourcr_directory(<dir> <variable>)例如：aux_sourcr_directory(. DIR_SRCS)将当前目录下的源文件名字存放到变量DIR_SRCS里面，如果源文件比较多，直接用DIR_SRCS变量即可。add_executable(Demo ${DIR_SRCS})生成名为Demo的可执行文件。

4.4 生成库文件

cmake中使用add_library来实现库文件的生成；命令：

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

libname:生成的库文件的名字
[SHARED|STATIC|MODULE]：生成库文件的类型（动态库静态库模块）
EXCLUDE_FROM_ALL：有这个参数表示该库不会被默认构建
source2 … sourceN：生成库依赖的源文件，如果源文件比较多，可以使用aux_sourcr_directory命令获取路径下所有源文件，具体章节参见：CMake基础知识简介->生成可执行文件->获取路径中所有源文件

示例：add_library(ALib SHARE alib.cpp)

4.5 添加头文件目录

命令1：

target_include_directories(
    <target> [SYSTEM] 
    [BEFORE] 
    <INTERFACE|PUBLIC|PRIVATE> [items1...] 
    [<INTERFACE|PUBLIC|PRIVATE> [items2...] ...]
    )

示例1：target_include_directories(RigelEditor PUBLIC ./include/rgeditor)，表示给RigelEditor 这个子项目添加一个库文件的路径。

命令2：include_directories([AFTER|BEFORE] [SYSTEM] dir1 [dir2 …]) 参数解析：

AFTER|BEFORE：指定了要添加路径是添加到原有列表之前还是之后
SYSTEM：若指定了system参数，则把被包含的路径当做系统包含路径来处理。
dir1 [dir2 …]:把这些路径添加到CMakeLists及其子目录的CMakeLists的头文件包含项目中相当于g++选项中的-l的参数的作用。

示例2：include_directories("/opt/MATLAB/R2012a/extern/include")

注意：两者都是将include目录添加到目标区域中，但是include_directories是对整个项目进行全局添加，target_include_directories是将CMake中针对指定的目标进行添加。

4.6 添加链接库文件路径

4.6.1 添加需要的库文件路径

命令1:

target_link_libraries(
    <target> 
    [item1 [item2 [...]]] 
    [[debug|optimized|general] <item>] 
    ...
    )

参数解析：

item: 对应的链接库文件
debug|optimized|general:调试配置/其它配置/所有配置

示例1：target_link_libraries(MyProject a b.a c.so) 将文件库链接到项目中，target_link_libraries中的库文件的顺序符合gcc/g++链接顺序规则，即：被依赖的库放在依赖其他的库的后面。

命令2：link_libraries 给当前工程链接需要的文件库。

注意：target_link_libraries可以给工程或者库文件设置其需要链接的库文件，而且不需要填写全路径，但是link_libraries只能给工程添加依赖的库，而且必须添加全路径。

4.6.2 添加需要的库文件的目录

link_directories

4.7 控制目标属性

以上的几条命令的区分都是：是否带target前缀，在CMake里面，一个target有自己的属性集，如果我们没有显示的设置这些target的属性的话，CMake默认是由相关的全局属性来填充target的属性，我们如果需要单独的设置target的属性，需要使用命令：set_target_properties()

命令格式：

set_target_properties(
    target1 
    target2 
    ... 
    PROPERTIES 属性名称1 值 
    属性名称2 值 
    ... 
    )

控制编译选项的属性是：COMPILE_FLAGS
控制链接选项的属性是：LINK_FLAGS
控制输出路径的属性：EXECUTABLE_OUTPUT_PATH（exe的输出路径）、LIBRARY_OUTPUT_PATH（库文件的输出路径）

示例：

set_target_properties(exe 
    PROPERTIES 
    LINK_FLAGS -static 
    LINK_FLAGS_RELEASE -s 
    )

这条指令会使得exe这个目标在所有的情况下都采用-static选项，而且在release build的时候-static -s 选项。但是这个属性仅仅在exe这个target上面有效。

4.8 变量和缓存

4.8.1 局部变量

CMakeLists.txt相当于一个函数，第一个执行的CMakeLists.txt相当于主函数，正常设置的变量不能跨越CMakeLists.txt文件，相当于局部变量只在当前函数域里面作用一样。但是当使用include()直接进行.cmake文件的引入时，可以实现变量的通用引用。

4.8.2 缓存变量

缓存变量就是cache变量，相当于全局变量，都是在第一个执行的CMakeLists.txt里面被设置的，不过在子项目的CMakeLists.txt文件里面也是可以修改这个变量的，此时会影响父目录的CMakeLists.txt，这些变量用来配置整个工程，配置好之后对整个工程使用。设置缓存变量: set(MY_CACHE_VALUE "cache_value" CACHE INTERNAL "THIS IS MY CACHE VALUE")；//THIS IS MY CACHE VALUE，这个字符串相当于对变量的描述说明，不能省略，但可以自己随便定义。

4.8.3 环境变量

设置环境变量：set(ENV{variable_name} value) 获取环境变量：$ENV{variable_name}

4.8.4 内置变量

CMake中包含大量的内置变量，和自定义的变量相同，常用的有以下：

CMAKE_C_COMPILER：指定C编译器
CMAKE_CXX_COMPILER：指定C++编译器
EXECUTABLE_OUTPUT_PATH：指定可执行文件的存放路径
LIBRARY_OUTPUT_PATH：指定库文件的放置路径
CMAKE_CURRENT_SOURCE_DIR：当前处理的CMakeLists.txt所在的路径
CMAKE_BUILD_TYPE：控制构建的时候是Debug还是Release命令：set(CMAKE_BUILD_TYPE Debug)
CMAKE_SOURCR_DIR：无论外部构建还是内部构建，都指的是工程的顶层目录（参考project命令执行之后，生成的_SOURCR_DIR以及CMake预定义的变量PROJECT_SOURCE_DIR）
CMAKE_BINARY_DIR：内部构建指的是工程顶层目录，外部构建指的是工程发生编译的目录（参考project命令执行之后，生成的_BINARY_DIR以及CMake预定义的变量PROJECT_BINARY_DIR）
CMAKE_CURRENT_LIST_LINE：输出这个内置变量所在的行。

CMake中的缓存大多数存储在CMakeCache.txt文件文件中。

5 CMake基本控制语法

5.1 if

基本语法：

if(expression)    
    COMMAND1(ARGS ...)    
    COMMAND2(ARGS ...)    
    ...
else(expression)    
    COMMAND1(ARGS ...)    
    COMMAND2(ARGS ...)    
    ...
endif(expression)

注意：ENDIF要和IF对应

if (expression)，expression不为：空,0,N,NO,OFF,FALSE,NOTFOUND或_NOTFOUND,为真
IF (not exp)，与上面相反
if (var1 AND var2)，var1且var2都为真，条件成立
if (var1 OR var2)，var1或var2其中某一个为真，条件成立
if (COMMAND cmd)，如果cmd确实是命令并可调用，为真；
if (EXISTS dir) 如果目录存在，为真
if (EXISTS file) 如果文件存在，为真
if (file1 IS_NEWER_THAN file2)，当file1比file2新，或file1/file2中有一个不存在时为真，文件名需使用全路径
if (IS_DIRECTORY dir) 当dir是目录时，为真
if (DEFINED var) 如果变量被定义，为真
if (string MATCHES regex) 当给定变量或字符串能匹配正则表达式regex时，为真

例：IF (“hello” MATCHES “ell”) MESSAGE(“true”) ENDIF (“hello” MATCHES “ell”)

数字表达式

if (var LESS number)，var小于number为真。
if (var GREATER number)，var大于number为真。
if (var EQUAL number)，var等于number为真。

字母顺序比较

IF (var1 STRLESS var2)，var1字母顺序小于var2为真。
IF (var1 STRGREATER var2)，var1字母顺序大于var2为真。
IF (var1 STREQUAL var2)，var1和var2字母顺序相等为真。

5.2 while

WHILE(condition) COMMAND1(ARGS …) COMMAND2(ARGS …) …ENDWHILE(condition)

条件判断参考if

5.3 Foreach

FOREACH有三种使用形式的语法，且每个FOREACH都需要一个ENDFOREACH()与之匹配。

列表循环

语法：

FOREACH(loop_var arg1 arg2 ...) 
    COMMAND1(ARGS ...) 
    COMMAND2(ARGS ...) 
    ...
ENDFOREACH(loop_var)

例子：
```
AUX_SOURCE_DIRECTORY(.SRC_LIST)
FOREACH(F ${SRC_LIST}) 
  MESSAGE(${F})
ENDFOREACH(F)
```
例子中，先将当前路径的源文件名放到变量SRC_LIST里面，然后遍历输出文件名

循环范围

语法：

FOREACH(loop_var RANGE total) 
    COMMAND1(ARGS ...) 
    COMMAND2(ARGS ...)
    ... 
ENDFOREACH(loop_var)

例子：

FOREACH(VAR RANGE 100)
    MESSAGE(${VAR})
ENDFOREACH(VAR)​​

例子中默认起点为0，步进为1，作用就是输出：0~100。

范围步进循环

语法:

FOREACH(loop_var RANGE start stop [step]) 
    COMMAND1(ARGS ...) 
    COMMAND2(ARGS ...)
    ... 
ENDFOREACH(loop_var)

例子：

FOREACH(A RANGE 0 100 10)
    MESSAGE(${A})
ENDFOREACH(A)​

例子中，起点是0，终点是100，步进是10，输出：0,10,20,30,40,50,60,70,80,90,100。

6 构建规范以及构建属性

用于指定构建规则以及程序使用要求的指令：

target_include_directories()
target_compile_definitions()
target_compile_options()

指令格式：

target_include_directories(
    <target> 
    [SYSTEM] 
    [BEFORE] 
    <INTERFACE|PUBLIC|PRIVATE> 
    [items1...] 
    [<INTERFACE|PUBLIC|PRIVATE> [items2...] ...]
    )

主要是设置include的头文件的查找目录，也就是GCC的[-lidr...]选项

target_compile_definitions(
    <target> 
    <INTERFACE|PUBLIC|PRIVATE> 
    [items1...]
    [<INTERFACE|PUBLIC|PRIVATE> [items2...] ...]
    )

设置c++文件中预定义的宏变量。 ```

target_compile_options( [BEFORE] <INTERFACE|PUBLIC|PRIVATE> [items1...] [<INTERFACE|PUBLIC|PRIVATE> [items2...] ...] )

    gcc其它的一些编译选项，比如-fPIC,-fPIC作用于编译阶段，告诉编译器产生与位置无关代码Position-Independent Code)，则产生的代码中，没有绝对地址，全部使用相对地址，故而代码可以被加载器加载到内存的任意位置，都可以正确的执行。这正是共享库所要求的，共享库被加载时，在内存的位置不是固定的。

以上的额三个命令会生成

- INCLUDE_DIRECTORIES, 
- COMPILE_DEFINITIONS, 
- COMPILE_OPTIONS
变量的值。或者 :
- INTERFACE_INCLUDE_DIRECTORIES
- INTERFACE_COMPILE_DEFINITIONS
- INTERFACE_COMPILE_OPTIONS

这三个命令都有三种可选模式: PRIVATE, PUBLIC。INTERFACE.PRIVATE模式仅填充不是接口的目标属性;INTERFACE模式仅填充接口目标的属性.PUBLIC模式填充这两种的目标属性。

## 7 宏和函数
CMake里面可以定义自己的函数（function）和宏（macro）
函数和宏的区别：

函数是有范围的，而宏没有。如果希望函数设置的变量在函数的外部也可以看见，就需要使用PARENT_SCOPE来修饰，但是函数对于变量的控制会比较好，不会有变量泄露。函数很难将计算结果传出来，使用宏就可以将一些值简单的传出来。

使用示例
- 宏(macro)

```cmake
macro( [arg1 [arg2 [arg3 ...]]])     
    COMMAND1(ARGS ...)     
    COMMAND2(ARGS ...)     
    ...
endmacro()

函数(function)

function( [arg1 [arg2 [arg3 ...]]])     
    COMMAND1(ARGS ...)     
    COMMAND2(ARGS ...)     
    ...

endfunction()

使用示例:

macro(macroTest)
    set(test1 "aaa")
endmacro()
​
function(funTest)
    set(test2 "bbb")
endfunction()
​
macroTest()
message("${test1}")
​funTest()
message("${test2}")
​
#最终显示结果为aaa,test2为局部变量，已经超出了他的工作范围。

8 和其它文件的交互

8.1 在代码中使用CMake中定义的变量

使用configure_file命令可以使得在普通文件中也能使用CMake中的变量

语法：

configure_file(
    <input> <output> 
    [COPYONLY] 
    [ESCAPE_QUOTES] 
    [@ONLY] 
    [NEWLINE_STYLE [UNIX|DOS|WIN32|LF|CRLF] ]
    )​;

参数：

COPYONLY：

只拷贝文件，不进行任何的变量替换。这个选项在指定了 NEWLINE_STYLE 选项时不能使用（无效）。
ESCAPE_QUOTES：

躲过任何的反斜杠(C风格)转义。躲避转义，比如你有个变量在CMake中是这样的 set(FOO_STRING “"foo"”) 那么在没有 ESCAPE_QUOTES 选项的状态下，通过变量替换将变为 "foo"，如果指定了 ESCAPE_QUOTES 选项，变量将不变。
@ONLY：

限制变量替换:，让其只替换被 @VAR@ 引用的变量（那么 ${VAR}格式的变量将不会被替换）。这在配置 ${VAR} 语法的脚本时是非常有用的。
NEWLINE_STYLE:

指定输出文件中的新行格式。UNIX 和 LF 的新行是 \n ，DOS 和 WIN32 和 CRLF 的新行格式是 \r\n 。这个选项在指定了 COPYONLY 选项时不能使用（无效）。

8.2 在CMake对文件的操作

8.2.1 file命令：

file(WRITE filename “message to write”… ):

WRITE选项会写一条消息到名为filename中，如果文件存在，则会覆盖原文件，如果文件不存在，他将创建该文件。
file(APPEND filename “message to write”… ):

APPEND选项和WRITE选项一样，只是APPEND会写到文件的末尾。
file(READ filename variable [LIMIT numBytes] [OFFSET offset] [HEX])：

READ选项会将读取的文件内容存放到变量variable，读取numBytes个字节，从offset位置开始，如果指定了[HEX]参数，二进制代码就会转换为十六进制的转换方式。
file(STRINGS filename variable [LIMIT_COUNT num] [LIMIT_INPUT numBytes] [LIMIT_OUTPUT numBytes] [LENGTH_MINIMUM numBytes] [LENGTH_MAXIMUM numBytes] [NEWLINE_CONSUME] [REGEX regex] [NO_HEX_CONVERSION])：

STRINGS标志，将会从一个文件中将ASCII字符串的list解析出来，然后储存在variable 变量中，文件中的二进制数据将会被忽略，回车换行符会被忽略（可以设置NO_HEX_CONVERSION选项来禁止这个功能）。LIMIT_COUNT：设定了返回字符串的最大数量；LIMIT_INPUT：设置了从输入文件中读取的最大字节数；LIMIT_OUTPUT：设置了在输出变量中允许存储的最大字节数；LENGTH_MINIMUM：设置了返回字符串的最小长度，小于该长度的字符串将会被忽略；LENGTH_MAXIMUM设置了返回字符串的最大长度，大于该长度的字符串将会被忽略；NEWLINE_CONSUME：该标志允许新行被包含到字符串中，而不是终止他们；REGEX：指定了返回的字符串必须满足的正则表达式。例如：file(STRINGS myfile.txt myfile)，将myfile.txt中的文本按行存储到myfile这个变量中。
file(GLOB variable [RELATIVE path] [globbing expressions]…)

GLOB：该选项将会为所有匹配表达式的文件生成一个文件list，并将该list存放在variable 里面，文件名的查询表达式和正则表达式类似，匹配和正则表达式相似。
file(GLOB_RECURSE variable [RELATIVE path] [FOLLOW_SYMLINKS] [globbing expressions]…)

GLOB_RECURSE会生成一个类似于通常GLOB选项的list，不过该选项可以递归查找文件中的匹配项。例如：/dir/*.py -就会匹配所有在/dir文件下面的python文件。
file(RENAME )

RENAME选项对同一个文件系统下的一个文件或目录重命名。
file(REMOVE [file1 …])

REMOVE选项将会删除指定的文件，包括在子路径下的文件。
file(REMOVE_RECURSE [file1 …])

REMOVE_RECURSE选项会删除给定的文件以及目录，包括非空目录
file(MAKE_DIRECTORY [directory1 directory2 …])

MAKE_DIRECTORY选项将会创建指定的目录，如果它们的父目录不存在时，同样也会创建。
file(RELATIVE_PATH variable directory file)

RELATIVE_PATH选项会确定从direcroty参数到指定文件的相对路径，然后存到变量variable中。
file(TO_CMAKE_PATH path result)

TO_CMAKE_PATH选项会把path转换为一个以unix的 / 开头的cmake风格的路径
file(TO_NATIVE_PATH path result)

TO_NATIVE_PATH选项与TO_CMAKE_PATH选项很相似，但是它会把cmake风格的路径转换为本地路径风格
file(DOWNLOAD url file [TIMEOUT timeout] [STATUS status] [LOG log] [EXPECTED_MD5 sum] [SHOW_PROGRESS])

DOWNLOAD将给定的url下载到指定的文件中，如果指定了LOG log，下载的日志将会被输出到log中，如果指定了STATUS status选项下载操作的状态就会被输出到status里面，该状态的返回值是一个长度为2的list，list第一个元素是操作的返回值，是一个数字，第二个返回值是错误的字符串，错误信息如果是0，就表示没有错误；如果指定了TIMEOUT time选项，time秒之后，操作就会推出。如果指定了EXPECTED_MD5 sum选项，下载操作会认证下载的文件的实际MD5和是否与期望值相匹配，如果不匹配，操作将返回一个错误；如果指定了SHOW_PROGRESS，进度信息会被打印出来，直到操作完成。

8.2.2 source_group命令

使用该命令可以将文件在VS中进行分组显示；source_group("Header Files" FILES ${HEADER_FILES})；以上命令是将变量HEADER_FILES里面的文件，在VS显示的时候都显示在“Header Files”选项下面

9 如何构建项目

使用include直接包含指定的文件，文件后缀名相关性不大，也可以使用add_subdirectories()来添加子文件夹，但是要求子文件夹中存在对应的CMakeList.txt文件。

存在项目目录如下：

project_dir
- lib文件夹
  - libA.c
  - libB.c
  - CMakeLists.txt
- include文件夹
  - includeA.h
  - inclueeB.h
  - CMakeLists.txt
- main.c
- CMakeLists.txt

第一层CMakeLists.txt内容如下：

#项目名称
project(main)
#需要的cmake最低版本
cmake_minium_required(VERSION 2.8)
#将当前目录下的源文件名都赋给DIR_SRC目录
aux_source_directories(. DIR_SRC)
#添加include目录
include_directories(include)
#生成可执行文件
add_executable(main ${DIR_SRC})
#添加子目录
add_subdirectories(lib)
#将生成的文件与动态库相连
target_link_libraries(main test)
#test是lib目录里面生成的​

lib目录下的CMakeLists

#将当前的源文件名字都添加到DIR_LIB变量下​
aux_source_director(. DIR_LIB)
#生成库文件命名为
testadd_libraries(test ${DIR_LIB})​​

10 运行其它程序

CMakeLists.txt中可以使用execute_process 来运行系统中的程序。

execute_process(
    [COMMAND <cmd1> [args1...]] 
    [COMMAND <cmd2> [args2...] [...]] 
    [WORKING_DIRECTORY <directory>] 
    [TIMEOUT <seconds>] 
    [RESULT_VARIABLE <variable>] 
    [OUTPUT_VARIABLE <variable>] 
    [ERROR_VARIABLE <variable>] 
    [INPUT_FILE <file>] 
    [OUTPUT_FILE <file>] 
    [ERROR_FILE <file>] 
    [OUTPUT_QUIET] 
    [ERROR_QUIET] 
    [OUTPUT_STRIP_TRAILING_WHITESPACE] 
    [ERROR_STRIP_TRAILING_WHITESPACE]
    )​

参数解析

COMMAND：子进程的命令行，CMake使用操作系统的API直接执行子进程，所有的参数逐字传输，没有中间脚本参与，像“>”的输出重定向也会被直接的传输到子进程里面，当做普通的参数进行处理。
WORKING_DIRECTORY：指定的工作目录将会设置为子进程的工作目录
TIMEOUT：子进程如果在指定的秒数之内没有结束就会被中断
RESULT_VARIABLE：变量被设置为包含子进程的运算结果，也就是命令执行的最后结果将会保存在这个变量之中，返回码将是来自最后一个子进程的整数或者一个错误描述字符串
OUTPUT_VARIABLE、ERROR_VARIABLE：输出变量和错误变量
INPUT_FILE、OUTPUT_FILE、ERROR_FILE：输入文件、输出文件、错误文件
OUTPUT_QUIET、ERROR_QUIET:输出忽略、错误忽略，标准输出和标准错误的结果将被默认忽略.

使用示例:

set(MAKE_CMD "/src/bin/make.bat")
MESSAGE("COMMAND: ${MAKE_CMD}")
execute_process(
    COMMAND "${MAKE_CMD}" 
    RESULT_VARIABLE 
    CMD_ERROR OUTPUT_FILE CMD_OUTPUT
    )
MESSAGE( 
    STATUS "CMD_ERROR:" 
    ${CMD_ERROR}
    )
MESSAGE(
    STATUS 
    "CMD_OUTPUT:" 
    ${CMD_OUTPUT}
    )

#输出：​​COMMAND:/src/bin/make.batCMD_ERROR:​No such file or directoryCMD_OUTPUT:​（因为这个路径下面没有这个文件）​​

11 find_package() 查找链接库函数

11.1 find_package（）命令查找***.cmake的顺序。

find_package()会优先从CMAKE_MODULE_PATH中寻找FindXXX.cmake来进行寻找。这种模式也成为Model模式。CMAKE_MODULE_PATH是cmake预先定义，但是一般没有值，一旦赋值则按照最先优先级去寻找。

因此我们可以通过set(CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake)来进行添加，比较建议的做法是LIST(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake_modules)这样解可以在多个列表后面直接添加。

如果没有在CMAKE_MODULE_PATH找到，就会在../.cmake/packages或者../uesr/local/share/中的包目录中查找：Config.cmake或者-config.cmake。这种查找模式称作Config模式。库名字小写>库名字大写>

无论那种方式只要找到XXXX.cmake文件，里面都会定义下面这些变量

<NAME>_FOUND<NAME>_INCLUDE_DIRS
<NAME>_INCLUDES<NAME>_LIBRARIES
<NAME>_LIBRARIES
<NAME>_LIBS<NAME>_DEFINITIONS

然后就可以使用include_directories(<Name>_INCLUDE_DIRS)来包含库的头文件。使用:link_libraries(<NAME>_LIBRARIES)来链接动态库。

可以使用cmake --help-module-list命令来查看当前cmake支持的模块。

11.2 find_package()的命令参数

命令：

FIND_PACKAGE( 
    <name> 
    [version] 
    [EXACT] 
    [QUIET] 
    [NO_MODULE] 
    [ [ REQUIRED | COMPONENTS ] [ componets... ] ]
    )

参数解释

version：需要一个版本号，给出这个参数而没有给出EXACT，那个就是找到和给出的这个版本号相互兼容就符合条件。
EXACT：要求版本号必须和version给出的精确匹配。没有指定时只要兼容就不会报错，但是当指定后不符合就会报错，因此建议使用版本范围。如：

find_package(OpenCV 3.0 QUIET)
if(NOT OpenCV_FOUND)
   find_package(OpenCV 2.4.3 QUIET)
   if(NOT OpenCV_FOUND)
      message(FATAL_ERROR "OpenCV > 2.4.3 not found.")
   endif()
endif()

QUIET：会禁掉查找的包没有被发现的警告信息。对应于Find.cmake模块里面的的NAME_FIND_QUIETLY变量。
NO_MODULE：给出该指令之后，cmake将直接跳过Module模式的查找，直接使用Config模式查找。
COMPONENTS: 有些库不是一个整体比如Qt，其中还包含QtOpenGL和QtXml组件，当我们需要使用库的组件的时候，就使用COMPONENTS这个选项.

11.3 编写find模块。

find模块的编写流程

使用：find_path和find_library查找模块的头文件以及库文件，然后将结果放到_INCLUDE_DIR和_LIBRARY里面。
设置：<NAME>_INCLUDE_DIRS为<NAME>_INCLUDE_DIR<dependency1>_INCLUDE_DIRS ...
设置 <name>_LIBRARIES 为 <name>_LIBRARY <dependency1>_LIBRARIES ...
调用宏 find_package_handle_standard_args() 设置 <name>_FOUND 并打印或失败信息。

find_path函数使用方式为：

find_path(<VAR> name1 [path1 path2 ...])

该命令搜索包含某个文件的路径，用于给定名字的文件坐在路径。的cache将会被创建。在路径中找到文件就存到变量中。除非变量被清除否则，搜索不会继续进行(者也是cmake配置错误需要删除cache的原因)。如果没有发现该文件就在里面存储`-NOTFOUND`

下面是一个FindBZip2.cmake模块的简单示例：

#.rst:
# FindBZip2
# ---------
#
# Try to find BZip2
#
# Once done this will define
#
# ::
#
#   BZIP2_FOUND - system has BZip2
#   BZIP2_INCLUDE_DIR - the BZip2 include directory
#   BZIP2_LIBRARIES - Link these to use BZip2
#   BZIP2_NEED_PREFIX - this is set if the functions are prefixed with BZ2_
#   BZIP2_VERSION_STRING - the version of BZip2 found (since CMake 2.8.8)

#=============================================================================
# Copyright 2006-2012 Kitware, Inc.
# Copyright 2006 Alexander Neundorf <neundorf@kde.org>
# Copyright 2012 Rolf Eike Beer <eike@sf-mail.de>
#
# Distributed under the OSI-approved BSD License (the "License");
# see accompanying file Copyright.txt for details.
#
# This software is distributed WITHOUT ANY WARRANTY; without even the
# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
# See the License for more information.
#=============================================================================
# (To distribute this file outside of CMake, substitute the full
#  License text for the above reference.)

#设置_BZIP2_PATHS

set(_BZIP2_PATHS PATHS
  "[HKEY_LOCAL_MACHINE\SOFTWARE\GnuWin32\Bzip2;InstallPath]"
  )
#查找文件路径并保存到变量BZIP2_INCLUDE_DIR中

find_path(BZIP2_INCLUDE_DIR bzlib.h ${_BZIP2_PATHS} PATH_SUFFIXES include)

#如果没有定义BZIP2_LIBRARIES，进行查找

if (NOT BZIP2_LIBRARIES)
    find_library(BZIP2_LIBRARY_RELEASE NAMES bz2 bzip2 ${_BZIP2_PATHS} PATH_SUFFIXES lib)
    find_library(BZIP2_LIBRARY_DEBUG NAMES bzip2d ${_BZIP2_PATHS} PATH_SUFFIXES lib)

    include(${CMAKE_CURRENT_LIST_DIR}/SelectLibraryConfigurations.cmake)
    SELECT_LIBRARY_CONFIGURATIONS(BZIP2)
endif ()

#include文件存在，进行正则匹配查找文件名中的版本信息。

if (BZIP2_INCLUDE_DIR AND EXISTS "${BZIP2_INCLUDE_DIR}/bzlib.h")
    file(STRINGS "${BZIP2_INCLUDE_DIR}/bzlib.h" BZLIB_H REGEX "bzip2/libbzip2 version [0-9]+\.[^ ]+ of [0-9]+ ")
    string(REGEX REPLACE ".* bzip2/libbzip2 version ([0-9]+\.[^ ]+) of [0-9]+ .*" "" BZIP2_VERSION_STRING "${BZLIB_H}")
endif ()

# handle the QUIETLY and REQUIRED arguments and set BZip2_FOUND to TRUE if
# all listed variables are TRUE
include(${CMAKE_CURRENT_LIST_DIR}/FindPackageHandleStandardArgs.cmake)
#答应获取的相关信息
FIND_PACKAGE_HANDLE_STANDARD_ARGS(BZip2
                                  REQUIRED_VARS BZIP2_LIBRARIES BZIP2_INCLUDE_DIR
                                  VERSION_VAR BZIP2_VERSION_STRING)
#如果找到了
if (BZIP2_FOUND)
   include(${CMAKE_CURRENT_LIST_DIR}/CheckSymbolExists.cmake)
   include(${CMAKE_CURRENT_LIST_DIR}/CMakePushCheckState.cmake)
   #确认cmake状态
   cmake_push_check_state()
   //设置CMAKE_REQUIRED_QUIET无错误的找到
   set(CMAKE_REQUIRED_QUIET ${BZip2_FIND_QUIETLY})
   set(CMAKE_REQUIRED_INCLUDES ${BZIP2_INCLUDE_DIR})
   set(CMAKE_REQUIRED_LIBRARIES ${BZIP2_LIBRARIES})
   CHECK_SYMBOL_EXISTS(BZ2_bzCompressInit "bzlib.h" BZIP2_NEED_PREFIX)
   cmake_pop_check_state()
endif ()
#这个主要是给cmake-gui进行使用的
mark_as_advanced(BZIP2_INCLUDE_DIR)

下面是对这个FindBZip2.cmake模块的调用示例：

cmake_minimum_required(VERSION 2.8)
project(helloword)
add_executable(hello main.c)
find_package(BZip2)
#如果查找成功BZIP2_FOUND会被设置成为1

if(BZIP2_FOUND)
    include_directories(${BZIP2_INCLUDE_DIRS})
    target_link_libraries(hello ${BZIP_LIBRARIES})
endif(BZIP_FOUND)

12 自定义内容

12.1 add_custom_command 为某一个工程添加一个自定义的命令

参考链接： 各平台编译器中的Pre-build及Post-build操作

add_custom_command(TARGET target 
    PRE_BUILD | PRE_LINK| POST_BUILD 
    COMMAND command1[ARGS] [args1...] 
    [COMMAND command2[ARGS] [args2...] ...] 
    [WORKING_DIRECTORYdir] 
    [COMMENT comment][VERBATIM]
    )

执行命令的时间由第二个参数决定:

PRE_BUILD - 命令将会在其他依赖项执行前执行。
PRE_LINK - 命令将会在其他依赖项执行完后执行。
POST_BUILD - 命令将会在目标构建完后执行。

例子：

add_custom_command(
    TARGET ${PROJECT_NAME} 
    POST_BUILD 
    COMMAND ${CMAKE_COMMAND} -E sleep 5
    )
#目标就是TARGET后面跟的工程，​当PROJECT_NAME被生成的时候就会执行COMMAND后面的命令。

add_custom_command(
    TARGET test_elf ​
    PRE_BUILD 
    COMMAND 
    move E:/cfg/start.o ${CMAKE_BINARY_DIR}/. && 
    )

#在test_el执行依赖之前，将start.o文件复制到编译目录

12.2 add_custom_command：（2）添加自定义命令来产生一个输出

参数格式：

add_custom_command(
    OUTPUT output1 [output2 ...]
    COMMAND command1[ARGS] [args1...]
    [COMMAND command2 [ARGS] [args2...] ...]
    [MAIN_DEPENDENCYdepend]
    [DEPENDS[depends...]]
    [IMPLICIT_DEPENDS<lang1> depend1 ...]
    [WORKING_DIRECTORYdir]
    [COMMENT comment] [VERBATIM] [APPEND]
    )

参数解析：

其中ARGS选项是为了向后兼容，MAIN_DEPENDENCY选项是针对VisualStudio给出一个建议，这两选项可以忽略。
COMMAND：指定一些在构建阶段执行的命令。如果指定了多于一条的命令，他会按照顺序去执行。如果指定了一个可执行目标的名字（被add_executable()命令创建），他会自动被在构建阶段创建的可执行文件的路径替换。
DEPENDS:指定目标依赖的文件，如果依赖的文件是和CMakeLists.txt相同目录的文件，则命令就会在CMakeLists.txt文件的，目录执行。如果没有指定DEPENDS，则只要缺少OUTPUT，该命令就会执行。如果指定的位置和CMAkeLists.txt不是同一位置，会先去创建依赖关系，先去将依赖的目标或者命令先去编译。
WORKING_DIRECTORY：使用给定的当前目录执行命令，如果是相对路径，则相对于当前源目录对应的目录结构进行解析

例子：

#首先生成creator的可执行文件 ​
add_executable(creator creator.cxx) 
#获取EXE_LOC的LOCATION属性存放到creator里面​​ 
get_target_property(creator EXE_LOC LOCATION) ​
#生成created.c文件 
add_custom_command(
    OUTPUT ${PROJECT_BINARY_DIR}/created.c 
    DEPENDS creator 
    COMMAND ${EXE_LOC} 
    ARGS ${PROJECT_BINARY_DIR}/created.c 
    ) 
#使用上一步生成的created.c文件来生成Foo可执行文件​​ 
add_executable(Foo ${PROJECT_BINARY_DIR}/created.c)

注意：不要在多个相互独立的文件中使用该命令产生相同的文件，放置冲突。

12.3 add_custom_target:增加定制目标。

add_custom_target(
    Name [ALL] [command1 [args1...]] 
    [COMMAND command2 [args2...] ...] 
    [DEPENDS depend depend depend ... ] 
    [BYPRODUCTS [files...]] 
    [WORKING_DIRECTORY dir] 
    [COMMENT comment] 
    [VERBATIM] [USES_TERMINAL] 
    [SOURCES src1 [src2...]]
    )

add_custom_target 可以增加定制目标，常常用于编译文档、运行测试用例等。

12.4 add_custom_command和add_custom_target的区别

命令命名里面的区别就在于：command和target，前者是自定义命令，后者是自定义目标
目标：使用add_custom_target定义的叫做自定义目标，因此这些“目标”区别于正常的目标，他们不生成exe或者lib，但是仍然会具有一些正常目标相同的属性，构建他们的时候，只是调用了为他们设置的命令，如果自定义目标对于其他目标有依赖，那么就会优先生成依赖的那些目标。
自定义命令：自定义命令不是一个“可构建”的对象，并且没有可以设置的属性，自定义命令是一个在构建依赖目标之前被调用的命令，自定义命令的依赖可以通过add_custom_command(TARGET target …)形式显式设置，也可以通过add_custom_command(OUTPUT output1 …)生成文件的形式隐式设置。显示执行的时候，每次构建目标，首先会执行自定义的命令，隐式执行的时候，如果自定义的命令依赖于其他文件，则在构建目标的时候先去执行生成其他文件。

13 C++中的常用选项

参考链接： CMake编译中target_link_libraries中属性PRIVATE、PUBLIC、INTERFACE含义

13.1 C++11功能的激活

使用target_compile_features(<target> <PRIVATE|PUBLIC|INTERFACE> <feature> [...])

添加c++11标准：target_compile_features(<project_name> PUBLIC cxx_std_11)。

注意：target必须是由:add_executable或者add_library生成的目标。

也可以使用下面的方式来进行支持：

#设置c++标准级别

set(CMAKE_CXX_STANDARD 11)
#告诉cmake使用它

set(CMAKE_CXX_STANDARD_REQUIRED ON)
#(可选)确保-std=c++11

13.2 中间过程优化

#检测编译器是否支持过程间优化

check_ipo_supported(RESULT result)

#如果不支持，判断进不去
if(result)
    #为工程设置过程间优化

    set_target_properties(foo PROPERTIES INTERPROCEDURAL_OPTIMIZATION TRUE)
endif()

13.3 cmake中的option

option命令可以设置默认值；例如option(address "this is path for value" ON)设置address的默认值为ON，并且添加注释提示。

注意：没有设置默认值时，默认的默认值是OFF，如果值已经改变一定要清除CMakeCache.txt。

可以另外当去创建option.txt文件，然后使用include进行包含。

可以使用cmake_dependent_option设置存在依赖的option ,但是一般建议使用if判断来进行配置。

cmake_dependent_option(DEPENT_USE_CURL "this is dependent on USE_CURL" ON "USE_CURL;NOT USE_MATH" OFF)

#设置一个option：​​DEPENT_USE_CURL,第二个参数是他的说明，ON后面的参数是一个表达式，当“USE_CURL”且“USE_MATH”为真的时候，DEPENT_USE_CURL取ON，为假取OFF

13.4 属性调试模块(CMakePrintHelpers)

CMAKE_PRINT_PROPERTIES(
    [TARGETS target1 .. targetN]
    [SOURCES source1 .. sourceN]
    [DIRECTORIES dir1 .. dirN]
    [TESTS test1 .. testN]
    [CACHE_ENTRIES entry1 .. entryN]
    PROPERTIES prop1 .. propN
    )

如果要检查foo目标的INTERFACE_INCLUDE_DIRS和LOCATION的值，则执行：

cmake_print_properties(
    TARGETS foo 
    PROPERTIES 
    INTERFACE_INCLUDE_DIRS 
    LOCATION
    )

cmake学习笔记(一)

CMake链接

CMake文档

思维导图

1 安装

1.1 Windows安装

1.2 macOS安装

1.3 Linux安装

2 使用CMake生成项目

2.1 使用Windows或者Linux生成项目

2.2 使用macOS生成项目

注意：（默认已经配置好环境变量）

3 CMake命令行选项的设置

3.1 指定构建系统生成器：-G

3.2CMakeCache.txt文件

3.3 添加变量到Cache文件中：-D

3.4 从Cache文件中删除变量：-U

3.5 CMake命令行模式：-E

3.6 打印运行的每一行CMake

3.7 设置编译参数

3.8 设置默认值命令：option

4 CMake基础知识简介

4.1 最低版本

4.1.1 判断cmake版本

4.2 设置项目名称

4.3 生成可执行文件

4.4 生成库文件

4.5 添加头文件目录

4.6 添加链接库文件路径

4.6.1 添加需要的库文件路径

4.6.2 添加需要的库文件的目录

4.7 控制目标属性

4.8 变量和缓存

4.8.1 局部变量

4.8.2 缓存变量

4.8.3 环境变量

4.8.4 内置变量

5 CMake基本控制语法

5.1 if

5.2 while

5.3 Foreach

6 构建规范以及构建属性

8 和其它文件的交互

8.1 在代码中使用CMake中定义的变量

8.2 在CMake对文件的操作

8.2.1 file命令：

8.2.2 source_group命令

9 如何构建项目

10 运行其它程序

11 find_package() 查找链接库函数

11.1 find_package（）命令查找***.cmake的顺序。

11.2 find_package()的命令参数

11.3 编写find模块。

12 自定义内容

12.1 add_custom_command 为某一个工程添加一个自定义的命令

12.2 add_custom_command：（2）添加自定义命令来产生一个输出

12.3 add_custom_target:增加定制目标。

12.4 add_custom_command和add_custom_target的区别

13 C++中的常用选项

13.1 C++11功能的激活

13.2 中间过程优化

13.3 cmake中的option

13.4 属性调试模块(CMakePrintHelpers)

CATALOG

FEATURED TAGS

FRIENDS