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
|
// Copyright (C) 2021 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
#ifndef QMLTCOUTPUTIR_H
#define QMLTCOUTPUTIR_H
#include <QtCore/qstring.h>
#include <QtCore/qlist.h>
#include <QtCore/qstringlist.h>
#include <QtCore/qset.h>
#include <private/qqmljsmetatypes_p.h>
#include <optional>
QT_BEGIN_NAMESPACE
// Below are the classes that represent compiled QML types in a string data
// form. These classes are used to generate C++ code.
// Represents C++ variable
struct QmltcVariable
{
QString cppType; // C++ type of a variable
QString name; // variable name
QString defaultValue; // optional initialization value
QmltcVariable() = default;
// special ctor for QList's emplace back
QmltcVariable(const QString &t, const QString &n, const QString &v = QString())
: cppType(t), name(n), defaultValue(v)
{
}
};
struct QmltcProperty : QmltcVariable
{
QString containingClass;
QString signalName;
QmltcProperty() = default;
QmltcProperty(const QString t, const QString &n, const QString &c, const QString &s)
: QmltcVariable(t, n), containingClass(c), signalName(s)
{
}
};
// Represents QML -> C++ compiled enumeration type
struct QmltcEnum
{
QString cppType; // C++ type of an enum
QStringList keys; // enumerator keys
QStringList values; // enumerator values
QString ownMocLine; // special MOC line that follows enum declaration
QmltcEnum() = default;
QmltcEnum(const QString &t, const QStringList &ks, const QStringList &vs, const QString &l)
: cppType(t), keys(ks), values(vs), ownMocLine(l)
{
}
};
struct QmltcMethodBase
{
QStringList comments; // C++ comments
QString name; // C++ function name
QList<QmltcVariable> parameterList; // C++ function parameter list
QStringList body; // C++ function code
QQmlJSMetaMethod::Access access = QQmlJSMetaMethod::Public; // access specifier
QStringList declarationPrefixes;
QStringList modifiers; // cv-qualifiers, ref-qualifier, noexcept, attributes
};
// Represents QML -> C++ compiled function
struct QmltcMethod : QmltcMethodBase
{
QString returnType; // C++ return type
QQmlJSMetaMethod::Type type = QQmlJSMetaMethod::Method; // Qt function type
// TODO: should be a better way to handle this
bool userVisible = false; // tells if a function is prioritized during the output generation
};
// Represents C++ ctor of a type
struct QmltcCtor : QmltcMethodBase
{
QStringList initializerList; // C++ ctor's initializer list
};
// Represents C++ dtor of a type
struct QmltcDtor : QmltcMethodBase
{
};
// Represents QML -> C++ compiled type
struct QmltcType
{
QString cppType; // C++ type of the QML type
QStringList baseClasses; // C++ type names of base classes
QStringList mocCode; // Qt MOC code
QStringList otherCode; // Random code that doesn't fit any category, e.g. friend declarations
// member types: enumerations and child types
QList<QmltcEnum> enums;
QList<QmltcType> children; // these are pretty much always empty
// special member functions:
QmltcCtor baselineCtor {}; // does basic contruction
QmltcCtor externalCtor {}; // calls basicCtor, calls init
QmltcMethod init {}; // starts object initialization (context setup), calls finalize
QmltcMethod beginClass {}; // calls QQmlParserStatus::classBegin()
QmltcMethod endInit {}; // ends object initialization (with "simple" bindings setup)
QmltcMethod setComplexBindings {}; // sets up "complex" (e.g. script) bindings
QmltcMethod completeComponent {}; // calls QQmlParserStatus::componentComplete()
QmltcMethod finalizeComponent {}; // calls QQmlFinalizerHook::componentFinalized()
QmltcMethod handleOnCompleted {}; // calls Component.onCompleted
std::optional<QmltcDtor> dtor {};
// member functions: methods, signals and slots
QList<QmltcMethod> functions;
// member variables
QList<QmltcVariable> variables;
QList<QmltcProperty> properties;
// QML document root specific:
std::optional<QmltcMethod> typeCount; // the number of QML types defined in a document
// TODO: only needed for binding callables - should not be needed, generally
bool ignoreInit = false; // specifies whether init and externalCtor should be ignored
// needed for singletons
std::optional<QmltcMethod> staticCreate{};
};
// Represents whole QML program, compiled to C++
struct QmltcProgram
{
QString url; // QML file url
QString cppPath; // C++ output .cpp path
QString hPath; // C++ output .h path
QString outNamespace;
QSet<QString> includes; // non-default C++ include files
QmltcMethod urlMethod; // returns QUrl of the QML document
QList<QmltcType> compiledTypes; // all QML types that are compiled to C++
};
QT_END_NAMESPACE
#endif // QMLTCOUTPUTIR_H
|
