modernize: Use raw string literals instead of escaped strings

[quassel.git] / src / common / settings.cpp

diff --git a/src/common/settings.cpp b/src/common/settings.cpp
index 334d197..2330f45 100644 (file)
--- a/src/common/settings.cpp
+++ b/src/common/settings.cpp
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-2013 by the Quassel Project                        *
+ *   Copyright (C) 2005-2018 by the Quassel Project                        *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
@@ -22,12 +22,18 @@
 
 #include "settings.h"
 
-const int VERSION = 1;
+const int VERSION = 1;              /// Settings version for backwords/forwards incompatible changes
+
+// This is used if no VersionMinor key exists, e.g. upgrading from a Quassel version before this
+// change.  This shouldn't be increased from 1; instead, change the logic in Core::Core() and
+// QtUiApplication::init() to handle upgrading and downgrading.
+const int VERSION_MINOR_INITIAL = 1; /// Initial settings version for compatible changes
 
 QHash<QString, QVariant> Settings::settingsCache;
+QHash<QString, bool> Settings::settingsKeyPersistedCache;
 QHash<QString, SettingsChangeNotifier *> Settings::settingsChangeNotifier;
 
-#ifdef Q_WS_MAC
+#ifdef Q_OS_MAC
 #  define create_qsettings QSettings s(QCoreApplication::organizationDomain(), appName)
 #else
 #  define create_qsettings QSettings s(fileName(), format())
@@ -86,6 +92,54 @@ uint Settings::version()
 }
 
 
+uint Settings::versionMinor()
+{
+    // Don't cache this value; ignore the group
+    create_qsettings;
+    // '0' means new configuration, anything else indicates an existing configuration.  Application
+    // initialization should check this value and manage upgrades/downgrades, e.g. in Core::Core()
+    // and QtUiApplication::init().
+    uint verMinor = s.value("Config/VersionMinor", 0).toUInt();
+
+    // As previous Quassel versions didn't implement this, we need to check if any settings other
+    // than Config/Version exist.  If so, assume it's version 1.
+    if (verMinor == 0 && s.allKeys().count() > 1) {
+        // More than 1 key exists, but version's never been set.  Assume and set version 1.
+        setVersionMinor(VERSION_MINOR_INITIAL);
+        return VERSION_MINOR_INITIAL;
+    } else {
+        return verMinor;
+    }
+}
+
+
+void Settings::setVersionMinor(const uint versionMinor)
+{
+    // Don't cache this value; ignore the group
+    create_qsettings;
+    // Set the value directly.
+    s.setValue("Config/VersionMinor", versionMinor);
+}
+
+
+bool Settings::sync() {
+    create_qsettings;
+    s.sync();
+    switch (s.status()) {
+        case QSettings::NoError:
+            return true;
+        default:
+            return false;
+    }
+}
+
+
+bool Settings::isWritable() {
+    create_qsettings;
+    return s.isWritable();
+}
+
+
 QStringList Settings::allLocalKeys()
 {
     create_qsettings;
@@ -133,6 +187,7 @@ void Settings::setLocalValue(const QString &key, const QVariant &data)
     QString normKey = normalizedKey(group, key);
     create_qsettings;
     s.setValue(normKey, data);
+    setCacheKeyPersisted(normKey, true);
     setCacheValue(normKey, data);
     if (hasNotifier(normKey)) {
         emit notifier(normKey)->valueChanged(data);
@@ -140,14 +195,37 @@ void Settings::setLocalValue(const QString &key, const QVariant &data)
 }
 
 
-const QVariant &Settings::localValue(const QString &key, const QVariant &def)
+QVariant Settings::localValue(const QString &key, const QVariant &def)
 {
     QString normKey = normalizedKey(group, key);
     if (!isCached(normKey)) {
         create_qsettings;
+        // Since we're loading from settings anyways, cache whether or not the key exists on disk
+        setCacheKeyPersisted(normKey, s.contains(normKey));
+        // Cache key value
         setCacheValue(normKey, s.value(normKey, def));
     }
-    return cacheValue(normKey);
+    if (cacheKeyPersisted(normKey)) {
+        return cacheValue(normKey);
+    } else {
+        // Don't return possibly wrong cached values
+        // A key gets cached with the first default value requested and never changes afterwards
+        return def;
+    }
+}
+
+
+bool Settings::localKeyExists(const QString &key)
+{
+    QString normKey = normalizedKey(group, key);
+    if (!isKeyPersistedCached(normKey)) {
+        create_qsettings;
+        // Cache whether or not key exists on disk
+        // We can't cache key value as we don't know the default
+        setCacheKeyPersisted(normKey, s.contains(normKey));
+    }
+
+    return cacheKeyPersisted(normKey);
 }
 
 
@@ -158,6 +236,13 @@ void Settings::removeLocalKey(const QString &key)
     s.remove(key);
     s.endGroup();
     QString normKey = normalizedKey(group, key);
-    if (isCached(normKey))
+    if (isCached(normKey)) {
         settingsCache.remove(normKey);
+    }
+    if (isKeyPersistedCached(normKey)) {
+        settingsKeyPersistedCache.remove(normKey);
+    }
+    if (hasNotifier(normKey)) {
+        emit notifier(normKey)->valueChanged({});
+    }
 }