do{...}while(0)；写法用途详解

╰半夏微凉° 2022-10-14 12:53 171阅读 0赞

在一些项目代码中，有时会遇到这样的代码：

do{ 
     ...
    }while(0);

我当时的反应大概是这样的  
![在这里插入图片描述][20210521160014963.png]  
实在是有点无解这种写法，说实话的确没看出来有什么用，这跟不加这个有什么不同吗？

后经查询资料才发现，这种写法大有用处，甚至在Linux的内核代码中很常见这类写法，看了各路大神的总结，我恍然大悟。在此主要是整理记录下来，方便查看。也希望对各位读者有帮助，谢谢！

**1.辅助定义复杂的宏，避免引用的时候出错**  
下面举例说明：  
出错情况1：

#define DOSOMETHING()\ fun1();\ fun2();

这个宏的本意是，当调用DOSOMETHING()时，函数fun1()和fun2()都会被调用。但是如果你在调用的时候这么写：

if(a>0)
        DOSOMETHING();

因为宏在预处理的时候会直接被展开，你实际上写的代码是这个样子的：

if(a>0)
        fun1();
    fun2();

这就出现了问题，因为无论a是否大于0，fun2()都会被执行，导致程序出错。这种情况甚至编译器不会报警，更不会报错。

出错情况2：  
对于上一种情况，可能会想到用\{\}将fun1();和fun2();括起来作为一个语句体不就好了，类似下面这样：

#define DOSOMETHING()\ { fun1();\ fun2();}

这样的确能解决第一种情况的问题，但如果是if…else呢？

if(a>0)
        DOSOMETHING();
    else
    	fun3();

宏展开后：

if(a>0)
    	{ fun1();fun2();};
    else
    	fun3();

这种情况直接导致错误程序编译不过，原因在于else的前面，\}的后面有一个;把if…else断开了。  
两种解决思路：  
一种是添加花括号

if(a>0)
    { 
        DOSOMETHING();
    }
    else
    	fun3();

还有一种是将宏改成do\{…\}while(0)形式

#define DOSOMETHING()\ do{ fun1();\ fun2();}while(0)

*注意while(0)后面没有封号*

**2.跳出代码块，不执行后面的语句**  
有些函数中，在函数return之前我们经常会进行一些收尾的工作，比如free掉一块函数开始malloc的内存，goto一直都是一个比较简便的方法：

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

由于goto不符合软件工程的结构化，而且有可能使得代码难懂，所以很多人都不倡导使用，那这个时候就可以用do\{\}while(0)来进行统一的管理：

int foo()
    { 
     
        somestruct* ptr = malloc(...);
     
        do{ 
            dosomething...;
            if(error)
            { 
                break;
            }
     
            dosomething...;
            if(error)
            { 
                break;
            }
            dosomething...;
        }while(0);
     
        free(ptr);
        return 0;
    }

上面的方法用break或者continue都可以。

**3.定义一个单独的函数块来实现复杂的操作**  
当你的功能很复杂，变量很多你又不愿意增加一个函数的时候，使用do\{\}while(0);，将你的代码写在里面，里面可以定义变量而不用考虑变量名会同函数之前或者之后的重复。

int fun()
    { 
    	something...;
    	do{ 
    		int i;
    		something...;
    	}while(0);
    	something...;
    }

如果不考虑替代goto的用法，我觉得直接使用一对花括号也未尝不可。

**4.避免空宏引起的warning**  
内核中由于不同架构的限制，很多时候会用到空宏，在编译的时候，空宏会给出warning，为了避免这样的warning，就可以使用do\{\}while(0)来定义空宏：

#define EMPTYMICRO do{ }while(0)

**【实例参考】**  
摘自stm32 HAL库：

#define __HAL_SYSCFG_FASTMODEPLUS_ENABLE(__FASTMODEPLUS__) do { assert_param(IS_SYSCFG_FASTMODEPLUS((__FASTMODEPLUS__)));\ SET_BIT(SYSCFG->CFGR1, (__FASTMODEPLUS__));\ }while(0)
    
    #define __HAL_SYSCFG_FASTMODEPLUS_DISABLE(__FASTMODEPLUS__) do { assert_param(IS_SYSCFG_FASTMODEPLUS((__FASTMODEPLUS__)));\ CLEAR_BIT(SYSCFG->CFGR1, (__FASTMODEPLUS__));\ }while(0)

摘自RT-Thread源码：

do                                                                            \
    {                                                                              \
        rt_base_t level;                                                          \
        level = rt_hw_interrupt_disable();                                        \
        if (rt_thread_self() == RT_NULL)                                          \
        {                                                                          \
            rt_kprintf("Function[%s] shall not be used before scheduler start\n", \
                       __FUNCTION__);                                             \
            RT_ASSERT(0)                                                          \
        }                                                                         \
        RT_DEBUG_NOT_IN_INTERRUPT;                                                \
        rt_hw_interrupt_enable(level);                                            \
    }                                                                             \
    while (0)

## 总结 ##

最后总结一下，do\{\}while(0)的最大的用途还是在于当需要对多个语句做一个宏定义封装，最好使用do\{\}while(0)，保证整体性的同时避免被意外分开处理。

参考鸣谢：  
[https://blog.csdn.net/dinghqalex/article/details/42420839][https_blog.csdn.net_dinghqalex_article_details_42420839]  
[https://www.cnblogs.com/zhuyf87/archive/2013/02/01/2889507.html][https_www.cnblogs.com_zhuyf87_archive_2013_02_01_2889507.html]  
[https://www.cnblogs.com/liushui-sky/p/5331813.html][https_www.cnblogs.com_liushui-sky_p_5331813.html]

[20210521160014963.png]: /images/20221014/739838d66cf0478092d3d733a6858c86.png
[https_blog.csdn.net_dinghqalex_article_details_42420839]: https://blog.csdn.net/dinghqalex/article/details/42420839
[https_www.cnblogs.com_zhuyf87_archive_2013_02_01_2889507.html]: https://www.cnblogs.com/zhuyf87/archive/2013/02/01/2889507.html
[https_www.cnblogs.com_liushui-sky_p_5331813.html]: https://www.cnblogs.com/liushui-sky/p/5331813.html