Initial commit
[platform/upstream/glib2.0.git] / 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 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 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
24 #error "Only <gio/gio.h> can be included directly."
25 #endif
26
27 #ifndef __G_CONVERTER_OUTPUT_STREAM_H__
28 #define __G_CONVERTER_OUTPUT_STREAM_H__
29
30 #include <gio/gfilteroutputstream.h>
31 #include <gio/gconverter.h>
32
33 G_BEGIN_DECLS
34
35 #define G_TYPE_CONVERTER_OUTPUT_STREAM         (g_converter_output_stream_get_type ())
36 #define G_CONVERTER_OUTPUT_STREAM(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_CONVERTER_OUTPUT_STREAM, GConverterOutputStream))
37 #define G_CONVERTER_OUTPUT_STREAM_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_CONVERTER_OUTPUT_STREAM, GConverterOutputStreamClass))
38 #define G_IS_CONVERTER_OUTPUT_STREAM(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_CONVERTER_OUTPUT_STREAM))
39 #define G_IS_CONVERTER_OUTPUT_STREAM_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_CONVERTER_OUTPUT_STREAM))
40 #define G_CONVERTER_OUTPUT_STREAM_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_CONVERTER_OUTPUT_STREAM, GConverterOutputStreamClass))
41
42 /**
43  * GConverterOutputStream:
44  * @parent_instance: a #GFilterOutputStream.
45  *
46  * An implementation of #GFilterOutputStream that allows data
47  * conversion.
48  **/
49 typedef struct _GConverterOutputStreamClass    GConverterOutputStreamClass;
50 typedef struct _GConverterOutputStreamPrivate  GConverterOutputStreamPrivate;
51
52 struct _GConverterOutputStream
53 {
54   GFilterOutputStream parent_instance;
55
56   /*< private >*/
57   GConverterOutputStreamPrivate *priv;
58 };
59
60 struct _GConverterOutputStreamClass
61 {
62   GFilterOutputStreamClass parent_class;
63
64   /*< private >*/
65   /* Padding for future expansion */
66   void (*_g_reserved1) (void);
67   void (*_g_reserved2) (void);
68   void (*_g_reserved3) (void);
69   void (*_g_reserved4) (void);
70   void (*_g_reserved5) (void);
71 };
72
73 GType                   g_converter_output_stream_get_type      (void) G_GNUC_CONST;
74 GOutputStream          *g_converter_output_stream_new           (GOutputStream         *base_stream,
75                                                                  GConverter            *converter);
76 GConverter             *g_converter_output_stream_get_converter (GConverterOutputStream *converter_stream);
77
78 G_END_DECLS
79
80 #endif /* __G_CONVERTER_OUTPUT_STREAM_H__ */