X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=src%2Fsettings.h;h=53e8d8ef5c85d43b30fa7c6889bb5b539824f5e2;hb=ea0df3e4cb75a7a104a81e050c019049219c4fee;hp=d75b0bec19616d7498ddeb4221b2bee4bbf5fac2;hpb=037b2591971d752e67fa7d47095b996b3f56da5a;p=minetest.git

diff --git a/src/settings.h b/src/settings.h
index d75b0bec1..53e8d8ef5 100644
--- a/src/settings.h
+++ b/src/settings.h
@@ -1,6 +1,6 @@
 /*
-Minetest-c55
-Copyright (C) 2010-2011 celeron55, Perttu Ahola <celeron55@gmail.com>
+Minetest
+Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
 
 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU Lesser General Public License as published by
@@ -20,18 +20,23 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #ifndef SETTINGS_HEADER
 #define SETTINGS_HEADER
 
-#include "common_irrlicht.h"
+#include "irrlichttypes_bloated.h"
+#include "exceptions.h"
 #include <string>
-#include <jthread.h>
-#include <jmutex.h>
-#include <jmutexautolock.h>
+#include "jthread/jmutex.h"
+#include "jthread/jmutexautolock.h"
 #include "strfnd.h"
 #include <iostream>
 #include <fstream>
 #include <sstream>
 #include "debug.h"
-#include "utility.h"
 #include "log.h"
+#include "util/string.h"
+#include "util/serialize.h"
+#include <list>
+#include <map>
+#include <set>
+#include "filesys.h"
 
 enum ValueType
 {
@@ -55,29 +60,47 @@ class Settings
 public:
 	Settings()
 	{
-		m_mutex.Init();
 	}
 
 	void writeLines(std::ostream &os)
 	{
 		JMutexAutoLock lock(m_mutex);
-		
-		for(core::map<std::string, std::string>::Iterator
-				i = m_settings.getIterator();
-				i.atEnd() == false; i++)
+
+		for(std::map<std::string, std::string>::iterator
+				i = m_settings.begin();
+				i != m_settings.end(); ++i)
 		{
-			std::string name = i.getNode()->getKey();
-			std::string value = i.getNode()->getValue();
+			std::string name = i->first;
+			std::string value = i->second;
 			os<<name<<" = "<<value<<"\n";
 		}
 	}
+  
+	// return all keys used
+	std::vector<std::string> getNames(){
+		std::vector<std::string> names;
+		for(std::map<std::string, std::string>::iterator
+				i = m_settings.begin();
+				i != m_settings.end(); ++i)
+		{
+			names.push_back(i->first);
+		}
+		return names;
+	}
+
+	// remove a setting
+	bool remove(const std::string& name)
+	{
+		return m_settings.erase(name);
+	}
+
 
 	bool parseConfigLine(const std::string &line)
 	{
 		JMutexAutoLock lock(m_mutex);
-		
+
 		std::string trimmedline = trim(line);
-		
+
 		// Ignore empty lines and comments
 		if(trimmedline.size() == 0 || trimmedline[0] == '#')
 			return true;
@@ -91,15 +114,15 @@ class Settings
 
 		if(name == "")
 			return true;
-		
+
 		std::string value = sf.next("\n");
 		value = trim(value);
 
 		/*infostream<<"Config name=\""<<name<<"\" value=\""
 				<<value<<"\""<<std::endl;*/
-		
+
 		m_settings[name] = value;
-		
+
 		return true;
 	}
 
