]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/base.h
Fixes for bug #12
[user/henk/code/inspircd.git] / include / base.h
index 856cd64c2370a5e5263eaa4a00c52b6e78d41b61..3f70f0195663fb0028c9ee65cea69b10e95d3ea7 100644 (file)
@@ -2,7 +2,7 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
+ *  InspIRCd: (C) 2002-2010 InspIRCd Development Team
  * See: http://wiki.inspircd.org/Credits
  *
  * This program is free but copyrighted software; see
@@ -11,8 +11,8 @@
  * ---------------------------------------------------
  */
 
-#ifndef __BASE_H__
-#define __BASE_H__
+#ifndef BASE_H
+#define BASE_H
 
 #include <map>
 #include <deque>
@@ -36,8 +36,6 @@ class CoreExport 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();
@@ -54,11 +52,12 @@ class CoreExport interfacebase
 {
  public:
        interfacebase() {}
+       static inline void* operator new(size_t, void* m) { return m; }
  private:
        interfacebase(const interfacebase&);
        void operator=(const interfacebase&);
-       void* operator new(size_t);
-       void operator delete(void*);
+       static void* operator new(size_t);
+       static void operator delete(void*);
 };
 
 /** The base class for inspircd classes that support reference counting.
@@ -76,37 +75,54 @@ class CoreExport interfacebase
  */
 class CoreExport refcountbase
 {
-       unsigned int refcount;
+       mutable unsigned int refcount;
  public:
        refcountbase();
        virtual ~refcountbase();
        inline unsigned int GetReferenceCount() const { return refcount; }
-       friend class reference_base;
+       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&);
 };
 
-class CoreExport reference_base
+/** 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
 {
- 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); }
+       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 reference : public reference_base
+class CoreExport reference
 {
        T* value;
  public:
        reference() : value(0) { }
-       reference(T* v) : value(v) { if (value) inc(value); }
-       reference(const reference& v) : value(v.value) { if (value) inc(value); }
+       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)
-                       inc(other.value);
+                       other.value->refcount_inc();
                this->reference::~reference();
                value = other.value;
                return *this;
@@ -114,19 +130,21 @@ class reference : public reference_base
 
        ~reference()
        {
-               if (value)
-               {
-                       int rc = dec(value);
-                       if (rc == 0)
-                               delete value;
-               }
+               if (value && value->refcount_dec())
+                       delete value;
        }
-       inline const T* operator->() const { return value; }
-       inline const T& operator*() const { return *value; }
-       inline T* operator->() { return value; }
-       inline T& operator*() { return *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.
@@ -137,14 +155,13 @@ class reference : public reference_base
  */
 class CoreExport CoreException : public std::exception
 {
- protected:
+ public:
        /** Holds the error message to be displayed
         */
        const std::string err;
        /** Source of the exception
         */
        const std::string source;
- public:
        /** Default constructor, just uses the error mesage 'Core threw an exception'.
         */
        CoreException() : err("Core threw an exception"), source("The core") {}
@@ -174,21 +191,44 @@ class CoreExport CoreException : public std::exception
        }
 };
 
+class Module;
 class CoreExport ModuleException : public CoreException
 {
  public:
-       /** Default constructor, just uses the error mesage 'Module threw an exception'.
-        */
-       ModuleException() : CoreException("Module threw an exception", "A Module") {}
-
        /** This constructor can be used to specify an error message before throwing.
         */
-       ModuleException(const std::string &message) : CoreException(message, "A Module") {}
-       /** 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 ~ModuleException() throw() {};
+       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