cmake入门教程 跨平台项目构建工具cmake介绍
创始人
2024-02-18 01:29:48

一.初识cmake

在介绍cmake之前,我们先来从工具一个个衍生出来,做过linux c/c++编程的时候一般用过gcc指令或者makefile。我们先来介绍下

gcc(GNU Compiler Collection)将源文件编译(Compile)成可执行文件或者库文件;

而当需要编译的东西很多时,需要说明先编译什么,后编译什么,这个过程称为构建(Build)。常用的工具是make,对应的定义构建过程的文件为Makefile

而编写Makefile对于大型项目又比较复杂,通过CMake就可以使用更加简洁的语法定义构建的流程,CMake定义构建过程的文件为CMakeLists.txt

gcc/make/cmake的关系如下,三个工具就是蓝色框框

二.cmake工具介绍

cmake的安装命令如下:

sudo apt install cmake

CMake提供cmake、ctest和cpack三个命令行工具分别负责构建、测试和打包。本文主要介绍cmake命令。

使用cmake一般流程为:

  • 生成构建系统(buildsystem,比如make工具对应的Makefile);
  • 执行构建(比如make),生成目标文件;
  • 执行测试、安装或打包。

1 .生成构建系统

通过cmake命令生成构建系统。

通过cmake --help可以看到cmake命令支持的详细参数,常用的参数如下:

参数

含义

-S

指定源文件根目录,必须包含一个CMakeLists.txt文件

-B

指定构建目录,构建生成的中间文件和目标文件的生成路径

-D

指定变量,格式为-D =,-D后面的空格可以省略

比如,指明使用当前目录作为源文件目录,其中包含CMakeLists.txt文件;使用build目录作为构建目录;设定变量CMAKE_BUILD_TYPE的值为Debug,变量AUTHOR的值为RealCoolEngineer:

cmake -S . -B build -DCMAKE_BUILD_TYPE=Debug -DAUTHOR=RealCoolEngineer

使用-D设置的变量在CMakeLists.txt中生效,可以设置cmake的内置支持的一些变量控制构建的行为;当然也可以使用自定义的变量,在CMakeLists.txt中自行判断做不同的处理。

2 .执行构建

使用cmake --build [

| --preset ]执行构建。

这里要指定的目录就是生成构建系统时指定的构建目录。常用的参数如下:

参数

含义

--target

指定构建目标代替默认的构建目标,可以指定多个

--parallel/-j []

指定构建目标时使用的进程数

在这一步,如果使用的是make构建工具,则可以在构建目录下直接使用make命令。

三.cmake使用方法

1.简单的一个cmake应用

此实验我们从一个cmake的简单编写/编译/执行做起,最后再讲解内部的原理,语法,一步步带入

1.1 程序源文件

首先先写一个main.c的源文件,实现很简单,就是打印一个hello cmake

#include int main()
{printf("Hello cmake\r\n");return 0;
}

1.2 cmake编译文件编写

然后我们再写一个CMakeLists.txt,内容如下:

PROJECT(HELLO)
ADD_EXECUTABLE(hello main.c)

这里有几个点需要重点强调下

1)CMakeLists.txt 这个文件名称不能修改,这个一个约定俗成的规则,所以不用纠结cmake里面怎么实现的,如果你没有这个文件,敲cmake编译的时候回提示这个错误

2)PROJECT指令的作用,定义工程名称,并可制订工程支持的语言,默认支持所有语言。此指令隐式的定义了两个变量 PROJECT_BINARY_DIR 和 PROJECT_SOURCE_DIR

语法如下:

PROJECT(projectname [CXX] [C] [Java])

# 例:PROJECT(HELLO)

3)ADD_EXECUTABLE指令的作用

定义工程会生成文件名为xx的可执行文件,相关的源文件是根据后面的源文件列表。

语法如下:

ADD_EXECUTABLE( ${SRC_LIST})

# 例:ADD_EXECUTABLE(hello ${SRC_LIST})

1.3 cmake编译

cmake的编译指令

cmake .

make

这里有几个重点需要强调下:

1)cmake后面的路径,这个是CMakeLists.txt 的路径

2)敲了cmake会生成什么?

这四个文件重点是Makefile,对,没错,cmake会自动帮我们生成makefile,我们后面敲make编译就能生成对应的可执行程序了!

1.4 编译引发的思考

可以这么多编译目录文件,我想让跟目录变的单纯点有什么办法呢?

