一. cmake有什么用?
可自行百度,简单理解就是跨平台编译
复杂工程代码之间的调用关系复杂而严格,如果我想在这样复杂的框架下进行二次开发,显然只拥有它的源码是远远不够的,还需要清楚的明白这几十个项目之间的复杂关系,在没有原作者的帮助下进行这项工作几乎是不可能的。
即使是原作者给出了相关的结构文档,对新手来说建立工程的过程依旧是漫长而艰辛的,因此CMake的作用就凸显出来了。原作者只需要生成一份CMakeLists.txt文档,框架的使用者们只需要在下载源码的同时下载作者提供的CMakeLists.txt,就可以利用CMake,在”原作者的帮助下“进行工程的搭建。
所以CMakeLists的作用就是告诉你这些源码之间的关系,也就是如何通过CMakeLists将这些源码搭建成一个工程,而那些ide其实就是根据CMakeLists来搭建工程的,比如我们熟悉的qtcreator(还记得用qt搭建px4的开发环境时就是先载入这个CMakeLists)。
而cmake的作用就是按照CMakeLists去执行编译的工具。但要注意,cmake这个命令不是用来执行编译,而是用来执行CMakeLists构建工程,得到makefile文件夹,这个文件夹存放的是编译规则,接下来就需要使用make命令编译这个makefile文件夹
二. 先从一个简单例子开始
1.先新建了一个文件夹(cmake-learning),在该文件夹下新建两个文件(main.cpp和CMakeLists.txt)和一个新的文件夹(build)。
2.在CMakeLists.txt中写入
PROJECT(test)
ADD_EXECUTABLE(mytest ./main.cpp)
3.在main.cpp中写入
#include "stdio.h"
int main(){
printf("6666666\n");
return 0;
}
4.执行以下命令
cd ~/cmake-learning/build //必须要进入该文件夹下,否则由cmake产生的文件不在里面。
cmake .. //cmake的作用不是编译,而是用来CMakeList.txt文件生成makefile的。并且cmake 后面要有.. ,build文件夹下什么都没有,光cmake当然不行。..用来指出 CMakeList.txt 所在的位置
5.在bulid目录下执行tree命令,可看到一个makefile文件, makefile关系到了整个工程的编译规则。。接下来我们就需要去执行这个makefile文件,在bulid下用命令make即可。此时ls后可以看到有一个mytest的可执行文件。
6.最后执行这个mytest文件即可。
./mytest
细节补充(高手忽略):
1.gedit 文件名--------用来创建文件并编写
2.touch 文件名 -------创建文件
3.mkdir 文件夹名字 ---------创建文件夹
4.这个文件夹的名字叫CMakeLists.txt,注意复数和大小写
5.CMakeLists.txt中的命令大小写随意。
6. ./文件名 命令可以直接运行该目录下的文件
7.注意:CMakeList.txt 文件中,命令名字是不区分大小写的,而参数和变量是大小写相关的。
三.分析CmakeLists.txt文件
1.cmake是通过解析CMakeLists.txt脚本来生成项目需要的编译文件的。它可以生成多种不同类型的编译文件如makeflie、ninja等;
2.CMakeLists.txt的编写依赖大量cmake提供的函数或者宏,如PROJECT、SET等,只要掌握了这些宏的含义,就可以读懂CMakeLists.txt,从而了解工程的结构。
3.cmake中常用的函数或宏
这些都是cmake提供好的,可以直接在CMakeLists.txt中使用,他们看起来就像是C语言的宏或者函数
PROJECT(工程名字)
这条指令会自动创建两个变量:
project name>_BINARY_DIR(二进制文件保存路径) project name>_SOURCE_DIR(源代码路径)
Cmake 系统也帮助我们预定义了 PROJECT_BINARY_DIR和PROJECT_SOURCE_DIR其值与上述对应相等
set(变量名 变量值)
SET(VAR [VALUE] [CACHE TYPEDOCSTRING [FORCE]])
SET(SRC_LIST main.c t1.c t2.c):即SPC_LIST代表main.c t1.c t2.c
SET(SRC_LIST main.c):同上
include
用法:include(file or module)
例如:include(test.cmake)
说明:与c语言的include类似
include_directories
用法:include_directories(dir1 dir2 ……)
例如:include_directories(“…/my/include” “…/my/include2”)
说明:用于在现有头文件搜索路径后面增加搜索路径
target_link_libraries
用法:target_link_libraries( target lib1 lib2 ……)
例如:target_linke_libraries(test libmy.so)
说明:target参数一般是add_excutable中指定的程序名
PROJECT_SOURCE_DIR
说明:这是cmake预定义号的一个宏,表示工程的根目录,可以直接使用(即源代码路径)
link_directories
说明:增加动态链接库的搜索路径,需要注意的是必须使用绝对路径。(相对路径其实也有办法用,但需要更多的配置,麻烦)
find_package
说明:当无法定位库的具体位置时,可以使用此命令进行查询。利用命令:cmake –help-module-list 和 cmake –help-module 来获取帮助信息。
例如:find_package(GTK2)
ADD_EXECUTABLE(生成的可执行文件名 生成该可执行文件的源文件)
ADD_EXECUTABLE(hello
S
R
C
L
I
S
T
)
:
通
过
{SRC_LIST}):通过
SRCLIST):通过{SRC_LIST}生成hello的可执行文件
MESSAGE(消息类型 消息内容)
MESSAGE([SEND_ERROR | STATUS| FATAL_ERROR] “message to display”)