src/list.h

   1 // Copyright 2011 the V8 project authors. All rights reserved.
   2 // Redistribution and use in source and binary forms, with or without
   3 // modification, are permitted provided that the following conditions are
   4 // met:
   5 //
   6 //     * Redistributions of source code must retain the above copyright
   7 //       notice, this list of conditions and the following disclaimer.
   8 //     * Redistributions in binary form must reproduce the above
   9 //       copyright notice, this list of conditions and the following
  10 //       disclaimer in the documentation and/or other materials provided
  11 //       with the distribution.
  12 //     * Neither the name of Google Inc. nor the names of its
  13 //       contributors may be used to endorse or promote products derived
  14 //       from this software without specific prior written permission.
  15 //
  16 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  17 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  19 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  20 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  26 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27
  28 #ifndef V8_LIST_H_
  29 #define V8_LIST_H_
  30
  31 #include "utils.h"
  32
  33 namespace v8 {
  34 namespace internal {
  35
  36
  37 // ----------------------------------------------------------------------------
  38 // The list is a template for very light-weight lists. We are not
  39 // using the STL because we want full control over space and speed of
  40 // the code. This implementation is based on code by Robert Griesemer
  41 // and Rob Pike.
  42 //
  43 // The list is parameterized by the type of its elements (T) and by an
  44 // allocation policy (P). The policy is used for allocating lists in
  45 // the C free store or the zone; see zone.h.
  46
  47 // Forward defined as
  48 // template <typename T,
  49 //           class AllocationPolicy = FreeStoreAllocationPolicy> class List;
  50 template <typename T, class AllocationPolicy>
  51 class List {
  52  public:
  53   explicit List(AllocationPolicy allocator = AllocationPolicy()) {
  54     Initialize(0, allocator);
  55   }
  56   INLINE(explicit List(int capacity,
  57                        AllocationPolicy allocator = AllocationPolicy())) {
  58     Initialize(capacity, allocator);
  59   }
  60   INLINE(~List()) { DeleteData(data_); }
  61
  62   // Deallocates memory used by the list and leaves the list in a consistent
  63   // empty state.
  64   void Free() {
  65     DeleteData(data_);
  66     Initialize(0);
  67   }
  68
  69   INLINE(void* operator new(size_t size,
  70                             AllocationPolicy allocator = AllocationPolicy())) {
  71     return allocator.New(static_cast<int>(size));
  72   }
  73   INLINE(void operator delete(void* p)) {
  74     AllocationPolicy::Delete(p);
  75   }
  76
  77   // Please the MSVC compiler.  We should never have to execute this.
  78   INLINE(void operator delete(void* p, AllocationPolicy allocator)) {
  79     UNREACHABLE();
  80   }
  81
  82   // Returns a reference to the element at index i.  This reference is
  83   // not safe to use after operations that can change the list's
  84   // backing store (e.g. Add).
  85   inline T& operator[](int i) const {
  86     ASSERT(0 <= i);
  87     ASSERT(i < length_);
  88     return data_[i];
  89   }
  90   inline T& at(int i) const { return operator[](i); }
  91   inline T& last() const { return at(length_ - 1); }
  92   inline T& first() const { return at(0); }
  93
  94   INLINE(bool is_empty() const) { return length_ == 0; }
  95   INLINE(int length() const) { return length_; }
  96   INLINE(int capacity() const) { return capacity_; }
  97
  98   Vector<T> ToVector() const { return Vector<T>(data_, length_); }
  99
 100   Vector<const T> ToConstVector() { return Vector<const T>(data_, length_); }
 101
 102   // Adds a copy of the given 'element' to the end of the list,
 103   // expanding the list if necessary.
 104   void Add(const T& element, AllocationPolicy allocator = AllocationPolicy());
 105
 106   // Add all the elements from the argument list to this list.
 107   void AddAll(const List<T, AllocationPolicy>& other,
 108               AllocationPolicy allocator = AllocationPolicy());
 109
 110   // Add all the elements from the vector to this list.
 111   void AddAll(const Vector<T>& other,
 112               AllocationPolicy allocator = AllocationPolicy());
 113
 114   // Inserts the element at the specific index.
 115   void InsertAt(int index, const T& element,
 116                 AllocationPolicy allocator = AllocationPolicy());
 117
 118   // Added 'count' elements with the value 'value' and returns a
 119   // vector that allows access to the elements.  The vector is valid
 120   // until the next change is made to this list.
 121   Vector<T> AddBlock(T value, int count,
 122                      AllocationPolicy allocator = AllocationPolicy());
 123
 124   // Removes the i'th element without deleting it even if T is a
 125   // pointer type; moves all elements above i "down". Returns the
 126   // removed element.  This function's complexity is linear in the
 127   // size of the list.
 128   T Remove(int i);
 129
 130   // Remove the given element from the list. Returns whether or not
 131   // the input is included in the list in the first place.
 132   bool RemoveElement(const T& elm);
 133
 134   // Removes the last element without deleting it even if T is a
 135   // pointer type. Returns the removed element.
 136   INLINE(T RemoveLast()) { return Remove(length_ - 1); }
 137
 138   // Deletes current list contents and allocates space for 'length' elements.
 139   INLINE(void Allocate(int length,
 140                        AllocationPolicy allocator = AllocationPolicy()));
 141
 142   // Clears the list by setting the length to zero. Even if T is a
 143   // pointer type, clearing the list doesn't delete the entries.
 144   INLINE(void Clear());
 145
 146   // Drops all but the first 'pos' elements from the list.
 147   INLINE(void Rewind(int pos));
 148
 149   // Drop the last 'count' elements from the list.
 150   INLINE(void RewindBy(int count)) { Rewind(length_ - count); }
 151
 152   bool Contains(const T& elm) const;
 153   int CountOccurrences(const T& elm, int start, int end) const;
 154
 155   // Iterate through all list entries, starting at index 0.
 156   void Iterate(void (*callback)(T* x));
 157   template<class Visitor>
 158   void Iterate(Visitor* visitor);
 159
 160   // Sort all list entries (using QuickSort)
 161   void Sort(int (*cmp)(const T* x, const T* y));
 162   void Sort();
 163
 164   INLINE(void Initialize(int capacity,
 165                          AllocationPolicy allocator = AllocationPolicy()));
 166
 167  private:
 168   T* data_;
 169   int capacity_;
 170   int length_;
 171
 172   INLINE(T* NewData(int n, AllocationPolicy allocator))  {
 173     return static_cast<T*>(allocator.New(n * sizeof(T)));
 174   }
 175   INLINE(void DeleteData(T* data))  {
 176     AllocationPolicy::Delete(data);
 177   }
 178
 179   // Increase the capacity of a full list, and add an element.
 180   // List must be full already.
 181   void ResizeAdd(const T& element, AllocationPolicy allocator);
 182
 183   // Inlined implementation of ResizeAdd, shared by inlined and
 184   // non-inlined versions of ResizeAdd.
 185   void ResizeAddInternal(const T& element, AllocationPolicy allocator);
 186
 187   // Resize the list.
 188   void Resize(int new_capacity, AllocationPolicy allocator);
 189
 190   DISALLOW_COPY_AND_ASSIGN(List);
 191 };
 192
 193 class Map;
 194 class Code;
 195 template<typename T> class Handle;
 196 typedef List<Map*> MapList;
 197 typedef List<Code*> CodeList;
 198 typedef List<Handle<Map> > MapHandleList;
 199 typedef List<Handle<Code> > CodeHandleList;
 200
 201 // Perform binary search for an element in an already sorted
 202 // list. Returns the index of the element of -1 if it was not found.
 203 // |cmp| is a predicate that takes a pointer to an element of the List
 204 // and returns +1 if it is greater, -1 if it is less than the element
 205 // being searched.
 206 template <typename T, class P>
 207 int SortedListBSearch(const List<T>& list, P cmp);
 208 template <typename T>
 209 int SortedListBSearch(const List<T>& list, T elem);
 210
 211
 212 } }  // namespace v8::internal
 213
 214
 215 #endif  // V8_LIST_H_