injabridge.h

Go to the documentation of this file.

// Copyright (C) 2025 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
 
#ifndef INJABRIDGE_H
#define INJABRIDGE_H
 
#include <QtCore/qlogging.h>
 
// Override Inja's default error handling before including inja.hpp.
// Inja's throw.hpp guards INJA_THROW with #ifndef, so defining it first
// takes precedence. Without this override, -fno-exceptions causes a bare
// std::abort() with no diagnostic output. With it, qFatal() logs the
// error message (including source location) before terminating.
#define INJA_THROW(exception)
    qFatal("Inja template error: %s", (exception).what())
 
#include <inja/inja.hpp>
 
#include <QJsonObject>
#include <QJsonArray>
#include <QJsonValue>
#include <QString>
 
#include <functional>
 
QT_BEGIN_NAMESPACE
 
class InjaBridge
{
public:
    using IncludeCallback = std::function<QString(const QString &name)>;
 
    static nlohmann::json toInjaJson(const QJsonValue &value);
    static nlohmann::json toInjaJson(const QJsonObject &obj);
    static nlohmann::json toInjaJson(const QJsonArray &array);
 
    static QString render(const QString &templateStr, const QJsonObject &data,
                          const QString &format = {});
    static QString render(const QString &templateStr, const QJsonObject &data,
                          const IncludeCallback &includeCallback,
                          const QString &format = {});
    static QString renderFile(const QString &templatePath, const QJsonObject &data,
                              const QString &format = {});
 
private:
    InjaBridge() = default;
};
 
QT_END_NAMESPACE
 
#endif // INJABRIDGE_H