Makefile：使用函数

1. makefile中的函数

• make解释器提供了一系列的函数供makefile调用（即预定义函数，相当于库函数）
• 在makefile中支持自定义函数实现，并调用执行
• 通过define关键字实现自定义函数
• 自定义的函数一般用于定义命令的集合，并且运用于规则中

自定义函数的语法来看下面的例子：

在Makefile中， 通过define关键字来实现函数的自定义，并以endef关键字结束，自定义函数使用预定义函数call调用，后边跟自定义函数名及参数。

define 函数名
    ....
endef

上边我们首先定义了一个伪目标test，接着定义了两个函数，func1和func2。fun1中直接通过$(0)输出call 的第一个参数，也就是函数名fun1，fun2中同时输出了第二个参数(这看起来有点 类似C语言里的main函数参数)。 在调用自定义函数fun1和fun2时，格式为$(call 函数名，参数...)，call函数的参数需要以逗号","隔开.

注意，自定义函数是一个过程调用，没有任何返回值，这是与Makefile的预定义函数的区别之处。

2. make解释器中的预定义函数

• make的函数提供了处理文件名，变量和命令的函数
• 可以在需要的地方调用函数来处理指定的参数
• 预定义函数是有返回值，函数在调用的地方被替换为处理结果

预定义函数的调用语法规则：

来看一个例子，abspath 用于输出当前路径名： 

 

 

字符串处理函数

subst

$(subst <from>,<to>,<text>)

• 名称：字符串替换函数

• 功能：把字串 <text> 中的 <from> 字符串替换成 <to> 

• 返回：函数返回被替换过后的字符串

示例：

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

 patsubst

$(patsubst <pattern>,<replacement>,<text>)

• 名称：模式字符串替换函数。

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

• 返回：函数返回被替换过后的字符串

示例：

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

 

备注：这和我们前面“变量章节”说过的相关知识有点相似。如 $(var:<pattern>=<replacement>) 相当于 $(patsubst <pattern>,<replacement>,$(var)) ，而 $(var: <suffix>=<replacement>) 则相当于 $(patsubst %<suffix>,%<replacement>,$(var)) 

例如有:

objects = foo.o bar.o baz.o

那么， $(objects:.o=.c) 和 $(patsubst %.o,%.c,$(objects)) 是一样的

strip

$(strip <string>)

• 名称：去空格函数

• 功能：去掉 <string> 字串中开￥（）头和结尾的空字符

• 返回：返回被去掉空格的字符串值

示例：

$(strip a b c )

findstring

$(findstring <find>,<in>)

• 名称：查找字符串函数

• 功能：在字串 <in> 中查找 <find> 字串

• 返回：如果找到，那么返回 <find> ，否则返回空字符串

示例：%。

$(findstring a,a b c)
$(findstring a,b c)

 filter

$(filter <pattern...>,<text>)

• 名称：过滤函数

• 功能：以 <pattern> 模式过滤 <text> 字符串中的单词，保留符合模式 <pattern> 的单词，可以有多个模式

• 返回：返回符合模式 <pattern> 的字串

示例：

sources := foo.c bar.c baz.s ugh.h
foo: $(sources)
    cc $(filter %.c %.s,$(sources)) -o foo

filter-out

$(filter-out <pattern...>,<text>)

• 名称：反过滤函数

• 功能：以 <pattern> 模式过滤 <text> 字符串中的单词，去除符合模式 <pattern> 的单词。可以有多个模式

• 返回：返回不符合模式 <pattern> 的字串

示例：

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

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

 

 sort

$(sort <list>)

• 名称：排序函数
• 功能：给字符串 <list> 中的单词排序（升序）
• 返回：返回排序后的字符串。

示例：

$(sort foo bar lose) 

 

• 备注： sort 函数会去掉 <list> 中相同的单词。

 word

$(word <n>,<text>)

• 名称：取单词函数
• 功能：取字符串 <text> 中第 <n> 个单词。（从1开始）
• 返回：返回字符串 <text> 中第 <n> 个单词。如果 <n> 比 <text> 中的单词数要大，那么返回空字符串。

