预处理详解_vs 预处理定义

本文主要介绍一些有关预处理的知识，主要有：预定义符号、#define、#undef、命令行定义、

条件编译、文件包含。

目录

一、预定义符号

二、#define

1.#define定义标识符

2.#define 定义宏

3.#define 替换规则

4.#和##

5.带副作用的宏参数

6.宏和函数对比

三、#undef

四、命令行定义

五、条件编译

六、文件包含

1.头文件被包含的方式：

2.嵌套文件包含

---

一、预定义符号

以下这些预定义符号都是语言内置的，我们直接使用即可。

（其中__为两个下划线。）

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

演示：

#include<stdio.h>
int main()
{
    printf("%s\n", __FILE__);
    printf("%d\n", __LINE__);
    printf("%s\n", __DATE__);
    printf("%s\n", __TIME__);
    printf("%s\n", __FUNCTION__);
    //printf("%d\n", __STDC__);  //该符号未定义
}

输出结果：

D:\Microsoft Visual Studio\预处理.c

105
Jul 28 2023
15:13:00
main

上述预定义符号可在日志中使用，记录相应的信息写到文件里。

二、#define

1.#define定义标识符

 代码演示：

#define num 50
#include<stdio.h>
int main()
{
	printf("%d\n", num);
	return 0;
}

输出结果： 50 

其他用法演示如下：

#define reg register //为 register这个关键字，创建一个简短的名字
#include<stdio.h>
int main()
{
	reg int num = 10;
	return 0;
}

#define do_forever for(;;)     //用更形象的符号来替换一种实现
#include<stdio.h>
int main()
{
	do_forever;//即可表示死循环
	return 0;
}

define CASE break;case  //在写case语句的时候自动把 break写上。
#include<stdio.h>
int main()
{
	int i = 1;
	switch (i)
	{
	case 1:         // 等同于     case 1：
		CASE 2 :               //   break; case 2:
			CASE 3 : break;      //        break;case 3: break;
	}
	return 0;
}

// 如果定义的 stuff过长，可以分成几行写，除了最后一行外，每行的后面都加一个反斜杠(续行符)。
#define DEBUG_PRINT printf("file:%s\tline:%d\t \
                          date:%s\ttime:%s\n" ,\
                            __FILE__,__LINE__ ,\
                            __DATE__,__TIME__ )
#include<stdio.h>
int main()
{
    DEBUG_PRINT;
    return 0;
}

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

如：

#define MAX 1000;
#define MAX 1000

#define MAX 1000;
int main()
{
	int i = MAX; // 等同于 int i = 1000; ;
	return 0;
}

一般情况下，加 ; 的语句预处理后可能会出现两个分号结尾，第二分号表示一条空语句。但在如下的场景中会出现语法错误：

#define condition 1
#define MAX 1000;
int main()
{
	int max;
	if (condition)
		max = MAX;//等同于 max = 1000;
	else               //      ;
		max = 0;
 
}

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

2.#define 定义宏

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

下面是宏的声明方式：

 

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

注意：

参数列表的左括号必须与name紧邻。

如果两者之间有任何空白存在，参数列表就会被解释为stuff的一部分。

演示：

#define SQUARE( x ) x * x
#include<stdio.h>
int main()
{
	int n = SQUARE(5);// 置于程序中，预处理器就会用下面这个表达式替换上面的表达式：
	printf("%d\n", n );//   5 * 5
	return 0;
}

例1：

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

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) );

例2：

有一个宏定义：

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

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

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

看上去，好像打印100，但事实上打印的是55。

我们发现替换之后：

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

乘法运算先于宏定义的加法，所以出现了结果：55。

提示：

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

3.#define 替换规则

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

① 在调用宏时，首先对参数进行检查，看看是否包含任何由#define定义的符号。如果是，它们首先 被替换。

② 替换文本随后被插入到程序中原来文本的位置。对于宏，参数名被他们的值替换。

③ 最后，再次对结果文件进行扫描，看看它是否包含任何由#define定义的符号。如果是，就重复上 述处理过程。

注意：

① 宏参数和#define 定义中可以出现其他#define定义的变量。但是对于宏，不能出现递归。

② 当预处理器搜索#define定义的符号的时候，字符串常量的内容并不被搜索。

4.#和##

1.#

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

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

#include<stdio.h>
int main()
{
	char* p = "hello ""world";
	printf("hello ""world\n");
	printf("%s\n", p);
	return 0;
}

输出结果：

hello world
hello world

我们可以发现：发现字符串是有自动连接的特点的。

那我们可以写这样的代码：

