C++中打印函数调用情况

　　在Java 中，如果产生异常，程序员可以很方便地调用printStackTrace()显示堆栈情况，这是因为Java虚拟机掌握所有运行时系统的信息。但是在C++中就没有相应的功能了，为了方便在调试时观察堆栈调用情况，我写了个很简单的框架来实现基本功能。

 

#include <string>
#include <list>
#include <exception>
#include <iostream>
using std::cout;
using std::endl;

/**//**
 * Calling stack recording class, used to store function names in current
 * calling stack.
 *
 * @see Tracelet
 */
class StackRecord
...{
public:
    static void PrintStack();
    static void Push(const std::string& aFuncName);
    static void Pop();
private:
    static std::list<std::string> mNames;
};

std::list<std::string> StackRecord::mNames;

void StackRecord::Push(const std::string& aFuncName)
...{
    mNames.push_back(aFuncName);
}

void StackRecord::Pop()
...{
    mNames.pop_back();
}

void StackRecord::PrintStack()
...{
    std::list<std::string>::const_iterator p;
    for(p = mNames.begin(); p!=mNames.end(); ++p)
        cout << *p << endl;
}



/**//**
 * Facility class to help add function name to trace record.
 */
class Tracelet
...{
public:
    Tracelet(const std::string& aFuncName);
    ~Tracelet();
};

Tracelet::Tracelet(const std::string& aFuncName)
...{
    StackRecord::Push(aFuncName);
}

Tracelet::~Tracelet()
...{
    if (std::uncaught_exception())
        // during exception handling
        StackRecord::PrintStack();
    // during normal return
    StackRecord::Pop();
}

#define TRACE(s) Tracelet tracelet(s)

StackRecord类负责纪录当前函数调用栈的情况，Tracelet类负责push或者pop函数名称。下面是一个例子：

#include "trace.h"

void foo()
...{
    TRACE("foo");
    throw 'a';
}

int main()
...{
    TRACE("main");

    try ...{
        foo();
    } catch(char a) ...{
        cout << "exception occured" << endl;
    }

    return 0;
}

输出结果为：

main
foo

原理是，当exception发生，并且被try_catch处理时，所有在try_catch块内的堆栈变量都会自动调用destructor。在每个函数声明一个Tracelet的局部变量对象，这样，当exception发生时，该对象被自动解构，destructor中的uncaught_exception()函数会判断destructor是不是被exception handler调用的，是的话打印stack trace。

如果程序没有exception handler, 也就是try_catch块，而产生了exception时，系统默认调用terminate函数，这时如果也想看到stack trace，则要用set_terminate()定义自己的terminate handler函数。代码如下：

#include "trace.h"

void termFunc()
...{
    StackRecord::PrintStack();
}

void foo()
...{
    TRACE("foo");
    throw 'a';
}

int main()
...{
    std::set_terminate(termFunc);

    TRACE("main");

    foo();

    return 0;
}