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
|
// Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
#include "quickcontrolssanity.h"
#include <QtQmlCompiler/private/qqmljslogger_p.h>
#include <memory>
QT_BEGIN_NAMESPACE
using namespace Qt::StringLiterals;
static constexpr QQmlJS::LoggerWarningId qmlControlsSanity{ "QuickControlsSanity.controls-sanity" };
AnchorsElementPass::AnchorsElementPass(QQmlSA::PassManager *manager)
: QQmlSA::ElementPass(manager), m_item(resolveType("QtQuick"_L1, "Item"_L1))
{
}
bool AnchorsElementPass::shouldRun(const QQmlSA::Element &element)
{
return !m_item.isNull() && element.inherits(m_item)
&& element.hasOwnPropertyBindings("anchors"_L1);
}
void AnchorsElementPass::run(const QQmlSA::Element &element)
{
const auto anchorBindings = element.propertyBindings("anchors"_L1);
for (const auto &anchors : anchorBindings) {
emitWarning(u"Using anchors here"_s, qmlControlsSanity, anchors.sourceLocation());
}
}
SignalHandlerPass::SignalHandlerPass(QQmlSA::PassManager *manager)
: QQmlSA::ElementPass(manager), m_qtobject(resolveType("QtQml"_L1, "QtObject"_L1))
{
}
bool SignalHandlerPass::shouldRun(const QQmlSA::Element &element)
{
return !m_qtobject.isNull() && element.inherits(m_qtobject);
}
void SignalHandlerPass::run(const QQmlSA::Element &element)
{
const auto &ownBindings = element.ownPropertyBindings();
for (auto it = ownBindings.constBegin(); it != ownBindings.constEnd(); ++it) {
const auto &propertyName = it.key();
const auto &propertyBinding = it.value();
// Already script binding, check if the script kind is signal handler
if (propertyBinding.bindingType() == QQmlSA::BindingType::Script) {
if (propertyBinding.scriptKind() == QQmlSA::ScriptBindingKind::SignalHandler) {
emitWarning(u"Declared signal handler \"%1\""_s.arg(propertyName),
qmlControlsSanity, propertyBinding.sourceLocation());
}
continue;
}
// Current property is attached property, recursively go through attaching type
if (propertyBinding.bindingType() == QQmlSA::BindingType::AttachedProperty) {
const auto scope = QQmlSA::Element{ propertyBinding.attachedType() };
run(scope);
}
}
}
FunctionDeclarationPass::FunctionDeclarationPass(QQmlSA::PassManager *manager)
: QQmlSA::ElementPass(manager)
{
}
bool FunctionDeclarationPass::shouldRun(const QQmlSA::Element &element)
{
Q_UNUSED(element);
return true;
}
void FunctionDeclarationPass::run(const QQmlSA::Element &element)
{
for (const auto &method : element.ownMethods()) {
if (method.methodType() != QQmlSA::MethodType::Method)
continue;
emitWarning(u"Declared function \"%1\""_s.arg(method.methodName()), qmlControlsSanity,
element.sourceLocation());
}
}
void QuickControlsSanityPlugin::registerPasses(QQmlSA::PassManager *manager,
const QQmlSA::Element &rootElement)
{
Q_UNUSED(rootElement);
if (manager->hasImportedModule("QtQuick"_L1)) {
manager->registerElementPass(std::make_unique<AnchorsElementPass>(manager));
}
manager->registerElementPass(std::make_unique<SignalHandlerPass>(manager));
manager->registerElementPass(std::make_unique<FunctionDeclarationPass>(manager));
}
QT_END_NAMESPACE
#include "moc_quickcontrolssanity.cpp"
|
