blob: b17755c5eb882f333ee44cda54d26b7ced925c2a (
plain)
1
2
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
75
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
103
104
105
106
107
108
|
/* $Id$ */
/*
* This file is part of OpenTTD.
* OpenTTD 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, version 2.
* OpenTTD 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 OpenTTD. If not, see <http://www.gnu.org/licenses/>.
*/
/** @file fixedsizearray.hpp A fixed size array that doesn't create items until needed. */
#ifndef FIXEDSIZEARRAY_HPP
#define FIXEDSIZEARRAY_HPP
/** fixed size array
* Upon construction it preallocates fixed size block of memory
* for all items, but doesn't construct them. Item's construction
* is delayed. */
template <class Titem_, int Tcapacity_>
struct CFixedSizeArrayT {
/** the only member of fixed size array is pointer to the block
* of C array of items. Header can be found on the offset -sizeof(CHdr). */
Titem_ *m_items;
/** header for fixed size array */
struct CHdr
{
int m_num_items; ///< number of items in the array
int m_ref_cnt; ///< block reference counter (used by copy constructor and by destructor)
};
/* make types and constants visible from outside */
typedef Titem_ Titem; // type of array item
static const int Tcapacity = Tcapacity_; // the array capacity (maximum size)
static const int TitemSize = sizeof(Titem_); // size of item
static const int ThdrSize = sizeof(CHdr); // size of header
/** Default constructor. Preallocate space for items and header, then initialize header. */
CFixedSizeArrayT()
{
/* allocate block for header + items (don't construct items) */
m_items = (Titem*)((MallocT<int8>(ThdrSize + Tcapacity * sizeof(Titem))) + ThdrSize);
SizeRef() = 0; // initial number of items
RefCnt() = 1; // initial reference counter
}
/** Copy constructor. Preallocate space for items and header, then initialize header. */
CFixedSizeArrayT(const CFixedSizeArrayT<Titem_, Tcapacity_>& src)
{
/* share block (header + items) with the source array */
m_items = src.m_items;
RefCnt()++; // now we share block with the source
}
/** destroy remaining items and free the memory block */
~CFixedSizeArrayT()
{
/* release one reference to the shared block */
if ((--RefCnt()) > 0) return; // and return if there is still some owner
Clear();
/* free the memory block occupied by items */
free(((int8*)m_items) - ThdrSize);
m_items = NULL;
}
/** Clear (destroy) all items */
FORCEINLINE void Clear()
{
/* walk through all allocated items backward and destroy them */
for (Titem *pItem = &m_items[Size() - 1]; pItem >= m_items; pItem--) {
pItem->~Titem_();
}
/* number of items become zero */
SizeRef() = 0;
}
protected:
/** return reference to the array header (non-const) */
FORCEINLINE CHdr& Hdr() { return *(CHdr*)(((int8*)m_items) - ThdrSize); }
/** return reference to the array header (const) */
FORCEINLINE const CHdr& Hdr() const { return *(CHdr*)(((int8*)m_items) - ThdrSize); }
/** return reference to the block reference counter */
FORCEINLINE int& RefCnt() { return Hdr().m_ref_cnt; }
/** return reference to number of used items */
FORCEINLINE int& SizeRef() { return Hdr().m_num_items; }
public:
/** return number of used items */
FORCEINLINE int Size() const { return Hdr().m_num_items; }
/** return true if array is full */
FORCEINLINE bool IsFull() const { return Size() >= Tcapacity; };
/** return true if array is empty */
FORCEINLINE bool IsEmpty() const { return Size() <= 0; };
/** index validation */
FORCEINLINE void CheckIdx(int idx) const { assert(idx >= 0); assert(idx < Size()); }
/** add (allocate), but don't construct item */
FORCEINLINE Titem& AddNC() { assert(!IsFull()); return m_items[SizeRef()++]; }
/** add and construct item using default constructor */
FORCEINLINE Titem& Add() { Titem& item = AddNC(); new(&item)Titem; return item; }
/** return item by index (non-const version) */
FORCEINLINE Titem& operator [] (int idx) { CheckIdx(idx); return m_items[idx]; }
/** return item by index (const version) */
FORCEINLINE const Titem& operator [] (int idx) const { CheckIdx(idx); return m_items[idx]; }
};
#endif /* FIXEDSIZEARRAY_HPP */
|
