make的内嵌函数(1)

1         make的函数

GNU make的函数为我们提供了处理文件名、变量、文本和命令的方法。是我们的Makefile更为灵活和健壮。我们可以在需要的地方地调用函数来处理指定的文本（参数），函数的在调用它的地方被替换为它的处理结果。函数调用（引用）的展开和变量引用的展开方式相同。

GNU make函数的调用格式类似于变量的引用格式，以“$”开头表示一个引用的过程。语法格式如下：

$(FUNCTION ARGUMENTS)

或者：

 ${FUNCTION ARGUMENTS}

对于函数调用的格式有以下几点说明：

1.       调用个语法格式中“FUNCTION”是需要调用的函数名，它应该是make内嵌的函数名。对于用户自己的函数需要通过make的“call”函数来间接调用。

2.       “ARGUMENTS”是函数的参数，参数和函数名之间使用若干个空格或者[tab]字符分割（建议使用一个空格，这样不仅使在书写上比较直观，更重要的是当你不能确定哪些地方是允许用[Tab]时候，避免不必要的麻烦）；如果存在多个参数时，参数之间使用逗号“,”分割。

3.      以“$”开头，使用成对的圆括号或花括号把函数名和参数括起（在Makefile中，圆括号和花括号在任何地方必须成对出现）。参数中存在变量或者函数的引用时，对它们使用所使用的分界符（圆括号或者花括号）建议使用和引用函数使用的相同。最好不要使用两种不同的括号。建议在变量的引用和函数的引用中统一使用圆括号；这样在使用“vim”编辑器书写Makefile时，使用圆括它可以亮度显式make的内嵌函数名，避免函数名的拼写错误。一般在Makefile中应该这样来书写“$(sort $(x))”；而不是“$(sort ${x})”和其它几种。

4.      函数处理参数时，参数中如果存在对其它变量或者函数的引用，首先对这些引用进行展开得到参数的实际内容。而后才对它们进行处理。参数的展开顺序是按照参数的先后顺序来进行的。

5.       书写时，函数的参数中不能出现逗号“,”和空格。这是因为逗号被作为多个参数的分隔符，前导空格会被忽略。在实际书写Makefile时，当需要使用这两个作为函数的参数时，可以把它们赋值给变量，在函数的参数中使用相应的变量引用。我们来看一个这样的例子：

comma:= ,

empty:=

space:= $(empty) $(empty)

foo:= a b c

bar:= $(subst $(space),$(comma),$(foo))

    

这样我们就实现了“bar”的值是“a,b,c”。

1.2        文本处理函数

以下是GNU make内嵌的文本（字符串）处理函数。

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

函数功能：把字串“TEXT”中的“FROM”字符替换为“TO”。

返回值：替换后的新字符串。

示例：

 $(subst ee,EE,feet on the street)

 替换“feet on the street”中的“ee”为“EE”，结果是新的字符串“fEEt on the strEEt”。

1.2.2       $(patsubst PATTERN,REPLACEMENT,TEXT)

函数名称：模式替换函数—patsubst。

函数功能：搜索“TEXT”中以空格分开的单词，将否符合模式“TATTERN”替换为“REPLACEMENT”。参数“PATTERN”中可以使用模式通配符“%”来代表一个单词中的若干字符。如果参数“REPLACEMENT”中也包含一个“%”，那么“REPLACEMENT”中的“%”将是“TATTERN”中的那个“%”所代表的字符串。在“TATTERN”和“REPLACEMENT”中，只有第一个“%”被作为模式字符来处理，后续的作为字符本上来处理。在两个参数中当使用第一个“%”本是字符本身时，可使用反斜杠“\”对它进行转义处理（转义处理的机制和使用静态模式的转义一致，具体可参考 3.12.1 静态模式规则的语法 一小节）。

返回值：替换后的新字符串。

