【原】C語(yǔ)言、嵌入式中幾個(gè)非常實(shí)用的宏技巧

嵌入式大雜燴 2021-08-20

展開全文

宏打印函數(shù)

在我們的嵌入式開發(fā)中，使用printf打印一些信息是一種常用的調(diào)試手段。但是，在打印的信息量比較多的時(shí)候，就比較難知道哪些信息在哪個(gè)函數(shù)里進(jìn)行打印。

特別是對(duì)于異常情況的打印，我們需要快速定位到異常情況的位置。

這時(shí)候我們可以使用宏定義來(lái)封裝一個(gè)宏打印函數(shù)，這個(gè)宏打印函數(shù)可以顯示打印信息所在的文件、行數(shù)、函數(shù)名等信息。如：

左右滑動(dòng)查看全部代碼>>>

#define DBG_PRINTF(fmt, args...)  \
{\
 printf("<<File:%s  Line:%d  Function:%s>> ", __FILE__, __LINE__, __FUNCTION__);\
 printf(fmt, ##args);\
}

使用范例：

可見，使用方法與printf的使用方法一樣，而且每條打印語(yǔ)句開頭都會(huì)打印調(diào)試信息所在的文件名、行號(hào)、函數(shù)名信息，方便我們查找一些調(diào)試信息。

其中，__FILE__、__LINE__、__FUNCTION__這三個(gè)宏是編譯器內(nèi)置宏定義，分別代表調(diào)試信息所在文件、行號(hào)、函數(shù)。

除此之外，常用的宏還有：__DATE__、__TIME__，分別代表當(dāng)前的編譯日期與時(shí)間。如：

DBG_PRINTF("Compile Time: %s  %s\n", __DATE__, __TIME__);

第二條printf中的##符號(hào)是為了處理args不代表任何參數(shù)的情況。如：

DBG_PRINTF("Hello world");

當(dāng)不加##符號(hào)是，以上宏的第二條語(yǔ)句被拓展為：

printf("Hello world\n", );

可見，多出了一個(gè)逗號(hào)，這個(gè)逗號(hào)是多余的。

加上##符號(hào)后，以上宏的第二條語(yǔ)句被拓展為：

printf("Hello world\n");

這才是我們想要的結(jié)果。其實(shí)這些結(jié)果我們通過(guò)查看預(yù)處理文件可以清晰的知道：

最后需要注意的是，這個(gè)DBG_PRINTF還是與printf不一樣的。DBG_PRINTF宏是兩條語(yǔ)句的組合，無(wú)返回值；而printf的原型是：

int printf (const char *__format, ...)

但是我們一般都很少使用printf的返回值，所以DBG_PRINTF的用法與printf函數(shù)基本一致。

打印調(diào)試宏開關(guān)

通常情況下，一些打印調(diào)試信息只是在我們調(diào)試階段需要的，在程序發(fā)布階段是不需要的。

所以，為了避免打印調(diào)試信息帶來(lái)的資源開銷，我們可以把這些打印調(diào)試語(yǔ)句給注釋掉。

一種方法是逐句進(jìn)行注釋，這是一種比較低效的方法。比較高效的方法就是添加調(diào)試宏開關(guān)，利用條件編譯來(lái)選擇打印/不打印調(diào)試信息。

比如我們可以把上面的代碼改造為：

#define  DEBUG   1  

#if DEBUG
  #define DBG_PRINTF(fmt, args...)  \
  {\
    printf("<<File:%s  Line:%d  Function:%s>> ", __FILE__, __LINE__, __FUNCTION__);\
    printf(fmt, ##args);\
  }
#else
  #define DBG_PRINTF(fmt, args...)   
#endif

根據(jù)DEBUG宏的值來(lái)選擇對(duì)應(yīng)的打印宏函數(shù)。當(dāng)DEBUG的值為1時(shí)啟動(dòng)相關(guān)的打印調(diào)試語(yǔ)句，DEBUG的值為0時(shí)則關(guān)閉打印調(diào)試語(yǔ)句。

這樣我們就可以很方便的通過(guò)設(shè)置DEBUG宏的值來(lái)啟動(dòng)與關(guān)閉我們整個(gè)工程的DBG_PRINTF打印調(diào)試信息。

do{}while(0)

其實(shí)，上面我們封裝的打印宏DBG_PRINTF還有一點(diǎn)缺陷，比如我們與if、else使用的時(shí)候，會(huì)有這樣的一種使用情況：

此時(shí)會(huì)報(bào)語(yǔ)法錯(cuò)誤。為什么呢？

同樣的，我們可以先來(lái)看一下我們的demo代碼預(yù)處理過(guò)后，相應(yīng)的宏代碼會(huì)被轉(zhuǎn)換為什么。如：

這里我們可以看到，我們的if、else結(jié)構(gòu)代碼被替換為如下形式：

if(c)
{ /* ....... */ };
else
{ /* ....... */ };

顯然，出現(xiàn)了語(yǔ)法錯(cuò)誤。if之后的大括號(hào)之后不能加分號(hào)，這里的分號(hào)其實(shí)可以看做一條空語(yǔ)句，這個(gè)空語(yǔ)句會(huì)把if與else給分隔開來(lái)，導(dǎo)致else不能正確匹配到if，導(dǎo)致語(yǔ)法錯(cuò)誤。

為了解決這個(gè)問(wèn)題，有幾種方法。第一種方法是：把分號(hào)去掉。代碼變成：

第二種方法是：在if之后使用DBG_PRINTF打印調(diào)試時(shí)總是加{}。代碼變成：

以上兩種方法都可以正常編譯、運(yùn)行了。

但是，我們C語(yǔ)言中，每條語(yǔ)句往往以分號(hào)結(jié)尾；并且，總有些人習(xí)慣在if判斷之后只有一條語(yǔ)句的情況下不加大括號(hào)；而且我們創(chuàng)建的DBG_PRINTF宏函數(shù)的目的就是為了對(duì)標(biāo)printf函數(shù)，printf函數(shù)的使用加分號(hào)在任何地方的使用都是沒(méi)有問(wèn)題的。

基于這幾個(gè)原因，我們有必要再對(duì)我們的DBG_PRINTF宏函數(shù)進(jìn)行一個(gè)改造。

下面引入do{}while(0)來(lái)對(duì)我們的DBG_PRINTF進(jìn)行一個(gè)簡(jiǎn)單的改造。改造后的DBG_PRINTF宏函數(shù)如下：

#define DBG_PRINTF(fmt, args...)  \
do\
{\
    printf("<<File:%s  Line:%d  Function:%s>> ", __FILE__, __LINE__, __FUNCTION__);\
    printf(fmt, ##args);\
}while(0)

這里的do...while循環(huán)的循環(huán)體只執(zhí)行一次，與不加循環(huán)是效果一樣。并且，可以避免了上面的問(wèn)題。預(yù)處理文件：