]> git.lizzy.rs Git - minetest.git/blobdiff - src/settings.cpp
Small fixes of minetest.has_feature
[minetest.git] / src / settings.cpp
index 09b413ed0a9ec30d3805ec79ae1bb68a3bbf4426..e1e01e81a28518bfc61836273477138796a52a6c 100644 (file)
@@ -20,7 +20,7 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #include "settings.h"
 #include "irrlichttypes_bloated.h"
 #include "exceptions.h"
-#include "jthread/jmutexautolock.h"
+#include "threading/mutex_auto_lock.h"
 #include "strfnd.h"
 #include <iostream>
 #include <fstream>
@@ -33,12 +33,13 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #include <cctype>
 #include <algorithm>
 
+static Settings main_settings;
+Settings *g_settings = &main_settings;
+std::string g_settings_path;
 
 Settings::~Settings()
 {
-       std::map<std::string, SettingsEntry>::const_iterator it;
-       for (it = m_settings.begin(); it != m_settings.end(); ++it)
-               delete it->second.group;
+       clear();
 }
 
 
@@ -55,8 +56,8 @@ Settings & Settings::operator = (const Settings &other)
        if (&other == this)
                return *this;
 
-       JMutexAutoLock lock(m_mutex);
-       JMutexAutoLock lock2(other.m_mutex);
+       MutexAutoLock lock(m_mutex);
+       MutexAutoLock lock2(other.m_mutex);
 
        clearNoLock();
        updateNoLock(other);
@@ -65,13 +66,54 @@ Settings & Settings::operator = (const Settings &other)
 }
 
 
-std::string Settings::sanitizeString(const std::string &value)
+bool Settings::checkNameValid(const std::string &name)
+{
+       bool valid = name.find_first_of("=\"{}#") == std::string::npos;
+       if (valid) valid = trim(name) == name;
+       if (!valid) {
+               errorstream << "Invalid setting name \"" << name << "\""
+                       << std::endl;
+               return false;
+       }
+       return true;
+}
+
+
+bool Settings::checkValueValid(const std::string &value)
+{
+       if (value.substr(0, 3) == "\"\"\"" ||
+               value.find("\n\"\"\"") != std::string::npos) {
+               errorstream << "Invalid character sequence '\"\"\"' found in"
+                       " setting value!" << std::endl;
+               return false;
+       }
+       return true;
+}
+
+
+std::string Settings::sanitizeName(const std::string &name)
+{
+       std::string n = trim(name);
+
+       for (const char *s = "=\"{}#"; *s; s++)
+               n.erase(std::remove(n.begin(), n.end(), *s), n.end());
+
+       return n;
+}
+
+
+std::string Settings::sanitizeValue(const std::string &value)
 {
-       std::string str = value;
-       for (const char *s = "\t\n\v\f\r\b =\""; *s; s++)
-               str.erase(std::remove(str.begin(), str.end(), *s), str.end());
+       std::string v(value);
+       size_t p = 0;
+
+       if (v.substr(0, 3) == "\"\"\"")
+               v.erase(0, 3);
+
+       while ((p = v.find("\n\"\"\"")) != std::string::npos)
+               v.erase(p, 4);
 
-       return str;
+       return v;
 }
 
 
@@ -101,9 +143,19 @@ std::string Settings::getMultiline(std::istream &is, size_t *num_lines)
 }
 
 
+bool Settings::readConfigFile(const char *filename)
+{
+       std::ifstream is(filename);
+       if (!is.good())
+               return false;
+
+       return parseConfigLines(is, "");
+}
+
+
 bool Settings::parseConfigLines(std::istream &is, const std::string &end)
 {
-       JMutexAutoLock lock(m_mutex);
+       MutexAutoLock lock(m_mutex);
 
        std::string line, name, value;
 
@@ -122,11 +174,12 @@ bool Settings::parseConfigLines(std::istream &is, const std::string &end)
                case SPE_END:
                        return true;
                case SPE_GROUP: {
-                       Settings *branch = new Settings;
-                       if (!branch->parseConfigLines(is, "}"))
+                       Settings *group = new Settings;
+                       if (!group->parseConfigLines(is, "}")) {
+                               delete group;
                                return false;
-
-                       m_settings[name] = SettingsEntry(branch);
+                       }
+                       m_settings[name] = SettingsEntry(group);
                        break;
                }
                case SPE_MULTILINE:
@@ -139,19 +192,9 @@ bool Settings::parseConfigLines(std::istream &is, const std::string &end)
 }
 
 
