SettingManager.h

//
//  SettingManager.h
//
//
//  Created by Clement on 2/2/15.
//  Copyright 2015 High Fidelity, Inc.
//  Copyright 2022 Overte e.V.
//
//  Distributed under the Apache License, Version 2.0.
//  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
 
#ifndef hifi_SettingManager_h
#define hifi_SettingManager_h
 
#include <QtCore/QPointer>
#include <QtCore/QSettings>
#include <QtCore/QTimer>
#include <QtCore/QUuid>
 
#include <QSettings>
#include <QThread>
#include <QLoggingCategory>
 
#include "DependencyManager.h"
#include "shared/ReadWriteLockable.h"
 
Q_DECLARE_LOGGING_CATEGORY(settings_manager)
Q_DECLARE_LOGGING_CATEGORY(settings_writer)
 
// This is for the testing system.
class SettingsTests;
class SettingsTestsWorker;
 
 
 
namespace Setting {
    class Interface;
 
    class WriteWorker : public QObject {
        Q_OBJECT
 
        public slots:
 
        void start();
 
        void setValue(const QString key, const QVariant value);
 
        void removeKey(const QString key);
 
        void clearAllSettings();
 
        void sync();
 
        void threadFinished();
 
        void terminate();
 
        private:
 
        void init() {
            if (!_qSettings) {
                _qSettings = new QSettings();
            }
        }
 
        QSettings* _qSettings = nullptr;
    };
 
    class Manager : public QObject, public ReadWriteLockable, public Dependency {
        Q_OBJECT
 
    public:
        Manager(QObject *parent = nullptr);
 
        void customDeleter() override;
 
        QString fileName() const;
 
        void remove(const QString &key);
 
        QStringList allKeys() const;
 
        bool contains(const QString &key) const;
 
        void setValue(const QString &key, const QVariant &value);
 
        QVariant value(const QString &key, const QVariant &defaultValue = QVariant()) const;
 
        void clearAllSettings();
    protected:
        const int THREAD_TERMINATION_TIMEOUT = 2000;
 
        ~Manager();
        void registerHandle(Interface* handle);
        void removeHandle(const QString& key);
 
        void loadSetting(Interface* handle);
        void saveSetting(Interface* handle);
 
 
        void forceSave();
 
        void terminateThread();
 
    signals:
        void valueChanged(const QString key, QVariant value);
 
        void keyRemoved(const QString key);
 
        void syncRequested();
 
        void clearAllSettingsRequested();
 
        void terminationRequested();
 
    private:
        QHash<QString, Interface*> _handles;
 
        friend class Interface;
        friend class ::SettingsTests;
        friend class ::SettingsTestsWorker;
 
        friend void cleanupSettingsSaveThread();
        friend void setupSettingsSaveThread();
 
 
        QHash<QString, QVariant> _settings;
        QString _fileName;
        QThread _workerThread;
    };
}
 
#endif // hifi_SettingManager_h