You need to sign in or sign up before continuing.
AllocatedArray.hxx 5.45 KB
Newer Older
1
/*
2
 * Copyright (C) 2010-2016 Max Kellermann <max.kellermann@gmail.com>
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *
 * - Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the
 * distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
 * FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef ALLOCATED_ARRAY_HXX
#define ALLOCATED_ARRAY_HXX

#include "WritableBuffer.hxx"
#include "Compiler.h"

#include <algorithm>

#include <assert.h>

/**
 * An array allocated on the heap with a length determined at runtime.
 */
template<class T>
class AllocatedArray {
	typedef WritableBuffer<T> Buffer;

public:
	typedef typename Buffer::size_type size_type;
	typedef typename Buffer::reference_type reference_type;
	typedef typename Buffer::const_reference_type const_reference_type;
	typedef typename Buffer::iterator iterator;
	typedef typename Buffer::const_iterator const_iterator;

protected:
	Buffer buffer{nullptr};

public:
	constexpr AllocatedArray() = default;

	explicit AllocatedArray(size_type _size)
		:buffer{new T[_size], _size} {
		assert(size() == 0 || buffer.data != nullptr);
	}

	explicit AllocatedArray(const AllocatedArray &other)
		:buffer{new T[other.buffer.size], other.buffer.size} {
		assert(size() == 0 || buffer.data != nullptr);
		assert(other.size() == 0 || other.buffer.data != nullptr);

		std::copy_n(other.buffer.data, buffer.size, buffer.data);
	}

	AllocatedArray(AllocatedArray &&other)
		:buffer(other.buffer) {
75
		other.buffer = nullptr;
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102
	}

	~AllocatedArray() {
		delete[] buffer.data;
	}

	AllocatedArray &operator=(const AllocatedArray &other) {
		assert(size() == 0 || buffer.data != nullptr);
		assert(other.size() == 0 || other.buffer.data != nullptr);

		if (&other == this)
			return *this;

		ResizeDiscard(other.size());
		std::copy_n(other.buffer.data, other.buffer.size, buffer.data);
		return *this;
	}

	AllocatedArray &operator=(AllocatedArray &&other) {
		std::swap(buffer, other.buffer);
		return *this;
	}

	constexpr bool IsNull() const {
		return buffer.IsNull();
	}

103 104 105 106 107 108 109 110
	constexpr bool operator==(std::nullptr_t) const {
		return buffer == nullptr;
	}

	constexpr bool operator!=(std::nullptr_t) const {
		return buffer != nullptr;
	}

111 112 113 114
	/**
	 * Returns true if no memory was allocated so far.
	 */
	constexpr bool empty() const {
115
		return buffer.empty();
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
	}

	/**
	 * Returns the number of allocated elements.
	 */
	constexpr size_type size() const {
		return buffer.size;
	}

	reference_type front() {
		return buffer.front();
	}

	const_reference_type front() const {
		return buffer.front();
	}

	reference_type back() {
		return buffer.back();
	}

	const_reference_type back() const {
		return buffer.back();
	}

	/**
	 * Returns one element.  No bounds checking.
	 */
	reference_type operator[](size_type i) {
		assert(i < size());

		return buffer.data[i];
	}

	/**
	 * Returns one constant element.  No bounds checking.
	 */
	const_reference_type operator[](size_type i) const {
		assert(i < size());

		return buffer.data[i];
	}

	iterator begin() {
		return buffer.begin();
	}

	constexpr const_iterator begin() const {
		return buffer.cbegin();
	}

	iterator end() {
		return buffer.end();
	}

	constexpr const_iterator end() const {
		return buffer.cend();
	}

	/**
	 * Resizes the array, discarding old data.
	 */
	void ResizeDiscard(size_type _size) {
		if (_size == buffer.size)
			return;

		delete[] buffer.data;
		buffer.size = _size;
		buffer.data = new T[buffer.size];

		assert(size() == 0 || buffer.data != nullptr);
	}

	/**
	 * Grows the array to the specified size, discarding old data.
	 * Similar to ResizeDiscard(), but will never shrink the array to
	 * avoid expensive heap operations.
	 */
	void GrowDiscard(size_type _size) {
		if (_size > buffer.size)
			ResizeDiscard(_size);
	}

	/**
	 * Grows the array to the specified size, preserving the value of a
	 * range of elements, starting from the beginning.
	 */
	void GrowPreserve(size_type _size, size_type preserve) {
		if (_size <= buffer.size)
			return;

		T *new_data = new T[_size];
		assert(_size == 0 || new_data != nullptr);

		std::move(buffer.data, buffer.data + preserve, new_data);

		delete[] buffer.data;
		buffer.data = new_data;
		buffer.size = _size;
	}

	/**
	 * Declare that the buffer has the specified size.  Must not be
	 * larger than the current size.  Excess elements are not used (but
	 * they are still allocated).
	 */
	void SetSize(size_type _size) {
		assert(_size <= buffer.size);

		buffer.size = _size;
	}
};

#endif