Change std::pair<bool,std::string> to neater typedef "ModePair"

[user/henk/code/inspircd.git] / include / base.h

diff --git a/include/base.h b/include/base.h
index d458021f69b6f5ab40885111ce56267bd1d60b16..e41f520f54e75d19c83e38e0d13a4992ddc43fb2 100644 (file)
--- a/include/base.h
+++ b/include/base.h
@@ -25,6 +25,8 @@
 
 typedef void* VoidPointer;
 typedef std::map<std::string,char*> 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.
         *
@@ -90,7 +113,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<typename T> bool GetExt(const std::string &key, T* &p)
        {
@@ -106,6 +130,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