blob: 364df2acd12ae2b8d27fbbd4301a967eecfffba9 [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>XalanOutputStream.hpp</h1> </div>
</div>
<div class="contents">
<a href="XalanOutputStream_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(XALANOUTPUTSTREAM_HEADER_GUARD_1357924680)</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span><span class="preprocessor">#define XALANOUTPUTSTREAM_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="XalanVector_8hpp.html">xalanc/Include/XalanVector.hpp</a>&gt;</span>
<a name="l00029"></a>00029
<a name="l00030"></a>00030
<a name="l00031"></a>00031
<a name="l00032"></a>00032 <span class="preprocessor">#include &lt;<a class="code" href="XalanDOMString_8hpp.html">xalanc/XalanDOM/XalanDOMString.hpp</a>&gt;</span>
<a name="l00033"></a>00033
<a name="l00034"></a>00034
<a name="l00035"></a>00035
<a name="l00036"></a>00036 <span class="preprocessor">#include &lt;<a class="code" href="XalanTranscodingServices_8hpp.html">xalanc/PlatformSupport/XalanTranscodingServices.hpp</a>&gt;</span>
<a name="l00037"></a>00037 <span class="preprocessor">#include &lt;<a class="code" href="XSLException_8hpp.html">xalanc/PlatformSupport/XSLException.hpp</a>&gt;</span>
<a name="l00038"></a>00038
<a name="l00039"></a>00039
<a name="l00040"></a>00040
<a name="l00041"></a>00041 XALAN_CPP_NAMESPACE_BEGIN
<a name="l00042"></a>00042
<a name="l00043"></a>00043
<a name="l00044"></a>00044
<a name="l00045"></a>00045 <span class="keyword">class </span><a class="code" href="classXalanOutputTranscoder.html">XalanOutputTranscoder</a>;
<a name="l00046"></a>00046
<a name="l00047"></a>00047
<a name="l00048"></a>00048
<a name="l00049"></a><a class="code" href="classXalanOutputStream.html">00049</a> <span class="keyword">class </span><a class="code" href="PlatformSupportDefinitions_8hpp.html#a72e8d5d428f0210697564ce111006fde">XALAN_PLATFORMSUPPORT_EXPORT</a> <a class="code" href="classXalanOutputStream.html">XalanOutputStream</a>
<a name="l00050"></a>00050 {
<a name="l00051"></a>00051 <span class="keyword">public</span> :
<a name="l00052"></a>00052
<a name="l00053"></a><a class="code" href="classXalanOutputStream.html#a6bfe11293db013d26e2699fc1b93f5e3a7031da5c57e17026988988e62b0d49fe">00053</a> <span class="keyword">enum</span> { eDefaultBufferSize = 512u, eDefaultTranscoderBlockSize = 1024u };
<a name="l00054"></a>00054
<a name="l00055"></a><a class="code" href="classXalanOutputStream.html#a1cf47da7f0f7c2760b4bd8bc9c7cce4d">00055</a> <span class="keyword">typedef</span> <a class="code" href="classXalanVector.html">XalanVector&lt;XalanDOMChar&gt;</a> <a class="code" href="classXalanVector.html">BufferType</a>;
<a name="l00056"></a><a class="code" href="classXalanOutputStream.html#a137a768b6c14e435f04c42ac60e6ae95">00056</a> <span class="keyword">typedef</span> <a class="code" href="classXalanVector.html">XalanVector&lt;char&gt;</a> <a class="code" href="classXalanVector.html">TranscodeVectorType</a>;
<a name="l00057"></a><a class="code" href="classXalanOutputStream.html#a6313c6fbbdc5fd6bcf3040d4f596cf71">00057</a> <span class="keyword">typedef</span> <a class="code" href="classXalanTranscodingServices.html#a803b202417ca9d2c306d759c83036b38">XalanTranscodingServices::size_type</a> size_type;
<a name="l00058"></a>00058 <span class="comment"></span>
<a name="l00059"></a>00059 <span class="comment"> /**</span>
<a name="l00060"></a>00060 <span class="comment"> * Constructor.</span>
<a name="l00061"></a>00061 <span class="comment"> *</span>
<a name="l00062"></a>00062 <span class="comment"> * @param theBufferSize the size of the transcoding buffer</span>
<a name="l00063"></a>00063 <span class="comment"> * @param theTranscoderBlockSize the size of the block used by the transcoder</span>
<a name="l00064"></a>00064 <span class="comment"> * @param fThrowTranscodeException If true, an error transcoding will result in an exception being thrown.</span>
<a name="l00065"></a>00065 <span class="comment"> */</span>
<a name="l00066"></a>00066 <span class="keyword">explicit</span>
<a name="l00067"></a>00067 <a class="code" href="classXalanOutputStream.html">XalanOutputStream</a>(
<a name="l00068"></a>00068 MemoryManager&amp; theManager,
<a name="l00069"></a>00069 <a class="code" href="classXalanOutputStream.html#a6313c6fbbdc5fd6bcf3040d4f596cf71">size_type</a> theBufferSize = eDefaultBufferSize,
<a name="l00070"></a>00070 <a class="code" href="classXalanOutputStream.html#a6313c6fbbdc5fd6bcf3040d4f596cf71">size_type</a> theTranscoderBlockSize = eDefaultTranscoderBlockSize,
<a name="l00071"></a>00071 <span class="keywordtype">bool</span> fThrowTranscodeException = <span class="keyword">true</span>);
<a name="l00072"></a>00072
<a name="l00073"></a>00073 <span class="keyword">virtual</span>
<a name="l00074"></a>00074 ~<a class="code" href="classXalanOutputStream.html">XalanOutputStream</a>();
<a name="l00075"></a>00075
<a name="l00076"></a>00076 MemoryManager&amp;
<a name="l00077"></a><a class="code" href="classXalanOutputStream.html#a83ad9a5d95b8dc6b8376de2da8d4c273">00077</a> getMemoryManager()
<a name="l00078"></a>00078 {
<a name="l00079"></a>00079 <span class="keywordflow">return</span> m_buffer.getMemoryManager();
<a name="l00080"></a>00080 }
<a name="l00081"></a>00081
<a name="l00082"></a>00082 <span class="keyword">static</span> <span class="keyword">const</span> XalanDOMChar*
<a name="l00083"></a><a class="code" href="classXalanOutputStream.html#a50c94df907ba7f2e03c6e05fa54eae89">00083</a> defaultNewlineString()
<a name="l00084"></a>00084 {
<a name="l00085"></a>00085 <span class="preprocessor">#if defined(XALAN_NEWLINE_IS_CRLF)</span>
<a name="l00086"></a>00086 <span class="preprocessor"></span> <span class="keywordflow">return</span> s_nlCRString;
<a name="l00087"></a>00087 <span class="preprocessor">#else</span>
<a name="l00088"></a>00088 <span class="preprocessor"></span> <span class="keywordflow">return</span> s_nlString;
<a name="l00089"></a>00089 <span class="preprocessor">#endif</span>
<a name="l00090"></a>00090 <span class="preprocessor"></span> }
<a name="l00091"></a>00091 <span class="comment"></span>
<a name="l00092"></a>00092 <span class="comment"> /**</span>
<a name="l00093"></a>00093 <span class="comment"> * Write the appropriate newline character(s) to the stream.</span>
<a name="l00094"></a>00094 <span class="comment"> */</span>
<a name="l00095"></a>00095 <span class="keyword">virtual</span> <span class="keywordtype">void</span>
<a name="l00096"></a>00096 newline();
<a name="l00097"></a>00097 <span class="comment"></span>
<a name="l00098"></a>00098 <span class="comment"> /**</span>
<a name="l00099"></a>00099 <span class="comment"> * Get the string which is appropriate for inserting a line feed in the stream.</span>
<a name="l00100"></a>00100 <span class="comment"> */</span>
<a name="l00101"></a>00101 <span class="keyword">virtual</span> <span class="keyword">const</span> XalanDOMChar*
<a name="l00102"></a>00102 getNewlineString() <span class="keyword">const</span>;
<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"> * Flush the stream&#39;s transcoding buffer, but do not request</span>
<a name="l00106"></a>00106 <span class="comment"> * the implementation class to flush its buffer.</span>
<a name="l00107"></a>00107 <span class="comment"> * .</span>
<a name="l00108"></a>00108 <span class="comment"> */</span>
<a name="l00109"></a>00109 <span class="keywordtype">void</span>
<a name="l00110"></a>00110 flushBuffer();
<a name="l00111"></a>00111 <span class="comment"></span>
<a name="l00112"></a>00112 <span class="comment"> /**</span>
<a name="l00113"></a>00113 <span class="comment"> * Flush the stream&#39;s buffer.</span>
<a name="l00114"></a>00114 <span class="comment"> */</span>
<a name="l00115"></a>00115 <span class="keywordtype">void</span>
<a name="l00116"></a><a class="code" href="classXalanOutputStream.html#a60009b6bcfabffb913b0291a036c22a4">00116</a> flush()
<a name="l00117"></a>00117 {
<a name="l00118"></a>00118 flushBuffer();
<a name="l00119"></a>00119
<a name="l00120"></a>00120 doFlush();
<a name="l00121"></a>00121 }
<a name="l00122"></a>00122 <span class="comment"></span>
<a name="l00123"></a>00123 <span class="comment"> /**</span>
<a name="l00124"></a>00124 <span class="comment"> * Write a character to the output stream. The character</span>
<a name="l00125"></a>00125 <span class="comment"> * will not be transcoded.</span>
<a name="l00126"></a>00126 <span class="comment"> *</span>
<a name="l00127"></a>00127 <span class="comment"> * @param theChar the character to write</span>
<a name="l00128"></a>00128 <span class="comment"> */</span>
<a name="l00129"></a>00129 <span class="keywordtype">void</span>
<a name="l00130"></a><a class="code" href="classXalanOutputStream.html#a284f41e874bb59d4a965f891c26ece1e">00130</a> write(<span class="keywordtype">char</span> theChar)
<a name="l00131"></a>00131 {
<a name="l00132"></a>00132 write(&amp;theChar, 1);
<a name="l00133"></a>00133 }
<a name="l00134"></a>00134 <span class="comment"></span>
<a name="l00135"></a>00135 <span class="comment"> /**</span>
<a name="l00136"></a>00136 <span class="comment"> * Write a wide character to the output stream. The character</span>
<a name="l00137"></a>00137 <span class="comment"> * will be transcoded, if an output encoding is specified.</span>
<a name="l00138"></a>00138 <span class="comment"> *</span>
<a name="l00139"></a>00139 <span class="comment"> * @param theChar the character to write</span>
<a name="l00140"></a>00140 <span class="comment"> */</span>
<a name="l00141"></a>00141 <span class="keywordtype">void</span>
<a name="l00142"></a><a class="code" href="classXalanOutputStream.html#afe677579d91c35ac4a997dbe1101e9e9">00142</a> write(XalanDOMChar theChar)
<a name="l00143"></a>00143 {
<a name="l00144"></a>00144 assert(m_bufferSize &gt; 0);
<a name="l00145"></a>00145
<a name="l00146"></a>00146 <span class="keywordflow">if</span> (m_buffer.size() == m_bufferSize)
<a name="l00147"></a>00147 {
<a name="l00148"></a>00148 flushBuffer();
<a name="l00149"></a>00149 }
<a name="l00150"></a>00150
<a name="l00151"></a>00151 m_buffer.push_back(theChar);
<a name="l00152"></a>00152 }
<a name="l00153"></a>00153 <span class="comment"></span>
<a name="l00154"></a>00154 <span class="comment"> /**</span>
<a name="l00155"></a>00155 <span class="comment"> * Write a null-terminated string to the output file. The character</span>
<a name="l00156"></a>00156 <span class="comment"> * will not be transcoded. The caller is responsible for making sure the</span>
<a name="l00157"></a>00157 <span class="comment"> * buffer is flushed before calling this member function.</span>
<a name="l00158"></a>00158 <span class="comment"> *</span>
<a name="l00159"></a>00159 <span class="comment"> * @param theBuffer character buffer to write</span>
<a name="l00160"></a>00160 <span class="comment"> */</span>
<a name="l00161"></a>00161 <span class="keywordtype">void</span>
<a name="l00162"></a><a class="code" href="classXalanOutputStream.html#a41121f7712ab2b164490750b30fb585a">00162</a> write(<span class="keyword">const</span> <span class="keywordtype">char</span>* theBuffer)
<a name="l00163"></a>00163 {
<a name="l00164"></a>00164 assert(theBuffer != 0);
<a name="l00165"></a>00165 assert(m_buffer.empty() == <span class="keyword">true</span>);
<a name="l00166"></a>00166
<a name="l00167"></a>00167 write(theBuffer, <a class="code" href="DOMStringHelper_8hpp.html#a409bd1c85ee504bc43f281c9cfd4882c" title="Get the length of a XalanDOMString.">length</a>(theBuffer));
<a name="l00168"></a>00168 }
<a name="l00169"></a>00169 <span class="comment"></span>
<a name="l00170"></a>00170 <span class="comment"> /**</span>
<a name="l00171"></a>00171 <span class="comment"> * Write a null-terminated wide string to the output file. The string</span>
<a name="l00172"></a>00172 <span class="comment"> * will be transcoded, if an output encoding is specified.</span>
<a name="l00173"></a>00173 <span class="comment"> *</span>
<a name="l00174"></a>00174 <span class="comment"> * @param theBuffer character buffer to write</span>
<a name="l00175"></a>00175 <span class="comment"> */</span>
<a name="l00176"></a>00176 <span class="keywordtype">void</span>
<a name="l00177"></a><a class="code" href="classXalanOutputStream.html#a0ef821d3a0b7160695068ec1b35966f2">00177</a> write(<span class="keyword">const</span> XalanDOMChar* theBuffer)
<a name="l00178"></a>00178 {
<a name="l00179"></a>00179 write(theBuffer, <a class="code" href="DOMStringHelper_8hpp.html#a409bd1c85ee504bc43f281c9cfd4882c" title="Get the length of a XalanDOMString.">length</a>(theBuffer));
<a name="l00180"></a>00180 }
<a name="l00181"></a>00181 <span class="comment"></span>
<a name="l00182"></a>00182 <span class="comment"> /**</span>
<a name="l00183"></a>00183 <span class="comment"> * Write a specified number of characters to the output stream. The string</span>
<a name="l00184"></a>00184 <span class="comment"> * will not be transcoded. The caller is responsible for making sure the</span>
<a name="l00185"></a>00185 <span class="comment"> * buffer is flushed before calling this member function.</span>
<a name="l00186"></a>00186 <span class="comment"> *</span>
<a name="l00187"></a>00187 <span class="comment"> * @param theBuffer character buffer to write</span>
<a name="l00188"></a>00188 <span class="comment"> * @param theBufferLength number of characters to write</span>
<a name="l00189"></a>00189 <span class="comment"> */</span>
<a name="l00190"></a>00190 <span class="keywordtype">void</span>
<a name="l00191"></a><a class="code" href="classXalanOutputStream.html#a227db17ffe1eaa15e052886a2a29af7d">00191</a> write(
<a name="l00192"></a>00192 <span class="keyword">const</span> <span class="keywordtype">char</span>* theBuffer,
<a name="l00193"></a>00193 <a class="code" href="classXalanOutputStream.html#a6313c6fbbdc5fd6bcf3040d4f596cf71">size_type</a> theBufferLength)
<a name="l00194"></a>00194 {
<a name="l00195"></a>00195 assert(theBuffer != 0);
<a name="l00196"></a>00196 assert(m_buffer.empty() == <span class="keyword">true</span>);
<a name="l00197"></a>00197
<a name="l00198"></a>00198 writeData(theBuffer,
<a name="l00199"></a>00199 theBufferLength);
<a name="l00200"></a>00200 }
<a name="l00201"></a>00201 <span class="comment"></span>
<a name="l00202"></a>00202 <span class="comment"> /**</span>
<a name="l00203"></a>00203 <span class="comment"> * Write a specified number of characters to the output stream. The string</span>
<a name="l00204"></a>00204 <span class="comment"> * will be transcoded, if an output encoding is specified.</span>
<a name="l00205"></a>00205 <span class="comment"> *</span>
<a name="l00206"></a>00206 <span class="comment"> * @param theBuffer character buffer to write</span>
<a name="l00207"></a>00207 <span class="comment"> * @param theBufferLength number of characters to write</span>
<a name="l00208"></a>00208 <span class="comment"> */</span>
<a name="l00209"></a>00209 <span class="keywordtype">void</span>
<a name="l00210"></a>00210 write(
<a name="l00211"></a>00211 <span class="keyword">const</span> XalanDOMChar* theBuffer,
<a name="l00212"></a>00212 <a class="code" href="XalanMap_8hpp.html#a39efc23c4f36ef6389e4a1fbe96c5f2e">size_type</a> theBufferLength);
<a name="l00213"></a>00213 <span class="comment"></span>
<a name="l00214"></a>00214 <span class="comment"> /**</span>
<a name="l00215"></a>00215 <span class="comment"> * Get the output encoding for the stream.</span>
<a name="l00216"></a>00216 <span class="comment"> *</span>
<a name="l00217"></a>00217 <span class="comment"> * @return The encoding name</span>
<a name="l00218"></a>00218 <span class="comment"> */</span>
<a name="l00219"></a>00219 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;
<a name="l00220"></a><a class="code" href="classXalanOutputStream.html#a92d82f5a1fdb1837fcec6825f356961d">00220</a> getOutputEncoding()<span class="keyword"> const</span>
<a name="l00221"></a>00221 <span class="keyword"> </span>{
<a name="l00222"></a>00222 <span class="keywordflow">return</span> m_encoding;
<a name="l00223"></a>00223 }
<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"> * Set the output encoding for the stream.</span>
<a name="l00227"></a>00227 <span class="comment"> *</span>
<a name="l00228"></a>00228 <span class="comment"> * @param theEncoding The encoding name</span>
<a name="l00229"></a>00229 <span class="comment"> */</span>
<a name="l00230"></a>00230 <span class="keywordtype">void</span>
<a name="l00231"></a>00231 setOutputEncoding(<span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; theEncoding);
<a name="l00232"></a>00232 <span class="comment"></span>
<a name="l00233"></a>00233 <span class="comment"> /**</span>
<a name="l00234"></a>00234 <span class="comment"> * Determine if a given value can be represented in</span>
<a name="l00235"></a>00235 <span class="comment"> * the output encoding.</span>
<a name="l00236"></a>00236 <span class="comment"> *</span>
<a name="l00237"></a>00237 <span class="comment"> * @return true if the value can be represented, and false if not.</span>
<a name="l00238"></a>00238 <span class="comment"> */</span>
<a name="l00239"></a>00239 <span class="keywordtype">bool</span>
<a name="l00240"></a>00240 canTranscodeTo(XalanUnicodeChar theChar) <span class="keyword">const</span>;
<a name="l00241"></a>00241
<a name="l00242"></a>00242
<a name="l00243"></a>00243 <span class="keyword">const</span> <a class="code" href="classXalanOutputTranscoder.html">XalanOutputTranscoder</a>*
<a name="l00244"></a><a class="code" href="classXalanOutputStream.html#a342ee0ef0a624fbb4e504d0c703bd38d">00244</a> getTranscoder()<span class="keyword"> const</span>
<a name="l00245"></a>00245 <span class="keyword"> </span>{
<a name="l00246"></a>00246 <span class="keywordflow">return</span> m_transcoder;
<a name="l00247"></a>00247 }
<a name="l00248"></a>00248 <span class="comment"></span>
<a name="l00249"></a>00249 <span class="comment"> /**</span>
<a name="l00250"></a>00250 <span class="comment"> * Set the flag that indicates whether a transcoding</span>
<a name="l00251"></a>00251 <span class="comment"> * error should throw an exception. The default is</span>
<a name="l00252"></a>00252 <span class="comment"> * to throw an exception. If this flag is false, and</span>
<a name="l00253"></a>00253 <span class="comment"> * and an error occurs transcoding, then data will</span>
<a name="l00254"></a>00254 <span class="comment"> * likely be lost.</span>
<a name="l00255"></a>00255 <span class="comment"> *</span>
<a name="l00256"></a>00256 <span class="comment"> * @return the value of the flag.</span>
<a name="l00257"></a>00257 <span class="comment"> */</span>
<a name="l00258"></a>00258 <span class="keywordtype">bool</span>
<a name="l00259"></a><a class="code" href="classXalanOutputStream.html#aa7db8729a27676af06f2cae135d51312">00259</a> getThrowTranscodeException()<span class="keyword"> const</span>
<a name="l00260"></a>00260 <span class="keyword"> </span>{
<a name="l00261"></a>00261 <span class="keywordflow">return</span> m_throwTranscodeException;
<a name="l00262"></a>00262 }
<a name="l00263"></a>00263 <span class="comment"></span>
<a name="l00264"></a>00264 <span class="comment"> /**</span>
<a name="l00265"></a>00265 <span class="comment"> * Set the flag that indicates whether a transcoding</span>
<a name="l00266"></a>00266 <span class="comment"> * error should throw an exception. The default is</span>
<a name="l00267"></a>00267 <span class="comment"> * to throw an exception. If this flag is false, and</span>
<a name="l00268"></a>00268 <span class="comment"> * and an error occurs transcoding, then data will</span>
<a name="l00269"></a>00269 <span class="comment"> * likely be lost.</span>
<a name="l00270"></a>00270 <span class="comment"> *</span>
<a name="l00271"></a>00271 <span class="comment"> * @param the new value of the flag.</span>
<a name="l00272"></a>00272 <span class="comment"> */</span>
<a name="l00273"></a>00273 <span class="keywordtype">void</span>
<a name="l00274"></a><a class="code" href="classXalanOutputStream.html#a063a0dfc25149696a609edd7b24bb776">00274</a> setThrowTranscodeException(<span class="keywordtype">bool</span> flag)
<a name="l00275"></a>00275 {
<a name="l00276"></a>00276 m_throwTranscodeException = flag;
<a name="l00277"></a>00277 }
<a name="l00278"></a>00278 <span class="comment"></span>
<a name="l00279"></a>00279 <span class="comment"> /**</span>
<a name="l00280"></a>00280 <span class="comment"> * Set the size of the output buffer.</span>
<a name="l00281"></a>00281 <span class="comment"> *</span>
<a name="l00282"></a>00282 <span class="comment"> * @param theBufferSize The buffer size.</span>
<a name="l00283"></a>00283 <span class="comment"> */</span>
<a name="l00284"></a>00284 <span class="keywordtype">void</span>
<a name="l00285"></a>00285 setBufferSize(<a class="code" href="XalanMap_8hpp.html#a39efc23c4f36ef6389e4a1fbe96c5f2e">size_type</a> theBufferSize);
<a name="l00286"></a>00286
<a name="l00287"></a>00287
<a name="l00288"></a><a class="code" href="classXalanOutputStream_1_1XalanOutputStreamException.html">00288</a> <span class="keyword">class </span><a class="code" href="PlatformSupportDefinitions_8hpp.html#a72e8d5d428f0210697564ce111006fde">XALAN_PLATFORMSUPPORT_EXPORT</a> <a class="code" href="classXalanOutputStream_1_1XalanOutputStreamException.html">XalanOutputStreamException</a> : <span class="keyword">public</span> <a class="code" href="classXSLException.html">XSLException</a>
<a name="l00289"></a>00289 {
<a name="l00290"></a>00290 <span class="keyword">public</span>:
<a name="l00291"></a>00291
<a name="l00292"></a>00292 <a class="code" href="classXalanOutputStream_1_1XalanOutputStreamException.html">XalanOutputStreamException</a>(
<a name="l00293"></a>00293 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; theMessage,
<a name="l00294"></a>00294 MemoryManager&amp; theManager,
<a name="l00295"></a>00295 <span class="keyword">const</span> Locator* theLocator);
<a name="l00296"></a>00296
<a name="l00297"></a>00297 <a class="code" href="classXalanOutputStream_1_1XalanOutputStreamException.html">XalanOutputStreamException</a>(
<a name="l00298"></a>00298 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; theMessage,
<a name="l00299"></a>00299 MemoryManager&amp; theManager);
<a name="l00300"></a>00300
<a name="l00301"></a>00301 <a class="code" href="classXalanOutputStream_1_1XalanOutputStreamException.html">XalanOutputStreamException</a>(<span class="keyword">const</span> <a class="code" href="classXalanOutputStream_1_1XalanOutputStreamException.html">XalanOutputStreamException</a>&amp; other);
<a name="l00302"></a>00302
<a name="l00303"></a>00303 <span class="keyword">virtual</span>
<a name="l00304"></a>00304 ~<a class="code" href="classXalanOutputStream_1_1XalanOutputStreamException.html">XalanOutputStreamException</a>();
<a name="l00305"></a>00305
<a name="l00306"></a>00306 <span class="keyword">virtual</span> <span class="keyword">const</span> XalanDOMChar*
<a name="l00307"></a>00307 getType() <span class="keyword">const</span>;
<a name="l00308"></a>00308
<a name="l00309"></a>00309 <span class="keyword">private</span>:
<a name="l00310"></a>00310 };
<a name="l00311"></a>00311
<a name="l00312"></a><a class="code" href="classXalanOutputStream_1_1UnsupportedEncodingException.html">00312</a> <span class="keyword">class </span><a class="code" href="PlatformSupportDefinitions_8hpp.html#a72e8d5d428f0210697564ce111006fde">XALAN_PLATFORMSUPPORT_EXPORT</a> <a class="code" href="classXalanOutputStream_1_1UnsupportedEncodingException.html">UnsupportedEncodingException</a> : <span class="keyword">public</span> <a class="code" href="classXalanOutputStream_1_1XalanOutputStreamException.html">XalanOutputStreamException</a>
<a name="l00313"></a>00313 {
<a name="l00314"></a>00314 <span class="keyword">public</span>:
<a name="l00315"></a>00315
<a name="l00316"></a>00316 <a class="code" href="classXalanOutputStream_1_1UnsupportedEncodingException.html">UnsupportedEncodingException</a>(
<a name="l00317"></a>00317 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; theEncoding,
<a name="l00318"></a>00318 <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; theBuffer,
<a name="l00319"></a>00319 <span class="keyword">const</span> Locator* theLocator);
<a name="l00320"></a>00320
<a name="l00321"></a>00321 <a class="code" href="classXalanOutputStream_1_1UnsupportedEncodingException.html">UnsupportedEncodingException</a>(
<a name="l00322"></a>00322 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; theEncoding,
<a name="l00323"></a>00323 <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; theBuffer);
<a name="l00324"></a>00324
<a name="l00325"></a><a class="code" href="classXalanOutputStream_1_1UnsupportedEncodingException.html#a04558174b985831cec457ad7e503568e">00325</a> <a class="code" href="classXalanOutputStream_1_1UnsupportedEncodingException.html">UnsupportedEncodingException</a>(<span class="keyword">const</span> <a class="code" href="classXalanOutputStream_1_1UnsupportedEncodingException.html">UnsupportedEncodingException</a>&amp; other) :
<a name="l00326"></a>00326 <a class="code" href="classXalanOutputStream_1_1XalanOutputStreamException.html">XalanOutputStreamException</a>(other),
<a name="l00327"></a>00327 m_encoding(
<a name="l00328"></a>00328 other.m_encoding,
<a name="l00329"></a>00329 other.m_memoryManager)
<a name="l00330"></a>00330 {
<a name="l00331"></a>00331 }
<a name="l00332"></a>00332
<a name="l00333"></a>00333 <span class="keyword">virtual</span>
<a name="l00334"></a>00334 ~<a class="code" href="classXalanOutputStream_1_1UnsupportedEncodingException.html">UnsupportedEncodingException</a>();
<a name="l00335"></a>00335
<a name="l00336"></a>00336 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;
<a name="l00337"></a><a class="code" href="classXalanOutputStream_1_1UnsupportedEncodingException.html#af7f7b79bcd319443bcf675325890c843">00337</a> getEncoding()<span class="keyword"> const</span>
<a name="l00338"></a>00338 <span class="keyword"> </span>{
<a name="l00339"></a>00339 <span class="keywordflow">return</span> m_encoding;
<a name="l00340"></a>00340 }
<a name="l00341"></a>00341
<a name="l00342"></a>00342 <span class="keyword">virtual</span> <span class="keyword">const</span> XalanDOMChar*
<a name="l00343"></a>00343 getType() <span class="keyword">const</span>;
<a name="l00344"></a>00344
<a name="l00345"></a>00345 <span class="keyword">private</span>:
<a name="l00346"></a>00346
<a name="l00347"></a>00347 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a> m_encoding;
<a name="l00348"></a>00348 };
<a name="l00349"></a>00349
<a name="l00350"></a><a class="code" href="classXalanOutputStream_1_1TranscoderInternalFailureException.html">00350</a> <span class="keyword">class </span><a class="code" href="PlatformSupportDefinitions_8hpp.html#a72e8d5d428f0210697564ce111006fde">XALAN_PLATFORMSUPPORT_EXPORT</a> <a class="code" href="classXalanOutputStream_1_1TranscoderInternalFailureException.html">TranscoderInternalFailureException</a> : <span class="keyword">public</span> <a class="code" href="classXalanOutputStream_1_1XalanOutputStreamException.html">XalanOutputStreamException</a>
<a name="l00351"></a>00351 {
<a name="l00352"></a>00352 <span class="keyword">public</span>:
<a name="l00353"></a>00353
<a name="l00354"></a>00354 <a class="code" href="classXalanOutputStream_1_1TranscoderInternalFailureException.html">TranscoderInternalFailureException</a>(
<a name="l00355"></a>00355 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; theEncoding,
<a name="l00356"></a>00356 <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; theBuffer,
<a name="l00357"></a>00357 <span class="keyword">const</span> Locator* theLocator);
<a name="l00358"></a>00358
<a name="l00359"></a>00359 <a class="code" href="classXalanOutputStream_1_1TranscoderInternalFailureException.html">TranscoderInternalFailureException</a>(
<a name="l00360"></a>00360 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; theEncoding,
<a name="l00361"></a>00361 <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; theBuffer);
<a name="l00362"></a>00362
<a name="l00363"></a>00363 <a class="code" href="classXalanOutputStream_1_1TranscoderInternalFailureException.html">TranscoderInternalFailureException</a>(<span class="keyword">const</span> <a class="code" href="classXalanOutputStream_1_1TranscoderInternalFailureException.html">TranscoderInternalFailureException</a>&amp; other);
<a name="l00364"></a>00364
<a name="l00365"></a>00365 <span class="keyword">virtual</span>
<a name="l00366"></a>00366 ~<a class="code" href="classXalanOutputStream_1_1TranscoderInternalFailureException.html">TranscoderInternalFailureException</a>();
<a name="l00367"></a>00367
<a name="l00368"></a>00368 <span class="keyword">virtual</span> <span class="keyword">const</span> XalanDOMChar*
<a name="l00369"></a>00369 getType() <span class="keyword">const</span>;
<a name="l00370"></a>00370
<a name="l00371"></a>00371 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;
<a name="l00372"></a><a class="code" href="classXalanOutputStream_1_1TranscoderInternalFailureException.html#af98dac291d86d84d7505e230d1356e3b">00372</a> getEncoding()<span class="keyword"> const</span>
<a name="l00373"></a>00373 <span class="keyword"> </span>{
<a name="l00374"></a>00374 <span class="keywordflow">return</span> m_encoding;
<a name="l00375"></a>00375 }
<a name="l00376"></a>00376
<a name="l00377"></a>00377 <span class="keyword">private</span>:
<a name="l00378"></a>00378
<a name="l00379"></a>00379 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a> m_encoding;
<a name="l00380"></a>00380 };
<a name="l00381"></a>00381
<a name="l00382"></a><a class="code" href="classXalanOutputStream_1_1TranscodingException.html">00382</a> <span class="keyword">class </span><a class="code" href="PlatformSupportDefinitions_8hpp.html#a72e8d5d428f0210697564ce111006fde">XALAN_PLATFORMSUPPORT_EXPORT</a> <a class="code" href="classXalanOutputStream_1_1TranscodingException.html">TranscodingException</a> : <span class="keyword">public</span> <a class="code" href="classXalanOutputStream_1_1XalanOutputStreamException.html">XalanOutputStreamException</a>
<a name="l00383"></a>00383 {
<a name="l00384"></a>00384 <span class="keyword">public</span>:
<a name="l00385"></a>00385
<a name="l00386"></a>00386 <a class="code" href="classXalanOutputStream_1_1TranscodingException.html">TranscodingException</a>(
<a name="l00387"></a>00387 <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; theBuffer,
<a name="l00388"></a>00388 <span class="keyword">const</span> Locator* theLocator);
<a name="l00389"></a>00389
<a name="l00390"></a>00390 <span class="keyword">explicit</span>
<a name="l00391"></a>00391 <a class="code" href="classXalanOutputStream_1_1TranscodingException.html">TranscodingException</a>(<a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; theBuffer);
<a name="l00392"></a>00392
<a name="l00393"></a>00393 <a class="code" href="classXalanOutputStream_1_1TranscodingException.html">TranscodingException</a>(<span class="keyword">const</span> <a class="code" href="classXalanOutputStream_1_1TranscodingException.html">TranscodingException</a>&amp; other);
<a name="l00394"></a>00394
<a name="l00395"></a>00395 <span class="keyword">virtual</span>
<a name="l00396"></a>00396 ~<a class="code" href="classXalanOutputStream_1_1TranscodingException.html">TranscodingException</a>();
<a name="l00397"></a>00397
<a name="l00398"></a>00398 <span class="keyword">virtual</span> <span class="keyword">const</span> XalanDOMChar*
<a name="l00399"></a>00399 getType() <span class="keyword">const</span>;
<a name="l00400"></a>00400 };
<a name="l00401"></a>00401
<a name="l00402"></a>00402 <span class="keyword">static</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;
<a name="l00403"></a>00403 <a class="code" href="classXalanOutputStream.html#ac53930c32df27f8e136073aefcd7e733">formatMessage</a>(
<a name="l00404"></a>00404 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; theMessage,
<a name="l00405"></a>00405 <span class="keywordtype">int</span> theErrorCode,
<a name="l00406"></a>00406 <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; theBuffer);
<a name="l00407"></a>00407
<a name="l00408"></a>00408 <span class="keyword">protected</span>:
<a name="l00409"></a>00409 <span class="comment"></span>
<a name="l00410"></a>00410 <span class="comment"> /**</span>
<a name="l00411"></a>00411 <span class="comment"> * Transcode a wide string.</span>
<a name="l00412"></a>00412 <span class="comment"> *</span>
<a name="l00413"></a>00413 <span class="comment"> * @param theBuffer The string to transcode.</span>
<a name="l00414"></a>00414 <span class="comment"> * @param theBufferLength The length of the string.</span>
<a name="l00415"></a>00415 <span class="comment"> * @param theDestination The destination vector.</span>
<a name="l00416"></a>00416 <span class="comment"> */</span>
<a name="l00417"></a>00417 <span class="keywordtype">void</span>
<a name="l00418"></a>00418 <a class="code" href="classXalanOutputStream.html#a123fa7e03a7f6f30d10ff6e250c7407a" title="Transcode a wide string.">transcode</a>(
<a name="l00419"></a>00419 <span class="keyword">const</span> XalanDOMChar* theBuffer,
<a name="l00420"></a>00420 <a class="code" href="classXalanOutputStream.html#a6313c6fbbdc5fd6bcf3040d4f596cf71">size_type</a> theBufferLength,
<a name="l00421"></a>00421 <a class="code" href="classXalanVector.html">TranscodeVectorType</a>&amp; theDestination);
<a name="l00422"></a>00422 <span class="comment"></span>
<a name="l00423"></a>00423 <span class="comment"> /**</span>
<a name="l00424"></a>00424 <span class="comment"> * Write the data in the buffer</span>
<a name="l00425"></a>00425 <span class="comment"> *</span>
<a name="l00426"></a>00426 <span class="comment"> * @param theBuffer The data to write</span>
<a name="l00427"></a>00427 <span class="comment"> * @param theBufferLength The length of theBuffer.</span>
<a name="l00428"></a>00428 <span class="comment"> */</span>
<a name="l00429"></a>00429 <span class="keyword">virtual</span> <span class="keywordtype">void</span>
<a name="l00430"></a>00430 <a class="code" href="classXalanOutputStream.html#afd3ee66f24a4a20803546ffcd7092304" title="Write the data in the buffer.">writeData</a>(
<a name="l00431"></a>00431 <span class="keyword">const</span> <span class="keywordtype">char</span>* theBuffer,
<a name="l00432"></a>00432 <a class="code" href="classXalanOutputStream.html#a6313c6fbbdc5fd6bcf3040d4f596cf71">size_type</a> theBufferLength) = 0;
<a name="l00433"></a>00433 <span class="comment"></span>
<a name="l00434"></a>00434 <span class="comment"> /**</span>
<a name="l00435"></a>00435 <span class="comment"> * Flush the stream.</span>
<a name="l00436"></a>00436 <span class="comment"> */</span>
<a name="l00437"></a>00437 <span class="keyword">virtual</span> <span class="keywordtype">void</span>
<a name="l00438"></a>00438 <a class="code" href="classXalanOutputStream.html#af877c1e7589acbd180dbb112dc1512d1" title="Flush the stream.">doFlush</a>() = 0;
<a name="l00439"></a>00439
<a name="l00440"></a><a class="code" href="classXalanOutputStream.html#a496d97d74745f2b6cc5230002e0c3e9a">00440</a> <span class="keyword">static</span> <span class="keyword">const</span> XalanDOMChar s_nlString[];
<a name="l00441"></a><a class="code" href="classXalanOutputStream.html#a197cde3b09b32e45f9db243d663d8769">00441</a> <span class="keyword">static</span> <span class="keyword">const</span> XalanDOMChar s_nlCRString[];
<a name="l00442"></a>00442
<a name="l00443"></a><a class="code" href="classXalanOutputStream.html#a272eec1ead87be6c1b3a016649763520">00443</a> <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html#ab8b91a47f3335d6c54c49029dd1074f2">XalanDOMString::size_type</a> s_nlStringLength;
<a name="l00444"></a><a class="code" href="classXalanOutputStream.html#a3c7e3742bde6a2cc2f0ef07146087d4d">00444</a> <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html#ab8b91a47f3335d6c54c49029dd1074f2">XalanDOMString::size_type</a> s_nlCRStringLength;
<a name="l00445"></a>00445
<a name="l00446"></a>00446 <span class="keyword">private</span>:
<a name="l00447"></a>00447
<a name="l00448"></a>00448 <span class="comment">// These are not implemented...</span>
<a name="l00449"></a>00449 <a class="code" href="classXalanOutputStream.html#ab355898f646b50a69ba7667a9cfbd5a3" title="Constructor.">XalanOutputStream</a>(<span class="keyword">const</span> <a class="code" href="classXalanOutputStream.html">XalanOutputStream</a>&amp;);
<a name="l00450"></a>00450
<a name="l00451"></a>00451 <a class="code" href="classXalanOutputStream.html">XalanOutputStream</a>&amp;
<a name="l00452"></a>00452 operator=(<span class="keyword">const</span> <a class="code" href="classXalanOutputStream.html">XalanOutputStream</a>&amp;);
<a name="l00453"></a>00453
<a name="l00454"></a>00454 <span class="keywordtype">bool</span>
<a name="l00455"></a>00455 <a class="code" href="ElemAttributeSet_8hpp.html#ae199bc16afddda1065706543e752d292">operator==</a>(<span class="keyword">const</span> <a class="code" href="classXalanOutputStream.html">XalanOutputStream</a>&amp;) <span class="keyword">const</span>;
<a name="l00456"></a>00456
<a name="l00457"></a>00457 <span class="keywordtype">void</span>
<a name="l00458"></a>00458 doWrite(
<a name="l00459"></a>00459 <span class="keyword">const</span> XalanDOMChar* theBuffer,
<a name="l00460"></a>00460 <a class="code" href="classXalanOutputStream.html#a6313c6fbbdc5fd6bcf3040d4f596cf71">size_type</a> theBufferLength);
<a name="l00461"></a>00461
<a name="l00462"></a>00462
<a name="l00463"></a>00463 <span class="keyword">const</span> <a class="code" href="classXalanOutputStream.html#a6313c6fbbdc5fd6bcf3040d4f596cf71">size_type</a> m_transcoderBlockSize;
<a name="l00464"></a>00464
<a name="l00465"></a>00465 <a class="code" href="classXalanOutputTranscoder.html">XalanOutputTranscoder</a>* m_transcoder;
<a name="l00466"></a>00466
<a name="l00467"></a>00467 <a class="code" href="classXalanOutputStream.html#a6313c6fbbdc5fd6bcf3040d4f596cf71">size_type</a> m_bufferSize;
<a name="l00468"></a>00468
<a name="l00469"></a>00469 <a class="code" href="classXalanVector.html">BufferType</a> m_buffer;
<a name="l00470"></a>00470
<a name="l00471"></a>00471 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> m_encoding;
<a name="l00472"></a>00472
<a name="l00473"></a>00473 <span class="keywordtype">bool</span> m_writeAsUTF16;
<a name="l00474"></a>00474
<a name="l00475"></a>00475 <span class="keywordtype">bool</span> m_throwTranscodeException;
<a name="l00476"></a>00476
<a name="l00477"></a>00477 <a class="code" href="classXalanVector.html">TranscodeVectorType</a> m_transcodingBuffer;
<a name="l00478"></a>00478 };
<a name="l00479"></a>00479
<a name="l00480"></a>00480
<a name="l00481"></a>00481
<a name="l00482"></a>00482 XALAN_CPP_NAMESPACE_END
<a name="l00483"></a>00483
<a name="l00484"></a>00484
<a name="l00485"></a>00485
<a name="l00486"></a>00486 <span class="preprocessor">#endif // XALANOUTPUTSTREAM_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>