elements.h 9.4 KB
Newer Older
1
// Copyright 2012 the V8 project authors. All rights reserved.
2 3
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
4 5 6 7

#ifndef V8_ELEMENTS_H_
#define V8_ELEMENTS_H_

8
#include "src/elements-kind.h"
9
#include "src/heap/heap.h"
10
#include "src/isolate.h"
11
#include "src/key-accumulator.h"
12
#include "src/objects.h"
13 14 15 16 17 18 19 20

namespace v8 {
namespace internal {

// Abstract base class for handles that can operate on objects with differing
// ElementsKinds.
class ElementsAccessor {
 public:
21
  explicit ElementsAccessor(const char* name) : name_(name) { }
22
  virtual ~ElementsAccessor() { }
23

24
  const char* name() const { return name_; }
25

26 27 28 29 30 31 32 33
  // Returns a shared ElementsAccessor for the specified ElementsKind.
  static ElementsAccessor* ForKind(ElementsKind elements_kind) {
    DCHECK(static_cast<int>(elements_kind) < kElementsKindCount);
    return elements_accessors_[elements_kind];
  }

  static ElementsAccessor* ForArray(Handle<FixedArrayBase> array);

34 35
  // Checks the elements of an object for consistency, asserting when a problem
  // is found.
36
  virtual void Validate(Handle<JSObject> obj) = 0;
37

38
  // Returns true if a holder contains an element with the specified index
39 40 41
  // without iterating up the prototype chain.  The caller can optionally pass
  // in the backing store to use for the check, which must be compatible with
  // the ElementsKind of the ElementsAccessor. If backing_store is NULL, the
42 43 44 45 46 47
  // holder->elements() is used as the backing store. If a |filter| is
  // specified the PropertyAttributes of the element at the given index
  // are compared to the given |filter|. If they match/overlap the given
  // index is ignored. Note that only Dictionary elements have custom
  // PropertyAttributes associated, hence the |filter| argument is ignored for
  // all but DICTIONARY_ELEMENTS and SLOW_SLOPPY_ARGUMENTS_ELEMENTS.
48
  virtual bool HasElement(Handle<JSObject> holder, uint32_t index,
49
                          Handle<FixedArrayBase> backing_store,
50
                          PropertyFilter filter = ALL_PROPERTIES) = 0;
51

52
  inline bool HasElement(Handle<JSObject> holder, uint32_t index,
53
                         PropertyFilter filter = ALL_PROPERTIES) {
54
    return HasElement(holder, index, handle(holder->elements()), filter);
55
  }
56

57 58 59 60 61
  // Returns true if the backing store is compact in the given range
  virtual bool IsPacked(Handle<JSObject> holder,
                        Handle<FixedArrayBase> backing_store, uint32_t start,
                        uint32_t end) = 0;

62 63
  virtual Handle<Object> Get(Handle<FixedArrayBase> backing_store,
                             uint32_t entry) = 0;
64

65 66 67 68 69
  // Modifies the length data property as specified for JSArrays and resizes the
  // underlying backing store accordingly. The method honors the semantics of
  // changing array sizes as defined in EcmaScript 5.1 15.4.5.2, i.e. array that
  // have non-deletable elements can only be shrunk to the size of highest
  // element that is non-deletable.
70
  virtual void SetLength(Handle<JSArray> holder, uint32_t new_length) = 0;
71

72
  // Deletes an element in an object.
73
  virtual void Delete(Handle<JSObject> holder, uint32_t entry) = 0;
74

75 76 77 78 79 80 81 82 83
  // If kCopyToEnd is specified as the copy_size to CopyElements, it copies all
  // of elements from source after source_start to the destination array.
  static const int kCopyToEnd = -1;
  // If kCopyToEndAndInitializeToHole is specified as the copy_size to
  // CopyElements, it copies all of elements from source after source_start to
  // destination array, padding any remaining uninitialized elements in the
  // destination array with the hole.
  static const int kCopyToEndAndInitializeToHole = -2;

84 85 86 87
  // Copy elements from one backing store to another. Typically, callers specify
  // the source JSObject or JSArray in source_holder. If the holder's backing
  // store is available, it can be passed in source and source_holder is
  // ignored.
88
  virtual void CopyElements(
89 90 91 92 93 94 95
      Handle<FixedArrayBase> source,
      uint32_t source_start,
      ElementsKind source_kind,
      Handle<FixedArrayBase> destination,
      uint32_t destination_start,
      int copy_size) = 0;

96 97 98 99
  // NOTE: this method violates the handlified function signature convention:
  // raw pointer parameter |source_holder| in the function that allocates.
  // This is done intentionally to avoid ArrayConcat() builtin performance
  // degradation.
100 101
  virtual void CopyElements(
      JSObject* source_holder,
102 103 104 105
      uint32_t source_start,
      ElementsKind source_kind,
      Handle<FixedArrayBase> destination,
      uint32_t destination_start,
106
      int copy_size) = 0;
107

108
  inline void CopyElements(
109 110
      Handle<JSObject> from_holder,
      Handle<FixedArrayBase> to,
111 112 113
      ElementsKind from_kind) {
    CopyElements(
      *from_holder, 0, from_kind, to, 0, kCopyToEndAndInitializeToHole);
114 115
  }

116 117 118 119 120 121 122
  // Copy all indices that have elements from |object| into the given
  // KeyAccumulator. For Dictionary-based element-kinds we filter out elements
  // whose PropertyAttribute match |filter|.
  virtual void CollectElementIndices(Handle<JSObject> object,
                                     Handle<FixedArrayBase> backing_store,
                                     KeyAccumulator* keys,
                                     uint32_t range = kMaxUInt32,
123
                                     PropertyFilter filter = ALL_PROPERTIES,
124 125 126 127 128
                                     uint32_t offset = 0) = 0;

