【程序环境与预处理玩转指南】

本章重点：

• 程序的翻译环境

• 程序的执行环境

• 详解：C语言程序的编译+链接

• 预定义符号介绍

• 预处理指令 #define

• 宏和函数的对比

• 预处理操作符#和##的介绍

• 命令定义

• 预处理指令 #include

• 预处理指令 #undef

• 条件编译

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

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

• 第1种是翻译环境，在这个环境中源代码经过编译和链接被转换为可执行的机器指令。
• 第2种是执行环境，它用于实际执行代码。

为什么有这两种环境呢？

        因为我们所书写的代码都是文本信息，计算机只能识别二进制，计算机不能直接理解文本信息，就需要将文本信息转为二级制指令，然后再去执行这些指令。

• 翻译环境：文本信息 - 二级制指令（存放在可执行程序里面）
• 执行环境：执行可执行程序

2. 详解编译+链接

2.1 翻译环境

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

2.2 编译本身也分为几个阶段：预编译（预处理）+ 编译 + 汇编

注：由于vs已经将编译和链接集成开发环境，不方便看到这些过程，咱们在gcc编译器测试。

1. 预处理（Preprocessing）：预处理器（Preprocessor）根据程序中包含的预编译指令，如#include等，将源代码中的宏定义、注释、条件编译等转换为实际的C代码。预处理的输出结果通常是一个扩展名为.i的文件。

2. 编译（Compilation）：编译器（Compiler）将扩展名为.i的预处理后的文件编译成汇编语言（Assembly Language）代码，这个汇编代码是计算机可以理解的中间语言。编译的输出结果通常是一个扩展名为.s的汇编语言代码文件。

3. 汇编（Assembly）：汇编器（Assembler）将扩展名为.s的汇编语言代码文件转换成计算机可执行的机器码（Machine Code）。汇编的输出结果通常是一个扩展名为.o的目标文件。

4. 链接（Linking）：链接器（Linker）将程序中使用到的各个目标文件和库文件（Library）链接成一个完整的可执行文件（Executable File）。器链接的输出结果通常是扩展名为.exe的可执行文件。

• 预处理 选项 gcc -E test.c -o test.i 预处理完成之后就停下来，预处理之后产生的结果都放在test.i文件中。
• 编译 选项 gcc -S test.c 编译完成之后就停下来，结果保存在test.s中。
• 汇编 gcc -c test.c 汇编完成之后就停下来，结果保存在test.o中。  
• 链接 gcc test.o -o test 链接之后就停下来，结果保存在test.o中。
• test.ot和test.exe都是按照 ELF 这种文件的格式来存储的，可通过Linux下的readelf阅读该文件，例如：readelf  test.o -a(显示所有)

符号表：全局变量和函数会形成，局部变量不会形成

2.3 运行环境

程序执行的过程：

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

3. 预处理详解

3.1 预定义符号

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

举个栗子：

#include
int main()
{
	printf("%s\n", __FILE__);
	printf("%d\n", __LINE__);
	printf("%s\n", __DATE__);
	printf("%s\n", __TIME__);
	//printf("%s\n", __STDC__); vs不支持ANSI C
	return 0;
}

运行结果：

3.2 #define

3.2.1 #define 定义标识符

语法： #define name stuff

#define MAX 1000
#define reg register          //为 register这个关键字，创建一个简短的名字
#define do_forever for(;;)     //用更形象的符号来替换一种实现
#define CASE break;case        //在写case语句的时候自动把 break写上。
// 如果定义的 stuff过长，可以分成几行写，除了最后一行外，\
每行的后面都加一个反斜杠(续行符),后面不能有空格。
#define DEBUG_PRINT printf("file:%s\tline:%d\t \
                          date:%s\ttime:%s\n" ,\
                            __FILE__,__LINE__ ,\
                            __DATE__,__TIME__ ) 
int main()
{
    int d = 1;
    switch (d)
    {
    case 1:
    CASE 2 :
    CASE 3 :
    CASE 4 :
    CASE 5 :
            ;//最后一个case语句的分号
        //最后一个case语句可以不用写break
    }
    return 0;
}

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

#define MAX 1000;
#define MAX 1000

建议不要加上 ; ,这样容易导致问题。

if(condition)
    max = MAX;
else
    max = 0;

由于宏定义是直接替换的，所以代码会变成下面情况，会出现语法错误。

