blob: 03906d681a5e6d64f63ab9b50285819a1804c122 [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>ProblemListenerBase.hpp</h1> </div>
</div>
<div class="contents">
<a href="ProblemListenerBase_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(XALAN_PROBLEMLISTENERBASE_HEADER_GUARD)</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span><span class="preprocessor">#define XALAN_PROBLEMLISTENERBASE_HEADER_GUARD</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 &quot;<a class="code" href="PlatformSupportDefinitions_8hpp.html">xalanc/PlatformSupport/PlatformSupportDefinitions.hpp</a>&quot;</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 &quot;LocalMsgIndex.hpp&quot;</span>
<a name="l00029"></a>00029
<a name="l00030"></a>00030
<a name="l00031"></a>00031
<a name="l00032"></a>00032 XALAN_DECLARE_XERCES_CLASS(Locator)
<a name="l00033"></a>00033
<a name="l00034"></a>00034
<a name="l00035"></a>00035
<a name="l00036"></a>00036 XALAN_CPP_NAMESPACE_BEGIN
<a name="l00037"></a>00037
<a name="l00038"></a>00038
<a name="l00039"></a>00039
<a name="l00040"></a>00040 <a class="code" href="XSLTProcessor_8hpp.html#a24af2755e58bade5ff0d5965b855e56a">XALAN_USING_XERCES</a>(Locator)
<a name="l00041"></a>00041
<a name="l00042"></a>00042
<a name="l00043"></a>00043 class <a class="code" href="classXalanDOMString.html">XalanDOMString</a>;
<a name="l00044"></a>00044 class <a class="code" href="classXalanNode.html">XalanNode</a>;
<a name="l00045"></a>00045 class <a class="code" href="classPrintWriter.html">PrintWriter</a>;
<a name="l00046"></a>00046
<a name="l00047"></a>00047
<a name="l00048"></a>00048 <span class="comment"></span>
<a name="l00049"></a>00049 <span class="comment">/**</span>
<a name="l00050"></a>00050 <span class="comment"> * This is the abstract class that is used when reporting a problem</span>
<a name="l00051"></a>00051 <span class="comment"> * some kind, that requires a message, an error or a warning.</span>
<a name="l00052"></a>00052 <span class="comment"> */</span>
<a name="l00053"></a><a class="code" href="classProblemListenerBase.html">00053</a> class <a class="code" href="PlatformSupportDefinitions_8hpp.html#a72e8d5d428f0210697564ce111006fde">XALAN_PLATFORMSUPPORT_EXPORT</a> <a class="code" href="classProblemListenerBase.html" title="This is the abstract class that is used when reporting a problem some kind, that requires a message...">ProblemListenerBase</a>
<a name="l00054"></a>00054 {
<a name="l00055"></a>00055 <span class="keyword">public</span>:
<a name="l00056"></a>00056
<a name="l00057"></a>00057 <span class="comment">// Sources of problem. The upper case versions</span>
<a name="l00058"></a>00058 <span class="comment">// of these enums are deprecated.</span>
<a name="l00059"></a><a class="code" href="classProblemListenerBase.html#ae363b5e4919bbe4e41f6b2c1b322ee7cab51b4ed9c748477c0f9c6603aa0ccdc8">00059</a> <span class="keyword">enum</span> <a class="code" href="classProblemListenerBase.html#ae363b5e4919bbe4e41f6b2c1b322ee7c">eSource</a> { eXMLPARSER = 0,
<a name="l00060"></a><a class="code" href="classProblemListenerBase.html#ae363b5e4919bbe4e41f6b2c1b322ee7ca3b9c52ddcd4f623dc44c9d2351b6ed78">00060</a> eXMLParser = 0,
<a name="l00061"></a><a class="code" href="classProblemListenerBase.html#ae363b5e4919bbe4e41f6b2c1b322ee7ca3d1e3719336dba5ed358e2095acb2e3f">00061</a> eXSLPROCESSOR = 1,
<a name="l00062"></a><a class="code" href="classProblemListenerBase.html#ae363b5e4919bbe4e41f6b2c1b322ee7ca9d60e975b9a404d5b1871ae69512ec9f">00062</a> eXSLTProcessor = 1,
<a name="l00063"></a><a class="code" href="classProblemListenerBase.html#ae363b5e4919bbe4e41f6b2c1b322ee7caaf22b9564dfa971a422d6d3eb5b660a4">00063</a> eXPATH = 2,
<a name="l00064"></a><a class="code" href="classProblemListenerBase.html#ae363b5e4919bbe4e41f6b2c1b322ee7cacca6897eaa639be8e25619ba80bacc77">00064</a> eXPath = 2,
<a name="l00065"></a><a class="code" href="classProblemListenerBase.html#ae363b5e4919bbe4e41f6b2c1b322ee7cac250037394b9363e44e51cf306eb99f8">00065</a> eSourceCount };
<a name="l00066"></a>00066
<a name="l00067"></a>00067 <span class="comment">// A typedef for compatibility.</span>
<a name="l00068"></a><a class="code" href="classProblemListenerBase.html#a9c9513a41170d6e3c7429a14943b7350">00068</a> <span class="keyword">typedef</span> <a class="code" href="classProblemListenerBase.html#ae363b5e4919bbe4e41f6b2c1b322ee7c">eSource</a> eProblemSource;
<a name="l00069"></a>00069
<a name="l00070"></a>00070 <span class="comment">// Severity of problem. The upper case versions</span>
<a name="l00071"></a>00071 <span class="comment">// of these enums are deprecated.</span>
<a name="l00072"></a><a class="code" href="classProblemListenerBase.html#a1fec6cce6cc3429e200355330a41152aadc81c2cebfe8f1221922d2c2c73d58af">00072</a> <span class="keyword">enum</span> <a class="code" href="classProblemListenerBase.html#a1fec6cce6cc3429e200355330a41152a">eClassification</a> { eMESSAGE = 0,
<a name="l00073"></a><a class="code" href="classProblemListenerBase.html#a1fec6cce6cc3429e200355330a41152aaa6cb23c269aac0dc9918f86cfd06e28a">00073</a> eMessage = 0,
<a name="l00074"></a><a class="code" href="classProblemListenerBase.html#a1fec6cce6cc3429e200355330a41152aa2e1a03f92eb740af6bc96fdeb9441fd5">00074</a> eWARNING = 1,
<a name="l00075"></a><a class="code" href="classProblemListenerBase.html#a1fec6cce6cc3429e200355330a41152aa1490bace488e75b3dd3b07d5b18b62af">00075</a> eWarning = 1,
<a name="l00076"></a><a class="code" href="classProblemListenerBase.html#a1fec6cce6cc3429e200355330a41152aada459fe7ccc4495ad264d7fd44e81b4f">00076</a> eERROR = 2,
<a name="l00077"></a><a class="code" href="classProblemListenerBase.html#a1fec6cce6cc3429e200355330a41152aaed0365bf84cd1b79718370e12c5228a9">00077</a> eError = 2,
<a name="l00078"></a><a class="code" href="classProblemListenerBase.html#a1fec6cce6cc3429e200355330a41152aac591e1423d63f089a4cbb114ca2c8e7a">00078</a> eClassificationCount };
<a name="l00079"></a>00079
<a name="l00080"></a>00080 ProblemListenerBase();
<a name="l00081"></a>00081
<a name="l00082"></a>00082 <span class="keyword">virtual</span>
<a name="l00083"></a>00083 ~ProblemListenerBase();
<a name="l00084"></a>00084 <span class="comment"></span>
<a name="l00085"></a>00085 <span class="comment"> /**</span>
<a name="l00086"></a>00086 <span class="comment"> * Function that is called when a problem event occurs.</span>
<a name="l00087"></a>00087 <span class="comment"> *</span>
<a name="l00088"></a>00088 <span class="comment"> * @param source Either eXMLParser, eXSLProcessor, or eXPATH.</span>
<a name="l00089"></a>00089 <span class="comment"> * @param classification Either eMessage, eWarning, or eError.</span>
<a name="l00090"></a>00090 <span class="comment"> * @param locator The current Locator instance for the stylesheet. Maybe be a null pointer.</span>
<a name="l00091"></a>00091 <span class="comment"> * @param sourceNode The current source node, if any.</span>
<a name="l00092"></a>00092 <span class="comment"> * @param msg The error message.</span>
<a name="l00093"></a>00093 <span class="comment"> */</span>
<a name="l00094"></a>00094 <span class="keyword">virtual</span> <span class="keywordtype">void</span>
<a name="l00095"></a>00095 problem(
<a name="l00096"></a>00096 eSource source,
<a name="l00097"></a>00097 eClassification classification,
<a name="l00098"></a>00098 <span class="keyword">const</span> XalanDOMString&amp; msg,
<a name="l00099"></a>00099 <span class="keyword">const</span> Locator* locator,
<a name="l00100"></a>00100 <span class="keyword">const</span> XalanNode* sourceNode) = 0;
<a name="l00101"></a>00101 <span class="comment"></span>
<a name="l00102"></a>00102 <span class="comment"> /**</span>
<a name="l00103"></a>00103 <span class="comment"> * Function that is called when a problem event occurs. This version</span>
<a name="l00104"></a>00104 <span class="comment"> * assumes location information is already formatted into the message.</span>
<a name="l00105"></a>00105 <span class="comment"> * </span>
<a name="l00106"></a>00106 <span class="comment"> * @param source either eXMLPARSER, eXSLPROCESSOR, or eXPATH</span>
<a name="l00107"></a>00107 <span class="comment"> * @param classification either eMESSAGE, eERROR or eWARNING</span>
<a name="l00108"></a>00108 <span class="comment"> * @param msg string message explaining the problem.</span>
<a name="l00109"></a>00109 <span class="comment"> */</span>
<a name="l00110"></a>00110 <span class="keyword">virtual</span> <span class="keywordtype">void</span>
<a name="l00111"></a>00111 problem(
<a name="l00112"></a>00112 eSource source,
<a name="l00113"></a>00113 eClassification classification,
<a name="l00114"></a>00114 <span class="keyword">const</span> XalanDOMString&amp; msg,
<a name="l00115"></a>00115 <span class="keyword">const</span> XalanNode* sourceNode) = 0;
<a name="l00116"></a>00116 <span class="comment"></span>
<a name="l00117"></a>00117 <span class="comment"> /**</span>
<a name="l00118"></a>00118 <span class="comment"> * Function to format a problem call to a PrintWriter instance.</span>
<a name="l00119"></a>00119 <span class="comment"> * This is a bare-bones implementation that uses localized strings.</span>
<a name="l00120"></a>00120 <span class="comment"> *</span>
<a name="l00121"></a>00121 <span class="comment"> * @param pw The PrintWriter instance to use.</span>
<a name="l00122"></a>00122 <span class="comment"> * @param source Either eXMLParser, eXSLProcessor, or eXPATH.</span>
<a name="l00123"></a>00123 <span class="comment"> * @param classification Either eMessage, eWarning, or eError.</span>
<a name="l00124"></a>00124 <span class="comment"> * @param locator The current Locator instance for the stylesheet. Maybe be a null pointer.</span>
<a name="l00125"></a>00125 <span class="comment"> * @param sourceNode The current source node, if any.</span>
<a name="l00126"></a>00126 <span class="comment"> * @param msg The error message.</span>
<a name="l00127"></a>00127 <span class="comment"> */</span>
<a name="l00128"></a>00128 <span class="keyword">static</span> <span class="keywordtype">void</span>
<a name="l00129"></a>00129 defaultFormat(
<a name="l00130"></a>00130 PrintWriter&amp; pw,
<a name="l00131"></a>00131 eSource source,
<a name="l00132"></a>00132 eClassification classification,
<a name="l00133"></a>00133 <span class="keyword">const</span> XalanDOMString&amp; msg,
<a name="l00134"></a>00134 <span class="keyword">const</span> Locator* locator,
<a name="l00135"></a>00135 <span class="keyword">const</span> XalanNode* sourceNode);
<a name="l00136"></a>00136 <span class="comment"></span>
<a name="l00137"></a>00137 <span class="comment"> /**</span>
<a name="l00138"></a>00138 <span class="comment"> * Function to format a problem call to a PrintWriter instance.</span>
<a name="l00139"></a>00139 <span class="comment"> * This is a bare-bones implementation that uses localized strings.</span>
<a name="l00140"></a>00140 <span class="comment"> *</span>
<a name="l00141"></a>00141 <span class="comment"> * @param pw The PrintWriter instance to use.</span>
<a name="l00142"></a>00142 <span class="comment"> * @param source either eXMLPARSER, eXSLPROCESSOR, or eXPATH</span>
<a name="l00143"></a>00143 <span class="comment"> * @param classification either eMESSAGE, eERROR or eWARNING</span>
<a name="l00144"></a>00144 <span class="comment"> * @param msg string message explaining the problem.</span>
<a name="l00145"></a>00145 <span class="comment"> */</span>
<a name="l00146"></a>00146 <span class="keyword">static</span> <span class="keywordtype">void</span>
<a name="l00147"></a>00147 defaultFormat(
<a name="l00148"></a>00148 PrintWriter&amp; pw,
<a name="l00149"></a>00149 eSource source,
<a name="l00150"></a>00150 eClassification classification,
<a name="l00151"></a>00151 <span class="keyword">const</span> XalanDOMString&amp; msg,
<a name="l00152"></a>00152 <span class="keyword">const</span> XalanNode* sourceNode);
<a name="l00153"></a>00153
<a name="l00154"></a>00154 <span class="keyword">protected</span>:
<a name="l00155"></a>00155
<a name="l00156"></a><a class="code" href="classProblemListenerBase.html#aae8a30e6ccef0a1be3c80df08e8d510e">00156</a> <span class="keyword">static</span> <span class="keyword">const</span> XalanMessages::Codes s_messageCodes[eSourceCount][eClassificationCount];
<a name="l00157"></a>00157 };
<a name="l00158"></a>00158
<a name="l00159"></a>00159
<a name="l00160"></a>00160
<a name="l00161"></a>00161 XALAN_CPP_NAMESPACE_END
<a name="l00162"></a>00162
<a name="l00163"></a>00163
<a name="l00164"></a>00164
<a name="l00165"></a>00165 <span class="preprocessor">#endif // XALAN_PROBLEMLISTENER_HEADER_GUARD</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>