1. 程式人生 > >跟我一起寫Makefile:使用變數

跟我一起寫Makefile:使用變數

轉載:

使用變數

在Makefile中的定義的變數,就像是C/C++語言中的巨集一樣,他代表了一個文字字串,在Makefile中執行的時候其會自動原模原樣地展開在所使用的地方。其與C/C++所不同的是,你可以在Makefile中改變其值。在Makefile中,變數可以使用在“目標”,“依賴目標”, “命令”或是Makefile的其它部分中。

變數的命名字可以包含字元、數字,下劃線(可以是數字開頭),但不應該含有“:”、“#”、“=”或是空字元(空格、回車等)。變數是區分英文字母大小寫的,“foo”、“Foo”和“FOO”是三個不同的變數名。傳統的Makefile的變數名是全大寫的命名方式,但我推薦使用大小寫搭配的變數名,如: MakeFlags。這樣可以避免和系統的變數衝突,而發生意外的事情。

有一些變數是很奇怪字串,如“$<”、“[email protected]”等,這些是自動化變數,我會在後面介紹。

變數的基礎

變數在宣告時需要給予初值,而在使用時,需要給在變數名前加上“$”符號,但最好用小括號“()”或是大括號“{}”把變數給包括起來。如果你要使用真實的“$”字元,那麼你需要用“$$”來表示。

變數可以使用在許多地方,如規則中的“目標”、“依賴”、“命令”以及新的變數中。先看一個例子:

objects = program.o foo.o utils.o
program : $(objects)
        cc -o program $(objects)

$(objects) : defs.h

變數會在使用它的地方精確地展開,就像C/C++中的巨集一樣,例如:

foo = c
prog.o : prog.$(foo)
        $(foo)$(foo) -$(foo) prog.$(foo)

展開後得到:

prog.o : prog.c
        cc -c prog.c

當然,千萬不要在你的Makefile中這樣幹,這裡只是舉個例子來表明Makefile中的變數在使用處展開的真實樣子。可見其就是一個“替代”的原理。

另外,給變數加上括號完全是為了更加安全地使用這個變數,在上面的例子中,如果你不想給變數加上括號,那也可以,但我還是強烈建議你給變數加上括號。

變數中的變數

在定義變數的值時,我們可以使用其它變數來構造變數的值,在Makefile中有兩種方式來在用變數定義變數的值。

先看第一種方式,也就是簡單的使用“=”號,在“=”左側是變數,右側是變數的值,右側變數的值可以定義在檔案的任何一處,也就是說,右側中的變數不一定非要是已定義好的值,其也可以使用後面定義的值。如:

foo = $(bar)
bar = $(ugh)
ugh = Huh?

all:
        echo $(foo)

我們執行“make all”將會打出變數$(foo)的值是“Huh?”( $(foo)的值是$(bar),$(bar)的值是$(ugh),$(ugh)的值是“Huh?”)可見,變數是可以使用後面的變數來定義的。

這個功能有好的地方,也有不好的地方,好的地方是,我們可以把變數的真實值推到後面來定義,如:

CFLAGS = $(include_dirs) -O
include_dirs = -Ifoo -Ibar

當“CFLAGS”在命令中被展開時,會是“-Ifoo -Ibar -O”。但這種形式也有不好的地方,那就是遞迴定義,如:

CFLAGS = $(CFLAGS) -O

或:

A = $(B)
B = $(A)

這會讓make陷入無限的變數展開過程中去,當然,我們的make是有能力檢測這樣的定義,並會報錯。還有就是如果在變數中使用函式,那麼,這種方式會讓我們的make執行時非常慢,更糟糕的是,他會使用到的兩個make的函式“wildcard”和“shell”發生不可預知的錯誤。因為你不會知道這兩個函式會被呼叫多少次。

為了避免上面的這種方法,我們可以使用make中的另一種用變數來定義變數的方法。這種方法使用的是“:=”操作符,如:

x := foo
y := $(x) bar
x := later

其等價於:

y := foo bar
x := later

值得一提的是,這種方法,前面的變數不能使用後面的變數,只能使用前面已定義好了的變數。如果是這樣:

