CMake

1.CMake:

CMake是开源、跨平台的构建工具，可以让我们通过编写简单的配置文件去生成本地的Makefile，这个配置文件是独立于运行平台和编译器的，这样就不用亲自去编写Makefile了，而且配置文件可以直接拿到其它平台上使用，无需修改，非常方便。

2.简单样例

首先让我们从最简单的代码入手，先来体验下cmake是如何操作的。编写main.cpp，如下，

 

然后在main.cpp相同目录下编写CMakeLists.txt，内容如下，

 

第一行意思是表示cmake的最低版本要求是3.16，我们安装的是3.17.3；

第二行是表示本工程信息，也就是工程名叫demo；

第三行比较关键，表示最终要生成的elf文件的名字叫test，使用的源文件是main.cpp

在终端下切到main.cpp所在的目录下，然后输入以下命令运行

cmake  .

会输出如下信息，

 

再来看看目录下的文件，

 

可以看到成功生成了Makefile，还有一些cmake运行时自动生成的文件。

然后在终端下输入make并回车，

 

再看下目录下的文件，可以看到我们需要的elf文件main也成功生成了，

 

然后运行main，

 

3.同一目录下多个源文件

在之前的目录下添加2个文件，testFunc.cpp和testFunc.h。添加完后整体文件结构如下，

 

testFunc.h内容如下，

 

testFunc.cpp内容如下，

 

修改main.cpp，调用testFunc.h里声明的函数func()，

 

修改CMakeLists.txt，在add_executable的参数里把testFunc.cpp加进来

 

然后重新执行cmake生成Makefile并运行make，然后运行重新生成的elf文件test，运行成功！

 

可以类推，如果在同一目录下有多个源文件，那么只要在add_executable里把所有源文件都添加进去就可以了。但是如果有一百个源文件，再这样做就有点坑了，无法体现cmake的优越性，cmake提供了一个命令可以把指定目录下所有的源文件存储在一个变量中，这个命令就是

aux_source_directory(dir var)。

第一个参数dir是指定目录，第二个参数var是用于存放源文件列表的变量。

修改CMakeLists.txt，

 

使用aux_source_directory把当前目录下的源文件存列表存放到变量SRC_LIST里，然后在add_executable里调用SRC_LIST（注意调用变量时的写法）。

再次执行cmake和make，并运行main，也可以运行成功。

 

aux_source_directory()也存在弊端，它会把指定目录下的所有源文件都加进来，可能会加入一些我们不需要的文件，此时我们可以使用set命令去新建变量来存放需要的源文件，如下，

 

 

4.不同目录下多个源文件

 

4.1.方式一

 

4.2 方式二

 

include_directories。该命令是用来向工程添加多个指定头文件的搜索路径，路径之间用空格分隔。

因为main.cpp里include了testFunc.h和testFunc1.h，如果没有这个命令来指定头文件所在位置，就会无法编译。

5.正规一点的组织结构

正规一点来说，一般会把源文件放到src目录下，把头文件放入到include文件下，生成的对象文件放入到build目录下，最终输出的elf文件会放到bin目录下，这样整个结构更加清晰。

 

最外层目录下新建一个CMakeLists.txt，内容如下，

 

这里出现一个新的命令add_subdirectory()，这个命令可以向当前工程添加存放源文件的子目录，并可以指定中间二进制和目标二进制的存放位置。

这里指定src目录下存放了源文件，当执行cmake时，就会进入src目录下去找src目录下的CMakeLists.txt，所以在src目录下也建立一个CMakeLists.txt，内容如下，

 

新的命令set，是用于定义变量的，EXECUTABLE_OUT_PATH和PROJECT_SOURCE_DIR是CMake自带的预定义变量，其意义如下，

EXECUTABLE_OUTPUT_PATH ：目标二进制可执行文件的存放位置

PROJECT_SOURCE_DIR：工程的根目录

所以，这里set的意思是把存放elf文件的位置设置为工程根目录下的bin目录。

