C語言添加宏開關

原文地址：http://blog.csdn.net/cp1300/article/details/7773239

我們在寫程序的時候，總是或多或少會加入一些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測試。

//============================================================================
// Name : debug.cpp
// Author : boyce
// Version : 1.0
// Copyright : pku
// Description : Hello World in C++, Ansi-style
//============================================================================
#include <stdio.h>

#define __DEBUG__

#ifdef __DEBUG__
#define DEBUG(format,...) printf("File: "__FILE__", Line: %05d: "format"\n", __LINE__, ##__VA_ARGS__)
#else
#define DEBUG(format,...)
#endif

int main(int argc, char **argv) {
    char str[]="Hello World";
    DEBUG("A ha, check me: %s",str);
    return 0;
}

 

測試結果：