重中之重:
CMake目录结构:项目主目录存在一个CMakeLists.txt文件。(主目录的意思就是在你项目的根目录下)
例如:
我现在又一个c++项目文件project02
我们进入这个项目看看有什么:
进入project02后,这就是我们当前项目的根目录,这个项目里有一些文件夹和cpp文件,那我们就必须创建一个CMakeLists.txt文件与include、main.cpp、src同级目录,如下所示:
知道这个首要原则之后,接下来我们继续看,
CMake有两种方式设置编译规则:
1.包含源文件的子文件夹包含CMakeLists.txt文件,主目录的CMakeLists.txt通过add_subdirectory添加子目录即可;
2.包含源文件的子文件夹未包含CMakeLists.txt文件,子目录编译规则体现在主目录的CMakeLists.txt中;
**这两种编译规则我会在后面实践中体现。**
CMake的编译流程:
在linux平台下使用CMake构建C/C++工程的流程如下:
- 手动编写CmakeLists.txt
- 执行命令cmake PATH生成 Makefile ( PATH是顶层CMakeLists.txt所在的目录,也就是开头所说的目录)
- 执行命令make进行编译
那么我们以代码实战详细讲讲两种构建方式:
一、内部构建(in-source build): 不推荐使用
内部构建会在同级目录下产生一大堆中间文件,这些中间文件并不是我们最终所需要的,和工程源文件放在一起会显得杂乱无章。
##内部构建
#在当前目录下,编译本目录的CMakeLists.txt,生成Makefile和其他文件
cmake .
#执行make命令,生成target
make
我以刚刚的project02 c++项目为例,项目构成如下:
两个目录(include、src),三个文件(swap.h、main.cpp、swap.cpp)
项目的源代码就不看了,不重要,就是实现打印交换两个数功能。
现在开始使用CMake编译该工程项目:
1.项目根目录创建CMakeLists.txt,创建完的目录情况如下:
CMakeLists.txt的内容是:
cmake_minimum_required(VERSION 3.0)
project(SWAP)
include_directories(include)
add_executable(main_cmake main.cpp src/swap.cpp)
根据我上一篇博客《CMake的基本概念及其常用指令(Linux/c/c++)》,对照读者这里自行理解每行指令的意思。**这篇文章主要是讲CMake编译工程的流程,先关指令就不在赘述。**
2.编译
当前目录下,在终端输入cmake .
(注意空格,注意'.')
等待编译完成:
打开我们的工程目录 ./project02
会发现生成了许多中间文件,关注到有一个Makefile,这也是上一篇博客我说CMake是makefile的格式化的体现。
3.终端输入 make
等待文件编译,最终生成main_cmake的可执行文件,这个名字是我们在CMakeLists.txt中自己定义的。
在次展开根目录:
可以发现多了一个main_cmake的可执行文件。
到这里CMake内部构建(in-source build)编译工程就结束了。
我们在终端输入 ./main_cmake 执行文件:
没问题,结束。
从上面我们可以看到,内部构建(in-source build)有一个问题就是,会在根目录下产生大量的五官紧要的文件,其实我们就只是需要最后的生成文件和CMakeLists.txt。那么怎么解决呢?
那就需要外部构建(out-of-source build),将编译输出文件与源文件放到不同目录中。
开整:
二、外部构建(out-of-source build):推荐使用
##外部构建
#1、在当前目录下,创建build文件夹
mkdir build
#2.进入到bui1d文件夹
cd bui1d
#3.编译上级目录的CMakeLists.txt,生成Makefile和其他文件
cmake ..
#4.执行make命令,生成target
make
相当于就是我们在工程文件的根目录下创建一个build文件,让这个文件存储中间产生的一些其他无关紧要的文件,以达到精简我们的项目目录的目的。
那么我们代码实战:
1.进入项目根目录,输入 mkdir build,在项目根目录下创建一个名字为build的文件夹,以至于为什么叫build,可以理解为默认吧,你去其他名字也可以,这里我就默认了。
2. cd build 进入build文件夹
3.cmake .. (注意空格,注意‘..’,两个点,表示CMakeLists.txt在上一级目录)
4. make 生成目标文件main_cmake
查看build文件夹,看到多了一个main_cmake的可执行文件
./mian_cmake 运行可执行文件
没问题。
讲解完成!