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
|
/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* This program 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; either version 2
* of the License, or (at your option) any later version.
*
* 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, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
*/
#ifndef COMMON_CONFIG_MANAGER_H
#define COMMON_CONFIG_MANAGER_H
#include "common/array.h"
#include "common/hashmap.h"
#include "common/singleton.h"
#include "common/str.h"
#include "common/hash-str.h"
namespace Common {
class WriteStream;
class SeekableReadStream;
/**
* The (singleton) configuration manager, used to query & set configuration
* values using string keys.
*
* @todo Implement the callback based notification system (outlined below)
* which sends out notifications to interested parties whenever the value
* of some specific (or any) configuration key changes.
*/
class ConfigManager : public Singleton<ConfigManager> {
public:
class Domain {
private:
StringMap _entries;
StringMap _keyValueComments;
String _domainComment;
public:
typedef StringMap::const_iterator const_iterator;
const_iterator begin() const { return _entries.begin(); }
const_iterator end() const { return _entries.end(); }
bool empty() const { return _entries.empty(); }
bool contains(const String &key) const { return _entries.contains(key); }
String &operator[](const String &key) { return _entries[key]; }
const String &operator[](const String &key) const { return _entries[key]; }
void setVal(const String &key, const String &value) { _entries.setVal(key, value); }
String &getVal(const String &key) { return _entries.getVal(key); }
const String &getVal(const String &key) const { return _entries.getVal(key); }
void clear() { _entries.clear(); }
void erase(const String &key) { _entries.erase(key); }
void setDomainComment(const String &comment);
const String &getDomainComment() const;
void setKVComment(const String &key, const String &comment);
const String &getKVComment(const String &key) const;
bool hasKVComment(const String &key) const;
};
typedef HashMap<String, Domain, IgnoreCase_Hash, IgnoreCase_EqualTo> DomainMap;
/** The name of the application domain (normally 'scummvm'). */
static char const *const kApplicationDomain;
/** The transient (pseudo) domain. */
static char const *const kTransientDomain;
#ifdef ENABLE_KEYMAPPER
/** The name of keymapper domain used to store the key maps */
static char const *const kKeymapperDomain;
#endif
#ifdef USE_CLOUD
/** The name of cloud domain used to store user's tokens */
static char const *const kCloudDomain;
#endif
void loadDefaultConfigFile();
void loadConfigFile(const String &filename);
/**
* Retrieve the config domain with the given name.
* @param domName the name of the domain to retrieve
* @return pointer to the domain, or 0 if the domain doesn't exist.
*/
Domain * getDomain(const String &domName);
const Domain * getDomain(const String &domName) const;
//
// Generic access methods: No domain specified, use the values from the
// various domains in the order of their priority.
//
bool hasKey(const String &key) const;
const String & get(const String &key) const;
void set(const String &key, const String &value);
#if 1
//
// Domain specific access methods: Acces *one specific* domain and modify it.
// TODO: I'd like to get rid of most of those if possible, or at least reduce
// their usage, by using getDomain as often as possible. For example in the
// options dialog code...
//
bool hasKey(const String &key, const String &domName) const;
const String & get(const String &key, const String &domName) const;
void set(const String &key, const String &value, const String &domName);
void removeKey(const String &key, const String &domName);
#endif
//
// Some additional convenience accessors.
//
int getInt(const String &key, const String &domName = String()) const;
bool getBool(const String &key, const String &domName = String()) const;
void setInt(const String &key, int value, const String &domName = String());
void setBool(const String &key, bool value, const String &domName = String());
void registerDefault(const String &key, const String &value);
void registerDefault(const String &key, const char *value);
void registerDefault(const String &key, int value);
void registerDefault(const String &key, bool value);
void flushToDisk();
void setActiveDomain(const String &domName);
Domain * getActiveDomain() { return _activeDomain; }
const Domain * getActiveDomain() const { return _activeDomain; }
const String & getActiveDomainName() const { return _activeDomainName; }
void addGameDomain(const String &domName);
void removeGameDomain(const String &domName);
void renameGameDomain(const String &oldName, const String &newName);
void addMiscDomain(const String &domName);
void removeMiscDomain(const String &domName);
void renameMiscDomain(const String &oldName, const String &newName);
bool hasGameDomain(const String &domName) const;
bool hasMiscDomain(const String &domName) const;
const DomainMap & getGameDomains() const { return _gameDomains; }
DomainMap::iterator beginGameDomains() { return _gameDomains.begin(); }
DomainMap::iterator endGameDomains() { return _gameDomains.end(); }
static void defragment(); // move in memory to reduce fragmentation
void copyFrom(ConfigManager &source);
private:
friend class Singleton<SingletonBaseType>;
ConfigManager();
void loadFromStream(SeekableReadStream &stream);
void addDomain(const String &domainName, const Domain &domain);
void writeDomain(WriteStream &stream, const String &name, const Domain &domain);
void renameDomain(const String &oldName, const String &newName, DomainMap &map);
Domain _transientDomain;
DomainMap _gameDomains;
DomainMap _miscDomains; // Any other domains
Domain _appDomain;
Domain _defaultsDomain;
#ifdef ENABLE_KEYMAPPER
Domain _keymapperDomain;
#endif
#ifdef USE_CLOUD
Domain _cloudDomain;
#endif
Array<String> _domainSaveOrder;
String _activeDomainName;
Domain * _activeDomain;
String _filename;
};
} // End of namespace Common
/** Shortcut for accessing the configuration manager. */
#define ConfMan Common::ConfigManager::instance()
#endif
|
