【C语言】预处理详解

---

前言

提示：这里可以添加本文要记录的大概内容：
在C语言中，预处理阶段是代码执行之前的一个重要步骤，负责对源代码进行宏替换、条件编译等处理。预处理器提供了强大的工具，使得我们能够在编写代码时更加灵活、高效。本博客将深入探讨C语言预处理的基本概念、常见指令以及它们在代码中的应用。通过了解预处理的机制，我们可以更好地理解C语言代码背后的运作原理，提高代码的可维护性和可读性。

---

提示：以下是本篇文章正文内容，下面案例可供参考

1. 预处理符号

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

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

预定义符号示例：

预定义符号是由编译器提供的一些预先定义的宏，用于获取关于编译环境、代码结构以及版本信息等有用的信息。以下是一些常见的预定义符号及其示例：

// 文件：example.c

#include 

int main() {
    // __FILE__：当前源文件名
    printf("File: %s\n", __FILE__);

    // __LINE__：当前源文件中的行号
    printf("Line: %d\n", __LINE__);

    // __DATE__：源文件的编译日期
    printf("Date: %s\n", __DATE__);

    // __TIME__：源文件的编译时间
    printf("Time: %s\n", __TIME__);

    // __cplusplus：用于检测C++编译器
    #ifdef __cplusplus
        printf("Compiled as C++\n");
    #else
        printf("Compiled as C\n");
    #endif

    return 0;
}

在这个示例中，__FILE__ 表示当前源文件名，__LINE__ 表示当前源文件中的行号，__DATE__ 表示源文件的编译日期，__TIME__ 表示源文件的编译时间。此外，__cplusplus 可用于检测当前是否为C++编译环境。

这些预定义符号可以在编写代码时提供有用的信息，例如记录日志、调试代码或实现跨平台的条件编译。通过利用这些符号，我们能够在不同的编译环境中编写更具灵活性和可移植性的代码。

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

思考一个问题，在使用#define 定义常量的时候，需不需要再最后加上分号？？？
比如：

#define MAX 100
#define MAX 100;

答案是最好不好加上分号，因为容易出现问题
来看接下来的一个场景

#include 
#define MAX 100;
int main() {
    int condition = 10l;
    int max = 0;
    if (condition)
        max = MAX;
    else
        max = MAX;
    return 0;
}

编译通不过

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

3. #define 定义宏

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

#define name( parament-list ) stuff

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

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

举例说明

#define MUL(x) x*x

这个宏接收一个参数x。如果在上述声明之后，你把MUL(5)置于程序中，预处理器就会用下面这个表达式替换上面的表达式：5 * 5

宏定义在C语言中是一种强大的工具，可以用于创建简单的代码替换，但它们也可能导致一些问题。以下是一些宏定义可能出现的问题，以及相应的详细解释：

1. 缺乏括号的问题：

   #define SQUARE(x) x * x
   

   这个宏定义用于计算一个数的平方，但在使用时可能导致错误，例如 result = SQUARE(2 + 3) 展开后变成 result = 2 + 3 * 2 + 3，而不是期望的 result = (2 + 3) * (2 + 3)。为了解决这个问题，宏定义应该使用括号确保运算顺序。

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

2. 副作用问题：

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

   这个宏定义用于获取两个数的最大值，但当在宏中使用带有副作用的表达式时，可能导致不符合预期的结果。例如，MAX(x++, y++) 会导致 x 和 y 的增量执行多次。解决这个问题的方法是避免使用带有副作用的表达式作为宏的参数。

3. 名称冲突问题：

   #define PI 3.14159
   

   如果在程序中有其他地方也使用了 PI 这个名称，可能导致冲突。为了避免这种问题，可以使用更具描述性的名称或使用命名空间。

4. 可读性问题：

   #define LOOP for(int i=0; i<10; i++)
   

   尽管这样的宏定义可以减少代码行数，但可读性较差，特别是在调试和维护代码时。使用宏定义时应考虑代码的可读性，以确保其他开发人员能够轻松理解和维护代码。

