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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
|
/* This file is part of the KDE project
* Copyright (c) 2004 Cyrille Berger <cberger@cberger.net>
* Copyright (c) 2006 Boudewijn Rempt <boud@valdyas.org>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library 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
* Library General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library; see the file COPYING.LIB. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#ifndef _KO_GENERIC_REGISTRY_H_
#define _KO_GENERIC_REGISTRY_H_
#include <kdemacros.h>
#include <kdebug.h>
#include <QList>
#include <QString>
#include <QHash>
/**
* Base class for registry objects.
*
* Registered objects are owned by the registry.
*
* Items are mapped by QString as a unique Id.
*
* Exemple of use:
* @code
* class KoMyClassRegistry : public KoGenericRegistry<MyClass*> {
* public:
* static KoMyClassRegistry * instance();
* private:
* static KoMyClassRegistry* s_instance;
* };
*
* KoMyClassRegistry *KoMyClassRegistry::s_instance = 0;
* KoMyClassRegistry * KoMyClassRegistry::instance()
* {
* if(s_instance == 0)
* {
* s_instance = new KoMyClassRegistry;
* }
* return s_instance;
* }
*
* @endcode
*/
template<typename T>
class KoGenericRegistry
{
public:
KoGenericRegistry() { }
virtual ~KoGenericRegistry() { m_hash.clear(); }
public:
/**
* Add an object to the registry. If it is a QObject, make sure it isn't in the
* QObject ownership hierarchy, since the registry itself is responsbile for
* deleting it.
*
* @param item the item to add (NOTE: T must have an QString id() const function)
*/
void add(T item) {
Q_ASSERT( item );
QString id = item->id();
if(m_hash.contains(id)) {
m_doubleEntries << value(id);
remove(id);
}
m_hash.insert(id, item);
}
/**
* add an object to the registry
* @param id the id of the object
* @param item the item to add
*/
void add(const QString &id, T item) {
Q_ASSERT( item );
if(m_hash.contains(id)) {
m_doubleEntries << value(id);
remove(id);
}
m_hash.insert(id, item);
}
/**
* This function removes an item from the registry
*/
void remove(const QString &id) {
m_hash.remove(id);
}
/**
* Retrieve the object from the registry based on the unique
* identifier string.
*
* @param id the id
*/
T get(const QString& id) const {
return value(id);
}
/**
* @return if there is an object stored in the registry identified
* by the id.
* @param id the unique identifier string
*/
bool contains(const QString &id) const {
return m_hash.contains(id);
}
/**
* Retrieve the object from the registry based on the unique identifier string
* @param id the id
*/
const T value(const QString &id) const {
return m_hash.value(id);
}
/**
* @return a list of all keys
*/
QList<QString> keys() const {
return m_hash.keys();
}
int count() const {
return m_hash.count();
}
QList<T> values() const {
return m_hash.values();
}
QList<T> doubleEntries() const {
return m_doubleEntries;
}
private:
QList<T> m_doubleEntries;
private:
QHash<QString, T> m_hash;
};
#endif
|
