File: iterator_tpl.h

package info (click to toggle)
libatomicbitvector 0.0%2Bgit20200519.e295358-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 148 kB
  • sloc: ansic: 245; cpp: 154; sh: 11; makefile: 8
file content (374 lines) | stat: -rw-r--r-- 12,035 bytes parent folder | download | duplicates (3)
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
#ifndef _iterator_tpl_h_
#define _iterator_tpl_h_

namespace iterator_tpl {

// Use this define to declare both:
// - `iterator`
// - `const_iterator`:
// As members of your class
#define SETUP_ITERATORS(C, T, S)  \
  SETUP_MUTABLE_ITERATOR(C, T, S) \
  SETUP_CONST_ITERATOR(C, T, S)

// Use this define to declare only `iterator`
#define SETUP_MUTABLE_ITERATOR(C, T, S)              \
  typedef iterator_tpl::iterator<C, T, S> iterator;  \
  iterator begin() { return iterator::begin(this); } \
  iterator end()   { return iterator::end(this);   }

// Use this define to declare only `const_iterator`
#define SETUP_CONST_ITERATOR(C, T, S)                                  \
  typedef iterator_tpl::const_iterator<C, T, S> const_iterator;        \
  const_iterator begin() const { return const_iterator::begin(this); } \
  const_iterator end()   const { return const_iterator::end(this);   }

// S should be the state struct used to forward iteration:
#define SETUP_REVERSE_ITERATORS(C, T, S)                            \
  struct S##_reversed : public S {                                  \
    inline void next (const C* ref) { S::prev(ref); }               \
    inline void prev (const C* ref) { S::next(ref); }               \
    inline void begin(const C* ref) { S::end(ref); S::prev(ref);}   \
    inline void end  (const C* ref) { S::begin(ref); S::prev(ref);} \
  };                                                                \
  SETUP_MUTABLE_RITERATOR(C, T, S)                                  \
  SETUP_CONST_RITERATOR(C, T, S)

#define SETUP_MUTABLE_RITERATOR(C, T, S) \
  typedef iterator_tpl::iterator<C, T, S##_reversed > reverse_iterator; \
  reverse_iterator rbegin() { return reverse_iterator::begin(this); }   \
  reverse_iterator rend()   { return reverse_iterator::end(this); }     \

#define SETUP_CONST_RITERATOR(C, T, S)                                              \
  typedef iterator_tpl::const_iterator<C, T, S##_reversed > const_reverse_iterator; \
  const_reverse_iterator rbegin() const {                                           \
    return const_reverse_iterator::begin(this);                                     \
  }                                                                                 \
  const_reverse_iterator rend() const {                                             \
    return const_reverse_iterator::end(this);                                       \
  }

#define STL_TYPEDEFS(T)                    \
  typedef std::ptrdiff_t difference_type;  \
  typedef size_t size_type;                \
  typedef T value_type;                    \
  typedef T* pointer;                      \
  typedef const T* const_pointer;          \
  typedef T& reference;                    \
  typedef const T& const_reference

// Forward declaration of const_iterator:
template <class C, typename T, class S>
struct const_iterator;

/* * * * * MUTABLE ITERATOR TEMPLATE: * * * * */

// C - The container type
// T - The content type
// S - The state keeping structure
template <class C, typename T, class S>
// The non-specialized version is used for T=rvalue:
struct iterator {
  // Keeps a reference to the container:
  C* ref;

  // User defined struct to describe the iterator state:
  // This struct should provide the functions listed below,
  // however, note that some of them are optional
  S state;

  // Set iterator to next() state:
  void next()  { state.next(ref);  }
  // Initialize iterator to first state:
  void begin() { state.begin(ref); }
  // Initialize iterator to end state:
  void end()   { state.end(ref);   }
  // Returns current `value`
  T get() { return state.get(ref); }
  // Return true if `state != s`:
  bool cmp(const S& s) const { return state.cmp(s); }

  // Optional function for reverse iteration:
  void prev() { state.prev(ref); }

