Makefile学习

Makefile中的字符串处理函数

$(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搜索头文件路径的参数。

 

文件名操作函数
$(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”。

 

Makefile---条件处理函数

一 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 = $(call reverse,a,b)
此时的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
    endif

当然，你也许会说，使用override关键字不就能重新定义环境中的变量了吗？为什么
需要使用这样的步骤？是的，我们用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 ;)

    产生一个致命的错误，;是错误信息。注意，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 ;)

     这个函数非常像error函数，只是他并不会让make退出，只是输出一段警告信息，而
make继续执行。
make的运行：
一般来说，最简单的就是直接在命令行下输入make命令，make命令会找当前目录的
makefile来执行，一切都是自动的。但也有时你也许只想让make重编译某些文件，而不
是整个工程，而又有的时候你有几套编译规则，你想在不同的时候使用不同的编译规
则，等等。本章节就是讲述怎么使用 make命令的。
一、make的退出码
make命令执行后有三个退出码：
    0 ?? 表示成功执行。
    1 ?? 如果make运行时出现所有错误，其返回1。
    2 ?? 如果你使用了make的“-q”选项，并且make使得一些目标不必更新，那么返回2。
Make的相关参数我们会在后续章节中讲述。
二、指定Makefile
前面我们说过，GNU make找寻默认的Makefile的规则是在当前目录下依次找三个文件??
“GNUmakefile”、“makefile”和“Makefile”。其按顺序找这三个文件，一旦找到，就开始
读取这个文件并执行。
当前，我们也能给make命令指定一个特别名字的Makefile。要达到这个功能，我们要
使用make的“-f”或是“--file”参数（“--makefile”参数也行）。例如，我们有个
makefile的名字是“hchen.mk”，那么，我们能这样来让make来执行这个文件：
    make ?f hchen.mk
如果在make的命令行是，你不只一次地使用了“-f”参数，那么，所有指定的makefile将
会被连在一起传递给make执行。
三、指定目标
一般来说，make的最终目标是makefile中的第一个目标，而其他目标一般是由这个目标
连带出来的。这是make的默认行为。当然，一般来说，你的makefile中的第一个目标是
由许多个目标组成，你能指示make，让其完成你所指定的目标。要达到这一目的非常简
单，需在make命令后直接跟目标的名字就能完成（如前面提到的“make clean”形式）
所有在makefile中的目标都能被指定成终极目标，不过除了以“-”打头，或是包含了
“=”的目标，因为有这些字符的目标，会被解析成命令行参数或是变量。甚至没有被我们
明确写出来的目标也能成为make的终极目标，也就是说，只要make能找到其隐含规
则推导规则，那么这个隐含目标同样能被指定成终极目标。
有一个make的环境变量叫“MAKECMDGOALS”，这个变量中会存放你所指定的终极目标的列
表，如果在命令行上，你没有指定目标，那么，这个变量是空值。这个变量能让你使
用在一些比较特别的情形下。比如下面的例子：
    sources = foo.c bar.c
    ifneq ( $(MAKECMDGOALS),clean)
    include $(sources:.c=.d)
    endif
基于上面的这个例子，只要我们输入的命令不是“make clean”，那么makefile会自动包
含“foo.d”和“bar.d”这两个makefile。
使用指定终极目标的方法能非常方便地让我们编译我们的程式，例如下面这个例子：
    .PHONY: all
    all: prog1 prog2 prog3 prog4
从这个例子中，我们能看到，这个makefile中有四个需要编译的程式??“prog1”，
“prog2”， “prog3”和  “prog4”，我们能使用“make all”命令来编译所有的目标（如
果把all置成第一个目标，那么只需执行“make”），我们也能使用 “make prog2”来单
独编译目标“prog2”。
即然make能指定所有makefile中的目标，那么也包括“伪目标”，于是我们能根据这
种性质来让我们的makefile根据指定的不同的目标来完成不同的事。在Unix世界中，软
件发布时，特别是GNU这种开源软件的发布时，其makefile都包含了编译、安装、打包等
功能。我们能参照这种规则来书写我们的makefile中的目标。
     “all”
        这个伪目标是所有目标的目标，其功能一般是编译所有的目标。
     “clean”
        这个伪目标功能是删除所有被make创建的文件。
     “install”
        这个伪目标功能是安装已编译好的程式，其实就是把目标执行文件拷贝到指定
的目标中去。
     “print”
        这个伪目标的功能是例出改动过的源文件。
     “tar”
        这个伪目标功能是把源程式打包备份。也就是个tar文件。
     “dist”
        这个伪目标功能是创建一个压缩文件，一般是把tar文件压成Z文件。或是gz文件。
     “TAGS”
        这个伪目标功能是更新所有的目标，以备完整地重编译使用。
     “check”和“test”
        这两个伪目标一般用来测试makefile的流程。
当然一个项目的makefile中也不一定要书写这样的目标，这些东西都是GNU的东西，不过
我想，GNU搞出这些东西一定有其可取之处（等你的 UNIX下的程式文件一多时你就会发
现这些功能非常有用了），这里只不过是说明了，如果你要书写这种功能，最佳使用这种
名字命名你的目标，这样规范一些，规范的好处就是??不用解释，大家都明白。而且如
果你的makefile中有这些功能，一是非常实用，二是能显得你的makefile非常专业（不是
那种初学者的作品）。
四、检查规则
有时候，我们不想让我们的makefile中的规则执行起来，我们只想检查一下我们的命
令，或是执行的序列。于是我们能使用make命令的下述参数：
    “-n”
    “--just-print”
    “--dry-run”
    “--recon”
    不执行参数，这些参数只是打印命令，不管目标是否更新，把规则和连带规则下的
命令打印出来，但不执行，这些参数对于我们调试makefile非常有用处。
    “-t”
    “--touch”
    这个参数的意思就是把目标文件的时间更新，但不更改目标文件。也就是说，make
假装编译目标，但不是真正的编译目标，只是把目标变成已编译过的状态。
    “-q”
    “--question”
    这个参数的行为是找目标的意思，也就是说，如果目标存在，那么其什么也不会输
出，当然也不会执行编译，如果目标不存在，其会打印出一条出错信息。
    “-W ;”
    “--what-if=;”
    “--assume-new=;”
    “--new-file=;”
    这个参数需要指定一个文件。一般是是源文件（或依赖文件），Make会根据规则推
导来运行依赖于这个文件的命令，一般来说，能和“-n”参数一同使用，来查看这个依
赖文件所发生的规则命令。
另外一个非常有意思的用法是结合“-p”和“-v”来输出makefile被执行时的信息（这个将在
后面讲述）。