Google Git
Sign in
apache / xalan-site / 1b0c6dd5447f3bc951dcdd0e155aae8fc8efd4de / . / xalan-c / apiDocs / classXalanOutputTranscoder.html
blob: 3ce3965993a82c30c07bb84c24cd7f83e4ac9ac8 [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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>XalanOutputTranscoder Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="XalanOutputTranscoder" -->
<p><code>#include &lt;<a class="el" href="XalanTranscodingServices_8hpp_source.html">XalanTranscodingServices.hpp</a>&gt;</code></p>
<p>Inherited by <a class="el" href="classXalanToXercesTranscoderWrapper.html">XalanToXercesTranscoderWrapper</a>, and <a class="el" href="classXalanUTF16Transcoder.html">XalanUTF16Transcoder</a>.</p>
<p><a href="classXalanOutputTranscoder-members.html">List of all members.</a></p>
<h2><a name="pub-types"></a>
Public Types</h2>
<ul>
<li>typedef <br class="typebreak"/>
<a class="el" href="classXalanTranscodingServices.html#a4b43275fdb575e1515572a6a3cab937a">XalanTranscodingServices::XalanXMLByte</a> <a class="el" href="classXalanOutputTranscoder.html#ade80f08c257deffdedd09ae11603aec0">XalanXMLByte</a>
<li>typedef <br class="typebreak"/>
<a class="el" href="classXalanTranscodingServices.html#af5c7c33ef0d33f11713309c6f5dac12e">XalanTranscodingServices::eCode</a> <a class="el" href="classXalanOutputTranscoder.html#ac21aa42db0df39cda13ba308fc80171f">eCode</a>
<li>typedef <br class="typebreak"/>
<a class="el" href="classXalanTranscodingServices.html#a803b202417ca9d2c306d759c83036b38">XalanTranscodingServices::size_type</a> <a class="el" href="classXalanOutputTranscoder.html#a6a916b266ee78074c0d9309e027e3e2b">size_type</a>
</ul>
<h2><a name="pub-methods"></a>
Public Member Functions</h2>
<ul>
<li><a class="el" href="classXalanOutputTranscoder.html#a5ad5f56a462862d4c9bb9587cf764bed">XalanOutputTranscoder</a> (MemoryManager &amp;theManager)
<li>virtual <a class="el" href="classXalanOutputTranscoder.html#aa5f25498c9f8e185f6fae37eec989062">~XalanOutputTranscoder</a> ()
<li>MemoryManager &amp; <a class="el" href="classXalanOutputTranscoder.html#a5afdcf993ca4a3421c0aa0756ace22b0">getMemoryManager</a> ()
<li>virtual <a class="el" href="classXalanTranscodingServices.html#af5c7c33ef0d33f11713309c6f5dac12e">eCode</a> <a class="el" href="classXalanOutputTranscoder.html#a9d43e3433264ebd83fc6bf7b7aa84955">transcode</a> (const XalanDOMChar *theSourceData, <a class="el" href="classXalanOutputTranscoder.html#a6a916b266ee78074c0d9309e027e3e2b">size_type</a> theSourceCount, <a class="el" href="classXalanOutputTranscoder.html#ade80f08c257deffdedd09ae11603aec0">XalanXMLByte</a> *theTarget, <a class="el" href="classXalanOutputTranscoder.html#a6a916b266ee78074c0d9309e027e3e2b">size_type</a> theTargetSize, <a class="el" href="classXalanOutputTranscoder.html#a6a916b266ee78074c0d9309e027e3e2b">size_type</a> &amp;theSourceCharsTranscoded, <a class="el" href="classXalanOutputTranscoder.html#a6a916b266ee78074c0d9309e027e3e2b">size_type</a> &amp;theTargetBytesUsed)=0
<dl class="el"><dd class="mdescRight">Transcode data from UTF-16 to the transcoder's encoding. <a href="#a9d43e3433264ebd83fc6bf7b7aa84955"></a><br/></dl><li>virtual <a class="el" href="classXalanTranscodingServices.html#af5c7c33ef0d33f11713309c6f5dac12e">eCode</a> <a class="el" href="classXalanOutputTranscoder.html#a08800efa7c137c61ad0203b83b9a5994">transcode</a> (const <a class="el" href="classXalanOutputTranscoder.html#ade80f08c257deffdedd09ae11603aec0">XalanXMLByte</a> *theSourceData, <a class="el" href="classXalanOutputTranscoder.html#a6a916b266ee78074c0d9309e027e3e2b">size_type</a> theSourceCount, XalanDOMChar *theTarget, <a class="el" href="classXalanOutputTranscoder.html#a6a916b266ee78074c0d9309e027e3e2b">size_type</a> theTargetSize, <a class="el" href="classXalanOutputTranscoder.html#a6a916b266ee78074c0d9309e027e3e2b">size_type</a> &amp;theSourceCharsTranscoded, <a class="el" href="classXalanOutputTranscoder.html#a6a916b266ee78074c0d9309e027e3e2b">size_type</a> &amp;theTargetBytesUsed, unsigned char *theCharSizes)=0
<dl class="el"><dd class="mdescRight">Transcode data from the transcoder's encoding to UTF-16. <a href="#a08800efa7c137c61ad0203b83b9a5994"></a><br/></dl><li>virtual bool <a class="el" href="classXalanOutputTranscoder.html#a394b841e954d6c031ff169b31c885541">canTranscodeTo</a> (XalanUnicodeChar theChar) const =0
</ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Definition at line <a class="el" href="XalanTranscodingServices_8hpp_source.html#l00332">332</a> of file <a class="el" href="XalanTranscodingServices_8hpp_source.html">XalanTranscodingServices.hpp</a>.</p>
<hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="ac21aa42db0df39cda13ba308fc80171f"></a><!-- doxytag: member="XalanOutputTranscoder::eCode" ref="ac21aa42db0df39cda13ba308fc80171f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classXalanTranscodingServices.html#af5c7c33ef0d33f11713309c6f5dac12e">XalanTranscodingServices::eCode</a> <a class="el" href="classXalanTranscodingServices.html#af5c7c33ef0d33f11713309c6f5dac12e">XalanOutputTranscoder::eCode</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="XalanTranscodingServices_8hpp_source.html#l00337">337</a> of file <a class="el" href="XalanTranscodingServices_8hpp_source.html">XalanTranscodingServices.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a6a916b266ee78074c0d9309e027e3e2b"></a><!-- doxytag: member="XalanOutputTranscoder::size_type" ref="a6a916b266ee78074c0d9309e027e3e2b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classXalanTranscodingServices.html#a803b202417ca9d2c306d759c83036b38">XalanTranscodingServices::size_type</a> <a class="el" href="classXalanOutputTranscoder.html#a6a916b266ee78074c0d9309e027e3e2b">XalanOutputTranscoder::size_type</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="XalanTranscodingServices_8hpp_source.html#l00338">338</a> of file <a class="el" href="XalanTranscodingServices_8hpp_source.html">XalanTranscodingServices.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="ade80f08c257deffdedd09ae11603aec0"></a><!-- doxytag: member="XalanOutputTranscoder::XalanXMLByte" ref="ade80f08c257deffdedd09ae11603aec0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classXalanTranscodingServices.html#a4b43275fdb575e1515572a6a3cab937a">XalanTranscodingServices::XalanXMLByte</a> <a class="el" href="classXalanOutputTranscoder.html#ade80f08c257deffdedd09ae11603aec0">XalanOutputTranscoder::XalanXMLByte</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="XalanTranscodingServices_8hpp_source.html#l00336">336</a> of file <a class="el" href="XalanTranscodingServices_8hpp_source.html">XalanTranscodingServices.hpp</a>.</p>
</div>
</div>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a5ad5f56a462862d4c9bb9587cf764bed"></a><!-- doxytag: member="XalanOutputTranscoder::XalanOutputTranscoder" ref="a5ad5f56a462862d4c9bb9587cf764bed" args="(MemoryManager &amp;theManager)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XalanOutputTranscoder::XalanOutputTranscoder </td>
<td>(</td>
<td class="paramtype">MemoryManager &amp;&nbsp;</td>
<td class="paramname"> <em>theManager</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aa5f25498c9f8e185f6fae37eec989062"></a><!-- doxytag: member="XalanOutputTranscoder::~XalanOutputTranscoder" ref="aa5f25498c9f8e185f6fae37eec989062" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual XalanOutputTranscoder::~XalanOutputTranscoder </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a394b841e954d6c031ff169b31c885541"></a><!-- doxytag: member="XalanOutputTranscoder::canTranscodeTo" ref="a394b841e954d6c031ff169b31c885541" args="(XalanUnicodeChar theChar) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool XalanOutputTranscoder::canTranscodeTo </td>
<td>(</td>
<td class="paramtype">XalanUnicodeChar&nbsp;</td>
<td class="paramname"> <em>theChar</em></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Implemented in <a class="el" href="classXalanToXercesTranscoderWrapper.html#a0436a00fd2dc0164b482aaddc95e8b74">XalanToXercesTranscoderWrapper</a>, and <a class="el" href="classXalanUTF16Transcoder.html#a68f8c4cbc4385916c21474d7d12e5924">XalanUTF16Transcoder</a>.</p>
</div>
</div>
<a class="anchor" id="a5afdcf993ca4a3421c0aa0756ace22b0"></a><!-- doxytag: member="XalanOutputTranscoder::getMemoryManager" ref="a5afdcf993ca4a3421c0aa0756ace22b0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MemoryManager&amp; XalanOutputTranscoder::getMemoryManager </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="XalanTranscodingServices_8hpp_source.html#l00347">347</a> of file <a class="el" href="XalanTranscodingServices_8hpp_source.html">XalanTranscodingServices.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a08800efa7c137c61ad0203b83b9a5994"></a><!-- doxytag: member="XalanOutputTranscoder::transcode" ref="a08800efa7c137c61ad0203b83b9a5994" args="(const XalanXMLByte *theSourceData, size_type theSourceCount, XalanDOMChar *theTarget, size_type theTargetSize, size_type &amp;theSourceCharsTranscoded, size_type &amp;theTargetBytesUsed, unsigned char *theCharSizes)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classXalanTranscodingServices.html#af5c7c33ef0d33f11713309c6f5dac12e">eCode</a> XalanOutputTranscoder::transcode </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXalanOutputTranscoder.html#ade80f08c257deffdedd09ae11603aec0">XalanXMLByte</a> *&nbsp;</td>
<td class="paramname"> <em>theSourceData</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classXalanOutputTranscoder.html#a6a916b266ee78074c0d9309e027e3e2b">size_type</a>&nbsp;</td>
<td class="paramname"> <em>theSourceCount</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">XalanDOMChar *&nbsp;</td>
<td class="paramname"> <em>theTarget</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classXalanOutputTranscoder.html#a6a916b266ee78074c0d9309e027e3e2b">size_type</a>&nbsp;</td>
<td class="paramname"> <em>theTargetSize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classXalanOutputTranscoder.html#a6a916b266ee78074c0d9309e027e3e2b">size_type</a> &amp;&nbsp;</td>
<td class="paramname"> <em>theSourceCharsTranscoded</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classXalanOutputTranscoder.html#a6a916b266ee78074c0d9309e027e3e2b">size_type</a> &amp;&nbsp;</td>
<td class="paramname"> <em>theTargetBytesUsed</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned char *&nbsp;</td>
<td class="paramname"> <em>theCharSizes</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Transcode data from the transcoder's encoding to UTF-16. </p>
<p>If successfull, theResult will be set to OK. If not, it will be set to one of the other codes.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>theSourceData</em>&nbsp;</td><td>The source data to transcode </td></tr>
<tr><td valign="top"></td><td valign="top"><em>theSourceCount</em>&nbsp;</td><td>The length of the source data. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>theTarget</em>&nbsp;</td><td>The target array for storing the transcoded data. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>theTargetSize</em>&nbsp;</td><td>The number of characters that can be stored in the target. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>theSourceCharsTranscoded</em>&nbsp;</td><td>The count of the source characters that were transcoded. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>theTargetBytesUsed</em>&nbsp;</td><td>The number of characters stored in the target array </td></tr>
<tr><td valign="top"></td><td valign="top"><em>theCharSizes</em>&nbsp;</td><td>For each character in theTarget, the number of characters consumed from theSourceData. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The result code. </dd></dl>
<p>Implemented in <a class="el" href="classXalanToXercesTranscoderWrapper.html#a75fe3a085b07b6eee3d085949439535e">XalanToXercesTranscoderWrapper</a>, and <a class="el" href="classXalanUTF16Transcoder.html#a07185a60e250c74e0bb6496145ea8bfa">XalanUTF16Transcoder</a>.</p>
</div>
</div>
<a class="anchor" id="a9d43e3433264ebd83fc6bf7b7aa84955"></a><!-- doxytag: member="XalanOutputTranscoder::transcode" ref="a9d43e3433264ebd83fc6bf7b7aa84955" args="(const XalanDOMChar *theSourceData, size_type theSourceCount, XalanXMLByte *theTarget, size_type theTargetSize, size_type &amp;theSourceCharsTranscoded, size_type &amp;theTargetBytesUsed)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classXalanTranscodingServices.html#af5c7c33ef0d33f11713309c6f5dac12e">eCode</a> XalanOutputTranscoder::transcode </td>
<td>(</td>
<td class="paramtype">const XalanDOMChar *&nbsp;</td>
<td class="paramname"> <em>theSourceData</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classXalanOutputTranscoder.html#a6a916b266ee78074c0d9309e027e3e2b">size_type</a>&nbsp;</td>
<td class="paramname"> <em>theSourceCount</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classXalanOutputTranscoder.html#ade80f08c257deffdedd09ae11603aec0">XalanXMLByte</a> *&nbsp;</td>
<td class="paramname"> <em>theTarget</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classXalanOutputTranscoder.html#a6a916b266ee78074c0d9309e027e3e2b">size_type</a>&nbsp;</td>
<td class="paramname"> <em>theTargetSize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classXalanOutputTranscoder.html#a6a916b266ee78074c0d9309e027e3e2b">size_type</a> &amp;&nbsp;</td>
<td class="paramname"> <em>theSourceCharsTranscoded</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classXalanOutputTranscoder.html#a6a916b266ee78074c0d9309e027e3e2b">size_type</a> &amp;&nbsp;</td>
<td class="paramname"> <em>theTargetBytesUsed</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Transcode data from UTF-16 to the transcoder's encoding. </p>
<p>If successfull, theResult will be set to OK. If not, it will be set to one of the other codes.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>theSourceData</em>&nbsp;</td><td>The source data to transcode </td></tr>
<tr><td valign="top"></td><td valign="top"><em>theSourceCount</em>&nbsp;</td><td>The length of the source data. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>theTarget</em>&nbsp;</td><td>The target array for storing the transcoded data. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>theTargetSize</em>&nbsp;</td><td>The number of characters that can be stored in the target. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>theSourceCharsTranscoded</em>&nbsp;</td><td>The count of the source characters that were transcoded. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>theTargetBytesUsed</em>&nbsp;</td><td>The number of characters stored in the target array </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The result code. </dd></dl>
<p>Implemented in <a class="el" href="classXalanToXercesTranscoderWrapper.html#a488958531a694b8fbed66435377c87fa">XalanToXercesTranscoderWrapper</a>, and <a class="el" href="classXalanUTF16Transcoder.html#a325260b966fae15244f7a27723c68ac1">XalanUTF16Transcoder</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XalanTranscodingServices_8hpp_source.html">XalanTranscodingServices.hpp</a></li>
</ul>
</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>