X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fbase.h;h=2259953b83818c174773dbd3b0219e6adef8d4c3;hb=db0c7fae77b60857adf9dd083a1b6ce524a6808f;hp=c347aedb30edc93b4318075a7adeb0341a15b3c7;hpb=8f282762b0a90458a808e13c4a52196ebd14534a;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/base.h b/include/base.h index c347aedb3..2259953b8 100644 --- a/include/base.h +++ b/include/base.h @@ -1,22 +1,214 @@ -/* +/* +------------------------------------+ + * | Inspire Internet Relay Chat Daemon | + * +------------------------------------+ + * + * 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 "inspircd_config.h" -#include - #ifndef __BASE_H__ #define __BASE_H__ - -class classbase + +#include "inspircd_config.h" +#include +#include +#include +#include + +typedef void* VoidPointer; +typedef std::map ExtensibleStore; + +class InspIRCd; + +/** The base class for all inspircd classes +*/ +class CoreExport classbase { public: + /** Time that the object was instantiated (used for TS calculation etc) + */ time_t age; - classbase() { age = time(NULL); } + /** Constructor, + * Sets the object's time + */ + classbase(); ~classbase() { } }; -#endif +/** class Extensible is the parent class of many classes such as userrec and chanrec. + * 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 + * 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 CoreExport Extensible : public classbase +{ + /** Private data store + */ + ExtensibleStore Extension_Items; + +public: + + /** Extend an Extensible class. + * + * @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 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 Returns true on success, false if otherwise + */ + template bool Extend(const std::string &key, T* p) + { + /* 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*)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 + * + * You must provide a key name. The given key name will be removed from the classes data. If + * you provide a nonexistent key (case is important) then the function will return false. + * @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 + * @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 bool GetExt(const std::string &key, T* &p) + { + ExtensibleStore::iterator iter = this->Extension_Items.find(key); + if(iter != this->Extension_Items.end()) + { + p = (T*)iter->second; + return true; + } + else + { + p = NULL; + 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 + * @return This function writes a list of all extension items stored in this object by name into the given deque and returns void. + */ + void GetExtList(std::deque &list); +}; + +/** BoolSet is a utility class designed to hold eight bools in a bitmask. + * Use BoolSet::Set and BoolSet::Get to set and get bools in the bitmask, + * and Unset and Invert for special operations upon them. + */ +class CoreExport BoolSet : public classbase +{ + char bits; + + public: + + /** The default constructor initializes the BoolSet to all values unset. + */ + BoolSet(); + + /** This constructor copies the default bitmask from a char + */ + BoolSet(char bitmask); + + /** The Set method sets one bool in the set. + * + * @param number The number of the item to set. This must be between 0 and 7. + */ + void Set(int number); + + /** The Get method returns the value of one bool in the set + * + * @param number The number of the item to retrieve. This must be between 0 and 7. + * + * @return True if the item is set, false if it is unset. + */ + bool Get(int number); + + /** The Unset method unsets one value in the set + * + * @param number The number of the item to set. This must be between 0 and 7. + */ + void Unset(int number); + + /** The Unset method inverts (flips) one value in the set + * + * @param number The number of the item to invert. This must be between 0 and 7. + */ + void Invert(int number); + + /** Compare two BoolSets + */ + bool operator==(BoolSet other); + + /** OR two BoolSets together + */ + BoolSet operator|(BoolSet other); + + /** AND two BoolSets together + */ + BoolSet operator&(BoolSet other); + + /** Assign one BoolSet to another + */ + bool operator=(BoolSet other); +}; + + +#endif