aboutsummaryrefslogtreecommitdiffstats
path: root/src/qmldom/qqmldomreformatter_p.h
blob: fc665db0b08cc4c79462dd3321eff1259e7218e3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
// Copyright (C) 2021 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only

#ifndef QQMLDOMREFORMATTER_P
#define QQMLDOMREFORMATTER_P

//
//  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 "qqmldom_global.h"

#include "qqmldomoutwriter_p.h"
#include "qqmldom_fwd_p.h"
#include "qqmldomcomments_p.h"
#include "qqmldomelements_p.h"

#include <QtQml/private/qqmljsast_p.h>

QT_BEGIN_NAMESPACE
namespace QQmlJS {
namespace Dom {

class ScriptFormatter final : protected AST::JSVisitor
{
public:
    // TODO QTBUG-121988
    ScriptFormatter(OutWriter &lw, const ScriptExpression *const script) : lw(lw), m_script(script)
    {
        if (m_script) {
            comments = m_script->astComments();
            accept(m_script->ast());
        }
    }

protected:
    inline void out(const char *str) { lw.write(QString::fromLatin1(str)); }
    inline void out(QStringView str) { lw.write(str); }
    inline void out(const SourceLocation &loc)
    {
        if (loc.length != 0)
            out(m_script->loc2Str(loc));
    }
    enum CommentOption { NoSpace, SpaceBeforePostComment, OnlyComments };
    void outWithComments(const SourceLocation &loc, AST::Node *node, CommentOption option = NoSpace)
    {
        if (!loc.isValid())
            return;
        const CommentedElement *c = comments->commentForNode(node, CommentAnchor::from(loc));
        if (c)
            c->writePre(lw);
        if (option != OnlyComments)
            out(loc);
        if (option == SpaceBeforePostComment)
            lw.ensureSpace();
        if (c)
            c->writePost(lw);
    }
    inline void newLine(quint32 count = 1) { lw.ensureNewline(count); }

    inline void accept(AST::Node *node) { AST::Node::accept(node, this); }
    void lnAcceptIndented(AST::Node *node);
    bool acceptBlockOrIndented(AST::Node *ast, bool finishWithSpaceOrNewline = false);

    bool preVisit(AST::Node *n) override;
    void postVisit(AST::Node *n) override;

    bool visit(AST::ThisExpression *ast) override;
    bool visit(AST::NullExpression *ast) override;
    bool visit(AST::TrueLiteral *ast) override;
    bool visit(AST::FalseLiteral *ast) override;
    bool visit(AST::IdentifierExpression *ast) override;
    bool visit(AST::StringLiteral *ast) override;
    bool visit(AST::NumericLiteral *ast) override;
    bool visit(AST::RegExpLiteral *ast) override;

    bool visit(AST::ArrayPattern *ast) override;

    bool visit(AST::ObjectPattern *ast) override;

    bool visit(AST::PatternElementList *ast) override;

    bool visit(AST::PatternPropertyList *ast) override;
    bool visit(AST::PatternProperty *property) override;

    bool visit(AST::NestedExpression *ast) override;
    bool visit(AST::IdentifierPropertyName *ast) override;
    bool visit(AST::StringLiteralPropertyName *ast) override;
    bool visit(AST::NumericLiteralPropertyName *ast) override;

    bool visit(AST::TemplateLiteral *ast) override;
    bool visit(AST::ArrayMemberExpression *ast) override;

    bool visit(AST::FieldMemberExpression *ast) override;

    bool visit(AST::NewMemberExpression *ast) override;

    bool visit(AST::NewExpression *ast) override;

    bool visit(AST::CallExpression *ast) override;

    bool visit(AST::PostIncrementExpression *ast) override;

    bool visit(AST::PostDecrementExpression *ast) override;
    bool visit(AST::PreIncrementExpression *ast) override;

    bool visit(AST::PreDecrementExpression *ast) override;

    bool visit(AST::DeleteExpression *ast) override;

    bool visit(AST::VoidExpression *ast) override;
    bool visit(AST::TypeOfExpression *ast) override;

