Makefile系列之五 ：函数

一、函数的调用语法
　　函数调用与变量一样，也是以“$”来标识的，其语法如下：
　　　　　　　　　　$(<function> <arguments>)
　　或是
　　　　　　　　　　${<function> <arguments>}
　　<function>就是函数名，<arguments>是函数的参数，参数间以逗号“,”分隔，而函数名和参数之间以“空格”分隔。函数调用以“$”开头，以圆括号或花括号把函数名和参数括起。

二、字符串处理函数
　　１）$(subst <from>,<to>,<text>)
　　　　名称：字符串替换函数——subst。
　　　　功能：把字串<text>中的<from>字符串替换成<to>。
　　　　返回：函数返回被替换过后的字符串。
　　　　示例：
　　　　　　　　　　$(subst ee,EE,feet on the street)，
　　　　返回结果：“fEEt onthe strEEt”。

　　2) $(patsubst <pattern>,<replacement>,<text>)
　　　　名称：模式字符串替换函数——patsubst。
　　　　功能：查找<text>中的单词（单词以“空格”、“Tab”、“回车”或“换行”分隔）是否符合模式<pattern>，如果匹配的话，则以<replacement>替换。<pattern>可以包括通配符“%”，表示任意长度的字串。如果<replacement>中也包含“%”，那么，<replacement>中的这个“%”将是<pattern>中的那个“%”所代表的字串。（可以用“\”来转义，以“\%”来表示真实含义的“%”字符）
　　　　返回：函数返回被替换过后的字符串。
　　　　示例：
　　　　　　　　　　$(patsubst %.c,%.o,x.c.c bar.c)
　　　　把字串“x.c.c bar.c”符合模式[%.c]的单词替换成[%.o]，返回结果是“x.c.o bar.o”
　　　　备注：“$(var:<pattern>=<replacement>)”  <=> “$(patsubst <pattern>,<replacement>,$(var))”，
　　　　　　“$(var: <suffix>=<replacement>)” <=> “$(patsubst %<suffix>,%<replacement>,$(var))”。
　　3) $(strip <string>)
　　　　名称：去空格函数——strip。
　　　　功能：去掉<string>字串中开头和结尾的空字符。
　　　　返回：返回被去掉空格的字符串值。
　　　　示例：
　　　　　　　　　　$(strip a b c )
　　　　把字串“a b c ”去到开头和结尾的空格，结果是“a b c”。
　　4) $(findstring <find>,<in>)
　　　　名称：查找字符串函数——findstring。
　　　　功能：在字串<in>中查找<find>字串。
　　　　返回：如果找到，那么返回<find>，否则返回空字符串。
　　　　示例：
　　　　　　　　　　$(findstring a,a b c)
　　　　　　　　　　$(findstring a,b c)
　　　　第一个函数返回“a”字符串，第二个返回“”字符串（空字符串）
　　5) $(filter <pattern...>,<text>)
　　　　名称：过滤函数——filter。
　　　　功能：以<pattern>模式过滤<text>字符串中的单词，保留符合模式<pattern>的单词。可以有多个模式。
　　　　返回：返回符合模式<pattern>的字串。
　　　　示例：
　　　　　　　　　　sources := foo.c bar.c baz.s ugh.h
　　　　　　　　　　foo: $(sources)
　　　　　　　　　　　　cc $(filter %.c %.s,$(sources)) -o foo
　　　　$(filter %.c %.s,$(sources))返回的值是“foo.c bar.c baz.s”。
　　6) $(filter-out <pattern...>,<text>)
　　　　名称：反过滤函数——filter-out。
　　　　功能：以<pattern>模式过滤<text>字符串中的单词，去除符合模式<pattern>的单词。可以有多个模式。
　　　　返回：返回不符合模式<pattern>的字串。
　　　　示例：
　　　　　　　　　　objects=main1.o foo.o main2.o bar.o
　　　　　　　　　　mains=main1.o main2.o
　　　　$(filter-out $(mains),$(objects)) 返回值是“foo.o bar.o”。
　　7) $(sort <list>)
　　　　名称：排序函数——sort。
　　　　功能：给字符串<list>中的单词排序（升序）。
　　　　返回：返回排序后的字符串。
　　　　如$(sort foo bar lose)返回“bar foo lose” 。
　　　　备注：sort函数会去掉<list>中相同的单词。
　　8) $(word <n>,<text>)
　　　　名称：取单词函数——word。
　　　　功能：取字符串<text>中第<n>个单词。（从一开始）
　　　　返回：返回字符串<text>中第<n>个单词。如果<n>比<text>中的单词数要大，那么返回空字符串。
　　　　如　$(word 2, foo bar baz)返回值是“bar”。
　　9) $(wordlist <s>,<e>,<text>)
　　　　名称：取单词串函数——wordlist。
　　　　功能：从字符串<text>中取从<s>开始到<e>的单词串。<s>和<e>是一个数字。
　　　　返回：返回字符串<text>中从<s>到<e>的单词字串。如果<s>比<text>中 的单词数要大，那么返回空字符串。如果<e>大于<text>的单词数，那么返回从<s>开始， 到<text>结束的单词串。
　　　　如 $(wordlist 2, 3, foo bar baz)返回值是“bar baz”。
　　10) $(words <text>)
　　　　名称：单词个数统计函数——words。
　　　　功能：统计<text>中字符串中的单词个数。
　　　　返回：返回<text>中的单词数。
　　　　如$(words, foo bar baz)返回值是“3”，如取<text>中最后的一个单词：$(word $(words<text>),<text>)。
　　11) $(firstword <text>)
　　　　名称：首单词函数——firstword。
　　　　功能：取字符串<text>中的第一个单词。
　　　　返回：返回字符串<text>的第一个单词。
　　　　如　$(firstword foo bar)返回值是“foo”。这个函数可以用word函数来实现：$(word 1,<text>)。
　　以上，是所有的字符串操作函数，如搭配混合使用，可完成比较复杂的功能。举个例子，make用“VPATH”变量来指定“依赖文件”的搜索路径。于是可用这个搜索路径来指定编译器对头文件的搜索路径参数CFLAGS，如：
　　　　　　　　　　override CFLAGS += $(patsubst %,-I%,$(subst :, ,$(VPATH)))
　　如果我们的“$(VPATH)”值是“src:../headers”，那么“$(patsubst %,-I%,$(subst :, ,$(VPATH)))”将返回“-Isrc -I../headers”，这正是cc或gcc搜索头文件路径的参数。

