aboutsummaryrefslogtreecommitdiffstats
path: root/tools/qmllint/scopetree.h
blob: f5d1155a49e21b00941f649d62bf47e9b222a62b (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
/****************************************************************************
**
** Copyright (C) 2019 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the tools applications of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:GPL-EXCEPT$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef SCOPETREE_H
#define SCOPETREE_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 "metatypes.h"
#include "componentversion.h"

#include <QtQml/private/qqmljsast_p.h>
#include <QtQml/private/qqmljssourcelocation_p.h>

#include <QtCore/qset.h>
#include <QtCore/qhash.h>
#include <QtCore/qstring.h>

enum MessageColors
{
    Error,
    Warning,
    Info,
    Normal,
    Hint
};

enum class ScopeType
{
    JSFunctionScope,
    JSLexicalScope,
    QMLScope
};

struct MethodUsage
{
    MetaMethod method;
    QQmlJS::AST::SourceLocation loc;
    bool hasMultilineHandlerBody;
};

class ColorOutput;
class ScopeTree
{
    Q_DISABLE_COPY_MOVE(ScopeTree)
public:
    using Ptr = QSharedPointer<ScopeTree>;
    using ConstPtr = QSharedPointer<const ScopeTree>;

    class Export {
    public:
        Export() = default;
        Export(QString package, QString type, const ComponentVersion &version,
               int metaObjectRevision);

        bool isValid() const;

        int metaObjectRevision() const { return m_metaObjectRevision; }
        void setMetaObjectRevision(int metaObjectRevision)
        {
            m_metaObjectRevision = metaObjectRevision;
        }

        QString package() const { return m_package; }
        QString type() const { return m_type; }

    private:
        QString m_package;
        QString m_type;
        ComponentVersion m_version;
        int m_metaObjectRevision = 0;
    };

    ScopeTree(ScopeType type, QString name = QString(),
              ScopeTree *parentScope = nullptr);

    ScopeTree::Ptr createNewChildScope(ScopeType type, const QString &name);
    ScopeTree *parentScope() const { return m_parentScope; }

    void insertJSIdentifier(const QString &id, QQmlJS::AST::VariableScope scope);
    void insertSignalIdentifier(const QString &id, const MetaMethod &method,
                                const QQmlJS::AST::SourceLocation &loc, bool hasMultilineHandlerBody);
    // inserts property as qml identifier as well as the corresponding
    void insertPropertyIdentifier(const MetaProperty &prop);
    void addUnmatchedSignalHandler(const QString &handler,
                                   const QQmlJS::AST::SourceLocation &location);

    bool isIdInCurrentScope(const QString &id) const;
    void addIdToAccessed(const QString &id, const QQmlJS::AST::SourceLocation &location);
    void accessMember(const QString &name, const QString &parentType,
                      const QQmlJS::AST::SourceLocation &location);
    void resetMemberScope();

    bool isVisualRootScope() const;
    QString name() const { return m_name; }

    bool recheckIdentifiers(
            const QString &code,
            const QHash<QString, const ScopeTree *> &qmlIDs,
            const QHash<QString, ScopeTree::ConstPtr> &types,
            const ScopeTree *root, const QString& rootId, ColorOutput &colorOut) const;

    ScopeType scopeType() const { return m_scopeType; }

    void addMethods(const QHash<QString, MetaMethod> &methods) { m_methods.insert(methods); }
    void addMethod(const MetaMethod &method) { m_methods.insert(method.methodName(), method); }
    QHash<QString, MetaMethod> methods() const { return m_methods; }

    void addEnum(const MetaEnum &fakeEnum) { m_enums.insert(fakeEnum.name(), fakeEnum); }
    QHash<QString, MetaEnum> enums() const { return m_enums; }

    QString className() const { return m_className; }
    void setClassName(const QString &name) { m_className = name; }

    void addExport(const QString &name, const QString &package, const ComponentVersion &version);
    void setExportMetaObjectRevision(int exportIndex, int metaObjectRevision);
    QList<Export> exports() const { return m_exports; }

    void setSuperclassName(const QString &superclass) { m_superName = superclass; }
    QString superclassName() const { return m_superName; }

    void addProperty(const MetaProperty &prop) { m_properties.insert(prop.propertyName(), prop); }
    QHash<QString, MetaProperty> properties() const { return m_properties; }
    void updateParentProperty(const ScopeTree *scope);

    QString defaultPropertyName() const { return m_defaultPropertyName; }
    void setDefaultPropertyName(const QString &name) { m_defaultPropertyName = name; }

    QString attachedTypeName() const { return m_attachedTypeName; }
    void setAttachedTypeName(const QString &name) { m_attachedTypeName = name; }

    bool isSingleton() const { return m_isSingleton; }
    bool isCreatable() const { return m_isCreatable; }
    bool isComposite() const { return m_isComposite; }
    void setIsSingleton(bool value) { m_isSingleton = value; }
    void setIsCreatable(bool value) { m_isCreatable = value; }
    void setIsComposite(bool value) { m_isSingleton = value; }

private:
    struct FieldMemberList
    {
        QString m_name;
        QString m_parentType;
        QQmlJS::AST::SourceLocation m_location;
        std::unique_ptr<FieldMemberList> m_child;
    };

    QSet<QString> m_jsIdentifiers;
    QMultiHash<QString, MethodUsage> m_injectedSignalIdentifiers;

    QHash<QString, MetaMethod> m_methods;
    QHash<QString, MetaProperty> m_properties;
    QHash<QString, MetaEnum> m_enums;

    std::vector<std::unique_ptr<FieldMemberList>> m_accessedIdentifiers;
    FieldMemberList *m_currentFieldMember = nullptr;

    QVector<QPair<QString, QQmlJS::AST::SourceLocation>> m_unmatchedSignalHandlers;

    QVector<ScopeTree::Ptr> m_childScopes;
    ScopeTree *m_parentScope;

    QString m_name;
    QString m_className;
    QString m_superName;

    ScopeType m_scopeType = ScopeType::QMLScope;
    QList<Export> m_exports;

    QString m_defaultPropertyName;
    QString m_attachedTypeName;
    bool m_isSingleton = false;
    bool m_isCreatable = true;
    bool m_isComposite = false;

    bool isIdInCurrentQMlScopes(const QString &id) const;
    bool isIdInCurrentJSScopes(const QString &id) const;
    bool isIdInjectedFromSignal(const QString &id) const;
    const ScopeTree *currentQMLScope() const;
    void printContext(ColorOutput &colorOut, const QString &code,
                      const QQmlJS::AST::SourceLocation &location) const;
    bool checkMemberAccess(
            const QString &code,
            FieldMemberList *members,
            const ScopeTree *scope,
            const QHash<QString, ScopeTree::ConstPtr> &types,
            ColorOutput& colorOut) const;
};

#endif // SCOPETREE_H