C++程序设计——二十一

光風

已于 2022-01-27 11:51:31 修改

阅读量643

点赞数

分类专栏：项目实训文章标签： c++

于 2021-06-01 23:39:30 首次发布

本文链接：https://blog.csdn.net/KAI_ZHAN/article/details/117457464

版权

项目实训专栏收录该内容

21 篇文章 2 订阅

订阅专栏

C 项目组织和Makefile

1、Makefile介绍

在前面的学习中，我们写的都是一个非常简单的样例程序，可以单独执行，但是如果我们写了一个工程，工程中有很多文件，要想运行这样一整个工程，需要在终端下执行make命令，而执行make命令，就需要编写makefile。
makefile定义了一系列的规则来指定哪些文件需要先编译，哪些文件需要后编译，哪些文件需要重新编译，甚至于进行更复杂的功能操作，因为 makefile就像一个Shell脚本一样，也可以执行操作系统的命令。

1.1、Makefile的优缺点

优点：使用广泛，通用性强，可跨平台
缺点：语法比较复杂，要写出一个通用，便于管理，且兼容性强的makefile比较困难

1.2、Makefile的语法规则

<target1 > <target2>.... : <prerequisites1> <prerequisites2>...
[TAB] <command1>
[TAB] <command2>
...

理解：

target：可以是一个object file(目标文件)，也可以是一个执行文件，还可以是一个标签（label）
prerequisites是要生成target需要的文件或者目标
command自然是make需要执行的命令

Makefile其实写的就是工程文件里面的依赖关系，也就是说，target这一个或多个的目标文件依赖于prerequisites中的文件，其生成规则定义在 command中。说白一点就是说，prerequisites中如果有一个以上的文件比target文件要新的话，command所定义的命令就会被执行。这就是makefile的规则。也就是makefile中最核心的内容。

1.2.1、Makefile中的通配符

Makefile中的通配符和正则表达式相类似

*：表示任意一个或多个字符
?：表示任意一个字符
[...]：例[abcd]表示a，b，c，d中任意一个字符，[^abcd]表示除a，b，c，d以外的任意一个字符，[0-9]表示0到9中任意一个数字
~：表示home目录

1.2.2、路径搜索

当一个Makefile中涉及到大量源文件时(这些源文件和Makefile极有可能不在同一个目录中),

这时, 最好将源文件的路径明确在Makefile中, 便于编译时查找. Makefile中有个特殊的变量 VPATH就是完成这个功能的。
指定了 VPATH之后, 如果当前目录中没有找到相应文件或依赖的文件, Makefile 回到 VPATH指定的路径中再去查找。
VPATH使用方法：

vpath directories：当前目录中找不到文件时, 就从directories中搜索
vpath pattern directories：符合pattern格式的文件, 就从directories中搜索
vpath pattern：清除符合pattern格式的文件搜索路径
vpath：清除所有已经设置好的文件路径

示例如下

# 示例1 - 当前目录中找不到文件时, 按顺序从 src目录 ../parent-dir目录中查找文件
VPATH src:../parent-dir   

# 示例2 - .h结尾的文件都从 ./header 目录中查找
VPATH %.h ./header

# 示例3 - 清除示例2中设置的规则
VPATH %.h

# 示例4 - 清除所有VPATH的设置
VPATH

1.2.3、Makefile中的变量

变量定义

变量定义使用=或者:=，其中 = 和 := 的区别在于, := 只能使用前面定义好的变量, = 可以使用后面定义的变量
测试=

# Makefile内容
OBJS2 = $(OBJS1) programC.o
OBJS1 = programA.o programB.o

all:
    @echo $(OBJS2)

# bash中执行 make, 可以看出虽然 OBJS1 是在 OBJS2 之后定义的, 但在 OBJS2中可以提前使用
$ make
programA.o programB.o programC.o

测试:=

# Makefile内容
OBJS2 := $(OBJS1) programC.o
OBJS1 := programA.o programB.o

all:
    @echo $(OBJS2)

# bash中执行 make, 可以看出 OBJS2 中的 $(OBJS1) 为空
$ make
programC.o

变量替换

# Makefile内容
SRCS := programA.c programB.c programC.c
OBJS := $(SRCS:%.c=%.o)

all:
    @echo "SRCS: " $(SRCS)
    @echo "OBJS: " $(OBJS)

# bash中运行make
$ make
SRCS:  programA.c programB.c programC.c
OBJS:  programA.o programB.o programC.o

变量追加值

# Makefile内容
SRCS := programA.c programB.c programC.c
SRCS += programD.c

all:
    @echo "SRCS: " $(SRCS)

# bash中运行make
$ make
SRCS:  programA.c programB.c programC.c programD.c

变量覆盖override

override指令使Makefile中定义的变量能够覆盖 make 命令参数中指定的变量

# Makefile内容 (没有用override)
SRCS := programA.c programB.c programC.c

all:
    @echo "SRCS: " $(SRCS)

