Humble Framework for SkyOS

---

HError.h

Go to the documentation of this file.

/****************************************************************************
**
**  $Header: /SkyOS.root/pig/Humble/HError.h 4     12/24/04 3:59p Neusel $
**
****************************************************************************/
#ifndef HERROR_H
#   define  HERROR_H
/*  ----------------------------------------------------------------------
    Error Codes
    ----------------------------------------------------------------------  */
enum ErrCode
    {
#if __DEBUG__
    ERR_ASSERT = -1,        
#endif

    NO_ERROR = 0,           

    ERR_API_ERROR,          
    
    ERR_BAD_PARAMETER,      
    ERR_BAD_WINDOW,         

    ERR_BUFFER_OVERFLOW,    
    ERR_BUFFER_UNDERFLOW,   
    ERR_BUY_MORE_RAM,       
    
    ERR_CRC_FAILURE,        
    ERR_DATA_INVALID,       
    ERR_DIV_ZERO,           
    ERR_DUPLICATE,          

    ERR_FILE_INVALID,       //~< An invalid file was detected
    ERR_FILE_DELETE,        
    ERR_FILE_OPEN,          
    ERR_FILE_READ,          
    ERR_FILE_WRITE,         
    
    ERR_MAX_CAPACITY,       
    ERR_NOT_FOUND,          
    ERR_NOT_IMPLEMENTED,    
    ERR_NOT_INITIALIZED,    
    ERR_NULL_PTR,           
    ERR_OUT_OF_RANGE,       
    ERR_STL_EXCEPTION,      

    ERR_MYSTERY             
    };
class HAssertion :  public HObj,
                    public std::logic_error
    {
    typedef HObj        base_class;
    static StringPtr    ClassName(void) { return "HAssertion"; }
/*  ----------------------------------------------------------------------
    VARIABLES
    ----------------------------------------------------------------------  */
protected:
    StringPtr           m_pstrWhat;     
    StringPtr           m_pstrFile;     
    uint32              m_uLine;        
/*  ----------------------------------------------------------------------
    CTOR / DTOR
    ----------------------------------------------------------------------  */
public:
    HAssertion(StringPtr pstrWhat, StringPtr pstrFile, uint32 uLine) : std::logic_error("HAssertion")
        { (void) Set(pstrWhat, pstrFile, uLine); }

    virtual
    ~HAssertion(void) throw()
        { /* EMPTY DTOR */ }
/*  ----------------------------------------------------------------------
    METHODS
    ----------------------------------------------------------------------  */
    void
    Reset(void)
        {
        m_pstrWhat  = NULL;
        m_pstrFile  = NULL;
        m_uLine     = 0;
        }
    void
    Throw(StringPtr pstrWhat, StringPtr pstrFile, uint32 uLine) throw()
        { throw Set(pstrWhat, pstrFile, uLine); }
    const char *
    what(void) const throw()
        {
        static Text szWhat[MAX_PATH+1];

        MEM_ZERO(szWhat, sizeof(szWhat));
        STR_SPRINTF(szWhat, MAX_PATH,
                    "Assert \"%s\" failed at %s(%lu)",
                    STR_SAFE(m_pstrWhat), STR_SAFE(m_pstrFile), m_uLine);

        return szWhat;
        }
/*  ----------------------------------------------------------------------
    GETTERS & SETTERS
    ----------------------------------------------------------------------  */
    HAssertion &        Set(StringPtr pstrWhat, StringPtr pstrFile, uint32 uLine)
                            {
                            m_pstrWhat  = pstrWhat;
                            m_pstrFile  = pstrFile;
                            m_uLine     = uLine;

                            DEBUG_LOG("### ASSERT: \"%s\" ###\n", what());

                            return *this;
                            }
    };
