Makefile之函数使用

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

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

  $(<function> <arguments> )

或者

${<function> <arguments>}

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

字符串处理函数

• $(subst from,to,text )
  名称：字符串替换函数——subst。
  功能：把字串text中的from字符串替换成to。
  返回：函数返回被替换过后的字符串。
  示例：

  var=this is a makefile
  bar=$(subst t,T,$(var))
  
  target:
      @echo $(bar)

运行结果:

This is a makefile

• $(patsubst pattern,replacement,text )
  名称：模式字符串替换函数——patsubst。
  功能：查找text中的单词（单词以“空格”、“Tab”或“回车”“换行”分隔）是否符合模式pattern，如果匹配的话，则以replacement替换。这里，pattern可以包括通配符“%”，表示任意长度的字串。如果replacement中也包含“%”，那么，replacement中的这个“%”将是pattern中的那个“%”所代表的字串。（可以用“\”来转义，以“\%”来表示真实含义的“%”字符）返回：函数返回被替换过后的字符串。
  示例:

  src1=main.c fun1.c fun2.c
  obj1=$(patsubst %.c,%.o,$(src1))
  
  src2=Patsubst Test!
  obj2=$(patsubst P%,p%,$(src2))
  
  target:
      @echo obj1=$(obj1)
      @echo obj2=$(obj2)

结果:

obj1=main.o fun1.o fun2.o
obj2=patsubst Test!

• $(strip string )
  名称：去空格函数——strip。
  功能：去掉string字串中开头和结尾的空字符。
  返回：返回被去掉空格的字符串值。
  示例：

  empty=
  var=$(empty) $(empty) Hello Makefile
  
  s_var=$(strip $(var))
  target2:
      @echo var:$(var)
      @echo s_var:$(s_var)

结果:

var: Hello Makefile
s_var:Hello Makefile

这上面使用两个空的变量empty定义了一个空格

• $(findstring find,in )
  名称：查找字符串函数——findstring。
  功能：在字串in中查找find字串。
  返回：如果找到，那么返回find，否则返回空字符串。
  示例：

  var1=$(findstring a,a b c)
  var2=$(findstring a,b c)
  
  target:
      @echo var1=$(var1)
      @echo var2=$(var2)

结果:

var1=a
var2=

• $(filter pattern…,text )
  名称：过滤函数——filter。
  功能：以pattern模式过滤text字符串中的单词，保留符合模式pattern的单词。可
  以有多个模式。
  返回：返回符合模式pattern的字串。
  示例：

  obj=$(filter %.o,main.c main.o base.h wrapper.o wrapper.c wrapper.h)
  
  target:
      @echo $(obj)

结果:

main.o wrapper.o

• $(filter-out pattern…,text )
  名称：反过滤函数——filter-out。
  功能：以pattern模式过滤text字符串中的单词，去除符合模式pattern的单词。可
  以有多个模式。
  返回：返回不符合模式pattern的字串。
  示例：

  src=$(filter %.c,main.c main.o base.h wrapper.o wrapper.c wrapper.h)
  
  target:
      @echo $(src)

结果:

main.c wrapper.c

• $(sort list )
  名称：排序函数——sort。
  功能：给字符串list中的单词排序（升序）。
  返回：返回排序后的字符串。
  备注：sort函数会去掉list中相同的单词。
  示例：

  after_sort_var=$(sort zipper begin cat apple dog boy zipper)
  
  target:
      @echo $(after_sort_var)

结果:

apple begin boy cat dog zipper

• $(word n,text )
  名称：取单词函数——word。
  功能：取字符串text中第n个单词。（从一开始）
  返回：返回字符串text中第n个单词。如果n比text中的单词数要大，那么返回空
  字符串。
  示例:

  choice1=$(word 2, apple boy cat)
  choice2=$(word 4, apple boy cat)
  
  target:
      @echo choice1=$(choice1)
      @echo choice2=$(choice2)

结果:

choice1=boy
choice2=

• $(wordlist s,e,text )
  名称：取单词串函数——wordlist。
  功能：从字符串text中取从s开始到e的单词串。s和e是一个数字。
  返回：返回字符串text中从s到e的单词字串。如果s比text中的单词数要大，那
  么返回空字符串。如果e大于text的单词数，那么返回从s开始，到text结束的单
  词串。
  示例：

  var1=$(wordlist 1,2,i am Makefile)
  var2=$(wordlist 4,1,i am Makefile)
  var3=$(wordlist 1,20,i am Makefile)
  
  target:
      @echo $(var1)
      @echo $(var2)
      @echo $(var3)

