e079ee4ca9fbb682cecb1faf0f9e9f56f70bffcb
[WebKit-https.git] / Source / JavaScriptCore / runtime / JSScope.h
1 /*
2  * Copyright (C) 2012-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 "GetPutInfo.h"
29 #include "JSObject.h"
30
31 namespace JSC {
32
33 class ScopeChainIterator;
34 class SymbolTable;
35 class VariableEnvironment;
36 class WatchpointSet;
37
38 class JSScope : public JSNonFinalObject {
39 public:
40     typedef JSNonFinalObject Base;
41     static const unsigned StructureFlags = Base::StructureFlags;
42
43     friend class LLIntOffsetsExtractor;
44     static size_t offsetOfNext();
45
46     static JSObject* objectAtScope(JSScope*);
47
48     static JSObject* resolve(ExecState*, JSScope*, const Identifier&);
49     static JSValue resolveScopeForHoistingFuncDeclInEval(ExecState*, JSScope*, const Identifier&);
50     static ResolveOp abstractResolve(ExecState*, size_t depthOffset, JSScope*, const Identifier&, GetOrPut, ResolveType, InitializationMode);
51
52     static bool hasConstantScope(ResolveType);
53     static JSScope* constantScopeForCodeBlock(ResolveType, CodeBlock*);
54
55     static void collectClosureVariablesUnderTDZ(JSScope*, VariableEnvironment& result);
56
57     static void visitChildren(JSCell*, SlotVisitor&);
58
59     bool isVarScope();
60     bool isLexicalScope();
61     bool isModuleScope();
62     bool isCatchScope();
63     bool isFunctionNameScopeObject();
64
65     bool isNestedLexicalScope();
66
67     ScopeChainIterator begin();
68     ScopeChainIterator end();
69     JSScope* next();
70
71     JSGlobalObject* globalObject();
72     JSGlobalObject* globalObject(VM&);
73     JSObject* globalThis();
74
75     SymbolTable* symbolTable(VM&);
76
77 protected:
78     JSScope(VM&, Structure*, JSScope* next);
79
80     template<typename ReturnPredicateFunctor, typename SkipPredicateFunctor>
81     static JSObject* resolve(ExecState*, JSScope*, const Identifier&, ReturnPredicateFunctor, SkipPredicateFunctor);
82
83 private:
84     WriteBarrier<JSScope> m_next;
85 };
86
87 inline JSScope::JSScope(VM& vm, Structure* structure, JSScope* next)
88     : Base(vm, structure)
89     , m_next(vm, this, next, WriteBarrier<JSScope>::MayBeNull)
90 {
91 }
92
93 class ScopeChainIterator {
94 public:
95     ScopeChainIterator(JSScope* node)
96         : m_node(node)
97     {
98     }
99
100     JSObject* get() const { return JSScope::objectAtScope(m_node); }
101     JSObject* operator->() const { return JSScope::objectAtScope(m_node); }
102     JSScope* scope() const { return m_node; }
103
104     ScopeChainIterator& operator++() { m_node = m_node->next(); return *this; }
105
106     // postfix ++ intentionally omitted
107
108     bool operator==(const ScopeChainIterator& other) const { return m_node == other.m_node; }
109     bool operator!=(const ScopeChainIterator& other) const { return m_node != other.m_node; }
110
111 private:
112     JSScope* m_node;
113 };
114
115 inline ScopeChainIterator JSScope::begin()
116 {
117     return ScopeChainIterator(this); 
118 }
119
120 inline ScopeChainIterator JSScope::end()
121
122     return ScopeChainIterator(0); 
123 }
124
125 inline JSScope* JSScope::next()
126
127     return m_next.get();
128 }
129
130 inline JSGlobalObject* JSScope::globalObject()
131
132     return structure()->globalObject();
133 }
134
135 inline JSGlobalObject* JSScope::globalObject(VM& vm)
136
137     return structure(vm)->globalObject();
138 }
139
140 inline Register& Register::operator=(JSScope* scope)
141 {
142     *this = JSValue(scope);
143     return *this;
144 }
145
146 inline JSScope* Register::scope() const
147 {
148     return jsCast<JSScope*>(unboxedCell());
149 }
150
151 inline JSGlobalObject* ExecState::lexicalGlobalObject() const
152 {
153     return jsCallee()->globalObject();
154 }
155
156 inline size_t JSScope::offsetOfNext()
157 {
158     return OBJECT_OFFSETOF(JSScope, m_next);
159 }
160
161 } // namespace JSC