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