XException.h

// XException.h: interface for the exception classes.
//
//////////////////////////////////////////////////////////////////////
 
#if !defined(CXEXCEPTION_INCLUDE_H)
#define CXEXCEPTION_INCLUDE_H
 
#ifdef _MSC_VER
#pragma once
#endif // _MSC_VER
 
#include "XObject.h"
 
BEGIN_MOOTOOLS_NAMESPACE
 
    ///////////////////////////////////////////////////////////////////////
    // Exceptions helpers
    class CXException;
 
    DLL_TOOLSFUNCTION void XSetThreadException(CXException *ex);
    DLL_TOOLSFUNCTION void XDeleteThreadException();
 
    ///////////////////////////////////////////////////////////////////////
    // Exceptions classes
 
    class DLL_TOOLSFUNCTION CXException : public CXObject
    {
        DECLARE_DYNAMIC_XOBJECT(CXException)
 
    public:
            CXException(const CXString& txt = CXString());
            virtual ~CXException();
            void Delete();
 
            CXString GetErrorMessage() const;
            
            virtual bool ReportError(unsigned int nMessageID = 0);
 
        protected:
            CXString exceptionTxt;
    };
 
    class DLL_TOOLSFUNCTION CXFileException : public CXException
    {
        DECLARE_DYNAMIC_XOBJECT(CXFileException)
 
    public:
        typedef enum FileExceptionType {
            none,
            genericException,
            fileNotFound,
            badPath,
            tooManyOpenFiles,
            accessDenied,
            invalidFile,
            removeCurrentDir,
            directoryFull,
            badSeek,
            hardIO,
            sharingViolation,
            lockViolation,
            diskFull,
            endOfFile,
        } FileExceptionType;
 
        // Constructor
        CXFileException(FileExceptionType error = none, const CXString& filename = CXString(), const CXString& exceptiontxt = CXString());
 
        // Attributes
        FileExceptionType cause;
        CXString filename;
 
        static FileExceptionType ErrnoToException(int nErrno);
        static void ThrowOsError(FileExceptionType defaultType, const CXString& filename, CXFileException *e = NULL); // Set a default exception type, that might be internally overidden by an OS error code to get more precise information
        static void ThrowErrno(FileExceptionType error, int nErrno, const CXString& filename, CXFileException *e = NULL); // Set a stdlib error code
 
        // Implementation
        public:
            virtual CXString GetErrorMessage() const;
 
    #ifdef _DEBUG
        void IsXException() {}; // Only to check we really have a 
        virtual void Dump() const;
    #endif
    };
 
 
    class DLL_TOOLSFUNCTION CXArchiveException : public CXException
    {
        DECLARE_DYNAMIC_XOBJECT(CXArchiveException)
 
    public:
        typedef enum ArchiveExceptionType {
            none,
            genericException,
            readOnly,
            endOfFile,
            writeOnly,
            badIndex,
            badClass,
            badSchema,
            bufferFull
        } ArchiveExceptionType;
 
        // Constructor
        CXArchiveException(ArchiveExceptionType error = none, const CXString& filename = CXString());
 
        // Attributes
            int cause;
            CXString filename;
 
        // Implementation
    public:
            virtual CXString GetErrorMessage() const;
 
    #ifdef _DEBUG
        virtual void Dump() const;
    #endif
    };
 
    class DLL_TOOLSFUNCTION CXUserException : public CXException        // general user visible alert
    {
        DECLARE_DYNAMIC_XOBJECT(CXUserException)
    };
 
    class DLL_TOOLSFUNCTION CXMemoryException : public CXException      // out-of-memory exception
    {
        DECLARE_DYNAMIC_XOBJECT(CXMemoryException)
    };
 
    class DLL_TOOLSFUNCTION CXInvalidArgException : public CXException  // one of the parameters to the function is invalid
    {
        DECLARE_DYNAMIC_XOBJECT(CXInvalidArgException)
    };
 
 
    class DLL_TOOLSFUNCTION CXInternetException : public CXException
    {
        DECLARE_DYNAMIC_XOBJECT(CXInternetException)
 
    public:
            typedef enum InternetExceptionType {
                none,
                genericException,
            } InternetExceptionType;
        
            // Constructor
            CXInternetException(longuint context, unsigned int error = 0);
 
            // Attributes
            unsigned int cause;
            longuint context;
 
            // Implementation
        public:
            virtual CXString GetErrorMessage(unsigned int *pnHelpContext = NULL) const;
 
        #ifdef _DEBUG
                virtual void Dump() const;
        #endif
    };
 
#define XThrowException(exception) \
    { \
            XTRACE(_T("Warning: throwing exception of type %s\n"), _T(#exception)); \
            exception *ex = xNew(exception); \
            XSetThreadException(ex); \
            throw ex; \
    }
 
#define XThrowExceptionWithArgs(exception, ...) \
        { \
            XTRACE(_T("Warning: throwing exception of type %s\n"), _T(#exception)); \
            exception *ex =  xNewParams(exception, __VA_ARGS__); \
            XSetThreadException(ex); \
            throw ex; \
        }
 
#define XENSURE(cond) \
        { \
            if (!(cond)) \
                XThrowException(CXInvalidArgException) \
        }
 
#define XTHROW_LAST() throw
 
#define XTRY \
        {  \
            try  \
            {
 
#define XCATCH(class, e) \
            } \
            catch (class *e) \
            { \
                XASSERT(e->IsKindOf(XRUNTIME_CLASS(CXException)));
 
#define XCATCH_ALL \
            } \
            catch (...) \
            { \
 
#define XEND_CATCH \
            } \
            XDeleteThreadException(); \
        }
 
END_MOOTOOLS_NAMESPACE
 
#endif // !defined(CXEXCEPTION_INCLUDE_H)