Makefile学习
参考自《跟我一起写Makefile》陈皓
Makefile 的语法规则
基本语法
target ... : prerequisites ...
command
...
...
翻译成中文大概就是:
一系列目标文件:一系列依赖文件
执行的一些命令
target 也就是一个目标文件,可以是 Object File ,也可以是执行文件。还可以是一个标签。
prerequisites 就是要生成那个 target 所需要的文件或是目标。
command 也就是 make 需要执行的任意的 shell 命令。
默认情况下, make 命令会在当前目录下按顺序找寻文件名为"GNUmakefile" "makefile" "Makefile"的文件,并解释这个文件。一般使用"Makefile"这个文件名。
如果要指定特定的 Makefile,你可以使用 make 的"-f"和"--file"参数,如:make -f Make.Linux 或 make --file Make.AIX。
更新函数库文件
liba(a.o ...):a.o ...
ar cr liba a.o ...
条件表达式
条件表达式的语法为:
<conditional-directive>
<text-if-true>
endif
以及:
<conditional-directive>
<text-if-true>
else <conditional-directive>
<text-if-true>
else
<text-if-false>
endif
其中<conditional-directive>表示条件关键字,这个关键字有四种:
- ifeq
ifeq (<arg1>, <arg2>)
ifeq '<arg1>' '<arg2>'
ifeq "<arg1>" "<arg2>"
ifeq "<arg1>" '<arg2>'
ifeq '<arg1>' "<arg2>"
比较参数"arg1"和"arg2"的值是否相同。
- ifneq
ifneq (<arg1>, <arg2>)
ifneq '<arg1>' '<arg2>'
ifneq "<arg1>" "<arg2>"
ifneq "<arg1>" '<arg2>'
ifneq '<arg1>' "<arg2>"
比较参数"arg1"和"arg2"的值是否相同,如果不同,则为真。
- ifdef
ifdef <variable-name>
如果变量<variable-name>的值非空,那到表达式为真。否则,表达式为假。当然,<variable-name>同样可以是一个函数的返回值。注意,ifdef 只是测试一个变量是否有值,其并不会把变量扩展到当前位置。
- ifndef
ifndef <variable-name>
和 ifdef 是意思相反。
伪目标
"伪目标"并不是一个文件,只是一个标签,由于"伪目标"不是文件,所以 make 无法生成它的依赖关系和决定它是否要执行。我们只有通过显示地指明这个"目标"才能让其生效。当然,"伪目标"的取名不能和文件名重名,不然其就失去了"伪目标"的意义了。
当然,为了避免和文件重名的这种情况,我们可以使用一个特殊的标记".PHONY"来显示地指明一个目标是"伪目标",向 make 说明,不管是否有这个文件,这个目标就是"伪目标"。
.PHONY : clean
多目标
bigoutput littleoutput : text.g
generate text.g -$(subst output,,$@) > $@
上述规则等价于:
bigoutput : text.g
generate text.g -big > bigoutput
littleoutput : text.ggenerate text.g -little > littleoutput
静态模式
<targets ...>: <target-pattern>: <prereq-patterns ...>
<commands>
...
targets 定义了一系列的目标文件,可以有通配符。是目标的一个集合。
target-parrtern 是指明了 targets 的模式,也就是的目标集模式。
prereq-parrterns 是目标的依赖模式,它对 target-parrtern 形成的模式再进行一次依赖目标的定义。
注释
Makefile 中使用'#'字符作为注释符,在'#'之后的是注释部分,当你真正想用到'#'字符时,可以用反斜杠进行转义,如'\#'。
Makefile 使用变量
普通变量
a = main.o # 定义变量a的值为main.o
var = aa
$a # 调用变量
$(a) # 调用变量
${a}
$(var) # 调用变量
${var}
多行变量
define two-lines
echo foo
echo $(bar)
endef
自动化变量
$@ 表示规则中的目标文件集。在模式规则中,如果有多个目标,那么,"$@"就是匹配于目标中模式定义的集合。
$% 仅当目标是函数库文件中,表示规则中的目标成员名。例如,如果一个目标是"foo.a(bar.o)",那么,"$%"就是"bar.o","$@"就是"foo.a"。如果目标不是函数库文件(Unix 下是[.a],Windows 下是[.lib]),那么,其值为空。
$< 依赖目标中的第一个目标名字。如果依赖目标是以模式(即"%")定义的,那么"$<"将是符合模式的一系列的文件集。注意,其是一个一个取出来的。
$? 所有比目标新的依赖目标的集合。以空格分隔。
$^ 所有的依赖目标的集合。以空格分隔。如果在依赖目标中有多个重复的,那个这个变量会去除重复的依赖目标,只保留一份。
$+ 这个变量很像"$^",也是所有依赖目标的集合。只是它不去除重复的依赖目标。
$* 这个变量表示目标模式中"%"及其之前的部分。如果目标是"dir/a.foo.b",并且目标的模式是"a.%.b",那么,"$*"的值就是"dir/a.foo"。这个变量对于构造有关联的文件名是比较有较。如果目标中没有模式的定义,那么"$*"也就不能被推导出,但是,如果目标文件的后缀是 make 所识别的,那么"$*"就是除了后缀的那一部分。例如:如果目标是"foo.c",因为".c"是 make 所能识别的后缀名,所以,"$*"的值就是"foo"。这个特性是 GNU make 的,很有可能不兼容于其它版本的 make,所以,你应该尽量避免使用"$*",除非是在隐含规则或是静态模式中。如果目标中的后缀是 make 所不能识别的,那么"$*"就是空值。
$(@D) 表示"$@"的目录部分(不以斜杠作为结尾),如果"$@"值是"dir/foo.o",那么"$(@D)"就是"dir",而如果"$@"中没有包含斜杠的话,其值就是"."(当前目录)。
$(@F) 表示"$@"的文件部分,如果"$@"值是"dir/foo.o",那么"$(@F)"就是"foo.o"。
$(F)、$(D)、$(%D)、$(%F)、$(<D)、$(<F)、$(D)**、**$(F)、$(+D)、$(+F)、$(?D)、$(?F)** 同理分别表示对应文件的目录部分和文件部分。
变量赋值
= 是最基本的赋值
:= 是覆盖之前的值
?= 是如果没有被赋值过就赋予等号后面的值
+= 是追加等号后面的值
Makefile 使用函数
函数调用语法
$(<function> <arguments>)
${<function> <arguments>}
字符串处理函数
- 字符串替换函数——subst
$(subst <from>, <to>, <text>)
功能:把字符串<text>中的<from>字符串替换成<to>。
返回:函数返回被替换过后的字符串。
- 模式字符串替换函数——patsubst
$(patsubst <pattern>, <replacement>, <text>)
功能:查找<text>中的单词(单词以"空格"、"Tab"、"回车"或"换行"分隔)是否符合模式<pattern>,如果匹配的话,则以<replacement>替换。这里,<pattern>可以包括通配符"%",表示任意长度的字符串。如果<replacement>中也包含"%",那么,<replacement>中的这个"%"将是<pattern>中的那个"%"所代表的字符串。(可以用""来转义,以"%"来表示真实含义的"%"字符)
返回:函数返回被替换过后的字符串。
- 去空格函数——strip
$(strip <string>)
功能:去掉<string>字符串中开头和结尾的空字符。
返回:返回被去掉空格的字符串值。
- 查找字符串函数——findstring
$(findstring <find>, <in>)
功能:在字符串<in>中查找<find>字符串。
返回:如果找到,那么返回<find>,否则返回空字符串。
- 过滤函数——filter
$(filter <pattern...>, <text>)
功能:以<pattern>模式过滤<text>字符串中的单词,保留符合模式<pattern>的单词。可以有多个模式。
返回:返回符合模式<pattern>的字符串。
- 反过滤函数——filter-out
$(filter-out <pattern...>, <text>)
功能:以<pattern>模式过滤<text>字符串中的单词,去除符合模式<pattern>的单词。可以有多个模式。
返回:返回不符合模式<pattern>的字符串。
- 排序函数——sort
$(sort <list>)
功能:给字符串<list>中的单词排序(升序)。
返回:返回排序后的字符串。
- 取单词函数——word
$(word <n>, <text>)
功能:取字符串<text>中第<n>个单词。(从一开始)
返回:返回字符串<text>中第<n>个单词。如果<n>比<text>中的单词数要大,那么返回空字符串。
- 取单词串函数——wordlist
$(wordlist <s>, <e>, <text>)
功能:从字符串<text>中取从<s>开始到<e>的单词串。<s>和<e>是一个数字。
返回:返回字符串<text>中从<s>到<e>的单词字符串。如果<s>比<text>中的单词数要大,那么返回空字符串。如果<e>大于<text>的单词数,那么返回从<s>开始,到<text>结束的单词串。
- 单词个数统计函数——words
$(words <text>)
功能:统计<text>中字符串中的单词个数。
返回:返回<text>中的单词数。
- 首单词函数——firstword
$(firstword <text>)
功能:取字符串<text>中的第一个单词。
返回:返回字符串<text>的第一个单词。
文件名操作函数
- 取目录函数——dir
$(dir <names...>)
功能:从文件名序列<names>中取出目录部分。目录部分是指最后一个反斜杠("/")之前的部分。如果没有反斜杠,那么返回"./"。
返回:返回文件名序列<names>的目录部分。
- 取文件函数——notdir
$(notdir <names...>)
功能:从文件名序列<names>中取出非目录部分。非目录部分是指最后一个反斜杠("/")之后的部分。
返回:返回文件名序列<names>的非目录部分。
- 取后缀函数——suffix
$(suffix <names...>)
功能:从文件名序列<names>中取出各个文件名的后缀。
返回:返回文件名序列<names>的后缀序列,如果文件没有后缀,则返回空字符串。
- 取前缀函数——basename
$(basename <names...>)
功能:从文件名序列<names>中取出各个文件名的前缀部分。
返回:返回文件名序列<names>的前缀序列,如果文件没有前缀,则返回空字符串。
- 加后缀函数——addsuffix
$(addsuffix <suffix>, <names...>)
功能:把后缀<suffix>加到<names>中的每个单词后面。
返回:返回加过后缀的文件名序列。
- 加前缀函数——addprefix
$(addprefix <prefix>, <names...>)
功能:把前缀<prefix>加到<names>中的每个单词前面。
返回:返回加过前缀的文件名序列。
- 连接函数——join
$(join <list1>, <list2>)
功能:把<list2>中的单词对应地加到<list1>的单词后面。如果<list1>的单词个数要比<list2>的多,那么,<list1>中的多出来的单词将保持原样。如果<list2>的单词个数要比<list1>多,那么,<list2>多出来的单词将被复制到<list2>中。
返回:返回连接过后的字符串。
foreach函数
$(foreach <var>, <list>, <text>)
功能:把参数<list>中的单词逐一取出放到参数<var>所指定的变量中,然后再执行<text>所包含的表达式。每一次<text>会返回一个字符串,循环过程中, <text>的所返回的每个字符串会以空格分隔,最后当整个循环结束时,<text>所返回的每个字符串所组成的整个字符串(以空格分隔)将会是 foreach 函数的返回值。
返回:<text>所返回的每个字符串所组成的整个字符串(以空格分隔)。
if函数
$(if <condition>, <then-part>)
$(if <condition>, <then-part>, <else-part>)
功能:<condition>参数是 if 的表达式,如果其返回的为非空字符串,那么这个表达式就相当于返回真,于是,<then-part>会被计算,否则<else-part>会被计算。
返回:如果<condition>为真(非空字符串),那个<then-part>会是整个函数的返回值,如果<condition>为假(空字符串),那么<else-part>会是整个函数的返回值,此时如果<else-part>没有被定义,那么,整个函数返回空字符串。
所以,<then-part>和<else-part>只会有一个被计算。
call函数
$(call <expression>, <parm1>, <parm2>, <parm3> ...)
功能:当 make 执行这个函数时,<expression>参数中的变量,如$(1),$(2),$(3)等,会被参数<parm1>,<parm2>,<parm3>依次取代。
返回:<expression>的返回值就是 call 函数的返回值。
origin函数
$(origin <variable>)
注意,<variable>是变量的名字,不应该是引用。所以你最好不要在<variable>中使用"$"字符。Origin 函数会以其返回值来告诉你这个变量的"出生情况",下面,是 origin函数的返回值:
"undefined"
如果<variable>从来没有定义过,origin 函数返回这个值"undefined"。"default"
如果<variable>是一个默认的定义,比如"CC"这个变量。"environment"
如果<variable>是一个环境变量,并且当 Makefile 被执行时,"-e"参数没有被打开。"file"
如果<variable>这个变量被定义在 Makefile 中。"command line"
如果<variable>这个变量是被命令行定义的。"override"
如果<variable>是被 override 指示符重新定义的。"automatic"
如果<variable>是一个命令运行中的自动化变量。
shell函数
$(shell <shell script>)
功能:shell 函数也不像其它的函数。顾名思义,它的参数应该就是操作系统 Shell 的命令。它和反引号"`"是相同的功能。
返回:shell 函数把执行操作系统命令后的输出作为函数返回。
注意,这个函数会新生成一个 Shell 程序来执行命令,所以你要注意其运行性能,如果你的 Makefile 中有一些比较复杂的规则,并大量使用了这个函数,那么对于你的系统性能是有害的。特别是 Makefile 的隐晦的规则可能会让你的 shell 函数执行的次数比你想像的多得多。
控制make的函数
- error函数
$(error <text ...>)
产生一个致命的错误,make 退出,<text ...>是错误信息。注意,error 函数不会在一被使用就会产生错误信息,所以如果你把其定义在某个变量中,并在后续的脚本中使用这个变量,那么也是可以的。
- warning函数
$(warning <text ...>)
这个函数很像 error 函数,只是它并不会让 make 退出,只是输出一段警告信息,而 make 继续执行。
Makefile 自动推导
只要 make 看到一个[.o]文件,它就会自动的把[.c]文件加在依赖关系中,并且
$(CC) -c [.c]
也会被推导出来
- 我的个人主页:http://www.techping.cn/
- 我的个人站点博客:http://www.techping.cn/blog/wordpress/
- 我的CSDN博客:http://blog.csdn.net/techping
- 我的简书:http://www.jianshu.com/users/b2a36e431d5e/timeline
- 我的GitHub:https://github.com/techping
欢迎相互follow~