Makefile六层功力的锻炼(五)


Makefile六层功力的锻炼(五)一、使用条件判断1.示例2.语法二、使用函数1.函数的调用语法2.字符串处理函数3.文件名操作函数4.foreach函数5.if函数6.call函数7.origin函数8.shell函数9.控制make的函数三、模块级Makefile的模板式用法四、最后

一、使用条件判断

使用条件判断,可以让 make 根据运行时的不同情况选择不同的执行分支。条件表达式可以 是比较变量的值,或是变量和常量的值。

1.示例

下面的例子,判断$(CC)变量是否“gcc”,如果是的话,则使用 GNU 函数编译目标。

 

可见,在上面示例的这个规则中,目标“foo”可以根据变量“$(CC)”值来选取不同的函数库来编译程序。

我们可以从上面的示例中看到三个关键字:ifeq、else 和 endif。ifeq 的意思表示条件语句的开始,并指定一个条件表达式,表达式包含两个参数,以逗号分隔,表达式以圆括号括起。else 表示条件表达式为假的情况。endif表示一个条件语句的结束,任何一个条件表达式都应该以 endif 结束。

当我们的变量$(CC)值是“gcc”时,目标 foo 的规则是:

 

而当我们的变量$(CC)值不是“gcc”时(比如“cc”),目标 foo 的规则是:

 

当然,我们还可以把上面的那个例子写得更简洁一些:

 

2.语法

条件表达式的语法为:

 

以及:

 

其中表示条件关键字,如“ifeq”。这个关键字有四种。

第一个是我们前面所见过的“ifeq”

 

比较参数“arg1”和“arg2”的值是否相同。当然,参数中我们还可以使用 make 的函数。

如:

 

这个示例中使用了“strip”函数,如果这个函数的返回值是空(Empty),那么 就生效。

第二个条件关键字是“ifneq”。语法是:

 

其比较参数“arg1”和“arg2”的值是否相同,如果不同,则为真。和“ifeq”类似。

第三个条件关键字是“ifdef”。语法是:

 

如果变量的值非空,那到表达式为真。否则,表达式为假。当然, 同样可以是一个函数的返回值。注意,ifdef 只是测试一个变量是否有 值,其并不会把变量扩展到当前位置。还是来看两个例子:

 

第一个例子中,“$(frobozz)”值是“yes”,第二个则是“no”。 第四个条件关键字是“ifndef”。其语法是:

 

这个我就不多说了,和“ifdef”是相反的意思。

这一行上,多余的空格是被允许的,但是不能以[Tab]键 做为开始(不然就被认为是命令)。而注释符“#”同样也是安全的。“else”和“endif” 也一样,只要不是以[Tab]键开始就行了。

特别注意的是,make 是在读取 Makefile 时就计算条件表达式的值,并根据条件表达式的 值来选择语句,所以,你最好不要把自动化变量(如“$@”等)放入条件表达式中,因为自 动化变量是在运行时才有的。

而且,为了避免混乱,make 不允许把整个条件语句分成两部分放在不同的文件中。

二、使用函数

在 Makefile 中可以使用函数来处理变量,从而让我们的命令或是规则更为的灵活和具有智 能。make 所支持的函数也不算很多,不过已经足够我们的操作了。函数调用后,函数的返 回值可以当做变量来使用。

1.函数的调用语法

函数调用,很像变量的使用,也是以“$”来标识的,其语法如下:

 

或是:

 

这里,就是函数名,make 支持的函数不多。是函数的参数,参 数间以逗号“,”分隔,而函数名和参数之间以“空格”分隔。函数调用以“$”开头,以圆括号或花括号把函数名和参数括起。感觉很像一个变量,是不是?函数中的参数可以使用变 量,为了风格的统一,函数和变量的括号最好一样,如使用“(x))”这样 的形式,而不是“{x})”的形式。因为统一会更清楚,也会减少一些不必 要的麻烦。

还是来看一个示例:

 

在这个示例中,(space)使用了$(empty)定义了一个空格, (bar)的定义用,调用了函数“subst”,这是一个替换函数, 这个函数有三个参数,第一个参数是被替换字串,第二个参数是替换字串,第三个参数是替 换操作作用的字串。这个函数也就是把(bar)的值是 “a,b,c”。

2.字符串处理函数

 

名称:字符串替换函数——subst。

功能:把字串中的字符串替换成

返回:函数返回被替换过后的字符串。

