/*  *	HT Editor *	stream.h * *	Copyright (C) 1999-2002 Stefan Weyergraf (stefan@weyergraf.de) * *	This program is free software; you can redistribute it and/or modify *	it under the terms of the GNU General Public License version 2 as *	published by the Free Software Foundation. * *	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., 675 Mass Ave, Cambridge, MA 02139, USA. */#ifndef __STREAM_H__#define __STREAM_H__#include <stdarg.h>#include <stdio.h>#include "data.h"#include "str.h"#include "io/file.h"class String;/** *	A stream. */class Stream {private:	IOAccessMode mAccessMode;protected:		void			checkAccess(IOAccessMode mask);public:					Stream();	virtual				~Stream() {};	/* new */	virtual	FileOfs			copyAllTo(Stream *stream);	virtual	FileOfs			copyTo(Stream *stream, FileOfs count);	virtual	IOAccessMode		getAccessMode() const;	virtual	String &		getDesc(String &result) const;	virtual	uint			read(void *buf, uint size);		void			readx(void *buf, uint size);	virtual	int			setAccessMode(IOAccessMode mode);		void			setAccessModex(IOAccessMode mode);	virtual	uint			write(const void *buf, uint size);		void			writex(const void *buf, uint size);		char *			readstrz();		bool			readStringz(String &s);		void			writestrz(const char *str);		char *			readstrp();		void			writestrp(const char *str);		char *			readstrw();		void			writestrw( const char *str);		char *			readstrl();		void			writestrl(const char *str);		void *			readmeml(uint32 &len);		void			writememl(void *mem, uint32 len);};/** *	A stream, layering a stream. */class StreamLayer: public Stream {protected:	Stream *mStream;	bool mOwnStream;public:					StreamLayer(Stream *stream, bool own_stream);	virtual				~StreamLayer();	/* extends Stream */	virtual IOAccessMode		getAccessMode() const;	virtual String &		getDesc(String &result) const;	virtual uint			read(void *buf, uint size);	virtual int			setAccessMode(IOAccessMode mode);	virtual uint			write(const void *buf, uint size);	/* new */		Stream *		getLayered() const;	virtual	void			setLayered(Stream *newLayered, bool ownNewLayered);};#define	OS_FMT_DEC		0#define	OS_FMT_HEX		1class GetObject;/** *	A stream-layer, storing/loading |Object|s. */class ObjectStream: public StreamLayer {public:				ObjectStream(Stream *stream, bool own_stream);	/* new */	virtual void		getBinary(void *buf, uint size, const char *desc) = 0;	virtual bool		getBool(const char *desc) = 0;	virtual uint64		getInt(uint size, const char *desc) = 0;	virtual Object *	getObjectInternal(const char *name, ObjectID id = OBJID_INVALID) = 0;		GetObject	getObject(const char *name, ObjectID id = OBJID_INVALID);	virtual char *		getString(const char *desc) = 0;	virtual byte *		getLenString(int &length, const char *desc) = 0;	virtual void		putBinary(const void *mem, uint size, const char *desc) = 0;	virtual void		putBool(bool b, const char *desc) = 0;	virtual void		putComment(const char *comment) = 0;	virtual void		putCommentf(const char *comment_format, ...);	virtual void		putInt(uint64 i, uint size, const char *desc, uint int_fmt_hint = OS_FMT_DEC) = 0;	virtual void		putObject(const Object *object, const char *name, ObjectID id = OBJID_INVALID) = 0;	virtual void		putSeparator() = 0;	virtual void		putString(const char *string, const char *desc) = 0;	virtual void		putLenString(const byte *string, int length, const char *desc) = 0;	virtual void		corrupt() = 0;};class GetObject {private:	friend GetObject ObjectStream::getObject(const char *name, ObjectID id);		ObjectStream &mO;	const char *mName;	ObjectID mId;	GetObject(ObjectStream &o, const char *name, ObjectID id = OBJID_INVALID)		: mO(o), mName(name), mId(id)	{	}	GetObject operator=(const GetObject &); // not implementedpublic:	template <typename T> operator T* () const	{		return static_cast<T*>(mO.getObjectInternal(mName, mId));	}};inline GetObject ObjectStream::getObject(const char *name, ObjectID id){	return GetObject(*this, name, id);}#define PUTX_BINARY(st, d, size, dstr)	(st).putBinary(d, size, dstr)#define PUTX_BOOL(st, d, dstr)		(st).putBool(d, dstr)#define PUTX_INT(st, d, size, dstr)	(st).putInt(d, size, dstr)#define PUTX_INTD(st, d, size, dstr)	(st).putInt(d, size, dstr, OS_FMT_DEC)#define PUTX_INTX(st, d, size, dstr)	(st).putInt(d, size, dstr, OS_FMT_HEX)#define PUTX_INT8(st, d, dstr)		(st).putInt(d, 1, dstr)#define PUTX_INT8D(st, d, dstr)		(st).putInt(d, 1, dstr, OS_FMT_DEC)#define PUTX_INT8X(st, d, dstr)		(st).putInt(d, 1, dstr, OS_FMT_HEX)#define PUTX_INT16(st, d, dstr)		(st).putInt(d, 2, dstr)#define PUTX_INT16D(st, d, dstr)	(st).putInt(d, 2, dstr, OS_FMT_DEC)#define PUTX_INT16X(st, d, dstr)	(st).putInt(d, 2, dstr, OS_FMT_HEX)#define PUTX_INT32(st, d, dstr)		(st).putInt(d, 4, dstr)#define PUTX_INT32D(st, d, dstr)	(st).putInt(d, 4, dstr, OS_FMT_DEC)#define PUTX_INT32X(st, d, dstr)	(st).putInt(d, 4, dstr, OS_FMT_HEX)#define PUTX_INT64(st, d, dstr)		(st).putInt(d, 8, dstr)#define PUTX_INT64D(st, d, dstr)	(st).putInt(d, 8, dstr, OS_FMT_DEC)#define PUTX_INT64X(st, d, dstr)	(st).putInt(d, 8, dstr, OS_FMT_HEX)#define PUTX_OBJECT(st, d, dstr)	(st).putObject(d, dstr)#define PUTX_STRING(st, d, dstr)	(st).putString(d, dstr)#define PUTX_LSTRING(st, d, len, dstr)	(st).putLenString(d, len, dstr)#define PUT_BINARY(st, d, size)		PUTX_BINARY(st, d, size, #d)#define PUT_BOOL(st, d)			PUTX_BOOL(st, d, #d)#define PUT_INT(st, d, size)		PUTX_INT(st, d, size, #d)#define PUT_INTD(st, d, size)		PUTX_INTD(st, d, size, #d)#define PUT_INTX(st, d, size)		PUTX_INTX(st, d, size, #d)#define PUT_INT8(st, d)			PUTX_INT8(st, d, #d)#define PUT_INT8D(st, d)		PUTX_INT8D(st, d, #d)#define PUT_INT8X(st, d)		PUTX_INT8X(st, d, #d)#define PUT_INT16(st, d)		PUTX_INT16(st, d, #d)#define PUT_INT16D(st, d)		PUTX_INT16D(st, d, #d)#define PUT_INT16X(st, d)		PUTX_INT16X(st, d, #d)#define PUT_INT32(st, d)		PUTX_INT32(st, d, #d)#define PUT_INT32D(st, d)		PUTX_INT32D(st, d, #d)#define PUT_INT32X(st, d)		PUTX_INT32X(st, d, #d)#define PUT_INT64(st, d)		PUTX_INT64(st, d, #d)#define PUT_INT64D(st, d)		PUTX_INT64D(st, d, #d)#define PUT_INT64X(st, d)		PUTX_INT64X(st, d, #d)#define PUT_OBJECT(st, d)		PUTX_OBJECT(st, d, #d)#define PUT_STRING(st, d)		PUTX_STRING(st, d, #d)#define PUT_LSTRING(st, d, len)		PUTX_LSTRING(st, d, len, #d)#define GETX_BINARY(st, d, size, dstr)	(st).getBinary(d, size, dstr)#define GETX_BOOL(st, dstr)		(st).getBool(dstr)#define GETX_INT(st, size, dstr)	(st).getInt(size, dstr)#define GETX_INTD(st, size, dstr)       GETX_INT(st, size, dstr)#define GETX_INTX(st, size, dstr)       GETX_INT(st, size, dstr)#define GETX_INT8(st, dstr)		(st).getInt(1, dstr)#define GETX_INT8D(st, dstr)		GETX_INT8(st, dstr)#define GETX_INT8X(st, dstr)		GETX_INT8(st, dstr)#define GETX_INT16(st, dstr)		(st).getInt(2, dstr)#define GETX_INT16D(st, dstr)		GETX_INT16(st, dstr)#define GETX_INT16X(st, dstr)		GETX_INT16(st, dstr)#define GETX_INT32(st, dstr)		(st).getInt(4, dstr)#define GETX_INT32D(st, dstr)		GETX_INT32(st, dstr)#define GETX_INT32X(st, dstr)		GETX_INT32(st, dstr)#define GETX_INT64(st, dstr)		(st).getInt(8, dstr)#define GETX_INT64D(st, dstr)		GETX_INT64(st, dstr)#define GETX_INT64X(st, dstr)		GETX_INT64(st, dstr)#define GETX_STRING(st, dstr)		(st).getString(dstr)#define GETX_LSTRING(st, size, dstr)	(st).getLenString(size, dstr)#define GETX_OBJECT(st, dstr)		(st).getObject(dstr)#define GET_BINARY(st, d, size)		GETX_BINARY(st, d, size, #d)#define GET_BOOL(st, d)			d=GETX_BOOL(st, #d)#define GET_INT(st, d, size)		d=GETX_INT(st, size, #d)#define GET_INTD(st, d, size)		d=GET_INT(st, d, size)#define GET_INTX(st, d, size)		d=GET_INT(st, d, size)#define GET_INT8(st, d)			d=GETX_INT8(st, #d)#define GET_INT8D(st, d)		d=GETX_INT8D(st, #d)#define GET_INT8X(st, d)		d=GETX_INT8X(st, #d)#define GET_INT16(st, d)		d=GETX_INT16(st, #d)#define GET_INT16D(st, d)		d=GETX_INT16D(st, #d)#define GET_INT16X(st, d)		d=GETX_INT16X(st, #d)#define GET_INT32(st, d)		d=GETX_INT32(st, #d)#define GET_INT32D(st, d)		d=GETX_INT32D(st, #d)#define GET_INT32X(st, d)		d=GETX_INT32X(st, #d)#define GET_INT64(st, d)		d=GETX_INT64(st, #d)#define GET_INT64D(st, d)		d=GETX_INT64D(st, #d)#define GET_INT64X(st, d)		d=GETX_INT64X(st, #d)#define GET_STRING(st, d)		d=GETX_STRING(st, #d)#define GET_LSTRING(st, d, size)	d=GETX_LSTRING(st, size, #d)#define GET_OBJECT(st, d)		d=GETX_OBJECT(st, #d)/** *	A object-stream-layer. */class ObjectStreamLayer: public ObjectStream {protected:	ObjectStream	*mObjStream;public:				ObjectStreamLayer(ObjectStream *aObjStream, bool own_ostream);	/* extends ObjectStream */	virtual void		getBinary(void *buf, uint size, const char *desc);	virtual bool		getBool(const char *desc);	virtual uint64		getInt(uint size, const char *desc);	virtual Object *	getObjectInternal(const char *name, ObjectID id = OBJID_INVALID);	virtual char *		getString(const char *desc);	virtual byte *		getLenString(int &length, const char *desc);	virtual void		putBinary(const void *mem, uint size, const char *desc);	virtual void		putBool(bool b, const char *desc);	virtual void		putComment(const char *comment);	virtual void		putInt(uint64 i, uint size, const char *desc, uint int_fmt_hint = OS_FMT_DEC);	virtual void		putObject(const Object *object, const char *name, ObjectID id = OBJID_INVALID);	virtual void		putSeparator();	virtual void		putString(const char *string, const char *desc);