1// Copyright (C) 2021 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
3
4#ifndef QQMLJSTYPEPROPAGATOR_P_H
5#define QQMLJSTYPEPROPAGATOR_P_H
6
7//
8// W A R N I N G
9// -------------
10//
11// This file is not part of the Qt API. It exists purely as an
12// implementation detail. This header file may change from version to
13// version without notice, or even be removed.
14//
15// We mean it.
16
17#include <private/qqmljsast_p.h>
18#include <private/qqmljsscope_p.h>
19#include <private/qqmljscompilepass_p.h>
20
21QT_BEGIN_NAMESPACE
22
23namespace QQmlSA {
24class PassManager;
25};
26
27struct Q_QMLCOMPILER_EXPORT QQmlJSTypePropagator : public QQmlJSCompilePass
28{
29 QQmlJSTypePropagator(const QV4::Compiler::JSUnitGenerator *unitGenerator,
30 const QQmlJSTypeResolver *typeResolver, QQmlJSLogger *logger,
31 BasicBlocks basicBlocks = {}, InstructionAnnotations annotations = {},
32 QQmlSA::PassManager *passManager = nullptr);
33
34 BlocksAndAnnotations run(const Function *m_function, QQmlJS::DiagnosticMessage *error);
35
36 void generate_Ret() override;
37 void generate_Debug() override;
38 void generate_LoadConst(int index) override;
39 void generate_LoadZero() override;
40 void generate_LoadTrue() override;
41 void generate_LoadFalse() override;
42 void generate_LoadNull() override;
43 void generate_LoadUndefined() override;
44 void generate_LoadInt(int value) override;
45 void generate_MoveConst(int constIndex, int destTemp) override;
46 void generate_LoadReg(int reg) override;
47 void generate_StoreReg(int reg) override;
48 void generate_MoveReg(int srcReg, int destReg) override;
49 void generate_LoadImport(int index) override;
50 void generate_LoadLocal(int index) override;
51 void generate_StoreLocal(int index) override;
52 void generate_LoadScopedLocal(int scope, int index) override;
53 void generate_StoreScopedLocal(int scope, int index) override;
54 void generate_LoadRuntimeString(int stringId) override;
55 void generate_MoveRegExp(int regExpId, int destReg) override;
56 void generate_LoadClosure(int value) override;
57 void generate_LoadName(int nameIndex) override;
58 void generate_LoadGlobalLookup(int index) override;
59 void generate_LoadQmlContextPropertyLookup(int index) override;
60 void generate_StoreNameCommon(int nameIndex);
61 void generate_StoreNameSloppy(int nameIndex) override;
62 void generate_StoreNameStrict(int name) override;
63 void generate_LoadElement(int base) override;
64 void generate_StoreElement(int base, int index) override;
65 void generate_LoadProperty(int nameIndex) override;
66 void generate_LoadOptionalProperty(int name, int offset) override;
67 void generate_GetLookup(int index) override;
68 void generate_GetOptionalLookup(int index, int offset) override;
69 void generate_StoreProperty(int name, int base) override;
70 void generate_SetLookup(int index, int base) override;
71 void generate_LoadSuperProperty(int property) override;
72 void generate_StoreSuperProperty(int property) override;
73 void generate_Yield() override;
74 void generate_YieldStar() override;
75 void generate_Resume(int) override;
76
77 void generate_CallValue(int name, int argc, int argv) override;
78 void generate_CallWithReceiver(int name, int thisObject, int argc, int argv) override;
79 void generate_CallProperty(int name, int base, int argc, int argv) override;
80 void generate_CallPropertyLookup(int lookupIndex, int base, int argc, int argv) override;
81 void generate_CallName(int name, int argc, int argv) override;
82 void generate_CallPossiblyDirectEval(int argc, int argv) override;
83 void generate_CallGlobalLookup(int index, int argc, int argv) override;
84 void generate_CallQmlContextPropertyLookup(int index, int argc, int argv) override;
85 void generate_CallWithSpread(int func, int thisObject, int argc, int argv) override;
86 void generate_TailCall(int func, int thisObject, int argc, int argv) override;
87 void generate_Construct(int func, int argc, int argv) override;
88 void generate_ConstructWithSpread(int func, int argc, int argv) override;
89 void generate_SetUnwindHandler(int offset) override;
90 void generate_UnwindDispatch() override;
91 void generate_UnwindToLabel(int level, int offset) override;
92 void generate_DeadTemporalZoneCheck(int name) override;
93 void generate_ThrowException() override;
94 void generate_GetException() override;
95 void generate_SetException() override;
96 void generate_CreateCallContext() override;
97 void generate_PushCatchContext(int index, int name) override;
98 void generate_PushWithContext() override;
99 void generate_PushBlockContext(int index) override;
100 void generate_CloneBlockContext() override;
101 void generate_PushScriptContext(int index) override;
102 void generate_PopScriptContext() override;
103 void generate_PopContext() override;
104 void generate_GetIterator(int iterator) override;
105 void generate_IteratorNext(int value, int offset) override;
106 void generate_IteratorNextForYieldStar(int iterator, int object, int offset) override;
107 void generate_IteratorClose() override;
108 void generate_DestructureRestElement() override;
109 void generate_DeleteProperty(int base, int index) override;
110 void generate_DeleteName(int name) override;
111 void generate_TypeofName(int name) override;
112 void generate_TypeofValue() override;
113 void generate_DeclareVar(int varName, int isDeletable) override;
114 void generate_DefineArray(int argc, int args) override;
115 void generate_DefineObjectLiteral(int internalClassId, int argc, int args) override;
116 void generate_CreateClass(int classIndex, int heritage, int computedNames) override;
117 void generate_CreateMappedArgumentsObject() override;
118 void generate_CreateUnmappedArgumentsObject() override;
119 void generate_CreateRestParameter(int argIndex) override;
120 void generate_ConvertThisToObject() override;
121 void generate_LoadSuperConstructor() override;
122 void generate_ToObject() override;
123 void generate_Jump(int offset) override;
124 void generate_JumpTrue(int offset) override;
125 void generate_JumpFalse(int offset) override;
126 void generate_JumpNoException(int offset) override;
127 void generate_JumpNotUndefined(int offset) override;
128 void generate_CheckException() override;
129 void generate_CmpEqNull() override;
130 void generate_CmpNeNull() override;
131 void generate_CmpEqInt(int lhsConst) override;
132 void generate_CmpNeInt(int lhs) override;
133 void generate_CmpEq(int lhs) override;
134 void generate_CmpNe(int lhs) override;
135 void generate_CmpGt(int lhs) override;
136 void generate_CmpGe(int lhs) override;
137 void generate_CmpLt(int lhs) override;
138 void generate_CmpLe(int lhs) override;
139 void generate_CmpStrictEqual(int lhs) override;
140 void generate_CmpStrictNotEqual(int lhs) override;
141 void generate_CmpIn(int lhs) override;
142 void generate_CmpInstanceOf(int lhs) override;
143 void generate_As(int lhs) override;
144 void generate_UNot() override;
145 void generate_UPlus() override;
146 void generate_UMinus() override;
147 void generate_UCompl() override;
148 void generate_Increment() override;
149 void generate_Decrement() override;
150 void generate_Add(int lhs) override;
151 void generate_BitAnd(int lhs) override;
152 void generate_BitOr(int lhs) override;
153 void generate_BitXor(int lhs) override;
154 void generate_UShr(int lhs) override;
155 void generate_Shr(int lhs) override;
156 void generate_Shl(int lhs) override;
157 void generate_BitAndConst(int rhsConst) override;
158 void generate_BitOrConst(int rhsConst) override;
159 void generate_BitXorConst(int rhsConst) override;
160 void generate_UShrConst(int rhsConst) override;
161 void generate_ShrConst(int rhs) override;
162 void generate_ShlConst(int rhs) override;
163 void generate_Exp(int lhs) override;
164 void generate_Mul(int lhs) override;
165 void generate_Div(int lhs) override;
166 void generate_Mod(int lhs) override;
167 void generate_Sub(int lhs) override;
168 void generate_InitializeBlockDeadTemporalZone(int firstReg, int count) override;
169 void generate_ThrowOnNullOrUndefined() override;
170 void generate_GetTemplateObject(int index) override;
171
172 bool checkForEnumProblems(const QQmlJSRegisterContent &base, const QString &propertyName);
173
174 Verdict startInstruction(QV4::Moth::Instr::Type instr) override;
175 void endInstruction(QV4::Moth::Instr::Type instr) override;
176
177private:
178 struct ExpectedRegisterState
179 {
180 int originatingOffset = 0;
181 VirtualRegisters registers;
182 };
183
184 struct PassState : QQmlJSCompilePass::State
185 {
186 InstructionAnnotations annotations;
187 QSet<int> jumpTargets;
188 bool skipInstructionsUntilNextJumpTarget = false;
189 bool needsMorePasses = false;
190 };
191
192 void handleUnqualifiedAccess(const QString &name, bool isMethod) const;
193 void checkDeprecated(QQmlJSScope::ConstPtr scope, const QString &name, bool isMethod) const;
194 bool isCallingProperty(QQmlJSScope::ConstPtr scope, const QString &name) const;
195
196 enum PropertyResolution {
197 PropertyMissing,
198 PropertyTypeUnresolved,
199 PropertyFullyResolved
200 };
201
202 PropertyResolution propertyResolution(QQmlJSScope::ConstPtr scope, const QString &type) const;
203 QQmlJS::SourceLocation getCurrentSourceLocation() const;
204 QQmlJS::SourceLocation getCurrentBindingSourceLocation() const;
205
206 void checkConversion(const QQmlJSRegisterContent &from, const QQmlJSRegisterContent &to);
207 void generateUnaryArithmeticOperation(QQmlJSTypeResolver::UnaryOperator op);
208
209 QQmlJSRegisterContent propagateBinaryOperation(QSOperator::Op op, int lhs);
210 void generateBinaryArithmeticOperation(QSOperator::Op op, int lhs);
211 void generateBinaryConstArithmeticOperation(QSOperator::Op op);
212
213 void propagateCall(
214 const QList<QQmlJSMetaMethod> &methods, int argc, int argv,
215 const QQmlJSScope::ConstPtr &scope);
216 bool propagateTranslationMethod(const QList<QQmlJSMetaMethod> &methods, int argc, int argv);
217 void propagateStringArgCall(int argv);
218 bool propagateArrayMethod(const QString &name, int argc, int argv, const QQmlJSRegisterContent &valueType);
219 void propagatePropertyLookup(
220 const QString &name, int lookupIndex = QQmlJSRegisterContent::InvalidLookupIndex);
221 void propagateScopeLookupCall(const QString &functionName, int argc, int argv);
222 void saveRegisterStateForJump(int offset);
223 bool canConvertFromTo(const QQmlJSRegisterContent &from, const QQmlJSRegisterContent &to);
224
225 QString registerName(int registerIndex) const;
226
227 QQmlJSRegisterContent checkedInputRegister(int reg);
228 QQmlJSMetaMethod bestMatchForCall(const QList<QQmlJSMetaMethod> &methods, int argc, int argv,
229 QStringList *errors);
230
231 void setAccumulator(const QQmlJSRegisterContent &content);
232 void setRegister(int index, const QQmlJSRegisterContent &content);
233 void mergeRegister(int index, const QQmlJSRegisterContent &a, const QQmlJSRegisterContent &b);
234
235 void addReadRegister(int index, const QQmlJSRegisterContent &convertTo);
236 void addReadAccumulator(const QQmlJSRegisterContent &convertTo)
237 {
238 addReadRegister(index: Accumulator, convertTo);
239 }
240
241 void recordEqualsNullType();
242 void recordEqualsIntType();
243 void recordEqualsType(int lhs);
244 void recordCompareType(int lhs);
245
246 // helper functions to deal with special cases in generate_ methods
247 void generate_CallProperty_SCMath(int base, int arcg, int argv);
248 void generate_CallProperty_SCconsole(int base, int argc, int argv);
249 void generate_Construct_SCDate(int argc, int argv);
250 void generate_Construct_SCArray(int argc, int argv);
251
252 // helper functions to perform QQmlSA checks
253 void generate_ret_SAcheck();
254 void generate_LoadQmlContextPropertyLookup_SAcheck(const QString &name);
255 void generate_StoreNameCommon_SAcheck(const QQmlJSRegisterContent &in, const QString &name);
256 void propagatePropertyLookup_SAcheck(const QString &propertyName);
257 void generate_StoreProperty_SAcheck(const QString propertyName, const QQmlJSRegisterContent &callBase);
258 void generate_callProperty_SAcheck(const QString propertyName, const QQmlJSScope::ConstPtr &baseType);
259
260
261 QQmlJSRegisterContent m_returnType;
262 QQmlSA::PassManager *m_passManager = nullptr;
263 QQmlJSScope::ConstPtr m_attachedContext;
264
265 // Not part of the state, as the back jumps are the reason for running multiple passes
266 QMultiHash<int, ExpectedRegisterState> m_jumpOriginRegisterStateByTargetInstructionOffset;
267
268 InstructionAnnotations m_prevStateAnnotations;
269 PassState m_state;
270};
271
272QT_END_NAMESPACE
273
274#endif // QQMLJSTYPEPROPAGATOR_P_H
275

source code of qtdeclarative/src/qmlcompiler/qqmljstypepropagator_p.h