1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright (C) 2006-2007 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, write to the
17 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
18 * Boston, MA 02111-1307, USA.
20 * Author: Christian Kellner <gicmo@gnome.org>
24 #include "gfilterinputstream.h"
25 #include "ginputstream.h"
26 #include "gsimpleasyncresult.h"
32 * SECTION:gfilterinputstream
33 * @short_description: Filter Input Stream
44 static void g_filter_input_stream_set_property (GObject *object,
49 static void g_filter_input_stream_get_property (GObject *object,
53 static void g_filter_input_stream_finalize (GObject *object);
56 static gssize g_filter_input_stream_read (GInputStream *stream,
59 GCancellable *cancellable,
61 static gssize g_filter_input_stream_skip (GInputStream *stream,
63 GCancellable *cancellable,
65 static gboolean g_filter_input_stream_close (GInputStream *stream,
66 GCancellable *cancellable,
69 G_DEFINE_TYPE (GFilterInputStream, g_filter_input_stream, G_TYPE_INPUT_STREAM)
71 #define GET_PRIVATE(inst) G_TYPE_INSTANCE_GET_PRIVATE (inst, \
72 G_TYPE_FILTER_INPUT_STREAM, GFilterInputStreamPrivate)
77 GAsyncReadyCallback outstanding_callback;
78 gpointer outstanding_user_data;
79 } GFilterInputStreamPrivate;
82 g_filter_input_stream_class_init (GFilterInputStreamClass *klass)
84 GObjectClass *object_class;
85 GInputStreamClass *istream_class;
87 object_class = G_OBJECT_CLASS (klass);
88 object_class->get_property = g_filter_input_stream_get_property;
89 object_class->set_property = g_filter_input_stream_set_property;
90 object_class->finalize = g_filter_input_stream_finalize;
92 istream_class = G_INPUT_STREAM_CLASS (klass);
93 istream_class->read_fn = g_filter_input_stream_read;
94 istream_class->skip = g_filter_input_stream_skip;
95 istream_class->close_fn = g_filter_input_stream_close;
97 g_type_class_add_private (klass, sizeof (GFilterInputStreamPrivate));
99 g_object_class_install_property (object_class,
101 g_param_spec_object ("base-stream",
102 P_("The Filter Base Stream"),
103 P_("The underlying base stream on which the io ops will be done."),
105 G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
106 G_PARAM_STATIC_NAME|G_PARAM_STATIC_NICK|G_PARAM_STATIC_BLURB));
108 g_object_class_install_property (object_class,
110 g_param_spec_boolean ("close-base-stream",
111 P_("Close Base Stream"),
112 P_("If the base stream should be closed when the filter stream is closed."),
113 TRUE, G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
114 G_PARAM_STATIC_NAME|G_PARAM_STATIC_NICK|G_PARAM_STATIC_BLURB));
118 g_filter_input_stream_set_property (GObject *object,
123 GFilterInputStream *filter_stream;
126 filter_stream = G_FILTER_INPUT_STREAM (object);
130 case PROP_BASE_STREAM:
131 obj = g_value_dup_object (value);
132 filter_stream->base_stream = G_INPUT_STREAM (obj);
135 case PROP_CLOSE_BASE:
136 g_filter_input_stream_set_close_base_stream (filter_stream,
137 g_value_get_boolean (value));
141 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
148 g_filter_input_stream_get_property (GObject *object,
153 GFilterInputStream *filter_stream;
155 filter_stream = G_FILTER_INPUT_STREAM (object);
159 case PROP_BASE_STREAM:
160 g_value_set_object (value, filter_stream->base_stream);
163 case PROP_CLOSE_BASE:
164 g_value_set_boolean (value, GET_PRIVATE (filter_stream)->close_base);
168 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
175 g_filter_input_stream_finalize (GObject *object)
177 GFilterInputStream *stream;
179 stream = G_FILTER_INPUT_STREAM (object);
181 g_object_unref (stream->base_stream);
183 G_OBJECT_CLASS (g_filter_input_stream_parent_class)->finalize (object);
187 g_filter_input_stream_init (GFilterInputStream *stream)
193 * g_filter_input_stream_get_base_stream:
194 * @stream: a #GFilterInputStream.
196 * Gets the base stream for the filter stream.
198 * Returns: a #GInputStream.
201 g_filter_input_stream_get_base_stream (GFilterInputStream *stream)
203 g_return_val_if_fail (G_IS_FILTER_INPUT_STREAM (stream), NULL);
205 return stream->base_stream;
209 * g_filter_input_stream_get_close_base_stream:
210 * @stream: a #GFilterInputStream.
212 * Returns whether the base stream will be closed when @stream is
215 * Return value: %TRUE if the base stream will be closed.
218 g_filter_input_stream_get_close_base_stream (GFilterInputStream *stream)
220 g_return_val_if_fail (G_IS_FILTER_INPUT_STREAM (stream), FALSE);
222 return GET_PRIVATE (stream)->close_base;
226 * g_filter_input_stream_set_close_base_stream:
227 * @stream: a #GFilterInputStream.
228 * @close_base: %TRUE to close the base stream.
230 * Sets whether the base stream will be closed when @stream is closed.
233 g_filter_input_stream_set_close_base_stream (GFilterInputStream *stream,
236 GFilterInputStreamPrivate *priv;
238 g_return_if_fail (G_IS_FILTER_INPUT_STREAM (stream));
240 close_base = !!close_base;
242 priv = GET_PRIVATE (stream);
244 if (priv->close_base != close_base)
246 priv->close_base = close_base;
247 g_object_notify (G_OBJECT (stream), "close-base-stream");
252 g_filter_input_stream_read (GInputStream *stream,
255 GCancellable *cancellable,
258 GFilterInputStream *filter_stream;
259 GInputStream *base_stream;
262 filter_stream = G_FILTER_INPUT_STREAM (stream);
263 base_stream = filter_stream->base_stream;
265 nread = g_input_stream_read (base_stream,
275 g_filter_input_stream_skip (GInputStream *stream,
277 GCancellable *cancellable,
280 GFilterInputStream *filter_stream;
281 GInputStream *base_stream;
284 filter_stream = G_FILTER_INPUT_STREAM (stream);
285 base_stream = filter_stream->base_stream;
287 nskipped = g_input_stream_skip (base_stream,
295 g_filter_input_stream_close (GInputStream *stream,
296 GCancellable *cancellable,
301 if (GET_PRIVATE (stream)->close_base)
303 GFilterInputStream *filter_stream;
304 GInputStream *base_stream;
306 filter_stream = G_FILTER_INPUT_STREAM (stream);
307 base_stream = filter_stream->base_stream;
309 res = g_input_stream_close (base_stream,
317 #define __G_FILTER_INPUT_STREAM_C__
318 #include "gioaliasdef.c"