程序环境和预处理-C语言进阶

本章重点：

• 程序的翻译环境
• 程序的执行环境
• 详解：C语言程序的编译 + 链接
• 预定义符号的介绍
• 预处理指令 #define
• 宏和函数的对比
• 预处理操作符 # 和 ## 的介绍
• 命令定义
• 预处理指令 #include
• 预处理指令 #undef
• 条件编译

1. 程序的翻译环境和执行环境

在 ANSI C 的任何一种实现中，存在两个不同的环境。

第 1 种是翻译环境，在这个环节中源代码被转化为可执行的机器指令。
第 2 种是执行环境，它用于实际执行代码。

2. 详解编译+链接

2.1 翻译环境

• 组成一个程序的每个源文件通过编译过程分别转换成目标代码（object code）。
• 每个目标文件由链接器（linker）捆绑在一起，形成一个单一而完整的可执行程序。
• 链接器同时也会引入标准 C 函数库中任何被该程序所用到的函数，而且它可以搜索程序员个人的程序库，将其需要的函数也链接到程序中。

2.2 编译本身也分为几个阶段：

看代码：

sum.c

int g_val = 2023;
void print(const char* str) {
	printf("%s\n", str);
}

test.c

#include <stdio.h>

	extern void print(char* str);//不声明会报警告，不会出错
	extern int g_val;
int main() {
	printf("%d\n", g_val);
	print("hello\n");

	return 0;
}

• 编译：
  • 预编译阶段：文本操作
    • 头文件的包含（#include）：把头文件的内容拷贝到 test.i 文件中。
    • define 定义符号的替换，删除定义的符号
    • 注释删除
  • 编译：把 C 语言代码转换成汇编代码
    • 语法分析
    • 词法分析：把整个代码的符号（类型，变量，常量，运算符等），关键字等拆开汇总成语法树。
    • 符号汇总：把全局的符号汇总出来（如 g_val, Add, main）
    • 语义分析：循环等逻辑进行语义分析
  • 汇编：
    • 把汇编代码转换成二进制指令/机器指令。
    • 形成符号表：把汇总的符号关联一个地址形成一个表格，对于只有声明没有实现的符号匹配一个 无效/错误 的地址。
• 链接：
  • 链接阶段：链接目标文件和链接库
    • 合并段表：把相同的段合并起来，统一合并到一个文件/把相同格式的文件进行相关的合并。
    • 符号表的合并和重定位：把各个目标文件的符号表进行合并，相同的符号筛选有效的地址。保证能够跨文件找到函数/符号等。（通过地址无法找到的符号将会出现链接错误）

• sum.o 和 test.o 文件在 linux 系统下都是 elf 格式，这种格式会把文件分成不同的段，每个段存储相应的数据（某一种属性的数据）。
• linux 环境下的可执行程序也是 elf 格式的。

如何查看编译期间每一步发生了什么呢？

test.c

#include <stdio.h>

int g_val = 2023;
int Add(int x, int y) {
	return x + y;
}

#define MAX 100
//这是一个故意写的注释
int main() {
	int value = MAX;
	int i = 0;
	for(i = 0; i < 10; i++) {
		printf("%d", i);
	}

	return 0;
}

1. 预处理 选项 gcc test.c -E -o test.i
   预处理完成之后就停下来，预处理之后产生的结果都放在 test.i 文件中。
2. 编译 选项 gcc test.c -S/gcc test.i -S
   编译完成之后就停下来，结果保存在 test.s 中。
3. 汇编 选项 gcc test.c -c/gcc test.s -c
   汇编完成之后就停下来，结果保存在 test.o 中。

VIM 学习资料
简明 VIM 练级攻略：
https://coolshell.cn/articles/5426.html
给程序员的 VIM 速查卡
https://coolshell.cn/articles/5479.html

2.3 运行环境

程序执行的过程：

