makefile 中使用函数

makefile 中使用函数：

函数,通常是给定输入,获取输出的手段.
很多事情，说起来复杂，做起来简单。（跟说着容易做着难正好相反？？）
************************************************************
先给一个makefile 包含函数的非常简单又较为完整的一个例子。
书写规范及约定需要经过实践才能体会。所以手敲是有益的。
************************************************************
# 包括如下函数 if, foreach, origin, shell, string functios, filename functions 等等

下例在变量赋值语句中使用了系统内置的函数, 将函数的返回值付给了变量.

# variable
    a = 5
    b = 6
    c = $(if $a,8,9)
    name = "this is my name"    
#    name_strip = $(strip $(name))
    name_obj= $(foreach t, $(name), $t.o)
    name_c = $(subst .o,.c, $(name_obj))
    name_h = $(patsubst %.o, %.h, $(name_obj))
    name_find = $(findstring my.o, $(name_obj))
    name_blind = $(name_obj) $(name_c) $(name_h)
    name_filter = $(filter %.h %.c, $(name_blind))
    name_sort = $(sort $(name_blind))
    testfile=/usr/software/abc.txt /usr/script/123.mk
info:
    @echo a is $a
    @echo b is $b
    @echo c is $c
    @echo name is $(name)
    @#echo name_strip is $(name_strip)
    @echo name_obj is $(name_obj)
    @echo name_c is $(name_c)
    @echo name_h is $(name_h)
    @echo name_find is $(name_find)
    @echo name_blind is $(name_blind)
    @echo name_filter is $(name_filter)
    @echo name_sort is $(name_sort)
    @# attention, origin need variable, not ref variable
    @echo name_obj is $(origin name_obj)
    @echo dir of testfile is $(dir $(testfile))
    @echo notdir of testfile is $(notdir $(testfile))
    @echo basename of testfile is $(basename  $(testfile))
    @echo suffix of testfile is $(suffix  $(testfile))
    @echo addsuffix of testfile is $(addsuffix  .cpp, $(testfile))
    @echo addprefix of testfile is $(addprefix  /home, $(testfile))
    @echo $(shell date)

************************************************************
输出结果如下：

************************************************************
a is 5
b is 6
c is 8
name is this is my name
name_obj is this.o  is.o  my.o  name.o
name_c is this.c  is.c  my.c  name.c
name_h is this.h  is.h  my.h  name.h
name_find is my.o
name_blind is this.o  is.o  my.o  name.o this.c  is.c  my.c  name.c this.h  is.h  my.h  name.h
name_filter is this.c is.c my.c name.c this.h is.h my.h name.h
name_sort is this.c this.h this.o is.c is.h is.o my.c my.h my.o name.c name.h name.o
name_obj is file
dir of testfile is /usr/software/ /usr/script/
notdir of testfile is abc.txt 123.mk
basename of testfile is /usr/software/abc /usr/script/123
suffix of testfile is .txt .mk
addsuffix of testfile is /usr/software/abc.txt.cpp /usr/script/123.mk.cpp
addprefix of testfile is /home/usr/software/abc.txt /home/usr/script/123.mk

Mon Nov 11 11:17:54 EST 2013

-------------------------------------------------------------------------

call 函数用来调用自定义的函数
函数调用:
$(call <expression>, <parm1>,<parm2>,<parm3>...)
函数实现:
<expression> 参数中的变量用$(1)，$(2)，$(3)获取,函数调用参数以逗号分割.

makefile中纯自定义函数只是过程调用,没有返回值.

-------------------------------------------------------------------------

举例:

quote = '
escsq = $(subst $(squote),'\$(squote)',$1)

define newFun
@echo $1
@echo $2
@echo $3
endef

all:
    @echo $(call escsq, 'hello')
    @echo $(call escsq, 1234)
    $(call newFun, do,you,like,this)

 

