gio/gconverterinputstream.h

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright (C) 2009 Red Hat, Inc.
   4  *
   5  * SPDX-License-Identifier: LGPL-2.1-or-later
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General
  18  * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
  19  *
  20  * Author: Alexander Larsson <alexl@redhat.com>
  21  */
  22
  23 #ifndef __G_CONVERTER_INPUT_STREAM_H__
  24 #define __G_CONVERTER_INPUT_STREAM_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/gfilterinputstream.h>
  31 #include <gio/gconverter.h>
  32
  33 G_BEGIN_DECLS
  34
  35 #define G_TYPE_CONVERTER_INPUT_STREAM         (g_converter_input_stream_get_type ())
  36 #define G_CONVERTER_INPUT_STREAM(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_CONVERTER_INPUT_STREAM, GConverterInputStream))
  37 #define G_CONVERTER_INPUT_STREAM_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_CONVERTER_INPUT_STREAM, GConverterInputStreamClass))
  38 #define G_IS_CONVERTER_INPUT_STREAM(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_CONVERTER_INPUT_STREAM))
  39 #define G_IS_CONVERTER_INPUT_STREAM_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_CONVERTER_INPUT_STREAM))
  40 #define G_CONVERTER_INPUT_STREAM_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_CONVERTER_INPUT_STREAM, GConverterInputStreamClass))
  41
  42 /**
  43  * GConverterInputStream:
  44  *
  45  * An implementation of #GFilterInputStream that allows data
  46  * conversion.
  47  **/
  48 typedef struct _GConverterInputStreamClass    GConverterInputStreamClass;
  49 typedef struct _GConverterInputStreamPrivate  GConverterInputStreamPrivate;
  50
  51 struct _GConverterInputStream
  52 {
  53   GFilterInputStream parent_instance;
  54
  55   /*< private >*/
  56   GConverterInputStreamPrivate *priv;
  57 };
  58
  59 struct _GConverterInputStreamClass
  60 {
  61   GFilterInputStreamClass parent_class;
  62
  63   /*< private >*/
  64   /* Padding for future expansion */
  65   void (*_g_reserved1) (void);
  66   void (*_g_reserved2) (void);
  67   void (*_g_reserved3) (void);
  68   void (*_g_reserved4) (void);
  69   void (*_g_reserved5) (void);
  70 };
  71
  72 GIO_AVAILABLE_IN_ALL
  73 GType                  g_converter_input_stream_get_type      (void) G_GNUC_CONST;
  74 GIO_AVAILABLE_IN_ALL
  75 GInputStream          *g_converter_input_stream_new           (GInputStream          *base_stream,
  76                                                                GConverter            *converter);
  77 GIO_AVAILABLE_IN_ALL
  78 GConverter            *g_converter_input_stream_get_converter (GConverterInputStream *converter_stream);
  79
  80 G_END_DECLS
  81
  82 #endif /* __G_CONVERTER_INPUT_STREAM_H__ */