1. 程序比必须载入内存中。在有操作系统的环境中：一般这个由操作系统完成。在独立的环境中，程序的载入必须由手工安排，也可能是通过可执行代码置入只读内存来完成。
2. 程序的执行便开始。接着便调用 main 函数
3. 开始执行程序代码。这个时候程序将使用一个运行时堆栈（stack），存储函数的局部变量和返回地址。程序同时也可以使用静态（static）内存，存储于静态内存中的变量在程序的整个执行过程中一直保留他们的值。
4. 终止程序。正常终止 main 函数；也有可能是意外终止。

注：
介绍一本书《程序员的自我修养》

3. 预处理详解

3.1 预定义符号

__FILE__	//进行编译的源文件
__LINE__	//文件当前的行号
__DATE__	//文件被编译的日期
__TIME__	//文件被编译的时间
__STDC__	//如果编译器（gcc）遵循 ANSI C，其值为 1，否则未定义（VS编译器不遵循）

这些与定义符号都是语言内置的。

gcc编译器是严格遵循 ANSI C。

举个栗子：

#include <stdio.h>
#include <stdlib.h>

int main() {
	int i = 0;
	FILE* pf = fopen("log.txt", "w");
	if (pf == NULL) {
		perror("fopen");
		return EXIT_FAILURE;//1
	}
	for (i = 0; i < 10; i++) {
		fprintf(pf,"file:%s line=%d date:%s time:%s i=%d\n", __FILE__, __LINE__, __DATE__, __TIME__, i);
	}
	fclose(pf);
	pf = NULL;
	
	return 0;
}

EXIT_FAILURE 值为 1, 在头文件 stdlib.h 中

3.2 #define

3.2.1 #define 定义标识符

语法：
#define name stuff

举个栗子：

#define MAX 1000
#define STR "hello"
#define reg register		// 为register关键字创建一个简短名字
#define do_forever for(;;)	// 用更形象的符号来替换一种实现
#define CASE break;case		// 在写 case 语句的时候自动把 break 写上
//如果定义的 stuff 过长，可以分开几行写，除了最后一行外，每行的后面都加一个反斜杠（续行符）。
#define DEBUG_PRINT print("file:%s\tline:%d\t\
						date:%s\ttime:%s\n",\
						__FILE__,__LINE__,\
						__DATE__,__TIME__)

续行符原理：转义回车，让回车不是回车。因此后面不能有其它东西（尤其是空格）。

提问：

在 define 定义标识符的时候，要不要在最后加上 ; ?

注意：建议在 define 定义的代码最后不要加分号(;)，这样容易出问题。

比如下面的场景：

#define MAX 1000;
if (condition)
	max = MAX;
else
	max = 0;

这里会出现语法错误。

3.2.2 #define 定义宏

#define 机制包括了一个规定，允许把参数替换到文本中，这种实现通常称为宏（macro）或定义宏（#define macro）。

下面是宏的申明方式：

#define name( parament-list ) stuff

其中的 parament-list 是一个由逗号隔开的符号表，它们可能出现在 stuff 中。

注意：
参数列表的左括号必须跟 name 紧邻。
如果两者之间有任何空白存在，参数列表就会被解释为 stuff 的一部分。

如：

#include <stdio.h>

#define SQUARE(X) X * X

int main() {
	int r = SQUARE(5);
	printf("%d\n", r);
	
	return 0;
}

这个宏接收一个参数 X，如果在上述声明之后，你把

SQUARE(5)

置于程序中，预处理器就会用下面这个表达式替换上面的表达式：

5 * 5

警告⚠：
这个宏存在一个问题：
观察下面的代码段：

int a = 5;
printf("%d\n", SQUARE(a + 1));

乍一看，你可能觉得这段代码将打印 36 这个值。
事实上，它将打印 11。
为什么？

替换文本时，参数 x 被替换成 a + 1，所以这条语句实际上变成了：
printf("%d\n", a + 1 * a + 1);

这样就比较清晰了，由替换产生的表达式并没有按照预想的次序进行求值。

在宏定义上加上两个括号，这个问题便轻松的解决了：

#define SQUARE(X) (X) * (X)

这样预处理后就产生了预期的效果：

