1/* GIO - GLib Input, Output and Streaming Library
2 *
3 * Copyright (C) 2006-2007 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: Christian Kellner <gicmo@gnome.org>
19 */
20
21#ifndef __G_FILTER_OUTPUT_STREAM_H__
22#define __G_FILTER_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/goutputstream.h>
29
30G_BEGIN_DECLS
31
32#define G_TYPE_FILTER_OUTPUT_STREAM (g_filter_output_stream_get_type ())
33#define G_FILTER_OUTPUT_STREAM(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_FILTER_OUTPUT_STREAM, GFilterOutputStream))
34#define G_FILTER_OUTPUT_STREAM_CLASS(k) (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_FILTER_OUTPUT_STREAM, GFilterOutputStreamClass))
35#define G_IS_FILTER_OUTPUT_STREAM(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_FILTER_OUTPUT_STREAM))
36#define G_IS_FILTER_OUTPUT_STREAM_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_FILTER_OUTPUT_STREAM))
37#define G_FILTER_OUTPUT_STREAM_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_FILTER_OUTPUT_STREAM, GFilterOutputStreamClass))
38
39/**
40 * GFilterOutputStream:
41 *
42 * A base class for all output streams that work on an underlying stream.
43 **/
44typedef struct _GFilterOutputStreamClass GFilterOutputStreamClass;
45
46struct _GFilterOutputStream
47{
48 GOutputStream parent_instance;
49
50 /*< protected >*/
51 GOutputStream *base_stream;
52};
53
54struct _GFilterOutputStreamClass
55{
56 GOutputStreamClass parent_class;
57
58 /*< private >*/
59 /* Padding for future expansion */
60 void (*_g_reserved1) (void);
61 void (*_g_reserved2) (void);
62 void (*_g_reserved3) (void);
63};
64
65
66GLIB_AVAILABLE_IN_ALL
67GType g_filter_output_stream_get_type (void) G_GNUC_CONST;
68GLIB_AVAILABLE_IN_ALL
69GOutputStream * g_filter_output_stream_get_base_stream (GFilterOutputStream *stream);
70GLIB_AVAILABLE_IN_ALL
71gboolean g_filter_output_stream_get_close_base_stream (GFilterOutputStream *stream);
72GLIB_AVAILABLE_IN_ALL
73void g_filter_output_stream_set_close_base_stream (GFilterOutputStream *stream,
74 gboolean close_base);
75
76G_END_DECLS
77
78#endif /* __G_FILTER_OUTPUT_STREAM_H__ */
79