1 /*
2  * Copyright (c) 2021-2024 Huawei Device Co., Ltd.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 
16 #ifndef ECMASCRIPT_JS_GENERATOR_OBJECT_H
17 #define ECMASCRIPT_JS_GENERATOR_OBJECT_H
18 
19 #include "ecmascript/accessor_data.h"
20 #include "ecmascript/js_object.h"
21 
22 namespace panda {
23 namespace ecmascript {
24 enum class JSGeneratorState : uint8_t {
25     UNDEFINED = 0,
26     SUSPENDED_START,
27     SUSPENDED_YIELD,
28     EXECUTING,
29     COMPLETED,
30 };
31 enum class GeneratorResumeMode : uint8_t {
32     RETURN = 0,
33     THROW,
34     NEXT,
35     UNDEFINED
36 };
37 
38 class GeneratorContext : TaggedObject {
39 public:
40     CAST_CHECK(GeneratorContext, IsGeneratorContext);
41 
42     static constexpr size_t GENERATOR_REGS_ARRAY_OFFSET = TaggedObjectSize();
43     ACCESSORS(RegsArray, GENERATOR_REGS_ARRAY_OFFSET, GENERATOR_METHOD_OFFSET)
44     ACCESSORS(Method, GENERATOR_METHOD_OFFSET, GENERATOR_THIS_OFFSET)
45     ACCESSORS(This, GENERATOR_THIS_OFFSET, GENERATOR_ACC_OFFSET)
46     ACCESSORS(Acc, GENERATOR_ACC_OFFSET, GENERATOR_GENERATOR_OBJECT_OFFSET)
47     ACCESSORS(GeneratorObject, GENERATOR_GENERATOR_OBJECT_OFFSET, GENERATOR_LEXICALENV_OFFSET)
48     ACCESSORS(LexicalEnv, GENERATOR_LEXICALENV_OFFSET, GENERATOR_NREGS_OFFSET)
49     ACCESSORS_PRIMITIVE_FIELD(NRegs, uint32_t, GENERATOR_NREGS_OFFSET, GENERATOR_BC_OFFSET_OFFSET)
50     ACCESSORS_PRIMITIVE_FIELD(BCOffset, uint32_t, GENERATOR_BC_OFFSET_OFFSET, LAST_OFFSET)
51     DEFINE_ALIGN_SIZE(LAST_OFFSET);
52 
53     DECL_VISIT_OBJECT(GENERATOR_REGS_ARRAY_OFFSET, GENERATOR_NREGS_OFFSET)
54     DECL_DUMP()
55 };
56 
57 class JSGeneratorObject : public JSObject {
58 public:
59     CAST_CHECK(JSGeneratorObject, IsGeneratorObject);
60 
61     static constexpr size_t GENERATOR_CONTEXT_OFFSET = JSObject::SIZE;
62     ACCESSORS(GeneratorContext, GENERATOR_CONTEXT_OFFSET, GENERATOR_RESUME_RESULT_OFFSET)
63     ACCESSORS(ResumeResult, GENERATOR_RESUME_RESULT_OFFSET, TASK_INFO_OFFSET)
64     ACCESSORS_PRIMITIVE_FIELD(TaskInfo, uintptr_t, TASK_INFO_OFFSET, BIT_FIELD_OFFSET)
65     ACCESSORS_BIT_FIELD(BitField, BIT_FIELD_OFFSET, LAST_OFFSET)
66     DEFINE_ALIGN_SIZE(LAST_OFFSET);
67 
68     // define BitField
69     static constexpr size_t GENERATOE_STATE_BITS = 3;
70     static constexpr size_t RESUME_MODE_BITS = 3;
71     FIRST_BIT_FIELD(BitField, GeneratorState, JSGeneratorState, GENERATOE_STATE_BITS)
72     NEXT_BIT_FIELD(BitField, ResumeMode, GeneratorResumeMode, RESUME_MODE_BITS, GeneratorState)
73 
74     DECL_VISIT_OBJECT_FOR_JS_OBJECT(JSObject, GENERATOR_CONTEXT_OFFSET, TASK_INFO_OFFSET)
75     DECL_DUMP()
76 
77     // 26.4.3.2 GeneratorValidate(generator)
78     static JSGeneratorState GeneratorValidate(JSThread *thread, const JSHandle<JSTaggedValue> &obj);
79 
80     // 26.4.3.3 GeneratorResume(generator, value)
81     static JSHandle<JSObject> GeneratorResume(JSThread *thread, const JSHandle<JSGeneratorObject> &generator,
82                                               JSTaggedValue value);
83 
84     // 26.4.3.4 GeneratorResumeAbrupt(generator, abruptCompletion)
85     static JSHandle<JSObject> GeneratorResumeAbrupt(JSThread *thread, const JSHandle<JSGeneratorObject> &generator,
86                                                     const JSHandle<CompletionRecord> &abruptCompletion);
87 
IsSuspendYield() const88     inline bool IsSuspendYield() const
89     {
90         return GetGeneratorState() == JSGeneratorState::SUSPENDED_YIELD;
91     }
92 
IsExecuting() const93     inline bool IsExecuting() const
94     {
95         return GetGeneratorState() == JSGeneratorState::EXECUTING;
96     }
97 };
98 
99 class JSAsyncFuncObject : public JSGeneratorObject {
100 public:
101     CAST_CHECK(JSAsyncFuncObject, IsAsyncFuncObject);
102 
103     static constexpr size_t GENERATOR_PROMISE_OFFSET = JSGeneratorObject::SIZE;
104     ACCESSORS(Promise, GENERATOR_PROMISE_OFFSET, SIZE);
105 
106     DECL_VISIT_OBJECT_FOR_JS_OBJECT(JSGeneratorObject, GENERATOR_PROMISE_OFFSET, SIZE)
107     DECL_DUMP()
108 };
109 }  // namespace ecmascript
110 }  // namespace panda
111 
112 #endif  // ECMASCRIPT_JS_GENERATOR_OBJECT_H
113