]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/modules.h
Refactored /RESTART (and added InspIRCd::Restart(reason))
[user/henk/code/inspircd.git] / include / modules.h
index 275063be986d8b8561b4041dc79a00405cdb4c09..337064eb3bdaca72a05205750c65522a35876a9a 100644 (file)
@@ -2,19 +2,15 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
- *                    E-mail:
- *             <brain@chatspike.net>
- *               <Craig@chatspike.net>
- *     
- * Written by Craig Edwards, Craig McLure, and others.
+ *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
+ * See: http://www.inspircd.org/wiki/index.php/Credits
+ *
  * This program is free but copyrighted software; see
- *         the file COPYING for details.
+ *            the file COPYING for details.
  *
  * ---------------------------------------------------
  */
 
-
 #ifndef __MODULES_H
 #define __MODULES_H
 
@@ -121,9 +117,9 @@ typedef std::map<std::string, std::pair<int, modulelist> > interfacelist;
                { \
                        ServerInstance->modules[_i]->x ; \
                } \
-               catch (ModuleException& modexcept) \
+               catch (CoreException& modexcept) \
                { \
-                       ServerInstance->Log(DEBUG,"Module exception caught: %s",modexcept.GetReason()); \
+                       ServerInstance->Log(DEFAULT,"Exception cought: %s",modexcept.GetReason()); \
                } \
        } \
   }
@@ -135,9 +131,9 @@ typedef std::map<std::string, std::pair<int, modulelist> > interfacelist;
                { \
                        z->modules[_i]->x ; \
                } \
-               catch (ModuleException& modexcept) \
+               catch (CoreException& modexcept) \
                { \
-                       z->Log(DEBUG,"Module exception caught: %s",modexcept.GetReason()); \
+                       z->Log(DEFAULT,"Exception cought: %s",modexcept.GetReason()); \
                } \
        } \
 }
@@ -158,9 +154,9 @@ typedef std::map<std::string, std::pair<int, modulelist> > interfacelist;
                                                break; \
                                        } \
                                } \
-                               catch (ModuleException& modexcept) \
+                               catch (CoreException& modexcept) \
                                { \
-                                       ServerInstance->Log(DEBUG,"Module exception cought: %s",modexcept.GetReason()); \
+                                       ServerInstance->Log(DEFAULT,"Exception cought: %s",modexcept.GetReason()); \
                                } \
                        } \
                } \
@@ -179,9 +175,9 @@ typedef std::map<std::string, std::pair<int, modulelist> > interfacelist;
                                                break; \
                                        } \
                                } \
-                               catch (ModuleException& modexcept) \
+                               catch (CoreException& modexcept) \
                                { \
-                                       z->Log(DEBUG,"Module exception cought: %s",modexcept.GetReason()); \
+                                       z->Log(DEBUG,"Exception cought: %s",modexcept.GetReason()); \
                                } \
                        } \
                } \
@@ -326,24 +322,29 @@ class Event : public ModuleMessage
  * be loaded. If this happens, the error message returned by ModuleException::GetReason will be displayed to the user
  * attempting to load the module, or dumped to the console if the ircd is currently loading for the first time.
  */
-class ModuleException : public std::exception
+class CoreException : public std::exception
 {
- private:
+ protected:
        /** Holds the error message to be displayed
         */
-       std::string err;
+       const std::string err;
+       const std::string source;
  public:
-       /** Default constructor, just uses the error mesage 'Module threw an exception'.
+       /** Default constructor, just uses the error mesage 'Core threw an exception'.
         */
-       ModuleException() : err("Module threw an exception") {}
+       CoreException() : err("Core threw an exception"), source("The core") {}
        /** This constructor can be used to specify an error message before throwing.
         */
-       ModuleException(std::string message) : err(message) {}
+       CoreException(const std::string &message) : err(message), source("The core") {}
+       /** This constructor can be used to specify an error message before throwing,
+        * and to specify the source of the exception.
+        */
+       CoreException(const std::string &message, const std::string &src) : err(message), source(src) {}
        /** This destructor solves world hunger, cancels the world debt, and causes the world to end.
         * Actually no, it does nothing. Never mind.
         * @throws Nothing!
         */
-       virtual ~ModuleException() throw() {};
+       virtual ~CoreException() throw() {};
        /** Returns the reason for the exception.
         * The module should probably put something informative here as the user will see this upon failure.
         */
@@ -351,6 +352,28 @@ class ModuleException : public std::exception
        {
                return err.c_str();
        }
+
+       virtual const char* GetSource()
+       {
+               return source.c_str();
+       }
+};
+
+class ModuleException : public CoreException
+{
+ public:
+       /** Default constructor, just uses the error mesage 'Module threw an exception'.
+        */
+       ModuleException() : CoreException("Module threw an exception", "A Module") {}
+
+       /** This constructor can be used to specify an error message before throwing.
+        */
+       ModuleException(const std::string &message) : CoreException(message, "A Module") {}
+       /** This destructor solves world hunger, cancels the world debt, and causes the world to end.
+        * Actually no, it does nothing. Never mind.
+        * @throws Nothing!
+        */
+       virtual ~ModuleException() throw() {};
 };
 
 /** Priority types which can be returned from Module::Prioritize()
@@ -1368,7 +1391,7 @@ class ConfigReader : public classbase
         * This method retrieves a value from the config file. Where multiple copies of the tag
         * exist in the config file, index indicates which of the values to retrieve.
         */
-       std::string ReadValue(const std::string &tag, const std::string &name, int index);
+       std::string ReadValue(const std::string &tag, const std::string &name, int index, bool allow_linefeeds = false);
        /** Retrieves a boolean value from the config file.
         * This method retrieves a boolean value from the config file. Where multiple copies of the tag
         * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"