X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fbase.h;h=e41f520f54e75d19c83e38e0d13a4992ddc43fb2;hb=a1f073f66f4b985bf776b9be2015136209c0c311;hp=ac5fec63f9e06e76905218fbd23034006aa346b6;hpb=9941a616cbba8ad5dec07bdf908a1d08d81e568e;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/base.h b/include/base.h index ac5fec63f..e41f520f5 100644 --- a/include/base.h +++ b/include/base.h @@ -5,7 +5,7 @@ * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev. * E-mail: * - * + * * * Written by Craig Edwards, Craig McLure, and others. * This program is free but copyrighted software; see @@ -25,6 +25,8 @@ typedef void* VoidPointer; typedef std::map ExtensibleStore; + +extern time_t TIME; /** The base class for all inspircd classes */ @@ -38,7 +40,7 @@ class classbase /** Constructor, * Sets the object's time */ - classbase() { age = time(NULL); } + classbase() { age = TIME; } ~classbase() { } }; @@ -62,7 +64,8 @@ public: * @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. * @@ -76,6 +79,26 @@ public: */ 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. * @@ -83,7 +106,6 @@ public: * * 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); @@ -91,28 +113,40 @@ public: /** 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 bool GetExt(const std::string &key, T* &p) { - ExtensibleStore::iterator iter = this->Extension_Items.find(key); - if(iter != this->Extension_Items.end()) - { + ExtensibleStore::iterator iter = this->Extension_Items.find(key); + if(iter != this->Extension_Items.end()) + { p = (T*)iter->second; - return true; - } - else - { - return false; + return true; + } + else + { + p = NULL; + return false; } } - //char* GetExt(const std::string &key); + + /** 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); @@ -122,7 +156,7 @@ public: * 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 +class BoolSet : public classbase { char bits;