]> git.lizzy.rs Git - dragonfireclient.git/blobdiff - src/settings.h
Slightly improved version of mystrtok_r
[dragonfireclient.git] / src / settings.h
index 4bc22eaa1e08f47682108872b272a7790dc246d4..2b46676c6b7ae03a440b2a9870f4494b2599a51f 100644 (file)
@@ -3,16 +3,16 @@ Minetest-c55
 Copyright (C) 2010-2011 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 General Public License as published by
-the Free Software Foundation; either version 2 of the License, or
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation; either version 2.1 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.
+GNU Lesser General Public License for more details.
 
-You should have received a copy of the GNU General Public License along
+You should have received a copy of the GNU Lesser 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.
 */
@@ -20,7 +20,7 @@ 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 <string>
 #include <jthread.h>
 #include <jmutex.h>
@@ -30,8 +30,9 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #include <fstream>
 #include <sstream>
 #include "debug.h"
-#include "utility.h"
 #include "log.h"
+#include "util/string.h"
+#include "porting.h"
 
 enum ValueType
 {
@@ -61,7 +62,7 @@ class Settings
        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++)
@@ -71,13 +72,33 @@ class Settings
                        os<<name<<" = "<<value<<"\n";
                }
        }
+  
+       // return all keys used 
+       std::vector<std::string> getNames(){
+               std::vector<std::string> names;
+               for(core::map<std::string, std::string>::Iterator
+                               i = m_settings.getIterator();
+                               i.atEnd() == false; i++)
+               {
+                       std::string name = i.getNode()->getKey();
+                       names.push_back(name);
+               }
+               return names;  
+       }
+
+       // remove a setting
+       bool remove(const std::string& name)
+       {
+               return m_settings.remove(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 +112,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 +145,7 @@ class Settings
        {
                if(is.eof())
                        return false;
-               
+
                /*
                        NOTE: This function might be expanded to allow multi-line
                              settings.
@@ -145,24 +166,20 @@ class Settings
        {
                std::ifstream is(filename);
                if(is.good() == false)
-               {
-                       errorstream<<"Error opening configuration file \""
-                                       <<filename<<"\""<<std::endl;
                        return false;
-               }
 
-               infostream<<"Parsing configuration file: \""
-                               <<filename<<"\""<<std::endl;
-                               
+               /*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.
@@ -172,13 +189,14 @@ class Settings
        */
        bool getUpdatedConfigObject(std::istream &is,
                        core::list<std::string> &dst,
-                       core::map<std::string, bool> &updated)
+                       core::map<std::string, bool> &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);
@@ -188,7 +206,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] == '#')
                {
@@ -206,26 +224,29 @@ class Settings
                        dst.push_back(line+line_end);
                        return true;
                }
-               
+
                std::string value = sf.next("\n");
                value = trim(value);
-               
+
                if(m_settings.find(name))
                {
                        std::string newvalue = m_settings[name];
-                       
+
                        if(newvalue != value)
                        {
                                infostream<<"Changing value of \""<<name<<"\" = \""
                                                <<value<<"\" -> \""<<newvalue<<"\""
                                                <<std::endl;
+                               value_changed = true;
                        }
 
                        dst.push_back(name + " = " + newvalue + line_end);
 
                        updated[name] = true;
                }
-               
+               else //file contains a setting which is not in m_settings
+                       value_changed=true;
+                       
                return true;
        }
 
@@ -238,10 +259,11 @@ class Settings
        {
                infostream<<"Updating configuration file: \""
                                <<filename<<"\""<<std::endl;
-               
+
                core::list<std::string> objects;
                core::map<std::string, bool> updated;
-               
+               bool something_actually_changed = false;
+
                // Read and modify stuff
                {
                        std::ifstream is(filename);
@@ -254,12 +276,34 @@ class Settings
                        }
                        else
                        {
-                               while(getUpdatedConfigObject(is, objects, updated));
+                               while(getUpdatedConfigObject(is, objects, updated,
+                                               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++)
+                       {
+                               if(updated.find(i.getNode()->getKey()))
+                                       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);
@@ -270,7 +314,7 @@ class Settings
                                                <<filename<<"\""<<std::endl;
                                return false;
                        }
-                       
+
                        /*
                                Write updated stuff
                        */
@@ -297,7 +341,7 @@ class Settings
                                os<<name<<" = "<<value<<"\n";
                        }
                }
-               
+
                return true;
        }
 
