* | Inspire Internet Relay Chat Daemon |
* +------------------------------------+
*
- * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
- * E-mail:
- * <brain@chatspike.net>
- * <Craig@chatspike.net>
- *
- * Written by Craig Edwards, Craig McLure, and others.
+ * InspIRCd: (C) 2002-2007 InspIRCd Development Team
+ * See: http://www.inspircd.org/wiki/index.php/Credits
+ *
* This program is free but copyrighted software; see
* the file COPYING for details.
*
#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;
-extern time_t TIME;
-
-/** The base class for all inspircd classes
+/** 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
+ * as 'anonymous' classes.
*/
-class classbase
+class CoreExport classbase
{
public:
/** Time that the object was instantiated (used for TS calculation etc)
*/
time_t age;
- static unsigned long id;
- /** Constructor,
+ /** Constructor.
* Sets the object's time
*/
- classbase() { time = TIME; id++; }
- ~classbase() { id--; }
+ classbase();
+
+ /** Destructor.
+ * Does sweet FA.
+ */
+ virtual ~classbase() { }
};
/** class Extensible is the parent class of many classes such as userrec and chanrec.
* a flags variable, and each module defining bits within the flag as 'theirs' as it is less prone to conflict and
* supports arbitary data storage).
*/
-class Extensible : public classbase
+class CoreExport Extensible : public classbase
{
- /** Private data store
+ /** Private data store.
+ * Holds all extensible metadata for the class.
*/
ExtensibleStore Extension_Items;
* @param key The key parameter is an arbitary string which identifies the extension data
* @param p This parameter is a pointer to any data you wish to associate with the object
*
- * You must provide a key to store the data as, and a void* to the data (typedef VoidPointer)
+ * You must provide a key to store the data as via the parameter 'key' and store the data
+ * in the templated parameter 'p'.
* The data will be inserted into the map. If the data already exists, you may not insert it
* twice, Extensible::Extend will return false in this case.
*
return this->Extension_Items.insert(std::make_pair(key, (char*)p)).second;
}
+ /** Extend an Extensible class.
+ *
+ * @param key The key parameter is an arbitary string which identifies the extension data
+ *
+ * You must provide a key to store the data as via the parameter 'key', this single-parameter
+ * version takes no 'data' parameter, this is used purely for boolean values.
+ * The key will be inserted into the map with a NULL 'data' pointer. If the key already exists
+ * then you may not insert it twice, Extensible::Extend will return false in this case.
+ *
+ * @return Returns true on success, false if otherwise
+ */
+ bool Extend(const std::string &key)
+ {
+ /* This will only add an item if it doesnt already exist,
+ * the return value is a std::pair of an iterator to the
+ * element, and a bool saying if it was actually inserted.
+ */
+ return this->Extension_Items.insert(std::make_pair(key, (char*)NULL)).second;
+ }
+
/** Shrink an Extensible class.
*
* @param key The key parameter is an arbitary string which identifies the extension data
/** Get an extension item.
*
* @param key The key parameter is an arbitary string which identifies the extension data
- * @return If you provide a non-existent key name, the function returns NULL, otherwise a pointer to the item referenced by the key is returned.
+ * @param p If you provide a non-existent key, this value will be NULL. Otherwise a pointer to the item you requested will be placed in this templated parameter.
+ * @return Returns true if the item was found and false if it was nor, regardless of wether 'p' is NULL. This allows you to store NULL values in Extensible.
*/
template<typename T> 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().
+ */
+ bool GetExt(const std::string &key)
+ {
+ return (this->Extension_Items.find(key) != this->Extension_Items.end());
+ }
/** Get a list of all extension items names.
* @param list A deque of strings to receive the list
* Use BoolSet::Set and BoolSet::Get to set and get bools in the bitmask,
* and Unset and Invert for special operations upon them.
*/
-class BoolSet : public classbase
+class CoreExport BoolSet : public classbase
{
+ /** Actual bit values */
char bits;
public:
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
projects / user / henk / code / inspircd.git / blobdiff