/*  EQEMu:  Everquest Server Emulator
    Copyright (C) 2001-2013  EQEMu Development Team (http://eqemulator.net)

  This program is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; version 2 of the License.
  
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY except by those people which sell it, which
	are required to give you total support for your newly bought product;
	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 this program; if not, write to the Free Software
	  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

#ifndef _EQEMU_EQEMUEXCEPTION_H
#define _EQEMU_EQEMUEXCEPTION_H

#include <sstream>
#include <exception>

namespace EQEmu
{
    //! EQEmu Exception Class
    /*!
        A custom exception class for things EQEmu throws.
    */
    class Exception : public std::exception {
    public:
        
        //! Detailed Constructor
        /*!
          \param name The name given for this exception.
          \param description The description for this exception.
          \param file The file name for this exception.
          \param line The line number for this exception.
        */
        Exception(const char* name, const std::string& description, const char* file, long line);
        
        //! Copy Constructor
        Exception(const Exception& e);
        
        //! Move Constructor
#ifdef EQEMU_RVALUE_MOVE
        Exception(const Exception&& e);
#endif
        
        //! Destructor
        ~Exception() throw() { }
        
        //! Assignment Operator
        void operator=(const Exception& e);

        //! Get Name
        /*!
            Gets the name of the exception as it was when it was created.  
            These are typically descriptive categories that the exception would fall under.
        */
        virtual const std::string& name() const { return name_; }
        
        //! Get Basic Description
        /*!
            Gets the description of the exception as it was when it was created.  
            This tends to explain the circumstances of why the exception was thrown.
        */
        virtual const std::string& description() const { return desc_; }
        
        //! Get Full Description
        /*!
            Gets a full description for this exception. 
            This is a string containing the name, description, file and line number in a custom format.
            This string is created the first time the full_description is accessed.
        */
        virtual const std::string& full_description() const;
        
        //! Get File Name
        /*!
            Gets the name of the file this exception was thrown from.
        */
        virtual const std::string& file() const { return file_; }
        
        //! Get File Line
        /*!
            Gets the file line this exception was thrown from.
        */
        virtual const long& line() const { return line_; }
        
        //! std::exception overload
        /*!
            Overload from std::exception
            Allows it to be caught as a std::exception without casting which is nice, returns the full description.
        */
        const char* what() const throw() { return full_description().c_str(); }
    protected:
        std::string name_; //!< Exception name
        std::string desc_; //!< Exception Description
        mutable std::string full_desc_; //!< Full Exception Description
        std::string file_; //!< File Name
        long line_; //<! File Line
    };
} // EQEmu

#ifndef EQ_EXCEPT
#define EQ_EXCEPT(n, d) throw EQEmu::Exception(n, d, __FILE__, __LINE__)
#endif

#endif