OgreException.h

Go to the documentation of this file.

/*
-----------------------------------------------------------------------------
This source file is part of OGRE
(Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org/

Copyright (c) 2000-2012 Torus Knot Software Ltd

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 OR COPYRIGHT HOLDERS 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 __Exception_H_
#define __Exception_H_

// Precompiler options
#include "OgrePrerequisites.h"
#include "OgreHeaderPrefix.h"
#include "OgreString.h"
#include <exception>

// Backwards compatibility with old assert mode definitions
#if OGRE_RELEASE_ASSERT == 1
#   define OGRE_ASSERT_MODE 1
#endif

// Check for OGRE assert mode

// RELEASE_EXCEPTIONS mode
#if OGRE_ASSERT_MODE == 1
#   ifdef _DEBUG
#       define OgreAssert( a, b ) assert( (a) && (b) )

#   else
#       if OGRE_COMP != OGRE_COMPILER_BORL
#           define OgreAssert( a, b ) if( !(a) ) OGRE_EXCEPT( Ogre::Exception::ERR_RT_ASSERTION_FAILED, (b), "no function info")
#       else
#           define OgreAssert( a, b ) if( !(a) ) OGRE_EXCEPT( Ogre::Exception::ERR_RT_ASSERTION_FAILED, (b), __FUNC__ )
#       endif

#   endif

// EXCEPTIONS mode
#elif OGRE_ASSERT_MODE == 2
#   if OGRE_COMP != OGRE_COMPILER_BORL
#       define OgreAssert( a, b ) if( !(a) ) OGRE_EXCEPT( Ogre::Exception::ERR_RT_ASSERTION_FAILED, (b), "no function info")
#   else
#       define OgreAssert( a, b ) if( !(a) ) OGRE_EXCEPT( Ogre::Exception::ERR_RT_ASSERTION_FAILED, (b), __FUNC__ )
#   endif

// STANDARD mode
#else
#   define OgreAssert( a, b ) assert( (a) && (b) )

#endif

namespace Ogre {
    class _OgreExport Exception : public std::exception
    {
    protected:
        long line;
        int number;
        String typeName;
        String description;
        String source;
        String file;
        mutable String fullDesc;
    public:
        enum ExceptionCodes {
            ERR_CANNOT_WRITE_TO_FILE,
            ERR_INVALID_STATE,
            ERR_INVALIDPARAMS,
            ERR_RENDERINGAPI_ERROR,
            ERR_DUPLICATE_ITEM,
            ERR_ITEM_NOT_FOUND,
            ERR_FILE_NOT_FOUND,
            ERR_INTERNAL_ERROR,
            ERR_RT_ASSERTION_FAILED, 
            ERR_NOT_IMPLEMENTED
        };

        Exception( int number, const String& description, const String& source );

        Exception( int number, const String& description, const String& source, const char* type, const char* file, long line );

        Exception(const Exception& rhs);

        ~Exception() throw() {}

        void operator = (const Exception& rhs);

        virtual const String& getFullDescription(void) const;

        virtual int getNumber(void) const throw();

        virtual const String &getSource() const { return source; }

        virtual const String &getFile() const { return file; }

        virtual long getLine() const { return line; }

        virtual const String &getDescription(void) const { return description; }

        const char* what() const throw() { return getFullDescription().c_str(); }
        
    };


    template <int num>
    struct ExceptionCodeType
    {
        enum { number = num };
    };

    // Specialised exceptions allowing each to be caught specifically
    // backwards-compatible since exception codes still used

    class _OgreExport UnimplementedException : public Exception 
    {
    public:
        UnimplementedException(int inNumber, const String& inDescription, const String& inSource, const char* inFile, long inLine)
            : Exception(inNumber, inDescription, inSource, "UnimplementedException", inFile, inLine) {}
    };
    class _OgreExport FileNotFoundException : public Exception
    {
    public:
        FileNotFoundException(int inNumber, const String& inDescription, const String& inSource, const char* inFile, long inLine)
            : Exception(inNumber, inDescription, inSource, "FileNotFoundException", inFile, inLine) {}
    };
    class _OgreExport IOException : public Exception
    {
    public:
        IOException(int inNumber, const String& inDescription, const String& inSource, const char* inFile, long inLine)
            : Exception(inNumber, inDescription, inSource, "IOException", inFile, inLine) {}
    };
    class _OgreExport InvalidStateException : public Exception
    {
    public:
        InvalidStateException(int inNumber, const String& inDescription, const String& inSource, const char* inFile, long inLine)
            : Exception(inNumber, inDescription, inSource, "InvalidStateException", inFile, inLine) {}
    };
    class _OgreExport InvalidParametersException : public Exception
    {
    public:
        InvalidParametersException(int inNumber, const String& inDescription, const String& inSource, const char* inFile, long inLine)
            : Exception(inNumber, inDescription, inSource, "InvalidParametersException", inFile, inLine) {}
    };
    class _OgreExport ItemIdentityException : public Exception
    {
    public:
        ItemIdentityException(int inNumber, const String& inDescription, const String& inSource, const char* inFile, long inLine)
            : Exception(inNumber, inDescription, inSource, "ItemIdentityException", inFile, inLine) {}
    };
    class _OgreExport InternalErrorException : public Exception
    {
    public:
        InternalErrorException(int inNumber, const String& inDescription, const String& inSource, const char* inFile, long inLine)
            : Exception(inNumber, inDescription, inSource, "InternalErrorException", inFile, inLine) {}
    };
    class _OgreExport RenderingAPIException : public Exception
    {
    public:
        RenderingAPIException(int inNumber, const String& inDescription, const String& inSource, const char* inFile, long inLine)
            : Exception(inNumber, inDescription, inSource, "RenderingAPIException", inFile, inLine) {}
    };
    class _OgreExport RuntimeAssertionException : public Exception
    {
    public:
        RuntimeAssertionException(int inNumber, const String& inDescription, const String& inSource, const char* inFile, long inLine)
            : Exception(inNumber, inDescription, inSource, "RuntimeAssertionException", inFile, inLine) {}
    };


    class ExceptionFactory
    {
    private:
        ExceptionFactory() {}
    public:
        static UnimplementedException create(
            ExceptionCodeType<Exception::ERR_NOT_IMPLEMENTED> code, 
            const String& desc, 
            const String& src, const char* file, long line)
        {
            return UnimplementedException(code.number, desc, src, file, line);
        }
        static FileNotFoundException create(
            ExceptionCodeType<Exception::ERR_FILE_NOT_FOUND> code, 
            const String& desc, 
            const String& src, const char* file, long line)
        {
            return FileNotFoundException(code.number, desc, src, file, line);
        }
        static IOException create(
            ExceptionCodeType<Exception::ERR_CANNOT_WRITE_TO_FILE> code, 
            const String& desc, 
            const String& src, const char* file, long line)
        {
            return IOException(code.number, desc, src, file, line);
        }
        static InvalidStateException create(
            ExceptionCodeType<Exception::ERR_INVALID_STATE> code, 
            const String& desc, 
            const String& src, const char* file, long line)
        {
            return InvalidStateException(code.number, desc, src, file, line);
        }
        static InvalidParametersException create(
            ExceptionCodeType<Exception::ERR_INVALIDPARAMS> code, 
            const String& desc, 
            const String& src, const char* file, long line)
        {
            return InvalidParametersException(code.number, desc, src, file, line);
        }
        static ItemIdentityException create(
            ExceptionCodeType<Exception::ERR_ITEM_NOT_FOUND> code, 
            const String& desc, 
            const String& src, const char* file, long line)
        {
            return ItemIdentityException(code.number, desc, src, file, line);
        }
        static ItemIdentityException create(
            ExceptionCodeType<Exception::ERR_DUPLICATE_ITEM> code, 
            const String& desc, 
            const String& src, const char* file, long line)
        {
            return ItemIdentityException(code.number, desc, src, file, line);
        }
        static InternalErrorException create(
            ExceptionCodeType<Exception::ERR_INTERNAL_ERROR> code, 
            const String& desc, 
            const String& src, const char* file, long line)
        {
            return InternalErrorException(code.number, desc, src, file, line);
        }
        static RenderingAPIException create(
            ExceptionCodeType<Exception::ERR_RENDERINGAPI_ERROR> code, 
            const String& desc, 
            const String& src, const char* file, long line)
        {
            return RenderingAPIException(code.number, desc, src, file, line);
        }
        static RuntimeAssertionException create(
            ExceptionCodeType<Exception::ERR_RT_ASSERTION_FAILED> code, 
            const String& desc, 
            const String& src, const char* file, long line)
        {
            return RuntimeAssertionException(code.number, desc, src, file, line);
        }

    };
    

    
#ifndef OGRE_EXCEPT
#define OGRE_EXCEPT(num, desc, src) throw Ogre::ExceptionFactory::create( \
    Ogre::ExceptionCodeType<num>(), desc, src, __FILE__, __LINE__ );
#endif

} // Namespace Ogre

#include "OgreHeaderSuffix.h"
#endif