Google Git
Sign in
apache / xalan-site / 1b0c6dd5447f3bc951dcdd0e155aae8fc8efd4de / . / old / xalan-c / apiDocs / classVariablesStack_1_1StackEntry.html
blob: 5d333146754df2babc1df07e1d26a272e40f4cb9 [file] [log] [blame]
<HTML><HEAD><TITLE>Xalan-C++ API Documentation</TITLE></HEAD>
<BODY>
<h2 align="center">Xalan-C++ API Documentation</h2>
<h3 align="center">The Xalan C++ XSLT Processor Version 1.10</h3>
</BODY>
<!-- Generated by Doxygen 1.2.8.1 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>VariablesStack::StackEntry Class Reference</h1><code>#include &lt;<a class="el" href="VariablesStack_8hpp-source.html">VariablesStack.hpp</a>&gt;</code>
<p>
Collaboration diagram for VariablesStack::StackEntry:<p><center><img src="classVariablesStack_1_1StackEntry__coll__graph.gif" border="0" usemap="#VariablesStack::StackEntry_coll_map" alt="Collaboration graph"></center>
<map name="VariablesStack::StackEntry_coll_map">
<area href="classElemVariable.html" shape="rect" coords="384,165,480,141">
<area href="classElemTemplateElement.html" shape="rect" coords="7,58,156,34">
<area href="classXalanNode.html" shape="rect" coords="417,58,497,34">
<area href="classXalanQName.html" shape="rect" coords="709,58,805,34">
<area href="classXPath.html" shape="rect" coords="548,58,601,34">
<area href="classXObjectPtr.html" shape="rect" coords="308,58,393,34">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classVariablesStack_1_1StackEntry-members.html">List of all members.</a><h2>Public Types</h2>
<ul>
<li>enum <a class="el" href="classVariablesStack_1_1StackEntry.html#s6">eType</a> { <br>
&nbsp;&nbsp;<a class="el" href="classVariablesStack_1_1StackEntry.html#s6s0">eContextMarker</a>,
<a class="el" href="classVariablesStack_1_1StackEntry.html#s6s1">eVariable</a>,
<a class="el" href="classVariablesStack_1_1StackEntry.html#s6s2">eParam</a>,
<a class="el" href="classVariablesStack_1_1StackEntry.html#s6s3">eActiveParam</a>,
<br>
&nbsp;&nbsp;<a class="el" href="classVariablesStack_1_1StackEntry.html#s6s4">eElementFrameMarker</a>,
<a class="el" href="classVariablesStack_1_1StackEntry.html#s6s5">eNextValue</a>
<br>
}
<dl class="el"><dd><font size=-1><em>Enumeration for types of stack entries, one of context state, context marker, element marker, or argument.</em> <a href="#s6">More...</a><em><br><br></em></font></dl></ul>
<h2>Public Methods</h2>
<ul>
<li><a class="el" href="classVariablesStack_1_1StackEntry.html#a0">StackEntry</a> ()
<dl class="el"><dd><font size=-1><em>Construct a context marker.</em> <a href="#a0">More...</a><em><br><br></em></font></dl><li><a class="el" href="classVariablesStack_1_1StackEntry.html#a1">StackEntry</a> (const <a class="el" href="classXalanQName.html">XalanQName</a> *name, const <a class="el" href="classXObjectPtr.html">XObjectPtr</a> &amp;val, bool isParam=false)
<dl class="el"><dd><font size=-1><em>Construct a variable that is already evaluated.</em> <a href="#a1">More...</a><em><br><br></em></font></dl><li><a class="el" href="classVariablesStack_1_1StackEntry.html#a2">StackEntry</a> (const <a class="el" href="classXalanQName.html">XalanQName</a> *name, const <a class="el" href="classElemVariable.html">ElemVariable</a> *var, bool isParam=false)
<dl class="el"><dd><font size=-1><em>Construct a variable that has not been evaluated yet.</em> <a href="#a2">More...</a><em><br><br></em></font></dl><li><a class="el" href="classVariablesStack_1_1StackEntry.html#a3">StackEntry</a> (const <a class="el" href="classElemTemplateElement.html">ElemTemplateElement</a> *elem)
<dl class="el"><dd><font size=-1><em>Construct an element frame marker.</em> <a href="#a3">More...</a><em><br><br></em></font></dl><li><a class="el" href="classVariablesStack_1_1StackEntry.html#a4">StackEntry</a> (const StackEntry &amp;theSource)
<dl class="el"><dd><font size=-1><em>Copy constructor...</em> <a href="#a4">More...</a><em><br><br></em></font></dl><li><a class="el" href="classVariablesStack_1_1StackEntry.html#a5">~StackEntry</a> ()
<dl class="el"><dd><font size=-1><em>Destructor...</em> <a href="#a5">More...</a><em><br><br></em></font></dl><li><a class="el" href="classVariablesStack_1_1StackEntry.html#s6">eType</a> <a class="el" href="classVariablesStack_1_1StackEntry.html#a6">getType</a> () const
<dl class="el"><dd><font size=-1><em>Determine type of stack entry.</em> <a href="#a6">More...</a><em><br><br></em></font></dl><li>const <a class="el" href="classXalanQName.html">XalanQName</a>* <a class="el" href="classVariablesStack_1_1StackEntry.html#a7">getName</a> () const
<dl class="el"><dd><font size=-1><em>Retrieve object name.</em> <a href="#a7">More...</a><em><br><br></em></font></dl><li>const <a class="el" href="classXObjectPtr.html">XObjectPtr</a>&amp; <a class="el" href="classVariablesStack_1_1StackEntry.html#a8">getValue</a> () const
<dl class="el"><dd><font size=-1><em>Retrieve object's <a class="el" href="classXObject.html">XObject</a> pointer.</em> <a href="#a8">More...</a><em><br><br></em></font></dl><li>void <a class="el" href="classVariablesStack_1_1StackEntry.html#a9">setValue</a> (const <a class="el" href="classXObjectPtr.html">XObjectPtr</a> &amp;theValue)
<dl class="el"><dd><font size=-1><em>Retrieve object's <a class="el" href="classXObject.html">XObject</a> pointer.</em> <a href="#a9">More...</a><em><br><br></em></font></dl><li>const <a class="el" href="classElemVariable.html">ElemVariable</a>* <a class="el" href="classVariablesStack_1_1StackEntry.html#a10">getVariable</a> () const
<dl class="el"><dd><font size=-1><em>Retrieve object's <a class="el" href="classXObject.html">XObject</a> pointer.</em> <a href="#a10">More...</a><em><br><br></em></font></dl><li>void <a class="el" href="classVariablesStack_1_1StackEntry.html#a11">activate</a> ()
<li>void <a class="el" href="classVariablesStack_1_1StackEntry.html#a12">deactivate</a> ()
<li>const <a class="el" href="classElemTemplateElement.html">ElemTemplateElement</a>* <a class="el" href="classVariablesStack_1_1StackEntry.html#a13">getElement</a> () const
<dl class="el"><dd><font size=-1><em>Retrieve the ElemTemplateElem where frame begins.</em> <a href="#a13">More...</a><em><br><br></em></font></dl><li>StackEntry&amp; <a class="el" href="classVariablesStack_1_1StackEntry.html#a14">operator=</a> (const StackEntry &amp;theRHS)
<li>bool <a class="el" href="classVariablesStack_1_1StackEntry.html#a15">operator==</a> (const StackEntry &amp;theRHS) const
</ul>
<hr><h2>Member Enumeration Documentation</h2>
<a name="s6" doxytag="VariablesStack::StackEntry::eType"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
enum VariablesStack::StackEntry::eType
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Enumeration for types of stack entries, one of context state, context marker, element marker, or argument.
<p>
<dl compact><dt>
<b>Enumeration values:</b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><a name="s6s0" doxytag="eContextMarker"></a><em>eContextMarker</em>
&nbsp;</td><td>
</td></tr>
<tr><td valign=top><a name="s6s1" doxytag="eVariable"></a><em>eVariable</em>
&nbsp;</td><td>
</td></tr>
<tr><td valign=top><a name="s6s2" doxytag="eParam"></a><em>eParam</em>
&nbsp;</td><td>
</td></tr>
<tr><td valign=top><a name="s6s3" doxytag="eActiveParam"></a><em>eActiveParam</em>
&nbsp;</td><td>
</td></tr>
<tr><td valign=top><a name="s6s4" doxytag="eElementFrameMarker"></a><em>eElementFrameMarker</em>
&nbsp;</td><td>
</td></tr>
<tr><td valign=top><a name="s6s5" doxytag="eNextValue"></a><em>eNextValue</em>
&nbsp;</td><td>
</td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="VariablesStack::StackEntry::StackEntry"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
VariablesStack::StackEntry::StackEntry (
</b></td>
<td valign="bottom"><b>
)<code> [explicit]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Construct a context marker.
<p>
</td>
</tr>
</table>
<a name="a1" doxytag="VariablesStack::StackEntry::StackEntry"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
VariablesStack::StackEntry::StackEntry (
</b></td>
<td valign="bottom"><b>
const <a class="el" href="classXalanQName.html">XalanQName</a> * <em>name</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="classXObjectPtr.html">XObjectPtr</a> &amp; <em>val</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
bool <em>isParam</em> = false&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Construct a variable that is already evaluated.
<p>
</td>
</tr>
</table>
<a name="a2" doxytag="VariablesStack::StackEntry::StackEntry"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
VariablesStack::StackEntry::StackEntry (
</b></td>
<td valign="bottom"><b>
const <a class="el" href="classXalanQName.html">XalanQName</a> * <em>name</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="classElemVariable.html">ElemVariable</a> * <em>var</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
bool <em>isParam</em> = false&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Construct a variable that has not been evaluated yet.
<p>
</td>
</tr>
</table>
<a name="a3" doxytag="VariablesStack::StackEntry::StackEntry"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
VariablesStack::StackEntry::StackEntry (
</b></td>
<td valign="bottom"><b>
const <a class="el" href="classElemTemplateElement.html">ElemTemplateElement</a> * <em>elem</em>&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Construct an element frame marker.
<p>
</td>
</tr>
</table>
<a name="a4" doxytag="VariablesStack::StackEntry::StackEntry"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
VariablesStack::StackEntry::StackEntry (
</b></td>
<td valign="bottom"><b>
const StackEntry &amp; <em>theSource</em>&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Copy constructor...
<p>
</td>
</tr>
</table>
<a name="a5" doxytag="VariablesStack::StackEntry::~StackEntry"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
VariablesStack::StackEntry::~StackEntry (
</b></td>
<td valign="bottom"><b>
)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Destructor...
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a11" doxytag="VariablesStack::StackEntry::activate"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void VariablesStack::StackEntry::activate (
</b></td>
<td valign="bottom"><b>
)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a12" doxytag="VariablesStack::StackEntry::deactivate"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void VariablesStack::StackEntry::deactivate (
</b></td>
<td valign="bottom"><b>
)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a13" doxytag="VariablesStack::StackEntry::getElement"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const <a class="el" href="classElemTemplateElement.html">ElemTemplateElement</a> * VariablesStack::StackEntry::getElement (
</b></td>
<td valign="bottom"><b>
) const
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Retrieve the ElemTemplateElem where frame begins.
<p>
Valid only for element frame markers
<p>
<dl compact><dt>
<b>Returns: </b><dd>
<a class="el" href="classElemTemplateElement.html">ElemTemplateElement</a> corresponding to marker </dl> </td>
</tr>
</table>
<a name="a7" doxytag="VariablesStack::StackEntry::getName"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const <a class="el" href="classXalanQName.html">XalanQName</a> * VariablesStack::StackEntry::getName (
</b></td>
<td valign="bottom"><b>
) const
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Retrieve object name.
<p>
Valid only for variables
<p>
<dl compact><dt>
<b>Returns: </b><dd>
qualified name of object </dl> </td>
</tr>
</table>
<a name="a6" doxytag="VariablesStack::StackEntry::getType"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
<a class="el" href="classVariablesStack_1_1StackEntry.html#s6">eType</a> VariablesStack::StackEntry::getType (
</b></td>
<td valign="bottom"><b>
) const
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Determine type of stack entry.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
enumeration value for type </dl> </td>
</tr>
</table>
<a name="a8" doxytag="VariablesStack::StackEntry::getValue"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const <a class="el" href="classXObjectPtr.html">XObjectPtr</a> &amp; VariablesStack::StackEntry::getValue (
</b></td>
<td valign="bottom"><b>
) const
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Retrieve object's <a class="el" href="classXObject.html">XObject</a> pointer.
<p>
Valid only for variables
<p>
<dl compact><dt>
<b>Returns: </b><dd>
pointer to <a class="el" href="classXObject.html">XObject</a> </dl> </td>
</tr>
</table>
<a name="a10" doxytag="VariablesStack::StackEntry::getVariable"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const <a class="el" href="classElemVariable.html">ElemVariable</a> * VariablesStack::StackEntry::getVariable (
</b></td>
<td valign="bottom"><b>
) const
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Retrieve object's <a class="el" href="classXObject.html">XObject</a> pointer.
<p>
Valid only for variables
<p>
<dl compact><dt>
<b>Returns: </b><dd>
pointer to <a class="el" href="classXObject.html">XObject</a> </dl> </td>
</tr>
</table>
<a name="a14" doxytag="VariablesStack::StackEntry::operator="></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
StackEntry &amp; VariablesStack::StackEntry::operator= (
</b></td>
<td valign="bottom"><b>
const StackEntry &amp; <em>theRHS</em>&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a15" doxytag="VariablesStack::StackEntry::operator=="></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
bool VariablesStack::StackEntry::operator== (
</b></td>
<td valign="bottom"><b>
const StackEntry &amp; <em>theRHS</em>&nbsp;) const
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a9" doxytag="VariablesStack::StackEntry::setValue"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void VariablesStack::StackEntry::setValue (
</b></td>
<td valign="bottom"><b>
const <a class="el" href="classXObjectPtr.html">XObjectPtr</a> &amp; <em>theValue</em>&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Retrieve object's <a class="el" href="classXObject.html">XObject</a> pointer.
<p>
Valid only for variables
<p>
<dl compact><dt>
<b>Returns: </b><dd>
pointer to <a class="el" href="classXObject.html">XObject</a> </dl> </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="VariablesStack_8hpp-source.html">VariablesStack.hpp</a></ul>
<p align="center"><a href="diagramnotes.html">Interpreting class diagrams</a></p>
<p><FONT color="#000000" face="arial,helvetica,sanserif" size="-1">
<i><A href="http://www.stack.nl/~dimitri/doxygen/">Doxygen</A> and
<A href="http://www.research.att.com/sw/tools/graphviz/">GraphViz</A> are used to generate this API documentation from the Xalan-C header files.</I></FONT></p>
<TABLE border="0" cellpadding="0" cellspacing="0" width="820"><TR><TD bgcolor="#0086b2"><IMG height="1" src="../resources/dot.gif" width="1" alt="dot"></TD></TR></TABLE>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" WIDTH="80%">
<TR>
<TD WIDTH="80%" VALIGN="TOP">
<P ALIGN="CENTER"><B>Xalan-C++ XSLT Processor Version 1.10</B><BR>
Copyright &copy; 1999-2004 The Apache Software Foundation. All Rights Reserved.</i></p>
</TD>
</TR>
<TR>
<TD WIDTH="100%">
<P ALIGN="CENTER"><IMG SRC="ApacheLogo.jpg" WIDTH="387" HEIGHT="100" ALIGN="BOTTOM" BORDER="0" ALT="Apache Logo">
</TD>
</TR>
</TABLE>