ErrLib.h

Go to the documentation of this file.

//Project: ErrLib
//Author: MSDN.WhiteKnight (https://github.com/MSDN-WhiteKnight)
 
#ifndef ErrLib_H_INCLUDED
#define ErrLib_H_INCLUDED
#include <stdlib.h>
#include <stdio.h>
#include <stdint.h>
 
#include <windows.h>
#include <strsafe.h>
#include <process.h>
#include <DbgHelp.h>
#include <Shlobj.h>
 
#ifdef __cplusplus
#include <exception>
#include <comdef.h>
#define ERRLIB_REFERENCE
#define ERRLIB_INLINE inline
#else
#define ERRLIB_REFERENCE &
#define ERRLIB_INLINE __inline
#endif
 
#pragma comment(lib, "advapi32.lib")
#pragma comment(lib, "Dbghelp.lib")
 
#define ErrLib_MaxNameLen 300
 
#define ErrLib_MessageLen 1024
 
#define ErrLib_StackLen 10000
 
#ifdef ERRLIB_EXPORTS
#define ERRLIB_API  __declspec(dllexport) 
#else
#define ERRLIB_API  __declspec(dllimport)
#pragma comment(lib, "ErrLib.lib")
#endif
 
// *** The following are the message definitions. ***
 
#define MSG_ERROR                        ((DWORD)0xC0020100L)
 
#define MSG_WARNING                      ((DWORD)0x80020101L)
 
#define MSG_INFORMATION                  ((DWORD)0x40020102L)
 
// *** Configuration flags *** 
 
#define ERRLIB_OUTPUT_LOGFILE 1
 
#define ERRLIB_OUTPUT_STDERR 2
 
#define ERRLIB_OUTPUT_MBOX 3
 
#define ERRLIB_OUTPUT_EVENT_LOG 4
 
#define ERRLIB_OUTPUT_CUSTOM 5
 
#define ERRLIB_PARAM_VISUALCPPVERSION 100
#define ERRLIB_PARAM_ISDEBUGBUILD 101
 
#define ERRLIB_SYMBOL_NAME   1
 
#define ERRLIB_SYMBOL_MODULE 2
 
#define ERRLIB_SYMBOL_SOURCE 3
 
// *** Typedefs *** 
 
//Function pointer type used as unhandled exception callback
typedef LONG  (WINAPI * ERRLIB_EXCEPTION_CALLBACK) ( struct _EXCEPTION_POINTERS *,LPCWSTR,LPCWSTR);
 
//Function pointer type used for custom logging targets
typedef void (WINAPI * ERRLIB_LOGGING_CALLBACK) (LPCWSTR, void*);
 
typedef struct structERRLIB_STACK_FRAME{
    uint64_t addr;
    uint64_t displacement;
    WCHAR symbol[MAX_SYM_NAME];
    WCHAR module[MAX_PATH];
    WCHAR src_file[MAX_PATH];
    DWORD src_line;
} ERRLIB_STACK_FRAME;
 
typedef struct structERRLIB_STACK_TRACE{
    ERRLIB_STACK_FRAME *data;
    int capacity;
    int count;
    BOOL isOnHeap;
} ERRLIB_STACK_TRACE;
 
// *** Custom exception codes for SEH *** 
 
//Win32 Exception
#define ERRLIB_WIN32_EXCEPTION  0xC0400000 
 
//Com Exception
#define ERRLIB_COM_EXCEPTION  0xC0400001
 
//Application Exception
#define ERRLIB_APP_EXCEPTION  0xC0400002 
 
// *** exported function declarations *** 
 
