/***************************************************************************
- * Copyright (C) 2005-08 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 *
* 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
#include <QCoreApplication>
#include <QHash>
+#include <QSettings>
#include <QString>
#include <QVariant>
-class SettingsChangeNotifier : public QObject {
- Q_OBJECT
+#include "quassel.h"
+
+class 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 Settings
+{
public:
- enum Mode { Default, Custom };
+ enum Mode { Default, Custom };
public:
- void notify(const QString &key, QObject *receiver, const char *slot);
+ //! Call the given slot on change of the given key
+ virtual void notify(const QString &key, QObject *receiver, const char *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());
+
+ /**
+ * 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(group_), appName(appName_) {}
+ inline virtual ~Settings() {}
- inline void setGroup(const QString &group_) { group = group_; }
+ inline void setGroup(const QString &group_) { group = group_; }
- virtual QStringList allLocalKeys();
- virtual QStringList localChildKeys(const QString &rootkey = QString());
- virtual QStringList localChildGroups(const QString &rootkey = QString());
+ virtual QStringList allLocalKeys();
+ virtual QStringList localChildKeys(const QString &rootkey = QString());
+ 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 void setLocalValue(const QString &key, const QVariant &data);
+ virtual QVariant localValue(const QString &key, const QVariant &def = QVariant());
- 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);
- QString group;
- QString appName;
+ virtual void removeLocalKey(const QString &key);
+
+ QString group;
+ QString appName;
private:
- inline QString org() {
-#ifdef Q_WS_MAC
- return QCoreApplication::organizationDomain();
+ inline QSettings::Format format()
+ {
+#ifdef Q_OS_WIN
+ return QSettings::IniFormat;
#else
- return QCoreApplication::organizationName();
+ return QSettings::NativeFormat;
#endif
- }
-
- static QHash<QString, QHash<QString, QVariant> > settingsCache;
- static QHash<QString, QHash<QString, SettingsChangeNotifier *> > 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);
- }
+ }
+
+
+ inline QString fileName()
+ {
+ return Quassel::configDirPath() + appName
+ + ((format() == QSettings::NativeFormat) ? QLatin1String(".conf") : QLatin1String(".ini"));
+ }
+
+
+ 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)
+ {
+ if (group.isEmpty())
+ return key;
+ return group + '/' + 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;
+ }
+
+
+ inline const QVariant &cacheValue(const QString &normKey)
+ {
+ return settingsCache[normKey];
+ }
+
+
+ inline bool isCached(const QString &normKey)
+ {
+ return settingsCache.contains(normKey);
+ }
+
+
+ inline SettingsChangeNotifier *notifier(const QString &normKey)
+ {
+ if (!hasNotifier(normKey))
+ settingsChangeNotifier[normKey] = new SettingsChangeNotifier();
+ return settingsChangeNotifier[normKey];
+ }
+
+
+ inline bool hasNotifier(const QString &normKey)
+ {
+ return settingsChangeNotifier.contains(normKey);
+ }
};
+
#endif