Google Git
Sign in
apache / xalan-site / 74fb702d7feb31dc5929ce81016774187d62264d / . / xalan-c / apiDocs / classExecutionContext.html
blob: 16fd1fcaa6d31f40f1e7746723edcf64314c3450 [file] [log] [blame]
<!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"/>
<title>Xalan-C++ API : Main Page</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<!-- The head section is copied from Doxygen 1.7.1 generated default output -->
<body>
<h2 align="center">Xalan-C++ API Documentation</h2>
<h3 align="center"><a href="../index.html">The Xalan C++ XSLT Processor Version 1.11</a></h3>
<hr/>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="pages.html"><span>Related&nbsp;Pages</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>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="classes.html"><span>Class&nbsp;Index</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>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<h1>ExecutionContext Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="ExecutionContext" --><!-- doxytag: inherits="ProblemListenerBase" -->
<p><code>#include &lt;<a class="el" href="ExecutionContext_8hpp_source.html">ExecutionContext.hpp</a>&gt;</code></p>
<p>Inherits <a class="el" href="classProblemListenerBase.html">ProblemListenerBase</a>.</p>
<p>Inherited by <a class="el" href="classXPathExecutionContext.html">XPathExecutionContext</a>.</p>
<div class="dynheader">
Collaboration diagram for ExecutionContext:</div>
<div class="dyncontent">
<div class="center"><img src="classExecutionContext__coll__graph.png" border="0" usemap="#ExecutionContext_coll__map" alt="Collaboration graph"/></div>
<map name="ExecutionContext_coll__map" id="ExecutionContext_coll__map">
<area shape="rect" id="node2" href="classProblemListenerBase.html" title="This is the abstract class that is used when reporting a problem some kind, that requires a message..." alt="" coords="5,5,163,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classExecutionContext-members.html">List of all members.</a></p>
<h2><a name="pub-methods"></a>
Public Member Functions</h2>
<ul>
<li><a class="el" href="classExecutionContext.html#a4f63f8be7eb10584288564f4b98cda8e">ExecutionContext</a> (MemoryManager &amp;theMemoryManager)
<li>virtual <a class="el" href="classExecutionContext.html#abc658fb1894cf47b2ffa4cba7362f2c7">~ExecutionContext</a> ()
<li>virtual void <a class="el" href="classExecutionContext.html#aef05baae1479aa180449c1abd28d5a79">problem</a> (<a class="el" href="classProblemListenerBase.html#ae363b5e4919bbe4e41f6b2c1b322ee7c">eSource</a> source, <a class="el" href="classProblemListenerBase.html#a1fec6cce6cc3429e200355330a41152a">eClassification</a> classification, const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;msg, const Locator *locator, const <a class="el" href="classXalanNode.html">XalanNode</a> *sourceNode)=0
<dl class="el"><dd class="mdescRight"><a class="el" href="classFunction.html">Function</a> that is called when a problem event occurs. <a href="#aef05baae1479aa180449c1abd28d5a79"></a><br/></dl><li>virtual void <a class="el" href="classExecutionContext.html#ac03a4ad6f7a58fb10eeaa6b027e83003">problem</a> (<a class="el" href="classProblemListenerBase.html#ae363b5e4919bbe4e41f6b2c1b322ee7c">eSource</a> source, <a class="el" href="classProblemListenerBase.html#a1fec6cce6cc3429e200355330a41152a">eClassification</a> classification, const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;msg, const <a class="el" href="classXalanNode.html">XalanNode</a> *sourceNode)=0
<dl class="el"><dd class="mdescRight"><a class="el" href="classFunction.html">Function</a> that is called when a problem event occurs. <a href="#ac03a4ad6f7a58fb10eeaa6b027e83003"></a><br/></dl><li>bool <a class="el" href="classExecutionContext.html#a5d609251df064cf178f4de8e8b726072">hasPreserveOrStripSpaceConditions</a> () const
<li>virtual bool <a class="el" href="classExecutionContext.html#a37412900bb3314f79d6691e4d0ae3b8f">shouldStripSourceNode</a> (const <a class="el" href="classXalanText.html">XalanText</a> &amp;node)=0
<dl class="el"><dd class="mdescRight">Determine if a text node should be stripped from the source tree, as if it weren't there. <a href="#a37412900bb3314f79d6691e4d0ae3b8f"></a><br/></dl><li>MemoryManager &amp; <a class="el" href="classExecutionContext.html#a9f14779fae4cdbf80374926c951674ec">getMemoryManager</a> () const
<li>MemoryManager &amp; <a class="el" href="classExecutionContext.html#acefbfc106ef501bf7cdb61489c2099f7">getExceptionMemoryManager</a> () const
</ul>
<h2><a name="pro-attribs"></a>
Protected Attributes</h2>
<ul>
<li>MemoryManager &amp; <a class="el" href="classExecutionContext.html#a680912c07af8753ef49a4b022b46ae05">m_memoryManager</a>
<li>bool <a class="el" href="classExecutionContext.html#a9d27122cf9fbb0749771ad456570430c">m_hasPreserveOrStripConditions</a>
</ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Definition at line <a class="el" href="ExecutionContext_8hpp_source.html#l00057">57</a> of file <a class="el" href="ExecutionContext_8hpp_source.html">ExecutionContext.hpp</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a4f63f8be7eb10584288564f4b98cda8e"></a><!-- doxytag: member="ExecutionContext::ExecutionContext" ref="a4f63f8be7eb10584288564f4b98cda8e" args="(MemoryManager &amp;theMemoryManager)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ExecutionContext::ExecutionContext </td>
<td>(</td>
<td class="paramtype">MemoryManager &amp;&nbsp;</td>
<td class="paramname"> <em>theMemoryManager</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="abc658fb1894cf47b2ffa4cba7362f2c7"></a><!-- doxytag: member="ExecutionContext::~ExecutionContext" ref="abc658fb1894cf47b2ffa4cba7362f2c7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ExecutionContext::~ExecutionContext </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="acefbfc106ef501bf7cdb61489c2099f7"></a><!-- doxytag: member="ExecutionContext::getExceptionMemoryManager" ref="acefbfc106ef501bf7cdb61489c2099f7" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MemoryManager&amp; ExecutionContext::getExceptionMemoryManager </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="ExecutionContext_8hpp_source.html#l00106">106</a> of file <a class="el" href="ExecutionContext_8hpp_source.html">ExecutionContext.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a9f14779fae4cdbf80374926c951674ec"></a><!-- doxytag: member="ExecutionContext::getMemoryManager" ref="a9f14779fae4cdbf80374926c951674ec" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MemoryManager&amp; ExecutionContext::getMemoryManager </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="ExecutionContext_8hpp_source.html#l00100">100</a> of file <a class="el" href="ExecutionContext_8hpp_source.html">ExecutionContext.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a5d609251df064cf178f4de8e8b726072"></a><!-- doxytag: member="ExecutionContext::hasPreserveOrStripSpaceConditions" ref="a5d609251df064cf178f4de8e8b726072" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ExecutionContext::hasPreserveOrStripSpaceConditions </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="ExecutionContext_8hpp_source.html#l00084">84</a> of file <a class="el" href="ExecutionContext_8hpp_source.html">ExecutionContext.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="ac03a4ad6f7a58fb10eeaa6b027e83003"></a><!-- doxytag: member="ExecutionContext::problem" ref="ac03a4ad6f7a58fb10eeaa6b027e83003" args="(eSource source, eClassification classification, const XalanDOMString &amp;msg, const XalanNode *sourceNode)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void ExecutionContext::problem </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classProblemListenerBase.html#ae363b5e4919bbe4e41f6b2c1b322ee7c">eSource</a>&nbsp;</td>
<td class="paramname"> <em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classProblemListenerBase.html#a1fec6cce6cc3429e200355330a41152a">eClassification</a>&nbsp;</td>
<td class="paramname"> <em>classification</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;&nbsp;</td>
<td class="paramname"> <em>msg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXalanNode.html">XalanNode</a> *&nbsp;</td>
<td class="paramname"> <em>sourceNode</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classFunction.html">Function</a> that is called when a problem event occurs. </p>
<p>This version assumes location information is already formatted into the message.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>source</em>&nbsp;</td><td>either eXMLPARSER, eXSLPROCESSOR, or eXPATH </td></tr>
<tr><td valign="top"></td><td valign="top"><em>classification</em>&nbsp;</td><td>either eMESSAGE, eERROR or eWARNING </td></tr>
<tr><td valign="top"></td><td valign="top"><em>msg</em>&nbsp;</td><td>string message explaining the problem. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classProblemListenerBase.html#ab0b6125dce1f0c27a3d91fdca012f3b4">ProblemListenerBase</a>.</p>
<p>Implemented in <a class="el" href="classStylesheetExecutionContext.html#adc5fd22cd952a0a93043eead9eb34afd">StylesheetExecutionContext</a>, <a class="el" href="classStylesheetExecutionContextDefault.html#a489078725f0b847c62ed54ded52091e4">StylesheetExecutionContextDefault</a>, <a class="el" href="classXPathExecutionContext.html#aba684e720626568df72c1756f8a0668d">XPathExecutionContext</a>, and <a class="el" href="classXPathExecutionContextDefault.html#ab2bf3ef366010729dec0ba37de0f5d7b">XPathExecutionContextDefault</a>.</p>
</div>
</div>
<a class="anchor" id="aef05baae1479aa180449c1abd28d5a79"></a><!-- doxytag: member="ExecutionContext::problem" ref="aef05baae1479aa180449c1abd28d5a79" args="(eSource source, eClassification classification, const XalanDOMString &amp;msg, const Locator *locator, const XalanNode *sourceNode)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void ExecutionContext::problem </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classProblemListenerBase.html#ae363b5e4919bbe4e41f6b2c1b322ee7c">eSource</a>&nbsp;</td>
<td class="paramname"> <em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classProblemListenerBase.html#a1fec6cce6cc3429e200355330a41152a">eClassification</a>&nbsp;</td>
<td class="paramname"> <em>classification</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;&nbsp;</td>
<td class="paramname"> <em>msg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Locator *&nbsp;</td>
<td class="paramname"> <em>locator</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXalanNode.html">XalanNode</a> *&nbsp;</td>
<td class="paramname"> <em>sourceNode</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classFunction.html">Function</a> that is called when a problem event occurs. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>source</em>&nbsp;</td><td>Either eXMLParser, eXSLProcessor, or eXPATH. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>classification</em>&nbsp;</td><td>Either eMessage, eWarning, or eError. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>locator</em>&nbsp;</td><td>The current Locator instance for the stylesheet. Maybe be a null pointer. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>sourceNode</em>&nbsp;</td><td>The current source node, if any. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>msg</em>&nbsp;</td><td>The error message. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classProblemListenerBase.html#a50a8c4dee286543750b247df7ca99ca0">ProblemListenerBase</a>.</p>
<p>Implemented in <a class="el" href="classStylesheetExecutionContext.html#ac2021f630141884516db1de79db4772c">StylesheetExecutionContext</a>, <a class="el" href="classStylesheetExecutionContextDefault.html#a9052a7b580c4c4beab09b1c400ed82f3">StylesheetExecutionContextDefault</a>, <a class="el" href="classXPathExecutionContext.html#ad968f5fdf3eb15c30783258f9f596d98">XPathExecutionContext</a>, and <a class="el" href="classXPathExecutionContextDefault.html#a3b209d973f66f12979433c22b98013ce">XPathExecutionContextDefault</a>.</p>
</div>
</div>
<a class="anchor" id="a37412900bb3314f79d6691e4d0ae3b8f"></a><!-- doxytag: member="ExecutionContext::shouldStripSourceNode" ref="a37412900bb3314f79d6691e4d0ae3b8f" args="(const XalanText &amp;node)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool ExecutionContext::shouldStripSourceNode </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXalanText.html">XalanText</a> &amp;&nbsp;</td>
<td class="paramname"> <em>node</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Determine if a text node should be stripped from the source tree, as if it weren't there. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>textNode</em>&nbsp;</td><td>text node from the source tree </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the text node should be stripped </dd></dl>
<p>Implemented in <a class="el" href="classStylesheetExecutionContext.html#aaf2294b6ed8988263571fc8a4fac5343">StylesheetExecutionContext</a>, <a class="el" href="classStylesheetExecutionContextDefault.html#a8f9ce2f440e78a5392ba6c5b555b116b">StylesheetExecutionContextDefault</a>, <a class="el" href="classXPathExecutionContext.html#af8c302eabd7cf85e25fd33d1c181f539">XPathExecutionContext</a>, and <a class="el" href="classXPathExecutionContextDefault.html#a710c64cbd31fa4e4cf69a425a94ad2d4">XPathExecutionContextDefault</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a9d27122cf9fbb0749771ad456570430c"></a><!-- doxytag: member="ExecutionContext::m_hasPreserveOrStripConditions" ref="a9d27122cf9fbb0749771ad456570430c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classExecutionContext.html#a9d27122cf9fbb0749771ad456570430c">ExecutionContext::m_hasPreserveOrStripConditions</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="ExecutionContext_8hpp_source.html#l00115">115</a> of file <a class="el" href="ExecutionContext_8hpp_source.html">ExecutionContext.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a680912c07af8753ef49a4b022b46ae05"></a><!-- doxytag: member="ExecutionContext::m_memoryManager" ref="a680912c07af8753ef49a4b022b46ae05" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MemoryManager&amp; <a class="el" href="classExecutionContext.html#a680912c07af8753ef49a4b022b46ae05">ExecutionContext::m_memoryManager</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="ExecutionContext_8hpp_source.html#l00113">113</a> of file <a class="el" href="ExecutionContext_8hpp_source.html">ExecutionContext.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="ExecutionContext_8hpp_source.html">ExecutionContext.hpp</a></li>
</ul>
</div>
<p align="center"><a href="graph_legend.html">Interpreting class diagrams</a></p>
<p><font color="#000000" face="arial,helvetica,sanserif" size="-1">
<i><a href="http://www.doxygen.org/">Doxygen</a> and
<a href="http://www.graphviz.org/">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="80%">
<tr>
<td width="80%" valign="top">
<p align="center"><b>Xalan-C++ XSLT Processor Version 1.11</b><br/>
Copyright &copy; 1999-2012 The Apache Software Foundation.<br/>
All Rights Reserved.</p>
</td>
</tr>
<tr>
<td width="100%">
<p align="center"><img src="asf_logo_wide.gif" width="268" height="25" align="bottom" border="0" alt="Apache Logo">
</td>
</tr>
</table>
</body>
</html>