X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fextensible.h;h=bcc4992bb4867cf1fcad7923ecb8a4750a23b9a3;hb=4c751dbbe8945e5efc230a59b0ed51c2ba10cf92;hp=3e6bd4c993dbb6fd6a8b5ad98ab2ba37305f1973;hpb=ec1df83c875bb783ca660a1fec700983fe1d9266;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/extensible.h b/include/extensible.h index 3e6bd4c99..bcc4992bb 100644 --- a/include/extensible.h +++ b/include/extensible.h @@ -1,5 +1,26 @@ -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 . + */ + + +#ifndef EXTENSIBLE_H +#define EXTENSIBLE_H + +#include enum SerializeFormat { @@ -15,11 +36,9 @@ 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); virtual ~ExtensionItem(); /** Serialize this item into a string @@ -28,7 +47,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 @@ -40,16 +59,13 @@ class CoreExport ExtensionItem 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 */ -CoreExport 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,34 +75,35 @@ CoreExport typedef std::map ExtensibleStore; */ class CoreExport Extensible : public classbase { + public: + typedef std::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; 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); - - // Friend access for the protected getter/setter - friend class ExtensionItem; +class CoreExport ExtensionManager +{ + std::map > types; + public: + bool Register(ExtensionItem* item); + void BeginUnregister(Module* module, std::vector >& list); + ExtensionItem* GetItem(const std::string& name); }; /** Base class for items that are NOT synchronized between servers */ @@ -95,7 +112,7 @@ class CoreExport LocalExtItem : public ExtensionItem public: LocalExtItem(const std::string& key, 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; }; @@ -112,22 +129,11 @@ class 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); @@ -158,7 +164,7 @@ class CoreExport LocalStringExt : public SimpleExtItem public: LocalStringExt(const std::string& key, 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; }; class CoreExport LocalIntExt : public LocalExtItem @@ -166,8 +172,8 @@ class CoreExport LocalIntExt : public LocalExtItem public: LocalIntExt(const std::string& key, 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; + intptr_t get(const Extensible* container) const; intptr_t set(Extensible* container, intptr_t value); void free(void* item); }; @@ -177,10 +183,12 @@ class CoreExport StringExtItem : public ExtensionItem public: StringExtItem(const std::string& key, 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); void free(void* item); }; + +#endif