@@ -124,7 +147,7 @@ class Settings
 	{
 		if(is.eof())
 			return false;
-		
+
 		/*
 			NOTE: This function might be expanded to allow multi-line
 			      settings.
@@ -149,16 +172,16 @@ class Settings
 
 		/*infostream<<"Parsing configuration file: \""
 				<<filename<<"\""<<std::endl;*/
-				
+
 		while(parseConfigObject(is));
-		
+
 		return true;
 	}
 
 	/*
 		Reads a configuration object from stream (usually a single line)
 		and adds it to dst.
-		
+
 		Preserves comments and empty lines.
 
 		Settings that were added to dst are also added to updated.
@@ -167,15 +190,15 @@ class Settings
 		Returns false on EOF
 	*/
 	bool getUpdatedConfigObject(std::istream &is,
-			core::list<std::string> &dst,
-			core::map<std::string, bool> &updated,
+			std::list<std::string> &dst,
+			std::set<std::string> &updated,
 			bool &value_changed)
 	{
 		JMutexAutoLock lock(m_mutex);
-		
+
 		if(is.eof())
 			return false;
-		
+
 		// NOTE: This function will be expanded to allow multi-line settings
 		std::string line;
 		std::getline(is, line);
@@ -185,7 +208,7 @@ class Settings
 		std::string line_end = "";
 		if(is.eof() == false)
 			line_end = "\n";
-		
+
 		// Ignore empty lines and comments
 		if(trimmedline.size() == 0 || trimmedline[0] == '#')
 		{
@@ -203,14 +226,14 @@ class Settings
 			dst.push_back(line+line_end);
 			return true;
 		}
-		
+
 		std::string value = sf.next("\n");
 		value = trim(value);
-		
-		if(m_settings.find(name))
+
+		if(m_settings.find(name) != m_settings.end())
 		{
 			std::string newvalue = m_settings[name];
-			
+
 			if(newvalue != value)
 			{
 				infostream<<"Changing value of \""<<name<<"\" = \""
@@ -221,9 +244,11 @@ class Settings
 
 			dst.push_back(name + " = " + newvalue + line_end);
 
-			updated[name] = true;
+			updated.insert(name);
 		}
-		
+		else //file contains a setting which is not in m_settings
+			value_changed=true;
+			
 		return true;
 	}
 
@@ -236,11 +261,11 @@ class Settings
 	{
 		infostream<<"Updating configuration file: \""
 				<<filename<<"\""<<std::endl;
-		
-		core::list<std::string> objects;
-		core::map<std::string, bool> updated;
+
+		std::list<std::string> objects;
+		std::set<std::string> updated;
 		bool something_actually_changed = false;
-		
+
 		// Read and modify stuff
 		{
 			std::ifstream is(filename);
@@ -257,68 +282,68 @@ class Settings
 						something_actually_changed));
 			}
 		}
-		
+
 		JMutexAutoLock lock(m_mutex);
-		
+
 		// If something not yet determined to have been changed, check if
 		// any new stuff was added
 		if(!something_actually_changed){
-			for(core::map<std::string, std::string>::Iterator
-					i = m_settings.getIterator();
-					i.atEnd() == false; i++)
+			for(std::map<std::string, std::string>::iterator
+					i = m_settings.begin();
+					i != m_settings.end(); ++i)
 			{
-				if(updated.find(i.getNode()->getKey()))
+				if(updated.find(i->first) != updated.end())
 					continue;
 				something_actually_changed = true;
 				break;
 			}
 		}
-		
+
 		// If nothing was actually changed, skip writing the file
 		if(!something_actually_changed){
 			infostream<<"Skipping writing of "<<filename
 					<<" because content wouldn't be modified"<<std::endl;
 			return true;
 		}
