1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * Inspire is copyright (C) 2002-2004 ChatSpike-Dev.
7 * <brain@chatspike.net>
8 * <Craig@chatspike.net>
10 * Written by Craig Edwards, Craig McLure, and others.
11 * This program is free but copyrighted software; see
12 * the file COPYING for details.
14 * ---------------------------------------------------
20 #include "inspircd_config.h"
26 typedef void* VoidPointer;
28 /** The base class for all inspircd classes
33 /** Time that the object was instantiated (used for TS calculation etc)
38 * Sets the object's time
40 classbase() { age = time(NULL); }
44 /** class Extensible is the parent class of many classes such as userrec and chanrec.
45 * class Extensible implements a system which allows modules to 'extend' the class by attaching data within
46 * a map associated with the object. In this way modules can store their own custom information within user
47 * objects, channel objects and server objects, without breaking other modules (this is more sensible than using
48 * a flags variable, and each module defining bits within the flag as 'theirs' as it is less prone to conflict and
49 * supports arbitary data storage).
51 class Extensible : public classbase
53 /** Private data store
55 std::map<std::string,char*> 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, and a void* to the data (typedef VoidPointer)
65 * The data will be inserted into the map. If the data already exists, you may not insert it
66 * twice, Extensible::Extend will return false in this case.
68 * @return Returns true on success, false if otherwise
70 bool Extend(std::string key, char* p);
72 /** Shrink an Extensible class.
74 * @param key The key parameter is an arbitary string which identifies the extension data
76 * You must provide a key name. The given key name will be removed from the classes data. If
77 * you provide a nonexistent key (case is important) then the function will return false.
79 * @return Returns true on success.
81 bool Shrink(std::string key);
83 /** Get an extension item.
85 * @param key The key parameter is an arbitary string which identifies the extension data
87 * @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.
89 char* GetExt(std::string key);
91 /** Get a list of all extension items names.
93 * @param list A deque of strings to receive the list
95 * @return This function writes a list of all extension items stored in this object by name into the given deque and returns void.
97 void GetExtList(std::deque<std::string> &list);
100 /** BoolSet is a utility class designed to hold eight bools in a bitmask.
101 * Use BoolSet::Set and BoolSet::Get to set and get bools in the bitmask,
102 * and Unset and Invert for special operations upon them.
110 /** The default constructor initializes the BoolSet to all values unset.
114 /** This constructor copies the default bitmask from a char
116 BoolSet(char bitmask);
118 /** The Set method sets one bool in the set.
120 * @param number The number of the item to set. This must be between 0 and 7.
122 void Set(int number);
124 /** The Get method returns the value of one bool in the set
126 * @param number The number of the item to retrieve. This must be between 0 and 7.
128 * @return True if the item is set, false if it is unset.
130 bool Get(int number);
132 /** The Unset method unsets one value in the set
134 * @param number The number of the item to set. This must be between 0 and 7.
136 void Unset(int number);
138 /** The Unset method inverts (flips) one value in the set
140 * @param number The number of the item to invert. This must be between 0 and 7.
142 void Invert(int number);
144 /** Compare two BoolSets
146 bool operator==(BoolSet other);
148 /** OR two BoolSets together
150 BoolSet operator|(BoolSet other);
152 /** AND two BoolSets together
154 BoolSet operator&(BoolSet other);
156 /** Assign one BoolSet to another
158 bool operator=(BoolSet other);