@@ -309,6 +353,7 @@ class Settings
        bool parseCommandLine(int argc, char *argv[],
                        core::map<std::string, ValueSpec> &allowed_options)
        {
+               int nonopt_index = 0;
                int i=1;
                for(;;)
                {
@@ -317,6 +362,15 @@ class Settings
                        std::string argname = argv[i];
                        if(argname.substr(0, 2) != "--")
                        {
+                               // If option doesn't start with -, read it in as nonoptX
+                               if(argname[0] != '-'){
+                                       std::string name = "nonopt";
+                                       name += itos(nonopt_index);
+                                       set(name, argname);
+                                       nonopt_index++;
+                                       i++;
+                                       continue;
+                               }
                                errorstream<<"Invalid command-line parameter \""
                                                <<argname<<"\": --<option> expected."<<std::endl;
                                return false;
@@ -337,7 +391,7 @@ class Settings
                        ValueType type = n->getValue().type;
 
                        std::string value = "";
-                       
+
                        if(type == VALUETYPE_FLAG)
                        {
                                value = "true";
@@ -353,7 +407,7 @@ class Settings
                                value = argv[i];
                                i++;
                        }
-                       
+
 
                        infostream<<"Valid command-line parameter: \""
                                        <<name<<"\" = \""<<value<<"\""
@@ -367,7 +421,7 @@ class Settings
        void set(std::string name, std::string value)
        {
                JMutexAutoLock lock(m_mutex);
-               
+
                m_settings[name] = value;
        }
 
@@ -382,21 +436,21 @@ 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));
        }
 
        std::string get(std::string name)
        {
                JMutexAutoLock lock(m_mutex);
-               
+
                core::map<std::string, std::string>::Node *n;
                n = m_settings.find(name);
                if(n == NULL)
@@ -404,8 +458,6 @@ class Settings
                        n = m_defaults.find(name);
                        if(n == NULL)
                        {
-                               infostream<<"Settings: Setting not found: \""
-                                               <<name<<"\""<<std::endl;
                                throw SettingNotFoundException("Setting not found");
                        }
                }
@@ -417,7 +469,7 @@ class Settings
        {
                return is_yes(get(name));
        }
-       
+
        bool getFlag(std::string name)
        {
                try
@@ -436,7 +488,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]: ";
@@ -464,7 +516,7 @@ class Settings
                // If it is in settings
                if(exists(name))
                        return getU16(name);
-               
+
                std::string s;
                char templine[10];
                std::cout<<question<<" ["<<def<<"]: ";
@@ -517,6 +569,269 @@ class Settings
                return value;
        }
 
