#include <fileStream.h>

Inheritance diagram for FileStream:

Public Types
enum	AccessMode { Read = File::Read, Write = File::Write, ReadWrite = File::ReadWrite, WriteAppend = File::WriteAppend }

enum	{ BUFFER_SIZE = 8 * 1024, BUFFER_INVALID = 0xffffffff }

Public Types inherited from Stream
enum	Status { Ok = 0, IOError, EOS, IllegalCall, Closed, UnknownError }
	Status constantants for the stream. More...

enum	Capability { StreamWrite = BIT(0), StreamRead = BIT(1), StreamPosition = BIT(2) }

Public Member Functions
	FileStream ()

virtual	~FileStream ()

virtual bool	hasCapability (const Capability i_cap) const
	Checks to see if this stream has the capability of a given function. More...

virtual U32	getPosition () const
	Gets the position in the stream. More...

virtual bool	setPosition (const U32 i_newPosition)
	Sets the position of the stream. Returns if the new position is valid or not. More...

virtual U32	getStreamSize ()
	Gets the size of the stream. More...

virtual bool	open (const char *i_pFilename, AccessMode i_openMode)

virtual void	close ()

bool	Flush ()

Public Member Functions inherited from Stream
	Stream ()

virtual	~Stream ()

Stream::Status	getStatus () const
	Gets the status of the stream. More...

void	readLine (U8 *buffer, U32 bufferSize)

void	writeLine (U8 *buffer)
	writes a line to the stream More...

const char *	readSTString (bool casesens=false)

virtual void	readString (char stringBuf[256])
	Reads a string of maximum 255 characters long. More...

void	readLongString (U32 maxStringLen, char *stringBuf)

void	writeLongString (U32 maxStringLen, const char *string)

bool	Put (char character)

virtual void	writeString (const char *stringBuf, S32 maxLen=255)
	Writes a string to the stream. More...

bool	writeFormattedBuffer (const char *format,...)

bool	writeStringBuffer (const char *buffer)
	Writes a NULL terminated string buffer. More...

bool	write (const ColorI &)
	Write an integral color to the stream. More...

bool	write (const ColorF &)
	Write a floating point color to the stream. More...

bool	read (ColorI *)
	Read an integral color from the stream. More...

bool	read (ColorF *)
	Read a floating point color from the stream. More...

bool	read (const U32 in_numBytes, void *out_pBuffer)

bool	write (const U32 in_numBytes, const void *in_pBuffer)

bool	read (bool *out_pRead)

bool	write (const bool &in_rWrite)

bool	copyFrom (Stream *other)
	Copy the contents of another stream into this one. More...

void	writeTabs (U32 count)
	Write a number of tabs to this stream. More...

Protected Member Functions
	FileStream (const FileStream &i_fileStrm)

FileStream &	operator= (const FileStream &i_fileStrm)

virtual bool	_read (const U32 i_numBytes, void *o_pBuffer)

virtual bool	_write (const U32 i_numBytes, const void *i_pBuffer)

void	init ()

bool	fillBuffer (const U32 i_startPosition)

void	clearBuffer ()

void	setStatus ()

Protected Member Functions inherited from Stream
void	setStatus (const Status in_newStatus)

Static Protected Member Functions
static void	calcBlockHead (const U32 i_position, U32 *o_blockHead)

static void	calcBlockBounds (const U32 i_position, U32 o_blockHead, U32 o_blockTail)

Protected Attributes
File	mFile

U32	mStreamCaps

U8	mBuffer [BUFFER_SIZE]

U32	mBuffHead

U32	mBuffPos

U32	mBuffTail

bool	mDirty

bool	mEOF

Additional Inherited Members
Static Public Member Functions inherited from Stream
static const char *	getStatusString (const Status in_status)
	Gets a printable string form of the status. More...

Member Enumeration Documentation

anonymous enum

Enumerator
BUFFER_SIZE
BUFFER_INVALID

enum AccessMode

Enumerator
Read
Write
ReadWrite
WriteAppend

Constructor & Destructor Documentation

FileStream ( const FileStream & i_fileStrm )

protected

FileStream ( )

~FileStream ( )

virtual

Member Function Documentation

bool _read	(	const U32	i_numBytes,
		void *	o_pBuffer
	)

protectedvirtual

Implements Stream.

bool _write	(	const U32	i_numBytes,
		const void *	i_pBuffer
	)

protectedvirtual

Implements Stream.

void calcBlockBounds	(	const U32	i_position,
		U32 *	o_blockHead,
		U32 *	o_blockTail
	)

staticprotected

void calcBlockHead	(	const U32	i_position,
		U32 *	o_blockHead
	)

staticprotected

void clearBuffer ( )

protected

void close ( )

virtual

Reimplemented in ZipTempStream.

bool fillBuffer ( const U32 i_startPosition )

protected

bool Flush ( )

U32 getPosition ( ) const

virtual

Gets the position in the stream.

Implements Stream.

U32 getStreamSize ( )

virtual

Gets the size of the stream.

Implements Stream.

bool hasCapability ( const Capability ) const

virtual

Checks to see if this stream has the capability of a given function.

Implements Stream.

void init ( )

protected

bool open	(	const char *	i_pFilename,
		AccessMode	i_openMode
	)

virtual

Reimplemented in ZipTempStream.

FileStream& operator= ( const FileStream & i_fileStrm )

protected

bool setPosition ( const U32 in_newPosition )

virtual

Sets the position of the stream. Returns if the new position is valid or not.

Implements Stream.

Reimplemented in ZipTempStream.

void setStatus ( )

protected

Member Data Documentation

U8 mBuffer[BUFFER_SIZE]

protected

U32 mBuffHead

protected

U32 mBuffPos

protected

U32 mBuffTail

protected

bool mDirty

protected

bool mEOF

protected

File mFile

protected

U32 mStreamCaps

protected

The documentation for this class was generated from the following files:

io/fileStream.h
io/fileStream.cc

Public Types

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation