6 /** Shown to a human (does not need to be unserializable) */
8 /** Passed internally to this process (i.e. for /RELOADMODULE) */
10 /** Passed to other servers on the network (i.e. METADATA s2s command) */
12 /** Stored on disk (i.e. permchannel database) */
16 /** Class represnting an extension of some object
18 class CoreExport ExtensionItem
21 const std::string key;
23 ExtensionItem(const std::string& key, Module* owner);
24 virtual ~ExtensionItem();
25 /** Serialize this item into a string
27 * @param format The format to serialize to
28 * @param container The object containing this item
29 * @param item The item itself
31 virtual std::string serialize(SerializeFormat format, const Extensible* container, void* item) = 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
37 virtual void unserialize(SerializeFormat format, Extensible* container, const std::string& value) = 0;
39 virtual void free(void* item) = 0;
42 /** Get the item from the internal map */
43 void* get_raw(const Extensible* container);
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);
50 /** A private data store for an Extensible class */
51 typedef std::map<std::string,void*> ExtensibleStore;
53 /** class Extensible is the parent class of many classes such as User and Channel.
54 * class Extensible implements a system which allows modules to 'extend' the class by attaching data within
55 * a map associated with the object. In this way modules can store their own custom information within user
56 * objects, channel objects and server objects, without breaking other modules (this is more sensible than using
57 * a flags variable, and each module defining bits within the flag as 'theirs' as it is less prone to conflict and
58 * supports arbitary data storage).
60 class CoreExport Extensible : public classbase
62 /** Private data store.
63 * Holds all extensible metadata for the class.
65 ExtensibleStore extensions;
66 typedef std::map<std::string, ExtensionItem*> ExtensibleTypes;
67 static ExtensibleTypes extension_types;
70 * Get the extension items for iteraton (i.e. for metadata sync during netburst)
72 inline const ExtensibleStore& GetExtList() const { return extensions; }
73 static inline const ExtensibleTypes& GetTypeList() { return extension_types; }
74 static inline ExtensionItem* GetItem(const std::string& name)
76 ExtensibleTypes::iterator i = extension_types.find(name);
77 if (i == extension_types.end())
82 virtual ~Extensible();
84 static bool Register(ExtensionItem* item);
85 static std::vector<ExtensionItem*> BeginUnregister(Module* module);
86 void doUnhookExtensions(const std::vector<ExtensionItem*>& toRemove);
88 // Friend access for the protected getter/setter
89 friend class ExtensionItem;
92 /** Base class for items that are NOT synchronized between servers */
93 class CoreExport LocalExtItem : public ExtensionItem
96 LocalExtItem(const std::string& key, Module* owner);
97 virtual ~LocalExtItem();
98 virtual std::string serialize(SerializeFormat format, const Extensible* container, void* item);
99 virtual void unserialize(SerializeFormat format, Extensible* container, const std::string& value);
100 virtual void free(void* item) = 0;
104 class CoreExport SimpleExtItem : public LocalExtItem
107 SimpleExtItem(const std::string& Key, Module* parent) : LocalExtItem(Key, parent)
111 virtual ~SimpleExtItem()
115 inline T* get(const Extensible* container)
117 return static_cast<T*>(get_raw(container));
120 inline T* getNew(Extensible* container)
122 T* ptr = get(container);
126 set_raw(container, ptr);
131 inline void set(Extensible* container, const T& value)
133 T* ptr = new T(value);
134 T* old = static_cast<T*>(set_raw(container, ptr));
138 inline void set(Extensible* container, T* value)
140 T* old = static_cast<T*>(set_raw(container, value));
144 inline void unset(Extensible* container)
146 T* old = static_cast<T*>(unset_raw(container));
150 virtual void free(void* item)
152 delete static_cast<T*>(item);
156 class CoreExport LocalStringExt : public SimpleExtItem<std::string>
159 LocalStringExt(const std::string& key, Module* owner);
160 virtual ~LocalStringExt();
161 std::string serialize(SerializeFormat format, const Extensible* container, void* item);
164 class CoreExport LocalIntExt : public LocalExtItem
167 LocalIntExt(const std::string& key, Module* owner);
168 virtual ~LocalIntExt();
169 std::string serialize(SerializeFormat format, const Extensible* container, void* item);
170 intptr_t get(const Extensible* container);
171 intptr_t set(Extensible* container, intptr_t value);
172 void free(void* item);
175 class CoreExport StringExtItem : public ExtensionItem
178 StringExtItem(const std::string& key, Module* owner);
179 virtual ~StringExtItem();
180 std::string* get(const Extensible* container);
181 std::string serialize(SerializeFormat format, const Extensible* container, void* item);
182 void unserialize(SerializeFormat format, Extensible* container, const std::string& value);
183 void set(Extensible* container, const std::string& value);
184 void unset(Extensible* container);
185 void free(void* item);