函数说明：参数“TEXT”单词之间的多个空格在处理时被合并为一个空格，但前导和结尾空格忽略。

示例：

$(patsubst %.c,%.o,x.c.c bar.c)

 把字串“x.c.c bar.c”中以.c结尾的单词替换成以.o结尾的字符。函数的返回结果是“x.c.o bar.o”

本文的第五章在 变量的高级用法的第一小节 中我们曾经讨论了变量的替换引用，它是一个简化版的“patsubst”函数在变量引用过程的实现。变量替换引用中：

 $(VAR:PATTERN=REPLACEMENT)

 就等于：

 $(patsubst PATTERN,REPLACEMENT,$(VAR))

 而另外一种更为简单的替换字符后缀的实现：

 $(VAR:SUFFIX=REPLACEMENT)

 它等于：

 $(patsubst %SUFFIX,%REPLACEMENT,$(VAR))

 例如我们存在一个代表所有.o文件的变量。定义为“objects = foo.o bar.o baz.o”。为了得到这些.o文件所对应的.c源文件。我们可以使用以下两种方式的任意一个：

$(objects:.o=.c)

$(patsubst %.o,%.c,$(objects))

1.2.3       $(strip STRINT)

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

函数功能：去掉字串（若干单词，使用若干空字符分割）“STRINT”开头和结尾的空字符，并将其中多个连续空字符合并为一个空字符。

返回值：无前导和结尾空字符、使用单一空格分割的多单词字符串。

函数说明：空字符包括空格、[Tab]等不可显示字符。

示例：

STR =        a    b c    

LOSTR = $(strip $(STR))

结果是“a b c”。

“strip”函数经常用在条件判断语句的表达式中，确保表达式比较的可靠和健壮！参考 6.2.1.2 关键字“ifeq” 一小节的例子。

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

函数功能：搜索字串“IN”，查找“FIND”字串。

返回值：如果在“IN”之中存在“FIND”，则返回“FIND”，否则返回空。

函数说明：字串“IN”之中可以包含空格、[Tab]。搜索需要是严格的文本匹配。

示例：

$(findstring a,a b c)

$(findstring a,b c)

第一个函数结果是字“a”；第二个值为空字符。

函数名称：过滤函数—filter。

函数功能：过滤掉字串“TEXT”中所有不符合模式“PATTERN”的单词，保留所有符合此模式的单词。可以使用多个模式。模式中一般需要包含模式字符“%”。存在多个模式时，模式表达式之间使用空格分割。

返回值：空格分割的“TEXT”字串中所有符合模式“PATTERN”的字串。

函数说明：“filter”函数可以用来去除一个变量中的某些字符串，我们下边的例子中就是用到了此函数。

示例：

sources := foo.c bar.c baz.s ugh.h

foo: $(sources)

cc $(filter %.c %.s,$(sources)) -o foo

 使用“$(filter %.c %.s,$(sources))”的返回值给cc来编译生成目标“foo”，函数返回值为“foo.c bar.c baz.s”。

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

函数功能：和“filter”函数事项的功能相反。过滤掉字串“TEXT”中所有符合模式“PATTERN”的单词，保留所有不符合此模式的单词。可以有多个模式。存在多个模式时，模式表达式之间使用空格分割。。

返回值：空格分割的“TEXT”字串中所有不符合模式“PATTERN”的字串。

函数说明：“filter-out”函数也可以用来去除一个变量中的某些字符串，（实现和“filter”函数相反）。

示例：

objects=main1.o foo.o main2.o bar.o

mains=main1.o main2.o

$(filter-out $(mains),$(objects))

实现了去除变量“objects”中“mains”定义的字串（文件名）功能。它的返回值为“foo.o bar.o”。

函数名称：排序函数—sort。

函数功能：给字串“LIST”中的单词以首字母为准进行排序（升序），并取掉重复的单词。

返回值：空格分割的没有重复单词的字串。

