X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fextensible.h;h=07756fb599a419fe3525fb326cfac2ff28d1ec22;hb=c528328748444fa0f0cff1a0377a7a6b9e557905;hp=10e96d8752d80d04ca56519c7311acb0fa8c8629;hpb=d5e36aa2b2ca26fe689ae9e29c74b3565dd018c7;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/extensible.h b/include/extensible.h index 10e96d875..07756fb59 100644 --- a/include/extensible.h +++ b/include/extensible.h @@ -1,5 +1,23 @@ -class Extensible; -class Module; +/* + * InspIRCd -- Internet Relay Chat Daemon + * + * Copyright (C) 2009 Daniel De Graaf + * + * 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 . + */ + + +#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 * @@ -28,7 +57,7 @@ class CoreExport ExtensionItem * @param container The object containing this item * @param item The item itself */ - virtual std::string serialize(SerializeFormat format, const Extensible* container, void* item) = 0; + virtual std::string serialize(SerializeFormat format, const Extensible* container, void* item) const = 0; /** Convert the string form back into an item * @param format The format to serialize from (not FORMAT_USER) * @param container The object that this item applies to @@ -38,18 +67,19 @@ class CoreExport ExtensionItem /** Free the item */ virtual void free(void* item) = 0; + /** Register this object in the ExtensionManager + */ + void RegisterService() CXX11_OVERRIDE; + protected: /** Get the item from the internal map */ - void* get_raw(const Extensible* container); + void* get_raw(const Extensible* container) const; /** Set the item in the internal map; returns old value */ void* set_raw(Extensible* container, void* value); /** Remove the item from the internal map; returns old value */ void* unset_raw(Extensible* container); }; -/** A private data store for an Extensible class */ -typedef std::map ExtensibleStore; - /** class Extensible is the parent class of many classes such as User and Channel. * class Extensible implements a system which allows modules to 'extend' the class by attaching data within * a map associated with the object. In this way modules can store their own custom information within user @@ -59,52 +89,73 @@ typedef std::map ExtensibleStore; */ class CoreExport Extensible : public classbase { + public: + typedef insp::flat_map, void*> ExtensibleStore; + + // Friend access for the protected getter/setter + friend class ExtensionItem; + private: /** Private data store. * Holds all extensible metadata for the class. */ ExtensibleStore extensions; - typedef std::map ExtensibleTypes; - static ExtensibleTypes extension_types; + + /** 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; } - static inline const ExtensibleTypes& GetTypeList() { return extension_types; } - static inline ExtensionItem* GetItem(const std::string& name) - { - ExtensibleTypes::iterator i = extension_types.find(name); - if (i == extension_types.end()) - return NULL; - return i->second; - } + Extensible(); + virtual CullResult cull(); virtual ~Extensible(); + void doUnhookExtensions(const std::vector >& toRemove); - static bool Register(ExtensionItem* item); - static std::vector BeginUnregister(Module* module); - void doUnhookExtensions(const std::vector& toRemove); + /** + * Free all extension items attached to this Extensible + */ + void FreeAllExtItems(); +}; - // Friend access for the protected getter/setter - friend class ExtensionItem; +class CoreExport ExtensionManager +{ + public: + typedef std::map > ExtMap; + + bool Register(ExtensionItem* item); + void BeginUnregister(Module* module, std::vector >& 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); + 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; }; -template -class CoreExport SimpleExtItem : public LocalExtItem +template > +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) { } @@ -112,73 +163,69 @@ class CoreExport SimpleExtItem : public LocalExtItem { } - inline T* get(const Extensible* container) + inline T* get(const Extensible* container) const { return static_cast(get_raw(container)); } - inline T* getNew(Extensible* container) - { - 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(set_raw(container, ptr)); - delete old; + Del del; + del(old); } inline void set(Extensible* container, T* value) { T* old = static_cast(set_raw(container, value)); - delete old; + Del del; + del(old); } inline void unset(Extensible* container) { T* old = static_cast(unset_raw(container)); - delete old; + Del del; + del(old); } virtual void free(void* item) { - delete static_cast(item); + Del del; + del(static_cast(item)); } }; class CoreExport LocalStringExt : public SimpleExtItem { 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); + std::string serialize(SerializeFormat format, const Extensible* container, void* item) const; + void unserialize(SerializeFormat format, Extensible* container, const std::string& value); }; 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); - intptr_t get(const Extensible* container); + std::string serialize(SerializeFormat format, const Extensible* container, void* item) const; + void unserialize(SerializeFormat format, Extensible* container, const std::string& value); + intptr_t get(const Extensible* container) const; intptr_t set(Extensible* container, intptr_t value); + void unset(Extensible* container) { set(container, 0); } void free(void* item); }; 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); - std::string serialize(SerializeFormat format, const Extensible* container, void* item); + 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); void set(Extensible* container, const std::string& value); void unset(Extensible* container);