[ES7] yield star should not return if the inner iterator.throw returns { done: true }
[WebKit-https.git] / Source / JavaScriptCore / runtime / JSGeneratorFunction.h
1 /*
2  * Copyright (C) 2015 Yusuke Suzuki <utatane.tea@gmail.com>.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef JSGeneratorFunction_h
27 #define JSGeneratorFunction_h
28
29 #include "JSFunction.h"
30
31 namespace JSC {
32
33 class JSGlobalObject;
34 class LLIntOffsetsExtractor;
35 class LLIntDesiredOffsets;
36
37 class JSGeneratorFunction : public JSFunction {
38     friend class JIT;
39 #if ENABLE(DFG_JIT)
40     friend class DFG::SpeculativeJIT;
41     friend class DFG::JITCompiler;
42 #endif
43     friend class VM;
44 public:
45     typedef JSFunction Base;
46
47     enum class GeneratorResumeMode : int32_t {
48         NormalMode = 0,
49         ReturnMode = 1,
50         ThrowMode = 2
51     };
52
53     enum class GeneratorState : int32_t {
54         Completed = -1,
55         Executing = -2,
56     };
57
58     const static unsigned StructureFlags = Base::StructureFlags;
59
60     DECLARE_EXPORT_INFO;
61
62     static JSGeneratorFunction* create(VM&, FunctionExecutable*, JSScope*);
63     static JSGeneratorFunction* createWithInvalidatedReallocationWatchpoint(VM&, FunctionExecutable*, JSScope*);
64
65     static size_t allocationSize(size_t inlineCapacity)
66     {
67         ASSERT_UNUSED(inlineCapacity, !inlineCapacity);
68         return sizeof(JSGeneratorFunction);
69     }
70
71     static Structure* createStructure(VM& vm, JSGlobalObject* globalObject, JSValue prototype)
72     {
73         ASSERT(globalObject);
74         return Structure::create(vm, globalObject, prototype, TypeInfo(JSFunctionType, StructureFlags), info());
75     }
76
77 private:
78     JSGeneratorFunction(VM&, FunctionExecutable*, JSScope*);
79
80     static JSGeneratorFunction* createImpl(VM&, FunctionExecutable*, JSScope*);
81
82     friend class LLIntOffsetsExtractor;
83 };
84
85 } // namespace JSC
86
87 #endif // JSGeneratorFunction_h