示例:

 

把“feet on the street”中的“ee”替换成“EE”,返回结果是“fEEt on the strEEt”。

 

名称:模式字符串替换函数——patsubst。

功能:查找中的单词(单词以“空格”、“Tab”或“回车”“换 行”分隔)是否符合模式,如果匹配的话,则以替换。这里,可 以包括通配符“%”,表示任意长度的字串。如果中也包含“%”,那么,中的这个“%”将是中的那个“%”所代表的字串。(可以用“\” 来转义,以“\%”来表示真实含义的“%”字符)

返回:函数返回被替换过后的字符串。

示例:

 

把字串“x.c.c bar.c”符合模式[%.c]的单词替换成[%.o],返回结果是“x.c.o bar.o”

备注:

这 和 我 们 前 面 “ 变 量 章 节 ” 说 过 的 相 关 知 识 有 点 相 似 。 如 : “ (patsubst ,,(var: =)” 则相当于“(var))”。例如有:objects = foo.o bar.o baz.o , 那 么 ,“ (patsubst %.o,%.c,$(objects))”是一样的。

 

名称:去空格函数——strip。

功能:去掉字串中开头和结尾的空字符。

返回:返回被去掉空格的字符串值。

示例:

 

把字串“a b c ”去到开头和结尾的空格,结果是“a b c”。

 

名称:查找字符串函数——findstring。

功能:在字串中查找字串。

返回:如果找到,那么返回,否则返回空字符串。

示例:

 

第一个函数返回“a”字符串,第二个返回“”字符串(空字符串)

 

名称:过滤函数——filter。

功能:以模式过滤字符串中的单词,保留符合模式的单 词。可以有多个模式。

返回:返回符合模式的字串。

示例:

 

(sources))返回的值是“foo.c bar.c baz.s”。

 

名称:反过滤函数——filter-out。

功能:以模式过滤字符串中的单词,去除符合模式的单 词。可以有多个模式。

返回:返回不符合模式的字串。

示例:

 

(mains),$(objects)) 返回值是“foo.o bar.o”。

 

名称:排序函数——sort。

功能:给字符串中的单词排序(升序)。

返回:返回排序后的字符串。

示例:$(sort foo bar lose)返回“bar foo lose” 。

备注:sort 函数会去掉中相同的单词。

 

名称:取单词函数——word。

功能:取字符串中第个单词。(从一开始)

返回:返回字符串中第个单词。如果中的单词数要大,那么 返回空字符串。

示例:$(word 2, foo bar baz)返回值是“bar”。

 

名称:取单词串函数——wordlist。

功能:从字符串中取从<s> 开始到的单词串。<s>和是一个数字。

返回:返回字符串中从<s>到的单词字串。如果<s>比中的单词数 要大,那么返回空字符串。如果大于的单词数,那么返回从<s>开始,到 结束的单词串。 示例: $(wordlist 2, 3, foo bar baz)返回值是“bar baz”。

$(words <text>)

名称:单词个数统计函数——words。

功能:统计中字符串中的单词个数。

返回:返回中的单词数。

示例:$(words, foo bar baz)返回值是“3”。

备注:如果我们要取中最后的一个单词,我们可以这样:(words ),)。

$(firstword <text>)

名称:首单词函数——firstword。

功能:取字符串中的第一个单词。

返回:返回字符串的第一个单词。

示例:$(firstword foo bar)返回值是“foo”。

备注:这个函数可以用 word 函数来实现:$(word 1,)。

以上,是所有的字符串操作函数,如果搭配混合使用,可以完成比较复杂的功能。这里,举一个现实中应用的例子。我们知道,make 使用“VPATH”变量来指定“依赖文件”的搜索 路径。于是,我们可以利用这个搜索路径来指定编译器对头文件的搜索路径参数 CFLAGS, 如:

override CFLAGS += $(patsubst %,-I%,$(subst :, ,$(VPATH)))

如 果 我 们 的 “ (patsubst %,-I%,(VPATH)))”将返回“-Isrc -I../headers”,这正是 cc 或 gcc 搜索头文件路径的参数。

3.文件名操作函数

下面我们要介绍的函数主要是处理文件名的。每个函数的参数字符串都会被当做一个或是一系列的文件名来对待。

$(dir <names...>)

名称:取目录函数——dir。

