X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcommon%2Fsettings.h;h=ed815dc472ff4649d5fb14137ea93842f6de3717;hp=e9bf28d087da87869c83fc367682de98c00c878e;hb=cc6e7c08709c4e761e2fd9c2e322751015497003;hpb=d2ac8f78a0e050d2efa397c434b249d6b3391576 diff --git a/src/common/settings.h b/src/common/settings.h index e9bf28d0..ed815dc4 100644 --- a/src/common/settings.h +++ b/src/common/settings.h @@ -1,5 +1,5 @@ /*************************************************************************** - * Copyright (C) 2005-2016 by the Quassel Project * + * Copyright (C) 2005-2019 by the Quassel Project * * devel@quassel-irc.org * * * * This program is free software; you can redistribute it and/or modify * @@ -18,8 +18,13 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * ***************************************************************************/ -#ifndef SETTINGS_H -#define SETTINGS_H +#pragma once + +#include "common-export.h" + +#include +#include +#include #include #include @@ -29,29 +34,43 @@ #include "quassel.h" -class SettingsChangeNotifier : public QObject +class COMMON_EXPORT SettingsChangeNotifier : public QObject { Q_OBJECT signals: - void valueChanged(const QVariant &newValue); + void valueChanged(const QVariant& newValue); private: friend class Settings; }; - -class Settings +class COMMON_EXPORT Settings { public: - enum Mode { Default, Custom }; + enum Mode + { + Default, + Custom + }; public: - //! Call the given slot on change of the given key - virtual void notify(const QString &key, QObject *receiver, const char *slot); + //! Calls the given slot on change of the given key + template + void notify(const QString& key, const Receiver* receiver, Slot slot) const + { + static_assert(!std::is_same::value, "Old-style slots not supported"); + QObject::connect(notifier(normalizedKey(_group, keyForNotify(key))), &SettingsChangeNotifier::valueChanged, receiver, slot); + } //! Sets up notification and calls the given slot to set the initial value - void initAndNotify(const QString &key, QObject *receiver, const char *slot, const QVariant &defaultValue = QVariant()); + template + void initAndNotify(const QString& key, const Receiver* receiver, Slot slot, const QVariant& defaultValue = {}) const + { + notify(key, receiver, std::move(slot)); + auto notifyKey = keyForNotify(key); + emit notifier(normalizedKey(_group, notifyKey))->valueChanged(localValue(notifyKey, defaultValue)); + } /** * Get the major configuration version @@ -60,7 +79,7 @@ public: * * @return Major configuration version (the X in XX.YY) */ - virtual uint version(); + virtual uint version() const; /** * Get the minor configuration version @@ -70,7 +89,7 @@ public: * @see Settings::setVersionMinor() * @return Minor configuration version (the Y in XX.YY) */ - virtual uint versionMinor(); + virtual uint versionMinor() const; /** * Set the minor configuration version @@ -83,18 +102,42 @@ public: */ 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() const; + protected: - inline Settings(QString group_, QString appName_) : group(group_), appName(appName_) {} - inline virtual ~Settings() {} + Settings(QString group, QString appName); + virtual ~Settings() = default; - inline void setGroup(const QString &group_) { group = group_; } + void setGroup(QString group); + + /** + * Allows subclasses to transform the key given to notify(). + * + * Default implementation just returns the given key. + * + * @param key Key given to notify() + * @returns Key that should be used for notfication + */ + virtual QString keyForNotify(const QString& key) const; - virtual QStringList allLocalKeys(); - virtual QStringList localChildKeys(const QString &rootkey = QString()); - virtual QStringList localChildGroups(const QString &rootkey = QString()); + virtual QStringList allLocalKeys() const; + virtual QStringList localChildKeys(const QString& rootkey = QString()) const; + virtual QStringList localChildGroups(const QString& rootkey = QString()) const; - virtual void setLocalValue(const QString &key, const QVariant &data); - virtual const QVariant &localValue(const QString &key, const QVariant &def = QVariant()); + virtual void setLocalValue(const QString& key, const QVariant& data); + virtual QVariant localValue(const QString& key, const QVariant& def = QVariant()) const; /** * Gets if a key exists in settings @@ -102,73 +145,58 @@ protected: * @param[in] key ID of local settings key * @returns True if key exists in settings, otherwise false */ - virtual bool localKeyExists(const QString &key); + virtual bool localKeyExists(const QString& key) const; - virtual void removeLocalKey(const QString &key); + virtual void removeLocalKey(const QString& key); - QString group; - QString appName; + QString _group; + QString _appName; private: - inline QSettings::Format format() - { -#ifdef Q_OS_WIN - return QSettings::IniFormat; -#else - return QSettings::NativeFormat; -#endif - } - - - inline QString fileName() - { - return Quassel::configDirPath() + appName - + ((format() == QSettings::NativeFormat) ? QLatin1String(".conf") : QLatin1String(".ini")); - } + QSettings::Format format() const; + QString fileName() const; - static QHash settingsCache; - static QHash settingsChangeNotifier; + QString normalizedKey(const QString& group, const QString& key) const; - inline QString normalizedKey(const QString &group, const QString &key) - { - if (group.isEmpty()) - return key; - return group + '/' + key; - } - - - inline void setCacheValue(const QString &normKey, const QVariant &data) - { - settingsCache[normKey] = data; - } + /** + * 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 + */ + void setCacheKeyPersisted(const QString& normKey, bool exists) const; + /** + * 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 + */ + bool cacheKeyPersisted(const QString& normKey) const; - inline const QVariant &cacheValue(const QString &normKey) - { - return settingsCache[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 + */ + bool isKeyPersistedCached(const QString& normKey) const; + void setCacheValue(const QString& normKey, const QVariant& data) const; - inline bool isCached(const QString &normKey) - { - return settingsCache.contains(normKey); - } + QVariant cacheValue(const QString& normKey) const; + bool isCached(const QString& normKey) const; - inline SettingsChangeNotifier *notifier(const QString &normKey) - { - if (!hasNotifier(normKey)) - settingsChangeNotifier[normKey] = new SettingsChangeNotifier(); - return settingsChangeNotifier[normKey]; - } + SettingsChangeNotifier* notifier(const QString& normKey) const; + bool hasNotifier(const QString& normKey) const; - inline bool hasNotifier(const QString &normKey) - { - return settingsChangeNotifier.contains(normKey); - } +private: + static QHash _settingsCache; ///< Cached settings values + static QHash _settingsKeyPersistedCache; ///< Cached settings key exists on disk + static QHash> _settingsChangeNotifier; }; - - -#endif