【C/C++】你了解预处理吗?带你深度剖析#define定义宏

简介: 【C/C++】你了解预处理吗?带你深度剖析#define定义宏

目录


1.预定义符号

2.#define

2.1#define定义标识符

2.2#define定义宏

2.3#define的替换规则

2.4#和##

2.5带副作用的宏参数

2.6宏和函数的对比

命名约定

3.undef

4.命令行定义

5.条件编译

6.文件包含

6.1头文件被包含的方式

①本地文件包含

②库文件包含

6.2嵌套文件包含

7.其他预处理指令


正文


1.预定义符号


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

这些预定义符号都是C语言内置的。

输出一下这些预定义符号:

#include<stdio.h>
int main()
{
  printf("%s\n", __FILE__);
  printf("%d\n", __LINE__);
  printf("%s\n", __DATE__);
  printf("%s\n", __TIME__);
  return 0;
}

22223.png


2.#define


2.1#define定义标识符


#define定义标识符在我们平时写代码的过程中经常运用,例如:

1.#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;

如果加上 ; 可能会引发这样的问题:

#define MAX 100;
int main()
{
  int a = 0;
  int max = 0;
  if (a == 0)
    max = MAX;
  else
    max = 0;
  return 0;
}

212.png

其原因在于在预编译时,MAX会被替换为100; 而不是100,预编译后,编译器得到的代码实际上是这个样子的:

int main()
{
  int a = 0;
  int max = 0;
  if (a == 0)
    max = 100;;//注意
  else
    max = 0;
  return 0;
}

所以为了避免这样的语法问题,尽量不用在末尾加;。


2.2#define定义宏


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

下面是宏的声明方式:

#define name(parament-list) stuff


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

注意:

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

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

例如:

#define SQUARE(x) x*x

这个宏可以接收一个参数x

这时,我们将如下代码置于程序中

SQURE(5);

在程序预处理阶段,就会被编译器替换为这样的语句:

5*5

代码实现:

#define SQUARE(x) x*x
int main()
{
  printf("%d\n", SQUARE(5));
  return 0;
}

image.png

到这里,看似很完美的思路实际上是存在漏洞的。

再来一组用例:

SQUARE(5+1);

结果如下:

333.png

乍一看,你可能觉得这段代码将打印36这个值,但是结果却是11

仔细分析一下,在替换文本时,参数x被替换为5+1,所以这条语句实际上变成了:

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

所以想要严谨一点,最好在宏定义上加上两个括号:

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

类似的,还有:

#define DOUBLE(X) ((x)+(x))   //双层括号  避免如5*x+x

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


2.3#define的替换规则


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

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

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

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

注意

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

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


2.4#和##


假设我们现在想定义一个具有打印功能的宏 PRINT

首先我们得认知到字符串是有自动连接的功能的,例如:

printf("Hello ""World""!");

image.png

那么我们的宏PRINT是否可以这样完成:

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


很显然这种写法是错误的:

4443.png

正确的做法:

#define PRINT(FORMAT,VALUE) printf("the value is "FORMAT"\n",VALUE);

66.png

这里只有当字符串作为宏参数的时候,才可以把字符串放在字符串中

当然,除此之外,还有另外一个技巧是:

使用 # ,把一个宏参数变成对应的字符串

比如:

1. #define PRINT(FORMAT,VALUE)\
2.      printf("the value of "#VALUE " is "FORMAT"\n", VALUE)

image.png

同样的,

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

667.png

##的作用

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

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

例如:

#define ADD_TO_SUM(num, value)\
    sum##num += value
int main()
{
  int sum5 = 0;
  ADD_TO_SUM(5, 10);//作用是:给sum5增加10.
  return 0;
}


2.5带副作用的宏参数


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

例如:

1. x+1;  //不带副作用
2. 
3. x++;  //带副作用

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

#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);//输出的结果是什么?
    return 0;
}

经过预处理之后,实际上代码是这个样子:

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

运行之后:

2345.png

是否如同你所料呢?


2.6宏和函数的对比


宏经常被应用于简单的运算。比如在两个数中找出最大的一个。

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

原因有两个:


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

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


当然宏和函数相比还有劣势的地方:


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

2.宏是没办法调试的。

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

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


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

例如:

#define MALLOC(num, type)\
    (type*)malloc(num * sizeof(type))
int main()
{
    int* newNode=MALLOC(10, int);//类型作为参数
    return 0;
}


预编译后的代码:

int* newNode = (int*)malloc(10 * sizeof(int));

宏和函数的一个对比

属性 #define定义宏 函数



每次使用时,宏代码都会被插入到程序中。除了非常小的宏之外,程序的长度会大幅度增长

函数代码只出现在一个地方;每次使用这个函数时,都调用那个地方的 同一份代码。



更快 存在函数的调用和返回的额外开销,所以相对慢一些。





