runtime/JSPropertyNameIterator.h

   1 /*
   2  * Copyright (C) 2008, 2009 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  *
   8  * 1.  Redistributions of source code must retain the above copyright
   9  *     notice, this list of conditions and the following disclaimer.
  10  * 2.  Redistributions in binary form must reproduce the above copyright
  11  *     notice, this list of conditions and the following disclaimer in the
  12  *     documentation and/or other materials provided with the distribution.
  13  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
  14  *     its contributors may be used to endorse or promote products derived
  15  *     from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
  18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 #ifndef JSPropertyNameIterator_h
  30 #define JSPropertyNameIterator_h
  31
  32 #include "JSObject.h"
  33 #include "JSString.h"
  34 #include "PropertyNameArray.h"
  35 #include <memory>
  36
  37 namespace JSC {
  38
  39     class Identifier;
  40     class JSObject;
  41     class LLIntOffsetsExtractor;
  42
  43     class JSPropertyNameIterator : public JSCell {
  44         friend class JIT;
  45
  46     public:
  47         typedef JSCell Base;
  48
  49         static JSPropertyNameIterator* create(ExecState*, JSObject*);
  50
  51         static const bool needsDestruction = true;
  52         static const bool hasImmortalStructure = true;
  53         static void destroy(JSCell*);
  54
  55         static Structure* createStructure(VM& vm, JSGlobalObject* globalObject, JSValue prototype)
  56         {
  57             return Structure::create(vm, globalObject, prototype, TypeInfo(CompoundType, StructureFlags), info());
  58         }
  59
  60         static void visitChildren(JSCell*, SlotVisitor&);
  61
  62         JSValue get(ExecState*, JSObject*, size_t i);
  63         size_t size() { return m_jsStringsSize; }
  64
  65         void setCachedStructure(VM& vm, Structure* structure)
  66         {
  67             ASSERT(!m_cachedStructure);
  68             ASSERT(structure);
  69             m_cachedStructure.set(vm, this, structure);
  70         }
  71         Structure* cachedStructure() { return m_cachedStructure.get(); }
  72
  73         void setCachedPrototypeChain(VM& vm, StructureChain* cachedPrototypeChain) { m_cachedPrototypeChain.set(vm, this, cachedPrototypeChain); }
  74         StructureChain* cachedPrototypeChain() { return m_cachedPrototypeChain.get(); }
  75
  76         DECLARE_EXPORT_INFO;
  77
  78     protected:
  79         static const unsigned StructureFlags = OverridesVisitChildren | StructureIsImmortal;
  80
  81         void finishCreation(VM& vm, PropertyNameArrayData* propertyNameArrayData, JSObject* object)
  82         {
  83             Base::finishCreation(vm);
  84             PropertyNameArrayData::PropertyNameVector& propertyNameVector = propertyNameArrayData->propertyNameVector();
  85             for (size_t i = 0; i < m_jsStringsSize; ++i)
  86                 m_jsStrings[i].set(vm, this, jsOwnedString(&vm, propertyNameVector[i].string()));
  87             m_cachedStructureInlineCapacity = object->structure()->inlineCapacity();
  88         }
  89
  90     private:
  91         friend class LLIntOffsetsExtractor;
  92
  93         JSPropertyNameIterator(ExecState*, PropertyNameArrayData* propertyNameArrayData, size_t numCacheableSlot);
  94
  95         WriteBarrier<Structure> m_cachedStructure;
  96         WriteBarrier<StructureChain> m_cachedPrototypeChain;
  97         uint32_t m_numCacheableSlots;
  98         uint32_t m_jsStringsSize;
  99         unsigned m_cachedStructureInlineCapacity;
 100         std::unique_ptr<WriteBarrier<Unknown>[]> m_jsStrings;
 101     };
 102
 103     ALWAYS_INLINE JSPropertyNameIterator* Register::propertyNameIterator() const
 104     {
 105         return jsCast<JSPropertyNameIterator*>(jsValue().asCell());
 106     }
 107
 108     inline JSPropertyNameIterator* StructureRareData::enumerationCache()
 109     {
 110         return m_enumerationCache.get();
 111     }
 112
 113     inline void StructureRareData::setEnumerationCache(VM& vm, JSPropertyNameIterator* value)
 114     {
 115         m_enumerationCache.set(vm, this, value);
 116     }
 117
 118 } // namespace JSC
 119
 120 #endif // JSPropertyNameIterator_h