class HError :  public HObj,
                public std::runtime_error
    {
    typedef HObj        base_class;
    static StringPtr    ClassName(void) { return "HError"; }
/*  ----------------------------------------------------------------------
    VARIABLES
    ----------------------------------------------------------------------  */
protected:
    static HError       theErr;         

    ErrCode             m_ec;           
    StringPtr           m_pstrFile;     
    uint32              m_uLine;        
/*  ----------------------------------------------------------------------
    CTOR / DTOR
    ----------------------------------------------------------------------  */
public:
    HError(void) : std::runtime_error("HError")
        { Reset(); }

    HError(ErrCode ec, StringPtr pstrFile, uint32 uLine) : std::runtime_error("HError")
        { (void) SetInfo(ec, pstrFile, uLine, false); }

    virtual
    ~HError(void) throw()
        { /* EMPTY DTOR */ }
/*  ----------------------------------------------------------------------
    METHODS
    ----------------------------------------------------------------------  */
    ErrCode
    Reset(void)
        {
        m_ec        = NO_ERROR;
        m_pstrFile  = kStrEmpty;
        m_uLine     = 0;
        return NO_ERROR;
        }
    static void
    Throw(ErrCode ec, StringPtr pstrFile, uint32 uLine) throw()
        {
        if (GetLastError().SetInfo(ec, pstrFile, uLine, false) != NO_ERROR)
            throw GetLastError();
        }
    virtual const char *
    what(void) const throw()
        {
        static Text szWhat[MAX_PATH+1];
        
        MEM_ZERO(szWhat, sizeof(szWhat));
        (void) STR_SPRINTF( szWhat, MAX_PATH,
                            "Error #%ld at %s(%lu)",
                            int32(m_ec), STR_SAFE(m_pstrFile), m_uLine);

        return szWhat;
        }
/*  ----------------------------------------------------------------------
    GETTERS / SETTERS
    ----------------------------------------------------------------------  */
    static HError &     GetLastError(void)
                            {
                            static HError   me;
                            return me;
                            }
    static ErrCode      Set(ErrCode ec, StringPtr pstrFile, uint32 uLine)
                            { return GetLastError().SetInfo(ec, pstrFile, uLine, true); }
    static ErrCode      SetSilent(ErrCode ec, StringPtr pstrFile, uint32 uLine)
                            { return GetLastError().SetInfo(ec, pstrFile, uLine, false); }
    ErrCode             SetInfo(ErrCode ec, StringPtr pstrFile, uint32 uLine, bool bNotify)
                            {
                            m_ec        = ec;
                            m_pstrFile  = pstrFile;
                            m_uLine     = uLine;
                            if (bNotify && ec != NO_ERROR)
                                {
                                DEBUG_LOG("### ERROR: %s ###\n", what());
                                }
                                
                            return ec;
                            }
/*  ----------------------------------------------------------------------
    INLINES
    ----------------------------------------------------------------------  */
    inline static ErrCode   NoError(void)
                                { return GetLastError().Reset(); }
    inline bool             IsError(void) const
                                { return (m_ec != NO_ERROR); }
/*  ----------------------------------------------------------------------
    OPERATORS
    ----------------------------------------------------------------------  */
    operator ErrCode(void) const
        { return m_ec; }
    };

#endif  // HERROR_H
/****************************************************************************
**
**  $History: HError.h $
 * 
 * *****************  Version 4  *****************
 * User: Neusel       Date: 12/24/04   Time: 3:59p
 * Updated in $/SkyOS.root/pig/Humble
 * 
 * *****************  Version 3  *****************
 * User: Neusel       Date: 12/08/04   Time: 5:06p
 * Updated in $/SkyOS.root/pig/Humble
 * 20041208
 * 
 * *****************  Version 2  *****************
 * User: Neusel       Date: 11/30/04   Time: 1:01p
 * Updated in $/SkyOS.root/pig/Humble
 * Released as HUMBLE_VER 20041130.
 * 
 * *****************  Version 1  *****************
 * User: Neusel       Date: 11/23/04   Time: 8:24a
 * Created in $/SkyOS.root/pig/Humble
**
**  -------------------------------------------------------------------------
**
**  End of HError.h
**
****************************************************************************/

---