三、文件名操作函数
　　１）$(dir <names...>)
　　　　名称：取目录函数——dir。
　　　　功能：从文件名序列<names>中取出目录部分。目录部分是指最后一个反斜杠（“/”）之前的部分。如果没有反　　　　斜杠，那么返回“./”。
　　　　返回：返回文件名序列<names>的目录部分。
　　　　示例： $(dir src/foo.c hacks)返回值是“src/ ./”。
　　２）$(notdir <names...>)
　　　　名称：取文件函数——notdir。
　　　　功能：从文件名序列<names>中取出非目录部分。非目录部分是指最后一个反斜杠（“/”）之后的部分。
　　　　返回：返回文件名序列<names>的非目录部分。
　　　　示例： $(notdir src/foo.c hacks)返回值是“foo.c hacks”。
　　３）$(suffix <names...>)
　　　　名称：取后缀函数——suffix。
　　　　功能：从文件名序列<names>中取出各个文件名的后缀。
　　　　返回：返回文件名序列<names>的后缀序列，如果文件没有后缀，则返回空字串。
　　　　示例：$(suffix src/foo.c src-1.0/bar.c hacks)返回值是“.c .c”。
　　４）$(basename <names...>)
　　　　名称：取前缀函数——basename。
　　　　功能：从文件名序列<names>中取出各个文件名的前缀部分。
　　　　返回：返回文件名序列<names>的前缀序列，如果文件没有前缀，则返回空字串。
　　　　示例：$(basename src/foo.c src-1.0/bar.c hacks)返回值是“src/foo　src-1.0/bar hacks”。
　　５）$(addsuffix <suffix>,<names...>)
　　　　名称：加后缀函数——addsuffix。
　　　　功能：把后缀<suffix>加到<names>中的每个单词后面。
　　　　返回：返回加过后缀的文件名序列。
　　　　示例：$(addsuffix .c,foo bar)返回值是“foo.c bar.c”。
　　６）$(addprefix <prefix>,<names...>)
　　　　名称：加前缀函数——addprefix。
　　　　功能：把前缀<prefix>加到<names>中的每个单词后面。
　　　　返回：返回加过前缀的文件名序列。
　　　　示例：$(addprefix src/,foo bar)返回值是“src/foo src/bar”。
　　７）$(join <list1>,<list2>)
　　　　名称：连接函数——join。
　　　　功能：把<list2>中的单词对应地加到<list1>的单词后面。如果<list1>的单词个数要比<list2>的多，<list1>中的多出来的单词将保持原样。如果<list2>的单词个数要 比<list1>多，<list2>多出来的单词将被复制到结果中。

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

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

