X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fbase.h;h=904a1005cb4c67061d6e133a1f851b89c4032641;hb=c84ad4cc16452b86bb444a22a55203afa4fa5454;hp=ba8184c3c29773ca04922fedd9ba636c0d43ed4b;hpb=f2acdbc3820f0f4f5ef76a0a64e73d2a320df91f;p=user%2Fhenk%2Fcode%2Finspircd.git

diff --git a/include/base.h b/include/base.h
index ba8184c3c..904a1005c 100644
--- a/include/base.h
+++ b/include/base.h
@@ -2,7 +2,7 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
+ *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
  * See: http://www.inspircd.org/wiki/index.php/Credits
  *
  * This program is free but copyrighted software; see
@@ -14,21 +14,13 @@
 #ifndef __BASE_H__ 
 #define __BASE_H__ 
 
-#include "inspircd_config.h"
-#include <time.h>
 #include <map>
 #include <deque>
 #include <string>
 
-/** Do we use this? -- Brain */
-typedef void* VoidPointer;
-
 /** A private data store for an Extensible class */
 typedef std::map<std::string,char*> ExtensibleStore;
 
-/** Needed */
-class InspIRCd;
-
 /** The base class for all inspircd classes.
  * Wherever possible, all classes you create should inherit from this,
  * giving them the ability to be passed to various core functions
@@ -49,10 +41,10 @@ class CoreExport classbase
 	/** Destructor.
 	 * Does sweet FA.
 	 */
-	~classbase() { }
+	virtual ~classbase() { }
 };
 
-/** class Extensible is the parent class of many classes such as userrec and chanrec.
+/** class Extensible is the parent class of many classes such as User and Channel.
  * class Extensible implements a system which allows modules to 'extend' the class by attaching data within
  * a map associated with the object. In this way modules can store their own custom information within user
  * objects, channel objects and server objects, without breaking other modules (this is more sensible than using
@@ -223,6 +215,66 @@ class CoreExport BoolSet : public classbase
 	bool operator=(BoolSet other);
 };
 
+/** This class can be used on its own to represent an exception, or derived to represent a module-specific exception.
+ * When a module whishes to abort, e.g. within a constructor, it should throw an exception using ModuleException or
+ * a class derived from ModuleException. If a module throws an exception during its constructor, the module will not
+ * be loaded. If this happens, the error message returned by ModuleException::GetReason will be displayed to the user
+ * attempting to load the module, or dumped to the console if the ircd is currently loading for the first time.
+ */
+class CoreExport CoreException : public std::exception
+{
+ protected:
+	/** Holds the error message to be displayed
+	 */
+	const std::string err;
+	/** Source of the exception
+	 */
+	const std::string source;
+ public:
+	/** Default constructor, just uses the error mesage 'Core threw an exception'.
+	 */
+	CoreException() : err("Core threw an exception"), source("The core") {}
+	/** This constructor can be used to specify an error message before throwing.
+	 */
+	CoreException(const std::string &message) : err(message), source("The core") {}
+	/** This constructor can be used to specify an error message before throwing,
+	 * and to specify the source of the exception.
+	 */
+	CoreException(const std::string &message, const std::string &src) : err(message), source(src) {}
+	/** This destructor solves world hunger, cancels the world debt, and causes the world to end.
+	 * Actually no, it does nothing. Never mind.
+	 * @throws Nothing!
+	 */
+	virtual ~CoreException() throw() {};
+	/** Returns the reason for the exception.
+	 * The module should probably put something informative here as the user will see this upon failure.
+	 */
+	virtual const char* GetReason()
+	{
+		return err.c_str();
+	}
 
-#endif
+	virtual const char* GetSource()
+	{
+		return source.c_str();
+	}
+};
 
+class CoreExport ModuleException : public CoreException
+{
+ public:
+	/** Default constructor, just uses the error mesage 'Module threw an exception'.
+	 */
+	ModuleException() : CoreException("Module threw an exception", "A Module") {}
+
+	/** This constructor can be used to specify an error message before throwing.
+	 */
+	ModuleException(const std::string &message) : CoreException(message, "A Module") {}
+	/** This destructor solves world hunger, cancels the world debt, and causes the world to end.
+	 * Actually no, it does nothing. Never mind.
+	 * @throws Nothing!
+	 */
+	virtual ~ModuleException() throw() {};
+};
+
+#endif