 public:
  static iterator begin(C* ref) {
    iterator it(ref);
    it.begin();
    return it;
  }
  static iterator end(C* ref) {
    iterator it(ref);
    it.end();
    return it;
  }

 protected:
  iterator(C* ref) : ref(ref) {}

 public:
  // Note: Instances build with this constructor should
  // be used only after copy-assigning from other iterator!
  iterator() {}

 public:
  T operator*() { return get(); }
  iterator& operator++() { next(); return *this; }
  iterator operator++(int) { iterator temp(*this); next(); return temp; }
  iterator& operator--() { prev(); return *this; }
  iterator operator--(int) { iterator temp(*this); prev(); return temp; }
  bool operator!=(const iterator& other) const {
    return ref != other.ref || cmp(other.state);
  }
  bool operator==(const iterator& other) const {
    return !operator!=(other);
  }

  friend struct iterator_tpl::const_iterator<C,T,S>;

  // Comparisons between const and normal iterators:
  bool operator!=(const const_iterator<C,T,S>& other) const {
    return ref != other.ref || cmd(other.state);
  }
  bool operator==(const const_iterator<C,T,S>& other) const {
    return !operator!=(other);
  }
};

template <class C, typename T, class S>
// This specialization is used for iterators to reference types:
struct iterator<C,T&,S> {
  // Keeps a reference to the container:
  C* ref;

  // User defined struct to describe the iterator state:
  // This struct should provide the functions listed below,
  // however, note that some of them are optional
  S state;

  // Set iterator to next() state:
  void next()  { state.next(ref);  }
  // Initialize iterator to first state:
  void begin() { state.begin(ref); }
  // Initialize iterator to end state:
  void end()   { state.end(ref);   }
  // Returns current `value`
  T& get() { return state.get(ref); }
  // Return true if `state != s`:
  bool cmp(const S& s) const { return state.cmp(s); }

  // Optional function for reverse iteration:
  void prev() { state.prev(ref); }

 public:
  static iterator begin(C* ref) {
    iterator it(ref);
    it.begin();
    return it;
  }
  static iterator end(C* ref) {
    iterator it(ref);
    it.end();
    return it;
  }

 protected:
  iterator(C* ref) : ref(ref) {}

 public:
  // Note: Instances build with this constructor should
  // be used only after copy-assigning from other iterator!
  iterator() {}

 public:
  T& operator*()  { return  get(); }
  T* operator->() { return &get(); }
  iterator& operator++() { next(); return *this; }
  iterator operator++(int) { iterator temp(*this); next(); return temp; }
  iterator& operator--() { prev(); return *this; }
  iterator operator--(int) { iterator temp(*this); prev(); return temp; }
  bool operator!=(const iterator& other) const {
    return ref != other.ref || cmp(other.state);
  }
  bool operator==(const iterator& other) const {
    return !operator!=(other);
  }

  friend struct iterator_tpl::const_iterator<C,T&,S>;

  // Comparisons between const and normal iterators:
  bool operator!=(const const_iterator<C,T&,S>& other) const {
    return ref != other.ref || cmd(other.state);
  }
  bool operator==(const const_iterator<C,T&,S>& other) const {
    return !operator!=(other);
  }
};

/* * * * * CONST ITERATOR TEMPLATE: * * * * */

// C - The container type
// T - The content type
// S - The state keeping structure
template <class C, typename T, class S>
// The non-specialized version is used for T=rvalue:
struct const_iterator {
  // Keeps a reference to the container:
  const C* ref;

  // User defined struct to describe the iterator state:
  // This struct should provide the functions listed below,
  // however, note that some of them are optional
  S state;

  // Set iterator to next() state:
  void next()  { state.next(ref);  }
  // Initialize iterator to first state:
  void begin() { state.begin(ref); }
  // Initialize iterator to end state:
  void end()   { state.end(ref);   }
  // Returns current `value`
  const T get() { return state.get(ref); }
  // Return true if `state != s`:
  bool cmp(const S& s) const { return state.cmp(s); }

  // Optional function for reverse iteration:
  void prev() { state.prev(ref); }

