C/C++中宏定义的那些事儿

宏定义是C/C++语言提供的三种预处理方式之一,合理地使用宏定义可以达到很多功能目的,某些情况下可以减少大量重复代码。


image.png

宏的基本原理是,在代码的预处理阶段做形式上的替换,而不做类型上的检查。

宏的主要用途

宏主要包含三种用途:

  • 编译器参数和条件编译
    在C代码的编译过程中,经常需要通过宏来根据硬件平台和编译平台来控制编译的流程。
    其次,在头文件中经常见到下面的代码,以防止头文件的重复包含:
#ifndef  _XXX_H
#define  _XXX_H
//...
#endif

这个功能目前暂时没有别的选项可以替代。

此外,在面对不同的系统架构、字节序等情况时,也可以通过宏的方式进行区分。例如:

#ifdef  _BIG_ENDIAN
//...
#endif

#ifndef  _LITTLE_ENDIAN
//...
#endif

  • 定义Magic Number
    通过具有明确含义的宏代替具体的常数,使得代码更容易被理解,还能避免代码中相互关联而又分布零散混乱的Hard Code。

  • 定义宏函数
    这是宏功能强大的地方,也是比较容易出错的地方。下文通过一些具体的案例重点展示它的常见用法。

宏函数

宏函数在使用时,也可以带参数,大部分情况下和普通的函数差异不大。
但是,宏函数在代码的 预处理 阶段就会把所有调用它的地方替换掉,可以理解为简单的文本替换,因此有可能踩到一些意想不到的“坑”。

  1. 求最大值和最小值
#define  MAX(a, b)  (((a) > (b)) ? (a) : (b))
#define  MIN(a, b)  (((a) < (b)) ? (a) : (b))
  1. 得到一个字段field在结构体type中的偏移量
#define  FPOS(type, field)  (&(((type*)0)->field))
  1. 得到结构体中一个字段field所占的字节数
#define  FSIZE(type, field)  sizeof(((type*)0)->field)
  1. 返回数组元素的个数
#define  ARRAY_SIZE(a)  (sizeof((a)) / sizeof((a[0])))
  1. 几个常用的宏定义
    ANSI C中预定义了几个非常有用的编译宏:
__LINE__
__FILE__
__DATE__ 
__TIME__
__STDC__

例如:

#define DEBUG_PRINT(msg)  \
do {  \  
    printf(“%s %s - line:%d, file:%s”, __DATE__, __TIME__, __LINE__, __FILE__);   \
    printf(msg);  \
}while(0)

#和##的用途

1.基本用法
使用 # 将宏参数转换为字符串,使用 ## 将宏参数进行连接。

#define  STR(x)  #x
printf(STR(helloworld))  //输出字符串helloworld

#define CONS(a, b)   (a##e##b)
printf("%f \n", CONS(2,3));  //输出 2000.0
#define   TWO  (2)
#define   THREE  (3)
#define   MUL(a, b)   ((a) * (b))

printf("%f \n", CONS(TWO, THREE));  // 输出 6

2.宏函数可以是另外的宏

#define   TWO  (2)
#define   THREE  (3)
#define   MUL(a, b)   ((a) * (b))

printf("%f \n", CONS(TWO, THREE));  // 输出 6

不过,需要特别注意的是:在使用 ### 的时候,如果宏参数本身又是一个宏,它不会自动展开。例如:

#define   TEN  10
#define   STR(x)  #x
printf(STR(TEN))      //不会输出字符串"10",而是会输出字符串"TEN"

在这个例子中,TEN没有展开为10。如果想达到这个目的,可以在中间再插入一层转换。如下所示:

#define   TEN  10
#define   _STR(x)    #x
#define   STR(x)  _STR(x)    // 宏参数转换
printf(STR(TEN));      //输出字符串"10"

在这种情况下,#define STR(x) _STR(x)完成宏参数转换的作用。STR(TEN)会被展开为_STR(10)_STR(10)再进一步展开为字符串"10"

类似地,下面例子中的 ## 参数可以通过插入一个转换层完成参数的展开:

