You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
468 lines
32 KiB
468 lines
32 KiB
<!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"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.9.1"/>
|
|
<title>Xerces-C++: XMLTranscoder Class Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">Xerces-C++
|
|
 <span id="projectnumber">3.1.2</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.9.1 -->
|
|
<div id="navrow1" 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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-types">Public Types</a> |
|
|
<a href="#pro-methods">Protected Member Functions</a> |
|
|
<a href="classXMLTranscoder-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">XMLTranscoder Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><code><a class="el" href="classXMLTranscoder.html" title="XMLTranscoder is for transcoding non-local code page encodings, i.e. ">XMLTranscoder</a></code> is for transcoding non-local code page encodings, i.e.
|
|
<a href="classXMLTranscoder.html#details">More...</a></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for XMLTranscoder:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classXMLTranscoder.png" usemap="#XMLTranscoder_map" alt=""/>
|
|
<map id="XMLTranscoder_map" name="XMLTranscoder_map">
|
|
<area href="classXMemory.html" title="This class makes it possible to override the C++ memory management by adding new/delete operators to ..." alt="XMemory" shape="rect" coords="0,0,104,24"/>
|
|
</map>
|
|
</div></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
|
|
Public Types</h2></td></tr>
|
|
<tr class="memitem:a0189aaebdb21f66d5f75383b68a88977"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classXMLTranscoder.html#a0189aaebdb21f66d5f75383b68a88977">UnRepOpts</a> { <a class="el" href="classXMLTranscoder.html#a0189aaebdb21f66d5f75383b68a88977a229094064f4df0c677985267231fe929">UnRep_Throw</a>,
|
|
<a class="el" href="classXMLTranscoder.html#a0189aaebdb21f66d5f75383b68a88977af58d3b8f8058b2b74e54f964f908e0e3">UnRep_RepChar</a>
|
|
}</td></tr>
|
|
<tr class="memdesc:a0189aaebdb21f66d5f75383b68a88977"><td class="mdescLeft"> </td><td class="mdescRight">This enum is used by the <code><a class="el" href="classXMLTranscoder.html#ab05cfacbdf33f720c615f3b49f8e5a7b" title="Converts from the internal XMLCh* encoding to the encoding of the service. ">transcodeTo()</a></code> method to indicate how to react to unrepresentable characters. <a href="classXMLTranscoder.html#a0189aaebdb21f66d5f75383b68a88977">More...</a><br /></td></tr>
|
|
<tr class="separator:a0189aaebdb21f66d5f75383b68a88977"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Destructor.</div></td></tr>
|
|
<tr class="memitem:a692d6db451c87b9450620235328b8f67"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classXMLTranscoder.html#a692d6db451c87b9450620235328b8f67">~XMLTranscoder</a> ()</td></tr>
|
|
<tr class="memdesc:a692d6db451c87b9450620235328b8f67"><td class="mdescLeft"> </td><td class="mdescRight">Destructor for <a class="el" href="classXMLTranscoder.html" title="XMLTranscoder is for transcoding non-local code page encodings, i.e. ">XMLTranscoder</a>. <a href="#a692d6db451c87b9450620235328b8f67">More...</a><br /></td></tr>
|
|
<tr class="separator:a692d6db451c87b9450620235328b8f67"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">The virtual transcoding interface</div></td></tr>
|
|
<tr class="memitem:ab14defff33f7161782acaca7e256259d"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#ac0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXMLTranscoder.html#ab14defff33f7161782acaca7e256259d">transcodeFrom</a> (const <a class="el" href="XercesDefs_8hpp.html#a7470c7a32c59355685ebcd878a33f126">XMLByte</a> *const srcData, const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#ac0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> srcCount, <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *const toFill, const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#ac0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> maxChars, <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#ac0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> &bytesEaten, unsigned char *const charSizes)=0</td></tr>
|
|
<tr class="memdesc:ab14defff33f7161782acaca7e256259d"><td class="mdescLeft"> </td><td class="mdescRight">Converts from the encoding of the service to the internal XMLCh* encoding. <a href="#ab14defff33f7161782acaca7e256259d">More...</a><br /></td></tr>
|
|
<tr class="separator:ab14defff33f7161782acaca7e256259d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab05cfacbdf33f720c615f3b49f8e5a7b"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#ac0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXMLTranscoder.html#ab05cfacbdf33f720c615f3b49f8e5a7b">transcodeTo</a> (const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *const srcData, const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#ac0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> srcCount, <a class="el" href="XercesDefs_8hpp.html#a7470c7a32c59355685ebcd878a33f126">XMLByte</a> *const toFill, const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#ac0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> maxBytes, <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#ac0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> &charsEaten, const <a class="el" href="classXMLTranscoder.html#a0189aaebdb21f66d5f75383b68a88977">UnRepOpts</a> options)=0</td></tr>
|
|
<tr class="memdesc:ab05cfacbdf33f720c615f3b49f8e5a7b"><td class="mdescLeft"> </td><td class="mdescRight">Converts from the internal XMLCh* encoding to the encoding of the service. <a href="#ab05cfacbdf33f720c615f3b49f8e5a7b">More...</a><br /></td></tr>
|
|
<tr class="separator:ab05cfacbdf33f720c615f3b49f8e5a7b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad390abcb373540ab460408b27f098e54"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classXMLTranscoder.html#ad390abcb373540ab460408b27f098e54">canTranscodeTo</a> (const unsigned int toCheck)=0</td></tr>
|
|
<tr class="memdesc:ad390abcb373540ab460408b27f098e54"><td class="mdescLeft"> </td><td class="mdescRight">Query whether the transcoder can handle a given character. <a href="#ad390abcb373540ab460408b27f098e54">More...</a><br /></td></tr>
|
|
<tr class="separator:ad390abcb373540ab460408b27f098e54"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Getter methods</div></td></tr>
|
|
<tr class="memitem:a2e436bd211ba823fa77af4f5d15fec83"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#ac0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXMLTranscoder.html#a2e436bd211ba823fa77af4f5d15fec83">getBlockSize</a> () const </td></tr>
|
|
<tr class="memdesc:a2e436bd211ba823fa77af4f5d15fec83"><td class="mdescLeft"> </td><td class="mdescRight">Get the internal block size. <a href="#a2e436bd211ba823fa77af4f5d15fec83">More...</a><br /></td></tr>
|
|
<tr class="separator:a2e436bd211ba823fa77af4f5d15fec83"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae6504b962e5540dc19cb7b8a10b1c263"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXMLTranscoder.html#ae6504b962e5540dc19cb7b8a10b1c263">getEncodingName</a> () const </td></tr>
|
|
<tr class="memdesc:ae6504b962e5540dc19cb7b8a10b1c263"><td class="mdescLeft"> </td><td class="mdescRight">Get the encoding name. <a href="#ae6504b962e5540dc19cb7b8a10b1c263">More...</a><br /></td></tr>
|
|
<tr class="separator:ae6504b962e5540dc19cb7b8a10b1c263"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3affa8b64dffd3829d81869049d69d14"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classMemoryManager.html">MemoryManager</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXMLTranscoder.html#a3affa8b64dffd3829d81869049d69d14">getMemoryManager</a> () const </td></tr>
|
|
<tr class="memdesc:a3affa8b64dffd3829d81869049d69d14"><td class="mdescLeft"> </td><td class="mdescRight">Get the plugged-in memory manager. <a href="#a3affa8b64dffd3829d81869049d69d14">More...</a><br /></td></tr>
|
|
<tr class="separator:a3affa8b64dffd3829d81869049d69d14"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_classXMemory"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classXMemory')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classXMemory.html">XMemory</a></td></tr>
|
|
<tr class="memitem:a717678d9deadc627a41fe0dddede9f7f inherit pub_methods_classXMemory"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXMemory.html#a717678d9deadc627a41fe0dddede9f7f">operator new</a> (size_t size)</td></tr>
|
|
<tr class="memdesc:a717678d9deadc627a41fe0dddede9f7f inherit pub_methods_classXMemory"><td class="mdescLeft"> </td><td class="mdescRight">This method overrides operator new. <a href="#a717678d9deadc627a41fe0dddede9f7f">More...</a><br /></td></tr>
|
|
<tr class="separator:a717678d9deadc627a41fe0dddede9f7f inherit pub_methods_classXMemory"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac3022fcc968c684a31c1e6a9ede83c10 inherit pub_methods_classXMemory"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXMemory.html#ac3022fcc968c684a31c1e6a9ede83c10">operator new</a> (size_t size, <a class="el" href="classMemoryManager.html">MemoryManager</a> *memMgr)</td></tr>
|
|
<tr class="memdesc:ac3022fcc968c684a31c1e6a9ede83c10 inherit pub_methods_classXMemory"><td class="mdescLeft"> </td><td class="mdescRight">This method defines a custom operator new, that will use the provided memory manager to perform the allocation. <a href="#ac3022fcc968c684a31c1e6a9ede83c10">More...</a><br /></td></tr>
|
|
<tr class="separator:ac3022fcc968c684a31c1e6a9ede83c10 inherit pub_methods_classXMemory"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeaad885b799ac2188ffd28f76182339c inherit pub_methods_classXMemory"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXMemory.html#aeaad885b799ac2188ffd28f76182339c">operator new</a> (size_t size, void *ptr)</td></tr>
|
|
<tr class="memdesc:aeaad885b799ac2188ffd28f76182339c inherit pub_methods_classXMemory"><td class="mdescLeft"> </td><td class="mdescRight">This method overrides placement operator new. <a href="#aeaad885b799ac2188ffd28f76182339c">More...</a><br /></td></tr>
|
|
<tr class="separator:aeaad885b799ac2188ffd28f76182339c inherit pub_methods_classXMemory"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9da30f1601ea458908cbf150fc2f8f8b inherit pub_methods_classXMemory"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXMemory.html#a9da30f1601ea458908cbf150fc2f8f8b">operator delete</a> (void *p)</td></tr>
|
|
<tr class="memdesc:a9da30f1601ea458908cbf150fc2f8f8b inherit pub_methods_classXMemory"><td class="mdescLeft"> </td><td class="mdescRight">This method overrides operator delete. <a href="#a9da30f1601ea458908cbf150fc2f8f8b">More...</a><br /></td></tr>
|
|
<tr class="separator:a9da30f1601ea458908cbf150fc2f8f8b inherit pub_methods_classXMemory"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a22efbc6459bdbe79f83b7791bba4d1f6 inherit pub_methods_classXMemory"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXMemory.html#a22efbc6459bdbe79f83b7791bba4d1f6">operator delete</a> (void *p, <a class="el" href="classMemoryManager.html">MemoryManager</a> *memMgr)</td></tr>
|
|
<tr class="memdesc:a22efbc6459bdbe79f83b7791bba4d1f6 inherit pub_methods_classXMemory"><td class="mdescLeft"> </td><td class="mdescRight">This method provides a matching delete for the custom operator new. <a href="#a22efbc6459bdbe79f83b7791bba4d1f6">More...</a><br /></td></tr>
|
|
<tr class="separator:a22efbc6459bdbe79f83b7791bba4d1f6 inherit pub_methods_classXMemory"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a32ee38b70d412e12f669cfbd86adf623 inherit pub_methods_classXMemory"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXMemory.html#a32ee38b70d412e12f669cfbd86adf623">operator delete</a> (void *p, void *ptr)</td></tr>
|
|
<tr class="memdesc:a32ee38b70d412e12f669cfbd86adf623 inherit pub_methods_classXMemory"><td class="mdescLeft"> </td><td class="mdescRight">This method provides a matching delete for the placement new. <a href="#a32ee38b70d412e12f669cfbd86adf623">More...</a><br /></td></tr>
|
|
<tr class="separator:a32ee38b70d412e12f669cfbd86adf623 inherit pub_methods_classXMemory"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
|
|
Protected Member Functions</h2></td></tr>
|
|
<tr class="memitem:ab634235f90e1719fded6c54bcafa75b2"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXMLTranscoder.html#ab634235f90e1719fded6c54bcafa75b2">XMLTranscoder</a> (const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *const encodingName, const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#ac0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> blockSize, <a class="el" href="classMemoryManager.html">MemoryManager</a> *const manager=<a class="el" href="classXMLPlatformUtils.html#a97eff0d9fff3567bea3acd3ca4d95252">XMLPlatformUtils::fgMemoryManager</a>)</td></tr>
|
|
<tr class="separator:ab634235f90e1719fded6c54bcafa75b2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pro_methods_classXMemory"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classXMemory')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classXMemory.html">XMemory</a></td></tr>
|
|
<tr class="memitem:ae5b8adaa10d5d9276b42823f47e06858 inherit pro_methods_classXMemory"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXMemory.html#ae5b8adaa10d5d9276b42823f47e06858">XMemory</a> ()</td></tr>
|
|
<tr class="memdesc:ae5b8adaa10d5d9276b42823f47e06858 inherit pro_methods_classXMemory"><td class="mdescLeft"> </td><td class="mdescRight">Protected default constructor. <a href="#ae5b8adaa10d5d9276b42823f47e06858">More...</a><br /></td></tr>
|
|
<tr class="separator:ae5b8adaa10d5d9276b42823f47e06858 inherit pro_methods_classXMemory"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p><code><a class="el" href="classXMLTranscoder.html" title="XMLTranscoder is for transcoding non-local code page encodings, i.e. ">XMLTranscoder</a></code> is for transcoding non-local code page encodings, i.e. </p>
|
|
<p>named encodings. These are used internally by the scanner to internalize raw XML into the internal Unicode format, and by writer classes to convert that internal Unicode format (which comes out of the parser) back out to a format that the receiving client code wants to use. </p>
|
|
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
|
|
<a class="anchor" id="a0189aaebdb21f66d5f75383b68a88977"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="classXMLTranscoder.html#a0189aaebdb21f66d5f75383b68a88977">XMLTranscoder::UnRepOpts</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This enum is used by the <code><a class="el" href="classXMLTranscoder.html#ab05cfacbdf33f720c615f3b49f8e5a7b" title="Converts from the internal XMLCh* encoding to the encoding of the service. ">transcodeTo()</a></code> method to indicate how to react to unrepresentable characters. </p>
|
|
<p>The <code><a class="el" href="classXMLTranscoder.html#ab14defff33f7161782acaca7e256259d" title="Converts from the encoding of the service to the internal XMLCh* encoding. ">transcodeFrom()</a></code> method always works the same. It will consider any invalid data to be an error and throw. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="a0189aaebdb21f66d5f75383b68a88977a229094064f4df0c677985267231fe929"></a>UnRep_Throw </td><td class="fielddoc">
|
|
<p>Throw an exception. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="a0189aaebdb21f66d5f75383b68a88977af58d3b8f8058b2b74e54f964f908e0e3"></a>UnRep_RepChar </td><td class="fielddoc">
|
|
<p>Use the replacement char. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="a692d6db451c87b9450620235328b8f67"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual XMLTranscoder::~XMLTranscoder </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Destructor for <a class="el" href="classXMLTranscoder.html" title="XMLTranscoder is for transcoding non-local code page encodings, i.e. ">XMLTranscoder</a>. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab634235f90e1719fded6c54bcafa75b2"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">XMLTranscoder::XMLTranscoder </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *const </td>
|
|
<td class="paramname"><em>encodingName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#ac0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> </td>
|
|
<td class="paramname"><em>blockSize</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classMemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="paramname"><em>manager</em> = <code><a class="el" href="classXMLPlatformUtils.html#a97eff0d9fff3567bea3acd3ca4d95252">XMLPlatformUtils::fgMemoryManager</a></code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="ad390abcb373540ab460408b27f098e54"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool XMLTranscoder::canTranscodeTo </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const unsigned int </td>
|
|
<td class="paramname"><em>toCheck</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Query whether the transcoder can handle a given character. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">toCheck</td><td>the character code point to check </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a2e436bd211ba823fa77af4f5d15fec83"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#ac0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> XMLTranscoder::getBlockSize </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the internal block size. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The block size indicated in the constructor. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ae6504b962e5540dc19cb7b8a10b1c263"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> * XMLTranscoder::getEncodingName </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the encoding name. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>the name of the encoding that this <code><a class="el" href="classXMLTranscoder.html" title="XMLTranscoder is for transcoding non-local code page encodings, i.e. ">XMLTranscoder</a></code> object is for </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a3affa8b64dffd3829d81869049d69d14"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classMemoryManager.html">MemoryManager</a> * XMLTranscoder::getMemoryManager </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the plugged-in memory manager. </p>
|
|
<p>This method returns the plugged-in memory manager user for dynamic memory allocation/deallocation.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>the plugged-in memory manager </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab14defff33f7161782acaca7e256259d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#ac0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> XMLTranscoder::transcodeFrom </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="XercesDefs_8hpp.html#a7470c7a32c59355685ebcd878a33f126">XMLByte</a> *const </td>
|
|
<td class="paramname"><em>srcData</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#ac0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> </td>
|
|
<td class="paramname"><em>srcCount</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *const </td>
|
|
<td class="paramname"><em>toFill</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#ac0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> </td>
|
|
<td class="paramname"><em>maxChars</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#ac0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> & </td>
|
|
<td class="paramname"><em>bytesEaten</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned char *const </td>
|
|
<td class="paramname"><em>charSizes</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Converts from the encoding of the service to the internal XMLCh* encoding. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">srcData</td><td>the source buffer to be transcoded </td></tr>
|
|
<tr><td class="paramname">srcCount</td><td>number of bytes in the source buffer </td></tr>
|
|
<tr><td class="paramname">toFill</td><td>the destination buffer </td></tr>
|
|
<tr><td class="paramname">maxChars</td><td>the max number of characters in the destination buffer </td></tr>
|
|
<tr><td class="paramname">bytesEaten</td><td>after transcoding, this will hold the number of bytes that were processed from the source buffer </td></tr>
|
|
<tr><td class="paramname">charSizes</td><td>an array which must be at least as big as maxChars into which will be inserted values that indicate how many bytes from the input went into each XMLCh that was created into toFill. Since many encodings use variable numbers of byte per character, this provides a means to find out what bytes in the input went into making a particular output UTF-16 character. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns the number of chars put into the target buffer </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab05cfacbdf33f720c615f3b49f8e5a7b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#ac0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> XMLTranscoder::transcodeTo </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *const </td>
|
|
<td class="paramname"><em>srcData</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#ac0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> </td>
|
|
<td class="paramname"><em>srcCount</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="XercesDefs_8hpp.html#a7470c7a32c59355685ebcd878a33f126">XMLByte</a> *const </td>
|
|
<td class="paramname"><em>toFill</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#ac0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> </td>
|
|
<td class="paramname"><em>maxBytes</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#ac0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> & </td>
|
|
<td class="paramname"><em>charsEaten</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classXMLTranscoder.html#a0189aaebdb21f66d5f75383b68a88977">UnRepOpts</a> </td>
|
|
<td class="paramname"><em>options</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Converts from the internal XMLCh* encoding to the encoding of the service. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">srcData</td><td>the source buffer to be transcoded </td></tr>
|
|
<tr><td class="paramname">srcCount</td><td>number of characters in the source buffer </td></tr>
|
|
<tr><td class="paramname">toFill</td><td>the destination buffer </td></tr>
|
|
<tr><td class="paramname">maxBytes</td><td>the max number of bytes in the destination buffer </td></tr>
|
|
<tr><td class="paramname">charsEaten</td><td>after transcoding, this will hold the number of chars that were processed from the source buffer </td></tr>
|
|
<tr><td class="paramname">options</td><td>options to pass to the transcoder that explain how to respond to an unrepresentable character </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns the number of chars put into the target buffer </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="TransService_8hpp_source.html">TransService.hpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Wed Mar 18 2015 10:43:39 for Xerces-C++ by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.9.1
|
|
</small></address>
|
|
</body>
|
|
</html>
|