92b1660adfba8a98403f6b9f8434d051a2876c0e
[WebKit-https.git] / Source / JavaScriptCore / runtime / JSCell.h
1 /*
2  *  Copyright (C) 1999-2001 Harri Porten (porten@kde.org)
3  *  Copyright (C) 2001 Peter Kelly (pmk@post.com)
4  *  Copyright (C) 2003, 2004, 2005, 2007, 2008, 2009 Apple Inc. All rights reserved.
5  *
6  *  This library is free software; you can redistribute it and/or
7  *  modify it under the terms of the GNU Library General Public
8  *  License as published by the Free Software Foundation; either
9  *  version 2 of the License, or (at your option) any later version.
10  *
11  *  This library is distributed in the hope that it will be useful,
12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  *  Library General Public License for more details.
15  *
16  *  You should have received a copy of the GNU Library General Public License
17  *  along with this library; see the file COPYING.LIB.  If not, write to
18  *  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19  *  Boston, MA 02110-1301, USA.
20  *
21  */
22
23 #ifndef JSCell_h
24 #define JSCell_h
25
26 #include "CallData.h"
27 #include "CallFrame.h"
28 #include "ConstructData.h"
29 #include "Heap.h"
30 #include "JSLock.h"
31 #include "JSValueInlineMethods.h"
32 #include "SlotVisitor.h"
33 #include "WriteBarrier.h"
34 #include <wtf/Noncopyable.h>
35
36 namespace JSC {
37
38     class JSGlobalObject;
39     class Structure;
40
41     class JSCell {
42         friend class JSValue;
43         friend class MarkedBlock;
44
45     public:
46         enum CreatingEarlyCellTag { CreatingEarlyCell };
47         JSCell(CreatingEarlyCellTag);
48
49         enum VPtrStealingHackType { VPtrStealingHack };
50         explicit JSCell(VPtrStealingHackType) { }
51
52     public:
53         void* operator new(size_t, void* placementNewDestination) { return placementNewDestination; } // Used for initialization after GC allocation.
54
55     protected:
56         JSCell(JSGlobalData&, Structure*);
57         virtual ~JSCell(); // Invoked by GC finalization.
58
59     public:
60         // Querying the type.
61         bool isString() const;
62         bool isObject() const;
63         bool isGetterSetter() const;
64         bool inherits(const ClassInfo*) const;
65         bool isAPIValueWrapper() const;
66
67         Structure* structure() const;
68         void setStructure(JSGlobalData&, Structure*);
69         void clearStructure() { m_structure.clear(); }
70
71         // Extracting the value.
72         bool getString(ExecState* exec, UString&) const;
73         UString getString(ExecState* exec) const; // null string if not a string
74         JSObject* getObject(); // NULL if not an object
75         const JSObject* getObject() const; // NULL if not an object
76         
77         static CallType getCallData(JSCell*, CallData&);
78         static ConstructType getConstructData(JSCell*, ConstructData&);
79
80         // Basic conversions.
81         JSValue toPrimitive(ExecState*, PreferredPrimitiveType) const;
82         bool getPrimitiveNumber(ExecState*, double& number, JSValue&) const;
83         bool toBoolean(ExecState*) const;
84         double toNumber(ExecState*) const;
85         UString toString(ExecState*) const;
86         JSObject* toObject(ExecState*, JSGlobalObject*) const;
87
88         static void visitChildren(JSCell*, SlotVisitor&);
89
90         // Object operations, with the toObject operation included.
91         const ClassInfo* classInfo() const;
92         const MethodTable* methodTable() const;
93         static void put(JSCell*, ExecState*, const Identifier& propertyName, JSValue, PutPropertySlot&);
94         static void putByIndex(JSCell*, ExecState*, unsigned propertyName, JSValue);
95         
96         static bool deleteProperty(JSCell*, ExecState*, const Identifier& propertyName);
97         static bool deletePropertyByIndex(JSCell*, ExecState*, unsigned propertyName);
98
99         static JSObject* toThisObject(JSCell*, ExecState*);
100
101         void* vptr() const { ASSERT(!isZapped()); return *reinterpret_cast<void* const*>(this); }
102         void setVPtr(void* vptr) { *reinterpret_cast<void**>(this) = vptr; ASSERT(!isZapped()); }
103         void zap() { *reinterpret_cast<uintptr_t**>(this) = 0; }
104         bool isZapped() const { return !*reinterpret_cast<uintptr_t* const*>(this); }
105
106         // FIXME: Rename getOwnPropertySlot to virtualGetOwnPropertySlot, and
107         // fastGetOwnPropertySlot to getOwnPropertySlot. Callers should always
108         // call this function, not its slower virtual counterpart. (For integer
109         // property names, we want a similar interface with appropriate optimizations.)
110         bool fastGetOwnPropertySlot(ExecState*, const Identifier& propertyName, PropertySlot&);
111         JSValue fastGetOwnProperty(ExecState*, const UString&);
112
113         static ptrdiff_t structureOffset()
114         {
115             return OBJECT_OFFSETOF(JSCell, m_structure);
116         }
117         
118         void* structureAddress()
119         {
120             return &m_structure;
121         }
122
123 #if ENABLE(GC_VALIDATION)
124         Structure* unvalidatedStructure() { return m_structure.unvalidatedGet(); }
125 #endif
126         
127     protected:
128
129         void finishCreation(JSGlobalData&);
130         void finishCreation(JSGlobalData&, Structure*, CreatingEarlyCellTag);
131
132         // Base implementation; for non-object classes implements getPropertySlot.
133         static bool getOwnPropertySlot(JSCell*, ExecState*, const Identifier& propertyName, PropertySlot&);
134         static bool getOwnPropertySlotByIndex(JSCell*, ExecState*, unsigned propertyName, PropertySlot&);
135
136         // Dummy implementations of override-able static functions for classes to put in their MethodTable
137         static NO_RETURN_DUE_TO_ASSERT void defineGetter(JSObject*, ExecState*, const Identifier&, JSObject*, unsigned);
138         
139     private:
140         WriteBarrier<Structure> m_structure;
141     };
142     
143     inline JSCell::JSCell(JSGlobalData& globalData, Structure* structure)
144         : m_structure(globalData, this, structure)
145     {
146     }
147
148     inline JSCell::JSCell(CreatingEarlyCellTag)
149     {
150     }
151
152     inline void JSCell::finishCreation(JSGlobalData& globalData)
153     {
154 #if ENABLE(GC_VALIDATION)
155         ASSERT(globalData.isInitializingObject());
156         globalData.setInitializingObject(false);
157 #else
158         UNUSED_PARAM(globalData);
159 #endif
160         ASSERT(m_structure);
161     }
162
163     inline void JSCell::finishCreation(JSGlobalData& globalData, Structure* structure, CreatingEarlyCellTag)
164     {
165 #if ENABLE(GC_VALIDATION)
166         ASSERT(globalData.isInitializingObject());
167         globalData.setInitializingObject(false);
168         if (structure)
169 #endif
170             m_structure.setEarlyValue(globalData, this, structure);
171         // Very first set of allocations won't have a real structure.
172         ASSERT(m_structure || !globalData.structureStructure);
173     }
174
175     inline JSCell::~JSCell()
176     {
177     }
178
179     inline Structure* JSCell::structure() const
180     {
181         return m_structure.get();
182     }
183
184     inline void JSCell::visitChildren(JSCell* cell, SlotVisitor& visitor)
185     {
186         JSCell* thisObject = static_cast<JSCell*>(cell);
187         visitor.append(&thisObject->m_structure);
188     }
189
190     // --- JSValue inlines ----------------------------
191
192     inline bool JSValue::isString() const
193     {
194         return isCell() && asCell()->isString();
195     }
196
197     inline bool JSValue::isPrimitive() const
198     {
199         return !isCell() || asCell()->isString();
200     }
201
202     inline bool JSValue::isGetterSetter() const
203     {
204         return isCell() && asCell()->isGetterSetter();
205     }
206
207     inline bool JSValue::isObject() const
208     {
209         return isCell() && asCell()->isObject();
210     }
211
212     inline bool JSValue::getString(ExecState* exec, UString& s) const
213     {
214         return isCell() && asCell()->getString(exec, s);
215     }
216
217     inline UString JSValue::getString(ExecState* exec) const
218     {
219         return isCell() ? asCell()->getString(exec) : UString();
220     }
221
222     template <typename Base> UString HandleConverter<Base, Unknown>::getString(ExecState* exec) const
223     {
224         return jsValue().getString(exec);
225     }
226
227     inline JSObject* JSValue::getObject() const
228     {
229         return isCell() ? asCell()->getObject() : 0;
230     }
231
232     ALWAYS_INLINE bool JSValue::getUInt32(uint32_t& v) const
233     {
234         if (isInt32()) {
235             int32_t i = asInt32();
236             v = static_cast<uint32_t>(i);
237             return i >= 0;
238         }
239         if (isDouble()) {
240             double d = asDouble();
241             v = static_cast<uint32_t>(d);
242             return v == d;
243         }
244         return false;
245     }
246
247     inline JSValue JSValue::toPrimitive(ExecState* exec, PreferredPrimitiveType preferredType) const
248     {
249         return isCell() ? asCell()->toPrimitive(exec, preferredType) : asValue();
250     }
251
252     inline bool JSValue::getPrimitiveNumber(ExecState* exec, double& number, JSValue& value)
253     {
254         if (isInt32()) {
255             number = asInt32();
256             value = *this;
257             return true;
258         }
259         if (isDouble()) {
260             number = asDouble();
261             value = *this;
262             return true;
263         }
264         if (isCell())
265             return asCell()->getPrimitiveNumber(exec, number, value);
266         if (isTrue()) {
267             number = 1.0;
268             value = *this;
269             return true;
270         }
271         if (isFalse() || isNull()) {
272             number = 0.0;
273             value = *this;
274             return true;
275         }
276         ASSERT(isUndefined());
277         number = std::numeric_limits<double>::quiet_NaN();
278         value = *this;
279         return true;
280     }
281
282     ALWAYS_INLINE double JSValue::toNumber(ExecState* exec) const
283     {
284         if (isInt32())
285             return asInt32();
286         if (isDouble())
287             return asDouble();
288         return toNumberSlowCase(exec);
289     }
290
291     inline JSObject* JSValue::toObject(ExecState* exec) const
292     {
293         return isCell() ? asCell()->toObject(exec, exec->lexicalGlobalObject()) : toObjectSlowCase(exec, exec->lexicalGlobalObject());
294     }
295
296     inline JSObject* JSValue::toObject(ExecState* exec, JSGlobalObject* globalObject) const
297     {
298         return isCell() ? asCell()->toObject(exec, globalObject) : toObjectSlowCase(exec, globalObject);
299     }
300
301     template <typename T> void* allocateCell(Heap& heap)
302     {
303 #if ENABLE(GC_VALIDATION)
304         ASSERT(sizeof(T) == T::s_info.cellSize);
305         ASSERT(!heap.globalData()->isInitializingObject());
306         heap.globalData()->setInitializingObject(true);
307 #endif
308         JSCell* result = static_cast<JSCell*>(heap.allocate(sizeof(T)));
309         result->clearStructure();
310         return result;
311     }
312     
313     inline bool isZapped(const JSCell* cell)
314     {
315         return cell->isZapped();
316     }
317
318 } // namespace JSC
319
320 #endif // JSCell_h