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 "gmemoryinputstream.h"
25 #include "ginputstream.h"
26 #include "gseekable.h"
28 #include "gsimpleasyncresult.h"
34 * SECTION:gmemoryinputstream
35 * @short_description: Streaming input operations on memory chunks
37 * @see_also: #GMemoryOutputStream
39 * #GMemoryInputStream is a class for using arbitrary
40 * memory chunks as input for GIO streaming input operations.
44 typedef struct _Chunk Chunk;
49 GDestroyNotify destroy;
52 struct _GMemoryInputStreamPrivate {
58 static gssize g_memory_input_stream_read (GInputStream *stream,
61 GCancellable *cancellable,
63 static gssize g_memory_input_stream_skip (GInputStream *stream,
65 GCancellable *cancellable,
67 static gboolean g_memory_input_stream_close (GInputStream *stream,
68 GCancellable *cancellable,
70 static void g_memory_input_stream_read_async (GInputStream *stream,
74 GCancellable *cancellable,
75 GAsyncReadyCallback callback,
77 static gssize g_memory_input_stream_read_finish (GInputStream *stream,
80 static void g_memory_input_stream_skip_async (GInputStream *stream,
83 GCancellable *cancellabl,
84 GAsyncReadyCallback callback,
86 static gssize g_memory_input_stream_skip_finish (GInputStream *stream,
89 static void g_memory_input_stream_close_async (GInputStream *stream,
91 GCancellable *cancellabl,
92 GAsyncReadyCallback callback,
94 static gboolean g_memory_input_stream_close_finish (GInputStream *stream,
98 static void g_memory_input_stream_seekable_iface_init (GSeekableIface *iface);
99 static goffset g_memory_input_stream_tell (GSeekable *seekable);
100 static gboolean g_memory_input_stream_can_seek (GSeekable *seekable);
101 static gboolean g_memory_input_stream_seek (GSeekable *seekable,
104 GCancellable *cancellable,
106 static gboolean g_memory_input_stream_can_truncate (GSeekable *seekable);
107 static gboolean g_memory_input_stream_truncate (GSeekable *seekable,
109 GCancellable *cancellable,
111 static void g_memory_input_stream_finalize (GObject *object);
113 G_DEFINE_TYPE_WITH_CODE (GMemoryInputStream, g_memory_input_stream, G_TYPE_INPUT_STREAM,
114 G_IMPLEMENT_INTERFACE (G_TYPE_SEEKABLE,
115 g_memory_input_stream_seekable_iface_init))
119 g_memory_input_stream_class_init (GMemoryInputStreamClass *klass)
121 GObjectClass *object_class;
122 GInputStreamClass *istream_class;
124 g_type_class_add_private (klass, sizeof (GMemoryInputStreamPrivate));
126 object_class = G_OBJECT_CLASS (klass);
127 object_class->finalize = g_memory_input_stream_finalize;
129 istream_class = G_INPUT_STREAM_CLASS (klass);
130 istream_class->read_fn = g_memory_input_stream_read;
131 istream_class->skip = g_memory_input_stream_skip;
132 istream_class->close_fn = g_memory_input_stream_close;
134 istream_class->read_async = g_memory_input_stream_read_async;
135 istream_class->read_finish = g_memory_input_stream_read_finish;
136 istream_class->skip_async = g_memory_input_stream_skip_async;
137 istream_class->skip_finish = g_memory_input_stream_skip_finish;
138 istream_class->close_async = g_memory_input_stream_close_async;
139 istream_class->close_finish = g_memory_input_stream_close_finish;
143 free_chunk (gpointer data,
149 chunk->destroy (chunk->data);
151 g_slice_free (Chunk, chunk);
155 g_memory_input_stream_finalize (GObject *object)
157 GMemoryInputStream *stream;
158 GMemoryInputStreamPrivate *priv;
160 stream = G_MEMORY_INPUT_STREAM (object);
163 g_slist_foreach (priv->chunks, free_chunk, NULL);
164 g_slist_free (priv->chunks);
166 if (G_OBJECT_CLASS (g_memory_input_stream_parent_class)->finalize)
167 (*G_OBJECT_CLASS (g_memory_input_stream_parent_class)->finalize) (object);
171 g_memory_input_stream_seekable_iface_init (GSeekableIface *iface)
173 iface->tell = g_memory_input_stream_tell;
174 iface->can_seek = g_memory_input_stream_can_seek;
175 iface->seek = g_memory_input_stream_seek;
176 iface->can_truncate = g_memory_input_stream_can_truncate;
177 iface->truncate_fn = g_memory_input_stream_truncate;
181 g_memory_input_stream_init (GMemoryInputStream *stream)
183 stream->priv = G_TYPE_INSTANCE_GET_PRIVATE (stream,
184 G_TYPE_MEMORY_INPUT_STREAM,
185 GMemoryInputStreamPrivate);
189 g_memory_input_stream_new (void)
191 GInputStream *stream;
193 stream = g_object_new (G_TYPE_MEMORY_INPUT_STREAM, NULL);
199 * g_memory_input_stream_new_from_data:
201 * @len: length of the data, may be -1 if @data is a nul-terminated string
202 * @destroy: function that is called to free @data, or %NULL
204 * Creates a new #GMemoryInputStream with data in memory of a given size.
206 * Returns: new #GInputStream read from @data of @len bytes.
209 g_memory_input_stream_new_from_data (const void *data,
211 GDestroyNotify destroy)
213 GInputStream *stream;
215 stream = g_memory_input_stream_new ();
217 g_memory_input_stream_add_data (G_MEMORY_INPUT_STREAM (stream),
224 g_memory_input_stream_add_data (GMemoryInputStream *stream,
227 GDestroyNotify destroy)
229 GMemoryInputStreamPrivate *priv;
232 g_return_if_fail (G_IS_MEMORY_INPUT_STREAM (stream));
233 g_return_if_fail (data != NULL);
240 chunk = g_slice_new (Chunk);
241 chunk->data = (guint8 *)data;
243 chunk->destroy = destroy;
245 priv->chunks = g_slist_append (priv->chunks, chunk);
246 priv->len += chunk->len;
250 g_memory_input_stream_read (GInputStream *stream,
253 GCancellable *cancellable,
256 GMemoryInputStream *memory_stream;
257 GMemoryInputStreamPrivate *priv;
260 gsize offset, start, rest, size;
262 memory_stream = G_MEMORY_INPUT_STREAM (stream);
263 priv = memory_stream->priv;
265 count = MIN (count, priv->len - priv->pos);
268 for (l = priv->chunks; l; l = l->next)
270 chunk = (Chunk *)l->data;
272 if (offset + chunk->len > priv->pos)
275 offset += chunk->len;
278 start = priv->pos - offset;
281 for (; l && rest > 0; l = l->next)
283 chunk = (Chunk *)l->data;
284 size = MIN (rest, chunk->len - start);
286 memcpy (buffer + (count - rest), chunk->data + start, size);
298 g_memory_input_stream_skip (GInputStream *stream,
300 GCancellable *cancellable,
303 GMemoryInputStream *memory_stream;
304 GMemoryInputStreamPrivate *priv;
306 memory_stream = G_MEMORY_INPUT_STREAM (stream);
307 priv = memory_stream->priv;
309 count = MIN (count, priv->len - priv->pos);
316 g_memory_input_stream_close (GInputStream *stream,
317 GCancellable *cancellable,
324 g_memory_input_stream_read_async (GInputStream *stream,
328 GCancellable *cancellable,
329 GAsyncReadyCallback callback,
332 GSimpleAsyncResult *simple;
335 nread = g_memory_input_stream_read (stream, buffer, count, cancellable, NULL);
336 simple = g_simple_async_result_new (G_OBJECT (stream),
339 g_memory_input_stream_read_async);
340 g_simple_async_result_set_op_res_gssize (simple, nread);
341 g_simple_async_result_complete_in_idle (simple);
342 g_object_unref (simple);
346 g_memory_input_stream_read_finish (GInputStream *stream,
347 GAsyncResult *result,
350 GSimpleAsyncResult *simple;
353 simple = G_SIMPLE_ASYNC_RESULT (result);
354 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_memory_input_stream_read_async);
356 nread = g_simple_async_result_get_op_res_gssize (simple);
361 g_memory_input_stream_skip_async (GInputStream *stream,
364 GCancellable *cancellable,
365 GAsyncReadyCallback callback,
368 GSimpleAsyncResult *simple;
371 nskipped = g_memory_input_stream_skip (stream, count, cancellable, NULL);
372 simple = g_simple_async_result_new (G_OBJECT (stream),
375 g_memory_input_stream_skip_async);
376 g_simple_async_result_set_op_res_gssize (simple, nskipped);
377 g_simple_async_result_complete_in_idle (simple);
378 g_object_unref (simple);
382 g_memory_input_stream_skip_finish (GInputStream *stream,
383 GAsyncResult *result,
386 GSimpleAsyncResult *simple;
389 simple = G_SIMPLE_ASYNC_RESULT (result);
390 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_memory_input_stream_skip_async);
392 nskipped = g_simple_async_result_get_op_res_gssize (simple);
397 g_memory_input_stream_close_async (GInputStream *stream,
399 GCancellable *cancellable,
400 GAsyncReadyCallback callback,
403 GSimpleAsyncResult *simple;
405 simple = g_simple_async_result_new (G_OBJECT (stream),
408 g_memory_input_stream_close_async);
409 g_simple_async_result_complete_in_idle (simple);
410 g_object_unref (simple);
414 g_memory_input_stream_close_finish (GInputStream *stream,
415 GAsyncResult *result,
422 g_memory_input_stream_tell (GSeekable *seekable)
424 GMemoryInputStream *memory_stream;
425 GMemoryInputStreamPrivate *priv;
427 memory_stream = G_MEMORY_INPUT_STREAM (seekable);
428 priv = memory_stream->priv;
434 gboolean g_memory_input_stream_can_seek (GSeekable *seekable)
440 g_memory_input_stream_seek (GSeekable *seekable,
443 GCancellable *cancellable,
446 GMemoryInputStream *memory_stream;
447 GMemoryInputStreamPrivate *priv;
450 memory_stream = G_MEMORY_INPUT_STREAM (seekable);
451 priv = memory_stream->priv;
456 absolute = priv->pos + offset;
464 absolute = priv->len + offset;
470 G_IO_ERROR_INVALID_ARGUMENT,
471 _("Invalid GSeekType supplied"));
476 if (absolute < 0 || absolute > priv->len)
480 G_IO_ERROR_INVALID_ARGUMENT,
481 _("Invalid seek request"));
485 priv->pos = absolute;
491 g_memory_input_stream_can_truncate (GSeekable *seekable)
497 g_memory_input_stream_truncate (GSeekable *seekable,
499 GCancellable *cancellable,
504 G_IO_ERROR_NOT_SUPPORTED,
505 _("Cannot truncate GMemoryInputStream"));
509 #define __G_MEMORY_INPUT_STREAM_C__
510 #include "gioaliasdef.c"