结果:

i am

i am Makefile

• $(words text )
  名称：单词个数统计函数——words。
  功能：统计text中字符串中的单词个数。
  返回：返回text中的单词数。
  备注：如果我们要取text中最后的一个单词，我们可以这样：$(word $(words text
  ),text )
  示例:

  count=$(words i am Makefile)
  
  target:
      @echo count=$(count)

结果:

count=3

• $(firstword text )
  名称：首单词函数——firstword。
  功能：取字符串text中的第一个单词。
  返回：返回字符串text的第一个单词。
  备注：这个函数可以用word函数来实现：$(word 1,text )。
  示例：

  str=$(firstword Hello Makefile)
  
  target:
      @echo str=$(str)

结果：

str=Hello

以上，是所有的字符串操作函数，如果搭配混合使用，可以完成比较复杂的功能。这里，
举一个现实中应用的例子。我们知道，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=$(dir src/foo.c include/base.h base.c)
  
  target:
      @echo $(dir)

结果:

src/ include/ ./

• $(notdir names…)
  名称：取文件函数——notdir。
  功能：从文件名序列names中取出非目录部分。非目录部分是指最后一个反斜杠（“/”）之后的部分。
  返回：返回文件名序列names的非目录部分。
  示例:

  src=$(notdir src/main.c include/base.h base.c)
  
  target:
      @echo src=$(src)

结果:

src=main.c base.h base.c

• $(suffix names…)
  名称：取后缀函数——suffix。
  功能：从文件名序列names中取出各个文件名的后缀。
  返回：返回文件名序列names的后缀序列，如果文件没有后缀，则返回空字串。
  示例:

  suffix=$(suffix src/main.c include/base.h base.c)
  
  target:
      @echo suffix=$(suffix)

结果:

suffix=.c .h .c

• $(basename names…)
  名称：取前缀函数——basename。
  功能：从文件名序列names中取出各个文件名的前缀部分。
  返回：返回文件名序列names的前缀序列，如果文件没有前缀，则返回空字串。
  示例:

  basename=$(basename src/main.c include/base.h .S)
  
  target:
      @echo basename=$(basename)

结果：

basename=src/main include/base

• $(addsuffix suffix,names…)
  名称：加后缀函数——addsuffix。
  功能：把后缀suffix加到names中的每个单词后面。
  返回：返回加过后缀的文件名序列。
  示例:

  src=$(addsuffix .c,main bar foo)
  
  target:
      @echo src=$(src)

结果:

src=main.c bar.c foo.c

• $(addprefix prefix,names…)
  名称：加前缀函数——addprefix。
  功能：把前缀prefix加到names中的每个单词后面。
  返回：返回加过前缀的文件名序列。
  示例:

  src=$(addprefix src/,main.c foo.c bar.c)
  
  target:
      @echo src=$(src)

结果:

src=src/main.c src/foo.c src/bar.c

• $(join list1,list2)
  名称：连接函数——join。
  功能：把list2中的单词对应地加到list1的单词后面。如果list1的单词个数要比list2的多，那么，list1中的多出来的单词将保持原样。如果list2的单词个数要比list1多，那么，list2多出来的单词将被复制到list2中。
  返回：返回连接过后的字符串。
  示例:

  str=$(join aaa bbb ccc,111 222 333)
  
  target:
      @echo str=$(str)

结果:

str=aaa111 bbb222 ccc333

foreach 函数

• $(foreach var,list,text)
  介绍:foreach 函数和别的函数非常的不一样。因为这个函数是用来做循环用的，Makefile中的foreach函数几乎是仿照于Unix标准Shell（/bin /sh）中的for语句，或是C-Shell（/bin/csh）中的foreach语句而构建的。
  功能:把参数list中的单词逐一取出放到参数var所指定的变量中，然后再执行text所包含的表达式。每一次text会返回一个字符串，循环过程中，text的所返回的每个字符串会以格分隔，最后当整个循环结束时，text所返回的每个字符串所组成的整个字符串（以空格分隔）将会是foreach函数的返回值
  注意：foreach中的var参数是一个临时的局部变量，foreach函数执行完后，参数var的变量将不在作用，其作用域只在foreach函数当中。
  示例:

  res=$(foreach n,main foo bar,$(n).c)
  
  target:
      @echo res=$(res)

