/* * Copyright (c) 2018-2020, Andreas Kling * Copyright (c) 2021, the SerenityOS developers. * * SPDX-License-Identifier: BSD-2-Clause */ #pragma once #include #include #include #include #include #include #include #include #include #include // NOTE: We can't include during the toolchain bootstrap, // since it's part of libstdc++, and libstdc++ depends on LibC. // For this reason, we don't support Vector(initializer_list) in LibC. #ifndef SERENITY_LIBC_BUILD # include #endif #ifndef __serenity__ # include #endif namespace AK { namespace Detail { template struct CanBePlacedInsideVectorHelper; template struct CanBePlacedInsideVectorHelper { template static constexpr bool value = requires(U&& u) { StorageType { &u }; }; }; template struct CanBePlacedInsideVectorHelper { template static constexpr bool value = requires(U&& u) { StorageType(forward(u)); }; }; } template requires(!IsRvalueReference) class Vector { private: static constexpr bool contains_reference = IsLvalueReference; using StorageType = Conditional>, T>; template static constexpr bool CanBePlacedInsideVector = Detail::CanBePlacedInsideVectorHelper::template value; public: using ValueType = T; Vector() : m_capacity(inline_capacity) { } #ifndef SERENITY_LIBC_BUILD Vector(std::initializer_list list) requires(!IsLvalueReference) { ensure_capacity(list.size()); for (auto& item : list) unchecked_append(item); } #endif Vector(Vector&& other) : m_size(other.m_size) , m_capacity(other.m_capacity) , m_outline_buffer(other.m_outline_buffer) { if constexpr (inline_capacity > 0) { if (!m_outline_buffer) { for (size_t i = 0; i < m_size; ++i) { new (&inline_buffer()[i]) StorageType(move(other.inline_buffer()[i])); other.inline_buffer()[i].~StorageType(); } } } other.m_outline_buffer = nullptr; other.m_size = 0; other.reset_capacity(); } Vector(Vector const& other) { ensure_capacity(other.size()); TypedTransfer::copy(data(), other.data(), other.size()); m_size = other.size(); } template Vector(Vector const& other) { ensure_capacity(other.size()); TypedTransfer::copy(data(), other.data(), other.size()); m_size = other.size(); } ~Vector() { clear(); } Span span() { return { data(), size() }; } Span span() const { return { data(), size() }; } operator Span() { return span(); } operator Span() const { return span(); } bool is_empty() const { return size() == 0; } ALWAYS_INLINE size_t size() const { return m_size; } size_t capacity() const { return m_capacity; } StorageType* data() { if constexpr (inline_capacity > 0) return m_outline_buffer ? m_outline_buffer : inline_buffer(); return m_outline_buffer; } StorageType const* data() const { if constexpr (inline_capacity > 0) return m_outline_buffer ? m_outline_buffer : inline_buffer(); return m_outline_buffer; } ALWAYS_INLINE T const& at(size_t i) const { VERIFY(i < m_size); if constexpr (contains_reference) return *data()[i]; else return data()[i]; } ALWAYS_INLINE T& at(size_t i) { VERIFY(i < m_size); if constexpr (contains_reference) return *data()[i]; else return data()[i]; } ALWAYS_INLINE T const& operator[](size_t i) const { return at(i); } ALWAYS_INLINE T& operator[](size_t i) { return at(i); } T const& first() const { return at(0); } T& first() { return at(0); } T const& last() const { return at(size() - 1); } T& last() { return at(size() - 1); } template Optional first_matching(Callback callback) { for (size_t i = 0; i < size(); ++i) { if (callback(at(i))) { return at(i); } } return {}; } template Optional last_matching(Callback callback) { for (ssize_t i = size() - 1; i >= 0; --i) { if (callback(at(i))) { return at(i); } } return {}; } template bool operator==(V const& other) const { if (m_size != other.size()) return false; return TypedTransfer::compare(data(), other.data(), size()); } bool contains_slow(T const& value) const { for (size_t i = 0; i < size(); ++i) { if (Traits::equals(at(i), value)) return true; } return false; } bool contains_in_range(T const& value, size_t const start, size_t const end) const { VERIFY(start <= end); VERIFY(end < size()); for (size_t i = start; i <= end; ++i) { if (Traits::equals(at(i), value)) return true; } return false; } template void insert(size_t index, U&& value) requires(CanBePlacedInsideVector) { auto did_allocate = try_insert(index, forward(value)); VERIFY(did_allocate); } template void insert_before_matching(U&& value, C callback, size_t first_index = 0, size_t* inserted_index = nullptr) requires(CanBePlacedInsideVector) { auto did_allocate = try_insert_before_matching(forward(value), callback, first_index, inserted_index); VERIFY(did_allocate); } void append(Vector&& other) { auto did_allocate = try_append(move(other)); VERIFY(did_allocate); } void append(Vector const& other) { auto did_allocate = try_append(other); VERIFY(did_allocate); } ALWAYS_INLINE void append(T&& value) { bool did_allocate; if constexpr (contains_reference) did_allocate = try_append(value); else did_allocate = try_append(move(value)); VERIFY(did_allocate); } ALWAYS_INLINE void append(T const& value) requires(!contains_reference) { auto did_allocate = try_append(T(value)); VERIFY(did_allocate); } void append(StorageType const* values, size_t count) { auto did_allocate = try_append(values, count); VERIFY(did_allocate); } template ALWAYS_INLINE void unchecked_append(U&& value) requires(CanBePlacedInsideVector) { VERIFY((size() + 1) <= capacity()); if constexpr (contains_reference) new (slot(m_size)) StorageType(&value); else new (slot(m_size)) StorageType(forward(value)); ++m_size; } template void empend(Args&&... args) requires(!contains_reference) { auto did_allocate = try_empend(forward(args)...); VERIFY(did_allocate); } template void prepend(U&& value) requires(CanBePlacedInsideVector) { auto did_allocate = try_insert(0, forward(value)); VERIFY(did_allocate); } void prepend(Vector&& other) { auto did_allocate = try_prepend(move(other)); VERIFY(did_allocate); } void prepend(StorageType const* values, size_t count) { auto did_allocate = try_prepend(values, count); VERIFY(did_allocate); } // FIXME: What about assigning from a vector with lower inline capacity? Vector& operator=(Vector&& other) { if (this != &other) { clear(); m_size = other.m_size; m_capacity = other.m_capacity; m_outline_buffer = other.m_outline_buffer; if constexpr (inline_capacity > 0) { if (!m_outline_buffer) { for (size_t i = 0; i < m_size; ++i) { new (&inline_buffer()[i]) StorageType(move(other.inline_buffer()[i])); other.inline_buffer()[i].~StorageType(); } } } other.m_outline_buffer = nullptr; other.m_size = 0; other.reset_capacity(); } return *this; } Vector& operator=(Vector const& other) { if (this != &other) { clear(); ensure_capacity(other.size()); TypedTransfer::copy(data(), other.data(), other.size()); m_size = other.size(); } return *this; } template Vector& operator=(Vector const& other) { clear(); ensure_capacity(other.size()); TypedTransfer::copy(data(), other.data(), other.size()); m_size = other.size(); return *this; } void clear() { clear_with_capacity(); if (m_outline_buffer) { kfree(m_outline_buffer); m_outline_buffer = nullptr; } reset_capacity(); } void clear_with_capacity() { for (size_t i = 0; i < m_size; ++i) data()[i].~StorageType(); m_size = 0; } void remove(size_t index) { VERIFY(index < m_size); if constexpr (Traits::is_trivial()) { TypedTransfer::copy(slot(index), slot(index + 1), m_size - index - 1); } else { at(index).~StorageType(); for (size_t i = index + 1; i < m_size; ++i) { new (slot(i - 1)) StorageType(move(at(i))); at(i).~StorageType(); } } --m_size; } void remove(size_t index, size_t count) { if (count == 0) return; VERIFY(index + count > index); VERIFY(index + count <= m_size); if constexpr (Traits::is_trivial()) { TypedTransfer::copy(slot(index), slot(index + count), m_size - index - count); } else { for (size_t i = index; i < index + count; i++) at(i).~StorageType(); for (size_t i = index + count; i < m_size; ++i) { new (slot(i - count)) StorageType(move(at(i))); at(i).~StorageType(); } } m_size -= count; } template bool remove_first_matching(Callback callback) { for (size_t i = 0; i < size(); ++i) { if (callback(at(i))) { remove(i); return true; } } return false; } template void remove_all_matching(Callback callback) { for (size_t i = 0; i < size();) { if (callback(at(i))) { remove(i); } else { ++i; } } } T take_last() { VERIFY(!is_empty()); auto value = move(raw_last()); if constexpr (!contains_reference) last().~T(); --m_size; if constexpr (contains_reference) return *value; else return value; } T take_first() { VERIFY(!is_empty()); auto value = move(raw_first()); remove(0); if constexpr (contains_reference) return *value; else return value; } T take(size_t index) { auto value = move(raw_at(index)); remove(index); if constexpr (contains_reference) return *value; else return value; } T unstable_take(size_t index) { VERIFY(index < m_size); swap(raw_at(index), raw_at(m_size - 1)); return take_last(); } template [[nodiscard]] bool try_insert(size_t index, U&& value) requires(CanBePlacedInsideVector) { if (index > size()) return false; if (index == size()) return try_append(forward(value)); if (!try_grow_capacity(size() + 1)) return false; ++m_size; if constexpr (Traits::is_trivial()) { TypedTransfer::move(slot(index + 1), slot(index), m_size - index - 1); } else { for (size_t i = size() - 1; i > index; --i) { new (slot(i)) StorageType(move(at(i - 1))); at(i - 1).~StorageType(); } } if constexpr (contains_reference) new (slot(index)) StorageType(&value); else new (slot(index)) StorageType(forward(value)); return true; } template [[nodiscard]] bool try_insert_before_matching(U&& value, C callback, size_t first_index = 0, size_t* inserted_index = nullptr) requires(CanBePlacedInsideVector) { for (size_t i = first_index; i < size(); ++i) { if (callback(at(i))) { if (!try_insert(i, forward(value))) return false; if (inserted_index) *inserted_index = i; return true; } } if (!try_append(forward(value))) return false; if (inserted_index) *inserted_index = size() - 1; return true; } [[nodiscard]] bool try_append(Vector&& other) { if (is_empty()) { *this = move(other); return true; } auto other_size = other.size(); Vector tmp = move(other); if (!try_grow_capacity(size() + other_size)) return false; TypedTransfer::move(data() + m_size, tmp.data(), other_size); m_size += other_size; return true; } [[nodiscard]] bool try_append(Vector const& other) { if (!try_grow_capacity(size() + other.size())) return false; TypedTransfer::copy(data() + m_size, other.data(), other.size()); m_size += other.m_size; return true; } [[nodiscard]] ALWAYS_INLINE bool try_append(T&& value) { if (!try_grow_capacity(size() + 1)) return false; if constexpr (contains_reference) new (slot(m_size)) StorageType(&value); else new (slot(m_size)) StorageType(move(value)); ++m_size; return true; } [[nodiscard]] ALWAYS_INLINE bool try_append(T const& value) requires(!contains_reference) { return try_append(T(value)); } [[nodiscard]] bool try_append(StorageType const* values, size_t count) { if (!count) return true; if (!try_grow_capacity(size() + count)) return false; TypedTransfer::copy(slot(m_size), values, count); m_size += count; return true; } template [[nodiscard]] bool try_empend(Args&&... args) requires(!contains_reference) { if (!try_grow_capacity(m_size + 1)) return false; new (slot(m_size)) StorageType { forward(args)... }; ++m_size; return true; } template [[nodiscard]] bool try_prepend(U&& value) requires(CanBePlacedInsideVector) { return try_insert(0, forward(value)); } [[nodiscard]] bool try_prepend(Vector&& other) { if (other.is_empty()) return true; if (is_empty()) { *this = move(other); return true; } auto other_size = other.size(); if (!try_grow_capacity(size() + other_size)) return false; for (size_t i = size() + other_size - 1; i >= other.size(); --i) { new (slot(i)) StorageType(move(at(i - other_size))); at(i - other_size).~StorageType(); } Vector tmp = move(other); TypedTransfer::move(slot(0), tmp.data(), tmp.size()); m_size += other_size; return true; } [[nodiscard]] bool try_prepend(StorageType const* values, size_t count) { if (!count) return true; if (!try_grow_capacity(size() + count)) return false; TypedTransfer::move(slot(count), slot(0), m_size); TypedTransfer::copy(slot(0), values, count); m_size += count; return true; } [[nodiscard]] bool try_grow_capacity(size_t needed_capacity) { if (m_capacity >= needed_capacity) return true; return try_ensure_capacity(padded_capacity(needed_capacity)); } [[nodiscard]] bool try_ensure_capacity(size_t needed_capacity) { if (m_capacity >= needed_capacity) return true; size_t new_capacity = kmalloc_good_size(needed_capacity * sizeof(StorageType)) / sizeof(StorageType); auto* new_buffer = (StorageType*)kmalloc(new_capacity * sizeof(StorageType)); if (new_buffer == nullptr) return false; if constexpr (Traits::is_trivial()) { TypedTransfer::copy(new_buffer, data(), m_size); } else { for (size_t i = 0; i < m_size; ++i) { new (&new_buffer[i]) StorageType(move(at(i))); at(i).~StorageType(); } } if (m_outline_buffer) kfree(m_outline_buffer); m_outline_buffer = new_buffer; m_capacity = new_capacity; return true; } [[nodiscard]] bool try_resize(size_t new_size, bool keep_capacity = false) requires(!contains_reference) { if (new_size <= size()) { shrink(new_size, keep_capacity); return true; } if (!try_ensure_capacity(new_size)) return false; for (size_t i = size(); i < new_size; ++i) new (slot(i)) StorageType {}; m_size = new_size; return true; } [[nodiscard]] bool try_resize_and_keep_capacity(size_t new_size) requires(!contains_reference) { return try_resize(new_size, true); } void grow_capacity(size_t needed_capacity) { auto did_allocate = try_grow_capacity(needed_capacity); VERIFY(did_allocate); } void ensure_capacity(size_t needed_capacity) { auto did_allocate = try_ensure_capacity(needed_capacity); VERIFY(did_allocate); } void shrink(size_t new_size, bool keep_capacity = false) { VERIFY(new_size <= size()); if (new_size == size()) return; if (!new_size) { if (keep_capacity) clear_with_capacity(); else clear(); return; } for (size_t i = new_size; i < size(); ++i) at(i).~StorageType(); m_size = new_size; } void resize(size_t new_size, bool keep_capacity = false) requires(!contains_reference) { auto did_allocate = try_resize(new_size, keep_capacity); VERIFY(did_allocate); } void resize_and_keep_capacity(size_t new_size) requires(!contains_reference) { auto did_allocate = try_resize_and_keep_capacity(new_size); VERIFY(did_allocate); } using ConstIterator = SimpleIterator; using Iterator = SimpleIterator; ConstIterator begin() const { return ConstIterator::begin(*this); } Iterator begin() { return Iterator::begin(*this); } ConstIterator end() const { return ConstIterator::end(*this); } Iterator end() { return Iterator::end(*this); } template ConstIterator find_if(TUnaryPredicate&& finder) const { return AK::find_if(begin(), end(), forward(finder)); } template Iterator find_if(TUnaryPredicate&& finder) { return AK::find_if(begin(), end(), forward(finder)); } ConstIterator find(T const& value) const { return AK::find(begin(), end(), value); } Iterator find(T const& value) { return AK::find(begin(), end(), value); } Optional find_first_index(T const& value) const { if (auto const index = AK::find_index(begin(), end(), value); index < size()) { return index; } return {}; } private: void reset_capacity() { m_capacity = inline_capacity; } static size_t padded_capacity(size_t capacity) { return max(static_cast(4), capacity + (capacity / 4) + 4); } StorageType* slot(size_t i) { return &data()[i]; } StorageType const* slot(size_t i) const { return &data()[i]; } StorageType* inline_buffer() { static_assert(inline_capacity > 0); return reinterpret_cast(m_inline_buffer_storage); } StorageType const* inline_buffer() const { static_assert(inline_capacity > 0); return reinterpret_cast(m_inline_buffer_storage); } StorageType& raw_last() { return raw_at(size() - 1); } StorageType& raw_first() { return raw_at(0); } StorageType& raw_at(size_t index) { return *slot(index); } size_t m_size { 0 }; size_t m_capacity { 0 }; alignas(StorageType) unsigned char m_inline_buffer_storage[sizeof(StorageType) * inline_capacity]; StorageType* m_outline_buffer { nullptr }; }; } using AK::Vector;