X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fbase.h;h=bea7075a02e7e506dab3c148d135be7dc8356b74;hb=38ca8be9a3881a3cb3cf6864e67b779ffbab6874;hp=12538defab5ae5164cc134604d02e4f7a8a3d867;hpb=f6103acd925a1dc878728885bad32fbf76f62cea;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/base.h b/include/base.h index 12538defa..bea7075a0 100644 --- a/include/base.h +++ b/include/base.h @@ -2,12 +2,9 @@ * | Inspire Internet Relay Chat Daemon | * +------------------------------------+ * - * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev. - * E-mail: - * - * - * - * Written by Craig Edwards, Craig McLure, and others. + * 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. * @@ -26,8 +23,8 @@ typedef void* VoidPointer; typedef std::map ExtensibleStore; -extern time_t TIME; - +class InspIRCd; + /** The base class for all inspircd classes */ class classbase @@ -36,13 +33,12 @@ class classbase /** Time that the object was instantiated (used for TS calculation etc) */ time_t age; - static unsigned long id; /** Constructor, * Sets the object's time */ - classbase() { age = TIME; id++; } - ~classbase() { id--; } + classbase(); + ~classbase() { } }; /** class Extensible is the parent class of many classes such as userrec and chanrec. @@ -65,7 +61,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. * @@ -80,6 +77,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. * * @param key The key parameter is an arbitary string which identifies the extension data @@ -93,7 +110,8 @@ 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) { @@ -109,6 +127,20 @@ public: 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