documentation for settings

renamed some PluginSettings members and moved them around

1 files changed, 67 insertions, 63 deletions

diff --git a/src/settings.cpp b/src/settings.cpp
index a33005b6..ce9676ea 100644
--- a/src/settings.cpp
+++ b/src/settings.cpp
@@ -512,9 +512,9 @@ const LoadMechanism& GameSettings::loadMechanism() const
   return m_LoadMechanism;
 }
 
-void GameSettings::setupLoadMechanism()
+LoadMechanism& GameSettings::loadMechanism()
 {
-  m_LoadMechanism.activate(loadMechanismType());
+  return m_LoadMechanism;
 }
 
 bool GameSettings::hideUncheckedPlugins() const
@@ -1063,19 +1063,7 @@ void PluginSettings::clearPlugins()
   m_PluginSettings.clear();
   m_PluginBlacklist.clear();
 
-  m_PluginBlacklist = readPluginBlacklist();
-}
-
-QSet<QString> PluginSettings::readPluginBlacklist() const
-{
-  QSet<QString> set;
-
-  ScopedReadArray sra(m_Settings, "pluginBlacklist");
-  sra.for_each([&]{
-    set.insert(sra.get<QString>("name"));
-  });
-
-  return set;
+  m_PluginBlacklist = readBlacklist();
 }
 
 void PluginSettings::registerPlugin(IPlugin *plugin)
@@ -1106,12 +1094,12 @@ void PluginSettings::registerPlugin(IPlugin *plugin)
   }
 }
 
-bool PluginSettings::pluginBlacklisted(const QString &fileName) const
+std::vector<MOBase::IPlugin*> PluginSettings::plugins() const
 {
-  return m_PluginBlacklist.contains(fileName);
+  return m_Plugins;
 }
 