#define PRINT(FORMAT, VALUE) printf("the value is "FORMAT"\n", VALUE)
int main()
{
	PRINT("%d", 10);
	return 0;
}

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

使用 # ，也可以把一个宏参数变成对应的字符串：

#define PRINT(FORMAT, VALUE)  printf("the value of " #VALUE " is "FORMAT "\n", VALUE)
#include<stdio.h>
int main()
{
	int i = 10;
	PRINT("%d", i + 3);
	return 0;
}

输出结果：the value of i + 3 is 13

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

2.##的作用

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

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

例：

#define ADD_TO_SUM(num, value) sum##num += value
#include<stdio.h>
int main()
{                      
	ADD_TO_SUM(5, 10);//作用是：给sum5增加10
	return 0;         //sum5 此时未定义 
}

注意：

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

#define CAT(name,num) name##num
int main()
{
	int ab123 = 100;
	printf("%d\n", CAT(ab, 123));
	return 0;
}

输出结果：100

5.带副作用的宏参数

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

例如：

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

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

#define MAX(a, b) ( (a) > (b) ? (a) : (b) )
int main()
{
	int x, y, z;
	x = 5;
	y = 8;
	z = MAX(x++, y++);
	printf("x=%d y=%d z=%d\n", x, y, z);
	return 0;
}

此时：

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

输出结果：x=6 y=10 z=9

6.宏和函数对比

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

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

原因：

① 用于调用函数和从函数返回的代码可能比实际执行这个小型计算工作所需要的时间更多。所以宏比 函数在程序的规模和速度方面更胜一筹。

② 更为重要的是函数的参数必须声明为特定的类型。所以函数只能在类型合适的表达式上使用。反之 这个宏怎可以适用于整形、长整型、浮点型等可以用于>来比较的类型。宏是类型无关的。

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

① 每次使用宏的时候，一份宏定义的代码将插入到程序中。除非宏比较短，否则可能大幅度增加程序的长度。

② 宏是没法调试的。

③ 宏由于类型无关，也就不够严谨。

④ 宏可能会带来运算符优先级的问题，导致程容易出现错。

宏有时候可以做函数做不到的事情。

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

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

宏和函数的一个对比：

命名约定：

一般来讲函数的宏的使用语法很相似。所以语言本身没法帮我们区分二者。

① 把宏名全部大写。

② 函数名不要全部大写。

三、#undef

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

代码演示：

#define MAX 100
int main()
{
	int a = MAX;
#undef MAX
	int b = MAX;//此时MAX定义已被移除
	return 0;
}

四、命令行定义

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

在Linux环境下：

编译指令：gcc -D ARRAY_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__ //判断是否定义__DEBUG__
		printf("%d\n", arr[i]);//为了观察数组是否赋值成功。 
#endif //结束
	}
	return 0;
}

如果没有定义__DEBUG__，#ifdef 与 #endif 之间的语句不会被编译。

常见的条件编译指令：

1.常量表达式

#if 常量表达式
 //...
#endif

#include <stdio.h>
#define __DEBUG__  0
int main()
{
	int i = 0;
	int arr[10] = { 0 };
	for (i = 0; i < 10; i++)
	{
		arr[i] = i;
#if __DEBUG__
		printf("%d\n", arr[i]);//为了观察数组是否赋值成功。 
#endif 
	}
	return 0;
}

2.多个分支的条件编译

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

#define DEBUG 1
int main()
{
#if DEBUG == 1
	printf("111");
#elif DEBUG ==2 
	printf("2222");
#else
	printf("3333");
#endif
	return 0;
}

3.判断是否被定义

//判断是否被定义
#if defined(symbol)
#ifdef symbol
#if !defined(symbol)
#ifndef symbol

#include<stdio.h>
#define DEBUG 1
int main()
{
#if defined DEBUG   //等同于 #ifdef DEBUG
	printf("111");
#endif
 
#if !defined DEBUG  //等同于 #ifndef DEBUG
	printf("2222");
#endif
	return 0;
}

4.嵌套指令

与if语句的嵌套相似

//嵌套指令
#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

六、文件包含

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

这种替换的方式很简单：

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

1.头文件被包含的方式：

本地文件包含：

#include "filename"

查找策略：

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

库文件包含：

#include <filename.h>

查找策略：

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

这样是不是可以说，对于库文件也可以使用 “ ” 的形式包含？

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

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__

如果没有定义__TEST_H__  则定义，如果已经定义则不编译 #ifndef 到 #endif 之间的内容。

或者：

#pragma once  //让头文件即使被包含多次，也只包含一份

就可以避免头文件的重复引入。