src/common/settings.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-09 by the Quassel Project                          *
   3  *   devel@quassel-irc.org                                                 *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) version 3.                                           *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  19  ***************************************************************************/
  20
  21 #ifndef SETTINGS_H
  22 #define SETTINGS_H
  23
  24 #include <QCoreApplication>
  25 #include <QHash>
  26 #include <QSettings>
  27 #include <QString>
  28 #include <QVariant>
  29
  30 #include "quassel.h"
  31
  32 class SettingsChangeNotifier : public QObject {
  33   Q_OBJECT
  34
  35 signals:
  36   void valueChanged(const QVariant &newValue);
  37
  38 private:
  39   friend class Settings;
  40 };
  41
  42 class Settings {
  43 public:
  44   enum Mode { Default, Custom };
  45
  46 public:
  47   //! Call the given slot on change of the given key
  48   virtual void notify(const QString &key, QObject *receiver, const char *slot);
  49
  50   //! Sets up notification and calls the given slot to set the initial value
  51   void initAndNotify(const QString &key, QObject *receiver, const char *slot, const QVariant &defaultValue = QVariant());
  52
  53   virtual uint version();
  54
  55 protected:
  56   inline Settings(QString group_, QString appName_) : group(group_), appName(appName_) {}
  57   inline virtual ~Settings() {}
  58
  59   inline void setGroup(const QString &group_) { group = group_; }
  60
  61   virtual QStringList allLocalKeys();
  62   virtual QStringList localChildKeys(const QString &rootkey = QString());
  63   virtual QStringList localChildGroups(const QString &rootkey = QString());
  64
  65   virtual void setLocalValue(const QString &key, const QVariant &data);
  66   virtual const QVariant &localValue(const QString &key, const QVariant &def = QVariant());
  67
  68   virtual void removeLocalKey(const QString &key);
  69
  70   QString group;
  71   QString appName;
  72
  73 private:
  74   inline QSettings::Format format() {
  75 #ifdef Q_WS_WIN
  76     return QSettings::IniFormat;
  77 #else
  78     return QSettings::NativeFormat;
  79 #endif
  80   }
  81   inline QString fileName() {
  82     return Quassel::configDirPath() + appName
  83            + ((format() == QSettings::NativeFormat) ? QLatin1String(".conf") : QLatin1String(".ini"));
  84   }
  85
  86   static QHash<QString, QVariant> settingsCache;
  87   static QHash<QString, SettingsChangeNotifier *> settingsChangeNotifier;
  88
  89   inline QString normalizedKey(const QString &group, const QString &key) {
  90     if(group.isEmpty())
  91       return key;
  92     return group + '/' + key;
  93   }
  94
  95   inline void setCacheValue(const QString &normKey, const QVariant &data) {
  96     settingsCache[normKey] = data;
  97   }
  98   inline const QVariant &cacheValue(const QString &normKey) {
  99     return settingsCache[normKey];
 100   }
 101   inline bool isCached(const QString &normKey) {
 102     return settingsCache.contains(normKey);
 103   }
 104
 105   inline SettingsChangeNotifier *notifier(const QString &normKey) {
 106     if(!hasNotifier(normKey))
 107       settingsChangeNotifier[normKey] = new SettingsChangeNotifier();
 108     return settingsChangeNotifier[normKey];
 109   }
 110
 111   inline bool hasNotifier(const QString &normKey) {
 112     return settingsChangeNotifier.contains(normKey);
 113   }
 114 };
 115
 116 #endif