X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fbase.h;h=fa4e5c0028d593d7646ddcb1fc91d1b6444e444b;hb=14db93e7cfd4f434731305ef6e8832880f642fc5;hp=2259953b83818c174773dbd3b0219e6adef8d4c3;hpb=9cf56d917d92959701694477f7944d45ad2c38ed;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/base.h b/include/base.h index 2259953b8..fa4e5c002 100644 --- a/include/base.h +++ b/include/base.h @@ -2,8 +2,8 @@ * | Inspire Internet Relay Chat Daemon | * +------------------------------------+ * - * InspIRCd: (C) 2002-2007 InspIRCd Development Team - * See: http://www.inspircd.org/wiki/index.php/Credits + * InspIRCd: (C) 2002-2009 InspIRCd Development Team + * See: http://wiki.inspircd.org/Credits * * This program is free but copyrighted software; see * the file COPYING for details. @@ -11,22 +11,21 @@ * --------------------------------------------------- */ -#ifndef __BASE_H__ -#define __BASE_H__ +#ifndef __BASE_H__ +#define __BASE_H__ -#include "inspircd_config.h" -#include #include #include #include -typedef void* VoidPointer; +/** A private data store for an Extensible class */ typedef std::map ExtensibleStore; -class InspIRCd; - -/** The base class for all inspircd classes -*/ +/** 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 + * as 'anonymous' classes. +*/ class CoreExport classbase { public: @@ -34,14 +33,18 @@ class CoreExport classbase */ time_t age; - /** Constructor, + /** Constructor. * Sets the object's time */ classbase(); - ~classbase() { } + + /** Destructor. + * Does sweet FA. + */ + 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 @@ -50,10 +53,11 @@ class CoreExport classbase */ class CoreExport Extensible : public classbase { - /** Private data store + /** Private data store. + * Holds all extensible metadata for the class. */ ExtensibleStore Extension_Items; - + public: /** Extend an Extensible class. @@ -106,7 +110,7 @@ public: * @return Returns true on success. */ bool Shrink(const std::string &key); - + /** Get an extension item. * * @param key The key parameter is an arbitary string which identifies the extension data @@ -115,24 +119,24 @@ public: */ template bool GetExt(const std::string &key, T* &p) { - ExtensibleStore::iterator iter = this->Extension_Items.find(key); + ExtensibleStore::iterator iter = this->Extension_Items.find(key); /* Find the item */ if(iter != this->Extension_Items.end()) { - p = (T*)iter->second; + p = (T*)iter->second; /* Item found */ return true; } else { - p = NULL; + p = NULL; /* Item not found */ return false; } } - + /** Get an extension item. * * @param key The key parameter is an arbitary string which identifies the extension data * @return Returns true if the item was found and false if it was not. - * + * * This single-parameter version only checks if the key exists, it does nothing with * the 'data' field and is probably only useful in conjunction with the single-parameter * version of Extend(). @@ -155,6 +159,7 @@ public: */ class CoreExport BoolSet : public classbase { + /** Actual bit values */ char bits; public: @@ -200,7 +205,7 @@ class CoreExport BoolSet : public classbase /** OR two BoolSets together */ BoolSet operator|(BoolSet other); - + /** AND two BoolSets together */ BoolSet operator&(BoolSet other); @@ -210,5 +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(); + } + + 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