Remove camel_stream_reset().
authorMatthew Barnes <mbarnes@redhat.com>
Tue, 5 Jul 2011 14:50:11 +0000 (10:50 -0400)
committerMatthew Barnes <mbarnes@redhat.com>
Tue, 5 Jul 2011 14:51:53 +0000 (10:51 -0400)
All use cases accounted for; they're all seekable streams, so use
g_seekable_seek() instead if you need to reset the cursor position.

Obviously an API break.  The libcamel soname has already been bumped for
3.1.4 so we'll leave it be.

camel/camel-http-stream.c
camel/camel-stream-filter.c
camel/camel-stream-null.c
camel/camel-stream.c
camel/camel-stream.h
camel/providers/imapx/camel-imapx-stream.c
camel/providers/nntp/camel-nntp-stream.c
camel/providers/pop3/camel-pop3-stream.c
docs/reference/camel/camel-sections.txt
docs/reference/camel/tmpl/camel-stream.sgml

index 8736087..e866d4d 100644 (file)
@@ -527,18 +527,6 @@ http_stream_close (CamelStream *stream,
        return 0;
 }
 
-static gint
-http_stream_reset (CamelStream *stream,
-                   GError **error)
-{
-       CamelHttpStream *http = CAMEL_HTTP_STREAM (stream);
-
-       if (http->raw)
-               http_disconnect (http);
-
-       return 0;
-}
-
 static void
 camel_http_stream_class_init (CamelHttpStreamClass *class)
 {
@@ -554,7 +542,6 @@ camel_http_stream_class_init (CamelHttpStreamClass *class)
        stream_class->write = http_stream_write;
        stream_class->flush = http_stream_flush;
        stream_class->close = http_stream_close;
-       stream_class->reset = http_stream_reset;
 }
 
 static void
index a647b5a..1f44cfb 100644 (file)
@@ -288,28 +288,6 @@ stream_filter_eos (CamelStream *stream)
        return camel_stream_eos (priv->source);
 }
 
-static gint
-stream_filter_reset (CamelStream *stream,
-                     GError **error)
-{
-       CamelStreamFilterPrivate *priv;
-       struct _filter *f;
-
-       priv = CAMEL_STREAM_FILTER (stream)->priv;
-
-       priv->filteredlen = 0;
-       priv->flushed = FALSE;
-
-       /* and reset filters */
-       f = priv->filters;
-       while (f) {
-               camel_mime_filter_reset (f->filter);
-               f = f->next;
-       }
-
-       return camel_stream_reset (priv->source, error);
-}
-
 static void
 camel_stream_filter_class_init (CamelStreamFilterClass *class)
 {
@@ -327,7 +305,6 @@ camel_stream_filter_class_init (CamelStreamFilterClass *class)
        stream_class->flush = stream_filter_flush;
        stream_class->close = stream_filter_close;
        stream_class->eos = stream_filter_eos;
-       stream_class->reset = stream_filter_reset;
 }
 
 static void
index 6e208a6..48bf012 100644 (file)
@@ -48,15 +48,6 @@ stream_null_eos (CamelStream *stream)
        return TRUE;
 }
 
-static gint
-stream_null_reset (CamelStream *stream,
-                   GError **error)
-{
-       CAMEL_STREAM_NULL (stream)->written = 0;
-
-       return 0;
-}
-
 static void
 camel_stream_null_class_init (CamelStreamNullClass *class)
 {
@@ -65,7 +56,6 @@ camel_stream_null_class_init (CamelStreamNullClass *class)
        stream_class = CAMEL_STREAM_CLASS (class);
        stream_class->write = stream_null_write;
        stream_class->eos = stream_null_eos;
-       stream_class->reset = stream_null_reset;
 }
 
 static void
index 5dc1fe9..6d3c654 100644 (file)
@@ -76,19 +76,6 @@ stream_eos (CamelStream *stream)
        return stream->eos;
 }
 
-static gint
-stream_reset (CamelStream *stream,
-              GError **error)
-{
-       gboolean success = TRUE;
-
-       if (G_IS_SEEKABLE (stream))
-               success = g_seekable_seek (
-                       G_SEEKABLE (stream), 0, G_SEEK_SET, NULL, error);
-
-       return success ? 0 : -1;
-}
-
 static void
 camel_stream_class_init (CamelStreamClass *class)
 {
@@ -97,7 +84,6 @@ camel_stream_class_init (CamelStreamClass *class)
        class->close = stream_close;
        class->flush = stream_flush;
        class->eos = stream_eos;
-       class->reset = stream_reset;
 }
 
 static void
@@ -255,35 +241,6 @@ camel_stream_eos (CamelStream *stream)
        return class->eos (stream);
 }
 
