src/common/settings.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-08 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 <QString>
  27 #include <QVariant>
  28
  29 class SettingsChangeNotifier : public QObject {
  30   Q_OBJECT
  31
  32 signals:
  33   void valueChanged(const QVariant &newValue);
  34
  35 private:
  36   friend class Settings;
  37 };
  38
  39
  40
  41 class Settings {
  42 public:
  43   enum Mode { Default, Custom };
  44
  45 public:
  46   void notify(const QString &key, QObject *receiver, const char *slot);
  47
  48 protected:
  49   inline Settings(QString group_, QString appName_) : group(group_), appName(appName_) {}
  50   inline virtual ~Settings() {}
  51
  52   inline void setGroup(const QString &group_) { group = group_; }
  53
  54   virtual QStringList allLocalKeys();
  55   virtual QStringList localChildKeys(const QString &rootkey = QString());
  56   virtual QStringList localChildGroups(const QString &rootkey = QString());
  57
  58   virtual void setLocalValue(const QString &key, const QVariant &data);
  59   virtual const QVariant &localValue(const QString &key, const QVariant &def = QVariant());
  60
  61   virtual void removeLocalKey(const QString &key);
  62
  63   QString group;
  64   QString appName;
  65
  66 private:
  67   inline QString org() {
  68 #ifdef Q_WS_MAC
  69     return QCoreApplication::organizationDomain();
  70 #else
  71     return QCoreApplication::organizationName();
  72 #endif
  73   }
  74
  75   static QHash<QString, QHash<QString, QVariant> > settingsCache;
  76   static QHash<QString, QHash<QString, SettingsChangeNotifier *> > settingsChangeNotifier;
  77
  78   inline void setCacheValue(const QString &group, const QString &key, const QVariant &data) {
  79     settingsCache[group][key] = data;
  80   }
  81   inline const QVariant &cacheValue(const QString &group, const QString &key) {
  82     return settingsCache[group][key];
  83   }
  84   inline bool isCached(const QString &group, const QString &key) {
  85     return settingsCache.contains(group) && settingsCache[group].contains(key);
  86   }
  87
  88   inline SettingsChangeNotifier *notifier(const QString &group, const QString &key) {
  89     if(!hasNotifier(group, key))
  90       settingsChangeNotifier[group][key] = new SettingsChangeNotifier();
  91     return settingsChangeNotifier[group][key];
  92   }
  93
  94   inline bool hasNotifier(const QString &group, const QString &key) {
  95     return settingsChangeNotifier.contains(group) && settingsChangeNotifier[group].contains(key);
  96   }
  97 };
  98
  99 #endif