[Scummvm-git-logs] scummvm master -> f1b04fb5b7bbb97ac9ba60e29542470366fa43ca

dreammaster noreply at scummvm.org
Sat Aug 3 17:43:08 UTC 2024


This automated email contains information about 1 new commit which have been
pushed to the 'scummvm' repo located at https://github.com/scummvm/scummvm .

Summary:
f1b04fb5b7 COMMON: Make Std::vector a subclass of Common::Array


Commit: f1b04fb5b7bbb97ac9ba60e29542470366fa43ca
    https://github.com/scummvm/scummvm/commit/f1b04fb5b7bbb97ac9ba60e29542470366fa43ca
Author: Cameron Cawley (ccawley2011 at gmail.com)
Date: 2024-08-03T10:43:05-07:00

Commit Message:
COMMON: Make Std::vector a subclass of Common::Array

Changed paths:
    common/std/vector.h


diff --git a/common/std/vector.h b/common/std/vector.h
index a126e9becdc..72f4b4cedf2 100644
--- a/common/std/vector.h
+++ b/common/std/vector.h
@@ -31,29 +31,12 @@
 #ifndef COMMON_STD_VECTOR_H
 #define COMMON_STD_VECTOR_H
 
-#include "common/std/type_traits.h"
-#include "common/std/utility.h"
-#include "common/scummsys.h"
-#include "common/algorithm.h"
-#include "common/memory.h"
+#include "common/array.h"
 
 namespace Std {
 
 template<class T>
-class vector {
-public:
-	typedef T *iterator; /*!< vector iterator. */
-	typedef const T *const_iterator; /*!< Const-qualified array iterator. */
-
-	typedef T value_type; /*!< Value type of the array. */
-
-	typedef uint size_type; /*!< Size type of the array. */
-
-protected:
-	size_type _capacity; /*!< Maximum number of elements the array can hold. */
-	size_type _size; /*!< How many elements the array holds. */
-	T *_storage;  /*!< Memory used for element storage. */
-
+class vector : public Common::Array<T> {
 public:
 	struct reverse_iterator {
 	private:
@@ -112,100 +95,22 @@ public:
 		}
 	};
 public:
-	vector() : _capacity(0), _size(0), _storage(nullptr) {
-	}
-
-	/**
-	 * Construct an array with @p count default-inserted instances of @p T. No
-	 * copies are made.
-	 */
-	explicit vector(size_type count) : _size(count) {
-		allocCapacity(count);
-		for (size_type i = 0; i < count; ++i)
-			new ((void *)&_storage[i]) T();
-	}
-
-	/**
-	 * Construct an array with @p count copies of elements with value @p value.
-	 */
-	vector(size_type count, const T &value) : _size(count) {
-		allocCapacity(count);
-		Common::uninitialized_fill_n(_storage, count, value);
-	}
-
-	/**
-	 * Construct an array as a copy of the given @p array.
-	 */
-	vector(const vector<T> &array) : _capacity(array._size), _size(array._size), _storage(nullptr) {
-		if (array._storage) {
-			allocCapacity(_size);
-			Common::uninitialized_copy(array._storage, array._storage + _size, _storage);
-		}
-	}
+	using iterator = typename Common::Array<T>::iterator;
+	using const_iterator = typename Common::Array<T>::const_iterator;
 
-	/**
-	 * Construct an array as a copy of the given array using the C++11 move semantic.
-	 */
-	vector(vector<T> &&old) : _capacity(old._capacity), _size(old._size), _storage(old._storage) {
-		old._storage = nullptr;
-		old._capacity = 0;
-		old._size = 0;
-	}
+	constexpr vector() : Common::Array<T>() {}
+	explicit vector(size_t newSize) : Common::Array<T>(newSize) {}
+	vector(size_t newSize, const T &elem) : Common::Array<T>(newSize, elem) {}
+	vector(std::initializer_list<T> list) : Common::Array<T>(list) {}
 
-	/**
-	 * Construct an array using list initialization.
-	 * For example:
-	 * @code
-	 * Common::vector<int> myArray = {1, 7, 42};
-	 * @endcode
-	 * constructs an array with 3 elements whose values are 1, 7, and 42 respectively.
-	 * @note
-	 * This constructor is only available when C++11 support is enabled.
-	 */
-	vector(::std::initializer_list<T> list) : _size(list.size()) {
-		allocCapacity(list.size());
-		if (_storage)
-			Common::uninitialized_copy(list.begin(), list.end(), _storage);
-	}
-
-	/**
-	 * Construct an array by copying data from a regular array.
-	 */
-	template<class T2>
-	vector(const T2 *array, size_type n) {
-		_size = n;
-		allocCapacity(n);
-		Common::uninitialized_copy(array, array + _size, _storage);
-	}
-
-	~vector() {
-		freeStorage(_storage, _size);
-		_storage = nullptr;
-		_capacity = _size = 0;
-	}
-
-	/** Append an element to the end of the array. */
-	void push_back(const T &element) {
-		if (_size + 1 <= _capacity)
-			new ((void *)&_storage[_size++]) T(element);
-		else
-			insert_aux(end(), &element, &element + 1);
-	}
 
 	template<class... Args>
 	void emplace_back(Args... args) {
 		T tmp(args...);
-		push_back(tmp);
+		this->push_back(tmp);
 	}
 
-	/** Append an element to the end of the array. */
-	void push_back(const vector<T> &array) {
-		if (_size + array.size() <= _capacity) {
-			Common::uninitialized_copy(array.begin(), array.end(), end());
-			_size += array.size();
-		} else
-			insert_aux(end(), array.begin(), array.end());
-	}
+	using Common::Array<T>::insert;
 
 	void insert(const T &element) {
 		this->push_back(element);
@@ -217,84 +122,10 @@ public:
 	void insert(iterator position, const_iterator first, const_iterator last) {
 		int destIndex = position - this->begin();
 		for (; first != last; ++first) {
-			insert_at(destIndex++, *first);
+			this->insert_at(destIndex++, *first);
 		}
 	}
 
-	/** Remove the last element of the array. */
-	void pop_back() {
-		assert(_size > 0);
-		_size--;
-		// We also need to destroy the last object properly here.
-		_storage[_size].~T();
-	}
-
-	/** Return a pointer to the underlying memory serving as element storage. */
-	const T *data() const {
-		return _storage;
-	}
-
-	/** Return a pointer to the underlying memory serving as element storage. */
-	T *data() {
-		return _storage;
-	}
-
-	/** Return a reference to the first element of the array. */
-	T &front() {
-		assert(_size > 0);
-		return _storage[0];
-	}
-
-	/** Return a reference to the first element of the array. */
-	const T &front() const {
-		assert(_size > 0);
-		return _storage[0];
-	}
-
-	/** Return a reference to the last element of the array. */
-	T &back() {
-		assert(_size > 0);
-		return _storage[_size - 1];
-	}
-
-	/** Return a reference to the last element of the array. */
-	const T &back() const {
-		assert(_size > 0);
-		return _storage[_size - 1];
-	}
-
-	/** Insert an element into the array at the given position. */
-	void insert_at(size_type idx, const T &element) {
-		assert(idx <= _size);
-		insert_aux(_storage + idx, &element, &element + 1);
-	}
-
-	/** Insert copies of all the elements from the given array into this array at the given position. */
-	void insert_at(size_type idx, const vector<T> &array) {
-		assert(idx <= _size);
-		insert_aux(_storage + idx, array.begin(), array.end());
-	}
-
-	/**
-	 * Insert an element before @p pos.
-	 */
-	void insert(iterator pos, const T &element) {
-		insert_aux(pos, &element, &element + 1);
-	}
-
-	/** Remove an element at the given position from the array and return the value of that element. */
-	T remove_at(size_type idx) {
-		assert(idx < _size);
-		T tmp = Common::move(_storage[idx]);
-		Common::move(_storage + idx + 1, _storage + _size, _storage + idx);
-		_size--;
-		// We also need to destroy the last object properly here.
-		_storage[_size].~T();
-		return tmp;
-	}
-
-	// TODO: insert, remove, ...
-
 	T &at(size_t index) {
 		return (*this)[index];
 	}
@@ -302,84 +133,6 @@ public:
 		return (*this)[index];
 	}
 
-	/** Return a reference to the element at the given position in the array. */
-	T &operator[](size_type idx) {
-		assert(idx < _size);
-		return _storage[idx];
-	}
-
-	/** Return a const reference to the element at the given position in the array. */
-	const T &operator[](size_type idx) const {
-		assert(idx < _size);
-		return _storage[idx];
-	}
-
-	/** Assign the given @p array to this array. */
-	vector<T> &operator=(const vector<T> &array) {
-		if (this == &array)
-			return *this;
-
-		freeStorage(_storage, _size);
-		_size = array._size;
-		allocCapacity(_size);
-		Common::uninitialized_copy(array._storage, array._storage + _size, _storage);
-
-		return *this;
-	}
-
-	/** Assign the given array to this array using the C++11 move semantic. */
-	vector &operator=(vector<T> &&old) {
-		if (this == &old)
-			return *this;
-
-		freeStorage(_storage, _size);
-		_capacity = old._capacity;
-		_size = old._size;
-		_storage = old._storage;
-
-		old._storage = nullptr;
-		old._capacity = 0;
-		old._size = 0;
-
-		return *this;
-	}
-
-	/** Return the size of the array. */
-	size_type size() const {
-		return _size;
-	}
-
-	/** Clear the array of all its elements. */
-	void clear() {
-		freeStorage(_storage, _size);
-		_storage = nullptr;
-		_size = 0;
-		_capacity = 0;
-	}
-
-	/** Erase the element at @p pos position and return an iterator pointing to the next element in the array. */
-	iterator erase(iterator pos) {
-		Common::move(pos + 1, _storage + _size, pos);
-		_size--;
-		// We also need to destroy the last object properly here.
-		_storage[_size].~T();
-		return pos;
-	}
-
-	/** Erase the elements from @p first to @p last and return an iterator pointing to the next element in the array. */
-	iterator erase(iterator first, iterator last) {
-		Common::move(last, this->_storage + this->_size, first);
-
-		int count = (last - first);
-		this->_size -= count;
-
-		// We also need to destroy the objects beyond the new size
-		for (uint idx = this->_size; idx < (this->_size + count); ++idx)
-			this->_storage[idx].~T();
-
-		return first;
-	}
-
 	/**
 	 * Remove an element
 	 */
@@ -392,66 +145,16 @@ public:
 		}
 	}
 
