Mercurial > fife-parpg
diff engine/core/util/base/exception.h @ 0:4a0efb7baf70
* Datasets becomes the new trunk and retires after that :-)
author | mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 |
---|---|
date | Sun, 29 Jun 2008 18:44:17 +0000 |
parents | |
children | 90005975cdbb |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/engine/core/util/base/exception.h Sun Jun 29 18:44:17 2008 +0000 @@ -0,0 +1,93 @@ +/*************************************************************************** + * Copyright (C) 2005-2008 by the FIFE team * + * http://www.fifengine.de * + * This file is part of FIFE. * + * * + * FIFE 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 2 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, write to the * + * Free Software Foundation, Inc., * + * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA * + ***************************************************************************/ + +#ifndef FIFE_EXCEPTION_H +#define FIFE_EXCEPTION_H + +// Standard C++ library includes +#include <string> + +// 3rd party library includes + +// FIFE includes +// These includes are split up in two parts, separated by one empty line +// First block: files included from the FIFE root src directory +// Second block: files included from the same folder + +namespace FIFE { + + /** Exception base class. + * All other exceptions derived from this merely adjust the error string + * to be slightly more specific. + */ + class Exception { + public: + /** Constructor. + * @param txt The error mesage to be stored. + */ + Exception(const std::string& msg); + + /** Destructor. + */ + virtual ~Exception(); + + /** Returns the error message. + * @return The error message. + */ + std::string getMessage() const; + + virtual const std::string& getTypeStr() const { static const std::string s = "Exception"; return s; } + virtual const std::string& getDescription() const { static const std::string s = "Generic FIFE exception"; return s; } + + private: + // The error string. + std::string m_message; + }; + + #define FIFE_EXCEPTION_DECL(_name, _description) \ + class _name : public Exception { \ + public: \ + _name(const std::string& msg) : Exception(msg) {} \ + const std::string& getTypeStr() const { static const std::string s = #_name; return s; } \ + const std::string& getDescription() const { static const std::string s = _description; return s; } \ + } + + FIFE_EXCEPTION_DECL(SDLException, "SDL reported something bad"); + FIFE_EXCEPTION_DECL(NotFound, "Something was searched, but not found"); + FIFE_EXCEPTION_DECL(NotSet, "Something was not set correctly"); + FIFE_EXCEPTION_DECL(IndexOverflow, "Someone tried to access a non-existing element"); + FIFE_EXCEPTION_DECL(InvalidFormat, "Found invalid data"); + FIFE_EXCEPTION_DECL(CannotOpenFile, "File couldn't be opened"); + FIFE_EXCEPTION_DECL(InvalidConversion, "Tried an invalid conversion"); + FIFE_EXCEPTION_DECL(NotSupported, "This action was not supported"); + FIFE_EXCEPTION_DECL(NameClash, "A name or identifier is already in use"); + FIFE_EXCEPTION_DECL(Duplicate, "A duplicate item was added, where this is not allowed"); + FIFE_EXCEPTION_DECL(ScriptException, "Error related to scripting functionality"); + FIFE_EXCEPTION_DECL(EventException, "Error related to event functionality"); + FIFE_EXCEPTION_DECL(GuiException, "Error related to gui functionality"); + + /** @bug The memory allocation in @c std::string might fail, resulting in terminate. */ + FIFE_EXCEPTION_DECL(OutOfMemory, "Buy more ram ;)"); + + +}//FIFE + +#endif