* | Inspire Internet Relay Chat Daemon |
* +------------------------------------+
*
- * InspIRCd: (C) 2002-2007 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ * InspIRCd: (C) 2002-2009 InspIRCd Development Team
+ * See: http://wiki.inspircd.org/Credits
*
* This program is free but copyrighted software; see
* the file COPYING for details.
* ---------------------------------------------------
*/
-#ifndef __BASE_H__
-#define __BASE_H__
+#ifndef __BASE_H__
+#define __BASE_H__
-#include "inspircd_config.h"
-#include <time.h>
#include <map>
#include <deque>
#include <string>
-/** Do we use this? -- Brain */
-typedef void* VoidPointer;
-
-/** A private data store for an Extensible class */
-typedef std::map<std::string,char*> ExtensibleStore;
-
-/** Needed */
-class InspIRCd;
+/** Dummy class to help enforce culls being parent-called up to classbase */
+class CullResult
+{
+ CullResult();
+ friend class classbase;
+};
-/** The base class for all inspircd classes.
- * Wherever possible, all classes you create should inherit from this,
- * giving them the ability to be passed to various core functions
- * as 'anonymous' classes.
-*/
+/** The base class for all inspircd classes with a well-defined lifetime.
+ * Classes that inherit from this may be destroyed through GlobalCulls,
+ * and may rely on cull() being called prior to their deletion.
+ */
class CoreExport classbase
{
public:
- /** Time that the object was instantiated (used for TS calculation etc)
- */
- time_t age;
-
- /** Constructor.
- * Sets the object's time
- */
classbase();
- /** Destructor.
- * Does sweet FA.
- */
- ~classbase() { }
+ /**
+ * Called just prior to destruction via cull list.
+ *
+ * @return true to allow the delete, or false to halt the delete
+ */
+ virtual CullResult cull();
+ virtual ~classbase();
+ private:
+ // uncopyable
+ classbase(const classbase&);
+ void operator=(const classbase&);
};
-/** class Extensible is the parent class of many classes such as userrec and chanrec.
- * class Extensible implements a system which allows modules to 'extend' the class by attaching data within
- * a map associated with the object. In this way modules can store their own custom information within user
- * objects, channel objects and server objects, without breaking other modules (this is more sensible than using
- * a flags variable, and each module defining bits within the flag as 'theirs' as it is less prone to conflict and
- * supports arbitary data storage).
+/** The base class for inspircd classes that provide a wrapping interface, and
+ * should only exist while being used. Prevents heap allocation.
*/
-class CoreExport Extensible : public classbase
+class CoreExport interfacebase
{
- /** Private data store.
- * Holds all extensible metadata for the class.
- */
- ExtensibleStore Extension_Items;
-
-public:
+ public:
+ interfacebase() {}
+ private:
+ interfacebase(const interfacebase&);
+ void operator=(const interfacebase&);
+ void* operator new(size_t);
+ void operator delete(void*);
+};
- /** Extend an Extensible class.
- *
- * @param key The key parameter is an arbitary string which identifies the extension data
- * @param p This parameter is a pointer to any data you wish to associate with the object
- *
- * You must provide a key to store the data as via the parameter 'key' and store the data
- * in the templated parameter 'p'.
- * The data will be inserted into the map. If the data already exists, you may not insert it
- * twice, Extensible::Extend will return false in this case.
- *
- * @return Returns true on success, false if otherwise
- */
- template<typename T> bool Extend(const std::string &key, T* p)
- {
- /* This will only add an item if it doesnt already exist,
- * the return value is a std::pair of an iterator to the
- * element, and a bool saying if it was actually inserted.
- */
- return this->Extension_Items.insert(std::make_pair(key, (char*)p)).second;
- }
+/** The base class for inspircd classes that support reference counting.
+ * Any objects that do not have a well-defined lifetime should inherit from
+ * this, and should be assigned to a reference<type> object to establish their
+ * lifetime.
+ *
+ * Reference objects should not hold circular references back to themselves,
+ * even indirectly; this will cause a memory leak because the count will never
+ * drop to zero.
+ *
+ * Using a normal pointer for the object is recommended if you can assure that
+ * at least one reference<> will remain as long as that pointer is used; this
+ * will avoid the slight overhead of changing the reference count.
+ */
+class CoreExport refcountbase
+{
+ mutable unsigned int refcount;
+ public:
+ refcountbase();
+ virtual ~refcountbase();
+ inline unsigned int GetReferenceCount() const { return refcount; }
+ friend class reference_base;
+ void* operator new(size_t);
+ void operator delete(void*);
+ private:
+ // uncopyable
+ refcountbase(const refcountbase&);
+ void operator=(const refcountbase&);
+};
- /** Extend an Extensible class.
- *
- * @param key The key parameter is an arbitary string which identifies the extension data
- *
- * You must provide a key to store the data as via the parameter 'key', this single-parameter
- * version takes no 'data' parameter, this is used purely for boolean values.
- * The key will be inserted into the map with a NULL 'data' pointer. If the key already exists
- * then you may not insert it twice, Extensible::Extend will return false in this case.
- *
- * @return Returns true on success, false if otherwise
- */
- bool Extend(const std::string &key)
+class CoreExport reference_base
+{
+ protected:
+ template<typename T> static inline unsigned int inc(T* v) { return ++(v->refcount); }
+ template<typename T> static inline unsigned int dec(T* v) { return --(v->refcount); }
+
+};
+
+template <typename T>
+class reference : public reference_base
+{
+ T* value;
+ public:
+ reference() : value(0) { }
+ reference(T* v) : value(v) { if (value) inc(value); }
+ reference(const reference<T>& v) : value(v.value) { if (value) inc(value); }
+ reference<T>& operator=(const reference<T>& other)
{
- /* This will only add an item if it doesnt already exist,
- * the return value is a std::pair of an iterator to the
- * element, and a bool saying if it was actually inserted.
- */
- return this->Extension_Items.insert(std::make_pair(key, (char*)NULL)).second;
+ if (other.value)
+ inc(other.value);
+ this->reference::~reference();
+ value = other.value;
+ return *this;
}
- /** Shrink an Extensible class.
- *
- * @param key The key parameter is an arbitary string which identifies the extension data
- *
- * You must provide a key name. The given key name will be removed from the classes data. If
- * you provide a nonexistent key (case is important) then the function will return false.
- * @return Returns true on success.
- */
- bool Shrink(const std::string &key);
-
- /** Get an extension item.
- *
- * @param key The key parameter is an arbitary string which identifies the extension data
- * @param p If you provide a non-existent key, this value will be NULL. Otherwise a pointer to the item you requested will be placed in this templated parameter.
- * @return Returns true if the item was found and false if it was nor, regardless of wether 'p' is NULL. This allows you to store NULL values in Extensible.
- */
- template<typename T> bool GetExt(const std::string &key, T* &p)
+ ~reference()
{
- ExtensibleStore::iterator iter = this->Extension_Items.find(key); /* Find the item */
- if(iter != this->Extension_Items.end())
- {
- p = (T*)iter->second; /* Item found */
- return true;
- }
- else
+ if (value)
{
- p = NULL; /* Item not found */
- return false;
+ int rc = dec(value);
+ if (rc == 0)
+ delete value;
}
}
-
- /** Get an extension item.
- *
- * @param key The key parameter is an arbitary string which identifies the extension data
- * @return Returns true if the item was found and false if it was not.
- *
- * This single-parameter version only checks if the key exists, it does nothing with
- * the 'data' field and is probably only useful in conjunction with the single-parameter
- * version of Extend().
- */
- bool GetExt(const std::string &key)
- {
- return (this->Extension_Items.find(key) != this->Extension_Items.end());
- }
-
- /** Get a list of all extension items names.
- * @param list A deque of strings to receive the list
- * @return This function writes a list of all extension items stored in this object by name into the given deque and returns void.
- */
- void GetExtList(std::deque<std::string> &list);
+ inline operator bool() const { return value; }
+ inline operator T*() const { return value; }
+ inline T* operator->() const { return value; }
+ inline T& operator*() const { return *value; }
+ inline bool operator<(const reference<T>& other) const { return value < other.value; }
+ inline bool operator>(const reference<T>& other) const { return value > other.value; }
+ inline bool operator==(const reference<T>& other) const { return value == other.value; }
+ inline bool operator!=(const reference<T>& other) const { return value != other.value; }
+ private:
+ void* operator new(size_t);
+ void operator delete(void*);
};
-/** BoolSet is a utility class designed to hold eight bools in a bitmask.
- * Use BoolSet::Set and BoolSet::Get to set and get bools in the bitmask,
- * and Unset and Invert for special operations upon them.
+/** This class can be used on its own to represent an exception, or derived to represent a module-specific exception.
+ * When a module whishes to abort, e.g. within a constructor, it should throw an exception using ModuleException or
+ * a class derived from ModuleException. If a module throws an exception during its constructor, the module will not
+ * 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 CoreExport BoolSet : public classbase
+class CoreExport CoreException : public std::exception
{
- /** Actual bit values */
- char bits;
-
- public:
-
- /** The default constructor initializes the BoolSet to all values unset.
+ protected:
+ /** Holds the error message to be displayed
*/
- BoolSet();
-
- /** This constructor copies the default bitmask from a char
+ const std::string err;
+ /** Source of the exception
*/
- BoolSet(char bitmask);
-
- /** The Set method sets one bool in the set.
- *
- * @param number The number of the item to set. This must be between 0 and 7.
+ const std::string source;
+ public:
+ /** Default constructor, just uses the error mesage 'Core threw an exception'.
*/
- void Set(int number);
-
- /** The Get method returns the value of one bool in the set
- *
- * @param number The number of the item to retrieve. This must be between 0 and 7.
- *
- * @return True if the item is set, false if it is unset.
+ CoreException() : err("Core threw an exception"), source("The core") {}
+ /** This constructor can be used to specify an error message before throwing.
*/
- bool Get(int number);
-
- /** The Unset method unsets one value in the set
- *
- * @param number The number of the item to set. This must be between 0 and 7.
+ 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.
*/
- void Unset(int number);
-
- /** The Unset method inverts (flips) one value in the set
- *
- * @param number The number of the item to invert. This must be between 0 and 7.
+ 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!
*/
- void Invert(int number);
-
- /** Compare two BoolSets
+ 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.
*/
- bool operator==(BoolSet other);
+ virtual const char* GetReason()
+ {
+ return err.c_str();
+ }
- /** OR two BoolSets together
- */
- BoolSet operator|(BoolSet other);
-
- /** AND two BoolSets together
- */
- BoolSet operator&(BoolSet other);
+ virtual const char* GetSource()
+ {
+ return source.c_str();
+ }
+};
- /** Assign one BoolSet to another
+class CoreExport ModuleException : public CoreException
+{
+ public:
+ /** This constructor can be used to specify an error message before throwing.
*/
- bool operator=(BoolSet other);
+ ModuleException(const std::string &message, Module* me = NULL);
};
+/** Module reference, similar to reference<Module>
+ */
+class CoreExport ModuleRef : public reference_base
+{
+ Module* const value;
+ public:
+ ModuleRef(Module* v);
+ ~ModuleRef();
+ inline operator Module*() const { return value; }
+ inline Module* operator->() const { return value; }
+ inline Module& operator*() const { return *value; }
+ private:
+ ModuleRef(const ModuleRef&);
+ void operator=(const ModuleRef&);
+ void* operator new(size_t);
+ void operator delete(void*);
+};
#endif
-
projects / user / henk / code / inspircd.git / blobdiff