SchemaValidator.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 fuddlesworth
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#pragma once
 
#include <PhosphorFsLoader/phosphorfsloader_export.h>
 
#include <QtCore/QByteArray>
#include <QtCore/QJsonValue>
#include <QtCore/QList>
#include <QtCore/QString>
 
#include <memory>
#include <optional>
 
class QLoggingCategory;
 
namespace PhosphorFsLoader {
 
class PHOSPHORFSLOADER_EXPORT SchemaValidator
{
public:
    struct Error
    {
        QString path;
 
        QString message;
    };
 
    explicit SchemaValidator(const QByteArray& schemaJson);
    ~SchemaValidator();
 
    SchemaValidator(SchemaValidator&&) noexcept;
    SchemaValidator& operator=(SchemaValidator&&) noexcept;
    SchemaValidator(const SchemaValidator&) = delete;
    SchemaValidator& operator=(const SchemaValidator&) = delete;
 
    [[nodiscard]] static SchemaValidator fromResource(const QString& resourcePath, const QLoggingCategory& category);
 
    [[nodiscard]] bool isValid() const;
 
    [[nodiscard]] std::optional<QList<Error>> validate(const QJsonValue& document) const;
 
private:
    struct Private;
    std::unique_ptr<Private> d;
};
 
PHOSPHORFSLOADER_EXPORT void logSchemaErrors(const QLoggingCategory& category,
                                             const QList<SchemaValidator::Error>& errors);
 
} // namespace PhosphorFsLoader