/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/* camel-stream.h : class for an abstract stream */

/*
 * 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
 * published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
 * USA
 */


#ifndef CAMEL_STREAM_H
#define CAMEL_STREAM_H 1


#ifdef __cplusplus
extern "C" {
#pragma }
#endif /* __cplusplus }*/

#include <camel/camel-object.h>
#include <stdarg.h>

#define CAMEL_STREAM_TYPE     (camel_stream_get_type ())
#define CAMEL_STREAM(obj)     (GTK_CHECK_CAST((obj), CAMEL_STREAM_TYPE, CamelStream))
#define CAMEL_STREAM_CLASS(k) (GTK_CHECK_CLASS_CAST ((k), CAMEL_STREAM_TYPE, CamelStreamClass))
#define CAMEL_IS_STREAM(o)    (GTK_CHECK_TYPE((o), CAMEL_STREAM_TYPE))

struct _CamelStream
{
	CamelObject parent_object;

	gboolean eos;
};

typedef struct {
	CamelObjectClass parent_class;

	/* Virtual methods */

	int       (*read)       (CamelStream *stream, char *buffer,
				 unsigned int n, CamelException *ex);
	int       (*write)      (CamelStream *stream, const char *buffer,
				 unsigned int n, CamelException *ex);
	void      (*flush)      (CamelStream *stream, CamelException *ex);
	gboolean  (*eos)        (CamelStream *stream);
	void      (*reset)      (CamelStream *stream, CamelException *ex);

} CamelStreamClass;

/* Standard Gtk function */
GtkType camel_stream_get_type (void);

/* public methods */
int        camel_stream_read       (CamelStream *stream, char *buffer,
				    unsigned int n, CamelException *ex);
int        camel_stream_write      (CamelStream *stream, const char *buffer,
				    unsigned int n, CamelException *ex);
void       camel_stream_flush      (CamelStream *stream, CamelException *ex);
gboolean   camel_stream_eos        (CamelStream *stream);
void       camel_stream_reset      (CamelStream *stream, CamelException *ex);

/* utility macros and funcs */
int camel_stream_write_string (CamelStream *stream, const char *string,
			       CamelException *ex);
int camel_stream_printf (CamelStream *stream, CamelException *ex,
			 const char *fmt, ... ) G_GNUC_PRINTF (3, 4);
int camel_stream_vprintf (CamelStream *stream, CamelException *ex,
			  const char *fmt, va_list ap);

/* Write a whole stream to another stream, until eof or error on
 * either stream.
 */
int camel_stream_write_to_stream (CamelStream *stream,
				  CamelStream *output_stream,
				  CamelException *ex);

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* CAMEL_STREAM_H */