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
|
/****************************************************************************
**
** Copyright (C) 2017 Klarälvdalens Datakonsult AB, a KDAB Group company, info@kdab.com, author Kevin Krammer <kevin.krammer@kdab.com>
** Contact: https://www.qt.io/licensing/
**
** This file is part of the test suite 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$
**
****************************************************************************/
#include <qtest.h>
#include <QtQml/qqmlcomponent.h>
#include <QtQml/qqmlengine.h>
#include <QtQml/private/qqmlmetatype_p.h>
#include <QtCore/QDebug>
#include <QtCore/QHash>
#include <QtCore/QSet>
class tst_PropertyRequirements : public QObject
{
Q_OBJECT
public:
tst_PropertyRequirements();
private slots:
void constantOrNotifyableMain();
void constantOrNotifyableFull();
private:
typedef QList<QQmlType> Failures;
/*!
All properties that do not pass the check and the affected QML types
Key: Property name formatted as C++-class-name::property-name
Value: List of QQmlType which have the property
*/
typedef QHash<QString, Failures> FailuresByProperty;
enum TestDepth {
MainTypeOnly, //! Check only the properties of the main C++ type for each QML type
WithSuperClasses //! Check the super classes for each C++ type as well
};
void testAllQmlTypes(TestDepth testDepth, FailuresByProperty &failuresByProperty);
void testQmlType(TestDepth testDepth, const QQmlType &qmlType, FailuresByProperty &failuresByProperty);
};
tst_PropertyRequirements::tst_PropertyRequirements()
{
}
void tst_PropertyRequirements::constantOrNotifyableMain()
{
FailuresByProperty failuresByProperty;
// test
testAllQmlTypes(MainTypeOnly, failuresByProperty);
// report
QHash<QString, QStringList> occurrences;
for (auto it = failuresByProperty.constBegin(); it != failuresByProperty.constEnd(); ++it) {
occurrences[it.value().at(0).qmlTypeName()].append(it.key());
}
QStringList messages;
for (auto it = occurrences.constBegin(); it != occurrences.constEnd(); ++it) {
const QString occurrencePattern("%1:\n\t%2");
QStringList properties = it.value();
properties.sort();
messages.append(occurrencePattern.arg(it.key(), properties.join("\n\t")));
}
messages.sort();
const QString message("\nThe following QML Types have properties which are neither CONSTANT nor NOTIFYable:\n");
QWARN(qPrintable(message + messages.join("\n")));
// TODO enable once technical debt is fixes
// QCOMPARE(failuresByProperty.count(), 0);
}
void tst_PropertyRequirements::constantOrNotifyableFull()
{
FailuresByProperty failuresByProperty;
// test
testAllQmlTypes(WithSuperClasses, failuresByProperty);
// report
QStringList messages;
for (auto it = failuresByProperty.constBegin(); it != failuresByProperty.constEnd(); ++it) {
QSet<QString> occurrences;
for (const QQmlType &qmlType : it.value()) {
static const QString occurrencePattern("%1 (%2)");
occurrences.insert(occurrencePattern.arg(qmlType.metaObject()->className(),
qmlType.qmlTypeName()));
}
static const QString messagePattern("\nProperty %1 neither CONSTANT nor NOTIFYable. Affected types:\n\t%2");
QStringList occurrencesList = occurrences.values();
occurrencesList.sort();
messages.append(messagePattern.arg(it.key(), occurrencesList.join("\n\t")));
}
messages.sort();
QWARN(qPrintable(messages.join("\n")));
// TODO enable once technical debt is fixes
// QCOMPARE(failuresByProperty.count(), 0);
}
void tst_PropertyRequirements::testAllQmlTypes(TestDepth testDepth, FailuresByProperty &failuresByProperty)
{
const QVector<QByteArray> qmlData {
"import QtQml 2.2\nQtObject {}",
"import QtQml.Models 2.2\nListModel {}",
"import QtQuick 2.5\nItem {}",
"import QtQuick.Window 2.2\nWindow {}",
"import QtQuick.Dialogs 1.2\nDialog {}",
"import QtQuick.Layouts 1.2\nGridLayout {}",
"import QtQuick.Controls 2.2\nButton {}",
"import QtQuick.Templates 2.2\nButton {}"
};
QQmlEngine engine;
QSet<QString> seenTypes;
for (const QByteArray &data : qmlData) {
QQmlComponent component(&engine);
component.setData(data, QUrl());
for (const QQmlType &qmlType : QQmlMetaType::qmlTypes()) {
if (!seenTypes.contains(qmlType.qmlTypeName())) {
testQmlType(testDepth, qmlType, failuresByProperty);
}
}
const auto &typeNameList = QQmlMetaType::qmlTypeNames();
seenTypes.unite(QSet<QString>(typeNameList.cbegin(), typeNameList.cend()));
}
}
void tst_PropertyRequirements::testQmlType(TestDepth testDepth, const QQmlType &qmlType, FailuresByProperty &failuresByProperty)
{
QList<const QMetaObject*> inheritanceHierarchy;
const QMetaObject *mo = qmlType.metaObject();
while (mo) {
inheritanceHierarchy.prepend(mo);
mo = mo->superClass();
}
// check if this type is derived from QObject and even can have signals
// i.e. weed out the Q_GADGET classes
if (inheritanceHierarchy.isEmpty()
|| inheritanceHierarchy.constFirst()->className() != QByteArrayLiteral("QObject")) {
return;
}
if (testDepth == MainTypeOnly) {
inheritanceHierarchy.clear();
inheritanceHierarchy.append(qmlType.metaObject());
}
for (const QMetaObject *metaClass : qAsConst(inheritanceHierarchy)) {
for (int idx = metaClass->propertyOffset(); idx < metaClass->propertyCount(); ++idx) {
const QMetaProperty property = metaClass->property(idx);
// needs to be either CONSTANT or have a NOTIFY signal
if (!property.isConstant() && !property.hasNotifySignal()) {
static const QString fullNamePattern("%1::%2");
const QString fullPropertyName = fullNamePattern.arg(metaClass->className(), property.name());
failuresByProperty[fullPropertyName].append(qmlType);
}
}
}
}
QTEST_MAIN(tst_PropertyRequirements)
#include "tst_propertyrequirements.moc"
|
