Remove excessive headers from JavaScriptCore
[WebKit-https.git] / Source / JavaScriptCore / runtime / FunctionExecutable.h
1 /*
2  * Copyright (C) 2009, 2010, 2013-2016 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 #pragma once
27
28 #include "ScriptExecutable.h"
29 #include "SourceCode.h"
30
31 namespace JSC {
32
33 class FunctionExecutable final : public ScriptExecutable {
34     friend class JIT;
35     friend class LLIntOffsetsExtractor;
36 public:
37     typedef ScriptExecutable Base;
38     static const unsigned StructureFlags = Base::StructureFlags | StructureIsImmortal;
39
40     static FunctionExecutable* create(
41         VM& vm, const SourceCode& source, UnlinkedFunctionExecutable* unlinkedExecutable, 
42         unsigned lastLine, unsigned endColumn, Intrinsic intrinsic)
43     {
44         FunctionExecutable* executable = new (NotNull, allocateCell<FunctionExecutable>(vm.heap)) FunctionExecutable(vm, source, unlinkedExecutable, lastLine, endColumn, intrinsic);
45         executable->finishCreation(vm);
46         return executable;
47     }
48     static FunctionExecutable* fromGlobalCode(
49         const Identifier& name, ExecState&, const SourceCode&, 
50         JSObject*& exception, int overrideLineNumber);
51
52     static void destroy(JSCell*);
53         
54     UnlinkedFunctionExecutable* unlinkedExecutable() const
55     {
56         return m_unlinkedExecutable.get();
57     }
58
59     // Returns either call or construct bytecode. This can be appropriate
60     // for answering questions that that don't vary between call and construct --
61     // for example, argumentsRegister().
62     FunctionCodeBlock* eitherCodeBlock()
63     {
64         if (m_codeBlockForCall)
65             return m_codeBlockForCall.get();
66         return m_codeBlockForConstruct.get();
67     }
68         
69     bool isGeneratedForCall() const
70     {
71         return !!m_codeBlockForCall;
72     }
73
74     FunctionCodeBlock* codeBlockForCall()
75     {
76         return m_codeBlockForCall.get();
77     }
78
79     bool isGeneratedForConstruct() const
80     {
81         return m_codeBlockForConstruct.get();
82     }
83
84     FunctionCodeBlock* codeBlockForConstruct()
85     {
86         return m_codeBlockForConstruct.get();
87     }
88         
89     bool isGeneratedFor(CodeSpecializationKind kind)
90     {
91         if (kind == CodeForCall)
92             return isGeneratedForCall();
93         ASSERT(kind == CodeForConstruct);
94         return isGeneratedForConstruct();
95     }
96         
97     FunctionCodeBlock* codeBlockFor(CodeSpecializationKind kind)
98     {
99         if (kind == CodeForCall)
100             return codeBlockForCall();
101         ASSERT(kind == CodeForConstruct);
102         return codeBlockForConstruct();
103     }
104
105     FunctionCodeBlock* baselineCodeBlockFor(CodeSpecializationKind);
106         
107     FunctionCodeBlock* profiledCodeBlockFor(CodeSpecializationKind kind)
108     {
109         return baselineCodeBlockFor(kind);
110     }
111
112     RefPtr<TypeSet> returnStatementTypeSet() 
113     {
114         if (!m_returnStatementTypeSet)
115             m_returnStatementTypeSet = TypeSet::create();
116
117         return m_returnStatementTypeSet;
118     }
119         
120     FunctionMode functionMode() { return m_unlinkedExecutable->functionMode(); }
121     bool isBuiltinFunction() const { return m_unlinkedExecutable->isBuiltinFunction(); }
122     ConstructAbility constructAbility() const { return m_unlinkedExecutable->constructAbility(); }
123     bool isClass() const { return !classSource().isNull(); }
124     bool isArrowFunction() const { return parseMode() == SourceParseMode::ArrowFunctionMode; }
125     bool isGetter() const { return parseMode() == SourceParseMode::GetterMode; }
126     bool isSetter() const { return parseMode() == SourceParseMode::SetterMode; }
127     bool isGenerator() const { return isGeneratorParseMode(parseMode()); }
128     bool isMethod() const { return parseMode() == SourceParseMode::MethodMode; }
129     bool hasCallerAndArgumentsProperties() const
130     {
131         // Per https://tc39.github.io/ecma262/#sec-forbidden-extensions, only sloppy-mode non-builtin functions in old-style (pre-ES6) syntactic forms can contain
132         // "caller" and "arguments".
133         return !isStrictMode() && parseMode() == SourceParseMode::NormalFunctionMode && !isClassConstructorFunction();
134     }
135     bool hasPrototypeProperty() const
136     {
137         return SourceParseModeSet(
138             SourceParseMode::NormalFunctionMode,
139             SourceParseMode::GeneratorBodyMode,
140             SourceParseMode::GeneratorWrapperFunctionMode,
141             SourceParseMode::GeneratorWrapperMethodMode
142         ).contains(parseMode()) || isClass();
143     }
144     DerivedContextType derivedContextType() const { return m_unlinkedExecutable->derivedContextType(); }
145     bool isClassConstructorFunction() const { return m_unlinkedExecutable->isClassConstructorFunction(); }
146     const Identifier& name() { return m_unlinkedExecutable->name(); }
147     const Identifier& ecmaName() { return m_unlinkedExecutable->ecmaName(); }
148     const Identifier& inferredName() { return m_unlinkedExecutable->inferredName(); }
149     unsigned parameterCount() const { return m_unlinkedExecutable->parameterCount(); } // Excluding 'this'!
150     SourceParseMode parseMode() const { return m_unlinkedExecutable->parseMode(); }
151     JSParserScriptMode scriptMode() const { return m_unlinkedExecutable->scriptMode(); }
152     const SourceCode& classSource() const { return m_unlinkedExecutable->classSource(); }
153
154     static void visitChildren(JSCell*, SlotVisitor&);
155     static Structure* createStructure(VM& vm, JSGlobalObject* globalObject, JSValue proto)
156     {
157         return Structure::create(vm, globalObject, proto, TypeInfo(FunctionExecutableType, StructureFlags), info());
158     }
159
160     unsigned parametersStartOffset() const { return m_parametersStartOffset; }
161
162     void overrideParameterAndTypeProfilingStartEndOffsets(unsigned parametersStartOffset, unsigned typeProfilingStartOffset, unsigned typeProfilingEndOffset)
163     {
164         m_parametersStartOffset = parametersStartOffset;
165         m_typeProfilingStartOffset = typeProfilingStartOffset;
166         m_typeProfilingEndOffset = typeProfilingEndOffset;
167     }
168
169     DECLARE_INFO;
170
171     InferredValue* singletonFunction() { return m_singletonFunction.get(); }
172
173 private:
174     friend class ExecutableBase;
175     FunctionExecutable(
176         VM&, const SourceCode&, UnlinkedFunctionExecutable*,
177         unsigned lastLine, unsigned endColumn, Intrinsic);
178     
179     void finishCreation(VM&);
180
181     friend class ScriptExecutable;
182     
183     unsigned m_parametersStartOffset;
184     WriteBarrier<UnlinkedFunctionExecutable> m_unlinkedExecutable;
185     WriteBarrier<FunctionCodeBlock> m_codeBlockForCall;
186     WriteBarrier<FunctionCodeBlock> m_codeBlockForConstruct;
187     RefPtr<TypeSet> m_returnStatementTypeSet;
188     WriteBarrier<InferredValue> m_singletonFunction;
189 };
190
191 } // namespace JSC