put_to_scope[5] should not point to the structure if it's a variable access, but...
[WebKit-https.git] / Source / JavaScriptCore / runtime / JSScope.h
1 /*
2  * Copyright (C) 2012, 2013 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 JSScope_h
27 #define JSScope_h
28
29 #include "JSObject.h"
30
31 namespace JSC {
32
33 class ScopeChainIterator;
34 class WatchpointSet;
35
36 enum ResolveMode {
37     ThrowIfNotFound,
38     DoNotThrowIfNotFound
39 };
40
41 enum ResolveType {
42     // Lexical scope guaranteed a certain type of variable access.
43     GlobalProperty,
44     GlobalVar,
45     ClosureVar,
46
47     // Ditto, but at least one intervening scope used non-strict eval, which
48     // can inject an intercepting var delcaration at runtime.
49     GlobalPropertyWithVarInjectionChecks,
50     GlobalVarWithVarInjectionChecks,
51     ClosureVarWithVarInjectionChecks,
52
53     // Lexical scope didn't prove anything -- probably because of a 'with' scope.
54     Dynamic
55 };
56
57 inline ResolveType makeType(ResolveType type, bool needsVarInjectionChecks)
58 {
59     if (!needsVarInjectionChecks)
60         return type;
61
62     switch (type) {
63     case GlobalProperty:
64         return GlobalPropertyWithVarInjectionChecks;
65     case GlobalVar:
66         return GlobalVarWithVarInjectionChecks;
67     case ClosureVar:
68         return ClosureVarWithVarInjectionChecks;
69     case GlobalPropertyWithVarInjectionChecks:
70     case GlobalVarWithVarInjectionChecks:
71     case ClosureVarWithVarInjectionChecks:
72     case Dynamic:
73         return type;
74     }
75
76     RELEASE_ASSERT_NOT_REACHED();
77     return type;
78 }
79
80 inline bool needsVarInjectionChecks(ResolveType type)
81 {
82     switch (type) {
83     case GlobalProperty:
84     case GlobalVar:
85     case ClosureVar:
86         return false;
87     case GlobalPropertyWithVarInjectionChecks:
88     case GlobalVarWithVarInjectionChecks:
89     case ClosureVarWithVarInjectionChecks:
90     case Dynamic:
91         return true;
92     default:
93         RELEASE_ASSERT_NOT_REACHED();
94         return true;
95     }
96 }
97
98 struct ResolveOp {
99     ResolveOp(ResolveType type, size_t depth, Structure* structure, WatchpointSet* watchpointSet, uintptr_t operand)
100         : type(type)
101         , depth(depth)
102         , structure(structure)
103         , watchpointSet(watchpointSet)
104         , operand(operand)
105     {
106     }
107
108     ResolveType type;
109     size_t depth;
110     Structure* structure;
111     WatchpointSet* watchpointSet;
112     uintptr_t operand;
113 };
114
115 class ResolveModeAndType {
116     typedef unsigned Operand;
117 public:
118     static const size_t shift = sizeof(Operand) * 8 / 2;
119     static const unsigned mask = (1 << shift) - 1;
120
121     ResolveModeAndType(ResolveMode resolveMode, ResolveType resolveType)
122         : m_operand((resolveMode << shift) | resolveType)
123     {
124     }
125
126     explicit ResolveModeAndType(unsigned operand)
127         : m_operand(operand)
128     {
129     }
130
131     ResolveMode mode() { return static_cast<ResolveMode>(m_operand >> shift); }
132     ResolveType type() { return static_cast<ResolveType>(m_operand & mask); }
133     unsigned operand() { return m_operand; }
134
135 private:
136     Operand m_operand;
137 };
138
139 enum GetOrPut { Get, Put };
140
141 class JSScope : public JSNonFinalObject {
142 public:
143     typedef JSNonFinalObject Base;
144
145     friend class LLIntOffsetsExtractor;
146     static size_t offsetOfNext();
147
148     JS_EXPORT_PRIVATE static JSObject* objectAtScope(JSScope*);
149
150     static JSValue resolve(ExecState*, JSScope*, const Identifier&);
151     static ResolveOp abstractResolve(ExecState*, JSScope*, const Identifier&, GetOrPut, ResolveType);
152
153     static void visitChildren(JSCell*, SlotVisitor&);
154
155     ScopeChainIterator begin();
156     ScopeChainIterator end();
157     JSScope* next();
158     int depth();
159
160     JSGlobalObject* globalObject();
161     VM* vm();
162     JSObject* globalThis();
163
164 protected:
165     JSScope(VM&, Structure*, JSScope* next);
166     static const unsigned StructureFlags = OverridesVisitChildren | Base::StructureFlags;
167
168 private:
169     WriteBarrier<JSScope> m_next;
170 };
171
172 inline JSScope::JSScope(VM& vm, Structure* structure, JSScope* next)
173     : Base(vm, structure)
174     , m_next(vm, this, next, WriteBarrier<JSScope>::MayBeNull)
175 {
176 }
177
178 class ScopeChainIterator {
179 public:
180     ScopeChainIterator(JSScope* node)
181         : m_node(node)
182     {
183     }
184
185     JSObject* get() const { return JSScope::objectAtScope(m_node); }
186     JSObject* operator->() const { return JSScope::objectAtScope(m_node); }
187
188     ScopeChainIterator& operator++() { m_node = m_node->next(); return *this; }
189
190     // postfix ++ intentionally omitted
191
192     bool operator==(const ScopeChainIterator& other) const { return m_node == other.m_node; }
193     bool operator!=(const ScopeChainIterator& other) const { return m_node != other.m_node; }
194
195 private:
196     JSScope* m_node;
197 };
198
199 inline ScopeChainIterator JSScope::begin()
200 {
201     return ScopeChainIterator(this); 
202 }
203
204 inline ScopeChainIterator JSScope::end()
205
206     return ScopeChainIterator(0); 
207 }
208
209 inline JSScope* JSScope::next()
210
211     return m_next.get();
212 }
213
214 inline JSGlobalObject* JSScope::globalObject()
215
216     return structure()->globalObject();
217 }
218
219 inline VM* JSScope::vm()
220
221     return MarkedBlock::blockFor(this)->vm();
222 }
223
224 inline Register& Register::operator=(JSScope* scope)
225 {
226     *this = JSValue(scope);
227     return *this;
228 }
229
230 inline JSScope* Register::scope() const
231 {
232     return jsCast<JSScope*>(jsValue());
233 }
234
235 inline VM& ExecState::vm() const
236 {
237     ASSERT(scope()->vm());
238     return *scope()->vm();
239 }
240
241 inline JSGlobalObject* ExecState::lexicalGlobalObject() const
242 {
243     return scope()->globalObject();
244 }
245
246 inline JSObject* ExecState::globalThisValue() const
247 {
248     return scope()->globalThis();
249 }
250
251 inline size_t JSScope::offsetOfNext()
252 {
253     return OBJECT_OFFSETOF(JSScope, m_next);
254 }
255
256 } // namespace JSC
257
258 #endif // JSScope_h