预处理深入详解：预定义符号、宏、命名约定、命令行定义、条件编译、头文件的包含

🔥个人主页：艾莉丝努力练剑 🍓专栏传送门：《C语言》 🍉学习方向：C/C++方向 ⭐️人生格言：为天地立心，为生民立命，为往圣继绝学，为万世开太平

前言:前面几篇文章介绍了c语言的一些知识，包括循环、数组、函数、VS实用调试技巧、函数递归、操作符、指针、字符函数和字符串函数、C语言内存函数、数据在内存中的存储、结构体、联合和枚举、动态内存管理、文件操作、编译和链接等，在这篇文章中，我将开始介绍预处理的一些重要知识点！对预处理感兴趣的友友们可以在评论区一起交流学习！

一、预定义符号

C语言设置了一些预定义符号，可以直接使用，预定义符号也是在预处理期间处理的。

都有哪些预定义符号呢？我们在这里展示一下：

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

我们这里举个例子：

printf("file:%s line:%d\n", __FILE__, __LINE__);

我们创建一个文件，写入预定义符号，可以得到这样的效果：

#include<stdio.h>

int main()
{
	printf("%s\n", __FILE__);
	printf("%s\n", __LINE__);
	printf("%s\n", __DATE__);
	printf("%s\n", __TIME__);

	return 0;
}

二、#define定义常量

基本语法：

#define name stuff

举个例子：

#define M 100
#define STR "hehe"
#define reg register
//register - 寄存器

int main()
{
	printf("%d\n", M);
	int a = 5 + M;
	printf("%s\n", STR);

	return 0;
}

再举个例子：

#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__ ) 

思考一下：在define定义标识符的时候，需要不需要在最后加上";"呢？

比如：

#define MAX 1000;
#define MAX 1000

到底要不要加呢？好像加不加都可以，又好像不可以。

这里我们建议不要加;，这样容易导致问题，我们光这样说空口无凭 ，举个例子：

比如下面这种场景：

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

如果是加了分号的情况，等替换后，if和else之间就是两条语句，而没有大括号的时候，if后边只能有一条语句。这里会出现语法错误。

三、宏

（一）#define定义宏

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

下面是宏的声明方式：

#define name ( parament-list ) stuff

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

注意：

参数列表的左括号必须与name紧邻，因为如果两者之间有任何空白存在，参数列表就会被解释为stuff的一部分，结果将大不相同。

举个例子：

#define SQUARE(x) x*x

这里这个宏接受了一个参数x，如果在上述声明之后，我们把SQUARE(10) ; 置于程序中，预处理就会用下面这个表达式替换上面这个表达式了：10*10

警告：这个宏存在一个bug，我们观察下面的代码：

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

粗略一看，你可能会想：这不就是100吗？实际上它打印出来的结果是21！这是为什么呢？

其实，在替换文本的时候，参数x被替换成了a+1，因此这条语句实际上变成了：

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

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

我们只要在宏定义上加上两个括号就能解决问题了：

#define SQUARE(x) (x) * (x)

这样进行预处理之后就能达到我们预期的效果了：

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

此处还有一个宏定义：

#define DOUBLE(x) (x) + (x)

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

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

这次又会打印什么值呢？看上去好像会打印200，但实际上打印的是110，我们发现替换之后：

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

乘法运算先于宏定义的加法，因此出现了110的值。

这个问题有办法解决吗？有的有的。我们只要在宏定义表达式的两边加上一对括号就可以了。

#define DOUBLE(x) ((x)*(x))

注意：

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

（二）带有副作用的宏参数

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

例如：

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

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

#define MAX(a, b) ( (a) > (b) ? (a) : (b) )
...
x = 5;
y = 8;
z = MAX(x++, y++);
printf("x=%d y=%d z=%d\n", x, y, z);//输出的结果是什么？

此处我们得知道预处理之后的结果是什么？

z = (x++) > (y++) ? (x++) : (y++);

因此输出的结果就是：

x=6 y=10 z=9

（三）宏替换的规则

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

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

注意：

1、宏参数和#define定义中可以出现其它#define定义的符号，但对于宏而言，不能出现递归； 2、当预处理搜索#idefine定义的符号的时候，字符串常量的内容并不被搜索。

（四）宏和函数的对比

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

比如要求在两个数中找出比较大的一个的时候，写成下面的宏，会更有优势些：

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

那为什么不用函数来完成呢？其实有两个原因：

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

和函数相比宏的劣势：

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

宏有时候可以做到函数做不到的事情：宏的参数可以出现类型，但函数做不到（正因如此，就导致了上面所说的同函数相比宏的第3个劣势）。

#define MALLOC(num, type)\
 (type )malloc(num sizeof(type))
...
//使用
MALLOC(10, int);//类型作为参数 

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

为了直观地对比宏和函数，这里我们列了一个表格：

四、#和##

（一）#运算符

#运算符将宏的一个参数转换为字符串字面量； 它仅允许出现在带参数的宏的替换列表中； #运算符所执行的操作可以理解为“字符串化”。

当我们有一个变量 int a = 10；的时候 ，我们想打印出：the value of a is 10 的时候就可以这么写：

#define PRINT(n) printf("the value of "#n"is %d",n);

当我们按照下面的方式调用的时候：

PRINT(a);//当我们把a替换到宏的体内时，就出现了#a，而#a就是转换为"a"此时一个字符串代码就会被预处理为 ：

printf("the value of "a" is %d", a);

此时运行代码就能够在屏幕上打印：

the value of a is 10

（二）##运算符

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

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

这里我们思考一下，如果要求写出一个函数以求两个数的较大值的时候，不同的数据类型就得写不同的函数。

