<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta name="robots" content="noindex">
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>XMLStream class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body bgcolor="#ffffff">
<!-- Generated by Doxygen 1.2.5 on Thu Oct 4 15:33:03 2001 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center>
<hr><h1>XMLStream Class Reference</h1>This class impliments a basic XML stream parser that can be used to examine an XML resource thru virtual I/O methods. XML Stream Parser (SAX).
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="xml_h-source.html">xml.h</a>></code>
<p>
<a href="class_xmlstream-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>virtual <a class="el" href="config_h.html#a17">bool</a> </td><td valign=bottom><a class="el" href="class_xmlstream.html#a0">Open</a> (const char *resource)</td></tr>
<tr><td> </td><td><font size=-1><em>May perform an open operation on behalf of a parsed resource.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_xmlstream.html#a1">Close</a> (void)</td></tr>
<tr><td> </td><td><font size=-1><em>May perform a close operation of an i/o source when the parser has completed operation.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual <a class="el" href="slog_h.html#a15">slog_level_t</a> </td><td valign=bottom><a class="el" href="class_xmlstream.html#a2">getLogging</a> (void)</td></tr>
<tr><td> </td><td><font size=-1><em>Get error logging level.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_xmlstream.html#a3">comment</a> (const unsigned char *text)</td></tr>
<tr><td> </td><td><font size=-1><em>Virtual to receive embedded comments in an XML document being parsed.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual int </td><td valign=bottom><a class="el" href="class_xmlstream.html#a4">Read</a> (unsigned char *buffer, int len)=0</td></tr>
<tr><td> </td><td><font size=-1><em>Read method to aquire data for the parser.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_xmlstream.html#a5">characters</a> (const unsigned char *text, unsigned len)=0</td></tr>
<tr><td> </td><td><font size=-1><em>Virtual to receive character text extracted from the document in the current element.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_xmlstream.html#a6">startDocument</a> (void)</td></tr>
<tr><td> </td><td><font size=-1><em>Identify start of document event.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_xmlstream.html#a7">endDocument</a> (void)</td></tr>
<tr><td> </td><td><font size=-1><em>Identify end of document event.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_xmlstream.html#a8">startElement</a> (const unsigned char *name, const unsigned char **attr)=0</td></tr>
<tr><td> </td><td><font size=-1><em>Identify start of an element in the document.</em> <a href="#a8">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_xmlstream.html#a9">endElement</a> (const unsigned char *name)=0</td></tr>
<tr><td> </td><td><font size=-1><em>Identify end of an element in the document.</em> <a href="#a9">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="config_h.html#a17">bool</a> </td><td valign=bottom><a class="el" href="class_xmlstream.html#a10">Parse</a> (const char *resource=NULL)</td></tr>
<tr><td> </td><td><font size=-1><em>Parse a resource as a stream thru the virtual read method.</em> <a href="#a10">More...</a><em></em></font><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This class impliments a basic XML stream parser that can be used to examine an XML resource thru virtual I/O methods. XML Stream Parser (SAX).
<p>
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 <a class="el" href="class_urlstream.html">URLStream</a> would seem a likely combination for this purpose.
<p>
<dl compact><dt>
<b>Author(s): </b><dd>
David Sugar <<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>> </dl>
<p>
<hr><h2>Member Function Documentation</h2>
<a name="a1" doxytag="XMLStream::Close"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void XMLStream::Close (
</b></td>
<td valign="bottom"><b>
void )<code> [inline, virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
May perform a close operation of an i/o source when the parser has completed operation.
<p>
</td>
</tr>
</table>
<a name="a0" doxytag="XMLStream::Open"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
<a class="el" href="config_h.html#a17">bool</a> XMLStream::Open (
</b></td>
<td valign="bottom"><b>
const char * <em>resource</em> )<code> [inline, virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
May perform an open operation on behalf of a parsed resource.
<p>
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.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
true if open is successful. </dl><dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>resource</em>
</td><td>
passed to Parse methods. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a10" doxytag="XMLStream::Parse"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
<a class="el" href="config_h.html#a17">bool</a> XMLStream::Parse (
</b></td>
<td valign="bottom"><b>
const char * <em>resource</em> = NULL )
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Parse a resource as a stream thru the virtual read method.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
true if well formed document has been fully parsed. </dl><dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>optional</em>
</td><td>
name of resource. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a4" doxytag="XMLStream::Read"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
int XMLStream::Read (
</b></td>
<td valign="bottom"><b>
unsigned char * <em>buffer</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
int <em>len</em> )<code> [pure virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Read method to aquire data for the parser.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
number of bytes actually read. </dl><dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>buffer</em>
</td><td>
to read data into. </td></tr>
<tr><td valign=top><em>number</em>
</td><td>
of bytes to read. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a5" doxytag="XMLStream::characters"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void XMLStream::characters (
</b></td>
<td valign="bottom"><b>
const unsigned char * <em>text</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
unsigned <em>len</em> )<code> [pure virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Virtual to receive character text extracted from the document in the current element.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>text</em>
</td><td>
received. </td></tr>
<tr><td valign=top><em>length</em>
</td><td>
of text received. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a3" doxytag="XMLStream::comment"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void XMLStream::comment (
</b></td>
<td valign="bottom"><b>
const unsigned char * <em>text</em> )<code> [inline, virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Virtual to receive embedded comments in an XML document being parsed.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>text</em>
</td><td>
comment extracted. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a7" doxytag="XMLStream::endDocument"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void XMLStream::endDocument (
</b></td>
<td valign="bottom"><b>
void )<code> [inline, virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Identify end of document event.
<p>
</td>
</tr>
</table>
<a name="a9" doxytag="XMLStream::endElement"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void XMLStream::endElement (
</b></td>
<td valign="bottom"><b>
const unsigned char * <em>name</em> )<code> [pure virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Identify end of an element in the document.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>name</em>
</td><td>
of element found. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a2" doxytag="XMLStream::getLogging"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
<a class="el" href="slog_h.html#a15">slog_level_t</a> XMLStream::getLogging (
</b></td>
<td valign="bottom"><b>
void )<code> [inline, virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Get error logging level.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
error logging level. </dl> </td>
</tr>
</table>
<a name="a6" doxytag="XMLStream::startDocument"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void XMLStream::startDocument (
</b></td>
<td valign="bottom"><b>
void )<code> [inline, virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Identify start of document event.
<p>
</td>
</tr>
</table>
<a name="a8" doxytag="XMLStream::startElement"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void XMLStream::startElement (
</b></td>
<td valign="bottom"><b>
const unsigned char * <em>name</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const unsigned char ** <em>attr</em> )<code> [pure virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Identify start of an element in the document.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>name</em>
</td><td>
of element found. </td></tr>
<tr><td valign=top><em>list</em>
</td><td>
of attributes extracted. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="xml_h-source.html">xml.h</a></ul>
<hr><address><small>Generated at Thu Oct 4 15:33:03 2001 for CommonC++ by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.gif" alt="doxygen" align="middle" border=0
width=110 height=53></a>1.2.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
© 1997-2001</small></address>
</body>
</html>
distrib
>
Mandriva
>
8.2
>
i586
>
media
>
contrib
>
by-pkgid
>
68d373e54fb21da3730c08bede406633
>
files
>
460
