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
|
/*
Defines the base classes used by InspIRCd
*/
#ifndef __BASE_H__
#define __BASE_H__
#include "inspircd_config.h"
#include <time.h>
#include <map>
#include <string>
typedef void* VoidPointer;
/** The base class for all inspircd classes
*/
class classbase
{
public:
/** Time that the object was instantiated (used for TS calculation etc)
*/
time_t age;
/** Constructor,
* Sets the object's time
*/
classbase() { age = time(NULL); }
~classbase() { }
};
/** class Extensible is the parent class of many classes such as userrec and chanrec.
* 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
* objects, channel objects and server objects, without breaking other modules (this is more sensible than using
* a flags variable, and each module defining bits within the flag as 'theirs' as it is less prone to conflict and
* supports arbitary data storage).
*/
class Extensible : public classbase
{
/** Private data store
*/
std::map<std::string,VoidPointer> Extension_Items;
public:
/** Extend an Extensible class.
* You must provide a key to store the data as, and a void* to the data (typedef VoidPointer)
* The data will be inserted into the map. If the data already exists, you may not insert it
* twice, Extensible::Extend will return false in this case.
* On successful extension, Extend returns true.
*/
bool Extend(std::string key, VoidPointer p);
/** Shrink an Extensible class.
* You must provide a key name. The given key name will be removed from the classes data. If
* you provide a nonexistent key (case is important) then the function will return false.
* Returns true on success.
*/
bool Shrink(std::string key);
/** Get an extension item.
* You must provide a key name, which is case sensitive. If you provide a non-existent key name,
* the function returns NULL, otherwise a pointer to the item referenced by the key is returned.
*/
VoidPointer GetExt(std::string key);
};
#endif
|
