Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

ACEXML_CharStream Class Reference

#include "ACEXML/common/CharStream.h"

Inheritance diagram for ACEXML_CharStream:

Inheritance graph
List of all members.

Public Methods

virtual ~ACEXML_CharStream ()=0
virtual int available (void)=0
virtual int close (void)=0
virtual int get (ACEXML_Char &ch)=0
virtual int read (ACEXML_Char *str, size_t len)=0
virtual int peek (void)=0
virtual const ACEXML_ChargetEncoding (void)=0

Detailed Description

ACEXML_CharStream is an abstract class (interface) which defines the basic opertions a parser could use to retrieve XML charater sequence. The sequence can be read from a file or a character buffer.

Definition at line 31 of file CharStream.h.

Constructor & Destructor Documentation

ACEXML_CharStream::~ACEXML_CharStream   [pure virtual]

Virtual destructor, must have.

Definition at line 5 of file CharStream.cpp.

00006 {
00007 }

Member Function Documentation

virtual int ACEXML_CharStream::available void    [pure virtual]

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

Implemented in ACEXML_FileCharStream.

virtual int ACEXML_CharStream::close void    [pure virtual]

Close this stream and release all resources used by it.

Implemented in ACEXML_FileCharStream.

virtual int ACEXML_CharStream::get ACEXML_Char   ch [pure virtual]

Read the next ACEXML_Char. Return -1 if we are not able to return an ACEXML_Char, 0 if EOS is reached, or 1 if succeed.

Implemented in ACEXML_FileCharStream.

Referenced by ACEXML_Parser::get.

virtual const ACEXML_Char* ACEXML_CharStream::getEncoding void    [pure virtual]

Implemented in ACEXML_FileCharStream.

virtual int ACEXML_CharStream::peek void    [pure virtual]

Peek the next ACEXML_Char in the CharStream. Return the character if succeess, -1 if EOS is reached.

Implemented in ACEXML_FileCharStream.

Referenced by ACEXML_Parser::peek.

virtual int ACEXML_CharStream::read ACEXML_Char   str,
size_t    len
[pure virtual]

Read the next batch of ACEXML_Char strings

Implemented in ACEXML_FileCharStream.

The documentation for this class was generated from the following files:
Generated on Mon Jun 16 13:26:35 2003 for ACEXML by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002