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, 64 insertions, 33 deletions

diff --git a/camel/camel-mime-part.c b/camel/camel-mime-part.c
index 9d4b98a07e..3fd3ddfb89 100644
--- a/camel/camel-mime-part.c
+++ b/camel/camel-mime-part.c
@@ -30,11 +30,11 @@
 #include "gmime-content-field.h"
 #include "string-utils.h"
 #include "gmime-utils.h"
-#include "camel-simple-data-wrapper.h"
 #include "hash-table-utils.h"
 #include "camel-mime-part-utils.h"
 #include <ctype.h>
 #include "camel-mime-parser.h"
+#include "camel-stream-mem.h"
 
 #define d(x)
 
@@ -61,12 +61,12 @@ static CamelMediumClass *parent_class=NULL;
 #define CMD_CLASS(so) CAMEL_MEDIUM_CLASS (GTK_OBJECT(so)->klass)
 
 /* from GtkObject */
-static void            my_finalize (GtkObject *object);
+static void            finalize (GtkObject *object);
 
 /* from CamelDataWrapper */
-static void            my_write_to_stream              (CamelDataWrapper *data_wrapper, 
+static int             write_to_stream                 (CamelDataWrapper *data_wrapper, 
 							CamelStream *stream);
-static void	       construct_from_stream	       (CamelDataWrapper *dw, CamelStream *s);
+static int	       construct_from_stream	       (CamelDataWrapper *dw, CamelStream *s);
 
 /* from CamelMedia */ 
 static void            add_header                      (CamelMedium *medium, const char *header_name, const void *header_value);
@@ -74,10 +74,10 @@ static void            set_header                      (CamelMedium *medium, con
 static void            remove_header                   (CamelMedium *medium, const char *header_name);
 static const void     *get_header                      (CamelMedium *medium, const char *header_name);
 
-static void            my_set_content_object           (CamelMedium *medium, CamelDataWrapper *content);
+static void            set_content_object              (CamelMedium *medium, CamelDataWrapper *content);
 
 /* from camel mime parser */
-static void            construct_from_parser           (CamelMimePart *, CamelMimeParser *);
+static int             construct_from_parser           (CamelMimePart *, CamelMimeParser *);
 
 /* forward references */
 static void set_disposition (CamelMimePart *mime_part, const gchar *disposition);
@@ -87,7 +87,7 @@ static void set_disposition (CamelMimePart *mime_part, const gchar *disposition)
 /* recognize and associate them with a unique enum  */
 /* identifier (see CamelHeaderType above)           */
 static void
-my_init_header_name_table()
+init_header_name_table()
 {
 	header_name_table = g_hash_table_new (g_strcase_hash, g_strcase_equal);
 	g_hash_table_insert (header_name_table, "Content-Description", (gpointer)HEADER_DESCRIPTION);
@@ -107,7 +107,7 @@ camel_mime_part_class_init (CamelMimePartClass *camel_mime_part_class)
 	GtkObjectClass *gtk_object_class = GTK_OBJECT_CLASS (camel_data_wrapper_class);
 
 	parent_class = gtk_type_class (camel_medium_get_type ());
-	my_init_header_name_table();
+	init_header_name_table();
 
 	camel_mime_part_class->construct_from_parser = construct_from_parser;
 	
@@ -116,12 +116,12 @@ camel_mime_part_class_init (CamelMimePartClass *camel_mime_part_class)
 	camel_medium_class->set_header                = set_header;
 	camel_medium_class->get_header                = get_header;
 	camel_medium_class->remove_header             = remove_header;
-	camel_medium_class->set_content_object        = my_set_content_object;
+	camel_medium_class->set_content_object        = set_content_object;
 
-	camel_data_wrapper_class->write_to_stream     = my_write_to_stream;
+	camel_data_wrapper_class->write_to_stream     = write_to_stream;
 	camel_data_wrapper_class->construct_from_stream= construct_from_stream;
 
-	gtk_object_class->finalize                    = my_finalize;
+	gtk_object_class->finalize                    = finalize;
 }
 
 static void
@@ -170,7 +170,7 @@ camel_mime_part_get_type (void)
 
 
 static void           
-my_finalize (GtkObject *object)
+finalize (GtkObject *object)
 {
 	CamelMimePart *mime_part = CAMEL_MIME_PART (object);
 
@@ -480,7 +480,7 @@ camel_mime_part_get_content_type (CamelMimePart *mime_part)
 
 
 static void
-my_set_content_object (CamelMedium *medium, CamelDataWrapper *content)
+set_content_object (CamelMedium *medium, CamelDataWrapper *content)
 {
 	CamelMimePart *mime_part = CAMEL_MIME_PART (medium);
 	GMimeContentField *object_content_field;
@@ -507,39 +507,48 @@ my_set_content_object (CamelMedium *medium, CamelDataWrapper *content)
 #define WHPT gmime_write_header_pair_to_stream
 
 
-static void
-my_write_to_stream (CamelDataWrapper *data_wrapper, CamelStream *stream)
+static int
+write_to_stream (CamelDataWrapper *data_wrapper, CamelStream *stream)
 {
 	CamelMimePart *mp = CAMEL_MIME_PART (data_wrapper);
 	CamelMedium *medium = CAMEL_MEDIUM (data_wrapper);
 	CamelDataWrapper *content;
+	int total = 0, count;
 
 	d(printf("mime_part::write_to_stream\n"));
 
 	/* FIXME: something needs to be done about this ... */
+	/* FIXME: need to count these bytes too */
 #warning content-languages should be stored as a header
 	gmime_write_header_with_glist_to_stream (stream, "Content-Language", mp->content_languages,", ");
 
 	if (mp->headers) {
 		struct _header_raw *h = mp->headers;
 		while (h) {
-			camel_stream_write_strings (stream, h->name, isspace(h->value[0])?":":": ", h->value, "\n", NULL);
+			if ( (count = camel_stream_write_strings (stream, h->name, isspace(h->value[0])?":":": ", h->value, "\n", NULL) ) == -1 )
+				return -1;
+			total += count;
 			h = h->next;
 		}
 	}
 
-	camel_stream_write_string(stream,"\n");
+	if ( (count = camel_stream_write_string(stream,"\n")) == -1)
+		return -1;
+	total += count;
 
 	content = camel_medium_get_content_object (medium);
 	if (content) {
-		camel_data_wrapper_write_to_stream(content, stream);
+		if ( (count = camel_data_wrapper_write_to_stream(content, stream)) == -1 )
+			return -1;
+		total += count;
 	} else {
 		g_warning("No content for medium, nothing to write");
 	}
+	return total;
 }
 
 /* mime_part */
-static void
+static int
 construct_from_parser(CamelMimePart *dw, CamelMimeParser *mp)
 {
 	struct _header_raw *headers;
@@ -565,28 +574,42 @@ construct_from_parser(CamelMimePart *dw, CamelMimeParser *mp)
 	}
 
 	d(printf("mime_part::construct_from_parser() leaving\n"));
+#warning "Need to work out how to detect a (fatally) bad parse in the parser"
+	return 0;
 }
 
-void
+/**
+ * camel_mime_part_construct_from_parser:
+ * @mime_part: 
+ * @mp: 
+ * 
+ * 
+ * 
+ * Return value: 
+ **/
+int
 camel_mime_part_construct_from_parser(CamelMimePart *mime_part, CamelMimeParser *mp)
 {
-	CMP_CLASS (mime_part)->construct_from_parser (mime_part, mp);
+	return CMP_CLASS (mime_part)->construct_from_parser (mime_part, mp);
 }
 
-static void
+static int
 construct_from_stream(CamelDataWrapper *dw, CamelStream *s)
 {
 	CamelMimeParser *mp;
+	int ret;
 
-	printf("mime_part::construct_from_stream()\n");
+	d(printf("mime_part::construct_from_stream()\n"));
 
 	mp = camel_mime_parser_new();
 	if (camel_mime_parser_init_with_stream(mp, s) == -1) {
 		g_warning("Cannot create parser for stream");
+		ret = -1;
 	} else {
-		camel_mime_part_construct_from_parser((CamelMimePart *)dw, mp);
+		ret = camel_mime_part_construct_from_parser((CamelMimePart *)dw, mp);
 	}
 	gtk_object_unref((GtkObject *)mp);
+	return ret;
 }
 
 
@@ -644,22 +667,30 @@ camel_mime_part_encoding_from_string (const gchar *string)
  * be a text string. When @text is NULL, this routine can be used as
  * a way to remove old text content.
  * 
+ * This can only be used to set US-ASCII text currently.
+ *
+ * And only text/plain.
+ *
+ * Perhaps it should accept a type parameter?
  **/
 void 
 camel_mime_part_set_text (CamelMimePart *camel_mime_part, const gchar *text)
 {
-	CamelSimpleDataWrapper *simple_data_wrapper;
+	CamelDataWrapper *dw;
+	CamelStreamMem *stream;
 	CamelMedium *medium = CAMEL_MEDIUM (camel_mime_part);
 
 	if (medium->content)
 		gtk_object_unref (GTK_OBJECT (medium->content));
+
 	if (text) {
-		simple_data_wrapper = camel_simple_data_wrapper_new ();
-		camel_data_wrapper_set_mime_type (CAMEL_DATA_WRAPPER (simple_data_wrapper), "text/plain");
-		camel_simple_data_wrapper_set_text ( simple_data_wrapper, text);
-		camel_medium_set_content_object ( CAMEL_MEDIUM (camel_mime_part), CAMEL_DATA_WRAPPER (simple_data_wrapper));
-		gtk_object_unref (GTK_OBJECT (simple_data_wrapper));
-	} else medium->content = NULL;
+		dw = camel_data_wrapper_new();
+		camel_data_wrapper_set_mime_type (dw, "text/plain");
+		stream = (CamelStream *)camel_stream_mem_new_with_buffer(text, strlen(text));
+		camel_data_wrapper_construct_from_stream(dw, (CamelStream *)stream);
+		camel_medium_set_content_object ( medium, dw );
+		gtk_object_unref ((GtkObject *)dw);
+	} else {
+		medium->content = NULL;
+	}
 }
-
-