y := $(x) bar
x := foo

那麼,y的值是“bar”,而不是“foo bar”。

上面都是一些比較簡單的變數使用了,讓我們來看一個複雜的例子,其中包括了make的函式、條件表示式和一個系統變數“MAKELEVEL”的使用:

ifeq (0,${MAKELEVEL})
cur-dir   := $(shell pwd)
whoami    := $(shell whoami)
host-type := $(shell arch)
MAKE := ${MAKE} host-type=${host-type} whoami=${whoami}
endif

關於條件表示式和函式,我們在後面再說,對於系統變數“MAKELEVEL”,其意思是,如果我們的make有一個巢狀執行的動作(參見前面的“巢狀使用make”),那麼,這個變數會記錄了我們的當前Makefile的呼叫層數。

下面再介紹兩個定義變數時我們需要知道的,請先看一個例子,如果我們要定義一個變數,其值是一個空格,那麼我們可以這樣來:

nullstring :=
space := $(nullstring) # end of the line

nullstring是一個Empty變數,其中什麼也沒有,而我們的space的值是一個空格。因為在操作符的右邊是很難描述一個空格的,這裡採用的技術很管用,先用一個Empty變數來標明變數的值開始了,而後面採用“#”註釋符來表示變數定義的終止,這樣,我們可以定義出其值是一個空格的變數。請注意這裡關於“#”的使用,註釋符“#”的這種特性值得我們注意,如果我們這樣定義一個變數:

dir := /foo/bar    # directory to put the frobs in

dir這個變數的值是“/foo/bar”,後面還跟了4個空格,如果我們這樣使用這樣變數來指定別的目錄——“$(dir)/file”那麼就完蛋了。

還有一個比較有用的操作符是“?=”,先看示例:

FOO ?= bar

其含義是,如果FOO沒有被定義過,那麼變數FOO的值就是“bar”,如果FOO先前被定義過,那麼這條語句將什麼也不做,其等價於:

ifeq ($(origin FOO), undefined)
  FOO = bar
endif

變數高階用法

這裡介紹兩種變數的高階使用方法,第一種是變數值的替換。

我們可以替換變數中的共有的部分,其格式是“$(var:a=b)”或是“${var:a=b}”,其意思是,把變數“var”中所有以“a”字串“結尾”的“a”替換成“b”字串。這裡的“結尾”意思是“空格”或是“結束符”。

還是看一個示例吧:

foo := a.o b.o c.o
bar := $(foo:.o=.c)

這個示例中,我們先定義了一個“$(foo)”變數,而第二行的意思是把“$(foo)”中所有以“.o”字串“結尾”全部替換成“.c”,所以我們的“$(bar)”的值就是“a.c b.c c.c”。

另外一種變數替換的技術是以“靜態模式”(參見前面章節)定義的,如:

foo := a.o b.o c.o
bar := $(foo:%.o=%.c)

這依賴於被替換字串中的有相同的模式,模式中必須包含一個“%”字元,這個例子同樣讓$(bar)變數的值為“a.c b.c c.c”。

第二種高階用法是——“把變數的值再當成變數”。先看一個例子:

x = y
y = z
a := $($(x))

在這個例子中,$(x)的值是“y”,所以$($(x))就是$(y),於是$(a)的值就是“z”。(注意,是“x=y”,而不是“x=$(y)”)

我們還可以使用更多的層次:

x = y
y = z
z = u
a := $($($(x)))

這裡的$(a)的值是“u”,相關的推導留給讀者自己去做吧。

讓我們再複雜一點,使用上“在變數定義中使用變數”的第一個方式,來看一個例子:

x = $(y)
y = z
z = Hello
a := $($(x))

這裡的$($(x))被替換成了$($(y)),因為$(y)值是“z”,所以,最終結果是:a:=$(z),也就是“Hello”。

再複雜一點,我們再加上函式:

x = variable1
variable2 := Hello
y = $(subst 1,2,$(x))
z = y
a := $($($(z)))