-		
+
 		// Write stuff back
 		{
-			std::ofstream os(filename);
-			if(os.good() == false)
-			{
-				errorstream<<"Error opening configuration file"
-						" for writing: \""
-						<<filename<<"\""<<std::endl;
-				return false;
-			}
-			
+			std::ostringstream ss(std::ios_base::binary);
+
 			/*
 				Write updated stuff
 			*/
-			for(core::list<std::string>::Iterator
+			for(std::list<std::string>::iterator
 					i = objects.begin();
-					i != objects.end(); i++)
+					i != objects.end(); ++i)
 			{
-				os<<(*i);
+				ss<<(*i);
 			}
 
 			/*
 				Write stuff that was not already in the file
 			*/
-			for(core::map<std::string, std::string>::Iterator
-					i = m_settings.getIterator();
-					i.atEnd() == false; i++)
+			for(std::map<std::string, std::string>::iterator
+					i = m_settings.begin();
+					i != m_settings.end(); ++i)
 			{
-				if(updated.find(i.getNode()->getKey()))
+				if(updated.find(i->first) != updated.end())
 					continue;
-				std::string name = i.getNode()->getKey();
-				std::string value = i.getNode()->getValue();
+				std::string name = i->first;
+				std::string value = i->second;
 				infostream<<"Adding \""<<name<<"\" = \""<<value<<"\""
 						<<std::endl;
-				os<<name<<" = "<<value<<"\n";
+				ss<<name<<" = "<<value<<"\n";
+			}
+
+			if(!fs::safeWriteToFile(filename, ss.str()))
+			{
+				errorstream<<"Error writing configuration file: \""
+						<<filename<<"\""<<std::endl;
+				return false;
 			}
 		}
-		
+
 		return true;
 	}
 
