XQuilla/docs/simple-api/classScope.html
2020-02-17 22:19:08 +01:00

496 lines
19 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.3.9.1 -->
<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a> | <a class="qindex" href="examples.html">Examples</a></div>
<h1>Scope&lt; TYPE &gt; Class Template Reference</h1>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,136,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">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#w0">VarHash</a></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#w4">Type</a> { <a class="el" href="classScope.html#w4w1">GLOBAL_SCOPE</a>,
<a class="el" href="classScope.html#w4w2">LOCAL_SCOPE</a>,
<a class="el" href="classScope.html#w4w3">LOGICAL_BLOCK_SCOPE</a>
}</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">enum for classifying type of scope <a href="#w4">More...</a><br></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#a0">Scope</a> (<a class="el" href="classXPath2MemoryManager.html">XPath2MemoryManager</a> *memMgr, <a class="el" href="classScope.html#w4">Type</a> type)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">constructor. <a href="#a0"></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#a1">~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#a2">clear</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classScope.html#w4">Type</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScope.html#a3">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#a4">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#a5">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#a6">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#a7">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#a8">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#a9">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="w0" doxytag="Scope::VarHash"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class TYPE&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top">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#w0">VarHash</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="w4" doxytag="Scope::Type"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class TYPE&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top">enum <a class="el" href="classScope.html#w4">Scope::Type</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
enum for classifying type of scope
<p>
<dl compact><dt><b>Enumeration values: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="w4w1" doxytag="GLOBAL_SCOPE"></a>GLOBAL_SCOPE</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="w4w2" doxytag="LOCAL_SCOPE"></a>LOCAL_SCOPE</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="w4w3" doxytag="LOGICAL_BLOCK_SCOPE"></a>LOGICAL_BLOCK_SCOPE</em>&nbsp;</td><td>
</td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="a0" doxytag="Scope::Scope"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class TYPE&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classScope.html">Scope</a>&lt; TYPE &gt;::<a class="el" href="classScope.html">Scope</a> </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="classXPath2MemoryManager.html">XPath2MemoryManager</a> *&nbsp;</td>
<td class="mdname" nowrap> <em>memMgr</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="classScope.html#w4">Type</a>&nbsp;</td>
<td class="mdname" nowrap> <em>type</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
constructor.
<p>
</td>
</tr>
</table>
<a class="anchor" name="a1" doxytag="Scope::~Scope"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class TYPE&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classScope.html">Scope</a>&lt; TYPE &gt;::~<a class="el" href="classScope.html">Scope</a> </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a2" doxytag="Scope::clear"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class TYPE&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top">void <a class="el" href="classScope.html">Scope</a>&lt; TYPE &gt;::clear </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="a4" doxytag="Scope::get"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class TYPE&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"><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 class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">unsigned int&nbsp;</td>
<td class="mdname" nowrap> <em>nsID</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const XMLCh *&nbsp;</td>
<td class="mdname" nowrap> <em>name</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="a8" doxytag="Scope::getNext"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class TYPE&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"><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 class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="a3" doxytag="Scope::getType"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class TYPE&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classScope.html">Scope</a>&lt; TYPE &gt;::<a class="el" href="classScope.html#w4">Type</a> <a class="el" href="classScope.html">Scope</a>&lt; TYPE &gt;::getType </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="a7" doxytag="Scope::getVars"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class TYPE&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top">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 class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="a5" doxytag="Scope::put"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class TYPE&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top">void <a class="el" href="classScope.html">Scope</a>&lt; TYPE &gt;::put </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">unsigned int&nbsp;</td>
<td class="mdname" nowrap> <em>nsID</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const XMLCh *&nbsp;</td>
<td class="mdname" nowrap> <em>name</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="classVarHashEntry.html">VarHashEntry</a>&lt; TYPE &gt; *&nbsp;</td>
<td class="mdname" nowrap> <em>value</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="a6" doxytag="Scope::remove"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class TYPE&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top">void <a class="el" href="classScope.html">Scope</a>&lt; TYPE &gt;::remove </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">unsigned int&nbsp;</td>
<td class="mdname" nowrap> <em>nsID</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const XMLCh *&nbsp;</td>
<td class="mdname" nowrap> <em>name</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="a9" doxytag="Scope::setNext"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class TYPE&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top">void <a class="el" href="classScope.html">Scope</a>&lt; TYPE &gt;::setNext </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="classScope.html">Scope</a>&lt; TYPE &gt; *&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>next</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<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 Fri Sep 25 06:55:41 2009 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.3.9.1 </small></address>
</body>
</html>