1 /****************************************************************************
3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
4 ** All rights reserved.
5 ** Contact: Nokia Corporation (qt-info@nokia.com)
7 ** This file is part of the QtCore module of the Qt Toolkit.
9 ** $QT_BEGIN_LICENSE:LGPL$
10 ** GNU Lesser General Public License Usage
11 ** This file may be used under the terms of the GNU Lesser General Public
12 ** License version 2.1 as published by the Free Software Foundation and
13 ** appearing in the file LICENSE.LGPL included in the packaging of this
14 ** file. Please review the following information to ensure the GNU Lesser
15 ** General Public License version 2.1 requirements will be met:
16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
18 ** In addition, as a special exception, Nokia gives you certain additional
19 ** rights. These rights are described in the Nokia Qt LGPL Exception
20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
22 ** GNU General Public License Usage
23 ** Alternatively, this file may be used under the terms of the GNU General
24 ** Public License version 3.0 as published by the Free Software Foundation
25 ** and appearing in the file LICENSE.GPL included in the packaging of this
26 ** file. Please review the following information to ensure the GNU General
27 ** Public License version 3.0 requirements will be met:
28 ** http://www.gnu.org/copyleft/gpl.html.
31 ** Alternatively, this file may be used in accordance with the terms and
32 ** conditions contained in a signed written agreement between you and Nokia.
40 ****************************************************************************/
45 #include <QtCore/qiterator.h>
46 #include <QtCore/qatomic.h>
47 #include <QtCore/qalgorithms.h>
48 #include <QtCore/qlist.h>
56 #ifdef Q_COMPILER_INITIALIZER_LISTS
57 #include <initializer_list>
66 struct Q_CORE_EXPORT QVectorData
71 #if defined(QT_ARCH_SPARC) && defined(Q_CC_GNU) && defined(__LP64__) && defined(QT_BOOTSTRAPPED)
72 // workaround for bug in gcc 3.4.2
82 static QVectorData shared_null;
83 // ### Qt 5: rename to 'allocate()'. The current name causes problems for
84 // some debugges when the QVector is member of a class within an unnamed namespace.
85 // ### Qt 5: can be removed completely. (Ralf)
86 static QVectorData *malloc(int sizeofTypedData, int size, int sizeofT, QVectorData *init);
87 static QVectorData *allocate(int size, int alignment);
88 static QVectorData *reallocate(QVectorData *old, int newsize, int oldsize, int alignment);
89 static void free(QVectorData *data, int alignment);
90 static int grow(int sizeofTypedData, int size, int sizeofT, bool excessive);
94 struct QVectorTypedData : private QVectorData
95 { // private inheritance as we must not access QVectorData member thought QVectorTypedData
96 // as this would break strict aliasing rules. (in the case of shared_null)
99 static inline void free(QVectorTypedData<T> *x, int alignment) { QVectorData::free(static_cast<QVectorData *>(x), alignment); }
104 template <typename T>
107 typedef QVectorTypedData<T> Data;
110 #if defined(Q_CC_SUN) && (__SUNPRO_CC <= 0x550)
111 QVectorTypedData<T> *p;
118 // ### Qt 5: Consider making QVector non-shared to get at least one
119 // "really fast" container. See tests/benchmarks/corelib/tools/qvector/
120 inline QVector() : d(&QVectorData::shared_null) { d->ref.ref(); }
121 explicit QVector(int size);
122 QVector(int size, const T &t);
123 inline QVector(const QVector<T> &v) : d(v.d) { d->ref.ref(); if (!d->sharable) detach_helper(); }
124 inline ~QVector() { if (!d) return; if (!d->ref.deref()) free(p); }
125 QVector<T> &operator=(const QVector<T> &v);
126 #ifdef Q_COMPILER_RVALUE_REFS
127 inline QVector<T> operator=(QVector<T> &&other)
128 { qSwap(p, other.p); return *this; }
130 inline void swap(QVector<T> &other) { qSwap(d, other.d); }
131 #ifdef Q_COMPILER_INITIALIZER_LISTS
132 inline QVector(std::initializer_list<T> args);
134 bool operator==(const QVector<T> &v) const;
135 inline bool operator!=(const QVector<T> &v) const { return !(*this == v); }
137 inline int size() const { return d->size; }
139 inline bool isEmpty() const { return d->size == 0; }
141 void resize(int size);
143 inline int capacity() const { return d->alloc; }
144 void reserve(int size);
145 inline void squeeze() { realloc(d->size, d->size); d->capacity = 0; }
147 inline void detach() { if (d->ref != 1) detach_helper(); }
148 inline bool isDetached() const { return d->ref == 1; }
149 inline void setSharable(bool sharable) { if (!sharable) detach(); d->sharable = sharable; }
150 inline bool isSharedWith(const QVector<T> &other) const { return d == other.d; }
152 inline T *data() { detach(); return p->array; }
153 inline const T *data() const { return p->array; }
154 inline const T *constData() const { return p->array; }
157 const T &at(int i) const;
158 T &operator[](int i);
159 const T &operator[](int i) const;
160 void append(const T &t);
161 void prepend(const T &t);
162 void insert(int i, const T &t);
163 void insert(int i, int n, const T &t);
164 void replace(int i, const T &t);
166 void remove(int i, int n);
168 QVector<T> &fill(const T &t, int size = -1);
170 int indexOf(const T &t, int from = 0) const;
171 int lastIndexOf(const T &t, int from = -1) const;
172 bool contains(const T &t) const;
173 int count(const T &t) const;
175 #ifdef QT_STRICT_ITERATORS
179 typedef std::random_access_iterator_tag iterator_category;
180 typedef qptrdiff difference_type;
181 typedef T value_type;
183 typedef T &reference;
185 inline iterator() : i(0) {}
186 inline iterator(T *n) : i(n) {}
187 inline iterator(const iterator &o): i(o.i){}
188 inline T &operator*() const { return *i; }
189 inline T *operator->() const { return i; }
190 inline T &operator[](int j) const { return *(i + j); }
191 inline bool operator==(const iterator &o) const { return i == o.i; }
192 inline bool operator!=(const iterator &o) const { return i != o.i; }
193 inline bool operator<(const iterator& other) const { return i < other.i; }
194 inline bool operator<=(const iterator& other) const { return i <= other.i; }
195 inline bool operator>(const iterator& other) const { return i > other.i; }
196 inline bool operator>=(const iterator& other) const { return i >= other.i; }
197 inline iterator &operator++() { ++i; return *this; }
198 inline iterator operator++(int) { T *n = i; ++i; return n; }
199 inline iterator &operator--() { i--; return *this; }
200 inline iterator operator--(int) { T *n = i; i--; return n; }
201 inline iterator &operator+=(int j) { i+=j; return *this; }
202 inline iterator &operator-=(int j) { i-=j; return *this; }
203 inline iterator operator+(int j) const { return iterator(i+j); }
204 inline iterator operator-(int j) const { return iterator(i-j); }
205 inline int operator-(iterator j) const { return i - j.i; }
207 friend class iterator;
209 class const_iterator {
212 typedef std::random_access_iterator_tag iterator_category;
213 typedef qptrdiff difference_type;
214 typedef T value_type;
215 typedef const T *pointer;
216 typedef const T &reference;
218 inline const_iterator() : i(0) {}
219 inline const_iterator(T *n) : i(n) {}
220 inline const_iterator(const const_iterator &o): i(o.i) {}
221 inline explicit const_iterator(const iterator &o): i(o.i) {}
222 inline const T &operator*() const { return *i; }
223 inline const T *operator->() const { return i; }
224 inline const T &operator[](int j) const { return *(i + j); }
225 inline bool operator==(const const_iterator &o) const { return i == o.i; }
226 inline bool operator!=(const const_iterator &o) const { return i != o.i; }
227 inline bool operator<(const const_iterator& other) const { return i < other.i; }
228 inline bool operator<=(const const_iterator& other) const { return i <= other.i; }
229 inline bool operator>(const const_iterator& other) const { return i > other.i; }
230 inline bool operator>=(const const_iterator& other) const { return i >= other.i; }
231 inline const_iterator &operator++() { ++i; return *this; }
232 inline const_iterator operator++(int) { T *n = i; ++i; return n; }
233 inline const_iterator &operator--() { i--; return *this; }
234 inline const_iterator operator--(int) { T *n = i; i--; return n; }
235 inline const_iterator &operator+=(int j) { i+=j; return *this; }
236 inline const_iterator &operator-=(int j) { i-=j; return *this; }
237 inline const_iterator operator+(int j) const { return const_iterator(i+j); }
238 inline const_iterator operator-(int j) const { return const_iterator(i-j); }
239 inline int operator-(const_iterator j) const { return i - j.i; }
241 friend class const_iterator;
245 typedef const T* const_iterator;
247 inline iterator begin() { detach(); return p->array; }
248 inline const_iterator begin() const { return p->array; }
249 inline const_iterator constBegin() const { return p->array; }
250 inline iterator end() { detach(); return p->array + d->size; }
251 inline const_iterator end() const { return p->array + d->size; }
252 inline const_iterator constEnd() const { return p->array + d->size; }
253 iterator insert(iterator before, int n, const T &x);
254 inline iterator insert(iterator before, const T &x) { return insert(before, 1, x); }
255 iterator erase(iterator begin, iterator end);
256 inline iterator erase(iterator pos) { return erase(pos, pos+1); }
259 inline int count() const { return d->size; }
260 inline T& first() { Q_ASSERT(!isEmpty()); return *begin(); }
261 inline const T &first() const { Q_ASSERT(!isEmpty()); return *begin(); }
262 inline T& last() { Q_ASSERT(!isEmpty()); return *(end()-1); }
263 inline const T &last() const { Q_ASSERT(!isEmpty()); return *(end()-1); }
264 inline bool startsWith(const T &t) const { return !isEmpty() && first() == t; }
265 inline bool endsWith(const T &t) const { return !isEmpty() && last() == t; }
266 QVector<T> mid(int pos, int length = -1) const;
268 T value(int i) const;
269 T value(int i, const T &defaultValue) const;
272 typedef T value_type;
273 typedef value_type* pointer;
274 typedef const value_type* const_pointer;
275 typedef value_type& reference;
276 typedef const value_type& const_reference;
277 typedef qptrdiff difference_type;
278 typedef iterator Iterator;
279 typedef const_iterator ConstIterator;
280 typedef int size_type;
281 inline void push_back(const T &t) { append(t); }
282 inline void push_front(const T &t) { prepend(t); }
283 void pop_back() { Q_ASSERT(!isEmpty()); erase(end()-1); }
284 void pop_front() { Q_ASSERT(!isEmpty()); erase(begin()); }
285 inline bool empty() const
286 { return d->size == 0; }
287 inline T& front() { return first(); }
288 inline const_reference front() const { return first(); }
289 inline reference back() { return last(); }
290 inline const_reference back() const { return last(); }
293 QVector<T> &operator+=(const QVector<T> &l);
294 inline QVector<T> operator+(const QVector<T> &l) const
295 { QVector n = *this; n += l; return n; }
296 inline QVector<T> &operator+=(const T &t)
297 { append(t); return *this; }
298 inline QVector<T> &operator<< (const T &t)
299 { append(t); return *this; }
300 inline QVector<T> &operator<<(const QVector<T> &l)
301 { *this += l; return *this; }
303 QList<T> toList() const;
305 static QVector<T> fromList(const QList<T> &list);
308 static inline QVector<T> fromStdVector(const std::vector<T> &vector)
309 { QVector<T> tmp; tmp.reserve(int(vector.size())); qCopy(vector.begin(), vector.end(), std::back_inserter(tmp)); return tmp; }
310 inline std::vector<T> toStdVector() const
311 { std::vector<T> tmp; tmp.reserve(size()); qCopy(constBegin(), constEnd(), std::back_inserter(tmp)); return tmp; }
314 friend class QRegion; // Optimization for QRegion::rects()
316 void detach_helper();
317 QVectorData *malloc(int alloc);
318 void realloc(int size, int alloc);
320 int sizeOfTypedData() {
321 // this is more or less the same as sizeof(Data), except that it doesn't
322 // count the padding at the end
323 return reinterpret_cast<const char *>(&(reinterpret_cast<const Data *>(this))->array[1]) - reinterpret_cast<const char *>(this);
325 inline int alignOfTypedData() const
328 return qMax<int>(sizeof(void*), Q_ALIGNOF(Data));
335 template <typename T>
336 void QVector<T>::detach_helper()
337 { realloc(d->size, d->alloc); }
338 template <typename T>
339 void QVector<T>::reserve(int asize)
340 { if (asize > d->alloc) realloc(d->size, asize); if (d->ref == 1) d->capacity = 1; }
341 template <typename T>
342 void QVector<T>::resize(int asize)
343 { realloc(asize, (asize > d->alloc || (!d->capacity && asize < d->size && asize < (d->alloc >> 1))) ?
344 QVectorData::grow(sizeOfTypedData(), asize, sizeof(T), QTypeInfo<T>::isStatic)
346 template <typename T>
347 inline void QVector<T>::clear()
348 { *this = QVector<T>(); }
349 template <typename T>
350 inline const T &QVector<T>::at(int i) const
351 { Q_ASSERT_X(i >= 0 && i < d->size, "QVector<T>::at", "index out of range");
352 return p->array[i]; }
353 template <typename T>
354 inline const T &QVector<T>::operator[](int i) const
355 { Q_ASSERT_X(i >= 0 && i < d->size, "QVector<T>::operator[]", "index out of range");
356 return p->array[i]; }
357 template <typename T>
358 inline T &QVector<T>::operator[](int i)
359 { Q_ASSERT_X(i >= 0 && i < d->size, "QVector<T>::operator[]", "index out of range");
361 template <typename T>
362 inline void QVector<T>::insert(int i, const T &t)
363 { Q_ASSERT_X(i >= 0 && i <= d->size, "QVector<T>::insert", "index out of range");
364 insert(begin() + i, 1, t); }
365 template <typename T>
366 inline void QVector<T>::insert(int i, int n, const T &t)
367 { Q_ASSERT_X(i >= 0 && i <= d->size, "QVector<T>::insert", "index out of range");
368 insert(begin() + i, n, t); }
369 template <typename T>
370 inline void QVector<T>::remove(int i, int n)
371 { Q_ASSERT_X(i >= 0 && n >= 0 && i + n <= d->size, "QVector<T>::remove", "index out of range");
372 erase(begin() + i, begin() + i + n); }
373 template <typename T>
374 inline void QVector<T>::remove(int i)
375 { Q_ASSERT_X(i >= 0 && i < d->size, "QVector<T>::remove", "index out of range");
376 erase(begin() + i, begin() + i + 1); }
377 template <typename T>
378 inline void QVector<T>::prepend(const T &t)
379 { insert(begin(), 1, t); }
381 template <typename T>
382 inline void QVector<T>::replace(int i, const T &t)
384 Q_ASSERT_X(i >= 0 && i < d->size, "QVector<T>::replace", "index out of range");
389 template <typename T>
390 QVector<T> &QVector<T>::operator=(const QVector<T> &v)
392 QVectorData *o = v.d;
402 template <typename T>
403 inline QVectorData *QVector<T>::malloc(int aalloc)
405 QVectorData *vectordata = QVectorData::allocate(sizeOfTypedData() + (aalloc - 1) * sizeof(T), alignOfTypedData());
406 Q_CHECK_PTR(vectordata);
410 template <typename T>
411 QVector<T>::QVector(int asize)
415 d->alloc = d->size = asize;
418 if (QTypeInfo<T>::isComplex) {
420 T* i = p->array + d->size;
424 qMemSet(p->array, 0, asize * sizeof(T));
428 template <typename T>
429 QVector<T>::QVector(int asize, const T &t)
433 d->alloc = d->size = asize;
436 T* i = p->array + d->size;
437 while (i != p->array)
441 #ifdef Q_COMPILER_INITIALIZER_LISTS
442 template <typename T>
443 QVector<T>::QVector(std::initializer_list<T> args)
445 d = malloc(int(args.size()));
447 d->alloc = d->size = int(args.size());
450 T* i = p->array + d->size;
451 auto it = args.end();
452 while (i != p->array)
453 new (--i) T(*(--it));
457 template <typename T>
458 void QVector<T>::free(Data *x)
460 if (QTypeInfo<T>::isComplex) {
462 union { QVectorData *d; Data *p; } u;
464 T* i = b + u.d->size;
468 x->free(x, alignOfTypedData());
471 template <typename T>
472 void QVector<T>::realloc(int asize, int aalloc)
474 Q_ASSERT(asize <= aalloc);
477 union { QVectorData *d; Data *p; } x;
480 if (QTypeInfo<T>::isComplex && asize < d->size && d->ref == 1 ) {
481 // call the destructor on all objects that need to be
482 // destroyed when shrinking
483 pOld = p->array + d->size;
484 pNew = p->array + asize;
485 while (asize < d->size) {
491 if (aalloc != d->alloc || d->ref != 1) {
492 // (re)allocate memory
493 if (QTypeInfo<T>::isStatic) {
494 x.d = malloc(aalloc);
497 } else if (d->ref != 1) {
498 x.d = malloc(aalloc);
500 if (QTypeInfo<T>::isComplex) {
503 ::memcpy(x.p, p, sizeOfTypedData() + (qMin(aalloc, d->alloc) - 1) * sizeof(T));
508 QVectorData *mem = QVectorData::reallocate(d, sizeOfTypedData() + (aalloc - 1) * sizeof(T),
509 sizeOfTypedData() + (d->alloc - 1) * sizeof(T), alignOfTypedData());
513 } QT_CATCH (const std::bad_alloc &) {
514 if (aalloc > d->alloc) // ignore the error in case we are just shrinking.
520 x.d->sharable = true;
521 x.d->capacity = d->capacity;
525 if (QTypeInfo<T>::isComplex) {
527 pOld = p->array + x.d->size;
528 pNew = x.p->array + x.d->size;
529 // copy objects from the old array into the new array
530 const int toMove = qMin(asize, d->size);
531 while (x.d->size < toMove) {
532 new (pNew++) T(*pOld++);
535 // construct all new objects when growing
536 while (x.d->size < asize) {
545 } else if (asize > x.d->size) {
546 // initialize newly allocated memory to 0
547 qMemSet(x.p->array + x.d->size, 0, (asize - x.d->size) * sizeof(T));
559 Q_OUTOFLINE_TEMPLATE T QVector<T>::value(int i) const
561 if (i < 0 || i >= d->size) {
567 Q_OUTOFLINE_TEMPLATE T QVector<T>::value(int i, const T &defaultValue) const
569 return ((i < 0 || i >= d->size) ? defaultValue : p->array[i]);
572 template <typename T>
573 void QVector<T>::append(const T &t)
575 if (d->ref != 1 || d->size + 1 > d->alloc) {
577 realloc(d->size, (d->size + 1 > d->alloc) ?
578 QVectorData::grow(sizeOfTypedData(), d->size + 1, sizeof(T), QTypeInfo<T>::isStatic)
580 if (QTypeInfo<T>::isComplex)
581 new (p->array + d->size) T(copy);
583 p->array[d->size] = copy;
585 if (QTypeInfo<T>::isComplex)
586 new (p->array + d->size) T(t);
588 p->array[d->size] = t;
593 template <typename T>
594 Q_TYPENAME QVector<T>::iterator QVector<T>::insert(iterator before, size_type n, const T &t)
596 int offset = int(before - p->array);
599 if (d->ref != 1 || d->size + n > d->alloc)
600 realloc(d->size, QVectorData::grow(sizeOfTypedData(), d->size + n, sizeof(T),
601 QTypeInfo<T>::isStatic));
602 if (QTypeInfo<T>::isStatic) {
603 T *b = p->array + d->size;
604 T *i = p->array + d->size + n;
607 i = p->array + d->size;
609 b = p->array + offset;
616 T *b = p->array + offset;
618 memmove(i, b, (d->size - offset) * sizeof(T));
624 return p->array + offset;
627 template <typename T>
628 Q_TYPENAME QVector<T>::iterator QVector<T>::erase(iterator abegin, iterator aend)
630 int f = int(abegin - p->array);
631 int l = int(aend - p->array);
634 if (QTypeInfo<T>::isComplex) {
635 qCopy(p->array+l, p->array+d->size, p->array+f);
636 T *i = p->array+d->size;
637 T* b = p->array+d->size-n;
643 memmove(p->array + f, p->array + l, (d->size-l)*sizeof(T));
649 template <typename T>
650 bool QVector<T>::operator==(const QVector<T> &v) const
652 if (d->size != v.d->size)
658 T* j = v.p->array + d->size;
665 template <typename T>
666 QVector<T> &QVector<T>::fill(const T &from, int asize)
669 resize(asize < 0 ? d->size : asize);
671 T *i = p->array + d->size;
679 template <typename T>
680 QVector<T> &QVector<T>::operator+=(const QVector &l)
682 int newSize = d->size + l.d->size;
683 realloc(d->size, newSize);
685 T *w = p->array + newSize;
686 T *i = l.p->array + l.d->size;
689 if (QTypeInfo<T>::isComplex)
698 template <typename T>
699 int QVector<T>::indexOf(const T &t, int from) const
702 from = qMax(from + d->size, 0);
703 if (from < d->size) {
704 T* n = p->array + from - 1;
705 T* e = p->array + d->size;
713 template <typename T>
714 int QVector<T>::lastIndexOf(const T &t, int from) const
718 else if (from >= d->size)
722 T* n = p->array + from + 1;
731 template <typename T>
732 bool QVector<T>::contains(const T &t) const
735 T* i = p->array + d->size;
742 template <typename T>
743 int QVector<T>::count(const T &t) const
747 T* i = p->array + d->size;
754 template <typename T>
755 Q_OUTOFLINE_TEMPLATE QVector<T> QVector<T>::mid(int pos, int length) const
758 length = size() - pos;
759 if (pos == 0 && length == size())
761 if (pos + length > size())
762 length = size() - pos;
764 copy.reserve(length);
765 for (int i = pos; i < pos + length; ++i)
770 template <typename T>
771 Q_OUTOFLINE_TEMPLATE QList<T> QVector<T>::toList() const
774 result.reserve(size());
775 for (int i = 0; i < size(); ++i)
776 result.append(at(i));
780 template <typename T>
781 Q_OUTOFLINE_TEMPLATE QVector<T> QList<T>::toVector() const
783 QVector<T> result(size());
784 for (int i = 0; i < size(); ++i)
789 template <typename T>
790 QVector<T> QVector<T>::fromList(const QList<T> &list)
792 return list.toVector();
795 template <typename T>
796 QList<T> QList<T>::fromVector(const QVector<T> &vector)
798 return vector.toList();
801 Q_DECLARE_SEQUENTIAL_ITERATOR(Vector)
802 Q_DECLARE_MUTABLE_SEQUENTIAL_ITERATOR(Vector)
806 ### This needs to be removed for next releases of Qt. It is a workaround for vc++ because
807 ### Qt exports QPolygon and QPolygonF that inherit QVector<QPoint> and
808 ### QVector<QPointF> respectively.
812 QT_BEGIN_INCLUDE_NAMESPACE
813 #include <QtCore/QPointF>
814 #include <QtCore/QPoint>
815 QT_END_INCLUDE_NAMESPACE
817 #if defined(QT_BUILD_CORE_LIB)
818 #define Q_TEMPLATE_EXTERN
820 #define Q_TEMPLATE_EXTERN extern
822 Q_TEMPLATE_EXTERN template class Q_CORE_EXPORT QVector<QPointF>;
823 Q_TEMPLATE_EXTERN template class Q_CORE_EXPORT QVector<QPoint>;