一、文本處理函數
以下是GNU make內嵌的文本(字符串)處理函數。
1 $(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”。
2 $(patsubst PATTERN,REPLACEMENT,TEXT)
函數名稱:模式替換函數—patsubst。
函數功能:搜索“TEXT”中以空格分開的單詞,將否符合模式“TATTERN”替換為“REPLACEMENT”。參數“PATTERN”中可以使用模式通配符“%”來代表一個單詞中的若干字符。如果參數“REPLACEMENT”中也包含一個“%”,那么“REPLACEMENT”中的“%”將是“TATTERN”中的那個“%”所代表的字符串。在“TATTERN”和“REPLACEMENT”中,只有第一個“%”被作為模式字符來處理,之后出現的不再作模式字符(作為一個字符)。在參數中如果需要將第一個出現的“%”作為字符本身而不作為模式字符時,可使用反斜杠“\”進行轉義處理。
返回值:替換后的新字符串。
函數說明:參數“TEXT”單詞之間的多個空格在處理時被合並為一個空格,並忽略前導和結尾空格。
示例:
$(patsubst %.c,%.o,x.c.c bar.c)
把字串“x.c.c bar.c”中以.c結尾的單詞替換成以.o結尾的字符。函數的返回結果是“x.c.o bar.o”
變量的替換引用,它是一個簡化版的“patsubst”函數在變量引用過程的實現。變量替換引用中:
$(VAR:PATTERN=REPLACEMENT)
就相當於:
$(patsubst PATTERN,REPLACEMENT,$(VAR))
而另外一種更為簡單的替換字符后綴的實現:
$(VAR:SUFFIX=REPLACEMENT)
它等於:
$(patsubst %SUFFIX,%REPLACEMENT,$(VAR))
例如我們存在一個代表所有.o文件的變量。定義為“objects = foo.o bar.o baz.o”。為了得到這些.o文件所對應的.c源文件。我們可以使用以下兩種方式的任意一個:
$(objects:.o=.c)
$(patsubst %.o,%.c,$(objects))
patsubst三個操作數用逗號隔開
作用:將foo的所有由空格隔開的字符串尾的.c用.o代替
出錯提示:Makefile:4: *** insufficient number of arguments (2) to function `patsubst'. Stop.
格式舉例:bar := $(patsubst %.c,%.o,$(foo))
3 $(strip STRINT)
函數名稱:去空格函數—strip。
函數功能:去掉字串(若干單詞,使用若干空字符分割)“STRINT”開頭和結尾的空字符,並將其中多個連續空字符合並為一個空字符。
返回值:無前導和結尾空字符、使用單一空格分割的多單詞字符串。
函數說明:空字符包括空格、[Tab]等不可顯示字符。
示例:
STR = a b c
LOSTR = $(strip $(STR))
結果是“a b c”。
“strip”函數經常用在條件判斷語句的表達式中,確保表達式比較的可靠和健壯!
4 $(findstring FIND,IN)
函數名稱:查找字符串函數—findstring。
函數功能:搜索字串“IN”,查找“FIND”字串。
返回值:如果在“IN”之中存在“FIND”,則返回“FIND”,否則返回空。
函數說明:字串“IN”之中可以包含空格、[Tab]。搜索需要是嚴格的文本匹配。
示例:
$(findstring a,a b c)
$(findstring a,b c)
第一個函數結果是字“a”;第二個值為空字符。
5 $(filter PATTERN…,TEXT)
函數名稱:過濾函數—filter。
函數功能:過濾掉字串“TEXT”中所有不符合模式“PATTERN”的單詞,保留所有符合此模式的單詞。可以使用多個模式。模式中一般需要包含模式字符“%”。存在多個模式時,模式表達式之間使用空格分割。
返回值:空格分割的“TEXT”字串中所有符合模式“PATTERN”的字串。
函數說明:“filter”函數可以用來去除一個變量中的某些字符串,我們下邊的例子中就是用到了此函數。
示例:
sources := foo.c bar.c baz.s ugh.h
foo: $(sources)
cc $(filter %.c %.s,$(sources)) -o foo
使用“$(filter %.c %.s,$(sources))”的返回值給cc來編譯生成目標“foo”,函數返回值為“foo.c bar.c baz.s”。
6 $(filter-out PATTERN...,TEXT)
函數名稱:反過濾函數—filter-out。
函數功能:和“filter”函數實現的功能相反。過濾掉字串“TEXT”中所有符合模式“PATTERN”的單詞,保留所有不符合此模式的單詞。可以有多個模式。存在多個模式時,模式表達式之間使用空格分割。。
返回值:空格分割的“TEXT”字串中所有不符合模式“PATTERN”的字串。
函數說明:“filter-out”函數也可以用來去除一個變量中的某些字符串,(實現和“filter”函數相反)。
示例:
objects=main1.o foo.o main2.o bar.o
mains=main1.o main2.o
$(filter-out $(mains),$(objects))
實現了去除變量“objects”中“mains”定義的字串(文件名)功能。它的返回值為“foo.o bar.o”。
7 $(sort LIST)
函數名稱:排序函數—sort。
函數功能:給字串“LIST”中的單詞以首字母為准進行排序(升序),並去掉重復的單詞。
返回值:空格分割的沒有重復單詞的字串。
函數說明:兩個功能,排序和去字串中的重復單詞。可以單獨使用其中一個功能。
示例:
$(sort foo bar lose foo)
返回值為:“bar foo lose” 。
8 $(word N,TEXT)
函數名稱:取單詞函數—word。
函數功能:取字串“TEXT”中第“N”個單詞(“N”的值從1開始)。
返回值:返回字串“TEXT”中第“N”個單詞。
函數說明:如果“N”值大於字串“TEXT”中單詞的數目,返回空字符串。如果“N”為0,出錯!
示例:
$(word 2, foo bar baz)
返回值為“bar”。
9 $(wordlist S,E,TEXT)
函數名稱:取字串函數—wordlist。
函數功能:從字串“TEXT”中取出從“S”開始到“E”的單詞串。“S”和“E”表示單詞在字串中位置的數字。
返回值:字串“TEXT”中從第“S”到“E”(包括“E”)的單詞字串。
函數說明:“S”和“E”都是從1開始的數字。
當“S”比“TEXT”中的字數大時,返回空。如果“E”大於“TEXT”字數,返回從“S”開始,到“TEXT”結束的單詞串。如果“S”大於“E”,返回空。
示例:
$(wordlist 2, 3, foo bar baz)
返回值為:“bar baz”。
10 $(words TEXT)
函數名稱:統計單詞數目函數—words。
函數功能:字算字串“TEXT”中單詞的數目。
返回值:“TEXT”字串中的單詞數。
示例:
$(words, foo bar)
返回值是“2”。所以字串“TEXT”的最后一個單詞就是:$(word $(words TEXT),TEXT)。
11 $(firstword NAMES…)
函數名稱:取首單詞函數—firstword。
函數功能:取字串“NAMES…”中的第一個單詞。
返回值:字串“NAMES…”的第一個單詞。
函數說明:“NAMES”被認為是使用空格分割的多個單詞(名字)的序列。函數忽略“NAMES…”中除第一個單詞以外的所有的單詞。
示例:
$(firstword foo bar)
返回值為“foo”。函數“firstword”實現的功能等效於“$(word 1, NAMES…)”。
以上11個函數是make內嵌的的文本處理函數。書寫Makefile時可搭配使用來實現復雜功能。最后我們使用這些函數來實現一個實際應用。例子中我們使用函數“subst”和“patsbust”。Makefile中可以使用變量“VPATH”來指定搜索路徑。對於源代碼所包含的頭文件的搜索路徑需要使用gcc的“-I”參數指定目錄來實現,“VPATH”羅列的目錄是用冒號“:”分割的。如下就是Makefile的片段:
……
VPATH = src:../includes
override CFLAGS += $(patsubst %,-I%,$(subst :, ,$(VPATH)))
…….
那么第二條語句所實現的功能就是“CFLAGS += -Isrc –I../includes”。
二、文件名處理函數
GNU make除支持文本處理函數之外,還支持一些針對於文件名的處理函數。這些函數主要用來對一系列空格分割的文件名進行轉換,這些函數的參數被作為若干個文件名來對待。函數對作為參數的一組文件名按照一定方式進行處理並返回空格分割的多個文件名序列。
1 $(dir NAMES…)
函數名稱:取目錄函數—dir。
函數功能:從文件名序列“NAMES…”中取出各個文件名的目錄部分。文件名的目錄部分就是包含在文件名中的最后一個斜線(“/”)(包括斜線)之前的部分。
返回值:空格分割的文件名序列“NAMES…”中每一個文件的目錄部分。
函數說明:如果文件名中沒有斜線,認為此文件為當前目錄(“./”)下的文件。
示例:
$(dir src/foo.c hacks)
返回值為“src/ ./”。
2 $(notdir NAMES…)
函數名稱:取文件名函數——notdir。
函數功能:從文件名序列“NAMES…”中取出非目錄部分。目錄部分是指最后一個斜線(“/”)(包括斜線)之前的部分。刪除所有文件名中的目錄部分,只保留非目錄部分。
返回值:文件名序列“NAMES…”中每一個文件的非目錄部分。
函數說明:如果“NAMES…”中存在不包含斜線的文件名,則不改變這個文件名。以反斜線結尾的文件名,是用空串代替,因此當“NAMES…”中存在多個這樣的文件名時,返回結果中分割各個文件名的空格數目將不確定!這是此函數的一個缺陷。
示例:
$(notdir src/foo.c hacks)
返回值為:“foo.c hacks”。
3 $(suffix NAMES…)
函數名稱:取后綴函數—suffix。
函數功能:從文件名序列“NAMES…”中取出各個文件名的后綴。后綴是文件名中最后一個以點“.”開始的(包含點號)部分,如果文件名中不包含一個點號,則為空。
返回值:以空格分割的文件名序列“NAMES…”中每一個文件的后綴序列。
函數說明:“NAMES…”是多個文件名時,返回值是多個以空格分割的單詞序列。如果文件名沒有后綴部分,則返回空。
示例:
$(suffix src/foo.c src-1.0/bar.c hacks)
返回值為“.c .c”。
4 $(basename NAMES…)
函數名稱:取前綴函數—basename。
函數功能:從文件名序列“NAMES…”中取出各個文件名的前綴部分(點號之后的部分)。前綴部分指的是文件名中最后一個點號之前的部分。
返回值:空格分割的文件名序列“NAMES…”中各個文件的前綴序列。如果文件沒有前綴,則返回空字串。
函數說明:如果“NAMES…”中包含沒有后綴的文件名,此文件名不改變。如果一個文件名中存在多個點號,則返回值為此文件名的最后一個點號之前的文件名部分。
示例:
$(basename src/foo.c src-1.0/bar.c /home/jack/.font.cache-1 hacks)
返回值為:“src/foo src-1.0/bar /home/jack/.font hacks”。
5 $(addsuffix SUFFIX,NAMES…)
函數名稱:加后綴函數—addsuffix。
函數功能:為“NAMES…”中的每一個文件名添加后綴“SUFFIX”。參數“NAMES…”為空格分割的文件名序列,將“SUFFIX”追加到此序列的每一個文件名的末尾。
返回值:以單空格分割的添加了后綴“SUFFIX”的文件名序列。
函數說明:
示例:
$(addsuffix .c,foo bar)
返回值為“foo.c bar.c”。
6 $(addprefix PREFIX,NAMES…)
函數名稱:加前綴函數—addprefix。
函數功能:為“NAMES…”中的每一個文件名添加前綴“PREFIX”。參數“NAMES…”是空格分割的文件名序列,將“SUFFIX”添加到此序列的每一個文件名之前。
返回值:以單空格分割的添加了前綴“PREFIX”的文件名序列。
函數說明:
示例:
$(addprefix src/,foo bar)
返回值為“src/foo src/bar”。
7 $(join LIST1,LIST2)
函數名稱:單詞連接函數——join。
函數功能:將字串“LIST1”和字串“LIST2”各單詞進行對應連接。就是將“LIST2”中的第一個單詞追加“LIST1”第一個單詞字后合並為一個單詞;將“LIST2”中的第二個單詞追加到“LIST1”的第一個單詞之后並合並為一個單詞,……依次列推。
返回值:單空格分割的合並后的字(文件名)序列。
函數說明:如果“LIST1”和“LIST2”中的字數目不一致時,兩者中多余部分將被作為返回序列的一部分。
示例1:
$(join a b , .c .o)
返回值為:“a.c b.o”。
示例2:
$(join a b c , .c .o)
返回值為:“a.c b.o c”。
8 $(wildcard PATTERN)
函數名稱:獲取匹配模式文件名函數—wildcard
函數功能:列出當前目錄下所有符合模式“PATTERN”格式的文件名。
返回值:空格分割的、存在當前目錄下的所有符合模式“PATTERN”的文件名。
函數說明:“PATTERN”使用shell可識別的通配符,包括“?”(單字符)、“*”(多字符)等。
示例:
$(wildcard *.c)
返回值為當前目錄下所有.c源文件列表。
三、foreach函數
函數“foreach”不同於其它函數。它是一個循環函數。類似於Linux的shell中的for語句。
“foreach”函數的語法:
$(foreach VAR,LIST,TEXT)
函數功能:這個函數的工作過程是這樣的:如果需要(存在變量或者函數的引用),首先展開變量“VAR”和“LIST”的引用;而表達式“TEXT”中的變量引用不展開。執行時把“LIST”中使用空格分割的單詞依次取出賦值給變量“VAR”,然后執行“TEXT”表達式。重復直到“LIST”的最后一個單詞(為空時結束)。“TEXT”中的變量或者函數引用在執行時才被展開,因此如果在“TEXT”中存在對“VAR”的引用,那么“VAR”的值在每一次展開式將會到的不同的值。
返回值:空格分割的多次表達式“TEXT”的計算的結果。
看一個例子,定義變量“files”,它的值為四個目錄(變量“dirs”代表的a、b、c、d四個目錄)下的文件列表:
dirs := a b c d
files := $(foreach dir,$(dirs),$(wildcard $(dir)/*))
例子中,“TEXT”的表達式為“$(wildcard $(dir)/*)”。表達式第一次執行時將展開為“$(wildcard a/*)”;第二次執行時將展開為“$(wildcard b/*)”;第三次展開為“$(wildcard c/*)”;….;以此類推。所以此函數所實現的功能就和一下語句等價:
files := $(wildcard a/* b/* c/* d/*)
當函數的“TEXT”表達式過於復雜時,我們可以通過定義一個中間變量,此變量代表表達式的一部分。並在函數的“TEXT”中引用這個變量。上邊的例子也可以這樣來實現:
find_files = $(wildcard $(dir)/*)
dirs := a b c d
files := $(foreach dir,$(dirs),$(find_files))
在這里我們定義了一個變量(也可以稱之為表達式),需要注意,在這里定義的是“遞歸展開”時的變量“find_files”。保證了定義時變量值中的引用不展開,而是在表達式被函數處理時才展開(如果這里使用直接展開式的定義將是無效的表達式)。
函數說明:函數中參數“VAR”是一個局部的臨時變量,它只在“foreach”函數的上下文中有效,它的定義不會影響其它部分定義的同名“VAR”變量的值。在函數的執行過程中它是一個“直接展開”式變量。
在使用函數“foreach”時,需要注意:變量“VAR”的名字。我們建議使用一個單詞、最好能夠表達其含義的名字,不要使用一個奇怪的字符串作為變量名。雖然執行是不會發生錯誤,但是會讓人很費解。
沒有人會喜歡這種方式,盡管可能它可以正常工作:
files := $(foreach Esta escrito en espanol!,b c ch,$(find_files))
四、if函數
函數“if”提供了一個在函數上下文中實現條件判斷的功能。就像make所支持的條件語句—ifeq一樣。
函數語法:
$(if CONDITION,THEN-PART[,ELSE-PART])
函數功能:第一個參數“CONDITION”,在函數執行時忽略其前導和結尾空字符,如果包含對其他變量或者函數的引用則進行展開。如果“CONDITION”的展開結果非空,則條件為真,就將第二個參數“THEN_PATR”作為函數的計算表達式;“CONDITION”的展開結果為空,將第三個參數“ELSE-PART”作為函數的表達式,函數的返回結果為有效表達式的計算結果。
返回值:根據條件決定函數的返回值是第一個或者第二個參數表達式的計算結果。當不存在第三個參數“ELSE-PART”,並且“CONDITION”展開為空,函數返回空。
函數說明:函數的條件表達式“CONDITION”決定了函數的返回值只能是“THEN-PART”或者“ELSE-PART”兩個之一的計算結果。
函數示例:
SUBDIR += $(if $(SRC_DIR) $(SRC_DIR),/home/src)
函數的結果是:如果“SRC_DIR”變量值不為空,則將變量“SRC_DIR”指定的目錄作為一個子目錄;否則將目錄“/home/src”作為一個子目錄。
五、call函數
“call”函數是唯一一個可以創建定制化參數函數的引用函數。使用這個函數可以實現對用戶自己定義函數引用。我們可以將一個變量定義為一個復雜的表達式,用“call”函數根據不同的參數對它進行展開來獲得不同的結果。
函數語法:
$(call VARIABLE,PARAM,PARAM,...)
函數功能:在執行時,將它的參數“PARAM”依次賦值給臨時變量“$(1)”、“$(2)”(這些臨時變量定義在“VARIABLE”的值中,參考下邊的例子)…… call函數對參數的數目沒有限制,也可以沒有參數值,沒有參數值的“call”沒有任何實際存在的意義。執行時變量“VARIABLE”被展開為在函數上下文有效的臨時變量,變量定義中的“$(1)”作為第一個參數,並將函數參數值中的第一個參數賦值給它;變量中的“$(2)”一樣被賦值為函數的第二個參數值;依此類推(變量$(0)代表變量“VARIABLE”本身)。之后對變量“VARIABLE” 表達式的計算值。
返回值:參數值“PARAM”依次替換“$(1)”、“$(2)”…… 之后變量“VARIABLE”定義的表達式的計算值。(使用call函數“VARIABLE”中一定存在“$(1)”、“$(2)”…… )
函數說明:1. 函數中“VARIBLE”是一個變量名,而不是變量引用。因此,通常“call”函數中的“VARIABLE”中不包含“$”(當然,除非此變量名是一個計算的變量名)。2. 當變量“VARIBLE”是一個make內嵌的函數名時(如“if”、“foreach”、“strip”等),對“PARAM”參數的使用需要注意,因為不合適或者不正確的參數將會導致函數的返回值難以預料。3. 函數中多個“PARAM”之間使用逗號分割。4. 變量“VARIABLE”在定義時不能定義為直接展開式!只能定義為遞歸展開式。
函數示例:
首先,來看一個簡單的例子。
示例1:
reverse = $(2) $(1)
foo = $(call reverse,a,b)
變量“foo”的值為“ba”。這里變量“reverse”中的參數定義順序可以根據需要來調整,並不是需要按照“$(1)”、“$(2)”、“$(3)”…… 這樣的順序來定義。
看一個稍微復雜一些的例子。我們定義了一個宏“pathsearch”來在“PATH”路徑中搜索第一個指定的程序。
示例2:
pathsearch = $(firstword $(wildcard $(addsuffix /$(1),$(subst :, ,$(PATH)))))
LS := $(call pathsearch,ls)
變量“LS”的結果為“/bin/sh”。執行過程:函數“subst”將環境變量“PATH”轉換為空格分割的搜索路徑列表;“addsuffix”構造出可能的可執行程序“$(1)”(這里是“ls”)帶路徑的完整文件名(如:“/bin/$(1)”),之后使用函數“wildcard”匹配,最后“firstword”函數取第一個文件名。
函數“call”以可以套嵌使用。每一層“call”函數的調用都為它自己的局部變量“$(1)”等賦值,覆蓋上一層函數為它所賦的值。
示例3:
map = $(foreach a,$(2),$(call $(1),$(a)))
o = $(call map,origin,o map MAKE)
那么變量“o”的值就為“file file default”。我們這里使用了“origin”函數。我們分析函數的執行過程:首先,“o=$(call map,origin, o map MAKE)”這個函數調用使用了變量“map”所定義的表達式;使用內嵌函數名“origin”作為它的第一個參數值,使用Makefile中的變量“o map MAKE”作為他的第二個參數值。當使用“call”函數展開后等價於“$(foreach a,o map MAKE,$(origin $(a)))”。
注意:和其它函數一樣,“call”函數會保留出現在其參數值列表中的空字符。因此在使用參數值時對空格處理要格外小心。如果參數中存在多余的空格,函數可能會返回一個莫名奇妙的值。為了安全,在變量作為“call”函數參數值之前,應去掉其值中的多余空格。
六、value函數
函數“value”提供了一種在不對變量進行展開的情況下獲取變量值的方法。注意:並不是說函數會取消之前已經執行過的替換擴展。比如:定義了一個直接展開式的變量,此變量在定義過程中對其它變量的引用進行替換而得到自身的值。在使用“value”函數取這個變量進行取值時,得到的是不包含任何引用值。而不是將定義過程中的替換展開動作取消后包含引用的定義值。就是說此過程不能取消此變量在定義時已經發生了的替換展開動作。
函數語法:
$(value VARIABLE)
函數功能:不對變量“VARIBLE”進行任何展開操作,直接返回變量“VARIBALE”的值。這里“VARIABLE”是一個變量名,一般不包含“$”(除非計算的變量名),
返回值:變量“VARIBALE”所定義文本值(如果變量定義為遞歸展開式,其中包含對其他變量或者函數的引用,那么函數不對這些引用進行展開。函數的返回值是包含有引用值)。
函數說明:
示例:
# sample Makefile
FOO = $PATH
all:
@echo $(FOO)
@echo $(value FOO)
執行make,可以看到的結果是:第一行為:“ATH”。這是因為變量“FOO”定義為“$PATH”,所以展開為“ATH”(“$P”為空)。
第二行才是我們需要顯示的系統環境變量“PATH”的值(value函數得到變量“FOO”的值為“$PATH”)。
七、eval函數
函數功能:函數“eval”是一個比較特殊的函數。使用它可以在Makefile中構造一個可變的規則結構關系(依賴關系鏈),其中可以使用其它變量和函數。函數“eval”對它的參數進行展開,展開的結果作為Makefile的一部分,make可以對展開內容進行語法解析。展開的結果可以包含一個新變量、目標、隱含規則或者是明確規則等。也就是說此函數的功能主要是:根據其參數的關系、結構,對它們進行替換展開。
返回值:函數“eval”的返回值時空,也可以說沒有返回值。
函數說明:“eval”函數執行時會對它的參數進行兩次展開。第一次展開過程是由函數本身完成的,第二次是函數展開后的結果被作為Makefile內容時由make解析時展開的。明確這一過程對於使用“eval”函數非常重要。理解了函數“eval”二次展開的過程后。實際使用時,如果在函數的展開結果中存在引用(格式為:$(x)),那么在函數的參數中應該使用“$$”來代替“$”。因為這一點,所以通常它的參數中會使用函數“value”來取一個變量的文本值。
我們看一個例子。例子看起來似乎非常復雜,因為它綜合了其它的一些概念和函數。不過我們可以考慮兩點:其一,通常實際一個模板的定義可能比例子中的更為復雜;其二,我們可以實現一個復雜通用的模板,在所有Makefile中包含它,亦可作到一勞永逸。相信這一點可能是大多數程序員所推崇的。
示例:
# sample Makefile
PROGRAMS = server client
server_OBJS = server.o server_priv.o server_access.o
server_LIBS = priv protocol
client_OBJS = client.o client_api.o client_mem.o
client_LIBS = protocol
# Everything after this is generic
.PHONY: all
all: $(PROGRAMS)
define PROGRAM_template
$(1): $$($(1)_OBJ) $$($(1)_LIBS:%=-l%)
ALL_OBJS += $$($(1)_OBJS)
endef
$(foreach prog,$(PROGRAMS),$(eval $(call PROGRAM_template,$(prog))))
$(PROGRAMS):
$(LINK.o) $^ $(LDLIBS) -o $@
clean:
rm -f $(ALL_OBJS) $(PROGRAMS)
來看一下這個例子:它實現的功能是完成“PROGRAMS”的編譯鏈接。例子中“$(LINK.o)”為“$(CC) $(LDFLAGS)”,意思是對所有的.o文件和指定的庫文件進行鏈接。
“$(foreach prog,$(PROGRAM),$(eval $(call PROGRAM_template,$(prog))))”展開為:
server : $(server_OBJS) –l$(server_LIBS)
client : $(client_OBJS) –l$(client_LIBS)
八、origin函數
函數“origin”和其他函數不同,函數“origin”的動作不是操作變量(它的參數)。它只是獲取此變量(參數)相關的信息,告訴我們這個變量的出處(定義方式)。
函數語法:
$(origin VARIABLE)
函數功能:函數“origin”查詢參數“VARIABLE”(一個變量名)的出處。
函數說明:“VARIABLE”是一個變量名而不是一個變量的引用。因此通常它不包含“$”(當然,計算的變量名例外)。
返回值:返回“VARIABLE”的定義方式。用字符串表示。
函數的返回情況有以下幾種:
1. undefined
變量“VARIABLE”沒有被定義。
2. default
變量“VARIABLE”是一個默認定義(內嵌變量)。如“CC”、“MAKE”、“RM”等變量。如果在Makefile中重新定義這些變量,函數返回值將相應發生變化。
3. environment
變量“VARIABLE”是一個系統環境變量,並且make沒有使用命令行選項“-e”(Makefile中不存在同名的變量定義,此變量沒有被替代)。
4. environment override
變量“VARIABLE”是一個系統環境變量,並且make使用了命令行選項“-e”。Makefile中存在一個同名的變量定義,使用“make -e”時環境變量值替代了文件中的變量定義。
5. file
變量“VARIABLE”在某一個makefile文件中定義。
6. command line
變量“VARIABLE”在命令行中定義。
7. override
變量“VARIABLE”在makefile文件中定義並使用“override”指示符聲明。
8. automatic
變量“VARIABLE”是自動化變量。
函數“origin”返回的變量信息對我們書寫Makefile是相當有用的,可以使我們在使用一個變量之前對它值的合法性進行判斷。假設在Makefile其包了另外一個名為bar.mk的makefile文件。我們需要在bar.mk中定義變量“bletch”(無論它是否是一個環境變量),保證“make –f bar.mk”能夠正確執行。另外一種情況,當Makefile包含bar.mk,在Makefile包含bar.mk之前有同樣的變量定義,但是我們不希望覆蓋bar.mk中的“bletch”的定義。一種方式是:我們在bar.mk中使用指示符“override”聲明這個變量。但是它所存在的問題時,此變量不能被任何方式定義的同名變量覆蓋,包括命令行定義。另外一種比較靈活的實現就是在bar.mk中使用“origin”函數,如下:
ifdef bletch
ifeq "$(origin bletch)" "environment"
bletch = barf, gag, etc.
endif
endif
這里,如果存在環境變量“bletch”,則對它進行重定義。
ifneq "$(findstring environment,$(origin bletch))" ""
bletch = barf, gag, etc.
endif
這個例子實現了:即使環境變量中已經存在變量“bletch”,無論是否使用“make -e”來執行Makefile,變量“bletch”的值都是“barf,gag,etc”(在Makefile中所定義的)。環境變量不能替代文件中的定義。
如果“$(origin bletch)”返回“environment”或“environment override”,都將對變量“bletch”重新定義。
九、shell函數
shell函數不同於除“wildcard”函數之外的其它函數。make可以使用它來和外部通信。
函數功能:函數“shell”所實現的功能和shell中的引用(``)相同。實現對命令的擴展。這就意味着需要一個shell 命令作為此函數的參數,函數的返回結果是此命令在shell中的執行結果。make僅僅對它的回返結果進行處理;make將函數返回結果中的所有換行符(“\n”)或者一對“\n\r”替換為單空格;並去掉末尾的回車符號(“\n”)或者“\n\r”。進行函數展開式時,它所調用的命令(它的參數)得到執行。除對它的引用出現在規則的命令行和遞歸變量的定義中以外,其它決大多數情況下,make是在讀取解析Makefile時完成對函數shell的展開。
返回值:函數“shell”的參數(一個shell命令)在shell環境中的執行結果。
函數說明:函數本身的返回值是其參數的執行結果,沒有進行任何處理。對結果的處理是由make進行的。當對函數的引用出現在規則的命令行中,命令行在執行時函數才被展開。展開時函數參數(shell命令)的執行是在另外一個shell進程中完成的,因此需要對出現在規則命令行的多級“shell”函數引用需要謹慎處理,否則會影響效率(每一級的“shell”函數的參數都會有各自的shell進程)。
示例1:
contents := $(shell cat foo)
將變量“contents”賦值為文件“foo”的內容,文件中的換行符在變量中使用空格代替。
示例2:
files := $(shell echo *.c)
將變量“files”賦值為當前目錄下所有.c文件的列表(文件名之間使用空格分割)。在shell中之行的命令是“echo *.c”,此命令返回當前目錄下的所有.c文件列表。上例的執行結果和函數“$(wildcard *.c)”的結果相同,除非你使用的是一個奇怪的shell。
注意:通過上邊的兩個例子我們可以看到,當引用“shell”函數的變量定義使用直接展開式定義時可以保證函數的展開是在make讀入Makefile時完成。后續對此變量的引用就不會有展開過程。這樣就可以避免規則命令行中的變量引用在命令行執行時展開的情況發生(因為展開“shell”函數需要另外的shell進程完成,影響命令的執行效率)。這也是我們建議的方式。
十、make的控制函數
make提供了兩個控制make運行方式的函數。通常它們用在Makefile中,當make執行過程中檢測到某些錯誤是為用戶提供消息,並且可以控制make過程是否繼續。
1 $(error TEXT…)
函數功能:產生致命錯誤,並提示“TEXT…”信息給用戶,並退出make的執行。需要說明的是:“error”函數是在函數展開式(函數被調用時)才提示信息並結束make進程。因此如果函數出現在命令中或者一個遞歸的變量定義中時,在讀取Makefile時不會出現錯誤。而只有包含“error”函數引用的命令被執行,或者定義中引用此函數的遞歸變量被展開時,才會提示致命信息“TEXT…”同時退出make。
返回值:空
函數說明:“error”函數一般不出現在直接展開式的變量定義中,否則在make讀取Makefile時將會提示致命錯誤。
假設我們的Makefile中包含以下兩個片斷;
示例1:
ifdef ERROR1
$(error error is $(ERROR1))
endif
make讀取解析Makefile時,如果只起那已經定義變量“EROOR1”,make將會提示致命錯誤信息“$(ERROR1)”並退出。
示例2:
ERR = $(error found an error!)
.PHONY: err
err: ; $(ERR)
這個例子,在make讀取Makefile時不會出現致命錯誤。只有目標“err”被作為一個目標被執行時才會出現。
2 $(warning TEXT…)
函數功能:函數“warning”類似於函數“error”,區別在於它不會導致致命錯誤(make不退出),而只是提示“TEXT…”,make的執行過程繼續。
返回值:空
函數說明:用法和“error”類似,展開過程相同。