]> git.saurik.com Git - apple/javascriptcore.git/blobdiff - runtime/JSCell.h
JavaScriptCore-1218.tar.gz
[apple/javascriptcore.git] / runtime / JSCell.h
index 43d81a55563dbae2738aa9c857db84fcbb4e0ff9..76acb1e555edc5bc96fd930c0f8e47d810ceed73 100644 (file)
@@ -1,7 +1,7 @@
 /*
  *  Copyright (C) 1999-2001 Harri Porten (porten@kde.org)
  *  Copyright (C) 2001 Peter Kelly (pmk@post.com)
- *  Copyright (C) 2003, 2004, 2005, 2007, 2008 Apple Inc. All rights reserved.
+ *  Copyright (C) 2003, 2004, 2005, 2007, 2008, 2009 Apple Inc. All rights reserved.
  *
  *  This library is free software; you can redistribute it and/or
  *  modify it under the terms of the GNU Library General Public
 #ifndef JSCell_h
 #define JSCell_h
 
+#include "CallData.h"
+#include "ConstructData.h"
+#include "Heap.h"
+#include "JSLock.h"
+#include "SlotVisitor.h"
+#include "TypedArrayDescriptor.h"
+#include "WriteBarrier.h"
 #include <wtf/Noncopyable.h>
-#include "Structure.h"
-#include "JSValue.h"
-#include "JSImmediate.h"
-#include "Collector.h"
+#include <wtf/TypeTraits.h>
 
 namespace JSC {
 
-    class JSCell : Noncopyable {
-        friend class JIT;
-        friend class GetterSetter;
-        friend class Heap;
-        friend class JSNumberCell;
-        friend class JSObject;
-        friend class JSPropertyNameIterator;
-        friend class JSString;
-        friend class JSValuePtr;
-        friend class Interpreter;
-
-    private:
-        explicit JSCell(Structure*);
-        virtual ~JSCell();
-
-    public:
-        // Querying the type.
-        bool isNumber() const;
-        bool isString() const;
-        bool isObject() const;
-        virtual bool isGetterSetter() const;
-        virtual bool isObject(const ClassInfo*) const;
-
-        Structure* structure() const;
-
-        // Extracting the value.
-        bool getString(UString&) const;
-        UString getString() const; // null string if not a string
-        JSObject* getObject(); // NULL if not an object
-        const JSObject* getObject() const; // NULL if not an object
+class CopyVisitor;
+class ExecState;
+class JSDestructibleObject;
+class JSGlobalObject;
+class LLIntOffsetsExtractor;
+class PropertyDescriptor;
+class PropertyNameArray;
+class Structure;
+
+enum EnumerationMode {
+    ExcludeDontEnumProperties,
+    IncludeDontEnumProperties
+};
+
+class JSCell {
+    friend class JSValue;
+    friend class MarkedBlock;
+    template<typename T> friend void* allocateCell(Heap&);
+    template<typename T> friend void* allocateCell(Heap&, size_t);
+
+public:
+    static const unsigned StructureFlags = 0;
+
+    static const bool needsDestruction = false;
+    static const bool hasImmortalStructure = false;
+
+    enum CreatingEarlyCellTag { CreatingEarlyCell };
+    JSCell(CreatingEarlyCellTag);
+
+protected:
+    JSCell(VM&, Structure*);
+    JS_EXPORT_PRIVATE static void destroy(JSCell*);
+
+public:
+    // Querying the type.
+    bool isString() const;
+    bool isObject() const;
+    bool isGetterSetter() const;
+    bool isProxy() const;
+    bool inherits(const ClassInfo*) const;
+    bool isAPIValueWrapper() const;
+
+    Structure* structure() const;
+    void setStructure(VM&, Structure*);
+    void clearStructure() { m_structure.clear(); }
+
+    const char* className();
+
+    // Extracting the value.
+    JS_EXPORT_PRIVATE bool getString(ExecState*, String&) const;
+    JS_EXPORT_PRIVATE String getString(ExecState*) const; // null string if not a string
+    JS_EXPORT_PRIVATE JSObject* getObject(); // NULL if not an object
+    const JSObject* getObject() const; // NULL if not an object
         
-        virtual CallType getCallData(CallData&);
-        virtual ConstructType getConstructData(ConstructData&);
-
-        // Extracting integer values.
-        // FIXME: remove these methods, can check isNumberCell in JSValuePtr && then call asNumberCell::*.
-        virtual bool getUInt32(uint32_t&) const;
-        virtual bool getTruncatedInt32(int32_t&) const;
-        virtual bool getTruncatedUInt32(uint32_t&) const;
-
-        // Basic conversions.
-        virtual JSValuePtr toPrimitive(ExecState*, PreferredPrimitiveType) const = 0;
-        virtual bool getPrimitiveNumber(ExecState*, double& number, JSValuePtr&) = 0;
-        virtual bool toBoolean(ExecState*) const = 0;
-        virtual double toNumber(ExecState*) const = 0;
-        virtual UString toString(ExecState*) const = 0;
-        virtual JSObject* toObject(ExecState*) const = 0;
-
-        // Garbage collection.
-        void* operator new(size_t, ExecState*);
-        void* operator new(size_t, JSGlobalData*);
-        void* operator new(size_t, void* placementNewDestination) { return placementNewDestination; }
-        virtual void mark();
-        bool marked() const;
-
-        // Object operations, with the toObject operation included.
-        virtual const ClassInfo* classInfo() const;
-        virtual void put(ExecState*, const Identifier& propertyName, JSValuePtr, PutPropertySlot&);
-        virtual void put(ExecState*, unsigned propertyName, JSValuePtr);
-        virtual bool deleteProperty(ExecState*, const Identifier& propertyName);
-        virtual bool deleteProperty(ExecState*, unsigned propertyName);
-
-        virtual JSObject* toThisObject(ExecState*) const;
-        virtual UString toThisString(ExecState*) const;
-        virtual JSString* toThisJSString(ExecState*);
-        virtual JSValuePtr getJSNumber();
-        void* vptr() { return *reinterpret_cast<void**>(this); }
-
-    private:
-        // Base implementation; for non-object classes implements getPropertySlot.
-        bool fastGetOwnPropertySlot(ExecState*, const Identifier& propertyName, PropertySlot&);
-        virtual bool getOwnPropertySlot(ExecState*, const Identifier& propertyName, PropertySlot&);
-        virtual bool getOwnPropertySlot(ExecState*, unsigned propertyName, PropertySlot&);
+    JS_EXPORT_PRIVATE static CallType getCallData(JSCell*, CallData&);
+    JS_EXPORT_PRIVATE static ConstructType getConstructData(JSCell*, ConstructData&);
+
+    // Basic conversions.
+    JS_EXPORT_PRIVATE JSValue toPrimitive(ExecState*, PreferredPrimitiveType) const;
+    bool getPrimitiveNumber(ExecState*, double& number, JSValue&) const;
+    bool toBoolean(ExecState*) const;
+    TriState pureToBoolean() const;
+    JS_EXPORT_PRIVATE double toNumber(ExecState*) const;
+    JS_EXPORT_PRIVATE JSObject* toObject(ExecState*, JSGlobalObject*) const;
+
+    static void visitChildren(JSCell*, SlotVisitor&);
+    JS_EXPORT_PRIVATE static void copyBackingStore(JSCell*, CopyVisitor&);
+
+    // Object operations, with the toObject operation included.
+    const ClassInfo* classInfo() const;
+    const MethodTable* methodTable() const;
+    const MethodTable* methodTableForDestruction() const;
+    static void put(JSCell*, ExecState*, PropertyName, JSValue, PutPropertySlot&);
+    static void putByIndex(JSCell*, ExecState*, unsigned propertyName, JSValue, bool shouldThrow);
         
-        Structure* m_structure;
-    };
-
-    JSCell* asCell(JSValuePtr);
-
-    inline JSCell* asCell(JSValuePtr value)
-    {
-        return value.asCell();
-    }
+    static bool deleteProperty(JSCell*, ExecState*, PropertyName);
+    static bool deletePropertyByIndex(JSCell*, ExecState*, unsigned propertyName);
 
-    inline JSCell::JSCell(Structure* structure)
-        : m_structure(structure)
-    {
-    }
-
-    inline JSCell::~JSCell()
-    {
-    }
-
-    inline bool JSCell::isNumber() const
-    {
-        return Heap::isNumber(const_cast<JSCell*>(this));
-    }
-
-    inline bool JSCell::isObject() const
-    {
-        return m_structure->typeInfo().type() == ObjectType;
-    }
-
-    inline bool JSCell::isString() const
-    {
-        return m_structure->typeInfo().type() == StringType;
-    }
+    static JSObject* toThisObject(JSCell*, ExecState*);
 
-    inline Structure* JSCell::structure() const
-    {
-        return m_structure;
-    }
+    void zap() { *reinterpret_cast<uintptr_t**>(this) = 0; }
+    bool isZapped() const { return !*reinterpret_cast<uintptr_t* const*>(this); }
 
-    inline bool JSCell::marked() const
-    {
-        return Heap::isCellMarked(this);
-    }
+    // FIXME: Rename getOwnPropertySlot to virtualGetOwnPropertySlot, and
+    // fastGetOwnPropertySlot to getOwnPropertySlot. Callers should always
+    // call this function, not its slower virtual counterpart. (For integer
+    // property names, we want a similar interface with appropriate optimizations.)
+    bool fastGetOwnPropertySlot(ExecState*, PropertyName, PropertySlot&);
+    JSValue fastGetOwnProperty(ExecState*, const String&);
 
-    inline void JSCell::mark()
+    static ptrdiff_t structureOffset()
     {
-        return Heap::markCell(this);
+        return OBJECT_OFFSETOF(JSCell, m_structure);
     }
 
-    ALWAYS_INLINE JSCell* JSValuePtr::asCell() const
+    void* structureAddress()
     {
-        ASSERT(isCell());
-        return m_ptr;
+        return &m_structure;
     }
-
-    inline void* JSCell::operator new(size_t size, JSGlobalData* globalData)
-    {
-#ifdef JAVASCRIPTCORE_BUILDING_ALL_IN_ONE_FILE
-        return globalData->heap.inlineAllocate(size);
-#else
-        return globalData->heap.allocate(size);
+        
+#if ENABLE(GC_VALIDATION)
+    Structure* unvalidatedStructure() { return m_structure.unvalidatedGet(); }
 #endif
-    }
-
-    // --- JSValue inlines ----------------------------
-
-    inline bool JSValuePtr::isString() const
-    {
-        return !JSImmediate::isImmediate(asValue()) && asCell()->isString();
-    }
-
-    inline bool JSValuePtr::isGetterSetter() const
-    {
-        return !JSImmediate::isImmediate(asValue()) && asCell()->isGetterSetter();
-    }
-
-    inline bool JSValuePtr::isObject() const
-    {
-        return !JSImmediate::isImmediate(asValue()) && asCell()->isObject();
-    }
-
-    inline bool JSValuePtr::getString(UString& s) const
-    {
-        return !JSImmediate::isImmediate(asValue()) && asCell()->getString(s);
-    }
-
-    inline UString JSValuePtr::getString() const
-    {
-        return JSImmediate::isImmediate(asValue()) ? UString() : asCell()->getString();
-    }
-
-    inline JSObject* JSValuePtr::getObject() const
-    {
-        return JSImmediate::isImmediate(asValue()) ? 0 : asCell()->getObject();
-    }
-
-    inline CallType JSValuePtr::getCallData(CallData& callData)
-    {
-        return JSImmediate::isImmediate(asValue()) ? CallTypeNone : asCell()->getCallData(callData);
-    }
-
-    inline ConstructType JSValuePtr::getConstructData(ConstructData& constructData)
-    {
-        return JSImmediate::isImmediate(asValue()) ? ConstructTypeNone : asCell()->getConstructData(constructData);
-    }
-
-    ALWAYS_INLINE bool JSValuePtr::getUInt32(uint32_t& v) const
-    {
-        return JSImmediate::isImmediate(asValue()) ? JSImmediate::getUInt32(asValue(), v) : asCell()->getUInt32(v);
-    }
-
-    ALWAYS_INLINE bool JSValuePtr::getTruncatedInt32(int32_t& v) const
-    {
-        return JSImmediate::isImmediate(asValue()) ? JSImmediate::getTruncatedInt32(asValue(), v) : asCell()->getTruncatedInt32(v);
-    }
-
-    inline bool JSValuePtr::getTruncatedUInt32(uint32_t& v) const
-    {
-        return JSImmediate::isImmediate(asValue()) ? JSImmediate::getTruncatedUInt32(asValue(), v) : asCell()->getTruncatedUInt32(v);
-    }
-
-    inline void JSValuePtr::mark()
-    {
-        asCell()->mark(); // callers should check !marked() before calling mark(), so this should only be called with cells
-    }
-
-    inline bool JSValuePtr::marked() const
-    {
-        return JSImmediate::isImmediate(asValue()) || asCell()->marked();
-    }
-
-    inline JSValuePtr JSValuePtr::toPrimitive(ExecState* exec, PreferredPrimitiveType preferredType) const
-    {
-        return JSImmediate::isImmediate(asValue()) ? asValue() : asCell()->toPrimitive(exec, preferredType);
-    }
-
-    inline bool JSValuePtr::getPrimitiveNumber(ExecState* exec, double& number, JSValuePtr& value)
-    {
-        if (JSImmediate::isImmediate(asValue())) {
-            number = JSImmediate::toDouble(asValue());
-            value = asValue();
-            return true;
-        }
-        return asCell()->getPrimitiveNumber(exec, number, value);
-    }
-
-    inline bool JSValuePtr::toBoolean(ExecState* exec) const
-    {
-        return JSImmediate::isImmediate(asValue()) ? JSImmediate::toBoolean(asValue()) : asCell()->toBoolean(exec);
-    }
-
-    ALWAYS_INLINE double JSValuePtr::toNumber(ExecState* exec) const
-    {
-        return JSImmediate::isImmediate(asValue()) ? JSImmediate::toDouble(asValue()) : asCell()->toNumber(exec);
-    }
-
-    inline UString JSValuePtr::toString(ExecState* exec) const
-    {
-        return JSImmediate::isImmediate(asValue()) ? JSImmediate::toString(asValue()) : asCell()->toString(exec);
-    }
-
-    inline JSObject* JSValuePtr::toObject(ExecState* exec) const
-    {
-        return JSImmediate::isImmediate(asValue()) ? JSImmediate::toObject(asValue(), exec) : asCell()->toObject(exec);
-    }
-
-    inline JSObject* JSValuePtr::toThisObject(ExecState* exec) const
-    {
-        if (UNLIKELY(JSImmediate::isImmediate(asValue())))
-            return JSImmediate::toThisObject(asValue(), exec);
-        return asCell()->toThisObject(exec);
-    }
-
-    inline bool JSValuePtr::needsThisConversion() const
-    {
-        if (UNLIKELY(JSImmediate::isImmediate(asValue())))
-            return true;
-        return asCell()->structure()->typeInfo().needsThisConversion();
-    }
-
-    inline UString JSValuePtr::toThisString(ExecState* exec) const
-    {
-        return JSImmediate::isImmediate(asValue()) ? JSImmediate::toString(asValue()) : asCell()->toThisString(exec);
-    }
-
-    inline JSValuePtr JSValuePtr::getJSNumber()
-    {
-        return JSImmediate::isNumber(asValue()) ? asValue() : JSImmediate::isImmediate(asValue()) ? noValue() : asCell()->getJSNumber();
-    }
+        
+    static const TypedArrayType TypedArrayStorageType = TypedArrayNone;
+protected:
+
+    void finishCreation(VM&);
+    void finishCreation(VM&, Structure*, CreatingEarlyCellTag);
+
+    // Base implementation; for non-object classes implements getPropertySlot.
+    static bool getOwnPropertySlot(JSCell*, ExecState*, PropertyName, PropertySlot&);
+    static bool getOwnPropertySlotByIndex(JSCell*, ExecState*, unsigned propertyName, PropertySlot&);
+
+    // Dummy implementations of override-able static functions for classes to put in their MethodTable
+    static JSValue defaultValue(const JSObject*, ExecState*, PreferredPrimitiveType);
+    static NO_RETURN_DUE_TO_CRASH void getOwnPropertyNames(JSObject*, ExecState*, PropertyNameArray&, EnumerationMode);
+    static NO_RETURN_DUE_TO_CRASH void getOwnNonIndexPropertyNames(JSObject*, ExecState*, PropertyNameArray&, EnumerationMode);
+    static NO_RETURN_DUE_TO_CRASH void getPropertyNames(JSObject*, ExecState*, PropertyNameArray&, EnumerationMode);
+    static String className(const JSObject*);
+    JS_EXPORT_PRIVATE static bool customHasInstance(JSObject*, ExecState*, JSValue);
+    static NO_RETURN_DUE_TO_CRASH void putDirectVirtual(JSObject*, ExecState*, PropertyName, JSValue, unsigned attributes);
+    static bool defineOwnProperty(JSObject*, ExecState*, PropertyName, PropertyDescriptor&, bool shouldThrow);
+    static bool getOwnPropertyDescriptor(JSObject*, ExecState*, PropertyName, PropertyDescriptor&);
+
+private:
+    friend class LLIntOffsetsExtractor;
+        
+    WriteBarrier<Structure> m_structure;
+};
+
+template<typename To, typename From>
+inline To jsCast(From* from)
+{
+    ASSERT(!from || from->JSCell::inherits(&WTF::RemovePointer<To>::Type::s_info));
+    return static_cast<To>(from);
+}
+    
+template<typename To>
+inline To jsCast(JSValue from)
+{
+    ASSERT(from.isCell() && from.asCell()->JSCell::inherits(&WTF::RemovePointer<To>::Type::s_info));
+    return static_cast<To>(from.asCell());
+}
+
+template<typename To, typename From>
+inline To jsDynamicCast(From* from)
+{
+    return from->inherits(&WTF::RemovePointer<To>::Type::s_info) ? static_cast<To>(from) : 0;
+}
+
+template<typename To>
+inline To jsDynamicCast(JSValue from)
+{
+    return from.isCell() && from.asCell()->inherits(&WTF::RemovePointer<To>::Type::s_info) ? static_cast<To>(from.asCell()) : 0;
+}
 
 } // namespace JSC