summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorattilamolnar <attilamolnar@hush.com>2013-07-15 12:26:45 +0200
committerattilamolnar <attilamolnar@hush.com>2013-08-18 15:11:02 +0200
commit153179b574dccd6df9c5c5f3e68f3c1725e26843 (patch)
tree06b56255d8a45a476089e772cc30d11f2dde19fa /include
parentb395c59997debe3827a39ec23cba54465d2aaf6a (diff)
Create the CommandBase class from Command
The Handle() method is not part of CommandBase, making it possible to provide a different Handle() in each class derived from CommandBase
Diffstat (limited to 'include')
-rw-r--r--include/command_parse.h4
-rw-r--r--include/ctables.h34
2 files changed, 26 insertions, 12 deletions
diff --git a/include/command_parse.h b/include/command_parse.h
index f9ea1df7f..6682bc4fb 100644
--- a/include/command_parse.h
+++ b/include/command_parse.h
@@ -125,7 +125,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
* @param paramnumber The index of the parameter we are translating.
*/
- static void TranslateSingleParam(TranslateType to, const std::string& item, std::string& dest, Command* custom_translator = NULL, unsigned int paramnumber = 0);
+ static void TranslateSingleParam(TranslateType to, const std::string& item, std::string& dest, CommandBase* custom_translator = NULL, unsigned int paramnumber = 0);
/** Translate nicknames in a list of strings into UIDs, based on the TranslateTypes given.
* @param to The translation types to use for the process. If this list is too short, TR_TEXT is assumed for the rest.
@@ -134,7 +134,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, Command* custom_translator = NULL);
+ static std::string TranslateUIDs(const std::vector<TranslateType>& to, const std::vector<std::string>& source, bool prefix_final = false, CommandBase* custom_translator = NULL);
};
/** A lookup table of values for multiplier characters used by
diff --git a/include/ctables.h b/include/ctables.h
index f6d712937..747901459 100644
--- a/include/ctables.h
+++ b/include/ctables.h
@@ -97,7 +97,7 @@ struct RouteDescriptor
/** A structure that defines a command. Every command available
* in InspIRCd must be defined as derived from Command.
*/
-class CoreExport Command : public ServiceProvider
+class CoreExport CommandBase : public ServiceProvider
{
public:
/** User flags needed to execute the command or 0
@@ -156,20 +156,13 @@ class CoreExport Command : public ServiceProvider
* @param maxpara Maximum number of parameters this command may have - extra parameters
* will be tossed into one last space-seperated param.
*/
- Command(Module* me, const std::string &cmd, int minpara = 0, int maxpara = 0) :
+ CommandBase(Module* me, const std::string &cmd, int minpara = 0, int maxpara = 0) :
ServiceProvider(me, cmd, SERVICE_COMMAND), flags_needed(0), min_params(minpara), max_params(maxpara),
use_count(0), disabled(false), works_before_reg(false), allow_empty_last_param(true),
Penalty(1)
{
}
- /** Handle the command from a user.
- * @param parameters The parameters for the command.
- * @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 RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
{
return ROUTE_LOCALONLY;
@@ -218,7 +211,28 @@ class CoreExport Command : public ServiceProvider
return works_before_reg;
}
- virtual ~Command();
+ virtual ~CommandBase();
+};
+
+class CoreExport Command : public CommandBase
+{
+ public:
+ Command(Module* me, const std::string& cmd, unsigned int minpara = 0, unsigned int maxpara = 0)
+ : CommandBase(me, cmd, minpara, maxpara)
+ {
+ }
+
+ /** Handle the command from a user.
+ * @param parameters The parameters for the command.
+ * @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;
+
+ /** Destructor
+ * Removes this command from the command parser
+ */
+ ~Command();
};
class CoreExport SplitCommand : public Command