if(condition)
    max = 100;
    ;
else
    max = 0;

3.2.2 #define 定义宏

• #define 机制包括了一个规定，允许把参数替换到文本中，这种实现通常称为宏（macro）或定义宏（define macro）。
• 宏的申明方式：
• #define name( parament-list ) stuff   
• 其中的 parament-list 是一个由逗号隔开的符号表，它们可能出现在stuff中。
• 注意： 参数列表的左括号必须与name紧邻。 如果两者之间有任何空白存在，参数列表就会被解释为stuff的一部分。

#include
#define SQUARE(x) x * x     //参数列表的左括号必须与SQUARE紧邻
int main()
{
	printf("%d\n",SQUARE(5));//替换为SQUARE(5) 5 * 5 - 直接替换
    //printf("%d\n", 5 * 5);
	return 0;
}

运行结果：

我们再测试一个：

#include
#define SQUARE(x) x * x     //参数列表的左括号必须与SQUARE紧邻
int main()
{
	int a = 5;
	printf("%d\n", SQUARE(a + 1));
	return 0;
}

运行结果：

• 乍一看，你可能觉得这段代码将打印36这个值。 事实上，它将打印11. 为什么？
• 替换文本时，参数 x 被替换成 a + 1
• 所以这条语句实际上变成了：

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

• 这样就比较清晰了，由替换产生的表达式并没有按照预想的次序进行求值。
• 在宏定义上加上两个括号，这个问题便轻松的解决了：

再来看看下面的情况：

#include
#define DOUBLE(x) (x) + (x)     //参数列表的左括号必须与DOUBLE紧邻
int main()
{
	int a = 5;
	printf("%d\n", 10 * DOUBLE(a));
	return 0;
}

运行结果：

• 这将打印什么值呢？
• 看上去，好像打印100，但事实上打印的是55. 我们发现替换之后： 

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

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

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

2.2.3 #define 替换规则

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

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

注意：

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

3.2.4 #和##

字符串是有自动连接的特点的。

#include
int main()
{
	int a = 10;
	printf("The value of a is %d\n", a);

	int b = 20;
	printf("The value of b is %d\n", b);
	return 0;
}

我们发现上面的代码除了变量和变量的值不同之外，输出模式都是一样，那我们是否可以将打印封装成一个函数呢？

#include
void Print(int value)//假如传入的类型为浮点型呢？
{
    //如何把参数插入到字符串中？
	printf("The value of ？ is %d\n", value);//这里？的地方要怎么写呢？
	//%d - 这样写是不是写死了呢？万一传入是其他类型呢？
}
int main()
{
	int a = 10;
	//printf("The value of a is %d\n", a);
	Print(a);

	int b = 20;
	//printf("The value of b is %d\n", b);
	Print(b);
	return 0;
}

我们发现函数无法实现，那宏呢？如何把参数插入到字符串中？如何传入的类型为浮点型呢？ -  使用 # ，把一个宏参数变成对应的字符串。

#include
#define PRINT(n,format) printf("The value of "#n" is "#format"\n", n)
int main()
{
	int a = 10;
	//printf("The value of a is %d\n", a);
	PRINT(a, "%d");

	int b = 20;
	//printf("The value of b is %d\n", b);
	PRINT(b, "%d");

	float f = 3.14f;
	//printf("The value of f is %f\n", f);
	PRINT(f, "%f");
	return 0;
}

运行结果：

## 的作用

##可以把位于它两边的符号合成一个符号。 它允许宏定义从分离的文本片段创建标识符。

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

3.2.5 带副作用的宏参数

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

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

#include
#define MAX(a, b) ( (a) > (b) ? (a) : (b) )
int main()
{
	int x = 5;
	int y = 8;
	int z = MAX(x++, y++);//使用超过一次带有副作用的参数
	printf("x=%d y=%d z=%d\n", x, y, z);//输出的结果是什么？
}

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

z = ( (x++) > (y++) ? (x++) : (y++));
//     5       8      不执行   执行
//     x = 6   9               z = 9
//                             y = 10

3.2.6 宏和函数对比

宏通常被应用于执行简单的运算。 比如在两个数中找出较大的一个。

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

函数找最大值

int Max(int a, int b)
{
    return x > y ? x : y;
}

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

原因有二：

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

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

