X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=src%2Fsettings.h;h=80d41fd790f18b5c66a387a577c5ea0e2702f04f;hb=d494733839e9cf6cb557462326ed21e7a58816c7;hp=57325ebe50e651b1d323b3a6c8f706087c910a42;hpb=45cf32afc5554d76f7f48268a8cab5a051638761;p=minetest.git diff --git a/src/settings.h b/src/settings.h index 57325ebe5..80d41fd79 100644 --- a/src/settings.h +++ b/src/settings.h @@ -1,6 +1,6 @@ /* -Minetest-c55 -Copyright (C) 2010-2011 celeron55, Perttu Ahola +Minetest +Copyright (C) 2010-2013 celeron55, Perttu Ahola 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 @@ -21,955 +21,213 @@ with this program; if not, write to the Free Software Foundation, Inc., #define SETTINGS_HEADER #include "irrlichttypes_bloated.h" -#include -#include -#include -#include -#include "strfnd.h" -#include -#include -#include -#include "debug.h" -#include "log.h" #include "util/string.h" +#include "threading/mutex.h" +#include +#include +#include +#include + +class Settings; +struct NoiseParams; -enum ValueType -{ +// Global objects +extern Settings *g_settings; +extern std::string g_settings_path; + +/** function type to register a changed callback */ +typedef void (*setting_changed_callback)(const std::string &name, void *data); + +enum ValueType { VALUETYPE_STRING, VALUETYPE_FLAG // Doesn't take any arguments }; -struct ValueSpec -{ +enum SettingsParseEvent { + SPE_NONE, + SPE_INVALID, + SPE_COMMENT, + SPE_KVPAIR, + SPE_END, + SPE_GROUP, + SPE_MULTILINE, +}; + +struct ValueSpec { ValueSpec(ValueType a_type, const char *a_help=NULL) { type = a_type; help = a_help; } + ValueType type; const char *help; }; -class Settings -{ -public: - Settings() +struct SettingsEntry { + SettingsEntry() { - m_mutex.Init(); + group = NULL; + is_group = false; } - void writeLines(std::ostream &os) + SettingsEntry(const std::string &value_) { - JMutexAutoLock lock(m_mutex); - - for(core::map::Iterator - i = m_settings.getIterator(); - i.atEnd() == false; i++) - { - std::string name = i.getNode()->getKey(); - std::string value = i.getNode()->getValue(); - os< getNames(){ - std::vector names; - for(core::map::Iterator - i = m_settings.getIterator(); - i.atEnd() == false; i++) - { - std::string name = i.getNode()->getKey(); - names.push_back(name); - } - return names; + value = value_; + group = NULL; + is_group = false; } - // remove a setting - bool remove(const std::string& name) + SettingsEntry(Settings *group_) { - return m_settings.remove(name); + group = group_; + is_group = true; } + std::string value; + Settings *group; + bool is_group; +}; - 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; - - //infostream<<"trimmedline=\""< &dst, - core::map &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); - - std::string trimmedline = trim(line); - - std::string line_end = ""; - if(is.eof() == false) - line_end = "\n"; - - // Ignore empty lines and comments - if(trimmedline.size() == 0 || trimmedline[0] == '#') - { - dst.push_back(line+line_end); - return true; - } - - Strfnd sf(trim(line)); - - std::string name = sf.next("="); - name = trim(name); - - if(name == "") - { - 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 \""< \""< objects; - core::map updated; - bool something_actually_changed = false; - - // Read and modify stuff - { - std::ifstream is(filename); - if(is.good() == false) - { - infostream<<"updateConfigFile():" - " Error opening configuration file" - " for reading: \"" - <::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 "<::Iterator - i = objects.begin(); - i != objects.end(); i++) - { - os<<(*i); - } - - /* - Write stuff that was not already in the file - */ - for(core::map::Iterator - i = m_settings.getIterator(); - i.atEnd() == false; i++) - { - if(updated.find(i.getNode()->getKey())) - continue; - std::string name = i.getNode()->getKey(); - std::string value = i.getNode()->getValue(); - infostream<<"Adding \""< &allowed_options) - { - int nonopt_index = 0; - int i=1; - for(;;) - { - if(i >= argc) - break; - 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 \"" - < expected."<::Node *n; - n = allowed_options.find(name); - if(n == NULL) - { - errorstream<<"Unknown command-line parameter \"" - <getValue().type; - - std::string value = ""; - - if(type == VALUETYPE_FLAG) - { - value = "true"; - } - else - { - if(i >= argc) - { - errorstream<<"Invalid command-line parameter \"" - < &allowed_options); + bool parseConfigLines(std::istream &is, const std::string &end = ""); + void writeLines(std::ostream &os, u32 tab_depth=0) const; + + SettingsParseEvent parseConfigObject(const std::string &line, + const std::string &end, std::string &name, std::string &value); + bool updateConfigObject(std::istream &is, std::ostream &os, + const std::string &end, u32 tab_depth=0); + + static bool checkNameValid(const std::string &name); + static bool checkValueValid(const std::string &value); + static std::string sanitizeName(const std::string &name); + static std::string sanitizeValue(const std::string &value); + static std::string getMultiline(std::istream &is, size_t *num_lines=NULL); + static void printEntry(std::ostream &os, const std::string &name, + const SettingsEntry &entry, u32 tab_depth=0); + + /*********** + * Getters * + ***********/ + + const SettingsEntry &getEntry(const std::string &name) const; + Settings *getGroup(const std::string &name) const; + std::string get(const std::string &name) const; + bool getBool(const std::string &name) const; + u16 getU16(const std::string &name) const; + s16 getS16(const std::string &name) const; + s32 getS32(const std::string &name) const; + u64 getU64(const std::string &name) const; + float getFloat(const std::string &name) const; + v2f getV2F(const std::string &name) const; + v3f getV3F(const std::string &name) const; + u32 getFlagStr(const std::string &name, const FlagDesc *flagdesc, + u32 *flagmask) const; + // N.B. if getStruct() is used to read a non-POD aggregate type, + // the behavior is undefined. + bool getStruct(const std::string &name, const std::string &format, + void *out, size_t olen) const; + bool getNoiseParams(const std::string &name, NoiseParams &np) const; + bool getNoiseParamsFromValue(const std::string &name, NoiseParams &np) const; + bool getNoiseParamsFromGroup(const std::string &name, NoiseParams &np) const; + + // return all keys used + std::vector getNames() const; + bool exists(const std::string &name) const; + + + /*************************************** + * Getters that don't throw exceptions * + ***************************************/ + + bool getEntryNoEx(const std::string &name, SettingsEntry &val) const; + bool getGroupNoEx(const std::string &name, Settings *&val) const; + bool getNoEx(const std::string &name, std::string &val) const; + bool getFlag(const std::string &name) const; + bool getU16NoEx(const std::string &name, u16 &val) const; + bool getS16NoEx(const std::string &name, s16 &val) const; + bool getS32NoEx(const std::string &name, s32 &val) const; + bool getU64NoEx(const std::string &name, u64 &val) const; + bool getFloatNoEx(const std::string &name, float &val) const; + bool getV2FNoEx(const std::string &name, v2f &val) const; + bool getV3FNoEx(const std::string &name, v3f &val) const; + // 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(const std::string &name, u32 &val, FlagDesc *flagdesc) const; + + + /*********** + * Setters * + ***********/ + + // N.B. Groups not allocated with new must be set to NULL in the settings + // tree before object destruction. + bool setEntry(const std::string &name, const void *entry, + bool set_group, bool set_default); + bool set(const std::string &name, const std::string &value); + bool setDefault(const std::string &name, const std::string &value); + bool setGroup(const std::string &name, Settings *group); + bool setGroupDefault(const std::string &name, Settings *group); + bool setBool(const std::string &name, bool value); + bool setS16(const std::string &name, s16 value); + bool setU16(const std::string &name, u16 value); + bool setS32(const std::string &name, s32 value); + bool setU64(const std::string &name, u64 value); + bool setFloat(const std::string &name, float value); + bool setV2F(const std::string &name, v2f value); + bool setV3F(const std::string &name, v3f value); + bool setFlagStr(const std::string &name, u32 flags, + const FlagDesc *flagdesc, u32 flagmask); + bool setNoiseParams(const std::string &name, const NoiseParams &np, + bool set_default=false); + // N.B. if setStruct() is used to write a non-POD aggregate type, + // the behavior is undefined. + bool setStruct(const std::string &name, const std::string &format, void *value); - void set(std::string name, const char *value) - { - JMutexAutoLock lock(m_mutex); - - m_settings[name] = value; - } - - - 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::Node *n; - n = m_settings.find(name); - if(n == NULL) - { - n = m_defaults.find(name); - if(n == NULL) - { - throw SettingNotFoundException("Setting not found"); - } - } - - return n->getValue(); - } - - bool getBool(std::string name) - { - return is_yes(get(name)); - } - - bool getFlag(std::string name) - { - try - { - return getBool(name); - } - catch(SettingNotFoundException &e) - { - return false; - } - } - - // Asks if empty - bool getBoolAsk(std::string name, std::string question, bool def) - { - // If it is in settings - if(exists(name)) - return getBool(name); - - std::string s; - char templine[10]; - std::cout<>value; - return value; - } - -template struct alignment_trick { char c; T member; }; -#define ALIGNOF(type) offsetof (alignment_trick, member) -#define PADDING(x, y) ((ALIGNOF(y) - ((uintptr_t)(x) & (ALIGNOF(y) - 1))) & (ALIGNOF(y) - 1)) -typedef int64_t s64; - - void *getStruct(std::string &name, std::string format, size_t len) - { - std::vector strs_alloced; - std::string *str; - char *s = &(get(name))[0]; - char *buf = new char[len]; - char *bufpos = buf; - char *f, *snext; - size_t pos; - - char *fmt = &format[0]; - while ((f = strsep(&fmt, ",")) && s) { - bool is_unsigned = false; - int width = 0; - char valtype = *f; - - width = (int)strtol(f + 1, &f, 10); - if (width && valtype == 's') - valtype = 'i'; - - switch (*f) { - case 'u': - is_unsigned = true; - /* FALLTHROUGH */ - case 'i': - if (width == 16) { - bufpos += PADDING(bufpos, u16); - if ((bufpos - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 ((bufpos - buf) > len) //error, buffer too small - goto fail; - } - - if (f && *f) { //error, mismatched number of fields and values -fail: - for (int i = 0; i != strs_alloced.size(); i++) - delete strs_alloced[i]; - 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; - - int nprinted; - char *bufpos = (char *)value; - char *fmt = &format[0]; - - while ((f = strsep(&fmt, ","))) { - 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); - 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, ", - *((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) - set(name, "true"); - else - set(name, "false"); - } - - void setFloat(std::string name, float value) - { - set(name, ftos(value)); - } - - void setV3F(std::string name, v3f value) - { - std::ostringstream os; - os<<"("<::Iterator - i = other.m_settings.getIterator(); - i.atEnd() == false; i++) - { - m_settings[i.getNode()->getKey()] = i.getNode()->getValue(); - } - - for(core::map::Iterator - i = other.m_defaults.getIterator(); - i.atEnd() == false; i++) - { - m_defaults[i.getNode()->getKey()] = i.getNode()->getValue(); - } - - return; - } + // remove a setting + bool remove(const std::string &name); + void clear(); + void clearDefaults(); + void updateValue(const Settings &other, const std::string &name); + void update(const Settings &other); + void registerChangedCallback(std::string name, setting_changed_callback cbf, void *userdata = NULL); + void deregisterChangedCallback(std::string name, setting_changed_callback cbf, void *userdata = NULL); - Settings & operator+=(Settings &other) - { - JMutexAutoLock lock(m_mutex); - JMutexAutoLock lock2(other.m_mutex); - - if(&other == this) - return *this; - - for(core::map::Iterator - i = other.m_settings.getIterator(); - i.atEnd() == false; i++) - { - m_settings.insert(i.getNode()->getKey(), - i.getNode()->getValue()); - } - - for(core::map::Iterator - i = other.m_defaults.getIterator(); - i.atEnd() == false; i++) - { - m_defaults.insert(i.getNode()->getKey(), - i.getNode()->getValue()); - } - - return *this; +private: - } + void updateNoLock(const Settings &other); + void clearNoLock(); + void clearDefaultsNoLock(); - Settings & operator=(Settings &other) - { - JMutexAutoLock lock(m_mutex); - JMutexAutoLock lock2(other.m_mutex); + void doCallbacks(std::string name); - if(&other == this) - return *this; + std::map m_settings; + std::map m_defaults; - clear(); - (*this) += other; + std::map > > m_callbacks; - return *this; - } + mutable Mutex m_callbackMutex; + mutable Mutex m_mutex; // All methods that access m_settings/m_defaults directly should lock this. -private: - core::map m_settings; - core::map m_defaults; - // All methods that access m_settings/m_defaults directly should lock this. - JMutex m_mutex; }; #endif