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"
30 * SECTION:gfilterinputstream
31 * @short_description: Filter Input Stream
34 * Base class for input stream implementations that perform some
35 * kind of filtering operation on a base stream. Typical examples
36 * of filtering operations are character set conversion, compression
37 * and byte order flipping.
46 static void g_filter_input_stream_set_property (GObject
*object
,
51 static void g_filter_input_stream_get_property (GObject
*object
,
55 static void g_filter_input_stream_finalize (GObject
*object
);
58 static gssize
g_filter_input_stream_read (GInputStream
*stream
,
61 GCancellable
*cancellable
,
63 static gssize
g_filter_input_stream_skip (GInputStream
*stream
,
65 GCancellable
*cancellable
,
67 static gboolean
g_filter_input_stream_close (GInputStream
*stream
,
68 GCancellable
*cancellable
,
74 } GFilterInputStreamPrivate
;
76 G_DEFINE_ABSTRACT_TYPE_WITH_PRIVATE (GFilterInputStream
, g_filter_input_stream
, G_TYPE_INPUT_STREAM
)
79 g_filter_input_stream_class_init (GFilterInputStreamClass
*klass
)
81 GObjectClass
*object_class
;
82 GInputStreamClass
*istream_class
;
84 object_class
= G_OBJECT_CLASS (klass
);
85 object_class
->get_property
= g_filter_input_stream_get_property
;
86 object_class
->set_property
= g_filter_input_stream_set_property
;
87 object_class
->finalize
= g_filter_input_stream_finalize
;
89 istream_class
= G_INPUT_STREAM_CLASS (klass
);
90 istream_class
->read_fn
= g_filter_input_stream_read
;
91 istream_class
->skip
= g_filter_input_stream_skip
;
92 istream_class
->close_fn
= g_filter_input_stream_close
;
94 g_object_class_install_property (object_class
,
96 g_param_spec_object ("base-stream",
97 P_("The Filter Base Stream"),
98 P_("The underlying base stream on which the io ops will be done."),
100 G_PARAM_READWRITE
| G_PARAM_CONSTRUCT_ONLY
|
101 G_PARAM_STATIC_NAME
|G_PARAM_STATIC_NICK
|G_PARAM_STATIC_BLURB
));
103 g_object_class_install_property (object_class
,
105 g_param_spec_boolean ("close-base-stream",
106 P_("Close Base Stream"),
107 P_("If the base stream should be closed when the filter stream is closed."),
108 TRUE
, G_PARAM_READWRITE
| G_PARAM_CONSTRUCT
|
109 G_PARAM_STATIC_NAME
|G_PARAM_STATIC_NICK
|G_PARAM_STATIC_BLURB
));
113 g_filter_input_stream_set_property (GObject
*object
,
118 GFilterInputStream
*filter_stream
;
121 filter_stream
= G_FILTER_INPUT_STREAM (object
);
125 case PROP_BASE_STREAM
:
126 obj
= g_value_dup_object (value
);
127 filter_stream
->base_stream
= G_INPUT_STREAM (obj
);
130 case PROP_CLOSE_BASE
:
131 g_filter_input_stream_set_close_base_stream (filter_stream
,
132 g_value_get_boolean (value
));
136 G_OBJECT_WARN_INVALID_PROPERTY_ID (object
, prop_id
, pspec
);
143 g_filter_input_stream_get_property (GObject
*object
,
148 GFilterInputStream
*filter_stream
;
149 GFilterInputStreamPrivate
*priv
;
151 filter_stream
= G_FILTER_INPUT_STREAM (object
);
152 priv
= g_filter_input_stream_get_instance_private (filter_stream
);
156 case PROP_BASE_STREAM
:
157 g_value_set_object (value
, filter_stream
->base_stream
);
160 case PROP_CLOSE_BASE
:
161 g_value_set_boolean (value
, priv
->close_base
);
165 G_OBJECT_WARN_INVALID_PROPERTY_ID (object
, prop_id
, pspec
);
172 g_filter_input_stream_finalize (GObject
*object
)
174 GFilterInputStream
*stream
;
176 stream
= G_FILTER_INPUT_STREAM (object
);
178 g_object_unref (stream
->base_stream
);
180 G_OBJECT_CLASS (g_filter_input_stream_parent_class
)->finalize (object
);
184 g_filter_input_stream_init (GFilterInputStream
*stream
)
189 * g_filter_input_stream_get_base_stream:
190 * @stream: a #GFilterInputStream.
192 * Gets the base stream for the filter stream.
194 * Returns: (transfer none): a #GInputStream.
197 g_filter_input_stream_get_base_stream (GFilterInputStream
*stream
)
199 g_return_val_if_fail (G_IS_FILTER_INPUT_STREAM (stream
), NULL
);
201 return stream
->base_stream
;
205 * g_filter_input_stream_get_close_base_stream:
206 * @stream: a #GFilterInputStream.
208 * Returns whether the base stream will be closed when @stream is
211 * Return value: %TRUE if the base stream will be closed.
214 g_filter_input_stream_get_close_base_stream (GFilterInputStream
*stream
)
216 GFilterInputStreamPrivate
*priv
;
218 g_return_val_if_fail (G_IS_FILTER_INPUT_STREAM (stream
), FALSE
);
220 priv
= g_filter_input_stream_get_instance_private (stream
);
222 return priv
->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
= g_filter_input_stream_get_instance_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
,
299 GFilterInputStream
*filter_stream
= G_FILTER_INPUT_STREAM (stream
);
300 GFilterInputStreamPrivate
*priv
= g_filter_input_stream_get_instance_private (filter_stream
);
303 if (priv
->close_base
)
305 res
= g_input_stream_close (filter_stream
->base_stream
,