  inline void CollectElementIndices(Handle<JSObject> object,
                                    KeyAccumulator* keys,
                                    uint32_t range = kMaxUInt32,
129
                                    PropertyFilter filter = ALL_PROPERTIES,
130 131 132 133
                                    uint32_t offset = 0) {
    CollectElementIndices(object, handle(object->elements()), keys, range,
                          filter, offset);
  }
134

135 136
  virtual void AddElementsToKeyAccumulator(Handle<JSObject> receiver,
                                           KeyAccumulator* accumulator,
137
                                           AddKeyConversion convert) = 0;
138

139 140
  virtual void GrowCapacityAndConvert(Handle<JSObject> object,
                                      uint32_t capacity) = 0;
141

142
  static void InitializeOncePerProcess();
143
  static void TearDown();
144

145
  virtual void Set(FixedArrayBase* backing_store, uint32_t entry,
146
                   Object* value) = 0;
147

148
  virtual void Reconfigure(Handle<JSObject> object,
149
                           Handle<FixedArrayBase> backing_store, uint32_t entry,
150 151
                           Handle<Object> value,
                           PropertyAttributes attributes) = 0;
152

153
  virtual void Add(Handle<JSObject> object, uint32_t index,
154 155
                   Handle<Object> value, PropertyAttributes attributes,
                   uint32_t new_capacity) = 0;
156

157 158 159
  static Handle<JSArray> Concat(Isolate* isolate, Arguments* args,
                                uint32_t concat_size);

160
  virtual uint32_t Push(Handle<JSArray> receiver,
161 162
                        Handle<FixedArrayBase> backing_store, Arguments* args,
                        uint32_t push_size) = 0;
163

164 165 166 167
  virtual uint32_t Unshift(Handle<JSArray> receiver,
                           Handle<FixedArrayBase> backing_store,
                           Arguments* args, uint32_t unshift_size) = 0;

168 169 170 171
  virtual Handle<JSArray> Slice(Handle<JSObject> receiver,
                                Handle<FixedArrayBase> backing_store,
                                uint32_t start, uint32_t end) = 0;

172 173 174
  virtual Handle<JSArray> Splice(Handle<JSArray> receiver,
                                 Handle<FixedArrayBase> backing_store,
                                 uint32_t start, uint32_t delete_count,
175
                                 Arguments* args, uint32_t add_count) = 0;
176

cbruni's avatar
cbruni committed
177 178 179
  virtual Handle<Object> Pop(Handle<JSArray> receiver,
                             Handle<FixedArrayBase> backing_store) = 0;

180 181 182
  virtual Handle<Object> Shift(Handle<JSArray> receiver,
                               Handle<FixedArrayBase> backing_store) = 0;

183
 protected:
184
  friend class LookupIterator;
185

186 187
  static ElementsAccessor* ForArray(FixedArrayBase* array);

188

189 190 191 192 193 194 195 196 197 198 199
  // Element handlers distinguish between entries and indices when they
  // manipulate elements. Entries refer to elements in terms of their location
  // in the underlying storage's backing store representation, and are between 0
  // and GetCapacity. Indices refer to elements in terms of the value that would
  // be specified in JavaScript to access the element. In most implementations,
  // indices are equivalent to entries. In the NumberDictionary
  // ElementsAccessor, entries are mapped to an index using the KeyAt method on
  // the NumberDictionary.
  virtual uint32_t GetEntryForIndex(JSObject* holder,
                                    FixedArrayBase* backing_store,
                                    uint32_t index) = 0;
200
  virtual PropertyDetails GetDetails(FixedArrayBase* backing_store,
201
                                     uint32_t entry) = 0;
202

203
 private:
204 205
  virtual uint32_t GetCapacity(JSObject* holder,
                               FixedArrayBase* backing_store) = 0;
206
  static ElementsAccessor** elements_accessors_;
207
  const char* name_;
208 209 210 211

  DISALLOW_COPY_AND_ASSIGN(ElementsAccessor);
};

212
void CheckArrayAbuse(Handle<JSObject> obj, const char* op, uint32_t index,
213
                     bool allow_appending = false);
214

215 216 217
MUST_USE_RESULT MaybeHandle<Object> ArrayConstructInitializeElements(
    Handle<JSArray> array,
    Arguments* args);
218

219 220
}  // namespace internal
}  // namespace v8
221 222

#endif  // V8_ELEMENTS_H_