Document SendMetaData.

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

diff --git a/include/ctables.h b/include/ctables.h
index d9f660f7145f5a652da3a51669a857a6fb79f89c..37ed92ce0dac923b83ee2c24f217d76b1e8a0d27 100644 (file)
--- a/include/ctables.h
+++ b/include/ctables.h
@@ -23,13 +23,19 @@ enum CmdResult
        CMD_INVALID = 2         /* Command doesnt exist at all! */
 };
 
+/** Translation types for translation of parameters to UIDs.
+ * This allows the core commands to not have to be aware of how UIDs
+ * work (making it still possible to write other linking modules which
+ * do not use UID (but why would you want to?)
+ */
 enum TranslateType
 {
        TR_END,                 /* End of known parameters, everything after this is TR_TEXT */
        TR_TEXT,                /* Raw text, leave as-is */
        TR_NICK,                /* Nickname, translate to UUID for server->server */
        TR_NICKLIST,            /* Comma seperated nickname list, translate to UUIDs */
-       TR_SPACENICKLIST        /* Space seperated nickname list, translate to UUIDs */
+       TR_SPACENICKLIST,       /* Space seperated nickname list, translate to UUIDs */
+       TR_CUSTOM               /* Custom translation handled by EncodeParameter/DecodeParameter */
 };
 
 /** For commands which should not be replicated to other
@@ -80,6 +86,9 @@ class CoreExport Command : public Extensible
         */
        std::string syntax;
 
+       /** Translation type list for possible parameters, used to tokenize
+        * parameters into UIDs and SIDs etc.
+        */
        std::vector<TranslateType> translation;
 
        /** How many seconds worth of penalty does this command have?
@@ -139,6 +148,25 @@ class CoreExport Command : public Extensible
                return CMD_INVALID;
        }
 
+       /** Encode a parameter for server->server transmission.
+        * Used for parameters for which the translation type is TR_CUSTOM.
+        * @param parameter The parameter to encode. Can be modified in place.
+        * @param index The parameter index (0 == first parameter).
+        */
+       virtual void EncodeParameter(std::string& parameter, int index)
+       {
+       }
+
+       /** Decode a parameter from server->server transmission.
+        * Not currently used in this version of InspIRCd.
+        * Used for parameters for which the translation type is TR_CUSTOM.
+        * @param parameter The parameter to decode. Can be modified in place.
+        * @param index The parameter index (0 == first parameter).
+        */
+       virtual void DecodeParameter(std::string& parameter, int index)
+       {
+       }
+
        /** Disable or enable this command.
         * @param setting True to disable the command.
         */
@@ -173,8 +201,10 @@ class CoreExport Command : public Extensible
 
 /** A hash of commands used by the core
  */
-typedef nspace::hash_map<std::string,Command*> Commandable;
+typedef nspace::hash_map<std::string,Command*> Commandtable;
 
+/** Shortcut macros for defining translation lists
+ */
 #define TRANSLATE1(x1) translation.push_back(x1);
 #define TRANSLATE2(x1,x2)  translation.push_back(x1);translation.push_back(x2);
 #define TRANSLATE3(x1,x2,x3)  translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);