| <!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 Page</span></a></li> |
| <li><a href="pages.html"><span>Related 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 List</span></a></li> |
| <li><a href="globals.html"><span>File Members</span></a></li> |
| </ul> |
| </div> |
| <div class="header"> |
| <div class="headertitle"> |
| <h1>XalanXMLFileReporter.hpp</h1> </div> |
| </div> |
| <div class="contents"> |
| <a href="XalanXMLFileReporter_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 "License");</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 "AS IS" 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(HARNESS_HEADER_GUARD_1357924680)</span> |
| <a name="l00019"></a>00019 <span class="preprocessor"></span><span class="preprocessor">#define HARNESS_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="preprocessor">#include "<a class="code" href="XalanHarnessDefinitions_8hpp.html">xalanc/Harness/XalanHarnessDefinitions.hpp</a>"</span> |
| <a name="l00024"></a>00024 |
| <a name="l00025"></a>00025 |
| <a name="l00026"></a>00026 |
| <a name="l00027"></a>00027 <span class="preprocessor">#include <cstdio></span> |
| <a name="l00028"></a>00028 |
| <a name="l00029"></a>00029 |
| <a name="l00030"></a>00030 |
| <a name="l00031"></a>00031 <span class="preprocessor">#include "<a class="code" href="XalanDOMString_8hpp.html">xalanc/XalanDOM/XalanDOMString.hpp</a>"</span> |
| <a name="l00032"></a>00032 |
| <a name="l00033"></a>00033 |
| <a name="l00034"></a>00034 |
| <a name="l00035"></a>00035 <span class="preprocessor">#include "<a class="code" href="XalanAutoPtr_8hpp.html">xalanc/Include/XalanAutoPtr.hpp</a>"</span> |
| <a name="l00036"></a>00036 <span class="preprocessor">#include "<a class="code" href="XalanMap_8hpp.html">xalanc/Include/XalanMap.hpp</a>"</span> |
| <a name="l00037"></a>00037 <span class="preprocessor">#include "<a class="code" href="XalanVector_8hpp.html">xalanc/Include/XalanVector.hpp</a>"</span> |
| <a name="l00038"></a>00038 |
| <a name="l00039"></a>00039 |
| <a name="l00040"></a>00040 |
| <a name="l00041"></a>00041 <span class="preprocessor">#include "<a class="code" href="DOMStringHelper_8hpp.html">xalanc/PlatformSupport/DOMStringHelper.hpp</a>"</span> |
| <a name="l00042"></a>00042 |
| <a name="l00043"></a>00043 |
| <a name="l00044"></a>00044 |
| <a name="l00045"></a>00045 XALAN_CPP_NAMESPACE_BEGIN |
| <a name="l00046"></a>00046 |
| <a name="l00047"></a>00047 |
| <a name="l00048"></a>00048 |
| <a name="l00049"></a>00049 <span class="keyword">class </span><a class="code" href="classXalanOutputTranscoder.html">XalanOutputTranscoder</a>; |
| <a name="l00050"></a>00050 |
| <a name="l00051"></a><a class="code" href="classXalanXMLFileReporter.html">00051</a> <span class="keyword">class </span><a class="code" href="XalanHarnessDefinitions_8hpp.html#a94b67e1ba25a3117ad9864017ff1ac96">XALAN_HARNESS_EXPORT</a> <a class="code" href="classXalanXMLFileReporter.html">XalanXMLFileReporter</a> |
| <a name="l00052"></a>00052 { |
| <a name="l00053"></a>00053 |
| <a name="l00054"></a>00054 <span class="keyword">public</span>: |
| <a name="l00055"></a>00055 |
| <a name="l00056"></a><a class="code" href="classXalanXMLFileReporter.html#acbdd62902a23f0a0435301a07062f0e3">00056</a> <span class="keyword">typedef</span> <a class="code" href="classXalanMap.html">XalanMap<XalanDOMString, XalanDOMString></a> <a class="code" href="classXalanMap.html">Hashtable</a>; |
| <a name="l00057"></a>00057 |
| <a name="l00058"></a>00058 <span class="preprocessor">#if defined(XALAN_STRICT_ANSI_HEADERS)</span> |
| <a name="l00059"></a>00059 <span class="preprocessor"></span> <span class="keyword">typedef</span> std::FILE FileHandleType; |
| <a name="l00060"></a>00060 <span class="preprocessor">#else</span> |
| <a name="l00061"></a><a class="code" href="classXalanXMLFileReporter.html#a6f8d9015b8faa7ac2cdcdcbfdb0d91bb">00061</a> <span class="preprocessor"></span> <span class="keyword">typedef</span> FILE FileHandleType; |
| <a name="l00062"></a>00062 <span class="preprocessor">#endif</span> |
| <a name="l00063"></a>00063 <span class="preprocessor"></span> |
| <a name="l00064"></a>00064 <span class="keyword">public</span>: |
| <a name="l00065"></a>00065 |
| <a name="l00066"></a>00066 |
| <a name="l00067"></a>00067 <span class="comment">// Construct and initialize this reporter with specified filename, if</span> |
| <a name="l00068"></a>00068 <span class="comment">// the filename is not empty.</span> |
| <a name="l00069"></a>00069 <a class="code" href="classXalanXMLFileReporter.html">XalanXMLFileReporter</a>(MemoryManager& theManager, <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& fileName); |
| <a name="l00070"></a>00070 |
| <a name="l00071"></a>00071 ~<a class="code" href="classXalanXMLFileReporter.html">XalanXMLFileReporter</a>(); |
| <a name="l00072"></a>00072 |
| <a name="l00073"></a>00073 <span class="comment">// Initialize this XalanXMLFileReporter. Must be called before attempting to log anything.</span> |
| <a name="l00074"></a>00074 <span class="keywordtype">bool</span> initialize(MemoryManager& theManager); |
| <a name="l00075"></a>00075 |
| <a name="l00076"></a>00076 MemoryManager& |
| <a name="l00077"></a><a class="code" href="classXalanXMLFileReporter.html#ad4c8a1d501adb9a1544f189d25b02db2">00077</a> getMemoryManager() |
| <a name="l00078"></a>00078 { |
| <a name="l00079"></a>00079 <span class="keywordflow">return</span> m_fileName.getMemoryManager(); |
| <a name="l00080"></a>00080 } |
| <a name="l00081"></a>00081 |
| <a name="l00082"></a>00082 <span class="comment">// Accessor for flushing; is set from properties.</span> |
| <a name="l00083"></a>00083 <span class="keywordtype">bool</span> getFlushOnCaseClose(); |
| <a name="l00084"></a>00084 |
| <a name="l00085"></a>00085 <span class="comment">// Accessor methods for our properties block.</span> |
| <a name="l00086"></a>00086 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& getFileName() <span class="keyword">const</span>; |
| <a name="l00087"></a>00087 |
| <a name="l00088"></a>00088 <span class="comment">// Accessor methods for our properties block.</span> |
| <a name="l00089"></a>00089 <span class="keywordtype">void</span> setFileName(<span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& fileName); |
| <a name="l00090"></a>00090 |
| <a name="l00091"></a>00091 <span class="comment">// Accessor methods for our properties block.</span> |
| <a name="l00092"></a><a class="code" href="classXalanXMLFileReporter.html#addc754e9818ee02438cc00f3d2770577">00092</a> <span class="keywordtype">void</span> setFileName(<span class="keyword">const</span> <span class="keywordtype">char</span>* fileName, MemoryManager& theManager) |
| <a name="l00093"></a>00093 { |
| <a name="l00094"></a>00094 setFileName(<a class="code" href="classXalanDOMString.html">XalanDOMString</a>(fileName, theManager)); |
| <a name="l00095"></a>00095 } |
| <a name="l00096"></a>00096 |
| <a name="l00097"></a>00097 <span class="comment">//</span> |
| <a name="l00098"></a>00098 <span class="comment">// Is this Reporter still running OK? </span> |
| <a name="l00099"></a>00099 <span class="comment">// @returns status - true if an error has occoured, false if it's still working fine</span> |
| <a name="l00100"></a>00100 <span class="keywordtype">bool</span> checkError(); |
| <a name="l00101"></a>00101 |
| <a name="l00102"></a>00102 |
| <a name="l00103"></a>00103 <span class="comment">//</span> |
| <a name="l00104"></a>00104 <span class="comment">// Is this Reporter ready to log results? </span> |
| <a name="l00105"></a>00105 <span class="comment">// @returns status - true if it's ready to report, false otherwise</span> |
| <a name="l00106"></a>00106 <span class="keywordtype">bool</span> isReady(); |
| <a name="l00107"></a>00107 |
| <a name="l00108"></a>00108 <span class="comment">// Flush this reporter - ensure our File is flushed.</span> |
| <a name="l00109"></a>00109 <span class="keywordtype">void</span> flush(); |
| <a name="l00110"></a>00110 |
| <a name="l00111"></a>00111 |
| <a name="l00112"></a>00112 <span class="comment">// Close this reporter - ensure our File, etc. are closed.</span> |
| <a name="l00113"></a>00113 <span class="keywordtype">void</span> close(); |
| <a name="l00114"></a>00114 |
| <a name="l00115"></a>00115 <span class="comment">//-----------------------------------------------------</span> |
| <a name="l00116"></a>00116 <span class="comment">//-------- Testfile / Testcase start and stop routines --------</span> |
| <a name="l00117"></a>00117 <span class="comment">//-----------------------------------------------------</span> |
| <a name="l00118"></a>00118 <span class="comment"></span> |
| <a name="l00119"></a>00119 <span class="comment"> /**</span> |
| <a name="l00120"></a>00120 <span class="comment"> * Report that a testfile has started. </span> |
| <a name="l00121"></a>00121 <span class="comment"> * @param msg message to log out</span> |
| <a name="l00122"></a>00122 <span class="comment"> */</span> |
| <a name="l00123"></a>00123 <span class="keywordtype">void</span> logTestFileInit(<span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& msg); |
| <a name="l00124"></a>00124 |
| <a name="l00125"></a><a class="code" href="classXalanXMLFileReporter.html#ab02a1259091e643880c4423828b11458">00125</a> <span class="keywordtype">void</span> logTestFileInit(<span class="keyword">const</span> <span class="keywordtype">char</span>* msg) |
| <a name="l00126"></a>00126 { |
| <a name="l00127"></a>00127 logTestFileInit(<a class="code" href="classXalanDOMString.html">XalanDOMString</a>(msg, getMemoryManager())); |
| <a name="l00128"></a>00128 } |
| <a name="l00129"></a>00129 <span class="comment"></span> |
| <a name="l00130"></a>00130 <span class="comment"> /**</span> |
| <a name="l00131"></a>00131 <span class="comment"> * Report that a testfile has finished, and report it's result. </span> |
| <a name="l00132"></a>00132 <span class="comment"> * @param msg message to log out</span> |
| <a name="l00133"></a>00133 <span class="comment"> * @param result result of testfile</span> |
| <a name="l00134"></a>00134 <span class="comment"> */</span> |
| <a name="l00135"></a>00135 <span class="keywordtype">void</span> logTestFileClose(<span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& msg, <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& result); |
| <a name="l00136"></a>00136 |
| <a name="l00137"></a><a class="code" href="classXalanXMLFileReporter.html#abf8afba746aefd5374bd93ffbb75a34f">00137</a> <span class="keywordtype">void</span> logTestFileClose(<span class="keyword">const</span> <span class="keywordtype">char</span>* msg, <span class="keyword">const</span> <span class="keywordtype">char</span>* result) |
| <a name="l00138"></a>00138 { |
| <a name="l00139"></a>00139 logTestFileClose(<a class="code" href="classXalanDOMString.html">XalanDOMString</a>(msg, getMemoryManager()), <a class="code" href="classXalanDOMString.html">XalanDOMString</a>(result, getMemoryManager())); |
| <a name="l00140"></a>00140 } |
| <a name="l00141"></a>00141 |
| <a name="l00142"></a>00142 <span class="keywordtype">void</span> logTestCaseInit(<span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& msg); |
| <a name="l00143"></a>00143 |
| <a name="l00144"></a><a class="code" href="classXalanXMLFileReporter.html#a8e324608c2e1c3bb54b4f5b0c34b504f">00144</a> <span class="keywordtype">void</span> logTestCaseInit(<span class="keyword">const</span> <span class="keywordtype">char</span>* msg) |
| <a name="l00145"></a>00145 { |
| <a name="l00146"></a>00146 logTestCaseInit(<a class="code" href="classXalanDOMString.html">XalanDOMString</a>(msg, getMemoryManager())); |
| <a name="l00147"></a>00147 } |
| <a name="l00148"></a>00148 <span class="comment"></span> |
| <a name="l00149"></a>00149 <span class="comment"> /**</span> |
| <a name="l00150"></a>00150 <span class="comment"> * Report that a testcase has finished, and report it's result. </span> |
| <a name="l00151"></a>00151 <span class="comment"> * @param msg message to log out</span> |
| <a name="l00152"></a>00152 <span class="comment"> * @param result result of testfile</span> |
| <a name="l00153"></a>00153 <span class="comment"> */</span> |
| <a name="l00154"></a>00154 <span class="keywordtype">void</span> logTestCaseClose(<span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& msg, <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& result); |
| <a name="l00155"></a>00155 |
| <a name="l00156"></a><a class="code" href="classXalanXMLFileReporter.html#ad788b50d7deb4e76005e1af51c26bed2">00156</a> <span class="keywordtype">void</span> logTestCaseClose(<span class="keyword">const</span> <span class="keywordtype">char</span>* msg, <span class="keyword">const</span> <span class="keywordtype">char</span>* result) |
| <a name="l00157"></a>00157 { |
| <a name="l00158"></a>00158 logTestCaseClose(<a class="code" href="classXalanDOMString.html">XalanDOMString</a>(msg , getMemoryManager()), <a class="code" href="classXalanDOMString.html">XalanDOMString</a>(result , getMemoryManager())); |
| <a name="l00159"></a>00159 } |
| <a name="l00160"></a>00160 <span class="comment">//-----------------------------------------------------</span> |
| <a name="l00161"></a>00161 <span class="comment">//-------- Test results reporting and logging routines --------</span> |
| <a name="l00162"></a>00162 <span class="comment">//-----------------------------------------------------</span> |
| <a name="l00163"></a>00163 |
| <a name="l00164"></a>00164 <span class="comment"></span> |
| <a name="l00165"></a>00165 <span class="comment"> /**</span> |
| <a name="l00166"></a>00166 <span class="comment"> * Report a comment to result file with specified severity. </span> |
| <a name="l00167"></a>00167 <span class="comment"> * <P>Record format: &lt;message level="##"&gt;msg&lt;/message&gt;</P></span> |
| <a name="l00168"></a>00168 <span class="comment"> * @param level severity or class of message.</span> |
| <a name="l00169"></a>00169 <span class="comment"> * @param msg comment to log out.</span> |
| <a name="l00170"></a>00170 <span class="comment"> */</span> |
| <a name="l00171"></a>00171 <span class="keywordtype">void</span> logMessage(<span class="keywordtype">int</span> level, <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& msg); |
| <a name="l00172"></a>00172 <span class="comment"></span> |
| <a name="l00173"></a>00173 <span class="comment"> /**</span> |
| <a name="l00174"></a>00174 <span class="comment"> * Logs out statistics to result file with specified severity. </span> |
| <a name="l00175"></a>00175 <span class="comment"> * <P>Record format: &lt;statistic level="##" desc="msg"&gt;&lt;longval&gt;1234&lt;/longval&gt;&lt;doubleval&gt;1.234&lt;/doubleval&gt;&lt;/statistic&gt;</P></span> |
| <a name="l00176"></a>00176 <span class="comment"> * @param level severity of message.</span> |
| <a name="l00177"></a>00177 <span class="comment"> * @param lVal statistic in long format.</span> |
| <a name="l00178"></a>00178 <span class="comment"> * @param dVal statistic in double format.</span> |
| <a name="l00179"></a>00179 <span class="comment"> * @param msg comment to log out.</span> |
| <a name="l00180"></a>00180 <span class="comment"> */</span> |
| <a name="l00181"></a>00181 <span class="keywordtype">void</span> logStatistic (<span class="keywordtype">int</span> level, <span class="keywordtype">long</span> lVal, <span class="keywordtype">double</span> dVal, <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& msg); |
| <a name="l00182"></a>00182 |
| <a name="l00183"></a><a class="code" href="classXalanXMLFileReporter.html#a2b4e4a67dafaad4793883b80c512e715">00183</a> <span class="keywordtype">void</span> logStatistic (<span class="keywordtype">int</span> level, <span class="keywordtype">long</span> lVal, <span class="keywordtype">double</span> dVal, <span class="keyword">const</span> <span class="keywordtype">char</span>* msg) |
| <a name="l00184"></a>00184 { |
| <a name="l00185"></a>00185 logStatistic(level, lVal, dVal, <a class="code" href="classXalanDOMString.html">XalanDOMString</a>(msg, getMemoryManager())); |
| <a name="l00186"></a>00186 } |
| <a name="l00187"></a>00187 |
| <a name="l00188"></a>00188 <span class="comment">// This routine will add an attribute to the attribute list.</span> |
| <a name="l00189"></a>00189 <span class="keywordtype">void</span> addMetricToAttrs(<span class="keyword">const</span> <span class="keywordtype">char</span>* desc, <span class="keywordtype">double</span> theMetric, Hashtable& attrs); |
| <a name="l00190"></a>00190 <span class="comment"></span> |
| <a name="l00191"></a>00191 <span class="comment"> /**</span> |
| <a name="l00192"></a>00192 <span class="comment"> * Logs out a element to results with specified severity.</span> |
| <a name="l00193"></a>00193 <span class="comment"> * Uses user-supplied element name and attribute list. Currently</span> |
| <a name="l00194"></a>00194 <span class="comment"> * attribute values and msg are forced .toString(). Also,</span> |
| <a name="l00195"></a>00195 <span class="comment"> * 'level' is forced to be the first attribute of the element.</span> |
| <a name="l00196"></a>00196 <span class="comment"> * @param level severity of message.</span> |
| <a name="l00197"></a>00197 <span class="comment"> * @param element name of enclosing element</span> |
| <a name="l00198"></a>00198 <span class="comment"> * @param attrs hash of name=value attributes; note that the</span> |
| <a name="l00199"></a>00199 <span class="comment"> * caller must ensure they're legal XML</span> |
| <a name="l00200"></a>00200 <span class="comment"> * @param msg comment to log out.</span> |
| <a name="l00201"></a>00201 <span class="comment"> */</span> |
| <a name="l00202"></a>00202 <span class="keywordtype">void</span> logElementWAttrs(<span class="keywordtype">int</span> level, <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& element, Hashtable& attrs, <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& msg); |
| <a name="l00203"></a>00203 |
| <a name="l00204"></a><a class="code" href="classXalanXMLFileReporter.html#af91577c4b840f4662a0754c574d54154">00204</a> <span class="keywordtype">void</span> logElementWAttrs(<span class="keywordtype">int</span> level, <span class="keyword">const</span> <span class="keywordtype">char</span>* element, <a class="code" href="classXalanMap.html">Hashtable</a>& attrs, <span class="keyword">const</span> <span class="keywordtype">char</span>* msg) |
| <a name="l00205"></a>00205 { |
| <a name="l00206"></a>00206 logElementWAttrs(level, <a class="code" href="classXalanDOMString.html">XalanDOMString</a>(element, getMemoryManager()), attrs, <a class="code" href="classXalanDOMString.html">XalanDOMString</a>(msg, getMemoryManager())); |
| <a name="l00207"></a>00207 } |
| <a name="l00208"></a>00208 |
| <a name="l00209"></a>00209 <span class="keywordtype">void</span> logElement(<span class="keywordtype">int</span> level, <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& element, <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& msg); |
| <a name="l00210"></a>00210 |
| <a name="l00211"></a>00211 <span class="keywordtype">void</span> logElement(<span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& element, <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& msg);<span class="comment"></span> |
| <a name="l00212"></a>00212 <span class="comment"> /**</span> |
| <a name="l00213"></a>00213 <span class="comment"> * Report an arbitrary XalanDOMString to result file with specified severity. </span> |
| <a name="l00214"></a>00214 <span class="comment"> * <P>Appends and prepends \\n newline characters at the start and </span> |
| <a name="l00215"></a>00215 <span class="comment"> * end of the message to separate it from the tags.</P></span> |
| <a name="l00216"></a>00216 <span class="comment"> * <P>Record format: &lt;arbitrary level="##"&gt;<BR/></span> |
| <a name="l00217"></a>00217 <span class="comment"> * msg<BR/></span> |
| <a name="l00218"></a>00218 <span class="comment"> * &lt;/arbitrary&gt;</span> |
| <a name="l00219"></a>00219 <span class="comment"> * </P></span> |
| <a name="l00220"></a>00220 <span class="comment"> * @param level severity or class of message.</span> |
| <a name="l00221"></a>00221 <span class="comment"> * @param msg arbitrary XalanDOMString to log out.</span> |
| <a name="l00222"></a>00222 <span class="comment"> */</span> |
| <a name="l00223"></a>00223 <span class="keywordtype">void</span> logArbitraryMessage (<span class="keywordtype">int</span> level, <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& msg); |
| <a name="l00224"></a>00224 <span class="comment"></span> |
| <a name="l00225"></a>00225 <span class="comment"> /**</span> |
| <a name="l00226"></a>00226 <span class="comment"> * Report a complete Hashtable to result file with specified severity. </span> |
| <a name="l00227"></a>00227 <span class="comment"> * <P>Indents each hashitem within the table.</P></span> |
| <a name="l00228"></a>00228 <span class="comment"> * <P>Record format: &lt;hashtable level="##" desc="msg"/&gt;<BR/></span> |
| <a name="l00229"></a>00229 <span class="comment"> * &nbsp;&nbsp;&lt;hashitem key="key1"&gt;value1&lt;/hashitem&gt;<BR/></span> |
| <a name="l00230"></a>00230 <span class="comment"> * &nbsp;&nbsp;&lt;hashitem key="key2"&gt;value2&lt;/hashitem&gt;<BR/></span> |
| <a name="l00231"></a>00231 <span class="comment"> * &lt;/hashtable&gt;</span> |
| <a name="l00232"></a>00232 <span class="comment"> * </P></span> |
| <a name="l00233"></a>00233 <span class="comment"> * @param level severity or class of message.</span> |
| <a name="l00234"></a>00234 <span class="comment"> * @param hash Hashtable to log the contents of. </span> |
| <a name="l00235"></a>00235 <span class="comment"> * @param msg decription of the Hashtable.</span> |
| <a name="l00236"></a>00236 <span class="comment"> */</span> |
| <a name="l00237"></a>00237 <span class="comment">/*</span> |
| <a name="l00238"></a>00238 <span class="comment"> void logHashtable (int level, Hashtable hash, const XalanDOMString& msg);</span> |
| <a name="l00239"></a>00239 <span class="comment"> */</span> |
| <a name="l00240"></a>00240 <span class="comment"></span> |
| <a name="l00241"></a>00241 <span class="comment"> /**</span> |
| <a name="l00242"></a>00242 <span class="comment"> * Writes out a Pass record with comment. </span> |
| <a name="l00243"></a>00243 <span class="comment"> * <P>Record format: &lt;checkresult result="PASS" desc="comment"/&gt;</P></span> |
| <a name="l00244"></a>00244 <span class="comment"> * @param comment comment to log with the pass record.</span> |
| <a name="l00245"></a>00245 <span class="comment"> */</span> |
| <a name="l00246"></a>00246 <span class="keywordtype">void</span> logCheckPass(<span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& comment); |
| <a name="l00247"></a>00247 <span class="comment"></span> |
| <a name="l00248"></a>00248 <span class="comment"> /**</span> |
| <a name="l00249"></a>00249 <span class="comment"> * Writes out an ambiguous record with comment. </span> |
| <a name="l00250"></a>00250 <span class="comment"> * <P>Record format: &lt;checkresult result="AMBG" desc="comment"/&gt;</P></span> |
| <a name="l00251"></a>00251 <span class="comment"> * @param comment comment to log with the ambg record.</span> |
| <a name="l00252"></a>00252 <span class="comment"> */</span> |
| <a name="l00253"></a>00253 <span class="keywordtype">void</span> logCheckAmbiguous(<span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& comment); |
| <a name="l00254"></a>00254 <span class="comment"></span> |
| <a name="l00255"></a>00255 <span class="comment"> /**</span> |
| <a name="l00256"></a>00256 <span class="comment"> * Writes out a Fail record with comment. </span> |
| <a name="l00257"></a>00257 <span class="comment"> * <P>Record format: &lt;checkresult result="FAIL" desc="comment"/&gt;</P></span> |
| <a name="l00258"></a>00258 <span class="comment"> * @param comment comment to log with the fail record.</span> |
| <a name="l00259"></a>00259 <span class="comment"> */</span> |
| <a name="l00260"></a>00260 <span class="keywordtype">void</span> logCheckFail(<span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& comment); |
| <a name="l00261"></a>00261 |
| <a name="l00262"></a>00262 <span class="keywordtype">void</span> logCheckFail(<span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& test, <span class="keyword">const</span> Hashtable& faildata, <span class="keyword">const</span> Hashtable& actexp); |
| <a name="l00263"></a>00263 |
| <a name="l00264"></a>00264 <span class="keywordtype">void</span> logCheckFail(<span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& test, <span class="keyword">const</span> Hashtable& actexp); |
| <a name="l00265"></a>00265 |
| <a name="l00266"></a>00266 <span class="keywordtype">void</span> logErrorResult(<span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& test, <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& reason); |
| <a name="l00267"></a>00267 <span class="comment"></span> |
| <a name="l00268"></a>00268 <span class="comment"> /**</span> |
| <a name="l00269"></a>00269 <span class="comment"> * Writes out a Error record with comment. </span> |
| <a name="l00270"></a>00270 <span class="comment"> * <P>Record format: &lt;checkresult result="ERRR" desc="comment"/&gt;</P></span> |
| <a name="l00271"></a>00271 <span class="comment"> * @param comment comment to log with the error record.</span> |
| <a name="l00272"></a>00272 <span class="comment"> */</span> |
| <a name="l00273"></a>00273 <span class="keywordtype">void</span> logCheckErr(<span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& comment); |
| <a name="l00274"></a>00274 <span class="comment"></span> |
| <a name="l00275"></a>00275 <span class="comment"> /**</span> |
| <a name="l00276"></a>00276 <span class="comment"> * Escapes a XalanDOMString to remove <, >, ', &, and " so it's valid XML. </span> |
| <a name="l00277"></a>00277 <span class="comment"> * <P>Stolen mostly from Xalan applet sample.</P></span> |
| <a name="l00278"></a>00278 <span class="comment"> * @param s XalanDOMString to escape.</span> |
| <a name="l00279"></a>00279 <span class="comment"> * @return XalanDOMString that has been escaped.</span> |
| <a name="l00280"></a>00280 <span class="comment"> */</span> |
| <a name="l00281"></a>00281 <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& escapestring(<span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& s, <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& buffer); |
| <a name="l00282"></a>00282 |
| <a name="l00283"></a>00283 |
| <a name="l00284"></a>00284 <span class="keyword">private</span>: |
| <a name="l00285"></a>00285 <span class="comment">// not implemented</span> |
| <a name="l00286"></a>00286 <a class="code" href="classXalanXMLFileReporter.html">XalanXMLFileReporter</a>(<span class="keyword">const</span> <a class="code" href="classXalanXMLFileReporter.html">XalanXMLFileReporter</a>&);<span class="comment"></span> |
| <a name="l00287"></a>00287 <span class="comment"> /**</span> |
| <a name="l00288"></a>00288 <span class="comment"> * worker method to dump the xml header and open the resultsfile element. </span> |
| <a name="l00289"></a>00289 <span class="comment"> */</span> |
| <a name="l00290"></a>00290 <span class="keywordtype">bool</span> startResultsFile(); |
| <a name="l00291"></a>00291 <span class="comment"></span> |
| <a name="l00292"></a>00292 <span class="comment"> /**</span> |
| <a name="l00293"></a>00293 <span class="comment"> * worker method to close the resultsfile element. </span> |
| <a name="l00294"></a>00294 <span class="comment"> */</span> |
| <a name="l00295"></a>00295 <span class="keywordtype">bool</span> closeResultsFile(); |
| <a name="l00296"></a>00296 <span class="comment"></span> |
| <a name="l00297"></a>00297 <span class="comment"> /**</span> |
| <a name="l00298"></a>00298 <span class="comment"> * worker method to prints to the resultsfile. </span> |
| <a name="l00299"></a>00299 <span class="comment"> */</span> |
| <a name="l00300"></a>00300 <span class="keywordtype">bool</span> printToFile(<span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& output); |
| <a name="l00301"></a>00301 |
| <a name="l00302"></a>00302 <span class="keywordtype">void</span> |
| <a name="l00303"></a>00303 initStrings(); |
| <a name="l00304"></a>00304 <span class="comment"></span> |
| <a name="l00305"></a>00305 <span class="comment"> /**</span> |
| <a name="l00306"></a>00306 <span class="comment"> * worker method to prints to the resultsfile. </span> |
| <a name="l00307"></a>00307 <span class="comment"> */</span> |
| <a name="l00308"></a>00308 <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& |
| <a name="l00309"></a>00309 getDateTimeString(<a class="code" href="classXalanDOMString.html">XalanDOMString</a>& result); |
| <a name="l00310"></a>00310 <span class="comment"></span> |
| <a name="l00311"></a>00311 <span class="comment"> /** Key for Properties block that denotes our output filename. */</span> |
| <a name="l00312"></a>00312 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> OPT_FILENAME; |
| <a name="l00313"></a>00313 <span class="comment"></span> |
| <a name="l00314"></a>00314 <span class="comment"> /** XML tagnames for results file structure. */</span> |
| <a name="l00315"></a>00315 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> ELEM_RESULTSFILE; |
| <a name="l00316"></a>00316 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> ELEM_TESTFILE; |
| <a name="l00317"></a>00317 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> ELEM_FILERESULT; |
| <a name="l00318"></a>00318 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> ELEM_TESTCASE; |
| <a name="l00319"></a>00319 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> ELEM_CASERESULT; |
| <a name="l00320"></a>00320 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> ELEM_CHECKRESULT; |
| <a name="l00321"></a>00321 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> ELEM_STATISTIC; |
| <a name="l00322"></a>00322 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> ELEM_LONGVAL; |
| <a name="l00323"></a>00323 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> ELEM_DOUBLEVAL; |
| <a name="l00324"></a>00324 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> ELEM_MESSAGE; |
| <a name="l00325"></a>00325 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> ELEM_ARBITRARY; |
| <a name="l00326"></a>00326 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> ELEM_HASHTABLE; |
| <a name="l00327"></a>00327 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> ELEM_HASHITEM; |
| <a name="l00328"></a>00328 <span class="comment"></span> |
| <a name="l00329"></a>00329 <span class="comment"> /** XML attribute names for results file structure. */</span> |
| <a name="l00330"></a>00330 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> ATTR_LEVEL; |
| <a name="l00331"></a>00331 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> ATTR_DESC; |
| <a name="l00332"></a>00332 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> ATTR_TIME; |
| <a name="l00333"></a>00333 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> ATTR_RESULT; |
| <a name="l00334"></a>00334 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> ATTR_KEY; |
| <a name="l00335"></a>00335 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> ATTR_FILENAME; |
| <a name="l00336"></a>00336 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> LESS_THAN; |
| <a name="l00337"></a>00337 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> GREATER_THAN; |
| <a name="l00338"></a>00338 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> EQUALS_QUOTE; |
| <a name="l00339"></a>00339 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> SPACE; |
| <a name="l00340"></a>00340 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> QUOTE; |
| <a name="l00341"></a>00341 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> QUOTE_SPACE; |
| <a name="l00342"></a>00342 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> QUOTE_GREATER_THAN; |
| <a name="l00343"></a>00343 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> QUOTE_SOLIDUS_GREATER_THAN; |
| <a name="l00344"></a>00344 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> PASS; |
| <a name="l00345"></a>00345 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> AMBG; |
| <a name="l00346"></a>00346 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> ERRR; |
| <a name="l00347"></a>00347 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> FAIL; |
| <a name="l00348"></a>00348 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> LESS_THAN_SOLIDUS; |
| <a name="l00349"></a>00349 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> XML_HEADER; |
| <a name="l00350"></a>00350 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> REASON_EQUALS_QUOTE; |
| <a name="l00351"></a>00351 <span class="comment"></span> |
| <a name="l00352"></a>00352 <span class="comment"> /** </span> |
| <a name="l00353"></a>00353 <span class="comment"> * Optimization: for heavy use methods, form pre-defined constants to save on XalanDOMString concatenation. </span> |
| <a name="l00354"></a>00354 <span class="comment"> * <P>Note the indent; must be updated if we ever switch to another indenting method.</P></span> |
| <a name="l00355"></a>00355 <span class="comment"> */</span> |
| <a name="l00356"></a>00356 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> TESTCASEINIT_HDR; |
| <a name="l00357"></a>00357 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> TESTCASECLOSE_HDR; |
| <a name="l00358"></a>00358 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> MESSAGE_HDR; |
| <a name="l00359"></a>00359 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> STATISTIC_HDR; |
| <a name="l00360"></a>00360 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> ARBITRARY_HDR; |
| <a name="l00361"></a>00361 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> HASHTABLE_HDR; |
| <a name="l00362"></a>00362 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> HASHITEM_HDR; |
| <a name="l00363"></a>00363 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> CHECKPASS_HDR; |
| <a name="l00364"></a>00364 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> CHECKAMBG_HDR; |
| <a name="l00365"></a>00365 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> CHECKERRR_HDR; |
| <a name="l00366"></a>00366 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> CHECKFAIL_HDR; |
| <a name="l00367"></a>00367 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> CHECKFAIL_FTR; |
| <a name="l00368"></a>00368 <span class="comment"></span> |
| <a name="l00369"></a>00369 <span class="comment"> /** If we have output anything yet. */</span> |
| <a name="l00370"></a>00370 <span class="keywordtype">bool</span> m_anyOutput; |
| <a name="l00371"></a>00371 <span class="comment"></span> |
| <a name="l00372"></a>00372 <span class="comment"> /** Name of the file we're outputing to. */</span> |
| <a name="l00373"></a>00373 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> m_fileName; |
| <a name="l00374"></a>00374 <span class="comment"></span> |
| <a name="l00375"></a>00375 <span class="comment"> /** File reference and other internal convenience variables. */</span> |
| <a name="l00376"></a>00376 FileHandleType* m_fileHandle; |
| <a name="l00377"></a>00377 <span class="comment"></span> |
| <a name="l00378"></a>00378 <span class="comment"> /** If we're ready to start outputting yet. */</span> |
| <a name="l00379"></a>00379 <span class="keywordtype">bool</span> m_ready; |
| <a name="l00380"></a>00380 <span class="comment"></span> |
| <a name="l00381"></a>00381 <span class="comment"> /** If an error has occoured in this Reporter. */</span> |
| <a name="l00382"></a>00382 <span class="keywordtype">bool</span> m_error; |
| <a name="l00383"></a>00383 <span class="comment"></span> |
| <a name="l00384"></a>00384 <span class="comment"> /** If we should flush after every logTestCaseClose. */</span> |
| <a name="l00385"></a>00385 <span class="keywordtype">bool</span> m_flushOnCaseClose; |
| <a name="l00386"></a>00386 |
| <a name="l00387"></a>00387 <span class="keyword">const</span> <a class="code" href="classXalanAutoPtr.html">XalanAutoPtr<XalanOutputTranscoder></a> m_transcoder; |
| <a name="l00388"></a>00388 |
| <a name="l00389"></a>00389 <a class="code" href="classXalanVector.html">CharVectorType</a> m_buffer; |
| <a name="l00390"></a>00390 }; <span class="comment">// end of class XalanXMLFileReporter</span> |
| <a name="l00391"></a>00391 |
| <a name="l00392"></a>00392 |
| <a name="l00393"></a>00393 |
| <a name="l00394"></a>00394 XALAN_CPP_NAMESPACE_END |
| <a name="l00395"></a>00395 |
| <a name="l00396"></a>00396 |
| <a name="l00397"></a>00397 |
| <a name="l00398"></a>00398 <span class="preprocessor">#endif</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 © 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> |
