Project Site at

---

                 

---

iError.h

Go to the documentation of this file.

#ifndef _i_iError_h_
#define _i_iError_h_

#ifdef _MSC_VER
#       pragma warning( push )
#       pragma warning( disable : 4786 ) // 'identifier' : identifier was truncated to 'number' characters in the debug information
//#     pragma warning( disable : 4503 ) // 'identifier' : decorated name length exceeded, name was truncated
//#     pragma warning( disable : 4250 ) // 'class1' : inherits 'class2::member' via dominance
//#     pragma warning( disable : 4251 ) // 'identifier' : class 'type' needs to have dll-interface to be used by clients of class 'type2'
#endif
#ifdef __INTEL_COMPILER
#       pragma warning( disable : 985  ) // == C4786
#endif^

// $Log: iError.h,v $
// Revision 1.3  2002/09/02 11:19:23  vofka
// minor changes
//
// Revision 1.2  2002/08/30 15:19:38  vofka
// automake support added
//
// Revision 1.1  2002/06/28 12:23:19  vofka
// first time on sourceforge.net cvs
//

#include <cstring>
#include <cstdarg>

#ifndef __FUNCTION__
#       define __FUNCTION__ "unknown"
#endif

#ifdef WIN32
#       ifdef IERROR_EXPORTS
#               define IERROR_API __declspec(dllexport)
#       else
#               define IERROR_API __declspec(dllimport)
#               ifdef _DEBUG
#                       pragma comment(lib, "iError_d.lib")
#               else
#                       ifdef DEBUG
#                               pragma comment(lib, "iError_d.lib")
#                       else
#                               pragma comment(lib, "iError.lib")
#                       endif
#               endif
#       endif
#else
#       define IERROR_API
#endif

#define ERR_MAX_PARAM 8
#define ERR_MAX_STACK_DEPTH 32
#define ERR_MAX_DESCRIPTION 1024
#define ERR_MAX_DEBUG_DESCRIPTION 128
#define ERR_MAX_DEBUG_INFO ERR_MAX_STACK_DEPTH*ERR_MAX_DEBUG_DESCRIPTION


#define iLastError iERR::iErrorHandler::Current()->LastError

#define iThrow iERR::iErrorHandler::Current()->Throw

#define iRethrow() iERR::iErrorHandler::Current()->Rethrow(HERE)

#define iReset iERR::iErrorHandler::Current()->Reset

#define iHandleLastError() iERR::iErrorHandler::Current()->Handle(HERE)

#define iAssert(exp) if (!(exp)) iThrow(iError::iASSERTION,__FUNCTION__,__FILE__,__LINE__,&iERR::iERR_ASSERT, #exp)

#define INFO(err) iError::iINFO,__FUNCTION__,__FILE__,__LINE__,&err
#define WARNING(err) iError::iWARNING,__FUNCTION__,__FILE__,__LINE__,&err
#define CRITICAL(err) iError::iCRITICAL,__FUNCTION__,__FILE__,__LINE__,&err
#define EXCEPTION(err) iError::iEXCEPTION,__FUNCTION__,__FILE__,__LINE__,&err

#define HERE __FUNCTION__,__FILE__,__LINE__

namespace iERR {

class IERROR_API iErrorHandler;
class IERROR_API iStdErrorHandler;
class IERROR_API iError;
class IERROR_API iErrorCode;
class IERROR_API CDescriptionParam;
        
// following are error codes alredy defined by the library and may be used.
extern IERROR_API iErrorCode UNKNOWN;   // UNKNOWN("[UNKNOWN] Unknown Error");
extern IERROR_API iErrorCode INTERNAL;  // INTERNAL("[INTERNAL] Internal Error.")
extern IERROR_API iErrorCode GENERIC;   // GENERIC("[GENERIC] %s") // not effecient. Define special codes for errors
extern IERROR_API iErrorCode SYSTEM;    // SYSTEM("[SYSTEM] System Error: %s")
extern IERROR_API iErrorCode iERR_ASSERT; // only to be used by iAssert macro

/*
 * class used to store parameters of an error description.
 */
class CDescriptionParam
{
public:
        union UDescriptionParam
        {
                int    i;
                long   l;
                double d;
                void  *p;
        };

