【CMake学习笔记】| CMake调用不同生成器(Unix Makefiles/Ninja)构建及编译C/C++项目(四)

文摘   科技   2024-04-07 08:30   江苏  

对于 CMake ,我一直理解为项目构建工具,直到遇到 --build 才发现,CMake 还统一了各个平台的编译阶段。要了解 CMake 的构建和编译,首先需要了解生成器。

一、生成器

CMake 生成器负责为底层构建系统编写输入文件(例如Makefile)。运行cmake --help将显示可用的生成器。对于cmake 3.26.5 ,我的系统支持的生成器包括:

Generators

The following generators are available on this platform (* marks default):
Green Hills MULTI = Generates Green Hills MULTI files
(experimental, work-in-progress).
* Unix Makefiles = Generates standard UNIX makefiles.
Ninja = Generates build.ninja files.
Ninja Multi-Config = Generates build-<Config>.ninja files.
Watcom WMake = Generates Watcom WMake makefiles.
CodeBlocks - Ninja = Generates CodeBlocks project files.
CodeBlocks - Unix Makefiles = Generates CodeBlocks project files.
CodeLite - Ninja = Generates CodeLite project files.
CodeLite - Unix Makefiles = Generates CodeLite project files.
Eclipse CDT4 - Ninja = Generates Eclipse CDT 4.0 project files.
Eclipse CDT4 - Unix Makefiles= Generates Eclipse CDT 4.0 project files.
Kate - Ninja = Generates Kate project files.
Kate - Unix Makefiles = Generates Kate project files.
Sublime Text 2 - Ninja = Generates Sublime Text 2 project files.
Sublime Text 2 - Unix Makefiles
= Generates Sublime Text 2 project files.

正如本文所述,CMake 包括不同类型的生成器,如命令行生成器、IDE生成器和其他生成器。

1. 命令行生成器

这些生成器用于命令行构建工具,如 Make 和 Ninja。在使用 CMake 生成构建系统之前,必须配置所选的工具链。

支持的生成器包括:

  • Borland Makefiles
  • MSYS Makefiles
  • MinGW Makefiles
  • NMake Makefiles
  • NMake Makefiles JOM
  • Ninja
  • Unix Makefiles
  • Watcom WMake

2. IDE 生成器

这些生成器用于集成开发环境,其中包括它们自己的编译器。例如 Visual Studio和 Xcode,它们本身就包含一个编译器。

支持的生成器包括:

  • Visual Studio 6
  • Visual Studio 7
  • Visual Studio 7 .NET 2003
  • Visual Studio 8 2005
  • Visual Studio 9 2008
  • Visual Studio 10 2010
  • Visual Studio 11 2012
  • Visual Studio 12 2013
  • Xcode

3. 其他生成器

这些生成器创建配置并与其他 IDE 工具共同工作,并且必须包含在 IDE 或命令行生成器中。

支持的生成器包括:

  • CodeBlocks
  • CodeLite
  • Eclipse CDT4
  • KDevelop3
  • Kate
  • Sublime Text 2

要调用 CMake 生成器,可以使用 -G 命令行开关。

二、CMake构建及编译

在 Linux 平台下,使用 CMake 构建及编译相关项目时,通常会使用如下命令操作:

mkdir build
cd build
cmake ..
cmake --build .

其中,cmake .. 和 cmake --build . 是用于构建及编译链接 C/C++ 项目的常用命令。

解析

  1. cmake .. :构建项目,使用 cmake 生成 Makefile 文件(cmake的主要功能)及其他构建系统所需的文件

  2. cmake --build . :在当前目录中编译和链接项目

  • 编译:语法分析、语义分析等,生成与特定平台相关的汇编代码

  • 链接:符号解析,地址重定位

