make之makefile 三 书写规则

版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/u013896064/article/details/83040801

makefile的规则包括两个部分,一个是依赖关系,一个是生成目标的方法。

在Makefile中,规则的顺序是非常重要的,由于,Makefile中仅仅应该有一个最终目标,其他的目标都是被这个目标所连带出来的,所以一定要让make知道你的最终目标是什么。一般来说,定义在Makefile中的目标可能会有非常多,可是第一条规则中的目标将被确立为最终的目标。假设第一条规则中的目标有非常多个,那么,第一个目标会成为最终的目标。make所完成的也就是这个目标。

好了,还是让我们来看一看怎样书写规则。


一、规则举例

foo.o : foo.c defs.h # foo模块
    cc -c -g foo.c

看到这个样例,各位应该不是非常陌生了,前面也已说过,foo.o是我们的目标,foo.c和defs.h是目标所依赖的源文件,而唯独一个命令“cc -c -g foo.c”(以Tab键开头)。这个规则告诉我们两件事:

1、文件的依赖关系,foo.o依赖于foo.c和defs.h的文件,假设foo.c和defs.h的文件日期要比foo.o文件日期要新,或是foo.o不存在,那么依赖关系发生。
2、假设生成(或更新)foo.o文件。也就是那个cc命令,其说明了,怎样生成foo.o这个文件。(当然foo.c文件include了defs.h文件)


二、规则的语法

targets : prerequisites
command
...

或是这样: 

targets : prerequisites ; command
command
...

targets是文件名称,以空格分开,能够使用通配符。一般来说,我们的目标基本上是一个文件,但也有可能是多个文件。

command是命令行,假设其不跟“targets : rerequisites”在同一行,那么,必须以[Tab键]开头,假设和prerequisites在一行,那么能够用分号做为分隔。(见上)

prerequisites也就是目标所依赖的文件(或依赖目标)。假设当中的某个文件要比目标文件要新,那么,目标就被觉得是“过时的”,被觉得是须要重生成的。这个在前面已经讲过了。

假设命令太长,你能够使用反斜框(‘/’)作为换行符。make对一行上有多少个字符沒有限制。规则告诉make两件事,文件的依赖关系和怎样成成目标文件。

一般来说,make会以UNIX的标准Shell,也就是/bin/sh来运行命令。


三、在规则中使用通配符

假设我们想定义一系列比較相似的文件,我们非常自然地就想起使用通配符。make支持三种通配符:“*”,“?”和“[...]”。这是和Unix的B-Shell是相同的。

波浪号(“~”)字符在文件名称中也有比較特殊的用途。假设是“~/test”,这就表示当前用户的$(HOME)文件夹下的test文件夹。而“~hchen/test”则表示用户hchen的宿主文件夹下的test文件夹。(这些都是Unix下的小知识了,make也支持)而在Windows或是MS-DOS下,用户沒有宿主文件夹,那么波浪号所指的文件夹则依据环境变量“HOME”而定。