功能:从文件名序列中取出目录部分。目录部分是指最后一个反斜杠(“/”) 之前的部分。如果没有反斜杠,那么返回“./”。

返回:返回文件名序列的目录部分。

示例: $(dir src/foo.c hacks)返回值是“src/ ./”。

$(notdir <names...>)

名称:取文件函数——notdir。

功能:从文件名序列中取出非目录部分。非目录部分是指最后一个反斜杠(“/”)之后的部分。

返回:返回文件名序列的非目录部分。

示例: $(notdir src/foo.c hacks)返回值是“foo.c hacks”。

$(suffix <names...>)

名称:取后缀函数——suffix。

功能:从文件名序列中取出各个文件名的后缀。

返回:返回文件名序列的后缀序列,如果文件没有后缀,则返回空字串。

示例:$(suffix src/foo.c src-1.0/bar.c hacks)返回值是“.c .c”。

$(basename <names...>)

名称:取前缀函数——basename。

功能:从文件名序列中取出各个文件名的前缀部分。

返回:返回文件名序列的前缀序列,如果文件没有前缀,则返回空字串。

示例:$(basename src/foo.c src-1.0/bar.c hacks)返回值是“src/foo src-1.0/bar hacks”。

$(addsuffix <suffix>,<names...>)

名称:加后缀函数——addsuffix。

功能:把后缀加到中的每个单词后面。

返回:返回加过后缀的文件名序列。

示例:$(addsuffix .c,foo bar)返回值是“foo.c bar.c”。

$(addprefix <prefix>,<names...>)

名称:加前缀函数——addprefix。

功能:把前缀加到中的每个单词后面。

返回:返回加过前缀的文件名序列。

示例:$(addprefix src/,foo bar)返回值是“src/foo src/bar”。

$(join <list1>,<list2>)

名称:连接函数——join。

功能:把中的单词对应地加到的单词后面。如果的单词个 数要比的多,那么,中的多出来的单词将保持原样。如果的单 词个数要比多,那么,多出来的单词将被复制到中。

返回:返回连接过后的字符串。

示例:$(join aaa bbb , 111 222 333)返回值是“aaa111 bbb222 333”。

4.foreach函数

foreach 函数和别的函数非常的不一样。因为这个函数是用来做循环用的,Makefile 中 的 foreach 函数几乎是仿照于 Unix 标准 Shell(/bin/sh)中的 for 语句,或是 C-Shell (/bin/csh)中的 foreach 语句而构建的。它的语法是:

$(foreach <var>,<list>,<text>)

这个函数的意思是,把参数中的单词逐一取出放到参数所指定的变量中,然 后再执行所包含的表达式。每一次会返回一个字符串,循环过程中, 的所返回的每个字符串会以空格分隔,最后当整个循环结束时,所返回的每个字符 串所组成的整个字符串(以空格分隔)将会是 foreach 函数的返回值。

所以,最好是一个变量名,可以是一个表达式,而中一般会使用 这个参数来依次枚举中的单词。举个例子:

names := a b c d
files := $(foreach n,$(names),$(n).o)

上面的例子中,(n).o”每次根 据“$(n)”计算出一个值,这些值以空格分隔,最后作为 foreach 函数的返回,所以, $(files)的值是“a.o b.o c.o d.o”。

注意,foreach 中的参数是一个临时的局部变量,foreach 函数执行完后,参数 的变量将不在作用,其作用域只在 foreach 函数当中。

5.if函数

if 函数很像 GNU 的 make 所支持的条件语句——ifeq(参见前面所述的章节),if 函数的语法是:

$(if <condition>,<then-part>)

或是

$(if <condition>,<then-part>,<else-part>)

可见,if 函数可以包含“else”部分,或是不含。即 if 函数的参数可以是两个,也可以 是三个。参数是 if 的表达式,如果其返回的为非空字符串,那么这个表达式 就相当于返回真,于是,会被计算,否则会被计算。

而 if 函数的返回值是,如果为真(非空字符串),那个会是整 个函数的返回值,如果为假(空字符串),那么会是整个函数 的返回值,此时如果没有被定义,那么,整个函数返回空字串。

所以,只会有一个被计算。

6.call函数

call 函数是唯一一个可以用来创建新的参数化的函数。你可以写一个非常复杂的表达式, 这个表达式中,你可以定义许多参数,然后你可以用 call 函数来向这个表达式传递参数。

其语法是:

$(call <expression>,<parm1>,<parm2>,<parm3>...)

