Makefile (理论)

make file 的编写规则：

 

命令：

makefile的基本命令：

target : prerequisites
  <tab> command

其中target为目标，可以有一个或多个，用“：”分开prerequisites为依赖文件，也可以多个。然后就是换行，在command之前一定要记得得有一个tab空格，否则执行时报错，这个很重要。

可以简单的记为：

======makefile=======

目标：依赖

<tab>命令

===================

以上这个文件应该是makefile的真正核心，其它都是浮云。要写MAKEFILE就按这相格式来堆吧。其中的目标，依赖，命令，都可以使用变量来轻松搞掂。

 

变量： 

makefile 中的变量声明与使用：

变量习惯性的使用大写：如CFLAG

变量的值设置如可以通过：= ，：=，？=，+=

变量的使用：$(变量名) 如：$(CFLAG)

 

“=”     ：等号后面的值可以是变量，也可以是常量。如果是变量，这个变量可以在任意地方定义。

eg：

      VAR_OK = 200   //定义了一个名为“VAR_OK”的变量，同时值为常量200;

      VAR_YES = $(VAR_OK)   //使用变量来进行赋值，同样变量VAR_YES 的值也为200;

    

      对这变量VAR_YES来说，这个VAR_OK写在前面和写在后面效果是一样的。

即：

     VAR_OK = 200  

     VAR_YES = $(VAR_OK) 

等价于

     VAR_YES = $(VAR_OK) 

     VAR_OK = 200  

 

“：=”     ：这个的使用就有限制性了，如果值部分使用的是变量，哪么这个变量就必须在使用前进行定义。

eg：

     VAR_YES := $(VAR_OK) 

     VAR_OK = 200  

     这个写法则VAR_YES的值为空，因为VAR_YES使用了“：=”来赋值，所以变量VAR_OK必须在VAR_YES之前定义。

 

“？=”  ：如果“？=”前面的变量没有定义过，哪么就以“：=”后面的值来进行赋值，如果之前已有这个变量了，哪么这句就不执行。

      eg：

           kk = 300
           kk ?=$(v)
           v = 400

         all:
             echo $(kk)

         保存为Makefile文件执行make all可以看到输出的是300，不执行kk ?=$(v)

 “+=”   ：变量值追加

      eg：   

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

自动变量:

目标(target):依赖(depend)

$^ : 显示当前目标(target)依赖对象列表(depend)(以空格分隔,重复依赖被去重).
$< : 显示当前目标(target)依赖(depend)中的第一个对象.
$@ : 显示当前目标(target)名.
$% : 如果目录不是静态库(.a)文件，则这个值为空，否则为库名
$? : 未弄明白
$+ : 与$^相同，但可以保留重复的依赖对象
$* : 未弄明白

 

例子：

ok : config.h utils.h utils.c utils.h
 echo $^

 

上例子保存为makefile文件执行make ok 只输出了config.h utils.h utils.c即去重了一个

将$^改为其它的执行一下看效果大既就差不多弄明白这几个了。

 

1、wildcard : 扩展通配符
2、notdir ： 去除路径
3、patsubst ：替换通配符

例子：
建立一个测试目录，在测试目录下建立一个名为sub的子目录
$ mkdir test
$ cd test
$ mkdir sub

在test下，建立a.c和b.c2个文件，在sub目录下，建立sa.c和sb.c2 个文件

