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   virtual void notify(const QString &key, QObject *receiver, const char *slot);
  48   virtual uint version();
  49
  50 protected:
  51   inline Settings(QString group_, QString appName_) : group(group_), appName(appName_) {}
  52   inline virtual ~Settings() {}
  53
  54   inline void setGroup(const QString &group_) { group = group_; }
  55
  56   virtual QStringList allLocalKeys();
  57   virtual QStringList localChildKeys(const QString &rootkey = QString());
  58   virtual QStringList localChildGroups(const QString &rootkey = QString());
  59
  60   virtual void setLocalValue(const QString &key, const QVariant &data);
  61   virtual const QVariant &localValue(const QString &key, const QVariant &def = QVariant());
  62
  63   virtual void removeLocalKey(const QString &key);
  64
  65   QString group;
  66   QString appName;
  67
  68 private:
  69   inline QSettings::Format format() {
  70 #ifdef Q_WS_WIN
  71     return QSettings::IniFormat;
  72 #else
  73     return QSettings::NativeFormat;
  74 #endif
  75   }
  76   inline QString fileName() {
  77     return Quassel::configDirPath() + appName
  78            + ((format() == QSettings::NativeFormat) ? QLatin1String(".conf") : QLatin1String(".ini"));
  79   }
  80
  81   static QHash<QString, QHash<QString, QVariant> > settingsCache;
  82   static QHash<QString, QHash<QString, SettingsChangeNotifier *> > settingsChangeNotifier;
  83
  84   inline void setCacheValue(const QString &group, const QString &key, const QVariant &data) {
  85     settingsCache[group][key] = data;
  86   }
  87   inline const QVariant &cacheValue(const QString &group, const QString &key) {
  88     return settingsCache[group][key];
  89   }
  90   inline bool isCached(const QString &group, const QString &key) {
  91     return settingsCache.contains(group) && settingsCache[group].contains(key);
  92   }
  93
  94   inline SettingsChangeNotifier *notifier(const QString &group, const QString &key) {
  95     if(!hasNotifier(group, key))
  96       settingsChangeNotifier[group][key] = new SettingsChangeNotifier();
  97     return settingsChangeNotifier[group][key];
  98   }
  99
 100   inline bool hasNotifier(const QString &group, const QString &key) {
 101     return settingsChangeNotifier.contains(group) && settingsChangeNotifier[group].contains(key);
 102   }
 103 };
 104
 105 #endif