First step on the road of module loader rewriting. So far this only really removes module factories. Any modules not updated to use MODULE_INIT() yet will now fail to compile \o/

git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@7971 e03df62e-2008-0410-955e-edbf42e46eb7

1 files changed, 61 insertions, 1 deletions

diff --git a/include/base.h b/include/base.h
index e769e93b1..faea391a3 100644
--- a/include/base.h
+++ b/include/base.h
@@ -223,6 +223,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