编写高质量的Makefile


分类: c++/c研究 GNU&LINUX163人阅读 评论(0)收藏举报

源地址 :http://acm.hrbeu.edu.cn/forums/index.php?showtopic=1827&st=0&gopid=8924&#entry8924

一、前言

回想自己的第一个Makefile,是这个样子的

CODE
hello:hello.c
     gcc hello.c -o hello



后来有所进步,陆续地写了一些大都是这个样子的Makefile:

CODE

foobar:foo.o bar.o
     gcc -o foo.o bar.o
foo.o:foo.c
     gcc -c foo.c
bar.o:foo.c
     gcc -c bar.c

.PHONY:clean
clean:
     rm -rf *.o foobar



看上去还行,用起来也不错,但是随着程序规模的扩大,每次添加一个新文件,都要手动修改Makefile,实在是不厌其烦。

后来阅读了一些开源程序的Makefile源代码,当然,不是automake生成的那种,有了一些心得,几番进化,一段时间后,感觉对GNU make算是有了些初步的了解,在此总结一下,也算是温故而知新了。而且我记性比较差 ,放在这里算是记录一下,免得以后忘记。同时也免得大家再去翻那些繁复的手册,浪费不必要的时间。 

下文中makefile操作的对象有三个文件: foo.c , bar.c 和bar.h,内容分别如下:

foo.c

CODE

#include "bar.h"

int main(){

     print("Hello, makefile!");
              
     return 0;
}




bar.c

CODE

#include <stdio.h>

int print(char * msg){

     printf("%s/n",msg);

     return 0;
}




bar.h

CODE
int print(char * msg);




OK,该交代的都交代了,进入正题。


二、我的makefile模板

把上个项目的makefile整理了一下,感觉结构比较清晰,可以作为模板供以后使用。

文件内容大体是这个样子的:

CODE

CC = gcc
CFLAGS = -Wall -O
INCLUDE = -I/usr/include/mysql                             #其实在这里用不着这几个选项
LFLAGS = -L/usr/lib/mysql -lmysqlclient -lpthread   #仅做示意之用

TARGET = foobar

SOUCE_FILES = $(wildcard *.c)
OBJS = $(patsubst %.c,%.o,$(SOUCE_FILES))

%.o : %.c %.h
     $(CC) -c $(CFLAGS) $< -o $@

%.o : %.c
     $(CC) -c $(CFLAGS) $< -o $@

$(TARGET): $(OBJS)
     $(CC) $^ -o $@ $(INCLUDE) $(LFLAGS)

.PHONY:clean
clean:
     $(RM) $(TARGET) $(OBJS)




解释:

前几行都是变量的定义,至于为什么要定义这些变量,理由和编程中使用宏定义是一样的,那就是改一个就可以使很多地方同时生效,避免了重复的工作。

按照惯例:

CC变量指定了使用的编译器
CFLAGS变量包含了所需的编译选项
INCLUDE是寻找头文件的路径
LFLAGS是加载外部库时的指定选项。
TARGET变量代表最终要生成的可执行程序

下面的内容就是关键了,我们将利用一些GNU make内置的函数与推导规则来完成我们的目标。

首先的任务是自动获得当前目录下所有的源文件,好让我们新添文件后不必再修改Makefile。
完成这个功能的是这行代码

SOUCE_FILES = $(wildcard *.c)

wildcard 是GNU make程序预定义的一个函数,作用便是获取匹配模式文件名,原型为$(wildcard PATTERN)。它的详细说明可以看这里。简单来说wildcard函数的参数只有一个,就是函数名之后的文件名模式,这里的模式使用shell可识别 的通配符,包括“?”(单字符)、“*”(多字符)等。现在我们的需求是获取当前目录下的所有.c文件,模式自然是*.c。

按照最基本的依赖规则,生成TARGET文件依赖于一系列的.o文件,那么如何获得这些.o文件的列表呢?答案是使用patsubst模式替换函数函数:

$(patsubst %.c,%.o,$(SOUCE_FILES))

