Makefile中常用的函數

在Makefile中可以使用函數來處理變量，進而讓我們的指令或是規則更為的靈活和具有智能。make所支援的函數也不算很多，不過已經足夠我們的操作了。函數調用後，函數的傳回值可以當做變量來使用。

一、函數的調用文法

函數調用，很像變量的使用，也是以“$”來辨別的，其文法如下：

    $(

)

或是

    ${

}

這裡，就是函數名，make支援的函數不多。是函數的參數，參數間以逗号“,”分隔，而函數名和參數之間以“空格”分隔。函數調用以“$”開頭，以圓括号或花括号把函數名和參數括起。感覺很像一個變量，是不是？函數中的參數可以使用變量，為了風格的統一，函數和變量的括号最好一樣，如使用“$(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

,,)

    名稱：字元串替換函數——subst。

    功能：把字串中的字元串替換成。

    傳回：函數傳回被替換過後的字元串。

    示例：

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

        把“feet on the street”中的“ee”替換成“EE”，傳回結果是“fEEt

on the strEEt”。

$(patsubst ,,)

    名稱：模式字元串替換函數——patsubst。

    功能：查找中的單詞（單詞以“空格”、“Tab”或“回車”“換行”分隔）是否符合模式，如果比對的話，則以替換。這裡，可以包括通配符“%”，表示任意長度的字串。如果中也包含“%”，那麼，中的這個“%”将是中的那個“%”所代表的字串。（可以用“\”來轉義，以“\%”來表示真實含義的“%”字元）

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

        把字串“x.c.c

bar.c”符合模式[%.c]的單詞替換成[%.o]，傳回結果是“x.c.o

bar.o”

    備注：

        這和我們前面“變量章節”說過的相關知識有點相似。如：

        “$(var:=)”

         相當于

        “$(patsubst

,,$(var))”，

         而“$(var:

=)”

         則相當于

         “$(patsubst

%,%,$(var))”。

         例如有：objects = foo.o

bar.o baz.o，

         那麼，“$(objects:.o=.c)”和“$(patsubst

%.o,%.c,$(objects))”是一樣的。

$(strip )

    名稱：去空格函數——strip。

    功能：去掉字串中開頭和結尾的空字元。

    傳回：傳回被去掉空格的字元串值。

        $(strip a b c )

        把字串“a b

c ”去到開頭和結尾的空格，結果是“a b c”。

$(findstring ,)

    名稱：查找字元串函數——findstring。

    功能：在字串中查找字串。

    傳回：如果找到，那麼傳回，否則傳回空字元串。

$(findstring a,a b c)

        $(findstring a,b c)

        第一個函數傳回“a”字元串，第二個傳回“”字元串（空字元串）

$(filter

,)

    名稱：過濾函數——filter。

    功能：以模式過濾字元串中的單詞，保留符合模式的單詞。可以有多個模式。

    傳回：傳回符合模式的字串。

        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

    名稱：反過濾函數——filter-out。

    功能：以模式過濾字元串中的單詞，去除符合模式的單詞。可以有多個模式。

    傳回：傳回不符合模式的字串。

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

        mains=main1.o main2.o

        $(filter-out $(mains),$(objects)) 傳回值是“foo.o

bar.o”。

$(sort )

    名稱：排序函數——sort。

    功能：給字元串中的單詞排序（升序）。

    傳回：傳回排序後的字元串。

    示例：$(sort foo bar lose)傳回“bar foo lose” 。

    備注：sort函數會去掉中相同的單詞。

$(word ,)

    名稱：取單詞函數——word。

    功能：取字元串中第個單詞。（從一開始）

    傳回：傳回字元串中第個單詞。如果比中的單詞數要大，那麼傳回空字元串。

    示例：$(word 2, foo bar baz)傳回值是“bar”。

