2007-05-30 21:56:52 +00:00
|
|
|
/* ScummVM - Graphic Adventure Engine
|
|
|
|
*
|
|
|
|
* ScummVM is the legal property of its developers, whose names
|
|
|
|
* are too numerous to list here. Please refer to the COPYRIGHT
|
|
|
|
* file distributed with this source distribution.
|
2004-04-09 15:10:23 +00:00
|
|
|
*
|
|
|
|
* This program is free software; you can redistribute it and/or
|
|
|
|
* modify it under the terms of the GNU General Public License
|
|
|
|
* as published by the Free Software Foundation; either version 2
|
|
|
|
* of the License, or (at your option) any later version.
|
|
|
|
*
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU General Public License
|
|
|
|
* along with this program; if not, write to the Free Software
|
2005-10-18 01:30:26 +00:00
|
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
2004-04-09 15:10:23 +00:00
|
|
|
*
|
2006-02-11 09:53:53 +00:00
|
|
|
* $URL$
|
|
|
|
* $Id$
|
2004-04-09 15:10:23 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef COMMON_ARRAY_H
|
|
|
|
#define COMMON_ARRAY_H
|
|
|
|
|
|
|
|
#include "common/scummsys.h"
|
2007-05-23 12:02:31 +00:00
|
|
|
#include "common/algorithm.h"
|
2004-04-09 15:10:23 +00:00
|
|
|
|
|
|
|
namespace Common {
|
|
|
|
|
2009-05-26 11:28:38 +00:00
|
|
|
/**
|
|
|
|
* This class implements a dynamically sized container, which
|
|
|
|
* can be accessed similar to a regular C++ array. Accessing
|
|
|
|
* elements is performed in constant time (like with plain arrays).
|
|
|
|
* In addition, one can append, insert and remove entries (this
|
|
|
|
* is the 'dynamic' part). Doing that in general takes time
|
|
|
|
* proportional to the number of elements in the array.
|
|
|
|
*
|
|
|
|
* The container class closest to this in the C++ standard library is
|
|
|
|
* std::vector. However, there are some differences. The most important one is
|
|
|
|
* that std::vector has a far more sophisticated (and complicated) memory
|
|
|
|
* management scheme. There, only elements that 'live' are actually constructed
|
|
|
|
* (i.e., have their constructor called), and objects that are removed are
|
|
|
|
* immediately destructed (have their destructor called).
|
|
|
|
* With Common::Array, this is not the case; instead, it simply uses new[] and
|
|
|
|
* delete[] to allocate whole blocks of objects, possibly more than are
|
|
|
|
* currently 'alive'. This simplifies memory management, but may have
|
|
|
|
* undesirable side effects when one wants to use an Array of complex
|
|
|
|
* data types.
|
|
|
|
*
|
|
|
|
* @todo Improve the storage management of this class.
|
|
|
|
* In particular, don't use new[] and delete[], but rather
|
|
|
|
* construct/destruct objects manually. This way, we can
|
|
|
|
* ensure that storage which is not currently used does not
|
|
|
|
* correspond to a live active object.
|
|
|
|
* (This is only of interest for array of non-POD objects).
|
|
|
|
*/
|
2008-05-03 23:02:05 +00:00
|
|
|
template<class T>
|
2004-04-09 15:10:23 +00:00
|
|
|
class Array {
|
|
|
|
protected:
|
2008-02-27 13:35:29 +00:00
|
|
|
uint _capacity;
|
|
|
|
uint _size;
|
2008-08-20 11:07:16 +00:00
|
|
|
T *_storage;
|
2004-04-09 15:10:23 +00:00
|
|
|
|
|
|
|
public:
|
|
|
|
typedef T *iterator;
|
|
|
|
typedef const T *const_iterator;
|
|
|
|
|
2007-05-23 12:02:31 +00:00
|
|
|
typedef T value_type;
|
|
|
|
|
2004-04-09 15:10:23 +00:00
|
|
|
public:
|
2008-08-20 11:07:16 +00:00
|
|
|
Array() : _capacity(0), _size(0), _storage(0) {}
|
2009-05-26 11:28:38 +00:00
|
|
|
|
|
|
|
Array(const Array<T> &array) : _capacity(array._size), _size(array._size), _storage(0) {
|
|
|
|
if (array._storage) {
|
|
|
|
_storage = new T[_capacity];
|
|
|
|
assert(_storage);
|
|
|
|
copy(array._storage, array._storage + _size, _storage);
|
|
|
|
}
|
2004-04-09 15:10:23 +00:00
|
|
|
}
|
|
|
|
|
2009-04-20 19:27:11 +00:00
|
|
|
/**
|
|
|
|
* Construct an array by copying data from a regular array.
|
|
|
|
*/
|
2009-04-22 17:52:56 +00:00
|
|
|
template<class T2>
|
|
|
|
Array(const T2 *data, int n) {
|
2009-04-20 19:27:11 +00:00
|
|
|
_capacity = _size = n;
|
|
|
|
_storage = new T[_capacity];
|
2009-05-03 22:45:31 +00:00
|
|
|
assert(_storage);
|
2009-04-20 19:27:11 +00:00
|
|
|
copy(data, data + _size, _storage);
|
|
|
|
}
|
|
|
|
|
2006-10-13 20:18:27 +00:00
|
|
|
~Array() {
|
2008-08-20 11:07:16 +00:00
|
|
|
delete[] _storage;
|
2009-05-05 12:29:15 +00:00
|
|
|
_storage = 0;
|
|
|
|
_capacity = _size = 0;
|
2004-04-09 15:10:23 +00:00
|
|
|
}
|
|
|
|
|
2009-04-27 14:25:16 +00:00
|
|
|
/** Appends element to the end of the array. */
|
2008-05-03 23:02:05 +00:00
|
|
|
void push_back(const T &element) {
|
2009-05-26 11:28:38 +00:00
|
|
|
if (_size + 1 <= _capacity)
|
|
|
|
_storage[_size++] = element;
|
|
|
|
else
|
|
|
|
insert_aux(end(), &element, &element + 1);
|
2004-04-09 15:10:23 +00:00
|
|
|
}
|
|
|
|
|
2008-05-03 23:02:05 +00:00
|
|
|
void push_back(const Array<T> &array) {
|
2009-05-26 11:28:38 +00:00
|
|
|
if (_size + array.size() <= _capacity) {
|
|
|
|
copy(array.begin(), array.end(), end());
|
|
|
|
_size += array.size();
|
|
|
|
} else
|
|
|
|
insert_aux(end(), array.begin(), array.end());
|
2004-04-09 15:10:23 +00:00
|
|
|
}
|
|
|
|
|
2009-04-27 14:25:16 +00:00
|
|
|
/** Removes the last element of the array. */
|
2009-04-27 14:23:20 +00:00
|
|
|
void pop_back() {
|
|
|
|
assert(_size > 0);
|
|
|
|
_size--;
|
|
|
|
}
|
|
|
|
|
2009-04-27 14:25:16 +00:00
|
|
|
/** Returns a reference to the first element of the array. */
|
2009-04-27 14:23:20 +00:00
|
|
|
T &front() {
|
|
|
|
assert(_size > 0);
|
|
|
|
return _storage[0];
|
|
|
|
}
|
|
|
|
|
2009-04-27 14:25:16 +00:00
|
|
|
/** Returns a reference to the first element of the array. */
|
2009-04-27 14:23:20 +00:00
|
|
|
const T &front() const {
|
|
|
|
assert(_size > 0);
|
|
|
|
return _storage[0];
|
|
|
|
}
|
|
|
|
|
2009-04-27 14:25:16 +00:00
|
|
|
/** Returns a reference to the last element of the array. */
|
2009-04-27 14:23:20 +00:00
|
|
|
T &back() {
|
|
|
|
assert(_size > 0);
|
|
|
|
return _storage[_size-1];
|
|
|
|
}
|
|
|
|
|
2009-04-27 14:25:16 +00:00
|
|
|
/** Returns a reference to the last element of the array. */
|
2009-04-27 14:23:20 +00:00
|
|
|
const T &back() const {
|
|
|
|
assert(_size > 0);
|
|
|
|
return _storage[_size-1];
|
|
|
|
}
|
|
|
|
|
2009-05-26 11:28:38 +00:00
|
|
|
|
2008-05-03 23:02:05 +00:00
|
|
|
void insert_at(int idx, const T &element) {
|
2008-02-27 13:35:29 +00:00
|
|
|
assert(idx >= 0 && (uint)idx <= _size);
|
2009-05-26 11:28:38 +00:00
|
|
|
insert_aux(_storage + idx, &element, &element + 1);
|
2004-04-09 15:10:23 +00:00
|
|
|
}
|
|
|
|
|
2004-08-12 21:33:59 +00:00
|
|
|
T remove_at(int idx) {
|
2008-02-27 13:35:29 +00:00
|
|
|
assert(idx >= 0 && (uint)idx < _size);
|
2008-08-20 11:07:16 +00:00
|
|
|
T tmp = _storage[idx];
|
|
|
|
copy(_storage + idx + 1, _storage + _size, _storage + idx);
|
2004-04-09 15:10:23 +00:00
|
|
|
_size--;
|
|
|
|
return tmp;
|
|
|
|
}
|
|
|
|
|
|
|
|
// TODO: insert, remove, ...
|
|
|
|
|
2008-05-03 23:02:05 +00:00
|
|
|
T& operator[](int idx) {
|
2008-02-27 13:35:29 +00:00
|
|
|
assert(idx >= 0 && (uint)idx < _size);
|
2008-08-20 11:07:16 +00:00
|
|
|
return _storage[idx];
|
2004-04-09 15:10:23 +00:00
|
|
|
}
|
|
|
|
|
2008-05-03 23:02:05 +00:00
|
|
|
const T& operator[](int idx) const {
|
2008-02-27 13:35:29 +00:00
|
|
|
assert(idx >= 0 && (uint)idx < _size);
|
2008-08-20 11:07:16 +00:00
|
|
|
return _storage[idx];
|
2004-04-09 15:10:23 +00:00
|
|
|
}
|
|
|
|
|
2008-05-03 23:02:05 +00:00
|
|
|
Array<T>& operator=(const Array<T> &array) {
|
2007-03-12 22:34:29 +00:00
|
|
|
if (this == &array)
|
|
|
|
return *this;
|
|
|
|
|
2008-08-20 11:07:16 +00:00
|
|
|
delete[] _storage;
|
2004-04-09 15:10:23 +00:00
|
|
|
_size = array._size;
|
|
|
|
_capacity = _size + 32;
|
2008-08-20 11:07:16 +00:00
|
|
|
_storage = new T[_capacity];
|
2009-05-03 22:45:31 +00:00
|
|
|
assert(_storage);
|
2008-08-20 11:07:16 +00:00
|
|
|
copy(array._storage, array._storage + _size, _storage);
|
2004-04-09 15:10:23 +00:00
|
|
|
|
|
|
|
return *this;
|
|
|
|
}
|
|
|
|
|
|
|
|
uint size() const {
|
|
|
|
return _size;
|
|
|
|
}
|
|
|
|
|
|
|
|
void clear() {
|
2008-08-20 11:07:16 +00:00
|
|
|
delete[] _storage;
|
|
|
|
_storage = 0;
|
2004-04-09 15:10:23 +00:00
|
|
|
_size = 0;
|
|
|
|
_capacity = 0;
|
|
|
|
}
|
2005-07-30 21:11:48 +00:00
|
|
|
|
2006-03-28 09:42:54 +00:00
|
|
|
bool empty() const {
|
2004-04-09 15:10:23 +00:00
|
|
|
return (_size == 0);
|
|
|
|
}
|
|
|
|
|
2009-10-19 17:46:50 +00:00
|
|
|
bool operator==(const Array<T> &other) const {
|
|
|
|
if (this == &other)
|
|
|
|
return true;
|
|
|
|
if (_size != other._size)
|
|
|
|
return false;
|
|
|
|
for (uint i = 0; i < _size; ++i) {
|
|
|
|
if (_storage[i] != other._storage[i])
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
bool operator!=(const Array<T> &other) const {
|
|
|
|
return !(*this == other);
|
|
|
|
}
|
|
|
|
|
2004-04-09 15:10:23 +00:00
|
|
|
|
|
|
|
iterator begin() {
|
2008-08-20 11:07:16 +00:00
|
|
|
return _storage;
|
2004-04-09 15:10:23 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
iterator end() {
|
2008-08-20 11:07:16 +00:00
|
|
|
return _storage + _size;
|
2004-04-09 15:10:23 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
const_iterator begin() const {
|
2008-08-20 11:07:16 +00:00
|
|
|
return _storage;
|
2004-04-09 15:10:23 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
const_iterator end() const {
|
2008-08-20 11:07:16 +00:00
|
|
|
return _storage + _size;
|
2004-04-09 15:10:23 +00:00
|
|
|
}
|
|
|
|
|
2008-02-27 13:35:29 +00:00
|
|
|
void reserve(uint newCapacity) {
|
|
|
|
if (newCapacity <= _capacity)
|
2004-04-09 15:10:23 +00:00
|
|
|
return;
|
|
|
|
|
2008-08-20 11:07:16 +00:00
|
|
|
T *old_storage = _storage;
|
2008-02-27 13:35:29 +00:00
|
|
|
_capacity = newCapacity;
|
2009-07-12 05:34:46 +00:00
|
|
|
_storage = new T[newCapacity];
|
2009-05-03 22:45:31 +00:00
|
|
|
assert(_storage);
|
2004-04-09 15:10:23 +00:00
|
|
|
|
2008-08-20 11:07:16 +00:00
|
|
|
if (old_storage) {
|
2004-04-09 15:10:23 +00:00
|
|
|
// Copy old data
|
2008-08-20 11:07:16 +00:00
|
|
|
copy(old_storage, old_storage + _size, _storage);
|
|
|
|
delete[] old_storage;
|
2004-04-09 15:10:23 +00:00
|
|
|
}
|
|
|
|
}
|
2008-02-27 13:35:29 +00:00
|
|
|
|
2008-02-27 14:06:06 +00:00
|
|
|
void resize(uint newSize) {
|
2009-05-03 09:00:53 +00:00
|
|
|
reserve(newSize);
|
2009-05-10 19:17:11 +00:00
|
|
|
for (uint i = _size; i < newSize; ++i)
|
|
|
|
_storage[i] = T();
|
2008-02-27 14:06:06 +00:00
|
|
|
_size = newSize;
|
|
|
|
}
|
|
|
|
|
2008-02-27 13:35:29 +00:00
|
|
|
protected:
|
2009-05-26 11:28:38 +00:00
|
|
|
static uint roundUpCapacity(uint capacity) {
|
|
|
|
// Round up capacity to the next power of 2;
|
|
|
|
// we use a minimal capacity of 8.
|
|
|
|
uint capa = 8;
|
|
|
|
while (capa < capacity)
|
|
|
|
capa <<= 1;
|
|
|
|
return capa;
|
2008-02-27 13:35:29 +00:00
|
|
|
}
|
2009-05-26 11:28:38 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* 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 Array 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 uint n = last - first;
|
|
|
|
if (n) {
|
|
|
|
const uint idx = pos - _storage;
|
|
|
|
T *newStorage = _storage;
|
|
|
|
if (_size + n > _capacity) {
|
|
|
|
// If there is not enough space, allocate more and
|
|
|
|
// copy old elements over.
|
|
|
|
uint newCapacity = roundUpCapacity(_size + n);
|
2009-07-12 05:34:46 +00:00
|
|
|
newStorage = new T[newCapacity];
|
2009-05-26 11:28:38 +00:00
|
|
|
assert(newStorage);
|
|
|
|
copy(_storage, _storage + idx, newStorage);
|
|
|
|
pos = newStorage + idx;
|
|
|
|
}
|
|
|
|
|
|
|
|
// Make room for the new elements by shifting back
|
|
|
|
// existing ones.
|
|
|
|
copy_backward(_storage + idx, _storage + _size, newStorage + _size + n);
|
|
|
|
|
|
|
|
// Insert the new elements.
|
|
|
|
copy(first, last, pos);
|
|
|
|
|
|
|
|
// Finally, update the internal state
|
|
|
|
if (newStorage != _storage) {
|
|
|
|
delete[] _storage;
|
|
|
|
_capacity = roundUpCapacity(_size + n);
|
|
|
|
_storage = newStorage;
|
|
|
|
}
|
|
|
|
_size += n;
|
|
|
|
}
|
|
|
|
return pos;
|
|
|
|
}
|
|
|
|
|
2004-04-09 15:10:23 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
} // End of namespace Common
|
|
|
|
|
|
|
|
#endif
|