再谈C语言宏定义

再谈C语言宏定义

目录

• 再谈C语言宏定义
  • 简单的宏定义
• define
  • 带参数宏定义
• define
  • 宏定义中的#和##运算符
    • #运算符
    • ##运算符
  • 删除宏定义
  • 常用预定义宏

简单的宏定义

1. 简单宏定义格式

   [关键字] [标识符]	[替换列表]
   

   • 关键字

     define

   • 标识符

     需要符合C语言变量命名标准

   • 替换列表

     是一系列的C语言记号，包括标识符、关键字、数字、字符常量、字符串字面量、运算符和标点符号等（注意替换列表可以为空，即简单宏可以只包含[关键字]和[标识符]）。

2. 预编译过程对简单宏定义的处理

   当预处理器遇到第一个宏定义时，会做一个【标识符】代表【替换列表】的记录。在文件后面的内容中，不管标识符在代码的任何位置出现，预处理器都会用【替换列表】去代替【标识符】，即把宏编译到【标识符】所在的当前行。

3. 简单宏定义常规用途

   简单宏定义一半用在给常量命名

4. 示例（一般我们都习惯使用大写来表示【标识符】）

   #define N     100
   #define TRUE  1
   #define FALSE 0
   

5. 用宏定义对常量进行命名的好处

   • 程序会更容易阅读。一个有意义的命名可以帮助阅读者理解常量的意义，否则，程序中包含大量的"魔法数"，会让读者难于理解。

   • 可以帮助避免前后不一致或者键盘输入错误。例如数值常量3.14159在程序中大量出现，它可能会被意外的写成3.1516或者3.14195，这样就可能导致前后计算结果不一致。

   • 对类型进行重命名。例如，我们可以对unsigned char重命名为BYTE，这样书写上就可以简短一点，而且意义明确。

   • 控制条件编译。例如，在程序中出现的宏定义可能表明需要将程序在"调试模式下"进行编译，来使用额外的语句输出调试信息，在嵌入式开发中很常见。

     #define DEBUG
     
     #ifndef DEBUG
     #define LOG_ERROR()
     #else
     #define LOG_ERROR(format, ...) {printf(format"
     ", ##__VA_ARGS__);}
     #endif
     

---

带参数宏定义

1. 带参宏格式

   [关键字] [标识符](x1,x2,...,xn) [替换列表]
   

   • 关键字

     define

   • 标识符(参数列表)

     在简单宏的基础上，增加了参数列表，参数列表中的参数可以是英文字母或者是已经预定义好的宏，但是不能是关键字（注意：参数列表可以为空）。

   • 替换列表

     可以是数字、字母、语句块等等。

2. 预编译过程如何处理带参宏

   预处理器遇到一个带参数的宏，会将定义存储起来以便后续使用。在后面的程序中，如果任何地方出现了[标识符] (y1,y2,...,yn)格式的宏调用，预处理器会使用[替换列表]代替，并使用y1代替x1，有代替x2，以此类推。

3. 示例

   假设我们定义了如下的宏：

   #define MAX(x, y) ((x)>(y) ? (x) : (y))
   #define IS_EVEN(n) ((n)%2==0)
   

   程序中有如下语句：

   i = MAX(j+k, m-n);
   if(IS_EVEN(i))
       i++;
   

   则预处理器会替换为如下语句：

   i = ((j+k) > (m-n) ? (j+k) : (m+n));
   if(((i)%2==0))
       i++;
   

   带参数宏可以为空参数列表，例如：

   #define getchar() getc(stdin)
   

   空的参数列表不是一定确实需要，但可以使getchar更像一个函数（实际上标准库<stdio.h>中的getchar不是一个函数，就是一个宏定义而已）。

4. 使用带参宏优点和缺点

   • 相对于使用函数，带参宏的效率更高。因为函数在调用过程涉及到了上下文的切换，需要保护现场等。而使用带参宏，在预编译阶段就会进行替换，编译到当前行。

   • 所以相对于函数，宏的通用性更强。函数的参数需要指定类型，而宏定义的参数是没有类型的，宏可以接受任何类型的参数。

     万物都有两面性，既然有优点，缺点自然存在

   • 编译后代码通常会变大。没一处宏调用都会导致插入宏的替换列表，由此导致源代码的数量增加，宏使用的越频繁，这种效果越明显。

   • 无法使用一个指针来指向一个宏。

   • 宏有可能会不止一次地计算它的参数，导致语义错误。例如使用上面提到的MAX宏，n = MAX(i++, j)；在预处理后n=((i++)>(j)?(i++):(j));这样本来是要i+1而已，但是造成了i多运算了一次。