拓展

  1. 首先,使用命令行:cmake <source tree>,比如:cmake ..,在你的构建目录(外部构建方式)下生成了项目文件 project files,官方文档中又叫 build tree或binary tree,这其中就包括Makefile,还有一些其他相关文件 / 目录 / 子目录。

  2. 其次,自然是在构建目录内对生成好的项目(project files)进行编译链接,使用到的就是你说的cmake --build .

  3. 最后,--build 后面的那个 .,指的是生成项目文件的 build tree 的路径。一般来说,如果你明确知道,你的系统中使用的是哪种构建器(Build Generator), 比如:Unix Makefiles, 你完全可以直接使用 make 进行编译链接。对于这种 --build 的形式,多用于自动化脚本之中,或者 IDE 环境下。

注意<source tree>指的是源文件 + 顶层 CMakeLists 所在的路径,cmake ..假设了路径在上一层。

当然,CMake 构建及编译 C/C++ 项目还有另外一种书写方式,如下:

注意:当前目录为 CMakeLists.txt 所在的顶层目录

  1. 构建项目
cmake . -Bbuild -G "Unix Makefiles"
  • -B:指定生成的构建目录,即将生成的 Makefile 或项目文件保存到指定的目录中。这个目录可以是相对路径或绝对路径。例如: cmake -B build . 这将生成一个名为 build 的构建目录,并将生成的 Makefile 或项目文件保存到该目录中。您也可以使用绝对路径来指定构建目录,例如: cmake -B /path/to/build . 这将生成一个名为 build 的构建目录,并将生成的Makefile 或项目文件保存到 /path/to/build 目录中。总之,-B 选项用于指定生成的构建目录,即将 CMake 生成的 Makefile 或项目文件保存到指定的目录中。这使得我们可以将源码和构建过程分开,以便更好地管理项目。

  • -GGenerator 的意思,即指定生成器。生成器是一个特定于构建系统的工具,用于将 CMake 生成的 Makefile 或项目文件转换为实际的可执行文件、静态库或动态库。不同的构建系统有不同的生成器,每个生成器都可以将CMake 生成的文件转换为适用于特定构建系统的文件。例如,Unix Makefile生成器生成适用于 Unix/Linux 系统的 Makefile 文件,Ninja 生成器生成适用于 Ninja 构建系统的项目文件,Visual Studio 生成器生成适用于 Visual Studio IDE 的项目文件等等。生成器通过读取 CMake 生成的文件并将其转换为构建系统可以使用的文件来执行其工作。总之,生成器是一个特定于构建系统的工具,用于将 CMake 生成的 Makefile 或项目文件转换为实际的可执行文件、静态库或动态库。不同的构建系统有不同的生成器,每个生成器都可以将 CMake 生成的文件转换为适用于特定构建系统的文件。使用 -G 选项可以使用指定的生成器,例如Unix MakefilesNinjaVisual Studio等。例如:

    • cmake -G "Unix Makefiles" ..生成适用于 Unix/Linux 系统的Makefile文件。

    • cmake -G Ninja .. 生成适用于 Ninja 构建系统的项目文件。

    • cmake -G "Visual Studio 16" .. 生成适用于 Visual Studio 2016 的项目文件。

    • cmake -G "CodeBlocks - Unix Makefiles" .. 生成适用于Code::Blocks IDE 的 Makefile 文件。

    • cmake -G "Xcode" .. 生成适用于 Xcode IDE 的项目文件。

  1. 编译项目
cmake --build build

上述命令用于在 build 目录中编译链接项目;在 Linux 下,默认使用 make 命令进行项目编译链接。但是这里我们使用 cmake --build build 实现编译链接。

注意:为什么这里不直接使用 make,而是使用 cmake --build 形式的命令,主要是为了跨平台cmake 中有个概念叫做 cmake generator,它允许 cmake 支持不同的底层,比如 Makefile 系列、Ninja系列等。例如要使用 Ninja,加上 -G Ninja 即可,即 cmake -G Ninja。如果没有 cmake --build build 这条命令,就需要调用底层命令,比如 make 或者 ninja。但现在 cmake 提供了一个统一的命令接口,使用这种形式后,不管底层是啥,直接 --build 即可实现正确编译。

三、CMake构建及编译实战演示

