XQuilla/docs/simple-api/classStackFrame.html
2020-02-17 22:24:47 +01:00

514 lines
22 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>XQilla Simple API Documentation</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<a style="float:right;" href="http://sourceforge.net/projects/xqilla"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=152021&amp;type=2" border="0" alt="SourceForge.net Logo" /></a>
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</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 id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classStackFrame-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">StackFrame Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>A class that represents an item in a query call stack.
<a href="classStackFrame.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="StackFrame_8hpp_source.html">StackFrame.hpp</a>&gt;</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:ae3d14b6d23bb7f8ab5e6c78ebb4be18a"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStackFrame.html#ae3d14b6d23bb7f8ab5e6c78ebb4be18a">~StackFrame</a> ()</td></tr>
<tr class="separator:ae3d14b6d23bb7f8ab5e6c78ebb4be18a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a122c8864d02c50e4172e203a3ebe5be3"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classLocationInfo.html">LocationInfo</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStackFrame.html#a122c8864d02c50e4172e203a3ebe5be3">getLocationInfo</a> () const </td></tr>
<tr class="separator:a122c8864d02c50e4172e203a3ebe5be3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a870282cd662a6115a3c9ccf97410342f"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classStackFrame.html">StackFrame</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStackFrame.html#a870282cd662a6115a3c9ccf97410342f">getPreviousFrame</a> () const </td></tr>
<tr class="separator:a870282cd662a6115a3c9ccf97410342f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad9ded19822f5ce8574399ccf470b7b41"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classSequence.html">Sequence</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStackFrame.html#ad9ded19822f5ce8574399ccf470b7b41">query</a> (const XMLCh *query) const </td></tr>
<tr class="separator:ad9ded19822f5ce8574399ccf470b7b41"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad4af1075d79a1f376256d8bd8de5235f"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStackFrame.html#ad4af1075d79a1f376256d8bd8de5235f">query</a> (const XMLCh *query, <a class="el" href="classEventHandler.html">EventHandler</a> *events) const </td></tr>
<tr class="separator:ad4af1075d79a1f376256d8bd8de5235f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae89c3afeccff74d2326ad13be996b5e1"><td class="memItemLeft" align="right" valign="top">virtual const ASTNode *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStackFrame.html#ae89c3afeccff74d2326ad13be996b5e1">getASTNode</a> () const =0</td></tr>
<tr class="separator:ae89c3afeccff74d2326ad13be996b5e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5bd6e4e69cc366cc602c68548df4c269"><td class="memItemLeft" align="right" valign="top">virtual const TupleNode *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStackFrame.html#a5bd6e4e69cc366cc602c68548df4c269">getTupleNode</a> () const =0</td></tr>
<tr class="separator:a5bd6e4e69cc366cc602c68548df4c269"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3b2134e70dd2df043b86434e05a96c61"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStackFrame.html#a3b2134e70dd2df043b86434e05a96c61">getQueryPlan</a> () const =0</td></tr>
<tr class="separator:a3b2134e70dd2df043b86434e05a96c61"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:ab011fbb5ac9f44dfe6f5c77e500a2d7c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStackFrame.html#ab011fbb5ac9f44dfe6f5c77e500a2d7c">StackFrame</a> (const <a class="el" href="classLocationInfo.html">LocationInfo</a> *location, <a class="el" href="classDynamicContext.html">DynamicContext</a> *context)</td></tr>
<tr class="separator:ab011fbb5ac9f44dfe6f5c77e500a2d7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:acdadba111c7943f1855287576dfd4a93"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classLocationInfo.html">LocationInfo</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStackFrame.html#acdadba111c7943f1855287576dfd4a93">location_</a></td></tr>
<tr class="separator:acdadba111c7943f1855287576dfd4a93"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6acd59336ed7c8a05d218d7e27ef1f6f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classDynamicContext.html">DynamicContext</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStackFrame.html#a6acd59336ed7c8a05d218d7e27ef1f6f">context_</a></td></tr>
<tr class="separator:a6acd59336ed7c8a05d218d7e27ef1f6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa3adf6736983e167fc6b2a82c9ed2b5f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classItem.html#a73b92c0cc87378a05bd46328eed7f4ff">Item::Ptr</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStackFrame.html#aa3adf6736983e167fc6b2a82c9ed2b5f">contextItem_</a></td></tr>
<tr class="separator:aa3adf6736983e167fc6b2a82c9ed2b5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6282e12116bf469a8c11aed9117bdbc1"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStackFrame.html#a6282e12116bf469a8c11aed9117bdbc1">contextPosition_</a></td></tr>
<tr class="separator:a6282e12116bf469a8c11aed9117bdbc1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a36dbdf7b2678d0e311c93637c67f42e9"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStackFrame.html#a36dbdf7b2678d0e311c93637c67f42e9">contextSize_</a></td></tr>
<tr class="separator:a36dbdf7b2678d0e311c93637c67f42e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aed7d66589b38e61f45a7d4acf5cb513d"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classVariableStore.html">VariableStore</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStackFrame.html#aed7d66589b38e61f45a7d4acf5cb513d">variables_</a></td></tr>
<tr class="separator:aed7d66589b38e61f45a7d4acf5cb513d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a24c1ad7d5e7a4cfcc918f86399075ebb"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classxercesc_1_1DOMXPathNSResolver.html">xercesc::DOMXPathNSResolver</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStackFrame.html#a24c1ad7d5e7a4cfcc918f86399075ebb">nsResolver_</a></td></tr>
<tr class="separator:a24c1ad7d5e7a4cfcc918f86399075ebb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0dff85c57d4f6c4a1d4c5f46a92e56dd"><td class="memItemLeft" align="right" valign="top">const XMLCh *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStackFrame.html#a0dff85c57d4f6c4a1d4c5f46a92e56dd">defaultElementNS_</a></td></tr>
<tr class="separator:a0dff85c57d4f6c4a1d4c5f46a92e56dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7d982ac901ba9bb947bd11b49de8dbe6"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classStackFrame.html">StackFrame</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStackFrame.html#a7d982ac901ba9bb947bd11b49de8dbe6">prev_</a></td></tr>
<tr class="separator:a7d982ac901ba9bb947bd11b49de8dbe6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A class that represents an item in a query call stack. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ae3d14b6d23bb7f8ab5e6c78ebb4be18a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual StackFrame::~StackFrame </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ab011fbb5ac9f44dfe6f5c77e500a2d7c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">StackFrame::StackFrame </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classLocationInfo.html">LocationInfo</a> *&#160;</td>
<td class="paramname"><em>location</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classDynamicContext.html">DynamicContext</a> *&#160;</td>
<td class="paramname"><em>context</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ae89c3afeccff74d2326ad13be996b5e1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const ASTNode* StackFrame::getASTNode </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a122c8864d02c50e4172e203a3ebe5be3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classLocationInfo.html">LocationInfo</a>* StackFrame::getLocationInfo </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a870282cd662a6115a3c9ccf97410342f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classStackFrame.html">StackFrame</a>* StackFrame::getPreviousFrame </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a3b2134e70dd2df043b86434e05a96c61"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::string StackFrame::getQueryPlan </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a5bd6e4e69cc366cc602c68548df4c269"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const TupleNode* StackFrame::getTupleNode </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ad9ded19822f5ce8574399ccf470b7b41"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classSequence.html">Sequence</a> StackFrame::query </td>
<td>(</td>
<td class="paramtype">const XMLCh *&#160;</td>
<td class="paramname"><em>query</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ad4af1075d79a1f376256d8bd8de5235f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void StackFrame::query </td>
<td>(</td>
<td class="paramtype">const XMLCh *&#160;</td>
<td class="paramname"><em>query</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classEventHandler.html">EventHandler</a> *&#160;</td>
<td class="paramname"><em>events</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a6acd59336ed7c8a05d218d7e27ef1f6f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classDynamicContext.html">DynamicContext</a>* StackFrame::context_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="aa3adf6736983e167fc6b2a82c9ed2b5f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classItem.html#a73b92c0cc87378a05bd46328eed7f4ff">Item::Ptr</a> StackFrame::contextItem_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a6282e12116bf469a8c11aed9117bdbc1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t StackFrame::contextPosition_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a36dbdf7b2678d0e311c93637c67f42e9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t StackFrame::contextSize_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a0dff85c57d4f6c4a1d4c5f46a92e56dd"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const XMLCh* StackFrame::defaultElementNS_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="acdadba111c7943f1855287576dfd4a93"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classLocationInfo.html">LocationInfo</a>* StackFrame::location_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a24c1ad7d5e7a4cfcc918f86399075ebb"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const xercesc:: DOMXPathNSResolver* StackFrame::nsResolver_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a7d982ac901ba9bb947bd11b49de8dbe6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classStackFrame.html">StackFrame</a>* StackFrame::prev_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="aed7d66589b38e61f45a7d4acf5cb513d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classVariableStore.html">VariableStore</a>* StackFrame::variables_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="StackFrame_8hpp_source.html">StackFrame.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>