模 式替换函数patsubst函数原型为$(patsubst PATTERN,REPLACEMENT,TEXT),相比wildcard,它要复杂一些,顾名思义,三个参数依次代表了匹配模式,替换规则,替换目标 字符串。在这里,我们需要把所有.c替换成.o,所以写成上面的样子就可以了。

现在c源文件列表和obj文件列表都有了,下一步就该为每个源文件编写规则了。

其实很多源文件的编译规则都是一样的,就像最开始那个Makefile中那样

CODE

foo.o:foo.c
     gcc -c foo.c
bar.o:foo.c
     gcc -c bar.c



仅仅是文件名不同而已,因此就给了我们提取模式的某种可能性。我在一个关于winsock的makefile中找到了答案:

CODE
.SUFFIXES: .c .o
.c.o:
         $(CC) -c $(CFLAGS) $< -o $@



这个规则利用了GNU make的后缀规则。
在这里,当定义了一个目标是“.c.o”的规则时。它的含义是所有“.o”文件的依赖文件是对应的“.c”文件。因此在这条规则下,foo.c将被自动编译成foo,bar.c被编译成bar。
而特殊目标.SUFFIXES这句的作用是: 在默认后缀的基础上,增加了可以作为后缀的关键字符串。
其实.c.o是肯定在默认识别的规则中的,不过为了保险起见,还是显式地声明一下比较好。

可以看到,这个规则十分的晦涩,反正我第一眼真是没看明白。因此,新版本的GNU make已经使用模式规则替代了后缀规则。

同样的功能,利用模式规则实现如下:

CODE
%.o : %.c
         $(CC) -c $(CFLAGS) $< -o $@



这样看起来便清晰多了。如果考虑到头文件,完美的写法应该是这样的:

CODE
%.o : %.c %.h
         $(CC) -c $(CFLAGS) $< -o $@



在上面的规则中,还使用了一些GNU make的自动化变量,他们的含义分别如下:

$@ --- 目标文件
$< --- 第一个依赖文件
$^ --- 所有的依赖文件

更多的自动化变量可以参见这里

最后的规则就是生成可执行文件了,很普通,不再赘述。

为了方便调试,可以在makefile中定义一些伪目标。(伪目标的解释和意义可以看这里)
一般调试用的makefile中都会有两个伪目标,一个clean,一个debug

对 于clean,手册里说:“make存在一个内嵌隐含变量“RM”,它被定义为:“RM = rm –f”。因此在书写“clean”规则的命令行时可以使用变量“$(RM)”来代替“rm”,这样可以免出现一些不必要的麻烦!”虽然不知道“必要的麻 烦”是什么,但是小心不为过,照着手册做比较好。

对于debug,和正常模式不同的就是添加了一些编译选项,修改CFLAGS的内容就可以了。但目前还没搞明白怎么动态地在makefile里修改变量的内容。这个问题以后再说。

三、在多文件夹情况使用makefile组织代码

上一段中给出的makefile,对于一般的小程序已经足矣,但是如果代码文件越来越多,最后不得不放到几个文件夹中,这时又该怎么办?
比如说我们准备把bar.c中的函数整理成了一个函数库libbar放在主程序文件夹中的子文件夹libbar中,这时该如何利用makefile来组织这些文件?
比较好的办法是在libbar文件夹中放置一个独立的子makefile,然后在主makefile里调用它。

libbar/Makefile:

CODE

CC = gcc
CFLAGS = -Wall -O
AR = ar
AFLAGS = -r
INCLUDE = -I/usr/include/mysql
LFLAGS = -L/usr/lib/mysql -lmysqlclient -lpthread

TARGET = libbar.a

SOUCE_FILES = $(wildcard *.c)
OBJS = $(patsubst %.c,%.o,$(SOUCE_FILES))

%.o : %.c %.h
     $(CC) -c $(CFLAGS) $< -o $@

%.o : %.c
     $(CC) -c $(CFLAGS) $< -o $@

$(TARGET): $(OBJS)
     $(AR) $(AFLAGS) $(TARGET) $(OBJS)

.PHONY:clean
clean:
     $(RM) $(TARGET) $(OBJS)




主Makefile:

CODE

