1// Copyright (C) 2021 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
3
4#ifndef QMLMARKUPVISITOR_H
5#define QMLMARKUPVISITOR_H
6
7#include "node.h"
8#include "tree.h"
9#include "utilities.h"
10
11#include <QtCore/qstring.h>
12
13#include <private/qqmljsastvisitor_p.h>
14#include <private/qqmljsengine_p.h>
15
16QT_BEGIN_NAMESPACE
17
18class QmlMarkupVisitor : public QQmlJS::AST::Visitor
19{
20public:
21 enum ExtraType { Comment, Pragma };
22
23 QmlMarkupVisitor(const QString &code, const QList<QQmlJS::SourceLocation> &pragmas,
24 QQmlJS::Engine *engine);
25 ~QmlMarkupVisitor() override = default;
26
27 QString markedUpCode();
28 [[nodiscard]] bool hasError() const;
29
30 bool visit(QQmlJS::AST::UiImport *) override;
31 void endVisit(QQmlJS::AST::UiImport *) override;
32
33 bool visit(QQmlJS::AST::UiPublicMember *) override;
34 bool visit(QQmlJS::AST::UiObjectDefinition *) override;
35
36 bool visit(QQmlJS::AST::UiObjectInitializer *) override;
37 void endVisit(QQmlJS::AST::UiObjectInitializer *) override;
38
39 bool visit(QQmlJS::AST::UiObjectBinding *) override;
40 bool visit(QQmlJS::AST::UiScriptBinding *) override;
41 bool visit(QQmlJS::AST::UiArrayBinding *) override;
42 bool visit(QQmlJS::AST::UiArrayMemberList *) override;
43 bool visit(QQmlJS::AST::UiQualifiedId *) override;
44
45 bool visit(QQmlJS::AST::ThisExpression *) override;
46 bool visit(QQmlJS::AST::IdentifierExpression *) override;
47 bool visit(QQmlJS::AST::NullExpression *) override;
48 bool visit(QQmlJS::AST::TrueLiteral *) override;
49 bool visit(QQmlJS::AST::FalseLiteral *) override;
50 bool visit(QQmlJS::AST::NumericLiteral *) override;
51 bool visit(QQmlJS::AST::StringLiteral *) override;
52 bool visit(QQmlJS::AST::RegExpLiteral *) override;
53 bool visit(QQmlJS::AST::ArrayPattern *) override;
54
55 bool visit(QQmlJS::AST::ObjectPattern *) override;
56 void endVisit(QQmlJS::AST::ObjectPattern *) override;
57
58 bool visit(QQmlJS::AST::PatternElementList *) override;
59 bool visit(QQmlJS::AST::Elision *) override;
60 bool visit(QQmlJS::AST::PatternProperty *) override;
61 bool visit(QQmlJS::AST::ArrayMemberExpression *) override;
62 bool visit(QQmlJS::AST::FieldMemberExpression *) override;
63 bool visit(QQmlJS::AST::NewMemberExpression *) override;
64 bool visit(QQmlJS::AST::NewExpression *) override;
65 bool visit(QQmlJS::AST::ArgumentList *) override;
66 bool visit(QQmlJS::AST::PostIncrementExpression *) override;
67 bool visit(QQmlJS::AST::PostDecrementExpression *) override;
68 bool visit(QQmlJS::AST::DeleteExpression *) override;
69 bool visit(QQmlJS::AST::VoidExpression *) override;
70 bool visit(QQmlJS::AST::TypeOfExpression *) override;
71 bool visit(QQmlJS::AST::PreIncrementExpression *) override;
72 bool visit(QQmlJS::AST::PreDecrementExpression *) override;
73 bool visit(QQmlJS::AST::UnaryPlusExpression *) override;
74 bool visit(QQmlJS::AST::UnaryMinusExpression *) override;
75 bool visit(QQmlJS::AST::TildeExpression *) override;
76 bool visit(QQmlJS::AST::NotExpression *) override;
77 bool visit(QQmlJS::AST::BinaryExpression *) override;
78 bool visit(QQmlJS::AST::ConditionalExpression *) override;
79 bool visit(QQmlJS::AST::CommaExpression *) override;
80
81 bool visit(QQmlJS::AST::Block *) override;
82 void endVisit(QQmlJS::AST::Block *) override;
83
84 bool visit(QQmlJS::AST::VariableStatement *) override;
85 bool visit(QQmlJS::AST::VariableDeclarationList *) override;
86 bool visit(QQmlJS::AST::EmptyStatement *) override;
87 bool visit(QQmlJS::AST::ExpressionStatement *) override;
88 bool visit(QQmlJS::AST::IfStatement *) override;
89 bool visit(QQmlJS::AST::DoWhileStatement *) override;
90 bool visit(QQmlJS::AST::WhileStatement *) override;
91 bool visit(QQmlJS::AST::ForStatement *) override;
92 bool visit(QQmlJS::AST::ForEachStatement *) override;
93 bool visit(QQmlJS::AST::ContinueStatement *) override;
94 bool visit(QQmlJS::AST::BreakStatement *) override;
95 bool visit(QQmlJS::AST::ReturnStatement *) override;
96 bool visit(QQmlJS::AST::WithStatement *) override;
97
98 bool visit(QQmlJS::AST::CaseBlock *) override;
99 void endVisit(QQmlJS::AST::CaseBlock *) override;
100
101 bool visit(QQmlJS::AST::SwitchStatement *) override;
102 bool visit(QQmlJS::AST::CaseClause *) override;
103 bool visit(QQmlJS::AST::DefaultClause *) override;
104 bool visit(QQmlJS::AST::LabelledStatement *) override;
105 bool visit(QQmlJS::AST::ThrowStatement *) override;
106 bool visit(QQmlJS::AST::TryStatement *) override;
107 bool visit(QQmlJS::AST::Catch *) override;
108 bool visit(QQmlJS::AST::Finally *) override;
109 bool visit(QQmlJS::AST::FunctionDeclaration *) override;
110 bool visit(QQmlJS::AST::FunctionExpression *) override;
111 bool visit(QQmlJS::AST::FormalParameterList *) override;
112 bool visit(QQmlJS::AST::DebuggerStatement *) override;
113
114private:
115 typedef QHash<QString, QString> StringHash;
116 void addExtra(quint32 start, quint32 finish);
117 void addMarkedUpToken(QQmlJS::SourceLocation &location, const QString &text,
118 const StringHash &attributes = StringHash());
119 void addVerbatim(QQmlJS::SourceLocation first,
120 QQmlJS::SourceLocation last = QQmlJS::SourceLocation());
121 QString sourceText(QQmlJS::SourceLocation &location);
122 void throwRecursionDepthError() final;
123
124 QQmlJS::Engine *m_engine { nullptr };
125 QList<ExtraType> m_extraTypes {};
126 QList<QQmlJS::SourceLocation> m_extraLocations {};
127 QString m_source {};
128 QString m_output {};
129 quint32 m_cursor {};
130 int m_extraIndex {};
131 bool m_hasRecursionDepthError { false };
132};
133Q_DECLARE_TYPEINFO(QmlMarkupVisitor::ExtraType, Q_PRIMITIVE_TYPE);
134
135QT_END_NAMESPACE
136
137#endif
138

source code of qttools/src/qdoc/qdoc/src/qdoc/qmlmarkupvisitor.h