這個例子中,“$($($(z)))”擴充套件為“$($(y))”,而其再次被擴充套件為“$($(subst 1,2,$(x)))”。$(x)的值是“variable1”,subst函式把“variable1”中的所有“1”字串替換成“2”字串,於是,“variable1”變成 “variable2”,再取其值,所以,最終,$(a)的值就是$(variable2)的值——“Hello”。(喔,好不容易)

在這種方式中,或要可以使用多個變數來組成一個變數的名字,然後再取其值:

first_second = Hello
a = first
b = second
all = $($a_$b)

這裡的“$a_$b”組成了“first_second”,於是,$(all)的值就是“Hello”。

再來看看結合第一種技術的例子:

a_objects := a.o b.o c.o
1_objects := 1.o 2.o 3.o

sources := $($(a1)_objects:.o=.c)

這個例子中,如果$(a1)的值是“a”的話,那麼,$(sources)的值就是“a.c b.c c.c”;如果$(a1)的值是“1”,那麼$(sources)的值是“1.c 2.c 3.c”。

再來看一個這種技術和“函式”與“條件語句”一同使用的例子:

ifdef do_sort
func := sort
else
func := strip
endif

bar := a d b g q c

foo := $($(func) $(bar))

這個示例中,如果定義了“do_sort”,那麼:foo := $(sort a d b g q c),於是$(foo)的值就是 “a b c d g q”,而如果沒有定義“do_sort”,那麼:foo := $(strip a d b g q c),呼叫的就是strip函式。

當然,“把變數的值再當成變數”這種技術,同樣可以用在操作符的左邊:

