如何编写一个CMakeLists.txt文件(由简到难,较详细)

在Linux系统下,经常使用CMakeLists.txt文件来链接、编译C++工程,大部分人clone的代码里都是有CMakeLists.txt文件的,只需要cmake ..make就完事了,但在工作中,你必须要有从无到有编写CMakeLists.txt文件的能力。

一、简单CMakeLists.txt文件的编写

1.先看文件目录

在这里插入图片描述
在repository4文件夹下存在好几个C++相关的文件和一个CMakeLIsts.txt文件,文件清单如下表:

文件(夹)名文件(夹)类型/用途
repository4工程文件夹
calc.h头文件,声明了几个函数定义
add.cpp/div.cpp/mult.cpp/sub.cpp头文件中声明的函数的实现
test_calc.cpp调用前面实现的几个函数
CMakeLists.txt编写此文件,用于此工程的链接和编译

以上除CMakeLists.txt文件以外的文件自己在保证调用、语法、功能正确的前提下随便编写。

2.编写CMakeLists.txt文件

(1)编写简单CMakeLists.txt文件的流程

设置cmake的最低版本要求
指定C++标准
设置项目名称
搜索文件夹中源文件
添加头文件路径
生成可执行文件

(2)编写简单CMakeLists.txt文件

cmake_minimum_required(VERSION 3.16)  #cmake最低版本要求,不得高于你计算机安装的版本set(CMAKE_CXX_STANDARD 11)  #指定C++标准project(test_calculate)  #设置项目名称“test_calculate”aux_source_directory(${PROJECT_SOURCE_DIR} SRC)  #添加源文件到变量SRC中,宏PROJECT_SOURCE_DIR指的是正在编写的CMakeLists.txt文件所在的文件夹include_directories(${PROJECT_SOURCE_DIR})  #制定头文件路径,${}符号是CMake语法中从变量取出变量的值的符号add_executable(test_cacl ${SRC})  #使用源文件生成可执行文件test_cacl,源文件的路径及名称位于SRC变量中

这是非常简单的一个CMakeLists.txt文件,仅用于新手了解cmake的体验装

3.建立build文件夹,运行CMakeLists.txt文件,测试文件是否编写正确

建立build文件夹是为了保证源码文件的整洁,链接、编译生成的文件均在build文件夹下。

mkdir build  #在repository4文件夹下执行此命令生成build文件夹
cd build  #进入build文件夹
cmake ..  #使用CMakeLists.txt文件链接项目
make  #编译项目 生成可执行文件
./test_calc  #在编译正确后,运行生成的可执行文件test_calc

运行截图如下
在这里插入图片描述

4.稍微改进一下,显得整齐点

上面文件夹的内容显得比较凌乱,对其进行整理,整理后的文件目录如下,文件内容不变
在这里插入图片描述
将函数实现的cpp文件放在src目录下,将头文件放在include目录下
对应的CMakeLists.txt文件的内容如下

cmake_minimum_required(VERSION 3.16)set(CMAKE_CXX_STANDARD 11)project(test_calculate)aux_source_directory(${PROJECT_SOURCE_DIR}/src SRC)  #修改include_directories(${PROJECT_SOURCE_DIR}/include)  #修改add_executable(test_cacl ${SRC} test_calc.cpp)  #修改

执行命令不变!

二、编写嵌套CMakeLists.txt文件

1.先看文件目录

在这里插入图片描述

在repository5文件夹下存在好几个C++相关的文件和一个CMakeLIsts.txt文件,文件清单如下表:

文件(夹)名文件夹中的文件文件(夹)类型/用途
repository5以下文件(夹)工程文件夹
build链接、编译产生的文件用于存放链接、编译时产生的文件
includecalc.h / convert.h头文件,声明了几个函数定义
calccalc.cpp / CMakeLists.txt头文件calc.h中声明的函数的实现
convconv.cpp / CMakeLists.txt头文件convert.h中声明的函数的实现
test_calctest_calc.cpp / CMakeLists.txt调用calc.cpp实现的几个函数
test_convtest_conv.cpp / CMakeLists.txt调用conv.cpp实现的几个函数
CMakeLists.txt编写此文件,用于此工程的链接和编译