结果:

res=main.c foo.c bar.c

在这个示例中，会依次遍历第二参数中的字符串，赋值给n,然后再根据第三参数组合，最后返回遍历完成的结果

if 函数

• $(if condition,then-part) 或 $(if condition,then-part,else-part)
  介绍:if函数很像GNU的make所支持的条件语句——ifeq
  功能:可见，if函数可以包含“else”部分，或是不含。即if函数的参数可以是两个，也可以是三个。condition参数是if的表达式，如果其返回的为非空字符串，那么这个表达式就相当于返回真，于是，then-part会被计算，否则else-part会被计算
  返回值:如果condition为真（非空字符串），那个then- part会是整个函数的返回值，如果condition为假（空字符串），那么else-part会是整个函数的返回值，此时如else-part没有被定义，那么，整个函数返回空字串
  示例:

  flag=
  res=$(if $(flag),true-part,false-part)
  
  target:
      @echo res=$(res)

结果:

res=false-part

call函数

• $(call expression,parm1,parm2,parm3…)
  功能:call函数是唯一一个可以用来创建新的参数化的函数。你可以写一个非常复杂的表达式，这个表达式中，你可以定义许多参数，然后你可以用call函数来向这个表达式传递参数。
  返回值:当 make执行这个函数时，expression参数中的变量，如$(1)，$(2)，$(3)等，会被参数parm1，parm2，parm3依次取代。而expression的返回值就是 call函数的返回值。
  示例:

  func=$(1) $(2)
  res=$(call func,hello,makefile)
  
  target:
      @echo res=$(res)

结果:

res=hello makefile

origin函数

• $(origin variable)
  功能: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是一个命令运行中的自动化变量。关于自动化变量将在后面讲述
  示例:

  var=Hello
  override val=XX
  
  res_undef=$(origin A)
  res_default=$(origin CC)
  res_env=$(origin HOME)
  res_file=$(origin var)
  res_cmd=$(origin DEF)
  res_ord=$(origin val )
  
  target:
      @echo res_undef=$(res_undef)
      @echo res_default=$(res_default)
      @echo res_env=$(res_env)
      @echo res_file=$(res_file)
      @echo res_cmd=$(res_cmd)
      @echo res_ord=$(res_ord)

此处HOME是linux系统环境变量,使用make DEF=hello命令，传入命令行参数,结果:

res_undef=undefined
res_default=default
res_env=environment
res_file=file
res_cmd=command line
res_ord=override

shell函数

• $(shell cmd args…)
  介绍:shell 函数也不像其它的函数。顾名思义，它的参数应该就是操作系统Shell的命令。它和反引号“`”是相同的功能。这就是说，shell函数把执行操作系统命令后的输出作为函数
  返回值:cmd命令返回内容
  注意:这个函数会新生成一个Shell程序来执行命令，所以你要注意其运行性能，如果你的Makefile中有一些比较复杂的规则，并大量使用了这个函数，那么对于你的系统性能是有害的。特别是Makefile的隐晦的规则可能会让你的shell函数执行的次数比你想像的多得多
  示例:

  ls_res=$(shell ls -a)
  
  target:
      @echo ls_res=$(ls_res)

结果:

ls_res=. .. addprefix.mak addsuffix.mak basename.mak call.mak dir.mak foreach.mak if.mak join.mak notdir.mak origin.mak shell.mak suffix.mak

Makefile控制函数

控制函数不同于上边的函数，顾名思义，控制函数可以控制make的执行
make提供了一些函数来控制make的运行。通常，你需要检测一些运行Makefile时的运行时信息，并且根据这些信息来决定，你是让make继续执行，还是停止

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

  target:
      $(error this is an error)
      @echo after err #因为上边调用了error函数，make执行就退出了，所以这一句不会被执行

结果：

error.mak:2: *** this is an error.  Stop.

• $(warning text …)
  介绍:这个函数很像error函数，只是它并不会让make退出，只是输出一段警告信息，而make继续执行
  示例:

  target:
      $(warning this is an warning)
      @echo after warning

结果:

warning.mak:2: this is an warning
after warning