StackTracer.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants
Licensee a limited, non-exclusive, non-transferable, royalty-free license
(without the right to sublicense) to use the API solely for the purpose of
Licensee's internal development efforts to develop applications for which
the API was provided.
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: Base
File: LogMessage
Included in API: False
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include <NDEVR/String.h>
#ifdef _WIN32
    #include <vector>
    #include <map>
    #include <Windows.h>
    #include <string>
    
#endif
namespace NDEVR
{
    /**--------------------------------------------------------------------------------------------------
    \brief Used with StackTracer to track a specific function call in a stack trace.
    **/
    struct FunctionCall
    {
        String FunctionName;
        String FileName;
        int LineNumber;
    };
    /**--------------------------------------------------------------------------------------------------
    \brief Traces the stack to give the call-stack of a thrown exception.
    **/
    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;
 
    };
}