Add <cidr> block, and documentation in example config.

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

diff --git a/include/ctables.h b/include/ctables.h
index 33366f87a9f5e5e6bc3647610f507fe39544c4b4..ad2135b1e578dcb7641d462ea8e2064e247fb97b 100644 (file)
--- a/include/ctables.h
+++ b/include/ctables.h
@@ -2,7 +2,7 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
+ *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
  * See: http://www.inspircd.org/wiki/index.php/Credits
  *
  * This program is free but copyrighted software; see
@@ -14,23 +14,13 @@
 #ifndef __CTABLES_H__
 #define __CTABLES_H__
 
-
-#include "inspircd_config.h"
-#include "hash_map.h"
-#include "base.h"
-
-/* Forward declarations - required */
-class User;
-class InspIRCd;
-
 /** Used to indicate command success codes
  */
 enum CmdResult
 {
        CMD_FAILURE = 0,        /* Command exists, but failed */
        CMD_SUCCESS = 1,        /* Command exists, and succeeded */
-       CMD_INVALID = 2,        /* Command doesnt exist at all! */
-       CMD_USER_DELETED = 3    /* User was deleted - DEPRECIATED */
+       CMD_INVALID = 2         /* Command doesnt exist at all! */
 };
 
 enum TranslateType
@@ -69,7 +59,7 @@ class CoreExport Command : public Extensible
        char flags_needed;
        /** Minimum number of parameters command takes
        */
-       int min_params;
+       unsigned int min_params;
        /** used by /stats m
         */
        long double use_count;
@@ -94,19 +84,19 @@ class CoreExport Command : public Extensible
 
        /** How many seconds worth of penalty does this command have?
         */
-       int Penalty;
+       const int Penalty;
 
        /** Create a new command.
         * @param Instance Pointer to creator class
         * @param cmd Command name. This must be UPPER CASE.
-        * @param flags User modes required to execute the command.
+        * @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 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, char flags, int minpara, int before_reg = false) : ServerInstance(Instance), command(cmd), flags_needed(flags), min_params(minpara), disabled(false), works_before_reg(before_reg)
+       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)
        {
                use_count = 0;
                total_bytes = 0;
@@ -117,13 +107,12 @@ class CoreExport Command : public Extensible
 
        /** Handle the command from a user.
         * @param parameters The parameters for the command.
-        * @param pcnt The number of parameters available in 'parameters'
         * @param user The user who issued the command.
         * @return Return CMD_SUCCESS on success, or CMD_FAILURE on failure.
         * If the command succeeds but should remain local to this server,
         * return CMD_LOCALONLY.
         */
-       virtual CmdResult Handle(const char** parameters, int pcnt, User* user) = 0;
+       virtual CmdResult Handle(const std::vector<std::string>& parameters, User* user) = 0;
 
        /** Handle an internal request from another command, the core, or a module
         * @param Command ID
@@ -132,7 +121,7 @@ class CoreExport Command : public Extensible
         * If the command succeeds but should remain local to this server,
         * return CMD_LOCALONLY.
         */
-       virtual CmdResult HandleInternal(const unsigned int id, const std::deque<classbase*> &params)
+       virtual CmdResult HandleInternal(const unsigned int /* id */, const std::deque<classbase*>& /* params */)
        {
                return CMD_INVALID;
        }
@@ -140,13 +129,12 @@ class CoreExport Command : public Extensible
        /** Handle the command from a server.
         * Not currently used in this version of InspIRCd.
         * @param parameters The parameters given
-        * @param pcnt The number of parameters available
         * @param servername The server name which issued the command
         * @return Return CMD_SUCCESS on success, or CMD_FAILURE on failure.
         * If the command succeeds but should remain local to this server,
         * return CMD_LOCALONLY.
         */
-       virtual CmdResult HandleServer(const char** parameters, int pcnt, const std::string &servername)
+       virtual CmdResult HandleServer(const std::vector<std::string>& /* parameters */, const std::string& /* servername */)
        {
                return CMD_INVALID;
        }
@@ -177,12 +165,15 @@ class CoreExport Command : public Extensible
 
        /** Standard constructor gubbins
         */
-       virtual ~Command() {}
+       virtual ~Command()
+       {
+               syntax.clear();
+       }
 };
 
 /** A hash of commands used by the core
  */
-typedef nspace::hash_map<std::string,Command*> Commandable;
+typedef nspace::hash_map<std::string,Command*> Commandtable;
 
 #define TRANSLATE1(x1) translation.push_back(x1);
 #define TRANSLATE2(x1,x2)  translation.push_back(x1);translation.push_back(x2);