CC = gcc
CFLAGS = -Wall -O
INCLUDE = -I./libbar
LFLAGS = -L./libbar -lbar

SHELL = /bin/bash
SUBDIRS = libbar

TARGET = foobar

SOUCE_FILES = $(wildcard *.c)
OBJS = $(patsubst %.c,%.o,$(SOUCE_FILES))

%.o : %.c %.h
     $(CC) -c $(CFLAGS) $(INCLUDE) $< -o $@

$(TARGET): $(OBJS) libs
     $(CC) $(OBJS) -o $@ $(INCLUDE) $(LFLAGS)

libs:
     @ for subdir in $(SUBDIRS); do /
         (cd $$subdir && $(MAKE)); /
     done

.PHONY:clean
clean:
     $(RM) $(TARGET) $(OBJS)
     @ for subdir in $(SUBDIRS); do /
         (cd $$subdir && $(MAKE) clean); /
     done




在主makefile中使用了shell的for语句,循环取出SUBDIRS中的子文件夹名,然后进入子文件夹执行make,然后返回。如果在子makefile中出错,编译过程将终止。

四、编译多个目标

不知你有没有遇到过这样的情况,那就是需要从很多的代码,生成很多的可执行文件。

例如编写了一堆小工具,而每个工具只有一个源文件,用foo.c生成foo,用bar.c生成bar。

一个一个编译肯定不现实,这时该怎么做?让我们用GNU make来解决吧!

仔细阅读手册,发现GNU make中的静态模式,正好可以满足这个要求。

方便阅读,直接将手册中关于静态模式的解释粘贴如下:

QUOTE
静态模式规则是这样一个规则:规则存在多个目标,并且不同的目标可以根据目标文件的名字来自动构造出依赖文件。静态模式规则比多目标规则更通用,它不需要多个目标具有相同的依赖。但是静态模式规则中的依赖文件必须是相类似的而不是完全相同的。

静态模式规则的基本语法:

TARGETS ...: TARGET-PATTERN: PREREQ-PATTERNS ...

COMMANDS

...

“TAGETS”列出了此规则的一系列目标文件。像普通规则的目标一样可以包含通配符。

“TAGET -PATTERN”和“PREREQ-PATTERNS”说明了如何为每一个目标文件生成依赖文件。从目标模式(TAGET-PATTERN)的目标名字 中抽取一部分字符串(称为“茎”)。使用“茎”替代依赖模式(PREREQ-PATTERNS)中的相应部分来产生对应目标的依赖文件。




对应我们的需求,应该是用符合%.c模式的文件,生成文件名为%的可执行文件,同时利用自动化变量,构造规则如下:

CODE
$(TARGET_FILES): % : %.cpp
     g++ $(CFLAGS) $< -o $@



其中$(TARGET_FILES)为最终的可执行文件名,可以用wildcard配合patsubs函数获得。

因为$(TARGET_FILES)不止一个,所以直接写这个命令的结果是只会编译出一个可执行文件,即第目标文件列表中的一个文件,要想成功编译出所有的,还需要伪目标的帮忙。

完整的makefile如下:

CODE


CC = gcc
CFLAGS = -Wall -O

SOUCE_FILES=$(wildcard *.c)
TARGET_FILES=$(patsubst %.c,%,$(SOUCE_FILES))

.PHONY:all

all:$(TARGET_FILES)

$(TARGET_FILES): % : %.c
     g++ $(CFLAGS) $< -o $@

clean:
     $(RM) $(TARGET_FILES)




这里介绍两种变量的高级使用方法,第一种是变量值的替换。

我们可以替换变量中的共有的部分,其格式是“$(var:a=b)”或是“${var:a=b}”,其意思是,把变量“var”中所有以“a”字串“结尾”的“a”替换成“b”字串。这里的“结尾”意思是“空格”或是“结束符”。

还是看一个示例吧:

    foo := a.o b.o c.o
    bar := $(foo:.o=.c)

这个示例中,我们先定义了一个“$(foo)”变量,而第二行的意思是把“$(foo)”中所有以“.o”字串“结尾”全部替换成“.c”,所以我们的“$(bar)”的值就是“a.c b.c c.c”。

