1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
|
/*
* InspIRCd -- Internet Relay Chat Daemon
*
* Copyright (C) 2013, 2019, 2021-2022 Sadie Powell <sadie@sadiepowell.dev>
* Copyright (C) 2012, 2014-2015 Attila Molnar <attilamolnar@hush.com>
* Copyright (C) 2012 Robby <robby@chatbelgie.be>
* 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
class ExtensionItem;
/** Types of extensible that an extension can extend. */
enum class ExtensionType
: uint8_t
{
/** The extension extends the User class. */
USER = 0,
/** The extension extends the Channel class. */
CHANNEL = 1,
/** The extension extends the Membership class. */
MEMBERSHIP = 2,
};
/** Base class for types which can be extended with additional data. */
class CoreExport Extensible
: public Cullable
{
public:
/** The container which extension values are stored in. */
typedef insp::flat_map<ExtensionItem*, void*> ExtensibleStore;
/** Allows extensions to access the extension store. */
friend class ExtensionItem;
/** The type of extensible that this is. */
const ExtensionType extype:2;
~Extensible() override;
/** @copydoc Cullable::Cull */
Cullable::Result Cull() override;
/** Frees all extensions attached to this extensible. */
void FreeAllExtItems();
/** Retrieves the values for extensions which are set on this extensible. */
const ExtensibleStore& GetExtList() const { return extensions; }
/** Unhooks the specifies extensions from this extensible.
* @param items The items to unhook.
*/
void UnhookExtensions(const std::vector<ExtensionItem*>& items);
protected:
Extensible(ExtensionType exttype);
private:
/** The values for extensions which are set on this extensible. */
ExtensibleStore extensions;
/** Whether this extensible has been culled yet. */
bool culled:1;
};
/** Manager for the extension system */
class CoreExport ExtensionManager final
{
public:
/** The container which registered extensions are stored in. */
typedef std::map<std::string, ExtensionItem*, irc::insensitive_swo> ExtMap;
/** Begins unregistering extensions belonging to the specified module.
* @param module The module to unregister extensions for.
* @param list The list to add unregistered extensions to.
*/
void BeginUnregister(Module* module, std::vector<ExtensionItem*>& list);
/** Retrieves registered extensions keyed by their names. */
const ExtMap& GetExts() const { return types; }
/** Retrieves an extension by name.
* @param name The name of the extension to retrieve.
* @return Either the value of this extension or nullptr if it does not exist.
*/
ExtensionItem* GetItem(const std::string& name);
/** Registers an extension with the manager.
* @return Either true if the extension was registered or false if an extension with the same
* name already exists.
*/
bool Register(ExtensionItem* item);
private:
/** Registered extensions keyed by their names. */
ExtMap types;
};
|
