1 // Copyright 2006-2009 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
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.
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.
35 // ----------------------------------------------------------------------------
36 // The list is a template for very light-weight lists. We are not
37 // using the STL because we want full control over space and speed of
38 // the code. This implementation is based on code by Robert Griesemer
41 // The list is parameterized by the type of its elements (T) and by an
42 // allocation policy (P). The policy is used for allocating lists in
43 // the C free store or the zone; see zone.h.
46 // template <typename T, class P = FreeStoreAllocationPolicy> class List;
47 template <typename T, class P>
51 List() { Initialize(0); }
52 INLINE(explicit List(int capacity)) { Initialize(capacity); }
53 INLINE(~List()) { DeleteData(data_); }
55 // Deallocates memory used by the list and leaves the list in a consistent
62 INLINE(void* operator new(size_t size)) { return P::New(size); }
63 INLINE(void operator delete(void* p, size_t)) { return P::Delete(p); }
65 // Returns a reference to the element at index i. This reference is
66 // not safe to use after operations that can change the list's
67 // backing store (eg, Add).
68 inline T& operator[](int i) const {
69 ASSERT(0 <= i && i < length_);
72 inline T& at(int i) const { return operator[](i); }
73 inline T& last() const { return at(length_ - 1); }
74 inline T& first() const { return at(0); }
76 INLINE(bool is_empty() const) { return length_ == 0; }
77 INLINE(int length() const) { return length_; }
78 INLINE(int capacity() const) { return capacity_; }
80 Vector<T> ToVector() { return Vector<T>(data_, length_); }
82 Vector<const T> ToConstVector() { return Vector<const T>(data_, length_); }
84 // Adds a copy of the given 'element' to the end of the list,
85 // expanding the list if necessary.
86 void Add(const T& element);
88 // Add all the elements from the argument list to this list.
89 void AddAll(const List<T, P>& other);
91 // Added 'count' elements with the value 'value' and returns a
92 // vector that allows access to the elements. The vector is valid
93 // until the next change is made to this list.
94 Vector<T> AddBlock(T value, int count);
96 // Removes the i'th element without deleting it even if T is a
97 // pointer type; moves all elements above i "down". Returns the
98 // removed element. This function's complexity is linear in the
102 // Removes the last element without deleting it even if T is a
103 // pointer type. Returns the removed element.
104 INLINE(T RemoveLast()) { return Remove(length_ - 1); }
106 // Clears the list by setting the length to zero. Even if T is a
107 // pointer type, clearing the list doesn't delete the entries.
108 INLINE(void Clear());
110 // Drops all but the first 'pos' elements from the list.
111 INLINE(void Rewind(int pos));
113 bool Contains(const T& elm);
115 // Iterate through all list entries, starting at index 0.
116 void Iterate(void (*callback)(T* x));
118 // Sort all list entries (using QuickSort)
119 void Sort(int (*cmp)(const T* x, const T* y));
122 INLINE(void Initialize(int capacity));
129 INLINE(T* NewData(int n)) { return static_cast<T*>(P::New(n * sizeof(T))); }
130 INLINE(void DeleteData(T* data)) { P::Delete(data); }
132 // Increase the capacity of a full list, and add an element.
133 // List must be full already.
134 void ResizeAdd(const T& element);
136 // Inlined implementation of ResizeAdd, shared by inlined and
137 // non-inlined versions of ResizeAdd.
138 void ResizeAddInternal(const T& element);
141 void Resize(int new_capacity);
143 DISALLOW_COPY_AND_ASSIGN(List);
148 // Add() is inlined, ResizeAdd() called by Add() is inlined except for
149 // Lists of FrameElements, and ResizeAddInternal() is inlined in ResizeAdd().
151 void List<FrameElement,
152 FreeStoreAllocationPolicy>::ResizeAdd(const FrameElement& element);
154 } } // namespace v8::internal