这些文件总共生成两个可执行文件,一个是计算相关的calc,一个是转换大小写字母的conv,我们需要在实现头文件中声明的那些函数的源文件所在的文件夹调用头文件中函数的测试文件(main函数)所在的文件夹 以及 工程项目repository文件夹中创建CMakeLists.txt文件。
以上除CMakeLists.txt文件以外的文件自己在保证调用、语法、功能正确的前提下随便编写。

2.编写嵌套CMakeLists.txt文件

(1)编写嵌套CMakeLists.txt文件的流程
在这里插入图片描述
(2)编写外层CMakeLists.txt文件

cmake_minimum_required(VERSION 3.16)
set(CMAKE_CXX_STANDARD 11)
project(test)#添加子文件夹
add_subdirectory(calc)
add_subdirectory(conv)
add_subdirectory(test_calc)
add_subdirectory(test_conv)

(3)编写内层CMakeLists.txt文件
a.编写calc文件夹中的CMakeLists.txt文件

cmake_minimum_required(VERSION 3.16)
set(CMAKE_CXX_STANDARD 11)
project(calc)aux_source_directory(./ SRC)  # ./=${PROJECT_SOURCE_DIR},在当前CMakeLists.txt所在文件夹(calc)中搜索源文件,并放置在SRC变量中
include_directories(../include)  #添加头文件路径,../表示上一层目录,../include即在上一层目录下的include中
add_library(calculate STATIC ${SRC})  #取出SRC变量的值,生成一个名为calculate的静态库

b.编写test_calc文件夹中的CMakeLists.txt文件

cmake_minimum_required(VERSION 3.16)
set(CMAKE_CXX_STANDARD 11)
project(calculator)
aux_source_directory(./ SRC)
include_directories(../include)link_libraries(calculate)  #链接生成的静态库
add_executable(calculator ${SRC})  #生成名为calculator的可执行文件

与calc相关的CMakeLists.txt就写好了

c.剩下的两个与conv相关的CMakeLists.txt文件其实与上面两个编写是一样的,只是更改一下相关名称而已,其内容如下:
conv文件夹中的CMakeLists.txt:

cmake_minimum_required(VERSION 3.16)
set(CMAKE_CXX_STANDARD 11)
project(conv)aux_source_directory(./ SRC)
include_directories(../include)
add_library(convert STATIC ${SRC})

test_conv文件夹中的CMakeLists.txt:

cmake_minimum_required(VERSION 3.16)
set(CMAKE_CXX_STANDARD 11)
project(convertor)
aux_source_directory(./ SRC)
include_directories(../include)
link_libraries(convert)
add_executable(convertor ${SRC})

3.在项目文件夹下创建build文件夹,测试刚才编写的CMakeLists.txt文件

mkdir build
cd build
cmake ..
make
./test_conv/convertor

在这里插入图片描述

4. 同样改进一下,指定一下生成的库、可执行文件的存放目录

(1)在外层CMakeLists.txt文件中定义要存放生成的库、可执行文件的变量以及路径

set(LIBPATH ${PROJECT_SOURCE_DIR}/lib)  #设置生成库的路径,并放置在变量LIBPATH中
set(EXEPATH ${PROJECT_SOURCE_DIR}/bin)  #设置可执行文件的路径,并放置在变量EXEPATH中
#文件夹bin和lib会自动生成

(2)在内层CMakeLists.txt文件中使用上面两个全局变量LIBPATHEXEPATH

set(LIBRARY_OUTPUT_PATH ${LIBPATH})  #设置库的生成目录,在calc和conv文件夹下的CMakeLists.txt中添加
link_directories(../lib)  #设置要链接的库的目录,在test_calc和test_conv文件夹下的CMakeLists.txt中添加
set(EXECUTABLE_OUTPUT_PATH ${EXEPATH})  #设置可执行文件的生成目录,在test_calc和test_conv文件夹下的CMakeLists.txt中添加

(3)添加后在当前工程的build路径下执行以下命令来测试CMakeLists.txt文件