示例： 

$(word 2, foo bar baz)

 

 wordlist

$(wordlist <ss>,<e>,<text>)

• 名称：取单词串函数
• 功能：从字符串 <text> 中取从 <ss> 开始到 <e> 的单词串，<ss> 和 <e> 是一个数字
• 返回：返回字符串 <text> 中从 <ss> 到 <e> 的单词字串。如果 <ss> 比 <text> 中的单词数要大，那么返回空字符串。如果 <e> 大于 <text> 的单词数，那么返回从 <ss> 开始，到 <text> 结束的单词串

示例： 

$(wordlist 2, 4, foo bar baz succe) 

 

words

$(words <text>)

• 名称：单词个数统计函数
• 功能：统计 <text> 中字符串中的单词个数。
• 返回：返回 <text> 中的单词数。

示例：

 $(words, foo bar baz) 

 

• 备注：如果我们要取 <text> 中最后的一个单词，我们可以这样： $(word $(words <text>),<text>) 

firstword

$(firstword <text>)

• 名称：首单词函数——firstword。
• 功能：取字符串 <text> 中的第一个单词。
• 返回：返回字符串 <text> 的第一个单词。

示例：

 $(firstword foo bar)

 

• 备注：这个函数可以用 word 函数来实现： $(word 1,<text>)

文件名操作函数

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

dir

$(dir <names...>)

• 名称：取目录函数——dir。
• 功能：从文件名序列 <names> 中取出目录部分。目录部分是指最后一个反斜杠（ / ）之前的部分。如果没有反斜杠，那么返回 ./ 。
• 返回：返回文件名序列 <names> 的目录部分。

$(dir src/foo.c hacks)

notdir

$(notdir <names...>)

• 名称：取文件函数——notdir。
• 功能：从文件名序列 <names> 中取出非目录部分。非目录部分是指最後一个反斜杠（ / ）之后的部分。
• 返回：返回文件名序列 <names> 的非目录部分。

$(notdir src/foo.c hacks)

suffix

$(suffix <names...>)

• 名称：取後缀函数——suffix。
• 功能：从文件名序列 <names> 中取出各个文件名的后缀。
• 返回：返回文件名序列 <names> 的后缀序列，如果文件没有后缀，则返回空字串。

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

 

basename

$(basename <names...>)

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

$(basename src/foo.c src-1.0/bar.o hacks  .h)

 

addsuffix

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

• 名称：加后缀函数——addsuffix。
• 功能：把后缀 <suffix> 加到 <names> 中的每个单词后面。
• 返回：返回加过后缀的文件名序列。

 

addprefix

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

• 名称：加前缀函数——addprefix。
• 功能：把前缀 <prefix> 加到 <names> 中的每个单词后面。
• 返回：返回加过前缀的文件名序列。

 

join

$(join <list1>,<list2>)

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

 

foreach 函数

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

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

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

所以， <var> 最好是一个变量名， <list> 可以是一个表达式，而 <text> 中一般会使用 <var> 这个参数来依次枚举 <list> 中的单词。

if 函数

if函数的语法是：

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

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

而if函数的返回值是，如果 <condition> 为真（非空字符串），那个 <then-part> 会是整个函数的返回值，如果 <condition> 为假（空字符串），那么 <else-part> 会是整个函数的返回值，此时如果 <else-part> 没有被定义，那么，整个函数返回空字串。

所以， <then-part> 和 <else-part> 只会有一个被计算。

origin函数

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

$(origin <variable>)

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

如果 <variable> 从来没有定义过，origin函数返回这个值 

undefined

如果 <variable> 是一个默认的定义，比如“CC”这个变量，

environment

如果 <variable> 是一个环境变量，并且当Makefile被执行时， -e 参数没有被打开

file

如果 <variable> 这个变量被定义在Makefile中

command line

如果 <variable> 这个变量是被命令行定义的

override

如果 <variable> 是被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

shell函数

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

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