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.1 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, see <http://www.gnu.org/licenses/>.
  17  *
  18  * Author: Alexander Larsson <alexl@redhat.com>
  19  */
  20
  21 #ifndef __G_CONVERTER_H__
  22 #define __G_CONVERTER_H__
  23
  24 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  25 #error "Only <gio/gio.h> can be included directly."
  26 #endif
  27
  28 #include <gio/giotypes.h>
  29
  30 G_BEGIN_DECLS
  31
  32 #define G_TYPE_CONVERTER            (g_converter_get_type ())
  33 #define G_CONVERTER(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_CONVERTER, GConverter))
  34 #define G_IS_CONVERTER(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_CONVERTER))
  35 #define G_CONVERTER_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_CONVERTER, GConverterIface))
  36
  37 /**
  38  * GConverter:
  39  *
  40  * Seek object for streaming operations.
  41  *
  42  * Since: 2.24
  43  **/
  44 typedef struct _GConverterIface   GConverterIface;
  45
  46 /**
  47  * GConverterIface:
  48  * @g_iface: The parent interface.
  49  * @convert: Converts data.
  50  * @reset: Reverts the internal state of the converter to its initial state.
  51  *
  52  * Provides an interface for converting data from one type
  53  * to another type. The conversion can be stateful
  54  * and may fail at any place.
  55  *
  56  * Since: 2.24
  57  **/
  58 struct _GConverterIface
  59 {
  60   GTypeInterface g_iface;
  61
  62   /* Virtual Table */
  63
  64   GConverterResult (* convert) (GConverter *converter,
  65                                 const void *inbuf,
  66                                 gsize       inbuf_size,
  67                                 void       *outbuf,
  68                                 gsize       outbuf_size,
  69                                 GConverterFlags flags,
  70                                 gsize      *bytes_read,
  71                                 gsize      *bytes_written,
  72                                 GError    **error);
  73   void  (* reset)   (GConverter *converter);
  74 };
  75
  76 GLIB_AVAILABLE_IN_ALL
  77 GType            g_converter_get_type     (void) G_GNUC_CONST;
  78
  79 GLIB_AVAILABLE_IN_ALL
  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 GLIB_AVAILABLE_IN_ALL
  90 void             g_converter_reset   (GConverter       *converter);
  91
  92
  93 G_END_DECLS
  94
  95
  96 #endif /* __G_CONVERTER_H__ */