1 /* iterator.c generated by valac 0.19.0.4-d6d4, the Vala compiler
2 * generated from iterator.vala, do not modify */
3
4 /* iterator.vala
5 *
6 * Copyright (C) 2007-2008 Jürg Billeter
7 * Copyright (C) 2009 Didier Villevalois, Maciej Piechotka
8 *
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public
11 * License as published by the Free Software Foundation; either
12 * version 2.1 of the License, or (at your option) any later version.
13
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
18
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this library; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22 *
23 * Author:
24 * Jürg Billeter <j@bitron.ch>
25 * Maciej Piechotka <uzytkownik2@gmail.com>
26 * Didier 'Ptitjes Villevalois <ptitjes@free.fr>
27 */
28
29 #include <glib.h>
30 #include <glib-object.h>
31
32
33 #define GEE_TYPE_ITERATOR (gee_iterator_get_type ())
34 #define GEE_ITERATOR(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GEE_TYPE_ITERATOR, GeeIterator))
35 #define GEE_IS_ITERATOR(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GEE_TYPE_ITERATOR))
36 #define GEE_ITERATOR_GET_INTERFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), GEE_TYPE_ITERATOR, GeeIteratorIface))
37
38 typedef struct _GeeIterator GeeIterator;
39 typedef struct _GeeIteratorIface GeeIteratorIface;
40
41 struct _GeeIteratorIface {
42 GTypeInterface parent_iface;
43 gboolean (*next) (GeeIterator* self);
44 gboolean (*has_next) (GeeIterator* self);
45 gboolean (*first) (GeeIterator* self);
46 gpointer (*get) (GeeIterator* self);
47 void (*remove) (GeeIterator* self);
48 };
49
50
51
52 GType gee_iterator_get_type (void) G_GNUC_CONST;
53 gboolean gee_iterator_next (GeeIterator* self);
54 gboolean gee_iterator_has_next (GeeIterator* self);
55 gboolean gee_iterator_first (GeeIterator* self);
56 gpointer gee_iterator_get (GeeIterator* self);
57 void gee_iterator_remove (GeeIterator* self);
58
59
60 /**
61 * Advances to the next element in the iteration.
62 *
63 * @return ``true`` if the iterator has a next element
64 */
gee_iterator_next(GeeIterator * self)65 gboolean gee_iterator_next (GeeIterator* self) {
66 g_return_val_if_fail (self != NULL, FALSE);
67 return GEE_ITERATOR_GET_INTERFACE (self)->next (self);
68 }
69
70
71 /**
72 * Checks whether there is a next element in the iteration.
73 *
74 * @return ``true`` if the iterator has a next element
75 */
gee_iterator_has_next(GeeIterator * self)76 gboolean gee_iterator_has_next (GeeIterator* self) {
77 g_return_val_if_fail (self != NULL, FALSE);
78 return GEE_ITERATOR_GET_INTERFACE (self)->has_next (self);
79 }
80
81
82 /**
83 * Rewinds to the first element in the iteration.
84 *
85 * @return ``true`` if the iterator has a first element
86 */
gee_iterator_first(GeeIterator * self)87 gboolean gee_iterator_first (GeeIterator* self) {
88 g_return_val_if_fail (self != NULL, FALSE);
89 return GEE_ITERATOR_GET_INTERFACE (self)->first (self);
90 }
91
92
93 /**
94 * Returns the current element in the iteration.
95 *
96 * @return the current element in the iteration
97 */
gee_iterator_get(GeeIterator * self)98 gpointer gee_iterator_get (GeeIterator* self) {
99 g_return_val_if_fail (self != NULL, NULL);
100 return GEE_ITERATOR_GET_INTERFACE (self)->get (self);
101 }
102
103
104 /**
105 * Removes the current element in the iteration. The cursor is set in an
106 * in-between state. Both {@link get} and {@link remove} will fail until
107 * the next move of the cursor (calling {@link next} or {@link first}).
108 */
gee_iterator_remove(GeeIterator * self)109 void gee_iterator_remove (GeeIterator* self) {
110 g_return_if_fail (self != NULL);
111 GEE_ITERATOR_GET_INTERFACE (self)->remove (self);
112 }
113
114
gee_iterator_base_init(GeeIteratorIface * iface)115 static void gee_iterator_base_init (GeeIteratorIface * iface) {
116 static gboolean initialized = FALSE;
117 if (!initialized) {
118 initialized = TRUE;
119 }
120 }
121
122
123 /**
124 * An iterator over a collection.
125 *
126 * Gee's iterators are "on-track" iterators. They always point to an item
127 * except before the first call to {@link next} or {@link first}, or, when an
128 * item has been removed, until the next call to {@link next} or {@link first}.
129 *
130 * Please note that when the iterator is out of track, neither {@link get} nor
131 * {@link remove} are defined and both will fail. After the next call to
132 * {@link next} or {@link first}, they will be defined again.
133 */
gee_iterator_get_type(void)134 GType gee_iterator_get_type (void) {
135 static volatile gsize gee_iterator_type_id__volatile = 0;
136 if (g_once_init_enter (&gee_iterator_type_id__volatile)) {
137 static const GTypeInfo g_define_type_info = { sizeof (GeeIteratorIface), (GBaseInitFunc) gee_iterator_base_init, (GBaseFinalizeFunc) NULL, (GClassInitFunc) NULL, (GClassFinalizeFunc) NULL, NULL, 0, 0, (GInstanceInitFunc) NULL, NULL };
138 GType gee_iterator_type_id;
139 gee_iterator_type_id = g_type_register_static (G_TYPE_INTERFACE, "GeeIterator", &g_define_type_info, 0);
140 g_type_interface_add_prerequisite (gee_iterator_type_id, G_TYPE_OBJECT);
141 g_once_init_leave (&gee_iterator_type_id__volatile, gee_iterator_type_id);
142 }
143 return gee_iterator_type_id__volatile;
144 }
145
146
147
148