Makefile Simple Introduce & 自己的 makefile & 分離編譯

  • 部分轉載自:阮一峯的博客
  • 代碼變成可執行文件,叫做編譯(compile);先編譯這個,還是先編譯那個(即編譯的安排),叫做構建(build)

小例子

result.txt: source.txt
    cp source.txt result.txt
source.txt:
    echo "this is the source" > source.txt
    export foo=bar
    echo "foo=[$$foo]"
  • make 會生成source.txt 和 result.txt 兩個文件
  • 需要注意的是,每行命令在一個單獨的shell中執行。這些Shell之間沒有繼承關係。
  • 上面代碼執行後, 取不到foo的值。因爲兩行命令在兩個不同的進程執行
  • 用下面的寫法,加反斜槓
result.txt: source.txt
    cp source.txt result.txt
source.txt:
    echo "this is the source" > source.txt
    export foo=bar; \
    echo "foo=[$$foo]"
  • 兩個目標換一下位置,只會生成一個source.txt
  • 再加上一個 make result.txt 就可以生成 result.txt 文件了

語法

Makefile文件由一系列規則(rules)構成。每條規則的形式如下。

    <target> : <prerequisites>
    [tab]  <commands>
  • 上面第一行冒號前面的部分,叫做”目標”(target),冒號後面的部分叫做”前置條件”(prerequisites);第二行必須由一個tab鍵起首,後面跟着”命令”(commands)。
  • “目標”是必需的,不可省略;”前置條件”和”命令”都是可選的,但是兩者之中必須至少存在一個。
  • 每條規則就明確兩件事:構建目標的前置條件是什麼,以及如何構建。
  • 命令是Shell語句