# bash中运行make
$ make SRCS=nothing
SRCS:  nothing

#################################################

# Makefile内容 (用override)
override SRCS := programA.c programB.c programC.c

all:
    @echo "SRCS: " $(SRCS)

# bash中运行make
$ make SRCS=nothing
SRCS:  programA.c programB.c programC.c

目标变量

# Makefile 内容
SRCS := programA.c programB.c programC.c

target1: TARGET1-SRCS := programD.c
target1:
    @echo "SRCS: " $(SRCS)
    @echo "SRCS: " $(TARGET1-SRCS)

target2:
    @echo "SRCS: " $(SRCS)
    @echo "SRCS: " $(TARGET1-SRCS)

# bash中执行make
$ make target1
SRCS:  programA.c programB.c programC.c
SRCS:  programD.c

$ make target2     <-- target2中显示不了 $(TARGET1-SRCS)
SRCS:  programA.c programB.c programC.c
SRCS:

1.2.4、Makefile中的命令前缀

akefile 中书写shell命令时可以加2种前缀@和 -, 或者不用前缀.

3种格式的shell命令区别如下:

不用前缀：输出执行的命令以及命令执行的结果, 出错的话停止执行
前缀 @：只输出命令执行的结果, 出错的话停止执行
前缀 -：命令执行有错的话, 忽略错误, 继续执行

# Makefile 内容 (不用前缀)
all:
    echo "没有前缀"
    cat this_file_not_exist
    echo "错误之后的命令"       <-- 这条命令不会被执行

# bash中执行 make
$ make
echo "没有前缀"             <-- 命令本身显示出来
没有前缀                    <-- 命令执行结果显示出来
cat this_file_not_exist
cat: this_file_not_exist: No such file or directory
make: *** [all] Error 1

###########################################################

# Makefile 内容 (前缀 @)
all:
    @echo "没有前缀"
    @cat this_file_not_exist
    @echo "错误之后的命令"       <-- 这条命令不会被执行

# bash中执行 make
$ make
没有前缀                         <-- 只有命令执行的结果, 不显示命令本身
cat: this_file_not_exist: No such file or directory
make: *** [all] Error 1

###########################################################

# Makefile 内容 (前缀 -)
all:
    -echo "没有前缀"
    -cat this_file_not_exist
    -echo "错误之后的命令"       <-- 这条命令会被执行

# bash中执行 make
$ make
echo "没有前缀"             <-- 命令本身显示出来
没有前缀                    <-- 命令执行结果显示出来
cat this_file_not_exist
cat: this_file_not_exist: No such file or directory
make: [all] Error 1 (ignored)
echo "错误之后的命令"       <-- 出错之后的命令也会显示
错误之后的命令              <-- 出错之后的命令也会执行

1.2.5、make退出码

0：表示成功执行
1：表示make命令出现错误
2：使用了 “-q” 选项, 并且make使得一些目标不需要更新

2、简单工程的Makefile例子

在写一个Makefile文件之前，我们先回顾一下三个gcc命令：
gcc -g：可执行程序包含调式信息
gcc -o：后面跟文件名（不能和源文件重名），将结果输出到该文件中
gcc -c：只编译不链接，产生.o文件，就是obj文件，不产生执行文件。如果不给出文件名，gcc就给出预设的可执行文件a.out。
现在假设我们需要编写一个能够输出"Makefile Best"的程序，需要三个文件：
1、out.h

#include <stdio.h>
void out();//声明函数

2、out.c

#include"out.h"
void out()
{
	printf("Makefile Best!");
}
//定义函数

3、main.c

#include "out.h"
int main()
{
	out();
	return 0;
}
//调用函数

编写makefile如下：

makefile_best:main.o out.o
#makefile_best就是我们要生成的目标
#main.o out.o是生成此目标的先决条件

#shell命令，最前面必须是一个tab键
	gcc -o makefile_best main.o out.o
main.o:main.c out.h
	gcc -c main.c
out.o:out.c out.h
	gcc -c out.c
clean:
	rm makefile_best main.o out.o

输入make后生成main.o和out.o文件，以及一个可执行程序makefile_best

改进Makefile

上面的Makefile中，main.o和out.o定义了多次
我们使用宏，只定义一次

objects=main.o out.o
#声明变量
makefile_best:$(objects)
#声明变量后需要使用"$()"
	gcc -o makefile_best$(objects)
main.o:main.c out.h
	gcc -c main.c
out.o:out.c out.h
	gcc -c out.c
clean:
	rm makefile_best$(objects)

Makefile再改进

改进后，每一个*.o文件都不需要再写一句gcc -c *.c，都依赖的*.h文件也不需要都声明了

objects=main.o out.o
#声明变量
makefile_best:$(objects)
#声明变量后需要使用"$()"
	gcc -o makefile_best$(objects)
$(objects):out.h
#说明都依赖out.h

main.o:main.c out.h
out.o:out.c out.h
#省略了gcc -c *c，make时自动推导

clean:
	rm makefile_best$(objects)