gee/iterable.c

   1 /* iterable.c generated by valac 0.18.0, the Vala compiler
   2  * generated from iterable.vala, do not modify */
   3
   4 /* iterable.vala
   5  *
   6  * Copyright (C) 2007-2008  Jürg Billeter
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2.1 of the License, or (at your option) any later version.
  12
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Lesser General Public License for more details.
  17
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with this library; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301  USA
  21  *
  22  * Author:
  23  *      Jürg Billeter <j@bitron.ch>
  24  */
  25
  26 #include <glib.h>
  27 #include <glib-object.h>
  28
  29
  30 #define GEE_TYPE_TRAVERSABLE (gee_traversable_get_type ())
  31 #define GEE_TRAVERSABLE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GEE_TYPE_TRAVERSABLE, GeeTraversable))
  32 #define GEE_IS_TRAVERSABLE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GEE_TYPE_TRAVERSABLE))
  33 #define GEE_TRAVERSABLE_GET_INTERFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), GEE_TYPE_TRAVERSABLE, GeeTraversableIface))
  34
  35 typedef struct _GeeTraversable GeeTraversable;
  36 typedef struct _GeeTraversableIface GeeTraversableIface;
  37
  38 #define GEE_TRAVERSABLE_TYPE_STREAM (gee_traversable_stream_get_type ())
  39
  40 #define GEE_TYPE_LAZY (gee_lazy_get_type ())
  41 #define GEE_LAZY(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GEE_TYPE_LAZY, GeeLazy))
  42 #define GEE_LAZY_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GEE_TYPE_LAZY, GeeLazyClass))
  43 #define GEE_IS_LAZY(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GEE_TYPE_LAZY))
  44 #define GEE_IS_LAZY_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GEE_TYPE_LAZY))
  45 #define GEE_LAZY_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GEE_TYPE_LAZY, GeeLazyClass))
  46
  47 typedef struct _GeeLazy GeeLazy;
  48 typedef struct _GeeLazyClass GeeLazyClass;
  49
  50 #define GEE_TYPE_ITERATOR (gee_iterator_get_type ())
  51 #define GEE_ITERATOR(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GEE_TYPE_ITERATOR, GeeIterator))
  52 #define GEE_IS_ITERATOR(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GEE_TYPE_ITERATOR))
  53 #define GEE_ITERATOR_GET_INTERFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), GEE_TYPE_ITERATOR, GeeIteratorIface))
  54
  55 typedef struct _GeeIterator GeeIterator;
  56 typedef struct _GeeIteratorIface GeeIteratorIface;
  57
  58 #define GEE_TYPE_ITERABLE (gee_iterable_get_type ())
  59 #define GEE_ITERABLE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GEE_TYPE_ITERABLE, GeeIterable))
  60 #define GEE_IS_ITERABLE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GEE_TYPE_ITERABLE))
  61 #define GEE_ITERABLE_GET_INTERFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), GEE_TYPE_ITERABLE, GeeIterableIface))
  62
  63 typedef struct _GeeIterable GeeIterable;
  64 typedef struct _GeeIterableIface GeeIterableIface;
  65
  66 typedef gboolean (*GeeForallFunc) (gpointer g, void* user_data);
  67 typedef enum  {
  68         GEE_TRAVERSABLE_STREAM_YIELD,
  69         GEE_TRAVERSABLE_STREAM_CONTINUE,
  70         GEE_TRAVERSABLE_STREAM_END
  71 } GeeTraversableStream;
  72
  73 typedef GeeTraversableStream (*GeeStreamFunc) (GeeTraversableStream state, GeeLazy* g, GeeLazy** lazy, void* user_data);
  74 struct _GeeIteratorIface {
  75         GTypeInterface parent_iface;
  76         gboolean (*next) (GeeIterator* self);
  77         gboolean (*has_next) (GeeIterator* self);
  78         gpointer (*get) (GeeIterator* self);
  79         void (*remove) (GeeIterator* self);
  80         gboolean (*get_valid) (GeeIterator* self);
  81         gboolean (*get_read_only) (GeeIterator* self);
  82 };
  83
  84 typedef gpointer (*GeeFoldFunc) (gpointer g, gpointer a, void* user_data);
  85 typedef gpointer (*GeeMapFunc) (gpointer g, void* user_data);
  86 typedef gboolean (*GeePredicate) (gconstpointer g, void* user_data);
  87 struct _GeeTraversableIface {
  88         GTypeInterface parent_iface;
  89         GType (*get_g_type) (GeeTraversable* self);
  90         GBoxedCopyFunc (*get_g_dup_func) (GeeTraversable* self);
  91         GDestroyNotify (*get_g_destroy_func) (GeeTraversable* self);
  92         gboolean (*foreach) (GeeTraversable* self, GeeForallFunc f, void* f_target);
  93         GeeIterator* (*stream) (GeeTraversable* self, GType a_type, GBoxedCopyFunc a_dup_func, GDestroyNotify a_destroy_func, GeeStreamFunc f, void* f_target, GDestroyNotify f_target_destroy_notify);
  94         gpointer (*fold) (GeeTraversable* self, GType a_type, GBoxedCopyFunc a_dup_func, GDestroyNotify a_destroy_func, GeeFoldFunc f, void* f_target, gpointer seed);
  95         GeeIterator* (*map) (GeeTraversable* self, GType a_type, GBoxedCopyFunc a_dup_func, GDestroyNotify a_destroy_func, GeeMapFunc f, void* f_target);
  96         GeeIterator* (*scan) (GeeTraversable* self, GType a_type, GBoxedCopyFunc a_dup_func, GDestroyNotify a_destroy_func, GeeFoldFunc f, void* f_target, gpointer seed);
  97         GeeIterator* (*filter) (GeeTraversable* self, GeePredicate pred, void* pred_target, GDestroyNotify pred_target_destroy_notify);
  98         GeeIterator* (*chop) (GeeTraversable* self, gint offset, gint length);
  99         GType (*get_element_type) (GeeTraversable* self);
 100 };
 101
 102 struct _GeeIterableIface {
 103         GTypeInterface parent_iface;
 104         GType (*get_g_type) (GeeIterable* self);
 105         GBoxedCopyFunc (*get_g_dup_func) (GeeIterable* self);
 106         GDestroyNotify (*get_g_destroy_func) (GeeIterable* self);
 107         GeeIterator* (*iterator) (GeeIterable* self);
 108 };
 109
 110
 111
 112 GType gee_traversable_stream_get_type (void) G_GNUC_CONST;
 113 gpointer gee_lazy_ref (gpointer instance);
 114 void gee_lazy_unref (gpointer instance);
 115 GParamSpec* gee_param_spec_lazy (const gchar* name, const gchar* nick, const gchar* blurb, GType object_type, GParamFlags flags);
 116 void gee_value_set_lazy (GValue* value, gpointer v_object);
 117 void gee_value_take_lazy (GValue* value, gpointer v_object);
 118 gpointer gee_value_get_lazy (const GValue* value);
 119 GType gee_lazy_get_type (void) G_GNUC_CONST;
 120 GType gee_iterator_get_type (void) G_GNUC_CONST;
 121 GType gee_traversable_get_type (void) G_GNUC_CONST;
 122 GType gee_iterable_get_type (void) G_GNUC_CONST;
 123 GeeIterator* gee_iterable_iterator (GeeIterable* self);
 124
 125
 126 /**
 127  * Returns a {@link Iterator} that can be used for simple iteration over a
 128  * collection.
 129  *
 130  * @return a {@link Iterator} that can be used for simple iteration over a
 131  *         collection
 132  */
 133 GeeIterator* gee_iterable_iterator (GeeIterable* self) {
 134         g_return_val_if_fail (self != NULL, NULL);
 135         return GEE_ITERABLE_GET_INTERFACE (self)->iterator (self);
 136 }
 137
 138
 139 static void gee_iterable_base_init (GeeIterableIface * iface) {
 140         static gboolean initialized = FALSE;
 141         if (!initialized) {
 142                 initialized = TRUE;
 143         }
 144 }
 145
 146
 147 /**
 148  * An object that can provide an {@link Iterator}.
 149  */
 150 GType gee_iterable_get_type (void) {
 151         static volatile gsize gee_iterable_type_id__volatile = 0;
 152         if (g_once_init_enter (&gee_iterable_type_id__volatile)) {
 153                 static const GTypeInfo g_define_type_info = { sizeof (GeeIterableIface), (GBaseInitFunc) gee_iterable_base_init, (GBaseFinalizeFunc) NULL, (GClassInitFunc) NULL, (GClassFinalizeFunc) NULL, NULL, 0, 0, (GInstanceInitFunc) NULL, NULL };
 154                 GType gee_iterable_type_id;
 155                 gee_iterable_type_id = g_type_register_static (G_TYPE_INTERFACE, "GeeIterable", &g_define_type_info, 0);
 156                 g_type_interface_add_prerequisite (gee_iterable_type_id, G_TYPE_OBJECT);
 157                 g_type_interface_add_prerequisite (gee_iterable_type_id, GEE_TYPE_TRAVERSABLE);
 158                 g_once_init_leave (&gee_iterable_type_id__volatile, gee_iterable_type_id);
 159         }
 160         return gee_iterable_type_id__volatile;
 161 }
 162
 163
 164