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.
21 * Christian Kellner <gicmo@gnome.org>
22 * Krzysztof KosiĆski <tweenk.pl@gmail.com>
26 #include "gmemoryoutputstream.h"
27 #include "goutputstream.h"
28 #include "gpollableoutputstream.h"
29 #include "gseekable.h"
37 * SECTION:gmemoryoutputstream
38 * @short_description: Streaming output operations on memory chunks
40 * @see_also: #GMemoryInputStream
42 * #GMemoryOutputStream is a class for using arbitrary
43 * memory chunks as output for GIO streaming output operations.
45 * As of GLib 2.34, #GMemoryOutputStream implements
46 * #GPollableOutputStream.
49 #define MIN_ARRAY_SIZE 16
56 PROP_REALLOC_FUNCTION,
60 struct _GMemoryOutputStreamPrivate {
62 gpointer data; /* Write buffer */
63 gsize len; /* Current length of the data buffer. Can change with resizing. */
64 gsize valid_len; /* The part of data that has been written to */
65 gsize pos; /* Current position in the stream. Distinct from valid_len,
66 because the stream is seekable. */
68 GReallocFunc realloc_fn;
69 GDestroyNotify destroy;
72 static void g_memory_output_stream_set_property (GObject *object,
76 static void g_memory_output_stream_get_property (GObject *object,
80 static void g_memory_output_stream_finalize (GObject *object);
82 static gssize g_memory_output_stream_write (GOutputStream *stream,
85 GCancellable *cancellable,
88 static gboolean g_memory_output_stream_close (GOutputStream *stream,
89 GCancellable *cancellable,
92 static void g_memory_output_stream_close_async (GOutputStream *stream,
94 GCancellable *cancellable,
95 GAsyncReadyCallback callback,
97 static gboolean g_memory_output_stream_close_finish (GOutputStream *stream,
101 static void g_memory_output_stream_seekable_iface_init (GSeekableIface *iface);
102 static goffset g_memory_output_stream_tell (GSeekable *seekable);
103 static gboolean g_memory_output_stream_can_seek (GSeekable *seekable);
104 static gboolean g_memory_output_stream_seek (GSeekable *seekable,
107 GCancellable *cancellable,
109 static gboolean g_memory_output_stream_can_truncate (GSeekable *seekable);
110 static gboolean g_memory_output_stream_truncate (GSeekable *seekable,
112 GCancellable *cancellable,
115 static gboolean g_memory_output_stream_is_writable (GPollableOutputStream *stream);
116 static GSource *g_memory_output_stream_create_source (GPollableOutputStream *stream,
117 GCancellable *cancellable);
119 static void g_memory_output_stream_pollable_iface_init (GPollableOutputStreamInterface *iface);
121 G_DEFINE_TYPE_WITH_CODE (GMemoryOutputStream, g_memory_output_stream, G_TYPE_OUTPUT_STREAM,
122 G_IMPLEMENT_INTERFACE (G_TYPE_SEEKABLE,
123 g_memory_output_stream_seekable_iface_init);
124 G_IMPLEMENT_INTERFACE (G_TYPE_POLLABLE_OUTPUT_STREAM,
125 g_memory_output_stream_pollable_iface_init))
129 g_memory_output_stream_class_init (GMemoryOutputStreamClass *klass)
131 GOutputStreamClass *ostream_class;
132 GObjectClass *gobject_class;
134 g_type_class_add_private (klass, sizeof (GMemoryOutputStreamPrivate));
136 gobject_class = G_OBJECT_CLASS (klass);
137 gobject_class->set_property = g_memory_output_stream_set_property;
138 gobject_class->get_property = g_memory_output_stream_get_property;
139 gobject_class->finalize = g_memory_output_stream_finalize;
141 ostream_class = G_OUTPUT_STREAM_CLASS (klass);
143 ostream_class->write_fn = g_memory_output_stream_write;
144 ostream_class->close_fn = g_memory_output_stream_close;
145 ostream_class->close_async = g_memory_output_stream_close_async;
146 ostream_class->close_finish = g_memory_output_stream_close_finish;
149 * GMemoryOutputStream:data:
151 * Pointer to buffer where data will be written.
155 g_object_class_install_property (gobject_class,
157 g_param_spec_pointer ("data",
159 P_("Pointer to buffer where data will be written."),
160 G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
161 G_PARAM_STATIC_STRINGS));
164 * GMemoryOutputStream:size:
166 * Current size of the data buffer.
170 g_object_class_install_property (gobject_class,
172 g_param_spec_ulong ("size",
173 P_("Data Buffer Size"),
174 P_("Current size of the data buffer."),
176 G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
177 G_PARAM_STATIC_STRINGS));
180 * GMemoryOutputStream:data-size:
182 * Size of data written to the buffer.
186 g_object_class_install_property (gobject_class,
188 g_param_spec_ulong ("data-size",
190 P_("Size of data written to the buffer."),
193 G_PARAM_STATIC_STRINGS));
196 * GMemoryOutputStream:realloc-function: (skip)
198 * Function with realloc semantics called to enlarge the buffer.
202 g_object_class_install_property (gobject_class,
203 PROP_REALLOC_FUNCTION,
204 g_param_spec_pointer ("realloc-function",
205 P_("Memory Reallocation Function"),
206 P_("Function with realloc semantics called to enlarge the buffer."),
207 G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
208 G_PARAM_STATIC_STRINGS));
211 * GMemoryOutputStream:destroy-function: (skip)
213 * Function called with the buffer as argument when the stream is destroyed.
217 g_object_class_install_property (gobject_class,
218 PROP_DESTROY_FUNCTION,
219 g_param_spec_pointer ("destroy-function",
220 P_("Destroy Notification Function"),
221 P_("Function called with the buffer as argument when the stream is destroyed."),
222 G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
223 G_PARAM_STATIC_STRINGS));
227 g_memory_output_stream_pollable_iface_init (GPollableOutputStreamInterface *iface)
229 iface->is_writable = g_memory_output_stream_is_writable;
230 iface->create_source = g_memory_output_stream_create_source;
234 g_memory_output_stream_set_property (GObject *object,
239 GMemoryOutputStream *stream;
240 GMemoryOutputStreamPrivate *priv;
242 stream = G_MEMORY_OUTPUT_STREAM (object);
248 priv->data = g_value_get_pointer (value);
251 priv->len = g_value_get_ulong (value);
253 case PROP_REALLOC_FUNCTION:
254 priv->realloc_fn = g_value_get_pointer (value);
256 case PROP_DESTROY_FUNCTION:
257 priv->destroy = g_value_get_pointer (value);
260 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
266 g_memory_output_stream_get_property (GObject *object,
271 GMemoryOutputStream *stream;
272 GMemoryOutputStreamPrivate *priv;
274 stream = G_MEMORY_OUTPUT_STREAM (object);
280 g_value_set_pointer (value, priv->data);
283 g_value_set_ulong (value, priv->len);
286 g_value_set_ulong (value, priv->valid_len);
288 case PROP_REALLOC_FUNCTION:
289 g_value_set_pointer (value, priv->realloc_fn);
291 case PROP_DESTROY_FUNCTION:
292 g_value_set_pointer (value, priv->destroy);
295 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
301 g_memory_output_stream_finalize (GObject *object)
303 GMemoryOutputStream *stream;
304 GMemoryOutputStreamPrivate *priv;
306 stream = G_MEMORY_OUTPUT_STREAM (object);
310 priv->destroy (priv->data);
312 G_OBJECT_CLASS (g_memory_output_stream_parent_class)->finalize (object);
316 g_memory_output_stream_seekable_iface_init (GSeekableIface *iface)
318 iface->tell = g_memory_output_stream_tell;
319 iface->can_seek = g_memory_output_stream_can_seek;
320 iface->seek = g_memory_output_stream_seek;
321 iface->can_truncate = g_memory_output_stream_can_truncate;
322 iface->truncate_fn = g_memory_output_stream_truncate;
327 g_memory_output_stream_init (GMemoryOutputStream *stream)
329 stream->priv = G_TYPE_INSTANCE_GET_PRIVATE (stream,
330 G_TYPE_MEMORY_OUTPUT_STREAM,
331 GMemoryOutputStreamPrivate);
332 stream->priv->pos = 0;
333 stream->priv->valid_len = 0;
337 * g_memory_output_stream_new: (skip)
338 * @data: (allow-none): pointer to a chunk of memory to use, or %NULL
339 * @size: the size of @data
340 * @realloc_function: (allow-none): a function with realloc() semantics (like g_realloc())
341 * to be called when @data needs to be grown, or %NULL
342 * @destroy_function: (allow-none): a function to be called on @data when the stream is
343 * finalized, or %NULL
345 * Creates a new #GMemoryOutputStream.
347 * If @data is non-%NULL, the stream will use that for its internal storage.
348 * If @realloc_fn is non-%NULL, it will be used for resizing the internal
349 * storage when necessary. To construct a fixed-size output stream,
350 * pass %NULL as @realloc_fn.
353 * /* a stream that can grow */
354 * stream = g_memory_output_stream_new (NULL, 0, realloc, free);
356 * /* another stream that can grow */
357 * stream2 = g_memory_output_stream_new (NULL, 0, g_realloc, g_free);
359 * /* a fixed-size stream */
360 * data = malloc (200);
361 * stream3 = g_memory_output_stream_new (data, 200, NULL, free);
364 * Return value: A newly created #GMemoryOutputStream object.
367 g_memory_output_stream_new (gpointer data,
369 GReallocFunc realloc_function,
370 GDestroyNotify destroy_function)
372 GOutputStream *stream;
374 stream = g_object_new (G_TYPE_MEMORY_OUTPUT_STREAM,
377 "realloc-function", realloc_function,
378 "destroy-function", destroy_function,
385 * g_memory_output_stream_new_resizable:
387 * Creates a new #GMemoryOutputStream, using g_realloc() and g_free()
388 * for memory allocation.
393 g_memory_output_stream_new_resizable (void)
395 return g_memory_output_stream_new (NULL, 0, g_realloc, g_free);
399 * g_memory_output_stream_get_data:
400 * @ostream: a #GMemoryOutputStream
402 * Gets any loaded data from the @ostream.
404 * Note that the returned pointer may become invalid on the next
405 * write or truncate operation on the stream.
407 * Returns: (transfer none): pointer to the stream's data
410 g_memory_output_stream_get_data (GMemoryOutputStream *ostream)
412 g_return_val_if_fail (G_IS_MEMORY_OUTPUT_STREAM (ostream), NULL);
414 return ostream->priv->data;
418 * g_memory_output_stream_get_size:
419 * @ostream: a #GMemoryOutputStream
421 * Gets the size of the currently allocated data area (available from
422 * g_memory_output_stream_get_data()). If the stream isn't
423 * growable (no realloc was passed to g_memory_output_stream_new()) then
424 * this is the maximum size of the stream and further writes
425 * will return %G_IO_ERROR_NO_SPACE.
427 * Note that for growable streams the returned size may become invalid on
428 * the next write or truncate operation on the stream.
430 * If you want the number of bytes currently written to the stream, use
431 * g_memory_output_stream_get_data_size().
433 * Returns: the number of bytes allocated for the data buffer
436 g_memory_output_stream_get_size (GMemoryOutputStream *ostream)
438 g_return_val_if_fail (G_IS_MEMORY_OUTPUT_STREAM (ostream), 0);
440 return ostream->priv->len;
444 * g_memory_output_stream_get_data_size:
445 * @ostream: a #GMemoryOutputStream
447 * Returns the number of bytes from the start up
448 * to including the last byte written in the stream
449 * that has not been truncated away.
451 * Returns: the number of bytes written to the stream
456 g_memory_output_stream_get_data_size (GMemoryOutputStream *ostream)
458 g_return_val_if_fail (G_IS_MEMORY_OUTPUT_STREAM (ostream), 0);
460 return ostream->priv->valid_len;
464 * g_memory_output_stream_steal_data:
465 * @ostream: a #GMemoryOutputStream
467 * Gets any loaded data from the @ostream. Ownership of the data
468 * is transferred to the caller; when no longer needed it must be
469 * freed using the free function set in @ostream's
470 * #GMemoryOutputStream:destroy-function property.
472 * @ostream must be closed before calling this function.
474 * Returns: (transfer full): the stream's data
479 g_memory_output_stream_steal_data (GMemoryOutputStream *ostream)
483 g_return_val_if_fail (G_IS_MEMORY_OUTPUT_STREAM (ostream), NULL);
484 g_return_val_if_fail (g_output_stream_is_closed (G_OUTPUT_STREAM (ostream)), NULL);
486 data = ostream->priv->data;
487 ostream->priv->data = NULL;
493 * g_memory_output_stream_steal_as_bytes:
494 * @ostream: a #GMemoryOutputStream
496 * Returns data from the @ostream as a #GBytes. @ostream must be
497 * closed before calling this function.
499 * Returns: (transfer full): the stream's data
504 g_memory_output_stream_steal_as_bytes (GMemoryOutputStream *ostream)
508 g_return_val_if_fail (G_IS_MEMORY_OUTPUT_STREAM (ostream), NULL);
509 g_return_val_if_fail (g_output_stream_is_closed (G_OUTPUT_STREAM (ostream)), NULL);
511 result = g_bytes_new_with_free_func (ostream->priv->data,
512 ostream->priv->valid_len,
513 ostream->priv->destroy,
514 ostream->priv->data);
515 ostream->priv->data = NULL;
521 array_resize (GMemoryOutputStream *ostream,
523 gboolean allow_partial,
526 GMemoryOutputStreamPrivate *priv;
530 priv = ostream->priv;
532 if (priv->len == size)
535 if (!priv->realloc_fn)
538 priv->pos < priv->len)
539 return TRUE; /* Short write */
541 g_set_error_literal (error,
544 _("Memory output stream not resizable"));
549 data = priv->realloc_fn (priv->data, size);
551 if (size > 0 && !data)
554 priv->pos < priv->len)
555 return TRUE; /* Short write */
557 g_set_error_literal (error,
560 _("Failed to resize memory output stream"));
565 memset ((guint8 *)data + len, 0, size - len);
570 if (priv->len < priv->valid_len)
571 priv->valid_len = priv->len;
577 g_nearest_pow (gint num)
588 g_memory_output_stream_write (GOutputStream *stream,
591 GCancellable *cancellable,
594 GMemoryOutputStream *ostream;
595 GMemoryOutputStreamPrivate *priv;
599 ostream = G_MEMORY_OUTPUT_STREAM (stream);
600 priv = ostream->priv;
605 /* Check for address space overflow, but only if the buffer is resizable.
606 Otherwise we just do a short write and don't worry. */
607 if (priv->realloc_fn && priv->pos + count < priv->pos)
610 if (priv->pos + count > priv->len)
612 /* At least enought to fit the write, rounded up
613 for greater than linear growth.
614 TODO: This wastes a lot of memory at large stream sizes.
615 Figure out a more rational allocation strategy. */
616 new_size = g_nearest_pow (priv->pos + count);
617 /* Check for overflow again. We have only checked if
618 pos + count > G_MAXSIZE, but it only catches the case of writing
619 more than 4GiB total on a 32-bit system. There's still the problem
620 of g_nearest_pow overflowing above 0x7fffffff, so we're
621 effectively limited to 2GiB. */
622 if (new_size < priv->len)
625 new_size = MAX (new_size, MIN_ARRAY_SIZE);
626 if (!array_resize (ostream, new_size, TRUE, error))
630 /* Make sure we handle short writes if the array_resize
631 only added part of the required memory */
632 count = MIN (count, priv->len - priv->pos);
634 dest = (guint8 *)priv->data + priv->pos;
635 memcpy (dest, buffer, count);
638 if (priv->pos > priv->valid_len)
639 priv->valid_len = priv->pos;
644 /* Overflow: buffer size would need to be bigger than G_MAXSIZE. */
645 g_set_error_literal (error,
648 _("Amount of memory required to process the write is "
649 "larger than available address space"));
654 g_memory_output_stream_close (GOutputStream *stream,
655 GCancellable *cancellable,
662 g_memory_output_stream_close_async (GOutputStream *stream,
664 GCancellable *cancellable,
665 GAsyncReadyCallback callback,
670 task = g_task_new (stream, cancellable, callback, data);
672 /* will always return TRUE */
673 g_memory_output_stream_close (stream, cancellable, NULL);
675 g_task_return_boolean (task, TRUE);
676 g_object_unref (task);
680 g_memory_output_stream_close_finish (GOutputStream *stream,
681 GAsyncResult *result,
684 g_return_val_if_fail (g_task_is_valid (result, stream), -1);
686 return g_task_propagate_boolean (G_TASK (result), error);
690 g_memory_output_stream_tell (GSeekable *seekable)
692 GMemoryOutputStream *stream;
693 GMemoryOutputStreamPrivate *priv;
695 stream = G_MEMORY_OUTPUT_STREAM (seekable);
702 g_memory_output_stream_can_seek (GSeekable *seekable)
708 g_memory_output_stream_seek (GSeekable *seekable,
711 GCancellable *cancellable,
714 GMemoryOutputStream *stream;
715 GMemoryOutputStreamPrivate *priv;
718 stream = G_MEMORY_OUTPUT_STREAM (seekable);
724 absolute = priv->pos + offset;
732 absolute = priv->len + offset;
736 g_set_error_literal (error,
738 G_IO_ERROR_INVALID_ARGUMENT,
739 _("Invalid GSeekType supplied"));
746 g_set_error_literal (error,
748 G_IO_ERROR_INVALID_ARGUMENT,
749 _("Requested seek before the beginning of the stream"));
753 if (absolute > priv->len)
755 g_set_error_literal (error,
757 G_IO_ERROR_INVALID_ARGUMENT,
758 _("Requested seek beyond the end of the stream"));
762 priv->pos = absolute;
768 g_memory_output_stream_can_truncate (GSeekable *seekable)
770 GMemoryOutputStream *ostream;
771 GMemoryOutputStreamPrivate *priv;
773 ostream = G_MEMORY_OUTPUT_STREAM (seekable);
774 priv = ostream->priv;
776 return priv->realloc_fn != NULL;
780 g_memory_output_stream_truncate (GSeekable *seekable,
782 GCancellable *cancellable,
785 GMemoryOutputStream *ostream = G_MEMORY_OUTPUT_STREAM (seekable);
787 if (!array_resize (ostream, offset, FALSE, error))
794 g_memory_output_stream_is_writable (GPollableOutputStream *stream)
800 g_memory_output_stream_create_source (GPollableOutputStream *stream,
801 GCancellable *cancellable)
803 GSource *base_source, *pollable_source;
805 base_source = g_timeout_source_new (0);
806 pollable_source = g_pollable_source_new_full (stream, base_source,
808 g_source_unref (base_source);
810 return pollable_source;