X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcommon%2Fsettings.h;h=72dec758a512335a90ec10f91532d5f9e6213fc9;hp=9fe6e64ba2f2c08d43e72cebd60ce5557382edc1;hb=10e6f4629e39c66cfb8db6ab2806bf8f13ec700b;hpb=ec17201104f75eafaddccc174de8709b42b15ccb diff --git a/src/common/settings.h b/src/common/settings.h index 9fe6e64b..72dec758 100644 --- a/src/common/settings.h +++ b/src/common/settings.h @@ -1,11 +1,11 @@ /*************************************************************************** - * Copyright (C) 2005-07 by The Quassel Team * + * Copyright (C) 2005-2016 by the Quassel Project * * devel@quassel-irc.org * * * * This program is free software; you can redistribute it and/or modify * * it under the terms of the GNU General Public License as published by * * the Free Software Foundation; either version 2 of the License, or * - * (at your option) any later version. * + * (at your option) version 3. * * * * This program is distributed in the hope that it will be useful, * * but WITHOUT ANY WARRANTY; without even the implied warranty of * @@ -15,46 +15,174 @@ * 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_ +#ifndef SETTINGS_H +#define SETTINGS_H +#include +#include +#include #include #include -#include -class Settings : private QSettings { +#include "quassel.h" + +class SettingsChangeNotifier : public QObject +{ + Q_OBJECT + +signals: + void valueChanged(const QVariant &newValue); + +private: + friend class Settings; +}; + + +class Settings +{ +public: + enum Mode { Default, Custom }; - public: - virtual ~Settings(); +public: + //! Call the given slot on change of the given key + virtual void notify(const QString &key, QObject *receiver, const char *slot); - static void setGuiValue(QString, QVariant) {}; - static QVariant guiValue(QString, QVariant = QVariant()) { return QVariant(); } - protected: - Settings(QString group = "General"); + //! 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()); - void setGroup(QString group); + /** + * 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 void setGroup(const QString &group_) { group = group_; } virtual QStringList allLocalKeys(); - virtual QStringList localChildKeys(); - virtual QStringList localChildGroups(); - //virtual QStringList allSessionKeys() = 0; - virtual QStringList sessionKeys() = 0; + virtual QStringList localChildKeys(const QString &rootkey = QString()); + virtual QStringList localChildGroups(const QString &rootkey = QString()); virtual void setLocalValue(const QString &key, const QVariant &data); - virtual QVariant localValue(const QString &key, const QVariant &def = QVariant()); + virtual const QVariant &localValue(const QString &key, const QVariant &def = QVariant()); - virtual void setSessionValue(const QString &key, const QVariant &data) = 0; - virtual QVariant sessionValue(const QString &key, const QVariant &def = QVariant()) = 0; + /** + * 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); 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")); + } + + + static QHash settingsCache; + static QHash settingsChangeNotifier; + + 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; + } + + + 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