通配符代替了你一系列的文件,如“*.c”表示所有后缀名为.c的文件。一个需要我们注意的是,假设我们的文件名称中有通配符,如:“*”,那么能够用转义字符“/”,如“/*”来表示真实的“*”字符,而不是随意长度的字符串。

好吧,还是先来看几个样例吧:

clean:
    rm -f *.o

上面这个样例我不不多说了,这是操作系统Shell所支持的通配符。这是在命令中的通配符。

print: *.c
lpr -p $?
touch print

上面这个样例说明了通配符也能够在我们的规则中,目标print依赖于全部的[.c]文件。当中的“$?”是一个自己主动化变量,稍微后面会讲解。

objects = *.o

上面这个样例,表示了,通符相同能够用在变量中。并非说[*.o]会展开,不!objects的值就是“*.o”。Makefile中的变量事实上就是C/C++中的宏。假设你要让通配符在变量中展开,也就是让objects的值是全部[.o]的文件名称的集合,那么,你能够这样:

objects := $(wildcard *.o)

这样的使用方法由keyword“wildcard”指出,关于Makefile的keyword,我们将在后面讨论。


四、文件搜寻

在一些大的工程中,有大量的源文件,我们通常的做法是把这很多的源文件分类,并存放在不同的文件夹中。所以,当make须要去找寻文件的依赖关系时,你能够在文件前加上路径,但最好的方法是把一个路径告诉make,让make在自己主动去找。

Makefile文件里的特殊变量“VPATH”就是完成这个功能的,假设沒有指明这个变量,make仅仅会在当前的文件夹中去找寻依赖文件和目标文件。假设定义了这个变量,那么,make就会在当当前文件夹找不到的情况下,到所指定的文件夹中去找寻文件了。

VPATH = src:../headers

上面的的定义指定两个文件夹,“src”和“../headers”,make会依照这个顺序进行搜索。文件夹由“冒号”分隔。(当然,当前文件夹永远是最高优先搜索的地方)

另一个设置文件搜索路径的方法是使用make的“vpath”keyword(注意,它是全小写的),这不是变量,这是一个make的keyword,这和上面提到的那个VPATH变量非常相似,可是它更为灵活。它能够指定不同的文件在不同的搜索文件夹中。这是一个非常灵活的功能。它的使用方法有三种:

1、vpath <pattern> <directories>

为符合模式<pattern>的文件指定搜索文件夹<directories>。

2、vpath <pattern>

清除符合模式<pattern>的文件的搜索文件夹。

3、vpath

清除全部已被设置好了的文件搜索文件夹。

vapth使用方法中的<pattern>须要包括“%”字符。“%”的意思是匹配零或若干字符,比如,“%.h”表示全部以“.h”结尾的文件。<pattern>指定了要搜索的文件集,而<directories>则指定了<pattern>的文件集的搜索的文件夹。比如:

vpath %.h ../headers

该语句表示,要求make在“../headers”文件夹下搜索全部以“.h”结尾的文件。(假设某文件在当前文件夹沒有找到的话)

我们能够连续地使用vpath语句,以指定不同搜索策略。假设连续的vpath语句中出现了相同的<pattern>,或是被反复了的<pattern>,那么,make会依照vpath语句的先后顺序来运行搜索。如:

vpath %.c foo
vpath % blish
vpath %.c bar

其表示“.c”结尾的文件,先在“foo”文件夹,然后是“blish”,最后是“bar”文件夹。

vpath %.c foo:bar
vpath % blish

而上面的语句则表示“.c”结尾的文件,先在“foo”文件夹,然后是“bar”文件夹,最后才是“blish”文件夹。

我做了个简单的例子工程目录文件如下

├── Makefile
├── Makefile.mk
├── include
│   ├── include.h
│   └── include.h.gch
└── src
    ├── include.c
    └── main.c

此时我在外面的makefile文件的内容如下

#makefile demo
vpath %.h include   #make的时候会去该文件夹找寻所缺文件
vpath %.c src       #同上

OBJ_FILE=main.o include.o
CC=gcc

main:$(OBJ_FILE)
    $(CC) -o $@ $(OBJ_FILE) 
include.o:include.c include.h
    $(CC) -c $^ -Iinclude
main.o:main.c include.h
    $(CC) -c $^ -Iinclude 

include ./Makefile.mk

以上示例是使用vpath的使用示例。

注:Makefile.mk文件里面是clean的东西,所以无关紧要。


五、伪目标

最早先的一个样例中,我们提到过一个“clean”的目标,这是一个“伪目标”,

clean:
    rm *.o temp

正像我们前面样例中的“clean”一样,即然我们生成了很多文件编译文件,我们也应该提供一个清除它们的“目标”以备完整地重编译而用。 (以“make clean”来使用该目标)

由于,我们并不生成“clean”这个文件。“伪目标”并非一个文件,仅仅是一个标签,由于“伪目标”不是文件,所以make无法生成它的依赖关系和决定它是否要运行。我们唯独通过显示地指明这个“目标”才干让其生效。当然,“伪目标”的取名不能和文件名称重名,不然其就失去了“伪目标”的意义了。

当然,为了避免和文件重名的这样的情况,我们能够使用一个特殊的标记“.PHONY”来显示地指明一个目标是“伪目标”,向make说明,无论是否有这个文件,这个目标就是“伪目标”。

.PHONY : clean

仅仅要有这个声明,无论是否有“clean”文件,要运行“clean”这个目标,唯独“make clean”这样。于是整个过程能够这样写:

.PHONY: clean
clean:
    rm *.o temp

伪目标一般沒有依赖的文件。可是,我们也能够为伪目标指定所依赖的文件。伪目标相同能够作为“默认目标”,仅仅要将其放在第一个。一个演示例子就是,假设你的Makefile须要一口气生成若干个可运行文件,但你仅仅想简单地敲一个make完事,而且,全部的目标文件都写在一个Makefile中,那么你能够使用“伪目标”这个特性:

all : prog1 prog2 prog3
.PHONY : all

prog1 : prog1.o utils.o
    cc -o prog1 prog1.o utils.o

prog2 : prog2.o
    cc -o prog2 prog2.o

prog3 : prog3.o sort.o utils.o
    cc -o prog3 prog3.o sort.o utils.o

我们知道,Makefile中的第一个目标会被作为其默认目标。我们声明了一个“all”的伪目标,其依赖于其他三个目标。由于伪目标的特性是,总是被运行的,所以其依赖的那三个目标就总是不如“all”这个目标新。所以,其他三个目标的规则总是会被决议。也就达到了我们一口气生成多个目标的目的。“.PHONY : all”声明了“all”这个目标为“伪目标”。

随便提一句,从上面的样例我们能够看出,目标也能够成为依赖。所以,伪目标相同也可成为依赖。看以下的样例:

.PHONY: cleanall cleanobj cleandiff

cleanall : cleanobj cleandiff
    rm program

cleanobj :
    rm *.o

cleandiff :
    rm *.diff

“make clean”将清除全部要被清除的文件。“cleanobj”和“cleandiff”这两个伪目标有点像“子程序”的意思。我们能够输入“make cleanall”和“make cleanobj”和“make cleandiff”命令来达到清除不同种类文件的目的。

六、多目标

Makefile的规则中的目标能够不止一个,其支持多目标,有可能我们的多个目标同一时候依赖于一个文件,而且其生成的命令大体相似。于是我们就能把其合并起来。当然,多个目标的生成规则的运行命令是同一个,这可能会给我们带来麻烦,只是好在我们的能够使用一个自己主动化变量“$@”(关于自己主动化变量,将在后面讲述),这个变量表示着眼下规则中全部的目标的集合,这样说可能非常抽象,还是看一个样例吧。

bigoutput littleoutput : text.g
    generate text.g -$(subst output,,$@) > $@

上述规则等效于:

bigoutput : text.g
    generate text.g -big > bigoutput
littleoutput : text.g
    generate text.g -little > littleoutput

当中,-$(subst output,,$@)中的“$”表示运行一个Makefile的函数,函数名为subst,后面的为參数。关于函数,将在后面讲述。这里的这个函数是截取字符串的意思,“$@”表示目标的集合,就像一个数组,“$@”依次取出目标,并执于命令。

(上面这节这段好高级,平时应该很少用到)


七、静态模式

静态模式能够更加easy地定义多目标的规则,能够让我们的规则变得更加的有弹性和灵活。我们还是先来看一下语法:

<targets ...>: <target-pattern>: <prereq-patterns ...>
<commands>
...


targets定义了一系列的目标文件,能够有通配符。是目标的一个集合。

target-parrtern是指明了targets的模式,也就是的目标集模式。

prereq-parrterns是目标的依赖模式,它对target-parrtern形成的模式再进行一次依赖目标的定义。

这样描写叙述这三个东西,可能还是沒有说清晰,还是举个样例来说明一下吧。假设我们的<target-parrtern>定义成“%.o”,意思是我们的<target>集合中都是以“.o”结尾的,而假设我们的<prereq-parrterns>定义成“%.c”,意思是对<target-parrtern>所形成的目标集进行二次定义,其计算方法是,取<target-parrtern>模式中的“%”(也就是去掉了[.o]这个结尾),并为其加上[.c]这个结尾,形成的新集合。

所以,我们的“目标模式”或是“依赖模式”中都应该有“%”这个字符,假设你的文件名称中有“%”那么你能够使用反斜杠“/”进行转义,来标明真实的“%”字符。

看一个样例:

objects = foo.o bar.o

all: $(objects)

$(objects): %.o: %.c
$(CC) -c $(CFLAGS) $< -o $@


上面的样例中,指明了我们的目标从$object中获取,“%.o”表明要全部以“.o”结尾的目标,也就是“foo.o bar.o”,也就是变量$object集合的模式,而依赖模式“%.c”则取模式“%.o”的“%”,也就是“foo bar”,并为其加下“.c”的后缀,于是,我们的依赖目标就是“foo.c bar.c”。而命令中的“$<”和“$@”则是自己主动化变量,“$<”表示全部的依赖目标集(也就是“foo.c bar.c”),“$@”表示目标集(也就是“foo.o bar.o”)。于是,上面的规则展开后等效于以下的规则:

foo.o : foo.c
$(CC) -c $(CFLAGS) foo.c -o foo.o
bar.o : bar.c
$(CC) -c $(CFLAGS) bar.c -o bar.o

试想,假设我们的“%.o”有几百个,那种我们仅仅要用这样的非常easy的“静态模式规则”就能够写完一堆规则,实在是太有效率了。“静态模式规则”的使用方法非常灵活,假设用得好,那会一个非常强大的功能。再看一个样例:

files = foo.elc bar.o lose.o

$(filter %.o,$(files)): %.o: %.c
$(CC) -c $(CFLAGS) $< -o $@
$(filter %.elc,$(files)): %.elc: %.el
emacs -f batch-byte-compile $<


$(filter %.o,$(files))表示调用Makefile的filter函数,过滤“$filter”集,仅仅要当中模式为“%.o”的内容。其的它内容,我就不用多说了吧。这个例字展示了Makefile中更大的弹性。


八、自己主动生成依赖性

在Makefile中,我们的依赖关系可能会须要包括一系列的头文件,比方,假设我们的main.c中有一句“#include "defs.h"”,那么我们的依赖关系应该是:

main.o : main.c defs.h

可是,假设是一个比較大型的工程,你必需清晰哪些C文件包括了哪些头文件,而且,你在添加或删除头文件时,也须要小心地改动Makefile,这是一个非常沒有维护性的工作。为了避免这样的繁重而又easy出错的事情,我们能够使用C/C++编译的一个功能。大多数的C/C++编译器都支持一个“-M”的选项,即自己主动找寻源文件里包括的头文件,并生成一个依赖关系。比如,假设我们运行以下的命令:

cc -M main.c

其输出是:

main.o : main.c defs.h

于是由编译器自己主动生成的依赖关系,这样一来,你就不必再手动书写若干文件的依赖关系,而由编译器自己主动生成了。须要提醒一句的是,假设你使用GNU的C/C++编译器,你得用“-MM”參数,不然,“-M”參数会把一些标准库的头文件也包括进来。

gcc -M main.c的输出是:

main.o: main.c defs.h /usr/include/stdio.h /usr/include/features.h /
/usr/include/sys/cdefs.h /usr/include/gnu/stubs.h /
/usr/lib/gcc-lib/i486-suse-linux/2.95.3/include/stddef.h /
/usr/include/bits/types.h /usr/include/bits/pthreadtypes.h /
/usr/include/bits/sched.h /usr/include/libio.h /
/usr/include/_G_config.h /usr/include/wchar.h /
/usr/include/bits/wchar.h /usr/include/gconv.h /
/usr/lib/gcc-lib/i486-suse-linux/2.95.3/include/stdarg.h /
/usr/include/bits/stdio_lim.h


gcc -MM main.c的输出则是:

main.o: main.c defs.h

那么,编译器的这个功能怎样与我们的Makefile联系在一起呢。由于这样一来,我们的Makefile也要依据这些源文件又一次生成,让Makefile自已依赖于源文件?这个功能并不现实,只是我们能够有其他手段来迂回地实现这一功能。GNU组织建议把编译器为每一个源文件的自己主动生成的依赖关系放到一个文件里,为每一个“name.c”的文件都生成一个“name.d”的Makefile文件,[.d]文件里就存放对应[.c]文件的依赖关系。

于是,我们能够写出[.c]文件和[.d]文件的依赖关系,并让make自己主动更新或自成[.d]文件,并把其包括在我们的主Makefile中,这样,我们就能够自己主动化地生成每一个文件的依赖关系了。

这里,我们给出了一个模式规则来产生[.d]文件:

%.d: %.c
@set -e; rm -f $@; /
$(CC) -M $(CPPFLAGS) $< > $@.$$$$; /
sed 's,/($*/)/.o[ :]*,/1.o $@ : ,g' < $@.$$$$ > $@; /
rm -f $@.$$$$


