1 /****************************************************************************
2 **
3 ** Copyright (C) 2018 The Qt Company Ltd.
4 ** Contact: https://www.qt.io/licensing/
5 **
6 ** This file is part of the QtQml module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see https://www.qt.io/terms-conditions. For further
15 ** information use the contact form at https://www.qt.io/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 3 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL3 included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 3 requirements
23 ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24 **
25 ** GNU General Public License Usage
26 ** Alternatively, this file may be used under the terms of the GNU
27 ** General Public License version 2.0 or (at your option) the GNU General
28 ** Public license version 3 or any later version approved by the KDE Free
29 ** Qt Foundation. The licenses are as published by the Free Software
30 ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31 ** included in the packaging of this file. Please review the following
32 ** information to ensure the GNU General Public License requirements will
33 ** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34 ** https://www.gnu.org/licenses/gpl-3.0.html.
35 **
36 ** $QT_END_LICENSE$
37 **
38 ****************************************************************************/
39
40 #ifndef QV4GENERATOROBJECT_P_H
41 #define QV4GENERATOROBJECT_P_H
42
43 //
44 // W A R N I N G
45 // -------------
46 //
47 // This file is not part of the Qt API. It exists purely as an
48 // implementation detail. This header file may change from version to
49 // version without notice, or even be removed.
50 //
51 // We mean it.
52 //
53
54 #include "qv4functionobject_p.h"
55 #include "qv4stackframe_p.h"
56
57 QT_BEGIN_NAMESPACE
58
59 namespace QV4 {
60
61 enum class GeneratorState {
62 Undefined,
63 SuspendedStart,
64 SuspendedYield,
65 Executing,
66 Completed
67 };
68
69 namespace Heap {
70
71 struct GeneratorFunctionCtor : FunctionObject {
72 void init(QV4::ExecutionContext *scope);
73 };
74
75 struct GeneratorFunction : ArrowFunction {
76 void init(QV4::ExecutionContext *scope, Function *function, QV4::String *name = nullptr) {
77 ArrowFunction::init(scope, function, name);
78 }
79 };
80
81 struct MemberGeneratorFunction : MemberFunction {
82 };
83
84 struct GeneratorPrototype : FunctionObject {
85 void init();
86 };
87
88 #define GeneratorObjectMembers(class, Member) \
89 Member(class, Pointer, ExecutionContext *, context) \
90 Member(class, Pointer, GeneratorFunction *, function) \
91 Member(class, NoMark, GeneratorState, state) \
92 Member(class, NoMark, CppStackFrame, cppFrame) \
93 Member(class, ValueArray, ValueArray, stack)
94
DECLARE_HEAP_OBJECT(GeneratorObject,Object)95 DECLARE_HEAP_OBJECT(GeneratorObject, Object) {
96 DECLARE_MARKOBJECTS(GeneratorObject);
97 };
98
99 }
100
101 struct GeneratorFunctionCtor : FunctionCtor
102 {
103 V4_OBJECT2(GeneratorFunctionCtor, FunctionCtor)
104
105 static ReturnedValue virtualCallAsConstructor(const FunctionObject *f, const Value *argv, int argc, const Value *);
106 static ReturnedValue virtualCall(const FunctionObject *f, const Value *thisObject, const Value *argv, int argc);
107 };
108
109 struct GeneratorFunction : ArrowFunction
110 {
111 V4_OBJECT2(GeneratorFunction, ArrowFunction)
112 V4_INTERNALCLASS(GeneratorFunction)
113
114 static Heap::FunctionObject *create(ExecutionContext *scope, Function *function);
115 static ReturnedValue virtualCall(const FunctionObject *f, const Value *thisObject, const Value *argv, int argc);
116 };
117
118 struct MemberGeneratorFunction : MemberFunction
119 {
120 V4_OBJECT2(MemberGeneratorFunction, MemberFunction)
121 V4_INTERNALCLASS(MemberGeneratorFunction)
122
123 static Heap::FunctionObject *create(ExecutionContext *scope, Function *function, Object *homeObject, String *name);
124 static ReturnedValue virtualCall(const FunctionObject *f, const Value *thisObject, const Value *argv, int argc);
125 };
126
127 struct GeneratorPrototype : Object
128 {
129 void init(ExecutionEngine *engine, Object *ctor);
130
131 static ReturnedValue method_next(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
132 static ReturnedValue method_return(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
133 static ReturnedValue method_throw(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
134 };
135
136
137 struct GeneratorObject : Object {
138 V4_OBJECT2(GeneratorObject, Object)
139 Q_MANAGED_TYPE(GeneratorObject)
140 V4_INTERNALCLASS(GeneratorObject)
141 V4_PROTOTYPE(generatorPrototype)
142
143 ReturnedValue resume(ExecutionEngine *engine, const Value &arg) const;
144 };
145
146 }
147
148 QT_END_NAMESPACE
149
150 #endif // QV4GENERATORFUNCTION_P_H
151
152