1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2010 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 /** Dummy class to help enforce culls being parent-called up to classbase */
25 friend class classbase;
28 /** The base class for all inspircd classes with a well-defined lifetime.
29 * Classes that inherit from this may be destroyed through GlobalCulls,
30 * and may rely on cull() being called prior to their deletion.
32 class CoreExport classbase
38 * Called just prior to destruction via cull list.
40 virtual CullResult cull();
44 classbase(const classbase&);
45 void operator=(const classbase&);
48 /** The base class for inspircd classes that provide a wrapping interface, and
49 * should only exist while being used. Prevents heap allocation.
51 class CoreExport interfacebase
56 interfacebase(const interfacebase&);
57 void operator=(const interfacebase&);
58 void* operator new(size_t);
59 void operator delete(void*);
62 /** The base class for inspircd classes that support reference counting.
63 * Any objects that do not have a well-defined lifetime should inherit from
64 * this, and should be assigned to a reference<type> object to establish their
67 * Reference objects should not hold circular references back to themselves,
68 * even indirectly; this will cause a memory leak because the count will never
71 * Using a normal pointer for the object is recommended if you can assure that
72 * at least one reference<> will remain as long as that pointer is used; this
73 * will avoid the slight overhead of changing the reference count.
75 class CoreExport refcountbase
77 mutable unsigned int refcount;
80 virtual ~refcountbase();
81 inline unsigned int GetReferenceCount() const { return refcount; }
82 void* operator new(size_t);
83 void operator delete(void*);
84 inline void refcount_inc() const { refcount++; }
85 inline bool refcount_dec() const { refcount--; return !refcount; }
88 refcountbase(const refcountbase&);
89 void operator=(const refcountbase&);
92 /** Base class for use count tracking. Uses reference<>, but does not
93 * cause object deletion when the last user is removed.
95 * Safe for use as a second parent class; will not add a second vtable.
97 class CoreExport usecountbase
99 mutable unsigned int usecount;
101 usecountbase() : usecount(0) { }
103 inline unsigned int GetUseCount() const { return usecount; }
104 inline void refcount_inc() const { usecount++; }
105 inline bool refcount_dec() const { usecount--; return false; }
108 usecountbase(const usecountbase&);
109 void operator=(const usecountbase&);
112 template <typename T>
117 reference() : value(0) { }
118 reference(T* v) : value(v) { if (value) value->refcount_inc(); }
119 reference(const reference<T>& v) : value(v.value) { if (value) value->refcount_inc(); }
120 reference<T>& operator=(const reference<T>& other)
123 other.value->refcount_inc();
124 this->reference::~reference();
131 if (value && value->refcount_dec())
134 inline operator bool() const { return value; }
135 inline operator T*() const { return value; }
136 inline T* operator->() const { return value; }
137 inline T& operator*() const { return *value; }
138 inline bool operator<(const reference<T>& other) const { return value < other.value; }
139 inline bool operator>(const reference<T>& other) const { return value > other.value; }
141 void* operator new(size_t);
142 void operator delete(void*);
145 /** This class can be used on its own to represent an exception, or derived to represent a module-specific exception.
146 * When a module whishes to abort, e.g. within a constructor, it should throw an exception using ModuleException or
147 * a class derived from ModuleException. If a module throws an exception during its constructor, the module will not
148 * be loaded. If this happens, the error message returned by ModuleException::GetReason will be displayed to the user
149 * attempting to load the module, or dumped to the console if the ircd is currently loading for the first time.
151 class CoreExport CoreException : public std::exception
154 /** Holds the error message to be displayed
156 const std::string err;
157 /** Source of the exception
159 const std::string source;
160 /** Default constructor, just uses the error mesage 'Core threw an exception'.
162 CoreException() : err("Core threw an exception"), source("The core") {}
163 /** This constructor can be used to specify an error message before throwing.
165 CoreException(const std::string &message) : err(message), source("The core") {}
166 /** This constructor can be used to specify an error message before throwing,
167 * and to specify the source of the exception.
169 CoreException(const std::string &message, const std::string &src) : err(message), source(src) {}
170 /** This destructor solves world hunger, cancels the world debt, and causes the world to end.
171 * Actually no, it does nothing. Never mind.
174 virtual ~CoreException() throw() {};
175 /** Returns the reason for the exception.
176 * The module should probably put something informative here as the user will see this upon failure.
178 virtual const char* GetReason()
183 virtual const char* GetSource()
185 return source.c_str();
189 class CoreExport ModuleException : public CoreException
192 /** This constructor can be used to specify an error message before throwing.
194 ModuleException(const std::string &message, Module* me = NULL);
197 typedef const reference<Module> ModuleRef;
202 /** is a ModeHandler */
204 /** is a metadata descriptor */
206 /** is a data processing provider (MD5, SQL) */
208 /** is an I/O hook provider (SSL) */
212 /** A structure defining something that a module can provide */
213 class CoreExport ServiceProvider : public classbase
216 /** Module that is providing this service */
218 /** Name of the service being provided */
219 const std::string name;
220 /** Type of service (must match object type) */
221 const ServiceType service;
222 ServiceProvider(Module* Creator, const std::string& Name, ServiceType Type)
223 : creator(Creator), name(Name), service(Type) {}
224 virtual ~ServiceProvider();