/*===========================================================================
*
* File: DL_Err.H
* Author: Dave Humphrey (uesp@m0use.net)
* Created On: Tuesday, April 24, 2001
*
* Contains the definitions for the CErrorHandler class, used for the
* general handling of errors.
*
*=========================================================================*/
#ifndef __DL_ERR_H
#define __DL_ERR_H
/*===========================================================================
*
* Begin Required Includes
*
*=========================================================================*/
#include "dl_mem.h"
/*===========================================================================
* End of Required Includes
*=========================================================================*/
/*===========================================================================
*
* Begin Defines
*
*=========================================================================*/
/* Maximum size of a message string for the error message strings */
#define MAX_ERROR_MESSAGESIZE 1024
/* Number of error incidents allowed at a time */
#define MAX_ERROR_INCIDENTS 50
/*===========================================================================
* End of Defines
*=========================================================================*/
/*===========================================================================
*
* Begin Custom Error Code Defines
*
*=========================================================================*/
#define ERR_NONE ((errcode_t) 0)
#define ERR_MEM ((errcode_t) 1)
#define ERR_OPENFILE ((errcode_t) 2)
#define ERR_READFILE ((errcode_t) 3)
#define ERR_WRITEFILE ((errcode_t) 4)
#define ERR_OVERFLOW ((errcode_t) 5)
#define ERR_BADINPUT ((errcode_t) 6)
#define ERR_BADARRAYINDEX ((errcode_t) 7)
#define ERR_MAXINDEX ((errcode_t) 8)
#define ERR_SYSTEM ((errcode_t) 9)
#define ERR_TCGRAPH ((errcode_t) 10) /* Only in TC-DOS */
#define ERR_WINDOWS ((errcode_t) 11) /* Only under windows */
#define ERR_CUSTOM ((errcode_t) 12)
/*===========================================================================
* End of Custom Error Code Defines
*=========================================================================*/
/*===========================================================================
*
* Begin Type and Structure Definitions
*
*=========================================================================*/
/* Define type for error codes */
typedef long errcode_t;
/* Define the severity level of the custom error */
typedef enum {
ERRLEVEL_UNKNOWN = -1,
ERRLEVEL_INFO = 0,
ERRLEVEL_WARNING = 1,
ERRLEVEL_ERROR = 2,
ERRLEVEL_CRITICAL = 3
} errlevel_t;
/* Type for a error handler notify function */
typedef int ( ERR_NOTIFY_FUNCTION) (const char* pTitle, const char* pMsg);
typedef int (*PERR_NOTIFY_FUNCTION) (const char* pTitle, const char* pMsg);
/*===========================================================================
* End of Type and Structure Definitions
*=========================================================================*/
/*===========================================================================
*
* Begin Custom Error Function Definition
*
* The following function type definition allows the expansion of the
* error handler to support multiple systems of errors. The functions
* take an error code and return the associated error message. The
* functions should always return a valid string.
*
*=========================================================================*/
typedef char* ( ERR_CUSTOM_FUNCTION) (const errcode_t Code);
typedef char* (*PERR_CUSTOM_FUNCTION) (const errcode_t Code);
/*===========================================================================
* End of Custom Error Function Definition
*=========================================================================*/
/*===========================================================================
*
* Begin Class CErrorRecord Definition
*
* Defines one custom error definition for the CErrorHandler class. Uses
* a simple linked list structure.
*
*=========================================================================*/
class CErrorRecord {
/*---------- Begin Private Class Members ----------------------*/
private:
errcode_t Code; /* The custom code for this error */
char* pMessage; /* the custom message string for the error */
errlevel_t Level; /* The severity level for the custom error */
/* The optional function for retrieving the error message for
* different system/platforms */
PERR_CUSTOM_FUNCTION CustomErrFunction;
/* Points to the next record in the linked list (or NULL if last element) */
CErrorRecord* pNext;
/*---------- Begin Protected Class Methods --------------------*/
protected:
/*---------- Begin Public Class Methods -----------------------*/
public:
/* Class Constructors/Destructors */
CErrorRecord();
virtual ~CErrorRecord() { Destroy(); }
virtual void Destroy (void);
/* Get class members */
errcode_t GetCode (void) const { return (Code); }
errlevel_t GetLevel (void) const { return (Level); }
CErrorRecord* GetNext (void) const { return (pNext); }
char* GetMsg (const errcode_t SubCode = ERR_NONE) const;
/* Is this record the last in the linked list? */
boolean IsLast (void) { if (pNext == NULL) return (TRUE); else return (FALSE); }
/* Set class members */
void SetCode (const errcode_t NewCode) { Code = NewCode; }
void SetLevel (const errlevel_t NewLevel) { Level = NewLevel; }
void SetNext (CErrorRecord* pNewNext) { pNext = pNewNext; }
void SetMsg (const char* pString) { ReplaceString(&pMessage, pString); }
void SetFunction (PERR_CUSTOM_FUNCTION NewFunction) { CustomErrFunction = NewFunction; }
};
/*===========================================================================
* End of Class CErrorRecord Definition
*=========================================================================*/
/*===========================================================================
*
* Begin Class CErrorDatabase Definition
*
* Maintains a singly linked list of CErrorRecord objects containing
* information on custom errors. Can also be modified to handle any
* system or platform specific errors.
*
*=========================================================================*/
class CErrorDatabase {
/*---------- Begin Private Class Members ----------------------*/
private:
CErrorRecord* pHead; /* Start of the singly linked list */
boolean AddedDefaultErrors; /* Have the default custom errors been loaded? */
int NumErrors; /* Number of custom errors in list */
/*---------- Begin Protected Class Methods --------------------*/
protected:
/*---------- Begin Public Class Methods -----------------------*/
public:
/* Class Constructors/Destructors */
CErrorDatabase();
virtual ~CErrorDatabase() { Destroy(); }
virtual void Destroy (void);
/* Add a new custom error to the head of the linked list */
void Add (const errcode_t Code, const char* pMessage, const errlevel_t Level = ERRLEVEL_ERROR);
/* Add a custom error function */
void AddCustomError (const errcode_t Code, PERR_CUSTOM_FUNCTION ErrFunction);
/* Deletes the entire singly linked list of custom errors */
void ClearErrors( void);
/* Attempt to find a specific custom error record in the linked list */
CErrorRecord* Find (const errcode_t Code);
/* Get class members */
int GetNumErrors (void) { return (NumErrors); }
/* Add the default custom errors to the database */
void InitDefaultErrors (void);
};
/*===========================================================================
* End of Class CErrorDatabase Definition
*=========================================================================*/
/*===========================================================================
*
* Begin Class CErrorIncident Definition
*
* Records one occurence of an error for later retrieval. Uses a simple
* singly linked list structure.
*
*=========================================================================*/
class CErrorIncident {
/*---------- Begin Private Class Members ----------------------*/
private:
errcode_t Code; /* The custom error code */
errcode_t SubCode;
char* pMessage; /* The optional error message */
CErrorIncident* pNext; /* Pointer to the next record in linked list */
/*---------- Begin Protected Class Methods --------------------*/
protected:
/*---------- Begin Public Class Methods -----------------------*/
public:
/* Class Constructors/Destructors */
CErrorIncident();
virtual ~CErrorIncident() { Destroy(); }
virtual void Destroy (void);
/* Get class members */
errcode_t GetCode (void) const { return (Code); }
errcode_t GetSubCode (void) const { return (SubCode); }
char* GetMsg (void) const { return (pMessage); }
CErrorIncident* GetNext (void) const { return (pNext); }
/* Set class members */
void SetCode (const errcode_t NewCode) { Code = NewCode; }
void SetSubCode (const errcode_t NewCode) { SubCode = NewCode; }
void SetNext (CErrorIncident* pNewNext) { pNext = pNewNext; }
void SetMsg (const char* pString) { ReplaceString(&pMessage, pString); }
void SetMsg (const char* pString, va_list Args);
};
/*===========================================================================
* End of Class CErrorIncident Definition
*=========================================================================*/
/*===========================================================================
*
* Begin Class CErrorHandler Definition
*
* Handles the recording and display of the errors for the application.
*
*=========================================================================*/
class CErrorHandler {
/*---------- Begin Private Class Members ----------------------*/
private:
CErrorIncident* pIncidentHead; /* The current errors recorded */
int NumErrors;
CErrorDatabase& refErrorDatabase; /* The referenced database object */
PERR_NOTIFY_FUNCTION pNotifyFunc; /* The optional notify function supplied by user */
/*---------- Begin Protected Class Methods --------------------*/
protected:
/* Outputs the most recent error to the SystemLog */
void OutputLastErrorToLog (void);
/*---------- Begin Public Class Methods -----------------------*/
public:
/* Class Constructors/Destructors */
CErrorHandler (CErrorDatabase& ErrDB);
virtual ~CErrorHandler() { Destroy(); }
virtual void Destroy (void);
/* Add an error to the top of the list */
void AddError (const errcode_t Code, const char* pString = NULL, ...);
void AddError (const errcode_t Code, const errcode_t SubCode, const char* pString = NULL, ...);
void AddErrorV (const errcode_t Code, const errcode_t SubCode, const char* pString, va_list Args);
/* Delete all errors in the list */
void ClearErrors (void);
/* Display error message and abort program */
void Exit (const char* pTitle = "Application Error");
void _Exit (const char* pTitle = "Application Error");
/* Get a specific error from the current list */
CErrorIncident* GetError (const int Index = 0);
/* Gets the error message of the most recent error incident */
char* GetLastErrorMsg (void);
char* GetLastErrorDBMsg (void);
/* Get class members */
int GetNumErrors (void) { return (NumErrors); }
/* Notifies the user of the most recent error */
void Notify (const char* pTitle = "Application Error");
/* Retrieve the most recent error incident */
CErrorIncident* PopError (void);
/* Standard error message output function */
void Printf (const char* pTitle, const char* pString, ...);
void Printf (const char* pTitle, const char* pString, va_list Args);
/* Change the user notify function */
void SetNotifyFunc (PERR_NOTIFY_FUNCTION NewFunc) { pNotifyFunc = NewFunc; }
};
/*===========================================================================
* End of Class CErrorHandler Definition
*=========================================================================*/
/*===========================================================================
*
* Begin Global Variable Definitions
*
*=========================================================================*/
extern CErrorHandler ErrorHandler;
extern CErrorDatabase ErrorDatabase;
/*===========================================================================
* End of Global Variable Definitions
*=========================================================================*/
/*===========================================================================
*
* Begin Function Prototypes
*
*=========================================================================*/
/* Returns the system error message associated with the error code */
char* SystemErrorFunction (const errcode_t Code);
char* TCGraphErrorFunction (const errcode_t Code);
#if defined(_WIN32) || defined(__BCPLUSPLUS__)
char* WindowsErrorFunction (const errcode_t Code);
#endif
/*===========================================================================
* End of Function Prototypes
*=========================================================================*/
/*===========================================================================
*
* Begin Test Routine Definitions
*
* Function prototypes and definitions for the module test routines, only
* available in DEBUG builds.
*
*=========================================================================*/
/* Custom error codes for testing error handler */
#define TEST_ERR1 100
#define TEST_ERR2 101
#define TEST_ERR3 102
#define TEST_ERR4 103
#define TEST_ERR5 105
/* Test routines for the module */
void Test_DefaultErrors (void);
void Test_SystemErrors (void);
void Test_AddError (void);
void Test_AddCustomError (void);
void Test_HandlerAddError (void);
void Test_HandlerNotify (void);
void Test_DLErr (void);
char* Test_CustomErrFunc (const errcode_t Code);
/*===========================================================================
* End of Test Routine Definitions
*=========================================================================*/
#endif
/*===========================================================================
* End of File DL_Err.H
*=========================================================================*/