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
|
// Copyright (C) 2022 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
#include "lintplugin.h"
#include <QtQmlCompiler/private/qqmlsa_p.h>
#include <QtQmlCompiler/private/qqmljstyperesolver_p.h>
using namespace Qt::StringLiterals;
static constexpr QQmlSA::LoggerWarningId plugin{ "testPlugin.test" };
class ElementTest : public QQmlSA::ElementPass
{
public:
ElementTest(QQmlSA::PassManager *manager) : QQmlSA::ElementPass(manager)
{
m_rectangle = resolveType(u"QtQuick", u"Rectangle");
}
bool shouldRun(const QQmlSA::Element &element) override
{
return element.baseType() == m_rectangle;
}
void run(const QQmlSA::Element &element) override
{
auto property = element.property(u"radius"_s);
if (!property.isValid() || element.property(u"radius"_s).typeName() != u"double") {
emitWarning(u"Failed to verify radius property", plugin, element.sourceLocation());
return;
}
auto bindings = element.propertyBindings(u"radius"_s);
if (bindings.isEmpty() || bindings.constFirst().numberValue() != 5) {
emitWarning(u"Failed to verify radius property binding", plugin,
element.sourceLocation());
return;
}
emitWarning(u"ElementTest OK", plugin, element.sourceLocation());
}
private:
QQmlSA::Element m_rectangle;
};
class PropertyTest : public QQmlSA::PropertyPass
{
public:
PropertyTest(QQmlSA::PassManager *manager)
: QQmlSA::PropertyPass(manager)
, m_manager(manager) { }
void onBinding(const QQmlSA::Element &element, const QString &propertyName,
const QQmlSA::Binding &binding, const QQmlSA::Element &bindingScope,
const QQmlSA::Element &value) override
{
auto resolver = QQmlSA::PassManagerPrivate::resolver(*m_manager);
if (resolver->jsGlobalObject().isNull()) {
emitWarning(u"Type resolution is broken", plugin);
return;
}
emitWarning(u"Saw binding on %1 property %2 with value %3 (and type %4) in scope %5"_s
.arg(element.baseTypeName(), propertyName,
value.isNull()
? u"NULL"_s
: (value.name().isNull() ? value.baseTypeName()
: value.name()))
.arg(qToUnderlying(binding.bindingType()))
.arg(bindingScope.baseTypeName()),
plugin, binding.sourceLocation());
}
void onRead(const QQmlSA::Element &element, const QString &propertyName,
const QQmlSA::Element &readScope, QQmlSA::SourceLocation location) override
{
emitWarning(u"Saw read on %1 property %2 in scope %3"_s.arg(
element.baseTypeName(), propertyName, readScope.baseTypeName()),
plugin, location);
}
void onCall(const QQmlSA::Element &element, const QString &propertyName,
const QQmlSA::Element &readScope, QQmlSA::SourceLocation location) override
{
emitWarning(u"Saw call on %1 property %2 in scope %3"_s.arg(
element.baseTypeName(), propertyName, readScope.baseTypeName()),
plugin, location);
}
void onWrite(const QQmlSA::Element &element, const QString &propertyName,
const QQmlSA::Element &value, const QQmlSA::Element &writeScope,
QQmlSA::SourceLocation location) override
{
emitWarning(u"Saw write on %1 property %2 with value %3 in scope %4"_s.arg(
element.baseTypeName(), propertyName,
(value.name().isNull() ? value.baseTypeName()
: value.name()),
writeScope.baseTypeName()),
plugin, location);
}
private:
QQmlSA::PassManager *m_manager;
};
class HasImportedModuleTest : public QQmlSA::ElementPass
{
public:
HasImportedModuleTest(QQmlSA::PassManager *manager, QString message)
: QQmlSA::ElementPass(manager), m_message(message)
{
}
bool shouldRun(const QQmlSA::Element &element) override
{
Q_UNUSED(element)
return true;
}
void run(const QQmlSA::Element &element) override
{
Q_UNUSED(element)
emitWarning(m_message, plugin);
}
private:
QString m_message;
};
void LintPlugin::registerPasses(QQmlSA::PassManager *manager, const QQmlSA::Element &rootElement)
{
if (!rootElement.filePath().endsWith(u"_pluginTest.qml"))
return;
manager->registerElementPass(std::make_unique<ElementTest>(manager));
manager->registerPropertyPass(std::make_unique<PropertyTest>(manager), "QtQuick", "Text",
"text");
manager->registerPropertyPass(std::make_unique<PropertyTest>(manager), "", "", "x");
manager->registerPropertyPass(std::make_unique<PropertyTest>(manager), "", "", "onXChanged");
manager->registerPropertyPass(std::make_unique<PropertyTest>(manager), "", "", "log");
manager->registerPropertyPass(std::make_unique<PropertyTest>(manager), "", "", "abs");
manager->registerPropertyPass(std::make_unique<PropertyTest>(manager), "", "", "now");
manager->registerPropertyPass(std::make_unique<PropertyTest>(manager), "", "", "qsTr");
manager->registerPropertyPass(std::make_unique<PropertyTest>(manager), "", "", "qsTrId");
manager->registerPropertyPass(std::make_unique<PropertyTest>(manager), "", "", "qsTranslate");
manager->registerPropertyPass(std::make_unique<PropertyTest>(manager), "QtQuick", "ListView");
manager->registerPropertyPass(std::make_unique<PropertyTest>(manager), "QtQuick", "$internal$.QQuickEnterKeyAttached", "");
if (manager->hasImportedModule("QtQuick.Controls")) {
if (manager->hasImportedModule("QtQuick")) {
if (manager->hasImportedModule("QtQuick.Window")) {
manager->registerElementPass(std::make_unique<HasImportedModuleTest>(
manager, "QtQuick.Controls, QtQuick and QtQuick.Window present"));
}
} else {
manager->registerElementPass(std::make_unique<HasImportedModuleTest>(
manager, "QtQuick.Controls and NO QtQuick present"));
}
}
}
|