当 make 执行这个函数时,参数中的变量,如(2),$(3)等,会被 参数依次取代。而的返回值就是 call 函 数的返回值。例如:

reverse = $(1) $(2)
foo = $(call reverse,a,b)

那么,foo 的值就是“a b”。当然,参数的次序是可以自定义的,不一定是顺序的,如:

reverse = $(2) $(1)
foo = $(call reverse,a,b)

此时的 foo 的值就是“b a”。

7.origin函数

origin 函数不像其它的函数,他并不操作变量的值,他只是告诉你你的这个变量是哪里来 的?其语法是:

$(origin <variable>)

注意,是变量的名字,不应该是引用。所以你最好不要在中使用 “$”字符。Origin 函数会以其返回值来告诉你这个变量的“出生情况”,下面,是 origin 函数的返回值:

“undefined”

如果从来没有定义过,origin 函数返回这个值“undefined”。

“default”

如果是一个默认的定义,比如“CC”这个变量,这种变量我们将在后面 讲述。

“environment”

如果是一个环境变量,并且当 Makefile 被执行时,“-e”参数没有被 打开。

“file”

如果这个变量被定义在 Makefile 中。

“command line”

如果这个变量是被命令行定义的。

“override”

如果是被 override 指示符重新定义的。

“automatic”

如果是一个命令运行中的自动化变量。关于自动化变量将在后面讲述。

这些信息对于我们编写 Makefile 是非常有用的,例如,假设我们有一个 Makefile 其包 了一个定义文件 Make.def,在 Make.def 中定义了一个变量“bletch”,而我们的环境中 也有一个环境变量“bletch”,此时,我们想判断一下,如果变量来源于环境,那么我们就 把之重定义了,如果来源于 Make.def 或是命令行等非环境的,那么我们就不重新定义它。

于是,在我们的 Makefile 中,我们可以这样写:

ifdef bletch
ifeq "$(origin bletch)" "environment"
bletch = barf, gag, etc.
endif
endif

当然,你也许会说,使用 override 关键字不就可以重新定义环境中的变量了吗?为什么需 要使用这样的步骤?是的,我们用 override 是可以达到这样的效果,可是 override 过 于粗暴,它同时会把从命令行定义的变量也覆盖了,而我们只想重新定义环境传来的,而不 想重新定义命令行传来的。

8.shell函数

shell 函数也不像其它的函数。顾名思义,它的参数应该就是操作系统 Shell 的命令。它 和反引号“`”是相同的功能。这就是说,shell 函数把执行操作系统命令后的输出作为函 数返回。于是,我们可以用操作系统命令以及字符串处理命令 awk,sed 等等命令来生成一 个变量,如:

contents := $(shell cat foo)
files := $(shell echo *.c)

注意,这个函数会新生成一个 Shell 程序来执行命令,所以你要注意其运行性能,如果你 的 Makefile 中有一些比较复杂的规则,并大量使用了这个函数,那么对于你的系统性能是 有害的。特别是 Makefile 的隐晦的规则可能会让你的 shell 函数执行的次数比你想像的 多得多。

9.控制make的函数

make 提供了一些函数来控制 make 的运行。通常,你需要检测一些运行 Makefile 时的运 行时信息,并且根据这些信息来决定,你是让 make 继续执行,还是停止。

$(error <text ...>)

产生一个致命的错误,是错误信息。注意,error 函数不会在一被使用就 会产生错误信息,所以如果你把其定义在某个变量中,并在后续的脚本中使用这个变量,那 么也是可以的。例如:

示例一:
ifdef ERROR_001
$(error error is $(ERROR_001))
endif
示例二:
ERR = $(error found an error!)
.PHONY: err
err: ; $(ERR)

示例一会在变量 ERROR_001 定义了后执行时产生 error 调用,而示例二则在目录 err 被执行时才发生 error 调用。

$(warning <text ...>)

这个函数很像 error 函数,只是它并不会让 make 退出,只是输出一段警告信息,而 make 继续执行。

三、模块级Makefile的模板式用法

 

或者

 

只需要稍加改变或者完全不改变就可以用在某个模块下,当然这样做的局限性较大,但不得不说这就是学完Makefile后的一个灵活应用。

四、最后

其实到这里你已经可能已经有感觉,Makefile就像shell脚本一样,只不过Makefile用于编译程序,当你掌握了函数,你也就真正登堂入室了。