[ES6][ES7] Drop Constructability of generator function
[WebKit-https.git] / Source / JavaScriptCore / bytecode / UnlinkedFunctionExecutable.h
1 /*
2  * Copyright (C) 2012-2015 Apple Inc. All Rights Reserved.
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. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef UnlinkedFunctionExecutable_h
27 #define UnlinkedFunctionExecutable_h
28
29 #include "BytecodeConventions.h"
30 #include "CodeSpecializationKind.h"
31 #include "CodeType.h"
32 #include "ConstructAbility.h"
33 #include "ExpressionRangeInfo.h"
34 #include "HandlerInfo.h"
35 #include "Identifier.h"
36 #include "JSCell.h"
37 #include "JSString.h"
38 #include "ParserModes.h"
39 #include "RegExp.h"
40 #include "SpecialPointer.h"
41 #include "VariableEnvironment.h"
42 #include "VirtualRegister.h"
43 #include <wtf/RefCountedArray.h>
44 #include <wtf/Vector.h>
45
46 namespace JSC {
47
48 class FunctionMetadataNode;
49 class FunctionExecutable;
50 class ParserError;
51 class SourceCode;
52 class SourceProvider;
53 class UnlinkedFunctionCodeBlock;
54
55 enum UnlinkedFunctionKind {
56     UnlinkedNormalFunction,
57     UnlinkedBuiltinFunction,
58 };
59
60 class UnlinkedFunctionExecutable final : public JSCell {
61 public:
62     friend class CodeCache;
63     friend class VM;
64
65     typedef JSCell Base;
66     static const unsigned StructureFlags = Base::StructureFlags | StructureIsImmortal;
67
68     static UnlinkedFunctionExecutable* create(VM* vm, const SourceCode& source, FunctionMetadataNode* node, UnlinkedFunctionKind unlinkedFunctionKind, ConstructAbility constructAbility, VariableEnvironment& parentScopeTDZVariables, bool isDerivedConstructorContext, RefPtr<SourceProvider>&& sourceOverride = nullptr)
69     {
70         UnlinkedFunctionExecutable* instance = new (NotNull, allocateCell<UnlinkedFunctionExecutable>(vm->heap))
71             UnlinkedFunctionExecutable(vm, vm->unlinkedFunctionExecutableStructure.get(), source, WTF::move(sourceOverride), node, unlinkedFunctionKind, constructAbility, parentScopeTDZVariables, isDerivedConstructorContext);
72         instance->finishCreation(*vm);
73         return instance;
74     }
75
76     const Identifier& name() const { return m_name; }
77     const Identifier& inferredName() const { return m_inferredName; }
78     JSString* nameValue() const { return m_nameValue.get(); }
79     void setNameValue(VM& vm, JSString* nameValue) { m_nameValue.set(vm, this, nameValue); }
80     unsigned parameterCount() const { return m_parameterCount; };
81     SourceParseMode parseMode() const { return m_parseMode; };
82     bool isInStrictContext() const { return m_isInStrictContext; }
83     FunctionMode functionMode() const { return static_cast<FunctionMode>(m_functionMode); }
84     ConstructorKind constructorKind() const { return static_cast<ConstructorKind>(m_constructorKind); }
85     SuperBinding superBinding() const { return static_cast<SuperBinding>(m_superBinding); }
86
87     unsigned unlinkedFunctionNameStart() const { return m_unlinkedFunctionNameStart; }
88     unsigned unlinkedBodyStartColumn() const { return m_unlinkedBodyStartColumn; }
89     unsigned unlinkedBodyEndColumn() const { return m_unlinkedBodyEndColumn; }
90     unsigned startOffset() const { return m_startOffset; }
91     unsigned sourceLength() { return m_sourceLength; }
92     unsigned parametersStartOffset() const { return m_parametersStartOffset; }
93     unsigned typeProfilingStartOffset() const { return m_typeProfilingStartOffset; }
94     unsigned typeProfilingEndOffset() const { return m_typeProfilingEndOffset; }
95     void setInvalidTypeProfilingOffsets();
96
97     UnlinkedFunctionCodeBlock* unlinkedCodeBlockFor(
98         VM&, const SourceCode&, CodeSpecializationKind, DebuggerMode, ProfilerMode, 
99         ParserError&, SourceParseMode);
100
101     static UnlinkedFunctionExecutable* fromGlobalCode(
102         const Identifier&, ExecState&, const SourceCode&, JSObject*& exception, 
103         int overrideLineNumber);
104
105     JS_EXPORT_PRIVATE FunctionExecutable* link(VM&, const SourceCode&, int overrideLineNumber = -1);
106
107     void clearCode()
108     {
109         m_unlinkedCodeBlockForCall.clear();
110         m_unlinkedCodeBlockForConstruct.clear();
111     }
112
113     void recordParse(CodeFeatures features, bool hasCapturedVariables)
114     {
115         m_features = features;
116         m_hasCapturedVariables = hasCapturedVariables;
117     }
118
119     CodeFeatures features() const { return m_features; }
120     bool hasCapturedVariables() const { return m_hasCapturedVariables; }
121
122     static const bool needsDestruction = true;
123     static void destroy(JSCell*);
124
125     bool isBuiltinFunction() const { return m_isBuiltinFunction; }
126     ConstructAbility constructAbility() const { return static_cast<ConstructAbility>(m_constructAbility); }
127     bool isClassConstructorFunction() const { return constructorKind() != ConstructorKind::None; }
128     const VariableEnvironment* parentScopeTDZVariables() const { return &m_parentScopeTDZVariables; }
129     
130     bool isArrowFunction() const { return m_parseMode == SourceParseMode::ArrowFunctionMode; }
131     bool isDerivedConstructorContext() const {return m_isDerivedConstructorContext; }
132
133 private:
134     UnlinkedFunctionExecutable(VM*, Structure*, const SourceCode&, RefPtr<SourceProvider>&& sourceOverride, FunctionMetadataNode*, UnlinkedFunctionKind, ConstructAbility, VariableEnvironment&, bool isDerivedConstructorContext);
135     
136     WriteBarrier<UnlinkedFunctionCodeBlock> m_unlinkedCodeBlockForCall;
137     WriteBarrier<UnlinkedFunctionCodeBlock> m_unlinkedCodeBlockForConstruct;
138
139     Identifier m_name;
140     Identifier m_inferredName;
141     WriteBarrier<JSString> m_nameValue;
142     RefPtr<SourceProvider> m_sourceOverride;
143     VariableEnvironment m_parentScopeTDZVariables;
144     unsigned m_firstLineOffset;
145     unsigned m_lineCount;
146     unsigned m_unlinkedFunctionNameStart;
147     unsigned m_unlinkedBodyStartColumn;
148     unsigned m_unlinkedBodyEndColumn;
149     unsigned m_startOffset;
150     unsigned m_sourceLength;
151     unsigned m_parametersStartOffset;
152     unsigned m_typeProfilingStartOffset;
153     unsigned m_typeProfilingEndOffset;
154     unsigned m_parameterCount;
155     SourceParseMode m_parseMode;
156
157     CodeFeatures m_features;
158
159     unsigned m_isInStrictContext : 1;
160     unsigned m_hasCapturedVariables : 1;
161     unsigned m_isBuiltinFunction : 1;
162     unsigned m_constructAbility: 1;
163     unsigned m_constructorKind : 2;
164     unsigned m_functionMode : 1; // FunctionMode
165     unsigned m_superBinding : 1;
166     unsigned m_isDerivedConstructorContext : 1;
167
168 protected:
169     void finishCreation(VM& vm)
170     {
171         Base::finishCreation(vm);
172         m_nameValue.set(vm, this, jsString(&vm, name().string()));
173     }
174
175     static void visitChildren(JSCell*, SlotVisitor&);
176
177 public:
178     static Structure* createStructure(VM& vm, JSGlobalObject* globalObject, JSValue proto)
179     {
180         return Structure::create(vm, globalObject, proto, TypeInfo(UnlinkedFunctionExecutableType, StructureFlags), info());
181     }
182
183     DECLARE_EXPORT_INFO;
184 };
185
186 } // namespace JSC
187
188 #endif // UnlinkedFunctionExecutable_h