Store.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 <QColor>
#include <QJsonObject>
#include <QObject>
#include <QString>
#include <QVariant>
#include <QVariantMap>
 
#include <memory>
 
namespace PhosphorConfig {
 
class IBackend;
struct Schema;
 
class PHOSPHORCONFIG_EXPORT Store : public QObject
{
    Q_OBJECT
 
public:
    Store(IBackend* backend, Schema schema, QObject* parent = nullptr);
 
    ~Store() override;
 
    template<typename T>
    T read(const QString& group, const QString& key) const
    {
        static_assert(sizeof(T) == 0,
                      "PhosphorConfig::Store::read<T> is only implemented for QString, int, bool, double, "
                      "QColor, QVariantMap, QVariantList — extend store.cpp with a new specialization to add "
                      "another type.");
        return T();
    }
 
    QVariant readVariant(const QString& group, const QString& key) const;
 
    void write(const QString& group, const QString& key, const QVariant& value);
 
    void reset(const QString& group, const QString& key);
 
    void resetGroup(const QString& group);
 
    void resetAll();
 
    QJsonObject exportToJson() const;
 
    QJsonObject defaultsToJson() const;
 
    bool importFromJson(const QJsonObject& snapshot);
 
    bool sync();
 
    bool commit();
 
    IBackend* backend() const;
 
    const Schema& schema() const;
 
Q_SIGNALS:
    void changed(const QString& group, const QString& key);
 
private:
    class Private;
    std::unique_ptr<Private> d;
};
 
// ─ Supported read<T> specializations ────────────────────────────────────
// read<T> is fully specialized in store.cpp for QString / int / bool /
// double / QColor / QVariantMap / QVariantList — calls with any other T
// will fail to link. Extend by adding a specialization there and
// re-declaring it below so consumers see a declaration without a
// primary-template body in the header.
 
template<>
PHOSPHORCONFIG_EXPORT QString Store::read<QString>(const QString&, const QString&) const;
template<>
PHOSPHORCONFIG_EXPORT int Store::read<int>(const QString&, const QString&) const;
template<>
PHOSPHORCONFIG_EXPORT bool Store::read<bool>(const QString&, const QString&) const;
template<>
PHOSPHORCONFIG_EXPORT double Store::read<double>(const QString&, const QString&) const;
template<>
PHOSPHORCONFIG_EXPORT QColor Store::read<QColor>(const QString&, const QString&) const;
template<>
PHOSPHORCONFIG_EXPORT QVariantMap Store::read<QVariantMap>(const QString&, const QString&) const;
template<>
PHOSPHORCONFIG_EXPORT QVariantList Store::read<QVariantList>(const QString&, const QString&) const;
 
} // namespace PhosphorConfig