-	/** Check whether the array is empty. */
-	bool empty() const {
-		return (_size == 0);
-	}
-
-	/** Check whether two arrays are identical. */
-	bool operator==(const vector<T> &other) const {
-		if (this == &other)
-			return true;
-		if (_size != other._size)
-			return false;
-		for (size_type i = 0; i < _size; ++i) {
-			if (_storage[i] != other._storage[i])
-				return false;
-		}
-		return true;
-	}
-
-	/** Check if two arrays are different. */
-	bool operator!=(const vector<T> &other) const {
-		return !(*this == other);
-	}
-
-	/** Return an iterator pointing to the first element in the array. */
-	iterator       begin() {
-		return _storage;
-	}
-
-	/** Return an iterator pointing past the last element in the array. */
-	iterator       end() {
-		return _storage + _size;
-	}
-
-	/** Return a const iterator pointing to the first element in the array. */
-	const_iterator begin() const {
-		return _storage;
-	}
-
-	/** Return a const iterator pointing past the last element in the array. */
-	const_iterator end() const {
-		return _storage + _size;
-	}
-
-
-	void swap(vector &arr) {
-		SWAP(this->_capacity, arr._capacity);
-		SWAP(this->_size, arr._size);
-		SWAP(this->_storage, arr._storage);
-	}
-
 	/**
 	 * Rotates the array so that the item pointed to by the iterator becomes
 	 * the first item, and the predeceding item becomes the last one
 	 */
 	void rotate(iterator it) {
-		if (it != end()) {
-			size_t count = it - begin();
+		if (it != this->end()) {
+			size_t count = it - this->begin();
 			for (size_t ctr = 0; ctr < count; ++ctr) {
-				push_back(front());
-				remove_at(0);
+				this->push_back(this->front());
+				this->remove_at(0);
 			}
 		}
 	}
@@ -463,164 +166,23 @@ public:
 		return this->end();
 	}
 	reverse_iterator rbegin() {
-		return reverse_iterator(this, (int)size() - 1);
+		return reverse_iterator(this, (int)this->size() - 1);
 	}
 	reverse_iterator rend() {
 		return reverse_iterator(this, -1);
 	}
 	const_reverse_iterator rbegin() const {
-		return const_reverse_iterator(this, (int)size() - 1);
+		return const_reverse_iterator(this, (int)this->size() - 1);
 	}
 	const_reverse_iterator rend() const {
 		return const_reverse_iterator(this, -1);
 	}
 	const_reverse_iterator crbegin() const {
-		return const_reverse_iterator(this, (int)size() - 1);
+		return const_reverse_iterator(this, (int)this->size() - 1);
 	}
 	const_reverse_iterator crend() const {
 		return const_reverse_iterator(this, -1);
 	}
