/usr/share/doc/libucommon-dev/a00183.html is in libucommon-doc 3.2.0-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>UCommon: ucc::XMLParser Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="a00214.html">ucc</a>::<a class="el" href="a00183.html">XMLParser</a>
</div>
</div>
<div class="contents">
<h1>ucc::XMLParser Class Reference</h1><!-- doxytag: class="ucc::XMLParser" -->
<p>XML streaming parser.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00213_source.html">xml.h</a>></code></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00183.html#a52f2e5a9b0a82d3e39e19fd6382f9c5e">characters</a> (caddr_t text, size_t size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Virtual to receive character text extracted from the document. <a href="#a52f2e5a9b0a82d3e39e19fd6382f9c5e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00183.html#a867d08a0db560d9ae0e48776e3efb825">comment</a> (caddr_t text, size_t size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Virtual to receive embedded comments in XML document being parsed. <a href="#a867d08a0db560d9ae0e48776e3efb825"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a85e049df979439f6c3e17c2a4d319379"></a><!-- doxytag: member="ucc::XMLParser::endDocument" ref="a85e049df979439f6c3e17c2a4d319379" args="(void)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00183.html#a85e049df979439f6c3e17c2a4d319379">endDocument</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Notify end of document event. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00183.html#add90fe9f5b1591c6465eeed9c583a2fd">endElement</a> (caddr_t name)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Notify end of an element in the document. <a href="#add90fe9f5b1591c6465eeed9c583a2fd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00183.html#aff05afa8c405bc3dfa87d097d799f4d4">parse</a> (const char *address, size_t size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parse a chunk of data and return parser completion flag. <a href="#aff05afa8c405bc3dfa87d097d799f4d4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad40214af61900cb45d7265389d2d1475"></a><!-- doxytag: member="ucc::XMLParser::startDocument" ref="ad40214af61900cb45d7265389d2d1475" args="(void)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00183.html#ad40214af61900cb45d7265389d2d1475">startDocument</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Notify start of document event. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00183.html#a030cdef0fb7a372a48911c14ed91e21d">startElement</a> (caddr_t name, caddr_t *attr)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Notify start of an element in the document. <a href="#a030cdef0fb7a372a48911c14ed91e21d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00183.html#a9530a551b046196429a7bd394568eebf">XMLParser</a> (unsigned size=8192)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create xml parser. <a href="#a9530a551b046196429a7bd394568eebf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3a11330be6d74ca69bc3719692ccad53"></a><!-- doxytag: member="ucc::XMLParser::~XMLParser" ref="a3a11330be6d74ca69bc3719692ccad53" args="()" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="a00183.html#a3a11330be6d74ca69bc3719692ccad53">~XMLParser</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy xml parser. <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>XML streaming parser. </p>
<p>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 <a class="el" href="a00183.html" title="XML streaming parser.">XMLParser</a> 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.</p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>> </dd></dl>
<p>Definition at line <a class="el" href="a00213_source.html#l00043">43</a> of file <a class="el" href="a00213_source.html">xml.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a9530a551b046196429a7bd394568eebf"></a><!-- doxytag: member="ucc::XMLParser::XMLParser" ref="a9530a551b046196429a7bd394568eebf" args="(unsigned size=8192)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::XMLParser::XMLParser </td>
<td>(</td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>size</em> = <code>8192</code></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create xml parser. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of XML data buffer. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a52f2e5a9b0a82d3e39e19fd6382f9c5e"></a><!-- doxytag: member="ucc::XMLParser::characters" ref="a52f2e5a9b0a82d3e39e19fd6382f9c5e" args="(caddr_t text, size_t size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void ucc::XMLParser::characters </td>
<td>(</td>
<td class="paramtype">caddr_t </td>
<td class="paramname"> <em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>size</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Virtual to receive character text extracted from the document. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>text</em> </td><td>received. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of text received. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a867d08a0db560d9ae0e48776e3efb825"></a><!-- doxytag: member="ucc::XMLParser::comment" ref="a867d08a0db560d9ae0e48776e3efb825" args="(caddr_t text, size_t size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void ucc::XMLParser::comment </td>
<td>(</td>
<td class="paramtype">caddr_t </td>
<td class="paramname"> <em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>size</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Virtual to receive embedded comments in XML document being parsed. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>text</em> </td><td>received. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of text received. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="add90fe9f5b1591c6465eeed9c583a2fd"></a><!-- doxytag: member="ucc::XMLParser::endElement" ref="add90fe9f5b1591c6465eeed9c583a2fd" args="(caddr_t name)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void ucc::XMLParser::endElement </td>
<td>(</td>
<td class="paramtype">caddr_t </td>
<td class="paramname"> <em>name</em></td>
<td> ) </td>
<td><code> [protected, pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Notify end of an element in the document. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>of element ending. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aff05afa8c405bc3dfa87d097d799f4d4"></a><!-- doxytag: member="ucc::XMLParser::parse" ref="aff05afa8c405bc3dfa87d097d799f4d4" args="(const char *address, size_t size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ucc::XMLParser::parse </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>address</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>size</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Parse a chunk of data and return parser completion flag. </p>
<p>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. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>address</em> </td><td>of data to parse. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of data to parse. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a030cdef0fb7a372a48911c14ed91e21d"></a><!-- doxytag: member="ucc::XMLParser::startElement" ref="a030cdef0fb7a372a48911c14ed91e21d" args="(caddr_t name, caddr_t *attr)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void ucc::XMLParser::startElement </td>
<td>(</td>
<td class="paramtype">caddr_t </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">caddr_t * </td>
<td class="paramname"> <em>attr</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected, pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Notify start of an element in the document. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>of element found. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>attr</em> </td><td>list of attributes extracted. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00213_source.html">xml.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Tue Jul 6 08:22:54 2010 for UCommon by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
|