打个比方，像是这样：

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

float float_max(float x, float y)
{
	return x > y ? x : y;
}

可这样写起来太繁琐了，现在我们试着这样写代码：

//宏定义 

#define GENERIC_MAX(type) \
type type##_max(type x, type y)\
{ \
 return (x>y?x:y); \
}

友友们还记得吗，这个“\”就是我们前面介绍过的续航符，这里又出现了。

使用宏，定义不同函数：

GENERIC_MAX(int) //替换到宏体内后int##_max 生成了新的符号 int_max做函数名 
GENERIC_MAX(float) //替换到宏体内后float##_max 生成了新的符号 float_max做函数名 

int main()
{
	//调用函数 
	int m = int_max(2, 3);
	printf("%d\n", m);
	float fm = float_max(3.5f, 4.5f);
	printf("%f\n", fm);
	return 0;
}

完整代码演示：

#include<stdio.h>

//宏定义 

#define GENERIC_MAX(type) \
type type##_max(type x, type y)\
{ \
 return (x>y?x:y); \
}

GENERIC_MAX(int) //替换到宏体内后int##_max 生成了新的符号 int_max做函数名 
GENERIC_MAX(float) //替换到宏体内后float##_max 生成了新的符号 float_max做函数名 

int main()
{
	//调用函数 
	int m = int_max(2, 3);
	printf("%d\n", m);
	float fm = float_max(3.5f, 4.5f);
	printf("%f\n", fm);
	return 0;
}

输出结果：

在实际开发过程中##使用的很少，这个例子已经是能举出的相对贴切的例子啦。

五、命名约定

一般来讲，函数和宏的使用语法很类似，因此语言本身没法帮我们区分二者。

我们平时有一个习惯是：

| 把宏名全部大写； | 函数名不要全部大写。

六、#undef

#undef的这条这里用于移除一个宏定义。

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

七、命令行定义

许多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)
	{
		printf("%d", array[i]);
	}
	printf("\n");
	return 0;
}

编译指令：

这里是在linux环境下的演示，在上一篇文章中，我推荐友友们下载VS Code，配置好环境来实现一些代码，这里最好是能和远程的一台机器交互。我们就直接演示指令吧：

//Linux环境演示
gcc - D ARRAR_SIZE = 10 programe.c

八、条件编译

在编译一个程序的时候，我们如果要将一条语句（一组语句）编译或者放弃是非常方便的，因为我们有条件编译指令，比方说：

调试性的代码，删除了可惜，保留下来又碍事，所以我们可以选择性的编译。

代码演示：

#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、情况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

九、头文件的包含

（一）头文件被包含的方式

1、本地文件包含

#include "filename"

查找策略：

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

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

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

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

/usr/include

注意：我们要按照自己的安装路径去找。

2、库文件包含

#include<filename.h>

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

那么这样是不是可以这么说：对于库文件也可以使用""的形式包含了？

没错，可以。只是这样进行查找效率会低一些，而且这样也不容易区分到底是库文件还是本地文件了。

（二）嵌套文件包含

已知，#include指令可以使另外一个文件被编译，就好像它实际出现于#include指令的位置一样。

这种替换的方式其实很简单——预处理器先删除这条指令，并且用包含文件的内容替换。

一个头文件假如被包含了10次，那就是说实际被编译了10次，如果包含重复，对编译的压力就比较大了。代码演示如下：

（1）test.c

#include<test.h>
#include<test.h>
#include<test.h>
#include<test.h>
#include<test.h>
#include<test.h>
#include<test.h>

int main()
{


	return 0;
}

（2）test.h

#pragma once

void test();
struct Stu
{
	int id;
	char name[20];
};

如果我们直接这样写，test.c文件中将test.h包含6次，那么test.h文件的内容将会被拷贝6份在test.c中。如果test.h文件比较大，这样进行预处理后代码量会剧增，假如工程量比较大的话，有公共使用的头文件，大家都可以使用，还不做任何处理，后果不堪设想。

我们在VS环境的编译器下观察可能看不明显，可以在VS Code环境观察：将会看到成百上千行代码，这还只是重复包含了几次，如果这个程序工程量较大的话，比如有两三万行代码，这个代码量是非常大的，后果不堪设想。。。

说完了后果，我们来介绍一下该如何解决头文件被重复引用的问题——答案是：条件编译。

在每个头文件的开头写上这么几行代码：

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

或者：

#pragma once

这样就可以避免头文件的重复引用了：只会包含第一个头文件，剩下的会直接跳过。

十、其他预处理指令

#error
#pragma
#line
...
//其它的预处理指令大家可以自行去了解一下
#pragma pack()//我们在结构体部分介绍过这个，也是预处理指令

大家可以参考 《C语言深度解剖》这本书学习。

结尾

往期回顾：

深入详解编译与链接：翻译环境和运行环境，翻译环境：预编译+编译+汇编+链接，运行环境

【掌握文件操作】（下）：文件的顺序读写、文件的随机读写、文件读取结束的判定、文件缓冲区

【掌握文件操作】（上）：二进制文件和文本文件、文件的打开和关闭、文件的顺序读写

【动态内存管理】深入详解：malloc和free、calloc和realloc、常见的动态内存的错误、柔性数组、总结C/C++中程序内存区域划分

【详解自定义类型：联合和枚举】：联合体类型的声明、特点、大小的计算，枚举类型的声明、优点和使用

【自定义类型：结构体】：类型声明、结构体变量的创建与初始化、内存对齐、传参、位段

结语：本篇文章就到此结束了，本文为友友们分享了预处理相关的一些重要知识点，如果友友们有补充的话欢迎在评论区留言，在这里感谢友友们的关注与支持！