]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/command_parse.h
Implement IRCv3 message tag support.
[user/henk/code/inspircd.git] / include / command_parse.h
index 6682bc4fbb2bd45f579592332be1268557038e99..98484ca540f798618c20fdc4a06f99439c03751d 100644 (file)
  */
 class CoreExport CommandParser
 {
+ public:
+       typedef TR1NS::unordered_map<std::string, Command*, irc::insensitive, irc::StrHashComp> CommandMap;
+
  private:
        /** Process a command from a user.
-        * @param user The user to parse the command for
-        * @param cmd The command string to process
+        * @param user The user to parse the command for.
+        * @param command The name of the command.
+        * @param parameters The parameters to the command.
         */
-       void ProcessCommand(LocalUser* user, std::string& cmd);
+       void ProcessCommand(LocalUser* user, std::string& command, CommandBase::Params& parameters);
 
- public:
        /** Command list, a hash_map of command names to Command*
         */
-       Commandtable cmdlist;
+       CommandMap cmdlist;
 
+ public:
        /** Default constructor.
         */
        CommandParser();
 
+       /** Get a command name -> Command* map containing all client to server commands
+        * @return A map of command handlers keyed by command names
+        */
+       const CommandMap& GetCommands() const { return cmdlist; }
+
        /** Calls the handler for a given command.
         * @param commandname The command to find. This should be in uppercase.
         * @param parameters Parameter list
         * @param user The user to call the handler on behalf of
+        * @param cmd If non-NULL and the command was executed it is set to the command handler,
+        * otherwise it isn't written to.
         * @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
         * and called, but the command did not complete successfully, and it will return CMD_INVALID if the
         * 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 std::vector<std::string>& parameters, User *user);
+       CmdResult CallHandler(const std::string& commandname, const CommandBase::Params& parameters, User* user, Command** cmd = NULL);
 
        /** Get the handler function for a command.
         * @param commandname The command required. Always use uppercase for this parameter.
@@ -75,7 +86,7 @@ class CoreExport CommandParser
         * With one list it is much simpler, and is used in NAMES, WHOIS, PRIVMSG etc.
         *
         * If there is only one list and there are duplicates in it, then the command handler is only called for
-        * unique items. Entries are compared using "irc comparision" (see irc::string).
+        * unique items. Entries are compared using "irc comparison".
         * If the usemax parameter is true (the default) the function only parses until it reaches
         * ServerInstance->Config->MaxTargets number of targets, to stop abuse via spam.
         *
@@ -100,13 +111,13 @@ class CoreExport CommandParser
         * command handler for each entry on the list. When this occurs, the caller should return without doing anything,
         * otherwise it should continue into its main section of code.
         */
-       static bool LoopCall(User* user, Command* handler, const std::vector<std::string>& parameters, unsigned int splithere, int extra = -1, bool usemax = true);
+       static bool LoopCall(User* user, Command* handler, const CommandBase::Params& parameters, unsigned int splithere, int extra = -1, bool usemax = true);
 
        /** Take a raw input buffer from a recvq, and process it on behalf of a user.
         * @param buffer The buffer line to process
         * @param user The user to whom this line belongs
         */
-       void ProcessBuffer(std::string &buffer,LocalUser *user);
+       void ProcessBuffer(LocalUser* user, const std::string& buffer);
 
        /** Add a new command to the commands hash
         * @param f The new Command to add to the list
@@ -134,7 +145,7 @@ class CoreExport CommandParser
         * @param custom_translator Used to translate the parameter if the translation type is TR_CUSTOM, if NULL, TR_CUSTOM will act like TR_TEXT
         * @return dest The output string
         */
-       static std::string TranslateUIDs(const std::vector<TranslateType>& to, const std::vector<std::string>& source, bool prefix_final = false, CommandBase* custom_translator = NULL);
+       static std::string TranslateUIDs(const std::vector<TranslateType>& to, const CommandBase::Params& source, bool prefix_final = false, CommandBase* custom_translator = NULL);
 };
 
 /** A lookup table of values for multiplier characters used by