src/list.h

   1 // Copyright 2011 the V8 project authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef V8_LIST_H_
   6 #define V8_LIST_H_
   7
   8 #include "src/checks.h"
   9 #include "src/utils.h"
  10
  11 namespace v8 {
  12 namespace internal {
  13
  14 template<typename T> class Vector;
  15
  16 // ----------------------------------------------------------------------------
  17 // The list is a template for very light-weight lists. We are not
  18 // using the STL because we want full control over space and speed of
  19 // the code. This implementation is based on code by Robert Griesemer
  20 // and Rob Pike.
  21 //
  22 // The list is parameterized by the type of its elements (T) and by an
  23 // allocation policy (P). The policy is used for allocating lists in
  24 // the C free store or the zone; see zone.h.
  25
  26 // Forward defined as
  27 // template <typename T,
  28 //           class AllocationPolicy = FreeStoreAllocationPolicy> class List;
  29 template <typename T, class AllocationPolicy>
  30 class List {
  31  public:
  32   explicit List(AllocationPolicy allocator = AllocationPolicy()) {
  33     Initialize(0, allocator);
  34   }
  35   INLINE(explicit List(int capacity,
  36                        AllocationPolicy allocator = AllocationPolicy())) {
  37     Initialize(capacity, allocator);
  38   }
  39   INLINE(~List()) { DeleteData(data_); }
  40
  41   // Deallocates memory used by the list and leaves the list in a consistent
  42   // empty state.
  43   void Free() {
  44     DeleteData(data_);
  45     Initialize(0);
  46   }
  47
  48   INLINE(void* operator new(size_t size,
  49                             AllocationPolicy allocator = AllocationPolicy())) {
  50     return allocator.New(static_cast<int>(size));
  51   }
  52   INLINE(void operator delete(void* p)) {
  53     AllocationPolicy::Delete(p);
  54   }
  55
  56   // Please the MSVC compiler.  We should never have to execute this.
  57   INLINE(void operator delete(void* p, AllocationPolicy allocator)) {
  58     UNREACHABLE();
  59   }
  60
  61   // Returns a reference to the element at index i.  This reference is
  62   // not safe to use after operations that can change the list's
  63   // backing store (e.g. Add).
  64   inline T& operator[](int i) const {
  65     DCHECK(0 <= i);
  66     SLOW_DCHECK(static_cast<unsigned>(i) < static_cast<unsigned>(length_));
  67     return data_[i];
  68   }
  69   inline T& at(int i) const { return operator[](i); }
  70   inline T& last() const { return at(length_ - 1); }
  71   inline T& first() const { return at(0); }
  72
  73   typedef T* iterator;
  74   inline iterator begin() const { return &data_[0]; }
  75   inline iterator end() const { return &data_[length_]; }
  76
  77   INLINE(bool is_empty() const) { return length_ == 0; }
  78   INLINE(int length() const) { return length_; }
  79   INLINE(int capacity() const) { return capacity_; }
  80
  81   Vector<T> ToVector() const { return Vector<T>(data_, length_); }
  82
  83   Vector<const T> ToConstVector() const {
  84     return Vector<const T>(data_, length_);
  85   }
  86
  87   // Adds a copy of the given 'element' to the end of the list,
  88   // expanding the list if necessary.
  89   void Add(const T& element, AllocationPolicy allocator = AllocationPolicy());
  90
  91   // Add all the elements from the argument list to this list.
  92   void AddAll(const List<T, AllocationPolicy>& other,
  93               AllocationPolicy allocator = AllocationPolicy());
  94
  95   // Add all the elements from the vector to this list.
  96   void AddAll(const Vector<T>& other,
  97               AllocationPolicy allocator = AllocationPolicy());
  98
  99   // Inserts the element at the specific index.
 100   void InsertAt(int index, const T& element,
 101                 AllocationPolicy allocator = AllocationPolicy());
 102
 103   // Overwrites the element at the specific index.
 104   void Set(int index, const T& element);
 105
 106   // Added 'count' elements with the value 'value' and returns a
 107   // vector that allows access to the elements.  The vector is valid
 108   // until the next change is made to this list.
 109   Vector<T> AddBlock(T value, int count,
 110                      AllocationPolicy allocator = AllocationPolicy());
 111
 112   // Removes the i'th element without deleting it even if T is a
 113   // pointer type; moves all elements above i "down". Returns the
 114   // removed element.  This function's complexity is linear in the
 115   // size of the list.
 116   T Remove(int i);
 117
 118   // Remove the given element from the list. Returns whether or not
 119   // the input is included in the list in the first place.
 120   bool RemoveElement(const T& elm);
 121
 122   // Removes the last element without deleting it even if T is a
 123   // pointer type. Returns the removed element.
 124   INLINE(T RemoveLast()) { return Remove(length_ - 1); }
 125
 126   // Deletes current list contents and allocates space for 'length' elements.
 127   INLINE(void Allocate(int length,
 128                        AllocationPolicy allocator = AllocationPolicy()));
 129
 130   // Clears the list by setting the length to zero. Even if T is a
 131   // pointer type, clearing the list doesn't delete the entries.
 132   INLINE(void Clear());
 133
 134   // Drops all but the first 'pos' elements from the list.
 135   INLINE(void Rewind(int pos));
 136
 137   // Drop the last 'count' elements from the list.
 138   INLINE(void RewindBy(int count)) { Rewind(length_ - count); }
 139
 140   // Halve the capacity if fill level is less than a quarter.
 141   INLINE(void Trim(AllocationPolicy allocator = AllocationPolicy()));
 142
 143   bool Contains(const T& elm) const;
 144   int CountOccurrences(const T& elm, int start, int end) const;
 145
 146   // Iterate through all list entries, starting at index 0.
 147   void Iterate(void (*callback)(T* x));
 148   template<class Visitor>
 149   void Iterate(Visitor* visitor);
 150
 151   // Sort all list entries (using QuickSort)
 152   template <typename CompareFunction>
 153   void Sort(CompareFunction cmp, size_t start, size_t length);
 154   template <typename CompareFunction>
 155   void Sort(CompareFunction cmp);
 156   void Sort();
 157   template <typename CompareFunction>
 158   void StableSort(CompareFunction cmp, size_t start, size_t length);
 159   template <typename CompareFunction>
 160   void StableSort(CompareFunction cmp);
 161   void StableSort();
 162
 163   INLINE(void Initialize(int capacity,
 164                          AllocationPolicy allocator = AllocationPolicy()));
 165
 166  private:
 167   T* data_;
 168   int capacity_;
 169   int length_;
 170
 171   INLINE(T* NewData(int n, AllocationPolicy allocator))  {
 172     return static_cast<T*>(allocator.New(n * sizeof(T)));
 173   }
 174   INLINE(void DeleteData(T* data))  {
 175     AllocationPolicy::Delete(data);
 176   }
 177
 178   // Increase the capacity of a full list, and add an element.
 179   // List must be full already.
 180   void ResizeAdd(const T& element, AllocationPolicy allocator);
 181
 182   // Inlined implementation of ResizeAdd, shared by inlined and
 183   // non-inlined versions of ResizeAdd.
 184   void ResizeAddInternal(const T& element, AllocationPolicy allocator);
 185
 186   // Resize the list.
 187   void Resize(int new_capacity, AllocationPolicy allocator);
 188
 189   DISALLOW_COPY_AND_ASSIGN(List);
 190 };
 191
 192
 193 template<typename T, class P>
 194 size_t GetMemoryUsedByList(const List<T, P>& list) {
 195   return list.length() * sizeof(T) + sizeof(list);
 196 }
 197
 198
 199 class Map;
 200 template<class> class TypeImpl;
 201 struct HeapTypeConfig;
 202 typedef TypeImpl<HeapTypeConfig> HeapType;
 203 class Code;
 204 template<typename T> class Handle;
 205 typedef List<Map*> MapList;
 206 typedef List<Code*> CodeList;
 207 typedef List<Handle<Map> > MapHandleList;
 208 typedef List<Handle<HeapType> > TypeHandleList;
 209 typedef List<Handle<Code> > CodeHandleList;
 210
 211 // Perform binary search for an element in an already sorted
 212 // list. Returns the index of the element of -1 if it was not found.
 213 // |cmp| is a predicate that takes a pointer to an element of the List
 214 // and returns +1 if it is greater, -1 if it is less than the element
 215 // being searched.
 216 template <typename T, class P>
 217 int SortedListBSearch(const List<T>& list, P cmp);
 218 template <typename T>
 219 int SortedListBSearch(const List<T>& list, T elem);
 220
 221
 222 } }  // namespace v8::internal
 223
 224
 225 #endif  // V8_LIST_H_