StackTracer.h

Go to the documentation of this file.

/*
//
// Description: This class is used to get the call stack when there is an exception being caught use SEH
//
// Author: Baiyan Huang
// Date: 8/30/2009
//
// Usage:
//      __try
//      {
//          // main functions...
//      }
//      __except(StackTracer::ExceptionFilter(GetExceptionInformation()))
//      {
//          // Your code to show or log the exception msg...
//      }
*/
 
#pragma once
#include <NDEVR/String.h>
#ifdef _WIN32
    #include <vector>
    #include <map>
    #include <Windows.h>
    #include <string>
    
#endif
namespace NDEVR
{
    struct FunctionCall
    {
        String FunctionName;
        String FileName;
        int LineNumber;
    };
    class StackTracer
    {
    public:
#ifdef _WIN32
        static LONG ExceptionFilter(LPEXCEPTION_POINTERS e);
        static DWORD GetExceptionCode();
#endif
        // return the exception message along with call stacks
        static String GetCallStack();
        static String GetExceptionMessage();
 
        // Return exception code and call stack data structure so that 
        // user could customize their own message format
        static Buffer<FunctionCall> GetExceptionCallStack();
        String callStack() const;
 
    private:
        static StackTracer s_StackTracer;
 
    private:
        StackTracer(void);
        ~StackTracer(void);
#ifdef _WIN32
        // The main function to handle exception
        LONG __stdcall HandleException(LPEXCEPTION_POINTERS e);
 
        // Work through the stack upwards to get the entire call stack
        void traceCallStack(CONTEXT* pContext);
#endif
    private:
#ifdef _WIN32
        DWORD m_dwExceptionCode = 0;
        typedef std::map<DWORD, const char*> CodeDescMap;
        CodeDescMap m_mapCodeDesc;
        DWORD m_dwMachineType = 0; // Machine type matters when trace the call stack (StackWalk64)
#endif
        Buffer<FunctionCall> m_call_stack;
 
    };
}