1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2008 InspIRCd Development Team
6 * See: http://www.inspircd.org/wiki/index.php/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
17 #include "inspircd_config.h"
23 /** A private data store for an Extensible class */
24 typedef std::map<std::string,char*> ExtensibleStore;
26 /** The base class for all inspircd classes.
27 * Wherever possible, all classes you create should inherit from this,
28 * giving them the ability to be passed to various core functions
29 * as 'anonymous' classes.
31 class CoreExport classbase
34 /** Time that the object was instantiated (used for TS calculation etc)
39 * Sets the object's time
46 virtual ~classbase() { }
49 /** class Extensible is the parent class of many classes such as User and Channel.
50 * class Extensible implements a system which allows modules to 'extend' the class by attaching data within
51 * a map associated with the object. In this way modules can store their own custom information within user
52 * objects, channel objects and server objects, without breaking other modules (this is more sensible than using
53 * a flags variable, and each module defining bits within the flag as 'theirs' as it is less prone to conflict and
54 * supports arbitary data storage).
56 class CoreExport Extensible : public classbase
58 /** Private data store.
59 * Holds all extensible metadata for the class.
61 ExtensibleStore Extension_Items;
65 /** Extend an Extensible class.
67 * @param key The key parameter is an arbitary string which identifies the extension data
68 * @param p This parameter is a pointer to any data you wish to associate with the object
70 * You must provide a key to store the data as via the parameter 'key' and store the data
71 * in the templated parameter 'p'.
72 * The data will be inserted into the map. If the data already exists, you may not insert it
73 * twice, Extensible::Extend will return false in this case.
75 * @return Returns true on success, false if otherwise
77 template<typename T> bool Extend(const std::string &key, T* p)
79 /* This will only add an item if it doesnt already exist,
80 * the return value is a std::pair of an iterator to the
81 * element, and a bool saying if it was actually inserted.
83 return this->Extension_Items.insert(std::make_pair(key, (char*)p)).second;
86 /** Extend an Extensible class.
88 * @param key The key parameter is an arbitary string which identifies the extension data
90 * You must provide a key to store the data as via the parameter 'key', this single-parameter
91 * version takes no 'data' parameter, this is used purely for boolean values.
92 * The key will be inserted into the map with a NULL 'data' pointer. If the key already exists
93 * then you may not insert it twice, Extensible::Extend will return false in this case.
95 * @return Returns true on success, false if otherwise
97 bool Extend(const std::string &key)
99 /* This will only add an item if it doesnt already exist,
100 * the return value is a std::pair of an iterator to the
101 * element, and a bool saying if it was actually inserted.
103 return this->Extension_Items.insert(std::make_pair(key, (char*)NULL)).second;
106 /** Shrink an Extensible class.
108 * @param key The key parameter is an arbitary string which identifies the extension data
110 * You must provide a key name. The given key name will be removed from the classes data. If
111 * you provide a nonexistent key (case is important) then the function will return false.
112 * @return Returns true on success.
114 bool Shrink(const std::string &key);
116 /** Get an extension item.
118 * @param key The key parameter is an arbitary string which identifies the extension data
119 * @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.
120 * @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.
122 template<typename T> bool GetExt(const std::string &key, T* &p)
124 ExtensibleStore::iterator iter = this->Extension_Items.find(key); /* Find the item */
125 if(iter != this->Extension_Items.end())
127 p = (T*)iter->second; /* Item found */
132 p = NULL; /* Item not found */
137 /** Get an extension item.
139 * @param key The key parameter is an arbitary string which identifies the extension data
140 * @return Returns true if the item was found and false if it was not.
142 * This single-parameter version only checks if the key exists, it does nothing with
143 * the 'data' field and is probably only useful in conjunction with the single-parameter
144 * version of Extend().
146 bool GetExt(const std::string &key)
148 return (this->Extension_Items.find(key) != this->Extension_Items.end());
151 /** Get a list of all extension items names.
152 * @param list A deque of strings to receive the list
153 * @return This function writes a list of all extension items stored in this object by name into the given deque and returns void.
155 void GetExtList(std::deque<std::string> &list);
158 /** BoolSet is a utility class designed to hold eight bools in a bitmask.
159 * Use BoolSet::Set and BoolSet::Get to set and get bools in the bitmask,
160 * and Unset and Invert for special operations upon them.
162 class CoreExport BoolSet : public classbase
164 /** Actual bit values */
169 /** The default constructor initializes the BoolSet to all values unset.
173 /** This constructor copies the default bitmask from a char
175 BoolSet(char bitmask);
177 /** The Set method sets one bool in the set.
179 * @param number The number of the item to set. This must be between 0 and 7.
181 void Set(int number);
183 /** The Get method returns the value of one bool in the set
185 * @param number The number of the item to retrieve. This must be between 0 and 7.
187 * @return True if the item is set, false if it is unset.
189 bool Get(int number);
191 /** The Unset method unsets one value in the set
193 * @param number The number of the item to set. This must be between 0 and 7.
195 void Unset(int number);
197 /** The Unset method inverts (flips) one value in the set
199 * @param number The number of the item to invert. This must be between 0 and 7.
201 void Invert(int number);
203 /** Compare two BoolSets
205 bool operator==(BoolSet other);
207 /** OR two BoolSets together
209 BoolSet operator|(BoolSet other);
211 /** AND two BoolSets together
213 BoolSet operator&(BoolSet other);
215 /** Assign one BoolSet to another
217 bool operator=(BoolSet other);
220 /** This class can be used on its own to represent an exception, or derived to represent a module-specific exception.
221 * When a module whishes to abort, e.g. within a constructor, it should throw an exception using ModuleException or
222 * a class derived from ModuleException. If a module throws an exception during its constructor, the module will not
223 * be loaded. If this happens, the error message returned by ModuleException::GetReason will be displayed to the user
224 * attempting to load the module, or dumped to the console if the ircd is currently loading for the first time.
226 class CoreExport CoreException : public std::exception
229 /** Holds the error message to be displayed
231 const std::string err;
232 /** Source of the exception
234 const std::string source;
236 /** Default constructor, just uses the error mesage 'Core threw an exception'.
238 CoreException() : err("Core threw an exception"), source("The core") {}
239 /** This constructor can be used to specify an error message before throwing.
241 CoreException(const std::string &message) : err(message), source("The core") {}
242 /** This constructor can be used to specify an error message before throwing,
243 * and to specify the source of the exception.
245 CoreException(const std::string &message, const std::string &src) : err(message), source(src) {}
246 /** This destructor solves world hunger, cancels the world debt, and causes the world to end.
247 * Actually no, it does nothing. Never mind.
250 virtual ~CoreException() throw() {};
251 /** Returns the reason for the exception.
252 * The module should probably put something informative here as the user will see this upon failure.
254 virtual const char* GetReason()
259 virtual const char* GetSource()
261 return source.c_str();
265 class CoreExport ModuleException : public CoreException
268 /** Default constructor, just uses the error mesage 'Module threw an exception'.
270 ModuleException() : CoreException("Module threw an exception", "A Module") {}
272 /** This constructor can be used to specify an error message before throwing.
274 ModuleException(const std::string &message) : CoreException(message, "A Module") {}
275 /** This destructor solves world hunger, cancels the world debt, and causes the world to end.
276 * Actually no, it does nothing. Never mind.
279 virtual ~ModuleException() throw() {};