-bool Settings::readConfigFile(const char *filename)
-{
-       std::ifstream is(filename);
-       if (!is.good())
-               return false;
-
-       return parseConfigLines(is, "");
-}
-
-
 void Settings::writeLines(std::ostream &os, u32 tab_depth) const
 {
-       JMutexAutoLock lock(m_mutex);
+       MutexAutoLock lock(m_mutex);
 
        for (std::map<std::string, SettingsEntry>::const_iterator
                        it = m_settings.begin();
@@ -160,99 +203,28 @@ void Settings::writeLines(std::ostream &os, u32 tab_depth) const
 }
 
 
-bool Settings::printEntry(std::ostream &os, const std::string &name,
+void Settings::printEntry(std::ostream &os, const std::string &name,
        const SettingsEntry &entry, u32 tab_depth)
 {
-       bool printed = false;
-
-       if (!entry.group || entry.value != "") {
-               printValue(os, name, entry.value, tab_depth);
-               printed = true;
-       }
-
-       if (entry.group) {
-               printGroup(os, name, entry.group, tab_depth);
-               printed = true;
-       }
-
-       return printed;
-}
-
-
-
-void Settings::printValue(std::ostream &os, const std::string &name,
-       const std::string &value, u32 tab_depth)
-{
-       for (u32 i = 0; i != tab_depth; i++)
-               os << "\t";
-       os << name << " = ";
-
-       if (value.find('\n') != std::string::npos)
-               os << "\"\"\"\n" << value << "\n\"\"\"\n";
-       else
-               os << value << "\n";
-}
-
-
-void Settings::printGroup(std::ostream &os, const std::string &name,
-       const Settings *group, u32 tab_depth)
-{
-       // Recursively write group contents
-       for (u32 i = 0; i != tab_depth; i++)
-               os << "\t";
-
-       os << name << " = {\n";
-       group->writeLines(os, tab_depth + 1);
-
        for (u32 i = 0; i != tab_depth; i++)
                os << "\t";
 
-       os << "}\n";
-}
-
+       if (entry.is_group) {
+               os << name << " = {\n";
 
-void Settings::getNamesPresent(std::istream &is, const std::string &end,
-       std::set<std::string> &present_values, std::set<std::string> &present_groups)
-{
-       std::string name, value, line;
-       bool end_found = false;
-       int depth = 0;
-       size_t old_pos = is.tellg();
+               entry.group->writeLines(os, tab_depth + 1);
 
-       while (is.good() && !end_found) {
-               std::getline(is, line);
-               SettingsParseEvent event = parseConfigObject(line,
-                       depth ? "}" : end, name, value);
+               for (u32 i = 0; i != tab_depth; i++)
+                       os << "\t";
+               os << "}\n";
+       } else {
+               os << name << " = ";
 
-               switch (event) {
-               case SPE_END:
-                       if (depth == 0)
-                               end_found = true;
-                       else
-                               depth--;
-                       break;
-               case SPE_MULTILINE:
-                       while (is.good() && line != "\"\"\"")
-                               std::getline(is, line);
-                       /* FALLTHROUGH */
-               case SPE_KVPAIR:
-                       if (depth == 0)
-                               present_values.insert(name);
-                       break;
-               case SPE_GROUP:
-                       if (depth == 0)
-                               present_groups.insert(name);
-                       depth++;
-                       break;
-               case SPE_NONE:
-               case SPE_COMMENT:
-               case SPE_INVALID:
-                       break;
-               }
+               if (entry.value.find('\n') != std::string::npos)
+                       os << "\"\"\"\n" << entry.value << "\n\"\"\"\n";
+               else
+                       os << entry.value << "\n";
        }
-
-       is.clear();
-       is.seekg(old_pos);
 }
 
 
@@ -260,13 +232,11 @@ bool Settings::updateConfigObject(std::istream &is, std::ostream &os,
        const std::string &end, u32 tab_depth)
 {
        std::map<std::string, SettingsEntry>::const_iterator it;
-       std::set<std::string> present_values, present_groups;
+       std::set<std::string> present_entries;
        std::string line, name, value;
        bool was_modified = false;
        bool end_found = false;
 
-       getNamesPresent(is, end, present_values, present_groups);
-
        // Add any settings that exist in the config file with the current value
        // in the object if existing
        while (is.good() && !end_found) {
@@ -283,48 +253,30 @@ bool Settings::updateConfigObject(std::istream &is, std::ostream &os,
                        /* FALLTHROUGH */
                case SPE_KVPAIR:
                        it = m_settings.find(name);
-                       if (it != m_settings.end() && value != it->second.value) {
-                               if (!it->second.group || it->second.value != "")
-                                       printValue(os, name, it->second.value, tab_depth);
+                       if (it != m_settings.end() &&
+                               (it->second.is_group || it->second.value != value)) {
+                               printEntry(os, name, it->second, tab_depth);
                                was_modified = true;
                        } else {
                                os << line << "\n";
                                if (event == SPE_MULTILINE)
                                        os << value << "\n\"\"\"\n";
                        }
-
-                       // If this value name has a group not in the file, print it
-                       if (it != m_settings.end() && it->second.group &&
-                                       present_groups.find(name) == present_groups.end()) {
-                               printGroup(os, name, it->second.group, tab_depth);
-                               was_modified = true;
-                       }
-
+                       present_entries.insert(name);
                        break;
-               case SPE_GROUP: {
-                       Settings *group = NULL;
+               case SPE_GROUP:
                        it = m_settings.find(name);
-                       if (it != m_settings.end())
-                               group = it->second.group;
-
-                       // If this group name has a non-blank value not in the file, print it
-                       if (it != m_settings.end() && it->second.value != "" &&
-                                       present_values.find(name) == present_values.end()) {
-                               printValue(os, name, it->second.value, tab_depth);
-                               was_modified = true;
-                       }
-
-                       os << line << "\n";
-
-                       if (group) {
-                               was_modified |= group->updateConfigObject(is, os, "}", tab_depth + 1);
+                       if (it != m_settings.end() && it->second.is_group) {
+                               os << line << "\n";
+                               sanity_check(it->second.group != NULL);
+                               was_modified |= it->second.group->updateConfigObject(is, os,
+                                       "}", tab_depth + 1);
                        } else {
-                               // If a group exists in the file but not memory, don't touch it
-                               Settings dummy_settings;
-                               dummy_settings.updateConfigObject(is, os, "}", tab_depth + 1);
+                               printEntry(os, name, it->second, tab_depth);
+                               was_modified = true;
                        }
+                       present_entries.insert(name);
                        break;
-               }
                default:
                        os << line << (is.eof() ? "" : "\n");
                        break;
@@ -333,11 +285,11 @@ bool Settings::updateConfigObject(std::istream &is, std::ostream &os,
 
        // Add any settings in the object that don't exist in the config file yet
        for (it = m_settings.begin(); it != m_settings.end(); ++it) {
-               if (present_values.find(it->first) != present_values.end() ||
-                       present_groups.find(it->first) != present_groups.end())
+               if (present_entries.find(it->first) != present_entries.end())
                        continue;
 
-               was_modified |= printEntry(os, it->first, it->second, tab_depth);
+               printEntry(os, it->first, it->second, tab_depth);
+               was_modified = true;
        }
 
        return was_modified;
@@ -346,7 +298,7 @@ bool Settings::updateConfigObject(std::istream &is, std::ostream &os,
 
 bool Settings::updateConfigFile(const char *filename)
 {
-       JMutexAutoLock lock(m_mutex);
+       MutexAutoLock lock(m_mutex);
 
        std::ifstream is(filename);
        std::ostringstream os(std::ios_base::binary);
@@ -427,7 +379,7 @@ bool Settings::parseCommandLine(int argc, char *argv[],
 
 const SettingsEntry &Settings::getEntry(const std::string &name) const
 {
-       JMutexAutoLock lock(m_mutex);
+       MutexAutoLock lock(m_mutex);
 
        std::map<std::string, SettingsEntry>::const_iterator n;
        if ((n = m_settings.find(name)) == m_settings.end()) {
@@ -440,16 +392,19 @@ const SettingsEntry &Settings::getEntry(const std::string &name) const
 
 Settings *Settings::getGroup(const std::string &name) const
 {
-       Settings *group = getEntry(name).group;
-       if (group == NULL)
+       const SettingsEntry &entry = getEntry(name);
+       if (!entry.is_group)
                throw SettingNotFoundException("Setting [" + name + "] is not a group.");
-       return group;
+       return entry.group;
 }
 
 
 std::string Settings::get(const std::string &name) const
 {
-       return getEntry(name).value;
+       const SettingsEntry &entry = getEntry(name);
+       if (entry.is_group)
+               throw SettingNotFoundException("Setting [" + name + "] is a group.");
+       return entry.value;
 }
 
 
@@ -571,7 +526,11 @@ bool Settings::getNoiseParamsFromValue(const std::string &name,
        f.next(",");
        np.seed     = stoi(f.next(","));
        np.octaves  = stoi(f.next(","));
-       np.persist  = stof(f.next(""));
+       np.persist  = stof(f.next(","));
+
+       std::string optional_params = f.next("");
+       if (optional_params != "")
+               np.lacunarity = stof(optional_params);
 
        return true;
 }
@@ -603,7 +562,7 @@ bool Settings::getNoiseParamsFromGroup(const std::string &name,
 
 bool Settings::exists(const std::string &name) const
 {
-       JMutexAutoLock lock(m_mutex);
+       MutexAutoLock lock(m_mutex);
 
        return (m_settings.find(name) != m_settings.end() ||
                m_defaults.find(name) != m_defaults.end());
@@ -772,110 +731,119 @@ bool Settings::getFlagStrNoEx(const std::string &name, u32 &val,
  * Setters *
  ***********/
 
-
-void Settings::set(const std::string &name, const std::string &value)
+bool Settings::setEntry(const std::string &name, const void *data,
+       bool set_group, bool set_default)
 {
+       Settings *old_group = NULL;
+
+       if (!checkNameValid(name))
+               return false;
+       if (!set_group && !checkValueValid(*(const std::string *)data))
+               return false;
+
        {
-               JMutexAutoLock lock(m_mutex);
+               MutexAutoLock lock(m_mutex);
+
+               SettingsEntry &entry = set_default ? m_defaults[name] : m_settings[name];
+               old_group = entry.group;
 
-               m_settings[name].value = value;
+               entry.value    = set_group ? "" : *(const std::string *)data;
+               entry.group    = set_group ? *(Settings **)data : NULL;
+               entry.is_group = set_group;
        }
-       doCallbacks(name);
+
+       delete old_group;
+
+       return true;
 }
 
 
-void Settings::setGroup(const std::string &name, Settings *group)
+bool Settings::set(const std::string &name, const std::string &value)
 {
-       Settings *old_group = NULL;
-       {
-               JMutexAutoLock lock(m_mutex);
+       if (!setEntry(name, &value, false, false))
+               return false;
 
-               old_group = m_settings[name].group;
-               m_settings[name].group = group;
-       }
-       delete old_group;
+       doCallbacks(name);
+       return true;
 }
 
 
-void Settings::setDefault(const std::string &name, const std::string &value)
+bool Settings::setDefault(const std::string &name, const std::string &value)
 {
-       JMutexAutoLock lock(m_mutex);
-
-       m_defaults[name].value = value;
+       return setEntry(name, &value, false, true);
 }
 
 
-void Settings::setGroupDefault(const std::string &name, Settings *group)
+bool Settings::setGroup(const std::string &name, Settings *group)
 {
-       Settings *old_group = NULL;
-       {
-               JMutexAutoLock lock(m_mutex);
+       return setEntry(name, &group, true, false);
+}
 
-               old_group = m_defaults[name].group;
-               m_defaults[name].group = group;
-       }
-       delete old_group;
+
+bool Settings::setGroupDefault(const std::string &name, Settings *group)
+{
+       return setEntry(name, &group, true, true);
 }
 
 
-void Settings::setBool(const std::string &name, bool value)
+bool Settings::setBool(const std::string &name, bool value)
 {
-       set(name, value ? "true" : "false");
+       return set(name, value ? "true" : "false");
 }
 
 
-void Settings::setS16(const std::string &name, s16 value)
+bool Settings::setS16(const std::string &name, s16 value)
 {
-       set(name, itos(value));
+       return set(name, itos(value));
 }
 
 
-void Settings::setU16(const std::string &name, u16 value)
+bool Settings::setU16(const std::string &name, u16 value)
 {
-       set(name, itos(value));
+       return set(name, itos(value));
 }
 
 
-void Settings::setS32(const std::string &name, s32 value)
+bool Settings::setS32(const std::string &name, s32 value)
 {
-       set(name, itos(value));
+       return set(name, itos(value));
 }
 
 
-void Settings::setU64(const std::string &name, u64 value)
+bool Settings::setU64(const std::string &name, u64 value)
 {
        std::ostringstream os;
        os << value;
-       set(name, os.str());
+       return set(name, os.str());
 }
 
 
-void Settings::setFloat(const std::string &name, float value)
+bool Settings::setFloat(const std::string &name, float value)
 {
-       set(name, ftos(value));
+       return set(name, ftos(value));
 }
 
 
-void Settings::setV2F(const std::string &name, v2f value)
+bool Settings::setV2F(const std::string &name, v2f value)
 {
        std::ostringstream os;
        os << "(" << value.X << "," << value.Y << ")";
-       set(name, os.str());
+       return set(name, os.str());
 }
 
 
-void Settings::setV3F(const std::string &name, v3f value)
+bool Settings::setV3F(const std::string &name, v3f value)
 {
        std::ostringstream os;
        os << "(" << value.X << "," << value.Y << "," << value.Z << ")";
-       set(name, os.str());
+       return set(name, os.str());
 }
 
 
-void Settings::setFlagStr(const std::string &name, u32 flags,
+bool Settings::setFlagStr(const std::string &name, u32 flags,
        const FlagDesc *flagdesc, u32 flagmask)
 {
-       set(name, writeFlagString(flags, flagdesc, flagmask));
+       return set(name, writeFlagString(flags, flagdesc, flagmask));
 }
 
 
@@ -886,12 +854,12 @@ bool Settings::setStruct(const std::string &name, const std::string &format,
        if (!serializeStructToString(&structstr, format, value))
                return false;
 
-       set(name, structstr);
-       return true;
+       return set(name, structstr);
 }
 
 
-void Settings::setNoiseParams(const std::string &name, const NoiseParams &np)
+bool Settings::setNoiseParams(const std::string &name,
+       const NoiseParams &np, bool set_default)
 {
        Settings *group = new Settings;
 
@@ -904,38 +872,37 @@ void Settings::setNoiseParams(const std::string &name, const NoiseParams &np)
        group->setFloat("lacunarity",  np.lacunarity);
        group->setFlagStr("flags",     np.flags, flagdesc_noiseparams, np.flags);
 
-       Settings *old_group;
-       {
-               JMutexAutoLock lock(m_mutex);
-
-               old_group = m_settings[name].group;
-               m_settings[name].group = group;
-               m_settings[name].value = "";
-       }
-       delete old_group;
+       return setEntry(name, &group, true, set_default);
 }
 
 
 bool Settings::remove(const std::string &name)
 {
-       JMutexAutoLock lock(m_mutex);
+       MutexAutoLock lock(m_mutex);
+
+       delete m_settings[name].group;
        return m_settings.erase(name);
 }
 
 
 void Settings::clear()
 {
-       JMutexAutoLock lock(m_mutex);
+       MutexAutoLock lock(m_mutex);
        clearNoLock();
 }
 
+void Settings::clearDefaults()
+{
+       MutexAutoLock lock(m_mutex);
+       clearDefaultsNoLock();
+}
 
 void Settings::updateValue(const Settings &other, const std::string &name)
 {
        if (&other == this)
                return;
 
-       JMutexAutoLock lock(m_mutex);
+       MutexAutoLock lock(m_mutex);
 
        try {
                std::string val = other.get(name);
@@ -951,8 +918,8 @@ void Settings::update(const Settings &other)
        if (&other == this)
                return;
 
-       JMutexAutoLock lock(m_mutex);
-       JMutexAutoLock lock2(other.m_mutex);
+       MutexAutoLock lock(m_mutex);
+       MutexAutoLock lock2(other.m_mutex);
 
        updateNoLock(other);
 }
@@ -995,32 +962,56 @@ void Settings::updateNoLock(const Settings &other)
 
 void Settings::clearNoLock()
 {
+       std::map<std::string, SettingsEntry>::const_iterator it;
+       for (it = m_settings.begin(); it != m_settings.end(); ++it)
+               delete it->second.group;
        m_settings.clear();
+
+       clearDefaultsNoLock();
+}
+
+void Settings::clearDefaultsNoLock()
+{
+       std::map<std::string, SettingsEntry>::const_iterator it;
+       for (it = m_defaults.begin(); it != m_defaults.end(); ++it)
+               delete it->second.group;
        m_defaults.clear();
 }
 
 
 void Settings::registerChangedCallback(std::string name,
-       setting_changed_callback cbf)
+       setting_changed_callback cbf, void *userdata)
 {
-       m_callbacks[name].push_back(cbf);
+       MutexAutoLock lock(m_callbackMutex);
+       m_callbacks[name].push_back(std::make_pair(cbf, userdata));
 }
 
+void Settings::deregisterChangedCallback(std::string name, setting_changed_callback cbf, void *userdata)
+{
+       MutexAutoLock lock(m_callbackMutex);
+       std::map<std::string, std::vector<std::pair<setting_changed_callback, void*> > >::iterator iterToVector = m_callbacks.find(name);
+       if (iterToVector != m_callbacks.end())
+       {
+               std::vector<std::pair<setting_changed_callback, void*> > &vector = iterToVector->second;
+
+               std::vector<std::pair<setting_changed_callback, void*> >::iterator position =
+                       std::find(vector.begin(), vector.end(), std::make_pair(cbf, userdata));
+
+               if (position != vector.end())
+                       vector.erase(position);
+       }
+}
 
 void Settings::doCallbacks(const std::string name)
 {
-       std::vector<setting_changed_callback> tempvector;
+       MutexAutoLock lock(m_callbackMutex);
+       std::map<std::string, std::vector<std::pair<setting_changed_callback, void*> > >::iterator iterToVector = m_callbacks.find(name);
+       if (iterToVector != m_callbacks.end())
        {
-               JMutexAutoLock lock(m_mutex);
-               if (m_callbacks.find(name) != m_callbacks.end())
+               std::vector<std::pair<setting_changed_callback, void*> >::iterator iter;
+               for (iter = iterToVector->second.begin(); iter != iterToVector->second.end(); ++iter)
                {
-                       tempvector = m_callbacks[name];
+                       (iter->first)(name, iter->second);
                }
        }
-
-       for (std::vector<setting_changed_callback>::iterator iter = tempvector.begin();
-                       iter != tempvector.end(); iter ++)
-       {
-               (*iter)(name);
-       }
 }