Tons of comments

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

diff --git a/include/ctables.h b/include/ctables.h
index 33b4d564ce0a65e00033f8d8ef100288bcca9874..0b523a77fbf84dafe0a13974570cc537d85fba65 100644 (file)
--- a/include/ctables.h
+++ b/include/ctables.h
@@ -2,7 +2,7 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  Inspire is copyright (C) 2002-2003 ChatSpike-Dev.
+ *  InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
  *                       E-mail:
  *                <brain@chatspike.net>
  *               <Craig@chatspike.net>
@@ -12,49 +12,73 @@
  *            the file COPYING for details.
  *
  * ---------------------------------------------------
+ */
  
- $Log$
- Revision 1.2  2003/01/26 23:52:59  brain
- Modified documentation for base classes
- Added base classes
-
- Revision 1.1.1.1  2003/01/23 19:45:58  brain
- InspIRCd second source tree
-
- Revision 1.3  2003/01/15 22:47:44  brain
- Changed user and channel structs to classes (finally)
+#ifndef __CTABLES_H__
+#define __CTABLES_H__
 
- Revision 1.2  2003/01/09 21:09:50  brain
- added '/stats M' command
 
- Revision 1.1  2003/01/07 01:02:14  brain
+#include "inspircd_config.h"
+#include "hash_map.h"
+#include "base.h"
 
- definitions for command table types
+class userrec;
 
+/*typedef void (handlerfunc) (char**, int, userrec*);*/
 
- * ---------------------------------------------------
+/** A structure that defines a command
  */
-#include "inspircd_config.h"
-#include "inspircd.h"
-#include "base.h"
+class command_t : public Extensible
+{
+ public:
+       /** Command name
+       */
+        std::string command;
+       /** User flags needed to execute the command or 0
+        */
+       char flags_needed;
+       /** Minimum number of parameters command takes
+       */
+       int min_params;
+       /** used by /stats m
+        */
+       long use_count;
+       /** used by /stats m
+        */
+       long total_bytes;
+       /** used for resource tracking between modules
+        */
+       std::string source;
+       /** True if the command is disabled to non-opers
+        */
+       bool disabled;
+       /** 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;
 
-#ifndef __CTABLES_H__
-#define __CTABLES_H__
+       command_t(const std::string &cmd, char flags, int minpara) : command(cmd), flags_needed(flags), min_params(minpara), disabled(false)
+       {
+               use_count = total_bytes = 0;
+               source = "<core>";
+               syntax = "";
+       }
 
-typedef void (handlerfunc) (char**, int, userrec*);
+       virtual void Handle(const char** parameters, int pcnt, userrec* user) = 0;
 
-/* a structure that defines a command */
+       void Disable(bool setting)
+       {
+               disabled = setting;
+       }
 
-class command_t : public classbase
-{
- public:
-       char command[MAXBUF]; /* command name */
-       handlerfunc *handler_function; /* handler function as in typedef */
-       char flags_needed; /* user flags needed to execute the command or 0 */
-       int min_params; /* minimum number of parameters command takes */
-       long use_count; /* used by /stats m */
-       long total_bytes; /* used by /stats m */
+       bool IsDisabled()
+       {
+               return disabled;
+       }
+
+       virtual ~command_t() {}
 };
 
-#endif
+typedef nspace::hash_map<std::string,command_t*> command_table;
 
+#endif