mirror of
https://github.com/hyperion-project/hyperion.ng.git
synced 2025-03-01 10:33:28 +00:00
111 lines
3.0 KiB
C++
111 lines
3.0 KiB
C++
#pragma once
|
|
|
|
#include <utils/Logger.h>
|
|
#include <utils/settings.h>
|
|
|
|
#include <utils/version.hpp>
|
|
|
|
#include <db/SettingsTable.h>
|
|
using namespace semver;
|
|
|
|
// qt includes
|
|
#include <QJsonObject>
|
|
|
|
const char DEFAULT_VERSION[] = "2.0.0-alpha.8";
|
|
|
|
class Hyperion;
|
|
class SettingsTable;
|
|
|
|
///
|
|
/// @brief Manage the settings read write from/to configuration file, on settings changed will emit a signal to update components accordingly
|
|
///
|
|
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
|
|
///
|
|
SettingsManager(quint8 instance, QObject* parent = nullptr);
|
|
|
|
///
|
|
/// @brief Save a complete json configuration
|
|
/// @param config The entire config object
|
|
/// @param correct If true will correct json against schema before save
|
|
/// @return True on success else false
|
|
///
|
|
bool saveSettings(QJsonObject config, bool correct = false);
|
|
|
|
///
|
|
/// @brief Restore a complete json configuration
|
|
/// @param config The entire config object
|
|
/// @param correct If true will correct json against schema before save
|
|
/// @return True on success else false
|
|
///
|
|
bool restoreSettings(QJsonObject config, bool correct = false);
|
|
|
|
///
|
|
/// @brief get a single setting json from configuration
|
|
/// @param type The settings::type from enum
|
|
/// @return The requested json data as QJsonDocument
|
|
///
|
|
QJsonDocument getSetting(settings::type type) const;
|
|
|
|
///
|
|
/// @brief get a single setting json from configuration
|
|
/// @param type The type as string
|
|
/// @return The requested json data as QJsonDocument
|
|
///
|
|
QJsonDocument getSetting(const QString& type) const;
|
|
///
|
|
/// @brief get the selected settings objects of this instance (including global settings)
|
|
/// @return The requested json
|
|
///
|
|
//QJsonObject getSettings(const QStringList& type = {} ) const;
|
|
|
|
QJsonObject getSettings(const QStringList& filteredTypes = {}) const;
|
|
QJsonObject getSettings(const QVariant& instance, const QStringList& filteredTypes = {} ) const;
|
|
|
|
signals:
|
|
///
|
|
/// @brief Emits whenever a configuration part changed.
|
|
/// @param type The settings type from enum
|
|
/// @param data The data as QJsonDocument
|
|
///
|
|
void settingsChanged(settings::type type, const QJsonDocument& data);
|
|
|
|
private:
|
|
///
|
|
/// @brief Add possible migrations steps for configuration here
|
|
/// @param config The configuration object
|
|
/// @return True when a migration has been triggered
|
|
///
|
|
bool handleConfigUpgrade(QJsonObject& config);
|
|
|
|
bool resolveConfigVersion(const QJsonObject& config);
|
|
|
|
/// Logger instance
|
|
Logger* _log;
|
|
|
|
/// Hyperion instance
|
|
Hyperion* _hyperion;
|
|
|
|
/// Instance number
|
|
quint8 _instance;
|
|
|
|
/// instance of database table interface
|
|
SettingsTable* _sTable;
|
|
|
|
/// the schema
|
|
static QJsonObject schemaJson;
|
|
|
|
/// the current configuration of this instance
|
|
QJsonObject _qconfig;
|
|
|
|
semver::version _configVersion;
|
|
semver::version _previousVersion;
|
|
|
|
};
|