dir = foo
$(dir)_sources := $(wildcard $(dir)/*.c)
define $(dir)_print
lpr $($(dir)_sources)
endef

這個例子中定義了三個變數:“dir”,“foo_sources”和“foo_print”。

追加變數值

我們可以使用“+=”操作符給變數追加值,如:

objects = main.o foo.o bar.o utils.o
objects += another.o

於是,我們的$(objects)值變成:“main.o foo.o bar.o utils.o another.o”(another.o被追加進去了)

使用“+=”操作符,可以模擬為下面的這種例子:

objects = main.o foo.o bar.o utils.o
objects := $(objects) another.o

所不同的是,用“+=”更為簡潔。

如果變數之前沒有定義過,那麼,“+=”會自動變成“=”,如果前面有變數定義,那麼“+=”會繼承於前次操作的賦值符。如果前一次的是“:=”,那麼“+=”會以“:=”作為其賦值符,如:

variable := value
variable += more

等價於:

variable := value
variable := $(variable) more

但如果是這種情況:

variable = value
variable += more

由於前次的賦值符是“=”,所以“+=”也會以“=”來做為賦值,那麼豈不會發生變數的遞補歸定義,這是很不好的,所以make會自動為我們解決這個問題,我們不必擔心這個問題。

override 指示符

如果有變數是通過make的命令列引數設定的,那麼Makefile中對這個變數的賦值會被忽略。如果你想在Makefile中設定這類引數的值,那麼,你可以使用“override”指示符。其語法是:

override <variable>; = <value>;

override <variable>; := <value>;

當然,你還可以追加:

override <variable>; += <more text>;

對於多行的變數定義,我們用define指示符,在define指示符前,也同樣可以使用override指示符,如:

override define foo
bar
endef

多行變數

還有一種設定變數值的方法是使用define關鍵字。使用define關鍵字設定變數的值可以有換行,這有利於定義一系列的命令(前面我們講過“命令包”的技術就是利用這個關鍵字)。

define指示符後面跟的是變數的名字,而重起一行定義變數的值,定義是以endef 關鍵字結束。其工作方式和“=”操作符一樣。變數的值可以包含函式、命令、文字,或是其它變數。因為命令需要以[Tab]鍵開頭,所以如果你用define定義的命令變數中沒有以[Tab]鍵開頭,那麼make 就不會把其認為是命令。

下面的這個示例展示了define的用法:

define two-lines
echo foo
echo $(bar)
endef

變數的值在通常的賦值語句中只能在一行中完成,但在define指令中在define指令行以後endef行之前中間所有的行都是變數值的一部分(最後一行除外,因為標示endef那一行不能認為是變數值的一部分)。前面的例子功能上等同於: two-lines = echo foo; echo $(bar) 因為兩命令之間用分號隔開,其行為很接近於兩個分離的shell命令。然而,注意使用兩個分離的行,意味著make請求shell兩次,每一行都在獨立的子shell中執行。參閱執行命令。 如果您希望使用define指令的變數定義比使用命令列定義的變數優先,您可以把define指令和override指令一塊使用: override define two-lines foo $(bar) endef

環境變數

make執行時的系統環境變數可以在make開始執行時被載入到Makefile檔案中,但是如果Makefile中已定義了這個變數,或是這個變數由make命令列帶入,那麼系統的環境變數的值將被覆蓋。(如果make指定了“-e”引數,那麼,系統環境變數將覆蓋Makefile中定義的變數)

因此,如果我們在環境變數中設定了“CFLAGS”環境變數,那麼我們就可以在所有的Makefile中使用這個變量了。這對於我們使用統一的編譯引數有比較大的好處。如果Makefile中定義了CFLAGS,那麼則會使用Makefile中的這個變數,如果沒有定義則使用系統環境變數的值,一個共性和個性的統一,很像“全域性變數”和“區域性變數”的特性。

當make巢狀呼叫時(參見前面的“巢狀呼叫”章節),上層Makefile中定義的變數會以系統環境變數的方式傳遞到下層的Makefile 中。當然,預設情況下,只有通過命令列設定的變數會被傳遞。而定義在檔案中的變數,如果要向下層Makefile傳遞,則需要使用export關鍵字來宣告。(參見前面章節)

當然,我並不推薦把許多的變數都定義在系統環境中,這樣,在我們執行不用的Makefile時,擁有的是同一套系統變數,這可能會帶來更多的麻煩。

目標變數

前面我們所講的在Makefile中定義的變數都是“全域性變數”,在整個檔案,我們都可以訪問這些變數。當然,“自動化變數”除外,如“$<”等這種類量的自動化變數就屬於“規則型變數”,這種變數的值依賴於規則的目標和依賴目標的定義。

當然,我也同樣可以為某個目標設定區域性變數,這種變數被稱為“Target-specific Variable”,它可以和“全域性變數”同名,因為它的作用範圍只在這條規則以及連帶規則中,所以其值也只在作用範圍內有效。而不會影響規則鏈以外的全域性變數的值。

其語法是:

<target ...> : <variable-assignment>;

<target ...> : overide <variable-assignment>

<variable-assignment>;可以是前面講過的各種賦值表示式,如“=”、“:=”、“+=”或是“?=”。第二個語法是針對於make命令列帶入的變數,或是系統環境變數。

這個特性非常的有用,當我們設定了這樣一個變數,這個變數會作用到由這個目標所引發的所有的規則中去。如:

prog : CFLAGS = -g
prog : prog.o foo.o bar.o
        $(CC) $(CFLAGS) prog.o foo.o bar.o

prog.o : prog.c
        $(CC) $(CFLAGS) prog.c

foo.o : foo.c
        $(CC) $(CFLAGS) foo.c

bar.o : bar.c
        $(CC) $(CFLAGS) bar.c

在這個示例中,不管全域性的$(CFLAGS)的值是什麼,在prog目標,以及其所引發的所有規則中(prog.o foo.o bar.o的規則),$(CFLAGS)的值都是“-g”

模式變數

在GNU的make中,還支援模式變數(Pattern-specific Variable),通過上面的目標變數中,我們知道,變數可以定義在某個目標上。模式變數的好處就是,我們可以給定一種“模式”,可以把變數定義在符合這種模式的所有目標上。

我們知道,make的“模式”一般是至少含有一個“%”的,所以,我們可以以如下方式給所有以[.o]結尾的目標定義目標變數:

%.o : CFLAGS = -O

同樣,模式變數的語法和“目標變數”一樣:

<pattern ...>; : <variable-assignment>;

<pattern ...>; : override <variable-assignment>;

override同樣是針對於系統環境傳入的變數,或是make命令列指定的變數。