XQuilla/docs/simple-api/classScope.html
King_DuckZ 8c48174b5b v2.0.0
2020-02-17 22:12:51 +01:00

389 lines
18 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.5.1 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li id="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul></div>
<h1>Scope&lt; TYPE &gt; Class Template Reference</h1><!-- doxytag: class="Scope" --><!-- doxytag: inherits="xercesc::XMemory" -->used inside <a class="el" href="classVariableStore.html">VariableStore</a> to implement variable scoping
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="Scope_8hpp-source.html">Scope.hpp</a>&gt;</code>
<p>
Inheritance diagram for Scope&lt; TYPE &gt;:<p><center><img src="classScope__inherit__graph.png" border="0" usemap="#Scope_3_01TYPE_01_4__inherit__map" alt="Inheritance graph"></center>
<map name="Scope_3_01TYPE_01_4__inherit__map">
<area href="classxercesc_1_1XMemory.html" shape="rect" coords="5,7,152,31" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classScope-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScope.html#357719c423175c6c49b1cf3144cca7a5">Type</a> { <a class="el" href="classScope.html#357719c423175c6c49b1cf3144cca7a5cceac28db5b3a31f4c1bb1a095faffea">GLOBAL_SCOPE</a>,
<a class="el" href="classScope.html#357719c423175c6c49b1cf3144cca7a5712c77d1f90b905b1a998cd7891ec16b">LOCAL_SCOPE</a>,
<a class="el" href="classScope.html#357719c423175c6c49b1cf3144cca7a5d73acb935b2b7ad06613203b71754f5b">LOGICAL_BLOCK_SCOPE</a>
}</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">enum for classifying type of scope <a href="classScope.html#357719c423175c6c49b1cf3144cca7a5">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef xercesc::RefHash2KeysTableOf&lt;<br>
<a class="el" href="classVarHashEntry.html">VarHashEntry</a>&lt; TYPE &gt; &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScope.html#6a24b848c51155b2656ae11b503ca132">VarHash</a></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScope.html#177936eaead36bafe5e622c8b72bcba7">Scope</a> (<a class="el" href="classXPath2MemoryManager.html">XPath2MemoryManager</a> *memMgr, <a class="el" href="classScope.html#357719c423175c6c49b1cf3144cca7a5">Type</a> type)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">constructor. <a href="#177936eaead36bafe5e622c8b72bcba7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScope.html#229a9367bcbf0f874947703c4819d56c">~Scope</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScope.html#e0e4332611c4e2d6d19c85d75dde5453">clear</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classScope.html#357719c423175c6c49b1cf3144cca7a5">Type</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScope.html#b8c094f2109c355e429e05c49b01a91d">getType</a> () const</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVarHashEntry.html">VarHashEntry</a>&lt; TYPE &gt; *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScope.html#3479f6322803f522b024e4f01b6ffc68">get</a> (unsigned int nsID, const XMLCh *name)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScope.html#eb5cbf8b48e333f9b87244b41d237b8e">put</a> (unsigned int nsID, const XMLCh *name, <a class="el" href="classVarHashEntry.html">VarHashEntry</a>&lt; TYPE &gt; *value)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScope.html#3ecaa09a44e7e7a1003bd7ffd2b9e8cd">remove</a> (unsigned int nsID, const XMLCh *name)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::vector&lt; std::pair&lt; unsigned <br>
int, const XMLCh * &gt; &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScope.html#6abf1136065e37783f59c248e8b2373f">getVars</a> () const</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classScope.html">Scope</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScope.html#fcdfea70b1096d60d4ae41ad4d3df391">getNext</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScope.html#173df64f4ac82462d3868021caf34144">setNext</a> (<a class="el" href="classScope.html">Scope</a> *next)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class TYPE&gt;<br>
class Scope&lt; TYPE &gt;</h3>
used inside <a class="el" href="classVariableStore.html">VariableStore</a> to implement variable scoping
<p>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="6a24b848c51155b2656ae11b503ca132"></a><!-- doxytag: member="Scope::VarHash" ref="6a24b848c51155b2656ae11b503ca132" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TYPE&gt; </div>
<table class="memname">
<tr>
<td class="memname">typedef xercesc:: RefHash2KeysTableOf&lt; <a class="el" href="classVarHashEntry.html">VarHashEntry</a>&lt;TYPE&gt; &gt; <a class="el" href="classScope.html">Scope</a>&lt; TYPE &gt;::<a class="el" href="classScope.html#6a24b848c51155b2656ae11b503ca132">VarHash</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="357719c423175c6c49b1cf3144cca7a5"></a><!-- doxytag: member="Scope::Type" ref="357719c423175c6c49b1cf3144cca7a5" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TYPE&gt; </div>
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classScope.html#357719c423175c6c49b1cf3144cca7a5">Scope::Type</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
enum for classifying type of scope
<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="357719c423175c6c49b1cf3144cca7a5cceac28db5b3a31f4c1bb1a095faffea"></a><!-- doxytag: member="GLOBAL_SCOPE" ref="357719c423175c6c49b1cf3144cca7a5cceac28db5b3a31f4c1bb1a095faffea" args="" -->GLOBAL_SCOPE</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="357719c423175c6c49b1cf3144cca7a5712c77d1f90b905b1a998cd7891ec16b"></a><!-- doxytag: member="LOCAL_SCOPE" ref="357719c423175c6c49b1cf3144cca7a5712c77d1f90b905b1a998cd7891ec16b" args="" -->LOCAL_SCOPE</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="357719c423175c6c49b1cf3144cca7a5d73acb935b2b7ad06613203b71754f5b"></a><!-- doxytag: member="LOGICAL_BLOCK_SCOPE" ref="357719c423175c6c49b1cf3144cca7a5d73acb935b2b7ad06613203b71754f5b" args="" -->LOGICAL_BLOCK_SCOPE</em>&nbsp;</td><td>
</td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="177936eaead36bafe5e622c8b72bcba7"></a><!-- doxytag: member="Scope::Scope" ref="177936eaead36bafe5e622c8b72bcba7" args="(XPath2MemoryManager *memMgr, Type type)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TYPE&gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classScope.html">Scope</a>&lt; TYPE &gt;::<a class="el" href="classScope.html">Scope</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classXPath2MemoryManager.html">XPath2MemoryManager</a> *&nbsp;</td>
<td class="paramname"> <em>memMgr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classScope.html#357719c423175c6c49b1cf3144cca7a5">Type</a>&nbsp;</td>
<td class="paramname"> <em>type</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
constructor.
<p>
</div>
</div><p>
<a class="anchor" name="229a9367bcbf0f874947703c4819d56c"></a><!-- doxytag: member="Scope::~Scope" ref="229a9367bcbf0f874947703c4819d56c" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TYPE&gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classScope.html">Scope</a>&lt; TYPE &gt;::~<a class="el" href="classScope.html">Scope</a> </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="e0e4332611c4e2d6d19c85d75dde5453"></a><!-- doxytag: member="Scope::clear" ref="e0e4332611c4e2d6d19c85d75dde5453" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TYPE&gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classScope.html">Scope</a>&lt; TYPE &gt;::clear </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="b8c094f2109c355e429e05c49b01a91d"></a><!-- doxytag: member="Scope::getType" ref="b8c094f2109c355e429e05c49b01a91d" args="() const" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TYPE&gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classScope.html">Scope</a>&lt; TYPE &gt;::<a class="el" href="classScope.html#357719c423175c6c49b1cf3144cca7a5">Type</a> <a class="el" href="classScope.html">Scope</a>&lt; TYPE &gt;::getType </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="3479f6322803f522b024e4f01b6ffc68"></a><!-- doxytag: member="Scope::get" ref="3479f6322803f522b024e4f01b6ffc68" args="(unsigned int nsID, const XMLCh *name)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TYPE&gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classVarHashEntry.html">VarHashEntry</a>&lt; TYPE &gt; * <a class="el" href="classScope.html">Scope</a>&lt; TYPE &gt;::get </td>
<td>(</td>
<td class="paramtype">unsigned int&nbsp;</td>
<td class="paramname"> <em>nsID</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const XMLCh *&nbsp;</td>
<td class="paramname"> <em>name</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="eb5cbf8b48e333f9b87244b41d237b8e"></a><!-- doxytag: member="Scope::put" ref="eb5cbf8b48e333f9b87244b41d237b8e" args="(unsigned int nsID, const XMLCh *name, VarHashEntry&lt; TYPE &gt; *value)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TYPE&gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classScope.html">Scope</a>&lt; TYPE &gt;::put </td>
<td>(</td>
<td class="paramtype">unsigned int&nbsp;</td>
<td class="paramname"> <em>nsID</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const XMLCh *&nbsp;</td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classVarHashEntry.html">VarHashEntry</a>&lt; TYPE &gt; *&nbsp;</td>
<td class="paramname"> <em>value</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="3ecaa09a44e7e7a1003bd7ffd2b9e8cd"></a><!-- doxytag: member="Scope::remove" ref="3ecaa09a44e7e7a1003bd7ffd2b9e8cd" args="(unsigned int nsID, const XMLCh *name)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TYPE&gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classScope.html">Scope</a>&lt; TYPE &gt;::remove </td>
<td>(</td>
<td class="paramtype">unsigned int&nbsp;</td>
<td class="paramname"> <em>nsID</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const XMLCh *&nbsp;</td>
<td class="paramname"> <em>name</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="6abf1136065e37783f59c248e8b2373f"></a><!-- doxytag: member="Scope::getVars" ref="6abf1136065e37783f59c248e8b2373f" args="() const" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TYPE&gt; </div>
<table class="memname">
<tr>
<td class="memname">std::vector&lt; std::pair&lt; unsigned int, const XMLCh * &gt; &gt; <a class="el" href="classScope.html">Scope</a>&lt; TYPE &gt;::getVars </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="fcdfea70b1096d60d4ae41ad4d3df391"></a><!-- doxytag: member="Scope::getNext" ref="fcdfea70b1096d60d4ae41ad4d3df391" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TYPE&gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classScope.html">Scope</a>&lt; TYPE &gt; * <a class="el" href="classScope.html">Scope</a>&lt; TYPE &gt;::getNext </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="173df64f4ac82462d3868021caf34144"></a><!-- doxytag: member="Scope::setNext" ref="173df64f4ac82462d3868021caf34144" args="(Scope *next)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TYPE&gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classScope.html">Scope</a>&lt; TYPE &gt;::setNext </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classScope.html">Scope</a>&lt; TYPE &gt; *&nbsp;</td>
<td class="paramname"> <em>next</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Scope_8hpp-source.html">Scope.hpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Wed Dec 12 20:16:59 2007 for XQilla Simple API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
</body>
</html>