Fix bone-attached entities (#10015)
[oweals/minetest.git] / src / settings.cpp
index 8ea687d1c8b7cff41c7fb6c6490b3df9bd164477..55404319e8f9615a6f57b2ec5bdb42c9d41f38d6 100644 (file)
@@ -21,7 +21,7 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #include "irrlichttypes_bloated.h"
 #include "exceptions.h"
 #include "threading/mutex_auto_lock.h"
-#include "strfnd.h"
+#include "util/strfnd.h"
 #include <iostream>
 #include <fstream>
 #include <sstream>
@@ -69,7 +69,9 @@ Settings & Settings::operator = (const Settings &other)
 bool Settings::checkNameValid(const std::string &name)
 {
        bool valid = name.find_first_of("=\"{}#") == std::string::npos;
-       if (valid) valid = trim(name) == name;
+       if (valid)
+               valid = std::find_if(name.begin(), name.end(), ::isspace) == name.end();
+
        if (!valid) {
                errorstream << "Invalid setting name \"" << name << "\""
                        << std::endl;
@@ -90,33 +92,6 @@ bool Settings::checkValueValid(const std::string &value)
        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 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 v;
-}
-
-
 std::string Settings::getMultiline(std::istream &is, size_t *num_lines)
 {
        size_t lines = 1;
@@ -196,10 +171,8 @@ void Settings::writeLines(std::ostream &os, u32 tab_depth) const
 {
        MutexAutoLock lock(m_mutex);
 
-       for (std::map<std::string, SettingsEntry>::const_iterator
-                       it = m_settings.begin();
-                       it != m_settings.end(); ++it)
-               printEntry(os, it->first, it->second, tab_depth);
+       for (const auto &setting_it : m_settings)
+               printEntry(os, setting_it.first, setting_it.second, tab_depth);
 }
 
 
@@ -231,7 +204,7 @@ void Settings::printEntry(std::ostream &os, const std::string &name,
 bool Settings::updateConfigObject(std::istream &is, std::ostream &os,
        const std::string &end, u32 tab_depth)
 {
-       std::map<std::string, SettingsEntry>::const_iterator it;
+       SettingEntries::const_iterator it;
        std::set<std::string> present_entries;
        std::string line, name, value;
        bool was_modified = false;
@@ -254,9 +227,13 @@ bool Settings::updateConfigObject(std::istream &is, std::ostream &os,
                case SPE_KVPAIR:
                        it = m_settings.find(name);
                        if (it != m_settings.end() &&
-                               (it->second.is_group || it->second.value != value)) {
+                                       (it->second.is_group || it->second.value != value)) {
                                printEntry(os, name, it->second, tab_depth);
                                was_modified = true;
+                       } else if (it == m_settings.end()) {
+                               // Remove by skipping
+                               was_modified = true;
+                               break;
                        } else {
                                os << line << "\n";
                                if (event == SPE_MULTILINE)
@@ -271,6 +248,13 @@ bool Settings::updateConfigObject(std::istream &is, std::ostream &os,
                                sanity_check(it->second.group != NULL);
                                was_modified |= it->second.group->updateConfigObject(is, os,
                                        "}", tab_depth + 1);
+                       } else if (it == m_settings.end()) {
+                               // Remove by skipping
+                               was_modified = true;
+                               Settings removed_group; // Move 'is' to group end
+                               std::stringstream ss;
+                               removed_group.updateConfigObject(is, ss, "}", tab_depth + 1);
+                               break;
                        } else {
                                printEntry(os, name, it->second, tab_depth);
                                was_modified = true;
@@ -351,7 +335,7 @@ bool Settings::parseCommandLine(int argc, char *argv[],
 
                ValueType type = n->second.type;
 
-               std::string value = "";
+               std::string value;
 
                if (type == VALUETYPE_FLAG) {
                        value = "true";
@@ -381,7 +365,7 @@ const SettingsEntry &Settings::getEntry(const std::string &name) const
 {
        MutexAutoLock lock(m_mutex);
 
-       std::map<std::string, SettingsEntry>::const_iterator n;
+       SettingEntries::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.");
@@ -390,6 +374,18 @@ const SettingsEntry &Settings::getEntry(const std::string &name) const
 }
 
 
+const SettingsEntry &Settings::getEntryDefault(const std::string &name) const
+{
+       MutexAutoLock lock(m_mutex);
+
+       SettingEntries::const_iterator n;
+       if ((n = m_defaults.find(name)) == m_defaults.end()) {
+               throw SettingNotFoundException("Setting [" + name + "] not found.");
+       }
+       return n->second;
+}
+
+
 Settings *Settings::getGroup(const std::string &name) const
 {
        const SettingsEntry &entry = getEntry(name);
@@ -399,7 +395,7 @@ Settings *Settings::getGroup(const std::string &name) const
 }
 
 
-std::string Settings::get(const std::string &name) const
+const std::string &Settings::get(const std::string &name) const
 {
        const SettingsEntry &entry = getEntry(name);
        if (entry.is_group)
@@ -408,6 +404,15 @@ std::string Settings::get(const std::string &name) const
 }
 
 
+const std::string &Settings::getDefault(const std::string &name) const
+{
+       const SettingsEntry &entry = getEntryDefault(name);
+       if (entry.is_group)
+               throw SettingNotFoundException("Setting [" + name + "] is a group.");
+       return entry.value;
+}
+
+
 bool Settings::getBool(const std::string &name) const
 {
        return is_yes(get(name));
@@ -426,6 +431,11 @@ s16 Settings::getS16(const std::string &name) const
 }
 
 
+u32 Settings::getU32(const std::string &name) const
+{
+       return (u32) stoi(get(name));
+}
+
 s32 Settings::getS32(const std::string &name) const
 {
        return stoi(get(name));
@@ -474,12 +484,33 @@ v3f Settings::getV3F(const std::string &name) const
 u32 Settings::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 flags = 0;
+       u32 mask_default = 0;
+
+       std::string value;
+       // Read default value (if there is any)
+       if (getDefaultNoEx(name, value)) {
+               flags = std::isdigit(value[0])
+                       ? stoi(value)
+                       : readFlagString(value, flagdesc, &mask_default);
+       }
+
+       // Apply custom flags "on top"
+       value = get(name);
+       u32 flags_user;
+       u32 mask_user = U32_MAX;
+       flags_user = std::isdigit(value[0])
+               ? stoi(value) // Override default
+               : readFlagString(value, flagdesc, &mask_user);
 
+       flags &= ~mask_user;
+       flags |=  flags_user;
+
+       if (flagmask)
+               *flagmask = mask_default | mask_user;
+
+       return flags;
+}
 
 // N.B. if getStruct() is used to read a non-POD aggregate type,
 // the behavior is undefined.
@@ -529,7 +560,7 @@ bool Settings::getNoiseParamsFromValue(const std::string &name,
        np.persist  = stof(f.next(","));
 
        std::string optional_params = f.next("");
-       if (optional_params != "")
+       if (!optional_params.empty())
                np.lacunarity = stof(optional_params);
 
        return true;
@@ -572,10 +603,8 @@ bool Settings::exists(const std::string &name) const
 std::vector<std::string> Settings::getNames() const
 {
        std::vector<std::string> names;
-       for (std::map<std::string, SettingsEntry>::const_iterator
-                       i = m_settings.begin();
-                       i != m_settings.end(); ++i) {
-               names.push_back(i->first);
+       for (const auto &settings_it : m_settings) {
+               names.push_back(settings_it.first);
        }
        return names;
 }
@@ -597,6 +626,17 @@ bool Settings::getEntryNoEx(const std::string &name, SettingsEntry &val) const
 }
 
 
+bool Settings::getEntryDefaultNoEx(const std::string &name, SettingsEntry &val) const
+{
+       try {
+               val = getEntryDefault(name);
+               return true;
+       } catch (SettingNotFoundException &e) {
+               return false;
+       }
+}
+
+
 bool Settings::getGroupNoEx(const std::string &name, Settings *&val) const
 {
        try {
@@ -619,6 +659,17 @@ bool Settings::getNoEx(const std::string &name, std::string &val) const
 }
 
 
+bool Settings::getDefaultNoEx(const std::string &name, std::string &val) const
+{
+       try {
+               val = getDefault(name);
+               return true;
+       } catch (SettingNotFoundException &e) {
+               return false;
+       }
+}
+
+
 bool Settings::getFlag(const std::string &name) const
 {
        try {
@@ -706,19 +757,16 @@ bool Settings::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 Settings::getFlagStrNoEx(const std::string &name, u32 &val,
-       FlagDesc *flagdesc) const
+       const FlagDesc *flagdesc) const
 {
-       try {
-               u32 flags, flagmask;
-
-               flags = getFlagStr(name, flagdesc, &flagmask);
+       if (!flagdesc) {
+               if (!(flagdesc = getFlagDescFallback(name)))
+                       return false; // Not found
+       }
 
-               val &= ~flagmask;
-               val |=  flags;
+       try {
+               val = getFlagStr(name, flagdesc, nullptr);
 
                return true;
        } catch (SettingNotFoundException &e) {
@@ -843,6 +891,11 @@ bool Settings::setV3F(const std::string &name, v3f value)
 bool Settings::setFlagStr(const std::string &name, u32 flags,
        const FlagDesc *flagdesc, u32 flagmask)
 {
+       if (!flagdesc) {
+               if (!(flagdesc = getFlagDescFallback(name)))
+                       return false; // Not found
+       }
+
        return set(name, writeFlagString(flags, flagdesc, flagmask));
 }
 
@@ -878,16 +931,21 @@ bool Settings::setNoiseParams(const std::string &name,
 
 bool Settings::remove(const std::string &name)
 {
-       MutexAutoLock lock(m_mutex);
+       // Lock as short as possible, unlock before doCallbacks()
+       m_mutex.lock();
 
-       std::map<std::string, SettingsEntry>::iterator it = m_settings.find(name);
+       SettingEntries::iterator it = m_settings.find(name);
        if (it != m_settings.end()) {
                delete it->second.group;
                m_settings.erase(it);
+               m_mutex.unlock();
+
+               doCallbacks(name);
                return true;
-       } else {
-               return false;
        }
+
+       m_mutex.unlock();
+       return false;
 }
 
 
@@ -911,9 +969,7 @@ void Settings::updateValue(const Settings &other, const std::string &name)
        MutexAutoLock lock(m_mutex);
 
        try {
-               std::string val = other.get(name);
-
-               m_settings[name] = val;
+               m_settings[name] = other.get(name);
        } catch (SettingNotFoundException &e) {
        }
 }
@@ -968,8 +1024,9 @@ 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)
+
+       for (SettingEntries::const_iterator it = m_settings.begin();
+                       it != m_settings.end(); ++it)
                delete it->second.group;
        m_settings.clear();
 
@@ -978,46 +1035,81 @@ void Settings::clearNoLock()
 
 void Settings::clearDefaultsNoLock()
 {
-       std::map<std::string, SettingsEntry>::const_iterator it;
-       for (it = m_defaults.begin(); it != m_defaults.end(); ++it)
+       for (SettingEntries::const_iterator it = m_defaults.begin();
+                       it != m_defaults.end(); ++it)
                delete it->second.group;
        m_defaults.clear();
 }
 
+void Settings::setDefault(const std::string &name, const FlagDesc *flagdesc,
+       u32 flags)
+{
+       m_flags[name] = flagdesc;
+       setDefault(name, writeFlagString(flags, flagdesc, U32_MAX));
+}
 
-void Settings::registerChangedCallback(std::string name,
-       setting_changed_callback cbf, void *userdata)
+void Settings::overrideDefaults(Settings *other)
 {
-       MutexAutoLock lock(m_callbackMutex);
-       m_callbacks[name].push_back(std::make_pair(cbf, userdata));
+       for (const auto &setting : other->m_settings) {
+               if (setting.second.is_group) {
+                       setGroupDefault(setting.first, setting.second.group);
+                       continue;
+               }
+               const FlagDesc *flagdesc = getFlagDescFallback(setting.first);
+               if (flagdesc) {
+                       // Flags cannot be copied directly.
+                       // 1) Get the current set flags
+                       u32 flags = getFlagStr(setting.first, flagdesc, nullptr);
+                       // 2) Set the flags as defaults
+                       other->setDefault(setting.first, flagdesc, flags);
+                       // 3) Get the newly set flags and override the default setting value
+                       setDefault(setting.first, flagdesc,
+                               other->getFlagStr(setting.first, flagdesc, nullptr));
+                       continue;
+               }
+               // Also covers FlagDesc settings
+               setDefault(setting.first, setting.second.value);
+       }
 }
 
-void Settings::deregisterChangedCallback(std::string name, setting_changed_callback cbf, void *userdata)
+const FlagDesc *Settings::getFlagDescFallback(const std::string &name) const
 {
-       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;
+       auto it = m_flags.find(name);
+       return it == m_flags.end() ? nullptr : it->second;
+}
+
+void Settings::registerChangedCallback(const std::string &name,
+       SettingsChangedCallback cbf, void *userdata)
+{
+       MutexAutoLock lock(m_callback_mutex);
+       m_callbacks[name].emplace_back(cbf, userdata);
+}
 
-               std::vector<std::pair<setting_changed_callback, void*> >::iterator position =
-                       std::find(vector.begin(), vector.end(), std::make_pair(cbf, userdata));
+void Settings::deregisterChangedCallback(const std::string &name,
+       SettingsChangedCallback cbf, void *userdata)
+{
+       MutexAutoLock lock(m_callback_mutex);
+       SettingsCallbackMap::iterator it_cbks = m_callbacks.find(name);
 
-               if (position != vector.end())
-                       vector.erase(position);
+       if (it_cbks != m_callbacks.end()) {
+               SettingsCallbackList &cbks = it_cbks->second;
+
+               SettingsCallbackList::iterator position =
+                       std::find(cbks.begin(), cbks.end(), std::make_pair(cbf, userdata));
+
+               if (position != cbks.end())
+                       cbks.erase(position);
        }
 }
 
-void Settings::doCallbacks(const std::string name)
+void Settings::doCallbacks(const std::string &name) const
 {
-       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*> >::iterator iter;
-               for (iter = iterToVector->second.begin(); iter != iterToVector->second.end(); ++iter)
-               {
-                       (iter->first)(name, iter->second);
-               }
+       MutexAutoLock lock(m_callback_mutex);
+
+       SettingsCallbackMap::const_iterator it_cbks = m_callbacks.find(name);
+       if (it_cbks != m_callbacks.end()) {
+               SettingsCallbackList::const_iterator it;
+               for (it = it_cbks->second.begin(); it != it_cbks->second.end(); ++it)
+                       (it->first)(name, it->second);
        }
 }