3 Copyright (C) 2010-2011 celeron55, Perttu Ahola <celeron55@gmail.com>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License along
16 with this program; if not, write to the Free Software Foundation, Inc.,
17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20 #ifndef SETTINGS_HEADER
21 #define SETTINGS_HEADER
23 #include "common_irrlicht.h"
27 #include <jmutexautolock.h>
39 VALUETYPE_FLAG // Doesn't take any arguments
44 ValueSpec(ValueType a_type, const char *a_help=NULL)
61 void writeLines(std::ostream &os)
63 JMutexAutoLock lock(m_mutex);
65 for(core::map<std::string, std::string>::Iterator
66 i = m_settings.getIterator();
67 i.atEnd() == false; i++)
69 std::string name = i.getNode()->getKey();
70 std::string value = i.getNode()->getValue();
71 os<<name<<" = "<<value<<"\n";
75 bool parseConfigLine(const std::string &line)
77 JMutexAutoLock lock(m_mutex);
79 std::string trimmedline = trim(line);
81 // Ignore empty lines and comments
82 if(trimmedline.size() == 0 || trimmedline[0] == '#')
85 //infostream<<"trimmedline=\""<<trimmedline<<"\""<<std::endl;
87 Strfnd sf(trim(line));
89 std::string name = sf.next("=");
95 std::string value = sf.next("\n");
98 /*infostream<<"Config name=\""<<name<<"\" value=\""
99 <<value<<"\""<<std::endl;*/
101 m_settings[name] = value;
106 void parseConfigLines(std::istream &is, const std::string &endstring)
112 std::getline(is, line);
113 std::string trimmedline = trim(line);
115 if(trimmedline == endstring)
118 parseConfigLine(line);
122 // Returns false on EOF
123 bool parseConfigObject(std::istream &is)
129 NOTE: This function might be expanded to allow multi-line
133 std::getline(is, line);
134 //infostream<<"got line: \""<<line<<"\""<<std::endl;
136 return parseConfigLine(line);
140 Read configuration file
142 Returns true on success
144 bool readConfigFile(const char *filename)
146 std::ifstream is(filename);
147 if(is.good() == false)
150 infostream<<"Parsing configuration file: \""
151 <<filename<<"\""<<std::endl;
153 while(parseConfigObject(is));
159 Reads a configuration object from stream (usually a single line)
162 Preserves comments and empty lines.
164 Settings that were added to dst are also added to updated.
165 key of updated is setting name, value of updated is dummy.
169 bool getUpdatedConfigObject(std::istream &is,
170 core::list<std::string> &dst,
171 core::map<std::string, bool> &updated,
174 JMutexAutoLock lock(m_mutex);
179 // NOTE: This function will be expanded to allow multi-line settings
181 std::getline(is, line);
183 std::string trimmedline = trim(line);
185 std::string line_end = "";
186 if(is.eof() == false)
189 // Ignore empty lines and comments
190 if(trimmedline.size() == 0 || trimmedline[0] == '#')
192 dst.push_back(line+line_end);
196 Strfnd sf(trim(line));
198 std::string name = sf.next("=");
203 dst.push_back(line+line_end);
207 std::string value = sf.next("\n");
210 if(m_settings.find(name))
212 std::string newvalue = m_settings[name];
214 if(newvalue != value)
216 infostream<<"Changing value of \""<<name<<"\" = \""
217 <<value<<"\" -> \""<<newvalue<<"\""
219 value_changed = true;
222 dst.push_back(name + " = " + newvalue + line_end);
224 updated[name] = true;
231 Updates configuration file
233 Returns true on success
235 bool updateConfigFile(const char *filename)
237 infostream<<"Updating configuration file: \""
238 <<filename<<"\""<<std::endl;
240 core::list<std::string> objects;
241 core::map<std::string, bool> updated;
242 bool something_actually_changed = false;
244 // Read and modify stuff
246 std::ifstream is(filename);
247 if(is.good() == false)
249 infostream<<"updateConfigFile():"
250 " Error opening configuration file"
252 <<filename<<"\""<<std::endl;
256 while(getUpdatedConfigObject(is, objects, updated,
257 something_actually_changed));
261 JMutexAutoLock lock(m_mutex);
263 // If something not yet determined to have been changed, check if
264 // any new stuff was added
265 if(!something_actually_changed){
266 for(core::map<std::string, std::string>::Iterator
267 i = m_settings.getIterator();
268 i.atEnd() == false; i++)
270 if(updated.find(i.getNode()->getKey()))
272 something_actually_changed = true;
277 // If nothing was actually changed, skip writing the file
278 if(!something_actually_changed){
279 infostream<<"Skipping writing of "<<filename
280 <<" because content wouldn't be modified"<<std::endl;
286 std::ofstream os(filename);
287 if(os.good() == false)
289 errorstream<<"Error opening configuration file"
291 <<filename<<"\""<<std::endl;
298 for(core::list<std::string>::Iterator
300 i != objects.end(); i++)
306 Write stuff that was not already in the file
308 for(core::map<std::string, std::string>::Iterator
309 i = m_settings.getIterator();
310 i.atEnd() == false; i++)
312 if(updated.find(i.getNode()->getKey()))
314 std::string name = i.getNode()->getKey();
315 std::string value = i.getNode()->getValue();
316 infostream<<"Adding \""<<name<<"\" = \""<<value<<"\""
318 os<<name<<" = "<<value<<"\n";
326 NOTE: Types of allowed_options are ignored
328 returns true on success
330 bool parseCommandLine(int argc, char *argv[],
331 core::map<std::string, ValueSpec> &allowed_options)
338 std::string argname = argv[i];
339 if(argname.substr(0, 2) != "--")
341 errorstream<<"Invalid command-line parameter \""
342 <<argname<<"\": --<option> expected."<<std::endl;
347 std::string name = argname.substr(2);
349 core::map<std::string, ValueSpec>::Node *n;
350 n = allowed_options.find(name);
353 errorstream<<"Unknown command-line parameter \""
354 <<argname<<"\""<<std::endl;
358 ValueType type = n->getValue().type;
360 std::string value = "";
362 if(type == VALUETYPE_FLAG)
370 errorstream<<"Invalid command-line parameter \""
371 <<name<<"\": missing value"<<std::endl;
379 infostream<<"Valid command-line parameter: \""
380 <<name<<"\" = \""<<value<<"\""
388 void set(std::string name, std::string value)
390 JMutexAutoLock lock(m_mutex);
392 m_settings[name] = value;
395 void set(std::string name, const char *value)
397 JMutexAutoLock lock(m_mutex);
399 m_settings[name] = value;
403 void setDefault(std::string name, std::string value)
405 JMutexAutoLock lock(m_mutex);
407 m_defaults[name] = value;
410 bool exists(std::string name)
412 JMutexAutoLock lock(m_mutex);
414 return (m_settings.find(name) || m_defaults.find(name));
417 std::string get(std::string name)
419 JMutexAutoLock lock(m_mutex);
421 core::map<std::string, std::string>::Node *n;
422 n = m_settings.find(name);
425 n = m_defaults.find(name);
428 infostream<<"Settings: Setting not found: \""
429 <<name<<"\""<<std::endl;
430 throw SettingNotFoundException("Setting not found");
434 return n->getValue();
437 bool getBool(std::string name)
439 return is_yes(get(name));
442 bool getFlag(std::string name)
446 return getBool(name);
448 catch(SettingNotFoundException &e)
455 bool getBoolAsk(std::string name, std::string question, bool def)
457 // If it is in settings
459 return getBool(name);
463 std::cout<<question<<" [y/N]: ";
464 std::cin.getline(templine, 10);
473 float getFloat(std::string name)
475 return stof(get(name));
478 u16 getU16(std::string name)
480 return stoi(get(name), 0, 65535);
483 u16 getU16Ask(std::string name, std::string question, u16 def)
485 // If it is in settings
491 std::cout<<question<<" ["<<def<<"]: ";
492 std::cin.getline(templine, 10);
498 return stoi(s, 0, 65535);
501 s16 getS16(std::string name)
503 return stoi(get(name), -32768, 32767);
506 s32 getS32(std::string name)
508 return stoi(get(name));
511 v3f getV3F(std::string name)
516 value.X = stof(f.next(","));
517 value.Y = stof(f.next(","));
518 value.Z = stof(f.next(")"));
522 v2f getV2F(std::string name)
527 value.X = stof(f.next(","));
528 value.Y = stof(f.next(")"));
532 u64 getU64(std::string name)
535 std::string s = get(name);
536 std::istringstream ss(s);
541 void setBool(std::string name, bool value)
549 void setS32(std::string name, s32 value)
551 set(name, itos(value));
554 void setFloat(std::string name, float value)
556 set(name, ftos(value));
559 void setV3F(std::string name, v3f value)
561 std::ostringstream os;
562 os<<"("<<value.X<<","<<value.Y<<","<<value.Z<<")";
566 void setV2F(std::string name, v2f value)
568 std::ostringstream os;
569 os<<"("<<value.X<<","<<value.Y<<")";
573 void setU64(std::string name, u64 value)
575 std::ostringstream os;
582 JMutexAutoLock lock(m_mutex);
588 void updateValue(Settings &other, const std::string &name)
590 JMutexAutoLock lock(m_mutex);
596 std::string val = other.get(name);
597 m_settings[name] = val;
598 } catch(SettingNotFoundException &e){
604 void update(Settings &other)
606 JMutexAutoLock lock(m_mutex);
607 JMutexAutoLock lock2(other.m_mutex);
612 for(core::map<std::string, std::string>::Iterator
613 i = other.m_settings.getIterator();
614 i.atEnd() == false; i++)
616 m_settings[i.getNode()->getKey()] = i.getNode()->getValue();
619 for(core::map<std::string, std::string>::Iterator
620 i = other.m_defaults.getIterator();
621 i.atEnd() == false; i++)
623 m_defaults[i.getNode()->getKey()] = i.getNode()->getValue();
629 Settings & operator+=(Settings &other)
631 JMutexAutoLock lock(m_mutex);
632 JMutexAutoLock lock2(other.m_mutex);
637 for(core::map<std::string, std::string>::Iterator
638 i = other.m_settings.getIterator();
639 i.atEnd() == false; i++)
641 m_settings.insert(i.getNode()->getKey(),
642 i.getNode()->getValue());
645 for(core::map<std::string, std::string>::Iterator
646 i = other.m_defaults.getIterator();
647 i.atEnd() == false; i++)
649 m_defaults.insert(i.getNode()->getKey(),
650 i.getNode()->getValue());
657 Settings & operator=(Settings &other)
659 JMutexAutoLock lock(m_mutex);
660 JMutexAutoLock lock2(other.m_mutex);
672 core::map<std::string, std::string> m_settings;
673 core::map<std::string, std::string> m_defaults;
674 // All methods that access m_settings/m_defaults directly should lock this.