1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2009 InspIRCd Development Team
6 * See: http://wiki.inspircd.org/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
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.
26 class CoreExport classbase
32 * Called just prior to destruction via cull list.
34 * @return true to allow the delete, or false to halt the delete
40 /** The base class for inspircd classes that support reference counting.
41 * Any objects that do not have a well-defined lifetime should inherit from
44 class CoreExport refcountbase : public classbase
46 unsigned int refcount;
50 virtual ~refcountbase();
51 inline unsigned int GetReferenceCount() const { return refcount; }
52 friend class reference_base;
55 class CoreExport reference_base
58 static inline unsigned int inc(refcountbase* v) { return ++(v->refcount); }
59 static inline unsigned int dec(refcountbase* v) { return --(v->refcount); }
63 class CoreExport reference : public reference_base
67 reference() : value(0) { }
68 reference(T* v) : value(v) { if (value) inc(value); }
69 reference(const reference& v) : value(v.value) { if (value) inc(value); }
70 reference<T>& operator=(const reference<T>& other)
74 this->reference::~reference();
84 if (rc == 0 && value->cull())
88 inline const T* operator->() const { return value; }
89 inline const T& operator*() const { return *value; }
90 inline T* operator->() { return value; }
91 inline T& operator*() { return *value; }
92 operator bool() const { return value; }
93 operator T*() const { return value; }
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.
102 class CoreExport CoreException : public std::exception
105 /** Holds the error message to be displayed
107 const std::string err;
108 /** Source of the exception
110 const std::string source;
112 /** Default constructor, just uses the error mesage 'Core threw an exception'.
114 CoreException() : err("Core threw an exception"), source("The core") {}
115 /** This constructor can be used to specify an error message before throwing.
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.
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.
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.
130 virtual const char* GetReason()
135 virtual const char* GetSource()
137 return source.c_str();
141 class CoreExport ModuleException : public CoreException
144 /** Default constructor, just uses the error mesage 'Module threw an exception'.
146 ModuleException() : CoreException("Module threw an exception", "A Module") {}
148 /** This constructor can be used to specify an error message before throwing.
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.
155 virtual ~ModuleException() throw() {};