II C语言本质22Makefile基础1 基本规则Word文档格式.docx
《II C语言本质22Makefile基础1 基本规则Word文档格式.docx》由会员分享,可在线阅读,更多相关《II C语言本质22Makefile基础1 基本规则Word文档格式.docx(12页珍藏版)》请在冰豆网上搜索。
push(visit_point);
}
intmain(void)
structpointp={0,0};
maze[p.row][p.col]=2;
push(p);
while(!
is_empty()){
p=pop();
if(p.row==MAX_ROW-1/*goal*/
&
&
p.col==MAX_COL-1)
break;
if(p.col+1<
MAX_COL/*right*/
maze[p.row][p.col+1]==0)
visit(p.row,p.col+1,p);
if(p.row+1<
MAX_ROW/*down*/
maze[p.row+1][p.col]==0)
visit(p.row+1,p.col,p);
if(p.col-1>
=0/*left*/
maze[p.row][p.col-1]==0)
visit(p.row,p.col-1,p);
if(p.row-1>
=0/*up*/
maze[p.row-1][p.col]==0)
visit(p.row-1,p.col,p);
print_maze();
}
if(p.row==MAX_ROW-1&
p.col==MAX_COL-1){
printf("
(%d,%d)\n"
p.row,p.col);
while(predecessor[p.row][p.col].row!
=-1){
p=predecessor[p.row][p.col];
printf("
}
}else
Nopath!
\n"
);
return0;
我们把堆栈和迷宫的代码分别转移到模块stack.c和maze.c中,main.c包含它们提供的头文件stack.h和maze.h。
/*main.h*/
#ifndefMAIN_H
#defineMAIN_H
typedefstructpoint{introw,col;
}item_t;
#defineMAX_ROW5
#defineMAX_COL5
#endif
在main.h中定义了一个类型和两个常量,main.c、stack.c和maze.c都要用到这些定义,都要包含这个头文件。
/*stack.c*/
staticitem_tstack[512];
staticinttop=0;
voidpush(item_tp)
stack[top++]=p;
item_tpop(void)
returnstack[--top];
intis_empty(void)
returntop==0;
/*stack.h*/
#ifndefSTACK_H
#defineSTACK_H
/*providesdefinitionforitem_t*/
externvoidpush(item_t);
externitem_tpop(void);
externintis_empty(void);
例
12.3“用深度优先搜索解迷宫问题”中的堆栈规定死了只能放char型数据,现在我们做进一步抽象,堆栈中放item_t类型的数据,item_t可以定义为任意类型,只要它能够通过函数的参数和返回值传递并且支持赋值操作就行。
这也是一种避免硬编码的策略,stack.c中多次使用item_t类型,要改变它的定义只需改变main.h中的一行代码。
/*maze.c*/
intmaze[MAX_ROW][MAX_COL]={
0,1,0,0,0,
0,1,0,1,0,
0,0,0,0,0,
0,1,1,1,0,
0,0,0,1,0,
voidprint_maze(void)
inti,j;
for(i=0;
i<
MAX_ROW;
i++){
for(j=0;
j<
MAX_COL;
j++)
%d"
maze[i][j]);
putchar('
\n'
printf("
*********\n"
/*maze.h*/
#ifndefMAZE_H
#defineMAZE_H
/*providesdefintionforMAX_ROWandMAX_COL*/
externintmaze[MAX_ROW][MAX_COL];
voidprint_maze(void);
maze.c中定义了一个maze数组和一个print_maze函数,需要在头文件maze.h中声明,以便提供给main.c使用,注意print_maze的声明可以不加extern,而maze的声明必须加extern。
这些源文件可以这样编译:
$gccmain.cstack.cmaze.c-omain
但这不是个好办法,如果编译之后又对maze.c做了修改,又要把所有源文件编译一遍,即使main.c、stack.c和那些头文件都没有修改也要跟着重新编译。
一个大型的软件项目往往由上千个源文件组成,全部编译一遍需要几个小时,只改一个源文件就要求全部重新编译肯定是不合理的。
这样编译也许更好一些:
$gcc-cmain.c
$gcc-cstack.c
$gcc-cmaze.c
$gccmain.ostack.omaze.o-omain
如果编译之后又对maze.c做了修改,要重新编译只需要做两步:
这样又有一个问题,每次编译敲的命令都不一样,很容易出错,比如我修改了三个源文件,可能有一个忘了重新编译,结果编译完了修改没生效,运行时出了Bug还满世界找原因呢。
更复杂的问题是,假如我改了main.h怎么办?
所有包含main.h的源文件都需要重新编译,我得挨个找哪些源文件包含了main.h,有的还很不明显,例如stack.c包含了stack.h,而后者包含了main.h。
可见手动处理这些问题非常容易出错,那有没有自动的解决办法呢?
有,就是写一个Makefile文件和源代码放在同一个目录下:
main:
main.ostack.omaze.o
gccmain.ostack.omaze.o-omain
main.o:
main.cmain.hstack.hmaze.h
gcc-cmain.c
stack.o:
stack.cstack.hmain.h
gcc-cstack.c
maze.o:
maze.cmaze.hmain.h
gcc-cmaze.c
然后在这个目录下运行make编译:
$make
gcc-cmain.c
gcc-cstack.c
gcc-cmaze.c
gccmain.ostack.omaze.o-omain
make命令会自动读取当前目录下的Makefile文件[33],完成相应的编译步骤。
Makefile由一组规则(Rule)组成,每条规则的格式是:
target...:
prerequisites...
command1
command2
...
例如:
main是这条规则的目标(Target),main.o、stack.o和maze.o是这条规则的条件(Prerequisite)。
目标和条件之间的关系是:
欲更新目标,必须首先更新它的所有条件;
所有条件中只要有一个条件被更新了,目标也必须随之被更新。
所谓“更新”就是执行一遍规则中的命令列表,命令列表中的每条命令必须以一个Tab开头,注意不能是空格,Makefile的格式不像C语言的缩进那么随意,对于Makefile中的每个以Tab开头的命令,make会创建一个Shell进程去执行它。
对于上面这个例子,make执行如下步骤:
1.尝试更新Makefile中第一条规则的目标main,第一条规则的目标称为缺省目标,只要缺省目标更新了就算完成任务了,其它工作都是为这个目的而做的。
由于我们是第一次编译,main文件还没生成,显然需要更新,但规则说必须先更新了main.o、stack.o和maze.o这三个条件,然后才能更新main。
2.所以make会进一步查找以这三个条件为目标的规则,这些目标文件也没有生成,也需要更新,所以执行相应的命令(gcc-cmain.c、gcc-cstack.c和gcc-cmaze.c)更新它们。
3.最后执行gccmain.ostack.omaze.o-omain更新main。
如果没有做任何改动,再次运行make:
make:
`main'
isuptodate.
make会提示缺省目标已经是最新的了,不需要执行任何命令更新它。
再做个实验,如果修改了maze.h(比如加个无关痛痒的空格)再运行make:
make会自动选择那些受影响的源文件重新编译,不受影响的源文件则不重新编译,这是怎么做到的呢?
1.make仍然尝试更新缺省目标,首先检查目标main是否需要更新,这就要检查三个条件main.o、stack.o和maze.o是否需要更新。
2.make会进一步查找以这三个条件为目标的规则,然后发现main.o和maze.o需要更新,因为它们都有一个条件是maze.h,而这个文件的修改时间比main.o和maze.o晚,所以执行相应的命令更新main.o和maze.o。
3.既然main的三个条件中有两个被更新过了,那么main也需要更新,所以执行命令gccmain.ostack.omaze.o-omain更新main。
现在总结一下Makefile的规则,请读者结合上面的例子理解。
如果一条规则的目标属于以下情况之一,就称为需要更新:
∙目标没有生成。
∙某个条件需要更新。
∙某个条件的修改时间比目标晚。
在一条规则被执行之前,规则的条件可能处于以下三种状态之一:
∙需要更新。
能够找到以该条件为目标的规则,并且该规则中目标需要更新。
∙不需要更新。
能够找到以该条件为目标的规则,但是该规则中目标不需要更新;
或者不能找到以该条件为目标的规则,并且该条件已经生成。
∙错误。
不能找到以该条件为目标的规则,并且该条件没有生成。
执行一条规则A的步骤如下:
1.检查它的每个条件P:
∙如果P需要更新,就执行以P为目标的规则B。
之后,无论是否生成文件P,都认为P已被更新。
∙如果找不到规则B,并且文件P已存在,表示P不需要更新。
∙如果找不到规则B,并且文件P不存在,则报错退出。
2.在检查完规则A的所有条件后,检查它的目标T,如果属于以下情况之一,就执行它的命令列表:
∙文件T不存在。
∙文件T存在,但是某个条件的修改时间比它晚。
∙某个条件P已被更新(并不一定生成文件P)。
通常Makefile都会有一个clean规则,用于清除编译过程中产生的二进制文件,保留源文件:
clean:
@echo"
cleanningproject"
-rmmain*.o
cleancompleted"
把这条规则添加到我们的Makefile末尾,然后执行这条规则:
$makeclean
cleanningproject
rmmain*.o
cleancompleted
如果在make的命令行中指定一个目标(例如clean),则更新这个目标,如果不指定目标则更新Makefile中第一条规则的目标(缺省目标)。
和前面介绍的规则不同,clean目标不依赖于任何条件,并且执行它的命令列表不会生成clean这个文件,刚才说过,只要执行了命令列表就算更新了目标,即使目标并没有生成也算。
在这个例子还演示了命令前面加@和-字符的效果:
如果make执行的命令前面加了@字符,则不显示命令本身而只显示它的结果;
通常make执行的命令如果出错(该命令的退出状态非0)就立刻终止,不再执行后续命令,但如果命令前面加了-号,即使这条命令出错,make也会继续执行后续命令。
通常rm命令和mkdir命令前面要加-号,因为rm要删除的文件可能不存在,mkdir要创建的目录可能已存在,这两个命令都有可能出错,但这种错误是应该忽略的。
例如上面已经执行过一遍makeclean,再执行一遍就没有文件可删了,这时rm会报错,但make忽略这一错误,继续执行后面的echo命令:
rm:
cannotremove`main'
:
Nosuchfileordirectory
cannotremove`*.o'
[clean]Error1(ignored)
读者可以把命令前面的@和-去掉再试试,对比一下结果有何不同。
这里还有一个问题,如果当前目录下存在一个文件叫clean会怎么样呢?
$touchclean
$makeclean
`clean'
如果存在clean这个文件,clean目标又不依赖于任何条件,make就认为它不需要更新了。
而我们希望把clean当作一个特殊的名字使用,不管它存在不存在都要更新,可以添一条特殊规则,把clean声明为一个伪目标:
.PHONY:
clean
这条规则没有命令列表。
类似.PHONY这种make内建的特殊目标还有很多,各有不同的用途,详见[GNUmake]。
在C语言中要求变量和函数先声明后使用,而Makefile不太一样,这条规则写在clean:
规则的后面也行,也能起到声明clean是伪目标的作用:
当然写在前面也行。
gcc处理一个C程序分为预处理和编译两个阶段,类似地,make处理Makefile的过程也分为两个阶段:
1.首先从前到后读取所有规则,建立起一个完整的依赖关系图,例如:
图
22.1.
Makefile的依赖关系图
2.然后从缺省目标或者命令行指定的目标开始,根据依赖关系图选择适当的规则执行,执行Makefile中的规则和执行C代码不一样,并不是从前到后按顺序执行,也不是所有规则都要执行一遍,例如make缺省目标时不会更新clean目标,因为从上图可以看出,它跟缺省目标没有任何依赖关系。
clean目标是一个约定俗成的名字,在所有软件项目的Makefile中都表示清除编译生成的文件,类似这样的约定俗成的目标名字有:
∙all,执行主要的编译工作,通常用作缺省目标。
∙install,执行编译后的安装工作,把可执行文件、配置文件、文档等分别拷到不同的安装目录。
∙clean,删除编译生成的二进制文件。
∙distclean,不仅删除编译生成的二进制文件,也删除其它生成的文件,例如配置文件和格式转换后的文档,执行makedistclean之后应该清除所有这些文件,只留下源文件。
[33]只要符合本章所描述的语法的文件我们都叫它Makefile,而它的文件名则不一定是Makefile。
事实上,执行make命令时,是按照GNUmakefile、makefile、Makefile的顺序找到第一个存在的文件并执行它,不过还是建议使用Makefile做文件名。
除了GNUmake,有些UNIX系统的make命令不是GNUmake,不会查找GNUmakefile这个文件名,如果你写的Makefile包含GNUmake的特殊语法,可以起名为GNUmakefile,否则不建议用这个文件名。