summaryrefslogtreecommitdiffstats
path: root/clib/list_iter.h
blob: d9cfcecc2c01574e55e6e8ebcd0c2f2c96f6cc46 (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
/*
 * Copyright (c) International Business Machines Corp., 2014
 *
 * This program 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; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 this program.  If not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 */

/*! @file list_iter.h
 *  @brief List iterator
 *  @details For example,
 *  @code
 *  ...
 *  data_t * d;
 *  ...
 *  list_iter_t it;
 *  list_iter_init(&it, &t, LI_FLAG_FWD);
 *  ...
 *  list_for_each(&it, d, node) {
 *      printf("forward i[%d] f[%f]\n", d->i, d->f);
 *  }
 *  ...
 *  @endcode
 *  @author Shaun Wetzstein <shaun@us.ibm.com>
 *  @date 2010-2011
 */

#ifndef __LIST_ITER_H__
#define __LIST_ITER_H__

#include <stdbool.h>
#include <stdint.h>

#include "builtin.h"
#include "list.h"
#include "nargs.h"

/* ======================================================================= */

typedef struct list_iter list_iter_t;	//!< Alias for the @em list_iter class

/*!
 * @brief list iterator
 * @details list iterator class
*/
struct list_iter {
	list_t *list;		//!< Reference to the target list object
	list_node_t *node;	//!< Current position of the iterator
	uint32_t flags;		//!< Iterator configuration flags
};

/* ======================================================================= */

#define LI_FLAG_NONE		0x00000000	//!< No flag mask
#define LI_FLAG_FWD		0x00000000	//!< Forward (FWD) flag mask
#define LI_FLAG_BWD		0x00000002	//!< Backward (BWD) flag mask
#define LI_FLAG_MASK		0x00000003	//!< All flags mask

/*!
 * @brief Initializes an @em list_iter iterator object
 * @details For example,
 * @code
 * ...
 * list_t l;
 * list_init(&l);
 * ...
 * list_iter_t it;
 * list_iter_init(&it, &l, LI_FLAG_FWD);
 * ...
 * @endcode
 * @memberof list_iter
 * @param self [in] list_iter object @em self pointer
 * @param list [in] list container object to iterate
 * @param flags [in] iterator configuration flags
 * @return None
 * @throws UNEXPECTED if @em self pointer is NULL
 * @throws UNEXPECTED if @em list pointer is NULL
 */
extern void list_iter_init(list_iter_t * self, list_t * list, uint32_t flags)
/*! @cond */
__nonnull((1, 2)) /*! @endcond */ ;

/*!
 * @brief Resets a @em list iterator object
 * @details For example,
 * @code
 * ...
 * list_t l;
 * list_init(&l);
 * ...
 * list_iter_t it;
 * list_iter_init(&it, &l, l_FLAG_FWD);
 * list_iter_clear(&it);
 * ...
 * @endcode
 * @memberof list_iter
 * @param self [in] list_iter object @em self pointer
 * @return None
 * @throws UNEXPECTED if @em self pointer is NULL
 */
extern void list_iter_clear(list_iter_t * self)
/*! @cond */
__nonnull((1)) /*! @endcond */ ;

/*!
 * @brief Return a pointer to @em list element bytes at the current iterator position
 * @details For example,
 * @code
 * ...
 * list_t l;
 * list_init(&l, 4, 1024);
 * ...
 * list_iter_t it;
 * list_iter_init(&it, &l, LI_FLAG_FWD);
 * ...
 * data_t * d = (data_t *)list_iter_elem(&it);
 * ...
 * @endcode
 * @memberof list_iter
 * @param self [in] list_iter object @em self pointer
 * @return non-NULL on success, NULL otherwise
 * @throws UNEXPECTED if @em self pointer is NULL
 */
extern list_node_t *list_iter_elem(list_iter_t * self)
/*! @cond */
__nonnull((1)) /*! @endcond */ ;

/*!
 * @fn list_node_t * list_iter_inc(list_iter_t * self, size_t count = 1)
 * @brief Increment the position of an @em list iterator
 * @details If the second (2nd) parameter is omitted, the iterator is incremented by one (1) position.
 * @details For example,
 * @code
 * ...
 * list_t l;
 * list_init(&l);
 * ...
 * list_iter_t it;
 * list_iter_init(&it, &l, LI_FLAG_FWD);
 * ...
 * list_iter_inc(&it);
 * ...
 * @endcode
 * @memberof list_iter
 * @param self [in] list_iter object @em self pointer
 * @param count [in] Number of positions to increment (optional)
 * @return None
 * @throws UNEXPECTED if @em self pointer is NULL
 */
/*! @cond */
#define list_iter_inc(...) STRCAT(list_iter_inc, NARGS(__VA_ARGS__))(__VA_ARGS__)
extern list_node_t *list_iter_inc1(list_iter_t * self)
/*! @cond */
__nonnull((1)) /*! @endcond */ ;
extern list_node_t *list_iter_inc2(list_iter_t * self, size_t count)
/*! @cond */
__nonnull((1)) /*! @endcond */ ;
/*! @endcond */

/*!
 * @fn list_node_td * list_iter_dec(list_iter_t * self, size_t count = 1)
 * @brief decrement the position of an @em list iterator
 * @note If the second (2nd) parameter is omitted, the iterator is decremented by one (1) position.
 * @details For example,
 * @code
 * ...
 * list_t l;
 * list_init(&l);
 * ...
 * list_iter_t it;
 * list_iter_init(&it, &l, LI_FLAG_FWD);
 * ...
 * list_iter_dec(&it, 3);
 * ...
 * @endcode
 * @memberof list_iter
 * @param self [in] list_iter object @em self pointer
 * @param count [in] Number of positions to decrement (optional)
 * @return None
 * @throws UNEXPECTED if @em self pointer is NULL
 */
/*! @cond */
#define list_iter_dec(...) STRCAT(list_iter_dec, NARGS(__VA_ARGS__))(__VA_ARGS__)
extern list_node_t *list_iter_dec1(list_iter_t * self)
/*! @cond */
__nonnull((1)) /*! @endcond */ ;
extern list_node_t *list_iter_dec2(list_iter_t * self, size_t count)
/*! @cond */
__nonnull((1)) /*! @endcond */ ;
/*! @endcond */

/*!
 * @def list_for_each(it, i, m)
 * @hideinitializer
 * @brief List for-each algorithm
 * @param it [in] Tree iterator object
 * @param i [in] Tree element variable
 * @param m [in] Member name
 */
#if 0
#define list_for_each(l, i, m)				\
    for (i = container_of_var(l->node.next, i, m);	\
        &i->m != &(l)->node;				\
        i = container_of_var(i->m.next, i, m))
#define list_for_each_safe(l, i, n, m)			\
    for (i = container_of_var((l)->node.next, i, m),	\
            n = container_of_var(i->m.next, i, m);	\
        &i->m != &(l)->node;				\
        i = n, n = container_of_var(i->m.next, i, m))
#endif

#define list_for_each(it, i, m)					\
    for (i = container_of_var(list_iter_elem(it), i, m);	\
         list_iter_inc(it) != NULL;				\
         i = container_of_var(list_iter_elem(it), i, m))

#endif				/* __LIST_ITER_H__ */
OpenPOWER on IntegriCloud