qqmltcoutputprimitives_p.h

Go to the documentation of this file.

// Copyright (C) 2021 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
// Qt-Security score:significant
 
#ifndef QQMLTCOUTPUTPRIMITIVES_P_H
#define QQMLTCOUTPUTPRIMITIVES_P_H
 
//
//  W A R N I N G
//  -------------
//
// This file is not part of the Qt API.  It exists purely as an
// implementation detail.  This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
//
 
#include <QtCore/qstack.h>
#include <QtCore/qstring.h>
#include <QtCore/qstringbuilder.h>
 
QT_BEGIN_NAMESPACE
 
namespace QQmltc {
 
struct Output
{
    QString header;
    QString cpp;
};
 
class OutputWrapper
{
    Output &m_code;
 
    template<typename String>
    static void rawAppend(QString &out, const String &what, int extraIndent = 0)
    {
        constexpr char16_t newLine[] = u"\n";
        out += QString(extraIndent * 4, u' ') + what + newLine;
    }
 
public:
    OutputWrapper(Output &code) : m_code(code) { }
    const Output &code() const { return m_code; }
 
    QStack<QString> memberScopes; // member name scopes e.g. MyClass::MySubclass::
    int headerIndent = 0; // header indentation level
    int cppIndent = 0; // cpp indentation level
 
    // manages current scope of the generated code, which is necessary for
    // cpp file generation. Example:
    // class MyClass { MyClass(); };    - in header
    // MyClass::MyClass() {}            - in cpp
    // MemberNameScope makes sure "MyClass::" is recorded
    struct MemberNameScope
    {
        OutputWrapper *m_code;
        MemberNameScope(OutputWrapper *code, const QString &str) : m_code(code)
        {
            m_code->memberScopes.push(str);
        }
        ~MemberNameScope() { m_code->memberScopes.pop(); }
        Q_DISABLE_COPY_MOVE(MemberNameScope)
    };
 
    struct HeaderIndentationScope
    {
        OutputWrapper *m_code;
        HeaderIndentationScope(OutputWrapper *code) : m_code(code) { ++m_code->headerIndent; }
        ~HeaderIndentationScope() { --m_code->headerIndent; }
        Q_DISABLE_COPY_MOVE(HeaderIndentationScope)
    };
 
    struct CppIndentationScope
    {
        OutputWrapper *m_code;
        CppIndentationScope(OutputWrapper *code) : m_code(code) { ++m_code->cppIndent; }
        ~CppIndentationScope() { --m_code->cppIndent; }
        Q_DISABLE_COPY_MOVE(CppIndentationScope)
    };
 
    // appends string \a what with extra indentation \a extraIndent to current
    // header string
    template<typename String>
    void rawAppendToHeader(const String &what, int extraIndent = 0)
    {
        rawAppend(m_code.header, what, headerIndent + extraIndent);
    }
 
    // appends string \a what with extra indentation \a extraIndent to current
    // cpp string
    template<typename String>
    void rawAppendToCpp(const String &what, int extraIndent = 0)
    {
        rawAppend(m_code.cpp, what, cppIndent + extraIndent);
    }
 
    // special case of rawAppendToCpp that makes sure that string "foo()"
    // becomes "MyClass::foo()"
    template<typename String>
    void rawAppendSignatureToCpp(const String &what, int extraIndent = 0)
    {
        QString signatureScope;
        for (const auto &scope : std::as_const(memberScopes))
            signatureScope += scope + u"::";
        rawAppendToCpp(signatureScope + what, extraIndent);
    }
};
 
} // namespace QQmltc
 
QT_END_NAMESPACE
 
#endif // QQMLTCOUTPUTPRIMITIVES_P_H