#include
//宏的参数可以是数据类型
#define MALLOC(num,type) (type*)malloc(num * sizeof(type))
int main()
{
	//开辟40个字节的空间
	int* pa = (int*)malloc(10 * sizeof(int));

	int* pb = MALLOC(10, int);
	return 0;
}

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

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

宏和函数的一个对比

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

3.2.7 命名约定

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

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

3.3 #undef - 指令用于移除一个宏定义。

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

3.4 命令行定义

        许多C 的编译器提供了一种能力，允许在命令行中定义符号。用于启动编译过程。

例如：当我们根据同一个源文件要编译出一个程序的不同版本的时候，这个特性有点用处。（假定某个 程序中声明了一个某个长度的数组，如果机器内存有限，我们需要一个很小的数组，但是另外一个机器内存大些，我们需要一个数组能够大些。）

#include 
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]);
    }
    printf("\n");
    return 0;
}

编译指令：

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

3.5 条件编译 

        在编译一个程序的时候我们如果要将一条语句（一组语句）编译或者放弃是很方便的。因为我们有条件编译指令。比如说： 调试性的代码，删除可惜，保留又碍事，所以我们可以选择性的编译。

常见的条件编译指令： 

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

2.多个分支的条件编译
#if 常量表达式
//...
#elif 常量表达式
//...
#elif
//...
#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

3.6 文件包含

        我们已经知道， #include 指令可以使另外一个文件被编译。就像它实际出现于 #include 指令的地方 一样。这种替换的方式很简单： 预处理器先删除这条指令，并用包含文件的内容替换。 这样一个源文件被包含10次，那就实际被编译10次。

3.6.1 头文件被包含的方式：

• 本地文件包含

#include "filename.h"

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

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

/usr/include

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

C:\Program Files (x86)\Microsoft Visual Studio 12.0\VC\include
//这是VS2013的默认路径

• 库文件包含

#include 

        查找头文件直接去标准路径下去查找，如果找不到就提示编译错误。 对于库文件也可以使用 “” 的形式包含？ 答案是肯定的，可以。 但是这样做查找的效率就低些，当然这样也不容易区分是库文件还是本地文件了。

3.6.2 嵌套文件包含

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

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

每个头文件的开头写：

#ifndef __TEST_H__
#define __TEST_H__
//头文件的内容
#endif   //__TEST_H__

或者：

#pragma once

总结：

头文件中的 ifndef/define/endif是干什么用的?

        头文件中的 ifndef、define 和 endif 是预处理器指令用于防止头文件的重复包含（避免多重定义）。

        当头文件在多个源文件中被包含时，避免多次包含同一个头文件是很重要的。否则，可能导致重复定义的错误。

这是防止重复包含的常见做法：

1. ifndef (如果未定义)：检查是否已经定义了指定的宏，若未定义则执行下面的代码块。
2. define (定义宏)：定义指定的宏，通常用于避免重复定义。
3. endif (结束条件)：结束条件代码块。

#ifndef MY_HEADER_H
#define MY_HEADER_H

// 声明或定义内容

#endif // MY_HEADER_H

        当第一次包含头文件时，MY_HEADER_H 宏还未定义，因此代码块会被执行，并且定义了该宏。后续再次包含头文件时，ifndef 指令会检查到 MY_HEADER_H 已经被定义，于是避免再次包含头文件中的代码块，从而防止重复定义。

#include 和 #include "filename.h"有什么区别? 

1. #include :

   • 用尖括号括起来的头文件包含指令，通常用于包含标准库的头文件或系统提供的头文件。
   • 编译器会在系统的标准头文件目录中搜索该头文件。只在系统标准头文件目录中搜索，不会覆盖本地头文件。

2. #include "filename.h":

   • 用双引号括起来的头文件包含指令，通常用于包含用户自定义的头文件。
   • 编译器会先在当前源文件所在目录搜索该头文件，如果找不到，再去系统的标准头文件目录中搜索。当有相同名称的头文件同时存在于当前源文件目录和系统标准头文件目录时，优先使用当前源文件目录下的头文件，即本地头文件会覆盖系统标准头文件。

4. 其他预处理指令

• #error
• #pragma
• #line

这里可以去看一下我之前写的文章，里面讲解过：文件包含的本质、预处理符号、# vs ##_笨笨胡小巴的博客-CSDN博客

本章结束啦！！！