Fixed recursive 'splat' in the actors table

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

diff --git a/include/base.h b/include/base.h
index c347aedb30edc93b4318075a7adeb0341a15b3c7..c959cf8698ff8096acaba47efbfb0197feb36b78 100644 (file)
--- a/include/base.h
+++ b/include/base.h
@@ -1,22 +1,81 @@
-/*
+/*       +------------------------------------+
+ *       | Inspire Internet Relay Chat Daemon |
+ *       +------------------------------------+
+ *
+ *  Inspire is copyright (C) 2002-2004 ChatSpike-Dev.
+ *                       E-mail:
+ *                <brain@chatspike.net>
+ *               <Craig@chatspike.net>
+ *     
+ * Written by Craig Edwards, Craig McLure, and others.
+ * This program is free but copyrighted software; see
+ *            the file COPYING for details.
+ *
+ * ---------------------------------------------------
+ */
 
-
-*/
+#ifndef __BASE_H__ 
+#define __BASE_H__ 
 
 #include "inspircd_config.h" 
 #include <time.h>
+#include <map>
+#include <string>
+
+typedef void* VoidPointer;
  
-#ifndef __BASE_H__ 
-#define __BASE_H__ 
- 
+/** The base class for all inspircd classes
+*/ 
 class classbase
 {
  public:
+       /** Time that the object was instantiated (used for TS calculation etc)
+       */
        time_t age;
 
+       /** Constructor,
+        * Sets the object's time
+        */
        classbase() { age = time(NULL); }
        ~classbase() { }
 };
 
+/** 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 Extensible : public classbase
+{
+       /** Private data store
+        */
+       std::map<std::string,char*> Extension_Items;
+       
+public:
+
+       /** Extend an Extensible class.
+        * You must provide a key to store the data as, and a void* to the data (typedef VoidPointer)
+        * 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.
+        * On successful extension, Extend returns true.
+        */
+       bool Extend(std::string key, char* p);
+
+       /** Shrink an Extensible class.
+        * 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.
+        * Returns true on success.
+        */
+       bool Shrink(std::string key);
+       
+       /** Get an extension item.
+        * You must provide a key name, which is case sensitive. If you provide a non-existent key name,
+        * the function returns NULL, otherwise a pointer to the item referenced by the key is returned.
+        */
+       char* GetExt(std::string key);
+};
+
 #endif