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
|
/*
* The Mana World
* Copyright 2004 The Mana World Development Team
*
* This file is part of The Mana World.
*
* The Mana World 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
* any later version.
*
* The Mana World 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 The Mana World; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* $Id: configuration.h 4237 2008-05-14 18:57:32Z b_lindeijer $
*/
#ifndef _TMW_CONFIGURATION_H
#define _TMW_CONFIGURATION_H
#include <map>
#include <list>
#include <string>
#include <cassert>
#include <libxml/xmlwriter.h>
class ConfigListener;
class ConfigurationObject;
/**
* Configuration list manager interface; responsible for serlialising/deserialising
* configuration choices in containers.
*
* \param T Type of the container elements to serialise
* \param CONT Type of the container we (de)serialise
*/
template <class T, class CONT>
class ConfigurationListManager
{
public:
/**
* Writes a value into a configuration object
*
* \param value The value to write out
* \param obj The configuation object to write to
* \return obj, or otherwise NULL to indicate that this option should be skipped
*/
virtual ConfigurationObject *writeConfigItem(T value, ConfigurationObject *obj) = 0;
/**
* Reads a value from a configuration object
*
* \param obj The configuration object to read from
* \param container The container to insert the object to
*/
virtual CONT readConfigItem(ConfigurationObject *obj, CONT container) = 0;
};
/**
* Configuration object, mapping values to names and possibly containing
* lists of further configuration objects
*
* \ingroup CORE
*/
class ConfigurationObject
{
friend class Configuration;
public:
virtual ~ConfigurationObject(void);
/**
* Sets an option using a string value.
*
* \param key Option identifier.
* \param value Value.
*/
virtual void setValue(const std::string &key, std::string value);
/**
* Sets an option using a numeric value.
*
* \param key Option identifier.
* \param value Value.
*/
virtual void setValue(const std::string &key, float value);
/**
* Gets a value as string.
*
* \param key Option identifier.
* \param deflt Default option if not there or error.
*/
std::string getValue(const std::string &key, std::string deflt);
/**
* Gets a value as numeric (float).
*
* \param key Option identifier.
* \param deflt Default option if not there or error.
*/
float getValue(const std::string &key, float deflt);
/**
* Re-sets all data in the configuration
*/
virtual void clear(void);
/**
* Serialises a container into a list of configuration options
*
* \param IT Iterator type over CONT
* \param T Elements that IT iterates over
* \param CONT The associated container type
*
* \param name Name of the list the elements should be stored under
* \param begin Iterator start
* \param end Iterator end
* \param manager An object capable of serialising T items
*/
template <class IT, class T, class CONT>
void setList(const std::string &name, IT begin, IT end, ConfigurationListManager<T, CONT> *manager)
{
ConfigurationObject *nextobj = new ConfigurationObject();
deleteList(name);
ConfigurationList *list = &(mContainerOptions[name]);
for (IT it = begin; it != end; it++) {
ConfigurationObject *wrobj = manager->writeConfigItem(*it, nextobj);
if (wrobj) { // wrote something
assert (wrobj == nextobj);
nextobj = new ConfigurationObject();
list->push_back(wrobj);
} else
nextobj->clear(); // you never know...
}
delete nextobj;
}
/**
* Serialises a container into a list of configuration options
*
* \param IT Iterator type over CONT
* \param T Elements that IT iterates over
* \param CONT The associated container type
*
* \param name Name of the list the elements should be read from under
* \param empty Initial (empty) container to write to
* \param manager An object capable of deserialising items into CONT
*/
template<class T, class CONT>
CONT getList(const std::string &name, CONT empty, ConfigurationListManager<T, CONT> *manager)
{
ConfigurationList *list = &(mContainerOptions[name]);
CONT container = empty;
for (ConfigurationList::const_iterator it = list->begin(); it != list->end(); it++)
container = manager->readConfigItem(*it, container);
return container;
}
protected:
virtual void initFromXML(xmlNodePtr node);
virtual void writeToXML(xmlTextWriterPtr writer);
void deleteList(const std::string &name);
typedef std::map<std::string, std::string> Options;
typedef Options::iterator OptionIterator;
Options mOptions;
typedef std::list<ConfigurationObject *> ConfigurationList;
std::map<std::string, ConfigurationList> mContainerOptions;
};
/**
* Configuration handler for reading (and writing).
*
* \ingroup CORE
*/
class Configuration : public ConfigurationObject
{
public:
virtual ~Configuration(void) {}
/**
* Reads config file and parse all options into memory.
*
* \param filename path to config file
*/
void init(const std::string &filename);
/**
* Writes the current settings back to the config file.
*/
void write();
/**
* Adds a listener to the listen list of the specified config option.
*/
void addListener(const std::string &key, ConfigListener *listener);
/**
* Removes a listener from the listen list of the specified config
* option.
*/
void removeListener(const std::string &key, ConfigListener *listener);
virtual void setValue(const std::string &key, std::string value);
virtual void setValue(const std::string &key, float value);
private:
typedef std::list<ConfigListener*> Listeners;
typedef Listeners::iterator ListenerIterator;
typedef std::map<std::string, Listeners> ListenerMap;
typedef ListenerMap::iterator ListenerMapIterator;
ListenerMap mListenerMap;
std::string mConfigPath; /**< Location of config file */
};
extern Configuration config;
#endif
|
