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 "gfilteroutputstream.h"
25 #include "gsimpleasyncresult.h"
26 #include "goutputstream.h"
32 * SECTION:gfilteroutputstream
33 * @short_description: Filter Output Stream
44 static void g_filter_output_stream_set_property (GObject *object,
49 static void g_filter_output_stream_get_property (GObject *object,
53 static void g_filter_output_stream_dispose (GObject *object);
56 static gssize g_filter_output_stream_write (GOutputStream *stream,
59 GCancellable *cancellable,
61 static gboolean g_filter_output_stream_flush (GOutputStream *stream,
62 GCancellable *cancellable,
64 static gboolean g_filter_output_stream_close (GOutputStream *stream,
65 GCancellable *cancellable,
67 static void g_filter_output_stream_write_async (GOutputStream *stream,
71 GCancellable *cancellable,
72 GAsyncReadyCallback callback,
74 static gssize g_filter_output_stream_write_finish (GOutputStream *stream,
77 static void g_filter_output_stream_flush_async (GOutputStream *stream,
79 GCancellable *cancellable,
80 GAsyncReadyCallback callback,
82 static gboolean g_filter_output_stream_flush_finish (GOutputStream *stream,
85 static void g_filter_output_stream_close_async (GOutputStream *stream,
87 GCancellable *cancellable,
88 GAsyncReadyCallback callback,
90 static gboolean g_filter_output_stream_close_finish (GOutputStream *stream,
96 G_DEFINE_TYPE (GFilterOutputStream, g_filter_output_stream, G_TYPE_OUTPUT_STREAM)
98 #define GET_PRIVATE(inst) G_TYPE_INSTANCE_GET_PRIVATE (inst, \
99 G_TYPE_FILTER_OUTPUT_STREAM, GFilterOutputStreamPrivate)
104 } GFilterOutputStreamPrivate;
107 g_filter_output_stream_class_init (GFilterOutputStreamClass *klass)
109 GObjectClass *object_class;
110 GOutputStreamClass *ostream_class;
112 object_class = G_OBJECT_CLASS (klass);
113 object_class->get_property = g_filter_output_stream_get_property;
114 object_class->set_property = g_filter_output_stream_set_property;
115 object_class->dispose = g_filter_output_stream_dispose;
117 ostream_class = G_OUTPUT_STREAM_CLASS (klass);
118 ostream_class->write_fn = g_filter_output_stream_write;
119 ostream_class->flush = g_filter_output_stream_flush;
120 ostream_class->close_fn = g_filter_output_stream_close;
121 ostream_class->write_async = g_filter_output_stream_write_async;
122 ostream_class->write_finish = g_filter_output_stream_write_finish;
123 ostream_class->flush_async = g_filter_output_stream_flush_async;
124 ostream_class->flush_finish = g_filter_output_stream_flush_finish;
125 ostream_class->close_async = g_filter_output_stream_close_async;
126 ostream_class->close_finish = g_filter_output_stream_close_finish;
128 g_type_class_add_private (klass, sizeof (GFilterOutputStreamPrivate));
130 g_object_class_install_property (object_class,
132 g_param_spec_object ("base-stream",
133 P_("The Filter Base Stream"),
134 P_("The underlying base stream on which the io ops will be done."),
135 G_TYPE_OUTPUT_STREAM,
136 G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
137 G_PARAM_STATIC_NAME|G_PARAM_STATIC_NICK|G_PARAM_STATIC_BLURB));
139 g_object_class_install_property (object_class,
141 g_param_spec_boolean ("close-base-stream",
142 P_("Close Base Stream"),
143 P_("If the base stream should be closed when the filter stream is closed."),
144 TRUE, G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
145 G_PARAM_STATIC_NAME|G_PARAM_STATIC_NICK|G_PARAM_STATIC_BLURB));
149 g_filter_output_stream_set_property (GObject *object,
154 GFilterOutputStream *filter_stream;
157 filter_stream = G_FILTER_OUTPUT_STREAM (object);
161 case PROP_BASE_STREAM:
162 obj = g_value_dup_object (value);
163 filter_stream->base_stream = G_OUTPUT_STREAM (obj);
166 case PROP_CLOSE_BASE:
167 g_filter_output_stream_set_close_base_stream (filter_stream,
168 g_value_get_boolean (value));
172 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
179 g_filter_output_stream_get_property (GObject *object,
184 GFilterOutputStream *filter_stream;
186 filter_stream = G_FILTER_OUTPUT_STREAM (object);
190 case PROP_BASE_STREAM:
191 g_value_set_object (value, filter_stream->base_stream);
194 case PROP_CLOSE_BASE:
195 g_value_set_boolean (value, GET_PRIVATE (filter_stream)->close_base);
199 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
206 g_filter_output_stream_dispose (GObject *object)
208 GFilterOutputStream *stream;
210 stream = G_FILTER_OUTPUT_STREAM (object);
212 G_OBJECT_CLASS (g_filter_output_stream_parent_class)->dispose (object);
214 if (stream->base_stream)
216 g_object_unref (stream->base_stream);
217 stream->base_stream = NULL;
223 g_filter_output_stream_init (GFilterOutputStream *stream)
228 * g_filter_output_stream_get_base_stream:
229 * @stream: a #GFilterOutputStream.
231 * Gets the base stream for the filter stream.
233 * Returns: a #GOutputStream.
236 g_filter_output_stream_get_base_stream (GFilterOutputStream *stream)
238 g_return_val_if_fail (G_IS_FILTER_OUTPUT_STREAM (stream), NULL);
240 return stream->base_stream;
244 * g_filter_output_stream_get_close_base_stream:
245 * @stream: a #GFilterOutputStream.
247 * Returns whether the base stream will be closed when @stream is
250 * Return value: %TRUE if the base stream will be closed.
253 g_filter_output_stream_get_close_base_stream (GFilterOutputStream *stream)
255 g_return_val_if_fail (G_IS_FILTER_OUTPUT_STREAM (stream), FALSE);
257 return GET_PRIVATE (stream)->close_base;
261 * g_filter_output_stream_set_close_base_stream:
262 * @stream: a #GFilterOutputStream.
263 * @close_base: %TRUE to close the base stream.
265 * Sets whether the base stream will be closed when @stream is closed.
268 g_filter_output_stream_set_close_base_stream (GFilterOutputStream *stream,
271 GFilterOutputStreamPrivate *priv;
273 g_return_if_fail (G_IS_FILTER_OUTPUT_STREAM (stream));
275 close_base = !!close_base;
277 priv = GET_PRIVATE (stream);
279 if (priv->close_base != close_base)
281 priv->close_base = close_base;
282 g_object_notify (G_OBJECT (stream), "close-base-stream");
287 g_filter_output_stream_write (GOutputStream *stream,
290 GCancellable *cancellable,
293 GFilterOutputStream *filter_stream;
296 filter_stream = G_FILTER_OUTPUT_STREAM (stream);
298 nwritten = g_output_stream_write (filter_stream->base_stream,
308 g_filter_output_stream_flush (GOutputStream *stream,
309 GCancellable *cancellable,
312 GFilterOutputStream *filter_stream;
315 filter_stream = G_FILTER_OUTPUT_STREAM (stream);
317 res = g_output_stream_flush (filter_stream->base_stream,
325 g_filter_output_stream_close (GOutputStream *stream,
326 GCancellable *cancellable,
331 if (GET_PRIVATE (stream)->close_base)
333 GFilterOutputStream *filter_stream;
335 filter_stream = G_FILTER_OUTPUT_STREAM (stream);
337 res = g_output_stream_close (filter_stream->base_stream,
346 g_filter_output_stream_write_async (GOutputStream *stream,
350 GCancellable *cancellable,
351 GAsyncReadyCallback callback,
354 GFilterOutputStream *filter_stream;
356 filter_stream = G_FILTER_OUTPUT_STREAM (stream);
358 g_output_stream_write_async (filter_stream->base_stream,
369 g_filter_output_stream_write_finish (GOutputStream *stream,
370 GAsyncResult *result,
373 GFilterOutputStream *filter_stream;
376 filter_stream = G_FILTER_OUTPUT_STREAM (stream);
378 nwritten = g_output_stream_write_finish (filter_stream->base_stream,
386 g_filter_output_stream_flush_async (GOutputStream *stream,
388 GCancellable *cancellable,
389 GAsyncReadyCallback callback,
392 GFilterOutputStream *filter_stream;
394 filter_stream = G_FILTER_OUTPUT_STREAM (stream);
396 g_output_stream_flush_async (filter_stream->base_stream,
404 g_filter_output_stream_flush_finish (GOutputStream *stream,
405 GAsyncResult *result,
408 GFilterOutputStream *filter_stream;
411 filter_stream = G_FILTER_OUTPUT_STREAM (stream);
413 res = g_output_stream_flush_finish (filter_stream->base_stream,
421 g_filter_output_stream_close_ready (GObject *object,
422 GAsyncResult *result,
425 GSimpleAsyncResult *simple = user_data;
426 GError *error = NULL;
428 g_output_stream_close_finish (G_OUTPUT_STREAM (object), result, &error);
432 g_simple_async_result_set_from_error (simple, error);
433 g_error_free (error);
436 g_simple_async_result_complete (simple);
437 g_object_unref (simple);
441 g_filter_output_stream_close_async (GOutputStream *stream,
443 GCancellable *cancellable,
444 GAsyncReadyCallback callback,
447 GSimpleAsyncResult *simple;
449 simple = g_simple_async_result_new (G_OBJECT (stream),
451 g_filter_output_stream_close_async);
453 if (GET_PRIVATE (stream)->close_base)
455 GFilterOutputStream *filter_stream = G_FILTER_OUTPUT_STREAM (stream);
457 g_output_stream_close_async (filter_stream->base_stream,
458 io_priority, cancellable,
459 g_filter_output_stream_close_ready,
460 g_object_ref (simple));
464 g_simple_async_result_complete_in_idle (simple);
466 g_object_unref (simple);
470 g_filter_output_stream_close_finish (GOutputStream *stream,
471 GAsyncResult *result,
474 GSimpleAsyncResult *simple;
476 g_return_val_if_fail (g_simple_async_result_is_valid (
477 result, G_OBJECT (stream), g_filter_output_stream_close_async), FALSE);
479 simple = G_SIMPLE_ASYNC_RESULT (result);
481 return !g_simple_async_result_propagate_error (simple, error);
484 #define __G_FILTER_OUTPUT_STREAM_C__
485 #include "gioaliasdef.c"