include/extensible.h

   1 class Extensible;
   2 class Module;
   3
   4 enum SerializeFormat
   5 {
   6         /** Shown to a human (does not need to be unserializable) */
   7         FORMAT_USER,
   8         /** Passed internally to this process (i.e. for /RELOADMODULE) */
   9         FORMAT_INTERNAL,
  10         /** Passed to other servers on the network (i.e. METADATA s2s command) */
  11         FORMAT_NETWORK,
  12         /** Stored on disk (i.e. permchannel database) */
  13         FORMAT_PERSIST
  14 };
  15
  16 /** Class represnting an extension of some object
  17  */
  18 class CoreExport ExtensionItem
  19 {
  20  public:
  21         const std::string key;
  22         Module* const owner;
  23         ExtensionItem(const std::string& key, Module* owner);
  24         virtual ~ExtensionItem();
  25         /** Serialize this item into a string
  26          *
  27          * @param format The format to serialize to
  28          * @param container The object containing this item
  29          * @param item The item itself
  30          */
  31         virtual std::string serialize(SerializeFormat format, const Extensible* container, void* item) const = 0;
  32         /** Convert the string form back into an item
  33          * @param format The format to serialize from (not FORMAT_USER)
  34          * @param container The object that this item applies to
  35          * @param value The return from a serialize() call that was run elsewhere with this key
  36          */
  37         virtual void unserialize(SerializeFormat format, Extensible* container, const std::string& value) = 0;
  38         /** Free the item */
  39         virtual void free(void* item) = 0;
  40
  41  protected:
  42         /** Get the item from the internal map */
  43         void* get_raw(const Extensible* container) const;
  44         /** Set the item in the internal map; returns old value */
  45         void* set_raw(Extensible* container, void* value);
  46         /** Remove the item from the internal map; returns old value */
  47         void* unset_raw(Extensible* container);
  48 };
  49
  50 /** class Extensible is the parent class of many classes such as User and Channel.
  51  * class Extensible implements a system which allows modules to 'extend' the class by attaching data within
  52  * a map associated with the object. In this way modules can store their own custom information within user
  53  * objects, channel objects and server objects, without breaking other modules (this is more sensible than using
  54  * a flags variable, and each module defining bits within the flag as 'theirs' as it is less prone to conflict and
  55  * supports arbitary data storage).
  56  */
  57 class CoreExport Extensible : public classbase
  58 {
  59  public:
  60         typedef std::map<ExtensionItem*,void*> ExtensibleStore;
  61
  62         // Friend access for the protected getter/setter
  63         friend class ExtensionItem;
  64  private:
  65         /** Private data store.
  66          * Holds all extensible metadata for the class.
  67          */
  68         ExtensibleStore extensions;
  69  public:
  70         /**
  71          * Get the extension items for iteraton (i.e. for metadata sync during netburst)
  72          */
  73         inline const ExtensibleStore& GetExtList() const { return extensions; }
  74
  75         Extensible();
  76         virtual CullResult cull();
  77         virtual ~Extensible();
  78         void doUnhookExtensions(const std::vector<ExtensionItem*>& toRemove);
  79 };
  80
  81 class CoreExport ExtensionManager
  82 {
  83         std::map<std::string, ExtensionItem*> types;
  84  public:
  85         void Register(ExtensionItem* item);
  86         void BeginUnregister(Module* module, std::vector<ExtensionItem*>& list);
  87         ExtensionItem* GetItem(const std::string& name);
  88 };
  89
  90 /** Base class for items that are NOT synchronized between servers */
  91 class CoreExport LocalExtItem : public ExtensionItem
  92 {
  93  public:
  94         LocalExtItem(const std::string& key, Module* owner);
  95         virtual ~LocalExtItem();
  96         virtual std::string serialize(SerializeFormat format, const Extensible* container, void* item) const;
  97         virtual void unserialize(SerializeFormat format, Extensible* container, const std::string& value);
  98         virtual void free(void* item) = 0;
  99 };
 100
 101 template<typename T>
 102 class SimpleExtItem : public LocalExtItem
 103 {
 104  public:
 105         SimpleExtItem(const std::string& Key, Module* parent) : LocalExtItem(Key, parent)
 106         {
 107         }
 108
 109         virtual ~SimpleExtItem()
 110         {
 111         }
 112
 113         inline T* get(const Extensible* container) const
 114         {
 115                 return static_cast<T*>(get_raw(container));
 116         }
 117
 118         inline void set(Extensible* container, const T& value)
 119         {
 120                 T* ptr = new T(value);
 121                 T* old = static_cast<T*>(set_raw(container, ptr));
 122                 delete old;
 123         }
 124
 125         inline void set(Extensible* container, T* value)
 126         {
 127                 T* old = static_cast<T*>(set_raw(container, value));
 128                 delete old;
 129         }
 130
 131         inline void unset(Extensible* container)
 132         {
 133                 T* old = static_cast<T*>(unset_raw(container));
 134                 delete old;
 135         }
 136
 137         virtual void free(void* item)
 138         {
 139                 delete static_cast<T*>(item);
 140         }
 141 };
 142
 143 class CoreExport LocalStringExt : public SimpleExtItem<std::string>
 144 {
 145  public:
 146         LocalStringExt(const std::string& key, Module* owner);
 147         virtual ~LocalStringExt();
 148         std::string serialize(SerializeFormat format, const Extensible* container, void* item) const;
 149 };
 150
 151 class CoreExport LocalIntExt : public LocalExtItem
 152 {
 153  public:
 154         LocalIntExt(const std::string& key, Module* owner);
 155         virtual ~LocalIntExt();
 156         std::string serialize(SerializeFormat format, const Extensible* container, void* item) const;
 157         intptr_t get(const Extensible* container) const;
 158         intptr_t set(Extensible* container, intptr_t value);
 159         void free(void* item);
 160 };
 161
 162 class CoreExport StringExtItem : public ExtensionItem
 163 {
 164  public:
 165         StringExtItem(const std::string& key, Module* owner);
 166         virtual ~StringExtItem();
 167         std::string* get(const Extensible* container) const;
 168         std::string serialize(SerializeFormat format, const Extensible* container, void* item) const;
 169         void unserialize(SerializeFormat format, Extensible* container, const std::string& value);
 170         void set(Extensible* container, const std::string& value);
 171         void unset(Extensible* container);
 172         void free(void* item);
 173 };