<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Orcus: sax_parser_handler Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Orcus
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classsax__parser__handler-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">sax_parser_handler Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="sax_8hpp_source.html">sax.hpp</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a4dae48f324f4b4ebcf2b23c7f214a7bf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsax__parser__handler.html#a4dae48f324f4b4ebcf2b23c7f214a7bf">doctype</a> (const <a class="el" href="structorcus_1_1sax_1_1doctype__declaration.html">orcus::sax::doctype_declaration</a> &param)</td></tr>
<tr class="separator:a4dae48f324f4b4ebcf2b23c7f214a7bf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a87c21e8638e50965e36509a9b6f54dad"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsax__parser__handler.html#a87c21e8638e50965e36509a9b6f54dad">start_declaration</a> (const <a class="el" href="classorcus_1_1pstring.html">orcus::pstring</a> &decl)</td></tr>
<tr class="separator:a87c21e8638e50965e36509a9b6f54dad"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa7a8ca8db6a8a5fb0c283d4fd000dd36"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsax__parser__handler.html#aa7a8ca8db6a8a5fb0c283d4fd000dd36">end_declaration</a> (const <a class="el" href="classorcus_1_1pstring.html">orcus::pstring</a> &decl)</td></tr>
<tr class="separator:aa7a8ca8db6a8a5fb0c283d4fd000dd36"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a158de6865ab60f09c2a137c34888aeae"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsax__parser__handler.html#a158de6865ab60f09c2a137c34888aeae">start_element</a> (const <a class="el" href="structorcus_1_1sax_1_1parser__element.html">orcus::sax::parser_element</a> &elem)</td></tr>
<tr class="separator:a158de6865ab60f09c2a137c34888aeae"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab11dd575e55eae68f393e8891862dbc0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsax__parser__handler.html#ab11dd575e55eae68f393e8891862dbc0">end_element</a> (const <a class="el" href="structorcus_1_1sax_1_1parser__element.html">orcus::sax::parser_element</a> &elem)</td></tr>
<tr class="separator:ab11dd575e55eae68f393e8891862dbc0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a785031b7dc7f79b72298414b45678725"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsax__parser__handler.html#a785031b7dc7f79b72298414b45678725">characters</a> (const <a class="el" href="classorcus_1_1pstring.html">orcus::pstring</a> &val, bool transient)</td></tr>
<tr class="separator:a785031b7dc7f79b72298414b45678725"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af2abc57e7579f9eb1df8eff117b2b4b8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsax__parser__handler.html#af2abc57e7579f9eb1df8eff117b2b4b8">attribute</a> (const <a class="el" href="classorcus_1_1pstring.html">orcus::pstring</a> &name, const <a class="el" href="classorcus_1_1pstring.html">orcus::pstring</a> &val)</td></tr>
<tr class="separator:af2abc57e7579f9eb1df8eff117b2b4b8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5c12c8ba4ecdb0df8e27454f826dd4c7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsax__parser__handler.html#a5c12c8ba4ecdb0df8e27454f826dd4c7">attribute</a> (const <a class="el" href="structorcus_1_1sax_1_1parser__attribute.html">orcus::sax::parser_attribute</a> &attr)</td></tr>
<tr class="separator:a5c12c8ba4ecdb0df8e27454f826dd4c7"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Skeleton handler for sax_parser. Feel free to copy this as a starting point for your own handler. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="af2abc57e7579f9eb1df8eff117b2b4b8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af2abc57e7579f9eb1df8eff117b2b4b8">◆ </a></span>attribute() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void sax_parser_handler::attribute </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classorcus_1_1pstring.html">orcus::pstring</a> & </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classorcus_1_1pstring.html">orcus::pstring</a> & </td>
<td class="paramname"><em>val</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called upon parsing of a name-value pair within <? ... ?> tag.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>attribute name. </td></tr>
<tr><td class="paramname">val</td><td>attribute value text. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a5c12c8ba4ecdb0df8e27454f826dd4c7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5c12c8ba4ecdb0df8e27454f826dd4c7">◆ </a></span>attribute() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void sax_parser_handler::attribute </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structorcus_1_1sax_1_1parser__attribute.html">orcus::sax::parser_attribute</a> & </td>
<td class="paramname"><em>attr</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called upon parsing of an attribute of an element. Note that <em>when the attribute's transient flag is set, the attribute value is stored in a temporary buffer due to presence of one or more encoded characters, and must be processed within the scope of the callback</em>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">attr</td><td>struct containing attribute information. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a785031b7dc7f79b72298414b45678725"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a785031b7dc7f79b72298414b45678725">◆ </a></span>characters()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void sax_parser_handler::characters </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classorcus_1_1pstring.html">orcus::pstring</a> & </td>
<td class="paramname"><em>val</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>transient</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called when a segment of a text content is parsed. Each text content is a direct child of an element, which may have multiple child contents when the element also has a child element that are direct sibling to the text contents or the text contents are splitted by a comment.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">val</td><td>value of the text content. </td></tr>
<tr><td class="paramname">transient</td><td>when true, the text content has been converted and is stored in a temporary buffer due to presence of one or more encoded characters, in which case <em>the passed text value needs to be either immediately converted to a non-text value or be interned within the scope of the callback</em>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a4dae48f324f4b4ebcf2b23c7f214a7bf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4dae48f324f4b4ebcf2b23c7f214a7bf">◆ </a></span>doctype()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void sax_parser_handler::doctype </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structorcus_1_1sax_1_1doctype__declaration.html">orcus::sax::doctype_declaration</a> & </td>
<td class="paramname"><em>param</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called when a doctype declaration <!DOCTYPE ... > is encountered.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">param</td><td>struct containing doctype declaration data. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa7a8ca8db6a8a5fb0c283d4fd000dd36"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa7a8ca8db6a8a5fb0c283d4fd000dd36">◆ </a></span>end_declaration()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void sax_parser_handler::end_declaration </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classorcus_1_1pstring.html">orcus::pstring</a> & </td>
<td class="paramname"><em>decl</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called when the closing tag (>) of a <?... ?> is encountered.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">decl</td><td>name of the identifier. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ab11dd575e55eae68f393e8891862dbc0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab11dd575e55eae68f393e8891862dbc0">◆ </a></span>end_element()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void sax_parser_handler::end_element </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structorcus_1_1sax_1_1parser__element.html">orcus::sax::parser_element</a> & </td>
<td class="paramname"><em>elem</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called at the end of each element.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">elem</td><td>information of the element being parsed. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a87c21e8638e50965e36509a9b6f54dad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a87c21e8638e50965e36509a9b6f54dad">◆ </a></span>start_declaration()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void sax_parser_handler::start_declaration </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classorcus_1_1pstring.html">orcus::pstring</a> & </td>
<td class="paramname"><em>decl</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called when <?... is encountered, where the '...' may be an arbitraray dentifier. One common declaration is <?xml which is typically given at the start of an XML stream.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">decl</td><td>name of the identifier. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a158de6865ab60f09c2a137c34888aeae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a158de6865ab60f09c2a137c34888aeae">◆ </a></span>start_element()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void sax_parser_handler::start_element </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structorcus_1_1sax_1_1parser__element.html">orcus::sax::parser_element</a> & </td>
<td class="paramname"><em>elem</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called at the start of each element.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">elem</td><td>information of the element being parsed. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Feb 9 2019 16:54:03 for Orcus by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
distrib
>
Mageia
>
6
>
x86_64
>
media
>
core-updates
>
by-pkgid
>
e902a9e8772640e2ff6e25f239deeee4
>
files
>
269
