-/* +------------------------------------+\r * | Inspire Internet Relay Chat Daemon |\r * +------------------------------------+\r *\r * InspIRCd: (C) 2002-2007 InspIRCd Development Team\r * See: http://www.inspircd.org/wiki/index.php/Credits\r *\r * This program is free but copyrighted software; see\r * the file COPYING for details.\r *\r * ---------------------------------------------------\r */\r\r#ifndef __BASE_H__ \r#define __BASE_H__ \r\r#include "inspircd_config.h"\r#include <time.h>\r#include <map>\r#include <deque>\r#include <string>\r\r/** Do we use this? -- Brain */\rtypedef void* VoidPointer;\r\r/** A private data store for an Extensible class */\rtypedef std::map<std::string,char*> ExtensibleStore;\r\r/** Needed */\rclass InspIRCd;\r\r/** The base class for all inspircd classes.\r * Wherever possible, all classes you create should inherit from this,\r * giving them the ability to be passed to various core functions\r * as 'anonymous' classes.\r*/ \rclass CoreExport classbase\r{\r public:\r /** Time that the object was instantiated (used for TS calculation etc)\r */\r time_t age;\r\r /** Constructor.\r * Sets the object's time\r */\r classbase();\r\r /** Destructor.\r * Does sweet FA.\r */\r ~classbase() { }\r};\r\r/** class Extensible is the parent class of many classes such as userrec and chanrec.\r * class Extensible implements a system which allows modules to 'extend' the class by attaching data within\r * a map associated with the object. In this way modules can store their own custom information within user\r * objects, channel objects and server objects, without breaking other modules (this is more sensible than using\r * a flags variable, and each module defining bits within the flag as 'theirs' as it is less prone to conflict and\r * supports arbitary data storage).\r */\rclass CoreExport Extensible : public classbase\r{\r /** Private data store.\r * Holds all extensible metadata for the class.\r */\r ExtensibleStore Extension_Items;\r \rpublic:\r\r /** Extend an Extensible class.\r *\r * @param key The key parameter is an arbitary string which identifies the extension data\r * @param p This parameter is a pointer to any data you wish to associate with the object\r *\r * You must provide a key to store the data as via the parameter 'key' and store the data\r * in the templated parameter 'p'.\r * The data will be inserted into the map. If the data already exists, you may not insert it\r * twice, Extensible::Extend will return false in this case.\r *\r * @return Returns true on success, false if otherwise\r */\r template<typename T> bool Extend(const std::string &key, T* p)\r {\r /* This will only add an item if it doesnt already exist,\r * the return value is a std::pair of an iterator to the\r * element, and a bool saying if it was actually inserted.\r */\r return this->Extension_Items.insert(std::make_pair(key, (char*)p)).second;\r }\r\r /** Extend an Extensible class.\r *\r * @param key The key parameter is an arbitary string which identifies the extension data\r *\r * You must provide a key to store the data as via the parameter 'key', this single-parameter\r * version takes no 'data' parameter, this is used purely for boolean values.\r * The key will be inserted into the map with a NULL 'data' pointer. If the key already exists\r * then you may not insert it twice, Extensible::Extend will return false in this case.\r *\r * @return Returns true on success, false if otherwise\r */\r bool Extend(const std::string &key)\r {\r /* This will only add an item if it doesnt already exist,\r * the return value is a std::pair of an iterator to the\r * element, and a bool saying if it was actually inserted.\r */\r return this->Extension_Items.insert(std::make_pair(key, (char*)NULL)).second;\r }\r\r /** Shrink an Extensible class.\r *\r * @param key The key parameter is an arbitary string which identifies the extension data\r *\r * You must provide a key name. The given key name will be removed from the classes data. If\r * you provide a nonexistent key (case is important) then the function will return false.\r * @return Returns true on success.\r */\r bool Shrink(const std::string &key);\r \r /** Get an extension item.\r *\r * @param key The key parameter is an arbitary string which identifies the extension data\r * @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.\r * @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.\r */\r template<typename T> bool GetExt(const std::string &key, T* &p)\r {\r ExtensibleStore::iterator iter = this->Extension_Items.find(key); /* Find the item */\r if(iter != this->Extension_Items.end())\r {\r p = (T*)iter->second; /* Item found */\r return true;\r }\r else\r {\r p = NULL; /* Item not found */\r return false;\r }\r }\r \r /** Get an extension item.\r *\r * @param key The key parameter is an arbitary string which identifies the extension data\r * @return Returns true if the item was found and false if it was not.\r * \r * This single-parameter version only checks if the key exists, it does nothing with\r * the 'data' field and is probably only useful in conjunction with the single-parameter\r * version of Extend().\r */\r bool GetExt(const std::string &key)\r {\r return (this->Extension_Items.find(key) != this->Extension_Items.end());\r }\r\r /** Get a list of all extension items names.\r * @param list A deque of strings to receive the list\r * @return This function writes a list of all extension items stored in this object by name into the given deque and returns void.\r */\r void GetExtList(std::deque<std::string> &list);\r};\r\r/** BoolSet is a utility class designed to hold eight bools in a bitmask.\r * Use BoolSet::Set and BoolSet::Get to set and get bools in the bitmask,\r * and Unset and Invert for special operations upon them.\r */\rclass CoreExport BoolSet : public classbase\r{\r /** Actual bit values */\r char bits;\r\r public:\r\r /** The default constructor initializes the BoolSet to all values unset.\r */\r BoolSet();\r\r /** This constructor copies the default bitmask from a char\r */\r BoolSet(char bitmask);\r\r /** The Set method sets one bool in the set.\r *\r * @param number The number of the item to set. This must be between 0 and 7.\r */\r void Set(int number);\r\r /** The Get method returns the value of one bool in the set\r *\r * @param number The number of the item to retrieve. This must be between 0 and 7.\r *\r * @return True if the item is set, false if it is unset.\r */\r bool Get(int number);\r\r /** The Unset method unsets one value in the set\r *\r * @param number The number of the item to set. This must be between 0 and 7.\r */\r void Unset(int number);\r\r /** The Unset method inverts (flips) one value in the set\r *\r * @param number The number of the item to invert. This must be between 0 and 7.\r */\r void Invert(int number);\r\r /** Compare two BoolSets\r */\r bool operator==(BoolSet other);\r\r /** OR two BoolSets together\r */\r BoolSet operator|(BoolSet other);\r \r /** AND two BoolSets together\r */\r BoolSet operator&(BoolSet other);\r\r /** Assign one BoolSet to another\r */\r bool operator=(BoolSet other);\r};\r\r\r#endif\r\r
\ No newline at end of file
+/* +------------------------------------+
+ * | Inspire Internet Relay Chat Daemon |
+ * +------------------------------------+
+ *
+ * InspIRCd: (C) 2002-2010 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
+
+#include <map>
+#include <deque>
+#include <string>
+
+/** 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 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:
+ classbase();
+
+ /**
+ * Called just prior to destruction via cull list.
+ */
+ virtual CullResult cull();
+ virtual ~classbase();
+ private:
+ // uncopyable
+ classbase(const classbase&);
+ void operator=(const classbase&);
+};
+
+/** The base class for inspircd classes that provide a wrapping interface, and
+ * should only exist while being used. Prevents heap allocation.
+ */
+class CoreExport interfacebase
+{
+ public:
+ interfacebase() {}
+ static inline void* operator new(size_t, void* m) { return m; }
+ private:
+ interfacebase(const interfacebase&);
+ void operator=(const interfacebase&);
+ static void* operator new(size_t);
+ static void operator delete(void*);
+};
+
+/** 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; }
+ static inline void* operator new(size_t, void* m) { return m; }
+ static void* operator new(size_t);
+ static void operator delete(void*);
+ inline void refcount_inc() const { refcount++; }
+ inline bool refcount_dec() const { refcount--; return !refcount; }
+ private:
+ // uncopyable
+ refcountbase(const refcountbase&);
+ void operator=(const refcountbase&);
+};
+
+/** Base class for use count tracking. Uses reference<>, but does not
+ * cause object deletion when the last user is removed.
+ *
+ * Safe for use as a second parent class; will not add a second vtable.
+ */
+class CoreExport usecountbase
+{
+ mutable unsigned int usecount;
+ public:
+ usecountbase() : usecount(0) { }
+ ~usecountbase();
+ inline unsigned int GetUseCount() const { return usecount; }
+ inline void refcount_inc() const { usecount++; }
+ inline bool refcount_dec() const { usecount--; return false; }
+ private:
+ // uncopyable
+ usecountbase(const usecountbase&);
+ void operator=(const usecountbase&);
+};
+
+template <typename T>
+class CoreExport reference
+{
+ T* value;
+ public:
+ reference() : value(0) { }
+ reference(T* v) : value(v) { if (value) value->refcount_inc(); }
+ reference(const reference<T>& v) : value(v.value) { if (value) value->refcount_inc(); }
+ reference<T>& operator=(const reference<T>& other)
+ {
+ if (other.value)
+ other.value->refcount_inc();
+ this->reference::~reference();
+ value = other.value;
+ return *this;
+ }
+
+ ~reference()
+ {
+ if (value && value->refcount_dec())
+ delete value;
+ }
+ 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; }
+ static inline void* operator new(size_t, void* m) { return m; }
+ private:
+#ifndef WIN32
+ static void* operator new(size_t);
+ static void operator delete(void*);
+#endif
+};
+
+/** 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 CoreException : public std::exception
+{
+ public:
+ /** Holds the error message to be displayed
+ */
+ const std::string err;
+ /** Source of the exception
+ */
+ const std::string source;
+ /** Default constructor, just uses the error mesage 'Core threw an exception'.
+ */
+ CoreException() : err("Core threw an exception"), source("The core") {}
+ /** This constructor can be used to specify an error message before throwing.
+ */
+ 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 ~CoreException() throw() {};
+ /** Returns the reason for the exception.
+ * The module should probably put something informative here as the user will see this upon failure.
+ */
+ virtual const char* GetReason()
+ {
+ return err.c_str();
+ }
+
+ virtual const char* GetSource()
+ {
+ return source.c_str();
+ }
+};
+
+class Module;
+class CoreExport ModuleException : public CoreException
+{
+ public:
+ /** This constructor can be used to specify an error message before throwing.
+ */
+ ModuleException(const std::string &message, Module* me = NULL);
+};
+
+typedef const reference<Module> ModuleRef;
+
+enum ServiceType {
+ /** is a Command */
+ SERVICE_COMMAND,
+ /** is a ModeHandler */
+ SERVICE_MODE,
+ /** is a metadata descriptor */
+ SERVICE_METADATA,
+ /** is a data processing provider (MD5, SQL) */
+ SERVICE_DATA,
+ /** is an I/O hook provider (SSL) */
+ SERVICE_IOHOOK
+};
+
+/** A structure defining something that a module can provide */
+class CoreExport ServiceProvider : public classbase
+{
+ public:
+ /** Module that is providing this service */
+ ModuleRef creator;
+ /** Name of the service being provided */
+ const std::string name;
+ /** Type of service (must match object type) */
+ const ServiceType service;
+ ServiceProvider(Module* Creator, const std::string& Name, ServiceType Type)
+ : creator(Creator), name(Name), service(Type) {}
+ virtual ~ServiceProvider();
+};
+
+
+#endif
projects / user / henk / code / inspircd.git / blobdiff