Change SERVICE_{CMODE,UMODE} to SERVICE_MODE, which makes more sense

[user/henk/code/inspircd.git] / include / base.h

diff --git a/include/base.h b/include/base.h
index 0de37e781d6653796d589078e3dcf27a3f01d3bc..e75b4029fe27903f56b03617a57ed264c1f37c0d 100644 (file)
--- a/include/base.h
+++ b/include/base.h
@@ -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
@@ -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();
@@ -81,32 +79,48 @@ class CoreExport refcountbase
        refcountbase();
        virtual ~refcountbase();
        inline unsigned int GetReferenceCount() const { return refcount; }
-       friend class reference_base;
+       void* operator new(size_t);
+       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 reference
 {
        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* 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,12 +128,8 @@ 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 operator bool() const { return value; }
        inline operator T*() const { return value; }
@@ -127,8 +137,6 @@ class reference : public reference_base
        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*);
@@ -179,8 +187,6 @@ class CoreExport CoreException : public std::exception
        }
 };
 
-class Module;
-
 class CoreExport ModuleException : public CoreException
 {
  public:
@@ -189,20 +195,35 @@ class CoreExport ModuleException : public CoreException
        ModuleException(const std::string &message, Module* me = NULL);
 };
 
-class CoreExport ModuleRef : public reference_base
+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
 {
-       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*);
+       /** 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