宏参数的求值是在所有周围表达式的上下文环境里,除非加上括号,否则邻近操作符的优先级可能会产生不可预料的后果,所以建议在定义宏的时候多加上些括号。 函数参数只在函数调用的时候求
值一次,它的结果值传递给函
数。表达式的求值结果更容易预
测。







参数可能被替换到宏体中的多个位置,所以带有副作用的参数求值可能会产生不可预料的结果。 函数参数只在传参的时候求值一
次,结果更容易控制。



宏的参数与类型无关,只要对参数的操作是合法的,它就可以使用于任何参数类型。 函数的参数是与类型有关的,如
果参数的类型不同,就需要不同
的函数,即使他们执行的任务是
不同的。

宏是不方便调试的 函数是可以逐语句调试的

宏是不能递归的 函数是可以递归的


命名约定


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

那我们平时的一个习惯是:

把宏名全部大写

函数名不要全部大写


3.undef


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

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

例如:

#define MAX 100
int main()
{
  printf("%d\n", MAX);//此时正常使用
#undef MAX
  printf("%d", MAX);  //此时会报错
  return 0;
}


4.命令行定义


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


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


(Linux环境下实现)

image.png

编译的时候指定MAX=10

765.png

编译的时候指定MAX=20

766.png


5.条件编译


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

例如:

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

#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;
}

#ifdef:如果定义了某个内容,就执行。

#endif:结束ifdef。

常见的条件编译指令:

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


6.文件包含


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

这种替换的方式很简单:

预处理器先删除这条指令,并用包含文件的内容替换。

这样一个源文件被包含10次,那就实际被编译10次。


6.1头文件被包含的方式


①本地文件包含


#include "filename"

查找策略:先在源文件所在目录下查找,如果该头文件未找到,编译器就像查找库函数头文件一样在标准位置查找头文件。


如果找不到就提示编译错误。


Linux的标准头文件的路径:

/usr/include

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

C:\Program Files (x86)\Microsoft Visual Studio 12.0\VC\include

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


②库文件包含


#include<filename.h>

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

这样是不是可以说,对于库文件也可以用 " " 的形式包含?

答案是可以。

但是这样做查找的效率低些,当然这样也不容易区分是库文件和本地文件了。


6.2嵌套文件包含


如果出现这样的场景:

776.png

comm.h和comm.c是公共模块。

test1.h和test1.c使用了公共模块。

test2.h和test2.c使用了公共模块。

test.h和test.c使用了test1模块和test2模块。

这样最终程序中就会出现两份comm.h的内容。这样就造成了文件内容的重复。

如何j解决这个问题?

答案:条件编译

在每个文件的开头这样写:

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

或者:

#pragma once

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


7.其他预处理指令


#error
#pragma
#line
...

本文参考书籍:《C语言深度解剖》

目录
相关文章
|
7月前
|
C++
C++中类的定义与使用
C++中类的定义与使用
194 2
|
1月前
|
存储 编译器 Linux
【c++】类和对象(上)(类的定义格式、访问限定符、类域、类的实例化、对象的内存大小、this指针)
本文介绍了C++中的类和对象,包括类的概念、定义格式、访问限定符、类域、对象的创建及内存大小、以及this指针。通过示例代码详细解释了类的定义、成员函数和成员变量的作用,以及如何使用访问限定符控制成员的访问权限。此外,还讨论了对象的内存分配规则和this指针的使用场景,帮助读者深入理解面向对象编程的核心概念。
89 4
|
7月前
|
C++
C++程序中的类声明与对象定义
C++程序中的类声明与对象定义
85 1
|
2月前
|
存储 编译器 C语言
C++入门2——类与对象1(类的定义和this指针)
C++入门2——类与对象1(类的定义和this指针)
45 2
|
2月前
|
C++
C++番外篇——对于继承中子类与父类对象同时定义其析构顺序的探究
C++番外篇——对于继承中子类与父类对象同时定义其析构顺序的探究
63 1
|
3月前
|
C++
HTML+JavaScript构建一个将C/C++定义的ANSI字符串转换为MASM32定义的DWUniCode字符串的工具
HTML+JavaScript构建一个将C/C++定义的ANSI字符串转换为MASM32定义的DWUniCode字符串的工具
|
5月前
|
编译器 C++ 运维
开发与运维函数问题之函数的返回类型如何解决
开发与运维函数问题之函数的返回类型如何解决
41 6
|
4月前
|
编译器 C++
【C/C++学习笔记】C++声明与定义以及头文件与源文件的用途
【C/C++学习笔记】C++声明与定义以及头文件与源文件的用途
60 0
|
4月前
|
JSON Android开发 数据格式
Android c++ core guideline checker 应用问题之JSON compilation database的定义如何解决
Android c++ core guideline checker 应用问题之JSON compilation database的定义如何解决
|
5月前
|
机器学习/深度学习 PyTorch 算法框架/工具
C++多态崩溃问题之在PyTorch中,如何定义一个简单的线性回归模型
C++多态崩溃问题之在PyTorch中,如何定义一个简单的线性回归模型