調試中日誌列印printf技巧

前言：

我們在寫程式的時候，總是或多或少會加入一些printf之類的語句用於輸出調試資訊，但是printf語句有個很不方便的地方就是當我們需要發布程式的時候要一條一條的把這些語句刪除，而一旦需要再次調試的時候，這些語句又不得不一條條的加上，這給我們帶來了很大的不便，浪費了我們很多的時間，也造成了調試的效率低下。所以，很多人會選擇使用宏定義的方式來輸出調試語句。

比如，定義一個宏開關：

#define __DEBUG

當需要調試的時候，使用語句：

#ifdef __DEBUG

printf(xxx);

#endif

這種方式的調試，可以通過undef __DEBUG的方式讓告知編譯器不編譯這些語句，從而不再輸出這些語句。但是這種方式的麻煩之處也是顯而易見的，每一條調試語句都需要使用兩條宏定義來包圍，這不但在代碼的編寫上不便，源碼結構也不好看，工作量依然不小。

如果我們能夠把這三條語句編程一條，那該多舒服呀~，於是，我們想到使用這樣的語句：

#ifdef __DEBUG

#define DEBUG(info)    printf(info)

#else

#define DEBUG(info)

#endif

這樣，我們在編寫代碼的時候，使用DEBUG一條語句就可以了，我們把宏開關__DEBUG開啟，所有的DEBUG(info)宏定義資訊都會被替換為printf(info)，關上則會被替換成空，因此不會被編譯。嗯，這次方便多了，一條語句就可以了~~~ 但是，問題也隨之而來了，printf是支援多個參數的，而且是不定參數，當你使用下面這樣的語句時就會報錯：

DEBUG("%s",msg)

這是因為，DEBUG(info)這條宏定義只支援一個參數的替換。

因此，我們希望DEBUG能夠像printf那樣，支援多個參數，並且這些參數剛好展開成為printf語句本身使用的參數，譬如：我們希望DEBUG("%s",msg)能夠展開為printf("%s",msg)

本文：

通過網上的資料查閱，發現自C99規範以後，編譯器就開始支援不定參數的宏定義，就像printf一樣。

大家可以看看這篇文章：http://blog.csdn.net/aobai219/archive/2010/12/22/6092292.aspx

（這個連結也轉的，我已經找不到原始作者到底是誰了，唉，互連網啊。。。）

於是，我們定義了一個這樣的東東：

#define DEBUG(format, ...) printf (format, ##__VA_ARGS__)（' ## '的意思是，如果可變參數被忽略或為空白，將使前置處理器（ preprocessor ）去除掉它前面的那個逗號。）

於是乎，我們神奇地發現，DEBUG完全取代了printf，所有的DEBUG(…)都被完成的替換成了printf(…)，再也不會因那個可惡的逗號而煩惱了。

但是，我們發現，光有printf還不夠，雖然調試資訊是輸出了，可是很多的調試資訊輸出，我們並不能一下子知道這條資訊到底是在那裡列印出來的，於是，我們又想，能不能把當前所在檔案名稱和源碼行位置也列印出來呢，這樣不就一目瞭然了嗎，哪裡還用的著去想，去找調試資訊在哪裡輸出的呢，都已經列印出來了。

於是我們就有了下面的故事。。。

編譯器內建宏：

先介紹幾個編譯器內建的宏定義，這些宏定義不僅可以協助我們完成跨平台的源碼編寫，靈活使用也可以巧妙地幫我們輸出非常有用的調試資訊。

ANSI C標準中有幾個標準預定義宏（也是常用的）：

__LINE__：在原始碼中插入當前原始碼行號；

__FILE__：在源檔案中插入當前源檔案名稱；

__DATE__：在源檔案中插入當前的編譯日期

__TIME__：在源檔案中插入當前編譯時間；

__STDC__：當要求程式嚴格遵循ANSI C標準時該標識被賦值為1；

__cplusplus：當編寫C++程式時該標識符被定義。

編譯器在進行源碼編譯的時候，會自動將這些宏替換為相應內容。

看到這裡，你的眼睛應該一亮了吧，嗯，是的，__FILE__和__LINE__正是我們前面想要的輸出的，於是，我們的每一條語句都變成了：

DEBUG("FILE: %s, LINE: %d…",__FILE__,__LINE__,…)

其實沒有必要，__FILE__本身就會被編譯器置換為字元常量，於是乎我們的語句又變成了這樣：

DEBUG("FILE:"__FILE__", LINE: %d…",__LINE__,…)

但是，我們還是不滿足，依然發現，還是很討厭，為什麼每條語句都要寫"FILE:"__FILE__", LINE: %d 以及,__LINE,這兩個部分呢。這不是浪費我們時間麼。

哈哈，是的，這就是本次大結局，把DEBUG寫成這樣：

DEBUG(format,...) printf("FILE: "__FILE__", LINE: %d: "format"/n", __LINE__, ##__VA_ARGS__)

沒錯，就是這樣。下面，所有的DEBUG資訊都會按照這樣的方式輸出：

FILE: xxx, LINE: xxx, …….

最後：

最後，老規矩，coding測試。

view plain ·········10········20········30········40········50········60········70········80········90········100·······110·······120·······130·······140·······150 //============================================================================   // Name : debug.cpp   // Author : boyce   // Version : 1.0   // Copyright : pku   // Description : Hello World in C++, Ansi-style   //============================================================================   #include   #define __DEBUG__   #ifdef __DEBUG__   #define DEBUG(format,...) printf("File: "__FILE__", Line: %05d: "format"/n", __LINE__, ##__VA_ARGS__)   #else   #define DEBUG(format,...)   #endif   int main() {       char str[]="Hello World";       DEBUG("A ha, check me: %s",str);       return 0;   }    

 

測試結果：

是不是感覺很酷。O(∩_∩)O哈哈

----------------------------------------------------------------------------------------------------------

用可變參數宏(variadic macros)傳遞可變參數表

 

你可能很熟悉在函數中使用可變參數表，如：
void printf(const char* format, …);
 
直到最近，可變參數表還是只能應用在真正的函數中，不能使用在宏中。
 
C99編譯器標準終於改變了這種局面，它允許你可以定義可變參數宏(variadic macros)，這樣你就可以使用擁有可以變化的參數表的宏。可變參數宏就像下面這個樣子：
 
#define debug(…) printf(__VA_ARGS__)
 
預設號代表一個可以變化的參數表。使用保留名 __VA_ARGS__ 把參數傳遞給宏。當宏的調用展開時，實際的參數就傳遞給 printf()了。例如：
 
Debug(“Y = %dn”, y);
 
而處理器會把宏的調用替換成：
 
printf(“Y = %dn”, y);
 
因為debug()是一個可變參數宏，你能在每一次調用中傳遞不同數目的參數：
 
debug(“test”); //一個參數
 
可變參數宏不被ANSI/ISO C++ 所正式支援。因此，你應當檢查你的編譯器，看它是否支援這項技術