巨集列印函式

在我們的嵌入式開發中，使用printf列印一些資訊是一種常用的除錯手段。但是，在列印的資訊量比較多的時候，就比較難知道哪些資訊在哪個函式裡進行列印。

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

這時候我們可以使用巨集定義來封裝一個巨集列印函式，這個巨集列印函式可以顯示列印資訊所在的檔案、行數、函式名等資訊。如：

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

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

DBG_PRINTF("Hello world");

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

printf("Hello world\n", );

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

加上##符號後，以上巨集的第二條語句被拓展為：

printf("Hello world\n");

這些分析過程可通過檢視預處理檔案獲知：

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

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

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

列印除錯巨集開關

通常情況下，一些列印除錯資訊只是在我們除錯階段需要的，在程式釋出階段是不需要的。

所以，為了避免列印除錯資訊帶來的資源開銷，我們可以把這些列印除錯語句給註釋掉。

一種方法是逐句進行註釋，這是一種比較低效的方法。比較高效的方法就是新增除錯巨集開關，利用條件編譯來選擇列印/不列印除錯資訊。

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

#define DEBUG    1  

#if DEBUG
#define DBG_PRINTF(fmt, args...)    { \
    printf("<<File:%s  Line:%d  Function:%s>> ", __FILE__, __LINE__, __FUNCTION__); \
    printf(fmt, ##args); \
    printf("\r\n"); \
}
#else
#define DBG_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:%s  Line:%d  Function:%s>> ", __FILE__, __LINE__, __FUNCTION__); \
    printf(fmt, ##args); \
    printf("\r\n"); \
} 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）。以下程式演示這個過程：

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

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

【來源】https://mp.weixin.qq.com/s/K3yUcTiSTiqbVt5fwVM3UQ