fix for bug #175, change OnUserRegister to return int, and if greater than 0 = user...

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

diff --git a/include/configreader.h b/include/configreader.h
index 069e6321d4c80d8afdcaf1b7bb7c714597712c22..f3816ba32b61c1756918fae6eae917ac202a843f 100644 (file)
--- a/include/configreader.h
+++ b/include/configreader.h
@@ -35,74 +35,45 @@ class InspIRCd;
  */
 enum ConfigDataType { DT_NOTHING, DT_INTEGER, DT_CHARPTR, DT_BOOLEAN };
 
+/** Holds a config value, either string, integer or boolean.
+ * Callback functions receive one or more of these, either on
+ * their own as a reference, or in a reference to a deque of them.
+ * The callback function can then alter the values of the ValueItem
+ * classes to validate the settings.
+ */
 class ValueItem
 {
        std::string v;
  public:
-       ValueItem(int value)
-       {
-               std::stringstream n;
-               n << value;
-               v = n.str();
-       }
-
-       ValueItem(bool value)
-       {
-               std::stringstream n;
-               n << value;
-               v = n.str();
-       }
-
-       ValueItem(char* value)
-       {
-               v = value;
-       }
-
-       void Set(char* value)
-       {
-               v = value;
-       }
-
-       void Set(const char* value)
-       {
-               v = value;
-       }
-
-       void Set(int value)
-       {
-               std::stringstream n;
-               n << value;
-               v = n.str();
-       }
-
-       int GetInteger()
-       {
-               return atoi(v.c_str());
-       }
-
-       char* GetString()
-       {
-               return (char*)v.c_str();
-       }
-
-       bool GetBool()
-       {
-               return (GetInteger() || v == "yes" || v == "true");
-       }
+       ValueItem(int value);
+       ValueItem(bool value);
+       ValueItem(char* value);
+       void Set(char* value);
+       void Set(const char* val);
+       void Set(int value);
+       int GetInteger();
+       char* GetString();
+       bool GetBool();
 };
 
+/** The base class of the container 'ValueContainer'
+ * used internally by the core to hold core values.
+ */
 class ValueContainerBase
 {
  public:
-       ValueContainerBase()
-       {
-       }
-
-       virtual ~ValueContainerBase()
-       {
-       }
+       ValueContainerBase() { }
+       virtual ~ValueContainerBase() { }
 };
 
+/** ValueContainer is used to contain pointers to different
+ * core values such as the server name, maximum number of
+ * clients etc.
+ * It is specialized to hold a data type, then pointed at
+ * a value in the ServerConfig class. When the value has been
+ * read and validated, the Set method is called to write the
+ * value safely in a type-safe manner.
+ */
 template<typename T> class ValueContainer : public ValueContainerBase
 {
        T val;
@@ -125,11 +96,27 @@ template<typename T> class ValueContainer : public ValueContainerBase
        }
 };
 
+/** A specialization of ValueContainer to hold a pointer to a bool
+ */
 typedef ValueContainer<bool*> ValueContainerBool;
+
+/** A specialization of ValueContainer to hold a pointer to
+ * an unsigned int
+ */
 typedef ValueContainer<unsigned int*> ValueContainerUInt;
+
+/** A specialization of ValueContainer to hold a pointer to
+ * a char array.
+ */
 typedef ValueContainer<char*> ValueContainerChar;
+
+/** A specialization of ValueContainer to hold a pointer to
+ * an int
+ */
 typedef ValueContainer<int*> ValueContainerInt;
 
+/** A set of ValueItems used by multi-value validator functions
+ */
 typedef std::deque<ValueItem> ValueList;
 
 /** A callback for validating a single value
@@ -142,7 +129,6 @@ typedef bool (*MultiValidator)(ServerConfig* conf, const char*, char**, ValueLis
  */
 typedef bool (*MultiNotify)(ServerConfig* conf, const char*);
 
-
 /** Holds a core configuration item and its callbacks
  */
 struct InitialConfig
@@ -159,9 +145,9 @@ struct InitialConfig
  */
 struct MultiConfig
 {
-       const char* tag;
-       char* items[12];
-       int datatype[12];
+       const char*     tag;
+       char*           items[12];
+       int             datatype[12];
        MultiNotify     init_function;
        MultiValidator  validation_function;
        MultiNotify     finish_function;