我们可以创建一个build目录,然后进入build目录敲

cmake ..

make

可以看到所有的cmake的生成的文件都在build目录下,放跟目录很清洁

2.多文件cmake的应用

2.1 C语言源文件

在小节1的接触上,我们现在写两个.c文件,分别是main.c test.c

#include 
extern int test()int main()
{printf("Hello cmake 002\r\n");test();return 0;
}
#include int test()
{printf("This is test func\r\n");return 0;
}

很简单哈,就是test.c定义一个函数test,然后在main.c中调用

2.2 CMakeLists.txt文件

PROJECT(HELLO)
ADD_EXECUTABLE(hello main.c test.c)

很简单,我们就在实例1的基础上增加了一个test.c

2.3 编译运行

cmake .

make

2.4 引发思考

问题1:现在两个文件可以通过ADD_EXECUTABLE(hello main.c test.c) 这种方式一个个文件添加,但是如果是大型工程呢?这里可以通过两种方法来进行管理

1)通过引入变量自己通过变量来管理源文件,使管理更清晰

2)通过通配符来进行匹配,增加文件不需要再手动更改CMakeLists.txt

下面我们就来一一介绍下

1)通过引入变量自己通过变量来管理源文件,使管理更清晰

这种方式比较简单,就是引入了一个定义变量的概念,CMakeLists.txt实现如下:

PROJECT(HELLO)
SET(SRC_LIST main.c test.c)
ADD_EXECUTABLE(hello ${SRC_LIST})

先介绍下SET语法复制变量跟取值变量的语法

SET指令可以用来显示的定义变量即可

SET(VAR [VALUE] [CACHE TYPE DOCSTRING [FORCE]])

其中VAR就是变量名称 VALUE就是变量的值

使用${}方式来取得变量中的值,而在IF语句中则直接使用变量名。

懂了这个语法再看上面的CMakeLists.txt应该就没有难度了吧

2)通过通配符来进行匹配,增加文件不需要再手动更改CMakeLists.txt

PROJECT(HELLO)
file(GLOB SRC_LIST "./*.c")
ADD_EXECUTABLE(hello ${SRC_LIST})

问题2:不同的路径下多文件怎么管理?

假设现在有3个路径test1 test2 test3,分别里面有test1.c test2.c test.3,目录结构如下:

现在我们有两种方法去管理:

1)沿用之前的思路,暴力写CMakeLists.txt

2)增加子文件夹CMakeLists.txt的例子

我们首先来看下第一种方法

1)沿用之前的思路,暴力写CMakeLists.txt

PROJECT(HELLO)
SET(SRC_LIST main.c ./test1/test1.c./test2/test2.c./test3/test3.c)
ADD_EXECUTABLE(hello ${SRC_LIST})

这种方法感觉没有引入什么新的概念,所以一看就懂了·,不需要多多重复

2)通过静态库的方式链接

整个文件夹目录为:

其中顶层的CMakeLists.txt为

cmake_minimum_required(VERSION 3.25)
PROJECT(HELLO)
ADD_SUBDIRECTORY("test1")
ADD_SUBDIRECTORY("test2")
ADD_SUBDIRECTORY("test3")SET(STATIC_LIBRARIES test1	test2test3
)ADD_EXECUTABLE(hello main.c)
TARGET_LINK_LIBRARIES(hello ${STATIC_LIBRARIES})

整个设计实现为就是增加3个子集文件夹test1/test2/test3

然后编译的时候main.c编译为hello,并且把test1.a test2.a test3.a链接到hello中

test1的CMakeLists.txt为

cmake_minimum_required(VERSION 3.25)PROJECT("test1")
SET(TEST_NAME "test1")
file(GLOB TEST1_SRC_LIST "./*.c")
add_library(${TEST_NAME} STATIC ${TEST1_SRC_LIST})

整个设计思路就是把test1目录下的所有.c链接为test1.a

test2的CMakeLists.txt为

cmake_minimum_required(VERSION 3.25)PROJECT("test2")
SET(TEST_NAME "test2")
file(GLOB TEST1_SRC_LIST "./*.c")
add_library(${TEST_NAME} STATIC ${TEST1_SRC_LIST})

整个设计思路就是把test2目录下的所有.c链接为test2.a

test3的CMakeLists.txt为