printf("%d\n", (a + 1) * (a + 1));

这里还有一个宏定义：

#define DOUBLE(X) (X) + (X)

定义中我们使用了括号，想避免之前的问题，但是这个宏可能会出现新的错误。

int a = 5;
printf("%d\n", 10 * SQUARE(a));

这将打印什么值呢？

warning：
看上去，好像打印 100，但事实上打印的是 55。
我们发现替换之后：

printf("%d\n", 10 * (5) + (5));

乘法运算先于宏定义的加法，所以出现了 55 这个问题，解决方法是在宏定义表达式两边加上一对括号就可以了。

#define DOUBLE(X) ((X) + (X))

提示：

所有用于对数值表达式进行求值的宏定义都应该用这种方式加上括号，避免在使用宏时由于参数中的操作符与邻近操作符之间不可预料的相互作用。

3.2.3 #define 替换规则

在程序中扩展 #define 定义符号和宏时，需要涉及几个步骤。

1. 在调用宏时，首先对参数进行检查，看看是否包含任何由 #define 定义的符号。如果是，它们首先被替换。
2. 替换文本随后被插入到程序中原来文本的位置。对于宏，参数名被它们的值所替换。
3. 最后，再次对结果文件进行扫描，看看它是否包含任何由 #define 定义的符号。如果是，就重复上述处理过程。

注意：

1. 宏参数和 #define 定义中可以出现其他 #define 定义的符号。但是对于宏，不能出现递归。
2. 当预处理器搜索 #define 定义的符号时，字符串常量的内容并不被搜索。

3.2.4 # 和

如何把参数插入到字符串中？

首先我们看看这样的代码：

char* p = "hello ""abc\n";
printf("hello"" abc\n");
printf("%s", p);

这里的输出是不是

hello abc?

答案是确定的：是。

我们发现字符串是有自动连接的特点的。那我们是不是可以写这样的代码？

#define PRINT(FORMAT, VALUE)\
	printf("the value is "FORMAT"\n", VALUE);

PRINT("%d", 10);

这里只有当字符串作为宏参数的时候才可以把字符串放在字符串中。

另外一个技巧是：
使用 #，把一个宏参数变成对应的字符串。
比如：