让我们通过【CMake学习笔记】| 模块化项目管理(一) 中的多目录文件工程示例来演示一下 使用 CMake 跨平台构建和编译工程项目。

工程项目结构如下:

# 工程文件目录结构
[root@localhost multi_dir]# tree -L 2
.
├── app
│ └── main.c
├── build
├── CMakeLists.txt
├── hello
│ ├── CMakeLists.txt
│ ├── include
│ └── src
└── world
├── CMakeLists.txt
├── include
└── src

8 directories, 4 files

顶级目录下的主 CMakeLists.txt 文件:CMakeLists.txt

# CMake最低版本号要求
cmake_minimum_required(VERSION 3.0)

# 项目信息,随便写
project(HelloWorld)

# #设置C/C++版本(如c99,c++11,c++17等版本),下面表示使用c99版本
set(CMAKE_C_STANDARD 99)

# 指定目录添加到编译器的头文件搜索路径之下,指定的目录被解释成当前源码路径的相对路径。
# 当然也可以使用绝对路径和自定义的变量。默认情况下,include_directories命令会将目录
# 添加到列表最后(AFTER选项)。不过,可以通过命令设置CMAKE_INCLUDE_DIRECTORIES_BEFORE
# 变量为ON来改变它的默认行为,将目录添加到列表前面。也可以在每次调用include_directories命令时
# 使用AFTER或BEFORE选项来指定是添加到列表的前面或者后面。
include_directories(hello/include world/include)

# 设置变量DIR_SRCS,其值为app/下的源文件main.c
set(DIR_SRCS ./app/main.c)

# 添加子目录hello和world,这样hello和world各自目录下的CMakeLists.txt文件和源代码也会被处理
add_subdirectory(hello)
add_subdirectory(world)

# 指定静态库路径,${PROJECT_SOURCE_DIR}表示主CMakeLists.txt所在的文件夹路径,
# 即项目所在根目录文件路径
link_directories(${PROJECT_SOURCE_DIR}/world)
# 链接子目录生成的静态库libworld.a,指定的时候一般会掐头(lib)去尾(.a)
link_libraries(world)

# 指定生成目标
add_executable(HelloWorld ${DIR_SRCS})

# 链接子目录生成的动态库 libhello.so,指定的时候一般会掐头(lib)去尾(.so)
target_link_libraries(HelloWorld hello)

文件源码如下:

hello 子目录头文件:hello/include/hello.h

#ifndef HELLOWORLD_HELLO_H
#define HELLOWORLD_HELLO_H

extern void hello(void);

#endif //HELLOWORLD_HELLO_H

hello 子目录源文件:hello/src/hello.c

#include "hello.h"
#include <stdio.h>

void hello()
{
    printf("hello.\n");
}

hello 子目录CMakeLists.txt 文件:hello/CMakeLists.txt

# 添加头文件路径
include_directories(./include)

# 设置变量DIR_SRCS,其值为hello/src/下的源文件hello.c
set(DIR_SRCS ./src/hello.c)

# 生成动态链接库
add_library(hello SHARED ${DIR_SRCS}) 

world 子目录头文件:world/include/world.h

#ifndef HELLOWORLD_WORLD_H
#define HELLOWORLD_WORLD_H

extern void world(void);

#endif //HELLOWORLD_WORLD_H

world 子目录源文件:world/src/world.c

#include "world.h"
#include <stdio.h>

void world()
{
    printf("world.\n");
}

world 子目录CMakeLists.txt 文件:world/CMakeLists.txt

# 添加头文件路径
include_directories(./include)

# 设置变量DIR_SRCS,其值为world/src/下的源文件world.c
set(DIR_SRCS ./src/world.c)

# 生成静态链接库
add_library(world STATIC ${DIR_SRCS})

app 子目录主源文件:app/main.c

#include "hello.h"
#include "world.h"

