CEGUIExceptions.h

/***********************************************************************
filename:       CEGUIExceptions.h
created:        20/2/2004
author:         Paul D Turner, Frederico Jeronimo (fjeronimo)

purpose:        Defines exceptions used within the system
*************************************************************************/
/***************************************************************************
*   Copyright (C) 2004 - 2007 Paul D Turner & The CEGUI Development Team
*
*   Permission is hereby granted, free of charge, to any person obtaining
*   a copy of this software and associated documentation files (the
*   "Software"), to deal in the Software without restriction, including
*   without limitation the rights to use, copy, modify, merge, publish,
*   distribute, sublicense, and/or sell copies of the Software, and to
*   permit persons to whom the Software is furnished to do so, subject to
*   the following conditions:
*
*   The above copyright notice and this permission notice shall be
*   included in all copies or substantial portions of the Software.
*
*   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
*   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
*   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
*   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
*   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
*   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
*   OTHER DEALINGS IN THE SOFTWARE.
***************************************************************************/
#ifndef _CEGUIExceptions_h_
#define _CEGUIExceptions_h_

// INCLUDES

#include "CEGUIBase.h"
#include "CEGUIString.h"

// CEGUI NAMESPACE

// Start of CEGUI namespace section
namespace CEGUI
{
    // EXCEPTION

    class  CEGUIEXPORT Exception
    {

    public:
        /************************************************************************/
        /* DESTRUCTOR
        /************************************************************************/
        virtual ~Exception(void);

        /************************************************************************/
        /* PUBLIC FUNCTIONS
        /************************************************************************/

        const String&   getMessage(void) const          {return d_message;}

        const String& getName() const { return d_name; }

        const String&   getFileName(void) const         {return d_filename;}

        const int       getLine(void) const             {return d_line;}

    protected:

        /************************************************************************/
        /* CONSTRUCTORS
        /************************************************************************/

        Exception(const String& message = "", const String& name ="CEGUI::Exception", const String& filename = "", int line = 0);

        /************************************************************************/
        /* PROTECTED VARIABLES
        /************************************************************************/

        String  d_message;

        String d_filename;

        String d_name;

        int d_line;
    };

    // GENERIC EXCEPTION

    class CEGUIEXPORT GenericException : public Exception
    {
    public:

        /************************************************************************/
        /* CONSTRUCTORS/DESTRUCTORS
        /************************************************************************/

        GenericException(const String& message, const String& file = "unknown", int line = 0)
            : Exception(message, "CEGUI::GenericException", file, line) {}
    };

    #define GenericException(message)  \
        GenericException(message, __FILE__, __LINE__)

    // UNKNOWN OBJECT EXCEPTION

    class CEGUIEXPORT UnknownObjectException : public Exception
    {
    public:

        /************************************************************************/
        /* CONSTRUCTORS/DESTRUCTORS
        /************************************************************************/

        UnknownObjectException(const String& message, const String& file = "unknown", int line = 0)
            : Exception(message, "CEGUI::UnknownObjectException", file, line) {}
    };

    #define UnknownObjectException(message)  \
        UnknownObjectException(message, __FILE__, __LINE__)

    // INVALID REQUEST EXCEPTION

    class CEGUIEXPORT InvalidRequestException : public Exception
    {
    public:

        /************************************************************************/
        /* CONSTRUCTORS/DESTRUCTORS
        /************************************************************************/

        InvalidRequestException(const String& message, const String& file = "unknown", int line = 0)
            : Exception(message, "CEGUI::InvalidRequestException", file, line) {}
    };

    #define InvalidRequestException(message)  \
        InvalidRequestException(message, __FILE__, __LINE__)

    // FILE IO EXCEPTION

    class CEGUIEXPORT FileIOException : public Exception
    {
    public:

        /************************************************************************/
        /* CONSTRUCTORS/DESTRUCTORS
        /************************************************************************/

        FileIOException(const String& message, const String& file = "unknown", int line = 0)
            : Exception(message, "CEGUI::FileIOException", file, line) {}
    };

    #define FileIOException(message)  \
        FileIOException(message, __FILE__, __LINE__)

    // RENDERER EXCEPTION

    class CEGUIEXPORT RendererException : public Exception
    {
    public:

        /************************************************************************/
        /* CONSTRUCTORS/DESTRUCTORS
        /************************************************************************/

        RendererException(const String& message, const String& file = "unknown", int line = 0)
            : Exception(message, "CEGUI::RendererException", file, line) {}
    };

    #define RendererException(message)  \
        RendererException(message, __FILE__, __LINE__)

    // ALREADY EXISTS EXCEPTION

    class CEGUIEXPORT AlreadyExistsException : public Exception
    {
    public:

        /************************************************************************/
        /* CONSTRUCTORS/DESTRUCTORS
        /************************************************************************/

        AlreadyExistsException(const String& message, const String& file = "unknown", int line = 0)
            : Exception(message, "CEGUI::AlreadyExistsException", file, line) {}
    };

    #define AlreadyExistsException(message)  \
        AlreadyExistsException(message, __FILE__, __LINE__)

    // MEMORY EXCEPTION

    class CEGUIEXPORT MemoryException : public Exception
    {
    public:

        /************************************************************************/
        /* CONSTRUCTORS/DESTRUCTORS
        /************************************************************************/

        MemoryException(const String& message, const String& file = "unknown", int line = 0)
            : Exception(message, "CEGUI::MemoryException", file, line) {}
    };

    #define MemoryException(message)  \
        MemoryException(message, __FILE__, __LINE__)

    // NULL OBJECT EXCEPTION

    class CEGUIEXPORT NullObjectException : public Exception
    {
    public:

        /************************************************************************/
        /* CONSTRUCTORS/DESTRUCTORS
        /************************************************************************/

        NullObjectException(const String& message, const String& file = "unknown", int line = 0)
            : Exception(message, "CEGUI::NullObjectException", file, line) {}
    };

    #define NullObjectException(message)  \
        NullObjectException(message, __FILE__, __LINE__)

    // OBJECT IN USE EXCEPTION

    class CEGUIEXPORT ObjectInUseException : public Exception
    {
    public:

        /************************************************************************/
        /* CONSTRUCTORS/DESTRUCTORS
        /************************************************************************/

        ObjectInUseException(const String& message, const String& file = "unknown", int line = 0)
            : Exception(message, "CEGUI::ObjectInUseException", file, line) {}
    };

    #define ObjectInUseException(message)  \
        ObjectInUseException(message, __FILE__, __LINE__)

    // SCRIPT EXCEPTION

    class CEGUIEXPORT ScriptException : public Exception
    {
    public:

        /************************************************************************/
        /* CONSTRUCTORS/DESTRUCTORS
        /************************************************************************/

        ScriptException(const String& message, const String& file = "unknown", int line = 0)
            : Exception(message, "CEGUI::ScriptException", file, line) {}
    };

    #define ScriptException(message)  \
        ScriptException(message, __FILE__, __LINE__)


} // End of  CEGUI namespace section


#endif  // end of guard _CEGUIExceptions_h_