5. 不带括号的参数：

   #define SQUARE(x) x * x
   

   如果在宏定义中使用了参数，而调用时未使用括号将参数括起来，可能导致宏展开时出现意外的结果。为了防范这种情况，调用宏时应确保使用括号将参数括起来。

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

4. 带有副作用的宏参数

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

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

来看下面这个带有副作用的宏参数

#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

5. 宏替换的规则

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

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

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

6. 宏和函数的对比

宏通常被应用于执行简单的运算。
比如在两个数中找出较大的⼀个时，写成下面的宏，更有优势⼀些。

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

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

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

和函数相比宏的劣势：

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

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

#include 
#include 
#define MALLOC(num,type)\//使⽤类型作为参数
(type*)malloc(num*sizeof(type))
int main()
{
    MALLOC(10, int);//预处理器替换之后：(int*)malloc(10*sizeof(int))
    return 0;
}

7. #和##

#运算符

#运算符将宏的⼀个参数转换为字符串字面量。它仅允许出现在带参数的宏的替换列表中。#运算符所执行的操作可以理解为”字符串化“。
当我们有⼀个变量 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

##运算符

##可以把位于它两边的符号合成一个符号，它允许宏定义从分离的文本片段创建标识符。##被称为记号粘合
这样的连接必须产生一个合法的标识符。否则结果就是未定义的。
这里我们想想，写一个函数求2个数的较大值的时候，不同的数据类型就得写不同的函数。
比如：

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

但是这样写过于繁琐，我可以尝试利用##运算符

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

完整代码

//宏定义
#define GENERAL_MAX(type) \
type type##_max(type x, type y)\
{ \
 return (x>y?x:y); \
}
GENERAL_MAX(int)//函数int_max的定义
GENERAL_MAX(float)//函数float_max的定义
#include 
int main()
{
    int ret1 = int_max(5, 10);
    float ret2 = float_max(8.8f, 9.9f);
    printf("%d %f", ret1, ret2);
    return 0;
}

在实际开发过程中##使⽤的很少，很难取出⾮常贴切的例⼦

8. 命名约定

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

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

9. #undef

这个指令用于移除一个宏定义

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

举例：

#define NUM 100
#include 
int main()
{
	printf("%d\n", NUM);
#undef NUM
	//printf("%d", NUM);   此处会报错，因为宏定义已经被取消了
#define NUM 200
	printf("%d\n", NUM);//重新定义了名字一样的一个宏
	return 0;
}

10. 命令行定义

许多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

11. 条件编译（即选择性编译）

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

常见的条件编译指令：

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

12. 头文件的包含

头文件被包含的方式

本地文件包含

#include "filename"

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

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

/usr/include

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

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

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

库文件包含

#include 

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

嵌套文件的包含

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

来看接下来这种情况：

test.c中

#include "test.h"
#include "test.h"
#include "test.h"
#include "test.h"
#include "test.h"
int main()
{
 	return 0;
}

test.h中

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

**如果直接这样写，test.c文件中将test.h包含5次，那么test.h文件的内容将会被拷贝5份在test.c中。如果test.h 文件比较大，这样预处理后代码量会剧增。如果工程比较大，有公共使用的头文件，被大家都能使用，又不做任何的处理，那么结果不堪设想。
如何解决头文件被重复引入的问题？答案：条件编译。
**

每个头文件的开头写：

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

或者

#pragma once

这样就可以避免头文件的重复引入了

总结

C语言预处理阶段虽然在整个编译过程中占据了短暂的时间，但它对于代码的整体质量和可维护性却有着深远的影响。通过巧妙地使用宏、条件编译等预处理指令，我们能够实现代码的重用、提高代码的灵活性，并在不同平台或不同情境下进行定制化的编译。在本文中，我们深入剖析了预处理的基本概念和常见用法，希望读者能够对C语言中这一重要阶段有更清晰的认识，从而在编写代码时更加得心应手。通过灵活运用预处理器，我们可以更高效地编写出结构良好、易维护的C代码。