+       template <class T> T *getStruct(std::string name, std::string format)
+       {
+               size_t len = sizeof(T);
+               std::vector<std::string *> strs_alloced;
+               std::string *str;
+               std::string valstr = get(name);
+               char *s = &valstr[0];
+               T *buf = new T;
+               char *bufpos = (char *)buf;
+               char *f, *snext;
+               size_t pos;
+
+               char *fmtpos, *fmt = &format[0];
+               while ((f = strtok_r(fmt, ",", &fmtpos)) && s) {
+                       fmt = NULL;
+
+                       bool is_unsigned = false;
+                       int width = 0;
+                       char valtype = *f;
+
+                       width = (int)strtol(f + 1, &f, 10);
+                       if (width && valtype == 's')
+                               valtype = 'i';
+
+                       switch (valtype) {
+                               case 'u':
+                                       is_unsigned = true;
+                                       /* FALLTHROUGH */
+                               case 'i':
+                                       if (width == 16) {
+                                               bufpos += PADDING(bufpos, u16);
+                                               if ((bufpos - (char *)buf) + sizeof(u16) <= len) {
+                                                       if (is_unsigned)
+                                                               *(u16 *)bufpos = (u16)strtoul(s, &s, 10);
+                                                       else
+                                                               *(s16 *)bufpos = (s16)strtol(s, &s, 10);
+                                               }
+                                               bufpos += sizeof(u16);
+                                       } else if (width == 32) {
+                                               bufpos += PADDING(bufpos, u32);
+                                               if ((bufpos - (char *)buf) + sizeof(u32) <= len) {
+                                                       if (is_unsigned)
+                                                               *(u32 *)bufpos = (u32)strtoul(s, &s, 10);
+                                                       else
+                                                               *(s32 *)bufpos = (s32)strtol(s, &s, 10);
+                                               }
+                                               bufpos += sizeof(u32);
+                                       } else if (width == 64) {
+                                               bufpos += PADDING(bufpos, u64);
+                                               if ((bufpos - (char *)buf) + sizeof(u64) <= len) {
+                                                       if (is_unsigned)
+                                                               *(u64 *)bufpos = (u64)strtoull(s, &s, 10);
+                                                       else
+                                                               *(s64 *)bufpos = (s64)strtoll(s, &s, 10);
+                                               }
+                                               bufpos += sizeof(u64);
+                                       }
+                                       s = strchr(s, ',');
+                                       break;
+                               case 'b':
+                                       snext = strchr(s, ',');
+                                       if (snext)
+                                               *snext++ = 0;
+
+                                       bufpos += PADDING(bufpos, bool);
+                                       if ((bufpos - (char *)buf) + sizeof(bool) <= len)
+                                               *(bool *)bufpos = is_yes(std::string(s));
+                                       bufpos += sizeof(bool);
+
+                                       s = snext;
+                                       break;
+                               case 'f':
+                                       bufpos += PADDING(bufpos, float);
+                                       if ((bufpos - (char *)buf) + sizeof(float) <= len)
+                                               *(float *)bufpos = strtof(s, &s);
+                                       bufpos += sizeof(float);
+
+                                       s = strchr(s, ',');
+                                       break;
+                               case 's':
+                                       while (*s == ' ' || *s == '\t')
+                                               s++;
+                                       if (*s++ != '"') //error, expected string
+                                               goto fail;
+                                       snext = s;
+
+                                       while (snext[0] && !(snext[-1] != '\\' && snext[0] == '"'))
+                                               snext++;
+                                       *snext++ = 0;
+
+                                       bufpos += PADDING(bufpos, std::string *);
+
+                                       str = new std::string(s);
+                                       pos = 0;
+                                       while ((pos = str->find("\\\"", pos)) != std::string::npos)
+                                               str->erase(pos, 1);
+
+                                       if ((bufpos - (char *)buf) + sizeof(std::string *) <= len)
+                                               *(std::string **)bufpos = str;
+                                       bufpos += sizeof(std::string *);
+                                       strs_alloced.push_back(str);
+
+                                       s = *snext ? snext + 1 : NULL;
+                                       break;
+                               case 'v':
+                                       while (*s == ' ' || *s == '\t')
+                                               s++;
+                                       if (*s++ != '(') //error, expected vector
+                                               goto fail;
+
+                                       if (width == 2) {
+                                               bufpos += PADDING(bufpos, v2f);
+
+                                               if ((bufpos - (char *)buf) + sizeof(v2f) <= len) {
+                                               v2f *v = (v2f *)bufpos;
+                                                       v->X = strtof(s, &s);
+                                                       s++;
+                                                       v->Y = strtof(s, &s);
+                                               }
+
+                                               bufpos += sizeof(v2f);
+                                       } else if (width == 3) {
+                                               bufpos += PADDING(bufpos, v3f);
+                                               if ((bufpos - (char *)buf) + sizeof(v3f) <= len) {
+                                                       v3f *v = (v3f *)bufpos;
+                                                       v->X = strtof(s, &s);
+                                                       s++;
+                                                       v->Y = strtof(s, &s);
+                                                       s++;
+                                                       v->Z = strtof(s, &s);
+                                               }
+
+                                               bufpos += sizeof(v3f);
+                                       }
+                                       s = strchr(s, ',');
+                                       break;
+                               default: //error, invalid format specifier
+                                       goto fail;
+                       }
+
+                       if (s && *s == ',')
+                               s++;
+
+                       if ((size_t)(bufpos - (char *)buf) > len) //error, buffer too small
+                               goto fail;
+               }
+
+               if (f && *f) { //error, mismatched number of fields and values
+fail:
+                       for (unsigned int i = 0; i != strs_alloced.size(); i++)
+                               delete strs_alloced[i];
+                       delete buf;
+                       //delete[] buf;
+                       buf = NULL;
+               }
+
+               return buf;
+       }
+
+       bool setStruct(std::string name, std::string format, void *value)
+       {
+               char sbuf[2048];
+               int sbuflen = sizeof(sbuf) - 1;
+               sbuf[sbuflen] = 0;
+               std::string str;
+               int pos = 0;
+               size_t fpos;
+               char *f;
+
+               char *bufpos = (char *)value;
+               char *fmtpos, *fmt = &format[0];
+               while ((f = strtok_r(fmt, ",", &fmtpos))) {
+                       fmt = NULL;
+                       bool is_unsigned = false;
+                       int width = 0, nprinted = 0;
+                       char valtype = *f;
+
+                       width = (int)strtol(f + 1, &f, 10);
+                       if (width && valtype == 's')
+                               valtype = 'i';
+
+                       switch (valtype) {
+                               case 'u':
+                                       is_unsigned = true;
+                                       /* FALLTHROUGH */
+                               case 'i':
+                                       if (width == 16) {
+                                               bufpos += PADDING(bufpos, u16);
+                                               nprinted = snprintf(sbuf + pos, sbuflen,
+                                                                       is_unsigned ? "%u, " : "%d, ",
+                                                                       *((u16 *)bufpos));
+                                               bufpos += sizeof(u16);
+                                       } else if (width == 32) {
+                                               bufpos += PADDING(bufpos, u32);
+                                               nprinted = snprintf(sbuf + pos, sbuflen,
+                                                                       is_unsigned ? "%u, " : "%d, ",
+                                                                       *((u32 *)bufpos));
+                                               bufpos += sizeof(u32);
+                                       } else if (width == 64) {
+                                               bufpos += PADDING(bufpos, u64);
+                                               nprinted = snprintf(sbuf + pos, sbuflen,
+                                                                       is_unsigned ? "%llu, " : "%lli, ",
+                                                                       (unsigned long long)*((u64 *)bufpos));
+                                               bufpos += sizeof(u64);
+                                       }
+                                       break;
+                               case 'b':
+                                       bufpos += PADDING(bufpos, bool);
+                                       nprinted = snprintf(sbuf + pos, sbuflen, "%s, ",
+                                                                               *((bool *)bufpos) ? "true" : "false");
+                                       bufpos += sizeof(bool);
+                                       break;
+                               case 'f':
+                                       bufpos += PADDING(bufpos, float);
+                                       nprinted = snprintf(sbuf + pos, sbuflen, "%f, ",
+                                                                               *((float *)bufpos));
+                                       bufpos += sizeof(float);
+                                       break;
+                               case 's':
+                                       bufpos += PADDING(bufpos, std::string *);
+                                       str = **((std::string **)bufpos);
+
+                                       fpos = 0;
+                                       while ((fpos = str.find('"', fpos)) != std::string::npos) {
+                                               str.insert(fpos, 1, '\\');
+                                               fpos += 2;
+                                       }
+
+                                       nprinted = snprintf(sbuf + pos, sbuflen, "\"%s\", ",
+                                                                               (*((std::string **)bufpos))->c_str());
+                                       bufpos += sizeof(std::string *);
+                                       break;
+                               case 'v':
+                                       if (width == 2) {
+                                               bufpos += PADDING(bufpos, v2f);
+                                               v2f *v = (v2f *)bufpos;
+                                               nprinted = snprintf(sbuf + pos, sbuflen,
+                                                                                       "(%f, %f), ", v->X, v->Y);
+                                               bufpos += sizeof(v2f);
+                                       } else {
+                                               bufpos += PADDING(bufpos, v3f);
+                                               v3f *v = (v3f *)bufpos;
+                                               nprinted = snprintf(sbuf + pos, sbuflen,
+                                                                                       "(%f, %f, %f), ", v->X, v->Y, v->Z);
+                                               bufpos += sizeof(v3f);
+                                       }
+                                       break;
+                               default:
+                                       return false;
+                       }
+                       if (nprinted < 0) //error, buffer too small
+                               return false;
+                       pos     += nprinted;
+                       sbuflen -= nprinted;
+               }
+
+               if (pos >= 2)
+                       sbuf[pos - 2] = 0;
+
+               set(name, std::string(sbuf));
+               return true;
+       }
+
        void setBool(std::string name, bool value)
        {
                if(value)
@@ -525,11 +840,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));
@@ -549,6 +859,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;
@@ -559,7 +879,7 @@ class Settings
        void clear()
        {
                JMutexAutoLock lock(m_mutex);
-               
+
                m_settings.clear();
                m_defaults.clear();
        }
@@ -567,7 +887,7 @@ class Settings
        void updateValue(Settings &other, const std::string &name)
        {
                JMutexAutoLock lock(m_mutex);
-               
+
                if(&other == this)
                        return;
 
@@ -584,7 +904,7 @@ class Settings
        {
                JMutexAutoLock lock(m_mutex);
                JMutexAutoLock lock2(other.m_mutex);
-               
+
                if(&other == this)
                        return;
 
@@ -594,7 +914,7 @@ class Settings
                {
                        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++)
@@ -609,7 +929,7 @@ class Settings
        {
                JMutexAutoLock lock(m_mutex);
                JMutexAutoLock lock2(other.m_mutex);
-               
+
                if(&other == this)
                        return *this;
 
@@ -620,7 +940,7 @@ class Settings
                        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++)
@@ -637,13 +957,13 @@ class Settings
        {
                JMutexAutoLock lock(m_mutex);
                JMutexAutoLock lock2(other.m_mutex);
-               
+
                if(&other == this)
                        return *this;
 
                clear();
                (*this) += other;
-               
+
                return *this;
        }