@@ -328,7 +353,7 @@ class Settings
 		returns true on success
 	*/
 	bool parseCommandLine(int argc, char *argv[],
-			core::map<std::string, ValueSpec> &allowed_options)
+			std::map<std::string, ValueSpec> &allowed_options)
 	{
 		int nonopt_index = 0;
 		int i=1;
@@ -356,19 +381,19 @@ class Settings
 
 			std::string name = argname.substr(2);
 
-			core::map<std::string, ValueSpec>::Node *n;
+			std::map<std::string, ValueSpec>::iterator n;
 			n = allowed_options.find(name);
-			if(n == NULL)
+			if(n == allowed_options.end())
 			{
 				errorstream<<"Unknown command-line parameter \""
 						<<argname<<"\""<<std::endl;
 				return false;
 			}
 
-			ValueType type = n->getValue().type;
+			ValueType type = n->second.type;
 
 			std::string value = "";
-			
+
 			if(type == VALUETYPE_FLAG)
 			{
 				value = "true";
@@ -384,7 +409,7 @@ class Settings
 				value = argv[i];
 				i++;
 			}
-			
+
 
 			infostream<<"Valid command-line parameter: \""
 					<<name<<"\" = \""<<value<<"\""
@@ -398,7 +423,7 @@ class Settings
 	void set(std::string name, std::string value)
 	{
 		JMutexAutoLock lock(m_mutex);
-		
+
 		m_settings[name] = value;
 	}
 
@@ -413,40 +438,41 @@ class Settings
 	void setDefault(std::string name, std::string value)
 	{
 		JMutexAutoLock lock(m_mutex);
-		
+
 		m_defaults[name] = value;
 	}
 
 	bool exists(std::string name)
 	{
 		JMutexAutoLock lock(m_mutex);
-		
-		return (m_settings.find(name) || m_defaults.find(name));
+
+		return (m_settings.find(name) != m_settings.end() || m_defaults.find(name) != m_defaults.end());
 	}
 
 	std::string get(std::string name)
 	{
 		JMutexAutoLock lock(m_mutex);
-		
-		core::map<std::string, std::string>::Node *n;
+
+		std::map<std::string, std::string>::iterator n;
 		n = m_settings.find(name);
-		if(n == NULL)
+		if(n == m_settings.end())
 		{
 			n = m_defaults.find(name);
-			if(n == NULL)
+			if(n == m_defaults.end())
 			{
-				throw SettingNotFoundException("Setting not found");
+				throw SettingNotFoundException(("Setting [" + name + "] not found ").c_str());
 			}
 		}
 
-		return n->getValue();
+		return n->second;
 	}
 
+	//////////// Get setting
 	bool getBool(std::string name)
 	{
 		return is_yes(get(name));
 	}
-	
+
 	bool getFlag(std::string name)
 	{
 		try
@@ -465,7 +491,7 @@ class Settings
 		// If it is in settings
 		if(exists(name))
 			return getBool(name);
-		
+
 		std::string s;
 		char templine[10];
 		std::cout<<question<<" [y/N]: ";
@@ -493,7 +519,7 @@ class Settings
 		// If it is in settings
 		if(exists(name))
 			return getU16(name);
-		
+
 		std::string s;
 		char templine[10];
 		std::cout<<question<<" ["<<def<<"]: ";
@@ -546,6 +572,171 @@ class Settings
 		return value;
 	}
 
+	u32 getFlagStr(std::string name, FlagDesc *flagdesc, u32 *flagmask)
+	{
+		std::string val = get(name);
+		return (isdigit(val[0])) ? stoi(val) :
+			readFlagString(val, flagdesc, flagmask);
+	}
+
+	// N.B. if getStruct() is used to read a non-POD aggregate type,
+	// the behavior is undefined.
+	bool getStruct(std::string name, std::string format, void *out, size_t olen)
+	{
+		std::string valstr;
+
+		try {
+			valstr = get(name);
+		} catch (SettingNotFoundException &e) {
+			return false;
+		}
+
+		if (!deSerializeStringToStruct(valstr, format, out, olen))
+			return false;
+
+		return true;
+	}
+
+	//////////// Try to get value, no exception thrown
+	bool getNoEx(std::string name, std::string &val)
+	{
+		try {
+			val = get(name);
+			return true;
+		} catch (SettingNotFoundException &e) {
+			return false;
+		}
+	}
+
+	// N.B. getFlagStrNoEx() does not set val, but merely modifies it.  Thus,
+	// val must be initialized before using getFlagStrNoEx().  The intention of
+	// this is to simplify modifying a flags field from a default value.
+	bool getFlagStrNoEx(std::string name, u32 &val, FlagDesc *flagdesc)
+	{
+		try {
+			u32 flags, flagmask;
+
+			flags = getFlagStr(name, flagdesc, &flagmask);
+
+			val &= ~flagmask;
+			val |=  flags;
+
+			return true;
+		} catch (SettingNotFoundException &e) {
+			return false;
+		}
+	}
+
+	bool getFloatNoEx(std::string name, float &val)
+	{
+		try {
+			val = getFloat(name);
+			return true;
+		} catch (SettingNotFoundException &e) {
+			return false;
+		}
+	}
+
+	bool getU16NoEx(std::string name, int &val)
+	{
+		try {
+			val = getU16(name);
+			return true;
+		} catch (SettingNotFoundException &e) {
+			return false;
+		}
+	}
+
+	bool getU16NoEx(std::string name, u16 &val)
+	{
+		try {
+			val = getU16(name);
+			return true;
+		} catch (SettingNotFoundException &e) {
+			return false;
+		}
+	}
+
+	bool getS16NoEx(std::string name, int &val)
+	{
+		try {
+			val = getU16(name);
+			return true;
+		} catch (SettingNotFoundException &e) {
+			return false;
+		}
+	}
+
+	bool getS16NoEx(std::string name, s16 &val)
+	{
+		try {
+			val = getS16(name);
+			return true;
+		} catch (SettingNotFoundException &e) {
+			return false;
+		}
+	}
+
+	bool getS32NoEx(std::string name, s32 &val)
+	{
+		try {
+			val = getS32(name);
+			return true;
+		} catch (SettingNotFoundException &e) {
+			return false;
+		}
+	}
+
+	bool getV3FNoEx(std::string name, v3f &val)
+	{
+		try {
+			val = getV3F(name);
+			return true;
+		} catch (SettingNotFoundException &e) {
+			return false;
+		}
+	}
+
+	bool getV2FNoEx(std::string name, v2f &val)
+	{
+		try {
+			val = getV2F(name);
+			return true;
+		} catch (SettingNotFoundException &e) {
+			return false;
+		}
+	}
+
+	bool getU64NoEx(std::string name, u64 &val)
+	{
+		try {
+			val = getU64(name);
+			return true;
+		} catch (SettingNotFoundException &e) {
+			return false;
+		}
+	}
+
+	//////////// Set setting
+
+	// N.B. if setStruct() is used to write a non-POD aggregate type,
+	// the behavior is undefined.
+	bool setStruct(std::string name, std::string format, void *value)
+	{
+		std::string structstr;
+		if (!serializeStructToString(&structstr, format, value))
+			return false;
+
+		set(name, structstr);
+		return true;
+	}
+
+	void setFlagStr(std::string name, u32 flags,
+		FlagDesc *flagdesc, u32 flagmask)
+	{
+		set(name, writeFlagString(flags, flagdesc, flagmask));
+	}
+
 	void setBool(std::string name, bool value)
 	{
 		if(value)
@@ -554,11 +745,6 @@ class Settings
 			set(name, "false");
 	}
 
-	void setS32(std::string name, s32 value)
-	{
-		set(name, itos(value));
-	}
-
 	void setFloat(std::string name, float value)
 	{
 		set(name, ftos(value));
@@ -578,6 +764,16 @@ class Settings
 		set(name, os.str());
 	}
 
+	void setS16(std::string name, s16 value)
+	{
+		set(name, itos(value));
+	}
+
+	void setS32(std::string name, s32 value)
+	{
+		set(name, itos(value));
+	}
+
 	void setU64(std::string name, u64 value)
 	{
 		std::ostringstream os;
@@ -588,7 +784,7 @@ class Settings
 	void clear()
 	{
 		JMutexAutoLock lock(m_mutex);
-		
+
 		m_settings.clear();
 		m_defaults.clear();
 	}
@@ -596,7 +792,7 @@ class Settings
 	void updateValue(Settings &other, const std::string &name)
 	{
 		JMutexAutoLock lock(m_mutex);
-		
+
 		if(&other == this)
 			return;
 
@@ -613,23 +809,12 @@ class Settings
 	{
 		JMutexAutoLock lock(m_mutex);
 		JMutexAutoLock lock2(other.m_mutex);
-		
+
 		if(&other == this)
 			return;
 
-		for(core::map<std::string, std::string>::Iterator
-				i = other.m_settings.getIterator();
-				i.atEnd() == false; i++)
-		{
-			m_settings[i.getNode()->getKey()] = i.getNode()->getValue();
-		}
-		
-		for(core::map<std::string, std::string>::Iterator
-				i = other.m_defaults.getIterator();
-				i.atEnd() == false; i++)
-		{
-			m_defaults[i.getNode()->getKey()] = i.getNode()->getValue();
-		}
+		m_settings.insert(other.m_settings.begin(), other.m_settings.end());
+		m_defaults.insert(other.m_defaults.begin(), other.m_defaults.end());
 
 		return;
 	}
@@ -638,25 +823,11 @@ class Settings
 	{
 		JMutexAutoLock lock(m_mutex);
 		JMutexAutoLock lock2(other.m_mutex);
-		
+
 		if(&other == this)
 			return *this;
 
-		for(core::map<std::string, std::string>::Iterator
-				i = other.m_settings.getIterator();
-				i.atEnd() == false; i++)
-		{
-			m_settings.insert(i.getNode()->getKey(),
-					i.getNode()->getValue());
-		}
-		
-		for(core::map<std::string, std::string>::Iterator
-				i = other.m_defaults.getIterator();
-				i.atEnd() == false; i++)
-		{
-			m_defaults.insert(i.getNode()->getKey(),
-					i.getNode()->getValue());
-		}
+		update(other);
 
 		return *this;
 
@@ -666,19 +837,19 @@ class Settings
 	{
 		JMutexAutoLock lock(m_mutex);
 		JMutexAutoLock lock2(other.m_mutex);
-		
+
 		if(&other == this)
 			return *this;
 
 		clear();
 		(*this) += other;
-		
+
 		return *this;
 	}
 
 private:
-	core::map<std::string, std::string> m_settings;
-	core::map<std::string, std::string> m_defaults;
+	std::map<std::string, std::string> m_settings;
+	std::map<std::string, std::string> m_defaults;
 	// All methods that access m_settings/m_defaults directly should lock this.
 	JMutex m_mutex;
 };