这个规则的意思是,全部的[.d]文件依赖于[.c]文件,“rm -f $@”的意思是删除全部的目标,也就是[.d]文件,第二行的意思是,为每一个依赖文件“$<”,也就是[.c]文件生成依赖文件,“$@”表示模式“%.d”文件,假设有一个C文件是name.c,那么“%”就是“name”,“$$$$”意为一个随机编号,第二行生成的文件有可能是“name.d.12345”,第三行使用sed命令做了一个替换,关于sed命令的使用方法请參看相关的使用文档。第四行就是删除暂时文件。

总而言之,这个模式要做的事就是在编译器生成的依赖关系中添加[.d]文件的依赖,即把依赖关系:

main.o : main.c defs.h

转成:

main.o main.d : main.c defs.h

于是,我们的[.d]文件也会自己主动更新了,并会自己主动生成了,当然,你还能够在这个[.d]文件里添加的不仅仅是依赖关系,包括生成的命令也可一并添加,让每一个[.d]文件都包括一个完赖的规则。一旦我们完成这个工作,接下来,我们就要把这些自己主动生成的规则放进我们的主Makefile中。我们能够使用Makefile的“include”命令,来引入别的Makefile文件(前面讲过),比如:

sources = foo.c bar.c

include $(sources:.c=.d)

上述语句中的“$(sources:.c=.d)”中的“.c=.d”的意思是做一个替换,把变量$(sources)全部[.c]的字串都替换成[.d],关于这个“替换”的内容,在后面我会有更为具体的讲述。当然,你得注意次序,由于include是按次来加载文件,最先加载的[.d]文件里的目标会成为默认目标。

猜你喜欢

转载自blog.csdn.net/u013896064/article/details/83040801