]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/extensible.h
Release v3.0.0 release candidate 2.
[user/henk/code/inspircd.git] / include / extensible.h
index ff7bce477b767ea1aa2af98ed97b172c524d6f2c..f88ede4611805e449f6c690864f0327b7abe09cf 100644 (file)
@@ -1,5 +1,23 @@
-class Extensible;
-class Module;
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
+ *
+ *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
+ *
+ * This file is part of InspIRCd.  InspIRCd is free software: you can
+ * redistribute it and/or modify it under the terms of the GNU General Public
+ * License as published by the Free Software Foundation, version 2.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+
+#pragma once
 
 enum SerializeFormat
 {
@@ -15,12 +33,23 @@ enum SerializeFormat
 
 /** Class represnting an extension of some object
  */
-class CoreExport ExtensionItem
+class CoreExport ExtensionItem : public ServiceProvider, public usecountbase
 {
  public:
-       const std::string key;
-       Module* const owner;
-       ExtensionItem(const std::string& key, Module* owner);
+       /** Extensible subclasses
+        */
+       enum ExtensibleType
+       {
+               EXT_USER,
+               EXT_CHANNEL,
+               EXT_MEMBERSHIP
+       };
+
+       /** Type (subclass) of Extensible that this ExtensionItem is valid for
+        */
+       const ExtensibleType type;
+
+       ExtensionItem(const std::string& key, ExtensibleType exttype, Module* owner);
        virtual ~ExtensionItem();
        /** Serialize this item into a string
         *
@@ -36,7 +65,11 @@ class CoreExport ExtensionItem
         */
        virtual void unserialize(SerializeFormat format, Extensible* container, const std::string& value) = 0;
        /** Free the item */
-       virtual void free(void* item) = 0;
+       virtual void free(Extensible* container, void* item) = 0;
+
+       /** Register this object in the ExtensionManager
+        */
+       void RegisterService() CXX11_OVERRIDE;
 
  protected:
        /** Get the item from the internal map */
@@ -57,7 +90,7 @@ class CoreExport ExtensionItem
 class CoreExport Extensible : public classbase
 {
  public:
-       typedef std::map<ExtensionItem*,void*> ExtensibleStore;
+       typedef insp::flat_map<reference<ExtensionItem>, void*> ExtensibleStore;
 
        // Friend access for the protected getter/setter
        friend class ExtensionItem;
@@ -66,41 +99,63 @@ class CoreExport Extensible : public classbase
         * Holds all extensible metadata for the class.
         */
        ExtensibleStore extensions;
+
+       /** True if this Extensible has been culled.
+        * A warning is generated if false on destruction.
+        */
+       unsigned int culled:1;
  public:
        /**
         * Get the extension items for iteraton (i.e. for metadata sync during netburst)
         */
        inline const ExtensibleStore& GetExtList() const { return extensions; }
 
+       Extensible();
+       CullResult cull() CXX11_OVERRIDE;
        virtual ~Extensible();
-       void doUnhookExtensions(const std::vector<ExtensionItem*>& toRemove);
+       void doUnhookExtensions(const std::vector<reference<ExtensionItem> >& toRemove);
+
+       /**
+        * Free all extension items attached to this Extensible
+        */
+       void FreeAllExtItems();
 };
 
 class CoreExport ExtensionManager
 {
-       std::map<std::string, ExtensionItem*> types;
  public:
-       void Register(ExtensionItem* item);
-       void BeginUnregister(Module* module, std::vector<ExtensionItem*>& list);
+       typedef std::map<std::string, reference<ExtensionItem> > ExtMap;
+
+       bool Register(ExtensionItem* item);
+       void BeginUnregister(Module* module, std::vector<reference<ExtensionItem> >& list);
        ExtensionItem* GetItem(const std::string& name);
+
+       /** Get all registered extensions keyed by their names
+        * @return Const map of ExtensionItem pointers keyed by their names
+        */
+       const ExtMap& GetExts() const { return types; }
+
+ private:
+       ExtMap types;
 };
 
 /** Base class for items that are NOT synchronized between servers */
 class CoreExport LocalExtItem : public ExtensionItem
 {
  public:
-       LocalExtItem(const std::string& key, Module* owner);
+       LocalExtItem(const std::string& key, ExtensibleType exttype, Module* owner);
        virtual ~LocalExtItem();
-       virtual std::string serialize(SerializeFormat format, const Extensible* container, void* item) const;
-       virtual void unserialize(SerializeFormat format, Extensible* container, const std::string& value);
-       virtual void free(void* item) = 0;
+       std::string serialize(SerializeFormat format, const Extensible* container, void* item) const CXX11_OVERRIDE;
+       void unserialize(SerializeFormat format, Extensible* container, const std::string& value) CXX11_OVERRIDE;
+       void free(Extensible* container, void* item) CXX11_OVERRIDE = 0;
 };
 
-template<typename T>
+template <typename T, typename Del = stdalgo::defaultdeleter<T> >
 class SimpleExtItem : public LocalExtItem
 {
  public:
-       SimpleExtItem(const std::string& Key, Module* parent) : LocalExtItem(Key, parent)
+       SimpleExtItem(const std::string& Key, ExtensibleType exttype, Module* parent)
+               : LocalExtItem(Key, exttype, parent)
        {
        }
 
@@ -113,70 +168,66 @@ class SimpleExtItem : public LocalExtItem
                return static_cast<T*>(get_raw(container));
        }
 
-       inline T* getNew(Extensible* container) const
-       {
-               T* ptr = get(container);
-               if (!ptr)
-               {
-                       ptr = new T;
-                       set_raw(container, ptr);
-               }
-               return ptr;
-       }
-
        inline void set(Extensible* container, const T& value)
        {
                T* ptr = new T(value);
                T* old = static_cast<T*>(set_raw(container, ptr));
-               delete old;
+               Del del;
+               del(old);
        }
 
        inline void set(Extensible* container, T* value)
        {
                T* old = static_cast<T*>(set_raw(container, value));
-               delete old;
+               Del del;
+               del(old);
        }
 
        inline void unset(Extensible* container)
        {
                T* old = static_cast<T*>(unset_raw(container));
-               delete old;
+               Del del;
+               del(old);
        }
 
-       virtual void free(void* item)
+       void free(Extensible* container, void* item) CXX11_OVERRIDE
        {
-               delete static_cast<T*>(item);
+               Del del;
+               del(static_cast<T*>(item));
        }
 };
 
 class CoreExport LocalStringExt : public SimpleExtItem<std::string>
 {
  public:
-       LocalStringExt(const std::string& key, Module* owner);
+       LocalStringExt(const std::string& key, ExtensibleType exttype, Module* owner);
        virtual ~LocalStringExt();
-       std::string serialize(SerializeFormat format, const Extensible* container, void* item) const;
+       std::string serialize(SerializeFormat format, const Extensible* container, void* item) const CXX11_OVERRIDE;
+       void unserialize(SerializeFormat format, Extensible* container, const std::string& value) CXX11_OVERRIDE;
 };
 
 class CoreExport LocalIntExt : public LocalExtItem
 {
  public:
-       LocalIntExt(const std::string& key, Module* owner);
+       LocalIntExt(const std::string& key, ExtensibleType exttype, Module* owner);
        virtual ~LocalIntExt();
-       std::string serialize(SerializeFormat format, const Extensible* container, void* item) const;
+       std::string serialize(SerializeFormat format, const Extensible* container, void* item) const CXX11_OVERRIDE;
+       void unserialize(SerializeFormat format, Extensible* container, const std::string& value) CXX11_OVERRIDE;
        intptr_t get(const Extensible* container) const;
        intptr_t set(Extensible* container, intptr_t value);
-       void free(void* item);
+       void unset(Extensible* container) { set(container, 0); }
+       void free(Extensible* container, void* item) CXX11_OVERRIDE;
 };
 
 class CoreExport StringExtItem : public ExtensionItem
 {
  public:
-       StringExtItem(const std::string& key, Module* owner);
+       StringExtItem(const std::string& key, ExtensibleType exttype, Module* owner);
        virtual ~StringExtItem();
        std::string* get(const Extensible* container) const;
-       std::string serialize(SerializeFormat format, const Extensible* container, void* item) const;
-       void unserialize(SerializeFormat format, Extensible* container, const std::string& value);
+       std::string serialize(SerializeFormat format, const Extensible* container, void* item) const CXX11_OVERRIDE;
+       void unserialize(SerializeFormat format, Extensible* container, const std::string& value) CXX11_OVERRIDE;
        void set(Extensible* container, const std::string& value);
        void unset(Extensible* container);
-       void free(void* item);
+       void free(Extensible* container, void* item) CXX11_OVERRIDE;
 };