blob: 7507c4bf3959552ce917153806e0f28c6b2f9948 [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><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<h1>XSLException.hpp</h1> </div>
</div>
<div class="contents">
<a href="XSLException_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span>
<a name="l00003"></a>00003 <span class="comment"> * or more contributor license agreements. See the NOTICE file</span>
<a name="l00004"></a>00004 <span class="comment"> * distributed with this work for additional information</span>
<a name="l00005"></a>00005 <span class="comment"> * regarding copyright ownership. The ASF licenses this file</span>
<a name="l00006"></a>00006 <span class="comment"> * to you under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
<a name="l00007"></a>00007 <span class="comment"> * you may not use this file except in compliance with the License.</span>
<a name="l00008"></a>00008 <span class="comment"> * You may obtain a copy of the License at</span>
<a name="l00009"></a>00009 <span class="comment"> *</span>
<a name="l00010"></a>00010 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span>
<a name="l00011"></a>00011 <span class="comment"> *</span>
<a name="l00012"></a>00012 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span>
<a name="l00013"></a>00013 <span class="comment"> * distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span>
<a name="l00014"></a>00014 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<a name="l00015"></a>00015 <span class="comment"> * See the License for the specific language governing permissions and</span>
<a name="l00016"></a>00016 <span class="comment"> * limitations under the License.</span>
<a name="l00017"></a>00017 <span class="comment"> */</span>
<a name="l00018"></a>00018 <span class="preprocessor">#if !defined(XSLEXCEPTION_HEADER_GUARD_1357924680)</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span><span class="preprocessor">#define XSLEXCEPTION_HEADER_GUARD_1357924680</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span>
<a name="l00021"></a>00021
<a name="l00022"></a>00022
<a name="l00023"></a>00023 <span class="comment">// Base include file. Must be first.</span>
<a name="l00024"></a>00024 <span class="preprocessor">#include &lt;<a class="code" href="PlatformSupportDefinitions_8hpp.html">xalanc/PlatformSupport/PlatformSupportDefinitions.hpp</a>&gt;</span>
<a name="l00025"></a>00025
<a name="l00026"></a>00026
<a name="l00027"></a>00027
<a name="l00028"></a>00028 <span class="preprocessor">#include &lt;<a class="code" href="DOMStringHelper_8hpp.html">xalanc/PlatformSupport/DOMStringHelper.hpp</a>&gt;</span>
<a name="l00029"></a>00029 <span class="preprocessor">#include &lt;<a class="code" href="XalanLocator_8hpp.html">xalanc/PlatformSupport/XalanLocator.hpp</a>&gt;</span>
<a name="l00030"></a>00030
<a name="l00031"></a>00031
<a name="l00032"></a>00032
<a name="l00033"></a>00033 XALAN_CPP_NAMESPACE_BEGIN
<a name="l00034"></a>00034
<a name="l00035"></a>00035
<a name="l00036"></a>00036
<a name="l00037"></a><a class="code" href="XSLException_8hpp.html#a12c468c253325bbf88bb983911ef1623">00037</a> <span class="keyword">typedef</span> XERCES_CPP_NAMESPACE_QUALIFIER Locator LocatorType;
<a name="l00038"></a>00038 <a class="code" href="XSLTProcessor_8hpp.html#a24af2755e58bade5ff0d5965b855e56a">XALAN_USING_XERCES</a>(Locator)
<a name="l00039"></a>00039
<a name="l00040"></a>00040
<a name="l00041"></a>00041
<a name="l00042"></a><a class="code" href="classXSLException.html">00042</a> class <a class="code" href="PlatformSupportDefinitions_8hpp.html#a72e8d5d428f0210697564ce111006fde">XALAN_PLATFORMSUPPORT_EXPORT</a> <a class="code" href="classXSLException.html">XSLException</a>
<a name="l00043"></a>00043 {
<a name="l00044"></a>00044 <span class="keyword">public</span>:
<a name="l00045"></a>00045 <span class="comment"></span>
<a name="l00046"></a>00046 <span class="comment"> /**</span>
<a name="l00047"></a>00047 <span class="comment"> * Constructor</span>
<a name="l00048"></a>00048 <span class="comment"> *</span>
<a name="l00049"></a>00049 <span class="comment"> * @param theMessage The message to display when exception thrown</span>
<a name="l00050"></a>00050 <span class="comment"> * @param theManager The MemoryManager instance to use.</span>
<a name="l00051"></a>00051 <span class="comment"> * @param theLocator The locator instance for error reporting, if any.</span>
<a name="l00052"></a>00052 <span class="comment"> */</span>
<a name="l00053"></a>00053 XSLException(
<a name="l00054"></a>00054 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; theMessage,
<a name="l00055"></a>00055 MemoryManager&amp; theManager,
<a name="l00056"></a>00056 <span class="keyword">const</span> Locator* theLocator);
<a name="l00057"></a>00057 <span class="comment"></span>
<a name="l00058"></a>00058 <span class="comment"> /**</span>
<a name="l00059"></a>00059 <span class="comment"> * Constructor. Use this constructor when the message has </span>
<a name="l00060"></a>00060 <span class="comment"> * already been formatted.</span>
<a name="l00061"></a>00061 <span class="comment"> * </span>
<a name="l00062"></a>00062 <span class="comment"> * @param theMessage The message to display when exception thrown</span>
<a name="l00063"></a>00063 <span class="comment"> * @param theManager The MemoryManager instance to use.</span>
<a name="l00064"></a>00064 <span class="comment"> */</span>
<a name="l00065"></a>00065 XSLException(
<a name="l00066"></a>00066 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; theMessage,
<a name="l00067"></a>00067 MemoryManager&amp; theManager);
<a name="l00068"></a>00068
<a name="l00069"></a>00069 XSLException(<span class="keyword">const</span> XSLException&amp; other);
<a name="l00070"></a>00070
<a name="l00071"></a>00071 <span class="keyword">virtual</span>
<a name="l00072"></a>00072 ~XSLException();
<a name="l00073"></a>00073 <span class="comment"></span>
<a name="l00074"></a>00074 <span class="comment"> /**</span>
<a name="l00075"></a>00075 <span class="comment"> * Retrieve type of exception</span>
<a name="l00076"></a>00076 <span class="comment"> * </span>
<a name="l00077"></a>00077 <span class="comment"> * @return type of exception</span>
<a name="l00078"></a>00078 <span class="comment"> */</span>
<a name="l00079"></a>00079 <span class="keyword">virtual</span> <span class="keyword">const</span> XalanDOMChar*
<a name="l00080"></a>00080 getType() <span class="keyword">const</span> = 0;
<a name="l00081"></a>00081 <span class="comment"></span>
<a name="l00082"></a>00082 <span class="comment"> /**</span>
<a name="l00083"></a>00083 <span class="comment"> * Retrieve message for exception</span>
<a name="l00084"></a>00084 <span class="comment"> * </span>
<a name="l00085"></a>00085 <span class="comment"> * @return exception message</span>
<a name="l00086"></a>00086 <span class="comment"> */</span>
<a name="l00087"></a>00087 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;
<a name="l00088"></a><a class="code" href="classXSLException.html#a9f49165e176c7b0beccf51dfed49d22b">00088</a> getMessage()<span class="keyword"> const</span>
<a name="l00089"></a>00089 <span class="keyword"> </span>{
<a name="l00090"></a>00090 <span class="keywordflow">return</span> m_message;
<a name="l00091"></a>00091 }
<a name="l00092"></a>00092 <span class="comment"></span>
<a name="l00093"></a>00093 <span class="comment"> /**</span>
<a name="l00094"></a>00094 <span class="comment"> * Get the URI for the associated document, if any</span>
<a name="l00095"></a>00095 <span class="comment"> * </span>
<a name="l00096"></a>00096 <span class="comment"> * @return The URI.</span>
<a name="l00097"></a>00097 <span class="comment"> */</span>
<a name="l00098"></a>00098 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;
<a name="l00099"></a><a class="code" href="classXSLException.html#acf438ff23ff9cdcfc1094acaade51395">00099</a> getURI()<span class="keyword"> const</span>
<a name="l00100"></a>00100 <span class="keyword"> </span>{
<a name="l00101"></a>00101 <span class="keywordflow">return</span> m_uri;
<a name="l00102"></a>00102 }
<a name="l00103"></a>00103 <span class="comment"></span>
<a name="l00104"></a>00104 <span class="comment"> /**</span>
<a name="l00105"></a>00105 <span class="comment"> * Retrieve the line number.</span>
<a name="l00106"></a>00106 <span class="comment"> * </span>
<a name="l00107"></a>00107 <span class="comment"> * @return the line number</span>
<a name="l00108"></a>00108 <span class="comment"> */</span>
<a name="l00109"></a>00109 XalanFileLoc
<a name="l00110"></a><a class="code" href="classXSLException.html#af72dc93ecd56e669e6473ae0905c1947">00110</a> getLineNumber()<span class="keyword"> const</span>
<a name="l00111"></a>00111 <span class="keyword"> </span>{
<a name="l00112"></a>00112 <span class="keywordflow">return</span> m_lineNumber;
<a name="l00113"></a>00113 }
<a name="l00114"></a>00114 <span class="comment"></span>
<a name="l00115"></a>00115 <span class="comment"> /**</span>
<a name="l00116"></a>00116 <span class="comment"> * Retrieve the column number.</span>
<a name="l00117"></a>00117 <span class="comment"> * </span>
<a name="l00118"></a>00118 <span class="comment"> * @return the column number</span>
<a name="l00119"></a>00119 <span class="comment"> */</span>
<a name="l00120"></a>00120 XalanFileLoc
<a name="l00121"></a><a class="code" href="classXSLException.html#ad5645a781f282ab199f350a5b9e81f6d">00121</a> getColumnNumber()<span class="keyword"> const</span>
<a name="l00122"></a>00122 <span class="keyword"> </span>{
<a name="l00123"></a>00123 <span class="keywordflow">return</span> m_columnNumber;
<a name="l00124"></a>00124 }
<a name="l00125"></a>00125
<a name="l00126"></a>00126 <span class="keyword">const</span> MemoryManager&amp;
<a name="l00127"></a><a class="code" href="classXSLException.html#a643b3db42028123e15e9b8ae191d10d1">00127</a> getMemoryManager()<span class="keyword"> const</span>
<a name="l00128"></a>00128 <span class="keyword"> </span>{
<a name="l00129"></a>00129 <span class="keywordflow">return</span> m_memoryManager;
<a name="l00130"></a>00130 }
<a name="l00131"></a>00131
<a name="l00132"></a>00132 MemoryManager&amp;
<a name="l00133"></a><a class="code" href="classXSLException.html#a4522178a4b773ea9a9e37bddb76c612c">00133</a> getMemoryManager()
<a name="l00134"></a>00134 {
<a name="l00135"></a>00135 <span class="keywordflow">return</span> m_memoryManager;
<a name="l00136"></a>00136 }
<a name="l00137"></a>00137
<a name="l00138"></a>00138 <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;
<a name="l00139"></a>00139 defaultFormat(<a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; theBuffer) <span class="keyword">const</span>;
<a name="l00140"></a>00140
<a name="l00141"></a>00141 <span class="keyword">static</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;
<a name="l00142"></a><a class="code" href="classXSLException.html#a080dd4a08b32aa5b8d936ee1a127be22">00142</a> defaultFormat(
<a name="l00143"></a>00143 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; theMessage,
<a name="l00144"></a>00144 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; theURI,
<a name="l00145"></a>00145 XalanFileLoc theLineNumber,
<a name="l00146"></a>00146 XalanFileLoc theColumnNumber,
<a name="l00147"></a>00147 <span class="keyword">const</span> XalanDOMChar* theType,
<a name="l00148"></a>00148 <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; theBuffer)
<a name="l00149"></a>00149 {
<a name="l00150"></a>00150 <span class="keywordflow">return</span> defaultFormat(
<a name="l00151"></a>00151 theMessage.<a class="code" href="classXalanDOMString.html#ae1c7a620d58a51ebadba66d79b1ce770">c_str</a>(),
<a name="l00152"></a>00152 theMessage.<a class="code" href="classXalanDOMString.html#a4d40ab9e7373aa46f192a3dc5db0a940">size</a>(),
<a name="l00153"></a>00153 theURI.<a class="code" href="classXalanDOMString.html#ae1c7a620d58a51ebadba66d79b1ce770">c_str</a>(),
<a name="l00154"></a>00154 theURI.<a class="code" href="classXalanDOMString.html#a4d40ab9e7373aa46f192a3dc5db0a940">size</a>(),
<a name="l00155"></a>00155 theLineNumber,
<a name="l00156"></a>00156 theColumnNumber,
<a name="l00157"></a>00157 theType,
<a name="l00158"></a>00158 <a class="code" href="classXalanDOMString.html#a6292143f4f124543c4c9d1d5f3526183">XalanDOMString::length</a>(theType),
<a name="l00159"></a>00159 theBuffer);
<a name="l00160"></a>00160 }
<a name="l00161"></a>00161
<a name="l00162"></a>00162 <span class="keyword">static</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;
<a name="l00163"></a><a class="code" href="classXSLException.html#aab6c08f9f30a7b4412c27b943ecfbced">00163</a> defaultFormat(
<a name="l00164"></a>00164 <span class="keyword">const</span> XalanDOMChar* theMessage,
<a name="l00165"></a>00165 <span class="keyword">const</span> XalanDOMChar* theURI,
<a name="l00166"></a>00166 XalanFileLoc theLineNumber,
<a name="l00167"></a>00167 XalanFileLoc theColumnNumber,
<a name="l00168"></a>00168 <span class="keyword">const</span> XalanDOMChar* theType,
<a name="l00169"></a>00169 <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; theBuffer)
<a name="l00170"></a>00170 {
<a name="l00171"></a>00171 assert(theMessage != 0);
<a name="l00172"></a>00172
<a name="l00173"></a>00173 <span class="keywordflow">return</span> defaultFormat(
<a name="l00174"></a>00174 theMessage,
<a name="l00175"></a>00175 <a class="code" href="classXalanDOMString.html#a6292143f4f124543c4c9d1d5f3526183">XalanDOMString::length</a>(theMessage),
<a name="l00176"></a>00176 theURI,
<a name="l00177"></a>00177 theURI == 0 ? 0 : <a class="code" href="classXalanDOMString.html#a6292143f4f124543c4c9d1d5f3526183">XalanDOMString::length</a>(theURI),
<a name="l00178"></a>00178 theLineNumber,
<a name="l00179"></a>00179 theColumnNumber,
<a name="l00180"></a>00180 theType,
<a name="l00181"></a>00181 theType == 0 ? 0 : <a class="code" href="classXalanDOMString.html#a6292143f4f124543c4c9d1d5f3526183">XalanDOMString::length</a>(theType),
<a name="l00182"></a>00182 theBuffer);
<a name="l00183"></a>00183 }
<a name="l00184"></a>00184
<a name="l00185"></a>00185 <span class="keyword">static</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;
<a name="l00186"></a>00186 defaultFormat(
<a name="l00187"></a>00187 <span class="keyword">const</span> XalanDOMChar* theMessage,
<a name="l00188"></a>00188 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html#ab8b91a47f3335d6c54c49029dd1074f2">XalanDOMString::size_type</a> theMessageLength,
<a name="l00189"></a>00189 <span class="keyword">const</span> XalanDOMChar* theURI,
<a name="l00190"></a>00190 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html#ab8b91a47f3335d6c54c49029dd1074f2">XalanDOMString::size_type</a> theURILength,
<a name="l00191"></a>00191 XalanFileLoc theLineNumber,
<a name="l00192"></a>00192 XalanFileLoc theColumnNumber,
<a name="l00193"></a>00193 <span class="keyword">const</span> XalanDOMChar* theType,
<a name="l00194"></a>00194 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html#ab8b91a47f3335d6c54c49029dd1074f2">XalanDOMString::size_type</a> theTypeLength,
<a name="l00195"></a>00195 <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; theBuffer);
<a name="l00196"></a>00196
<a name="l00197"></a>00197 <span class="keyword">protected</span>:
<a name="l00198"></a>00198
<a name="l00199"></a><a class="code" href="classXSLException.html#a9e83ba2fbeae5180ec4afacbafda2854">00199</a> MemoryManager&amp; m_memoryManager;
<a name="l00200"></a>00200
<a name="l00201"></a>00201 <span class="keyword">private</span>:
<a name="l00202"></a>00202
<a name="l00203"></a>00203 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a> m_message;
<a name="l00204"></a>00204 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a> m_uri;
<a name="l00205"></a>00205
<a name="l00206"></a>00206 <span class="keyword">const</span> XalanFileLoc m_lineNumber;
<a name="l00207"></a>00207 <span class="keyword">const</span> XalanFileLoc m_columnNumber;
<a name="l00208"></a>00208
<a name="l00209"></a>00209 <span class="comment">// When true, the message has already formatted.</span>
<a name="l00210"></a>00210 <span class="keyword">const</span> <span class="keywordtype">bool</span> m_formatted;
<a name="l00211"></a>00211 };
<a name="l00212"></a>00212
<a name="l00213"></a>00213
<a name="l00214"></a>00214
<a name="l00215"></a>00215 XALAN_CPP_NAMESPACE_END
<a name="l00216"></a>00216
<a name="l00217"></a>00217
<a name="l00218"></a>00218
<a name="l00219"></a>00219 <span class="preprocessor">#endif // XSLEXCEPTION_HEADER_GUARD_1357924680</span>
</pre></div></div>
</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>