#define   TWO  2
#define   THREE  3
#define   EXP(a, b)   (a##e##b))
printf("%f \n", EXP(TWO, THREE));  // error
#define   TWO  2
#define   THREE  3
#define   _EXP(a, b)   (a##e##b)
#define   EXP(a, b)   _EXP(a, b)    // 宏参数转换
printf("%f \n", EXP(TWO, THREE));  // 输出2000.0

3.结构体填充

#define FILL(a)     {a, #a}
struct XYZ
{
    int val;
    char rep[64];
};

struct XYZ xyz = FILL(1000);
printf("%d - %s \n", xyz.val, xyz.rep);  // 输出 1000 - 1000

4.得到一个数值类型所对应的字符串缓冲区大小

#define    _TYPE_BUF_SIZE(type)   sizeof #type
#define    TYPE_BUF_SIZE(type)  _TYPE_BUF_SIZE(type) 

char buf[TYPE_BUF_SIZE(INT_MAX) ];  //相当于 buf[11]

它的展开过程为:
buf[TYPE_BUF_SIZE(INT_MAX) ] 被替换为: char buf[_TYPE_BUF_SIZE(0x7fffffff)]
然后 char buf[_TYPE_BUF_SIZE(0x7fffffff)] 被替换为char buf[sizeof "0x7fffffff"]
即为char buf[11]

5.在测试框架中的应用
在常见的C/C++单元测试框架,如CppUTest中有比较典型的 # 和 ## 的应用。
这里给出一个较为简单版本的框架代码示例。

#define TEST_CASE(NAME)                             \
    extern void TEST_CASE_FUNCTION_##NAME(void);    \
    class TEST_CASE_CLASS_##NAME                    \
    {                                               \
    public:                                         \
        TEST_CASE_CLASS_##NAME()                    \
        {                                           \
            std::cout << #NAME << std::endl;        \
            TEST_CASE_FUNCTION_##NAME();            \
        }                                           \
    } TEST_CASE_INSTANCE_##NAME;                    \
    void TEST_CASE_FUNCTION_##NAME(void)

相应地,测试用例可以这样写:

TEST_CASE(ONE_plus_ONE_should_be_equal_to_TWO)
{    
    ASSERT_EQ(2, 1+1);
}

使用宏的几点注意

  1. 宏参数要使用括号。
    例如:
#define  SQ(a)  a * a

SQ(1+2)时返回结果为5,而不是9

#define  SQ(a)  (a) * (a)

这样定义也有问题:16/SQ(1+3)的结果为16,而不是1

正确的方法应该是,在最外层也加上括号:

#define  SQ(a)  ((a) * (a))
  1. 在多行语句时使用do{...} while(0)。
    例如,下面这种定义方法会出错:
#define  XXX(x, y)  x+y; \
                    x-y;

if(...)
    XXX(x,y)   //error
else
   ...

正确的定义方法为:

#define  XXX(x, y)  do{ x+y; \
    x-y;} while(0)

  1. 由于宏定义只做形式上的替换,不做任何类型上的检查,所以,宏函数在传参的时候要特别注意。

  2. 建议只有对于那些功能短小精悍、使用频率较高的代码段,使用宏的方式进行定义,以方便代码的复用。
    否则,对其滥用有可能带来代码代码维护性上的问题,尤其是逻辑复杂、代码规模较大的情况。

  3. 关于性能
    有些情况下,使用宏可以提升代码运行的效率,尤其是在嵌入式开发的情况下。但是,需要在性能和代码的可理解性和可维护性之间做出平衡。
    尤其是在某些情况下,我们想当然的认为可以提高性能,实际上却没有提高,甚至是降低了性能。

#define MAX(a, b) ((a)>(b)?(a):(b))
int a[] = { 9, 3, 5, 2, 1, 0, 8, 7, 6, 4 };
int max(int n)
{
    return n == 0 ? a[0] : MAX(a[n], max(n-1));
}
int main(void)
{
    max(9);
    return 0;
}

在这个例子中,MAX宏函数被展开为( a[n]>max(n-1)?a[n]:max(n-1) ),其中max(n-1)被调用了两遍,反而降低了程序的性能。

【参考资料】

  • typedef的用法
  • 什么时候应该使用宏定义
  • 宏定义

你可能感兴趣的:(C/C++中宏定义的那些事儿)