C/C++語言宏定義函數封裝小妙招!
宏函數是一種在編程語言中定義的宏,用于在源代碼中進行文本替換。宏函數可以在編譯時展開,將宏的調用處替換為宏函數定義中的文本。宏函數的定義通常以#define關鍵字開始,后面跟著宏的名稱和宏的替換文本。
宏函數的定義可以包含參數,在宏的替換文本中使用這些參數來生成具體的代碼。宏函數的參數在宏調用時被傳遞,并在宏替換時被展開。
1. 函數宏介紹
函數宏,即包含多條語句的宏定義,其通常為某一被頻繁調用的功能的語句封裝,且不想通過函數方式封裝來降低額外的彈棧壓棧開銷。
函數宏本質上為宏,可以直接進行定義,例如:
#define INT_SWAP(a,b) \
int tmp = a; \
a = b; \
b = tmp
但上述的宏具有一個明顯的缺點:當遇到 if、while 等語句且不使用花括號僅調用宏時,實際作用范圍在宏的第一個分號后便結束。即 a = b 和 b = tmp 均不受控制語句所作用。
因此,在工程中,一般使用三種方式來對函數宏進行封裝,分別為 {}、do{...}while(0) 和 ({})。下文將一一對三種方式進行分析,比較各自的優劣點。
2. {} 方式
INT_SWAP 宏使用 {} 封裝后形態如下:
#define INT_SWAP(a,b)\
{ \
int tmp = a; \
a = b; \
b = tmp; \
}
此時,直接調用與在無花括號的控制語句(如 if、while)中調用均能正常運行,例如:
#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
}
但當無花括號的 if 語句存在其他分支(else if、else 等)如:
if (1)
INT_SWAP(var_a, var_b);
else
printf("hello world!\n");
會發現編譯出錯:
...
/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
這是因為 INT_SWAP(var_a, var_b); 最后的 ; 已經把 if 的作用域終結了,后續的 else 當然沒有找到與之匹配的 if 了。
因此,解決方法有兩種,分別為不使用 ;(port.1)或規定必須使用帶花括號的 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");
}
可見,不使用 ; 的調用方式無論從程序閱讀還是使用方法方面都是十分別扭的;而規定必須使用帶花括號的 if 的調用方式有違常理的,因為宏函數應該適用于任何語法。
優缺點總結:
- 優點:簡單粗暴。
- 缺點:不能在無花括號且有分支的 if 語句中直接調用;能夠不帶 ; 直接調用。
3. do{...}while(0) 方式
INT_SWAP 宏使用 do{...}while(0) 封裝后形態如下:
#define INT_SWAP(a,b) \
do{ \
int tmp = a; \
a = b; \
b = tmp; \
}while(0)
do{...}while(0) 表示只執行一遍 {} 內的語句,表象來說與 {} 的功能是一致的。不同的是,do{...}while(0) 可以提前退出函數宏、整合為一條語句與強制調用時必須使用 ;。
由于 do{...}while(0) 實際為 while 循環,因此可以使用關鍵字 break 提前結束循環。利用該特性,可以為函數宏添加參數檢測。例如:
#define INT_SWAP(a,b) \
do{ \
if (a < 0 || b < 0) \
break; \
int tmp = a; \
a = b; \
b = tmp; \
}while(0)
由于 do{...}while(0); 實際為一種語法,編譯器會把 do{...}while(0); 認為為一條語句。因此,do{...}while(0) 方式的函數宏可以在無花括號且有分支的 if 語句中直接調用。例如:
#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 語言規定,do{...}while(0) 語法必須使用 ; 作為語句結尾。因此不可能存在以下語句的程序出現:
if (1)
INT_SWAP(var_a, var_b)
else
{
printf("hello world!\n");
}
優缺點總結:
- 優點:支持在無花括號且有分支的 if 語句中直接調用;支持提前退出函數宏;強制調用時必須使用 ;。
- 缺點:無返回值,不能作為表達式的右值使用。
4. ({}) 方式
({}) 為 GNU C 擴展的語法,非 C 語言的原生語法。
INT_SWAP 宏使用 ({}) 封裝后形態如下:
#define INT_SWAP(a,b) \
({ \
int tmp = a; \
a = b; \
b = tmp; \
})
與 do{...}while(0) 相同,({}) 支持在無花括號且有分支的 if 語句中直接調用。例如:
#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) 不同的是,({}) 不能提前退出函數宏與支持返回值。({}) 畢竟不是 while 循環,不能直接使用 break退出函數宏是比較容易理解。那支持返回值是什么意思呢?
答案是 C 語言規定 ({}) 中的最后一條語句的結果為該雙括號體的返回值。例如:
int main()
{
int a = ({
10;
1000;
});
printf("a = %d\n", a); // a = 1000
}
因此,({}) 可以為函數宏提供返回值。例如:
#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;
}
可見,此時的 INT_SWAP 宏已與函數十分接近。
優缺點總結:
- 優點:支持在無花括號且有分支的 if 語句中直接調用;有返回值,支持作為表達式的右值。
- 缺點:不支持提前退出函數宏;非 C 的原生語法,編譯器可能不支持。
5. 總結
綜上,在 {}、do{...}while(0) 和 ({}) 這三種函數宏的封裝方式之中,應盡可能不使用 {},考慮兼容性一般選擇使用 do{...}while(0),當需要函數宏返回時可以考慮使用 ({}) 或直接定義函數。