summaryrefslogtreecommitdiffstats
path: root/clib/map_iter.h
blob: 5954e63f7cad34519f4cb31a35566fede3f1ac1c (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
/*
 * 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: map_iter.h
 * Author: Shaun Wetzstein <shaun@us.ibm.com>
 *  Descr: Iterator for the Map container
 *   Note:
 *   Date: 10/22/10
 */

#ifndef __MAP_ITER_H__
#define __MAP_ITER_H__

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

#include "builtin.h"

#include "map.h"
#include "tree_iter.h"

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

typedef tree_iter_t map_iter_t;

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

#define MI_FLAG_NONE		TI_FLAG_NONE
#define MI_FLAG_FWD		TI_FLAG_FWD
#define MI_FLAG_BWD		TI_FLAG_BWD

/*!
 * @brief Initializes an @em map_iter iterator object
 * @memberof map_iter
 * @param self [in] map_iter object @em self pointer
 * @param map [in] map container object to iterate
 * @param flags [in] iterator configuration flags
 * @return None
 * @throws UNEXPECTED if @em self pointer is NULL
 * @throws UNEXPECTED if @em map pointer is NULL
 */
static inline int map_iter_init(map_iter_t *, map_t *, uint32_t)
/*! @cond */
__nonnull((1, 2)) /*! @endcond */ ;

/*!
 * @brief Resets an @em map iterator object
 * @memberof map_iter
 * @param self [in] map_iter object @em self pointer
 * @return None
 * @throws UNEXPECTED if @em self pointer is NULL
 */
static inline int map_iter_clear(map_iter_t *)
/*! @cond */
__nonnull((1)) /*! @endcond */ ;

/*!
 * @brief Return a pointer to a @em map_node element at the current iterator
 * position
 * @memberof map_iter
 * @param self [in] map_iter object @em self pointer
 * @return non-NULL on success, NULL otherwise
 * @throws UNEXPECTED if @em self pointer is NULL
 */
static inline map_node_t *map_iter_elem(map_iter_t *)
/*! @cond */
__nonnull((1)) /*! @endcond */ ;

/*!
 * @brief Increment the position of an @em map iterator
 * @memberof map_iter
 * @param self [in] map_iter object @em self pointer
 * @param count [in] Number of positions to increment
 * @return None
 * @throws UNEXPECTED if @em self pointer is NULL
 */
static inline map_node_t *map_iter_inc(map_iter_t *)
/*! @cond */
__nonnull((1)) /*! @endcond */ ;

/*!
 * @brief Decrement the position of an @em map iterator
 * @memberof map_iter
 * @param self [in] map_iter object @em self pointer
 * @param count [in] Number of positions to decrement
 * @return None
 * @throws UNEXPECTED if @em self pointer is NULL
 */
static inline map_node_t *map_iter_dec(map_iter_t *)
/*! @cond */
__nonnull((1)) /*! @endcond */ ;

/*!
 * @def map_for_each(it, i, m)
 * @hideinitializer
 * @brief Tree for-each algorithm
 * @param it [in] Tree iterator object
 * @param i [in] Tree element variable
 * @param m [in] Member name
 */
#define map_for_each(it, i, m)						    \
    for (map_iter_clear(it), i = container_of_var(map_iter_elem(it), i, m); \
         map_iter_elem(it) != NULL;					    \
         i = container_of_var(map_iter_inc(it), i, m))

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

static inline int map_iter_init(map_iter_t * self, map_t * map, uint32_t flags)
{
	assert(self != NULL);
	assert(map != NULL);
	return tree_iter_init((tree_iter_t *) self, (tree_t *) map, flags);
}

int map_iter_clear(map_iter_t * self)
{
	assert(self != NULL);
	return tree_iter_clear((tree_iter_t *) self);
}

static inline map_node_t *map_iter_elem(map_iter_t * self)
{
	assert(self != NULL);
	return (map_node_t *) tree_iter_elem((tree_iter_t *) self);
}

static inline map_node_t *map_iter_inc(map_iter_t * self)
{
	assert(self != NULL);
	return (map_node_t *) tree_iter_inc((tree_iter_t *) self);
}

static inline map_node_t *map_iter_dec(map_iter_t * self)
{
	assert(self != NULL);
	return (map_node_t *) tree_iter_dec((tree_iter_t *) self);
}

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

#endif				/* __MAP_ITER_H__ */
OpenPOWER on IntegriCloud