什么情况下用宏定义do{}while(0);这种结构

墨蓝 2022-05-29 11:42 148阅读 0赞

## [什么情况下用宏定义do\{\}while(0);这种结构][do_while_0] ##

转自： [http://www.cnblogs.com/rollenholt/articles/1907414.html][do_while_0]

这两天在看别人代码时，发现别人在宏定义中使用了do...while语句，百思不得其解，于是在网上查找了一番，现总结了一下，转帖出来共享！

\#define MACRO\_NAME(para) do\{macro content\}while(0)

的格式，总结了以下几个原因：

1，空的宏定义避免warning:

\#define foo() do\{\}while(0)

2，存在一个独立的block，可以用来进行变量定义，进行比较复杂的实现。

3，如果出现在判断语句过后的宏，这样可以保证作为一个整体来是实现：

\#define foo(x) \\

action1(); \\

action2();

在以下情况下：

if(NULL == pPointer)

foo();

就会出现action1和action2不会同时被执行的情况，而这显然不是程序设计的目的。

4，以上的第3种情况用单独的\{\}也可以实现，但是为什么一定要一个do\{\}while(0)呢，看以下代码：

\#define switch(x,y) \{int tmp; tmp="x";x=y;y=tmp;\}

if(x>y)

switch(x,y);

else //error, parse error before else

otheraction();

在把宏引入代码中，会多出一个分号，从而会报错。

//------------------------------------------------

使用do\{….\}while(0) 把它包裹起来，成为一个独立的语法单元，从而不会与上下文发生混淆。同时因为绝大多数的编译器都能够识别do\{…\}while(0)这种无用的循环并进行优化，所以使用这种方法也不会导致程序的性能降低。  
详解如下：MFC, 在MFC的afx.h文件里面， 你会发现很多宏定义都是用了do...while(0)或do...while(false)， 比如说：  
\#define AFXASSUME(cond) do \{ bool \_\_afx\_condVal=!!(cond); ASSERT(\_\_afx\_condVal); \_\_analysis\_assume(\_\_afx\_condVal); \} while(0)  
粗看我们就会觉得很奇怪，既然循环里面只执行了一次，我要这个看似多余的do...while(0)有什么意义呢？  
当然有！  
为了看起来更清晰，这里用一个简单点的宏来演示：  
\#define SAFE\_DELETE(p) do\{ delete p; p = NULL\} while(0)  
假设这里去掉do...while(0),  
\#define SAFE\_DELETE(p) delete p; p = NULL;  
那么以下代码：  
if(NULL != p) SAFE\_DELETE(p)  
else ...do sth...  
就有两个问题，  
1) 因为if分支后有两个语句，else分支没有对应的if，编译失败  
2) 假设没有else, SAFE\_DELETE中的第二个语句无论if测试是否通过，会永远执行。  
你可能发现，为了避免这两个问题，我不一定要用这个令人费解的do...while, 我直接用\{\}括起来就可以了  
\#define SAFE\_DELETE(p) \{ delete p; p = NULL;\}  
的确，这样的话上面的问题是不存在了，但是我想对于C++程序员来讲，在每个语句后面加分号是一种约定俗成的习惯，这样的话，以下代码:  
if(NULL != p) SAFE\_DELETE(p);  
else ...do sth...  
其else分支就无法通过编译了（原因同上），所以采用do...while(0)是做好的选择了。

也许你会说，我们代码的习惯是在每个判断后面加上\{\}, 就不会有这种问题了，也就不需要do...while了，如：  
if(...)  
\{  
\}  
else  
\{  
\}  
诚然，这是一个好的，应该提倡的编程习惯，但一般这样的宏都是作为library的一部分出现的，而对于一个library的作者，他所要做的就是让其库具有通用性，强壮性，因此他不能有任何对库的使用者的假设，如其编码规范，技术水平等

### do...while(0)-妙用 (转...) ###

sswanglei 发表于 2007-7-1 22:33:00 在C++中，有三种类型的循环语句：for, while, 和do...while， 但是在一般应用中作循环时， 我们可能用for和while要多一些，do...while相对不受重视。  
但是，最近在读我们项目的代码时，却发现了do...while的一些十分聪明的用法，不是用来做循环，而是用作其他来提高代码的健壮性。

**1. do...while(0)消除goto语句。**  
通常，如果在一个函数中开始要分配一些资源，然后在中途执行过程中如果遇到错误则退出函数，当然，退出前先释放资源，我们的代码可能是这样：  
**version 1**

