do...while(0) 的妙用
在 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) 迴圈:
version 3
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; }
看程式碼就行了,啥都不用說了…
2. 巨集定義中的 do…while(0)
如果你是 C++ 程式設計師,我有理由相信你用過,或者接觸過,至少聽說過 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 something
就有兩個問題,
- 因為 if 分支後有兩個語句,else 分支沒有對應的 if,編譯失敗
- 假設沒有 else, SAFE_DELETE 中的第二個語句無論 if 測試是否通過,會永遠執行
你可能發現,為了避免這兩個問題,我不一定要用這個令人費解的 do…while,我直接用 {} 括起來就可以了
#define SAFE_DELETE(p) { delete p; p = NULL; }
的確,這樣的話上面的問題是不存在了,但是我想對於 C++ 程式設計師來講,在每個語句後面加分號是一種約定俗成的習慣,這樣的話,以下程式碼:
if (NULL != p)
SAFE_DELETE(p);
else
// do something
其 else 分支就無法通過編譯了(原因同上),所以採用 do…while(0) 是做好的選擇了。
也許你會說,我們程式碼的習慣是在每個判斷後面加上 {}, 就不會有這種問題了,也就不需要 do…while了,如:
if (...) {
} else {
}
誠然,這是一個好的,應該提倡的程式設計習慣,但一般這樣的巨集都是作為 library 的一部分出現的,而對於一個 library 的作者,他所要做的就是讓其庫具有通用性、強壯性,因此他不能有任何對庫的使用者的假設,如其編碼規範,技術水平等。