aboutsummaryrefslogtreecommitdiffstats
path: root/camel/camel-stream.c
diff options
context:
space:
mode:
authorDan Winship <danw@src.gnome.org>2000-05-09 06:27:59 +0800
committerDan Winship <danw@src.gnome.org>2000-05-09 06:27:59 +0800
commit65ec43cb553420890c8d14b6c76ce2606674d893 (patch)
tree227b1c2aa3be87901a1d971578b79cdde5ab557c /camel/camel-stream.c
parent3050b3ba056b047a8a1c44c32df5c5eb8558ea58 (diff)
downloadgsoc2013-evolution-65ec43cb553420890c8d14b6c76ce2606674d893.tar
gsoc2013-evolution-65ec43cb553420890c8d14b6c76ce2606674d893.tar.gz
gsoc2013-evolution-65ec43cb553420890c8d14b6c76ce2606674d893.tar.bz2
gsoc2013-evolution-65ec43cb553420890c8d14b6c76ce2606674d893.tar.lz
gsoc2013-evolution-65ec43cb553420890c8d14b6c76ce2606674d893.tar.xz
gsoc2013-evolution-65ec43cb553420890c8d14b6c76ce2606674d893.tar.zst
gsoc2013-evolution-65ec43cb553420890c8d14b6c76ce2606674d893.zip
Use CamelException to signal failure. (camel_stream_write_strings):
* camel-stream.c (camel_stream_read, camel_stream_write, camel_stream_flush, camel_stream_reset, camel_stream_printf, camel_stream_write_to_stream): Use CamelException to signal failure. (camel_stream_write_strings): Remove. camel_stream_printf is more useful in most of the places that used this. (camel_stream_write_string): Change from macro to function to prevent problems with double-evaluation. * camel-seekable-stream.c (camel_seekable_stream_seek, camel_seekable_stream_set_bounds): Use CamelException. (reset): Update. * camel-seekable-substream.c, camel-stream-buffer.c, camel-stream-filter.c, camel-stream-fs.c, camel-stream-mem.c: Update. * camel-stream-fs.c: Remove the virtual init functions and move the code into the creator functions. Add CamelExceptions to creation functions that could fail. * camel-data-wrapper.c (camel_data_wrapper_write_to_stream): Use CamelException. * camel-mime-message.c, camel-mime-part.c, camel-multipart.c (write_to_stream): Update. * camel-mime-parser.c: add an exception to the mime parser private data and pass that to stream functions as needed. * gmime-content-field.c, md5-utils.c: Update (badly) for stream changes. * camel-exception.h (camel_exception_is_set): convenience macro. * providers/Makefile.am: disable SMTP for now * providers/mbox/camel-mbox-folder.c (mbox_append_message): Pass CamelException to the functions that now need it. Check the exception after calling camel_stream_flush, and fail if it fails. (mbox_get_message_by_uid): More updates. * providers/pop/camel-pop3-folder.c, providers/pop/camel-pop3-store.c, providers/sendmail/camel-sendmail/transport.c: Update. svn path=/trunk/; revision=2924
Diffstat (limited to 'camel/camel-stream.c')
-rw-r--r--camel/camel-stream.c270
1 files changed, 132 insertions, 138 deletions
diff --git a/camel/camel-stream.c b/camel/camel-stream.c
index 082789733d..07578a7848 100644
--- a/camel/camel-stream.c
+++ b/camel/camel-stream.c
@@ -1,16 +1,14 @@
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/* camel-stream.c : abstract class for a stream */
-
-/*
- *
- * Author :
+/*
+ * Author:
* Bertrand Guiheneuf <bertrand@helixcode.com>
*
* Copyright 1999, 2000 Helix Code, Inc. (http://www.helixcode.com)
*
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License as
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation; either version 2 of the
* License, or (at your option) any later version.
*
@@ -24,71 +22,36 @@
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
* USA
*/
+
#include <config.h>
#include "camel-stream.h"
-
-enum {
- DATA_AVAILABLE,
- LAST_SIGNAL
-};
-
-static guint camel_stream_signals[LAST_SIGNAL] = { 0 };
-
static CamelObjectClass *parent_class = NULL;
-
/* Returns the class for a CamelStream */
#define CS_CLASS(so) CAMEL_STREAM_CLASS (GTK_OBJECT(so)->klass)
-static void
-default_camel_flush (CamelStream *stream)
-{
- /* nothing */
-}
-
-static gboolean
-eos (CamelStream *stream)
-{
- return stream->eos;
-}
+static void stream_flush (CamelStream *stream, CamelException *ex);
+static gboolean stream_eos (CamelStream *stream);
static void
camel_stream_class_init (CamelStreamClass *camel_stream_class)
{
- GtkObjectClass *gtk_object_class = GTK_OBJECT_CLASS (camel_stream_class);
-
parent_class = gtk_type_class (camel_object_get_type ());
/* virtual method definition */
- camel_stream_class->read = NULL;
- camel_stream_class->write = NULL;
- camel_stream_class->flush = default_camel_flush;
- camel_stream_class->eos = eos;
-
- /* virtual method overload */
-
- /* signal definition */
- camel_stream_signals[DATA_AVAILABLE] =
- gtk_signal_new ("data_available",
- GTK_RUN_LAST,
- gtk_object_class->type,
- GTK_SIGNAL_OFFSET (CamelStreamClass, data_available),
- gtk_marshal_NONE__NONE,
- GTK_TYPE_NONE, 0);
-
- gtk_object_class_add_signals (gtk_object_class, camel_stream_signals, LAST_SIGNAL);
-
+ camel_stream_class->flush = stream_flush;
+ camel_stream_class->eos = stream_eos;
}
GtkType
camel_stream_get_type (void)
{
static GtkType camel_stream_type = 0;
-
+
if (!camel_stream_type) {
- GtkTypeInfo camel_stream_info =
+ GtkTypeInfo camel_stream_info =
{
"CamelStream",
sizeof (CamelStream),
@@ -99,71 +62,103 @@ camel_stream_get_type (void)
/* reserved_2 */ NULL,
(GtkClassInitFunc) NULL,
};
-
- camel_stream_type = gtk_type_unique (camel_object_get_type (), &camel_stream_info);
+
+ camel_stream_type = gtk_type_unique (camel_object_get_type (),
+ &camel_stream_info);
}
-
+
return camel_stream_type;
}
/**
- * camel_stream_read:
+ * camel_stream_read:
* @stream: a CamelStream.
* @buffer: buffer where bytes pulled from the stream are stored.
* @n: max number of bytes to read.
- *
+ * @ex: a CamelException
+ *
* Read at most @n bytes from the @stream object and stores them
* in the buffer pointed at by @buffer.
- *
- * Return value: number of bytes actually read.
+ *
+ * Return value: number of bytes actually read. If an error occurs,
+ * @ex will contain a description of the error.
**/
-gint
-camel_stream_read (CamelStream *stream, gchar *buffer, gint n)
+int
+camel_stream_read (CamelStream *stream, char *buffer, unsigned int n,
+ CamelException *ex)
{
- return CS_CLASS (stream)->read (stream, buffer, n);
+ g_return_val_if_fail (CAMEL_IS_STREAM (stream), -1);
+ g_return_val_if_fail (n == 0 || buffer, -1);
+
+ return CS_CLASS (stream)->read (stream, buffer, n, ex);
}
/**
- * camel_stream_write:
+ * camel_stream_write:
* @stream: a CamelStream object.
* @buffer: buffer to write.
* @n: number of bytes to write
+ * @ex: a CamelException
*
* Write @n bytes from the buffer pointed at by @buffer into @stream.
*
- * Return value: the number of bytes actually written
- * in the stream.
+ * Return value: the number of bytes actually written to the stream. If
+ * an error occurs, @ex will contain a description of the error.
**/
-gint
-camel_stream_write (CamelStream *stream, const gchar *buffer, gint n)
+int
+camel_stream_write (CamelStream *stream, const char *buffer, unsigned int n,
+ CamelException *ex)
+{
+ g_return_val_if_fail (CAMEL_IS_STREAM (stream), -1);
+ g_return_val_if_fail (n == 0 || buffer, -1);
+
+ return CS_CLASS (stream)->write (stream, buffer, n, ex);
+}
+
+
+static void
+stream_flush (CamelStream *stream, CamelException *ex)
{
- return CS_CLASS (stream)->write (stream, buffer, n);
+ /* nothing */
}
/**
* camel_stream_flush:
* @stream: a CamelStream object
- *
- * Flushes the contents of the stream to its backing store.
+ * @ex: a CamelException
+ *
+ * Flushes the contents of the stream to its backing store. Only meaningful
+ * on writable streams. If an error occurs, @ex will be set.
**/
void
-camel_stream_flush (CamelStream *stream)
+camel_stream_flush (CamelStream *stream, CamelException *ex)
{
- CS_CLASS (stream)->flush (stream);
+ g_return_if_fail (CAMEL_IS_STREAM (stream));
+
+ CS_CLASS (stream)->flush (stream, ex);
+}
+
+
+static gboolean
+stream_eos (CamelStream *stream)
+{
+ return stream->eos;
}
/**
- * camel_stream_eos:
+ * camel_stream_eos:
* @stream: a CamelStream object
- *
+ *
* Test if there are bytes left to read on the @stream object.
- *
+ *
* Return value: %TRUE if all the contents on the stream has been read, or
* %FALSE if information is still available.
**/
gboolean
camel_stream_eos (CamelStream *stream)
{
+ g_return_val_if_fail (CAMEL_IS_STREAM (stream), TRUE);
+
return CS_CLASS (stream)->eos (stream);
}
@@ -171,67 +166,69 @@ camel_stream_eos (CamelStream *stream)
/**
* camel_stream_reset: reset a stream
* @stream: the stream object
- *
- * Reset a stream, that is put it in a state
- * where it can be read from the begining.
- * All streams in camel are not seekable,
- * but they must all be resettable.
- *
+ * @ex: a CamelException
+ *
+ * Reset a stream. That is, put it in a state where it can be read
+ * from the beginning again. Not all streams in Camel are seekable,
+ * but they must all be resettable.
**/
-void
-camel_stream_reset (CamelStream *stream)
-{
- CS_CLASS (stream)->reset (stream);
+void
+camel_stream_reset (CamelStream *stream, CamelException *ex)
+{
+ g_return_if_fail (CAMEL_IS_STREAM (stream));
+
+ CS_CLASS (stream)->reset (stream, ex);
}
/***************** Utility functions ********************/
/**
- * came_stream_write_strings:
- * @stream: a CamelStream object.
- * @...: A %NULL terminated list of strings.
+ * camel_stream_write_string:
+ * @stream: a stream object
+ * @string: a string
+ * @ex: a CamelException
*
- * This is a utility function that writes the list of
- * strings into the @stream object.
+ * Writes the string to the stream.
*
- * Returns number of successfully written bytes.
- */
+ * Return value: the number of characters output.
+ **/
int
-camel_stream_write_strings (CamelStream *stream, ... )
+camel_stream_write_string (CamelStream *stream, const char *string,
+ CamelException *ex)
{
- va_list args;
- const char *string;
- int total = 0;
-
- va_start(args, stream);
- string = va_arg (args, const char *);
-
- while (string) {
- int ret = camel_stream_write_string (stream, string);
- if (ret == -1)
- return -1;
- total += ret;
- string = va_arg (args, char *);
- }
- va_end (args);
- return total;
+ return camel_stream_write (stream, string, strlen (string), ex);
}
-int camel_stream_printf (CamelStream *stream, const char *fmt, ... )
+/**
+ * camel_stream_printf:
+ * @stream: a stream object
+ * @ex: a CamelException
+ * @fmt: a printf-style format string
+ *
+ * This printfs the given data to @stream. If an error occurs, @ex
+ * will be set.
+ *
+ * Return value: the number of characters output.
+ **/
+int
+camel_stream_printf (CamelStream *stream, CamelException *ex,
+ const char *fmt, ... )
{
va_list args;
char *string;
- int ret = 0;
-
- va_start(args, fmt);
- /* sigh, this allocates ... */
- string = g_strdup_vprintf(fmt, args);
- if (string) {
- ret = camel_stream_write_string(stream, string);
- g_free(string);
- }
- va_end(args);
+ int ret;
+ g_return_val_if_fail (CAMEL_IS_STREAM (stream), -1);
+
+ va_start (args, fmt);
+ string = g_strdup_vprintf (fmt, args);
+ va_end (args);
+
+ if (!string)
+ return -1;
+
+ ret = camel_stream_write (stream, string, strlen (string), ex);
+ g_free (string);
return ret;
}
@@ -239,40 +236,37 @@ int camel_stream_printf (CamelStream *stream, const char *fmt, ... )
* camel_stream_write_to_stream:
* @stream: Source CamelStream.
* @output_stream: Destination CamelStream.
- *
+ * @ex: a CamelException.
+ *
* Write all of a stream (until eos) into another stream, in a blocking
* fashion.
*
- * Return Value: Returns -1 on error, or the number of bytes succesfully
+ * Return value: Returns -1 on error, or the number of bytes succesfully
* copied across streams.
**/
int
-camel_stream_write_to_stream (CamelStream *stream,
- CamelStream *output_stream)
+camel_stream_write_to_stream (CamelStream *stream, CamelStream *output_stream,
+ CamelException *ex)
{
- gchar tmp_buf[4096];
+ char tmp_buf[4096];
int total = 0;
- gint nb_read;
- gint nb_written;
-
- /*
- * default implementation that uses the input
- * stream and stream it in a blocking way
- * to an output stream.
- */
- g_assert (output_stream);
- g_assert (stream);
-
- while (!camel_stream_eos (CAMEL_STREAM (stream))) {
- nb_read = camel_stream_read (CAMEL_STREAM (stream), tmp_buf, 4096);
+ int nb_read;
+ int nb_written;
+
+ g_return_val_if_fail (CAMEL_IS_STREAM (stream), -1);
+ g_return_val_if_fail (CAMEL_IS_STREAM (output_stream), -1);
+
+ while (!camel_stream_eos (stream)) {
+ nb_read = camel_stream_read (stream, tmp_buf,
+ sizeof (tmp_buf), ex);
if (nb_read < 0)
return -1;
- else if (nb_read>0) {
+ else if (nb_read > 0) {
nb_written = 0;
-
+
while (nb_written < nb_read) {
- int len = camel_stream_write (output_stream, tmp_buf + nb_written, nb_read - nb_written);
- if (len<0)
+ int len = camel_stream_write (output_stream, tmp_buf + nb_written, nb_read - nb_written, ex);
+ if (len < 0)
return -1;
nb_written += len;
}