blob: 25211d9a7b52b1d3ecf7192bb6d42893b0040f14 [file] [log] [blame]
Steve Blocka7e24c12009-10-30 11:49:00 +00001// 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
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
31namespace v8 {
32namespace internal {
33
34
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
39// and Rob Pike.
40//
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.
44
45// Forward defined as
46// template <typename T, class P = FreeStoreAllocationPolicy> class List;
47template <typename T, class P>
48class List {
49 public:
50
51 INLINE(explicit List(int capacity)) { Initialize(capacity); }
52 INLINE(~List()) { DeleteData(data_); }
53
54 // Deallocates memory used by the list and leaves the list in a consistent
55 // empty state.
56 void Free() {
57 DeleteData(data_);
58 Initialize(0);
59 }
60
61 INLINE(void* operator new(size_t size)) { return P::New(size); }
62 INLINE(void operator delete(void* p, size_t)) { return P::Delete(p); }
63
64 // Returns a reference to the element at index i. This reference is
65 // not safe to use after operations that can change the list's
66 // backing store (eg, Add).
67 inline T& operator[](int i) const {
68 ASSERT(0 <= i && i < length_);
69 return data_[i];
70 }
71 inline T& at(int i) const { return operator[](i); }
72 inline T& last() const { return at(length_ - 1); }
73 inline T& first() const { return at(0); }
74
75 INLINE(bool is_empty() const) { return length_ == 0; }
76 INLINE(int length() const) { return length_; }
77 INLINE(int capacity() const) { return capacity_; }
78
79 Vector<T> ToVector() { return Vector<T>(data_, length_); }
80
81 Vector<const T> ToConstVector() { return Vector<const T>(data_, length_); }
82
83 // Adds a copy of the given 'element' to the end of the list,
84 // expanding the list if necessary.
85 void Add(const T& element);
86
87 // Add all the elements from the argument list to this list.
88 void AddAll(const List<T, P>& other);
89
90 // Added 'count' elements with the value 'value' and returns a
91 // vector that allows access to the elements. The vector is valid
92 // until the next change is made to this list.
93 Vector<T> AddBlock(T value, int count);
94
95 // Removes the i'th element without deleting it even if T is a
96 // pointer type; moves all elements above i "down". Returns the
97 // removed element. This function's complexity is linear in the
98 // size of the list.
99 T Remove(int i);
100
101 // Removes the last element without deleting it even if T is a
102 // pointer type. Returns the removed element.
103 INLINE(T RemoveLast()) { return Remove(length_ - 1); }
104
105 // Clears the list by setting the length to zero. Even if T is a
106 // pointer type, clearing the list doesn't delete the entries.
107 INLINE(void Clear());
108
109 // Drops all but the first 'pos' elements from the list.
110 INLINE(void Rewind(int pos));
111
112 bool Contains(const T& elm);
113
114 // Iterate through all list entries, starting at index 0.
115 void Iterate(void (*callback)(T* x));
116
117 // Sort all list entries (using QuickSort)
118 void Sort(int (*cmp)(const T* x, const T* y));
119 void Sort();
120
121 INLINE(void Initialize(int capacity));
122
123 private:
124 T* data_;
125 int capacity_;
126 int length_;
127
128 INLINE(T* NewData(int n)) { return static_cast<T*>(P::New(n * sizeof(T))); }
129 INLINE(void DeleteData(T* data)) { P::Delete(data); }
130
131 // Increase the capacity of a full list, and add an element.
132 // List must be full already.
133 void ResizeAdd(const T& element);
134
135 // Inlined implementation of ResizeAdd, shared by inlined and
136 // non-inlined versions of ResizeAdd.
137 void ResizeAddInternal(const T& element);
138
139 // Resize the list.
140 void Resize(int new_capacity);
141
142 DISALLOW_COPY_AND_ASSIGN(List);
143};
144
145class FrameElement;
146
147// Add() is inlined, ResizeAdd() called by Add() is inlined except for
148// Lists of FrameElements, and ResizeAddInternal() is inlined in ResizeAdd().
149template <>
150void List<FrameElement,
151 FreeStoreAllocationPolicy>::ResizeAdd(const FrameElement& element);
152
153} } // namespace v8::internal
154
155#endif // V8_LIST_H_