Makefile常用函数介绍
一、语法格式
函数调用,很像变量的使用,也是以“$”来标识的,其语法如下:
$(<function> <arguments>)
或是
${<function> <arguments>}
函数调用以“$”开头,以圆括号或花括号把函数名和参数括起;<function>就是函数名,<arguments>是函数的参数,参数间以逗号“,”分隔,而函数名和参数之间以“空格”分隔。
二、常用函数
#字符串操作函数
1、subst
名称:字符串替换函数
语法:$(subst <from>,<to>,<text>)
功能:把字串<text>中的<from>字符串替换成<to>。
返回:函数返回被替换过后的字符串。
示例:
$(subst A,a,This is A cat),把“This is A cat”中的“A”替换成“a”,返回结果是“This is a cat”。
2、patsubst
名称:模式字符串替换函数
语法:$(patsubst<pattern>,<replacement>,<text>)
功能:查找<text>中的单词(单词以“空格”、“Tab”或“回车”“换行”分隔)是否符合模式<pattern>,如果匹配的话,则以<replacement>替换。这里,<pattern>可以包括通符“%”,表示任意长度的字串。如果<replacement>中也包含“%”,那么,<replacement>中的这个“%”将是<pattern>中的那个“%”所代表的字串。(可以用“\”来转义,以“\%”来表示真实含义的“%”字符)。
返回:函数返回被替换过后的字符串。
示例:
$(patsubst %.c,%.o,x.c bar.c), 把字串“x.c bar.c”符合模式[%.c]的单词替换成[%.o],返回结果是“x.o bar.o”。
3、strip
名称:去空格函数
语法:$(strip <string>)
功能:去掉<string>字串中开头和结尾的空字符。
返回:返回被去掉空格的字符串值。
示例:
$(strip a b c )
把字串“a b c ”去到开头和结尾的空格,结果是“a b c”。
4、findstring
名称:查找字符串函数
语法:$(findstring <find>,<in>)
功能:在字串<in>中查找<find>字串。
返回:如果找到,那么返回<find>,否则返回空字符串。
示例:
$(findstring a,a b c)
$(findstring a,b c)
第一个函数返回“a”字符串,第二个返回“”字符串(空字符串)。
5、filter
名称:过滤函数
语法:$(filter <pattern...>,<text>)
功能:以<pattern>模式过滤<text>字符串中的单词,保留符合模式<pattern>的单词。
返回:返回符合模式<pattern>的字串。
示例:
strfiles:= hello.c bar.c baz.s ugh.h
hello:$(strfiles)
gcc $(filter %.c %.s,$(strfiles)) –o hello
返回的值是: gcc hello.c bar.c baz.s -o hello
6、filter-out
名称:反过滤函数
语法:$(filter-out<pattern...>,<text>)
功能:以<pattern>模式过滤<text>字符串中的单词,去除符合模式<pattern>的单词。可以有多个模式。
返回:返回不符合模式<pattern>的字串。
示例:
hello=main.o bar.o helle.o test.o
foo=main.o bar.o
$(filter-out $(foo),$(hello)) 返回是“hello.o test.o”。
7、sort
名称:排序(升序)函数
语法:$(sort <list>)
功能:给字符串<list>中的单词从小到大排序, 去掉<list>中相同的单词。
返回:返回排序后的字符串。
示例:排序字符串<list>
$(sort foo bar lose foo)返回是“bar foo lose” 。
8、word
名称:取单词函数
语法:$(word <n>,<text>)
功能:取字符串<text>中第<n>个单词。
返回:返回字符串<text>中第<n>个单词。如果<n>比<text>中的单词数要大,那么返回空字符串。
示例:取<text>中第几个单词
$(word 2, foo bar baz)返回是“bar”。
9、wordlist
名称:取单词串函数
语法:$(wordlist <s>,<e>,<text>)
功能:从字符串<text>中取从<s>开始到<e>的单词串。<s>和<e>是一个数字。
返回:返回字符串<text>中从<s>到<e>的单词字串。如果<s>比<text>中的单词数要大,那么返回空字符串。如果<e>大于<text>的单词数,那么返回从<s>开始,到<text>结束的单词串。
示例:取<text>中连续几个单词串
$(wordlist 2, 5, foo bar baz main)返回值是“bar baz main”。
10、words
名称:单词个数统计函数
语法:$(words <text>)
功能:统计<text>中字符串中的单词个数。
返回:返回<text>中的单词数。
示例:取<text>中最后的一个单词
text=foo bar baz
$(word $(words $text),$text) 返回值是“baz”。
11、firstword
名称:首单词函数
语法:$(firstword <text>)
功能:取字符串<text>中的第一个单词。
返回:返回字符串<text>的第一个单词。
示例:
$(firstword foo bar)返回值是“foo”。
等效于:$(word 1,<text> )。
#文件名操作函数
1、dir
名称:取目录函数
语法:$(dir <names...> )
功能:从文件名序列<names>中取出目录部分。目录部分是指最后一个反斜杠(“/”)之前的部分。如果没有反斜杠,那么返回“./”。
返回:返回文件名序列<names>的目录部分。
示例:
$(dir include/def3.h hacks)返回值是“include/ ./”。
2、notdir
名称:取文件函数
语法:$(notdir <names...> )
功能:从文件名序列<names>中取出非目录部分。非目录部分是指最后一个反斜杠(“/”)之后的部分。
返回:返回文件名序列<names>的非目录部分,文件不存在亦原样返回。
示例:
$(notdir include/def3.h main)返回值是“def.3 main”。
3、suffix
名称:取后缀函数
语法:$(suffix <names...> )
功能:从文件名序列<names>中取出各个文件名的后缀。
返回:返回文件名序列<names>的后缀序列,如果文件没有后缀,则返回空字串。
示例:
$(suffix include/def3.h src/hello.c main)返回值是“.h .c”。
4、basename
名称:取前缀函数
语法:$(basename <names...> )
功能: 从文件名序列<names>中取出各个文件名的前缀部分。
返回:返回文件名序列<names>的前缀序列,如果文件没有前缀,则返回空字串。
示例:
$(basename src/foo.c src-1.0/bar.c hacks)返回值是“src/foo src-1.0/bar hacks”。
5、addsuffix
名称:加后缀函数
语法:$(addsuffix <suffix>,<names...>)
功能:把后缀<suffix>加到<names>中的每个单词后面。
返回:返回加过后缀的文件名序列。
示例:
$(addsuffix .c,foo bar)返回值是“foo.c bar.c”。
6、addprefix。
名称:加前缀函数
语法:$(addprefix <prefix>,<names...>)
功能:把前缀<prefix>加到<names>中的每个单词后面。
返回:返回加过前缀的文件名序列。
示例:
$(addprefix src/,foo bar)返回值是“src/foo src/bar”。
7、join
名称:连接函数
语法:$(join <list1>,<list2> )
功能: 把<list2>中的单词对应地加到<list1>的单词后面。如果<list1>的单词个数要比<list2>的多,那么,<list1>中的多出来的单词将保持原样。如果<list2>的单词个数要比<list1>多,那么,<list2>多出来的单词将被复制到<list2>中。
返回:返回连接过后的字符串。
示例:
$(join aaa bbb , 111 222 333)返回值是“aaa111 bbb222 333”。
8、wildcard
名称:获取匹配模式文件名函数
语法:$(wildcard PATTERN)
功能: 列出当前目录下所有符合模式“PATTERN”格式的文件名。“PATTERN”使用shell可识别的通配符,包括“?”(单字符)、“*”(多字符)等。
返回:空格分割的、存在当前目录下的所有符合模式“PATTERN”的文件名。
示例:
$(wildcard *.c)返回值为当前目录下所有.c源文件列表。
#特别函数
1、foreach
名称:循环函数
语法:$(foreach<var>,<list>,<text> )
功能: 把参数<list>中的单词逐一取出放到参数<var>所指定的变量中,然后再执行<text>所包含的表达式。每一次<text>会返回一个字符串,循环过程中,<text>的所返回的每个字符串会以空格分隔,最后当整个循环结束时,<text>所返回的每个字符串所组成的整个字符串(以空格分隔)将会是foreach函数的返回值。
返回:当整个循环结束时,<text>返回的每个字符串所组成的整个字符串(以空格分隔)。
示例:
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函数当中。
2、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>没有被定义,那么,整个函数返回空字串。
示例:
src:=$(wildcard *.c)
OBJFS:=$(if $(src),$(subst c,o,$(src)))
main:$(OBJFS)
gcc -o $@ $^
if $(src)表示如果目录中有“.c”文件,则执行$(subst c,o,$(src)),即把“.c”文件名列表替换成“.o”文件名列表。
3、call
名称:创建新的参数化的函数
语法:$(call<expression>,<parm1>,<parm2>,<parm3>...)
功能:你可以写一个非常复杂的表达式,
这个表达式中,你可以定义许多参数,然后你可以用call函数来向这个表达式传递参数。
返回:<expression>参数中的变量,如$(1),$(2),$(3)等,会被参数<parm1>,<parm2>,<parm3>依次取代。而<expression>的返回值就是call函数的返回值。
示例:
reverse = $(1) $(2)
foo = $(call reverse,a,b)
那么,foo的值就是“a b”。
4、origin
名称:判断变量来源函数
语法:$(origin <variable>)
功能:不操作变量的值,他只是告诉你你的这个变量是哪里来的,<variable>是变量的名字,不要在<variable>中使用“$”字符。
返回值:
“undefined”:从来没有定义过。
“default”:是一个默认的定义,比如“CC”这个变量。
“environment”:是一个环境变量。
“file”: 这个变量被定义在Makefile中。
“command line”: 这个变量是被命令行定义的。
“override”: 是被override指示符重新定义的。
“automatic”: 是一个命令运行中的自动化变量。
示例:
ifdef bletch
ifeq "$(origin bletch)" "environment"
bletch = barf, gag, etc.
endif
endif
上述案例解释:如果变量来源于环境,那么我们就把之重定义了,如果来源于Make.def或是命令行等非环境的,那么我们就不重新定义它。有一个Makefile其包含了一个定义文件Make.def,在Make.def中定义了一个变量“bletch”,而我们的环境中也有一个环境变量“bletch”,
5、shell
名称:shell函数
语法:$(shell <command1> <command2> <command3>...)
功能:可用来操作Linux系统命令以及字符串处理命令。
返回:把执行操作系统命令后的输出作为函数返回。
示例:
contents := $(shell cat foo)
files := $(shell echo *.c)
用命令cat生成一个变量。
6、error
名称:错误信息函数
语法: $(error<text ...>)
功能:可检测一些运行Makefile时的运行时信息,并且根据这些信息来决定,你是让make继续执行,还是停止。
返回:输出一段错误信息
示例:
ERR = $(error found an error!)
.PHONY: err
err: ; $(ERR)
或
ifdef ERROR_001
$(error error is $(ERROR_001))
Endif
部分资料整理来源于GNU网站,便于大家编写自己的Makefile文件时对照参考!
参考资料:
《Linux C 程序设计大全》清华大学出版社