-/**
- * camel_stream_reset:
- * @stream: a #CamelStream object
- * @error: return location for a #GError, or %NULL
- *
- * Resets the 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.
- *
- * Returns: %0 on success or %-1 on error along with setting @error.
- **/
-gint
-camel_stream_reset (CamelStream *stream,
-                    GError **error)
-{
-       CamelStreamClass *class;
-       gint retval;
-
-       g_return_val_if_fail (CAMEL_IS_STREAM (stream), -1);
-
-       class = CAMEL_STREAM_GET_CLASS (stream);
-       g_return_val_if_fail (class->reset != NULL, -1);
-
-       retval = class->reset (stream, error);
-       CAMEL_CHECK_GERROR (stream, reset, retval == 0, error);
-
-       return retval;
-}
-
 /***************** Utility functions ********************/
 
 /**
index 6b88919..9b2f67b 100644 (file)
@@ -83,8 +83,6 @@ struct _CamelStreamClass {
                                                 GCancellable *cancellable,
                                                 GError **error);
        gboolean        (*eos)                  (CamelStream *stream);
-       gint            (*reset)                (CamelStream *stream,
-                                                GError **error);
 };
 
 GType          camel_stream_get_type           (void);
@@ -105,8 +103,6 @@ gint                camel_stream_close              (CamelStream *stream,
                                                 GCancellable *cancellable,
                                                 GError **error);
 gboolean       camel_stream_eos                (CamelStream *stream);
-gint           camel_stream_reset              (CamelStream *stream,
-                                                GError **error);
 
 /* utility macros and funcs */
 gssize         camel_stream_write_string       (CamelStream *stream,
index 84281ad..43dd31d 100644 (file)
@@ -179,14 +179,6 @@ imapx_stream_eos (CamelStream *stream)
        return is->literal == 0;
 }
 
-static gint
-imapx_stream_reset (CamelStream *stream,
-                    GError **error)
-{
-       /* nop?  reset literal mode? */
-       return 0;
-}
-
 static void
 camel_imapx_stream_class_init (CamelIMAPXStreamClass *class)
 {
@@ -203,7 +195,6 @@ camel_imapx_stream_class_init (CamelIMAPXStreamClass *class)
        stream_class->close = imapx_stream_close;
        stream_class->flush = imapx_stream_flush;
        stream_class->eos = imapx_stream_eos;
-       stream_class->reset = imapx_stream_reset;
 }
 
 static void
index 91d7bd5..8e0731f 100644 (file)
@@ -218,14 +218,6 @@ nntp_stream_eos (CamelStream *stream)
        return is->mode != CAMEL_NNTP_STREAM_DATA;
 }
 
-static gint
-nntp_stream_reset (CamelStream *stream,
-                   GError **error)
-{
-       /* nop?  reset literal mode? */
-       return 0;
-}
-
 static void
 camel_nntp_stream_class_init (CamelNNTPStreamClass *class)
 {
@@ -242,7 +234,6 @@ camel_nntp_stream_class_init (CamelNNTPStreamClass *class)
        stream_class->close = nntp_stream_close;
        stream_class->flush = nntp_stream_flush;
        stream_class->eos = nntp_stream_eos;
-       stream_class->reset = nntp_stream_reset;
 }
 
 static void
index a68b26c..f785a08 100644 (file)
@@ -217,14 +217,6 @@ stream_eos (CamelStream *stream)
        return is->mode != CAMEL_POP3_STREAM_DATA;
 }
 
-static gint
-stream_reset (CamelStream *stream,
-              GError **error)
-{
-       /* nop?  reset literal mode? */
-       return 0;
-}
-
 static void
 camel_pop3_stream_class_init (CamelPOP3StreamClass *class)
 {
@@ -241,7 +233,6 @@ camel_pop3_stream_class_init (CamelPOP3StreamClass *class)
        stream_class->close = stream_close;
        stream_class->flush = stream_flush;
        stream_class->eos = stream_eos;
-       stream_class->reset = stream_reset;
 }
 
 static void
index 7c429b3..85d001d 100644 (file)
@@ -2117,7 +2117,6 @@ camel_stream_write
 camel_stream_flush
 camel_stream_close
 camel_stream_eos
-camel_stream_reset
 camel_stream_write_string
 camel_stream_printf
 camel_stream_vprintf
index e7dea6b..e40d845 100644 (file)
@@ -83,16 +83,6 @@ CamelStream
 @Returns: 
 
 
-<!-- ##### FUNCTION camel_stream_reset ##### -->
-<para>
-
-</para>
-
-@stream: 
-@error: 
-@Returns: 
-
-
 <!-- ##### FUNCTION camel_stream_write_string ##### -->
 <para>