巧用宏进行程序中的调试

转载的两篇是目前我见过很容易理解且也很详细的文章了

转载巧用可变参数宏、编译器内置宏和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测试

//============================================================================
// 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;
}

---

转载 Linux程序开发打印Debug信息的使用技巧
少废话，coding 最重要的是如何debug，debug 当然就少不了把程序信息输出，如何清晰明了地打印出程序信息，可以快速判断程序运行情况，定位程序出问题的地方。先来一段代码实战下再说：

#include <stdio.h>
#include <stdlib.h>
#include <errno.h>

#ifndef __USE_DEBUG
#define __USE_DEBUG

#define USE_DEBUG
#ifdef USE_DEBUG
#define DEBUG_LINE() printf("[%s:%s] line=%d\r\n",__FILE__, __func__, __LINE__)
#define DEBUG_ERR(fmt, args...) printf("\033[46;31m[%s:%d]\033[0m "#fmt" errno=%d, %m\r\n", __func__, __LINE__, ##args, errno, errno)
#define DEBUG_INFO(fmt, args...) printf("\033[33m[%s:%d]\033[0m "#fmt"\r\n", __func__, __LINE__, ##args)
#else
#define DEBUG_LINE()
#define DEBUG_ERR(fmt, ...)
#define DEBUG_INFO(fmt, ...)
#endif

#endif

void func()
{
        DEBUG_LINE();
        DEBUG_INFO("Garfield test DEBUG_INFO() d: %d ; s: %s", 1 , __FUNCTION__);
        DEBUG_ERR("Garfield test DEBUG_ERR() d: %d ; s: %s", 2 , __FUNCTION__);
}

int main(int argc,char **argv)
{
        func();

        return 0;
}

分析：
1， 使用颜色打印调试信息：

printf("\033[46;31m[%s:%d]\033[0m "#fmt" errno=%d, %m\r\n", __func__, __LINE__, ##args, errno, errno);

上面printf时在Linux 命令行下打印出带颜色的字体，方便一眼区分不同种类的调试信息，只需要加上一些颜色代码，例如：这里的46代表底色, 31代表字体的颜色。
使用ascii code 是对颜色调用的始末格式如下：

\033[ ; m …… \033[0m

后面哪个 ”\033[0m” 是对前面哪个颜色载入的结束，恢复到终端原来的背景色和字体色，可以把后面哪个修改成如下试试：

#define DEBUG_ERR(fmt, args...) printf("\033[46;31m[%s:%d]\033[40;37m "#fmt" errno=%d, %m\r\n", __func__, __LINE__, ##args, errno, errno);

下面列出 ascii code 的颜色值：
字背景颜色范围:40—-49 字颜色:30———–39
40:黑 30:黑
41:深红 31:红
42:绿 32:绿
43:黄色 33:黄
44:蓝色 34:蓝色
45:紫色 35:紫色
46:深绿 36:深绿
47:白色 37:白色

打印调试信息的跟踪位置：

printf("[%s:%s] line=%d\r\n",__FILE__, __func__, __LINE__);
printf("\033[33m[%s:%d]\033[0m "#fmt"\r\n", __func__, __LINE__, ##args);

如上代码：
1）__FILE__ 打印出调试信息所在的文件名；
2）__func__ 将会打印出调试信息所在的函数名；
3）__LINE__ 将会打印出调试信息所在文件的行号；

使用不定参数向打印信息里面加入自己想看到的调试信息：

#define DEBUG_INFO(fmt, args...) printf("\033[33m[%s:%d]\033[0m "#fmt"\r\n", __func__, __LINE__, ##args);

调用方式如下：

int i = 110;
char * s = “hello world!”;
DEBUG_INFO("Garfield test DEBUG_INFO() d: %d ; s: %s", i , s);

至于不定数量参数宏与不定参数函数的使用就没神马好说的啦，自己去google吧！

下面引用一位大侠的blog，列出一些常用的debug 语句：
出自：http://blog.mcuol.com/User/luoming/Article/16499_1.htm

#ifdef DEBUG
#define F_OUT printf("%s:", __FUNCTION__);fflush(stdout);
#define L_OUT printf("%s:%d:", __FILE__, __LINE__);fflush(stdout);
#define A_OUT printf("%s:%d:%s:", __FILE__, __LINE__, __FUNCTION__);fflush(stdout);
#define D_OUT printf("DEBUG:");fflush(stdout);

#define F_PRINTF(fmt, arg...) F_OUT printf(fmt, ##arg)
#define L_PRINTF(fmt, arg...) L_OUT printf(fmt, ##arg)
#define A_PRINTF(fmt, arg...) A_OUT printf(fmt, ##arg)
#define PRINTF(fmt, arg...) D_OUT printf(fmt, ##arg)
#define DBUG(a) {a;}
#else
#define F_OUT
#define L_OUT
#define A_OUT
#define D_OUT

#define F_PRINTF(fmt, arg...)
#define L_PRINTF(fmt, arg...)
#define A_PRINTF(fmt, arg...)
#define PRINTF(fmt, arg...)
#define DBUG(a)
#endif

#define F_PERROR(fmt) F_OUT perror(fmt)
#define L_PERROR(fmt) L_OUT perror(fmt)
#define A_PERROR(fmt) A_OUT perror(fmt)
#define PERROR(fmt) D_OUT perror(fmt)