]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/command_parse.h
Document ENCAP.
[user/henk/code/inspircd.git] / include / command_parse.h
index 25d334dbffec543f1a92d792d548bf5ad6bf05c4..b0babac712e63e45f762955ffc9d5cf7effd58a3 100644 (file)
@@ -39,7 +39,7 @@ class CoreExport CommandParser : public classbase
         * @param parameters The input string
         * @return The number of parameters parsed into command_p
         */
-       int ProcessParameters(char **command_p,char *parameters);
+       int ProcessParameters(std::vector<std::string>& command_p, char* parameters);
 
        /** Process a command from a user.
         * @param user The user to parse the command for
@@ -74,7 +74,7 @@ class CoreExport CommandParser : public classbase
  public:
        /** Command list, a hash_map of command names to Command*
         */
-       Commandable cmdlist;
+       Commandtable cmdlist;
 
        /** Reload a core command.
         * This will only reload commands implemented by the core,
@@ -84,7 +84,7 @@ class CoreExport CommandParser : public classbase
         * @return True if the command was reloaded, false if it could not be found
         * or another error occured
         */
-       bool ReloadCommand(const char* cmd, User* user);
+       bool ReloadCommand(std::string cmd, User* user);
 
        /** Default constructor.
         * @param Instance The creator of this class
@@ -93,8 +93,7 @@ class CoreExport CommandParser : public classbase
 
        /** Calls the handler for a given command.
         * @param commandname The command to find. This should be in uppercase.
-        * @param parameters Parameter list as an array of array of char (that's not a typo).
-        * @param pcnt The number of items in the parameters list
+        * @param parameters Parameter list
         * @param user The user to call the handler on behalf of
         * @return This method will return CMD_SUCCESS if the command handler was found and called,
         * and the command completeld successfully. It will return CMD_FAILURE if the command handler was found
@@ -102,7 +101,7 @@ class CoreExport CommandParser : public classbase
         * command simply did not exist at all or the wrong number of parameters were given, or the user
         * was not privilaged enough to execute the command.
         */
-       CmdResult CallHandler(const std::string &commandname,const char** parameters, int pcnt, User *user);
+       CmdResult CallHandler(const std::string &commandname, const std::vector<std::string>& parameters, User *user);
 
        /** Get the handler function for a command.
         * @param commandname The command required. Always use uppercase for this parameter.
@@ -118,7 +117,7 @@ class CoreExport CommandParser : public classbase
         * equal to or greater than the minimum number of parameters to the given command, then this
         * function will return true, otherwise it will return false.
         */
-       bool IsValidCommand(const std::string &commandname, int pcnt, User * user);
+       bool IsValidCommand(const std::string &commandname, unsigned int pcnt, User * user);
        
        /** LoopCall is used to call a command classes handler repeatedly based on the contents of a comma seperated list.
         * There are two overriden versions of this method, one of which takes two potential lists and the other takes one.
@@ -141,7 +140,7 @@ class CoreExport CommandParser : public classbase
         * @return This function will return 1 when there are no more parameters to process. When this occurs, its
         * caller should return without doing anything, otherwise it should continue into its main section of code.
         */
-       int LoopCall(User* user, Command* CommandObj, const char** parameters, int pcnt, unsigned int splithere, unsigned int extra);
+       int LoopCall(User* user, Command* CommandObj, const std::vector<std::string>& parameters, unsigned int splithere, unsigned int extra);
 
        /** LoopCall is used to call a command classes handler repeatedly based on the contents of a comma seperated list.
         * There are two overriden versions of this method, one of which takes two potential lists and the other takes one.
@@ -164,7 +163,7 @@ class CoreExport CommandParser : public classbase
         * @return This function will return 1 when there are no more parameters to process. When this occurs, its
         * caller should return without doing anything, otherwise it should continue into its main section of code.
         */
-       int LoopCall(User* user, Command* CommandObj, const char** parameters, int pcnt, unsigned int splithere);
+       int LoopCall(User* user, Command* CommandObj, const std::vector<std::string>& parameters, unsigned int splithere);
 
        /** Take a raw input buffer from a recvq, and process it on behalf of a user.
         * @param buffer The buffer line to process
@@ -180,9 +179,8 @@ class CoreExport CommandParser : public classbase
 
        /** Remove all commands relating to module 'source'.
         * @param source A module name which has introduced new commands
-        * @return True This function returns true if commands were removed
         */
-       bool RemoveCommands(const char* source);
+       void RemoveCommands(const char* source);
 
        /** Add a new command to the commands hash
         * @param f The new Command to add to the list
@@ -220,7 +218,7 @@ class cmd_reload : public Command
        cmd_reload (InspIRCd* Instance) : Command(Instance,"RELOAD","o",1) { syntax = "<core-command>"; }
        /** Handle RELOAD
         */
-       CmdResult Handle(const char** parameters, int pcnt, User *user);
+       CmdResult Handle(const std::vector<std::string>& parameters, User *user);
 };
 
 /** A lookup table of values for multiplier characters used by
@@ -236,9 +234,9 @@ const int duration_multi[] =
        1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
        1, 1, 1, 1, 1, 1, 1, 1, 86400, 1, 1, 1, 3600,
        1, 1, 1, 1, 60, 1, 1, 1, 1, 1, 1, 1, 1, 1,
-       604800, 1, 31536000, 1, 1, 1, 1, 1, 1, 1, 1,
+       604800, 1, 31557600, 1, 1, 1, 1, 1, 1, 1, 1,
        1, 1, 86400, 1, 1, 1, 3600, 1, 1, 1, 1, 60,
-       1, 1, 1, 1, 1, 1, 1, 1, 1, 604800, 1, 31536000,
+       1, 1, 1, 1, 1, 1, 1, 1, 1, 604800, 1, 31557600,
        1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
        1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
        1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,