generator.h

// SPDX-FileCopyrightText: 2013-2025 Paul Colby <git@colby.id.au>
// SPDX-License-Identifier: LGPL-3.0-or-later
 
#include <QtGlobal> // \todo Remove if/when dropping support for Qt 6.0.x.
#if (QT_VERSION_CHECK(6, 0, 0) <= QT_VERSION) && (QT_VERSION < QT_VERSION_CHECK(6, 1, 0))
#include <limits> // https://bugreports.qt.io/browse/QTBUG-89977
#endif
 
#include <QCoreApplication>
#include <QDir>
#include <QJsonObject>
#include <QLoggingCategory>
 
namespace smithy {
  class Model;
  class Shape;
}
class Renderer;
 
class Generator
{
Q_DECLARE_TR_FUNCTIONS(Generator);
 
public:
    enum class ClobberMode {
        Prompt,
        Overwrite,
        Skip,
    };
 
    Generator(const smithy::Model * const model, Renderer * const renderer);
 
    int expectedFileCount() const;
 
    bool generate(const QString &outputDir, ClobberMode clobberMode);
 
    QStringList renderedFiles() const;
    QStringList skippedFiles() const;
 
protected:
    enum class Capitalisation {
        NoChange  = 0,
        lowercase = 1,
        camelCase = 2,
        CamelCase = 3,
        UPPERCASE = 4,
    };
 
    bool renderService(const smithy::Shape &service,
                       const QStringList &serviceTemplateNames,
                       const QStringList &operationTemplateNames,
                       const QString &outputDir, ClobberMode &clobberMode);
 
    bool renderOperation(const smithy::Shape &operation, const QVariantHash serviceContext,
                         const QStringList &templateNames, const QString &outputDir,
                         ClobberMode &clobberMode);
 
    bool render(const QString &templateName, const QString &outputPathName,
                ClobberMode &clobberMode);
 
    QVariantHash toContext(const smithy::Shape &shape) const;
 
    static const QString canonicalServiceId(const QString &sdkId);
 
    static bool promptToOverwrite(const QString &pathName, ClobberMode &clobberMode);
 
    static Capitalisation getCase(const QString &first, const QString &second);
    static QString makeCase(const QString &string, const Capitalisation &capitalisation);
    static QString makeOutputPathName(const QString &templateName, const QRegularExpression &pattern,
                                      const QHash<QString,QString> &ids,
                                      const QString &outputDir = QString{});
 
    static QStringList formatHtmlDocumentation(const QString &html);
 
private:
    const smithy::Model * const model;
    Renderer * const renderer;
    QStringList renderedPathNames;
    QStringList skippedPathNames;
 
    static const QRegularExpression servicePattern;
    static const QRegularExpression operationPattern;
    static Q_LOGGING_CATEGORY(lc, "smithy.Generator", QtInfoMsg); ///< Logging category for Generator.
};