do-while竟然有這么多妙用？

嵌入式大雜燴

前言 這篇文章講解的知識點很小，但是在一些編程場合中非常適用，大家可以把這篇短文當(dāng)做甜品來品味一下。
地球人都知道，do-while語句是C/C++中的一個循環(huán)語句，特點是:
至少執(zhí)行一次循環(huán)體;
在循環(huán)的尾部進行結(jié)束條件的判斷。


其實do-while還可以用在其他一些場合中，非常巧妙的處理你的一些難題，比如：
在宏定義中寫復(fù)雜的語句;
在函數(shù)體中中止代碼段的處理。
好像有點抽象，那我們就來具體一些，通過代碼來聊聊這些用法。
也強烈建議您在平常的項目中把這些小技巧用起來，模仿是第一步，先僵化-再優(yōu)化-最后固化，這是提高編程能力的最有效方法。時間久了，用的多了，這些東西就是屬于你的。
在宏定義中的妙用 錯誤的宏定義

// 目的：把兩個參數(shù)分別自增一下#define OPT(a, b)   a++; b++;
int main(int argc, char *argv[]){    int i = 1;    int j = 1;    OPT(i, j);    printf("i = %d, j = %d
", i, j);    return 0;}
測試一下，結(jié)果沒有問題(代碼的目的就是讓i和j這個2個變量都自增1)：
i = 2, j = 2
而且OPT(i, j);中，最后的分號還可以省略，編譯和結(jié)果都沒有問題。
但是估計沒有誰會在項目中這么使用宏吧？！看一下下面這個例子：在調(diào)用OPT宏的外層添加一個if條件判斷：

#define OPT(a, b)   a++; b++;
int main(int argc, char *argv[]){    int i = 1;    int j = 1;    if(0)        OPT(i, j);    printf("i = %d, j = %d
", i, j);    return 0;}
打印結(jié)果是：
i = 1, j = 2
問題出現(xiàn)了：我們的本意是if條件為假，這2個變量都不要自增，但是輸出結(jié)果卻是：第二個參數(shù)自增了。
其實問題很明顯，把宏擴展開就一目了然了。

if(0)    a++; b++;
錯誤原因一目了然：由于if語句沒有用大括號{}把需要執(zhí)行的代碼全部包裹住，導(dǎo)致只有a++;語句是在if語句的控制范圍，而b++;語句無論如何都被執(zhí)行了。
也許你會說，這個簡單，使用if時，必須加上大括號{}。道理是沒錯，如果這個宏定義只有你自己使用，這不成問題。但是如果宏定義是你寫的，而使用者是你的同事，那么你怎么要求別人必須按照你所規(guī)定的格式來編碼？畢竟每個人的習(xí)慣是不一樣的。
很多時候，要求別人是不現(xiàn)實的。更有效的方法是優(yōu)化自己的輸出，提供更安全的代碼，讓別人想犯錯誤都沒機會。
比較好的宏定義怎么做才能更安全？更通用呢？使用do-while！

#define OPT(a, b)   do{a++;b++;}while(0)
也就是說，只要宏定義中存在多條語句，就可以用do-while把這些語句全部包裹起來，這樣無論怎么使用這個宏，都不會有問題。
例如：

if(0)    OPT(i, j);
宏擴展之后代碼為：

if(0)    do {        a++;        b++;    }while(0);
如果給if加上大括號，視覺上會更好一些：

if(0) {    OPT(i, j);}
宏擴展之后代碼為：

if(0) {    do {        a++;        b++;    }while(0);}
可以看到，無論是否加上大括號{}，從語法和語義上都不存在問題。
這里還有一個小細節(jié)可以留意一下：OPT(i,j);這行代碼中，尾部是加了分號的。
如果沒有加分號，那么宏擴展之后代碼為：

if(0)    do {        a++;        b++;    }while(0) // 注意：這里沒有分號
因為while(0)沒有分號，所以編譯會出錯。為了不對宏的使用者提出要求，可以在宏的最后加一個分號即可，如下：

#define OPT(a, b)   do{a++;b++;}while(0);
小結(jié)：使用do-while語句來包裹宏定義中的多行語句，解決了宏定義的安全問題。
但是，任何事情都不可能是完美的，例如：在宏定義中使用do-while就無法返回一個結(jié)果。
也就是說：如果我們需要從宏定義中返回一個結(jié)果，那么do-while就派不上用場了。那應(yīng)該怎么辦？
另一個也不錯的宏定義如果宏定義需要返回一個結(jié)果，最好的方式就是：使用({...})把宏定義中的多行語句包裹起來。如下：

#define ADD(a, b, c) ({ ++a; ++b; c=a+b; })
int i = 1;int j = 2;int k;printf("k = %d
", ADD(i, j, k));
下面這張圖來自GNU官方文檔：

翻譯過來就是：
GNU C中，在圓括號()中寫復(fù)雜語句是合法的，這樣你就可以在一個表達式中使用循環(huán)、switch、局部變量了。
什么是復(fù)雜語句呢？就是被大括號{}包裹的多行語句。
在上面的實例中，圓括號要放在大括號的外層。
使用({...})定義宏，因為是多行語句，可以返回一個結(jié)果，比do-while更勝一籌。
這里既然提到了在宏定義中使用局部變量，那我們再提供一個小技巧來提高代碼的執(zhí)行效率。
看一下這個宏定義：

#define max(a,b) ({ (a) > (b) ? (a) : (b) })
float i = 1.234;float j = 4.321;float max = max((i / 0.8 + 5) / 3, (j * 0.8) / 1.5);
宏擴展之后, a或者b中，肯定有一個被計算2次。當(dāng)然，這里的示例比較簡單，體現(xiàn)不出差距。如果是對時間要求特別苛刻的場合，計算量又很大，那么這個宏中由于兩次計算所耗費的時間就必須考慮了，那應(yīng)該如何優(yōu)化呢？使用局部變量！

#define max(a,b)  ({ int _a = (a), _b = (b); _a > _b ? _a : _b; })
通過增加局部變量_a和_b來緩存計算結(jié)果，就消除了2次計算的問題。
這個例子還可以再繼續(xù)優(yōu)化，這里的局部變量類型是int，這是寫死的，只能比較兩個整型的變量。如果寫成這樣：

#define max(a, b)  ({ typeof(a) _a = (a), _b = (b); _a > _b ? _a : _b; })
也就是用typeof來動態(tài)獲取比較變量的類型，這樣的話，任何數(shù)值類型的變量都可以使用這個宏了。
關(guān)于typeof的說明，請看GNU的這張圖，在文末的參考鏈接中，可以看到更加詳細的官方說明。

在函數(shù)體中的妙用 先來看2段代碼。
函數(shù)功能：返回錯誤代碼對應(yīng)的錯誤字符串

char *get_error_msg(int err_code){    if (1 == err_code) {        return "invalid name";    } else if (2 == err_code) {        return "invalid password";    } else if (3 == err_code) {        return "network error";    }
    return "unkown error";}
思考：一個設(shè)計良好的函數(shù)只有一個出口，也就是return語句，但是這個函數(shù)有這么多的return語句，是不是顯得很亂？示例代碼體積很小，似乎沒有感覺。但是上百行的函數(shù)在項目中還是比較常見的，在這種情況下如果給你來個十幾個return語句，你會不會想把寫代碼的那個家伙拎過來扇幾巴掌？
函數(shù)功能：通過TCP Socket連接服務(wù)器

void connect_server(char *ip, int port){    int ret, sockfd;    sockfd = socket(...);    if (sockfd         printf("socket create failed!
");        goto end;    }
    ret = connect(sockfd, ...);    if (ret         printf("connect failed!
");        goto end;    }
    ret = send(sockfd, ...)    if (ret         printf("send failed!
");        goto end;    }
end:    其他代碼}
思考：TCP socket編程中，需要按照固定的順序調(diào)用多個系統(tǒng)函數(shù)。這段代碼中調(diào)用系統(tǒng)函數(shù)后，對結(jié)果進行了檢查，這是非常好的習(xí)慣。如果在某個調(diào)用中發(fā)生錯誤，需要中止后面的操作，進行錯誤處理。雖然C語言中不禁止goto語句的使用，但是看到這么多的goto，難道就沒有美觀、更優(yōu)雅的做法嗎？
總結(jié)一下上面這2段代碼，它們共同的特點是：
在一連串的語句中，只需要執(zhí)行一部分的語句，也就是從代碼塊的某個中間位置中止執(zhí)行。
中止執(zhí)行，我們首先想到的就是break關(guān)鍵字，它主要用在循環(huán)和switch語句中。do-while循環(huán)語句首先執(zhí)行循環(huán)體，在尾部才進行循環(huán)的判斷。那么就可以利用這一點來解決這2段代碼面對的問題。解決多個return的問題

char *get_error_msg(int err_code){    char *msg;    do {        if (1 == err_code) {            msg = "invalid name";            break;        } else if (2 == err_code) {            msg = "invalid password";            break;        } else if (3 == err_code) {            msg = "network error";            break;        } else {            msg = "unkown error";            break;        }    }while(0);
    return msg;}
解決goto的問題

void connect_server(char *ip, int port){    int ret, sockfd;    do {        sockfd = socket(...);        if (sockfd             printf("socket create failed!
");            break;        }
        ret = connect(sockfd, ...);        if (ret             printf("connect failed!
");            break;        }
        ret = send(sockfd, ...)        if (ret             printf("send failed!
");            break;        }    }while(0);
    其他代碼}
這樣的代碼，是不是看起來順眼多了？總結(jié) do-while的主要作用是循環(huán)處理，但是在這篇文章中，我們利用的點并不是循環(huán)功能，而是代碼塊的包裹和中止執(zhí)行的功能。這些細小的點在一些牛逼的開源代碼中很常見，看到了我們就要學(xué)習(xí)、模仿、使用，用的多了它就是你的了！

參考文檔：
[1] https://gcc.gnu.org/onlinedocs/gcc/Typeof.html
[2] https://gcc.gnu.org/onlinedocs/gcc/Statement-Exprs.html
[3] https://stackoverflow.com/questions/9495962/why-use-do-while-0-in-macro-definition
[4] https://gcc.gnu.org/onlinedocs/gcc-6.2.0/gcc/Statement-Exprs.html#Statement-Exprs