$(wordlist

    名稱：取單詞串函數——wordlist。

    功能：從字元串中取從開始到的單詞串。和是一個數字。

    傳回：傳回字元串中從到的單詞字串。如果比中的單詞數要大，那麼傳回空字元串。如果大于的單詞數，那麼傳回從開始，到結束的單詞串。

    示例： $(wordlist 2, 3, foo bar baz)傳回值是“bar

baz”。

$(words )

    名稱：單詞個數統計函數——words。

    功能：統計中字元串中的單詞個數。

    傳回：傳回中的單詞數。

    示例：$(words, foo bar baz)傳回值是“3”。

    備注：如果我們要取中最後的一個單詞，我們可以這樣：$(word

$(words ),)。

$(firstword )

    名稱：首單詞函數——firstword。

    功能：取字元串中的第一個單詞。

    傳回：傳回字元串的第一個單詞。

    示例：$(firstword foo bar)傳回值是“foo”。

    備注：這個函數可以用word函數來實作：$(word

1,)。

以上，是所有的字元串操作函數，如果搭配混合使用，可以完成比較複雜的功能。這裡，舉一個現實中應用的例子。我們知道，make使用“VPATH”變量來指定“依賴檔案”的搜尋路徑。于是，我們可以利用這個搜尋路徑來指定編譯器對頭檔案的搜尋路徑參數CFLAGS，如：

    override CFLAGS += $(patsubst

%,-I%,$(subst :, ,$(VPATH)))

    如果我們的“$(VPATH)”值是“src:../headers”，那麼“$(patsubst

%,-I%,$(subst :, ,$(VPATH)))”将傳回“-Isrc -I../headers”，這正是cc或gcc搜尋頭檔案路徑的參數。

三、檔案名操作函數

下面我們要介紹的函數主要是處理檔案名的。每個函數的參數字元串都會被當做一個或是一系列的檔案名來對待。

$(wildcard )

名稱：檔案名展開函數——wildcard 。

    功能：功能是展開成一列所有符合由其參數描述的檔案名，檔案間以空格間隔。

    傳回：函數傳回展開後的檔案名清單。

示例：

        $(wildcard *.c)

        傳回結果是一個所有以 '.c' 結尾的檔案的清單。 

$(dir )

    名稱：取目錄函數——dir。

    功能：從檔案名序列中取出目錄部分。目錄部分是指最後一個反斜杠（“/”）之前的部分。如果沒有反斜杠，那麼傳回“./”。

    傳回：傳回檔案名序列的目錄部分。

    示例： $(dir src/foo.c hacks)傳回值是“src/

./”。

$(notdir )

    名稱：取檔案函數——notdir。

    功能：從檔案名序列中取出非目錄部分。非目錄部分是指最後一個反斜杠（“/”）之後的部分。

    傳回：傳回檔案名序列的非目錄部分。

    示例： $(notdir src/foo.c hacks)傳回值是“foo.c

hacks”。

$(suffix )

    名稱：取字尾函數——suffix。

    功能：從檔案名序列中取出各個檔案名的字尾。

    傳回：傳回檔案名序列的字尾序列，如果檔案沒有字尾，則傳回空字串。

    示例：$(suffix src/foo.c src-1.0/bar.c hacks)傳回值是“.c

.c”。

$(basename )

    名稱：取字首函數——basename。

    功能：從檔案名序列中取出各個檔案名的字首部分。

    傳回：傳回檔案名序列的字首序列，如果檔案沒有字首，則傳回空字串。

    示例：$(basename src/foo.c src-1.0/bar.c hacks)傳回值是“src/foo

src-1.0/bar hacks”。

$(addsuffix

    名稱：加字尾函數——addsuffix。

    功能：把字尾加到中的每個單詞後面。

    傳回：傳回加過字尾的檔案名序列。

    示例：$(addsuffix .c,foo bar)傳回值是“foo.c

bar.c”。

$(addprefix

    名稱：加字首函數——addprefix。

    功能：把字首加到中的每個單詞後面。

    傳回：傳回加過字首的檔案名序列。

    示例：$(addprefix src/,foo bar)傳回值是“src/foo

src/bar”。

$(join ,)

    名稱：連接配接函數——join。

    功能：把中的單詞對應地加到的單詞後面。如果的單詞個數要比的多，那麼，中的多出來的單詞将保持原樣。如果的單詞個數要比多，那麼，多出來的單詞将被複制到中。

    傳回：傳回連接配接過後的字元串。

    示例：$(join aaa bbb , 111 222 333)傳回值是“aaa111

bbb222 333”。

四、foreach 函數

foreach函數和别的函數非常的不一樣。因為這個函數是用來做循環用的，Makefile中的foreach函數幾乎是仿照于Unix标準Shell（/bin/sh）中的for語句，或是C-Shell（/bin/csh）中的foreach語句而建構的。它的文法是：

    $(foreach

這個函數的意思是，把參數中的單詞逐一取出放到參數所指定的變量中，然後再執行所包含的表達式。每一次會傳回一個字元串，循環過程中，的所傳回的每個字元串會以空格分隔，最後當整個循環結束時，所傳回的每個字元串所組成的整個字元串（以空格分隔）将會是foreach函數的傳回值。

是以，最好是一個變量名，可以是一個表達式，而中一般會使用這個參數來依次枚舉中的單詞。舉個例子：

    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中的參數是一個臨時的局部變量，foreach函數執行完後，參數的變量将不在作用，其作用域隻在foreach函數當中。

五、if 函數

if函數很像GNU的make所支援的條件語句——ifeq（參見前面所述的章節），if函數的文法是：

    $(if ,) 

    $(if

可見，if函數可以包含“else”部分，或是不含。即if函數的參數可以是兩個，也可以是三個。參數是if的表達式，如果其傳回的為非空字元串，那麼這個表達式就相當于傳回真，于是，會被計算，否則會被計算。

而if函數的傳回值是，如果為真（非空字元串），那個會是整個函數的傳回值，如果為假（空字元串），那麼會是整個函數的傳回值，此時如果沒有被定義，那麼，整個函數傳回空字串。

是以，和隻會有一個被計算。

六、call函數

call函數是唯一一個可以用來建立新的參數化的函數。你可以寫一個非常複雜的表達式，這個表達式中，你可以定義許多參數，然後你可以用call函數來向這個表達式傳遞參數。其文法是：

    $(call

,,,...)

當make執行這個函數時，參數中的變量，如$(1)，$(2)，$(3)等，會被參數，，依次取代。而的傳回值就是call函數的傳回值。例如：

    reverse =  $(1) $(2)

    foo = $(call reverse,a,b)

那麼，foo的值就是“a b”。當然，參數的次序是可以自定義的，不一定是順序的，如：

    reverse = 

$(2) $(1)

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

七、origin函數

origin函數不像其它的函數，他并不操作變量的值，他隻是告訴你你的這個變量是哪裡來的？其文法是：

    $(origin )

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

“undefined”

      如果從來沒有定義過，origin函數傳回這個值“undefined”。

“default”

      如果是一個預設的定義，比如“CC”這個變量，這種變量我們将在後面講述。

“environment”

      如果是一個環境變量，并且當Makefile被執行時，“-e”參數沒有被打開。

“file”

      如果這個變量被定義在Makefile中。

“command

line”

      如果這個變量是被指令行定義的。

“override”

      如果是被override訓示符重新定義的。

“automatic”

      如果是一個指令運作中的自動化變量。關于自動化變量将在後面講述。

這些資訊對于我們編寫Makefile是非常有用的，例如，假設我們有一個Makefile其包了一個定義檔案Make.def，在Make.def中定義了一個變量“bletch”，而我們的環境中也有一個環境變量“bletch”，此時，我們想判斷一下，如果變量來源于環境，那麼我們就把之重定義了，如果來源于Make.def或是指令行等非環境的，那麼我們就不重新定義它。于是，在我們的Makefile中，我們可以這樣寫：

    ifdef bletch

    ifeq "$(origin bletch)"

"environment"

    bletch = barf, gag, etc.

    endif

當然，你也許會說，使用override關鍵字不就可以重新定義環境中的變量了嗎？為什麼需要使用這樣的步驟？是的，我們用override是可以達到這樣的效果，可是override過于粗暴，它同時會把從指令行定義的變量也覆寫了，而我們隻想重新定義環境傳來的，而不想重新定義指令行傳來的。

八、shell函數

shell函數也不像其它的函數。顧名思義，它的參數應該就是作業系統Shell的指令。它和反引号“`”是相同的功能。這就是說，shell函數把執行作業系統指令後的輸出作為函數傳回。于是，我們可以用作業系統指令以及字元串處理指令awk，sed等等指令來生成一個變量，如：

    contents := $(shell cat foo)

    files := $(shell echo *.c)

注意，這個函數會新生成一個Shell程式來執行指令，是以你要注意其運作性能，如果你的Makefile中有一些比較複雜的規則，并大量使用了這個函數，那麼對于你的系統性能是有害的。特别是Makefile的隐晦的規則可能會讓你的shell函數執行的次數比你想像的多得多。