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

嵌入式大雜燴

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


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

// 目的：把兩個(gè)參數(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;}
測(cè)試一下，結(jié)果沒(méi)有問(wèn)題(代碼的目的就是讓i和j這個(gè)2個(gè)變量都自增1)：
i = 2, j = 2
而且OPT(i, j);中，最后的分號(hào)還可以省略，編譯和結(jié)果都沒(méi)有問(wèn)題。
但是估計(jì)沒(méi)有誰(shuí)會(huì)在項(xiàng)目中這么使用宏吧？！看一下下面這個(gè)例子：在調(diào)用OPT宏的外層添加一個(gè)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
問(wèn)題出現(xiàn)了：我們的本意是if條件為假，這2個(gè)變量都不要自增，但是輸出結(jié)果卻是：第二個(gè)參數(shù)自增了。
其實(shí)問(wèn)題很明顯，把宏擴(kuò)展開(kāi)就一目了然了。

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

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

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

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

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

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

if(0)    do {        a++;        b++;    }while(0) // 注意：這里沒(méi)有分號(hào)
因?yàn)閣hile(0)沒(méi)有分號(hào)，所以編譯會(huì)出錯(cuò)。為了不對(duì)宏的使用者提出要求，可以在宏的最后加一個(gè)分號(hào)即可，如下：

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

#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));
下面這張圖來(lái)自GNU官方文檔：

翻譯過(guò)來(lái)就是：
GNU C中，在圓括號(hào)()中寫(xiě)復(fù)雜語(yǔ)句是合法的，這樣你就可以在一個(gè)表達(dá)式中使用循環(huán)、switch、局部變量了。
什么是復(fù)雜語(yǔ)句呢？就是被大括號(hào){}包裹的多行語(yǔ)句。
在上面的實(shí)例中，圓括號(hào)要放在大括號(hào)的外層。
使用({...})定義宏，因?yàn)槭嵌嘈姓Z(yǔ)句，可以返回一個(gè)結(jié)果，比do-while更勝一籌。
這里既然提到了在宏定義中使用局部變量，那我們?cè)偬峁┮粋�(gè)小技巧來(lái)提高代碼的執(zhí)行效率。
看一下這個(gè)宏定義：

#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);
宏擴(kuò)展之后, a或者b中，肯定有一個(gè)被計(jì)算2次。當(dāng)然，這里的示例比較簡(jiǎn)單，體現(xiàn)不出差距。如果是對(duì)時(shí)間要求特別苛刻的場(chǎng)合，計(jì)算量又很大，那么這個(gè)宏中由于兩次計(jì)算所耗費(fèi)的時(shí)間就必須考慮了，那應(yīng)該如何優(yōu)化呢？使用局部變量！

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

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

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

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";}
思考：一個(gè)設(shè)計(jì)良好的函數(shù)只有一個(gè)出口，也就是return語(yǔ)句，但是這個(gè)函數(shù)有這么多的return語(yǔ)句，是不是顯得很亂？示例代碼體積很小，似乎沒(méi)有感覺(jué)。但是上百行的函數(shù)在項(xiàng)目中還是比較常見(jiàn)的，在這種情況下如果給你來(lái)個(gè)十幾個(gè)return語(yǔ)句，你會(huì)不會(huì)想把寫(xiě)代碼的那個(gè)家伙拎過(guò)來(lái)扇幾巴掌？
函數(shù)功能：通過(guò)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)用多個(gè)系統(tǒng)函數(shù)。這段代碼中調(diào)用系統(tǒng)函數(shù)后，對(duì)結(jié)果進(jìn)行了檢查，這是非常好的習(xí)慣。如果在某個(gè)調(diào)用中發(fā)生錯(cuò)誤，需要中止后面的操作，進(jìn)行錯(cuò)誤處理。雖然C語(yǔ)言中不禁止goto語(yǔ)句的使用，但是看到這么多的goto，難道就沒(méi)有美觀、更優(yōu)雅的做法嗎？
總結(jié)一下上面這2段代碼，它們共同的特點(diǎn)是：
在一連串的語(yǔ)句中，只需要執(zhí)行一部分的語(yǔ)句，也就是從代碼塊的某個(gè)中間位置中止執(zhí)行。
中止執(zhí)行，我們首先想到的就是break關(guān)鍵字，它主要用在循環(huán)和switch語(yǔ)句中。do-while循環(huán)語(yǔ)句首先執(zhí)行循環(huán)體，在尾部才進(jìn)行循環(huán)的判斷。那么就可以利用這一點(diǎn)來(lái)解決這2段代碼面對(duì)的問(wèn)題。解決多個(gè)return的問(wèn)題

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的問(wèn)題

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);
    其他代碼}
這樣的代碼，是不是看起來(lái)順眼多了？總結(jié) do-while的主要作用是循環(huán)處理，但是在這篇文章中，我們利用的點(diǎn)并不是循環(huán)功能，而是代碼塊的包裹和中止執(zhí)行的功能。這些細(xì)小的點(diǎn)在一些牛逼的開(kāi)源代碼中很常見(jiàn)，看到了我們就要學(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