/***************************************************************************
- * Copyright (C) 2005-2018 by the Quassel Project *
+ * Copyright (C) 2005-2020 by the Quassel Project *
* devel@quassel-irc.org *
* *
* This program is free software; you can redistribute it and/or modify *
#include <memory>
#include <type_traits>
+#include <utility>
#include <QCoreApplication>
#include <QHash>
#include <QSettings>
#include <QString>
#include <QVariant>
-#include <utility>
#include "quassel.h"
Q_OBJECT
signals:
- void valueChanged(const QVariant &newValue);
+ void valueChanged(const QVariant& newValue);
private:
friend class Settings;
};
-
class COMMON_EXPORT Settings
{
public:
- enum Mode { Default, Custom };
+ enum Mode
+ {
+ Default,
+ Custom
+ };
public:
//! Calls the given slot on change of the given key
template<typename Receiver, typename Slot>
- void notify(const QString &key, const Receiver *receiver, Slot slot) const
+ void notify(const QString& key, const Receiver* receiver, Slot slot) const
{
static_assert(!std::is_same<Slot, const char*>::value, "Old-style slots not supported");
QObject::connect(notifier(normalizedKey(_group, keyForNotify(key))), &SettingsChangeNotifier::valueChanged, receiver, slot);
//! Sets up notification and calls the given slot to set the initial value
template<typename Receiver, typename Slot>
- void initAndNotify(const QString &key, const Receiver *receiver, Slot slot, const QVariant &defaultValue = {}) const
+ void initAndNotify(const QString& key, const Receiver* receiver, Slot slot, const QVariant& defaultValue = {}) const
{
notify(key, receiver, std::move(slot));
auto notifyKey = keyForNotify(key);
* @param key Key given to notify()
* @returns Key that should be used for notfication
*/
- virtual QString keyForNotify(const QString &key) const;
+ virtual QString keyForNotify(const QString& key) const;
virtual QStringList allLocalKeys() const;
- virtual QStringList localChildKeys(const QString &rootkey = QString()) const;
- virtual QStringList localChildGroups(const QString &rootkey = QString()) const;
+ virtual QStringList localChildKeys(const QString& rootkey = QString()) const;
+ virtual QStringList localChildGroups(const QString& rootkey = QString()) const;
- virtual void setLocalValue(const QString &key, const QVariant &data);
- virtual QVariant localValue(const QString &key, const QVariant &def = QVariant()) const;
+ virtual void setLocalValue(const QString& key, const QVariant& data);
+ virtual QVariant localValue(const QString& key, const QVariant& def = QVariant()) const;
/**
* 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) const;
+ virtual bool localKeyExists(const QString& key) const;
- virtual void removeLocalKey(const QString &key);
+ virtual void removeLocalKey(const QString& key);
QString _group;
QString _appName;
QString fileName() const;
- QString normalizedKey(const QString &group, const QString &key) const;
+ QString normalizedKey(const QString& group, const QString& key) const;
/**
* 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
*/
- void setCacheKeyPersisted(const QString &normKey, bool exists) const;
+ void setCacheKeyPersisted(const QString& normKey, bool exists) const;
/**
* Check if the given settings key ID persists on disk (rather than being a default value)
* @param normKey Normalized settings key ID
* @return True if key exists and persistence has been cached, otherwise false
*/
- bool cacheKeyPersisted(const QString &normKey) const;
+ bool cacheKeyPersisted(const QString& normKey) const;
/**
* 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
*/
- bool isKeyPersistedCached(const QString &normKey) const;
+ bool isKeyPersistedCached(const QString& normKey) const;
- void setCacheValue(const QString &normKey, const QVariant &data) const;
+ void setCacheValue(const QString& normKey, const QVariant& data) const;
- QVariant cacheValue(const QString &normKey) const;
+ QVariant cacheValue(const QString& normKey) const;
- bool isCached(const QString &normKey) const;
+ bool isCached(const QString& normKey) const;
- SettingsChangeNotifier *notifier(const QString &normKey) const;
+ SettingsChangeNotifier* notifier(const QString& normKey) const;
- bool hasNotifier(const QString &normKey) const;
+ bool hasNotifier(const QString& normKey) const;
private:
- static QHash<QString, QVariant> _settingsCache; ///< Cached settings values
- static QHash<QString, bool> _settingsKeyPersistedCache; ///< Cached settings key exists on disk
+ static QHash<QString, QVariant> _settingsCache; ///< Cached settings values
+ static QHash<QString, bool> _settingsKeyPersistedCache; ///< Cached settings key exists on disk
static QHash<QString, std::shared_ptr<SettingsChangeNotifier>> _settingsChangeNotifier;
};