inifile.cc (9550:e0e2c8f83d08) inifile.cc (10385:3f943443ae30)
1/*
2 * Copyright (c) 2001-2005 The Regents of The University of Michigan
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met: redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer;
9 * redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution;
12 * neither the name of the copyright holders nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 *
28 * Authors: Nathan Binkert
29 * Steve Reinhardt
30 */
31
32#include <algorithm>
33#include <fstream>
34#include <iostream>
35#include <string>
36#include <vector>
37
38#include "base/inifile.hh"
39#include "base/str.hh"
40
41using namespace std;
42
43IniFile::IniFile()
44{}
45
46IniFile::~IniFile()
47{
48 SectionTable::iterator i = table.begin();
49 SectionTable::iterator end = table.end();
50
51 while (i != end) {
52 delete (*i).second;
53 ++i;
54 }
55}
56
57bool
58IniFile::load(const string &file)
59{
60 ifstream f(file.c_str());
61
62 if (!f.is_open())
63 return false;
64
65 return load(f);
66}
67
68
69const string &
70IniFile::Entry::getValue() const
71{
72 referenced = true;
73 return value;
74}
75
76
77void
78IniFile::Section::addEntry(const std::string &entryName,
79 const std::string &value,
80 bool append)
81{
82 EntryTable::iterator ei = table.find(entryName);
83
84 if (ei == table.end()) {
85 // new entry
86 table[entryName] = new Entry(value);
87 }
88 else if (append) {
89 // append new reult to old entry
90 ei->second->appendValue(value);
91 }
92 else {
93 // override old entry
94 ei->second->setValue(value);
95 }
96}
97
98
99bool
100IniFile::Section::add(const std::string &assignment)
101{
102 string::size_type offset = assignment.find('=');
103 if (offset == string::npos) {
104 // no '=' found
105 cerr << "Can't parse .ini line " << assignment << endl;
106 return false;
107 }
108
109 // if "+=" rather than just "=" then append value
110 bool append = (assignment[offset-1] == '+');
111
112 string entryName = assignment.substr(0, append ? offset-1 : offset);
113 string value = assignment.substr(offset + 1);
114
115 eat_white(entryName);
116 eat_white(value);
117
118 addEntry(entryName, value, append);
119 return true;
120}
121
122
123IniFile::Entry *
124IniFile::Section::findEntry(const std::string &entryName) const
125{
126 referenced = true;
127
128 EntryTable::const_iterator ei = table.find(entryName);
129
130 return (ei == table.end()) ? NULL : ei->second;
131}
132
133
134IniFile::Section *
135IniFile::addSection(const string &sectionName)
136{
137 SectionTable::iterator i = table.find(sectionName);
138
139 if (i != table.end()) {
140 return i->second;
141 }
142 else {
143 // new entry
144 Section *sec = new Section();
145 table[sectionName] = sec;
146 return sec;
147 }
148}
149
150
151IniFile::Section *
152IniFile::findSection(const string &sectionName) const
153{
154 SectionTable::const_iterator i = table.find(sectionName);
155
156 return (i == table.end()) ? NULL : i->second;
157}
158
159
160// Take string of the form "<section>:<parameter>=<value>" and add to
161// database. Return true if successful, false if parse error.
162bool
163IniFile::add(const string &str)
164{
165 // find ':'
166 string::size_type offset = str.find(':');
167 if (offset == string::npos) // no ':' found
168 return false;
169
170 string sectionName = str.substr(0, offset);
171 string rest = str.substr(offset + 1);
172
173 eat_white(sectionName);
174 Section *s = addSection(sectionName);
175
176 return s->add(rest);
177}
178
179bool
180IniFile::load(istream &f)
181{
182 Section *section = NULL;
183
184 while (!f.eof()) {
185 f >> ws; // Eat whitespace
186 if (f.eof()) {
187 break;
188 }
189
190 string line;
191 getline(f, line);
192 if (line.size() == 0)
193 continue;
194
195 eat_end_white(line);
196 int last = line.size() - 1;
197
198 if (line[0] == '[' && line[last] == ']') {
199 string sectionName = line.substr(1, last - 1);
200 eat_white(sectionName);
201 section = addSection(sectionName);
202 continue;
203 }
204
205 if (section == NULL)
206 continue;
207
208 if (!section->add(line))
209 return false;
210 }
211
212 return true;
213}
214
215bool
216IniFile::find(const string &sectionName, const string &entryName,
217 string &value) const
218{
219 Section *section = findSection(sectionName);
220 if (section == NULL)
221 return false;
222
223 Entry *entry = section->findEntry(entryName);
224 if (entry == NULL)
225 return false;
226
227 value = entry->getValue();
228
229 return true;
230}
231
232bool
233IniFile::sectionExists(const string &sectionName) const
234{
235 return findSection(sectionName) != NULL;
236}
237
238
239bool
240IniFile::Section::printUnreferenced(const string &sectionName)
241{
242 bool unref = false;
243 bool search_unref_entries = false;
244 vector<string> unref_ok_entries;
245
246 Entry *entry = findEntry("unref_entries_ok");
247 if (entry != NULL) {
248 tokenize(unref_ok_entries, entry->getValue(), ' ');
249 if (unref_ok_entries.size()) {
250 search_unref_entries = true;
251 }
252 }
253
254 for (EntryTable::iterator ei = table.begin();
255 ei != table.end(); ++ei) {
256 const string &entryName = ei->first;
257 entry = ei->second;
258
259 if (entryName == "unref_section_ok" ||
260 entryName == "unref_entries_ok")
261 {
262 continue;
263 }
264
265 if (!entry->isReferenced()) {
266 if (search_unref_entries &&
267 (std::find(unref_ok_entries.begin(), unref_ok_entries.end(),
268 entryName) != unref_ok_entries.end()))
269 {
270 continue;
271 }
272
273 cerr << "Parameter " << sectionName << ":" << entryName
274 << " not referenced." << endl;
275 unref = true;
276 }
277 }
278
279 return unref;
280}
281
282
1/*
2 * Copyright (c) 2001-2005 The Regents of The University of Michigan
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met: redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer;
9 * redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution;
12 * neither the name of the copyright holders nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 *
28 * Authors: Nathan Binkert
29 * Steve Reinhardt
30 */
31
32#include <algorithm>
33#include <fstream>
34#include <iostream>
35#include <string>
36#include <vector>
37
38#include "base/inifile.hh"
39#include "base/str.hh"
40
41using namespace std;
42
43IniFile::IniFile()
44{}
45
46IniFile::~IniFile()
47{
48 SectionTable::iterator i = table.begin();
49 SectionTable::iterator end = table.end();
50
51 while (i != end) {
52 delete (*i).second;
53 ++i;
54 }
55}
56
57bool
58IniFile::load(const string &file)
59{
60 ifstream f(file.c_str());
61
62 if (!f.is_open())
63 return false;
64
65 return load(f);
66}
67
68
69const string &
70IniFile::Entry::getValue() const
71{
72 referenced = true;
73 return value;
74}
75
76
77void
78IniFile::Section::addEntry(const std::string &entryName,
79 const std::string &value,
80 bool append)
81{
82 EntryTable::iterator ei = table.find(entryName);
83
84 if (ei == table.end()) {
85 // new entry
86 table[entryName] = new Entry(value);
87 }
88 else if (append) {
89 // append new reult to old entry
90 ei->second->appendValue(value);
91 }
92 else {
93 // override old entry
94 ei->second->setValue(value);
95 }
96}
97
98
99bool
100IniFile::Section::add(const std::string &assignment)
101{
102 string::size_type offset = assignment.find('=');
103 if (offset == string::npos) {
104 // no '=' found
105 cerr << "Can't parse .ini line " << assignment << endl;
106 return false;
107 }
108
109 // if "+=" rather than just "=" then append value
110 bool append = (assignment[offset-1] == '+');
111
112 string entryName = assignment.substr(0, append ? offset-1 : offset);
113 string value = assignment.substr(offset + 1);
114
115 eat_white(entryName);
116 eat_white(value);
117
118 addEntry(entryName, value, append);
119 return true;
120}
121
122
123IniFile::Entry *
124IniFile::Section::findEntry(const std::string &entryName) const
125{
126 referenced = true;
127
128 EntryTable::const_iterator ei = table.find(entryName);
129
130 return (ei == table.end()) ? NULL : ei->second;
131}
132
133
134IniFile::Section *
135IniFile::addSection(const string &sectionName)
136{
137 SectionTable::iterator i = table.find(sectionName);
138
139 if (i != table.end()) {
140 return i->second;
141 }
142 else {
143 // new entry
144 Section *sec = new Section();
145 table[sectionName] = sec;
146 return sec;
147 }
148}
149
150
151IniFile::Section *
152IniFile::findSection(const string &sectionName) const
153{
154 SectionTable::const_iterator i = table.find(sectionName);
155
156 return (i == table.end()) ? NULL : i->second;
157}
158
159
160// Take string of the form "<section>:<parameter>=<value>" and add to
161// database. Return true if successful, false if parse error.
162bool
163IniFile::add(const string &str)
164{
165 // find ':'
166 string::size_type offset = str.find(':');
167 if (offset == string::npos) // no ':' found
168 return false;
169
170 string sectionName = str.substr(0, offset);
171 string rest = str.substr(offset + 1);
172
173 eat_white(sectionName);
174 Section *s = addSection(sectionName);
175
176 return s->add(rest);
177}
178
179bool
180IniFile::load(istream &f)
181{
182 Section *section = NULL;
183
184 while (!f.eof()) {
185 f >> ws; // Eat whitespace
186 if (f.eof()) {
187 break;
188 }
189
190 string line;
191 getline(f, line);
192 if (line.size() == 0)
193 continue;
194
195 eat_end_white(line);
196 int last = line.size() - 1;
197
198 if (line[0] == '[' && line[last] == ']') {
199 string sectionName = line.substr(1, last - 1);
200 eat_white(sectionName);
201 section = addSection(sectionName);
202 continue;
203 }
204
205 if (section == NULL)
206 continue;
207
208 if (!section->add(line))
209 return false;
210 }
211
212 return true;
213}
214
215bool
216IniFile::find(const string &sectionName, const string &entryName,
217 string &value) const
218{
219 Section *section = findSection(sectionName);
220 if (section == NULL)
221 return false;
222
223 Entry *entry = section->findEntry(entryName);
224 if (entry == NULL)
225 return false;
226
227 value = entry->getValue();
228
229 return true;
230}
231
232bool
233IniFile::sectionExists(const string &sectionName) const
234{
235 return findSection(sectionName) != NULL;
236}
237
238
239bool
240IniFile::Section::printUnreferenced(const string &sectionName)
241{
242 bool unref = false;
243 bool search_unref_entries = false;
244 vector<string> unref_ok_entries;
245
246 Entry *entry = findEntry("unref_entries_ok");
247 if (entry != NULL) {
248 tokenize(unref_ok_entries, entry->getValue(), ' ');
249 if (unref_ok_entries.size()) {
250 search_unref_entries = true;
251 }
252 }
253
254 for (EntryTable::iterator ei = table.begin();
255 ei != table.end(); ++ei) {
256 const string &entryName = ei->first;
257 entry = ei->second;
258
259 if (entryName == "unref_section_ok" ||
260 entryName == "unref_entries_ok")
261 {
262 continue;
263 }
264
265 if (!entry->isReferenced()) {
266 if (search_unref_entries &&
267 (std::find(unref_ok_entries.begin(), unref_ok_entries.end(),
268 entryName) != unref_ok_entries.end()))
269 {
270 continue;
271 }
272
273 cerr << "Parameter " << sectionName << ":" << entryName
274 << " not referenced." << endl;
275 unref = true;
276 }
277 }
278
279 return unref;
280}
281
282
283void
284IniFile::getSectionNames(vector<string> &list) const
285{
286 for (SectionTable::const_iterator i = table.begin();
287 i != table.end(); ++i)
288 {
289 list.push_back((*i).first);
290 }
291}
292
283bool
284IniFile::printUnreferenced()
285{
286 bool unref = false;
287
288 for (SectionTable::iterator i = table.begin();
289 i != table.end(); ++i) {
290 const string &sectionName = i->first;
291 Section *section = i->second;
292
293 if (!section->isReferenced()) {
294 if (section->findEntry("unref_section_ok") == NULL) {
295 cerr << "Section " << sectionName << " not referenced."
296 << endl;
297 unref = true;
298 }
299 }
300 else {
301 if (section->printUnreferenced(sectionName)) {
302 unref = true;
303 }
304 }
305 }
306
307 return unref;
308}
309
310
311void
312IniFile::Section::dump(const string &sectionName)
313{
314 for (EntryTable::iterator ei = table.begin();
315 ei != table.end(); ++ei) {
316 cout << sectionName << ": " << (*ei).first << " => "
317 << (*ei).second->getValue() << "\n";
318 }
319}
320
321void
322IniFile::dump()
323{
324 for (SectionTable::iterator i = table.begin();
325 i != table.end(); ++i) {
326 i->second->dump(i->first);
327 }
328}
293bool
294IniFile::printUnreferenced()
295{
296 bool unref = false;
297
298 for (SectionTable::iterator i = table.begin();
299 i != table.end(); ++i) {
300 const string &sectionName = i->first;
301 Section *section = i->second;
302
303 if (!section->isReferenced()) {
304 if (section->findEntry("unref_section_ok") == NULL) {
305 cerr << "Section " << sectionName << " not referenced."
306 << endl;
307 unref = true;
308 }
309 }
310 else {
311 if (section->printUnreferenced(sectionName)) {
312 unref = true;
313 }
314 }
315 }
316
317 return unref;
318}
319
320
321void
322IniFile::Section::dump(const string &sectionName)
323{
324 for (EntryTable::iterator ei = table.begin();
325 ei != table.end(); ++ei) {
326 cout << sectionName << ": " << (*ei).first << " => "
327 << (*ei).second->getValue() << "\n";
328 }
329}
330
331void
332IniFile::dump()
333{
334 for (SectionTable::iterator i = table.begin();
335 i != table.end(); ++i) {
336 i->second->dump(i->first);
337 }
338}