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 Computer, 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 "Operations.h"
35#include "PropertyNameArray.h"
36
37namespace JSC {
38
39    class Identifier;
40    class JSObject;
41
42    class JSPropertyNameIterator : public JSCell {
43        friend class JIT;
44
45    public:
46        static JSPropertyNameIterator* create(ExecState*, JSObject*);
47
48        static Structure* createStructure(JSGlobalData& globalData, JSValue prototype)
49        {
50            return Structure::create(globalData, prototype, TypeInfo(CompoundType, OverridesMarkChildren), AnonymousSlotCount, &s_info);
51        }
52
53        virtual bool isPropertyNameIterator() const { return true; }
54
55        virtual void markChildren(MarkStack&);
56
57        bool getOffset(size_t i, int& offset)
58        {
59            if (i >= m_numCacheableSlots)
60                return false;
61            offset = i;
62            return true;
63        }
64
65        JSValue get(ExecState*, JSObject*, size_t i);
66        size_t size() { return m_jsStringsSize; }
67
68        void setCachedStructure(JSGlobalData& globalData, Structure* structure)
69        {
70            ASSERT(!m_cachedStructure);
71            ASSERT(structure);
72            m_cachedStructure.set(globalData, this, structure);
73        }
74        Structure* cachedStructure() { return m_cachedStructure.get(); }
75
76        void setCachedPrototypeChain(JSGlobalData& globalData, StructureChain* cachedPrototypeChain) { m_cachedPrototypeChain.set(globalData, this, cachedPrototypeChain); }
77        StructureChain* cachedPrototypeChain() { return m_cachedPrototypeChain.get(); }
78
79    private:
80        static const ClassInfo s_info;
81        JSPropertyNameIterator(ExecState*, PropertyNameArrayData* propertyNameArrayData, size_t numCacheableSlot);
82
83        WriteBarrier<Structure> m_cachedStructure;
84        WriteBarrier<StructureChain> m_cachedPrototypeChain;
85        uint32_t m_numCacheableSlots;
86        uint32_t m_jsStringsSize;
87        OwnArrayPtr<WriteBarrier<Unknown> > m_jsStrings;
88    };
89
90    inline void Structure::setEnumerationCache(JSGlobalData& globalData, JSPropertyNameIterator* enumerationCache)
91    {
92        ASSERT(!isDictionary());
93        m_enumerationCache.set(globalData, this, enumerationCache);
94    }
95
96    inline JSPropertyNameIterator* Structure::enumerationCache()
97    {
98        return m_enumerationCache.get();
99    }
100
101    ALWAYS_INLINE JSPropertyNameIterator* Register::propertyNameIterator() const
102    {
103        return static_cast<JSPropertyNameIterator*>(jsValue().asCell());
104    }
105
106} // namespace JSC
107
108#endif // JSPropertyNameIterator_h
109