Exceptions.h

Go to the documentation of this file.

/******************************************************************************
*
* Copyright Saab AB, 2005-2013 (http://safir.sourceforge.net)
* 
* Created by: Joel Ottosson / stjoot
*
*******************************************************************************
*
* This file is part of Safir SDK Core.
*
* Safir SDK Core is free software: you can redistribute it and/or modify
* it under the terms of version 3 of the GNU General Public License as
* published by the Free Software Foundation.
*
* Safir SDK Core is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Safir SDK Core.  If not, see <http://www.gnu.org/licenses/>.
*
******************************************************************************/

#ifndef _dots_exception_h
#define _dots_exception_h

//Definition of __WFILE__ which is the wide-string equivalent of __FILE__
#define WIDEN2(x) L ## x
#define WIDEN(x) WIDEN2(x)
#define __WFILE__ WIDEN(__FILE__)

#include <string>
#include <Safir/Dob/Typesystem/Defs.h>
#include <boost/static_assert.hpp>
namespace Safir
{
namespace Dob
{
namespace Typesystem
{
    namespace Internal
    {
#ifdef _MSC_VER
#pragma warning (push)
#pragma warning (disable:4251)
#endif

        class DOTS_CPP_API CommonExceptionBase:
            public std::exception
        {
        public:
            CommonExceptionBase(const std::wstring & message,
                                const std::wstring & fileName, //Use the __WFILE__ macro
                                const Dob::Typesystem::Int64 lineNumber); //Use the __LINE__ macro

            virtual ~CommonExceptionBase() throw();

            const std::wstring GetExceptionInfo() const;

            const std::wstring & GetMessage() const {return m_Message;}

            virtual const std::wstring GetName() const = 0;

            const std::wstring & GetFileName() const {return m_FileName;}

            const Dob::Typesystem::Int64 GetLineNumber() const {return m_LineNumber;}

            virtual const char * what() const throw();

            virtual TypeId GetTypeId() const = 0;

        private:
            Dob::Typesystem::Int64 m_LineNumber;
            std::wstring m_FileName;
            std::wstring m_Message;

            mutable std::string m_ConvertedMessage;
        };

#ifdef _MSC_VER
#pragma warning (pop)
#endif

    }

    class DOTS_CPP_API FundamentalException :
        public Internal::CommonExceptionBase
    {
    public:
        FundamentalException(const std::wstring & message,
                             const std::wstring & fileName,            //Use the __WFILE__ macro
                             const Dob::Typesystem::Int64 lineNumber); //Use the __LINE__ macro

        static const TypeId ExceptionTypeId = 5177142987005172374LL;

        //override of CommonExceptionBase::GetTypeId
        virtual TypeId GetTypeId() const {return ExceptionTypeId;}
    };

    class DOTS_CPP_API Exception :
        public Internal::CommonExceptionBase
    {
    public:
        Exception(const std::wstring & message,
                  const std::wstring & fileName,            //Use the __WFILE__ macro
                  const Dob::Typesystem::Int64 lineNumber); //Use the __LINE__ macro

        static const TypeId ExceptionTypeId = 8409897425067168944LL;

        //override of CommonExceptionBase::GetTypeId
        virtual TypeId GetTypeId() const {return ExceptionTypeId;}
    };

    class DOTS_CPP_API IllegalValueException :
        public FundamentalException
    {
    public:
        IllegalValueException(const std::wstring & message,
                              const std::wstring & fileName,           //Use the __WFILE__ macro
                              const Dob::Typesystem::Int64 lineNumber)://Use the __LINE__ macro
            FundamentalException(message,fileName,lineNumber) {}

        //override of CommonExceptionBase::GetName
        const std::wstring GetName() const {return L"Safir.Dob.Typesystem.IllegalValueException";}

        static const TypeId ExceptionTypeId = -3653935143986901894LL;

        //override of CommonExceptionBase::GetTypeId
        virtual TypeId GetTypeId() const {return ExceptionTypeId;}
    };

    class DOTS_CPP_API IncompatibleTypesException :
        public FundamentalException
    {
    public:
        IncompatibleTypesException(const std::wstring & message,
                                   const std::wstring & fileName,           //Use the __WFILE__ macro
                                   const Dob::Typesystem::Int64 lineNumber)://Use the __LINE__ macro
            FundamentalException(message,fileName,lineNumber) {}

        //override of CommonExceptionBase::GetName
        const std::wstring GetName() const {return L"Safir.Dob.Typesystem.IncompatibleTypesException";}

        static const TypeId ExceptionTypeId = -5150658527844777416LL;

        //override of CommonExceptionBase::GetTypeId
        virtual TypeId GetTypeId() const {return ExceptionTypeId;}
    };

    class DOTS_CPP_API ConfigurationErrorException :
        public FundamentalException
    {
    public:
        ConfigurationErrorException(const std::wstring & message,
                                    const std::wstring & fileName,           //Use the __WFILE__ macro
                                    const Dob::Typesystem::Int64 lineNumber)://Use the __LINE__ macro
            FundamentalException(message,fileName,lineNumber) {}

        //override of CommonExceptionBase::GetName
        const std::wstring GetName() const {return L"Safir.Dob.Typesystem.ConfigurationErrorException";}

        static const TypeId ExceptionTypeId = 2909620812590558895LL;

        //override of CommonExceptionBase::GetTypeId
        virtual TypeId GetTypeId() const {return ExceptionTypeId;}
    };

    class DOTS_CPP_API SoftwareViolationException :
        public FundamentalException
    {
    public:
        SoftwareViolationException(const std::wstring & message,
                                   const std::wstring & fileName,           //Use the __WFILE__ macro
                                   const Dob::Typesystem::Int64 lineNumber)://Use the __LINE__ macro
            FundamentalException(message,fileName,lineNumber) {}

        //override of CommonExceptionBase::GetName
        const std::wstring GetName() const {return L"Safir.Dob.Typesystem.SoftwareViolationException";}

        static const TypeId ExceptionTypeId = -2318636033853590373LL;

        //override of CommonExceptionBase::GetTypeId
        virtual TypeId GetTypeId() const {return ExceptionTypeId;}
    };

    class DOTS_CPP_API NullException :
        public FundamentalException
    {
    public:
        NullException(const std::wstring & message,
                      const std::wstring & fileName,           //Use the __WFILE__ macro
                      const Dob::Typesystem::Int64 lineNumber)://Use the __LINE__ macro
            FundamentalException(message,fileName,lineNumber) {}

        //override of CommonExceptionBase::GetName
        const std::wstring GetName() const {return L"Safir.Dob.Typesystem.NullException";}

        static const TypeId ExceptionTypeId = -6392953138294149211LL;

        //override of CommonExceptionBase::GetTypeId
        virtual TypeId GetTypeId() const {return ExceptionTypeId;}
    };


    class DOTS_CPP_API ReadOnlyException :
        public FundamentalException
    {
    public:
        ReadOnlyException(const std::wstring & message,
                          const std::wstring & fileName,           //Use the __WFILE__ macro
                          const Dob::Typesystem::Int64 lineNumber)://Use the __LINE__ macro
            FundamentalException(message,fileName,lineNumber) {}

        //override of CommonExceptionBase::GetName
        const std::wstring GetName() const {return L"Safir.Dob.Typesystem.ReadOnlyException";}

        static const TypeId ExceptionTypeId = -4804695341042352897LL;

        //override of CommonExceptionBase::GetTypeId
        virtual TypeId GetTypeId() const {return ExceptionTypeId;}
    };
}
}
}
#endif