Move the <disabled> tag out of the core to a new module.

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

diff --git a/include/ctables.h b/include/ctables.h
index bc4226ea93b5c7b73165fc748086c25195fd74ec..1c7d5b4bd5dadd1e45d619323ebab6411b71ca72 100644 (file)
--- a/include/ctables.h
+++ b/include/ctables.h
@@ -23,14 +23,17 @@
 
 #pragma once
 
-/** Used to indicate command success codes
- */
+/** Used to indicate the result of trying to execute a command. */
 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_EPERM = 3       /* Command failed because of a permission check */
+       /** The command exists but its execution failed. */
+       CMD_FAILURE = 0,
+
+       /** The command exists and its execution succeeded. */
+       CMD_SUCCESS = 1,
+
+       /* The command does not exist. */
+       CMD_INVALID = 2
 };
 
 /** Flag for commands that are only allowed from servers */
@@ -107,9 +110,44 @@ struct RouteDescriptor
 class CoreExport CommandBase : public ServiceProvider
 {
  public:
+       /** Encapsulates parameters to a command. */
+       class Params : public std::vector<std::string>
+       {
+        private:
+               /* IRCv3 message tags. */
+               ClientProtocol::TagMap tags;
+
+        public:
+               /** Initializes a new instance from parameter and tag references.
+                * @param paramsref Message parameters.
+                * @param tagsref IRCv3 message tags.
+                */
+               Params(const std::vector<std::string>& paramsref, const ClientProtocol::TagMap& tagsref)
+                       : std::vector<std::string>(paramsref)
+                       , tags(tagsref)
+               {
+               }
+
+               /** Initializes a new instance from parameter iterators.
+                * @param first The first element in the parameter array.
+                * @param last The last element in the parameter array.
+                */
+               template<typename Iterator>
+               Params(Iterator first, Iterator last)
+                       : std::vector<std::string>(first, last)
+               {
+               }
+
+               /** Initializes a new empty instance. */
+               Params() { }
+
+               /** Retrieves the IRCv3 message tags. */
+               const ClientProtocol::TagMap& GetTags() const { return tags; }
+       };
+
        /** User flags needed to execute the command or 0
         */
-       char flags_needed;
+       unsigned char flags_needed;
 
        /** Minimum number of parameters command takes
        */
@@ -125,10 +163,6 @@ class CoreExport CommandBase : public ServiceProvider
         */
        unsigned long use_count;
 
-       /** True if the command is disabled to non-opers
-        */
-       bool disabled;
-
        /** True if the command can be issued before registering
         */
        bool works_before_reg;
@@ -154,7 +188,7 @@ class CoreExport CommandBase : public ServiceProvider
 
        /** How many seconds worth of penalty does this command have?
         */
-       int Penalty;
+       unsigned int Penalty;
 
        /** Create a new command.
         * @param me The module which created this command.
@@ -165,31 +199,14 @@ class CoreExport CommandBase : public ServiceProvider
         */
        CommandBase(Module* me, const std::string& cmd, unsigned int minpara = 0, unsigned int maxpara = 0);
 
-       virtual RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters);
+       virtual RouteDescriptor GetRouting(User* user, const CommandBase::Params& parameters);
 
        /** 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);
-
-       /** Disable or enable this command.
-        * @param setting True to disable the command.
-        */
-       void Disable(bool setting)
-       {
-               disabled = setting;
-       }
-
-       /** Obtain this command's disable state.
-        * @return true if the command is currently disabled
-        * (disabled commands can be used only by operators)
-        */
-       bool IsDisabled()
-       {
-               return disabled;
-       }
+       virtual void EncodeParameter(std::string& parameter, unsigned int index);
 
        /** @return true if the command works before registration.
         */
@@ -216,7 +233,7 @@ class CoreExport Command : public CommandBase
         * @param user The user who issued the command.
         * @return Return CMD_SUCCESS on success, or CMD_FAILURE on failure.
         */
-       virtual CmdResult Handle(const std::vector<std::string>& parameters, User* user) = 0;
+       virtual CmdResult Handle(User* user, const Params& parameters) = 0;
 
        /** Register this object in the CommandParser
         */
@@ -231,12 +248,12 @@ class CoreExport Command : public CommandBase
 class CoreExport SplitCommand : public Command
 {
  public:
-       SplitCommand(Module* me, const std::string &cmd, int minpara = 0, int maxpara = 0)
+       SplitCommand(Module* me, const std::string &cmd, unsigned int minpara = 0, unsigned int maxpara = 0)
                : Command(me, cmd, minpara, maxpara) {}
-       virtual CmdResult Handle(const std::vector<std::string>& parameters, User* user);
-       virtual CmdResult HandleLocal(const std::vector<std::string>& parameters, LocalUser* user);
-       virtual CmdResult HandleRemote(const std::vector<std::string>& parameters, RemoteUser* user);
-       virtual CmdResult HandleServer(const std::vector<std::string>& parameters, FakeUser* user);
+       CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE;
+       virtual CmdResult HandleLocal(LocalUser* user, const Params& parameters);
+       virtual CmdResult HandleRemote(RemoteUser* user, const Params& parameters);
+       virtual CmdResult HandleServer(FakeUser* user, const Params& parameters);
 };
 
 /** Shortcut macros for defining translation lists