mirror of
https://github.com/EQEmu/Server.git
synced 2026-04-02 08:12:25 +00:00
7ab909ee47
- License was intended to be GPLv3 per earlier commit of GPLv3 LICENSE FILE - This is confirmed by the inclusion of libraries that are incompatible with GPLv2 - This is also confirmed by KLS and the agreement of KLS's predecessors - Added GPLv3 license headers to the compilable source files - Removed Folly licensing in strings.h since the string functions do not match the Folly functions and are standard functions - this must have been left over from previous implementations - Removed individual contributor license headers since the project has been under the "developer" mantle for many years - Removed comments on files that were previously automatically generated since they've been manually modified multiple times and there are no automatic scripts referencing them (removed in 2023)
107 lines
3.1 KiB
C++
107 lines
3.1 KiB
C++
/* EQEmu: EQEmulator
|
|
|
|
Copyright (C) 2001-2026 EQEmu Development Team
|
|
|
|
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; either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
#pragma once
|
|
|
|
#include <sstream>
|
|
#include <exception>
|
|
|
|
namespace EQ
|
|
{
|
|
//! 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:
|
|
mutable std::string full_desc_; //!< Full Exception Description
|
|
long line_; //<! File Line
|
|
std::string file_; //!< File Name
|
|
std::string desc_; //!< Exception Description
|
|
std::string name_; //!< Exception name
|
|
};
|
|
} // EQEmu
|
|
|
|
#ifndef EQ_EXCEPT
|
|
#define EQ_EXCEPT(n, d) throw EQ::Exception(n, d, __FILE__, __LINE__)
|
|
#endif
|