    bool visit(AST::UnaryPlusExpression *ast) override;

    bool visit(AST::UnaryMinusExpression *ast) override;

    bool visit(AST::TildeExpression *ast) override;

    bool visit(AST::NotExpression *ast) override;

    bool visit(AST::BinaryExpression *ast) override;

    bool visit(AST::ConditionalExpression *ast) override;

    bool visit(AST::Block *ast) override;

    bool visit(AST::VariableStatement *ast) override;

    bool visit(AST::PatternElement *ast) override;

    bool visit(AST::EmptyStatement *ast) override;

    bool visit(AST::IfStatement *ast) override;
    bool visit(AST::DoWhileStatement *ast) override;

    bool visit(AST::WhileStatement *ast) override;

    bool visit(AST::ForStatement *ast) override;

    bool visit(AST::ForEachStatement *ast) override;

    bool visit(AST::ContinueStatement *ast) override;
    bool visit(AST::BreakStatement *ast) override;

    bool visit(AST::ReturnStatement *ast) override;
    bool visit(AST::YieldExpression *ast) override;
    bool visit(AST::ThrowStatement *ast) override;
    bool visit(AST::WithStatement *ast) override;

    bool visit(AST::SwitchStatement *ast) override;

    bool visit(AST::CaseBlock *ast) override;

    bool visit(AST::CaseClause *ast) override;

    bool visit(AST::DefaultClause *ast) override;

    bool visit(AST::LabelledStatement *ast) override;

    bool visit(AST::TryStatement *ast) override;

    bool visit(AST::Catch *ast) override;

    bool visit(AST::Finally *ast) override;

    bool visit(AST::FunctionDeclaration *ast) override;

    bool visit(AST::FunctionExpression *ast) override;

    bool visit(AST::Elision *ast) override;

    bool visit(AST::ArgumentList *ast) override;

    bool visit(AST::StatementList *ast) override;

    bool visit(AST::VariableDeclarationList *ast) override;

    bool visit(AST::CaseClauses *ast) override;

    bool visit(AST::FormalParameterList *ast) override;

    bool visit(AST::SuperLiteral *) override;
    bool visit(AST::ComputedPropertyName *) override;
    bool visit(AST::CommaExpression *el) override;
    bool visit(AST::ExpressionStatement *el) override;

    bool visit(AST::ClassDeclaration *ast) override;

    bool visit(AST::ImportDeclaration *ast) override;
    bool visit(AST::ImportSpecifier *ast) override;
    bool visit(AST::NameSpaceImport *ast) override;
    bool visit(AST::ImportsList *ast) override;
    bool visit(AST::NamedImports *ast) override;
    bool visit(AST::ImportClause *ast) override;

    bool visit(AST::ExportDeclaration *ast) override;
    bool visit(AST::ExportClause *ast) override;
    bool visit(AST::ExportSpecifier *ast) override;
    bool visit(AST::ExportsList *ast) override;

    bool visit(AST::FromClause *ast) override;

    void endVisit(AST::ComputedPropertyName *) override;

    void endVisit(AST::ExportDeclaration *ast) override;
    void endVisit(AST::ExportClause *ast) override;

    void endVisit(AST::ImportDeclaration *ast) override;
    void endVisit(AST::NamedImports *ast) override;

    void throwRecursionDepthError() override;

private:
    bool addSemicolons() const { return expressionDepth > 0; }
    bool canRemoveSemicolon(AST::Node *node);
    OutWriter &writeOutSemicolon(AST::Node *);
    OutWriter &lw;
    std::shared_ptr<AstComments> comments;
    const ScriptExpression *const m_script = nullptr; // outlives this
    QHash<AST::Node *, QList<std::function<void()>>> postOps;
    int expressionDepth = 0;
};

QMLDOM_EXPORT void reformatAst(OutWriter &lw, const QQmlJS::Dom::ScriptExpression *const script);

} // namespace Dom
} // namespace QQmlJS
QT_END_NAMESPACE

#endif // QQMLDOMREFORMATTER_P