<HTML><HEAD><TITLE>Xalan-C++ API Documentation</TITLE></HEAD>
<BODY>
<h2 align="center">Xalan-C++ API Documentation</h2>
<h3 align="center">The Xalan C++ XSLT Processor Version 1.10</h3>
</BODY>
<!-- Generated by Doxygen 1.2.8.1 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>XalanTranscodingServices.hpp</h1><a href="XalanTranscodingServices_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <font class="comment">/*</font>
00002 <font class="comment"> * Copyright 1999-2004 The Apache Software Foundation.</font>
00003 <font class="comment"> *</font>
00004 <font class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</font>
00005 <font class="comment"> * you may not use this file except in compliance with the License.</font>
00006 <font class="comment"> * You may obtain a copy of the License at</font>
00007 <font class="comment"> *</font>
00008 <font class="comment"> *     http://www.apache.org/licenses/LICENSE-2.0</font>
00009 <font class="comment"> *</font>
00010 <font class="comment"> * Unless required by applicable law or agreed to in writing, software</font>
00011 <font class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</font>
00012 <font class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</font>
00013 <font class="comment"> * See the License for the specific language governing permissions and</font>
00014 <font class="comment"> * limitations under the License.</font>
00015 <font class="comment"> */</font>
00016 <font class="preprocessor">#if !defined(XALANTRANSCODINGSERVICES_HEADER_GUARD_1357924680)</font>
<a name="l00017"></a><a class="code" href="XalanTranscodingServices_8hpp.html#a0">00017</a> <font class="preprocessor"></font><font class="preprocessor">#define XALANTRANSCODINGSERVICES_HEADER_GUARD_1357924680</font>
00018 <font class="preprocessor"></font>
00019 
00020 
00021 <font class="comment">// Base include file.  Must be first.</font>
00022 <font class="preprocessor">#include &lt;<a class="code" href="PlatformSupportDefinitions_8hpp.html">xalanc/PlatformSupport/PlatformSupportDefinitions.hpp</a>&gt;</font>
00023 
00024 
00025 
00026 <font class="preprocessor">#include &lt;cassert&gt;</font>
00027 
00028 
00029 
00030 <font class="preprocessor">#include &lt;<a class="code" href="DOMStringHelper_8hpp.html">xalanc/PlatformSupport/DOMStringHelper.hpp</a>&gt;</font>
00031 <font class="preprocessor">#include &lt;<a class="code" href="XSLException_8hpp.html">xalanc/PlatformSupport/XSLException.hpp</a>&gt;</font>
00032 
00033 
00034 
00035 XALAN_CPP_NAMESPACE_BEGIN
00036 
00037 
00038 
<a name="l00039"></a><a class="code" href="XalanTranscodingServices_8hpp.html#a1">00039</a> <font class="keyword">class </font><a class="code" href="classXalanOutputTranscoder.html">XalanOutputTranscoder</a>;
00040 
00041 
00042 
<a name="l00043"></a><a class="code" href="classXalanTranscodingServices.html">00043</a> <font class="keyword">class </font>XALAN_PLATFORMSUPPORT_EXPORT <a class="code" href="classXalanTranscodingServices.html">XalanTranscodingServices</a>
00044 {
00045 <font class="keyword">public</font>:
00046 
00050     <font class="keyword">static</font> <font class="keywordtype">void</font>
00051     <a class="code" href="classXalanTranscodingServices.html#d0">initialize</a>(MemoryManagerType&amp;      theManager);
00052  
00056     <font class="keyword">static</font> <font class="keywordtype">void</font>
00057     <a class="code" href="classXalanTranscodingServices.html#d1">terminate</a>();
00058 
<a name="l00059"></a><a class="code" href="classXalanTranscodingServices.html#s0">00059</a>     <font class="keyword">typedef</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font>   XalanXMLByte;
<a name="l00060"></a><a class="code" href="classXalanTranscodingServices.html#s1">00060</a>     <font class="keyword">typedef</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font>    size_type;
<a name="l00061"></a><a class="code" href="classXalanTranscodingServices.html#s2">00061</a>     <font class="keyword">typedef</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font>    UnicodeCharType;
00062 
00063     <font class="keyword">static</font> size_type
<a name="l00064"></a><a class="code" href="classXalanTranscodingServices.html#d2">00064</a>     <a class="code" href="classXalanTranscodingServices.html#d2">length</a>(<font class="keyword">const</font> XalanXMLByte*  theBytes)<font class="keyword"></font>
00065 <font class="keyword">    </font>{
00066         assert(theBytes != 0);
00067 
00068         size_type   i = 0;
00069 
00070         <font class="keywordflow">while</font>(theBytes[i] != 0)
00071         {
00072             ++i;
00073         }
00074 
00075         <font class="keywordflow">return</font> i;
00076     }
00077 
<a name="l00078"></a><a class="code" href="classXalanTranscodingServices.html#s7">00078</a>     <font class="keyword">enum</font> eCode
00079     {
00080         OK,
00081         UnsupportedEncoding,
00082         InternalFailure,
00083         SupportFilesNotFound
00084     };
00085 
00086 
00096     <font class="keyword">static</font> <a class="code" href="classXalanOutputTranscoder.html">XalanOutputTranscoder</a>*
00097     <a class="code" href="classXalanTranscodingServices.html#d3">makeNewTranscoder</a>(
00098             MemoryManagerType&amp;      theManager,
00099             <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;   theEncodingName,
00100             eCode&amp;                  theResult,
00101             size_type               theBlockSize);
00102 
00108     <font class="keyword">static</font> <font class="keywordtype">void</font>
00109     <a class="code" href="classXalanTranscodingServices.html#d4">destroyTranscoder</a>(<a class="code" href="classXalanOutputTranscoder.html">XalanOutputTranscoder</a>*    theTranscoder);
00110 
00117     <font class="keyword">static</font> <font class="keywordtype">bool</font>
00118     <a class="code" href="classXalanTranscodingServices.html#d5">encodingIsUTF8</a>(<font class="keyword">const</font> XalanDOMChar*      theEncodingName);
00119 
00126     <font class="keyword">static</font> <font class="keywordtype">bool</font>
00127     <a class="code" href="classXalanTranscodingServices.html#d5">encodingIsUTF8</a>(<font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;    theEncodingName);
00128 
00135     <font class="keyword">static</font> <font class="keywordtype">bool</font>
00136     <a class="code" href="classXalanTranscodingServices.html#d7">encodingIsUTF16</a>(<font class="keyword">const</font> XalanDOMChar*     theEncodingName);
00137 
00144     <font class="keyword">static</font> <font class="keywordtype">bool</font>
00145     <a class="code" href="classXalanTranscodingServices.html#d7">encodingIsUTF16</a>(<font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;   theEncodingName);
00146 
00153     <font class="keyword">static</font> <font class="keywordtype">bool</font>
00154     <a class="code" href="classXalanTranscodingServices.html#d9">encodingIsUTF32</a>(<font class="keyword">const</font> XalanDOMChar*     theEncodingName);
00155 
00162     <font class="keyword">static</font> <font class="keywordtype">bool</font>
00163     <a class="code" href="classXalanTranscodingServices.html#d9">encodingIsUTF32</a>(<font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;   theEncodingName);
00175     <font class="keyword">static</font> <font class="keyword">const</font> XalanXMLByte*
00176     <a class="code" href="classXalanTranscodingServices.html#d11">getStreamProlog</a>(<font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;   theEncodingName);
00177 
00184     <font class="keyword">static</font> XalanDOMChar
00185     <a class="code" href="classXalanTranscodingServices.html#d13">getMaximumCharacterValue</a>(<font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;  theEncoding);
00186 
00195     <font class="keyword">static</font> XalanDOMChar
00196     <a class="code" href="classXalanTranscodingServices.html#d13">getMaximumCharacterValue</a>();
00197 
00205     <font class="keyword">static</font> <font class="keywordtype">bool</font>
00206     <a class="code" href="classXalanTranscodingServices.html#d14">getBytesEqualChars</a>(<font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;    theEncoding);
00207 
00208     <font class="keyword">static</font> <font class="keywordtype">bool</font>
<a name="l00209"></a><a class="code" href="classXalanTranscodingServices.html#d15">00209</a>     <a class="code" href="classXalanTranscodingServices.html#d15">canTranscodeToLocalCodePage</a>(UnicodeCharType     theChar)<font class="keyword"></font>
00210 <font class="keyword">    </font>{
00211         <font class="comment">// Yuck!! See getMaximumCharacterValue() for more details.</font>
00212         <font class="keywordflow">return</font> theChar &lt;= 0x7fu ? <font class="keyword">true</font> : <font class="keyword">false</font>;
00213     }
00214 
<a name="l00215"></a><a class="code" href="classXalanTranscodingServices.html#p0">00215</a>     <font class="keyword">static</font> <font class="keyword">const</font> XalanDOMChar   s_utf8String[];
00216 
<a name="l00217"></a><a class="code" href="classXalanTranscodingServices.html#p1">00217</a>     <font class="keyword">static</font> <font class="keyword">const</font> XalanDOMChar   s_utf16String[];
00218 
<a name="l00219"></a><a class="code" href="classXalanTranscodingServices.html#p2">00219</a>     <font class="keyword">static</font> <font class="keyword">const</font> XalanDOMChar   s_utf16LEString[];
00220 
<a name="l00221"></a><a class="code" href="classXalanTranscodingServices.html#p3">00221</a>     <font class="keyword">static</font> <font class="keyword">const</font> XalanDOMChar   s_utf16BEString[];
00222 
<a name="l00223"></a><a class="code" href="classXalanTranscodingServices.html#p4">00223</a>     <font class="keyword">static</font> <font class="keyword">const</font> XalanDOMChar   s_utf32String[];
00224 
<a name="l00225"></a><a class="code" href="classXalanTranscodingServices.html#p5">00225</a>     <font class="keyword">static</font> <font class="keyword">const</font> XalanDOMChar   s_asciiString[];
00226 
<a name="l00227"></a><a class="code" href="classXalanTranscodingServices.html#p6">00227</a>     <font class="keyword">static</font> <font class="keyword">const</font> XalanDOMChar   s_usASCIIString[];
00228 
<a name="l00229"></a><a class="code" href="classXalanTranscodingServices.html#p7">00229</a>     <font class="keyword">static</font> <font class="keyword">const</font> XalanDOMChar   s_windows1250String[];
00230 
<a name="l00231"></a><a class="code" href="classXalanTranscodingServices.html#p8">00231</a>     <font class="keyword">static</font> <font class="keyword">const</font> XalanDOMChar   s_iso88591String[];
00232 
<a name="l00233"></a><a class="code" href="classXalanTranscodingServices.html#p9">00233</a>     <font class="keyword">static</font> <font class="keyword">const</font> XalanDOMChar   s_shiftJISString[];
00234 
00235 
<a name="l00236"></a><a class="code" href="classXalanTranscodingServices_1_1UnrepresentableCharacterException.html">00236</a>     <font class="keyword">class </font>XALAN_PLATFORMSUPPORT_EXPORT UnrepresentableCharacterException : <font class="keyword">public</font> <a class="code" href="classXSLException.html">XSLException</a>
00237     {
00238     <font class="keyword">public</font>:
00239 
00240         <a class="code" href="classXalanTranscodingServices_1_1UnrepresentableCharacterException.html#a0">UnrepresentableCharacterException</a>(
00241             UnicodeCharType         theCharacter,
00242             <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;   theEncoding,
00243             <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;         theBuffer);
00244 
00245         <font class="keyword">virtual</font>
00246         <a class="code" href="classXalanTranscodingServices_1_1UnrepresentableCharacterException.html#a1">~UnrepresentableCharacterException</a>();
00247 
00248         UnicodeCharType
<a name="l00249"></a><a class="code" href="classXalanTranscodingServices_1_1UnrepresentableCharacterException.html#a2">00249</a>         <a class="code" href="classXalanTranscodingServices_1_1UnrepresentableCharacterException.html#a2">getCharacter</a>()<font class="keyword"> const</font>
00250 <font class="keyword">        </font>{
00251             <font class="keywordflow">return</font> m_badCharacter;
00252         }
00253 
00254         <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;
<a name="l00255"></a><a class="code" href="classXalanTranscodingServices_1_1UnrepresentableCharacterException.html#a3">00255</a>         <a class="code" href="classXalanTranscodingServices_1_1UnrepresentableCharacterException.html#a3">getEncoding</a>()<font class="keyword"> const</font>
00256 <font class="keyword">        </font>{
00257             <font class="keywordflow">return</font> m_encoding;
00258         }
00259 
00260         <font class="keyword">virtual</font> <font class="keyword">const</font> XalanDOMChar*
<a name="l00261"></a><a class="code" href="classXalanTranscodingServices_1_1UnrepresentableCharacterException.html#a4">00261</a>         <a class="code" href="classXalanTranscodingServices_1_1UnrepresentableCharacterException.html#a4">getType</a>()<font class="keyword"> const</font>
00262 <font class="keyword">        </font>{
00263             <font class="keywordflow">return</font> m_type;
00264         }
00265 
00266     <font class="keyword">private</font>:
00267         <font class="comment">// not implemented</font>
00268         <a class="code" href="classXalanTranscodingServices_1_1UnrepresentableCharacterException.html#a0">UnrepresentableCharacterException</a>(<font class="keyword">const</font> UnrepresentableCharacterException&amp;);
00269 
00270         <font class="keyword">static</font> <font class="keyword">const</font> XalanDOMChar   m_type[];
00271 
00272 
00273         <font class="keyword">const</font> UnicodeCharType   m_badCharacter;
00274 
00275         <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>    m_encoding;
00276     };
00277 
00278 <font class="keyword">private</font>:
00279 
00280     <font class="keyword">static</font> <font class="keyword">const</font> XalanXMLByte   s_dummyByteOrderMark[];
00281     <font class="keyword">static</font> <font class="keyword">const</font> XalanXMLByte   s_UTF8ByteOrderMark[];
00282     <font class="keyword">static</font> <font class="keyword">const</font> XalanDOMChar   s_UTF16ByteOrderMark[];
00283 };
00284 
00285 
00286 
<a name="l00287"></a><a class="code" href="classXalanOutputTranscoder.html">00287</a> <font class="keyword">class </font>XALAN_PLATFORMSUPPORT_EXPORT <a class="code" href="classXalanOutputTranscoder.html">XalanOutputTranscoder</a>
00288 {
00289 <font class="keyword">public</font>:
00290 
<a name="l00291"></a><a class="code" href="classXalanOutputTranscoder.html#s0">00291</a>     <font class="keyword">typedef</font> XalanTranscodingServices::XalanXMLByte      XalanXMLByte;
<a name="l00292"></a><a class="code" href="classXalanOutputTranscoder.html#s1">00292</a>     <font class="keyword">typedef</font> XalanTranscodingServices::eCode             eCode;
<a name="l00293"></a><a class="code" href="classXalanOutputTranscoder.html#s2">00293</a>     <font class="keyword">typedef</font> XalanTranscodingServices::size_type         size_type;
<a name="l00294"></a><a class="code" href="classXalanOutputTranscoder.html#s3">00294</a>     <font class="keyword">typedef</font> XalanTranscodingServices::UnicodeCharType   UnicodeCharType;
00295 
00296     <font class="keyword">explicit</font>
00297     <a class="code" href="XalanTranscodingServices_8hpp.html#a1">XalanOutputTranscoder</a>(MemoryManagerType&amp; theManager);
00298 
00299     <font class="keyword">virtual</font>
00300     <a class="code" href="classXalanOutputTranscoder.html#a1">~XalanOutputTranscoder</a>();
00301 
00302     MemoryManagerType&amp;
<a name="l00303"></a><a class="code" href="classXalanOutputTranscoder.html#a2">00303</a>     <a class="code" href="classXSLException.html#a10">getMemoryManager</a>()<font class="keyword"></font>
00304 <font class="keyword">    </font>{
00305         <font class="keywordflow">return</font> m_memoryManager;
00306     }
00307 
00321     <font class="keyword">virtual</font> eCode
00322     <a class="code" href="classXalanOutputTranscoder.html#a3">transcode</a>(
00323             <font class="keyword">const</font> XalanDOMChar*     theSourceData,
00324             size_type               theSourceCount,
00325             XalanXMLByte*           theTarget,
00326             size_type               theTargetSize,
00327             size_type&amp;              theSourceCharsTranscoded,
00328             size_type&amp;              theTargetBytesUsed) = 0;
00329 
00344     <font class="keyword">virtual</font> eCode
00345     <a class="code" href="classXalanOutputTranscoder.html#a3">transcode</a>(
00346             <font class="keyword">const</font> XalanXMLByte*     theSourceData,
00347             size_type               theSourceCount,
00348             XalanDOMChar*           theTarget,
00349             size_type               theTargetSize,
00350             size_type&amp;              theSourceCharsTranscoded,
00351             size_type&amp;              theTargetBytesUsed,
00352             <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font>*          theCharSizes) = 0;
00353 
00354     <font class="keyword">virtual</font> <font class="keywordtype">bool</font>
00355     <a class="code" href="classXalanOutputTranscoder.html#a5">canTranscodeTo</a>(UnicodeCharType  theChar) <font class="keyword">const</font> = 0;
00356 
00357 <font class="keyword">private</font>:
00358 
00359     MemoryManagerType&amp;              m_memoryManager;
00360     <font class="comment">// Not implemented...</font>
00361     <a class="code" href="XalanTranscodingServices_8hpp.html#a1">XalanOutputTranscoder</a>(<font class="keyword">const</font> <a class="code" href="classXalanOutputTranscoder.html">XalanOutputTranscoder</a>&amp;  theSource);
00362 
00363     <font class="keywordtype">bool</font>
00364     <a class="code" href="ElemAttributeSet_8hpp.html#a1">operator==</a>(<font class="keyword">const</font> <a class="code" href="classXalanOutputTranscoder.html">XalanOutputTranscoder</a>&amp; theRHS) <font class="keyword">const</font>;
00365 
00366     <a class="code" href="classXalanOutputTranscoder.html">XalanOutputTranscoder</a>&amp;
00367     operator=(<font class="keyword">const</font> <a class="code" href="classXalanOutputTranscoder.html">XalanOutputTranscoder</a>&amp;  theRHS);
00368 };
00369 
00370 
00371 
00372 XALAN_CPP_NAMESPACE_END
00373 
00374 
00375 
00376 <font class="preprocessor">#endif  // XALANTRANSCODINGSERVICES_HEADER_GUARD_1357924680</font>
</font></pre></div><p align="center"><a href="diagramnotes.html">Interpreting class diagrams</a></p>
<p><FONT color="#000000" face="arial,helvetica,sanserif" size="-1">
<i><A href="http://www.stack.nl/~dimitri/doxygen/">Doxygen</A> and 
<A href="http://www.research.att.com/sw/tools/graphviz/">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="820"><TR><TD bgcolor="#0086b2"><IMG height="1" src="../resources/dot.gif" width="1" alt="dot"></TD></TR></TABLE>
<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.10</B><BR>
			Copyright &copy; 1999-2004 The Apache Software Foundation. All Rights Reserved.</i></p>
		</TD>
	</TR>
	<TR>
		<TD WIDTH="100%">
			<P ALIGN="CENTER"><IMG SRC="ApacheLogo.jpg" WIDTH="387" HEIGHT="100" ALIGN="BOTTOM" BORDER="0" ALT="Apache Logo">
		</TD>
	</TR>
</TABLE>