241cee830f566c086b59127dfe7791627a149572
[WebKit.git] / JavaScriptCore / kjs / JSObject.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, 2006, 2007, 2008 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 JSObject_h
24 #define JSObject_h
25
26 #include "ArgList.h"
27 #include "ClassInfo.h"
28 #include "CommonIdentifiers.h"
29 #include "ExecState.h"
30 #include "JSNumberCell.h"
31 #include "PropertyMap.h"
32 #include "PropertySlot.h"
33 #include "PutPropertySlot.h"
34 #include "ScopeChain.h"
35 #include "StructureID.h"
36
37 namespace JSC {
38
39     class InternalFunction;
40     class PropertyNameArray;
41     class StructureID;
42     struct HashEntry;
43     struct HashTable;
44
45     // ECMA 262-3 8.6.1
46     // Property attributes
47     enum Attribute {
48         None         = 0,
49         ReadOnly     = 1 << 1,  // property can be only read, not written
50         DontEnum     = 1 << 2,  // property doesn't appear in (for .. in ..)
51         DontDelete   = 1 << 3,  // property can't be deleted
52         Function     = 1 << 4,  // property is a function - only used by static hashtables
53     };
54
55     class JSObject : public JSCell {
56         friend class BatchedTransitionOptimizer;
57         friend class CTI;
58
59     public:
60         explicit JSObject(PassRefPtr<StructureID>);
61
62         virtual void mark();
63
64         // The inline virtual destructor cannot be the first virtual function declared
65         // in the class as it results in the vtable being generated as a weak symbol
66         virtual ~JSObject();
67
68         bool inherits(const ClassInfo* classInfo) const { return JSCell::isObject(classInfo); }
69
70         JSValue* prototype() const;
71         void setPrototype(JSValue* prototype);
72         
73         void setStructureID(PassRefPtr<StructureID>);
74         StructureID* inheritorID();
75
76         PropertyStorage& propertyStorage() { return m_propertyStorage; }
77
78         virtual UString className() const;
79
80         JSValue* get(ExecState*, const Identifier& propertyName) const;
81         JSValue* get(ExecState*, unsigned propertyName) const;
82
83         bool getPropertySlot(ExecState*, const Identifier& propertyName, PropertySlot&);
84         bool getPropertySlot(ExecState*, unsigned propertyName, PropertySlot&);
85
86         virtual bool getOwnPropertySlot(ExecState*, const Identifier& propertyName, PropertySlot&);
87         virtual bool getOwnPropertySlot(ExecState*, unsigned propertyName, PropertySlot&);
88
89         virtual void put(ExecState*, const Identifier& propertyName, JSValue* value, PutPropertySlot&);
90         virtual void put(ExecState*, unsigned propertyName, JSValue* value);
91
92         virtual void putWithAttributes(ExecState*, const Identifier& propertyName, JSValue* value, unsigned attributes);
93         virtual void putWithAttributes(ExecState*, unsigned propertyName, JSValue* value, unsigned attributes);
94
95         bool propertyIsEnumerable(ExecState*, const Identifier& propertyName) const;
96
97         bool hasProperty(ExecState*, const Identifier& propertyName) const;
98         bool hasProperty(ExecState*, unsigned propertyName) const;
99         bool hasOwnProperty(ExecState*, const Identifier& propertyName) const;
100
101         virtual bool deleteProperty(ExecState*, const Identifier& propertyName);
102         virtual bool deleteProperty(ExecState*, unsigned propertyName);
103
104         virtual JSValue* defaultValue(ExecState*, PreferredPrimitiveType) const;
105
106         virtual bool hasInstance(ExecState*, JSValue*, JSValue* prototypeProperty);
107
108         virtual void getPropertyNames(ExecState*, PropertyNameArray&);
109
110         virtual JSValue* toPrimitive(ExecState*, PreferredPrimitiveType = NoPreference) const;
111         virtual bool getPrimitiveNumber(ExecState*, double& number, JSValue*& value);
112         virtual bool toBoolean(ExecState*) const;
113         virtual double toNumber(ExecState*) const;
114         virtual UString toString(ExecState*) const;
115         virtual JSObject* toObject(ExecState*) const;
116
117         virtual JSObject* toThisObject(ExecState*) const;
118         virtual JSGlobalObject* toGlobalObject(ExecState*) const;
119
120         virtual bool getPropertyAttributes(ExecState*, const Identifier& propertyName, unsigned& attributes) const;
121
122         // This get function only looks at the property map.
123         JSValue* getDirect(const Identifier& propertyName) const
124         {
125             size_t offset = m_structureID->propertyMap().get(propertyName);
126             return offset != WTF::notFound ? m_propertyStorage[offset] : 0;
127         }
128
129         JSValue** getDirectLocation(const Identifier& propertyName)
130         {
131             size_t offset = m_structureID->propertyMap().get(propertyName);
132             return offset != WTF::notFound ? locationForOffset(offset) : 0;
133         }
134
135         JSValue** getDirectLocation(const Identifier& propertyName, unsigned& attributes)
136         {
137             size_t offset = m_structureID->propertyMap().get(propertyName, attributes);
138             return offset != WTF::notFound ? locationForOffset(offset) : 0;
139         }
140
141         size_t offsetForLocation(JSValue** location)
142         {
143             return location - m_propertyStorage;
144         }
145
146         JSValue** locationForOffset(size_t offset)
147         {
148             return &m_propertyStorage[offset];
149         }
150
151         void transitionTo(StructureID*);
152
153         void removeDirect(const Identifier& propertyName);
154         bool hasCustomProperties() { return !m_structureID->propertyMap().isEmpty(); }
155         bool hasGetterSetterProperties() { return m_structureID->hasGetterSetterProperties(); }
156
157         void putDirect(const Identifier& propertyName, JSValue* value, unsigned attr = 0);
158         void putDirect(const Identifier& propertyName, JSValue* value, unsigned attr, bool checkReadOnly, PutPropertySlot& slot);
159         void putDirectFunction(ExecState* exec, InternalFunction* function, unsigned attr = 0);
160         void putDirectWithoutTransition(const Identifier& propertyName, JSValue* value, unsigned attr);
161         void putDirectFunctionWithoutTransition(ExecState* exec, InternalFunction* function, unsigned attr);
162
163         // Fast access to known property offsets.
164         JSValue* getDirectOffset(size_t offset) { return m_propertyStorage[offset]; }
165         void putDirectOffset(size_t offset, JSValue* value) { m_propertyStorage[offset] = value; }
166
167         void fillGetterPropertySlot(PropertySlot&, JSValue** location);
168
169         virtual void defineGetter(ExecState*, const Identifier& propertyName, JSObject* getterFunction);
170         virtual void defineSetter(ExecState*, const Identifier& propertyName, JSObject* setterFunction);
171         virtual JSValue* lookupGetter(ExecState*, const Identifier& propertyName);
172         virtual JSValue* lookupSetter(ExecState*, const Identifier& propertyName);
173
174         virtual bool isGlobalObject() const { return false; }
175         virtual bool isVariableObject() const { return false; }
176         virtual bool isWatchdogException() const { return false; }
177         virtual bool isNotAnObjectErrorStub() const { return false; }
178
179         void allocatePropertyStorage(size_t oldSize, size_t newSize);
180         bool usingInlineStorage() const { return m_propertyStorage == m_inlineStorage; }
181
182         static const size_t inlineStorageCapacity = 2;
183         static const size_t nonInlineBaseStorageCapacity = 16;
184
185         static PassRefPtr<StructureID> createStructureID(JSValue* proto) { return StructureID::create(proto, TypeInfo(ObjectType)); }
186
187     protected:
188         bool getOwnPropertySlotForWrite(ExecState*, const Identifier&, PropertySlot&, bool& slotIsWriteable);
189
190     private:
191         const HashEntry* findPropertyHashEntry(ExecState*, const Identifier& propertyName) const;
192         StructureID* createInheritorID();
193
194         RefPtr<StructureID> m_inheritorID;
195
196         PropertyStorage m_propertyStorage;        
197         JSValue* m_inlineStorage[inlineStorageCapacity];
198     };
199
200   JSObject* constructEmptyObject(ExecState*);
201
202 inline JSObject::JSObject(PassRefPtr<StructureID> structureID)
203     : JSCell(structureID.releaseRef()) // ~JSObject balances this ref()
204     , m_propertyStorage(m_inlineStorage)
205 {
206     ASSERT(m_structureID);
207     ASSERT(m_structureID->propertyStorageCapacity() == inlineStorageCapacity);
208     ASSERT(m_structureID->propertyMap().isEmpty());
209     ASSERT(prototype()->isNull() || Heap::heap(this) == Heap::heap(prototype()));
210 }
211
212 inline JSObject::~JSObject()
213 {
214     ASSERT(m_structureID);
215     if (m_propertyStorage != m_inlineStorage)
216         delete [] m_propertyStorage;
217     m_structureID->deref();
218 }
219
220 inline JSValue* JSObject::prototype() const
221 {
222     return m_structureID->storedPrototype();
223 }
224
225 inline void JSObject::setPrototype(JSValue* prototype)
226 {
227     ASSERT(prototype);
228     RefPtr<StructureID> newStructureID = StructureID::changePrototypeTransition(m_structureID, prototype);
229     setStructureID(newStructureID.release());
230 }
231
232 inline void JSObject::setStructureID(PassRefPtr<StructureID> structureID)
233 {
234     m_structureID->deref();
235     m_structureID = structureID.releaseRef(); // ~JSObject balances this ref()
236 }
237
238 inline StructureID* JSObject::inheritorID()
239 {
240     if (m_inheritorID)
241         return m_inheritorID.get();
242     return createInheritorID();
243 }
244
245 inline bool JSCell::isObject(const ClassInfo* info) const
246 {
247     for (const ClassInfo* ci = classInfo(); ci; ci = ci->parentClass) {
248         if (ci == info)
249             return true;
250     }
251     return false;
252 }
253
254 // this method is here to be after the inline declaration of JSCell::isObject
255 inline bool JSValue::isObject(const ClassInfo* classInfo) const
256 {
257     return !JSImmediate::isImmediate(this) && asCell()->isObject(classInfo);
258 }
259
260 inline JSValue* JSObject::get(ExecState* exec, const Identifier& propertyName) const
261 {
262     PropertySlot slot(const_cast<JSObject*>(this));
263     if (const_cast<JSObject*>(this)->getPropertySlot(exec, propertyName, slot))
264         return slot.getValue(exec, propertyName);
265     
266     return jsUndefined();
267 }
268
269 inline JSValue* JSObject::get(ExecState* exec, unsigned propertyName) const
270 {
271     PropertySlot slot(const_cast<JSObject*>(this));
272     if (const_cast<JSObject*>(this)->getPropertySlot(exec, propertyName, slot))
273         return slot.getValue(exec, propertyName);
274
275     return jsUndefined();
276 }
277
278 // It may seem crazy to inline a function this large but it makes a big difference
279 // since this is function very hot in variable lookup
280 inline bool JSObject::getPropertySlot(ExecState* exec, const Identifier& propertyName, PropertySlot& slot)
281 {
282     JSObject* object = this;
283     while (true) {
284         if (object->getOwnPropertySlot(exec, propertyName, slot))
285             return true;
286
287         JSValue* prototype = object->prototype();
288         if (!prototype->isObject())
289             return false;
290
291         object = static_cast<JSObject*>(prototype);
292     }
293 }
294
295 inline bool JSObject::getPropertySlot(ExecState* exec, unsigned propertyName, PropertySlot& slot)
296 {
297     JSObject* object = this;
298
299     while (true) {
300         if (object->getOwnPropertySlot(exec, propertyName, slot))
301             return true;
302
303         JSValue* prototype = object->prototype();
304         if (!prototype->isObject())
305             break;
306
307         object = static_cast<JSObject*>(prototype);
308     }
309
310     return false;
311 }
312
313 // It may seem crazy to inline a function this large, especially a virtual function,
314 // but it makes a big difference to property lookup that derived classes can inline their
315 // base class call to this.
316 ALWAYS_INLINE bool JSObject::getOwnPropertySlotForWrite(ExecState* exec, const Identifier& propertyName, PropertySlot& slot, bool& slotIsWriteable)
317 {
318     unsigned attributes;
319     if (JSValue** location = getDirectLocation(propertyName, attributes)) {
320         if (m_structureID->hasGetterSetterProperties() && location[0]->isGetterSetter()) {
321             slotIsWriteable = false;
322             fillGetterPropertySlot(slot, location);
323         } else {
324             slotIsWriteable = !(attributes & ReadOnly);
325             slot.setValueSlot(this, location, offsetForLocation(location));
326         }
327         return true;
328     }
329
330     // non-standard Netscape extension
331     if (propertyName == exec->propertyNames().underscoreProto) {
332         slot.setValue(prototype());
333         slotIsWriteable = false;
334         return true;
335     }
336
337     return false;
338 }
339
340 // It may seem crazy to inline a function this large, especially a virtual function,
341 // but it makes a big difference to property lookup that derived classes can inline their
342 // base class call to this.
343 ALWAYS_INLINE bool JSObject::getOwnPropertySlot(ExecState* exec, const Identifier& propertyName, PropertySlot& slot)
344 {
345     if (JSValue** location = getDirectLocation(propertyName)) {
346         if (m_structureID->hasGetterSetterProperties() && location[0]->isGetterSetter())
347             fillGetterPropertySlot(slot, location);
348         else
349             slot.setValueSlot(this, location, offsetForLocation(location));
350         return true;
351     }
352
353     // non-standard Netscape extension
354     if (propertyName == exec->propertyNames().underscoreProto) {
355         slot.setValue(prototype());
356         return true;
357     }
358
359     return false;
360 }
361
362 inline void JSObject::putDirect(const Identifier& propertyName, JSValue* value, unsigned attr)
363 {
364     PutPropertySlot slot;
365     putDirect(propertyName, value, attr, false, slot);
366 }
367
368 inline void JSObject::putDirect(const Identifier& propertyName, JSValue* value, unsigned attributes, bool checkReadOnly, PutPropertySlot& slot)
369 {
370     ASSERT(!Heap::heap(value) || Heap::heap(value) == Heap::heap(this));
371
372     if (m_structureID->isDictionary()) {
373         unsigned currentAttributes;
374         size_t offset = m_structureID->propertyMap().get(propertyName, currentAttributes);
375         if (offset != WTF::notFound) {
376             if (checkReadOnly && currentAttributes & ReadOnly)
377                 return;
378             m_propertyStorage[offset] = value;
379             slot.setExistingProperty(this, offset);
380             return;
381         }
382
383         size_t currentCapacity = m_structureID->propertyStorageCapacity();
384         offset = m_structureID->propertyMap().put(propertyName, attributes);
385         if (m_structureID->propertyMap().storageSize() > m_structureID->propertyStorageCapacity()) {
386             m_structureID->growPropertyStorageCapacity();
387             allocatePropertyStorage(currentCapacity, m_structureID->propertyStorageCapacity());
388         }
389
390         m_propertyStorage[offset] = value;
391         slot.setNewProperty(this, offset);
392         m_structureID->clearEnumerationCache();
393         return;
394     }
395
396     unsigned currentAttributes;
397     size_t offset = m_structureID->propertyMap().get(propertyName, currentAttributes);
398     if (offset != WTF::notFound) {
399         if (checkReadOnly && currentAttributes & ReadOnly)
400             return;
401         m_propertyStorage[offset] = value;
402         slot.setExistingProperty(this, offset);
403         return;
404     }
405
406     size_t currentCapacity = m_structureID->propertyStorageCapacity();
407     RefPtr<StructureID> structureID = StructureID::addPropertyTransition(m_structureID, propertyName, attributes, offset);
408     if (currentCapacity != structureID->propertyStorageCapacity())
409         allocatePropertyStorage(currentCapacity, structureID->propertyStorageCapacity());
410
411     ASSERT(offset < structureID->propertyStorageCapacity());
412     m_propertyStorage[offset] = value;
413     slot.setNewProperty(this, offset);
414     slot.setWasTransition(true);
415     setStructureID(structureID.release());
416 }
417
418 inline void JSObject::putDirectWithoutTransition(const Identifier& propertyName, JSValue* value, unsigned attributes)
419 {
420     size_t currentCapacity = m_structureID->propertyStorageCapacity();
421     size_t offset = m_structureID->addPropertyWithoutTransition(propertyName, attributes);
422     if (currentCapacity != m_structureID->propertyStorageCapacity())
423         allocatePropertyStorage(currentCapacity, m_structureID->propertyStorageCapacity());
424     m_propertyStorage[offset] = value;
425 }
426
427 inline void JSObject::transitionTo(StructureID* newStructureID)
428 {
429     if (m_structureID->propertyStorageCapacity() != newStructureID->propertyStorageCapacity())
430         allocatePropertyStorage(m_structureID->propertyStorageCapacity(), newStructureID->propertyStorageCapacity());
431     setStructureID(newStructureID);
432 }
433
434 inline JSValue* JSObject::toPrimitive(ExecState* exec, PreferredPrimitiveType preferredType) const
435 {
436     return defaultValue(exec, preferredType);
437 }
438
439 inline JSValue* JSValue::get(ExecState* exec, const Identifier& propertyName) const
440 {
441     PropertySlot slot(const_cast<JSValue*>(this));
442     return get(exec, propertyName, slot);
443 }
444
445 inline JSValue* JSValue::get(ExecState* exec, const Identifier& propertyName, PropertySlot& slot) const
446 {
447     if (UNLIKELY(JSImmediate::isImmediate(this))) {
448         JSObject* prototype = JSImmediate::prototype(this, exec);
449         if (!prototype->getPropertySlot(exec, propertyName, slot))
450             return jsUndefined();
451         return slot.getValue(exec, propertyName);
452     }
453     JSCell* cell = static_cast<JSCell*>(const_cast<JSValue*>(this));
454     while (true) {
455         if (cell->getOwnPropertySlot(exec, propertyName, slot))
456             return slot.getValue(exec, propertyName);
457         ASSERT(cell->isObject());
458         JSValue* prototype = static_cast<JSObject*>(cell)->prototype();
459         if (!prototype->isObject())
460             return jsUndefined();
461         cell = static_cast<JSCell*>(prototype);
462     }
463 }
464
465 inline JSValue* JSValue::get(ExecState* exec, unsigned propertyName) const
466 {
467     PropertySlot slot(const_cast<JSValue*>(this));
468     return get(exec, propertyName, slot);
469 }
470
471 inline JSValue* JSValue::get(ExecState* exec, unsigned propertyName, PropertySlot& slot) const
472 {
473     if (UNLIKELY(JSImmediate::isImmediate(this))) {
474         JSObject* prototype = JSImmediate::prototype(this, exec);
475         if (!prototype->getPropertySlot(exec, propertyName, slot))
476             return jsUndefined();
477         return slot.getValue(exec, propertyName);
478     }
479     JSCell* cell = const_cast<JSCell*>(asCell());
480     while (true) {
481         if (cell->getOwnPropertySlot(exec, propertyName, slot))
482             return slot.getValue(exec, propertyName);
483         ASSERT(cell->isObject());
484         JSValue* prototype = static_cast<JSObject*>(cell)->prototype();
485         if (!prototype->isObject())
486             return jsUndefined();
487         cell = static_cast<JSCell*>(prototype);
488     }
489 }
490
491 inline void JSValue::put(ExecState* exec, const Identifier& propertyName, JSValue* value, PutPropertySlot& slot)
492 {
493     if (UNLIKELY(JSImmediate::isImmediate(this))) {
494         JSImmediate::toObject(this, exec)->put(exec, propertyName, value, slot);
495         return;
496     }
497     asCell()->put(exec, propertyName, value, slot);
498 }
499
500 inline void JSValue::put(ExecState* exec, unsigned propertyName, JSValue* value)
501 {
502     if (UNLIKELY(JSImmediate::isImmediate(this))) {
503         JSImmediate::toObject(this, exec)->put(exec, propertyName, value);
504         return;
505     }
506     asCell()->put(exec, propertyName, value);
507 }
508
509 } // namespace JSC
510
511 #endif // JSObject_h