        CDescriptionParam() : m_String(0) {};
        ~CDescriptionParam() {if (m_String) {delete[] m_String;};};
        void SetInt(int v)    {m_Value.i=v;};
        void SetLong(long v)   {m_Value.l=v;};
        void SetDouble(double v) {m_Value.d=v;};
        void SetVoid(void* v)  {m_Value.p=v;};
        void SetString(const char* v) {if (m_String) {delete[] m_String;}; if (v) {m_String=new char[strlen(v)+1]; strcpy(m_String, v);} else {m_String=new char[1]; m_String[0]='\0';}};
        int GetInt() const {return m_Value.i;};
        long GetLong() const {return m_Value.l;};
        double GetDouble() const {return m_Value.d;};
        void* GetVoid() const {return m_Value.p;};
        const char * GetString() const {return m_String;};

protected:
        UDescriptionParam m_Value;
        char *m_String;
};

class iErrorCode
{
public:
        iErrorCode(
                const char *description,
                int errCode=0
        );

        ~iErrorCode();

        const char * GetDescription() const {return m_Description;};

        int GetErrorCode() const {return m_ErrorCode;};

        operator long() const {return m_ErrorCode;};

        const char *GetSig() const {return m_Sig;};

protected:
        char m_Sig[ERR_MAX_PARAM];

private:
        const char *m_Description;
        int m_ErrorCode;
};

class iError 
{
public:
        friend class iErrorHandler;

        typedef enum {iINFO=0, iWARNING=1, iCRITICAL=2, iEXCEPTION=3, iASSERTION=4} ErrorLevel;

        iError();
        
        ErrorLevel GetErrorLevel() const;

        iErrorCode* GetErrorCode() const;

        const char *GetDescription();
        
        const char *GetDebugInfo();

        operator long() const;

protected:
        void SetErrorCode(ErrorLevel errLevel, iErrorCode* errCode);

        void SetIntegerParam(int idx, int value);

        void SetDoubleParam(int idx, double value);

        void SetStringParam(int idx, const char* value);

        void SetVoidParam(int idx, void* value);

        void AddDebugInfo(
                const char* functionName,
                const char* fileName,
                int lineNr
        );

private:
        ErrorLevel m_ErrorLevel;

        iErrorCode* m_ErrorCode;
        
        const char* m_File[ERR_MAX_STACK_DEPTH];

        const char* m_Function[ERR_MAX_STACK_DEPTH];

        int m_Line[ERR_MAX_STACK_DEPTH];

        int m_LastDebugInfo;

        char m_Description[ERR_MAX_DESCRIPTION];

        char m_DebugInfo[ERR_MAX_DEBUG_INFO];

        CDescriptionParam m_Param[ERR_MAX_PARAM];

};

class iErrorHandler
{
public:
        friend class iError;

        iErrorHandler();

        virtual ~iErrorHandler();

        virtual int Throw(
                iError::ErrorLevel errLevel,
                const char *functionName,
                const char *file,
                int line,
                iErrorCode* errCode,
                ...
        );

        virtual bool Rethrow(
                const char *functionName=NULL,
                const char *file=NULL,
                int line=0
        );

        virtual bool Handle(
                const char *functionName=NULL,
                const char *file=NULL,
                int line=0
        );

        virtual bool Reset();

        virtual iError* LastError(bool reset=false);

        iErrorHandler* SetCurrent();
        
        static iErrorHandler* Current();
        
protected:
        virtual void _Throw() = 0;

        virtual void _Handle() = 0;

        iError* m_Last;

private:

        iError* m_LastError;

        
        static int m_HandlerCount;
};

class iStdErrorHandler : public iErrorHandler
{
public:
        iStdErrorHandler();

        void ShowDebugInfo(bool);

        iError::ErrorLevel SetNotificationLevel(iError::ErrorLevel newLevel);

        static iStdErrorHandler m_Default;

protected:
        virtual void _Throw();
        virtual void _Handle();

        bool m_ShowDebugInfo;
        iError::ErrorLevel m_NotificationLevel;
};

}; // iERR

#ifdef _MSC_VER
        #pragma warning( pop )
#endif

#endif

---