This class impliments a basic XML stream parser that can be used to examine an XML resource thru virtual I/O methods.
More...
#include <xml.h>
|
virtual bool | open (const char *resource) |
| May perform an open operation on behalf of a parsed resource. More...
|
|
virtual void | close (void) |
| May perform a close operation of an i/o source when the parser has completed operation. More...
|
|
virtual Slog::Level | getLogging (void) |
| Get error logging level. More...
|
|
virtual void | comment (const unsigned char *text, size_t len) |
| Virtual to receive embedded comments in an XML document being parsed. More...
|
|
virtual int | read (unsigned char *buffer, size_t len)=0 |
| Read method to aquire data for the parser. More...
|
|
virtual void | characters (const unsigned char *text, size_t len)=0 |
| Virtual to receive character text extracted from the document in the current element. More...
|
|
virtual void | startDocument (void) |
| Identify start of document event. More...
|
|
virtual void | endDocument (void) |
| Identify end of document event. More...
|
|
virtual void | startElement (const unsigned char *name, const unsigned char **attr)=0 |
| Identify start of an element in the document. More...
|
|
virtual void | endElement (const unsigned char *name)=0 |
| Identify end of an element in the document. More...
|
|
bool | parse (const char *resource=NULL) |
| Parse a resource as a stream thru the virtual read method. More...
|
|
This class impliments a basic XML stream parser that can be used to examine an XML resource thru virtual I/O methods.
This class must be derived into one that can impliment the physical I/O required to parse actual data. A mixer class using XMLStream and URLStream would seem a likely combination for this purpose.
- Author
- David Sugar dyfet.nosp@m.@ost.nosp@m.el.co.nosp@m.m XML Stream Parser (SAX)
- Examples:
- xmlfetch.cpp.
◆ ~XMLStream()
virtual ost::XMLStream::~XMLStream |
( |
| ) |
|
|
protectedvirtual |
◆ characters()
virtual void ost::XMLStream::characters |
( |
const unsigned char * |
text, |
|
|
size_t |
len |
|
) |
| |
|
pure virtual |
Virtual to receive character text extracted from the document in the current element.
- Parameters
-
text | received. |
len | length of text received. |
◆ close()
virtual void ost::XMLStream::close |
( |
void |
| ) |
|
|
virtual |
May perform a close operation of an i/o source when the parser has completed operation.
◆ comment()
virtual void ost::XMLStream::comment |
( |
const unsigned char * |
text, |
|
|
size_t |
len |
|
) |
| |
|
virtual |
Virtual to receive embedded comments in an XML document being parsed.
- Parameters
-
text | text comment extracted. |
len | length of comment. |
◆ endDocument()
virtual void ost::XMLStream::endDocument |
( |
void |
| ) |
|
|
virtual |
Identify end of document event.
◆ endElement()
virtual void ost::XMLStream::endElement |
( |
const unsigned char * |
name | ) |
|
|
pure virtual |
Identify end of an element in the document.
- Parameters
-
◆ getLogging()
virtual Slog::Level ost::XMLStream::getLogging |
( |
void |
| ) |
|
|
virtual |
Get error logging level.
- Returns
- error logging level.
◆ open()
virtual bool ost::XMLStream::open |
( |
const char * |
resource | ) |
|
|
virtual |
May perform an open operation on behalf of a parsed resource.
In some cases, the parser may be merged with a class that already has performed some kind of open, and this method can then be ignored.
- Returns
- true if open is successful.
- Parameters
-
resource | passed to Parse methods. |
◆ parse()
bool ost::XMLStream::parse |
( |
const char * |
resource = NULL | ) |
|
Parse a resource as a stream thru the virtual read method.
- Returns
- true if well formed document has been fully parsed.
- Parameters
-
resource | optional name of resource. |
◆ read()
virtual int ost::XMLStream::read |
( |
unsigned char * |
buffer, |
|
|
size_t |
len |
|
) |
| |
|
pure virtual |
Read method to aquire data for the parser.
- Returns
- number of bytes actually read.
- Parameters
-
buffer | to read data into. |
len | number of bytes to read. |
◆ startDocument()
virtual void ost::XMLStream::startDocument |
( |
void |
| ) |
|
|
virtual |
Identify start of document event.
◆ startElement()
virtual void ost::XMLStream::startElement |
( |
const unsigned char * |
name, |
|
|
const unsigned char ** |
attr |
|
) |
| |
|
pure virtual |
Identify start of an element in the document.
- Parameters
-
name | of element found. |
attr | list of attributes extracted. |
The documentation for this class was generated from the following file: