makefile： 管理项目基本用法#

3.1.、规则#

Makefile的框架是由规则构成的。make命令执行时先在Makefile文件中查找各种规则，对各种规则进行解析后运行规则。规则的基本格式为：

1
target1,target2...: depend1, depend2, ...
2
    command
3
    ......
4
    ......

每条规则由三个部分组成分别是目标(target), 依赖(depend)和命令(command)。

• 命令(command): 当前这条规则的动作，一般情况下这个动作就是一个 shell 命令

  • 例如：通过某个命令编译文件、生成库文件、进入目录等。
  • 动作可以是多个，每个命令前必须有一个Tab缩进并且独占占一行。

• 依赖(depend): 规则所必需的依赖条件，在规则的命令中可以使用这些依赖。

  • 例如：生成可执行文件的目标文件（*.o）可以作为依赖使用
  • 如果规则的命令中不需要任何依赖，那么规则的依赖可以为空
  • 当前规则中的依赖可以是其他规则中的某个目标，这样就形成了规则之间的嵌套
  • 依赖可以根据要执行的命令的实际需求, 指定很多个

• 目标(target)： 规则中的目标，这个目标和规则中的命令是对应的

  • 通过执行规则中的命令，可以生成一个和目标同名的文件
  • 规则中可以有多个命令, 因此可以通过这多条命令来生成多个目标, 所有目标也可以有很多个
  • 通过执行规则中的命令，可以只执行一个动作，不生成任何文件，这样的目标被称为伪目标

3.2、 工作原理#

在此主要为大家剖析一下通过提供的 makefile 文件，构建工具 make 什么时候编译项目中的所有文件, 什么时候只选择更新项目中的某几个文件。另外再研究一下如果makefile里边有多个规则它们之间是如何配合工作的，我们基于下边的例子，依次进行讲解。

make 命令执行的时候会根据文件的时间戳判定是否执行makefile文件中相关规则中的命令。

• 目标是通过依赖生成的，因此正常情况下：目标时间戳 > 所有依赖的时间戳, 如果执行 make 命令的时候检测到规则中的目标和依赖满足这个条件, 那么规则中的命令就不会被执行。
• 当依赖文件被更新了, 文件时间戳也会随之被更新, 这时候 目标时间戳 < 某些依赖的时间戳, 在这种情况下目标文件会通过规则中的命令被重新生成。
• 如果规则中的目标对应的文件根本就不存在， 那么规则中的命令肯定会被执行。

3.3、自动推导#

make 是一个功能强大的构建工具，虽然make需要根据 makefile 中指定的规则来完成源文件的编译。作为小白的我们编写makefile的时候难免写的不是那么严谨从而漏写一些构建规则，但是我们会发现程序还是会被编译成功。这是因为 make 有自动推导的能力，不会完全依赖 makefile。

比如: 使用命令 make 编译扩展名为.c 的 C 语言文件的时候，源文件的编译规则不用明确给出。这是因为 make 进行编译的时候会使用一个默认的编译规则，按照默认规则完成对.c文件的编译，生成对应的.o 文件。它使用命令cc -c来编译.c 源文件。在 Makefile 中只要给出需要构建的目标文件名（一个.o 文件），make 会自动为这个.o 文件寻找合适的依赖文件（对应的.c 文件），并且使用默认的命令来构建这个目标文件。

假设本地项目目录中有以下几个源文件:

1
$ tree
2
.
3
├── add.c
4
├── div.c
5
├── head.h
6
├── main.c
7
├── makefile
8
├── mult.c
9
└── sub.c

目录中 makefile 文件内容如下

1
calc:add.o  div.o  main.o  mult.o  sub.o
2
       gcc  add.o  div.o  main.o  mult.o  sub.o -o calc

通过make构建项目:

1
$ make
2
cc    -c -o add.o add.c
3
cc    -c -o div.o div.c
4
cc    -c -o main.o main.c
5
cc    -c -o mult.o mult.c
6
cc    -c -o sub.o sub.c
7
gcc  add.o  div.o  main.o  mult.o  sub.o -o calc

我们可以发现上边的 makefile 文件中只有一条规则, 依赖中所有的 .o文件在本地项目目录中是不存在的, 并且也没有其他的规则用来生成这些依赖文件, 这时候 make 会使用内部默认的构造规则先将这些依赖文件生成出来, 然后在执行规则中的命令, 最后生成目标文件 calc。

3.4、 变量#

使用 Makefile 进行规则定义的时候，为了写起来更加灵活，我们可以在里边使用变量。makefile中的变量分为三种：自定义变量，预定义变量和自动变量。

自定义变量用 Makefile 进行规则定义的时候，用户可以定义自己的变量，称为用户自定义变量。makefile 中的变量是没有类型的，直接创建变量然后给其赋值就可以了。

变量名=变量值

预定义变量 在 Makefile 中有一些已经定义的变量，用户可以直接使用这些变量，不用进行定义。在进行编译的时候，某些条件下 Makefile 会使用这些预定义变量的值进行编译。这些预定义变量的名字一般都是大写的，经常采用的预定义变量如下表所示：

自动变量：Makefile 中的变量除了用户自定义变量和预定义变量外，还有一类自动变量。Makefile 中的规则语句中经常会出现目标文件和依赖文件，自动变量用来代表这些规则中的目标文件和依赖文件，并且它们只能在规则的命令中使用。

下表中是一些常见的自动变量。

3.5、 模式匹配#

在介绍概念之前, 先读一下下面的这个 makefile 文件:

1
calc:add.o  div.o  main.o  mult.o  sub.o
2
        gcc  add.o  div.o  main.o  mult.o  sub.o -o calc
3

4
add.o:add.c
5
        gcc add.c -c
6

7
div.o:div.c
8
        gcc div.c -c
9

10
main.o:main.c
11
        gcc main.c -c
12

13
sub.o:sub.c
14
        gcc sub.c -c
15

16
mult.o:mult.c
17
        gcc mult.c -c

在阅读过程中能够发现从第二个规则开始到第六个规则做的是相同的事情, 但是由于文件名不同不得不在文件中写出多个规则，这就让 makefile 文件看起来非常的冗余，我们可以将这一系列的相同操作整理成一个模板，所有类似的操作都通过模板去匹配 makefile 会因此而精简不少，只是可读性会有所下降。

这个规则模板可以写成下边的样子，这种操作就称之为模式匹配。

1
%.o:%.c  gcc $< -c

3.6、函数#

makefile中有很多函数并且所有的函数都是有返回值的。makefile中函数的格式和C/C++中函数也不同，其写法是这样的： $(函数名 参数1, 参数2, 参数3, ...)，主要目的是让我们能够快速方便的得到函数的返回值。

这里为大家介绍两个 makefile 中使用频率比较高的函数：wildcard和patsubst。

wildcard

这个函数的主要作用是获取指定目录下指定类型的文件名，其返回值是以空格分割的、指定目录下的所有符合条件的文件名列表。函数原型如下：

1
$(wildcard PATTERN...)
2
    参数:    指定某个目录, 搜索这个路径下指定类型的文件，比如： *.c

• 参数功能:

  • PATTERN 指的是某个或多个目录下的对应的某种类型的文件, 比如当前目录下的.c文件可以写成 *.c
  • 可以指定多个目录，每个路径之间使用空格间隔

• 返回值：

  • 得到的若干个文件的文件列表， 文件名之间使用空格间隔
  • 示例：$(wildcard *.c ./sub/*.c)
    • 返回值格式: a.c b.c c.c d.c e.c f.c ./sub/aa.c ./sub/bb.c

patsubst

这个函数的功能是按照指定的模式替换指定的文件名的后缀, 函数原型如下:

1
$(patsubst <pattern>,<replacement>,<text>)

• 参数功能:
  • pattern: 这是一个模式字符串, 需要指定出要被替换的文件名中的后缀是什么
    • 文件名和路径不需要关心, 因此使用 % 表示即可 [通配符是 %]
    • 在通配符后边指定出要被替换的后缀, 比如: %.c, 意味着 .c的后缀要被替换掉
  • replacement: 这是一个模式字符串, 指定参数pattern中的后缀最终要被替换为什么
    • 还是使用 % 来表示参数pattern 中文件的路径和名字
    • 在通配符 % 后边指定出新的后缀名, 比如: %.o 这表示原来的后缀被替换为 .o
  • text: 该参数中存储这要被替换的原始数据
  • 返回值:
    • 函数返回被替换过后的字符串。