X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=src%2Fsettings.h;h=0c9a155db4f0ac258259166a13f8a3311490db65;hb=6ccb5835ff55d85156be91473c598eca9d6cb9a6;hp=c08d54a4713ad3c696640ee5e1542f651f189040;hpb=b485fac33ef961fb5725f3ae34520ee3b2f0339b;p=dragonfireclient.git diff --git a/src/settings.h b/src/settings.h index c08d54a47..0c9a155db 100644 --- a/src/settings.h +++ b/src/settings.h @@ -1,683 +1,252 @@ /* -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 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. */ -#ifndef SETTINGS_HEADER -#define SETTINGS_HEADER +#pragma once -#include "common_irrlicht.h" +#include "irrlichttypes_bloated.h" +#include "util/string.h" #include -#include -#include -#include -#include "strfnd.h" -#include -#include -#include -#include "debug.h" -#include "utility.h" -#include "log.h" - -enum ValueType -{ +#include +#include +#include + +class Settings; +struct NoiseParams; + +// Global objects +extern Settings *g_settings; +extern std::string g_settings_path; + +// Type for a settings changed callback function +typedef void (*SettingsChangedCallback)(const std::string &name, void *data); + +typedef std::vector< + std::pair< + SettingsChangedCallback, + void * + > +> SettingsCallbackList; + +typedef std::unordered_map SettingsCallbackMap; + +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() - { - m_mutex.Init(); - } +struct SettingsEntry { + SettingsEntry() = default; - void writeLines(std::ostream &os) - { - 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< SettingEntries; - /* - 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. - key of updated is setting name, value of updated is dummy. - - Returns false on EOF - */ - bool getUpdatedConfigObject(std::istream &is, - core::list &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 i=1; - for(;;) - { - if(i >= argc) - break; - std::string argname = argv[i]; - if(argname.substr(0, 2) != "--") - { - 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 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; + const SettingsEntry &getEntryDefault(const std::string &name) const; + Settings *getGroup(const std::string &name) const; + const std::string &get(const std::string &name) const; + const std::string &getDefault(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; + u32 getU32(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 getEntryDefaultNoEx(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 getDefaultNoEx(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; + + // Like other getters, but handling each flag individualy: + // 1) Read default flags (or 0) + // 2) Override using user-defined flags + bool getFlagStrNoEx(const std::string &name, u32 &val, + const 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 = nullptr, u32 flagmask = U32_MAX); + 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); + + // 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); + + /************** + * Miscellany * + **************/ + + void setDefault(const std::string &name, const FlagDesc *flagdesc, u32 flags); + // Takes the provided setting values and uses them as new defaults + void overrideDefaults(Settings *other); + const FlagDesc *getFlagDescFallback(const std::string &name) const; + + void registerChangedCallback(const std::string &name, + SettingsChangedCallback cbf, void *userdata = NULL); + void deregisterChangedCallback(const std::string &name, + SettingsChangedCallback cbf, void *userdata = NULL); - 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) - { - infostream<<"Settings: Setting not found: \"" - <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; - } - - void setBool(std::string name, bool value) - { - if(value) - set(name, "true"); - else - 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)); - } - - 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; - } - - 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; + SettingEntries m_settings; + SettingEntries m_defaults; + std::unordered_map m_flags; - } + SettingsCallbackMap m_callbacks; - Settings & operator=(Settings &other) - { - JMutexAutoLock lock(m_mutex); - JMutexAutoLock lock2(other.m_mutex); - - if(&other == this) - return *this; - - clear(); - (*this) += other; - - return *this; - } + mutable std::mutex m_callback_mutex; -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 + mutable std::mutex m_mutex; +};