-
-	/** Reserve enough memory in the array so that it can store at least the given number of elements.
-	 *  The current content of the array is not modified.
-	 */
-	void reserve(size_type newCapacity) {
-		if (newCapacity <= _capacity)
-			return;
-
-		T *oldStorage = _storage;
-		allocCapacity(newCapacity);
-
-		if (oldStorage) {
-			// Move old data
-			Common::uninitialized_move(oldStorage, oldStorage + _size, _storage);
-			freeStorage(oldStorage, _size);
-		}
-	}
-
-	/** Change the size of the array. */
-	void resize(size_type newSize) {
-		reserve(newSize);
-		for (size_type i = newSize; i < _size; ++i)
-			_storage[i].~T();
-		for (size_type i = _size; i < newSize; ++i)
-			new ((void *)&_storage[i]) T();
-		_size = newSize;
-	}
-
-	void resize(size_t newSize, const T elem) {
-		size_t oldSize = size();
-		resize(newSize);
-		for (size_t idx = oldSize; idx < newSize; ++idx)
-			this->operator[](idx) = elem;
-	}
-
-	/** Assign to this array the elements between the given iterators from another array,
-	 *  from @p first included to @p last excluded.
-	 */
-	void assign(const_iterator first, const_iterator last) {
-		resize(distance(first, last)); // FIXME: ineffective?
-		T *dst = _storage;
-		while (first != last)
-			*dst++ = *first++;
-	}
-
-protected:
-	/** Round up capacity to the next power of 2.
-	  * A minimal capacity of 8 is used.
-	  */
-	static size_type roundUpCapacity(size_type capacity) {
-		size_type capa = 8;
-		while (capa < capacity)
-			capa <<= 1;
-		return capa;
-	}
-
-	/** Allocate a specific capacity for the array. */
-	void allocCapacity(size_type capacity) {
-		_capacity = capacity;
-		if (capacity) {
-			_storage = (T *)malloc(sizeof(T) * capacity);
-			if (!_storage)
-				::error("Common::vector: failure to allocate %u bytes", capacity * (size_type)sizeof(T));
-		} else {
-			_storage = nullptr;
-		}
-	}
-
-	/** Free the storage used by the array. */
-	void freeStorage(T *storage, const size_type elements) {
-		for (size_type i = 0; i < elements; ++i)
-			storage[i].~T();
-		free(storage);
-	}
-
-	/**
-	 * Insert a range of elements coming from this or another array.
-	 * Unlike std::vector::insert, this method does not accept
-	 * arbitrary iterators, mainly because our iterator system is
-	 * seriously limited and does not distinguish between input iterators,
-	 * output iterators, forward iterators, or random access iterators.
-	 *
-	 * So, we simply restrict to vector iterators. Extending this to arbitrary
-	 * random access iterators would be trivial.
-	 *
-	 * Moreover, this method does not handle all cases of inserting a subrange
-	 * of an array into itself; this is why it is private for now.
-	 */
-	iterator insert_aux(iterator pos, const_iterator first, const_iterator last) {
-		assert(_storage <= pos && pos <= _storage + _size);
-		assert(first <= last);
-		const size_type n = last - first;
-		if (n) {
-			const size_type idx = pos - _storage;
-			if (_size + n > _capacity || (_storage <= first && first <= _storage + _size)) {
-				T *const oldStorage = _storage;
-
-				// If there is not enough space, allocate more.
-				// Likewise, if this is a self-insert, we allocate new
-				// storage to avoid conflicts.
-				allocCapacity(roundUpCapacity(_size + n));
-
-				// Move the data from the old storage till the position where
-				// we insert new data
-				Common::uninitialized_move(oldStorage, oldStorage + idx, _storage);
-				// Copy the data we insert
-				Common::uninitialized_copy(first, last, _storage + idx);
-				// Afterwards, move the old data from the position where we
-				// insert.
-				Common::uninitialized_move(oldStorage + idx, oldStorage + _size, _storage + idx + n);
-
-				freeStorage(oldStorage, _size);
-			} else if (idx + n <= _size) {
-				// Make room for the new elements by shifting back
-				// existing ones.
-				// 1. Move a part of the data to the uninitialized area
-				Common::uninitialized_move(_storage + _size - n, _storage + _size, _storage + _size);
-				// 2. Move a part of the data to the initialized area
-				Common::move_backward(pos, _storage + _size - n, _storage + _size);
-
-				// Insert the new elements.
-				Common::copy(first, last, pos);
-			} else {
-				// Move the old data from the position till the end to the new
-				// place.
-				Common::uninitialized_move(pos, _storage + _size, _storage + idx + n);
-
-				// Copy a part of the new data to the position inside the
-				// initialized space.
-				Common::copy(first, first + (_size - idx), pos);
-
-				// Copy a part of the new data to the position inside the
-				// uninitialized space.
-				Common::uninitialized_copy(first + (_size - idx), last, _storage + _size);
-			}
-
-			// Finally, update the internal state
-			_size += n;
-		}
-		return pos;
-	}
 };
 
 } // namespace Std




More information about the Scummvm-git-logs mailing list