do{...}while(0)的巧妙用处

最近读pjsip源码的时候看到do{...}while(0)的这种用法：

于是查了下这种用法的作用，发现挺有意思的。

1.辅助定义复杂的宏，避免引用的时候出错：

假设要定义一个宏：

#define F() f1(); f2();

这个宏的意思是，当调用F()时，f1()和f2()都会被调用。但是在调用的时候如果这么写：

if(expr)
    F();

 而宏在预处理的时候会直接被展开为：

if(expr)
    f1();f2();

这就导致无论expr是否为真，f2()一定被执行，因为if语句只能控制下一句f1()，这并不是我们的预期。

一种解决办法是用{}将f1();f2{};包起来：即

#define F() { f1(); f2(); }

但这种情况下，我们发现语句被展开为：

if(expr)
    {f1();f2();};

 最后的分号是我们习惯添加的，显然，这是个语法错误。有些编译器并不能通过。

这时候我们发现do{...}while(0)似乎是一种很好的解决办法：

#define F() \
        do{ \
          f1();\
          f2();\
        }while(0)\

可以达到语句被执行且仅执行一次，还能像普通函数调用一样在后面加分号。

pjsip C源码中很多的这种用法：

#if defined(PJ_ENABLE_EXTRA_CHECK) && PJ_ENABLE_EXTRA_CHECK != 0
#   define PJ_ASSERT_ON_FAIL(expr,exec_on_fail)    \
	    do { \
		pj_assert(expr); \
		if (!(expr)) exec_on_fail; \
	    } while (0)
#else
#   define PJ_ASSERT_ON_FAIL(expr,exec_on_fail)    pj_assert(expr)
#endif

2.避免使用goto对程序流进行统一的控制：

一些代码中想达到goto这种简单的代码流控制效果，例如：有些函数中，在函数return之前我们经常会进行一些收尾的工作，比如free掉一块函数开始malloc的内存，goto一直都是一个比较简便的方法。

int f()
{
    somestruct* ptr = malloc(...);
    ...;
    if(error)
    {
        goto END;
    }
    ...;
    if(error)
    {
        goto END;
    }
    ...;
 
END:
    free(ptr);
    return 0;
}

但是goto不符合软件工程的结构化，而且有可能使得代码难懂，所以不倡导使用，这时可以用do{}while(0)来进行统一的管理：

int f()
{
    somestruct* ptr = malloc(...);

    do{
        ...;
        if(error)
        {
            break;
        }
        ...;
        if(error)
        {
            break;
        }
        ...;
    }while(0);
 
    free(ptr);
    return 0;
}

 这里将函数主体部分使用do{...}while(0)包含起来，使用break来代替goto，后续的清理工作在while之后，现在既能达到同样的效果，而且代码的可读性、可维护性都要比上面的goto代码好的多了。

3、避免空宏引起的警告

内核中由于不同架构的限制，很多时候会用到空宏。在编译的时候，这些空宏会给出warning，为了避免这样的warning，可以使用do{...}while(0)来定义空宏：
#define EMPTYMICRO do{}while(0)
这种情况不太常见，因为有很多编译器，已经支持空宏。

4、定义一个单独的函数块来实现复杂的操作：

复杂的函数，变量很多，若不想要增加新的函数，可以用do{...}while(0)，将代码写在里面，里面可以定义变量而不用考虑变量名会同函数之前或者之后的重复。
但是不建议这样做，尽量声明不同的变量名，以便于后续开发人员阅读。

int i;
unsigned j;
int func()
{
    int j = fi();
    unsigned j = fj();
    ...;
    do{
        int i;
        unsigned j;
        ...;
    }while(0);    
}