X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fctables.h;h=c34e4abeb4ab9f1b6336a2b42fa0394068b97daf;hb=384ef31bc01e4a1a2e59d082c9066002410ba54a;hp=abf65f56127122f2e742b76592b3b65fdd8f23fe;hpb=6fe1f4e1136f2ab95a88e68af1894bf6002d03f4;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/ctables.h b/include/ctables.h index abf65f561..c34e4abeb 100644 --- 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,11 @@ struct RouteDescriptor class CoreExport CommandBase : public ServiceProvider { public: + typedef std::vector Params; + /** User flags needed to execute the command or 0 */ - char flags_needed; + unsigned char flags_needed; /** Minimum number of parameters command takes */ @@ -154,7 +159,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,14 +170,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& 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); + virtual void EncodeParameter(std::string& parameter, unsigned int index); /** Disable or enable this command. * @param setting True to disable the command. @@ -216,7 +221,11 @@ 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& parameters, User* user) = 0; + virtual CmdResult Handle(User* user, const Params& parameters) = 0; + + /** Register this object in the CommandParser + */ + void RegisterService() CXX11_OVERRIDE; /** Destructor * Removes this command from the command parser @@ -227,12 +236,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& parameters, User* user); - virtual CmdResult HandleLocal(const std::vector& parameters, LocalUser* user); - virtual CmdResult HandleRemote(const std::vector& parameters, RemoteUser* user); - virtual CmdResult HandleServer(const std::vector& 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