1. 程式人生 > >make之makefile 七 使用函式

make之makefile 七 使用函式

在Makefile中能夠使用函式來處理變數,從而讓我們的命令或是規則更為的靈活和具有智慧。make所支援的函式也不算非常多,只是已經足夠我們的操作了。函式呼叫後,函式的返回值能夠當做變數來使用。


一、函式的呼叫語法

函式呼叫,非常像變數的使用,也是以“$”來標識的,其語法例如以下:

$(<function> <arguments> )

或是

${<function> <arguments>}

這裡,<function>就是函式名,make支援的函式不多。<arguments>是函式的引數,引數間以逗號“,”分隔,而函式名和引數之間以“空格”分隔。函式呼叫以“$”開頭,以圓括號或花括號把函式名和引數括起。感覺非常像一個變數,是不是?函式中的引數能夠使用變數,為了風格的統一,函式和變數的括號最好一樣,如使用“$(subst a,b,$(x))”這樣的形式,而不是“$(subst a,b,${x})”的形式。由於統一會更清晰,也會降低一些不必要的麻煩。

還是來看一個演示例子:

comma:= ,
empty:=
space:= $(empty) $(empty)
foo:= a b c
bar:= $(subst $(space),$(comma),$(foo))

在這個演示例子中,$(comma)的值是一個逗號。$(space)使用了$(empty)定義了一個空格,$(foo)的值是“a b c”,$(bar)的定義用,呼叫了函式“subst”,這是一個替換函式,這個函式有三個引數,第一個引數是被替換字串,第二個引數是替換字串,第三個引數是替換操作作用的字串。這個函式也就是把$(foo)中的空格替換成逗號,所以$(bar)的值是“a,b,c”。


二、字串處理函式

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

名稱:字串替換函式——subst。
功能:把字串<text>中的<from>字串替換成<to>。
返回:函式返回被替換過後的字串。

演示例子:

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

把“feet on the street”中的“ee”替換成“EE”,返回結果是“fEEt on the strEEt”。


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

比如有:objects = foo.o bar.o baz.o,
那麼,“$(objects:.o=.c)”和“$(patsubst %.o,%.c,$(objects))”是一樣的。

$(strip <string> )

名稱:去空格函式——strip。
功能:去掉<string>字串中開頭和結尾的空字元。
返回:返回被去掉空格的字串值。
演示例子:

$(strip a b c )

把字串“a b c ”去到開頭和結尾的空格,結果是“a b c”。

$(findstring <find>,<in> )

名稱:查詢字串函式——findstring。
功能:在字串<in>中查詢<find>字串。
返回:假設找到,那麼返回<find>,否則返回空字串。
演示例子:

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

第一個函式返回“a”字串,第二個返回“”字串(空字串)

$(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>中的單詞排序(升序)。
返回:返回排序後的字串。
演示例子:$(sort foo bar lose)返回“bar foo lose” 。
備註: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>的第一個單詞。
演示例子:$(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>多出來的單詞將被拷貝到<list2>中。
返回:返回連線過後的字串。
演示例子:$(join aaa bbb , 111 222 333)返回值是“aaa111 bbb222 333”。

 

四、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>中的單詞。舉個樣例:

 

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函式非常像GNU的make所支援的條件語句——ifeq(參見前面所述的章節),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>僅僅會有一個被計算。

 

 

六、call函式


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”。當然,引數的次序是能夠自己定義的,不一定是順序的,如:

 

reverse = $(2) $(1)

foo = $(call reverse,a,b)

 

此時的foo的值就是“b a”。

 

 

七、origin函式
origin函式不像其他的函式,他並不操作變數的值,他僅僅是告訴你你的這個變數是哪裡來的?其語法是:

 

$(origin <variable> )

 

注意,<variable>是變數的名字,不應該是引用。所以你最好不要在<variable>中使用“$”字元。Origin函式會以其返回值來告訴你這個變數的“出生情況”,以下,是origin函式的返回值:

 

“undefined”

假設<variable>從來未定義過,origin函式返回這個值“undefined”。

 

“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

 

當然,你或許會說,使用overridekeyword不就能夠又一次定義環境中的變量了嗎?為什麼須要使用這樣的步驟?是的,我們用override是能夠達到這樣的效果,可是override過於粗暴,它同一時候會把從命令列定義的變數也覆蓋了,而我們僅僅想又一次定義環境傳來的,而不想又一次定義命令列傳來的。

 

 

八、shell函式


shell函式也不像其他的函式。顧名思義,它的引數應該就是作業系統Shell的命令。它和反引號“`”是相同的功能。這就是說,shell函式把執行作業系統命令後的輸出作為函式返回。於是,我們能夠用作業系統命令以及字串處理命令awk,sed等等命令來生成一個變數,如:

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

注意,這個函式會新生成一個Shell程式來執行命令,所以你要注意其執行效能,假設你的Makefile中有一些比較複雜的規則,並大量使用了這個函式,那麼對於你的系統性能是有害的。特別是Makefile的隱晦的規則可能會讓你的shell函式執行的次數比你想像的多得多。

 

九、控制make的函式


make提供了一些函式來控制make的執行。通常,你須要檢測一些執行Makefile時的執行時資訊,而且依據這些資訊來決定,你是讓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呼叫。

$(warning <text ...> )

這個函式非常像error函式,僅僅是它並不會讓make退出,僅僅是輸出一段警告資訊,而make繼續執行。