宏打印函數

在我們的嵌入式開發中，使用printf打印一些信息是一種常用的調試手段。但是，在打印的信息量比較多的時候，就比較難知道哪些信息在哪個函數里進行打印。

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

這時候我們可以使用宏定義來封裝一個宏打印函數，這個宏打印函數可以顯示打印信息所在的文件、行數、函數名等信息。如：

#defineDBG_PRINTF(fmt,args...)
{
printf("<>",__FILE__,__LINE__,__FUNCTION__);
printf(fmt,##args);
}

使用范例：

可見，使用方法與printf的使用方法一樣，而且每條打印語句開頭都會打印調試信息所在的文件名、行號、函數名信息，方便我們查找一些調試信息。

其中，__FILE__、__LINE__、__FUNCTION__這三個宏是編譯器內置宏定義，分別代表調試信息所在文件、行號、函數。

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

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

第二條printf中的##符號是為了處理args不代表任何參數的情況。如：

DBG_PRINTF("Hello world");

當不加##符號是，以上宏的第二條語句被拓展為：

printf("Helloworld
",);

可見，多出了一個逗號，這個逗號是多余的。

加上##符號后，以上宏的第二條語句被拓展為：

printf("Helloworld
");

這才是我們想要的結果。其實這些結果我們通過查看預處理文件可以清晰的知道：

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

intprintf(constchar*__format,...)

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

打印調試宏開關

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

所以，為了避免打印調試信息帶來的資源開銷，我們可以把這些打印調試語句給注釋掉。

一種方法是逐句進行注釋，這是一種比較低效的方法。比較高效的方法就是添加調試宏開關，利用條件編譯來選擇打印/不打印調試信息。

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

#defineDEBUG1

#ifDEBUG
#defineDBG_PRINTF(fmt,args...)
{
printf("<>",__FILE__,__LINE__,__FUNCTION__);
printf(fmt,##args);
}
#else
#defineDBG_PRINTF(fmt,args...)
#endif

根據DEBUG宏的值來選擇對應的打印宏函數。當DEBUG的值為1時啟動相關的打印調試語句，DEBUG的值為0時則關閉打印調試語句。

這樣我們就可以很方便的通過設置DEBUG宏的值來啟動與關閉我們整個工程的DBG_PRINTF打印調試信息。

do{}while(0)

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

此時會報語法錯誤。為什么呢？

同樣的，我們可以先來看一下我們的demo代碼預處理過后，相應的宏代碼會被轉換為什么。如：

這里我們可以看到，我們的if、else結構代碼被替換為如下形式：

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

顯然，出現了語法錯誤。if之后的大括號之后不能加分號，這里的分號其實可以看做一條空語句，這個空語句會把if與else給分隔開來，導致else不能正確匹配到if，導致語法錯誤。

為了解決這個問題，有幾種方法。第一種方法是：把分號去掉。代碼變成：

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

以上兩種方法都可以正常編譯、運行了。

但是，我們C語言中，每條語句往往以分號結尾；并且，總有些人習慣在if判斷之后只有一條語句的情況下不加大括號；而且我們創建的DBG_PRINTF宏函數的目的就是為了對標printf函數，printf函數的使用加分號在任何地方的使用都是沒有問題的。

基于這幾個原因，我們有必要再對我們的DBG_PRINTF宏函數進行一個改造。

下面引入do{}while(0)來對我們的DBG_PRINTF進行一個簡單的改造。改造后的DBG_PRINTF宏函數如下：

#define DBG_PRINTF(fmt, args...)  
do
{
    printf("<> ", __FILE__, __LINE__, __FUNCTION__);
    printf(fmt, ##args);
}while(0)

這里的do...while循環的循環體只執行一次，與不加循環是效果一樣。并且，可以避免了上面的問題。預處理文件：

我們的宏函數實體中，while(0)后面不加分號，在實際調用時補上分號，既符合了C語言語句分號結尾的習慣，也符合了do...while的語法規則。

使用do{}while(0)來封裝宏函數可能會讓很多初學者看著不習慣，但必須承認的是，這確確實實是一種很常用的方法。

在STM32的HAL庫中搜索while(0)：

在Linux源碼中搜索while(0)：

可見，在實際應用中，do{}while(0)用的很多。

#運算符與##運算符

這兩個運算符之前也有分享過，這里順便也提一下。

#號作為一個預處理運算符，可以把記號轉換成字符串。

例如，如果A是一個宏形參，那么#A就是轉換為字符串"A"的形參名。這個過程稱為字符串化（stringizing）。以下程序演示這個過程：

##運算符可以把兩個記號組合成一個記號。以下程序演示這個過程：

這個運算符用得很多。如：

END 審核編輯 ：李倩