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, 55 insertions, 53 deletions

diff --git a/camel/camel-mime-message.c b/camel/camel-mime-message.c
index fb034d36cf..60a518acec 100644
--- a/camel/camel-mime-message.c
+++ b/camel/camel-mime-message.c
@@ -55,20 +55,20 @@ static gchar *reply_to_str;
 static gchar *subject_str;
 static gchar *from_str;
 
-static void _add_recipient (CamelMimeMessage *mime_message, const gchar *recipient_type, const gchar *recipient); 
-static void _remove_recipient (CamelMimeMessage *mime_message, const gchar *recipient_type, const gchar *recipient);
-static const GList *_get_recipients (CamelMimeMessage *mime_message, const gchar *recipient_type);
-static void _set_flag (CamelMimeMessage *mime_message, const gchar *flag, gboolean value);
-static gboolean _get_flag (CamelMimeMessage *mime_message, const gchar *flag);
-static GList *_get_flag_list (CamelMimeMessage *mime_message);
-static void _set_message_number (CamelMimeMessage *mime_message, guint number);
-static guint _get_message_number (CamelMimeMessage *mime_message);
-static void _write_to_stream (CamelDataWrapper *data_wrapper, CamelStream *stream);
-static void _finalize (GtkObject *object);
+static void add_recipient (CamelMimeMessage *mime_message, const gchar *recipient_type, const gchar *recipient); 
+static void remove_recipient (CamelMimeMessage *mime_message, const gchar *recipient_type, const gchar *recipient);
+static const GList *get_recipients (CamelMimeMessage *mime_message, const gchar *recipient_type);
+static void set_flag (CamelMimeMessage *mime_message, const gchar *flag, gboolean value);
+static gboolean get_flag (CamelMimeMessage *mime_message, const gchar *flag);
+static GList *get_flag_list (CamelMimeMessage *mime_message);
+static void set_message_number (CamelMimeMessage *mime_message, guint number);
+static guint get_message_number (CamelMimeMessage *mime_message);
+static int write_to_stream (CamelDataWrapper *data_wrapper, CamelStream *stream);
+static void finalize (GtkObject *object);
 static void add_header (CamelMedium *medium, const char *header_name, const void *header_value);
 static void set_header (CamelMedium *medium, const char *header_name, const void *header_value);
 static void remove_header (CamelMedium *medium, const char *header_name);
-static void construct_from_parser (CamelMimePart *, CamelMimeParser *);
+static int construct_from_parser (CamelMimePart *, CamelMimeParser *);
 
 /* Returns the class for a CamelMimeMessage */
 #define CMM_CLASS(so) CAMEL_MIME_MESSAGE_CLASS (GTK_OBJECT(so)->klass)
@@ -77,7 +77,7 @@ static void construct_from_parser (CamelMimePart *, CamelMimeParser *);
 
 
 static void
-_init_header_name_table()
+init_header_name_table()
 {
 	header_name_table = g_hash_table_new (g_str_hash, g_str_equal);
 	g_hash_table_insert (header_name_table, "From", (gpointer)HEADER_FROM);
@@ -98,7 +98,7 @@ camel_mime_message_class_init (CamelMimeMessageClass *camel_mime_message_class)
 	CamelMediumClass *camel_medium_class = CAMEL_MEDIUM_CLASS (camel_mime_message_class);
 	
 	parent_class = gtk_type_class (camel_mime_part_get_type ());
-	_init_header_name_table();
+	init_header_name_table();
 	
 	received_date_str = "";
 	sent_date_str = "";
@@ -107,17 +107,17 @@ camel_mime_message_class_init (CamelMimeMessageClass *camel_mime_message_class)
 	from_str = "From";
 	
 	/* virtual method definition */
-	camel_mime_message_class->add_recipient = _add_recipient; 
-	camel_mime_message_class->remove_recipient = _remove_recipient;
-	camel_mime_message_class->get_recipients = _get_recipients;
-	camel_mime_message_class->set_flag = _set_flag;
-	camel_mime_message_class->get_flag = _get_flag;
-	camel_mime_message_class->get_flag_list = _get_flag_list;
-	camel_mime_message_class->set_message_number = _set_message_number;
-	camel_mime_message_class->get_message_number = _get_message_number;
+	camel_mime_message_class->add_recipient = add_recipient; 
+	camel_mime_message_class->remove_recipient = remove_recipient;
+	camel_mime_message_class->get_recipients = get_recipients;
+	camel_mime_message_class->set_flag = set_flag;
+	camel_mime_message_class->get_flag = get_flag;
+	camel_mime_message_class->get_flag_list = get_flag_list;
+	camel_mime_message_class->set_message_number = set_message_number;
+	camel_mime_message_class->get_message_number = get_message_number;
 	
 	/* virtual method overload */
-	camel_data_wrapper_class->write_to_stream = _write_to_stream;
+	camel_data_wrapper_class->write_to_stream = write_to_stream;
 
 	camel_medium_class->add_header = add_header;
 	camel_medium_class->set_header = set_header;
@@ -125,7 +125,7 @@ camel_mime_message_class_init (CamelMimeMessageClass *camel_mime_message_class)
 	
 	camel_mime_part_class->construct_from_parser = construct_from_parser;
 
-	gtk_object_class->finalize = _finalize;
+	gtk_object_class->finalize = finalize;
 }
 
 