int main()
{
    hello();
    world();

    return 0;

接下来让我们通过演示如何使用 CMake 调用不同的底层 Generator 跨平台构建和编译不同的工程项目。

1. Unix Makefiles

本节演示使用 Unix Makefiles 生成器生成适用于 Unix/Linux 系统的 Makefile 文件。随后通过 cmake --build build 调用调用底层命令 make 编译链接项目。示例如下:

[root@localhost multi_dir]# ls
app CMakeLists.txt hello world

# cmake 使用过 Unix Makefiles 构建项目
[root@localhost multi_dir]# cmake . -Bbuild -G "Unix Makefiles"
-- The C compiler identification is GNU 8.5.0
-- The CXX compiler identification is GNU 8.5.0
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Check for working C compiler: /usr/bin/cc - skipped
-- Detecting C compile features
-- Detecting C compile features - done
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- Check for working CXX compiler: /usr/bin/c++ - skipped
-- Detecting CXX compile features
-- Detecting CXX compile features - done
-- Configuring done (0.4s)
-- Generating done (0.0s)
-- Build files have been written to: /backup/cmake/multi_dir/build

[root@localhost multi_dir]# ls
app build CMakeLists.txt hello world

[root@localhost multi_dir]# ls build/
CMakeCache.txt CMakeFiles cmake_install.cmake hello Makefile world

# cmake使用make编译项目,生成可执行文件 HelloWorld
[root@localhost multi_dir]# cmake --build build
[ 16%] Building C object world/CMakeFiles/world.dir/src/world.c.o
[ 33%] Linking C static library libworld.a
[ 33%] Built target world
[ 50%] Building C object hello/CMakeFiles/hello.dir/src/hello.c.o
[ 66%] Linking C shared library libhello.so
[ 66%] Built target hello
[ 83%] Building C object CMakeFiles/HelloWorld.dir/app/main.c.o
[100%] Linking C executable HelloWorld
[100%] Built target HelloWorld

[root@localhost multi_dir]# ls
app build CMakeLists.txt hello world
[root@localhost multi_dir]#
[root@localhost multi_dir]# ls build/
CMakeCache.txt CMakeFiles cmake_install.cmake hello HelloWorld Makefile world

[root@localhost multi_dir]# ./build/HelloWorld
hello.
world.

2. Ninja

本节演示使用 Ninja 生成器生成适用于 Ninja 构建系统的 Makefile 文件。随后通过  cmake --build build 调用调用底层命令 ninja 编译链接项目。

注意cmake 可以使用 Ninja 生成器的前提是机器上已成功安装ninja可执行程序,安装方法可通过命令行或者源码编译安装,具体安装方法可自行网络检索。

示例如下:

# cmake 使用过Ninja构建项目
[root@localhost multi_dir]# cmake . -Bbuild -G Ninja
-- The C compiler identification is GNU 8.5.0
-- The CXX compiler identification is GNU 8.5.0
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Check for working C compiler: /usr/bin/cc - skipped
-- Detecting C compile features
-- Detecting C compile features - done
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- Check for working CXX compiler: /usr/bin/c++ - skipped
-- Detecting CXX compile features
-- Detecting CXX compile features - done
-- Configuring done (0.4s)
-- Generating done (0.0s)
-- Build files have been written to: /backup/cmake/multi_dir/build

[root@localhost multi_dir]# ls
app build CMakeLists.txt hello world
[root@localhost multi_dir]#
[root@localhost multi_dir]# ls build/
build.ninja CMakeCache.txt CMakeFiles cmake_install.cmake hello world

# cmake使用ninja编译项目,生成可执行文件 HelloWorld
[root@localhost multi_dir]# cmake --build build
[6/6] Linking C executable HelloWorld

[root@localhost multi_dir]# ls
app build CMakeLists.txt hello world
[root@localhost multi_dir]#
[root@localhost multi_dir]# ls build/
build.ninja CMakeCache.txt CMakeFiles cmake_install.cmake hello HelloWorld world

[root@localhost multi_dir]# ./build/HelloWorld
hello.
world.


Linux二进制
学习并分享Linux的相关技术,网络、内核、驱动、容器等。
 最新文章