建立一个简单的Makefile
src=$(wildcard *.c ./sub/*.c)
dir=$(notdir $(src))
obj=$(patsubst %.c,%.o,$(dir) )

all:
 @echo $(src)
 @echo $(dir)
 @echo $(obj)
 @echo "end"
 
执行结果分析：
第一行输出：
a.c b.c ./sub/sa.c ./sub/sb.c

wildcard把 指定目录 ./ 和 ./sub/ 下的所有后缀是c的文件全部展开。

第二行输出：
a.c b.c sa.c sb.c
notdir把展开的文件去除掉路径信息

第三行输出：
a.o b.o sa.o sb.o

在$(patsubst %.c,%.o,$(dir) )中，patsubst把$(dir)中的变量符合后缀是.c的全部替换成.o，
任何输出。
或者可以使用
obj=$(dir:%.c=%.o)
效果也是一样的。

 

 

关于命令的变量。

AR : 函数库打包程序。默认命令是“ar”。
AS : 汇编语言编译程序。默认命令是“as”。
CC : C语言编译程序。默认命令是“cc”。
CXX : C++语言编译程序。默认命令是“g++”。
CO : 从 RCS文件中扩展文件程序。默认命令是“co”。
CPP : C程序的预处理器（输出是标准输出设备）。默认命令是“$(CC) –E”。
FC : Fortran 和 Ratfor 的编译器和预处理程序。默认命令是“f77”。
GET : 从SCCS文件中扩展文件的程序。默认命令是“get”。
LEX : Lex方法分析器程序（针对于C或Ratfor）。默认命令是“lex”。
PC : Pascal语言编译程序。默认命令是“pc”。
YACC: Yacc文法分析器（针对于C程序）。默认命令是“yacc”。
YACCR : Yacc文法分析器（针对于Ratfor程序）。默认命令是“yacc –r”。
MAKEINFO : 转换Texinfo源文件（.texi）到Info文件程序。默认命令是“makeinfo”。
TEX : 从TeX源文件创建TeX DVI文件的程序。默认命令是“tex”。
TEXI2DVI : 从Texinfo源文件创建军TeX DVI 文件的程序。默认命令是“texi2dvi”。
WEAVE : 转换Web到TeX的程序。默认命令是“weave”。
CWEAVE : 转换C Web 到 TeX的程序。默认命令是“cweave”。
TANGLE: 转换Web到Pascal语言的程序。默认命令是“tangle”。
CTANGLE : 转换C Web 到 C。默认命令是“ctangle”。
RM : 删除文件命令。默认命令是“rm –f”。

关于命令参数的变量

下面的这些变量都是相关上面的命令的参数。如果没有指明其默认值，那么其默认值都是空。

ARFLAGS : 函数库打包程序AR命令的参数。默认值是“rv”。
ASFLAGS : 汇编语言编译器参数。（当明显地调用“.s”或“.S”文件时）。
CFLAGS : C语言编译器参数。
CXXFLAGS : C++语言编译器参数。
COFLAGS : RCS命令参数。
CPPFLAGS: C预处理器参数。（ C 和 Fortran 编译器也会用到）。
FFLAGS : Fortran语言编译器参数。
GFLAGS : SCCS “get”程序参数。
LDFLAGS : 链接器参数。（如：“ld”）
LFLAGS : Lex文法分析器参数。
PFLAGS : Pascal语言编译器参数。
RFLAGS : Ratfor 程序的Fortran 编译器参数。
YFLAGS : Yacc文法分析器参数。

 

使用条件判断

使用条件判断，可以让make根据运行时的不同情况选择不同的执行分支。条件表达式可以是比较变量的值，或是比较变量和常量的值。
一、示例
下面的例子，判断$(CC)变量是否“gcc”，如果是的话，则使用GNU函数编译目标。
libs_for_gcc = -lgnu
normal_libs =

foo: $(objects)
ifeq ($(CC),gcc)
$(CC) -o foo $(objects) $(libs_for_gcc)
else
$(CC) -o foo $(objects) $(normal_libs)
endif

可见，在上面示例的这个规则中，目标“foo”可以根据变量“$(CC)”值来选取不同的函数库来编译程序。
我们可以从上面的示例中看到三个关键字：ifeq、else和endif。ifeq的意思表示条件语句的开始，并指定一个条件表达式，表达式包含两个参数，以逗号分隔，表达式以圆括号括起。else表示条件表达式为假的情况。endif表示一个条件语句的结束，任何一个条件表达式都应该以endif结束。
当我们的变量$(CC)值是“gcc”时，目标foo的规则是：
foo: $(objects)
$(CC) -o foo $(objects) $(libs_for_gcc)

而当我们的变量$(CC)值不是“gcc”时（比如“cc”），目标foo的规则是：
foo: $(objects)
$(CC) -o foo $(objects) $(normal_libs)

当然，我们还可以把上面的那个例子写得更简洁一些：
libs_for_gcc = -lgnu
normal_libs =

ifeq ($(CC),gcc)
libs=$(libs_for_gcc)
else
libs=$(normal_libs)
endif

foo: $(objects)
$(CC) -o foo $(objects) $(libs)

语法

条件表达式的语法为：
<conditional-directive>
<text-if-true>
endif

以及：

<conditional-directive>
<text-if-true>
else
<text-if-false>
endif

其中<conditional-directive>表示条件关键字，如“ifeq”。这个关键字有四个。
第一个是我们前面所见过的“ifeq”

ifeq (<arg1>, <arg2> )
ifeq ‘<arg1>’ ‘<arg2>’
ifeq “<arg1>” “<arg2>”
ifeq “<arg1>” ‘<arg2>’
ifeq ‘<arg1>’ “<arg2>”

比较参数“arg1”和“arg2”的值是否相同。当然，参数中我们还可以使用make的函数。如：
ifeq ($(strip $(foo)),)
<text-if-empty>
endif

这个示例中使用了“strip”函数，如果这个函数的返回值是空（Empty），那么<text-if-empty>就生效。
第二个条件关键字是“ifneq”。语法是：
ifneq (<arg1>, <arg2> )
ifneq ‘<arg1>’ ‘<arg2>’
ifneq “<arg1>” “<arg2>”
ifneq “<arg1>” ‘<arg2>’
ifneq ‘<arg1>’ “<arg2>”

其比较参数“arg1”和“arg2”的值是否相同，如果不同，则为真。和“ifeq”类似。
第三个条件关键字是“ifdef”。语法是：
ifdef <variable-name>
如果变量<variable-name>的值非空，那到表达式为真。否则，表达式为假。当然，<variable-name>同样可以是一个函数的返回值。注意，ifdef只是测试一个变量是否有值，其并不会把变量扩展到当前位置。还是来看两个例子：
示例一：
bar =
foo = $(bar)
ifdef foo
frobozz = yes
else
frobozz = no
endif

示例二：
foo =
ifdef foo
frobozz = yes
else
frobozz = no
endif

第一个例子中，“$(frobozz)”值是“yes”，第二个则是“no”。
第四个条件关键字是“ifndef”。其语法是：
ifndef <variable-name>
这个我就不多说了，和“ifdef”是相反的意思。
在<conditional-directive>这一行上，多余的空格是被允许的，但是不能以[Tab]键做为开始（不然就被认为是命令）。而注释符“#”同样也是安全的。“else”和“endif”也一样，只要不是以[Tab]键开始就行了。
特别注意的是，make是在读取Makefile时就计算条件表达式的值，并根据条件表达式的值来选择语句，所以，你最好不要把自动化变量（如“$@”等）放入条件表达式中，因为自动化变量是在运行时才有的。
而且，为了避免混乱，make不允许把整个条件语句分成两部分放在不同的文件中。

 

 

函数：

字符串处理函数

$(subst oldstr,newstr,srcstr)
  名称：字符串替换函数——subst。
  功能：把字串srcstr中的oldstr字符串替换成newstr。
  返回：函数返回被替换过后的字符串。

  eg：      
    $(subst h,H,hello world)，      
    把"hello world"中的"h"替换成H，返回结果是"Hello world"

$(patsubst oldstr,newstr,srcstr)
  名称：模式字符串替换函数——patsubst。
  功能：查找srcstr中的单词(单词以"空格"、"Tab"或"回车"、"换行"分隔)是否符合模式oldstr，
     如果匹配的话,则以newstr替换。这里oldstr可以包括通配符"%",表示任意长度的字串。
     如果newstr中也包含"%",那么newstr中的这个"%"将是oldstr中的那个"%"所代表的字串。
     (可以用"\"来转义,以"\%"来表示真实含义的"%"字符)
  返回：函数返回被替换过后的字符串。

  eg：
  $(patsubst %.c,%.o,test.c hello.c)
  把字串"test.c hello.c"符合模式[%.c]的单词替换成[%.o]，返回结果是"test.o hello.o"

    obj = test.o ok.o hello.o
    如果想将.o转换为.c文件,可以这样用：
    $(obj:.o=.c)
    或$(patsubst %.o,%.c,$(obj))
   

$(strip str)
    名称：去空格函数——strip。
    功能：去掉str字串中开头和结尾的空字符。
    返回：返回被去掉空格的字符串值。
    eg：   
        $(strip  hello  )
        把字串" hello "去到开头和结尾的空格，结果是"hello"。

$(findstring sub,src)
    名称：查找字符串函数——findstring。
    功能：在字串src中查找sub字串。
    返回：如果找到，那么返回sub，否则返回空字符串。
    eg：
        $(findstring llo,hello world)
        $(findstring eo,hello world)

        第一个函数返回"llo"字符串，第二个返回空字符串

$(filter filterst,src)
    名称：过滤函数——filter。
    功能：以filterst模式过滤src字符串中的单词,保留符合模式filterst的单词。
       可以有多个filterst模式(以空格隔开)。
    返回：返回符合模式filterst的字串。
    eg：
        src := test.c hello.c hello.s hello.h
        tg: $(src)
              cc $(filter %.c %.s,$(src)) -o result

        $(filter %.c %.s,$(src))返回的值是"test.c hello.c hello.s"。

$(filter-out sub,src)
    名称：反过滤函数——filter-out。
    功能：以sub模式过滤src字符串中的单词，去除符合模式sub的单词。
       可以有多个模式(以空格隔开)。
    返回：返回不符合模式;的字串。
    eg：

        objects=test.o hello.o add.o plus.o
        deletes=hello.o test.o
       
        $(filter-out $(deletes),$(objects)) 返回值是"add.o plus.o"。
       
$(sort array)
    名称：排序函数——sort。
    功能：给字符串array中的单词排序（升序）。
    返回：返回排序后的字符串。
    eg：
      $(sort tool hello eg)返回"eg hello tool” 。
    注：sort函数会去掉array中相同的单词。

$(word index,src)
    名称：取单词函数——word。
    功能：取字符串src中第index个单词。（从1开始）
    返回：返回字符串src中第index个单词。
       如果index比src中的单词长度要大，那么返回空字符串。
    eg：
      $(word 2, ko you test)返回值是"you"。如果index =4,则返回空。
      
$(wordlist start,end,src )
  名称：取单词串函数——wordlist。
  功能：从字符串src中取从start开始到end的单词串。start和end是一个数字。
  返回：返回字符串src中从start到end的单词字串。
     如果start比src中的单词数要大，那么返回空字符串。
     如果end大于src的单词数，那么返回从start开始，到src结束的单词串。
  eg：
    $(wordlist 2, 3, hello func world)返回值是"func world"。

$(words src )
  名称：单词个数统计函数——words。
  功能：统计src中字符串中的单词个数。
  返回：返回src中的单词数。
  eg：
    $(words, hello test ok)返回值是3。
  如果我们要取src中最后的一个单词,我们可以这样：
    $(word $(words src ),src )。

$(firstword src)
  名称：首单词函数——firstword。
  功能：取字符串src中的第一个单词。
  返回：返回字符串src的第一个单词。
  eg：
    $(firstword hello test ok)返回值是hello。
  
  这个函数可以用word函数来实现：$(word 1,src )。

 

文件名操作函数：

$(dir files )
  名称：取目录函数——dir。
  功能：从文件名序列files中取出目录部分。
     目录部分是指最后一个反斜杠"/"之前的部分。
     如果没有反斜杠，那么返回"./"。
  返回：返回文件名序列files的目录部分。
  eg：
    $(dir src/hello.c test)返回值是"src/ ./"。

$(notdir files)
  名称：取文件函数——notdir。
  功能：从文件名序列files中取出非目录部分。非目录部分是指最后一个反斜杠"/"之后的部分。
  返回：返回文件名序列files的非目录部分。
  eg：
    $(notdir src/hello.c hacks)返回值是"hello.c hacks"。

$(suffix files)
  名称：取后缀函数——suffix。
  功能：从文件名序列files中取出各个文件名的后缀。
  返回：返回文件名序列files的后缀序列，如果文件没有后缀，则返回空字串。
  eg：
    $(suffix src/hello.c src-1.0/ok.c hacks)返回值是".c .c"。

$(basename files)
  名称：取前缀函数——basename。
  功能：从文件名序列files中取出各个文件名的前缀部分。
  返回：返回文件名序列files的前缀序列，如果文件没有前缀，则返回空字串。
  eg：
    $(basename src/test.c src-1.0/hello.c hacks)返回值是"src/test src-1.0/hello hacks”。

$(addsuffix suffix,files)
  名称：加后缀函数——addsuffix。
  功能：把后缀suffix加到files中的每个单词后面。
  返回：返回加过后缀的文件名序列。
  eg：
    $(addsuffix .c,hello test)返回值是"hello.c test.c"。

$(addprefix prefix,files)
  名称：加前缀函数——addprefix。
  功能：把前缀prefix加到files中的每个单词后面。
  返回：返回加过前缀的文件名序列。
  eg：
    $(addprefix src/,hello test)返回值是"src/hello src/test"。

$(join array1,array2)
  名称：连接函数——join。
  功能：把array2中的单词对应地加到array1的单词后面。
     如果array1的单词个数要比array2的多，那么，array1中的多出来的单词将保持原样。
     如果array2的单词个数要比array1多，那么，array2多出来的单词将被复制到array2中。
  返回：返回连接过后的字符串。
  eg：
    $(join aaa bbb , 111 222 333)返回值是"aaa111 bbb222 333"。

foreach 函数(循环)

foreach函数和别的函数非常的不一样。因为这个函数是用来做循环用的，
Makefile中的foreach函数几乎是仿照于Unix标准Shell（/bin/sh）中的for语句，或是C-Shell（/bin/csh）中的foreach语句而构建的。
它的语法是：
  $(foreach <var>,<list>,<text> )

  这个函数的意思是，把参数<list>中的单词逐一取出放到参数<var>所指定的变量中，然后再执行<text>所包含的表达式。
每一次<text>会返回一个字符串，循环过程中，<text>的所返回的每个字符串会以空格分隔，最后当整个循环结束时，
<text>所返回的每个字符串所组成的整个字符串（以空格分隔）将会是foreach函数的返回值。

所以，<var>最好是一个变量名，<list>可以是一个表达式，而<text>中一般会使用<var>这个参数来依次枚举<list>中的单词。
举个例子：
  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中的<var>参数是一个临时的局部变量，foreach函数执行完后，参数<var>的变量将不在作用，
其作用域只在foreach函数当中。

if 函数
if函数很像GNU的make所支持的条件语句——ifeq（参见前面所述的章节），if函数的语法是：
$(if <condition>,<then-part> )
或是
$(if <condition>,<then-part>,<else-part> )
可见，if函数可以包含“else”部分，或是不含。即if函数的参数可以是两个，也可以是三个。<condition>参数是if的表达式，
如果其返回的为非空字符串，那么这个表达式就相当于返回真，于是，<then-part>会被计算，否则<else-part>会被计算。
而if函数的返回值是，如果<condition>为真（非空字符串），那个<then-part>会是整个函数的返回值，
如果<condition>为假（空字符串），那么<else-part>会是整个函数的返回值，此时如果<else-part>没有被定义，那么，
整个函数返回空字串。
所以，<then-part>和<else-part>只会有一个被计算。

 

call函数
call函数是唯一一个可以用来创建新的参数化的函数。你可以写一个非常复杂的表达式，这个表达式中，你可以定义许多参数，然后你可以用call函数来向这个表达式传递参数。其语法是：
$(call <expression>,<parm1>,<parm2>,<parm3>…)
当make执行这个函数时，<expression>参数中的变量，如$(1)，$(2)，$(3)等，会被参数<parm1>，<parm2>，<parm3>依次取代。而<expression>的返回值就是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 <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>是一个命令运行中的自动化变量。关于自动化变量将在后面讲述。
这些信息对于我们编写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函数执行的次数比你想像的多得多。