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
109
110
111
112
113
114
115
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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org 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 Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef ARY_STORE_S_STORAGE_HXX
#define ARY_STORE_S_STORAGE_HXX
// USED SERVICES
#include <ary/types.hxx>
#include "s_iterator.hxx"
namespace ary
{
namespace stg
{
/** The storage unit of one class of commomly stored repository
entities.
*/
template <class ENTITY>
class Storage
{
public:
typedef Base<ENTITY> container_type;
typedef ary::TypedId<ENTITY> key_type;
typedef stg::const_iterator<ENTITY> c_iter;
typedef stg::iterator<ENTITY> iter;
// LIFECYCLE
virtual ~Storage() {}
// OPERATORS
const ENTITY & operator[](
key_type i_id ) const;
ENTITY & operator[](
key_type i_id );
const ENTITY & operator[](
Rid i_index ) const;
ENTITY & operator[](
Rid i_index );
// OPERATIONS
/// Sets the id of the new entity.
key_type Store_Entity(
DYN ENTITY & pass_newEntity );
/// Sets the id of the new entity.
void Set_Reserved(
uintt i_index,
DYN ENTITY & pass_newEntity );
/// Sets the id of the new entity.
void Replace_Entity(
key_type i_index,
DYN ENTITY & pass_newEntity );
// INQUIRY
bool Exists(
key_type i_id ) const;
bool Exists(
Rid i_index ) const;
c_iter Begin() const;
c_iter BeginUnreserved() const;
c_iter End() const;
// ACCESS
iter Begin();
iter BeginUnreserved();
iter End();
protected:
Storage(
uintt i_nrOfReservedItems );
private:
// DATA
container_type aData;
};
// IMPLEMENTATION
// Used later, so implemented first.
template <class ENTITY>
inline bool
Storage<ENTITY>::Exists(Rid i_index) const
{
return 0 < i_index AND i_index < aData.Size();
}
template <class ENTITY>
inline bool
Storage<ENTITY>::Exists(key_type i_id) const
{
return Exists(i_id.Value());
}
template <class ENTITY>
inline const ENTITY &
Storage<ENTITY>::operator[](Rid i_index) const
{
csv_assert(Exists(i_index));
return * aData[i_index];
}
template <class ENTITY>
inline ENTITY &
Storage<ENTITY>::operator[](Rid i_index)
{
csv_assert(Exists(i_index));
return * aData[i_index];
}
template <class ENTITY>
inline const ENTITY &
Storage<ENTITY>::operator[](key_type i_id) const
{
return operator[](i_id.Value());
}
template <class ENTITY>
inline ENTITY &
Storage<ENTITY>::operator[](key_type i_id)
{
return operator[](i_id.Value());
}
template <class ENTITY>
typename Storage<ENTITY>::key_type
Storage<ENTITY>::Store_Entity(DYN ENTITY & pass_newEntity)
{
csv_assert( aData.Size() >= aData.ReservedSize() );
Rid
ret( aData.Add_Entity(pass_newEntity) );
pass_newEntity.Set_Id(ret);
return key_type(ret);
}
template <class ENTITY>
void
Storage<ENTITY>::Set_Reserved(uintt i_index,
DYN ENTITY & pass_newEntity)
{
// 0 must not be used.
csv_assert( i_index != 0 );
// Make sure, i_index actually is the id of a reserved item.
csv_assert( i_index < aData.ReservedSize() );
// If there was a previous entity, it will be deleted by
// the destructor of pOldEntity.
Dyn<ENTITY>
pOldEntity(aData.Set_Entity(i_index, pass_newEntity));
pass_newEntity.Set_Id(i_index);
}
template <class ENTITY>
void
Storage<ENTITY>::Replace_Entity( key_type i_index,
DYN ENTITY & pass_newEntity )
{
uintt
nIndex = i_index.Value();
// Make sure, i_index actually is the id of an existing,
// non reserved entity.
csv_assert( csv::in_range(aData.ReservedSize(), nIndex, aData.Size()) );
// If there was a previous entity, it will be deleted by
// the destructor of pOldEntity.
Dyn<ENTITY>
pOldEntity(aData.Set_Entity(nIndex, pass_newEntity));
pass_newEntity.Set_Id(nIndex);
}
template <class ENTITY>
inline
typename Storage<ENTITY>::c_iter
Storage<ENTITY>::Begin() const
{
return c_iter(aData.Begin());
}
template <class ENTITY>
inline
typename Storage<ENTITY>::c_iter
Storage<ENTITY>::BeginUnreserved() const
{
return c_iter(aData.BeginUnreserved());
}
template <class ENTITY>
inline
typename Storage<ENTITY>::c_iter
Storage<ENTITY>::End() const
{
return c_iter(aData.End());
}
template <class ENTITY>
inline
typename Storage<ENTITY>::iter
Storage<ENTITY>::Begin()
{
return iter(aData.Begin());
}
template <class ENTITY>
inline
typename Storage<ENTITY>::iter
Storage<ENTITY>::BeginUnreserved()
{
return iter(aData.BeginUnreserved());
}
template <class ENTITY>
inline
typename Storage<ENTITY>::iter
Storage<ENTITY>::End()
{
return iter(aData.End());
}
template <class ENTITY>
inline
Storage<ENTITY>::Storage(uintt i_nrOfReservedItems)
: aData(i_nrOfReservedItems)
{
// Make sure Rid and uintt are the same type, because
// the interface of this uses Rid, but the interface of
// container_type uses uintt.
csv_assert( sizeof(uintt) == sizeof(Rid) );
}
// HELPER FUNCTIONS
/** @return 0, if data are not there.
*/
template <class ENTITY>
inline const ENTITY *
Search( const Storage<ENTITY> & i_storage,
Rid i_id )
{
if (NOT i_storage.Exists(i_id))
return 0;
return &i_storage[i_id];
}
/** @return 0, if data are not there.
*/
template <class ENTITY>
inline ENTITY *
SearchAccess( const Storage<ENTITY> & i_storage,
Rid i_id )
{
if (NOT i_storage.Exists(i_id))
return 0;
return &i_storage[i_id];
}
} // namespace stg
} // namespace ary
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
