超傻瓜式CMakeLists.txt手把手教程:附带实例源码,轻松入门CMake构建工具
csdn 2023-12-05

新手写CMakeLists.txt简直就是实力劝退,各种命令让很多人头大,如何写一个最基础的CMakeLists.txt呢?本文从一个实例出发,教你编写的基本流程。


CMakeLists.txt的基本结构

编写CMakeLists.txt最常用的功能就是调用其他的.h头文件和.so/.a库文件,将.cpp/.c/.cc文件编译成可执行文件或者新的库文件

命令的官方网站:CMake Reference Documentation

最常用的命令如下(仅供后期查询,初期不需要细看):

# 本CMakeLists.txt的project名称
# 会自动创建两个变量,PROJECT_SOURCE_DIR和PROJECT_NAME
# ${PROJECT_SOURCE_DIR}:本CMakeLists.txt所在的文件夹路径
# ${PROJECT_NAME}:本CMakeLists.txt的project名称
project(xxx)

# 获取路径下所有的.cpp/.c/.cc文件,并赋值给变量中
aux_source_directory(路径 变量)

# 给文件名/路径名或其他字符串起别名,用${变量}获取变量内容
set(变量 文件名/路径/...)

# 添加编译选项
add_definitions(编译选项)

# 打印消息
message(消息)

# 编译子文件夹的CMakeLists.txt
add_subdirectory(子文件夹名称)

# 将.cpp/.c/.cc文件生成.a静态库
# 注意,库文件名称通常为libxxx.so,在这里只要写xxx即可
add_library(库文件名称 STATIC 文件)

# 将.cpp/.c/.cc文件生成可执行文件
add_executable(可执行文件名称 文件)

# 规定.h头文件路径
include_directories(路径)

# 规定.so/.a库文件路径
link_directories(路径)

# 对add_library或add_executable生成的文件进行链接操作
# 注意,库文件名称通常为libxxx.so,在这里只要写xxx即可
target_link_libraries(库文件名称/可执行文件名称 链接的库文件名称)

通常一个CMakeLists.txt需按照下面的流程

project(xxx)                                          #必须

add_subdirectory(子文件夹名称)                         #父目录必须,子目录不必

add_library(库文件名称 STATIC 文件)                    #通常子目录(二选一)
add_executable(可执行文件名称 文件)                     #通常父目录(二选一)

include_directories(路径)                              #必须
link_directories(路径)                                 #必须

target_link_libraries(库文件名称/可执行文件名称 链接的库文件名称)       #必须

除了这些之外,就是些set变量的语句,if判断的语句,或者其他编译选项的语句,但基本结构都是这样的。


实例

我以自己曾经写的一段实际代码为例,来讲解究竟该怎么写CMakeLists。

实例地址:

GitHub:https://github.com/yngzMiao/protobuf-parser-tool

实例的功能是生成和解析proto文件,分为C++和python版本。其中,C++版本就是采用CMakeLists.txt编写的,目录结构如下:

|---example_person.cpp
|---proto_pb2
        |--Person.pb.cc
        |--Person.pb.h
|---proto_buf
        |---General_buf_read.h
        |---General_buf_write.h
|---protobuf
        |---bin
                |---...
        |---include
                |---...
        |---lib
                |---...

目录结构含义:

  1. protobuf:Google提供的相关解析库和头文件,被proto_pb2文件夹内引用;
  2. proto_pb2:封装的Person结构和Person相关的处理函数,被proto_buf文件夹内引用;
  3. proto_buf:封装的read和write函数,被example_persom.cpp文件引用。

也就是说:

example_person.cpp–>proto_buf文件夹–>proto_pb2文件夹–>protobuf文件夹


步骤

CMakeLists.txt的创建

在需要进行编译的文件夹内编写CMakeLists.txt,即含有.cpp/.c/.cc的文件夹内:

即目录结构如下:

|---example_person.cpp
|---CMakeLists.txt
|---proto_pb2
        |--Person.pb.cc
        |--Person.pb.h
        |--CMakeLists.txt
|---proto_buf
        |---General_buf_read.h
        |---General_buf_write.h
|---protobuf
        |---bin
                |---...
        |---include
                |---...
        |---lib
                |---...

CMakeLists.txt的编写

本项目的CMakeLists.txt的文件数量是2个,目录层次结构为上下层关系。通常的解决方案,就是将下层目录编译成一个静态库文件,让上层目录直接读取和调用,而上层目录就直接生成一个可执行文件

上层CMakeLists.txt的内容为:

cmake_minimum_required(VERSION 3.0)
project(example_person)

# 如果代码需要支持C++11,就直接加上这句
SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++0x")
# 如果想要生成的可执行文件拥有符号表,可以gdb调试,就直接加上这句
add_definitions("-Wall -g")

# 设置变量,下面的代码都可以用到
set(GOOGLE_PROTOBUF_DIR ${PROJECT_SOURCE_DIR}/protobuf)
set(PROTO_PB_DIR ${PROJECT_SOURCE_DIR}/proto_pb2)
set(PROTO_BUF_DIR ${PROJECT_SOURCE_DIR}/proto_buf)

# 编译子文件夹的CMakeLists.txt
add_subdirectory(proto_pb2)

