]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/ctables.h
This needs some testing.
[user/henk/code/inspircd.git] / include / ctables.h
index 26140c607578f5617e00b0c75ca79463607a0f0f..ca2ef074b8758ddc5239001acadd948dc060a747 100644 (file)
 #include "base.h"
 
 class userrec;
+class InspIRCd;
 
-/*typedef void (handlerfunc) (char**, int, userrec*);*/
+/** Used to indicate command success codes
+ */
+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_USER_DELETED = 3,   /* User was deleted! */
+};
 
 /** A structure that defines a command
  */
 class command_t : public Extensible
 {
+ protected:
+       InspIRCd* ServerInstance;
  public:
        /** Command name
        */
@@ -52,14 +63,22 @@ class command_t : public Extensible
        /** True if the command is disabled to non-opers
         */
        bool disabled;
+       /** True if the command can be issued before registering
+        */
+       bool works_before_reg;
+       /** Syntax string for the command, displayed if non-empty string.
+        * This takes place of the text in the 'not enough parameters' numeric.
+        */
+       std::string syntax;
 
-       command_t(const std::string &cmd, char flags, int minpara) : command(cmd), flags_needed(flags), min_params(minpara), disabled(false)
+       command_t(InspIRCd* Instance, const std::string &cmd, char flags, int minpara, int before_reg = false) : ServerInstance(Instance), command(cmd), flags_needed(flags), min_params(minpara), disabled(false), works_before_reg(before_reg)
        {
                use_count = total_bytes = 0;
                source = "<core>";
+               syntax = "";
        }
 
-       virtual void Handle(const char** parameters, int pcnt, userrec* user) = 0;
+       virtual CmdResult Handle(const char** parameters, int pcnt, userrec* user) = 0;
 
        void Disable(bool setting)
        {
@@ -71,6 +90,11 @@ class command_t : public Extensible
                return disabled;
        }
 
+       bool WorksBeforeReg()
+       {
+               return works_before_reg;
+       }
+
        virtual ~command_t() {}
 };