• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2008 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28 
29 #ifndef SegmentedVector_h
30 #define SegmentedVector_h
31 
32 #include <wtf/Vector.h>
33 
34 namespace WTF {
35 
36     // An iterator for SegmentedVector. It supports only the pre ++ operator
37     template <typename T, size_t SegmentSize> class SegmentedVector;
38     template <typename T, size_t SegmentSize> class SegmentedVectorIterator {
39     private:
40         friend class SegmentedVector<T, SegmentSize>;
41     public:
42         typedef SegmentedVectorIterator<T, SegmentSize> Iterator;
43 
~SegmentedVectorIterator()44         ~SegmentedVectorIterator() { }
45 
46         T& operator*() const { return m_vector.m_segments.at(m_segment)->at(m_index); }
47         T* operator->() const { return &m_vector.m_segments.at(m_segment)->at(m_index); }
48 
49         // Only prefix ++ operator supported
50         Iterator& operator++()
51         {
52             ASSERT(m_index != SegmentSize);
53             ++m_index;
54             if (m_index >= m_vector.m_segments.at(m_segment)->size())  {
55                 if (m_segment + 1 < m_vector.m_segments.size()) {
56                     ASSERT(m_vector.m_segments.at(m_segment)->size() > 0);
57                     ++m_segment;
58                     m_index = 0;
59                 } else {
60                     // Points to the "end" symbol
61                     m_segment = 0;
62                     m_index = SegmentSize;
63                 }
64             }
65             return *this;
66         }
67 
68         bool operator==(const Iterator& other) const
69         {
70             return (m_index == other.m_index && m_segment = other.m_segment && &m_vector == &other.m_vector);
71         }
72 
73         bool operator!=(const Iterator& other) const
74         {
75             return (m_index != other.m_index || m_segment != other.m_segment || &m_vector != &other.m_vector);
76         }
77 
78         SegmentedVectorIterator& operator=(const SegmentedVectorIterator<T, SegmentSize>& other)
79         {
80             m_vector = other.m_vector;
81             m_segment = other.m_segment;
82             m_index = other.m_index;
83             return *this;
84         }
85 
86     private:
SegmentedVectorIterator(SegmentedVector<T,SegmentSize> & vector,size_t segment,size_t index)87         SegmentedVectorIterator(SegmentedVector<T, SegmentSize>& vector, size_t segment, size_t index)
88             : m_vector(vector)
89             , m_segment(segment)
90             , m_index(index)
91         {
92         }
93 
94         SegmentedVector<T, SegmentSize>& m_vector;
95         size_t m_segment;
96         size_t m_index;
97     };
98 
99     // SegmentedVector is just like Vector, but it doesn't move the values
100     // stored in its buffer when it grows. Therefore, it is safe to keep
101     // pointers into a SegmentedVector.
102     template <typename T, size_t SegmentSize> class SegmentedVector {
103         friend class SegmentedVectorIterator<T, SegmentSize>;
104     public:
105         typedef SegmentedVectorIterator<T, SegmentSize> Iterator;
106 
SegmentedVector()107         SegmentedVector()
108             : m_size(0)
109         {
110             m_segments.append(&m_inlineSegment);
111         }
112 
~SegmentedVector()113         ~SegmentedVector()
114         {
115             deleteAllSegments();
116         }
117 
size()118         size_t size() const { return m_size; }
119 
at(size_t index)120         T& at(size_t index)
121         {
122             if (index < SegmentSize)
123                 return m_inlineSegment[index];
124             return segmentFor(index)->at(subscriptFor(index));
125         }
126 
127         T& operator[](size_t index)
128         {
129             return at(index);
130         }
131 
last()132         T& last()
133         {
134             return at(size() - 1);
135         }
136 
append(const U & value)137         template <typename U> void append(const U& value)
138         {
139             ++m_size;
140 
141             if (m_size <= SegmentSize) {
142                 m_inlineSegment.uncheckedAppend(value);
143                 return;
144             }
145 
146             if (!segmentExistsFor(m_size - 1))
147                 m_segments.append(new Segment);
148             segmentFor(m_size - 1)->uncheckedAppend(value);
149         }
150 
alloc()151         T& alloc()
152         {
153             append<T>(T());
154             return last();
155         }
156 
removeLast()157         void removeLast()
158         {
159             if (m_size <= SegmentSize)
160                 m_inlineSegment.removeLast();
161             else
162                 segmentFor(m_size - 1)->removeLast();
163             --m_size;
164         }
165 
grow(size_t size)166         void grow(size_t size)
167         {
168             ASSERT(size > m_size);
169             ensureSegmentsFor(size);
170             m_size = size;
171         }
172 
clear()173         void clear()
174         {
175             deleteAllSegments();
176             m_segments.resize(1);
177             m_inlineSegment.clear();
178             m_size = 0;
179         }
180 
begin()181         Iterator begin()
182         {
183             return Iterator(*this, 0, m_size ? 0 : SegmentSize);
184         }
185 
end()186         Iterator end()
187         {
188             return Iterator(*this, 0, SegmentSize);
189         }
190 
191     private:
192         typedef Vector<T, SegmentSize> Segment;
193 
deleteAllSegments()194         void deleteAllSegments()
195         {
196             // Skip the first segment, because it's our inline segment, which was
197             // not created by new.
198             for (size_t i = 1; i < m_segments.size(); i++)
199                 delete m_segments[i];
200         }
201 
segmentExistsFor(size_t index)202         bool segmentExistsFor(size_t index)
203         {
204             return index / SegmentSize < m_segments.size();
205         }
206 
segmentFor(size_t index)207         Segment* segmentFor(size_t index)
208         {
209             return m_segments[index / SegmentSize];
210         }
211 
subscriptFor(size_t index)212         size_t subscriptFor(size_t index)
213         {
214             return index % SegmentSize;
215         }
216 
ensureSegmentsFor(size_t size)217         void ensureSegmentsFor(size_t size)
218         {
219             size_t segmentCount = m_size / SegmentSize;
220             if (m_size % SegmentSize)
221                 ++segmentCount;
222             segmentCount = std::max<size_t>(segmentCount, 1); // We always have at least our inline segment.
223 
224             size_t neededSegmentCount = size / SegmentSize;
225             if (size % SegmentSize)
226                 ++neededSegmentCount;
227 
228             // Fill up to N - 1 segments.
229             size_t end = neededSegmentCount - 1;
230             for (size_t i = segmentCount - 1; i < end; ++i)
231                 ensureSegment(i, SegmentSize);
232 
233             // Grow segment N to accomodate the remainder.
234             ensureSegment(end, subscriptFor(size - 1) + 1);
235         }
236 
ensureSegment(size_t segmentIndex,size_t size)237         void ensureSegment(size_t segmentIndex, size_t size)
238         {
239             ASSERT(segmentIndex <= m_segments.size());
240             if (segmentIndex == m_segments.size())
241                 m_segments.append(new Segment);
242             m_segments[segmentIndex]->grow(size);
243         }
244 
245         size_t m_size;
246         Segment m_inlineSegment;
247         Vector<Segment*, 32> m_segments;
248     };
249 
250 } // namespace WTF
251 
252 #endif // SegmentedVector_h
253