X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcommon%2Fsettings.h;h=48dfafddc521c6d0c88280c67ef0d0bd34d050bd;hp=26c8ead0d7b15f64dab866daa97fbe0330040bc0;hb=61f33c7895e324f6e95034d86897ad2e963653f1;hpb=015de4656bebd990317b82d8cc993fdc63709f01 diff --git a/src/common/settings.h b/src/common/settings.h index 26c8ead0..48dfafdd 100644 --- a/src/common/settings.h +++ b/src/common/settings.h @@ -1,5 +1,5 @@ /*************************************************************************** - * Copyright (C) 2005-09 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 * @@ -15,91 +15,163 @@ * You should have received a copy of the GNU General Public License * * along with this program; if not, write to the * * Free Software Foundation, Inc., * - * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * + * 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 #include +#include #include "quassel.h" -class SettingsChangeNotifier : public QObject { - Q_OBJECT +class COMMON_EXPORT SettingsChangeNotifier : public QObject +{ + Q_OBJECT signals: - void valueChanged(const QVariant &newValue); + void valueChanged(const QVariant &newValue); private: - friend class Settings; + friend class Settings; }; -class Settings { + +class COMMON_EXPORT Settings +{ public: - enum Mode { Default, Custom }; + enum Mode { Default, Custom }; public: - virtual void notify(const QString &key, QObject *receiver, const char *slot); - virtual uint version(); + //! Call the given slot on change of the given key + void notify(const QString &key, QObject *receiver, const char *slot) const; + + //! 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()) const; + + /** + * Get the major configuration version + * + * This indicates the backwards/forwards incompatible version of configuration. + * + * @return Major configuration version (the X in XX.YY) + */ + virtual uint version() const; + + /** + * Get the minor configuration version + * + * This indicates the backwards/forwards compatible version of configuration. + * + * @see Settings::setVersionMinor() + * @return Minor configuration version (the Y in XX.YY) + */ + virtual uint versionMinor() const; + + /** + * Set the minor configuration version + * + * When making backwards/forwards compatible changes, call this with the new version number. + * This does not implement any upgrade logic; implement that when checking Settings::version(), + * e.g. in Core::Core() and QtUiApplication::init(). + * + * @param[in] versionMinor New minor version number + */ + 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); - 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; - virtual void removeLocalKey(const QString &key); + /** + * Gets if a key exists in settings + * + * @param[in] key ID of local settings key + * @returns True if key exists in settings, otherwise false + */ + virtual bool localKeyExists(const QString &key) const; - QString group; - QString appName; + virtual void removeLocalKey(const QString &key); + + QString _group; + QString _appName; private: - inline QSettings::Format format() { -#ifdef Q_WS_WIN - return QSettings::IniFormat; -#else - return QSettings::NativeFormat; -#endif - } - inline QString fileName() { - return Quassel::configDirPath() + appName - + ((format() == QSettings::NativeFormat) ? QLatin1String(".conf") : QLatin1String(".ini")); - } - - static QHash > settingsCache; - static QHash > settingsChangeNotifier; - - inline void setCacheValue(const QString &group, const QString &key, const QVariant &data) { - settingsCache[group][key] = data; - } - inline const QVariant &cacheValue(const QString &group, const QString &key) { - return settingsCache[group][key]; - } - inline bool isCached(const QString &group, const QString &key) { - return settingsCache.contains(group) && settingsCache[group].contains(key); - } - - inline SettingsChangeNotifier *notifier(const QString &group, const QString &key) { - if(!hasNotifier(group, key)) - settingsChangeNotifier[group][key] = new SettingsChangeNotifier(); - return settingsChangeNotifier[group][key]; - } - - inline bool hasNotifier(const QString &group, const QString &key) { - return settingsChangeNotifier.contains(group) && settingsChangeNotifier[group].contains(key); - } -}; + QSettings::Format format() const; + + QString fileName() const; + + QString normalizedKey(const QString &group, const QString &key) const; + + /** + * 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; -#endif + /** + * 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; + + QVariant cacheValue(const QString &normKey) const; + + bool isCached(const QString &normKey) const; + + SettingsChangeNotifier *notifier(const QString &normKey) const; + + bool hasNotifier(const QString &normKey) const; + +private: + static QHash _settingsCache; ///< Cached settings values + static QHash _settingsKeyPersistedCache; ///< Cached settings key exists on disk + static QHash> _settingsChangeNotifier; +};