Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
qqmljstypepropagator_p.h
Go to the documentation of this file.
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// Qt-Security score:significant
4
5#ifndef QQMLJSTYPEPROPAGATOR_P_H
6#define QQMLJSTYPEPROPAGATOR_P_H
7
8//
9// W A R N I N G
10// -------------
11//
12// This file is not part of the Qt API. It exists purely as an
13// implementation detail. This header file may change from version to
14// version without notice, or even be removed.
15//
16// We mean it.
17
18#include <private/qqmljsast_p.h>
19#include <private/qqmljsscope_p.h>
20#include <private/qqmljscompilepass_p.h>
21#include <private/qqmljscontextproperties_p.h>
22#include <private/qqmljsusercontextproperties_p.h>
23
24QT_BEGIN_NAMESPACE
25
26namespace QQmlSA {
27class PassManager;
28};
29
30struct Q_QMLCOMPILER_EXPORT QQmlJSTypePropagator : public QQmlJSCompilePass
31{
32 using QQmlJSCompilePass::QQmlJSCompilePass;
33
34 BlocksAndAnnotations run(const Function *m_function);
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_StoreNameSloppy(int nameIndex) override;
61 void generate_StoreNameStrict(int name) override;
62 void generate_LoadElement(int base) override;
63 void generate_StoreElement(int base, int index) override;
64 void generate_LoadProperty(int nameIndex) override;
65 void generate_LoadOptionalProperty(int name, int offset) override;
66 void generate_GetLookup(int index) override;
67 void generate_GetOptionalLookup(int index, int offset) override;
68 void generate_StoreProperty(int name, int base) override;
69 void generate_SetLookup(int index, int base) override;
70 void generate_LoadSuperProperty(int property) override;
71 void generate_StoreSuperProperty(int property) override;
72 void generate_Yield() override;
73 void generate_YieldStar() override;
74 void generate_Resume(int) override;
75
76 void generate_CallValue(int name, int argc, int argv) override;
77 void generate_CallWithReceiver(int name, int thisObject, int argc, int argv) override;
78 void generate_CallProperty(int name, int base, int argc, int argv) override;
79 void generate_CallPropertyLookup(int lookupIndex, int base, int argc, int argv) override;
80 void generate_CallName(int name, int argc, int argv) override;
81 void generate_CallPossiblyDirectEval(int argc, int argv) override;
82 void generate_CallGlobalLookup(int index, int argc, int argv) override;
83 void generate_CallQmlContextPropertyLookup(int index, int argc, int argv) override;
84 void generate_CallWithSpread(int func, int thisObject, int argc, int argv) override;
85 void generate_TailCall(int func, int thisObject, int argc, int argv) override;
86 void generate_Construct(int func, int argc, int argv) override;
87 void generate_ConstructWithSpread(int func, int argc, int argv) override;
88 void generate_SetUnwindHandler(int offset) override;
89 void generate_UnwindDispatch() override;
90 void generate_UnwindToLabel(int level, int offset) override;
91 void generate_DeadTemporalZoneCheck(int name) override;
92 void generate_ThrowException() override;
93 void generate_GetException() override;
94 void generate_SetException() override;
95 void generate_CreateCallContext() override;
96 void generate_PushCatchContext(int index, int name) override;
97 void generate_PushWithContext() override;
98 void generate_PushBlockContext(int index) override;
99 void generate_CloneBlockContext() override;
100 void generate_PushScriptContext(int index) override;
101 void generate_PopScriptContext() override;
102 void generate_PopContext() override;
103 void generate_GetIterator(int iterator) override;
104 void generate_IteratorNext(int value, int offset) override;
105 void generate_IteratorNextForYieldStar(int iterator, int object, int offset) override;
106 void generate_IteratorClose() override;
107 void generate_DestructureRestElement() override;
108 void generate_DeleteProperty(int base, int index) override;
109 void generate_DeleteName(int name) override;
110 void generate_TypeofName(int name) override;
111 void generate_TypeofValue() override;
112 void generate_DeclareVar(int varName, int isDeletable) override;
113 void generate_DefineArray(int argc, int args) override;
114 void generate_DefineObjectLiteral(int internalClassId, int argc, int args) override;
115 void generate_CreateClass(int classIndex, int heritage, int computedNames) override;
116 void generate_CreateMappedArgumentsObject() override;
117 void generate_CreateUnmappedArgumentsObject() override;
118 void generate_CreateRestParameter(int argIndex) override;
119 void generate_ConvertThisToObject() override;
120 void generate_LoadSuperConstructor() override;
121 void generate_ToObject() override;
122 void generate_Jump(int offset) override;
123 void generate_JumpTrue(int offset) override;
124 void generate_JumpFalse(int offset) override;
125 void generate_JumpNoException(int offset) override;
126 void generate_JumpNotUndefined(int offset) override;
127 void generate_CheckException() override;
128 void generate_CmpEqNull() override;
129 void generate_CmpNeNull() override;
130 void generate_CmpEqInt(int lhsConst) override;
131 void generate_CmpNeInt(int lhs) override;
132 void generate_CmpEq(int lhs) override;
133 void generate_CmpNe(int lhs) override;
134 void generate_CmpGt(int lhs) override;
135 void generate_CmpGe(int lhs) override;
136 void generate_CmpLt(int lhs) override;
137 void generate_CmpLe(int lhs) override;
138 void generate_CmpStrictEqual(int lhs) override;
139 void generate_CmpStrictNotEqual(int lhs) override;
140 void generate_CmpIn(int lhs) override;
141 void generate_CmpInstanceOf(int lhs) override;
142 void generate_As(int lhs) override;
143 void generate_UNot() override;
144 void generate_UPlus() override;
145 void generate_UMinus() override;
146 void generate_UCompl() override;
147 void generate_Increment() override;
148 void generate_Decrement() override;
149 void generate_Add(int lhs) override;
150 void generate_BitAnd(int lhs) override;
151 void generate_BitOr(int lhs) override;
152 void generate_BitXor(int lhs) override;
153 void generate_UShr(int lhs) override;
154 void generate_Shr(int lhs) override;
155 void generate_Shl(int lhs) override;
156 void generate_BitAndConst(int rhsConst) override;
157 void generate_BitOrConst(int rhsConst) override;
158 void generate_BitXorConst(int rhsConst) override;
159 void generate_UShrConst(int rhsConst) override;
160 void generate_ShrConst(int rhs) override;
161 void generate_ShlConst(int rhs) override;
162 void generate_Exp(int lhs) override;
163 void generate_Mul(int lhs) override;
164 void generate_Div(int lhs) override;
165 void generate_Mod(int lhs) override;
166 void generate_Sub(int lhs) override;
167 void generate_InitializeBlockDeadTemporalZone(int firstReg, int count) override;
168 void generate_ThrowOnNullOrUndefined() override;
169 void generate_GetTemplateObject(int index) override;
170
171 Verdict startInstruction(QV4::Moth::Instr::Type instr) override;
172 void endInstruction(QV4::Moth::Instr::Type instr) override;
173
174protected:
175 struct ExpectedRegisterState
176 {
177 int originatingOffset = 0;
178 VirtualRegisters registers;
179 };
180
181 struct PassState : QQmlJSCompilePass::State
182 {
183 InstructionAnnotations annotations;
184 QSet<int> jumpTargets;
185 bool skipInstructionsUntilNextJumpTarget = false;
186 bool needsMorePasses = false;
187 bool instructionHasError = false;
188 };
189
190 // Hooked for linting logic, some are stubs
191 virtual void handleUnqualifiedAccess(const QString &name, bool isMethod) const;
192 virtual void handleUnqualifiedAccessAndContextProperties(const QString &name, bool isMethod) const;
193 virtual void checkDeprecated(QQmlJSScope::ConstPtr scope, const QString &name, bool isMethod) const;
194 virtual bool isCallingProperty(QQmlJSScope::ConstPtr scope, const QString &name) const;
195 virtual bool handleImportNamespaceLookup(const QString &propertyName);
196 virtual void handleLookupError(const QString &propertyName);
197 virtual bool checkForEnumProblems(QQmlJSRegisterContent base, const QString &propertyName);
198 virtual void warnAboutTypeCoercion(int lhs);
199
200 enum PropertyResolution {
201 PropertyMissing,
202 PropertyTypeUnresolved,
203 PropertyFullyResolved
204 };
205
206 PropertyResolution propertyResolution(QQmlJSScope::ConstPtr scope, const QString &type) const;
207
208 void checkConversion(QQmlJSRegisterContent from, QQmlJSRegisterContent to);
209 void generateUnaryArithmeticOperation(QQmlJSTypeResolver::UnaryOperator op);
210
211 QQmlJSRegisterContent propagateBinaryOperation(QSOperator::Op op, int lhs);
212 void generateBinaryArithmeticOperation(QSOperator::Op op, int lhs);
213 void generateBinaryConstArithmeticOperation(QSOperator::Op op);
214
215 virtual void generate_StoreNameCommon(int nameIndex);
216 virtual void propagateCall(
217 const QList<QQmlJSMetaMethod> &methods, int argc, int argv,
218 QQmlJSRegisterContent scope);
219 virtual void propagateTranslationMethod_SAcheck(const QString &methodName);
220 bool propagateTranslationMethod(const QList<QQmlJSMetaMethod> &methods, int argc, int argv);
221 void propagateStringArgCall(QQmlJSRegisterContent base, int argv);
222 bool propagateArrayMethod(const QString &name, int argc, int argv, QQmlJSRegisterContent valueType);
223 virtual void propagatePropertyLookup(
224 const QString &name, int lookupIndex = QQmlJSRegisterContent::InvalidLookupIndex);
225 void propagateScopeLookupCall(const QString &functionName, int argc, int argv);
226 void saveRegisterStateForJump(int offset);
227 bool canConvertFromTo(QQmlJSRegisterContent from, QQmlJSRegisterContent to);
228 bool canConvertFromTo(QQmlJSRegisterContent from, const QQmlJSScope::ConstPtr &to);
229
230 QString registerName(int registerIndex) const;
231
232 QQmlJSRegisterContent checkedInputRegister(int reg);
233 QQmlJSMetaMethod bestMatchForCall(const QList<QQmlJSMetaMethod> &methods, int argc, int argv,
234 QStringList *errors);
235
236 void setAccumulator(QQmlJSRegisterContent content);
237 void setRegister(int index, QQmlJSRegisterContent content);
238 void mergeRegister(int index, const VirtualRegister &a, const VirtualRegister &b);
239
240 void addReadRegister(int index);
241 void addReadRegister(int index, QQmlJSRegisterContent convertTo);
242 void addReadRegister(int index, const QQmlJSScope::ConstPtr &convertTo);
243
244 void addReadAccumulator()
245 {
246 addReadRegister(Accumulator);
247 }
248
249 void addReadAccumulator(QQmlJSRegisterContent convertTo)
250 {
251 addReadRegister(Accumulator, convertTo);
252 }
253
254 void addReadAccumulator(const QQmlJSScope::ConstPtr &convertTo)
255 {
256 addReadRegister(Accumulator, convertTo);
257 }
258
259 bool populatesAccumulator(QV4::Moth::Instr::Type instr) const;
260 bool isNoop(QV4::Moth::Instr::Type instr) const;
261
262 void recordEqualsNullType();
263 void recordEqualsIntType();
264 void recordEqualsType(int lhs);
265 void recordCompareType(int lhs);
266
267 // helper functions to deal with special cases in generate_ methods
268 void generate_CallProperty_SCMath(const QString &name, int base, int arcg, int argv);
269 void generate_CallProperty_SCconsole(const QString &name, int base, int argc, int argv);
270 void generate_Construct_SCDate(const QQmlJSMetaMethod &ctor, int argc, int argv);
271 void generate_Construct_SCArray(const QQmlJSMetaMethod &ctor, int argc, int argv);
272
273 static bool isLoggingMethod(const QString &consoleMethod);
274
275 void addError(const QString &message)
276 {
277 QQmlJSCompilePass::addError(message);
278 m_state.instructionHasError = true;
279 }
280
281 void setVarAccumulatorAndError()
282 {
283 setAccumulator(m_typeResolver->syntheticType(m_typeResolver->varType()));
284 m_state.instructionHasError = true;
285 }
286
287 QQmlJSRegisterContent m_returnType;
288
289 // Not part of the state, as the back jumps are the reason for running multiple passes
290 QMultiHash<int, ExpectedRegisterState> m_jumpOriginRegisterStateByTargetInstructionOffset;
291
292 InstructionAnnotations m_prevStateAnnotations;
293 PassState m_state;
294};
295
296QT_END_NAMESPACE
297
298#endif // QQMLJSTYPEPROPAGATOR_P_H
QQmlSA
\inmodule QtQmlCompiler
Definition qqmljsscope_p.h:704
QT_BEGIN_NAMESPACE
Combined button and popup list for selecting options.
Definition qrandomaccessasyncfile_darwin.mm:17
isStringOrNumberOrBoolean
static bool isStringOrNumberOrBoolean(const QQmlJSScope::ConstPtr &scope, const QQmlJSTypeResolver *resolver)
Definition qqmljslintertypepropagator.cpp:610
shouldMentionRequiredProperties
static bool shouldMentionRequiredProperties(const QQmlJSScope::ConstPtr &qmlScope)
Definition qqmljslintertypepropagator.cpp:302
isVoidOrUndefined
static bool isVoidOrUndefined(const QQmlJSScope::ConstPtr &scope, const QQmlJSTypeResolver *resolver)
Definition qqmljslintertypepropagator.cpp:617
mightContainStringOrNumberOrBoolean
static bool mightContainStringOrNumberOrBoolean(const QQmlJSScope::ConstPtr &scope, const QQmlJSTypeResolver *resolver)
Definition qqmljslintertypepropagator.cpp:603
requiresStrictEquality
static bool requiresStrictEquality(const QQmlJSScope::ConstPtr &lhs, const QQmlJSScope::ConstPtr &rhs, const QQmlJSTypeResolver *resolver)
Definition qqmljslintertypepropagator.cpp:623
ContextPropertyInfo::heuristicContextProperties
QQmlJS::HeuristicContextProperties heuristicContextProperties
Definition qqmljslintertypepropagator_p.h:24
ContextPropertyInfo::userContextProperties
QQmlJS::UserContextProperties userContextProperties
Definition qqmljslintertypepropagator_p.h:25