C 語(yǔ)言函數(shù)宏封裝妙招
1. 函數(shù)宏介紹
函數(shù)宏,即包含多條語(yǔ)句的宏定義,其通常為某一被頻繁調(diào)用的功能的語(yǔ)句封裝,且不想通過(guò)函數(shù)方式封裝來(lái)降低額外的彈棧壓棧開銷。
函數(shù)宏本質(zhì)上為宏,可以直接進(jìn)行定義,例如:
#define INT_SWAP(a,b) \
int tmp = a; \
a = b; \
b = tmp
但上述的宏具有一個(gè)明顯的缺點(diǎn):當(dāng)遇到 if、while 等語(yǔ)句且不使用花括號(hào)僅調(diào)用宏時(shí),實(shí)際作用范圍在宏的第一個(gè)分號(hào)后便結(jié)束。即 a = b 和 b = tmp 均不受控制語(yǔ)句所作用。
因此,在工程中,一般使用三種方式來(lái)對(duì)函數(shù)宏進(jìn)行封裝,分別為 {}、do{...}while(0) 和 ({})。下文將一一對(duì)三種方式進(jìn)行分析,比較各自的優(yōu)劣點(diǎn)。
2. {} 方式
INT_SWAP 宏使用 {} 封裝后形態(tài)如下:
#define INT_SWAP(a,b)\
{ \
int tmp = a; \
a = b; \
b = tmp; \
}
此時(shí),直接調(diào)用與在無(wú)花括號(hào)的控制語(yǔ)句(如 if、while)中調(diào)用均能正常運(yùn)行,例如:
#define INT_SWAP(a,b) \
{ \
int tmp = a; \
a = b; \
b = tmp; \
}
int main()
{
int var_a = 1;
int var_b = 2;
INT_SWAP(var_a, var_b);
printf("var_a = %d, var_b = %d\n", var_a, var_b); // var_a = 2, var_b = 1
if (1)
INT_SWAP(var_a, var_b);
printf("var_a = %d, var_b = %d\n", var_a, var_b); // var_a = 1, var_b = 2
}
但當(dāng)無(wú)花括號(hào)的 if 語(yǔ)句存在其他分支(else if、else 等)如:
if (1)
INT_SWAP(var_a, var_b);
else
printf("hello world!\n");
會(huì)發(fā)現(xiàn)編譯出錯(cuò):
...
/mnt/hgfs/share/pr_c/src/main.c: In function ‘main’:
/mnt/hgfs/share/pr_c/src/main.c:18:2: error: ‘else’ without a previous ‘if’
else
這是因?yàn)?nbsp;INT_SWAP(var_a, var_b); 最后的 ; 已經(jīng)把 if 的作用域終結(jié)了,后續(xù)的 else 當(dāng)然沒(méi)有找到與之匹配的 if 了。
因此,解決方法有兩種,分別為不使用 ;(port.1)或規(guī)定必須使用帶花括號(hào)的 if(port.2),例如:
/* port.1 */
if (1)
INT_SWAP(var_a, var_b)
else
{
printf("hello world!\n");
}
/* port.2 */
if (1)
{
INT_SWAP(var_a, var_b);
}
else
{
printf("hello world!\n");
}
可見,不使用 ; 的調(diào)用方式無(wú)論從程序閱讀還是使用方法方面都是十分別扭的;而規(guī)定必須使用帶花括號(hào)的 if 的調(diào)用方式有違常理的,因?yàn)楹旰瘮?shù)應(yīng)該適用于任何語(yǔ)法。
優(yōu)缺點(diǎn)總結(jié):
- 優(yōu)點(diǎn):簡(jiǎn)單粗暴。
- 缺點(diǎn):不能在無(wú)花括號(hào)且有分支的 if 語(yǔ)句中直接調(diào)用;能夠不帶 ; 直接調(diào)用。
3. do{...}while(0) 方式
INT_SWAP 宏使用 do{...}while(0) 封裝后形態(tài)如下:
#define INT_SWAP(a,b) \
do{ \
int tmp = a; \
a = b; \
b = tmp; \
}while(0)
do{...}while(0) 表示只執(zhí)行一遍 {} 內(nèi)的語(yǔ)句,表象來(lái)說(shuō)與 {} 的功能是一致的。不同的是,do{...}while(0) 可以提前退出函數(shù)宏、整合為一條語(yǔ)句與強(qiáng)制調(diào)用時(shí)必須使用 ;。
由于 do{...}while(0) 實(shí)際為 while 循環(huán),因此可以使用關(guān)鍵字 break 提前結(jié)束循環(huán)。利用該特性,可以為函數(shù)宏添加參數(shù)檢測(cè)。例如:
#define INT_SWAP(a,b) \
do{ \
if (a < 0 || b < 0) \
break; \
int tmp = a; \
a = b; \
b = tmp; \
}while(0)
由于 do{...}while(0); 實(shí)際為一種語(yǔ)法,編譯器會(huì)把 do{...}while(0); 認(rèn)為為一條語(yǔ)句。因此,do{...}while(0) 方式的函數(shù)宏可以在無(wú)花括號(hào)且有分支的 if 語(yǔ)句中直接調(diào)用。例如:
#define INT_SWAP(a,b) \
do{ \
if (a < 0 || b < 0) \
break; \
int tmp = a; \
a = b; \
b = tmp; \
}while(0)
int main()
{
int var_a = 1;
int var_b = 2;
if (1)
INT_SWAP(var_a, var_b);
else
printf("hello world!\n");
printf("var_a = %d, var_b = %d\n", var_a, var_b); // var_a = 2, var_b = 1
return 0;
}
C 語(yǔ)言規(guī)定,do{...}while(0) 語(yǔ)法必須使用 ; 作為語(yǔ)句結(jié)尾。因此不可能存在以下語(yǔ)句的程序出現(xiàn):
if (1)
INT_SWAP(var_a, var_b)
else
{
printf("hello world!\n");
}
優(yōu)缺點(diǎn)總結(jié):
- 優(yōu)點(diǎn):支持在無(wú)花括號(hào)且有分支的 if 語(yǔ)句中直接調(diào)用;支持提前退出函數(shù)宏;強(qiáng)制調(diào)用時(shí)必須使用 ;。
- 缺點(diǎn):無(wú)返回值,不能作為表達(dá)式的右值使用。
4. ({}) 方式
({}) 為 GNU C 擴(kuò)展的語(yǔ)法,非 C 語(yǔ)言的原生語(yǔ)法。
INT_SWAP 宏使用 ({}) 封裝后形態(tài)如下:
#define INT_SWAP(a,b) \
({ \
int tmp = a; \
a = b; \
b = tmp; \
})
與 do{...}while(0) 相同,({}) 支持在無(wú)花括號(hào)且有分支的 if 語(yǔ)句中直接調(diào)用。例如:
#define INT_SWAP(a,b) \
({ \
int tmp = a; \
a = b; \
b = tmp; \
})
int main()
{
int var_a = 1;
int var_b = 2;
if (1)
INT_SWAP(var_a, var_b);
else
printf("hello world!\n");
printf("var_a = %d, var_b = %d\n", var_a, var_b); // var_a = 2, var_b = 1
return 0;
}
與 do{...}while(0) 不同的是,({}) 不能提前退出函數(shù)宏與支持返回值。({}) 畢竟不是 while 循環(huán),不能直接使用 break退出函數(shù)宏是比較容易理解。那支持返回值是什么意思呢?
答案是 C 語(yǔ)言規(guī)定 ({}) 中的最后一條語(yǔ)句的結(jié)果為該雙括號(hào)體的返回值。例如:
int main()
{
int a = ({
10;
1000;
});
printf("a = %d\n", a); // a = 1000
}
因此,({}) 可以為函數(shù)宏提供返回值。例如:
#define INT_SWAP(a,b) \
({ \
int ret = 0; \
if (a < 0 || b < 0) \
{ \
ret = -1; \
} \
else \
{ \
int tmp = a; \
a = b; \
b = tmp; \
} \
ret; \
})
int main()
{
int var_a = 1;
int var_b = 2;
if (INT_SWAP(var_a, var_b) != -1)
printf("swap success !!\n"); // swap success !!
else
printf("swap fail !!\n");
printf("var_a = %d, var_b = %d\n", var_a, var_b); // var_a = 2, var_b = 1
return 0;
}
可見,此時(shí)的 INT_SWAP 宏已與函數(shù)十分接近。
優(yōu)缺點(diǎn)總結(jié):
- 優(yōu)點(diǎn):支持在無(wú)花括號(hào)且有分支的 if 語(yǔ)句中直接調(diào)用;有返回值,支持作為表達(dá)式的右值。
- 缺點(diǎn):不支持提前退出函數(shù)宏;非 C 的原生語(yǔ)法,編譯器可能不支持。
5. 總結(jié)
綜上,在 {}、do{...}while(0) 和 ({}) 這三種函數(shù)宏的封裝方式之中,應(yīng)盡可能不使用 {},考慮兼容性一般選擇使用 do{...}while(0),當(dāng)需要函數(shù)宏返回時(shí)可以考慮使用 ({}) 或直接定義函數(shù)。