另外一种变量替换的技术是以“静态模式”(参见前面章节)定义的,如:

    foo := a.o b.o c.o
    bar := $(foo:%.o=%.c)

这依赖于被替换字串中的有相同的模式,模式中必须包含一个“%”字符,这个例子同样让$(bar)变量的值为“a.c b.c c.c”。


本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/254315.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

第六篇:python基础之文件处理

第六篇&#xff1a;python基础之文件处理 阅读目录 一.文件处理流程二.基本操作2.1 文件操作基本流程初探2.2 文件编码2.3 文件打开模式2.4 文件内置函数flush2.5 文件内光标移动2.6 open函数详解2.7 上下文管理2.8 文件的修改一.文件处理流程 打开文件&#xff0c;得到文件句柄…

前端每日实战:56# 视频演示如何用纯 CSS 描述程序员的生活

效果预览 按下右侧的“点击预览”按钮可以在当前页面预览&#xff0c;点击链接可以全屏预览。 https://codepen.io/comehope/pen/YvYVvY 可交互视频 此视频是可以交互的&#xff0c;你可以随时暂停视频&#xff0c;编辑视频中的代码。 请用 chrome, safari, edge 打开观看。 ht…

从特殊到一般-C#中的类

文章目录类的概念类的定义实例例子分析类的成员数据成员属性成员方法成员静态成员博主写作不容易&#xff0c;孩子需要您鼓励 万水千山总是情 , 先点个赞行不行 类的概念 在日常生活中&#xff0c;类是对具有相同特性的一类是物的抽象。比如水果是一个类&#xff0c;它是对…

Chapter 1 First Sight——30

The girl sitting there giggled. Id noticed that his eyes were black — coal black. 那个坐在那里的女孩笑着。我注意到她的眼睛是很色的--炭黑色的。 Mr. Banner signed my slip and handed me a book with no nonsense about introductions. Banner 先生签了我的名字然后…

GPU 与CPU的作用协调,工作流程、GPU整合到CPU得好处

在不少人的心目中&#xff0c;显卡最大的用途可能就只有两点——玩游戏、看电影&#xff0c;除此之外&#xff0c;GPU并没有其他的作用了。但是随着微软IE9的正式发布&#xff0c;不少人突然发现&#xff0c;微软一直提到一个名词&#xff1a;GPU硬件加速&#xff0c;从而也让不…

[luoguP1029] 最大公约数和最小公倍数问题(数论)

传送门 一.暴力枚举&#xff08;加了点优化&#xff09; #include <cstdio>int x, y, ans;inline int gcd(int x, int y) {return !y ? x : gcd(y, x % y); }inline int lcm(int x, int y) {return x / gcd(x, y) * y; }int main() {int i, j;scanf("%d %d", …

CPU和GPU擅长和不擅长的方面

从它们执行运算的速度与效率的方面来探讨这个论题。CPU和GPU都是具有运算能力的芯片&#xff0c; CPU更像“通才”——指令运算(执行)为重数值运算&#xff0c; GPU更像“专才”——图形类数值计算为核心。在不同类型的运算方面的速度也就决定了它们的能力——“擅长和不擅长”…

一些IO流的知识

IO流&#xff1a; 输入流&#xff1a;输出流&#xff1a; 字节流&#xff1a;字符流&#xff1a;为了处理文字数据方便而出现的对象。 其实这些对象的内部使用的还是字节流(因为文字最终也是字节数据) 只不过&#xff0c;通过字节流读取了相对应的字节数&#xff0c;没有对这些…

为人示弱,做事留余 | 摸鱼系列

我很喜欢结交有很好的自然观察能力的朋友&#xff0c;这是种对周围环境和文化的洞察力。 一方面的原因是优秀的领导者、企业家和投资人能利用这种能力发现新市场&#xff0c;预测新潮流&#xff0c;设计出有效的市场营销活动&#xff0c;并找到需要重点关注的人群。 另一方面&a…

从一般到特殊-C#中的对象

