UCommon
ost::XMLParser Class Referenceabstract

XML streaming parser. More...

#include <xml.h>

Protected Member Functions

virtual void characters (const caddr_t text, size_t size)
 Virtual to receive character text extracted from the document.
 
virtual void comment (const caddr_t text, size_t size)
 Virtual to receive embedded comments in XML document being parsed.
 
bool end (void) const
 End of document check.
 
virtual void endDocument (void)
 Notify end of document event.
 
virtual void endElement (const caddr_t name)=0
 Notify end of an element in the document.
 
bool parse (const char *cp)
 Parse a stream buffer and return parser document completion flag.
 
bool parse (FILE *file)
 Parse a file buffer and return parser document completion flag.
 
bool partial (const char *address, size_t size)
 Parse a chunk of data and return parser completion flag.
 
virtual void startDocument (void)
 Notify start of document event.
 
virtual void startElement (const caddr_t name, caddr_t *attr)=0
 Notify start of an element in the document.
 
 XMLParser (unsigned size=8192)
 Create xml parser.
 
virtual ~XMLParser ()
 Destroy xml parser.
 

Detailed Description

XML streaming parser.

This class implements 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 implement the physical I/O required to parse actual data. A mixer class using XMLParser and tcpstream would be one example of this. This can also be used to parse xml content in memory buffers easily. This parser is only concerned with well-formedness, and does not perform validation.

Author
David Sugar dyfet.nosp@m.@gnu.nosp@m.telep.nosp@m.hony.nosp@m..org

Definition at line 45 of file xml.h.

Constructor & Destructor Documentation

◆ XMLParser()

ost::XMLParser::XMLParser ( unsigned size = 8192)
protected

Create xml parser.

Parameters
sizeof XML data buffer.

Member Function Documentation

◆ characters()

virtual void ost::XMLParser::characters ( const caddr_t text,
size_t size )
protectedvirtual

Virtual to receive character text extracted from the document.

Parameters
textreceived.
sizeof text received.

◆ comment()

virtual void ost::XMLParser::comment ( const caddr_t text,
size_t size )
protectedvirtual

Virtual to receive embedded comments in XML document being parsed.

Parameters
textreceived.
sizeof text received.

◆ end()

bool ost::XMLParser::end ( void ) const
inlineprotected

End of document check.

Returns
true if end of document.

Definition at line 144 of file xml.h.

◆ endElement()

virtual void ost::XMLParser::endElement ( const caddr_t name)
protectedpure virtual

Notify end of an element in the document.

Parameters
nameof element ending.

◆ parse() [1/2]

bool ost::XMLParser::parse ( const char * cp)
protected

Parse a stream buffer and return parser document completion flag.

This is used to scan a stream buffer for a complete XML document. The stream is scanned until the document is complete or EOF. Multiple XML document instances can be scanned from a continues XML streaming source.

Parameters
streambuffer to parse.
Returns
true if parse complete, false if invalid or EOF.

◆ parse() [2/2]

bool ost::XMLParser::parse ( FILE * file)
protected

Parse a file buffer and return parser document completion flag.

This is used to scan a file buffer for a complete XML document. The file is scanned until the document is complete or EOF. Multiple XML document instances can be scanned from a continues XML streaming source.

Parameters
filebuffer to parse.
Returns
true if parse complete, false if invalid or EOF.

◆ partial()

bool ost::XMLParser::partial ( const char * address,
size_t size )
protected

Parse a chunk of data and return parser completion flag.

This is used to externally drive data into the XML parser. The return status can be used to determine when a document has been fully parsed. This can be called multiple times to push stream data into the parser.

Parameters
addressof data to parse.
sizeof data to parse.

◆ startElement()

virtual void ost::XMLParser::startElement ( const caddr_t name,
caddr_t * attr )
protectedpure virtual

Notify start of an element in the document.

Parameters
nameof element found.
attrlist of attributes extracted.

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