#ifdef __cplusplus
extern "C" {
#endif
 
ERRLIB_API void __stdcall ErrLib_ErrorMes(LPTSTR lpszFunction,DWORD dw,WCHAR* buf);
 
ERRLIB_API DWORD __stdcall ErrLib_GetWinapiErrorMessage(DWORD dwCode, BOOL localized, WCHAR* pOutput, int cch);
 
//Gets filename from full path
ERRLIB_API WCHAR* __stdcall ErrLib_FileNameFromPathW(WCHAR* path);
 
ERRLIB_API void __stdcall ErrLib_SetLoggingCallback(ERRLIB_LOGGING_CALLBACK pCallback);
 
ERRLIB_API void __stdcall ErrLib_SetExceptionCallback(ERRLIB_EXCEPTION_CALLBACK pCallback);
 
ERRLIB_API void __stdcall ErrLib_SetLogFilePath(LPCWSTR path);
 
ERRLIB_API BOOL __stdcall ErrLib_SetParameter(UINT param, UINT_PTR value);
 
//Initializes the library.
ERRLIB_API BOOL __stdcall ErrLib_InitializeInternal();
 
BOOL ERRLIB_INLINE ErrLib_Initialize(){
    BOOL ret = ErrLib_InitializeInternal();
#ifdef _MSC_VER
    ErrLib_SetParameter(ERRLIB_PARAM_VISUALCPPVERSION, (UINT_PTR)_MSC_VER);
#endif
 
#ifdef _DEBUG
    ErrLib_SetParameter(ERRLIB_PARAM_ISDEBUGBUILD, (UINT_PTR)TRUE);
#endif
 
    return ret;
}
 
ERRLIB_API BOOL __stdcall ErrLib_InitTLS();
ERRLIB_API BOOL __stdcall ErrLib_InitThread();
ERRLIB_API void __stdcall ErrLib_FreeThread();
 
ERRLIB_API BOOL __stdcall ErrLib_RegisterEventSource();
 
ERRLIB_API BOOL __stdcall ErrLib_UnregisterEventSource();
 
ERRLIB_API ERRLIB_STACK_TRACE __stdcall ErrLib_GetStackTrace(CONTEXT* ctx);
 
ERRLIB_API int __stdcall ErrLib_ST_GetFramesCount(const ERRLIB_STACK_TRACE* pStack);
 
ERRLIB_API const ERRLIB_STACK_FRAME*  __stdcall ErrLib_ST_GetFrame(const ERRLIB_STACK_TRACE* pStack, int n);
 
ERRLIB_API uint64_t __stdcall ErrLib_ST_GetAddress(const ERRLIB_STACK_FRAME* pFrame);
 
ERRLIB_API uint64_t __stdcall ErrLib_ST_GetDisplacement(const ERRLIB_STACK_FRAME* pFrame);
 
ERRLIB_API const WCHAR* __stdcall ErrLib_ST_GetStringProperty(const ERRLIB_STACK_FRAME* pFrame, int propId);
 
ERRLIB_API DWORD __stdcall ErrLib_ST_GetSymLine(const ERRLIB_STACK_FRAME* pFrame);
 
ERRLIB_API void __stdcall ErrLib_FreeStackTrace(ERRLIB_STACK_TRACE* pStack);
 
ERRLIB_API void __stdcall ErrLib_PrintStack(CONTEXT* ctx, WCHAR* dest, size_t cch);
 
ERRLIB_API void __stdcall ErrLib_GetExceptionMessage(struct _EXCEPTION_POINTERS* ExceptionInfo, LPWSTR dest, size_t cch);
 
ERRLIB_API void __stdcall ErrLib_LogExceptionInfo(DWORD dwExcCode,LPCWSTR lpwsMessage,LPCWSTR lpwsStackTrace, BOOL visible);
 
ERRLIB_API void __stdcall ErrLib_LogMessage(LPCWSTR lpwsMessage, BOOL visible, DWORD type, BOOL bIncludeStack );
 
ERRLIB_API DWORD __stdcall ErrLib_Except_GetCode();
 
ERRLIB_API LPWSTR __stdcall ErrLib_Except_GetMessage();
 
ERRLIB_API LPWSTR __stdcall ErrLib_Except_GetStackTrace();
 
ERRLIB_API ERRLIB_STACK_TRACE __stdcall ErrLib_Except_GetStackTraceData();
 
ERRLIB_API LONG __stdcall ErrLib_CatchCode( struct _EXCEPTION_POINTERS * ex, DWORD FilteredCode);
ERRLIB_API LONG __stdcall ErrLib_CatchAll( struct _EXCEPTION_POINTERS * ex);
 
ERRLIB_API LPVOID __stdcall ErrLib_StrBuf_GetPointer();
ERRLIB_API LPVOID __stdcall ErrLib_ExArgs_GetPointer();
 
#ifdef __cplusplus
ERRLIB_API void __stdcall ErrLib_HResultToString(HRESULT hr,LPTSTR lpszFunction,WCHAR* buf);
ERRLIB_API void __stdcall ErrLib_GetHResultMessage(HRESULT hr,WCHAR* lpOutput, int cch);
}//extern "C"
#endif
 
 
//**** Helper macro functions *****
 
#define ERRLIB_THROW(mes) {((ULONG_PTR*)ErrLib_ExArgs_GetPointer())[0]=(ULONG_PTR)mes;\
RaiseException(ERRLIB_APP_EXCEPTION,0,1,((ULONG_PTR*)ErrLib_ExArgs_GetPointer()));}
 
#define ERRLIB_THROW_IF_EQUAL(var,value,func) if((var)==(value)){DWORD ErrLibLocal_LastError=GetLastError();\
ErrLib_ErrorMes(L#func,ErrLibLocal_LastError,(WCHAR*)ErrLib_StrBuf_GetPointer());((ULONG_PTR*)ErrLib_ExArgs_GetPointer())[0]=(ULONG_PTR)ErrLibLocal_LastError;\
((ULONG_PTR*)ErrLib_ExArgs_GetPointer())[1]=(ULONG_PTR)ErrLib_StrBuf_GetPointer();RaiseException(ERRLIB_WIN32_EXCEPTION,0,2,(ULONG_PTR*)ErrLib_ExArgs_GetPointer());}
 
#define ERRLIB_THROW_IF_FAILED(var,func) if(FAILED(var)){ErrLib_HResultToString((DWORD)var,L#func,(WCHAR*)ErrLib_StrBuf_GetPointer());\
((ULONG_PTR*)ErrLib_ExArgs_GetPointer())[0]=(ULONG_PTR)var;((ULONG_PTR*)ErrLib_ExArgs_GetPointer())[1]=(ULONG_PTR)ErrLib_StrBuf_GetPointer();RaiseException(ERRLIB_COM_EXCEPTION,0,2,((ULONG_PTR*)ErrLib_ExArgs_GetPointer()));}
 
#define ERRLIB_INVOKEAPI(func, ...) if(FALSE == func( ##__VA_ARGS__ )){DWORD ErrLibLocal_LastError=GetLastError();\
ErrLib_ErrorMes((L#func),ErrLibLocal_LastError,(WCHAR*)ErrLib_StrBuf_GetPointer());\
((ULONG_PTR*)ErrLib_ExArgs_GetPointer())[0]=(ULONG_PTR)ErrLibLocal_LastError;((ULONG_PTR*)ErrLib_ExArgs_GetPointer())[1]=(ULONG_PTR)ErrLib_StrBuf_GetPointer();\
RaiseException(ERRLIB_WIN32_EXCEPTION,0,2,((ULONG_PTR*)ErrLib_ExArgs_GetPointer()));}
 
#define ERRLIB_CATCH_ALL __except(ErrLib_CatchAll(GetExceptionInformation()))
 
#define ERRLIB_CATCH(code) __except(ErrLib_CatchCode(GetExceptionInformation(),code))
 
#endif