include/base.h

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
   6  * See: http://wiki.inspircd.org/Credits
   7  *
   8  * This program is free but copyrighted software; see
   9  *            the file COPYING for details.
  10  *
  11  * ---------------------------------------------------
  12  */
  13
  14 #ifndef __BASE_H__
  15 #define __BASE_H__
  16
  17 #include <map>
  18 #include <deque>
  19 #include <string>
  20
  21 /** The base class for all inspircd classes.
  22  * Wherever possible, all classes you create should inherit from this,
  23  * giving them the ability to be passed to various core functions
  24  * as 'anonymous' classes.
  25 */
  26 class CoreExport classbase
  27 {
  28  public:
  29         classbase();
  30
  31         virtual ~classbase() { }
  32 };
  33
  34 /** BoolSet is a utility class designed to hold eight bools in a bitmask.
  35  * Use BoolSet::Set and BoolSet::Get to set and get bools in the bitmask,
  36  * and Unset and Invert for special operations upon them.
  37  */
  38 class CoreExport BoolSet : public classbase
  39 {
  40         /** Actual bit values */
  41         char bits;
  42
  43  public:
  44
  45         /** The default constructor initializes the BoolSet to all values unset.
  46          */
  47         BoolSet();
  48
  49         /** This constructor copies the default bitmask from a char
  50          */
  51         BoolSet(char bitmask);
  52
  53         /** The Set method sets one bool in the set.
  54          *
  55          * @param number The number of the item to set. This must be between 0 and 7.
  56          */
  57         void Set(int number);
  58
  59         /** The Get method returns the value of one bool in the set
  60          *
  61          * @param number The number of the item to retrieve. This must be between 0 and 7.
  62          *
  63          * @return True if the item is set, false if it is unset.
  64          */
  65         bool Get(int number);
  66
  67         /** The Unset method unsets one value in the set
  68          *
  69          * @param number The number of the item to set. This must be between 0 and 7.
  70          */
  71         void Unset(int number);
  72
  73         /** The Unset method inverts (flips) one value in the set
  74          *
  75          * @param number The number of the item to invert. This must be between 0 and 7.
  76          */
  77         void Invert(int number);
  78
  79         /** Compare two BoolSets
  80          */
  81         bool operator==(BoolSet other);
  82
  83         /** OR two BoolSets together
  84          */
  85         BoolSet operator|(BoolSet other);
  86
  87         /** AND two BoolSets together
  88          */
  89         BoolSet operator&(BoolSet other);
  90
  91         /** Assign one BoolSet to another
  92          */
  93         bool operator=(BoolSet other);
  94 };
  95
  96 /** This class can be used on its own to represent an exception, or derived to represent a module-specific exception.
  97  * When a module whishes to abort, e.g. within a constructor, it should throw an exception using ModuleException or
  98  * a class derived from ModuleException. If a module throws an exception during its constructor, the module will not
  99  * be loaded. If this happens, the error message returned by ModuleException::GetReason will be displayed to the user
 100  * attempting to load the module, or dumped to the console if the ircd is currently loading for the first time.
 101  */
 102 class CoreExport CoreException : public std::exception
 103 {
 104  protected:
 105         /** Holds the error message to be displayed
 106          */
 107         const std::string err;
 108         /** Source of the exception
 109          */
 110         const std::string source;
 111  public:
 112         /** Default constructor, just uses the error mesage 'Core threw an exception'.
 113          */
 114         CoreException() : err("Core threw an exception"), source("The core") {}
 115         /** This constructor can be used to specify an error message before throwing.
 116          */
 117         CoreException(const std::string &message) : err(message), source("The core") {}
 118         /** This constructor can be used to specify an error message before throwing,
 119          * and to specify the source of the exception.
 120          */
 121         CoreException(const std::string &message, const std::string &src) : err(message), source(src) {}
 122         /** This destructor solves world hunger, cancels the world debt, and causes the world to end.
 123          * Actually no, it does nothing. Never mind.
 124          * @throws Nothing!
 125          */
 126         virtual ~CoreException() throw() {};
 127         /** Returns the reason for the exception.
 128          * The module should probably put something informative here as the user will see this upon failure.
 129          */
 130         virtual const char* GetReason()
 131         {
 132                 return err.c_str();
 133         }
 134
 135         virtual const char* GetSource()
 136         {
 137                 return source.c_str();
 138         }
 139 };
 140
 141 class CoreExport ModuleException : public CoreException
 142 {
 143  public:
 144         /** Default constructor, just uses the error mesage 'Module threw an exception'.
 145          */
 146         ModuleException() : CoreException("Module threw an exception", "A Module") {}
 147
 148         /** This constructor can be used to specify an error message before throwing.
 149          */
 150         ModuleException(const std::string &message) : CoreException(message, "A Module") {}
 151         /** This destructor solves world hunger, cancels the world debt, and causes the world to end.
 152          * Actually no, it does nothing. Never mind.
 153          * @throws Nothing!
 154          */
 155         virtual ~ModuleException() throw() {};
 156 };
 157
 158 #endif