X-Git-Url: https://git.quassel-irc.org/?a=blobdiff_plain;ds=sidebyside;f=src%2Fcommon%2Fsettings.h;h=1a0fa6d7f9ee5bfd9198fc799c23326ed5a0b7b7;hb=c194ed5fb3d15e14b9364f9796d3521910dc72fe;hp=a5aa9adc397b107b7368a90cbded4d70919298d4;hpb=694f9bfbf7f1af19108461c7e00d133e55082bce;p=quassel.git diff --git a/src/common/settings.h b/src/common/settings.h index a5aa9adc..1a0fa6d7 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,21 +15,23 @@ * 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 "quassel.h" -class SettingsChangeNotifier : public QObject +class COMMON_EXPORT SettingsChangeNotifier : public QObject { Q_OBJECT @@ -41,7 +43,7 @@ private: }; -class Settings +class COMMON_EXPORT Settings { public: enum Mode { Default, Custom }; @@ -53,11 +55,53 @@ public: //! 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()); + /** + * 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(); + /** + * 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(); + + /** + * 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(); + 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_; } @@ -66,7 +110,15 @@ protected: 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 + * + * @param[in] key ID of local settings key + * @returns True if key exists in settings, otherwise false + */ + virtual bool localKeyExists(const QString &key); virtual void removeLocalKey(const QString &key); @@ -76,7 +128,7 @@ protected: private: inline QSettings::Format format() { -#ifdef Q_WS_WIN +#ifdef Q_OS_WIN return QSettings::IniFormat; #else return QSettings::NativeFormat; @@ -91,7 +143,8 @@ private: } - static QHash settingsCache; + static QHash settingsCache; ///< Cached settings values + static QHash settingsKeyPersistedCache; ///< Cached settings key exists on disk static QHash settingsChangeNotifier; inline QString normalizedKey(const QString &group, const QString &key) @@ -102,6 +155,44 @@ private: } + /** + * 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; @@ -133,6 +224,3 @@ private: return settingsChangeNotifier.contains(normKey); } }; - - -#endif