四、foreach 函数
　　foreach函数的语法是：
　　　　　　　　$(foreach <var>,<list>,<text>)
　　这个函数的意思是，把参数<list>中的单词逐一取出放到参数<var>所指定的变量中，然后再执行<text>所包含的表达式。每一次<text>会返回一个字符串，循环过程中，<text>所返回的每个字符串会以空格分隔，最后当整个循环结束时，<text>所返回的每个字符串所组成的整个字符串（以空格分隔）将会是foreach函数的返回值。
　　例子：
　　　　　　　　names := a b c d
　　　　　　　　files := $(foreach n,$(names),$(n).o)
　　$(name)中的单词会被挨个取出，并存到变量“n”中，“$(n).o”每次根据“$(n)”计算出一个值，这些值以空格分隔，最后作为foreach函数的返回，所以，$(files)的值是“a.o b.o c.o d.o”。
　　注意，foreach中的<var>参数是一个临时的局部变量，foreach函数执行完后，参数<var>的变量将不在作用，其作用域只在foreach函数当中。

五、if 函数
　　if函数的语法是：
　　　　　　　　$(if <condition>,<then-part>)
　　或是
　　　　　　　　$(if <condition>,<then-part>,<else-part>)
　　如果<condition>为真（非空字符串），那个<then-part>会是整个函数的返回值，如果<condition>为假（空字符串），那么<else-part>会是整个函数的返回值，此时如果<else-part>没有被定义，那么，整个函数返回空字串。

六、call函数
　　call函数语法是：
　　　　　　　　$(call <expression>,<parm1>,<parm2>,<parm3>...)
　　当make执行这个函数时，<expression>参数中的变量，如$(1)，$(2)，$(3)等，会被参数<parm1>，<parm2>，<parm3>依次取代。而<expression>的返回值就是call函数的返回值。例如：
　　　　　　　　reverse = $(1) $(2)
　　　　　　　　foo = $(call reverse,a,b)
那么，foo的值就是“a b”。

七、origin函数
　　origin函数不像其它的函数，他并不操作变量的值，他只是告诉你你的这个变量是哪里来的？其语法是：
　　　　　　　　$(origin <variable>)
　　注意，<variable>是变量的名字，不应该是引用（前面用$字符）。

　　origin函数的返回值:
　　１）“undefined”
　　　　如果<variable>从来没有定义过，origin函数返回这个值“undefined”。
　　２）“default”
　　　　如果<variable>是一个默认的定义，比如“CC”这个变量，这种变量我们将在后面讲述。
　　３）“environment”
　　　　如果<variable>是一个环境变量，并且当Makefile被执行时，“-e”参数没有被打开。
　　４）“file”
　　　　如果<variable>这个变量被定义在Makefile中。
　　５）“command line”
　　　　如果<variable>这个变量是被命令行定义的。
　　６）“override”
　　　　如果<variable>是被override指示符重新定义的。
　　７）“automatic”
　　　　表明<variable>是一个命令运行中的自动化变量。
　　例如，假设我们有一个Makefile其包了一个定义文件Make.def，在Make.def中定义了一个变量“bletch”，而我们的环境中也有一个环境变量“bletch”，此时如果变量来源于环境，那么我们就把之重定义，如果来源于Make.def或是命令行等非环境的，那么我们就不重新定义它。于是，在我们的Makefile中，我们可以这样写：
　　　　　　　　　　ifdef bletch
　　　　　　　　　　　　ifeq "$(origin bletch)" "environment"
　　　　　　　　　　　　　　bletch = barf, gag, etc.
　　　　　　　　　　　　endif
　　　　　　　　　　endif

八、shell函数
　　shell函数的参数应该就是操作系统Shell的命令。它和反引号“`”是相同的功能，把执行操作系统命令后的输出作为函数
返回。如：
　　　　　　　　　　contents := $(shell cat foo)
　　　　　　　　　　files := $(shell echo *.c)
九、控制make的函数
　　make提供了一些函数来控制make的运行。
　　１）$(error <text ...>)
　　　　产生一个致命的错误，<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调用。