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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
|
/*
This file is part of the KDE libraries
Copyright (c) 2006, 2007 Thomas Braxton <kde.braxton@gmail.com>
Copyright (c) 1999-2000 Preston Brown <pbrown@kde.org>
Copyright (C) 1996-2000 Matthias Kalle Dalheimer <kalle@kde.org>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library 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 Library 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 KCONFIGDATA_H
#define KCONFIGDATA_H
#include <QtCore/QByteArray>
#include <QtCore/QString>
#include <QtCore/QMap>
#include <QtCore/QDebug>
/**
* map/dict/list config node entry.
* @internal
*/
struct KEntry {
/** Constructor. @internal */
KEntry()
: mValue(), bDirty(false),
bGlobal(false), bImmutable(false), bDeleted(false), bExpand(false), bReverted(false),
bLocalizedCountry(false) {}
/** @internal */
QByteArray mValue;
/**
* Must the entry be written back to disk?
*/
bool bDirty : 1;
/**
* Entry should be written to the global config file
*/
bool bGlobal: 1;
/**
* Entry can not be modified.
*/
bool bImmutable: 1;
/**
* Entry has been deleted.
*/
bool bDeleted: 1;
/**
* Whether to apply dollar expansion or not.
*/
bool bExpand: 1;
/**
* Entry has been reverted to its default value (from a more global file).
*/
bool bReverted: 1;
/**
* Entry is for a localized key. If @c false the value references just language e.g. "de",
* if @c true the value references language and country, e.g. "de_DE".
**/
bool bLocalizedCountry: 1;
};
// These operators are used to check whether an entry which is about
// to be written equals the previous value. As such, this intentionally
// omits the dirty flag from the comparison.
inline bool operator ==(const KEntry &k1, const KEntry &k2)
{
return k1.bGlobal == k2.bGlobal && k1.bImmutable == k2.bImmutable
&& k1.bDeleted == k2.bDeleted && k1.bExpand == k2.bExpand
&& k1.mValue == k2.mValue;
}
inline bool operator !=(const KEntry &k1, const KEntry &k2)
{
return !(k1 == k2);
}
/**
* key structure holding both the actual key and the group
* to which it belongs.
* @internal
*/
struct KEntryKey {
/** Constructor. @internal */
KEntryKey(const QByteArray &_group = QByteArray(),
const QByteArray &_key = QByteArray(), bool isLocalized = false, bool isDefault = false)
: mGroup(_group), mKey(_key), bLocal(isLocalized), bDefault(isDefault), bRaw(false)
{
;
}
/**
* The "group" to which this EntryKey belongs
*/
QByteArray mGroup;
/**
* The _actual_ key of the entry in question
*/
QByteArray mKey;
/**
* Entry is localised or not
*/
bool bLocal : 1;
/**
* Entry indicates if this is a default value.
*/
bool bDefault: 1;
/** @internal
* Key is a raw unprocessed key.
* @warning this should only be set during merging, never for normal use.
*/
bool bRaw: 1;
};
/**
* Compares two KEntryKeys (needed for QMap). The order is localized, localized-default,
* non-localized, non-localized-default
* @internal
*/
inline bool operator <(const KEntryKey &k1, const KEntryKey &k2)
{
int result = qstrcmp(k1.mGroup, k2.mGroup);
if (result != 0) {
return result < 0;
}
result = qstrcmp(k1.mKey, k2.mKey);
if (result != 0) {
return result < 0;
}
if (k1.bLocal != k2.bLocal) {
return k1.bLocal;
}
return (!k1.bDefault && k2.bDefault);
}
QDebug operator<<(QDebug dbg, const KEntryKey &key);
QDebug operator<<(QDebug dbg, const KEntry &entry);
/**
* \relates KEntry
* type specifying a map of entries (key,value pairs).
* The keys are actually a key in a particular config file group together
* with the group name.
* @internal
*/
class KEntryMap : public QMap<KEntryKey, KEntry>
{
public:
enum SearchFlag {
SearchDefaults = 1,
SearchLocalized = 2
};
Q_DECLARE_FLAGS(SearchFlags, SearchFlag)
enum EntryOption {
EntryDirty = 1,
EntryGlobal = 2,
EntryImmutable = 4,
EntryDeleted = 8,
EntryExpansion = 16,
EntryRawKey = 32,
EntryLocalizedCountry = 64,
EntryDefault = (SearchDefaults << 16),
EntryLocalized = (SearchLocalized << 16)
};
Q_DECLARE_FLAGS(EntryOptions, EntryOption)
Iterator findExactEntry(const QByteArray &group, const QByteArray &key = QByteArray(),
SearchFlags flags = SearchFlags());
Iterator findEntry(const QByteArray &group, const QByteArray &key = QByteArray(),
SearchFlags flags = SearchFlags());
ConstIterator findEntry(const QByteArray &group, const QByteArray &key = QByteArray(),
SearchFlags flags = SearchFlags()) const;
/**
* Returns true if the entry gets dirtied or false in other case
*/
bool setEntry(const QByteArray &group, const QByteArray &key,
const QByteArray &value, EntryOptions options);
void setEntry(const QByteArray &group, const QByteArray &key,
const QString &value, EntryOptions options)
{
setEntry(group, key, value.toUtf8(), options);
}
QString getEntry(const QByteArray &group, const QByteArray &key,
const QString &defaultValue = QString(),
SearchFlags flags = SearchFlags(),
bool *expand = Q_NULLPTR) const;
bool hasEntry(const QByteArray &group, const QByteArray &key = QByteArray(),
SearchFlags flags = SearchFlags()) const;
bool getEntryOption(const ConstIterator &it, EntryOption option) const;
bool getEntryOption(const QByteArray &group, const QByteArray &key,
SearchFlags flags, EntryOption option) const
{
return getEntryOption(findEntry(group, key, flags), option);
}
void setEntryOption(Iterator it, EntryOption option, bool bf);
void setEntryOption(const QByteArray &group, const QByteArray &key, SearchFlags flags,
EntryOption option, bool bf)
{
setEntryOption(findEntry(group, key, flags), option, bf);
}
bool revertEntry(const QByteArray &group, const QByteArray &key, SearchFlags flags = SearchFlags());
};
Q_DECLARE_OPERATORS_FOR_FLAGS(KEntryMap::SearchFlags)
Q_DECLARE_OPERATORS_FOR_FLAGS(KEntryMap::EntryOptions)
/**
* \relates KEntry
* type for iterating over keys in a KEntryMap in sorted order.
* @internal
*/
typedef QMap<KEntryKey, KEntry>::Iterator KEntryMapIterator;
/**
* \relates KEntry
* type for iterating over keys in a KEntryMap in sorted order.
* It is const, thus you cannot change the entries in the iterator,
* only examine them.
* @internal
*/
typedef QMap<KEntryKey, KEntry>::ConstIterator KEntryMapConstIterator;
#endif
|
