Big cleanup of camel-stream-*, got rid of 3 classes, improved the interfaces,

and fixed at least one problem (end of stream never happening in certain
cases).  Things that can fail now have a way of saying they failed too.

So much for taking ANZAC day off to get drunk!

2000-04-26  NotZed  <NotZed@HelixCode.com>

	* camel-seekable-substream.c (stream_seek): Changed to have
	absolute seek semantics, not relative to the bounds.

	* camel-seekable-stream.c (reset): When we reset, seek to the
	start of the bound, if there is one.
	(stream_tell): Make tell virtual.

	* camel-stream-filter.c (do_available): Removed.

	* camel-stream-buffer.c: Remove leading _'s from static functions.
	(stream_read): Renamed from read().  Fancy that conflicting!  (my
	boo!)  Others too.

	* providers/pop3/camel-pop3-folder.c (get_message_by_number):
	Changed to stream_mem interface.

	* providers/mbox/camel-mbox-folder.c (_get_message_by_uid): Fixed
	for streamfs interface changes, and implement a failure case.
	(_append_message): Changed for fs stream interface change.

	* camel-multipart.c (print_part): Iterate rahter than callback.  I
	hate glists's interface (hence, move this to write_to_stream).
	(write_to_stream): Return an error (yuck, this is a royal PITA to
	do with the stream write interface).

	* camel-mime-message.c: Removed leading _ from static names.

	* camel-mime-part.h: construct_from_parser() now returns an error
	code.

	* camel-mime-part-utils.c
	(camel_mime_part_construct_content_from_parser): Changed to use a
	camel-data-wrapper instead of a camel-simple-data-wrapper (no
	change needed elsewhere?).
	(simple_data_wrapper_construct_from_parser): Fixes for stream-mem
	interface changes.

	* camel-simple-data-wrapper.[ch],
	camel-simple-data-wrapper-stream.[ch],
	camel-stream-data-wrapper.[ch], removed.  Fixed including of these
	files.

	* camel-mime-part.c (camel_mime_part_set_text): Remove the use of
	the camel-simple-data-wrapper-stream, just use a mem stream.
	(write_to_stream): Renamed from my_*
	(construct_from_stream): Return an error on error.

	* camel-stream-mem.c (camel_stream_mem_new*): Remove mode
	parameter.

	* camel-stream-mem.h (enum CamelStreamMemMode): Removed.  It
	wasn't used at all.

	* camel-data-wrapper.h: Add camel_data_wrapper_new() to create
	these.
	(write_to_stream, construct_from_stream): Return an error
	indicator for success.  Fixed all methods to match (ICK).

	* Makefile.am (libcamel_la_SOURCES): Remove
	camel-simple-data-wrapper.c, camel-simple-data-wrapper-stream.c,
	camel-stream-data-wrapper.c.  Obsoleted by code re-use!

	* camel-data-wrapper.c (construct_from_stream): Change the default
	implementation to just set the output stream == construction
	stream.  Well, this lets me get rid of both simple-data-wrapper
	and stream-data-wrapper (unused anyway), and
	simple-data-wrapper-stream in one hit.  CamelDataWrapper is now
	also a concrete class.
	(write_to_stream): Use camel_stream_write_to_stream() to
	calculate/return values (and save code).
	Include <errno.h> for obvious reasons.

	* camel-stream.c (eos): Provide a default implementation of .eos().
	(camel_stream_write_to_stream): Make it return an error code on
	error.
	(camel_stream_printf): Changed to return the number of bytes
	written/error.
	(camel_stream_available): Removed.

	* camel-stream-fs.h (enum CamelStreamFsMode): Removed.  Changed to
	use unix modes and so forth (wasn't used for anything but new file
	creation and didn't work well either).

	* camel-stream-fs.c: Removed leading _'s for names.  And removed
	some virtual method 'documentation'.
	(destroy): Dont try and close a closed/error fd.  Only report
	error if close returns -1.  Moved all the code to finalise(), and
	killed this function.
	(init_with_fd): Properly setup the seek offset, if it is a
	valid and seekable file descriptor.
	(init_with_fd_and_bounds): Use off_t for bounds, set bounds on the
	seekable stream.
	(init_with_name): Return error codes.
	(init_with_name_and_bounds): Ditto.
	(camel_stream_fs_new_with_name): REturn NULL object if it failed.
	(camel_stream_fs_new_with_name_and_bounds): Return NULL object on
	failure.  Changed with_name* api's to take unix open style args
	and flags.
	(read): The bounded stream bounds checking seemed off, simplified
	code a bit.
	(write): Implement bounds checking for writing, the comment was
	wrong, it could make sense to bound writing.  Cleaned up a little.
	(available): Gone.
	(eos): Removed.  Use CamelStream's implementation now.
	(close): Reset the fd to -1, provide a warning for bad usage.
	(seek): Cleaned up.  Changed the behaviour a little, the returned
	offset is the absolute position in the file, even in bounded
	streams.
	(seek): Seek from end mirrors lseek() behaviour (reverse seeking).

2000-04-25  NotZed  <NotZed@HelixCode.com>

	* camel-stream-fs.h (struct _CamelStreamFs): Moved bounds and eof
	indicator to other parent classes.

	* camel-stream.c (camel_stream_printf): New utility
	function.  Obvious use.

	* camel-stream-mem.c: Removed leading _'s from static func's.
	(camel_stream_mem_new_with_byte_array): Fixed for api changes, set
	the owner for the byte array to us.
	: Removed A bunch of gtk doc stuff for static (implementation) functions.
	(available): Removed.
	(write): Fixed the write implementation so that seek() works on a
	seekable memory stream, as expected.  Seeking past the end of the
	buffer has unix semantics (filling with 0).
	(available): Removed.
	(write): Implement seekable stream bounded stream.
	(read): Implement seekable stream bounded stream.
	(close): Dont free the stream_mem if we're not the owner.
	(seek): Allow to seek beyond the end of memory area,
	implement bounds checking.
	(seek): Set errno on bad policy.

	* camel-stream-mem.h (struct _CamelStreamMem): Changed position to off_t.
	(new_with_buffer): Changed len to be a size_t.
	(set_buffer, set_byte_array): New interface functions.
	(struct _CamelStreamMem): Removed position, it is stored in the
	superclass.

	* camel-stream.h: Removed some of the seemingly random
	whitespace.  Removed the available method (its not
	impelemented/useful enough).

	* camel-seekable-substream.c
	(init_with_seekable_stream_and_bounds): Remove the data_available
	stuff, it hasn't been properly implemented/finished, and may never
	work (unfortunately *sigh).
	(reemit_parent_signal): Removed part of the above change.
	(set_bounds): Removed (moved to seekable-stream).
	: Fixed up some of the generally unreadable indenting (sorry,
	wrapping at 80 characters with
	camels_really_long_function_names()
	just_doesnt_work_very_well_does_it().
	(available): Removed.
	(stream_seek): Fixup for object changes.  Make sure we return -1
	if the parent stream can't seek.

	* camel-seekable-stream.c (ccamel_seekable_stream_set_bounds): New
	function to bound any seekable stream.
	: Removed _'s.
	(camel_seekable_stream_class_init): Implement an init function, to
	setup the stream bounds to unbound.

	* camel-seekable-stream.h (CamelSeekableStreamClass): New virtual
	method set_bounds for seekable streams.
	(CAMEL_STREAM_UNBOUND): New define for no bound.

	* camel-seekable-substream.h (struct _CamelSeekableSubstream):
	Removed sup_bound and inf_bound, moved to CamelSeekableStream (and
	renamed, and changed to off_t's).
	(new_with_seekable_stream_and_bounds): Use off_t as the bounds.
	(CamelSeekableSubstreamClass): Uh, why was the intialiser virtual?
	Removed.

	* camel-seekable-stream.[ch] (CamelSeekableStreamClass): Changed seek
	to accept an off_t as the offset.
	(struct _CamelSeekableStream): Renamed cur_pos to position and
	changed it to an off_t type.
	(enum CamelStreamSeekPolicy): Set to match the SEEK_* constants
	from lseek().
	(get_current_position): Renamed to tell().

	* camel-stream-buffer.h: Commented out set_vbuf - never implemented.

svn path=/trunk/; revision=2624

1 files changed, 105 insertions, 132 deletions

diff --git a/camel/camel-stream-mem.c b/camel/camel-stream-mem.c
index 3e33f18f08..837fa17560 100644
--- a/camel/camel-stream-mem.c
+++ b/camel/camel-stream-mem.c
@@ -1,11 +1,9 @@
 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
-/* camel-stream-mem.c : memory buffer based stream */
-
-/* inspired by gnome-stream-mem.c in bonobo by Miguel de Icaza */
-/* 
+/* camel-stream-mem.c : memory buffer based stream
+ * inspired by gnome-stream-mem.c in bonobo by Miguel de Icaza
  *
- * Author : 
- *  Bertrand Guiheneuf <bertrand@helixcode.com>
+ * Authors: Bertrand Guiheneuf <bertrand@helixcode.com>
+ *	    Michael Zucchi <notzed@helixcode.com>
  *
  * Copyright 1999, 2000 Helix Code, Inc. (http://www.helixcode.com)
  *
@@ -33,19 +31,17 @@
 
 static CamelStreamClass *parent_class=NULL;
 
-
 /* Returns the class for a CamelStreamMEM */
 #define CSM_CLASS(so) CAMEL_STREAM_MEM_CLASS (GTK_OBJECT(so)->klass)
 
-static gint _read (CamelStream *stream, gchar *buffer, gint n);
-static gint _write (CamelStream *stream, const gchar *buffer, gint n);
-static void _flush (CamelStream *stream);
-static gint _available (CamelStream *stream);
-static gboolean _eos (CamelStream *stream);
-static void _close (CamelStream *stream);
-static gint _seek (CamelSeekableStream *stream, gint offset, CamelStreamSeekPolicy policy);
+static gint stream_read (CamelStream *stream, gchar *buffer, gint n);
+static gint stream_write (CamelStream *stream, const gchar *buffer, gint n);
+static void stream_flush (CamelStream *stream);
+static gboolean stream_eos (CamelStream *stream);
+static void stream_close (CamelStream *stream);
+static off_t stream_seek (CamelSeekableStream *stream, off_t offset, CamelStreamSeekPolicy policy);
 
-static void _finalize (GtkObject *object);
+static void finalize (GtkObject *object);
 
 static void
 camel_stream_mem_class_init (CamelStreamMemClass *camel_stream_mem_class)
@@ -59,24 +55,23 @@ camel_stream_mem_class_init (CamelStreamMemClass *camel_stream_mem_class)
 	/* virtual method definition */
 	
 	/* virtual method overload */
-	camel_stream_class->read = _read;
-	camel_stream_class->write = _write;
-	camel_stream_class->flush = _flush;
-	camel_stream_class->available = _available;
-	camel_stream_class->eos = _eos;
-	camel_stream_class->close = _close;
-
-	camel_seekable_stream_class->seek = _seek;
-	
-	gtk_object_class->finalize = _finalize;
+	camel_stream_class->read = stream_read;
+	camel_stream_class->write = stream_write;
+	camel_stream_class->flush = stream_flush;
+	camel_stream_class->eos = stream_eos;
+	camel_stream_class->close = stream_close;
+
+	camel_seekable_stream_class->seek = stream_seek;
 	
+	gtk_object_class->finalize = finalize;
 }
 
 static void
 camel_stream_mem_init (gpointer   object,  gpointer   klass)
 {
-	CamelStreamMem *camel_stream_mem = CAMEL_STREAM_MEM (object);
-	camel_stream_mem->position = 0;
+	CamelStreamMem *stream_mem = CAMEL_STREAM_MEM (object);
+	stream_mem->owner = FALSE;
+	stream_mem->buffer = 0;
 }
 
 GtkType
@@ -105,191 +100,169 @@ camel_stream_mem_get_type (void)
 
 
 CamelStream *
-camel_stream_mem_new (CamelStreamMemMode mode)
+camel_stream_mem_new (void)
 {
-	return camel_stream_mem_new_with_byte_array (g_byte_array_new (),
-						     mode);
+	return camel_stream_mem_new_with_byte_array (g_byte_array_new ());
 }
 
 CamelStream *
-camel_stream_mem_new_with_buffer (const char *buffer, unsigned int len,
-				  CamelStreamMemMode mode)
+camel_stream_mem_new_with_buffer (const char *buffer, unsigned int len)
 {
 	GByteArray *ba;
 
 	ba = g_byte_array_new ();
 	g_byte_array_append (ba, (const guint8 *)buffer, len);
-	return camel_stream_mem_new_with_byte_array (ba, mode);
+	return camel_stream_mem_new_with_byte_array (ba);
 }
 
 CamelStream *
-camel_stream_mem_new_with_byte_array (GByteArray *byte_array,
-				      CamelStreamMemMode mode)
+camel_stream_mem_new_with_byte_array (GByteArray *byte_array)
 {
 	CamelStreamMem *stream_mem;
 	
 	stream_mem = gtk_type_new (camel_stream_mem_get_type ());
-	stream_mem->mode = mode;
 	stream_mem->buffer = byte_array;
+	stream_mem->owner = TRUE;
 	
 	return CAMEL_STREAM (stream_mem);
 }
 
+/* note: with these functions the caller is the 'owner' of the buffer */
+void camel_stream_mem_set_byte_array (CamelStreamMem *s, GByteArray *buffer)
+{
+	if (s->buffer && s->owner)
+		g_byte_array_free(s->buffer, TRUE);
+	s->owner = FALSE;
+	s->buffer = buffer;
+}
+
+void camel_stream_mem_set_buffer (CamelStreamMem *s, const char *buffer, size_t len)
+{
+	GByteArray *ba;
 
+	ba = g_byte_array_new ();
+	g_byte_array_append (ba, (const guint8 *)buffer, len);
+	camel_stream_mem_set_byte_array(s, ba);
+}
 
 static void           
-_finalize (GtkObject *object)
+finalize (GtkObject *object)
 {
 	CamelStreamMem *stream_mem = CAMEL_STREAM_MEM (object);
 
-	if (stream_mem->buffer)
+	if (stream_mem->buffer && stream_mem->owner)
 		g_byte_array_free (stream_mem->buffer, TRUE);
 
 	GTK_OBJECT_CLASS (parent_class)->finalize (object);
 }
 
-
-
-/**
- * _read: read bytes from a stream
- * @stream: stream
- * @buffer: buffer where bytes are stored
- * @n: max number of bytes to read
- * 
- * 
- * 
- * Return value: number of bytes actually read.
- **/
 static gint
-_read (CamelStream *stream, gchar *buffer, gint n)
+stream_read (CamelStream *stream, gchar *buffer, gint n)
 {
 	CamelStreamMem *camel_stream_mem = CAMEL_STREAM_MEM (stream);
-	gint nb_bytes_to_read;
+	CamelSeekableStream *seekable = (CamelSeekableStream *)stream;
 
 	g_assert (stream);
-	nb_bytes_to_read = MIN (n, (camel_stream_mem->buffer)->len - camel_stream_mem->position);
-	if (nb_bytes_to_read>0) {
-		memcpy (buffer, (camel_stream_mem->buffer)->data + camel_stream_mem->position, nb_bytes_to_read);
-		camel_stream_mem->position += nb_bytes_to_read;
-	} else nb_bytes_to_read = -1;
 
-	return nb_bytes_to_read;
-}
+	if (seekable->bound_end != CAMEL_STREAM_UNBOUND) {
+		n = MIN(seekable->bound_end - seekable->position, n);
+	}
+
+	n = MIN (n, camel_stream_mem->buffer->len - seekable->position);
+	if (n>0) {
+		memcpy (buffer, (camel_stream_mem->buffer)->data + seekable->position, n);
+		seekable->position += n;
+	} else {
+		n = -1;
+	}
 
+	return n;
+}
 
-/**
- * _write: read bytes to a stream
- * @stream: the stream
- * @buffer: byte buffer
- * @n: number of bytes to write
- * 
- * 
- * 
- * Return value: the number of bytes actually written
- *  in the stream.
- **/
 static gint
-_write (CamelStream *stream, const gchar *buffer, gint n)
+stream_write (CamelStream *stream, const gchar *buffer, gint n)
 {
-	CamelStreamMem *camel_stream_mem = CAMEL_STREAM_MEM (stream);
+	CamelStreamMem *stream_mem = CAMEL_STREAM_MEM (stream);
+	CamelSeekableStream *seekable = (CamelSeekableStream *)stream;
 
 	g_assert (stream);
-	g_return_val_if_fail (camel_stream_mem->position>=0, -1);
-	camel_stream_mem->buffer = g_byte_array_append (camel_stream_mem->buffer, (const guint8 *)buffer, n);
-	camel_stream_mem->position += n;
+
+	if (seekable->bound_end != CAMEL_STREAM_UNBOUND) {
+		n = MIN(seekable->bound_end - seekable->position, n);
+	}
+
+#warning "g_byte_arrays use g_malloc and so are totally unsuitable for this object"
+	if (seekable->position == stream_mem->buffer->len) {
+		stream_mem->buffer = g_byte_array_append (stream_mem->buffer, (const guint8 *)buffer, n);
+	} else {
+		g_byte_array_set_size(stream_mem->buffer, n+stream_mem->buffer->len);
+		memcpy(stream_mem->buffer->data + seekable->position, buffer, n);
+	}
+	seekable->position += n;
 	
 	return n;
 }
 
-
-
-/**
- * _flush: flush pending changes 
- * @stream: the stream
- * 
- * 
- **/
 static void
-_flush (CamelStream *stream)
+stream_flush (CamelStream *stream)
 {
 	/* Nothing to do. */
 	return;
 }
 
-
-
-/**
- * _available: return the number of bytes available for reading
- * @stream: the stream
- * 
- * Return the number of bytes available without blocking.
- * 
- * Return value: the number of bytes available
- **/
-static gint 
-_available (CamelStream *stream)
-{
-	CamelStreamMem *camel_stream_mem = CAMEL_STREAM_MEM (stream);
-
-	return camel_stream_mem->buffer->len - camel_stream_mem->position;
-}
-
-
-/**
- * _eos: test if there are bytes left to read
- * @stream: the stream
- * 
- * Return value: true if all stream has been read
- **/
 static gboolean
-_eos (CamelStream *stream)
+stream_eos (CamelStream *stream)
 {
-	return _available (stream) == 0;
+	return ((CamelStreamMem *)stream)->buffer->len <= ((CamelSeekableStream *)stream)->position;
 }
 
-
-/**
- * _close: close a stream
- * @stream: the stream
- * 
- * 
- **/
 static void
-_close (CamelStream *stream)
+stream_close (CamelStream *stream)
 {
 	CamelStreamMem *stream_mem = CAMEL_STREAM_MEM (stream);
 
-	if (stream_mem->buffer)
+	if (stream_mem->buffer && stream_mem->owner)
 		g_byte_array_free (stream_mem->buffer, TRUE);
 	stream_mem->buffer = NULL;
 }
 
-
-
-static gint
-_seek (CamelSeekableStream *stream, gint offset, CamelStreamSeekPolicy policy)
+static off_t
+stream_seek (CamelSeekableStream *stream, off_t offset, CamelStreamSeekPolicy policy)
 {
-	gint position;
-	CamelStreamMem *camel_stream_mem = CAMEL_STREAM_MEM (stream);
+	off_t position;
+	CamelStreamMem *stream_mem = (CamelStreamMem *)stream;
 
 	switch  (policy) {
 	case CAMEL_STREAM_SET:
 		position = offset;
 		break;
 	case CAMEL_STREAM_CUR:
-		position = camel_stream_mem->position + offset;
+		position = stream->position + offset;
 		break;
 	case CAMEL_STREAM_END:
-		position = (camel_stream_mem->buffer)->len + offset;
+		position = (stream_mem->buffer)->len + offset;
 		break;
 	default:
+		errno = EINVAL;
 		return -1;
 	}
-		
-	position = MIN (position, (camel_stream_mem->buffer)->len);
-	position = MAX (position, 0);
 
-	camel_stream_mem->position = position;
+	if (stream->bound_end == CAMEL_STREAM_UNBOUND) {
+		position = MIN (position, stream->bound_end);
+	}
+	if (stream->bound_start == CAMEL_STREAM_UNBOUND) {
+		position = MAX (position, 0);
+	} else {
+		position = MAX (position, stream->bound_start);
+	}
+
+	if (position > stream_mem->buffer->len) {
+		int oldlen = stream_mem->buffer->len;
+		g_byte_array_set_size(stream_mem->buffer, position);
+		memset(stream_mem->buffer->data + oldlen, 0, position - oldlen);
+	}
+
+	stream->position = position;
 
 	return position;
 }