函数说明：两个功能，排序和去字串中的重复单词。可以单独使用其中一个功能。

示例：

$(sort foo bar lose foo)

 返回值为：“bar foo lose”。

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

函数功能：取字串“TEXT”中第“N”个单词（“N”的值从1开始）。

返回值：返回字串“TEXT”中第“N”个单词。

函数说明：如果“N”值大于字串“TEXT”中单词的数目，返回空字符串。如果“N”为0，出错！

示例：

$(word 2, foo bar baz)

返回值为“bar”。

函数名称：取字串函数—wordlist。

函数功能：从字串“TEXT”中取出从“S”开始到“E”的单词串。“S”和“E”表示单词在字串中位置的数字。

返回值：字串“TEXT”中从第“S”到“E”（包括“E”）的单词字串。

函数说明：“S”和“E”都是从1开始的数字。

当“S”比“TEXT”中的字数大时，返回空。如果“E”大于“TEXT”字数，返回从“S”开始，到“TEXT”结束的单词串。如果“S”大于“E”，返回空。

示例：

$(wordlist 2, 3, foo bar baz)

返回值为：“bar baz”。

函数名称：统计单词数目函数—words。

函数功能：字算字串“TEXT”中单词的数目。

返回值：“TEXT”字串中的单词数。

示例：

$(words, foo bar)

返回值是“2”。所以字串“TEXT”的最后一个单词就是：$(word $(words TEXT),TEXT)。

函数名称：取首单词函数—firstword。

函数功能：取字串“NAMES…”中的第一个单词。

返回值：字串“NAMES…”的第一个单词。

函数说明：“NAMES”被认为是使用空格分割的多个单词（名字）的序列。函数忽略“NAMES…”中除第一个单词以外的所有的单词。

示例：

$(firstword foo bar)

返回值为“foo”。函数“firstword”实现的功能等效于“$(word 1, NAMES…)”。

 以上11个函数是make内嵌的的文本处理函数。在书写Makefile时可搭配使用，来实现复杂功能。最后我们使用这些函数来实现一个实际应用的需求。例子中我们使用函数“subst”和“patsbust”。Makefile中可以使用变量“VPATH”（参考 3.5.1 一般搜索（变量VPATH） 一小节）来指定搜索路径。我们的例子中需要指定所有头文件的搜索路径也在这些目录下。头文件的搜索路径需要使用GCC的“-I”参数通过命令行选项来实现，而通过“VPATH”罗列的目录是用冒号“:”分割的。如下就是Makefile的片段：

……

VPATH = src:../includes

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

…….

那么第二条语句所实现的功能就是“CFLAGS += -Isrc –I../includes”。

1.3        文件名处理函数

GNU make除上一节所介绍的内嵌的文本处理函数之外，还存在一些针对于文件名的处理函数。这些函数主要用来对一系列空格分割的文件名进行转换，这些函数的参数被作为若干个文件名来对待。函数对作为参数的一组文件名按照一定方式进行处理并返回空格分割的多个文件名序列。

1.3.1       $(dir NAMES…)

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

函数功能：从文件名序列“NAMES…”中取出各个文件名目录部分。文件名的目录部分就是包含在文件名中的最后一个斜线（“/”）（包括斜线）之前的部分。

返回值：空格分割的文件名序列“NAMES…”中每一个文件的目录部分。

函数说明：如果文件名中没有斜线，认为此文件为当前目录（“./”）下的文件。

示例：

$(dir src/foo.c hacks)

返回值为“src/ ./”。

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

函数功能：从文件名序列“NAMES…”中取出非目录部分。目录部分是指最后一个斜线（“/”）（包括斜线）之前的部分。删除所有文件名中的目录部分，只保留非目录部分。

返回值：文件名序列“NAMES…”中每一个文件的非目录部分。