文章目录对象的概念对象的创建和使用匿名类型和初始化器构造函数和析构函数构造函数析构函数范例参数传递博主写作不容易&#xff0c;孩子需要您鼓励 万水千山总是情 , 先点个赞行不行 对象的概念 类是具有相同特征一类事物的抽象&#xff0c;而对象是类的实例。 类和对象…

如何用面对对象来做一个躁动的小球?

今天来看看怎样用面对对象来做一个躁动的小球。 首先我们先创建一个对象&#xff0c;他的属性包含小球的随机水平、纵向坐标&#xff0c;随机宽、高&#xff0c;随机颜色&#xff0c;以及创建小球的方法。 html: <div id"wrap"></div> js:function Boll(…

关于MyEclipse项目的名字的修改对项目导入导出的影响

不要修改项目名字&#xff0c;不管是在MyEclipse中(.project文件里面的额name会变)还是在G:\MyEclipseData目录下(.project文件里面的额name不会变)&#xff0c;否则导入的时候不能访问&#xff0c;会出现400的错误&#xff0c;而访问的网址必须是以前没改名前的那个名字才可以…

Gcc详解以及静态库、动态库生成

[转] Gcc详解以及静态库、动态库生成 http://www.360doc.com/content/10/0619/14/1795182_33985297.shtml 1。gcc包含的c/c编译器 gcc,cc,c,g,gcc和cc是一样的&#xff0c;c和g是一样的&#xff0c;(没有看太明白前面这半句是什 么意思:))一般c程序就用gcc编译&#xff0c;c程序…

改变世界的七大NLP技术,你了解多少?(上)

什么是NLP&#xff1f; 自然语言处理&#xff08;NLP&#xff09; 是计算机科学&#xff0c;人工智能和语言学的交叉领域。目标是让计算机处理或“理解”自然语言&#xff0c;以执行语言翻译和问题回答等任务。 随着语音接口和聊天机器人的兴起&#xff0c;NLP正在成为信息时代…

MINI类-结构体

文章目录结构体的定义和使用实例类和结构体的关系博主写作不容易&#xff0c;孩子需要您鼓励 万水千山总是情 , 先点个赞行不行 结构体与类相似&#xff0c;通常用来封装小型的相关变量组&#xff0c;例如&#xff0c;学生的学号、姓名、性别、年龄等。结构是一种值类型&am…

由.def文件生成lib文件[转]

最近在学习curl库时&#xff0c;碰到一个问题&#xff0c;从官网上下载了一个lib版的&#xff0c;却发现只有.dll&#xff0c;没有lib文件&#xff0c;感觉很奇怪&#xff0c;google了之后才知道&#xff0c;原来库作者的用意是让用户自己生成lib文件&#xff0c;下载到的lib文…

union 和 union all 有什么不同?

假设我们有一个表 Student&#xff0c; 包括以下字段与数据&#xff1a;drop table student;create table student( idint primary key,name nvarchar2(50) not null,score number not null);insert into student values(1,Aaron,78);insert into student values(2,Bill,76);in…

暴风影音硬件加速播放高清影片

近年来&#xff0c;高清视频因为画面清晰、视觉效果好&#xff0c;越来越受到众多电脑用户的厚爱。暴风影音3.6版本在高清的支持上&#xff0c;笔者必须得说&#xff0c;是暴风影音在高清方面的一个大跨越&#xff0c;在这个技术上&#xff0c;暴风把KMP等播放器都远远的抛在后…

SSL双向认证的实现

2019独角兽企业重金招聘Python工程师标准>>> 环境 系统&#xff1a;archlinux/centOS nginx&#xff1a;nginx/1.12.2 浏览器&#xff1a;火狐firefox 前提&#xff1a;1.安装nginx。    2.安装openssl。 生成证书 新建工作目录 首先建立一个工作目录&#x…

partial 分部类-庞大类的瘦身计划

文章目录使用情况语法博主写作不容易&#xff0c;孩子需要您鼓励 万水千山总是情 , 先点个赞行不行 一般来说&#xff0c;一个类、结构或者接口位于一个源文件中&#xff0c;但是某些情况&#xff0c;比如大型项目、特殊部署时&#xff0c;可能需要把一个类、结构或者接口放…