/**************************************************************************** ** ** Copyright (C) 2016 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the QtCore module of the Qt Toolkit. ** ** $QT_BEGIN_LICENSE:LGPL$ ** Commercial License Usage ** Licensees holding valid commercial Qt licenses may use this file in ** accordance with the commercial license agreement provided with the ** Software or, alternatively, in accordance with the terms contained in ** a written agreement between you and The Qt Company. For licensing terms ** and conditions see https://www.qt.io/terms-conditions. For further ** information use the contact form at https://www.qt.io/contact-us. ** ** GNU Lesser General Public License Usage ** Alternatively, this file may be used under the terms of the GNU Lesser ** General Public License version 3 as published by the Free Software ** Foundation and appearing in the file LICENSE.LGPL3 included in the ** packaging of this file. Please review the following information to ** ensure the GNU Lesser General Public License version 3 requirements ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. ** ** GNU General Public License Usage ** Alternatively, this file may be used under the terms of the GNU ** General Public License version 2.0 or (at your option) the GNU General ** Public license version 3 or any later version approved by the KDE Free ** Qt Foundation. The licenses are as published by the Free Software ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 ** included in the packaging of this file. Please review the following ** information to ensure the GNU General Public License requirements will ** be met: https://www.gnu.org/licenses/gpl-2.0.html and ** https://www.gnu.org/licenses/gpl-3.0.html. ** ** $QT_END_LICENSE$ ** ****************************************************************************/ #ifndef QVARLENGTHARRAY_H #define QVARLENGTHARRAY_H #include #include #include #include #include #include #include #include #include #include #include QT_BEGIN_NAMESPACE // Prealloc = 256 by default, specified in qcontainerfwd.h template class QVarLengthArray { static_assert(std::is_nothrow_destructible_v, "Types with throwing destructors are not supported in Qt containers."); public: QVarLengthArray() : QVarLengthArray(0) {} inline explicit QVarLengthArray(qsizetype size); inline QVarLengthArray(const QVarLengthArray &other) : a(Prealloc), s(0), ptr(reinterpret_cast(array)) { append(other.constData(), other.size()); } QVarLengthArray(QVarLengthArray &&other) noexcept(std::is_nothrow_move_constructible_v) : a{other.a}, s{other.s}, ptr{other.ptr} { const auto otherInlineStorage = reinterpret_cast(other.array); if (ptr == otherInlineStorage) { // inline buffer - move into our inline buffer: ptr = reinterpret_cast(array); QtPrivate::q_uninitialized_relocate_n(otherInlineStorage, s, ptr); } else { // heap buffer - we just stole the memory } // reset other to internal storage: other.a = Prealloc; other.s = 0; other.ptr = otherInlineStorage; } QVarLengthArray(std::initializer_list args) : QVarLengthArray(args.begin(), args.end()) { } template = true> inline QVarLengthArray(InputIterator first, InputIterator last) : QVarLengthArray() { QtPrivate::reserveIfForwardIterator(this, first, last); std::copy(first, last, std::back_inserter(*this)); } inline ~QVarLengthArray() { if (QTypeInfo::isComplex) { T *i = ptr + s; while (i-- != ptr) i->~T(); } if (ptr != reinterpret_cast(array)) free(ptr); } inline QVarLengthArray &operator=(const QVarLengthArray &other) { if (this != &other) { clear(); append(other.constData(), other.size()); } return *this; } QVarLengthArray &operator=(QVarLengthArray &&other) noexcept(std::is_nothrow_move_constructible_v) { // we're only required to be self-move-assignment-safe // when we're in the moved-from state (Hinnant criterion) // the moved-from state is the empty state, so we're good with the clear() here: clear(); Q_ASSERT(capacity() >= Prealloc); const auto otherInlineStorage = reinterpret_cast(other.array); if (other.ptr != otherInlineStorage) { // heap storage: steal the external buffer, reset other to otherInlineStorage a = std::exchange(other.a, Prealloc); ptr = std::exchange(other.ptr, otherInlineStorage); } else { // inline storage: move into our storage (doesn't matter whether inline or external) QtPrivate::q_uninitialized_relocate_n(other.ptr, other.s, ptr); } s = std::exchange(other.s, 0); return *this; } QVarLengthArray &operator=(std::initializer_list list) { resize(qsizetype(list.size())); std::copy(list.begin(), list.end(), QT_MAKE_CHECKED_ARRAY_ITERATOR(this->begin(), this->size())); return *this; } inline void removeLast() { Q_ASSERT(s > 0); if (QTypeInfo::isComplex) ptr[s - 1].~T(); --s; } inline qsizetype size() const { return s; } inline qsizetype count() const { return s; } inline qsizetype length() const { return s; } inline T &first() { Q_ASSERT(!isEmpty()); return *begin(); } inline const T &first() const { Q_ASSERT(!isEmpty()); return *begin(); } T &last() { Q_ASSERT(!isEmpty()); return *(end() - 1); } const T &last() const { Q_ASSERT(!isEmpty()); return *(end() - 1); } inline bool isEmpty() const { return (s == 0); } inline void resize(qsizetype size); inline void clear() { resize(0); } inline void squeeze(); inline qsizetype capacity() const { return a; } inline void reserve(qsizetype size); template inline qsizetype indexOf(const AT &t, qsizetype from = 0) const; template inline qsizetype lastIndexOf(const AT &t, qsizetype from = -1) const; template inline bool contains(const AT &t) const; inline T &operator[](qsizetype idx) { Q_ASSERT(idx >= 0 && idx < s); return ptr[idx]; } inline const T &operator[](qsizetype idx) const { Q_ASSERT(idx >= 0 && idx < s); return ptr[idx]; } inline const T &at(qsizetype idx) const { return operator[](idx); } T value(qsizetype i) const; T value(qsizetype i, const T &defaultValue) const; inline void append(const T &t) { if (s == a) { // i.e. s != 0 T copy(t); reallocate(s, s << 1); const qsizetype idx = s++; new (ptr + idx) T(std::move(copy)); } else { const qsizetype idx = s++; new (ptr + idx) T(t); } } void append(T &&t) { if (s == a) reallocate(s, s << 1); const qsizetype idx = s++; new (ptr + idx) T(std::move(t)); } void append(const T *buf, qsizetype size); inline QVarLengthArray &operator<<(const T &t) { append(t); return *this; } inline QVarLengthArray &operator<<(T &&t) { append(std::move(t)); return *this; } inline QVarLengthArray &operator+=(const T &t) { append(t); return *this; } inline QVarLengthArray &operator+=(T &&t) { append(std::move(t)); return *this; } void prepend(T &&t); void prepend(const T &t); void insert(qsizetype i, T &&t); void insert(qsizetype i, const T &t); void insert(qsizetype i, qsizetype n, const T &t); void replace(qsizetype i, const T &t); void remove(qsizetype i); void remove(qsizetype i, qsizetype n); inline T *data() { return ptr; } inline const T *data() const { return ptr; } inline const T *constData() const { return ptr; } typedef qsizetype size_type; typedef T value_type; typedef value_type *pointer; typedef const value_type *const_pointer; typedef value_type &reference; typedef const value_type &const_reference; typedef qptrdiff difference_type; typedef T *iterator; typedef const T *const_iterator; typedef std::reverse_iterator reverse_iterator; typedef std::reverse_iterator const_reverse_iterator; inline iterator begin() { return ptr; } inline const_iterator begin() const { return ptr; } inline const_iterator cbegin() const { return ptr; } inline const_iterator constBegin() const { return ptr; } inline iterator end() { return ptr + s; } inline const_iterator end() const { return ptr + s; } inline const_iterator cend() const { return ptr + s; } inline const_iterator constEnd() const { return ptr + s; } reverse_iterator rbegin() { return reverse_iterator(end()); } reverse_iterator rend() { return reverse_iterator(begin()); } const_reverse_iterator rbegin() const { return const_reverse_iterator(end()); } const_reverse_iterator rend() const { return const_reverse_iterator(begin()); } const_reverse_iterator crbegin() const { return const_reverse_iterator(end()); } const_reverse_iterator crend() const { return const_reverse_iterator(begin()); } iterator insert(const_iterator before, qsizetype n, const T &x); iterator insert(const_iterator before, T &&x); inline iterator insert(const_iterator before, const T &x) { return insert(before, 1, x); } iterator erase(const_iterator begin, const_iterator end); inline iterator erase(const_iterator pos) { return erase(pos, pos + 1); } // STL compatibility: inline bool empty() const { return isEmpty(); } inline void push_back(const T &t) { append(t); } void push_back(T &&t) { append(std::move(t)); } inline void pop_back() { removeLast(); } inline T &front() { return first(); } inline const T &front() const { return first(); } inline T &back() { return last(); } inline const T &back() const { return last(); } void shrink_to_fit() { squeeze(); } #ifdef Q_QDOC template friend inline bool operator==(const QVarLengthArray &l, const QVarLengthArray &r); template friend inline bool operator!=(const QVarLengthArray &l, const QVarLengthArray &r); template friend inline bool operator< (const QVarLengthArray &l, const QVarLengthArray &r); template friend inline bool operator> (const QVarLengthArray &l, const QVarLengthArray &r); template friend inline bool operator<=(const QVarLengthArray &l, const QVarLengthArray &r); template friend inline bool operator>=(const QVarLengthArray &l, const QVarLengthArray &r); #else template friend QTypeTraits::compare_eq_result operator==(const QVarLengthArray &l, const QVarLengthArray &r) { if (l.size() != r.size()) return false; const T *rb = r.begin(); const T *b = l.begin(); const T *e = l.end(); return std::equal(b, e, QT_MAKE_CHECKED_ARRAY_ITERATOR(rb, r.size())); } template friend QTypeTraits::compare_eq_result operator!=(const QVarLengthArray &l, const QVarLengthArray &r) { return !(l == r); } template friend QTypeTraits::compare_lt_result operator<(const QVarLengthArray &lhs, const QVarLengthArray &rhs) noexcept(noexcept(std::lexicographical_compare(lhs.begin(), lhs.end(), rhs.begin(), rhs.end()))) { return std::lexicographical_compare(lhs.begin(), lhs.end(), rhs.begin(), rhs.end()); } template friend QTypeTraits::compare_lt_result operator>(const QVarLengthArray &lhs, const QVarLengthArray &rhs) noexcept(noexcept(lhs < rhs)) { return rhs < lhs; } template friend QTypeTraits::compare_lt_result operator<=(const QVarLengthArray &lhs, const QVarLengthArray &rhs) noexcept(noexcept(lhs < rhs)) { return !(lhs > rhs); } template friend QTypeTraits::compare_lt_result operator>=(const QVarLengthArray &lhs, const QVarLengthArray &rhs) noexcept(noexcept(lhs < rhs)) { return !(lhs < rhs); } #endif private: void reallocate(qsizetype size, qsizetype alloc); qsizetype a; // capacity qsizetype s; // size T *ptr; // data std::aligned_storage_t array[Prealloc]; bool isValidIterator(const const_iterator &i) const { const std::less less = {}; return !less(cend(), i) && !less(i, cbegin()); } }; #if defined(__cpp_deduction_guides) && __cpp_deduction_guides >= 201606 template ::value_type, QtPrivate::IfIsInputIterator = true> QVarLengthArray(InputIterator, InputIterator) -> QVarLengthArray; #endif template Q_INLINE_TEMPLATE QVarLengthArray::QVarLengthArray(qsizetype asize) : s(asize) { static_assert(Prealloc > 0, "QVarLengthArray Prealloc must be greater than 0."); Q_ASSERT_X(s >= 0, "QVarLengthArray::QVarLengthArray()", "Size must be greater than or equal to 0."); if (s > Prealloc) { ptr = reinterpret_cast(malloc(s * sizeof(T))); Q_CHECK_PTR(ptr); a = s; } else { ptr = reinterpret_cast(array); a = Prealloc; } if (QTypeInfo::isComplex) { T *i = ptr + s; while (i != ptr) new (--i) T; } } template Q_INLINE_TEMPLATE void QVarLengthArray::resize(qsizetype asize) { reallocate(asize, qMax(asize, a)); } template Q_INLINE_TEMPLATE void QVarLengthArray::reserve(qsizetype asize) { if (asize > a) reallocate(s, asize); } template template Q_INLINE_TEMPLATE qsizetype QVarLengthArray::indexOf(const AT &t, qsizetype from) const { if (from < 0) from = qMax(from + s, qsizetype(0)); if (from < s) { T *n = ptr + from - 1; T *e = ptr + s; while (++n != e) if (*n == t) return n - ptr; } return -1; } template template Q_INLINE_TEMPLATE qsizetype QVarLengthArray::lastIndexOf(const AT &t, qsizetype from) const { if (from < 0) from += s; else if (from >= s) from = s - 1; if (from >= 0) { T *b = ptr; T *n = ptr + from + 1; while (n != b) { if (*--n == t) return n - b; } } return -1; } template template Q_INLINE_TEMPLATE bool QVarLengthArray::contains(const AT &t) const { T *b = ptr; T *i = ptr + s; while (i != b) { if (*--i == t) return true; } return false; } template Q_OUTOFLINE_TEMPLATE void QVarLengthArray::append(const T *abuf, qsizetype increment) { Q_ASSERT(abuf); if (increment <= 0) return; const qsizetype asize = s + increment; if (asize >= a) reallocate(s, qMax(s * 2, asize)); if (QTypeInfo::isComplex) { // call constructor for new objects (which can throw) while (s < asize) new (ptr+(s++)) T(*abuf++); } else { memcpy(static_cast(&ptr[s]), static_cast(abuf), increment * sizeof(T)); s = asize; } } template Q_INLINE_TEMPLATE void QVarLengthArray::squeeze() { reallocate(s, s); } template Q_OUTOFLINE_TEMPLATE void QVarLengthArray::reallocate(qsizetype asize, qsizetype aalloc) { Q_ASSERT(aalloc >= asize); T *oldPtr = ptr; qsizetype osize = s; const qsizetype copySize = qMin(asize, osize); Q_ASSUME(copySize >= 0); if (aalloc != a) { if (aalloc > Prealloc) { T *newPtr = reinterpret_cast(malloc(aalloc * sizeof(T))); Q_CHECK_PTR(newPtr); // could throw // by design: in case of QT_NO_EXCEPTIONS malloc must not fail or it crashes here ptr = newPtr; a = aalloc; } else { ptr = reinterpret_cast(array); a = Prealloc; } s = 0; if (!QTypeInfo::isRelocatable) { QT_TRY { // move all the old elements while (s < copySize) { new (ptr+s) T(std::move(*(oldPtr+s))); (oldPtr+s)->~T(); s++; } } QT_CATCH(...) { // clean up all the old objects and then free the old ptr qsizetype sClean = s; while (sClean < osize) (oldPtr+(sClean++))->~T(); if (oldPtr != reinterpret_cast(array) && oldPtr != ptr) free(oldPtr); QT_RETHROW; } } else { memcpy(static_cast(ptr), static_cast(oldPtr), copySize * sizeof(T)); } } s = copySize; if (QTypeInfo::isComplex) { // destroy remaining old objects while (osize > asize) (oldPtr+(--osize))->~T(); } if (oldPtr != reinterpret_cast(array) && oldPtr != ptr) free(oldPtr); if (QTypeInfo::isComplex) { // call default constructor for new objects (which can throw) while (s < asize) new (ptr+(s++)) T; } else { s = asize; } } template Q_OUTOFLINE_TEMPLATE T QVarLengthArray::value(qsizetype i) const { if (size_t(i) >= size_t(size())) return T(); return at(i); } template Q_OUTOFLINE_TEMPLATE T QVarLengthArray::value(qsizetype i, const T &defaultValue) const { return (size_t(i) >= size_t(size())) ? defaultValue : at(i); } template inline void QVarLengthArray::insert(qsizetype i, T &&t) { Q_ASSERT_X(i >= 0 && i <= s, "QVarLengthArray::insert", "index out of range"); insert(cbegin() + i, std::move(t)); } template inline void QVarLengthArray::insert(qsizetype i, const T &t) { Q_ASSERT_X(i >= 0 && i <= s, "QVarLengthArray::insert", "index out of range"); insert(begin() + i, 1, t); } template inline void QVarLengthArray::insert(qsizetype i, qsizetype n, const T &t) { Q_ASSERT_X(i >= 0 && i <= s, "QVarLengthArray::insert", "index out of range"); insert(begin() + i, n, t); } template inline void QVarLengthArray::remove(qsizetype i, qsizetype n) { Q_ASSERT_X(i >= 0 && n >= 0 && i + n <= s, "QVarLengthArray::remove", "index out of range"); erase(begin() + i, begin() + i + n); } template inline void QVarLengthArray::remove(qsizetype i) { Q_ASSERT_X(i >= 0 && i < s, "QVarLengthArray::remove", "index out of range"); erase(begin() + i, begin() + i + 1); } template inline void QVarLengthArray::prepend(T &&t) { insert(cbegin(), std::move(t)); } template inline void QVarLengthArray::prepend(const T &t) { insert(begin(), 1, t); } template inline void QVarLengthArray::replace(qsizetype i, const T &t) { Q_ASSERT_X(i >= 0 && i < s, "QVarLengthArray::replace", "index out of range"); const T copy(t); data()[i] = copy; } template Q_OUTOFLINE_TEMPLATE typename QVarLengthArray::iterator QVarLengthArray::insert(const_iterator before, T &&t) { Q_ASSERT_X(isValidIterator(before), "QVarLengthArray::insert", "The specified const_iterator argument 'before' is invalid"); qsizetype offset = qsizetype(before - ptr); reserve(s + 1); if (!QTypeInfo::isRelocatable) { T *b = ptr + offset; T *i = ptr + s; T *j = i + 1; // The new end-element needs to be constructed, the rest must be move assigned if (i != b) { new (--j) T(std::move(*--i)); while (i != b) *--j = std::move(*--i); *b = std::move(t); } else { new (b) T(std::move(t)); } } else { T *b = ptr + offset; memmove(static_cast(b + 1), static_cast(b), (s - offset) * sizeof(T)); new (b) T(std::move(t)); } s += 1; return ptr + offset; } template Q_OUTOFLINE_TEMPLATE typename QVarLengthArray::iterator QVarLengthArray::insert(const_iterator before, size_type n, const T &t) { Q_ASSERT_X(isValidIterator(before), "QVarLengthArray::insert", "The specified const_iterator argument 'before' is invalid"); qsizetype offset = qsizetype(before - ptr); if (n != 0) { const T copy(t); // `t` could alias an element in [begin(), end()[ resize(s + n); if (!QTypeInfo::isRelocatable) { T *b = ptr + offset; T *j = ptr + s; T *i = j - n; while (i != b) *--j = *--i; i = b + n; while (i != b) *--i = copy; } else { T *b = ptr + offset; T *i = b + n; memmove(static_cast(i), static_cast(b), (s - offset - n) * sizeof(T)); while (i != b) new (--i) T(copy); } } return ptr + offset; } template Q_OUTOFLINE_TEMPLATE typename QVarLengthArray::iterator QVarLengthArray::erase(const_iterator abegin, const_iterator aend) { Q_ASSERT_X(isValidIterator(abegin), "QVarLengthArray::insert", "The specified const_iterator argument 'abegin' is invalid"); Q_ASSERT_X(isValidIterator(aend), "QVarLengthArray::insert", "The specified const_iterator argument 'aend' is invalid"); qsizetype f = qsizetype(abegin - ptr); qsizetype l = qsizetype(aend - ptr); qsizetype n = l - f; if (QTypeInfo::isComplex) { std::copy(ptr + l, ptr + s, QT_MAKE_CHECKED_ARRAY_ITERATOR(ptr + f, s - f)); T *i = ptr + s; T *b = ptr + s - n; while (i != b) { --i; i->~T(); } } else { memmove(static_cast(ptr + f), static_cast(ptr + l), (s - l) * sizeof(T)); } s -= n; return ptr + f; } #ifdef Q_QDOC // Fake definitions for qdoc, only the redeclaration is used. template bool operator==(const QVarLengthArray &l, const QVarLengthArray &r) { return bool{}; } template bool operator!=(const QVarLengthArray &l, const QVarLengthArray &r) { return bool{}; } template bool operator< (const QVarLengthArray &l, const QVarLengthArray &r) { return bool{}; } template bool operator> (const QVarLengthArray &l, const QVarLengthArray &r) { return bool{}; } template bool operator<=(const QVarLengthArray &l, const QVarLengthArray &r) { return bool{}; } template bool operator>=(const QVarLengthArray &l, const QVarLengthArray &r) { return bool{}; } #endif template size_t qHash(const QVarLengthArray &key, size_t seed = 0) noexcept(noexcept(qHashRange(key.cbegin(), key.cend(), seed))) { return qHashRange(key.cbegin(), key.cend(), seed); } QT_END_NAMESPACE #endif // QVARLENGTHARRAY_H