1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
3 * Copyright (C) 2000-2012 Jeffrey Stedfast
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public License
7 * as published by the Free Software Foundation; either version 2.1
8 * 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 Public
16 * License along with this library; if not, write to the Free
17 * Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA
29 #include "gmime-stream-mem.h"
33 * SECTION: gmime-stream-mem
34 * @title: GMimeStreamMem
35 * @short_description: A memory-backed stream
36 * @see_also: #GMimeStream
38 * A simple #GMimeStream implementation that uses a memory buffer for
43 static void g_mime_stream_mem_class_init (GMimeStreamMemClass *klass);
44 static void g_mime_stream_mem_init (GMimeStreamMem *stream, GMimeStreamMemClass *klass);
45 static void g_mime_stream_mem_finalize (GObject *object);
47 static ssize_t stream_read (GMimeStream *stream, char *buf, size_t len);
48 static ssize_t stream_write (GMimeStream *stream, const char *buf, size_t len);
49 static int stream_flush (GMimeStream *stream);
50 static int stream_close (GMimeStream *stream);
51 static gboolean stream_eos (GMimeStream *stream);
52 static int stream_reset (GMimeStream *stream);
53 static gint64 stream_seek (GMimeStream *stream, gint64 offset, GMimeSeekWhence whence);
54 static gint64 stream_tell (GMimeStream *stream);
55 static gint64 stream_length (GMimeStream *stream);
56 static GMimeStream *stream_substream (GMimeStream *stream, gint64 start, gint64 end);
59 static GMimeStreamClass *parent_class = NULL;
63 g_mime_stream_mem_get_type (void)
65 static GType type = 0;
68 static const GTypeInfo info = {
69 sizeof (GMimeStreamMemClass),
70 NULL, /* base_class_init */
71 NULL, /* base_class_finalize */
72 (GClassInitFunc) g_mime_stream_mem_class_init,
73 NULL, /* class_finalize */
74 NULL, /* class_data */
75 sizeof (GMimeStreamMem),
77 (GInstanceInitFunc) g_mime_stream_mem_init,
80 type = g_type_register_static (GMIME_TYPE_STREAM, "GMimeStreamMem", &info, 0);
88 g_mime_stream_mem_class_init (GMimeStreamMemClass *klass)
90 GMimeStreamClass *stream_class = GMIME_STREAM_CLASS (klass);
91 GObjectClass *object_class = G_OBJECT_CLASS (klass);
93 parent_class = g_type_class_ref (GMIME_TYPE_STREAM);
95 object_class->finalize = g_mime_stream_mem_finalize;
97 stream_class->read = stream_read;
98 stream_class->write = stream_write;
99 stream_class->flush = stream_flush;
100 stream_class->close = stream_close;
101 stream_class->eos = stream_eos;
102 stream_class->reset = stream_reset;
103 stream_class->seek = stream_seek;
104 stream_class->tell = stream_tell;
105 stream_class->length = stream_length;
106 stream_class->substream = stream_substream;
110 g_mime_stream_mem_init (GMimeStreamMem *stream, GMimeStreamMemClass *klass)
112 stream->owner = TRUE;
113 stream->buffer = NULL;
117 g_mime_stream_mem_finalize (GObject *object)
119 GMimeStreamMem *stream = (GMimeStreamMem *) object;
121 if (stream->owner && stream->buffer)
122 g_byte_array_free (stream->buffer, TRUE);
124 G_OBJECT_CLASS (parent_class)->finalize (object);
129 stream_read (GMimeStream *stream, char *buf, size_t len)
131 GMimeStreamMem *mem = (GMimeStreamMem *) stream;
135 if (mem->buffer == NULL) {
140 bound_end = stream->bound_end != -1 ? stream->bound_end : (gint64) mem->buffer->len;
142 n = (size_t) MIN (bound_end - stream->position, (gint64) len);
144 memcpy (buf, mem->buffer->data + stream->position, n);
145 stream->position += n;
155 stream_write (GMimeStream *stream, const char *buf, size_t len)
157 GMimeStreamMem *mem = (GMimeStreamMem *) stream;
161 if (mem->buffer == NULL) {
166 if (stream->bound_end == -1) {
167 if (stream->position + len > mem->buffer->len)
168 g_byte_array_set_size (mem->buffer, (guint) stream->position + len);
170 bound_end = mem->buffer->len;
172 bound_end = stream->bound_end;
174 n = (size_t) MIN (bound_end - stream->position, (gint64) len);
176 memcpy (mem->buffer->data + stream->position, buf, n);
177 stream->position += n;
187 stream_flush (GMimeStream *stream)
189 GMimeStreamMem *mem = (GMimeStreamMem *) stream;
191 if (mem->buffer == NULL) {
200 stream_close (GMimeStream *stream)
202 GMimeStreamMem *mem = (GMimeStreamMem *) stream;
204 if (mem->owner && mem->buffer)
205 g_byte_array_free (mem->buffer, TRUE);
213 stream_eos (GMimeStream *stream)
215 GMimeStreamMem *mem = (GMimeStreamMem *) stream;
218 if (mem->buffer == NULL)
221 bound_end = stream->bound_end != -1 ? stream->bound_end : (gint64) mem->buffer->len;
223 return stream->position >= bound_end;
227 stream_reset (GMimeStream *stream)
229 GMimeStreamMem *mem = (GMimeStreamMem *) stream;
231 if (mem->buffer == NULL) {
240 stream_seek (GMimeStream *stream, gint64 offset, GMimeSeekWhence whence)
242 GMimeStreamMem *mem = (GMimeStreamMem *) stream;
243 gint64 bound_end, real = stream->position;
245 if (mem->buffer == NULL) {
250 bound_end = stream->bound_end != -1 ? stream->bound_end : (gint64) mem->buffer->len;
253 case GMIME_STREAM_SEEK_SET:
256 case GMIME_STREAM_SEEK_END:
257 real = offset + bound_end;
259 case GMIME_STREAM_SEEK_CUR:
260 real = stream->position + offset;
264 if (real < stream->bound_start) {
269 if (stream->bound_end != -1 && real > bound_end) {
274 if (real > bound_end) {
275 if (real > G_MAXUINT) {
280 g_byte_array_set_size (mem->buffer, (guint) real);
283 stream->position = real;
285 return stream->position;
289 stream_tell (GMimeStream *stream)
291 GMimeStreamMem *mem = (GMimeStreamMem *) stream;
293 if (mem->buffer == NULL) {
298 return stream->position;
302 stream_length (GMimeStream *stream)
304 GMimeStreamMem *mem = GMIME_STREAM_MEM (stream);
307 if (mem->buffer == NULL) {
312 bound_end = stream->bound_end != -1 ? stream->bound_end : (gint64) mem->buffer->len;
314 return bound_end - stream->bound_start;
318 stream_substream (GMimeStream *stream, gint64 start, gint64 end)
322 mem = g_object_newv (GMIME_TYPE_STREAM_MEM, 0, NULL);
323 g_mime_stream_construct ((GMimeStream *) mem, start, end);
324 mem->buffer = GMIME_STREAM_MEM (stream)->buffer;
327 return (GMimeStream *) mem;
332 * g_mime_stream_mem_new:
334 * Creates a new #GMimeStreamMem object.
336 * Returns: a new memory stream.
339 g_mime_stream_mem_new (void)
343 mem = g_object_newv (GMIME_TYPE_STREAM_MEM, 0, NULL);
344 g_mime_stream_construct ((GMimeStream *) mem, 0, -1);
345 mem->buffer = g_byte_array_new ();
348 return (GMimeStream *) mem;
353 * g_mime_stream_mem_new_with_byte_array:
354 * @array: source data
356 * Creates a new #GMimeStreamMem with data @array.
358 * Returns: a new memory stream using @array.
361 g_mime_stream_mem_new_with_byte_array (GByteArray *array)
365 mem = g_object_newv (GMIME_TYPE_STREAM_MEM, 0, NULL);
366 g_mime_stream_construct ((GMimeStream *) mem, 0, -1);
370 return (GMimeStream *) mem;
375 * g_mime_stream_mem_new_with_buffer:
376 * @buffer: stream data
377 * @len: buffer length
379 * Creates a new #GMimeStreamMem object and initializes the stream
380 * contents with the first @len bytes of @buffer.
382 * Returns: a new memory stream initialized with @buffer.
385 g_mime_stream_mem_new_with_buffer (const char *buffer, size_t len)
389 mem = g_object_newv (GMIME_TYPE_STREAM_MEM, 0, NULL);
390 g_mime_stream_construct ((GMimeStream *) mem, 0, -1);
391 mem->buffer = g_byte_array_new ();
394 g_byte_array_append (mem->buffer, (unsigned char *) buffer, len);
396 return (GMimeStream *) mem;
401 * g_mime_stream_mem_get_byte_array:
402 * @mem: a #GMimeStreamMem
404 * Gets the byte array from the memory stream.
406 * Returns: the byte array from the memory stream.
409 g_mime_stream_mem_get_byte_array (GMimeStreamMem *mem)
411 g_return_val_if_fail (GMIME_IS_STREAM_MEM (mem), NULL);
418 * g_mime_stream_mem_set_byte_array:
419 * @mem: a #GMimeStreamMem
420 * @array: stream data
422 * Sets the byte array on the memory stream.
424 * Note: The memory stream is not responsible for freeing the byte
425 * array. Use g_mime_stream_mem_set_owner() to change this behavior.
428 g_mime_stream_mem_set_byte_array (GMimeStreamMem *mem, GByteArray *array)
432 g_return_if_fail (GMIME_IS_STREAM_MEM (mem));
433 g_return_if_fail (array != NULL);
435 if (mem->owner && mem->buffer)
436 g_byte_array_free (mem->buffer, TRUE);
441 stream = GMIME_STREAM (mem);
443 stream->position = 0;
444 stream->bound_start = 0;
445 stream->bound_end = -1;
450 * g_mime_stream_mem_get_owner:
451 * @mem: a #GMimeStreamMem
453 * Gets whether or not @mem owns the backend memory buffer.
455 * Returns: %TRUE if @mem owns the backend memory buffer or %FALSE
459 g_mime_stream_mem_get_owner (GMimeStreamMem *mem)
461 g_return_val_if_fail (GMIME_IS_STREAM_MEM (mem), FALSE);
468 * g_mime_stream_mem_set_owner:
469 * @mem: a #GMimeStreamMem
470 * @owner: %TRUE if this stream should own the #GByteArray or %FALSE otherwise
472 * Sets whether or not @mem owns the backend memory buffer.
474 * Note: @owner should be %TRUE if the stream should free the backend
475 * memory buffer when destroyed or %FALSE otherwise.
478 g_mime_stream_mem_set_owner (GMimeStreamMem *mem, gboolean owner)
480 g_return_if_fail (GMIME_IS_STREAM_MEM (mem));