************************************************************
下面介绍一下makefile 函数的背景知识， 参考了网上文章，略加整理
为的是保证知识块的完整性
************************************************************
前言:函数的调用语法
    函数调用，很像变量的使用，也是以“$”来标识的，其语法如下：
    $(<function> <arguments> )
    或是
    ${<function> <arguments>}


    这里，<function>就是函数名，make支持的函数不多。<arguments>是函数的参数，参数
    间以逗号“,”分隔，而函数名和参数之间以“空格”分隔。函数调用以“$”开头，以圆
    括号或花括号把函数名和参数括起。感觉很像一个变量，是不是？

我把makefile 函数分为四类。
1. 流程控制类函数。 if foreach origin 函数
2. 功能扩展类函数。 call, shell
3. 字符串处理类函数。subst, patsubst, strip, findstring, filter, filter-out, sort, word, wordlist, word, firstword
4. 文件名处理类函数。dir, notdir, basename, suffix, addsuffix, addprefix, join

一、if函数， foreach 函数， origin函数
1.1 if 函数 的语法是：
$(if <condition>,<then-part>,[else-part] )

可见，if函数可以包含“else”部分，或是不含。
 
if函数的返回值是，如果<condition>为真（非空字符串），那个<then-part>会是整
个函数的返回值，如果<condition>为假（空字符串），那么<else-part>会是整个函数的
返回值，此时如果<else-part>没有被定义，那么，整个函数返回空字串。
所以，<then-part>和<else-part>只会有一个被计算。


1.2 foreach 函数和别的函数非常的不一样。因为这个函数是用来做循环用的。
$(foreach <var>,<list>,<text> )

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

注意，foreach中的<var>参数是一个临时的局部变量，foreach函数执行完后，参数
<var>的变量将不在作用，其作用域只在 foreach 函数当中。


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

注意，<variable>是变量的名字，不应该是引用。所以你最好不要在<variable>中使用“
$”字符。Origin 函数会以其返回值来告诉你这个变量的“出生情况”，下面，是 origin
函数的返回值:
“undefined”   <variable>从来没有定义过.
“default”      <variable>是一个默认的定义，比如“CC”这个变量，
“environment”  <variable>是一个环境变量，并且当Makefile被执行时，“-e”参数没有被打开。
“file”         <variable>这个变量被定义在Makefile中。
“command line” <variable>这个变量是被命令行定义的。
“override”     <variable>是被override指示符重新定义的。

 
“automatic”
如果<variable>是一个命令运行中的自动化变量。关于自动化变量将在后面讲述。
这些信息对于我们编写Makefile是非常有用的，例如，假设我们有一个Makefile其包
了一个定义文件Make.def，在Make.def中定义了一个变量“bletch”，而我们的环境中
也有一个环境变量“bletch”，此时，我们想判断一下，如果变量来源于环境，那么我
们就把之重定义了，如果来源于Make.def或是命令行等非环境的，那么我们就不重新
定义它。于是，在我们的Makefile中，我们可以这样写：
ifdef bletch

ifeq "$(origin bletch)" "environment"
bletch = barf, gag, etc.
endif
endif
当然，你也许会说，使用override关键字不就可以重新定义环境中的变量了吗？为什
么需要使用这样的步骤？是的，我们用override是可以达到这样的效果，可是override
过于粗暴，它同时会把从命令行定义的变量也覆盖了，而我们只想重新定义环境传来
的，而不想重新定义命令行传来的。

二、call函数 shell函数
2.1 call 函数是唯一一个可以用来创建新的参数化的函数。你可以写一个非常复杂的表达式，
这个表达式中，你可以定义许多参数，然后你可以用call函数来向这个表达式传递参
数。其语法是：
$(call <expression>,<parm1>,<parm2>,<parm3>...)

当make执行这个函数时，<expression>参数中的变量，如$(1)，$(2)，$(3)等，会被参
数<parm1>，<parm2>，<parm3>依次取代。而<expression>的返回值就是call函数的返
回值。例如：

