Schema.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 fuddlesworth
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#pragma once
 
#include <phosphorconfig_export.h>
 
#include <QJsonObject>
#include <QMap>
#include <QMetaType>
#include <QString>
#include <QVariant>
#include <QVector>
 
#include <functional>
#include <memory>
 
namespace PhosphorConfig {
 
class IGroupPathResolver;
 
struct PHOSPHORCONFIG_EXPORT ChoiceDef
{
    QVariant value;
 
    QString token;
};
 
struct PHOSPHORCONFIG_EXPORT KeyDef
{
    QString key;
    QVariant defaultValue;
    QMetaType::Type expectedType = QMetaType::UnknownType;
 
    QString description = {};
 
    std::function<QVariant(const QVariant& value)> validator = {};
 
    QVector<ChoiceDef> choices = {};
};
 
struct PHOSPHORCONFIG_EXPORT MigrationStep
{
    int fromVersion = 0;
    std::function<void(QJsonObject&)> migrate;
};
 
struct PHOSPHORCONFIG_EXPORT Schema
{
    int version = 1;
 
    QString versionKey = QStringLiteral("_version");
 
    QMap<QString, QVector<KeyDef>> groups;
 
    QVector<MigrationStep> migrations;
 
    std::shared_ptr<IGroupPathResolver> pathResolver;
 
    const KeyDef* findKey(const QString& group, const QString& key) const;
 
    QVariant defaultFor(const QString& group, const QString& key) const;
 
    QVector<ChoiceDef> choicesFor(const QString& group, const QString& key) const;
};
 
} // namespace PhosphorConfig