1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2009 InspIRCd Development Team
6 * See: http://wiki.inspircd.org/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
21 /** A private data store for an Extensible class */
22 typedef std::map<std::string,char*> ExtensibleStore;
24 /** The base class for all inspircd classes.
25 * Wherever possible, all classes you create should inherit from this,
26 * giving them the ability to be passed to various core functions
27 * as 'anonymous' classes.
29 class CoreExport classbase
33 * Sets the object's time
40 virtual ~classbase() { }
43 /** class Extensible is the parent class of many classes such as User and Channel.
44 * class Extensible implements a system which allows modules to 'extend' the class by attaching data within
45 * a map associated with the object. In this way modules can store their own custom information within user
46 * objects, channel objects and server objects, without breaking other modules (this is more sensible than using
47 * a flags variable, and each module defining bits within the flag as 'theirs' as it is less prone to conflict and
48 * supports arbitary data storage).
50 class CoreExport Extensible : public classbase
52 /** Private data store.
53 * Holds all extensible metadata for the class.
55 ExtensibleStore Extension_Items;
59 /** Extend an Extensible class.
61 * @param key The key parameter is an arbitary string which identifies the extension data
62 * @param p This parameter is a pointer to any data you wish to associate with the object
64 * You must provide a key to store the data as via the parameter 'key' and store the data
65 * in the templated parameter 'p'.
66 * The data will be inserted into the map. If the data already exists, you may not insert it
67 * twice, Extensible::Extend will return false in this case.
69 * @return Returns true on success, false if otherwise
71 template<typename T> bool Extend(const std::string &key, T* p)
73 /* This will only add an item if it doesnt already exist,
74 * the return value is a std::pair of an iterator to the
75 * element, and a bool saying if it was actually inserted.
77 return this->Extension_Items.insert(std::make_pair(key, (char*)p)).second;
80 /** Extend an Extensible class.
82 * @param key The key parameter is an arbitary string which identifies the extension data
84 * You must provide a key to store the data as via the parameter 'key', this single-parameter
85 * version takes no 'data' parameter, this is used purely for boolean values.
86 * The key will be inserted into the map with a NULL 'data' pointer. If the key already exists
87 * then you may not insert it twice, Extensible::Extend will return false in this case.
89 * @return Returns true on success, false if otherwise
91 bool Extend(const std::string &key)
93 /* This will only add an item if it doesnt already exist,
94 * the return value is a std::pair of an iterator to the
95 * element, and a bool saying if it was actually inserted.
97 return this->Extension_Items.insert(std::make_pair(key, (char*)NULL)).second;
100 /** Shrink an Extensible class.
102 * @param key The key parameter is an arbitary string which identifies the extension data
104 * You must provide a key name. The given key name will be removed from the classes data. If
105 * you provide a nonexistent key (case is important) then the function will return false.
106 * @return Returns true on success.
108 bool Shrink(const std::string &key);
110 /** Get an extension item.
112 * @param key The key parameter is an arbitary string which identifies the extension data
113 * @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.
114 * @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.
116 template<typename T> bool GetExt(const std::string &key, T* &p)
118 ExtensibleStore::iterator iter = this->Extension_Items.find(key); /* Find the item */
119 if(iter != this->Extension_Items.end())
121 p = (T*)iter->second; /* Item found */
126 p = NULL; /* Item not found */
131 /** Get an extension item.
133 * @param key The key parameter is an arbitary string which identifies the extension data
134 * @return Returns true if the item was found and false if it was not.
136 * This single-parameter version only checks if the key exists, it does nothing with
137 * the 'data' field and is probably only useful in conjunction with the single-parameter
138 * version of Extend().
140 bool GetExt(const std::string &key)
142 return (this->Extension_Items.find(key) != this->Extension_Items.end());
145 /** Get a list of all extension items names.
146 * @param list A deque of strings to receive the list
147 * @return This function writes a list of all extension items stored in this object by name into the given deque and returns void.
149 void GetExtList(std::deque<std::string> &list);
152 /** BoolSet is a utility class designed to hold eight bools in a bitmask.
153 * Use BoolSet::Set and BoolSet::Get to set and get bools in the bitmask,
154 * and Unset and Invert for special operations upon them.
156 class CoreExport BoolSet : public classbase
158 /** Actual bit values */
163 /** The default constructor initializes the BoolSet to all values unset.
167 /** This constructor copies the default bitmask from a char
169 BoolSet(char bitmask);
171 /** The Set method sets one bool in the set.
173 * @param number The number of the item to set. This must be between 0 and 7.
175 void Set(int number);
177 /** The Get method returns the value of one bool in the set
179 * @param number The number of the item to retrieve. This must be between 0 and 7.
181 * @return True if the item is set, false if it is unset.
183 bool Get(int number);
185 /** The Unset method unsets one value in the set
187 * @param number The number of the item to set. This must be between 0 and 7.
189 void Unset(int number);
191 /** The Unset method inverts (flips) one value in the set
193 * @param number The number of the item to invert. This must be between 0 and 7.
195 void Invert(int number);
197 /** Compare two BoolSets
199 bool operator==(BoolSet other);
201 /** OR two BoolSets together
203 BoolSet operator|(BoolSet other);
205 /** AND two BoolSets together
207 BoolSet operator&(BoolSet other);
209 /** Assign one BoolSet to another
211 bool operator=(BoolSet other);
214 /** This class can be used on its own to represent an exception, or derived to represent a module-specific exception.
215 * When a module whishes to abort, e.g. within a constructor, it should throw an exception using ModuleException or
216 * a class derived from ModuleException. If a module throws an exception during its constructor, the module will not
217 * be loaded. If this happens, the error message returned by ModuleException::GetReason will be displayed to the user
218 * attempting to load the module, or dumped to the console if the ircd is currently loading for the first time.
220 class CoreExport CoreException : public std::exception
223 /** Holds the error message to be displayed
225 const std::string err;
226 /** Source of the exception
228 const std::string source;
230 /** Default constructor, just uses the error mesage 'Core threw an exception'.
232 CoreException() : err("Core threw an exception"), source("The core") {}
233 /** This constructor can be used to specify an error message before throwing.
235 CoreException(const std::string &message) : err(message), source("The core") {}
236 /** This constructor can be used to specify an error message before throwing,
237 * and to specify the source of the exception.
239 CoreException(const std::string &message, const std::string &src) : err(message), source(src) {}
240 /** This destructor solves world hunger, cancels the world debt, and causes the world to end.
241 * Actually no, it does nothing. Never mind.
244 virtual ~CoreException() throw() {};
245 /** Returns the reason for the exception.
246 * The module should probably put something informative here as the user will see this upon failure.
248 virtual const char* GetReason()
253 virtual const char* GetSource()
255 return source.c_str();
259 class CoreExport ModuleException : public CoreException
262 /** Default constructor, just uses the error mesage 'Module threw an exception'.
264 ModuleException() : CoreException("Module threw an exception", "A Module") {}
266 /** This constructor can be used to specify an error message before throwing.
268 ModuleException(const std::string &message) : CoreException(message, "A Module") {}
269 /** This destructor solves world hunger, cancels the world debt, and causes the world to end.
270 * Actually no, it does nothing. Never mind.
273 virtual ~ModuleException() throw() {};