你的浏览器不支持canvas

让我们携手共创奇迹！

CMake简单入门

Date： Oct 01, 2024 Author： LBD

本文章采用 知识共享署名-非商业性使用-禁止演绎 4.0 国际许可协议 进行许可。转载请注明来自WindCrazy

这是CMake的超级简单入门讲解，可以迅速了解什么是CMake、干什么、怎么干

一、概要

  • CMake是一个跨平台的用于构建C/C++项目的工具，类似于Java项目项目中常用的Maven、Gradel
  • CMake需要和make、gcc/g++一起使用，它们在构建工程中的作用不同。
  • gcc/g++是linux下的一个编译器，用于将C/C++源码编译链接成可执行文件或者是库文件。（它的一个windows移植版本是mingw64，大家熟悉的C/C++ IDE 【CodeBlocks】【Dev-C++】中就内置了这个ming64）
  • gcc/g++可以用于直接编译单文件，然后在进行链接工作，最终形成可执行程序。但编译复杂工程时需要按照特定的顺序执行这些gcc/g++指令，人工敲指令不太方便，因此人们希望通过制定依赖规则等来自动化地编译链接，因此有了make这一工具
  • 使用make工具需要编写makefile文件来指定规则，make会在当前目录自动找到这个文件执行批处理构建工作；但对于复杂工程来说，依赖关系可能比较复杂，编写makefile也比较麻烦。这是，人们又设计了CMake用于生成makefile文件
  • 使用CMake工具需要编写CMakeLists.txt文件，用于在较高的抽象层次上指明构建任务，基本上类似于直接在IDE中设定表格选项。

二、流程

CMake是一个跨平台的开源构建系统生成工具，用于管理软件构建过程。CMake通过读取CMakeLists.txt文件中的指令和信息来生成适用于不同构建工具（如Make、Ninja等）的构建文件，比如Makefile。

下面是CMake如何生成Makefile文件的简要过程：

  1. 编写CMakeLists.txt文件：首先，开发人员需要编写CMakeLists.txt文件，该文件包含了项目的基本信息、依赖关系、源文件列表以及构建指令等内容。

  2. 创建一个构建目录：为了保持源代码目录的干净和独立性，一般会在项目目录外创建一个构建目录。在构建目录中运行CMake来生成Makefile文件。

  3. 运行CMake：在构建目录中打开终端，并运行以下命令：

    cmake /path/to/source

    其中/path/to/source是指向包含CMakeLists.txt文件的源代码目录的路径。

  4. 选择生成器：CMake会根据当前系统和环境自动选择一个默认的生成器（如Makefile生成器）。如果需要指定生成器，可以在运行CMake时使用-G参数，比如：

    cmake -G "Unix Makefiles" /path/to/source

  5. 生成Makefile：运行CMake后，它会解析CMakeLists.txt文件，并根据其中的指令和信息生成Makefile文件，其中包含了编译源文件、链接库、生成可执行文件等构建步骤所需的规则和命令。

  6. 使用生成的Makefile：生成的Makefile文件会在构建目录中，可以使用make命令来执行构建，比如：

    make

通过这个过程，CMake能够根据项目的配置信息和需求生成适用于特定构建系统（如Make）的构建文件（比如Makefile），从而实现跨平台的项目构建管理。

三、CMakeLists.txt写法

参考：https://blog.csdn.net/qq_40488628/article/details/108648329

https://blog.csdn.net/qq_38410730/article/details/102477162

编写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的内容为：

# 用于指定需要的CMamke的最低版本
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。

四、Makefile

由CMake生成出来的Makefile是如何编写的，参考：https://blog.csdn.net/weixin_44222088/article/details/135922367

对于本文内容有问题或建议的小伙伴，欢迎提出问题。