catenate = $(1) $(2)
foo = $(call catenate,a,b)
那么，foo的值就是“ab”。当然，参数的次序是可以自定义的，不一定是顺序的，如：
catenate = $(2) $(1)
foo = $(call catenate,a,b)
此时的foo的值就是“ba”。


2.2、shell函数
shell 函数也不像其它的函数。顾名思义，它的参数应该就是操作系统 Shell 的命令。它和
反引号“`”是相同的功能。这就是说，shell函数把执行操作系统命令后的输出作为函数
返回。于是，我们可以用操作系统命令以及字符串处理命令awk，sed等等命令来生成
一个变量，如：
contents := $(shell cat foo)
files := $(shell echo *.c)
注意，这个函数会新生成一个Shell程序来执行命令，所以你要注意其运行性能，如果
你的Makefile中有一些比较复杂的规则，并大量使用了这个函数，那么对于你的系统
性能是有害的。特别是Makefile的隐晦的规则可能会让你的shell函数执行的次数比你
想像的多得多。


三、字符串处理函数
$(subst <from>,<to>,<text> )
名称：字符串替换函数——subst。
功能：把字串<text>中的<from>字符串替换成<to>。
返回：函数返回被替换过后的字符串。


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

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

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

$(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”。

$(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”。

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

$(word <n>,<text> )
名称：取单词函数——word。
功能：取字符串<text>中第<n>个单词。（从一开始）
返回：返回字符串<text>中第<n>个单词。如果<n>比<text>中的单词数要大，那么返回
空字符串。
示例：$(word 2,foo bar baz)返回值是“bar”。

$(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”。

$(words <text> )
名称：单词个数统计函数——words。
功能：统计<text>中字符串中的单词个数。
返回：返回<text>中的单词数。
示例：$(words,foo bar baz)返回值是“3”。
备注：如果我们要取<text>中最后的一个单词，我们可以这样：$(word $(words <text> ),<text> )。

$(firstword <text> )
名称：首单词函数——firstword。
功能：取字符串<text>中的第一个单词。
返回：返回字符串<text>的第一个单词。
示例：$(firstwordfoobar)返回值是“foo”。
备注：这个函数可以用word函数来实现：$(word1,<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.chacks)返回值是“src/./”。

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

$(suffix <names...> )
名称：取后缀函数——suffix。
功能：从文件名序列<names>中取出各个文件名的后缀。
返回：返回文件名序列<names>的后缀序列，如果文件没有后缀，则返回空字串。
示例：$(suffixsrc/foo.csrc-1.0/bar.chacks)返回值是“.c.c”。

$(basename <names...> )
名称：取前缀函数——basename。
功能：从文件名序列<names>中取出各个文件名的前缀部分。
返回：返回文件名序列<names>的前缀序列，如果文件没有前缀，则返回空字串。
示例：$(basenamesrc/foo.csrc-1.0/bar.chacks)返回值是“src/foosrc-1.0/barhacks”。

$(addsuffix <suffix>,<names...> )
名称：加后缀函数——addsuffix。
功能：把后缀<suffix>加到<names>中的每个单词后面。
返回：返回加过后缀的文件名序列。
示例：$(addsuffix.c,foobar)返回值是“foo.cbar.c”。

$(addprefix <prefix>,<names...> )
名称：加前缀函数——addprefix。
功能：把前缀<prefix>加到<names>中的每个单词后面。
返回：返回加过前缀的文件名序列。
示例：$(addprefixsrc/,foobar)返回值是“src/foosrc/bar”。

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

 

--------------------------------------------------------------------------------

 

补充几个常用的函数

wildcard函数
当前目录下匹配模式的文件
例如：src=$(wildcard *.c)

notdir函数
去除路径
例如：$(notdir $src)

patsubst函数
模式匹配替换
例如：$(patsubst %.c,%.o,$src)
等价于$(src:.c=.o)

shell函数
执行shell命令
例如：$(shell ls )
--------------------------------------------------------------------------------