cmake ..
make
../bin/convertor  #当前在build文件夹中,bin文件夹和build并列,因此需要../

在这里插入图片描述

三、cmake常用函数

1.基础命令

命令功能备注
#单行注释
#[ [ ] ]块注释
${ }从变量或宏中取出其值例如:${PROJECT_SOURCE_DIR}
cmake_minimum_required(VERSION 3.0)指定使用的 cmake 的最低版本非必须,如果不加可能会有警告
project()定义工程名称,并可指定工程的版本、工程描述、web主页地址、支持的语言如果不需要这些都是可以忽略的,只需要指定出工程名字即可
add_executable(可执行程序名 源文件名称)使用后面的源文件生成可执行程序源文件名可以是一个也可以是多个,如有多个可用空格或;间隔
set(VAR [value]将[value]存入变量VAR中[value]可以是多个,空格或;间隔
set(CMAKE_CXX_STANDARD 11)设置C++的标准CMAKE_CXX_STANDARD是预定义的宏
aux_source_directory(< dir > < variable >)dir:要搜索的目录,variable:将从dir目录下搜索到的源文件列表存储到该变量中
file(GLOB/GLOB_RECURSE 变量名 要搜索的文件路径和文件类型)GLOB: 将指定目录下搜索到的满足条件的所有文件名生成一个列表,并将其存储到变量中,GLOB_RECURSE:递归搜索指定目录,将搜索到的满足条件的文件名生成一个列表,并将其存储到变量中GLOB与GLOB_RECURSE 二选一
include_directories(headpath)添加含头文件路径headpath:头文件路径
add_library(库名称 STATIC/SHARED 源文件1 [源文件2] …)使用源文件生成库STATIC:静态库,SHARED:动态库

2.包含库文件

link_libraries(<static lib> [<static lib>...])

参数1:指定出要链接的第一个静态库的名字,可以是全名 libxxx.a,也可以是掐头(lib)去尾(.a)之后的名字 xxx;
参数2-N:要链接的其它静态库的名字(根据实际情况是否需要);
如果该静态库不是系统提供的(自己制作或者使用第三方提供的静态库)可能出现静态库找不到的情况,此时可以将静态库的路径也指定出来:

link_directories(<lib path>)

在cmake中链接动态库的命令如下:

target_link_libraries(<target> <PRIVATE|PUBLIC|INTERFACE> <item>... [<PRIVATE|PUBLIC|INTERFACE> <item>...]...)

target:指定要加载的库的文件的名字:该文件可能是一个源文件、一个动态库/静态库文件、一个可执行文件
PRIVATE|PUBLIC|INTERFACE:动态库的访问权限,默认为PUBLIC
如果各个动态库之间没有依赖关系,无需做任何设置,三者没有没有区别,一般无需指定,使用默认的 PUBLIC 即可,动态库的链接具有传递性,如果动态库 A 链接了动态库B、C,动态库D链接了动态库A,此时动态库D相当于也链接了动态库B、C,并可以使用动态库B、C中定义的方法。

3.日志

message([STATUS|WARNING|AUTHOR_WARNING|FATAL_ERROR|SEND_ERROR] "message to display" ...)

(无) :重要消息
STATUS :非重要消息
WARNING:CMake 警告, 会继续执行
AUTHOR_WARNING:CMake 警告 (dev), 会继续执行
SEND_ERROR:CMake 错误, 继续执行,但是会跳过生成的步骤
FATAL_ERROR:CMake 错误, 终止所有处理过程
例如:

# 输出一般日志信息
message(STATUS "source path: ${PROJECT_SOURCE_DIR}")
# 输出警告信息
message(WARNING "source path: ${PROJECT_SOURCE_DIR}")
# 输出错误信息
message(FATAL_ERROR "source path: ${PROJECT_SOURCE_DIR}")

4.变量操作

命令功能
set(变量名1 ${变量名1} ${变量名2} …)将从第二个参数开始往后所有的字符串进行拼接,结果覆盖写入到第一个参数中
list(APPEND < list> [< element> …])APPEND表示进行数据追加,后边的参数和set就一样了
list(REMOVE_ITEM < list> < value>)从list中移除后面的value
list(LENGTH < list> < outputvariable>)获取 list 的长度,< output variable>:新创建的变量,用于存储列表的长度
list(GET < list> < element index> < output variable>)读取列表中指定索引的的元素,可以指定多个索引
list (JOIN < list> < glue> < output variable>)将列表中的元素用连接符(glue)连接起来组成一个字符串
list(FIND < list> < value> < output variable>)查找列表是否存在指定的元素,若果未找到,返回-1
list(INSERT < list> < element_index> < element> [< element> …])在list中指定的位置插入若干元素
list (PREPEND < list> [< element> …])将元素插入到列表的0索引位置
list (POP_BACK < list> [< out-var>…])将列表中最后元素移除
list (POP_FRONT < list> [< out-var>…])将列表中首元素移除
list (REMOVE_ITEM < list> < value> [< value> …])将指定的元素从列表中移除
list (REMOVE_AT < list> < index> [< index> …])将指定索引的元素从列表中移除
list (REMOVE_DUPLICATES < list>)移除列表中的重复元素
list(REVERSE < list>)列表翻转

列表排序

list (SORT <list> [COMPARE <compare>] [CASE <case>] [ORDER <order>])
/*
COMPARE:指定排序方法。有如下几种值可选:STRING:按照字母顺序进行排序,为默认的排序方法FILE_BASENAME:如果是一系列路径名,会使用basename进行排序NATURAL:使用自然数顺序排序
CASE:指明是否大小写敏感。有如下几种值可选:SENSITIVE: 按照大小写敏感的方式进行排序,为默认值INSENSITIVE:按照大小写不敏感方式进行排序
ORDER:指明排序的顺序。有如下几种值可选:ASCENDING:按照升序排列,为默认值DESCENDING:按照降序排列
*/

5.宏定义

在进行程序测试的时候,我们可以在代码中添加一些宏定义,通过这些宏来控制这些代码是否生效,如下所示:

#include <stdio.h>
#define NUMBER  3int main()
{int a = 10;
#ifdef DEBUGprintf("我是一个程序猿, 我不会爬树...\n");
#endiffor(int i=0; i<NUMBER; ++i){printf("hello, GCC!!!\n");}return 0;
}

在程序的第七行对DEBUG宏进行了判断,如果该宏被定义了,那么第八行就会进行日志输出,如果没有定义这个宏,第八行就相当于被注释掉了,因此最终无法看到日志输入出(上述代码中并没有定义这个宏)。
为了让测试更灵活,我们可以不在代码中定义这个宏,而是在测试的时候去把它定义出来,其中一种方式就是在gcc/g++命令中去指定,如下:

gcc test.c -DDEBUG -o app

在gcc/g++命令中通过参数 -D指定出要定义的宏的名字,这样就相当于在代码中定义了一个宏,其名字DEBUG
在CMake中我们也可以做类似的事情,对应的命令叫做add_definitions():

add_definitions(-D宏名称)//针对上面的例子在对应CMakeLists.txt文件中写这句就等于gcc test.c -DDEBUG -o app
//add_definitions(-DDEBUG)

下面的列表中为大家整理了一些CMake中常用的宏:

功能
PROJECT_SOURCE_DIR使用cmake命令后紧跟的目录,一般是工程的根目录
PROJECT_BINARY_DIR执行cmake命令的目录
CMAKE_CURRENT_SOURCE_DIR当前处理的CMakeLists.txt所在的路径
CMAKE_CURRENT_BINARY_DIRtarget 编译目录
EXECUTABLE_OUTPUT_PATH重新定义目标二进制可执行文件的存放位置
LIBRARY_OUTPUT_PATH重新定义目标链接库文件的存放位置
PROJECT_NAME返回通过PROJECT指令定义的项目名称
CMAKE_BINARY_DIR项目实际构建路径,假设在build目录进行的构建,那么得到的就是这个目录的路径

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.rhkb.cn/news/400289.html

如若内容造成侵权/违法违规/事实不符,请联系长河编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

【QGroundControl二次开发】十. QT添加GStreamer视频播放同时保存

上一章介绍使用QT播放GStreamer视频流 【QGroundControl二次开发】八. QT实现播放gstreamer视频。 这章介绍如何在原有基础上保存为视频&#xff0c;同时保存为一个个规定大小的小视频。 一. 思想 之前的文章展示了如何在QT中播放GST视频流&#xff0c;这章在原有的基础上增加…

金九银十,软件测试面试题合集(含答案)

前言 前面看到了一些面试题&#xff0c;总感觉会用得到&#xff0c;但是看一遍又记不住&#xff0c;所以我把面试题都整合在一起&#xff0c;都是来自各路大佬的分享&#xff0c;为了方便以后自己需要的时候刷一刷&#xff0c;不用再到处找题&#xff0c;今天把自己整理的这些…

常见的几种用例测试方法

等价类划分法 适用场景&#xff1a;需要有大量的测试数据输入&#xff0c;但是我们实际测试中不可能一一列举进行测试&#xff0c;所以讲数据进行分类&#xff0c;选出具有代表性的数据代表一类数据进行测试。 分类&#xff1a; 有效等价类&#xff1a;满足需求的数据无效等…

普元EOS-新项目不停提示登录信息已过期

1 问题 新创建的EOS精简应用&#xff0c; 项目端口为 28015 启动后&#xff0c;在浏览器输入地址 http://127.0.0.1:28015 。 页面不停提示 “登录信息已过期” 2 解决办法 EOS的项目对Login-Filter的配置错误&#xff0c; EOS的项目在Http安全过滤管理的时候&#xff0c;会…

【原创】java+swing+mysql商品信息管理系统设计与实现

个人主页&#xff1a;程序员杨工 个人简介&#xff1a;从事软件开发多年&#xff0c;前后端均有涉猎&#xff0c;具有丰富的开发经验 博客内容&#xff1a;全栈开发&#xff0c;分享Java、Python、Php、小程序、前后端、数据库经验和实战 开发背景&#xff1a; 使用javaswing技…

使用mybatis注解和xml映射执行javaWeb中增删改查等操作

Mapper接口 使用注解执行SQL语句操作和相应的Java抽象类&#xff08;对于简单的增删改查使用注解&#xff09; Mapper public interface EmpMapper {// 根据id删除员工信息Delete("delete from mybatis.emp where id#{id}")public int EmpDelete(Integer id);// 查…

【mysql 第一篇章】系统和数据库的交互方法

一、宏观的查看系统怎么和数据库交互 在我们刚刚接触系统和数据库的时候不明白其中的原理&#xff0c;只知道系统和数据库是需要交互的。所以我们会理解成上图的形式。 二、MYSQL 驱动 随着我们的学习时间的加长以及对程序的了解&#xff0c;发现链接数据库是需要有别的工具辅…

可乐机的设计验证

前言 状态机&#xff08;State Machine&#xff09;是一种数学模型&#xff0c;用于表示具有有限状态集合的系统。它通过定义状态、转移规则和事件&#xff0c;描述系统在不同条件下的行为。状态机的核心概念包括状态、事件、转移和动作。状态是系统的具体条件或配置&#xff0…

【Python】函数入门(下)

3&#xff09;&#xff09;* ** ​​​​​​注意&#xff1a;也遵循位置传参在前面&#xff0c;按关键字传参在后面。 代码示例&#xff1a; def func(*args,**kwargs):print(args,kwargs) 该函数中的参数会自动根据传参的方式不同&#xff08;即&#xff1a;按位置…

k8s 四种Service类型(ClusterIP、NodePort、LoadBalancer、ExternalName)详解

&#x1f407;明明跟你说过&#xff1a;个人主页 &#x1f3c5;个人专栏&#xff1a;《Kubernetes航线图&#xff1a;从船长到K8s掌舵者》 &#x1f3c5; &#x1f516;行路有良友&#xff0c;便是天堂&#x1f516; 目录 一、引言 1、k8s概述 2、Service在Kubernetes中的…

【Redis】事务

目录 什么是事务 事务操作 MULTI EXEC DISCARD WATCH UNWATCH 什么是事务 Redis 的事务和 MySQL 的事务概念上是类似的. 都是把⼀系列操作绑定成⼀组. 让这⼀组能够批量执⾏. 但是注意体会 Redis 的事务和 MySQL 事务的区别: 弱化的原⼦性: redis 没有 "回滚机制…

Zabbix自动导出PDF报告

zabbix6提供了定时导出PDF报告功能。此功能可按照Dashboard维度&#xff0c;定时自动导出报告&#xff0c;并通过邮件发送。 1.安装 zabbix 提供了官方的rhel8版本的rpm包&#xff0c;可使用yum方式安装&#xff0c;zabbix自动导出PDF功能是基于go环境的zabbix web service程…

C语言 ——— 在杨氏矩阵中查找具体的某个数

目录 何为杨氏矩阵 题目要求 代码实现 何为杨氏矩阵 可以把杨氏矩阵理解为一个二维数组&#xff0c;这个二维数组中的每一行从左到右是递增的&#xff0c;每一列从上到下是递增的 题目要求 在杨氏矩阵中查找具体的某个数 要求&#xff1a;时间复杂度小于O(N) 代码实现…

如何定义和引用二维数组

一.二维数组 常称为矩阵&#xff0c;把二维数组写成行和列的排列形式。、 二.怎么定义二维数组 float pay[3][5]; 以上定义了一个float型的二维数组&#xff0c;第1维有3个元素&#xff0c;第2维有6个元素。每一维的长度分别用一对方括号括起来。 二维数组定义的一般形式为 …

基于STM32开发的智能家居照明控制系统

目录 引言环境准备工作 硬件准备软件安装与配置系统设计 系统架构硬件连接代码实现 初始化代码控制代码应用场景 家庭照明自动化节能照明管理常见问题及解决方案 常见问题解决方案结论 1. 引言 智能家居照明控制系统通过整合各种传感器和控制器&#xff0c;能够实现对家居照…

基于ICMP(Ping)的多线程网络通道监视程序(QT)开发

基于ICMP(Ping)的多线程网络通道监视程序(QT)开发 1、 ICMP原理简介 可参考 ICMP(Ping)功能原理及其C实现简介 。 2、 网络通道监视程序开发 设计原理&#xff1a; 通过PING 功能实现服务器、交换机、网闸等设备的网络检测&#xff0c;判断网络的否可达和TTL计算 。 具备功…

【应用层协议】自定义协议 {定义结构化数据;数据格式转换:序列化和反序列化,使用json库进行数据格式交换;分包和解包:为报文内容添加报头}

一、简单了解TCP协议&#xff08;引子&#xff09; 1.1 三次握手 三次握手就是客户端向服务端发起连接的过程 服务器初始化 调用socket&#xff0c;创建套接字文件 调用bind&#xff0c;将当前的文件描述符和ip/port绑定在一起&#xff1b;如果这个端口已经被其他进程占用了&…

外贸12年,通过6个方法,成交几千万订单

做外贸有12个年头了&#xff0c;各种各样的方法都有试过&#xff0c;我成交的这几千万订单&#xff0c;大部分都是通过这6个方法来的&#xff0c;下面我来给大家整理分享一下。 1.谷歌搜索 谷歌搜索算是做外贸入门级的基础技能了&#xff0c;要做好外贸&#xff0c;这个技能一…

86.小米相机修改拍照(尺寸,画幅,比例)的方法

目录 1.打开相机&#xff0c;拍照模式&#xff0c;上面有个箭头或三个点&#xff0c;点击 2.点击画幅 3.点击你想要的画幅即可。 想要修改手机照片的&#xff08;尺寸&#xff0c;画幅&#xff0c;比例&#xff09;时&#xff0c;总会去找分辨率&#xff0c;其实并不是&…

Leetcode - 周赛410

目录 一&#xff0c;3248. 矩阵中的蛇 二&#xff0c;3249. 统计好节点的数目 三&#xff0c;3250. 单调数组对的数目 I dfs记忆化 dfs记忆化1&#xff1a;1改递推 四&#xff0c;3251. 单调数组对的数目 II 一&#xff0c;3248. 矩阵中的蛇 本题就是一道纯模拟题&#x…