summaryrefslogtreecommitdiffstats
path: root/src/qml/jsruntime/qv4promiseobject_p.h
blob: bce59b19a7c9fa1e95650510526100d71328e828 (plain)
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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
/****************************************************************************
**
** Copyright (C) 2018 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtQml module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** 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 Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** 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-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef QV4PROMISEOBJECT_H
#define QV4PROMISEOBJECT_H

//
//  W A R N I N G
//  -------------
//
// This file is not part of the Qt API.  It exists purely as an
// implementation detail.  This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
//

#include "qv4object_p.h"
#include "qv4functionobject_p.h"

QT_BEGIN_NAMESPACE

namespace QV4 {

struct PromiseCapability;

namespace Promise {

struct ReactionEvent;

class ReactionHandler : public QObject
{
    Q_OBJECT

public:
    ReactionHandler(QObject *parent = nullptr);
    virtual ~ReactionHandler();

    void addReaction(ExecutionEngine *e, const Value *reaction, const Value *value);

protected:
    void customEvent(QEvent *event);
    void executeReaction(ReactionEvent *event);
};

} // Promise

namespace Heap {

struct PromiseCtor : FunctionObject {
    void init(QV4::ExecutionContext *scope);
};

#define PromiseObjectMembers(class, Member) \
    Member(class, HeapValue, HeapValue, resolution) \
    Member(class, HeapValue, HeapValue, fulfillReactions) \
    Member(class, HeapValue, HeapValue, rejectReactions)

DECLARE_HEAP_OBJECT(PromiseObject, Object) {
    DECLARE_MARKOBJECTS(PromiseObject)
    void init(ExecutionEngine *e);

    enum State {
        Pending,
        Fulfilled,
        Rejected
    };

    void setState(State);
    bool isSettled() const;
    bool isPending() const;
    bool isFulfilled() const;
    bool isRejected() const;

    State state;

    void triggerFullfillReactions(ExecutionEngine *e);
    void triggerRejectReactions(ExecutionEngine *e);
};

#define PromiseCapabilityMembers(class, Member) \
    Member(class, HeapValue, HeapValue, promise) \
    Member(class, HeapValue, HeapValue, resolve) \
    Member(class, HeapValue, HeapValue, reject)

DECLARE_HEAP_OBJECT(PromiseCapability, Object) {
    DECLARE_MARKOBJECTS(PromiseCapability)
};

#define PromiseReactionMembers(class, Member) \
    Member(class, HeapValue, HeapValue, handler) \
    Member(class, Pointer, PromiseCapability*, capability)

DECLARE_HEAP_OBJECT(PromiseReaction, Object) {
    DECLARE_MARKOBJECTS(PromiseReaction)

    static Heap::PromiseReaction *createFulfillReaction(ExecutionEngine* e, const QV4::PromiseCapability *capability, const QV4::FunctionObject *onFulfilled);
    static Heap::PromiseReaction *createRejectReaction(ExecutionEngine* e, const QV4::PromiseCapability *capability, const QV4::FunctionObject *onRejected);

    void triggerWithValue(ExecutionEngine *e, const Value *value);

    enum Type {
        Function,
        Identity,
        Thrower
    };

    Type type;

    friend class ReactionHandler;
};

#define CapabilitiesExecutorWrapperMembers(class, Member) \
    Member(class, Pointer, PromiseCapability*, capabilities)

DECLARE_HEAP_OBJECT(CapabilitiesExecutorWrapper, FunctionObject) {
    DECLARE_MARKOBJECTS(CapabilitiesExecutorWrapper)
    void init();
    void destroy();
};

#define PromiseExecutionStateMembers(class, Member) \
    Member(class, HeapValue, HeapValue, values) \
    Member(class, HeapValue, HeapValue, capability)

DECLARE_HEAP_OBJECT(PromiseExecutionState, FunctionObject) {
    DECLARE_MARKOBJECTS(PromiseExecutionState)
    void init();

    uint index;
    uint remainingElementCount;
};

#define ResolveElementWrapperMembers(class, Member) \
    Member(class, HeapValue, HeapValue, state)

DECLARE_HEAP_OBJECT(ResolveElementWrapper, FunctionObject) {
    DECLARE_MARKOBJECTS(ResolveElementWrapper)
    void init();

    uint index;
    bool alreadyResolved;
};

#define ResolveWrapperMembers(class, Member) \
    Member(class, Pointer, PromiseObject*, promise)

DECLARE_HEAP_OBJECT(ResolveWrapper, FunctionObject) {
    DECLARE_MARKOBJECTS(ResolveWrapper)
    void init();

    bool alreadyResolved;
};

#define RejectWrapperMembers(class, Member) \
    Member(class, Pointer, PromiseObject*, promise)

DECLARE_HEAP_OBJECT(RejectWrapper, FunctionObject) {
    DECLARE_MARKOBJECTS(RejectWrapper)
    void init();

    bool alreadyResolved;
};

} // Heap

struct PromiseReaction : Object
{
    V4_OBJECT2(PromiseReaction, Object)
};

struct PromiseCapability : Object
{
    V4_OBJECT2(PromiseCapability, Object)
};

struct PromiseExecutionState : Object
{
    V4_OBJECT2(PromiseExecutionState, Object)
};

struct Q_QML_PRIVATE_EXPORT PromiseObject : Object
{
    V4_OBJECT2(PromiseObject, Object)
    V4_NEEDS_DESTROY
    V4_PROTOTYPE(promisePrototype)
};

struct PromiseCtor: FunctionObject
{
    V4_OBJECT2(PromiseCtor, FunctionObject)

    static ReturnedValue virtualCallAsConstructor(const FunctionObject *f, const Value *argv, int argc, const Value *);
    static ReturnedValue virtualCall(const FunctionObject *f, const Value *thisObject, const Value *argv, int argc);

    static ReturnedValue method_resolve(const FunctionObject *f, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_reject(const FunctionObject *f, const Value *thisObject, const Value *argv, int argc);

    static ReturnedValue method_all(const FunctionObject *f, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_race(const FunctionObject *f, const Value *thisObject, const Value *argv, int argc);
};

struct PromisePrototype : Object
{
    void init(ExecutionEngine *engine, Object *ctor);

    static ReturnedValue method_then(const FunctionObject *f, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_catch(const FunctionObject *f, const Value *thisObject, const Value *argv, int argc);
};

struct CapabilitiesExecutorWrapper: FunctionObject {
    V4_OBJECT2(CapabilitiesExecutorWrapper, FunctionObject)

    static ReturnedValue virtualCall(const FunctionObject *f, const Value *thisObject, const Value *argv, int argc);
};

struct ResolveElementWrapper : FunctionObject {
    V4_OBJECT2(ResolveElementWrapper, FunctionObject)

    static ReturnedValue virtualCall(const FunctionObject *f, const Value *thisObject, const Value *argv, int argc);
};

struct ResolveWrapper : FunctionObject {
    V4_OBJECT2(ResolveWrapper, FunctionObject)

    static ReturnedValue virtualCall(const FunctionObject *f, const Value *thisObject, const Value *argv, int argc);
};

struct RejectWrapper : FunctionObject {
    V4_OBJECT2(RejectWrapper, FunctionObject)

    static ReturnedValue virtualCall(const FunctionObject *f, const Value *thisObject, const Value *argv, int argc);
};

} // QV4

QT_END_NAMESPACE

#endif // QV4PROMISEOBJECT_H