下面来运行cmake，不过这次先让我们切到build目录下，然后输入以下命令，

cmake ..

Makefile会在build目录下生成，然后在build目录下运行make，

bin目录下，发现main已经生成

 

这里解释一下为什么在build目录下运行cmake？从前面几个case中可以看到，如果不这样做，cmake运行时生成的附带文件就会跟源码文件混在一起，这样会对程序的目录结构造成污染，而在build目录下运行cmake，生成的附带文件就只会待在build目录下，如果我们不想要这些文

了就可以直接清空build目录，非常方便。
 

另外一种写法：
前面的工程使用了2个CMakeLists.txt，这种写法是为了处理需要生成多个elf文件的情况，最外层的CMakeLists.txt用于掌控全局，使用add_subdirectory来添加要生成elf文件的源码目录。

如果只生成一个elf文件，那么上面的例子可以只使用一个CMakeLists.txt，可以把最外层的CMakeLists.txt内容改成如下，同时，还要把src目录下的CMakeLists.txt删除。
 

 

 

6.动态库和静态库的编译控制

有时只需要编译出动态库，静态库，然后等着让其它程序去使用。下这种情况该如何使用cmake。首先按照如下重新组织文件，只留下testFunc.h和testFunc.cpp，

在build目录下运行cmake，并把生成的库文件存放到lib目录下。

最外层的CMakeLists.txt内容如下，

 

lib_testFunc目录下的CMakeLists.txt如下，

 

 

add_library: 生成动态库或静态库(第1个参数指定库的名字；第2个参数决定是动态还是静态，如果没有就默认静态；第3个参数指定生成库的源文件)

set_target_properties: 设置输出的名称，还有其它功能，如设置库的版本号等等

LIBRARY_OUTPUT_PATH: 库文件的默认输出路径，这里设置为工程目录下的lib目录

好了，让我们进入build目录下运行cmake ..，成功后再运行make，
 

 

 

可以看出前面使用set_target_properties重新定义了库的输出名字，如果不用set_target_properties也可以，那么库的名字就是add_library里定义的名字，只是我们连续2次使用add_library指定库名字时，这个名字不能相同，而set_target_properties可以把名字设置为相同，只是最终生成的库文件后缀不同，这样相对来说会好看点。

7.对库进行链接

 

工程目录下的CMakeLists.txt，如下，

 

只是使用add_subdirectory把src目录添加进来。

src目录下的CMakeLists.txt如下，

 

link_directories: 添加非标准的共享库搜索路径

target_link_libraries: 把目标文件与库文件进行链接

（1）、在lib目录下有testFunc的静态库和动态库，target_link_libraries (main testFunc)默认是使用动态库，如果lib目录下只有静态库，那么这种写法就会去链接静态库。也可以直接指定使用动态库还是静态库，写法是：target_link_libraries (main libtestFunc.so)或

target_link_libraries (main libtestFunc.a)

（2）、查看elf文件使用了哪些库，可以使用readelf -d ./xx来查看
 

 

8.添加编译选项

有时编译程序时想添加一些编译选项，如-Wall，-std=c++11等，就可以使用add_compile_options来进行操作。

add_compile_options(-std=c++11 -Wall)

 

9.添加控制选项

有时希望在编译代码时只编译一些指定的源码，例如本来要编译生成多个bin或库文件，现在只想生成某些指定的bin或库文件，这时可以使用cmake的option命令。

 

10.基本命令

CMAKE_CURRENT_SOURCE_DIR
这是当前处理的CMakeLists.txt所在的目录

CMAKE_CURRENT_LIST_DIR
这是当前正在处理的列表文件的目录.

INCLUDE_DIRECTORIES（添加头文件目录）

LINK_DIRECTORIES（添加需要链接的库文件目录）

LINK_LIBRARIES　（添加需要链接的库文件路径，注意这里是全路径）

TARGET_LINK_LIBRARIES （设置要链接的库文件的名称）