0d571420c075ceca462b75b85720c6bf78e31e3e
[WebKit-https.git] / JavaScriptCore / wtf / Vector.h
1 // -*- mode: c++; c-basic-offset: 4 -*-
2 /*
3  *  This file is part of the KDE libraries
4  *  Copyright (C) 2005, 2006 Apple Computer, Inc.
5  *
6  *  This library is free software; you can redistribute it and/or
7  *  modify it under the terms of the GNU Library General Public
8  *  License as published by the Free Software Foundation; either
9  *  version 2 of the License, or (at your option) any later version.
10  *
11  *  This library is distributed in the hope that it will be useful,
12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  *  Library General Public License for more details.
15  *
16  *  You should have received a copy of the GNU Library General Public License
17  *  along with this library; see the file COPYING.LIB.  If not, write to
18  *  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19  *  Boston, MA 02110-1301, USA.
20  *
21  */
22
23 #ifndef WTF_Vector_h
24 #define WTF_Vector_h
25
26 #include "Assertions.h"
27 #include "FastMalloc.h"
28 #include "VectorTraits.h"
29 #include <limits>
30 #include <stdlib.h>
31 #include <string.h>
32 #include <utility>
33
34 namespace WTF {
35
36     using std::min;
37     using std::max;
38     
39     template <bool needsDestruction, typename T>
40     class VectorDestructor;
41
42     template<typename T>
43     struct VectorDestructor<false, T>
44     {
45         static void destruct(T*, T*) {}
46     };
47
48     template<typename T>
49     struct VectorDestructor<true, T>
50     {
51         static void destruct(T* begin, T* end) 
52         {
53             for (T* cur = begin; cur != end; ++cur)
54                 cur->~T();
55         }
56     };
57
58     template <bool needsInitialization, bool canInitializeWithMemset, typename T>
59     class VectorInitializer;
60
61     template<bool ignore, typename T>
62     struct VectorInitializer<false, ignore, T>
63     {
64         static void initialize(T*, T*) {}
65     };
66
67     template<typename T>
68     struct VectorInitializer<true, false, T>
69     {
70         static void initialize(T* begin, T* end) 
71         {
72             for (T* cur = begin; cur != end; ++cur)
73                 new (cur) T;
74         }
75     };
76
77     template<typename T>
78     struct VectorInitializer<true, true, T>
79     {
80         static void initialize(T* begin, T* end) 
81         {
82             memset(begin, 0, reinterpret_cast<char*>(end) - reinterpret_cast<char*>(begin));
83         }
84     };
85
86     template <bool canMoveWithMemcpy, typename T>
87     class VectorMover;
88
89     template<typename T>
90     struct VectorMover<false, T>
91     {
92         static void move(const T* src, const T* srcEnd, T* dst)
93         {
94             while (src != srcEnd) {
95                 new (dst) T(*src);
96                 src->~T();
97                 ++dst;
98                 ++src;
99             }
100         }
101         static void moveOverlapping(const T* src, const T* srcEnd, T* dst)
102         {
103             if (src > dst)
104                 move(src, srcEnd, dst);
105             else {
106                 T* dstEnd = dst + (srcEnd - src);
107                 while (src != srcEnd) {
108                     --srcEnd;
109                     --dstEnd;
110                     new (dstEnd) T(*srcEnd);
111                     srcEnd->~T();
112                 }
113             }
114         }
115     };
116
117     template<typename T>
118     struct VectorMover<true, T>
119     {
120         static void move(const T* src, const T* srcEnd, T* dst) 
121         {
122             memcpy(dst, src, reinterpret_cast<const char*>(srcEnd) - reinterpret_cast<const char*>(src));
123         }
124         static void moveOverlapping(const T* src, const T* srcEnd, T* dst) 
125         {
126             memmove(dst, src, reinterpret_cast<const char*>(srcEnd) - reinterpret_cast<const char*>(src));
127         }
128     };
129
130     template <bool canCopyWithMemcpy, typename T>
131     class VectorCopier;
132
133     template<typename T>
134     struct VectorCopier<false, T>
135     {
136         static void uninitializedCopy(const T* src, const T* srcEnd, T* dst) 
137         {
138             while (src != srcEnd) {
139                 new (dst) T(*src);
140                 ++dst;
141                 ++src;
142             }
143         }
144     };
145
146     template<typename T>
147     struct VectorCopier<true, T>
148     {
149         static void uninitializedCopy(const T* src, const T* srcEnd, T* dst) 
150         {
151             memcpy(dst, src, reinterpret_cast<const char*>(srcEnd) - reinterpret_cast<const char*>(src));
152         }
153     };
154
155     template <bool canFillWithMemset, typename T>
156     class VectorFiller;
157
158     template<typename T>
159     struct VectorFiller<false, T>
160     {
161         static void uninitializedFill(T* dst, T* dstEnd, const T& val) 
162         {
163             while (dst != dstEnd) {
164                 new (dst) T(val);
165                 ++dst;
166             }
167         }
168     };
169
170     template<typename T>
171     struct VectorFiller<true, T>
172     {
173         static void uninitializedFill(T* dst, T* dstEnd, const T& val) 
174         {
175             ASSERT(sizeof(T) == sizeof(char));
176             memset(dst, val, dstEnd - dst);
177         }
178     };
179     
180     template<bool canCompareWithMemcmp, typename T>
181     class VectorComparer;
182     
183     template<typename T>
184     struct VectorComparer<false, T>
185     {
186         static bool compare(const T* a, const T* b, size_t size)
187         {
188             for (size_t i = 0; i < size; ++i)
189                 if (a[i] != b[i])
190                     return false;
191             return true;
192         }
193     };
194
195     template<typename T>
196     struct VectorComparer<true, T>
197     {
198         static bool compare(const T* a, const T* b, size_t size)
199         {
200             return memcmp(a, b, sizeof(T) * size) == 0;
201         }
202     };
203     
204     template<typename T>
205     struct VectorTypeOperations
206     {
207         static void destruct(T* begin, T* end)
208         {
209             VectorDestructor<VectorTraits<T>::needsDestruction, T>::destruct(begin, end);
210         }
211
212         static void initialize(T* begin, T* end)
213         {
214             VectorInitializer<VectorTraits<T>::needsInitialization, VectorTraits<T>::canInitializeWithMemset, T>::initialize(begin, end);
215         }
216
217         static void move(const T* src, const T* srcEnd, T* dst)
218         {
219             VectorMover<VectorTraits<T>::canMoveWithMemcpy, T>::move(src, srcEnd, dst);
220         }
221
222         static void moveOverlapping(const T* src, const T* srcEnd, T* dst)
223         {
224             VectorMover<VectorTraits<T>::canMoveWithMemcpy, T>::moveOverlapping(src, srcEnd, dst);
225         }
226
227         static void uninitializedCopy(const T* src, const T* srcEnd, T* dst)
228         {
229             VectorCopier<VectorTraits<T>::canCopyWithMemcpy, T>::uninitializedCopy(src, srcEnd, dst);
230         }
231
232         static void uninitializedFill(T* dst, T* dstEnd, const T& val)
233         {
234             VectorFiller<VectorTraits<T>::canFillWithMemset, T>::uninitializedFill(dst, dstEnd, val);
235         }
236         
237         static bool compare(const T* a, const T* b, size_t size)
238         {
239             return VectorComparer<VectorTraits<T>::canCompareWithMemcmp, T>::compare(a, b, size);
240         }
241     };
242
243     template<typename T>
244     class VectorBufferBase {
245     public:
246         void allocateBuffer(size_t newCapacity)
247         {
248             ASSERT(newCapacity >= m_capacity);
249             m_capacity = newCapacity;
250             if (newCapacity > std::numeric_limits<size_t>::max() / sizeof(T))
251                 CRASH();
252             m_buffer = static_cast<T*>(fastMalloc(newCapacity * sizeof(T)));
253         }
254
255         void deallocateBuffer(T* bufferToDeallocate)
256         {
257             fastFree(bufferToDeallocate);
258         }
259
260         T* buffer() { return m_buffer; }
261         const T* buffer() const { return m_buffer; }
262         size_t capacity() const { return m_capacity; }
263
264         T* releaseBuffer()
265         {
266             T* buffer = m_buffer;
267             m_buffer = 0;
268             m_capacity = 0;
269             return buffer;
270         }
271
272     protected:
273         VectorBufferBase()
274             : m_buffer(0)
275             , m_capacity(0)
276         {
277         }
278
279         VectorBufferBase(T* buffer, size_t capacity)
280             : m_buffer(buffer)
281             , m_capacity(capacity)
282         {
283         }
284
285         ~VectorBufferBase()
286         {
287             // FIXME: It would be nice to find a way to ASSERT that m_buffer hasn't leaked here.
288         }
289
290         T* m_buffer;
291         size_t m_capacity;
292     };
293
294     template<typename T, size_t inlineCapacity>
295     class VectorBuffer;
296
297     template<typename T>
298     class VectorBuffer<T, 0> : private VectorBufferBase<T> {
299     private:
300         typedef VectorBufferBase<T> Base;
301     public:
302         VectorBuffer()
303         {
304         }
305
306         VectorBuffer(size_t capacity)
307         {
308             allocateBuffer(capacity);
309         }
310
311         ~VectorBuffer()
312         {
313             deallocateBuffer(buffer());
314         }
315         
316         void swap(VectorBuffer<T, 0>& other)
317         {
318             std::swap(m_buffer, other.m_buffer);
319             std::swap(m_capacity, other.m_capacity);
320         }
321
322         using Base::allocateBuffer;
323         using Base::deallocateBuffer;
324
325         using Base::buffer;
326         using Base::capacity;
327
328         using Base::releaseBuffer;
329     private:
330         using Base::m_buffer;
331         using Base::m_capacity;
332     };
333
334     template<typename T, size_t inlineCapacity>
335     class VectorBuffer : private VectorBufferBase<T> {
336     private:
337         typedef VectorBufferBase<T> Base;
338     public:
339         VectorBuffer()
340             : Base(inlineBuffer(), inlineCapacity)
341         {
342         }
343
344         VectorBuffer(size_t capacity)
345             : Base(inlineBuffer(), inlineCapacity)
346         {
347             if (capacity > inlineCapacity)
348                 allocateBuffer(capacity);
349         }
350
351         ~VectorBuffer()
352         {
353             deallocateBuffer(buffer());
354         }
355
356         using Base::allocateBuffer;
357
358         void deallocateBuffer(T* bufferToDeallocate)
359         {
360             if (bufferToDeallocate == inlineBuffer())
361                 return;
362             Base::deallocateBuffer(bufferToDeallocate);
363         }
364
365         using Base::buffer;
366         using Base::capacity;
367
368         T* releaseBuffer()
369         {
370             if (buffer() == inlineBuffer())
371                 return 0;
372             return Base::releaseBuffer();
373         }
374
375     private:
376         using Base::m_buffer;
377         using Base::m_capacity;
378
379         static const size_t m_inlineBufferSize = inlineCapacity * sizeof(T);
380         T* inlineBuffer() { return reinterpret_cast<T*>(&m_inlineBuffer); }
381
382         // FIXME: Nothing guarantees this buffer is appropriately aligned to hold objects of type T.
383         char m_inlineBuffer[m_inlineBufferSize];
384     };
385
386     template<typename T, size_t inlineCapacity = 0>
387     class Vector {
388     private:
389         typedef VectorBuffer<T, inlineCapacity> Impl;
390         typedef VectorTypeOperations<T> TypeOperations;
391
392     public:
393         typedef T* iterator;
394         typedef const T* const_iterator;
395
396         Vector() 
397             : m_size(0)
398         {
399         }
400         
401         explicit Vector(size_t size) 
402             : m_size(0)
403         {
404             resize(size);
405         }
406
407         ~Vector()
408         {
409             clear();
410         }
411
412         Vector(const Vector&);
413         template<size_t otherCapacity> 
414         Vector(const Vector<T, otherCapacity>&);
415
416         Vector& operator=(const Vector&);
417         template<size_t otherCapacity> 
418         Vector& operator=(const Vector<T, otherCapacity>&);
419
420         size_t size() const { return m_size; }
421         size_t capacity() const { return m_impl.capacity(); }
422         bool isEmpty() const { return !size(); }
423
424         T& at(size_t i) 
425         { 
426             ASSERT(i < size());
427             return m_impl.buffer()[i]; 
428         }
429         const T& at(size_t i) const 
430         {
431             ASSERT(i < size());
432             return m_impl.buffer()[i]; 
433         }
434
435         T& operator[](size_t i) { return at(i); }
436         const T& operator[](size_t i) const { return at(i); }
437
438         T* data() { return m_impl.buffer(); }
439         const T* data() const { return m_impl.buffer(); }
440
441         iterator begin() { return data(); }
442         iterator end() { return begin() + m_size; }
443         const_iterator begin() const { return data(); }
444         const_iterator end() const { return begin() + m_size; }
445         
446         T& first() { return at(0); }
447         const T& first() const { return at(0); }
448         T& last() { return at(size() - 1); }
449         const T& last() const { return at(size() - 1); }
450
451         void shrink(size_t size);
452         void resize(size_t size);
453         void reserveCapacity(size_t newCapacity);
454
455         void clear() { shrink(0); }
456
457         template<typename U> void append(const U*, size_t);
458         template<typename U> void append(const U&);
459         template<typename U, size_t c> void append(const Vector<U, c>&);
460
461         template<typename U> void insert(size_t position, const U*, size_t);
462         template<typename U> void insert(size_t position, const U&);
463         template<typename U, size_t c> void insert(size_t position, const Vector<U, c>&);
464
465         template<typename U> void prepend(const U*, size_t);
466         template<typename U> void prepend(const U&);
467         template<typename U, size_t c> void prepend(const Vector<U, c>&);
468
469         void remove(size_t position);
470
471         void removeLast() 
472         {
473             ASSERT(!isEmpty());
474             shrink(size() - 1); 
475         }
476
477         Vector(size_t size, const T& val)
478             : m_size(size)
479             , m_impl(size)
480         {
481             TypeOperations::uninitializedFill(begin(), end(), val);
482         }
483
484         void fill(const T&, size_t);
485         void fill(const T& val) { fill(val, size()); }
486
487         template<typename Iterator> void appendRange(Iterator start, Iterator end);
488
489         T* releaseBuffer();
490
491         void swap(Vector<T, inlineCapacity>& other)
492         {
493             std::swap(m_size, other.m_size);
494             m_impl.swap(other.m_impl);
495         }
496
497     private:
498         void expandCapacity(size_t newMinCapacity);
499         const T* expandCapacity(size_t newMinCapacity, const T*);
500         template<typename U> U* expandCapacity(size_t newMinCapacity, U*); 
501
502         size_t m_size;
503         Impl m_impl;
504     };
505
506     template<typename T, size_t inlineCapacity>
507     Vector<T, inlineCapacity>::Vector(const Vector& other)
508         : m_size(other.size())
509         , m_impl(other.capacity())
510     {
511         TypeOperations::uninitializedCopy(other.begin(), other.end(), begin());
512     }
513
514     template<typename T, size_t inlineCapacity>
515     template<size_t otherCapacity> 
516     Vector<T, inlineCapacity>::Vector(const Vector<T, otherCapacity>& other)
517         : m_size(other.size())
518         , m_impl(other.capacity())
519     {
520         TypeOperations::uninitializedCopy(other.begin(), other.end(), begin());
521     }
522
523     template<typename T, size_t inlineCapacity>
524     Vector<T, inlineCapacity>& Vector<T, inlineCapacity>::operator=(const Vector<T, inlineCapacity>& other)
525     {
526         if (&other == this)
527             return *this;
528         
529         if (size() > other.size())
530             shrink(other.size());
531         else if (other.size() > capacity()) {
532             clear();
533             reserveCapacity(other.size());
534         }
535         
536         std::copy(other.begin(), other.begin() + size(), begin());
537         TypeOperations::uninitializedCopy(other.begin() + size(), other.end(), end());
538         m_size = other.size();
539
540         return *this;
541     }
542
543     template<typename T, size_t inlineCapacity>
544     template<size_t otherCapacity> 
545     Vector<T, inlineCapacity>& Vector<T, inlineCapacity>::operator=(const Vector<T, otherCapacity>& other)
546     {
547         if (&other == this)
548             return *this;
549         
550         if (size() > other.size())
551             shrink(other.size());
552         else if (other.size() > capacity()) {
553             clear();
554             reserveCapacity(other.size());
555         }
556         
557         std::copy(other.begin(), other.begin() + size(), begin());
558         TypeOperations::uninitializedCopy(other.begin() + size(), other.end(), end());
559         m_size = other.size();
560
561         return *this;
562     }
563
564     template<typename T, size_t inlineCapacity>
565     void Vector<T, inlineCapacity>::fill(const T& val, size_t newSize)
566     {
567         if (size() > newSize)
568             shrink(newSize);
569         else if (newSize > capacity()) {
570             clear();
571             reserveCapacity(newSize);
572         }
573         
574         std::fill(begin(), end(), val);
575         TypeOperations::uninitializedFill(end(), begin() + newSize, val);
576         m_size = newSize;
577     }
578
579     template<typename T, size_t inlineCapacity>
580     template<typename Iterator>
581     void Vector<T, inlineCapacity>::appendRange(Iterator start, Iterator end)
582     {
583         for (Iterator it = start; it != end; ++it)
584             append(*it);
585     }
586
587     template<typename T, size_t inlineCapacity>
588     void Vector<T, inlineCapacity>::expandCapacity(size_t newMinCapacity)
589     {
590         reserveCapacity(max(newMinCapacity, max(static_cast<size_t>(16), capacity() + capacity() / 4 + 1)));
591     }
592     
593     template<typename T, size_t inlineCapacity>
594     const T* Vector<T, inlineCapacity>::expandCapacity(size_t newMinCapacity, const T* ptr)
595     {
596         if (ptr < begin() || ptr >= end()) {
597             expandCapacity(newMinCapacity);
598             return ptr;
599         }
600         size_t index = ptr - begin();
601         expandCapacity(newMinCapacity);
602         return begin() + index;
603     }
604
605     template<typename T, size_t inlineCapacity> template<typename U>
606     inline U* Vector<T, inlineCapacity>::expandCapacity(size_t newMinCapacity, U* ptr)
607     {
608         expandCapacity(newMinCapacity);
609         return ptr;
610     }
611
612     template<typename T, size_t inlineCapacity>
613     void Vector<T, inlineCapacity>::resize(size_t size)
614     {
615         if (size <= m_size)
616             TypeOperations::destruct(begin() + size, end());
617         else {
618             if (size > capacity())
619                 expandCapacity(size);
620             TypeOperations::initialize(end(), begin() + size);
621         }
622         
623         m_size = size;
624     }
625
626     template<typename T, size_t inlineCapacity>
627     void Vector<T, inlineCapacity>::shrink(size_t size)
628     {
629         ASSERT(size <= m_size);
630         TypeOperations::destruct(begin() + size, end());
631         m_size = size;
632     }
633
634     template<typename T, size_t inlineCapacity>
635     void Vector<T, inlineCapacity>::reserveCapacity(size_t newCapacity)
636     {
637         if (newCapacity < capacity())
638             return;
639         T* oldBuffer = begin();
640         T* oldEnd = end();
641         m_impl.allocateBuffer(newCapacity);
642         TypeOperations::move(oldBuffer, oldEnd, begin());
643         m_impl.deallocateBuffer(oldBuffer);
644     }
645
646     // Templatizing these is better than just letting the conversion happen implicitly,
647     // because for instance it allows a PassRefPtr to be appended to a RefPtr vector
648     // without refcount thrash.
649
650     template<typename T, size_t inlineCapacity> template<typename U>
651     void Vector<T, inlineCapacity>::append(const U* data, size_t dataSize)
652     {
653         size_t newSize = m_size + dataSize;
654         if (newSize > capacity())
655             data = expandCapacity(newSize, data);
656         T* dest = end();
657         for (size_t i = 0; i < dataSize; ++i)
658             new (&dest[i]) T(data[i]);
659         m_size = newSize;
660     }
661
662     template<typename T, size_t inlineCapacity> template<typename U>
663     inline void Vector<T, inlineCapacity>::append(const U& val)
664     {
665         const U* ptr = &val;
666         if (size() == capacity())
667             ptr = expandCapacity(size() + 1, ptr);
668         new (end()) T(*ptr);
669         ++m_size;
670     }
671
672     template<typename T, size_t inlineCapacity> template<typename U, size_t c>
673     inline void Vector<T, inlineCapacity>::append(const Vector<U, c>& val)
674     {
675         append(val.begin(), val.size());
676     }
677
678     template<typename T, size_t inlineCapacity> template<typename U>
679     void Vector<T, inlineCapacity>::insert(size_t position, const U* data, size_t dataSize)
680     {
681         ASSERT(position <= size());
682         size_t newSize = m_size + dataSize;
683         if (newSize > capacity())
684             data = expandCapacity(newSize, data);
685         T* spot = begin() + position;
686         TypeOperations::moveOverlapping(spot, end(), spot + dataSize);
687         for (size_t i = 0; i < dataSize; ++i)
688             new (&spot[i]) T(data[i]);
689         m_size = newSize;
690     }
691      
692     template<typename T, size_t inlineCapacity> template<typename U>
693     inline void Vector<T, inlineCapacity>::insert(size_t position, const U& val)
694     {
695         ASSERT(position <= size());
696         const U* data = &val;
697         if (size() == capacity())
698             data = expandCapacity(size() + 1, data);
699         T* spot = begin() + position;
700         TypeOperations::moveOverlapping(spot, end(), spot + 1);
701         new (spot) T(*data);
702         ++m_size;
703     }
704    
705     template<typename T, size_t inlineCapacity> template<typename U, size_t c>
706     inline void Vector<T, inlineCapacity>::insert(size_t position, const Vector<U, c>& val)
707     {
708         insert(position, val.begin(), val.size());
709     }
710
711     template<typename T, size_t inlineCapacity> template<typename U>
712     void Vector<T, inlineCapacity>::prepend(const U* data, size_t dataSize)
713     {
714         insert(0, data, dataSize);
715     }
716
717     template<typename T, size_t inlineCapacity> template<typename U>
718     inline void Vector<T, inlineCapacity>::prepend(const U& val)
719     {
720         insert(0, val);
721     }
722    
723     template<typename T, size_t inlineCapacity> template<typename U, size_t c>
724     inline void Vector<T, inlineCapacity>::prepend(const Vector<U, c>& val)
725     {
726         insert(0, val.begin(), val.size());
727     }
728     
729     template<typename T, size_t inlineCapacity>
730     inline void Vector<T, inlineCapacity>::remove(size_t position)
731     {
732         ASSERT(position < size());
733         T* spot = begin() + position;
734         spot->~T();
735         TypeOperations::moveOverlapping(spot + 1, end(), spot);
736         --m_size;
737     }
738
739     template<typename T, size_t inlineCapacity>
740     T* Vector<T, inlineCapacity>::releaseBuffer()
741     {
742         T* buffer = m_impl.releaseBuffer();
743         if (!buffer && m_size) {
744             // If the vector had some data, but no buffer to release,
745             // that means it was using the inline buffer. In that case,
746             // we create a brand new buffer so the caller always gets one.
747             size_t bytes = m_size * sizeof(T);
748             buffer = static_cast<T*>(fastMalloc(bytes));
749             memcpy(buffer, data(), bytes);
750         }
751         m_size = 0;
752         return buffer;
753     }
754
755     template<typename T, size_t inlineCapacity>
756     void deleteAllValues(const Vector<T, inlineCapacity>& collection)
757     {
758         typedef typename Vector<T, inlineCapacity>::const_iterator iterator;
759         iterator end = collection.end();
760         for (iterator it = collection.begin(); it != end; ++it)
761             delete *it;
762     }
763
764     template<typename T, size_t inlineCapacity>
765     inline void swap(Vector<T, inlineCapacity>& a, Vector<T, inlineCapacity>& b)
766     {
767         a.swap(b);
768     }
769
770     template<typename T, size_t inlineCapacity>
771     bool operator==(const Vector<T, inlineCapacity>& a, const Vector<T, inlineCapacity>& b)
772     {
773         if (a.size() != b.size())
774             return false;
775
776         return VectorTypeOperations<T>::compare(a.data(), b.data(), a.size());
777     }
778
779     template<typename T, size_t inlineCapacity>
780     inline bool operator!=(const Vector<T, inlineCapacity>& a, const Vector<T, inlineCapacity>& b)
781     {
782         return !(a == b);
783     }
784
785
786 } // namespace WTF
787
788 using WTF::Vector;
789
790 #endif // WTF_Vector_h