#include "settings.h"
#include "irrlichttypes_bloated.h"
#include "exceptions.h"
-#include "jthread/jmutexautolock.h"
-#include "strfnd.h"
+#include "threading/mutex_auto_lock.h"
+#include "util/strfnd.h"
#include <iostream>
#include <fstream>
#include <sstream>
#include "log.h"
#include "util/serialize.h"
#include "filesys.h"
+#include "noise.h"
#include <cctype>
+#include <algorithm>
+Settings *g_settings = nullptr;
+static SettingsHierarchy g_hierarchy;
+std::string g_settings_path;
-Settings & Settings::operator += (const Settings &other)
+std::unordered_map<std::string, const FlagDesc *> Settings::s_flags;
+
+/* Settings hierarchy implementation */
+
+SettingsHierarchy::SettingsHierarchy(Settings *fallback)
{
- update(other);
+ layers.push_back(fallback);
+}
- return *this;
+
+Settings *SettingsHierarchy::getLayer(int layer) const
+{
+ if (layer < 0 || layer >= (int)layers.size())
+ throw BaseException("Invalid settings layer");
+ return layers[layer];
+}
+
+
+Settings *SettingsHierarchy::getParent(int layer) const
+{
+ assert(layer >= 0 && layer < (int)layers.size());
+ // iterate towards the origin (0) to find the next fallback layer
+ for (int i = layer - 1; i >= 0; --i) {
+ if (layers[i])
+ return layers[i];
+ }
+
+ return nullptr;
+}
+
+
+void SettingsHierarchy::onLayerCreated(int layer, Settings *obj)
+{
+ if (layer < 0)
+ throw BaseException("Invalid settings layer");
+ if ((int)layers.size() < layer + 1)
+ layers.resize(layer + 1);
+
+ Settings *&pos = layers[layer];
+ if (pos)
+ throw BaseException("Setting layer " + itos(layer) + " already exists");
+
+ pos = obj;
+ // This feels bad
+ if (this == &g_hierarchy && layer == (int)SL_GLOBAL)
+ g_settings = obj;
+}
+
+
+void SettingsHierarchy::onLayerRemoved(int layer)
+{
+ assert(layer >= 0 && layer < (int)layers.size());
+ layers[layer] = nullptr;
+ if (this == &g_hierarchy && layer == (int)SL_GLOBAL)
+ g_settings = nullptr;
+}
+
+/* Settings implementation */
+
+Settings *Settings::createLayer(SettingsLayer sl, const std::string &end_tag)
+{
+ return new Settings(end_tag, &g_hierarchy, (int)sl);
+}
+
+
+Settings *Settings::getLayer(SettingsLayer sl)
+{
+ return g_hierarchy.getLayer(sl);
+}
+
+
+Settings::Settings(const std::string &end_tag, SettingsHierarchy *h,
+ int settings_layer) :
+ m_end_tag(end_tag),
+ m_hierarchy(h),
+ m_settingslayer(settings_layer)
+{
+ if (m_hierarchy)
+ m_hierarchy->onLayerCreated(m_settingslayer, this);
+}
+
+
+Settings::~Settings()
+{
+ MutexAutoLock lock(m_mutex);
+
+ if (m_hierarchy)
+ m_hierarchy->onLayerRemoved(m_settingslayer);
+
+ clearNoLock();
}
if (&other == this)
return *this;
- JMutexAutoLock lock(m_mutex);
- JMutexAutoLock lock2(other.m_mutex);
+ // TODO: Avoid copying Settings objects. Make this private.
+ FATAL_ERROR_IF(m_hierarchy || other.m_hierarchy,
+ "Cannot copy or overwrite Settings object that belongs to a hierarchy");
+
+ MutexAutoLock lock(m_mutex);
+ MutexAutoLock lock2(other.m_mutex);
clearNoLock();
- updateNoLock(other);
+ m_settings = other.m_settings;
+ m_callbacks = other.m_callbacks;
return *this;
}
-bool Settings::parseConfigLines(std::istream &is,
- const std::string &end)
+bool Settings::checkNameValid(const std::string &name)
{
- JMutexAutoLock lock(m_mutex);
-
- std::string name, value;
- bool end_found = false;
+ bool valid = name.find_first_of("=\"{}#") == std::string::npos;
+ if (valid)
+ valid = std::find_if(name.begin(), name.end(), ::isspace) == name.end();
- while (is.good() && !end_found) {
- if (parseConfigObject(is, name, value, end, end_found)) {
- m_settings[name] = value;
- }
+ if (!valid) {
+ errorstream << "Invalid setting name \"" << name << "\""
+ << std::endl;
+ return false;
}
- if (!end.empty() && !end_found) {
+ 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::getMultiline(std::istream &is, size_t *num_lines)
+{
+ size_t lines = 1;
+ std::string value;
+ std::string line;
+
+ while (is.good()) {
+ lines++;
+ std::getline(is, line);
+ if (line == "\"\"\"")
+ break;
+ value += line;
+ value.push_back('\n');
+ }
+
+ size_t len = value.size();
+ if (len)
+ value.erase(len - 1);
+
+ if (num_lines)
+ *num_lines = lines;
+
+ return value;
+}
+
bool Settings::readConfigFile(const char *filename)
{
if (!is.good())
return false;
- JMutexAutoLock lock(m_mutex);
+ return parseConfigLines(is);
+}
+
+
+bool Settings::parseConfigLines(std::istream &is)
+{
+ MutexAutoLock lock(m_mutex);
- std::string name, value;
+ std::string line, name, value;
while (is.good()) {
- if (parseConfigObject(is, name, value)) {
- m_settings[name] = value;
+ std::getline(is, line);
+ SettingsParseEvent event = parseConfigObject(line, name, value);
+
+ switch (event) {
+ case SPE_NONE:
+ case SPE_INVALID:
+ case SPE_COMMENT:
+ break;
+ case SPE_KVPAIR:
+ m_settings[name] = SettingsEntry(value);
+ break;
+ case SPE_END:
+ return true;
+ case SPE_GROUP: {
+ Settings *group = new Settings("}");
+ if (!group->parseConfigLines(is)) {
+ delete group;
+ return false;
+ }
+ m_settings[name] = SettingsEntry(group);
+ break;
+ }
+ case SPE_MULTILINE:
+ m_settings[name] = SettingsEntry(getMultiline(is));
+ break;
}
}
- return true;
+ // false (failure) if end tag not found
+ return m_end_tag.empty();
}
-void Settings::writeLines(std::ostream &os) const
+void Settings::writeLines(std::ostream &os, u32 tab_depth) const
{
- JMutexAutoLock lock(m_mutex);
+ MutexAutoLock lock(m_mutex);
+
+ for (const auto &setting_it : m_settings)
+ printEntry(os, setting_it.first, setting_it.second, tab_depth);
- for (std::map<std::string, std::string>::const_iterator
- i = m_settings.begin();
- i != m_settings.end(); ++i) {
- os << i->first << " = " << i->second << '\n';
+ // For groups this must be "}" !
+ if (!m_end_tag.empty()) {
+ for (u32 i = 0; i < tab_depth; i++)
+ os << "\t";
+
+ os << m_end_tag << "\n";
}
}
-bool Settings::updateConfigFile(const char *filename)
+void Settings::printEntry(std::ostream &os, const std::string &name,
+ const SettingsEntry &entry, u32 tab_depth)
{
- std::list<std::string> objects;
- std::set<std::string> updated;
- bool changed = false;
+ for (u32 i = 0; i != tab_depth; i++)
+ os << "\t";
- JMutexAutoLock lock(m_mutex);
+ if (entry.is_group) {
+ os << name << " = {\n";
- // Read the file and check for differences
- {
- std::ifstream is(filename);
- while (is.good()) {
- getUpdatedConfigObject(is, objects,
- updated, changed);
- }
+ entry.group->writeLines(os, tab_depth + 1);
+
+ // Closing bracket handled by writeLines
+ } else {
+ os << name << " = ";
+
+ if (entry.value.find('\n') != std::string::npos)
+ os << "\"\"\"\n" << entry.value << "\n\"\"\"\n";
+ else
+ os << entry.value << "\n";
}
+}
+
+
+bool Settings::updateConfigObject(std::istream &is, std::ostream &os, u32 tab_depth)
+{
+ SettingEntries::const_iterator it;
+ std::set<std::string> present_entries;
+ std::string line, name, value;
+ bool was_modified = false;
+ bool end_found = false;
- // If something not yet determined to have been changed, check if
- // any new stuff was added
- if (!changed) {
- for (std::map<std::string, std::string>::const_iterator
- i = m_settings.begin();
- i != m_settings.end(); ++i) {
- if (updated.find(i->first) == updated.end()) {
- changed = true;
+ // Add any settings that exist in the config file with the current value
+ // in the object if existing
+ while (is.good() && !end_found) {
+ std::getline(is, line);
+ SettingsParseEvent event = parseConfigObject(line, name, value);
+
+ switch (event) {
+ case SPE_END:
+ // Skip end tag. Append later.
+ end_found = true;
+ break;
+ case SPE_MULTILINE:
+ value = getMultiline(is);
+ /* FALLTHROUGH */
+ case SPE_KVPAIR:
+ it = m_settings.find(name);
+ if (it != m_settings.end() &&
+ (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)
+ os << value << "\n\"\"\"\n";
}
+ present_entries.insert(name);
+ break;
+ case SPE_GROUP:
+ it = m_settings.find(name);
+ 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 (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;
+ }
+ present_entries.insert(name);
+ break;
+ default:
+ os << line << (is.eof() ? "" : "\n");
+ break;
}
}
- // If nothing was actually changed, skip writing the file
- if (!changed) {
- return true;
+ if (!line.empty() && is.eof())
+ os << "\n";
+
+ // 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_entries.find(it->first) != present_entries.end())
+ continue;
+
+ printEntry(os, it->first, it->second, tab_depth);
+ was_modified = true;
}
- // Write stuff back
- {
- std::ostringstream ss(std::ios_base::binary);
+ // Append ending tag
+ if (!m_end_tag.empty()) {
+ os << m_end_tag << "\n";
+ was_modified |= !end_found;
+ }
- // Write changes settings
- for (std::list<std::string>::const_iterator
- i = objects.begin();
- i != objects.end(); ++i) {
- ss << (*i);
- }
+ return was_modified;
+}
- // Write new settings
- for (std::map<std::string, std::string>::const_iterator
- i = m_settings.begin();
- i != m_settings.end(); ++i) {
- if (updated.find(i->first) != updated.end())
- continue;
- ss << i->first << " = " << i->second << '\n';
- }
- if (!fs::safeWriteToFile(filename, ss.str())) {
- errorstream << "Error writing configuration file: \""
- << filename << "\"" << std::endl;
- return false;
- }
+bool Settings::updateConfigFile(const char *filename)
+{
+ MutexAutoLock lock(m_mutex);
+
+ std::ifstream is(filename);
+ std::ostringstream os(std::ios_base::binary);
+
+ bool was_modified = updateConfigObject(is, os);
+ is.close();
+
+ if (!was_modified)
+ return true;
+
+ if (!fs::safeWriteToFile(filename, os.str())) {
+ errorstream << "Error writing configuration file: \""
+ << filename << "\"" << std::endl;
+ return false;
}
return true;
ValueType type = n->second.type;
- std::string value = "";
+ std::string value;
if (type == VALUETYPE_FLAG) {
value = "true";
<< name << "\": missing value" << std::endl;
return false;
}
- value = argv[i++];
+ value = argv[++i];
}
set(name, value);
* Getters *
***********/
+Settings *Settings::getParent() const
+{
+ return m_hierarchy ? m_hierarchy->getParent(m_settingslayer) : nullptr;
+}
+
-std::string Settings::get(const std::string &name) const
+const SettingsEntry &Settings::getEntry(const std::string &name) const
{
- JMutexAutoLock lock(m_mutex);
+ {
+ MutexAutoLock lock(m_mutex);
- std::map<std::string, std::string>::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.");
- }
+ SettingEntries::const_iterator n;
+ if ((n = m_settings.find(name)) != m_settings.end())
+ return n->second;
}
- return n->second;
+
+ if (auto parent = getParent())
+ return parent->getEntry(name);
+
+ throw SettingNotFoundException("Setting [" + name + "] not found.");
+}
+
+
+Settings *Settings::getGroup(const std::string &name) const
+{
+ const SettingsEntry &entry = getEntry(name);
+ if (!entry.is_group)
+ throw SettingNotFoundException("Setting [" + name + "] is not a group.");
+ return entry.group;
+}
+
+
+const std::string &Settings::get(const std::string &name) const
+{
+ const SettingsEntry &entry = getEntry(name);
+ if (entry.is_group)
+ throw SettingNotFoundException("Setting [" + name + "] is a group.");
+ return entry.value;
}
}
+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));
u64 Settings::getU64(const std::string &name) const
{
- u64 value = 0;
std::string s = get(name);
- std::istringstream ss(s);
- ss >> value;
- return value;
+ return from_string<u64>(s);
}
u32 Settings::getFlagStr(const std::string &name, const FlagDesc *flagdesc,
- u32 *flagmask) const
+ u32 *flagmask) const
{
- std::string val = get(name);
- return std::isdigit(val[0])
- ? stoi(val)
- : readFlagString(val, flagdesc, flagmask);
+ u32 flags = 0;
+
+ // Read default value (if there is any)
+ if (auto parent = getParent())
+ flags = parent->getFlagStr(name, flagdesc, flagmask);
+
+ // Apply custom flags "on top"
+ if (m_settings.find(name) != m_settings.end()) {
+ std::string 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_user;
+ }
+
+ return flags;
}
-// N.B. if getStruct() is used to read a non-POD aggregate type,
-// the behavior is undefined.
-bool Settings::getStruct(const std::string &name, const std::string &format,
- void *out, size_t olen) const
+bool Settings::getNoiseParams(const std::string &name, NoiseParams &np) const
{
- std::string valstr;
+ if (getNoiseParamsFromGroup(name, np) || getNoiseParamsFromValue(name, np))
+ return true;
+ if (auto parent = getParent())
+ return parent->getNoiseParams(name, np);
- try {
- valstr = get(name);
- } catch (SettingNotFoundException &e) {
+ return false;
+}
+
+
+bool Settings::getNoiseParamsFromValue(const std::string &name,
+ NoiseParams &np) const
+{
+ std::string value;
+
+ if (!getNoEx(name, value))
return false;
- }
- if (!deSerializeStringToStruct(valstr, format, out, olen))
+ // Format: f32,f32,(f32,f32,f32),s32,s32,f32[,f32]
+ Strfnd f(value);
+
+ np.offset = stof(f.next(","));
+ np.scale = stof(f.next(","));
+ f.next("(");
+ np.spread.X = stof(f.next(","));
+ np.spread.Y = stof(f.next(","));
+ np.spread.Z = stof(f.next(")"));
+ f.next(",");
+ np.seed = stoi(f.next(","));
+ np.octaves = stoi(f.next(","));
+ np.persist = stof(f.next(","));
+
+ std::string optional_params = f.next("");
+ if (!optional_params.empty())
+ np.lacunarity = stof(optional_params);
+
+ return true;
+}
+
+
+bool Settings::getNoiseParamsFromGroup(const std::string &name,
+ NoiseParams &np) const
+{
+ Settings *group = NULL;
+
+ if (!getGroupNoEx(name, group))
return false;
+ group->getFloatNoEx("offset", np.offset);
+ group->getFloatNoEx("scale", np.scale);
+ group->getV3FNoEx("spread", np.spread);
+ group->getS32NoEx("seed", np.seed);
+ group->getU16NoEx("octaves", np.octaves);
+ group->getFloatNoEx("persistence", np.persist);
+ group->getFloatNoEx("lacunarity", np.lacunarity);
+
+ np.flags = 0;
+ if (!group->getFlagStrNoEx("flags", np.flags, flagdesc_noiseparams))
+ np.flags = NOISE_FLAG_DEFAULTS;
+
return true;
}
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());
+ if (m_settings.find(name) != m_settings.end())
+ return true;
+ if (auto parent = getParent())
+ return parent->exists(name);
+ return false;
}
std::vector<std::string> Settings::getNames() const
{
+ MutexAutoLock lock(m_mutex);
+
std::vector<std::string> names;
- for (std::map<std::string, std::string>::const_iterator
- i = m_settings.begin();
- i != m_settings.end(); ++i) {
- names.push_back(i->first);
+ names.reserve(m_settings.size());
+ for (const auto &settings_it : m_settings) {
+ names.push_back(settings_it.first);
}
return names;
}
* Getters that don't throw exceptions *
***************************************/
+bool Settings::getGroupNoEx(const std::string &name, Settings *&val) const
+{
+ try {
+ val = getGroup(name);
+ return true;
+ } catch (SettingNotFoundException &e) {
+ return false;
+ }
+}
+
bool Settings::getNoEx(const std::string &name, std::string &val) const
{
}
}
+bool Settings::getU32NoEx(const std::string &name, u32 &val) const
+{
+ try {
+ val = getU32(name);
+ return true;
+ } catch (SettingNotFoundException &e) {
+ return false;
+ }
+}
bool Settings::getS32NoEx(const std::string &name, s32 &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
+bool Settings::getFlagStrNoEx(const std::string &name, u32 &val,
+ 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) {
}
-
/***********
* Setters *
***********/
-
-void Settings::set(const std::string &name, std::string value)
+bool Settings::setEntry(const std::string &name, const void *data,
+ bool set_group)
{
- JMutexAutoLock lock(m_mutex);
+ if (!checkNameValid(name))
+ return false;
+ if (!set_group && !checkValueValid(*(const std::string *)data))
+ return false;
- m_settings[name] = value;
+ Settings *old_group = NULL;
+ {
+ MutexAutoLock lock(m_mutex);
+
+ SettingsEntry &entry = m_settings[name];
+ old_group = entry.group;
+
+ entry.value = set_group ? "" : *(const std::string *)data;
+ entry.group = set_group ? *(Settings **)data : NULL;
+ entry.is_group = set_group;
+ if (set_group)
+ entry.group->m_end_tag = "}";
+ }
+
+ delete old_group;
+
+ return true;
}
-void Settings::set(const std::string &name, const char *value)
+bool Settings::set(const std::string &name, const std::string &value)
{
- JMutexAutoLock lock(m_mutex);
+ if (!setEntry(name, &value, false))
+ return false;
- m_settings[name] = value;
+ doCallbacks(name);
+ return true;
+}
+
+
+// TODO: Remove this function
+bool Settings::setDefault(const std::string &name, const std::string &value)
+{
+ FATAL_ERROR_IF(m_hierarchy != &g_hierarchy, "setDefault is only valid on "
+ "global settings");
+ return getLayer(SL_DEFAULTS)->set(name, value);
}
-void Settings::setDefault(const std::string &name, std::string value)
+bool Settings::setGroup(const std::string &name, const Settings &group)
{
- JMutexAutoLock lock(m_mutex);
+ // Settings must own the group pointer
+ // avoid double-free by copying the source
+ Settings *copy = new Settings();
+ *copy = group;
+ return setEntry(name, ©, true);
+}
- m_defaults[name] = value;
+
+bool Settings::setBool(const std::string &name, bool value)
+{
+ return set(name, value ? "true" : "false");
}
-void Settings::setBool(const std::string &name, bool value)
+bool Settings::setS16(const std::string &name, s16 value)
{
- set(name, value ? "true" : "false");
+ return set(name, itos(value));
}
-void Settings::setS16(const std::string &name, s16 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));
+ if (!flagdesc) {
+ if (!(flagdesc = getFlagDescFallback(name)))
+ return false; // Not found
+ }
+
+ return set(name, writeFlagString(flags, flagdesc, flagmask));
}
-bool Settings::setStruct(const std::string &name, const std::string &format, void *value)
+bool Settings::setNoiseParams(const std::string &name, const NoiseParams &np)
{
- std::string structstr;
- if (!serializeStructToString(&structstr, format, value))
- return false;
-
- set(name, structstr);
- return true;
+ Settings *group = new Settings;
+
+ group->setFloat("offset", np.offset);
+ group->setFloat("scale", np.scale);
+ group->setV3F("spread", np.spread);
+ group->setS32("seed", np.seed);
+ group->setU16("octaves", np.octaves);
+ group->setFloat("persistence", np.persist);
+ group->setFloat("lacunarity", np.lacunarity);
+ group->setFlagStr("flags", np.flags, flagdesc_noiseparams, np.flags);
+
+ return setEntry(name, &group, true);
}
bool Settings::remove(const std::string &name)
{
- JMutexAutoLock lock(m_mutex);
- return m_settings.erase(name);
-}
+ // Lock as short as possible, unlock before doCallbacks()
+ m_mutex.lock();
+ SettingEntries::iterator it = m_settings.find(name);
+ if (it != m_settings.end()) {
+ delete it->second.group;
+ m_settings.erase(it);
+ m_mutex.unlock();
-void Settings::clear()
-{
- JMutexAutoLock lock(m_mutex);
- clearNoLock();
+ doCallbacks(name);
+ return true;
+ }
+
+ m_mutex.unlock();
+ return false;
}
-void Settings::updateValue(const Settings &other, const std::string &name)
+SettingsParseEvent Settings::parseConfigObject(const std::string &line,
+ std::string &name, std::string &value)
{
- if (&other == this)
- return;
+ std::string trimmed_line = trim(line);
- JMutexAutoLock lock(m_mutex);
+ if (trimmed_line.empty())
+ return SPE_NONE;
+ if (trimmed_line[0] == '#')
+ return SPE_COMMENT;
+ if (trimmed_line == m_end_tag)
+ return SPE_END;
- try {
- std::string val = other.get(name);
- m_settings[name] = val;
- } catch (SettingNotFoundException &e) {
- }
-}
+ size_t pos = trimmed_line.find('=');
+ if (pos == std::string::npos)
+ return SPE_INVALID;
+ name = trim(trimmed_line.substr(0, pos));
+ value = trim(trimmed_line.substr(pos + 1));
-void Settings::update(const Settings &other)
-{
- if (&other == this)
- return;
+ if (value == "{")
+ return SPE_GROUP;
+ if (value == "\"\"\"")
+ return SPE_MULTILINE;
- JMutexAutoLock lock(m_mutex);
- JMutexAutoLock lock2(other.m_mutex);
-
- updateNoLock(other);
+ return SPE_KVPAIR;
}
-inline bool Settings::parseConfigObject(std::istream &is,
- std::string &name, std::string &value)
+void Settings::clearNoLock()
{
- bool end_found = false;
- return parseConfigObject(is, name, value, "", end_found);
+ for (SettingEntries::const_iterator it = m_settings.begin();
+ it != m_settings.end(); ++it)
+ delete it->second.group;
+ m_settings.clear();
}
-// NOTE: This function might be expanded to allow multi-line settings.
-bool Settings::parseConfigObject(std::istream &is,
- std::string &name, std::string &value,
- const std::string &end, bool &end_found)
+void Settings::setDefault(const std::string &name, const FlagDesc *flagdesc,
+ u32 flags)
{
- std::string line;
- std::getline(is, line);
- std::string trimmed_line = trim(line);
-
- // Ignore empty lines and comments
- if (trimmed_line.empty() || trimmed_line[0] == '#') {
- value = trimmed_line;
- return false;
- }
- if (trimmed_line == end) {
- end_found = true;
- return false;
- }
-
- Strfnd sf(trimmed_line);
-
- name = trim(sf.next("="));
- if (name.empty()) {
- value = trimmed_line;
- return false;
- }
-
- value = trim(sf.next("\n"));
+ s_flags[name] = flagdesc;
+ setDefault(name, writeFlagString(flags, flagdesc, U32_MAX));
+}
- return true;
+const FlagDesc *Settings::getFlagDescFallback(const std::string &name) const
+{
+ auto it = s_flags.find(name);
+ return it == s_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);
+}
-void Settings::getUpdatedConfigObject(std::istream &is,
- std::list<std::string> &dst,
- std::set<std::string> &updated,
- bool &changed)
+void Settings::deregisterChangedCallback(const std::string &name,
+ SettingsChangedCallback cbf, void *userdata)
{
- std::string name, value;
- if (!parseConfigObject(is, name, value)) {
- dst.push_back(value + '\n');
- return;
- }
+ MutexAutoLock lock(m_callback_mutex);
+ SettingsCallbackMap::iterator it_cbks = m_callbacks.find(name);
- if (m_settings.find(name) != m_settings.end()) {
- std::string new_value = m_settings[name];
+ if (it_cbks != m_callbacks.end()) {
+ SettingsCallbackList &cbks = it_cbks->second;
- if (new_value != value) {
- changed = true;
- }
+ SettingsCallbackList::iterator position =
+ std::find(cbks.begin(), cbks.end(), std::make_pair(cbf, userdata));
- dst.push_back(name + " = " + new_value + '\n');
- updated.insert(name);
- } else { // File contains a setting which is not in m_settings
- changed = true;
+ if (position != cbks.end())
+ cbks.erase(position);
}
}
-
-void Settings::updateNoLock(const Settings &other)
+void Settings::removeSecureSettings()
{
- m_settings.insert(other.m_settings.begin(), other.m_settings.end());
- m_defaults.insert(other.m_defaults.begin(), other.m_defaults.end());
+ for (const auto &name : getNames()) {
+ if (name.compare(0, 7, "secure.") != 0)
+ continue;
+
+ errorstream << "Secure setting " << name
+ << " isn't allowed, so was ignored."
+ << std::endl;
+ remove(name);
+ }
}
-
-void Settings::clearNoLock()
+void Settings::doCallbacks(const std::string &name) const
{
- m_settings.clear();
- m_defaults.clear();
-}
+ 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);
+ }
+}
projects / dragonfireclient.git / blobdiff