• Home
  • History
  • Annotate
  • only in this directory
1/*
2 * Copyright (C) 2011, 2012 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 * 1. Redistributions of source code must retain the above copyright
8 *    notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 *    notice, this list of conditions and the following disclaimer in the
11 *    documentation and/or other materials provided with the distribution.
12 *
13 * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26#ifndef SparseArrayValueMap_h
27#define SparseArrayValueMap_h
28
29#include "JSCell.h"
30#include "JSTypeInfo.h"
31#include "PropertyDescriptor.h"
32#include "PutDirectIndexMode.h"
33#include "WriteBarrier.h"
34#include <wtf/HashMap.h>
35
36namespace JSC {
37
38class SparseArrayValueMap;
39
40struct SparseArrayEntry : public WriteBarrier<Unknown> {
41    typedef WriteBarrier<Unknown> Base;
42
43    SparseArrayEntry() : attributes(0) { }
44
45    JSValue get(ExecState*, JSObject*) const;
46    void get(JSObject*, PropertySlot&) const;
47    void get(PropertyDescriptor&) const;
48    void put(ExecState*, JSValue thisValue, SparseArrayValueMap*, JSValue, bool shouldThrow);
49    JSValue getNonSparseMode() const;
50
51    unsigned attributes;
52};
53
54class SparseArrayValueMap : public JSCell {
55public:
56    typedef JSCell Base;
57
58private:
59    typedef HashMap<uint64_t, SparseArrayEntry, WTF::IntHash<uint64_t>, WTF::UnsignedWithZeroKeyHashTraits<uint64_t>> Map;
60
61    enum Flags {
62        Normal = 0,
63        SparseMode = 1,
64        LengthIsReadOnly = 2,
65    };
66
67    SparseArrayValueMap(VM&);
68    ~SparseArrayValueMap();
69
70    void finishCreation(VM&);
71
72    static const unsigned StructureFlags = OverridesVisitChildren | StructureIsImmortal | JSCell::StructureFlags;
73
74public:
75    DECLARE_EXPORT_INFO;
76
77    typedef Map::iterator iterator;
78    typedef Map::const_iterator const_iterator;
79    typedef Map::AddResult AddResult;
80
81    static SparseArrayValueMap* create(VM&);
82
83    static const bool needsDestruction = true;
84    static const bool hasImmortalStructure = true;
85    static void destroy(JSCell*);
86
87    static Structure* createStructure(VM&, JSGlobalObject*, JSValue prototype);
88
89    static void visitChildren(JSCell*, SlotVisitor&);
90
91    bool sparseMode()
92    {
93        return m_flags & SparseMode;
94    }
95
96    void setSparseMode()
97    {
98        m_flags = static_cast<Flags>(m_flags | SparseMode);
99    }
100
101    bool lengthIsReadOnly()
102    {
103        return m_flags & LengthIsReadOnly;
104    }
105
106    void setLengthIsReadOnly()
107    {
108        m_flags = static_cast<Flags>(m_flags | LengthIsReadOnly);
109    }
110
111    // These methods may mutate the contents of the map
112    void putEntry(ExecState*, JSObject*, unsigned, JSValue, bool shouldThrow);
113    bool putDirect(ExecState*, JSObject*, unsigned, JSValue, unsigned attributes, PutDirectIndexMode);
114    AddResult add(JSObject*, unsigned);
115    iterator find(unsigned i) { return m_map.find(i); }
116    // This should ASSERT the remove is valid (check the result of the find).
117    void remove(iterator it) { m_map.remove(it); }
118    void remove(unsigned i) { m_map.remove(i); }
119
120    // These methods do not mutate the contents of the map.
121    iterator notFound() { return m_map.end(); }
122    bool isEmpty() const { return m_map.isEmpty(); }
123    bool contains(unsigned i) const { return m_map.contains(i); }
124    size_t size() const { return m_map.size(); }
125    // Only allow const begin/end iteration.
126    const_iterator begin() const { return m_map.begin(); }
127    const_iterator end() const { return m_map.end(); }
128
129private:
130    Map m_map;
131    Flags m_flags;
132    size_t m_reportedCapacity;
133};
134
135} // namespace JSC
136
137#endif // SparseArrayValueMap_h
138
139