gtestutils: Fix a typo in a documentation comment
[glib.git] / gio / gconverterinputstream.h
blob9f6d063a5775f47da9f42aadd5f00d0298e682a8
1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright (C) 2009 Red Hat, Inc.
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.
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.
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/>.
18 * Author: Alexander Larsson <alexl@redhat.com>
21 #ifndef __G_CONVERTER_INPUT_STREAM_H__
22 #define __G_CONVERTER_INPUT_STREAM_H__
24 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
25 #error "Only <gio/gio.h> can be included directly."
26 #endif
28 #include <gio/gfilterinputstream.h>
29 #include <gio/gconverter.h>
31 G_BEGIN_DECLS
33 #define G_TYPE_CONVERTER_INPUT_STREAM (g_converter_input_stream_get_type ())
34 #define G_CONVERTER_INPUT_STREAM(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_CONVERTER_INPUT_STREAM, GConverterInputStream))
35 #define G_CONVERTER_INPUT_STREAM_CLASS(k) (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_CONVERTER_INPUT_STREAM, GConverterInputStreamClass))
36 #define G_IS_CONVERTER_INPUT_STREAM(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_CONVERTER_INPUT_STREAM))
37 #define G_IS_CONVERTER_INPUT_STREAM_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_CONVERTER_INPUT_STREAM))
38 #define G_CONVERTER_INPUT_STREAM_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_CONVERTER_INPUT_STREAM, GConverterInputStreamClass))
40 /**
41 * GConverterInputStream:
43 * An implementation of #GFilterInputStream that allows data
44 * conversion.
45 **/
46 typedef struct _GConverterInputStreamClass GConverterInputStreamClass;
47 typedef struct _GConverterInputStreamPrivate GConverterInputStreamPrivate;
49 struct _GConverterInputStream
51 GFilterInputStream parent_instance;
53 /*< private >*/
54 GConverterInputStreamPrivate *priv;
57 struct _GConverterInputStreamClass
59 GFilterInputStreamClass parent_class;
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);
70 GLIB_AVAILABLE_IN_ALL
71 GType g_converter_input_stream_get_type (void) G_GNUC_CONST;
72 GLIB_AVAILABLE_IN_ALL
73 GInputStream *g_converter_input_stream_new (GInputStream *base_stream,
74 GConverter *converter);
75 GLIB_AVAILABLE_IN_ALL
76 GConverter *g_converter_input_stream_get_converter (GConverterInputStream *converter_stream);
78 G_END_DECLS
80 #endif /* __G_CONVERTER_INPUT_STREAM_H__ */