cmake_minimum_required(VERSION 3.25)PROJECT("test3")
SET(TEST_NAME "test3")
file(GLOB TEST1_SRC_LIST "./*.c")
add_library(${TEST_NAME} STATIC ${TEST1_SRC_LIST})

整个设计思路就是把test3目录下的所有.c链接为test3.a

里面有几个新的概念在里面:

1)增加子文件夹命令ADD_SUBDIRECTORY ,这个命令是增加子目录,也就是cmake会自动进入这个目录寻找子集CMakeLists.txt

2)ADD_LIBRAY 是把某一个source file打包成一个库

SHARED 动态库
STATIC 静态库
MODULE 在使用dyld的系统有效,如果不支持dyld,则被当做SHARED对待。
EXCLUDE_FROM_ALL参数的意思是这个不会被默认构建,除非有其他的组件依赖或者手工构建。

3)TARGET_LINK_LIBRARIES 增加link文件

3.头文件引用

首先我们来看下文件的目录为:

其中根目录下有main.c test1.c 以及有一个cmake的编译文件,另外还有inc文件夹下有test1.h的头文件夹

其中main.c的源码为:

#include 
#include "test1.h"int main()
{printf("Hello cmake 005\r\n");test1();return 0;
}

其中test.c的源码为:

#include int test1()
{printf("This is test1 func\r\n");return 0;
}

其中test1.h的源码为

#ifndef TEST1_H_H_H
#define TEST1_H_H_Hint test1();#endif

其中CMakeLists.txt的文件为:

cmake_minimum_required(VERSION 3.25)
PROJECT(HELLO)INCLUDE_DIRECTORIES(./inc)
ADD_EXECUTABLE(hello main.c test1.c)

新的内容只有这一块,主要是INCLUDE_DIRECTORIES,这个命令就是增加头文件include的目录的

相关内容

热门资讯

埃菲尔铁塔在哪 中国仿建埃菲尔... 2019年4月26日,广西南宁市,街头惊现一座巨型山寨版埃菲尔铁塔,高约20米,白色塔身,造型逼真,...
苗族的传统节日 贵州苗族节日有... 【岜沙苗族芦笙节】岜沙,苗语叫“分送”,距从江县城7.5公里,是世界上最崇拜树木并以树为神的枪手部落...
北京的名胜古迹 北京最著名的景... 北京从元代开始,逐渐走上帝国首都的道路,先是成为大辽朝五大首都之一的南京城,随着金灭辽,金代从海陵王...
应用未安装解决办法 平板应用未... ---IT小技术,每天Get一个小技能!一、前言描述苹果IPad2居然不能安装怎么办?与此IPad不...
脚上的穴位图 脚面经络图对应的... 人体穴位作用图解大全更清晰直观的标注了各个人体穴位的作用,包括头部穴位图、胸部穴位图、背部穴位图、胳...
长白山自助游攻略 吉林长白山游... 昨天介绍了西坡的景点详细请看链接:一个人的旅行,据说能看到长白山天池全凭运气,您的运气如何?今日介绍...
demo什么意思 demo版本... 618快到了,各位的小金库大概也在准备开闸放水了吧。没有小金库的,也该向老婆撒娇卖萌服个软了,一切只...
猫咪吃了塑料袋怎么办 猫咪误食... 你知道吗?塑料袋放久了会长猫哦!要说猫咪对塑料袋的喜爱程度完完全全可以媲美纸箱家里只要一有塑料袋的响...
世界上最漂亮的人 世界上最漂亮... 此前在某网上,选出了全球265万颜值姣好的女性。从这些数量庞大的女性群体中,人们投票选出了心目中最美...
埃菲尔铁塔在哪 中国仿建埃菲尔... 2019年4月26日,广西南宁市,街头惊现一座巨型山寨版埃菲尔铁塔,高约20米,白色塔身,造型逼真,...
苗族的传统节日 贵州苗族节日有... 【岜沙苗族芦笙节】岜沙,苗语叫“分送”,距从江县城7.5公里,是世界上最崇拜树木并以树为神的枪手部落...
北京的名胜古迹 北京最著名的景... 北京从元代开始,逐渐走上帝国首都的道路,先是成为大辽朝五大首都之一的南京城,随着金灭辽,金代从海陵王...
长白山自助游攻略 吉林长白山游... 昨天介绍了西坡的景点详细请看链接:一个人的旅行,据说能看到长白山天池全凭运气,您的运气如何?今日介绍...