@@ -178,7 +178,7 @@ camel_mime_message_get_type (void)
 
 
 static void           
-_finalize (GtkObject *object)
+finalize (GtkObject *object)
 {
 	CamelMimeMessage *message = CAMEL_MIME_MESSAGE (object);
 	
@@ -322,7 +322,7 @@ camel_mime_message_get_from (CamelMimeMessage *mime_message)
 /*  ****  */
 
 static void
-_add_recipient (CamelMimeMessage *mime_message, 
+add_recipient (CamelMimeMessage *mime_message, 
 		const gchar *recipient_type, 
 		const gchar *recipient) 
 {
@@ -343,7 +343,7 @@ camel_mime_message_add_recipient (CamelMimeMessage *mime_message,
 
 
 static void
-_remove_recipient (CamelMimeMessage *mime_message, 
+remove_recipient (CamelMimeMessage *mime_message, 
 		   const gchar *recipient_type, 
 		   const gchar *recipient) 
 {
@@ -363,7 +363,7 @@ camel_mime_message_remove_recipient (CamelMimeMessage *mime_message,
 
 
 static const GList *
-_get_recipients (CamelMimeMessage *mime_message, 
+get_recipients (CamelMimeMessage *mime_message, 
 		 const gchar *recipient_type)
 {
 	return camel_recipient_table_get (mime_message->recipients, recipient_type);
@@ -386,7 +386,7 @@ camel_mime_message_get_recipients (CamelMimeMessage *mime_message,
 
 
 static void
-_set_flag (CamelMimeMessage *mime_message, const gchar *flag, gboolean value)
+set_flag (CamelMimeMessage *mime_message, const gchar *flag, gboolean value)
 {
 	gchar *old_flags;
 	gboolean ptr_value;
@@ -413,7 +413,7 @@ camel_mime_message_set_flag (CamelMimeMessage *mime_message, const gchar *flag,
 
 
 static gboolean 
-_get_flag (CamelMimeMessage *mime_message, const gchar *flag)
+get_flag (CamelMimeMessage *mime_message, const gchar *flag)
 {
 	return GPOINTER_TO_INT (g_hash_table_lookup (mime_message->flags, flag));
 }
@@ -429,7 +429,7 @@ camel_mime_message_get_flag (CamelMimeMessage *mime_message, const gchar *flag)
 
 
 static void
-_add_flag_to_list (gpointer key, gpointer value, gpointer user_data)
+add_flag_to_list (gpointer key, gpointer value, gpointer user_data)
 {
 	GList **flag_list = (GList **)user_data;
 	gchar *flag_name = (gchar *)key;
@@ -439,12 +439,12 @@ _add_flag_to_list (gpointer key, gpointer value, gpointer user_data)
 }
 
 static GList *
-_get_flag_list (CamelMimeMessage *mime_message)
+get_flag_list (CamelMimeMessage *mime_message)
 {
 	GList *flag_list = NULL;
 	
 	if (mime_message->flags)
-		g_hash_table_foreach (mime_message->flags, _add_flag_to_list, &flag_list);
+		g_hash_table_foreach (mime_message->flags, add_flag_to_list, &flag_list);
 	return flag_list;
 }
 
@@ -460,13 +460,13 @@ camel_mime_message_get_flag_list (CamelMimeMessage *mime_message)
 
 
 static void 
-_set_message_number (CamelMimeMessage *mime_message, guint number)
+set_message_number (CamelMimeMessage *mime_message, guint number)
 {
 	mime_message->message_number = number;
 }
 
 static guint 
-_get_message_number (CamelMimeMessage *mime_message)
+get_message_number (CamelMimeMessage *mime_message)
 {
 	return mime_message->message_number;
 }
@@ -480,37 +480,39 @@ camel_mime_message_get_message_number (CamelMimeMessage *mime_message)
 }
 
 /* mime_message */
-static void
+static int
 construct_from_parser(CamelMimePart *dw, CamelMimeParser *mp)
 {
 	char *buf;
 	int len;
 	int state;
+	int ret;
 
 	d(printf("constructing mime-message\n"));
 
 	d(printf("mime_message::construct_from_parser()\n"));
 
 	/* let the mime-part construct the guts ... */
-	((CamelMimePartClass *)parent_class)->construct_from_parser(dw, mp);
+	ret = ((CamelMimePartClass *)parent_class)->construct_from_parser(dw, mp);
+
+	if (ret == -1)
+		return -1;
 
 	/* ... then clean up the follow-on state */
 	state = camel_mime_parser_step(mp, &buf, &len);
 	if (!(state == HSCAN_MESSAGE_END || state == HSCAN_EOF)) {
-		g_warning("Bad parser state: Expecing MESSAGE_END or EOF, got: %d", camel_mime_parser_state(mp));
+		g_error("Bad parser state: Expecing MESSAGE_END or EOF, got: %d", camel_mime_parser_state(mp));
 		camel_mime_parser_unstep(mp);
+		return -1;
 	}
 
 	d(printf("mime_message::construct_from_parser() leaving\n"));
+#warning "return a real error code"
+	return 0;
 }
 
-#ifdef WHPT
-#warning : WHPT is already defined !!!!!!
-#endif
-#define WHPT gmime_write_header_pair_to_stream
-
 static void
-_write_one_recipient_to_stream (gchar *recipient_type,
+write_one_recipient_to_stream (gchar *recipient_type,
 				GList *recipient_list,
 				gpointer user_data)
 {
@@ -521,15 +523,15 @@ _write_one_recipient_to_stream (gchar *recipient_type,
 }
 
 static void
-_write_recipients_to_stream (CamelMimeMessage *mime_message, CamelStream *stream)
+write_recipients_to_stream (CamelMimeMessage *mime_message, CamelStream *stream)
 {
 	camel_recipient_foreach_recipient_type (mime_message->recipients, 
-						_write_one_recipient_to_stream, 
+						write_one_recipient_to_stream, 
 						(gpointer)stream);
 }
 
-static void
-_write_to_stream (CamelDataWrapper *data_wrapper, CamelStream *stream)
+static int
+write_to_stream (CamelDataWrapper *data_wrapper, CamelStream *stream)
 {
 	CamelMimeMessage *mm = CAMEL_MIME_MESSAGE (data_wrapper);
 
@@ -552,10 +554,10 @@ _write_to_stream (CamelDataWrapper *data_wrapper, CamelStream *stream)
 #if 1
 #warning need to store receipients lists to headers
 	/* FIXME: remove this snot ... */
-	_write_recipients_to_stream (mm, stream);
+	write_recipients_to_stream (mm, stream);
 #endif
 
-	CAMEL_DATA_WRAPPER_CLASS (parent_class)->write_to_stream (data_wrapper, stream);
+	return CAMEL_DATA_WRAPPER_CLASS (parent_class)->write_to_stream (data_wrapper, stream);
 }
 
 /*******************************/
@@ -563,7 +565,7 @@ _write_to_stream (CamelDataWrapper *data_wrapper, CamelStream *stream)
 
 /* FIXME: This is totally totally broken */
 static void
-_set_recipient_list_from_string (CamelMimeMessage *message, const char *recipient_type, const char *recipients_string)
+set_recipient_list_from_string (CamelMimeMessage *message, const char *recipient_type, const char *recipients_string)
 {
 	GList *recipients_list;
 
@@ -599,19 +601,19 @@ process_header(CamelMedium *medium, const char *header_name, const char *header_
 		break;
 	case HEADER_TO:
 		if (header_value)
-			_set_recipient_list_from_string (message, "To", header_value);
+			set_recipient_list_from_string (message, "To", header_value);
 		else
 			camel_recipient_table_remove_type (message->recipients, "To");
 		break;
 	case HEADER_CC:
 		if (header_value)
-			_set_recipient_list_from_string (message, "Cc", header_value);
+			set_recipient_list_from_string (message, "Cc", header_value);
 		else
 			camel_recipient_table_remove_type (message->recipients, "Cc");
 		break;
 	case HEADER_BCC:
 		if (header_value)
-			_set_recipient_list_from_string (message, "Bcc", header_value);
+			set_recipient_list_from_string (message, "Bcc", header_value);
 		else
 			camel_recipient_table_remove_type (message->recipients, "Bcc");
 		break;