do{}while(0)只執(zhí)行一次無(wú)意義?你可能真的沒(méi)理解!
在嵌入式開發(fā)中,宏定義非常強(qiáng)大也非常便捷,如果正確使用可以讓你的工作事半功倍。然而,在很多的C程序中,你可能會(huì)看到不是那么直接的比較特殊一點(diǎn)的宏定義,比如do{}while(0)。
do{conditional code}while(condition)結(jié)構(gòu)
流程圖如下:
一般結(jié)構(gòu)如以下代碼
- do
- {
- //循環(huán)體
- }
- while (條件表達(dá)式);
do while/while do的區(qū)別
- do while()
意思是先干了再說(shuō)?。?/p>
- while() do
意思是先看看能不能干!
初見do{...}while(0)
linux內(nèi)核和其他一些開源的代碼中,經(jīng)常會(huì)遇到這樣的代碼:
- do{
- ...
- }while(0)
這樣的代碼一看就不是一個(gè)循環(huán),do..while表面上在這里一點(diǎn)意義都沒(méi)有,只執(zhí)行一次而已,那么為什么要這么用呢?
總結(jié)了7種妙處
實(shí)際上,do{...}while(0)的作用可不止一點(diǎn)點(diǎn),下面我列舉了一些。
- 有時(shí)候只是為了代碼分塊,比僅僅使用{}更直觀些。例如在cocos2d-x代碼中
- do
- {
- CCImage* pImage = new CCImage();
- CC_BREAK_IF(NULL == pImage);
- bRet = pImage->initWithString(text, (int)dimensions.width, (int)dimensions.height, eAlign, fontName, (int)fontSize);
- CC_BREAK_IF(!bRet);
- bRet = initWithImage(pImage);
- CC_SAFE_RELEASE(pImage);
- } while (0);
2. 為了宏展開的時(shí)候不會(huì)出錯(cuò)。如果直接放在花括號(hào)里會(huì)出錯(cuò)的
舉例來(lái)說(shuō),假設(shè)你需要定義這樣一個(gè)宏:
- #define DOSOMETHING() action1(); action2();
這個(gè)宏的本意是,當(dāng)執(zhí)行DOSOMETHING()時(shí),action1(),action2()都會(huì)被調(diào)用。如果有判斷,再執(zhí)行這個(gè)宏的話,如下:
- if(NULL == pPointer)
- DOSOMETHING();
- else
- ...
這樣宏在預(yù)處理的時(shí)候會(huì)直接被展開,放在花括號(hào)里,那么實(shí)際上寫的代碼如下:
- if(NULL == pPointer)
- action1();
- action2();
- else
- ...
這展開存在兩個(gè)問(wèn)題:
- 因?yàn)閕f分支后面有兩個(gè)語(yǔ)句,導(dǎo)致else分支沒(méi)有對(duì)應(yīng)的if,編譯失敗。
- 假設(shè)沒(méi)有else分支,則DOSOMETHING中的第二個(gè)語(yǔ)句無(wú)論if測(cè)試是否通過(guò),都會(huì)執(zhí)行。
那么僅僅使用{}把a(bǔ)ction1()、action2()包起來(lái)行么?比如:
- #define DOSOMETHING() { action1(); action2(); }
我們?cè)趯懘a的時(shí)候都習(xí)慣在語(yǔ)句右面加上分號(hào),如果在宏中使用{},代碼編譯展開后宏就相當(dāng)于這樣寫了:{...};,展開后如下:
- if(NULL == pPointer)
- {
- action1();
- action2();
- };
- else
- ...
這段代碼中大括號(hào)后多了一個(gè)分號(hào),如果有else,那么else又沒(méi)有對(duì)應(yīng)的if了,編譯出錯(cuò)。
那么辦法來(lái)了
如果我們使用do{...}while(0)來(lái)定義宏,即:
- #define DOSOMETHING() \
- do{ \
- action1();\
- action2();\
- }while(0)\
宏被展開后,上面的調(diào)用語(yǔ)句會(huì)保留初始的語(yǔ)義,同時(shí)絕大部分編譯器都能夠識(shí)別do{...}while(0)這種無(wú)用的循環(huán)并進(jìn)行優(yōu)化,不會(huì)導(dǎo)致性能優(yōu)化的降低。
小結(jié)
在Linux內(nèi)核和驅(qū)動(dòng)代碼還有cocos2d-x中,很多宏實(shí)現(xiàn)都使用do{...}while(0)來(lái)包裹他們的邏輯,Google的Robert Love(先前從事Linux內(nèi)核開發(fā))給我們解答如下:
“ 讓你定義的宏總是以相同的方式工作,不管在調(diào)用代碼中怎么使用分號(hào)和大括號(hào),而該宏總能確保其行為是一致的。
3. 當(dāng)你執(zhí)行一段代碼到一半,想跳過(guò)剩下的一半的時(shí)候,如果你正處于do{...}while(0)循環(huán)中,則能用break達(dá)到這個(gè)目的。
- do
- {
- 執(zhí)行.
- 再執(zhí)行…
- if (如果有什么條件滿足)
- {
- 我想跳到另外一段代碼了,剩下的不執(zhí)行了,可是不建議用goto語(yǔ)句,怎么辦呢?
- break;/*搞定*/
- }
- 我有可能被執(zhí)行.
- }while(false)
舉個(gè)例子如下
- do
- {
- if(!a) break;
- //do something here
- if(!b) break;
- //do another thing here
- }while(0);
4. 變形的goto,有些公司不讓用goto。在一些函數(shù)中,需要實(shí)現(xiàn)條件轉(zhuǎn)移,或者構(gòu)成循環(huán),跳出循環(huán)體,使用goto總是一種簡(jiǎn)單的方法,例如:
- #include <stdio.h>
- #include <stdlib.h>
- int main()
- {
- char *str;
- /* 最初的內(nèi)存分配 */
- str = (char *) malloc(15);
- if(str != NULL)
- goto loop;
- printf("hello world\n");
- loop:
- printf("malloc success\n");
- return(0);
- }
但由于goto不符合軟件工程的結(jié)構(gòu)化,而且有可能使得代碼難懂,所以很多人都不倡導(dǎo)使用,這個(gè)時(shí)候我們可以使用do{...}while(0)來(lái)做同樣的事情:
- #include <stdio.h>
- #include <stdlib.h>
- int main()
- {
- do{
- char *str;
- /* 最初的內(nèi)存分配 */
- str = (char *) malloc(15);
- if(str != NULL)
- break;
- printf("hello world\n");
- }while(0);
- printf("malloc success\n");
- return(0);
- }
這里將函數(shù)主體部分使用do{...}while(0)包含起來(lái),使用break來(lái)代替goto,后續(xù)的清理工作在while之后,現(xiàn)在既能達(dá)到同樣的效果,而且代碼的可讀性、可維護(hù)性都要比上面的goto代碼好的多了。
5. 可以是兼容各種編譯器
- int a;
- a = 10;
- int b;
- b = 20;
這種代碼在只支持c89的編譯器上是編譯不過(guò)去的,比如ADS 2.0。
- int a;
- a = 10;
- do
- {
- int b;
- b = 20;
- }while(0);
6. 避免由宏引起的警告內(nèi)核中由于不同架構(gòu)的限制,很多時(shí)候會(huì)用到空宏。在編譯的時(shí)候,這些空宏會(huì)給出警告,為了避免這樣的warning,我們可以使用do{...}while(0)來(lái)定義空宏:
- #define DOSOMETHING() do{}while(0)
7. 定義單一的函數(shù)塊來(lái)完成復(fù)雜的操作
如果你有一個(gè)復(fù)雜的函數(shù),變量很多,而且你不想要增加新的函數(shù),可以使用do{...}while(0),將你的代碼寫在里面,里面可以定義變量而不用考慮變量名會(huì)同函數(shù)之前或者之后的重復(fù),例如
- int key;
- string value;
- int func()
- {
- int key = GetKey();
- string value = GetValue();
- dosomething for key,value;
- do{
- int key;string value;
- dosomething for this key,value;
- }while(0);
- }
但是為了代碼的可讀性,盡量聲明不同的變量名,以便于后續(xù)開發(fā)人員欣賞