int i = 10;
#define PRINT(FORMAT, VALUE)\
	printf("the value of "#VALUE" is "FORMAT"\n", VALUE);

PRINT("%d", i+3);//产生了什么效果？

代码中 #VALUE 会预处理处理为："VALUE"

最终的输出结果应该是：

the value of i+3 is 13

## 的作用

可以把位于它两边的符号合成一个符号。

它允许宏定义从分离的文本片段创建标识符

#define ADD_TO_SUM(num, value) \
	sum##num += value;

ADD_TO_SUM(5, 10);//作用是：给 sum5 增加 10

注：
这样的连接必须产生一个合法的标识符。否则其结果就是未定义的。

3.2.5 带副作用的宏参数

当宏参数在宏的定义中出现超过一次的时候，如果参数带有副作用，那么你在使用这个宏的时候就可能出现危险，导致不可预测的后果。副作用就是表达式求值的时候出现的永久性效果。
例如：

x+1;//不带副作用
x++;//带有副作用

MAX 宏可以证明具有副作用的参数所引起的问题：

#include <stdio.h>

#define MAX(x, y) ((x)>(y)?(x):(y))
int main() {
	int a = 5;
	int b = 4;
	int m = MAX(a++, b++);

	printf("m=%d", m);//m=6
	printf("a=%d, b=%d\n", a, b);//a=7, b=5
	
	return 0;
}

三目操作符（ ? : ）先执行 判断表达式 1，再选择性执行表达式 2 或者 3，类似于 if (表达式 1) {表达式 2} else {表达式 3}

这里我们得知道预处理器处理之后的结果是什么：

m = ((a++)>(b++)?(a++):(b++));

所以输出的结果是：

m=6
a=7, b=5

3.2.6 宏和函数的对比

宏通常被应用于执行简单的运算。

比如两个数中找出较大的一个。

#define MAX(a,b) ((a)>(b)?(a):(b))

那为什么不用函数来完成这个任务？

int MAX (int x, int y) {
	return (x>y?x:y);
}

原因有二：

1. 用于调用函数和从函数返回的代码可能比实际执行这个小型计算工作所需要的时间更多。
   所以宏比函数在程序的规模和速度方面更胜一筹。
2. 更为重要的是函数的参数必须声明为特定的类型。所以函数只能在类型合适的表达式上使用。反之这个宏可以适用于整型、长整型、浮点型等可以用于 > 来比较的类型。
   宏是类型无关的。

宏的缺点：当然和函数相比宏也有劣势的地方：

1. 每次使用宏的时候，一份宏定义的代码将插入到程序中。除非宏比较短，否则可能大幅度增加程序的长度。
2. 宏是无法调试的。（调试在运行阶段，宏在预处理阶段完成替换）
3. 宏由于类型无关，也就不够严谨。
4. 宏可能会带来运算符优先级的问题，导致程序容易出错。

宏有时候可以做函数做不到的事情。比如：宏的参数可以出现 类型，但是函数做不到。

#define MALLOC(num,type) (type*)malloc((num)*sizeof(type))

//使用
int* p = MALLOC(10,int);//类型作为参数

//预处理器替换之后：
(int*)malloc(10*sizeof(int));

宏和函数的一个对比

属性	#define定义宏	函数
代码长度	每次使用时，宏代码都会被插入到程序中，除了非常小的宏之外，程序的长度会大幅度增长	函数代码只出现于一个地方：每次使用这个函数时，都调用那个地方的同一份代码
执行速度	更快	存在函数的调用和返回的额外开销，所以相对慢一些
操作符优先级	宏参数的求值时在所有周围表达式的上下文环境里，除非加上括号，否则邻近操作符的优先级可能会产生不可预料的后果，所以建议宏在书写的时候多些括号	函数参数只在函数调用的时候求值一次，它的结果传递给函数，表达式的求值结果更容易预测
带有副作用的参数	参数可能被替换到宏体中的多个位置，所以带有副作用的参数求值可能会产生不可预料的后果	函数参数只在传参的时候求值一次，结果更容易控制
参数类型	宏的参数与类型无关，只要对参数的操作是合法的，它就可以适用于任何参数类型	函数的参数是与类型有关的，如果参数的类型不同，就需要不同的函数，即使它们执行的任务是相同的
调试	宏是不方便调试的	函数时可以逐语句调试的
递归	宏是不能递归的	函数是可以递归的

3.2.7 命名约定

一般来讲函数的宏的使用语法很相似，所以语言本身无法帮我们区分两者。
那我们平时的一个习惯是：

把宏名全部大写
函数名不要全部大写

offsetof 是一个宏，但是写成了函数的形式，目的是让使用者误以为是函数

3.3 #undef

这条指令用于移出一个宏定义。

#define NAME
//如果现存的一个名字需要被重新定义，那么它的旧名字首先要被移除

示例：

#include <stdio.h>

#define M 100
int main() {
	printf("%d\n", M);
#undef M
	printf("%d\n", M);//报错：未定义的标识符

	return 0;
}

3.4 命令行定义

许多 C 的编译器提供了一种能力，允许在命令行中定义符号，用于启动编译过程。
例如：当我们根据同一个源文件要编译出一个程序的不同版本的时候，这个特性有点用处。（假定某个程序中声明了一个某个长度的数组，如果机器内存有限，我们需要一个很小的数组，但是另外一个机器内存大些，我们需要一个数组能够大些。）

#include <stdio.h>
int main() {
	int array[ARRAY_SIZE];
	int i = 0;
	for (i = 0; i < ARRAY_SIZE; i++) {
		array[i] = i;
	}
	for (i = 0; i < ARRAY_SIZE; i++) {
		printf("%d ", array[i]);
	}
}

编译指令：

//linux 环境演示
gcc -D ARRAY_SIZE=10 programe.c

3.5 条件编译

在编译一个程序的时候我们如果要将一条语句（一组语句）编译或者放弃是很方便的。因为我们有条件编译指令。（在某些条件下编译，条件满足就编译，条件不满足就不编译，编译器会在预处理阶段进行取舍）

比如说：

• 调试性的代码，删除可惜，保留又碍事，所以我们可以选择性编译。
• 条件编译适用于处理跨平台的问题。

#include <stdio.h>
#define __DEBUG__

int main() {
	int i = 0;
	int arr[10] = { 0 };
	for (i = 0; i < 10; i++) {
		arr[i] = i;
#ifdef __DEBUG__
		printf("%d\n", arr[i]);//为了观察数组是否赋值成功
#endif //__DEBUG__//注释条件编译结束的标识符，增加代码可读性
	}
	
	return 0;
}

常见的条件编译指令：

1.
#if 常量表达式
	//...
#endif
//常量表达式由预处理器求值
如：
#define __DEBUG__ 1
#if __DEBUG__
	//...
#endif

2.多个分支的条件编译
#if 常量表达式
	//...
#elif 常量表达式
	//...
#else
	//...
#endif

3.判断是否被定义
#if defined(symbol)
#ifdef symbol

#if !defined(symbol)
#ifndef symbol

4.嵌套指令
#if defined(OS UNIX)
	#ifdef OPTION1
		unix_version_option1();
	#endif
	#ifdef OPTION2
		unix_version_option2();
	#endif
#elif defined(OS_MSDOS)
	#ifdef OPTION2
		msdos_version_option2();
	#endif
#endif

示例：

2.多个分支的条件编译
#define MAX 6
#if MAX < 6
	//...
#elif MAX > 6
	//...
#else
	//...
#endif

3.判断是否被定义
#define MAX 100

#if defined(MAX)//#ifdef MAX
	printf("max\n");
#endif

3.6 文件包含

我们已经知道，#include 指令可以是另外一个文件被编译，就像它实际出现于 #include 指令的地方一样。

这种替换的方式很简单：
预处理器先删除这条指令，并用包含文件的内容替换。
这样一个源文件被包含 10 次，那就实际被编译 10 次。

3.6.1 头文件被包含的方式：

• 本地文件包含

#include "filename"

查找策略：先在源文件所在目录下查找，如果该头文件未找到，编译器就像查找库函数头文件一样在标准位置查找头文件。
如果找不到就提示编译错误。

Linux 环境的标准头文件的路径：

/usr/include

VS 环境的标准头文件的路径：

C:\Program Files (x86)\Microsoft visual Studio 12.0\vc\include
//这是vs2013的默认路径

注意按照自己的安装路径去找。

• 库文件包含

#include <filename.h>

查找策略：查找头文件直接去标准路径下去查找，如果找不到就提示编译错误。

这里是不是可以说，对于库文件也可以使用 “” 的形式包含？
答案是肯定的，可以。

但是这样做查找的效率就低些，当然这样也不容易区分是库文件还是本地文件了。

3.6.2 嵌套文件包含

假如 common.h 和 common.c 是公共模块。
test1.h 和 test1.c 使用了公共模块。
test2.h 和 test2.c 也使用了公共模块。
test.h 和 test.c 使用了 test1 模块 和 test2 模块。
这样最终程序中就会出现两份 common.h 的内容。这样就造成了文件内容的重复。

如何解决这个问题？
答案：条件编译。

为了防止头文件被多次重复包含：
方案 1：

#ifndef __TEST_H__
#define __TEST_H__

//...

#endif //__TEST_H__

方案 2：

#pragma once

//...

注：推荐《高质量C/C++编程指南》中附录的考试试卷（很重要）。
笔试题：

1.头文件中的 ifndef/define/endif 是干什么用的？
2.#include <filename.h> 和 #include "filename.h" 有什么区别？

4. 其他预处理指令

#error
#pragma
#line
...
自行了解

#pragma pack() 在结构体部分介绍

参考《C语言深度解剖》学习