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
|
/* ScummVM - Scumm Interpreter
* Copyright (C) 2001 Ludvig Strigeus
* Copyright (C) 2001-2004 The ScummVM project
*
* 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*
* $Header$
*
*/
#ifndef COMMON_CONFIG_H
#define COMMON_CONFIG_H
#include "common/array.h"
#include "common/map.h"
#include "common/singleton.h"
#include "common/str.h"
#include "common/util.h"
namespace Common {
/**
* The (singleton) configuration manager, used to query & set configuration
* values using string keys.
*
* @todo Implement the callback based notification system (outline below)
* which sends out notifications to interested parties whenever the value
* of some specific (or any) configuration key changes.
* @todo Preserve the order of the entries in the config file. Maybe even add
* an API to query/modify that order, which could be used by the launcher
* to allow arranging the game targets.
*/
class ConfigManager : public Singleton<ConfigManager> {
struct IgnoreCaseComparator {
int operator()(const String& x, const String& y) const { return scumm_stricmp(x.c_str(), y.c_str()); }
};
public:
typedef Map<String, String, IgnoreCaseComparator> StringMap;
class Domain : public StringMap {
private:
StringMap _keyValueComments;
String _domainComment;
public:
const String &get(const String &key) const;
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 Map<String, Domain, IgnoreCaseComparator> DomainMap;
/** The name of the application domain (normally 'scummvm'). */
static const String kApplicationDomain;
/** The transient (pseudo) domain. */
static const String kTransientDomain;
void loadDefaultConfigFile();
void loadConfigFile(const String &filename);
bool hasKey(const String &key) const;
bool hasKey(const String &key, const String &dom) const;
void removeKey(const String &key, const String &dom);
const String & get(const String &key, const String &dom = String::emptyString) const;
int getInt(const String &key, const String &dom = String::emptyString) const;
bool getBool(const String &key, const String &dom = String::emptyString) const;
void set(const String &key, const String &value, const String &dom = String::emptyString);
void set(const String &key, const char *value, const String &dom = String::emptyString);
void set(const String &key, int value, const String &dom = String::emptyString);
void set(const String &key, bool value, const String &dom = String::emptyString);
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 &domain);
const String & getActiveDomain() const { return _activeDomain; }
// void addDomain(const String &name);
void removeGameDomain(const String &name);
void renameGameDomain(const String &oldName, const String &newName);
bool hasGameDomain(const String &domain) const;
const DomainMap & getGameDomains() const { return _gameDomains; }
/*
TODO: Callback/change notification system
typedef void (*ConfigCallback)(const ConstString &key, void *refCon);
void registerCallback(ConfigCallback cfgc, void *refCon, const ConstString &key = String::emptyString)
void unregisterCallback(ConfigCallback cfgc, const ConstString &key = String::emptyString)
*/
private:
friend class Singleton<ConfigManager>;
ConfigManager();
void loadFile(const String &filename);
void writeDomain(FILE *file, const String &name, const Domain &domain);
Domain _transientDomain;
DomainMap _gameDomains;
DomainMap _globalDomains;
Domain _defaultsDomain;
StringList _domainSaveOrder;
String _activeDomain;
String _filename;
};
} // End of namespace Common
/** Shortcut for accessing the configuration manager. */
#define ConfMan Common::ConfigManager::instance()
#endif
|