註釋

  • 井號(#)在Makefile中表示註釋

回聲(echoing)

  • 正常情況下,make會打印每條命令,然後再執行,這就叫做回聲
  • 在命令的前面加上@,就可以關閉回聲
  • 由於在構建過程中,需要了解當前在執行哪條命令,所以通常只在註釋和純顯示的echo命令前面加上@。
test:
    @# 這是測試
    @echo TODO

通配符

  • 通配符(wildcard)用來指定一組符合條件的文件名。Makefile 的通配符與 Bash 一致,主要有星號()、問號(?)和 […] 。比如, .o 表示所有後綴名爲o的文件
clean:
        rm -f *.o

模式匹配

  • Make命令允許對文件名,進行類似正則運算的匹配,主要用到的匹配符是%。比如,假定當前目錄下有 f1.c 和 f2.c 兩個源碼文件,需要將它們編譯爲對應的對象文件
%.o: %.c
  • 等同於下面的寫法。
f1.o: f1.c
f2.o: f2.c

變量和賦值符q

txt = Hello World
test:
    @echo $(txt)
  • 上面代碼中,變量 txt 等於 Hello World。調用時,變量需要放在 $( ) 之中。
  • 調用Shell變量,需要在美元符號前,再加一個美元符號,這是因爲Make命令會對美元符號轉義。
test:
    @echo $$HOME

內置變量(Implicit Variables)

Make命令提供一系列內置變量,比如,$(CC) 指向當前使用的編譯器,$(MAKE) 指向當前使用的Make工具。這主要是爲了跨平臺的兼容性,詳細的內置變量清單見手冊。
output:
    $(CC) -o output input.c

自動變量(Automatic Variables)

  • Make命令還提供一些自動變量,它們的值與當前規則有關。主要有以下幾個。
$@
$@指代當前目標,就是Make命令當前構建的那個目標。比如,make foo的 $@ 就指代foo。
a.txt b.txt:
    touch $@
等同於下面的寫法。
a.txt:
    touch a.txt
b.txt:
    touch b.txt
$<
$< 指代第一個前置條件。比如,規則爲 t: p1 p2,那麼$< 就指代p1。
a.txt: b.txt c.txt
    cp $< $@
等同於下面的寫法。
a.txt: b.txt c.txt
    cp b.txt a.txt
$?
$? 指代比目標更新的所有前置條件,之間以空格分隔。比如,規則爲 t: p1 p2,其中 p2 的時間戳比 t 新,$?就指代p2。
$^
$^ 指代所有前置條件,之間以空格分隔。比如,規則爲 t: p1 p2,那麼 $^ 就指代 p1 p2 。
$*
$* 指代匹配符 % 匹配的部分, 比如% 匹配 f1.txt 中的f1 ,$* 就表示 f1。
(@D) (@F)
$(@D) 和 $(@F) 分別指向 $@ 的目錄名和文件名。比如,$@是 src/input.c,那麼$(@D) 的值爲 src ,$(@F) 的值爲 input.c。
(<D) (
$(<D) 和 $(<F) 分別指向 $< 的目錄名和文件名。
所有的自動變量清單,請看手冊。下面是自動變量的一個例子。
dest/%.txt: src/%.txt
    @[ -d dest ] || mkdir dest
    cp $< $@
上面代碼將 src 目錄下的 txt 文件,拷貝到 dest 目錄下。首先判斷 dest 目錄是否存在,如果不存在就新建,然後,$< 指代前置文件(src/%.txt), $@ 指代目標文件(dest/%.txt)。

判斷和循環

  • Makefile使用 Bash 語法,完成判斷和循環。
ifeq ($(CC),gcc)
  libs=$(libs_for_gcc)
else
  libs=$(normal_libs)
endif
  • 上面代碼判斷當前編譯器是否 gcc ,然後指定不同的庫文件。
LIST = one two three
all:
    for i in $(LIST); do \
        echo $$i; \
    done
# 等同於
all:
    for i in one two three; do \
        echo $i; \
    done
  • 上面代碼的運行結果。
  • one
  • two
  • three

函數

  • Makefile 還可以使用函數,格式如下。
$(function arguments)
# 或者
${function arguments}
  • Makefile提供了許多內置函數,可供調用。下面是幾個常用的內置函數。
shell 函數
  • shell 函數用來執行 shell 命令
srcfiles := $(shell echo src/{00..99}.txt)
wildcard 函數
  • wildcard 函數用來在 Makefile 中,替換 Bash 的通配符。
srcfiles := $(wildcard src/*.txt)
subst 函數
  • subst 函數用來文本替換,格式如下。
$(subst from,to,text)
  • 下面的例子將字符串”feet on the street”替換成”fEEt on the strEEt”。
$(subst ee,EE,feet on the street)
  • 下面是一個稍微複雜的例子。
comma:= ,
empty:=
# space變量用兩個空變量作爲標識符,當中是一個空格
space:= $(empty) $(empty)
foo:= a b c
bar:= $(subst $(space),$(comma),$(foo))
# bar is now `a,b,c'.
patsubst函數
  • patsubst 函數用於模式匹配的替換,格式如下。
$(patsubst pattern,replacement,text)
  • 下面的例子將文件名”x.c.c bar.c”,替換成”x.c.o bar.o”。
$(patsubst %.c,%.o,x.c.c bar.c)
替換後綴名
  • 替換後綴名函數的寫法是:變量名 + 冒號 + 後綴名替換規則。它實際上patsubst函數的一種簡寫形式。
min: $(OUTPUT:.js=.min.js)
  • 上面代碼的意思是,將變量OUTPUT中的後綴名 .js 全部替換成 .min.js 。

分割線

實例

執行多個目標

.PHONY: cleanall cleanobj cleandiff     # 如果當前目錄中,正好有一個文件叫做clean***,那麼這個命令不會執行.所以設置僞目標
cleanall : cleanobj cleandiff
        rm program
cleanobj :
        rm *.o
cleandiff :
        rm *.diff

上面代碼可以調用不同目標,刪除不同後綴名的文件,也可以調用一個目標(cleanall),刪除所有指定類型的文件。

編譯C語言項目

edit : main.o kbd.o command.o display.o
    cc -o edit main.o kbd.o command.o display.o
main.o : main.c defs.h
    cc -c main.c
kbd.o : kbd.c defs.h command.h
    cc -c kbd.c
command.o : command.c defs.h command.h
    cc -c command.c
display.o : display.c defs.h
    cc -c display.c
clean :
     rm edit main.o kbd.o command.o display.o
.PHONY: edit clean

自己項目的小例子

  • 編譯的結果放到build目錄下面,單元測試的編譯結果放到UnitTest下吧
  • 我的目錄結構是:
build/ test/ src/uniTest.cpp memDB.cpp memDB.h makefile/makefile
  • uniTest.cpp 是單元測試文件, middleware.cpp 是數據庫的中間件,沒有main函數,實現分離編譯
.PHONY: build clean
build: ../test/memDBTest.o ../build/memDB.o ../build/DataBase.o
    g++ --std=c++11 -O2 -o ../test/memDBTest  ../test/memDBTest.o ../build/memDB.o # 單元測試的結果
    @../test/memDBTest

../test/memDBTest.o:
    g++ --std=c++11 -O2 -c -o ../test/memDBTest.o ../src/memDBTest/memDBTest.cpp
../build/memDB.o:
    g++ --std=c++11 -O2 -c -o ../build/memDB.o ../src/memDB/memDB.cpp
../build/DataBase.o:
    g++ --std=c++11 -O2 -c -o ../build/DataBase.o ../src/memDB/DataBase.cpp

clean:
    rm ../test/memDBTest.o ../test/memDBTest ../build/memDB.o
發佈了153 篇原創文章 · 獲贊 72 · 訪問量 56萬+
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章