C语言基础:(二十五)预处理详解

目录

前言

一、预处理符号

[二、#define 定义常量](#define 定义常量)

[三、#define 定义宏](#define 定义宏)

四、带有副作用的宏参数

五、宏替换的规则

六、宏函数对比

[七、# 和 ##](# 和 ##)

7.1 #运算符

7.2 ##运算符

八、命名约定

九、#undef

十、命令行定义

十一、条件编译

十二、头文件的包含

[12.1 头文件被包含的方式](#12.1 头文件被包含的方式)

[12.1.1 本地文件包含](#12.1.1 本地文件包含)

[12.1.2 库文件包含](#12.1.2 库文件包含)

[12.2 嵌套文件包含](#12.2 嵌套文件包含)

十三、其他预处理指令

注意:

总结


前言

在C语言开发中,预处理阶段是编译过程中不可或缺的关键环节,它通过宏替换、条件编译和文件包含等机制,为代码的灵活性和可维护性提供了强大的支持。预处理指令虽然不直接参与程序运行,却在代码组织、跨平台适配以及性能优化等方面发挥着重要作用。深入理解预处理的工作原理与高级用法,不仅能帮助开发者规避潜在的宏陷阱,还能解锁诸如代码生成、调试控制等进阶技巧。下面就让我们正式开始吧!


一、预处理符号

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

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

举个使用的例子:

cpp 复制代码
printf("file:%s line:%d\n", __FILE__, __LINE__);

二、#define 定义常量

基本语法如下:

cpp 复制代码
#define name stuff

我们再来举一些使用的例子:

cpp 复制代码
#define MAX 1000               //定义一个常量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定义标识符的时候,要不要在最后加上 ";"?

比如:

cpp 复制代码
#define MAX 1000;
#define MAX 1000

建议不要加上";",这样容易导致问题。比如下面的场景:

cpp 复制代码
if(condition)
    max = MAX;
else
    max = 0;

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

三、#define 定义宏

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

以下是宏的申明方式:

cpp 复制代码
#define name( parament-list ) stuff

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

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

下面我们依旧来举个例子:

cpp 复制代码
#define SQUARE( x ) x * x

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

**注意:**上面这个宏其实存在一个问题,我们先来观察一下下面的代码段:

cpp 复制代码
int a = 5;
printf("%d\n" ,SQUARE( a + 1) );

乍一看,你或许会觉得这段代码将打印36,实际上它将打印11,这是为什么呢?

在替换文本的时候,参数x被替换成了a+1,所以这条语句实际上变成了:

cpp 复制代码
printf ("%d\n",a + 1 * a + 1 );

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

不过,我们只需要在宏定义上加两个括号,就可以轻松解决这个问题了:

cpp 复制代码
#define SQUARE(x) (x) * (x)

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

cpp 复制代码
printf ("%d\n",(a + 1) * (a + 1) );

再来看下面这个宏定义:

cpp 复制代码
#define DOUBLE(x) (x) + (x)

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

cpp 复制代码
int a = 5;
printf("%d\n" ,10 * DOUBLE(a));

这将打印出什么值呢?看上去好像打印的会是100,但事实上并非如此,而是55。

我们可以发现在替换之后:

cpp 复制代码
printf ("%d\n",10 * (5) + (5));

乘法运算是优先于宏定义的加法的,所以最后出现了10 * 5 + 5 = 55。

要想解决这个问题,只需要在宏定义表达式两边加上一对括号:

cpp 复制代码
#define DOUBLE(x) ( ( x ) + ( x ) )

下面是一些提示:

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

四、带有副作用的宏参数

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

例如:

cpp 复制代码
x+1;//不带副作⽤
x++;//带有副作⽤

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

cpp 复制代码
#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);//输出的结果是什么?

我们经过分析后,可以知道预处理器处理之后的结果是:

cpp 复制代码
z = ( (x++) > (y++) ? (x++) : (y++));

所以输出的结果为:x = 6 y = 10 z = 9

五、宏替换的规则

在程序中扩展#define定义符号和宏时,需要涉及以下几个步骤:

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

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

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

注意:

  1. 宏参数和#define定义中可以出现其他#define定义的符号。但是对于宏,不能出现递归。

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

六、宏函数对比

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

比如在两个数中找出较大的一个时,写成下面的宏,会更有优势一些:

cpp 复制代码
#define MAX(a, b) ((a)>(b)?(a):(b))

那么为什么我们不用函数来完成这个任务呢?

原因有以下两个:

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

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

宏和函数相比的劣势:

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

  2. 宏是没办法调试的。

  3. 宏由于类型无关,也就不够严谨。

  4. 宏可能会带来运算符优先级的问题,导致程序容易出现错误。

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

cpp 复制代码
#define MALLOC(num, type)\
(type )malloc(num sizeof(type))
...
//使⽤
MALLOC(10, int);//类型作为参数

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

宏和函数的一个对比:

七、# 和

7.1 #运算符

#运算符将宏的一个参数转换为字符串字面量。它仅允许出现在带参数的宏的替换列表中。

#运算符所执行的操作可以理解为**"字符串化"**。

当我们有一个变量 int a = 10; 的时候,我们想打印出:the value of a if 10,那么可以写:

cpp 复制代码
#define PRINT(n) printf("the value of "#n " is %d", n);

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

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

cpp 复制代码
printf("the value of ""a" " is %d", a);

运行上述代码就能在屏幕上打印:

cpp 复制代码
the value of a is 10

7.2 ##运算符

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

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

这里我们来想想,要写一个函数求两个数的较大值的时候,不同的数据类型就得写不同的函数。如下所示:

cpp 复制代码
int int_max(int x, int y)
{
    return x > y ? x : y;
} 

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

但是这样写起来太繁琐了,我们可以试试这样写:

cpp 复制代码
//宏定义
#define GENERIC_MAX(type)      \
type type##_max(type x, type y)\
{                              \
    return (x>y?x:y);          \
}

这样我们就可以使用宏来定义不同的函数:

cpp 复制代码
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;
}

输出结果如下所示:

cpp 复制代码
3 
4.500000

在实际开发过程中,##使用的很少,这里我们就不过多举例了。

八、命名约定

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

那么我们一般有以下命名习惯:

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

九、#undef

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

cpp 复制代码
#undef NAME
//如果现存的⼀个名字需要被重新定义,那么它的旧名字⾸先要被移除。

十、命令行定义

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

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

来看一段代码示例:

cpp 复制代码
#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;
}

编译指令如下:

cpp 复制代码
//linux 环境演⽰
gcc -D ARRAY_SIZE=10 programe.c

十一、条件编译

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

比如我们来看下面这段代码:

cpp 复制代码
#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;
}

上述作为一段调试性的代码,删除又可惜,保留又碍事,那么我们就可以利用条件编译指令来选择性地编译。

常见的条件编译指令如下:

cpp 复制代码
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.1 头文件被包含的方式

12.1.1 本地文件包含

cpp 复制代码
#include "filename"

本地文件的查找策略:

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

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

cpp 复制代码
/usr/include

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

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

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

12.1.2 库文件包含

cpp 复制代码
#include <filename.h>

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

那么这样是不是就可以说,对于库文件我们也可以使用**" "** 的形式来包含?

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

12.2 嵌套文件包含

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

这种替换的方式很简单:预处理指令先删除这条指令,并用包含文件的内容替换。

一个头文件被包含10次,那就会实际被编译10次,如果重复包含,那么对编译的压力就会比较大。

如下我们来展示两个test.c和test.h文件:

cpp 复制代码
//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文件比较大的话,预处理后的代码量就会剧增。如果工程比较大,并且有公共使用的头文件,能被大家使用,又不做任何的处理, 那么后果将会不堪设想。

那么我们如何解决头文件被重复引入的问题呢?答案是:条件编译

我们可以在每个头文件的开头这样写:

cpp 复制代码
#ifndef __TEST_H__
#define __TEST_H__
//头⽂件的内容
#endif //__TEST_H__

或者这样写:

cpp 复制代码
#pragma once

这两种写法都可以避免头文件的重复引入。

注:博主在这给大家推荐《高质量C/C++编程指南》中附录的考试试卷,里面有两道笔试题非常值得大家仔细思考一下。

即:

  1. 头文件中的ifdef/define/endif是干什么用的?

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

十三、其他预处理指令

cpp 复制代码
#error
#pragma
#line
...

#pragma pack()在结构体部分介绍。
预处理指令 作用描述 典型使用场景或示例
#error 在编译时产生一个错误信息,并立即终止编译过程。 用于检查不满足的编译条件,防止生成无效代码。 示例: #ifndef __STDC__ #error "This compiler is not ANSI C compliant!" #endif
#pragma 向编译器发出特殊的命令或指示,用于设定编译器的状态或指定编译器的特定操作。 (注意:其效果高度依赖于具体的编译器) 用于控制内存对齐、注释库文件、禁用特定警告等。 示例: #pragma once // (非标准但广泛支持) 用于头文件防止重复包含 #pragma pack(1) // 设置结构体对齐为1字节 #pragma warning(disable: 4996) // (MSVC) 禁用编号为4996的警告
#line 修改编译器在编译过程中记录的当前行号和文件名。 主要用于代码生成工具(如lex/yacc),使编译器错误信息指向原始输入文件,而不是生成的中间C文件。 示例: #line 42 "my_source.txt" // 将下一行的行号设为42,文件名设为"my_source.txt"

注意:

  • #error:是一个强制性的编译停止指令,用于在预处理阶段强制抛出错误。

  • #pragma :几乎所有的功能都由具体的编译器定义,不属于C语言标准的一部分,因此需要查阅特定编译器的文档。_Pragma 操作符 (C99) 提供了另一种更类似于宏的方式来执行 #pragma 的功能。

  • #line:主要用于调整编译器在报告错误和调试信息时使用的行号和文件名,对程序逻辑没有影响。

要想深入了解这些预处理指令,可以参考书目《C语言深度解剖》来进行学习。


总结

以上就是本期博客的全部内容啦!本期也是博主C语言基础系列专栏的最后一期博客,从下期开始,博主将正式开始更新数据结构的相关内容,敬请期待!