gio/gconverter.h

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright (C) 2009 Red Hat, Inc.
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General
  16  * Public License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  *
  20  * Author: Alexander Larsson <alexl@redhat.com>
  21  */
  22
  23 #ifndef __G_CONVERTER_H__
  24 #define __G_CONVERTER_H__
  25
  26 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  27 #error "Only <gio/gio.h> can be included directly."
  28 #endif
  29
  30 #include <gio/giotypes.h>
  31
  32 G_BEGIN_DECLS
  33
  34 #define G_TYPE_CONVERTER            (g_converter_get_type ())
  35 #define G_CONVERTER(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_CONVERTER, GConverter))
  36 #define G_IS_CONVERTER(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_CONVERTER))
  37 #define G_CONVERTER_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_CONVERTER, GConverterIface))
  38
  39 /**
  40  * GConverter:
  41  *
  42  * Seek object for streaming operations.
  43  *
  44  * Since: 2.24
  45  **/
  46 typedef struct _GConverterIface   GConverterIface;
  47
  48 /**
  49  * GConverterIface:
  50  * @g_iface: The parent interface.
  51  * @convert: Converts data.
  52  * @reset: Reverts the internal state of the converter to its initial state.
  53  *
  54  * Provides an interface for converting data from one type
  55  * to another type. The conversion can be stateful
  56  * and may fail at any place.
  57  *
  58  * Since: 2.24
  59  **/
  60 struct _GConverterIface
  61 {
  62   GTypeInterface g_iface;
  63
  64   /* Virtual Table */
  65
  66   GConverterResult (* convert) (GConverter *converter,
  67                                 const void *inbuf,
  68                                 gsize       inbuf_size,
  69                                 void       *outbuf,
  70                                 gsize       outbuf_size,
  71                                 GConverterFlags flags,
  72                                 gsize      *bytes_read,
  73                                 gsize      *bytes_written,
  74                                 GError    **error);
  75   void  (* reset)   (GConverter *converter);
  76 };
  77
  78 GType            g_converter_get_type     (void) G_GNUC_CONST;
  79
  80 GConverterResult g_converter_convert (GConverter       *converter,
  81                                       const void       *inbuf,
  82                                       gsize             inbuf_size,
  83                                       void             *outbuf,
  84                                       gsize             outbuf_size,
  85                                       GConverterFlags   flags,
  86                                       gsize            *bytes_read,
  87                                       gsize            *bytes_written,
  88                                       GError          **error);
  89 void             g_converter_reset   (GConverter       *converter);
  90
  91
  92 G_END_DECLS
  93
  94
  95 #endif /* __G_CONVERTER_H__ */