Add contents of LDFLAGS in addition to CXXFLAGS

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

diff --git a/include/ctables.h b/include/ctables.h
index f744d63406d9f2c9de7c976bbf90be38ebb0b369..9018d9c351981be442df857fcb630c74ab43e17f 100644 (file)
--- a/include/ctables.h
+++ b/include/ctables.h
@@ -2,15 +2,15 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
+ * See: http://wiki.inspircd.org/Credits
  *
  * This program is free but copyrighted software; see
  *            the file COPYING for details.
  *
  * ---------------------------------------------------
  */
- 
+
 #ifndef __CTABLES_H__
 #define __CTABLES_H__
 
@@ -23,14 +23,17 @@ 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_CUSTOM,              /* Custom translation handled by EncodeParameter/DecodeParameter */
+       TR_CUSTOM               /* Custom translation handled by EncodeParameter/DecodeParameter */
 };
 
 /** For commands which should not be replicated to other
@@ -55,32 +58,49 @@ class CoreExport Command : public Extensible
        /** Command name
        */
         std::string command;
+
        /** User flags needed to execute the command or 0
         */
        char flags_needed;
+
        /** Minimum number of parameters command takes
        */
-       unsigned int min_params;
+       const unsigned int min_params;
+
+       /** Maximum number of parameters command takes.
+        * This is used by the command parser to join extra parameters into one last param.
+        * If not set, no munging is done to this command.
+        */
+       const unsigned int max_params;
+
        /** used by /stats m
         */
        long double use_count;
+
        /** used by /stats m
         */
        long double total_bytes;
+
        /** used for resource tracking between modules
         */
        std::string source;
+
        /** True if the command is disabled to non-opers
         */
        bool disabled;
+
        /** True if the command can be issued before registering
         */
        bool works_before_reg;
+
        /** Syntax string for the command, displayed if non-empty string.
         * This takes place of the text in the 'not enough parameters' numeric.
         */
        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?
@@ -93,11 +113,21 @@ class CoreExport Command : public Extensible
         * @param flags User mode required to execute the command. May ONLY be one mode - it's a string to give warnings if people mix params up.
         * For oper only commands, set this to 'o', otherwise use 0.
         * @param minpara Minimum parameters required for the command.
+        * @param maxpara Maximum number of parameters this command may have - extra parameters will be tossed into one last space-seperated param.
         * @param before_reg If this is set to true, the command will
         * be allowed before the user is 'registered' (has sent USER,
         * NICK, optionally PASS, and been resolved).
         */
-       Command(InspIRCd* Instance, const std::string &cmd, const char *flags, int minpara, int before_reg = false, int penalty = 1) :  ServerInstance(Instance), command(cmd), flags_needed(flags ? *flags : 0), min_params(minpara), disabled(false), works_before_reg(before_reg),   Penalty(penalty)
+       Command(InspIRCd* Instance, const std::string &cmd, const char *flags, int minpara, bool before_reg = false, int penalty = 1) :         ServerInstance(Instance), command(cmd), flags_needed(flags ? *flags : 0), min_params(minpara), max_params(0), disabled(false), works_before_reg(before_reg), Penalty(penalty)
+       {
+               use_count = 0;
+               total_bytes = 0;
+               source = "<core>";
+               syntax = "";
+               translation.clear();
+       }
+
+       Command(InspIRCd* Instance, const std::string &cmd, const char *flags, int minpara, int maxpara, bool before_reg = false, int penalty = 1) :    ServerInstance(Instance), command(cmd), flags_needed(flags ? *flags : 0), min_params(minpara), max_params(maxpara), disabled(false), works_before_reg(before_reg), Penalty(penalty)
        {
                use_count = 0;
                total_bytes = 0;
@@ -195,6 +225,8 @@ class CoreExport Command : public Extensible
  */
 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);
@@ -209,4 +241,3 @@ typedef nspace::hash_map<std::string,Command*> Commandtable;
        translation.push_back(x5);translation.push_back(x6);translation.push_back(x7);translation.push_back(x8);
 
 #endif
-