5. 用带参宏作为模板

   有时候我们需要频繁使用类似以下的代码段：

   printf("the count is %d
   ", count);
   

   我们为了节省书写的代码量，可以定义一个带参宏作为模板：

   #define PRINT_COUNT(x) printf("the count is %d", x)
   

---

宏定义中的#和##运算符

#运算符

1. 作用

   把一个宏的参数转换为字符串字面量，它仅允许出现在带参宏的[替换列表]中

2. 示例

   #define PRINT_INT(x)	printf(#x " = %d", x)
   

   x之前的#会告诉预处理器根据PRINT_INT的参数创建一个字符串字面量，因此当调用时

   PRINT_INT(i/j);
   

   会变为

   printf("i/j" "= %d", i/j);
   

   在C语言中相邻的字符串字面量会被合并，因此上面的语句等效为

   printf("i/j = %d", i/j);
   

3. 常见应用场合

   #define assert(x)
   do{
       if (!(x))
       {
       p_err( "%s:%d assert " #x " failed
   ", __FILE__, __LINE__);
       while(1);
       }
   }while(0)
   

   把传入的表达式x变为字符串

---

##运算符

1. 作用

   用来连接前后两个（宏）变量。

2. 举例

   #define MK_ID(n) i##n
   int MK_ID(1)， MK_ID(2);
   

   预编译后声明变为：

   int i1, i2, i3;
   

3. 注意事项

• 连接符生成的新记号（token），应该是一个合法的，有意义的记号。比如你不能连接 "c"和 "-"/ "+"等等类似标记来生成"c-"或者 "c+"，否者预编译时候就会提示错误；

• 连接生成的新记号，但是如果生成的是某变量，依旧需要确保该变量名是合法的；

• 所有的注释代码，在 ##进行连接前，预编译器已经将他们翻译成空格符了，因此不能期望使用 ##来连接 /和 *来生成一个注释代码（当然如果不是闲得疼，应该也不会这么用）；

• 和前后两个记号之间的空格数可以随意。

• 常见使用场合如下

  #define PRINT_LOG_ERROR(format, ...) 
  {
  	if(g_LogLevel <= LOG_LEVEL_DEBUG)
  	{
  		printf("[debug] %s:%d %s()| "format"
  ", __FILE__, 
  				__LINE__, __func__, ##__VA_ARGS__);
  		fflush(stdout);
  	}
  }
  

  其中##__VA_ARGS__为了当...可变参数传入为空时，编译不报错。

---

删除宏定义

使用关键字 #undef [标识符]

例如：

#if RELEASE_VERSION		
#undef DEBUG
#endif

---

常用预定义宏

使用示例：

#if RELEASE_VERSION		
#undef DEBUG
#endif

#ifdef DEBUG
#define p_info(...) do{if(!dbg_level)break;printf("[I: %d.%03d] ",  os_time_get()/1000, os_time_get()%1000);printf(__VA_ARGS__); printf("
");}while(0)

#define p_err(...) do{printf("[E: %d.%03d] ",  os_time_get()/1000, os_time_get()%1000);printf(__VA_ARGS__); printf("
");}while(0)

#define p_dbg_track do{if(!dbg_level)break;printf("[D: %d.%03d] ",  os_time_get()/1000, os_time_get()%1000);printf("%s,%d",  __FUNCTION__, __LINE__, ); printf("
");}while(0)

#define p_dbg(...) do{if(!dbg_level)break;printf("[D: %d.%03d] ",  os_time_get()/1000, os_time_get()%1000);printf(__VA_ARGS__); printf("
");}while(0)

#define p_dbg_enter do{if(!dbg_level)break;printf("[D: %d.%03d] ",  os_time_get()/1000, os_time_get()%1000);printf("enter %s
", __FUNCTION__); printf("
");}while(0)

#define p_dbg_exit do{if(!dbg_level)break;printf("[D: %d.%03d] ",  os_time_get()/1000, os_time_get()%1000);printf("exit %s
", __FUNCTION__); printf("
");}while(0)

#define p_dbg_status do{if(!dbg_level)break;printf("[D: %d.%03d] ",  os_time_get()/1000, os_time_get()%1000);printf("status %d
", status); printf("
");}while(0)

#define p_err_miss do{printf("[E: %d.%03d] ",  os_time_get()/1000, os_time_get()%1000);printf("%s miss
", __FUNCTION__); printf("
");}while(0)

#define p_err_mem do{printf("[E: %d.%03d] ",  os_time_get()/1000, os_time_get()%1000);printf("%s mem err
", __FUNCTION__); printf("
");}while(0)

#define p_err_fun do{printf("[E: %d.%03d] ",  os_time_get()/1000, os_time_get()%1000);printf("%s err in %d
", __FUNCTION__, __LINE__); printf("
");}while(0)

#else
#define p_info(...) do{printf("[I: %d.%03d] ",  os_time_get()/1000, os_time_get()%1000); printf(__VA_ARGS__); printf("
");}while(0)

#define p_err(...)	do{printf("[E: %d.%03d] ",  os_time_get()/1000, os_time_get()%1000); printf(__VA_ARGS__); printf("
");}while(0)

#define p_err_miss 	do{printf("[E: %d.%03d] ",  os_time_get()/1000, os_time_get()%1000);printf("%s miss
", __FUNCTION__); printf("
");}while(0)

#define p_err_mem 	do{printf("[E: %d.%03d] ",  os_time_get()/1000, os_time_get()%1000);printf("%s mem err
", __FUNCTION__); printf("
");}while(0)

#define p_err_fun 	do{printf("[E: %d.%03d] ",  os_time_get()/1000, os_time_get()%1000);printf("%s err in %d
", __FUNCTION__, __LINE__); printf("
");}while(0)

#define p_dbg_track
#define p_dbg(...)
#define p_dbg_exit
#define p_dbg_enter
#define p_dbg_status

#endif