-QVariant PluginSettings::pluginSetting(const QString &pluginName, const QString &key) const
+QVariant PluginSettings::setting(const QString &pluginName, const QString &key) const
 {
   auto iterPlugin = m_PluginSettings.find(pluginName);
   if (iterPlugin == m_PluginSettings.end()) {
@@ -1126,7 +1114,7 @@ QVariant PluginSettings::pluginSetting(const QString &pluginName, const QString
   return *iterSetting;
 }
 
-void PluginSettings::setPluginSetting(const QString &pluginName, const QString &key, const QVariant &value)
+void PluginSettings::setSetting(const QString &pluginName, const QString &key, const QVariant &value)
 {
   auto iterPlugin = m_PluginSettings.find(pluginName);
 
@@ -1141,7 +1129,27 @@ void PluginSettings::setPluginSetting(const QString &pluginName, const QString &
   set(m_Settings, "Plugins", pluginName + "/" + key, value);
 }
 
-QVariant PluginSettings::pluginPersistent(const QString &pluginName, const QString &key, const QVariant &def) const
+QVariantMap PluginSettings::settings(const QString &pluginName) const
+{
+  return m_PluginSettings[pluginName];
+}
+
+void PluginSettings::setSettings(const QString &pluginName, const QVariantMap& map)
+{
+  m_PluginSettings[pluginName] = map;
+}
+
+QVariantMap PluginSettings::descriptions(const QString &pluginName) const
+{
+  return m_PluginDescriptions[pluginName];
+}
+
+void PluginSettings::setDescriptions(const QString &pluginName, const QVariantMap& map)
+{
+  m_PluginDescriptions[pluginName] = map;
+}
+
+QVariant PluginSettings::persistent(const QString &pluginName, const QString &key, const QVariant &def) const
 {
   if (!m_PluginSettings.contains(pluginName)) {
     return def;
@@ -1150,7 +1158,7 @@ QVariant PluginSettings::pluginPersistent(const QString &pluginName, const QStri
   return get<QVariant>(m_Settings, "PluginPersistance", pluginName + "/" + key, def);
 }
 
-void PluginSettings::setPluginPersistent(
+void PluginSettings::setPersistent(
   const QString &pluginName, const QString &key, const QVariant &value, bool sync)
 {
   if (!m_PluginSettings.contains(pluginName)) {
@@ -1165,74 +1173,70 @@ void PluginSettings::setPluginPersistent(
     m_Settings.sync();
   }
 }
-
-void PluginSettings::addBlacklistPlugin(const QString &fileName)
+void PluginSettings::addBlacklist(const QString &fileName)
 {
   m_PluginBlacklist.insert(fileName);
-  writePluginBlacklist();
+  writeBlacklist();
 }
 
-void PluginSettings::writePluginBlacklist()
+bool PluginSettings::blacklisted(const QString &fileName) const
 {
-  const auto current = readPluginBlacklist();
-
-  if (current.size() > m_PluginBlacklist.size()) {
-    // Qt can't remove array elements, the section must be cleared
-    removeSection(m_Settings, "pluginBlacklist");
-  }
+  return m_PluginBlacklist.contains(fileName);
+}
 
-  ScopedWriteArray swa(m_Settings, "pluginBlacklist", m_PluginBlacklist.size());
+void PluginSettings::setBlacklist(const QStringList& pluginNames)
+{
+  m_PluginBlacklist.clear();
 
-  for (const QString &plugin : m_PluginBlacklist) {
-    swa.next();
-    swa.set("name", plugin);
+  for (const auto& name : pluginNames) {
+    m_PluginBlacklist.insert(name);
   }
 }
 
-QVariantMap PluginSettings::pluginSettings(const QString &pluginName) const
+const QSet<QString>& PluginSettings::blacklist() const
 {
-  return m_PluginSettings[pluginName];
+  return m_PluginBlacklist;
 }
 
-void PluginSettings::setPluginSettings(const QString &pluginName, const QVariantMap& map)
+void PluginSettings::save()
 {
-  m_PluginSettings[pluginName] = map;
-}
+  for (auto iterPlugins=m_PluginSettings.begin(); iterPlugins!=m_PluginSettings.end(); ++iterPlugins) {
+    for (auto iterSettings=iterPlugins->begin(); iterSettings!=iterPlugins->end(); ++iterSettings) {
+      const auto key = iterPlugins.key() + "/" + iterSettings.key();
+      set(m_Settings, "Plugins", key, iterSettings.value());
+    }
+  }
 
-QVariantMap PluginSettings::pluginDescriptions(const QString &pluginName) const
-{
-  return m_PluginDescriptions[pluginName];
+  writeBlacklist();
 }
 
-void PluginSettings::pluginDescriptions(const QString &pluginName, const QVariantMap& map)
+void PluginSettings::writeBlacklist()
 {
-  m_PluginDescriptions[pluginName] = map;
-}
+  const auto current = readBlacklist();
 
-const QSet<QString>& PluginSettings::pluginBlacklist() const
-{
-  return m_PluginBlacklist;
-}
+  if (current.size() > m_PluginBlacklist.size()) {
+    // Qt can't remove array elements, the section must be cleared
+    removeSection(m_Settings, "pluginBlacklist");
+  }
 
-void PluginSettings::setPluginBlacklist(const QStringList& pluginNames)
-{
-  m_PluginBlacklist.clear();
+  ScopedWriteArray swa(m_Settings, "pluginBlacklist", m_PluginBlacklist.size());
 
-  for (const auto& name : pluginNames) {
-    m_PluginBlacklist.insert(name);
+  for (const QString &plugin : m_PluginBlacklist) {
+    swa.next();
+    swa.set("name", plugin);
   }
 }
 
-void PluginSettings::save()
+QSet<QString> PluginSettings::readBlacklist() const
 {
-  for (auto iterPlugins=m_PluginSettings.begin(); iterPlugins!=m_PluginSettings.end(); ++iterPlugins) {
-    for (auto iterSettings=iterPlugins->begin(); iterSettings!=iterPlugins->end(); ++iterSettings) {
-      const auto key = iterPlugins.key() + "/" + iterSettings.key();
-      set(m_Settings, "Plugins", key, iterSettings.value());
-    }
-  }
+  QSet<QString> set;
 
-  writePluginBlacklist();
+  ScopedReadArray sra(m_Settings, "pluginBlacklist");
+  sra.for_each([&]{
+    set.insert(sra.get<QString>("name"));
+    });
+
+  return set;
 }