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
|
/* ScummVM - Scumm Interpreter
* Copyright (C) 2005-2006 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* $URL$
* $Id$
*
*/
#ifndef COMMON_CONFIG_FILE_H
#define COMMON_CONFIG_FILE_H
#include "common/config-manager.h"
#include "common/list.h"
#include "common/str.h"
#include "common/stream.h"
namespace Common {
/**
* This class allows reading/writing INI style config files.
* It is used by the ConfigManager for storage, but can also
* be used by other code if it needs to read/write custom INI
* files.
*
* Lines starting with a '#' are ignored (i.e. treated as comments).
* Some effort is made to preserve comments, though.
*
* This class makes no attempts to provide fast access to key/value pairs.
* In particular, it stores all sections and k/v pairs in lists, not
* in dictionaries/maps. This makes it very easy to read/write the data
* from/to files, but of course is not appropriate for fast access.
* The main reason is that this class is indeed geared toward doing precisely
* that!
* If you need fast access to the game config, use higher level APIs, like the
* one provided by ConfigManager.
*/
class ConfigFile {
public:
typedef HashMap<String, bool, IgnoreCase_Hash, IgnoreCase_EqualTo> StringSet;
struct KeyValue {
String key;
String value;
String comment;
};
typedef List<KeyValue> SectionKeyList;
/** A section in a config file. I.e. corresponds to something like this:
* [mySection]
* key=value
*
* Comments are also stored, to keep users happy who like editing their
* config files manually.
*/
struct Section {
String name;
List<KeyValue> keys;
String comment;
bool hasKey(const String &key) const;
const KeyValue* getKey(const String &key) const;
void setKey(const String &key, const String &value);
void removeKey(const String &key);
const SectionKeyList getKeys() const { return keys; }
};
typedef List<Section> SectionList;
public:
ConfigFile();
~ConfigFile();
// TODO: Maybe add a copy constructor etc.?
/**
* Check whether the given string is a valid section or key name.
* For that, it must only consist of letters, numbers, dashes and
* underscores. In particular, white space and "#", "=", "[", "]"
* are not valid!
*/
static bool isValidName(const Common::String &name);
/** Reset everything stored in this config file. */
void clear();
bool loadFromFile(const String &filename);
bool loadFromStream(SeekableReadStream &stream);
bool saveToFile(const String &filename);
bool saveToStream(WriteStream &stream);
bool hasSection(const String §ion) const;
void removeSection(const String §ion);
void renameSection(const String &oldName, const String &newName);
bool hasKey(const String &key, const String §ion) const;
bool getKey(const String &key, const String §ion, String &value) const;
void setKey(const String &key, const String §ion, const String &value);
void removeKey(const String &key, const String §ion);
const SectionList getSections() const { return _sections; }
const SectionKeyList getKeys(const String §ion) const;
void listSections(StringSet &set);
void listKeyValues(StringMap &kv);
private:
SectionList _sections;
Section *getSection(const String §ion);
const Section *getSection(const String §ion) const;
};
/*
- ConfigMan owns a config file
- allow direct access to that config file (for the launcher)
- simplify and unify the regular ConfigMan API in exchange
*/
} // End of namespace Common
#endif
|
