CMake实战教程
前言
在学习CMake之前,一直都是自己在手敲Makefile文件,当项目的文件一旦多了起来,自己手动写Makefile就不是那么好玩了,也曾经了解了一下autotools,但是seeed的柱哥说有CMake这个东西,所以我就去学习了,也在网上搜过对比,下面的一句话让我果断放弃了autotools:
CMake产生的晚,解决了很多autotools工具的问题
其实吧,简单来说CMake就是生成Makefile的自动化构建工具(自动生成Makefile文件,不需要我们自己写Makefile),引用一句官方的描述就是:
CMake 是一个跨平台的构建系统生成工具。它使用平台无关的 CMake 清单文件CMakeLists.txt,指定工程的构建过程;源码树的每个路径下都有这个文件。CMake 产生一个适用于具体平台的构建系统,用户使用这个系统构建自己的工程。
安装CMake
开发环境:Ubuntu
一句代码的事安装CMake:
sudo apt-get install cmake
检测安装是否成功:
cmake --version
输出
cmake version 3.10.2
CMake suite maintained and supported by Kitware (kitware.com/cmake).
如果你用的是vscode写代码的话,最好还是装一个CMake插件,更加方便:
cmake插件
cmake插件
关于其他的一些注意事项,你需要编译c代码,起码Ubuntu得有个gcc编译器啥的吧~如果没有就直接安装得了….
初步了解CMake
其实呢,CMake是非常简单易用的,我们写代码无非就是将写好的代码进行编译生成可执行文件,那么就可以用CMake 生成 Makefile 文件并编译源代码!
它的流程基本如下:
编写 CMake配置文件 CMakeLists.txt 。
执行cmake PATH命令生成 Makefile。其中, PATH 是 CMakeLists.txt 所在的目录。
使用 make 命令进行编译。(既然步骤2的时候就生成Makefile文件了,那么肯定是可以直接make编译啦)
基本语法
一个最基本的CmakeLists.txt文件最少需要包含以下3行代码:
CMake 最低版本号要求
cmake_minimum_required (VERSION 2.8)
项目信息
project (section1)
指定生成目标
add_executable(section1 main.c)
注意:CMake的语法支持大写、小写甚至是大小写混合的,实在是太变态了,不过呢,在杰杰的提供例程中使用的CMake语法是小写的,全局变量是大写的,局部变量是小写!
section1
废话不多说,直接入门实战吧,写代码这东西还是要亲自动手去写采用意义~
文件夹目录结构如下:
jie@pc:~/github/cmake/section1$ tree
.
├── CMakeLists.txt
└── main.c
0 directories, 2 files
非常简单,也就是一个main.c文件与一个CMakeLists.txt文件,内容更是简单,main.c就只是打印个"Hello World!":
#include <stdio.h>
int main(void)
{
printf(“Hello World!\n”);
return 0;
}
CMakeLists.txt就是CMake最基础的3行代码:
CMake 最低版本号要求
cmake_minimum_required (VERSION 2.8)
项目信息
project (section1)
指定生成目标
add_executable(section1 main.c)
这样子可以在该目录下直接运行以下命令去编译(注意有一个 点.,表示CMakeLists.txt 所在的目录):
cmake .
编译输出信息如下:
jie@pc:~/github/cmake/section1$ cmake .
– The C compiler identification is GNU 7.4.0
– The CXX compiler identification is GNU 7.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
– Configuring done
– Generating done
– Build files have been written to: /home/jie/github/cmake/section1
然后你就会看到生成了一些其他文件文件以及一个Makefile文件:
jie@pc:~/github/cmake/section1$ ls
CMakeCache.txt CMakeFiles cmake_install.cmake CMakeLists.txt main.c Makefile
既然有Makefile文件那么就可以直接运行make命令去编译源码文件了,最后输出“Built target section1”表示编译成功!最终目录下会多出一个section1可执行文件,然后你运行它就能看到代码的执行效果了,直接打印输出"Hello World!"。
jie@pc:~/github/cmake/section1$ make
Scanning dependencies of target section1
[ 50%] Building C object CMakeFiles/section1.dir/main.c.o
[100%] Linking C executable section1
[100%] Built target section1
CMakeLists.txt分析
CMake 最低版本号要求
cmake_minimum_required (VERSION 2.8)
项目信息
project (section1)
指定生成目标
add_executable(section1 main.c)
其实上面的三句代码看起来像是函数,但并不是函数而是命令,它跟我们的在linux的命令差不多,反正就是指定CMake要怎么做的一系列命令。比如:
cmake_minimum_required:设置一个工程所需要的最低 CMake版本,如果 CMake的当前版本低于指定的版本,它会停止处理工程文件,并报告错误。
project:为整个工程设置一个工程名。
add_executable:使用给定的源文件,为工程引入一个可执行文件。
add_executable( [WIN32] [MACOSX_BUNDLE]
[EXCLUDE_FROM_ALL]
source1 [source2 …])
引入一个名字为的可执行目标,这个可执行目标会由调用该命令时在源文件列表中指定的源文件来构建,比如main.c就是一个源码文件。在工程范围内必须是全局唯一的,它实际上就是make编译后生成的可执行文件。
顺便再提一下语法,上面的代码呢,是必须填写的,然后也必须有一个源码文件source1,当然有可以有多个源码文件[source2 …]。
对了,# 后面的是注释,这根C语言中//表示注释是一样的!