函数说明：如果“NAMES…”中存在不包含斜线的文件名，则不改变这个文件名。以反斜线结尾的文件名，是用空串代替，因此当“NAMES…”中存在多个这样的文件名时，返回结果中分割各个文件名的空格数目将不确定！这是此函数的一个缺陷。

示例：

 $(notdir src/foo.c hacks)

 返回值为：“foo.c hacks”。

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

函数功能：从文件名序列“NAMES…”中取出各个文件名的后缀。后缀是文件名中最后一个以点“.”开始的（包含点号）部分，如果文件名中不包含一个点号，则为空。

返回值：以空格分割的文件名序列“NAMES…”中每一个文件的后缀序列。

函数说明：“NAMES…”是多个文件名时，返回值是多个以空格分割的单词序列。如果文件名没有后缀部分，则返回空。

示例：

 $(suffix src/foo.c src-1.0/bar.c hacks)

 返回值为“.c .c”。

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

函数功能：从文件名序列“NAMES…”中取出各个文件名的前缀部分（点号之后的部分）。前缀部分指的是文件名中最后一个点号之前的部分。

返回值：空格分割的文件名序列“NAMES…”中各个文件的前缀序列。如果文件没有前缀，则返回空字串。

函数说明：如果“NAMES…”中包含没有后缀的文件名，此文件名不改变。如果一个文件名中存在多个点号，则返回值为此文件名的最后一个点号之前的文件名部分。

示例：

 $(basename src/foo.c src-1.0/bar.c /home/jack/.font.cache-1 hacks)

 返回值为：“src/foo src-1.0/bar /home/jack/.font hacks”。

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

函数功能：为“NAMES…”中的每一个文件名添加后缀“SUFFIX”。参数“NAMES…”为空格分割的文件名序列，将“SUFFIX”追加到此序列的每一个文件名的末尾。

返回值：以单空格分割的添加了后缀“SUFFIX”的文件名序列。

函数说明：

示例：

 $(addsuffix .c,foo bar)

 返回值为“foo.c bar.c”。

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

函数功能：为“NAMES…”中的每一个文件名添加前缀“PREFIX”。参数“NAMES…”是空格分割的文件名序列，将“SUFFIX”添加到此序列的每一个文件名之前。

返回值：以单空格分割的添加了前缀“PREFIX”的文件名序列。

函数说明：

示例：

 $(addprefix src/,foo bar)

 返回值为“src/foo src/bar”。

函数名称：单词连接函数——join。

函数功能：将字串“LIST1”和字串“LIST2”各单词进行对应连接。就是将“LIST2”中的第一个单词追加“LIST1”第一个单词字后合并为一个单词；将“LIST2”中的第二个单词追加到“LIST1”的第一个单词之后并合并为一个单词，……依次列推。

返回值：单空格分割的合并后的字（文件名）序列。

函数说明：如果“LIST1”和“LIST2”中的字数目不一致时，两者中多余部分将被作为返回序列的一部分。

示例1：

$(join a b , .c .o)

 返回值为：“a.c b.o”。

示例2：

$(join a b c , .c .o)

 返回值为：“a.c b.o c”。

1.3.8       $(wildcard PATTERN)

函数名称：获取匹配模式文件名函数—wildcard

函数功能：列出当前目录下所有符合模式“PATTERN”格式的文件名。

返回值：空格分割的、存在当前目录下的所有符合模式“PATTERN”的文件名。

函数说明：“PATTERN”使用shell可识别的通配符，包括“?”（单字符）、“*”（多字符）等。可参考 3.4 文件名中使用通配符 一节。

示例：

 $(wildcard *.c)

 返回值为当前目录下所有.c源文件列表。

1.4        foreach 函数

函数“foreach”不同于其它函数。它是一个循环函数。类似于Linux的shell中的循环（for语句）。

