printf 的宏定義版本
前言:
我們在寫程序的時候,總是或多或少會加入一些printf之類的語句用于輸出調(diào)試信息,但是printf語句有個很不方便的地方就是當(dāng)我們需要發(fā)布程序的時候要一條一條的把這些語句刪除,而一旦需要再次調(diào)試的時候,這些語句又不得不一條條的加上,這給我們帶來了很大的不便,浪費(fèi)了我們很多的時間,也造成了調(diào)試的效率低下。所以,很多人會選擇使用宏定義的方式來輸出調(diào)試語句。
比如,定義一個宏開關(guān):
#define __DEBUG
當(dāng)需要調(diào)試的時候,使用語句:
#ifdef __DEBUG
printf(xxx);
#endif
這種方式的調(diào)試,可以通過undef __DEBUG的方式讓告知編譯器不編譯這些語句,從而不再輸出這些語句。但是這種方式的麻煩之處也是顯而易見的,每一條調(diào)試語句都需要使用兩條宏定義來包圍,這不但在代碼的編寫上不便,源碼結(jié)構(gòu)也不好看,工作量依然不小。
如果我們能夠把這三條語句編程一條,那該多舒服呀~,于是,我們想到使用這樣的語句:
#ifdef __DEBUG
#define DEBUG(info)????printf(info)
#else
#define DEBUG(info)
#endif
這樣,我們在編寫代碼的時候,使用DEBUG一條語句就可以了,我們把宏開關(guān)__DEBUG打開,所有的DEBUG(info)宏定義信息都會被替換為printf(info),關(guān)上則會被替換成空,因此不會被編譯。嗯,這次方便多了,一條語句就可以了~~~ 但是,問題也隨之而來了,printf是支持多個參數(shù)的,而且是不定參數(shù),當(dāng)你使用下面這樣的語句時就會報錯:
DEBUG("%s",msg)
這是因為,DEBUG(info)這條宏定義只支持一個參數(shù)的替換。
因此,我們希望DEBUG能夠像printf那樣,支持多個參數(shù),并且這些參數(shù)剛好展開成為printf語句本身使用的參數(shù),譬如:我們希望DEBUG("%s",msg)能夠展開為printf("%s",msg)
正文:
通過網(wǎng)上的資料查閱,發(fā)現(xiàn)自C99規(guī)范以后,編譯器就開始支持不定參數(shù)的宏定義,就像printf一樣。
于是,我們定義了一個這樣的東東:
#define DEBUG(format, ...) printf (format, ##__VA_ARGS__)(' ## '的意思是,如果可變參數(shù)被忽略或為空,將使預(yù)處理器( preprocessor )去除掉它前面的那個逗號。)
于是乎,我們神奇地發(fā)現(xiàn),DEBUG完全取代了printf,所有的DEBUG(…)都被完成的替換成了printf(…),再也不會因那個可惡的逗號而煩惱了。
但是,我們發(fā)現(xiàn),光有printf還不夠,雖然調(diào)試信息是輸出了,可是很多的調(diào)試信息輸出,我們并不能一下子知道這條信息到底是在那里打印出來的,于是,我們又想,能不能把當(dāng)前所在文件名和源碼行位置也打印出來呢,這樣不就一目了然了嗎,哪里還用的著去想,去找調(diào)試信息在哪里輸出的呢,都已經(jīng)打印出來了!
于是我們就有了下面的故事。。。
編譯器內(nèi)置宏:
先介紹幾個編譯器內(nèi)置的宏定義,這些宏定義不僅可以幫助我們完成跨平臺的源碼編寫,靈活使用也可以巧妙地幫我們輸出非常有用的調(diào)試信息。
ANSI C標(biāo)準(zhǔn)中有幾個標(biāo)準(zhǔn)預(yù)定義宏(也是常用的):
__LINE__:在源代碼中插入當(dāng)前源代碼行號;
__FILE__:在源文件中插入當(dāng)前源文件名;
__DATE__:在源文件中插入當(dāng)前的編譯日期
__TIME__:在源文件中插入當(dāng)前編譯時間;
__STDC__:當(dāng)要求程序嚴(yán)格遵循ANSI C標(biāo)準(zhǔn)時該標(biāo)識被賦值為1;
__cplusplus:當(dāng)編寫C++程序時該標(biāo)識符被定義。
編譯器在進(jìn)行源碼編譯的時候,會自動將這些宏替換為相應(yīng)內(nèi)容。
看到這里,你的眼睛應(yīng)該一亮了吧,嗯,是的,__FILE__和__LINE__正是我們前面想要的輸出的,于是,我們的每一條語句都變成了:
DEBUG("FILE: %s, LINE: %d…",__FILE__,__LINE__,…)
其實沒有必要,__FILE__本身就會被編譯器置換為字符常量,于是乎我們的語句又變成了這樣:
DEBUG("FILE:"__FILE__", LINE: %d…",__LINE__,…)
但是,我們還是不滿足,依然發(fā)現(xiàn),還是很討厭,為什么每條語句都要寫"FILE:"__FILE__", LINE: %d 以及,__LINE,這兩個部分呢?這不是浪費(fèi)我們時間么?
哈哈,是的,這就是本次大結(jié)局,把DEBUG寫成這樣:
DEBUG(format,...) printf("FILE: "__FILE__", LINE: %d: "format"/n", __LINE__, ##__VA_ARGS__)
沒錯,就是這樣!下面,所有的DEBUG信息都會按照這樣的方式輸出:
FILE: xxx, LINE: xxx, …….
最后:
最后,老規(guī)矩,coding測試。
?
測試結(jié)果:
是不是感覺很酷?O(∩_∩)O哈哈
~