hyperion.ng/include/hyperion/SettingsManager.h

79 lines
2.0 KiB
C
Raw Normal View History

2018-12-27 23:11:32 +01:00
#pragma once
#include <utils/Logger.h>
#include <utils/settings.h>
// qt incl
#include <QJsonObject>
class Hyperion;
class SettingsTable;
2018-12-27 23:11:32 +01:00
///
2018-12-31 15:48:29 +01:00
/// @brief Manage the settings read write from/to config file, on settings changed will emit a signal to update components accordingly
2018-12-27 23:11:32 +01:00
///
class SettingsManager : public QObject
{
Q_OBJECT
public:
///
/// @brief Construct a settings manager and assign a hyperion instance
/// @params instance Instance index of HyperionInstanceManager
/// @params parent The parent hyperion instance
2018-12-27 23:11:32 +01:00
///
2020-08-08 13:09:15 +02:00
SettingsManager(quint8 instance, QObject* parent = nullptr);
2018-12-27 23:11:32 +01:00
///
/// @brief Save a complete json config
/// @param config The entire config object
/// @param correct If true will correct json against schema before save
/// @return True on success else false
2018-12-27 23:11:32 +01:00
///
2020-08-08 13:09:15 +02:00
bool saveSettings(QJsonObject config, bool correct = false);
2018-12-27 23:11:32 +01:00
///
2018-12-31 15:48:29 +01:00
/// @brief get a single setting json from config
/// @param type The settings::type from enum
/// @return The requested json data as QJsonDocument
2018-12-27 23:11:32 +01:00
///
2020-08-08 13:09:15 +02:00
QJsonDocument getSetting(settings::type type) const;
2018-12-27 23:11:32 +01:00
///
/// @brief get the full settings object of this instance (with global settings)
/// @return The requested json
2018-12-27 23:11:32 +01:00
///
2020-08-08 13:09:15 +02:00
const QJsonObject & getSettings() const { return _qconfig; };
2018-12-27 23:11:32 +01:00
signals:
///
2018-12-31 15:48:29 +01:00
/// @brief Emits whenever a config part changed.
/// @param type The settings type from enum
/// @param data The data as QJsonDocument
2018-12-27 23:11:32 +01:00
///
2020-08-08 13:09:15 +02:00
void settingsChanged(settings::type type, const QJsonDocument& data);
2018-12-27 23:11:32 +01:00
private:
///
/// @brief Add possile migrations steps for config here
/// @param config The configuration object
/// @return True when a migration has been triggered
///
bool handleConfigUpgrade(QJsonObject& config);
2018-12-27 23:11:32 +01:00
/// Hyperion instance
Hyperion* _hyperion;
2018-12-31 15:48:29 +01:00
2018-12-27 23:11:32 +01:00
/// Logger instance
Logger* _log;
2018-12-31 15:48:29 +01:00
/// instance of database table interface
SettingsTable* _sTable;
2018-12-27 23:11:32 +01:00
/// the schema
static QJsonObject schemaJson;
2018-12-31 15:48:29 +01:00
2018-12-27 23:11:32 +01:00
/// the current config of this instance
QJsonObject _qconfig;
};