aboutsummaryrefslogtreecommitdiffstats
path: root/tools/qmllint/findwarnings.h
blob: cc56f628ee140b9c78df4bf301a74db51c2c38a1 (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
/****************************************************************************
**
** 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 FINDUNQUALIFIED_H
#define FINDUNQUALIFIED_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 "typedescriptionreader.h"
#include "scopetree.h"
#include "qcoloroutput.h"

#include <QtQml/private/qqmldirparser_p.h>
#include <QtQml/private/qqmljsastvisitor_p.h>
#include <QtQml/private/qqmljsast_p.h>

#include <QtCore/qscopedpointer.h>

class FindWarningVisitor : public QQmlJS::AST::Visitor
{
    Q_DISABLE_COPY_MOVE(FindWarningVisitor)
public:
    struct ImportedTypes
    {
        // C++ names used in qmltypes files for non-composite types
        QHash<QString, ScopeTree::Ptr> cppNames;

        // Names a component intends to export, without prefix
        QHash<QString, ScopeTree::Ptr> exportedQmlNames;

        // Names the importing component sees, possibly adding a prefix
        QHash<QString, ScopeTree::Ptr> importedQmlNames;
    };

    explicit FindWarningVisitor(
            QStringList qmltypeDirs, QStringList qmltypesFiles, QString code, QString fileName,
            bool silent, bool warnUnqualified, bool warnWithStatement, bool warnInheritanceCycle);
    ~FindWarningVisitor() override = default;
    bool check();

private:
    class Importer
    {
    public:
        Importer(const QString &currentDir, const QStringList &importPaths) :
            m_currentDir(currentDir), m_importPaths(importPaths) {}

        ImportedTypes importBareQmlTypes(const QStringList &qmltypesFiles);
        ImportedTypes importFileOrDirectory(
                const QString &fileOrDirectory, const QString &prefix = QString());
        ImportedTypes importModule(
                const QString &module, const QString &prefix = QString(),
                QTypeRevision version = QTypeRevision());

        QStringList takeWarnings()
        {
            QStringList result = std::move(m_warnings);
            m_warnings.clear();
            return result;
        }

    private:
        struct Import {
            QHash<QString, ScopeTree::Ptr> objects;
            QHash<QString, ScopeTree::Ptr> scripts;
            QList<QQmlDirParser::Import> imports;
            QList<QQmlDirParser::Import> dependencies;
        };

        void importHelper(const QString &module, const QString &prefix = QString(),
                          QTypeRevision version = QTypeRevision());
        void processImport(const QString &prefix, const Import &import, QTypeRevision version);
        void readQmltypes(const QString &filename, QHash<QString, ScopeTree::Ptr> *objects);
        Import readQmldir(const QString &dirname);
        ScopeTree::Ptr localFile2ScopeTree(const QString &filePath);

        QString m_currentDir;
        QStringList m_importPaths;
        QSet<QPair<QString, QString>> m_seenImports;
        QStringList m_warnings;

        ImportedTypes m_exportedName2Scope;
    };

    ImportedTypes m_rootScopeImports;

    ScopeTree::Ptr m_rootScope;
    ScopeTree::Ptr m_currentScope;
    QQmlJS::AST::ExpressionNode *m_fieldMemberBase = nullptr;
    QStringList m_qmltypesFiles;
    QString m_code;
    QHash<QString, ScopeTree::ConstPtr> m_qmlid2scope;
    QString m_rootId;
    QString m_filePath;
    QSet<QString> m_unknownImports;
    ColorOutput m_colorOut;
    bool m_visitFailed = false;

    bool m_warnUnqualified;
    bool m_warnWithStatement;
    bool m_warnInheritanceCycle;

    struct OutstandingConnection
    {
        QString targetName;
        ScopeTree::Ptr scope;
        QQmlJS::AST::UiObjectDefinition *uiod;
    };

    QVarLengthArray<OutstandingConnection, 3> m_outstandingConnections; // Connections whose target we have not encountered

    Importer m_importer;

    void enterEnvironment(ScopeType type, const QString &name);
    void leaveEnvironment();

    void importExportedNames(QStringView prefix, QString name);

    void parseHeaders(QQmlJS::AST::UiHeaderItemList *headers);
    ScopeTree::Ptr parseProgram(QQmlJS::AST::Program *program, const QString &name);

    void throwRecursionDepthError() override;

    // start block/scope handling
    bool visit(QQmlJS::AST::UiProgram *ast) override;
    void endVisit(QQmlJS::AST::UiProgram *ast) override;

    bool visit(QQmlJS::AST::ClassExpression *ast) override;
    void endVisit(QQmlJS::AST::ClassExpression *ast) override;

    bool visit(QQmlJS::AST::ClassDeclaration *ast) override;
    void endVisit(QQmlJS::AST::ClassDeclaration *ast) override;

    bool visit(QQmlJS::AST::ForStatement *ast) override;
    void endVisit(QQmlJS::AST::ForStatement *ast) override;

    bool visit(QQmlJS::AST::ForEachStatement *ast) override;
    void endVisit(QQmlJS::AST::ForEachStatement *ast) override;

    bool visit(QQmlJS::AST::Block *ast) override;
    void endVisit(QQmlJS::AST::Block *ast) override;

    bool visit(QQmlJS::AST::CaseBlock *ast) override;
    void endVisit(QQmlJS::AST::CaseBlock *ast) override;

    bool visit(QQmlJS::AST::Catch *ast) override;
    void endVisit(QQmlJS::AST::Catch *ast) override;

    bool visit(QQmlJS::AST::WithStatement *withStatement) override;
    void endVisit(QQmlJS::AST::WithStatement *ast) override;

    void visitFunctionExpressionHelper(QQmlJS::AST::FunctionExpression *fexpr);
    bool visit(QQmlJS::AST::FunctionExpression *fexpr) override;
    void endVisit(QQmlJS::AST::FunctionExpression *fexpr) override;

    bool visit(QQmlJS::AST::FunctionDeclaration *fdecl) override;
    void endVisit(QQmlJS::AST::FunctionDeclaration *fdecl) override;
    /* --- end block handling --- */

    bool visit(QQmlJS::AST::VariableDeclarationList *vdl) override;
    bool visit(QQmlJS::AST::FormalParameterList *fpl) override;

    bool visit(QQmlJS::AST::UiImport *import) override;
    bool visit(QQmlJS::AST::UiEnumDeclaration *uied) override;
    bool visit(QQmlJS::AST::UiObjectBinding *uiob) override;
    void endVisit(QQmlJS::AST::UiObjectBinding *uiob) override;
    bool visit(QQmlJS::AST::UiObjectDefinition *uiod) override;
    void endVisit(QQmlJS::AST::UiObjectDefinition *) override;
    bool visit(QQmlJS::AST::UiScriptBinding *uisb) override;
    bool visit(QQmlJS::AST::UiPublicMember *uipm) override;

    // expression handling
    bool visit(QQmlJS::AST::IdentifierExpression *idexp) override;

    bool visit(QQmlJS::AST::PatternElement *) override;
    bool visit(QQmlJS::AST::FieldMemberExpression *idprop) override;
    void endVisit(QQmlJS::AST::FieldMemberExpression *) override;

    bool visit(QQmlJS::AST::BinaryExpression *) override;
    void endVisit(QQmlJS::AST::BinaryExpression *) override;
};

#endif // FINDUNQUALIFIED_H