Ø         “foreach”函数的语法：

 $(foreach VAR,LIST,TEXT)

 Ø         函数功能：这个函数的工作过程是这样的：如果必要（存在变量或者函数的引用），首先展开变量“VAR”和“LIST”；而表达式“TEXT”中的变量引用不被展开。执行时把“LIST”中使用空格分割的单词依次取出赋值给变量“VAR”，然后执行“TEXT”表达式。重复直到“LIST”的最后一个单词（为空时结束）。“TEXT”中的变量或者函数引用在执行时才被展开，因此如果在“TEXT”中存在对“VAR”的引用，那么“VAR”的值在每一次展开式将会到的不同的值。

Ø         返回值：空格分割的多次表达式“TEXT”的计算的结果。

我们来看一个例子，实现了将变量“files”赋值为目录“dirs”下所有文件列表：

 dirs := a b c d

files := $(foreach dir,$(dirs),$(wildcard $(dir)/*))

 例子中，“TEXT”的表达式为“$(wildcard $(dir)/*)”。表达式第一次执行时将展开为“$(wildcard a/*)”；第二次执行时将展开为“$(wildcard b/*)”；第三次展开为“$(wildcard c/*)”；….；以此类推。所以此函数所实现的功能就和一下语句等价：

files := $(wildcard a/* b/* c/* d/*)

 函数的“TEXT”表达式过于复杂时，我们可以通过定义一个中间的变量来表示表达式的一部分。对于上边的例子我们也可以对各个部分分解来实现，如下：

 find_files = $(wildcard $(dir)/*)

dirs := a b c d

files := $(foreach dir,$(dirs),$(find_files))

 在这里我们定义了一个变量（也可以称之为表达式），需要注意的是，在这里定义的是“递归展开”时的变量“find_files”。保证定义时变量值中的引用不被展开，而是在“find_files”才展开（如果这里使用直接展开式的定义将是无效的表达式）。可参考 5.2 两种变量定义 一节。

Ø        函数说明：函数中参数“VAR”是一个局部的临时变量，它只在“foreach”函数的执行过程中有效，它在汉书中对它的定义不会影响其它部分定义的同名“VAR”变量的值。它在函数的执行过程中是一个“直接展开”式变量。

 在使用函数“foreach”时，需要注意：变量“VAR”的名字。我们建议使用一个单词、最好能够表达其含义的名字，不要使用一个奇怪的字符串作为变量名。虽然在可能在执行时没有错误，但是可能会让人很费解。

没有人会喜欢这种方式，尽管可能它可以正常工作：

 files := $(foreach Esta escrito en espanol!,b c ch,$(find_files))

 1.5        if 函数

函数“if”提供了一个在函数上下文中实现条件判断的功能。就像make所支持的条件语句—ifeq（参考 6.2.1.1 关键字“ifeq” 一小节）一样。

Ø         函数语法：

 $(if CONDITION,THEN-PART[,ELSE-PART])

 Ø         函数功能：第一个参数“CONDITION”，在函数执行时忽略其前导和结尾空字符并展开。“CONDITION”的展开结果非空，则条件为真，就将第二个参数“THEN_PATR”作为函数的计算表达式，函数的返回值就是第二表达式的计算结果；“CONDITION”的展开结果为空，将第三个参数“ELSE-PART”作为函数的表达式，返回结果为第三个表达式的计算结果。

Ø         返回值：根据条件决定函数的返回值是第一个或者第二个参数表达式的计算结果。当不存在第三个参数“ELSE-PART”，并且“CONDITION”展开为空，函数返回空。

Ø         函数说明：函数的条件表达式“CONDITION”决定了，函数的返回值只能是“THEN-PART”或者“ELSE-PART”两个之一的计算结果。

Ø         函数示例：

 SUBDIR += $(if $(SRC_DIR) $(SRC_DIR),/home/src)

 

函数的结果是：如果“SRC_DIR”变量值不为空，则将变量“SRC_DIR”指定的目录作为一个子目录；否则将目录“/home/src”作为一个子目录。