bool Execute()  
\{  
// 分配资源  
int \*p = new int;  
bool bOk(true);

// 执行并进行错误处理  
bOk = func1();  
if(!bOk)  
\{  
delete p;  
p = NULL;  
return false;  
\}

bOk = func2();  
if(!bOk)  
\{  
delete p;  
p = NULL;  
return false;  
\}

bOk = func3();  
if(!bOk)  
\{  
delete p;  
p = NULL;  
return false;  
\}

// ..........

// 执行成功，释放资源并返回  
delete p;  
p = NULL;  
return true;  
  
\}

这里一个最大的问题就是代码的冗余，而且我每增加一个操作，就需要做相应的错误处理，非常不灵活。于是我们想到了goto:  
**version 2**

bool Execute()  
\{  
// 分配资源  
int \*p = new int;  
bool bOk(true);

// 执行并进行错误处理  
bOk = func1();  
if(!bOk) goto errorhandle;

bOk = func2();  
if(!bOk) goto errorhandle;

bOk = func3();  
if(!bOk) goto errorhandle;

// ..........

// 执行成功，释放资源并返回  
delete p;  
p = NULL;  
return true;

errorhandle:  
delete p;  
p = NULL;  
return false;  
  
\}

代码冗余是消除了，但是我们引入了C++中身份比较微妙的goto语句，虽然正确的使用goto可以大大提高程序的灵活性与简洁性，但太灵 活的东西往往是很危险的，它会让我们的程序捉摸不定，那么怎么才能避免使用goto语句，又能消除代码冗余呢，请看do...while(0)循环：  
**version3**

bool Execute()  
\{  
// 分配资源  
int \*p = new int;

bool bOk(true);  
do  
\{  
// 执行并进行错误处理  
bOk = func1();  
if(!bOk) break;

bOk = func2();  
if(!bOk) break;

bOk = func3();  
if(!bOk) break;

// ..........  
  
\}while(0);

// 释放资源  
delete p;  
p = NULL;  
return bOk;  
  
\}

============================================================================== **我喜欢程序员，他们单纯、固执、容易体会到成就感；面对压力，能够挑灯夜战不眠不休；面对困难，能够迎难而上挑战自我。他们也会感到困惑与傍徨，但每个程序员的心中都有一个比尔盖茨或是乔布斯的梦想“用智慧开创属于自己的事业”。我想说的是，其实我是一个程序员。**===========================================================================

// other:

do-while的妙用  
do-while循环控制语句的特点就是循环体内的语句至少会被执行一次，如果while(…)内的条件始终为0时，循环体内的语句就会被执行且只被执行一次，这样的执行效果与直接使用循环体内的代码相同，但这们会得到更多的益处。  
\#define SWAP\_INT(a, b) do  
\{\\  
int tmp = a; \\  
a = b; \\  
b = tmp; \\  
\}while(0)

int main( void )  
\{  
int x = 3, y = 4;  
if( x > y )  
\{  
SWAP\_INT(x, y);  
\}  
return 0;  
\}  
通过do-while代码块的宏定义我们不仅可以把SWAP\_INT像函数一样用，而且还有优点：  
（1）、在宏定义中可以使用局部变量；  
（2）、在宏定义中可以包含多个语句，但可以当作一条语句使用，如代码中的if分支语句，如果没有do-while把多条语句组织成一个代码块，则程序的运行结果就不正确，甚至不能编译。  
其实我们定义的SWAP\_INT(a, b)相当于定义了引用参数或指针参数的函数，因为它可以改变实参的值。在C++0X中有了decltype关键词，这种优势就更显示了，因为在宏中使用了局部变量必须确定变量的类型，所以这个宏只能用于交换int型的变量值，如果换作其它类型则还必须定义新的宏，如SWAP\_FLOAT、SWAP\_CHAR等，而通过decltype，我们就可以定义一个万能的宏。  
\#include <iostream>  
using namespace std;  
\#define SWAP(a, b) do  
\{ \\  
decltype(a) tmp = a; \\  
a = b; \\  
b = tmp; \\  
\}while(0)

int main( void )  
\{  
int a = 1, b = 2;  
float f1 = 1.1f, f2 = 2.2f;  
SWAP(a, b);  
SWAP(f1,f2);  
return 0;  
\}  
通过宏实现的SWAP“函数”要比使用指针参数效率还要高，因为它连指针参数都不用传递而是使用直接代码，对于一些效率要求比较明显的场合，宏还是首选。

[do_while_0]: http://www.cnblogs.com/rollenholt/articles/1907414.html