 public:
  static const_iterator begin(const C* ref) {
    const_iterator it(ref);
    it.begin();
    return it;
  }
  static const_iterator end(const C* ref) {
    const_iterator it(ref);
    it.end();
    return it;
  }

 protected:
  const_iterator(const C* ref) : ref(ref) {}

 public:
  // Note: Instances build with this constructor should
  // be used only after copy-assigning from other iterator!
  const_iterator() {}

  // To make possible copy-construct non-const iterators:
  const_iterator(const iterator<C,T,S>& other) : ref(other.ref) {
    state = other.state;
  }

 public:
  const T operator*() { return get(); }
  const_iterator& operator++() { next(); return *this; }
  const_iterator operator++(int) { const_iterator temp(*this); next(); return temp;  }
  const_iterator& operator--() { prev(); return *this; }
  const_iterator operator--(int) { const_iterator temp(*this); prev(); return temp;  }
  bool operator!=(const const_iterator& other) const {
    return ref != other.ref || cmp(other.state);
  }
  bool operator==(const const_iterator& other) const {
    return !operator!=(other);
  }
  const_iterator& operator=(const iterator<C,T,S>& other) {
    ref = other.ref;
    state = other.state;
    return *this;
  }

  friend struct iterator_tpl::iterator<C,T,S>;

  // Comparisons between const and normal iterators:
  bool operator!=(const iterator<C,T,S>& other) const {
    return ref != other.ref || cmp(other.state);
  }
  bool operator==(const iterator<C,T,S>& other) const {
    return !operator!=(other);
  }
};

// This specialization is used for iterators to reference types:
template <class C, typename T, class S>
struct const_iterator<C,T&,S> {
  // Keeps a reference to the container:
  const C* ref;

  // User defined struct to describe the iterator state:
  // This struct should provide the functions listed below,
  // however, note that some of them are optional
  S state;

  // Set iterator to next() state:
  void next()  { state.next(ref);  }
  // Initialize iterator to first state:
  void begin() { state.begin(ref); }
  // Initialize iterator to end state:
  void end()   { state.end(ref);   }
  // Returns current `value`
  const T& get() { return state.get(ref); }
  // Return true if `state != s`:
  bool cmp(const S& s) const { return state.cmp(s); }

  // Optional function for reverse iteration:
  void prev() { state.prev(ref); }

 public:
  static const_iterator begin(const C* ref) {
    const_iterator it(ref);
    it.begin();
    return it;
  }
  static const_iterator end(const C* ref) {
    const_iterator it(ref);
    it.end();
    return it;
  }

 protected:
  const_iterator(const C* ref) : ref(ref) {}

 public:
  // Note: Instances build with this constructor should
  // be used only after copy-assigning from other iterator!
  const_iterator() {}

  // To make possible copy-construct non-const iterators:
  const_iterator(const iterator<C,T&,S>& other) : ref(other.ref) {
    state = other.state;
  }

 public:
  const T& operator*()  { return  get(); }
  const T* operator->() { return &get(); }
  const_iterator& operator++() { next(); return *this; }
  const_iterator operator++(int) { const_iterator temp(*this); next(); return temp; }
  const_iterator& operator--() { prev(); return *this; }
  const_iterator operator--(int) { const_iterator temp(*this); prev(); return temp; }
  bool operator!=(const const_iterator& other) const {
    return ref != other.ref || cmp(other.state);
  }
  bool operator==(const const_iterator& other) const {
    return !operator!=(other);
  }
  const_iterator& operator=(const iterator<C,T&,S>& other) {
    ref = other.ref;
    state = other.state;
    return *this;
  }

  friend struct iterator_tpl::iterator<C,T&,S>;

  // Comparisons between const and normal iterators:
  bool operator!=(const iterator<C,T&,S>& other) const {
    return ref != other.ref || cmp(other.state);
  }
  bool operator==(const iterator<C,T&,S>& other) const {
    return !operator!=(other);
  }
};

}  // namespace iterator_tpl

#endif