ACEXML_FileCharStream Class Reference

#include <FileCharStream.h>

Inheritance diagram for ACEXML_FileCharStream:

Collaboration diagram for ACEXML_FileCharStream:

Public Member Functions
	ACEXML_FileCharStream ()
	Default constructor.
virtual	~ACEXML_FileCharStream ()
	Destructor.
int	open (const ACEXML_Char *name)
	Open a file.
int	use_stream (FILE *open_file, const ACEXML_Char *name)
virtual int	available ()
virtual int	close ()
virtual int	get (ACEXML_Char &ch)
virtual int	read (ACEXML_Char *str, size_t len)
virtual int	determine_encoding ()
virtual int	peek ()
virtual void	rewind ()
virtual const ACEXML_Char *	getEncoding ()
virtual const ACEXML_Char *	getSystemId ()
Public Member Functions inherited from ACEXML_CharStream
virtual	~ACEXML_CharStream ()=0
virtual int	available ()=0
virtual int	close ()=0
virtual int	get (ACEXML_Char &ch)=0
virtual int	read (ACEXML_Char *str, size_t len)=0
virtual int	peek ()=0
virtual void	rewind ()=0
virtual const ACEXML_Char *	getEncoding ()=0
virtual const ACEXML_Char *	getSystemId ()=0

Private Member Functions
int	getchar_i (char &ch)
int	use_stream_i (FILE *open_file, const ACEXML_Char *name)
	internal accept an already opened file.

Private Attributes
ACEXML_Char *	filename_
ACEXML_Char *	encoding_
ACE_OFF_T	size_
FILE *	infile_
bool	close_infile_
ACEXML_Char	peek_

Detailed Description

An implementation of ACEXML_CharStream for reading input from a file.

Constructor & Destructor Documentation

ACEXML_FileCharStream()

ACEXML_FileCharStream::ACEXML_FileCharStream

(

)

Default constructor.

~ACEXML_FileCharStream()

ACEXML_FileCharStream::~ACEXML_FileCharStream ( )

virtual

Destructor.

Member Function Documentation

available()

int ACEXML_FileCharStream::available ( )

virtual

Returns the available ACEXML_Char in the buffer. -1 if the object is not initialized properly.

Implements ACEXML_CharStream.

close()

int ACEXML_FileCharStream::close ( )

virtual

Close this stream and release all resources used by it.

Implements ACEXML_CharStream.

determine_encoding()

int ACEXML_FileCharStream::determine_encoding ( )

virtual

Determine the encoding of the file.

get()

int ACEXML_FileCharStream::get ( ACEXML_Char &  ch )

virtual

Read the next ACEXML_Char. Return -1 if we are not able to return an ACEXML_Char, 0 if succees.

Implements ACEXML_CharStream.

getchar_i()

int ACEXML_FileCharStream::getchar_i ( char &  ch )

private

Read the next character as a normal character. Return -1 if EOF is reached, else return 0.

getEncoding()

const ACEXML_Char * ACEXML_FileCharStream::getEncoding ( )

virtual

Implements ACEXML_CharStream.

getSystemId()

const ACEXML_Char * ACEXML_FileCharStream::getSystemId ( )

virtual

Implements ACEXML_CharStream.

open()

int ACEXML_FileCharStream::open

(

const ACEXML_Char *

name

)

Open a file.

peek()

int ACEXML_FileCharStream::peek ( )

virtual

Peek the next ACEXML_Char in the CharStream. Return the character if success, -1 if EOF is reached.

Implements ACEXML_CharStream.

read()

int ACEXML_FileCharStream::read ( ACEXML_Char *  str, size_t  len  )

virtual

Read the next batch of ACEXML_Char strings

Implements ACEXML_CharStream.

rewind()

void ACEXML_FileCharStream::rewind ( )

virtual

Resets the file pointer to the beginning of the stream.

Implements ACEXML_CharStream.

use_stream()

int ACEXML_FileCharStream::use_stream	(	FILE *	open_file,
		const ACEXML_Char *	name
	)

Accept an already opened file. The stream does not assume ownership of open_file.

use_stream_i()

int ACEXML_FileCharStream::use_stream_i ( FILE *  open_file, const ACEXML_Char *  name  )

private

internal accept an already opened file.

Member Data Documentation

close_infile_

bool ACEXML_FileCharStream::close_infile_

private

encoding_

ACEXML_Char* ACEXML_FileCharStream::encoding_

private

filename_

ACEXML_Char* ACEXML_FileCharStream::filename_

private

infile_

FILE* ACEXML_FileCharStream::infile_

private

peek_

ACEXML_Char ACEXML_FileCharStream::peek_

private

size_

ACE_OFF_T ACEXML_FileCharStream::size_

private

---

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

• FileCharStream.h
• FileCharStream.cpp