gio/gconverteroutputstream.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_OUTPUT_STREAM_H__
  22 #define __G_CONVERTER_OUTPUT_STREAM_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/gfilteroutputstream.h>
  29 #include <gio/gconverter.h>
  30
  31 G_BEGIN_DECLS
  32
  33 #define G_TYPE_CONVERTER_OUTPUT_STREAM         (g_converter_output_stream_get_type ())
  34 #define G_CONVERTER_OUTPUT_STREAM(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_CONVERTER_OUTPUT_STREAM, GConverterOutputStream))
  35 #define G_CONVERTER_OUTPUT_STREAM_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_CONVERTER_OUTPUT_STREAM, GConverterOutputStreamClass))
  36 #define G_IS_CONVERTER_OUTPUT_STREAM(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_CONVERTER_OUTPUT_STREAM))
  37 #define G_IS_CONVERTER_OUTPUT_STREAM_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_CONVERTER_OUTPUT_STREAM))
  38 #define G_CONVERTER_OUTPUT_STREAM_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_CONVERTER_OUTPUT_STREAM, GConverterOutputStreamClass))
  39
  40 /**
  41  * GConverterOutputStream:
  42  *
  43  * An implementation of #GFilterOutputStream that allows data
  44  * conversion.
  45  **/
  46 typedef struct _GConverterOutputStreamClass    GConverterOutputStreamClass;
  47 typedef struct _GConverterOutputStreamPrivate  GConverterOutputStreamPrivate;
  48
  49 struct _GConverterOutputStream
  50 {
  51   GFilterOutputStream parent_instance;
  52
  53   /*< private >*/
  54   GConverterOutputStreamPrivate *priv;
  55 };
  56
  57 struct _GConverterOutputStreamClass
  58 {
  59   GFilterOutputStreamClass parent_class;
  60
  61   /*< private >*/
  62   /* Padding for future expansion */
  63   void (*_g_reserved1) (void);
  64   void (*_g_reserved2) (void);
  65   void (*_g_reserved3) (void);
  66   void (*_g_reserved4) (void);
  67   void (*_g_reserved5) (void);
  68 };
  69
  70 GLIB_AVAILABLE_IN_ALL
  71 GType                   g_converter_output_stream_get_type      (void) G_GNUC_CONST;
  72 GLIB_AVAILABLE_IN_ALL
  73 GOutputStream          *g_converter_output_stream_new           (GOutputStream         *base_stream,
  74                                                                  GConverter            *converter);
  75 GLIB_AVAILABLE_IN_ALL
  76 GConverter             *g_converter_output_stream_get_converter (GConverterOutputStream *converter_stream);
  77
  78 G_END_DECLS
  79
  80 #endif /* __G_CONVERTER_OUTPUT_STREAM_H__ */