/***************************************************************************
- * Copyright (C) 2005-2016 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 *
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
***************************************************************************/
-#ifndef SETTINGS_H
-#define SETTINGS_H
+#pragma once
+
+#include "common-export.h"
#include <QCoreApplication>
#include <QHash>
#include <QSettings>
#include <QString>
#include <QVariant>
+#include <utility>
#include "quassel.h"
-class SettingsChangeNotifier : public QObject
+class COMMON_EXPORT SettingsChangeNotifier : public QObject
{
Q_OBJECT
};
-class Settings
+class COMMON_EXPORT Settings
{
public:
enum Mode { Default, Custom };
*/
virtual void setVersionMinor(const uint versionMinor);
+ /**
+ * Persist unsaved changes to permanent storage
+ *
+ * @return true if succeeded, false otherwise
+ */
+ bool sync();
+
+ /**
+ * Check if the configuration storage is writable.
+ *
+ * @return true if writable, false otherwise
+ */
+ bool isWritable();
+
protected:
- inline Settings(QString group_, QString appName_) : group(group_), appName(appName_) {}
- inline virtual ~Settings() {}
+ inline Settings(QString group_, QString appName_) : group(std::move(group_)), appName(std::move(appName_)) {}
+ inline virtual ~Settings() = default;
inline void setGroup(const QString &group_) { group = group_; }
virtual QStringList localChildGroups(const QString &rootkey = QString());
virtual void setLocalValue(const QString &key, const QVariant &data);
- virtual const QVariant &localValue(const QString &key, const QVariant &def = QVariant());
+ virtual QVariant localValue(const QString &key, const QVariant &def = QVariant());
/**
* Gets if a key exists in settings
}
- static QHash<QString, QVariant> settingsCache;
+ static QHash<QString, QVariant> settingsCache; ///< Cached settings values
+ static QHash<QString, bool> settingsKeyPersistedCache; ///< Cached settings key exists on disk
static QHash<QString, SettingsChangeNotifier *> settingsChangeNotifier;
inline QString normalizedKey(const QString &group, const QString &key)
}
+ /**
+ * Update the cache of whether or not a given settings key persists on disk
+ *
+ * @param normKey Normalized settings key ID
+ * @param exists True if key exists, otherwise false
+ */
+ inline void setCacheKeyPersisted(const QString &normKey, bool exists)
+ {
+ settingsKeyPersistedCache[normKey] = exists;
+ }
+
+
+ /**
+ * Check if the given settings key ID persists on disk (rather than being a default value)
+ *
+ * @see Settings::localKeyExists()
+ *
+ * @param normKey Normalized settings key ID
+ * @return True if key exists and persistence has been cached, otherwise false
+ */
+ inline const bool &cacheKeyPersisted(const QString &normKey)
+ {
+ return settingsKeyPersistedCache[normKey];
+ }
+
+
+ /**
+ * Check if the persistence of the given settings key ID has been cached
+ *
+ * @param normKey Normalized settings key ID
+ * @return True if key persistence has been cached, otherwise false
+ */
+ inline bool isKeyPersistedCached(const QString &normKey)
+ {
+ return settingsKeyPersistedCache.contains(normKey);
+ }
+
+
inline void setCacheValue(const QString &normKey, const QVariant &data)
{
settingsCache[normKey] = data;
return settingsChangeNotifier.contains(normKey);
}
};
-
-
-#endif