Documentation change to indicate errno is valid on return from the constructor -...

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

diff --git a/include/command_parse.h b/include/command_parse.h
index d4c64dab4ad0db8d42ce6bbe32df231e26d92d3e..5750416db1806208e408af97170db3935dd713ed 100644 (file)
--- a/include/command_parse.h
+++ b/include/command_parse.h
@@ -2,12 +2,9 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
- *                       E-mail:
- *                <brain@chatspike.net>
- *                <Craig@chatspike.net>
+ *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
+ * See: http://www.inspircd.org/wiki/index.php/Credits
  *
- * Written by Craig Edwards, Craig McLure, and others.
  * This program is free but copyrighted software; see
  *            the file COPYING for details.
  *
@@ -24,6 +21,8 @@
 
 class InspIRCd;
 
+typedef std::map<std::string, void*> SharedObjectList;
+
 /** This class handles command management and parsing.
  * It allows you to add and remove commands from the map,
  * call command handlers by name, and chop up comma seperated
@@ -36,6 +35,10 @@ class CommandParser : public classbase
         */
        InspIRCd* ServerInstance;
 
+       /** Parameter buffer
+        */
+       std::vector<std::string> para;
+
        /** Process a parameter string into a list of items
         * @param command_p The output list of items
         * @param parameters The input string
@@ -53,14 +56,42 @@ class CommandParser : public classbase
         */
        void SetupCommandTable();
 
-       void FindSym(void** v, void* h);
+       /** Finds the init_command symbol in a .so file
+        * @param v A function pointer to be initialized
+        * @param h A valid shared object handle
+        * @return True if the symbol could be found
+        */
+       bool FindSym(void** v, void* h);
+
+       /** A list of core-implemented modes and their shared object handles
+        */
+       SharedObjectList RFCCommands;
+
+       /** Load a command from a shared object on disk.
+        * @param name The shared object to load (without path)
+        */
+       void LoadCommand(const char* name);
+
+       /** Removes a command if the sources match. Used as a helper for
+        *  safe hash_map delete while iter in RemoveCommands(const char* source).
+        */
+       void RemoveCommand(nspace::hash_map<std::string,command_t*>::iterator safei, const char* source);
+
 
  public:
        /** Command list, a hash_map of command names to command_t*
         */
        command_table cmdlist;
 
-       void LoadCommand(const char* name);
+       /** Reload a core command.
+        * This will only reload commands implemented by the core,
+        * to reload a modular command, you must reload that module.
+        * @param cmd The command to reload. This will cause the shared
+        * object which implements this command to be closed, and then reloaded.
+        * @return True if the command was reloaded, false if it could not be found
+        * or another error occured
+        */
+       bool ReloadCommand(const char* cmd);
 
        /** Default constructor.
         * @param Instance The creator of this class
@@ -72,9 +103,15 @@ class CommandParser : public classbase
         * @param parameters Parameter list as an array of array of char (that's not a typo).
         * @param pcnt The number of items in the parameters list
         * @param user The user to call the handler on behalf of
-        * @return This method will return true if the command handler was found and called
+        * @return This method will return CMD_SUCCESS if the command handler was found and called,
+        * and the command completeld successfully. It will return CMD_FAILURE if the command handler was found
+        * and called, but the command did not complete successfully, and it will return CMD_INVALID if the
+        * command simply did not exist at all or the wrong number of parameters were given, or the user
+        * was not privilaged enough to execute the command.
         */
-       bool CallHandler(const std::string &commandname,const char** parameters, int pcnt, userrec *user);
+       CmdResult CallHandler(const std::string &commandname,const char** parameters, int pcnt, userrec *user);
+
+       command_t* GetHandler(const std::string &commandname);
 
        /** This function returns true if a command is valid with the given number of parameters and user.
         * @param commandname The command name to check
@@ -146,9 +183,28 @@ class CommandParser : public classbase
 
        /** Add a new command to the commands hash
         * @param f The new command_t to add to the list
+        * @param so_handle The handle to the shared object where the command can be found.
+        * Only core commands loaded via cmd_*.so files should set this parameter to anything
+        * meaningful. Module authors should leave this parameter at its default of NULL.
         * @return True if the command was added
         */
-       bool CreateCommand(command_t *f);
+       bool CreateCommand(command_t *f, void* so_handle = NULL);
+};
+
+/** Command handler class for the RELOAD command.
+ * A command cant really reload itself, so this has to be in here.
+ */
+class cmd_reload : public command_t
+{
+ public:
+       /** Standard constructor
+        */
+       cmd_reload (InspIRCd* Instance) : command_t(Instance,"RELOAD",'o',1) { syntax = "<core-command>"; }
+       /** Handle RELOAD
+        */
+       CmdResult Handle(const char** parameters, int pcnt, userrec *user);
 };
 
+
+
 #endif