X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=src%2Fsettings.h;h=89f7589dfddc1bd40932133009ba1c52d6be25e1;hb=4a57ef12a163f9792a8822b6e1a2bd9dca4f86fb;hp=bfe7dd5a455487fef1cd92f7932df2f73d6e474c;hpb=2ae5d3f3abc7ac5ee96c4dfc7eeead045fdc775e;p=minetest.git diff --git a/src/settings.h b/src/settings.h index bfe7dd5a4..89f7589df 100644 --- a/src/settings.h +++ b/src/settings.h @@ -21,792 +21,201 @@ with this program; if not, write to the Free Software Foundation, Inc., #define SETTINGS_HEADER #include "irrlichttypes_bloated.h" -#include "exceptions.h" -#include -#include "jthread/jmutex.h" -#include "jthread/jmutexautolock.h" -#include "strfnd.h" -#include -#include -#include -#include "debug.h" -#include "log.h" #include "util/string.h" -#include "util/serialize.h" -#include +#include "jthread/jmutex.h" +#include #include +#include #include -#include "filesys.h" -#include -enum ValueType -{ +class Settings; +struct NoiseParams; + +/** function type to register a changed callback */ +typedef void (*setting_changed_callback)(const std::string); + +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() - { - } - - void writeLines(std::ostream &os) const - { - JMutexAutoLock lock(m_mutex); - - for(std::map::const_iterator - i = m_settings.begin(); - i != m_settings.end(); ++i) - { - std::string name = i->first; - std::string value = i->second; - os< getNames() const - { - std::vector names; - for(std::map::const_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) +struct SettingsEntry { + SettingsEntry() { - 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, - std::set &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) != m_settings.end()) - { - std::string newvalue = m_settings[name]; - - if(newvalue != value) - { - infostream<<"Changing value of \""< \""< objects; - std::set 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: \"" - <::const_iterator - i = m_settings.begin(); - i != m_settings.end(); ++i) - { - 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 "<::const_iterator - i = objects.begin(); - i != objects.end(); ++i) - { - ss<<(*i); - } - - /* - Write stuff that was not already in the file - */ - for(std::map::const_iterator - i = m_settings.begin(); - i != m_settings.end(); ++i) - { - if(updated.find(i->first) != updated.end()) - continue; - std::string name = i->first; - std::string value = i->second; - 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."<::iterator n; - n = allowed_options.find(name); - if(n == allowed_options.end()) - { - errorstream<<"Unknown command-line parameter \"" - <second.type; - - std::string value = ""; - - if(type == VALUETYPE_FLAG) - { - value = "true"; - } - else - { - if(i >= argc) - { - errorstream<<"Invalid command-line parameter \"" - <::const_iterator n; - if ((n = m_settings.find(name)) == m_settings.end()) - if ((n = m_defaults.find(name)) == m_defaults.end()) - throw SettingNotFoundException(("Setting [" + name + "] not found ").c_str()); - - return n->second; - } - - //////////// Get setting - bool getBool(const std::string &name) const - { - return is_yes(get(name)); - } - - bool getFlag(const std::string &name) const - { - try { - return getBool(name); - } catch(SettingNotFoundException &e) { - return false; - } - } - - float getFloat(const std::string &name) const - { - return stof(get(name)); - } - - u16 getU16(const std::string &name) const - { - return stoi(get(name), 0, 65535); - } - - s16 getS16(const std::string &name) const - { - return stoi(get(name), -32768, 32767); - } - - s32 getS32(const std::string &name) const - { - return stoi(get(name)); - } - - v3f getV3F(const std::string &name) const - { - v3f value; - Strfnd f(get(name)); - f.next("("); - value.X = stof(f.next(",")); - value.Y = stof(f.next(",")); - value.Z = stof(f.next(")")); - return value; - } - - v2f getV2F(const std::string &name) const - { - v2f value; - Strfnd f(get(name)); - f.next("("); - value.X = stof(f.next(",")); - value.Y = stof(f.next(")")); - return value; - } - - u64 getU64(const std::string &name) const - { - u64 value = 0; - std::string s = get(name); - std::istringstream ss(s); - ss >> value; - return value; - } - + std::map &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 - { - std::string val = get(name); - return std::isdigit(val[0]) - ? stoi(val) - : readFlagString(val, flagdesc, flagmask); - } - + 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 - { - 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(const std::string &name, std::string &val) const - { - try { - val = get(name); - return true; - } catch (SettingNotFoundException &e) { - return false; - } - } + 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 - { - try { - u32 flags, flagmask; - - flags = getFlagStr(name, flagdesc, &flagmask); - - val &= ~flagmask; - val |= flags; - - return true; - } catch (SettingNotFoundException &e) { - return false; - } - } - - bool getFloatNoEx(const std::string &name, float &val) const - { - try { - val = getFloat(name); - return true; - } catch (SettingNotFoundException &e) { - return false; - } - } - - bool getU16NoEx(const std::string &name, int &val) const - { - try { - val = getU16(name); - return true; - } catch (SettingNotFoundException &e) { - return false; - } - } - - bool getU16NoEx(const std::string &name, u16 &val) const - { - try { - val = getU16(name); - return true; - } catch (SettingNotFoundException &e) { - return false; - } - } - - bool getS16NoEx(const std::string &name, int &val) const - { - try { - val = getU16(name); - return true; - } catch (SettingNotFoundException &e) { - return false; - } - } - - bool getS16NoEx(const std::string &name, s16 &val) const - { - try { - val = getS16(name); - return true; - } catch (SettingNotFoundException &e) { - return false; - } - } - - bool getS32NoEx(const std::string &name, s32 &val) const - { - try { - val = getS32(name); - return true; - } catch (SettingNotFoundException &e) { - return false; - } - } - - bool getV3FNoEx(const std::string &name, v3f &val) const - { - try { - val = getV3F(name); - return true; - } catch (SettingNotFoundException &e) { - return false; - } - } - - bool getV2FNoEx(const std::string &name, v2f &val) const - { - try { - val = getV2F(name); - return true; - } catch (SettingNotFoundException &e) { - return false; - } - } - - bool getU64NoEx(const std::string &name, u64 &val) const - { - try { - val = getU64(name); - return true; - } catch (SettingNotFoundException &e) { - return false; - } - } - - //////////// Set setting - + 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) - { - std::string structstr; - if (!serializeStructToString(&structstr, format, value)) - return false; - - set(name, structstr); - return true; - } - - void setFlagStr(const std::string &name, u32 flags, - const FlagDesc *flagdesc, u32 flagmask) - { - set(name, writeFlagString(flags, flagdesc, flagmask)); - } - - void setBool(const std::string &name, bool value) - { - set(name, value ? "true" : "false"); - } - - void setFloat(const std::string &name, float value) - { - set(name, ftos(value)); - } - - void setV3F(const std::string &name, v3f value) - { - std::ostringstream os; - os<<"("< m_settings; - std::map m_defaults; + std::map m_settings; + std::map m_defaults; + std::map > m_callbacks; // All methods that access m_settings/m_defaults directly should lock this. mutable JMutex m_mutex; };