# 规定.h头文件路径
include_directories(${PROJECT_SOURCE_DIR}
    ${PROTO_PB_DIR} ${PROTO_BUF_DIR}
)

# 生成可执行文件
add_executable(${PROJECT_NAME} example_person.cpp )

# 链接操作
target_link_libraries(${PROJECT_NAME}
    general_pb2)

如果是初学者,这一段可能看不到两个地方,第一是链接操作的general_pb2,第二是按照上文的CMakeLists.txt的流程,并没有规定link_directories的库文件地址啊,这是什么道理?

这两个其实是一个道理,add_subdirectory起到的作用

当运行到add_subdirectory这一句时,会先将子文件夹进行编译,而libgeneral_pb2.a是在子文件夹中生成出来的库文件。子文件夹运行完后,父文件夹就已经知道了libgeneral_pb2.a这个库,因而不需要link_directories了。

同时,另一方面,在add_subdirector之前set的各个变量,在子文件夹中是可以调用的

下层CMakeLists.txt的内容为:

project(general_pb2)

aux_source_directory(${PROJECT_SOURCE_DIR} PB_FILES)

add_library(${PROJECT_NAME} STATIC ${PB_FILES})

include_directories(${PROJECT_SOURCE_DIR}
    ${GOOGLE_PROTOBUF_DIR}/include
)

link_directories(${GOOGLE_PROTOBUF_DIR}/lib/)

target_link_libraries(${PROJECT_NAME}
    protobuf
)

在这里,GOOGLE_PROTOBUF_DIR是上层CMakeLists.txt中定义的,libprotobuf.a是在${GOOGLE_PROTOBUF_DIR}/lib/目录下的。

显然可见,这就是一个标准的CMakeLixts.txt的流程。

CMakeLists.txt的编译

一般CMakeLists.txt是,在最顶层创建build文件夹,然后编译。即:

mkdir build && cd build
cmake ..
make

最终生成可执行文件example_person。

可以通过以下命令来运行该可执行文件:

./example_person
声明: 本文转载自其它媒体或授权刊载,目的在于信息传递,并不代表本站赞同其观点和对其真实性负责,如有新闻稿件和图片作品的内容、版权以及其它问题的,请联系我们及时删除。(联系我们,邮箱:evan.li@aspencore.com )
0
评论
  • 【7.24 深圳】2025国际AI+IoT生态发展大会/2025全球 MCU及嵌入式技术论坛


  • 相关技术文库
  • C语言
  • 编程
  • 软件开发
  • 程序
  • 光立方程序编写步骤

    基于51单片机的4*4*4光立方程序实现原理及程序代码。LED光立方的复位电路、时钟电路、每层LED灯电路控制逻辑,系统总原理图,工作流程及相关C语言源码实现。希望能够对你学习了解LED光立方程序编写及LED立方实体制...

    07-04
  • 封装继承多态

    封装: 封装是实现面向对象程序设计的第一步,封装就是将数据或函数等集合在一个个的单元中(我们称之为类)。被封装的对象通常被称为抽象数据类型。 封装的意义: 封装的意义在于保护或者防止代码(数据)被我们无意中...

    07-04
  • 封装是什么意思?

    即隐藏对象的属性和实现细节,仅对外公开接口,控制在程序中属性的读和修改的访问级别;将抽象得到的数据和行为(或功能)相结合,形成一个有机的整体,也就是将数据与操作数据的源代码进行有机的结合,形成“类”,其中...

    07-04
  • 超声波模块测距51程序_单片机超声波测距c语言

    超声波检测原理 超声波测距的程序流程图 程序如下: //超声波模块程序 //超声波模块程序 //Trig = P2^0 //Echo = P3^2 #include #define uchar unsigned char #define uint unsigned int // void delay(uint z) {...

    07-01
  • 大佬带你看嵌入式系统,嵌入式系统该学习什么?

    嵌入式系统是当今的热门系统之一,在诸多领域,嵌入式系统都有所应用。为增进大家对嵌入式系统的认识,小编将为大家介绍嵌入式系统是一个什么样的专业,以及学习嵌入式系统该学习哪些内容。如果你对嵌入式系统具有...

    06-27
  • c51单片机编程要点总结

    c51单片机编程要点总结 1、头文件:#include (我用的是 STC 89C54RD+) 2、预定义:sbit LED = P1^0// 定义 P1 口的 0 位为 LED 注:“P1^0”这个写法,与 A51 不同(A51 是 P1.0),P1 是一组端口,端口号范围 0~7 注2...

    06-25
  • C语言基础知识点汇总

    总结C语言基础知识点

    06-23
  • Keil使用中的若干问题

      一、混合编程  1、模块内接口:  使用如下标志符:  #pragma asm  汇编语句  #pragma endasm  注意:如果在c51程序中使用了汇编语言,注意在keil编译器中需要激活Properties中的“Generate Assembler...

    06-23
  • ESP32-finsh

    esp32c2添加finsh实现了ping指令和AT指令解析

    06-13
  • 一文讲通C语言位域,快速掌握!

    在嵌入式系统的开发中,内存是最程序员非常需要关注的对象,尤其是MCU开发、网络协议解析、硬件寄存器操作等领域,能否对内存进行高效的利用和合理的管理,将直接影响程序的性能和硬件的稳定性。

    06-10
下载排行榜
更多
评测报告
更多
广告