summaryrefslogtreecommitdiff
path: root/support/dktools/Dk4Container.h
blob: 4a616209a8b87dd021fca99c999cf3b4f014b3bc (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
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
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
/*
	WARNING: This file was generated by dkct.
	Changes you make here will be lost if dkct is run again!
	You should modify the original source and run dkct on it.
	Original source: Dk4Container.cpt
*/

/*
Copyright (C) 2013-2017, Dirk Krause

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 opyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.
* Neither the name of the author nor the names of contributors may be used
  to endorse or promote products derived from this software without specific
  prior written permission.

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 COPYRIGHT OWNER 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.
*/

/**	@file Dk4Container.h Header file for the Dk4Container module.
*/

#ifndef DK4CONTAINER_H_INCLUDED
/** Avoid multiple inclusions. */
#define DK4CONTAINER_H_INCLUDED 1


#line 8 "Dk4Container.cpt"

#include <dk4error.h>
#include <dk4sto.h>

#include <stdexcept>
#include <new>

#include "Dk4Comparable.h"


namespace DkTools4 {

  template<class T> class Container;
  template<class T> class Iterator;

  /**	A container class for  sorted storage.
  	The objects must be derived from the Comparable class.
  */
  template<class T>
  class Container
  {
    friend class Iterator<T>;

    private:

      /**	Storage to store elements.
      */
      dk4_sto_t	*sto;

      /**	Iterator, used in destructor.
      */
      dk4_sto_it_t	*it;

      /**	Comparison criteria for ordering elements.
      */
      int	 cr;

      /**	Flag: Container is owner of the objects and in charge
      		for destruction.
      */
      bool	 bOwner;

    public:
      /**	Create container.
      		@param	crit	Sort criteria for objects in container.
		@param	owner	Owner flag value. If a container is the
		owner of the objects stored in it, the objects are deleted
		in the containers destructor.
      */
      Container<T>(int crit, bool owner = false) throw (std::bad_alloc);

      /**	Destructor.
      */
      ~Container<T>();

      /**	Add an object to the container.
      		@param	ptr	Pointer to add.
		@return	True on success, false on error (object not added).
      */
      bool
      add(T *ptr);

      /**	Remove object from container.
      		@param	ptr	Pointer to remove.
		@return	True on success, false on error.
      */
      bool
      remove(T *ptr);

      /**	Check owner flag.
      		@return	Owner flag value.
      */
      void
      isOwner(void) const;

      /**	Reset iterator.
      */
      void
      reset(void);

      /**	Set iterator to exact position.
      		@param	data
		@param	crit
		@return	Pointer to found object on success, NULL otherwise.
      */
      T *
      findExact(void const *data, int crit);

      /**	Set iterator to object evaluating equally.
      		@param	data
		@param	crit
		@return	Pointer to found object on success, NULL otherwise.
      */
      T *
      findLike(void const *data, int crit);

      /**	Step to next element.
      		@return	Pointe to next object (if there is one), NULL
		if there is no next object.
      */
      T *
      next(void);



  };	/* End of class Container */

  /**	An iterator class to traverse a Containter.
  */
  template<class T>
  class Iterator
  {
    private:
      /**	Low-level iterator.
      */
      dk4_sto_it_t	*it;

    public:
      /**	Constructor.
      		@param	cont	Container for which the iterator is for.
      */
      Iterator<T>(Container<T>& cont) throw (std::bad_alloc);

      /**	Destructor.
      */
      ~Iterator<T>();

      /**	Reset iterator.
      */
      void
      reset(void);

      /**	Set iterator to exact position.
      		@param	data
		@param	crit
		@return	Pointer to found object on success, NULL otherwise.
      */
      T *
      findExact(void const *data, int crit);

      /**	Set iterator to object evaluating equally.
      		@param	data
		@param	crit
		@return	Pointer to found object on success, NULL otherwise.
      */
      T *
      findLike(void const *data, int crit);

      /**	Step to next element.
      		@return	Pointe to next object (if there is one), NULL
		if there is no next object.
      */
      T *
      next(void);

  };	/* End of class Iterator */


}	/* End of namespace DkTools4 */



/* ************************************************************************ */
/* *                                                                      * */
/* *         Implementation for container methods.                        * */
/* *                                                                      * */
/* ************************************************************************ */


#line 173 "Dk4Container.cpt"

template<class T>
DkTools4::Container<T>::Container(int crit, bool owner) throw (std::bad_alloc)
{
  bool	mustThrow = true;

  bOwner = owner;
  cr = crit;
  it = NULL;
  sto = dk4sto_open(NULL);
  if(NULL != sto) {
    dk4sto_set_comp(sto,DkTools4::Comparable::compareTwoPointers,crit);
    it = dk4sto_it_open(sto, NULL);
    if (NULL != it) {
      mustThrow = false;
    } else {
      dk4sto_close(sto);
      sto = NULL;
    }
  }
  if (mustThrow) {
    throw(std::bad_alloc());
  }
}



/*	The destructor is also called when an exception is thrown by
	the constructor. So we must check the sto and it component for
	being not NULL.
*/

template<class T>
DkTools4::Container<T>::~Container<T>()
{
  T *ptr;

  if (NULL != it) {
    if (bOwner) {
      dk4sto_it_reset(it);
      while(NULL != (ptr = (T *)dk4sto_it_next(it))) {
        delete ptr;
      }
    }
    dk4sto_it_close(it);
  }
  if (NULL != sto) {
    dk4sto_close(sto);
  }
  sto = NULL;
  it  = NULL;
  cr  = 0;
  bOwner = false;
}



/*	The remaining container methods are not called if there was
	an exception from the constructor. So no NULL pointer checks
	are necessary here.
*/


template<class T>
bool
DkTools4::Container<T>::add(T *ptr)
{
  bool back = false;
  if(0 != dk4sto_add(sto, (void *)ptr, NULL)) {
    back = true;
  }
  return back;
}



template<class T>
bool
DkTools4::Container<T>::remove(T *ptr)
{
  bool back = false;
  if(0 != dk4sto_remove(sto, (void *)ptr, NULL)) {
    back = true;
  }
  return back;
}



template<class T>
void
DkTools4::Container<T>::isOwner(void) const
{
  return bOwner;
}



/*	The remaining iterator methods are not invoked if the constructor
	throws an exception, so we do not need to check the it component.
*/

template<class T>
void
DkTools4::Container<T>::reset(void)
{
  dk4sto_it_reset(it);
}



template<class T>
T *
DkTools4::Container<T>::findExact(void const *data, int crit)
{
  T *back = NULL;
  back = (T *)dk4sto_it_find_exact(it, data);
  return back;
}



template<class T>
T *
DkTools4::Container<T>::findLike(void const *data, int crit)
{
  T *back;
  back = (T *)dk4sto_it_find_like(it, data, crit);
  return back;
}



template<class T>
T *
DkTools4::Container<T>::next(void)
{
  T *back = NULL;
  back = (T *)dk4sto_it_next(it);
  return back;
}



/* ************************************************************************ */
/* *                                                                      * */
/* *         Implementation for iterator methods.                         * */
/* *                                                                      * */
/* ************************************************************************ */


#line 320 "Dk4Container.cpt"

template<class T>
DkTools4::Iterator<T>::Iterator(Container<T>& cont) throw (std::bad_alloc)
{
  it = dk4sto_it_open(cont.sto, NULL);
  if(NULL != it) {
    dk4sto_it_reset(it);
  } else {
    throw(std::bad_alloc());
  }
}



/*	The iterators destructor is also invoked if the constructor throws
	an exception. So we must check the it component to be not NULL.
*/

template<class T>
DkTools4::Iterator<T>::~Iterator<T>()
{
  if (NULL != it) {
    dk4sto_it_close(it); it = NULL;
  }
}



/*	The remaining iterator methods are not invoked if the constructor
	throws an exception, so we do not need to check the it component.
*/

template<class T>
void
DkTools4::Iterator<T>::reset(void)
{
  dk4sto_it_reset(it);
}



template<class T>
T *
DkTools4::Iterator<T>::findExact(void const *data, int crit)
{
  T *back = NULL;
  back = (T *)dk4sto_it_find_exact(it, data);
  return back;
}



template<class T>
T *
DkTools4::Iterator<T>::findLike(void const *data, int crit)
{
  T *back;
  back = (T *)dk4sto_it_find_like(it, data, crit);
  return back;
}



template<class T>
T *
DkTools4::Iterator<T>::next(void)
{
  T *back = NULL;
  back = (T *)dk4sto_it_next(it);
  return back;
}


#endif