2 * Copyright (C) 1999-2000 Harri Porten (porten@kde.org)
3 * Copyright (C) 2003, 2007, 2008, 2009 Apple Inc. All rights reserved.
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
26 #define CHECK_ARRAY_CONSISTENCY 0
30 typedef HashMap<unsigned, WriteBarrier<Unknown> > SparseArrayValueMap;
32 // This struct holds the actual data values of an array. A JSArray object points to it's contained ArrayStorage
33 // struct by pointing to m_vector. To access the contained ArrayStorage struct, use the getStorage() and
34 // setStorage() methods. It is important to note that there may be space before the ArrayStorage that
35 // is used to quick unshift / shift operation. The actual allocated pointer is available by using:
36 // getStorage() - m_indexBias * sizeof(JSValue)
38 unsigned m_length; // The "length" property on the array
39 unsigned m_numValuesInVector;
40 SparseArrayValueMap* m_sparseValueMap;
41 void* subclassData; // A JSArray subclass can use this to fill the vector lazily.
42 void* m_allocBase; // Pointer to base address returned by malloc(). Keeping this pointer does eliminate false positives from the leak detector.
43 size_t reportedMapCapacity;
44 #if CHECK_ARRAY_CONSISTENCY
45 bool m_inCompactInitialization;
47 WriteBarrier<Unknown> m_vector[1];
50 // The CreateCompact creation mode is used for fast construction of arrays
51 // whose size and contents are known at time of creation.
53 // There are two obligations when using this mode:
55 // - uncheckedSetIndex() must be used when initializing the array.
56 // - setLength() must be called after initialization.
58 enum ArrayCreationMode { CreateCompact, CreateInitialized };
60 class JSArray : public JSNonFinalObject {
64 explicit JSArray(JSGlobalData&, Structure*);
66 void finishCreation(JSGlobalData&);
67 void finishCreation(JSGlobalData&, unsigned initialLength, ArrayCreationMode);
68 void finishCreation(JSGlobalData&, const ArgList&);
71 typedef JSNonFinalObject Base;
73 JSArray(VPtrStealingHackType);
76 static JSArray* create(JSGlobalData& globalData, Structure* structure)
78 JSArray* array = new (allocateCell<JSArray>(globalData.heap)) JSArray(globalData, structure);
79 array->finishCreation(globalData);
83 static JSArray* create(JSGlobalData& globalData, Structure* structure, unsigned initialLength, ArrayCreationMode createMode)
85 JSArray* array = new (allocateCell<JSArray>(globalData.heap)) JSArray(globalData, structure);
86 array->finishCreation(globalData, initialLength, createMode);
90 static JSArray* create(JSGlobalData& globalData, Structure* structure, const ArgList& initialValues)
92 JSArray* array = new (allocateCell<JSArray>(globalData.heap)) JSArray(globalData, structure);
93 array->finishCreation(globalData, initialValues);
97 virtual bool getOwnPropertySlot(ExecState*, const Identifier& propertyName, PropertySlot&);
98 virtual bool getOwnPropertySlot(ExecState*, unsigned propertyName, PropertySlot&);
99 virtual bool getOwnPropertyDescriptor(ExecState*, const Identifier&, PropertyDescriptor&);
100 virtual void put(ExecState*, unsigned propertyName, JSValue); // FIXME: Make protected and add setItem.
102 static JS_EXPORTDATA const ClassInfo s_info;
104 unsigned length() const { return m_storage->m_length; }
105 void setLength(unsigned); // OK to use on new arrays, but not if it might be a RegExpMatchArray.
107 void sort(ExecState*);
108 void sort(ExecState*, JSValue compareFunction, CallType, const CallData&);
109 void sortNumeric(ExecState*, JSValue compareFunction, CallType, const CallData&);
111 void push(ExecState*, JSValue);
114 void shiftCount(ExecState*, int count);
115 void unshiftCount(ExecState*, int count);
117 bool canGetIndex(unsigned i) { return i < m_vectorLength && m_storage->m_vector[i]; }
118 JSValue getIndex(unsigned i)
120 ASSERT(canGetIndex(i));
121 return m_storage->m_vector[i].get();
124 bool canSetIndex(unsigned i) { return i < m_vectorLength; }
125 void setIndex(JSGlobalData& globalData, unsigned i, JSValue v)
127 ASSERT(canSetIndex(i));
129 WriteBarrier<Unknown>& x = m_storage->m_vector[i];
131 ArrayStorage *storage = m_storage;
132 ++storage->m_numValuesInVector;
133 if (i >= storage->m_length)
134 storage->m_length = i + 1;
136 x.set(globalData, this, v);
139 void uncheckedSetIndex(JSGlobalData& globalData, unsigned i, JSValue v)
141 ASSERT(canSetIndex(i));
142 ArrayStorage *storage = m_storage;
143 #if CHECK_ARRAY_CONSISTENCY
144 ASSERT(storage->m_inCompactInitialization);
146 storage->m_vector[i].set(globalData, this, v);
149 void fillArgList(ExecState*, MarkedArgumentBuffer&);
150 void copyToRegisters(ExecState*, Register*, uint32_t);
152 static Structure* createStructure(JSGlobalData& globalData, JSGlobalObject* globalObject, JSValue prototype)
154 return Structure::create(globalData, globalObject, prototype, TypeInfo(ObjectType, StructureFlags), &s_info);
157 inline void visitChildrenDirect(SlotVisitor&);
159 static ptrdiff_t storageOffset()
161 return OBJECT_OFFSETOF(JSArray, m_storage);
164 static ptrdiff_t vectorLengthOffset()
166 return OBJECT_OFFSETOF(JSArray, m_vectorLength);
170 static const unsigned StructureFlags = OverridesGetOwnPropertySlot | OverridesVisitChildren | OverridesGetPropertyNames | JSObject::StructureFlags;
171 virtual void put(ExecState*, const Identifier& propertyName, JSValue, PutPropertySlot&);
172 virtual bool deleteProperty(ExecState*, const Identifier& propertyName);
173 virtual bool deleteProperty(ExecState*, unsigned propertyName);
174 virtual void getOwnPropertyNames(ExecState*, PropertyNameArray&, EnumerationMode mode = ExcludeDontEnumProperties);
175 virtual void visitChildren(SlotVisitor&);
177 void* subclassData() const;
178 void setSubclassData(void*);
181 bool getOwnPropertySlotSlowCase(ExecState*, unsigned propertyName, PropertySlot&);
182 void putSlowCase(ExecState*, unsigned propertyName, JSValue);
184 unsigned getNewVectorLength(unsigned desiredLength);
185 bool increaseVectorLength(unsigned newLength);
186 bool increaseVectorPrefixLength(unsigned newLength);
188 unsigned compactForSorting();
190 enum ConsistencyCheckType { NormalConsistencyCheck, DestructorConsistencyCheck, SortConsistencyCheck };
191 void checkConsistency(ConsistencyCheckType = NormalConsistencyCheck);
193 unsigned m_vectorLength; // The valid length of m_vector
194 int m_indexBias; // The number of JSValue sized blocks before ArrayStorage.
195 ArrayStorage *m_storage;
198 JSArray* asArray(JSValue);
200 inline JSArray* asArray(JSCell* cell)
202 ASSERT(cell->inherits(&JSArray::s_info));
203 return static_cast<JSArray*>(cell);
206 inline JSArray* asArray(JSValue value)
208 return asArray(value.asCell());
211 inline bool isJSArray(JSGlobalData* globalData, JSCell* cell) { return cell->vptr() == globalData->jsArrayVPtr; }
212 inline bool isJSArray(JSGlobalData* globalData, JSValue v) { return v.isCell() && isJSArray(globalData, v.asCell()); }
214 inline void JSArray::visitChildrenDirect(SlotVisitor& visitor)
216 JSObject::visitChildrenDirect(visitor);
218 ArrayStorage* storage = m_storage;
220 unsigned usedVectorLength = std::min(storage->m_length, m_vectorLength);
221 visitor.appendValues(storage->m_vector, usedVectorLength);
223 if (SparseArrayValueMap* map = storage->m_sparseValueMap) {
224 SparseArrayValueMap::iterator end = map->end();
225 for (SparseArrayValueMap::iterator it = map->begin(); it != end; ++it)
226 visitor.append(&it->second);
230 // Rule from ECMA 15.2 about what an array index is.
231 // Must exactly match string form of an unsigned integer, and be less than 2^32 - 1.
232 inline unsigned Identifier::toArrayIndex(bool& ok) const
234 unsigned i = toUInt32(ok);
235 if (ok && i >= 0xFFFFFFFFU)