classboost_1_1locale_1_1generic__codecvt_3_01CharType_00_01CodecvtImpl_00_012_01_4.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.6"/>
  7. <title>Boost.Locale: boost::locale::generic_codecvt&lt; CharType, CodecvtImpl, 2 &gt; Class Template Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="resize.js"></script>
  13. <script type="text/javascript" src="navtree.js"></script>
  14. <script type="text/javascript">
  15. $(document).ready(initResizable);
  16. $(window).load(resizeHeight);
  17. </script>
  18. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  19. </head>
  20. <body>
  21. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  22. <div id="titlearea">
  23. <table cellspacing="0" cellpadding="0">
  24. <tbody>
  25. <tr style="height: 56px;">
  26. <td id="projectlogo"><img alt="Logo" src="boost-small.png"/></td>
  27. <td style="padding-left: 0.5em;">
  28. <div id="projectname">Boost.Locale
  29. </div>
  30. </td>
  31. </tr>
  32. </tbody>
  33. </table>
  34. </div>
  35. <!-- end header part -->
  36. <!-- Generated by Doxygen 1.8.6 -->
  37. <div id="navrow1" class="tabs">
  38. <ul class="tablist">
  39. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  40. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  41. <li><a href="modules.html"><span>Modules</span></a></li>
  42. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  43. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  44. <li><a href="files.html"><span>Files</span></a></li>
  45. <li><a href="examples.html"><span>Examples</span></a></li>
  46. </ul>
  47. </div>
  48. <div id="navrow2" class="tabs2">
  49. <ul class="tablist">
  50. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  51. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  52. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  53. </ul>
  54. </div>
  55. </div><!-- top -->
  56. <div id="side-nav" class="ui-resizable side-nav-resizable">
  57. <div id="nav-tree">
  58. <div id="nav-tree-contents">
  59. <div id="nav-sync" class="sync"></div>
  60. </div>
  61. </div>
  62. <div id="splitbar" style="-moz-user-select:none;"
  63. class="ui-resizable-handle">
  64. </div>
  65. </div>
  66. <script type="text/javascript">
  67. $(document).ready(function(){initNavTree('classboost_1_1locale_1_1generic__codecvt_3_01CharType_00_01CodecvtImpl_00_012_01_4.html','');});
  68. </script>
  69. <div id="doc-content">
  70. <div class="header">
  71. <div class="summary">
  72. <a href="#pub-types">Public Types</a> &#124;
  73. <a href="#pub-methods">Public Member Functions</a> &#124;
  74. <a href="#pro-methods">Protected Member Functions</a> &#124;
  75. <a href="classboost_1_1locale_1_1generic__codecvt_3_01CharType_00_01CodecvtImpl_00_012_01_4-members.html">List of all members</a> </div>
  76. <div class="headertitle">
  77. <div class="title">boost::locale::generic_codecvt&lt; CharType, CodecvtImpl, 2 &gt; Class Template Reference</div> </div>
  78. </div><!--header-->
  79. <div class="contents">
  80. <p>UTF-16 to/from UTF-8 codecvt facet to use with char16_t or wchar_t on Windows.
  81. <a href="classboost_1_1locale_1_1generic__codecvt_3_01CharType_00_01CodecvtImpl_00_012_01_4.html#details">More...</a></p>
  82. <p><code>#include &lt;<a class="el" href="generic__codecvt_8hpp_source.html">boost/locale/generic_codecvt.hpp</a>&gt;</code></p>
  83. <div class="dynheader">
  84. Inheritance diagram for boost::locale::generic_codecvt&lt; CharType, CodecvtImpl, 2 &gt;:</div>
  85. <div class="dyncontent">
  86. <div class="center">
  87. <img src="classboost_1_1locale_1_1generic__codecvt_3_01CharType_00_01CodecvtImpl_00_012_01_4.png" usemap="#boost::locale::generic_codecvt&lt; CharType, CodecvtImpl, 2 &gt;_map" alt=""/>
  88. <map id="boost::locale::generic_codecvt&lt; CharType, CodecvtImpl, 2 &gt;_map" name="boost::locale::generic_codecvt&lt; CharType, CodecvtImpl, 2 &gt;_map">
  89. <area href="classboost_1_1locale_1_1generic__codecvt__base.html" title="A base class that used to define constants for generic_codecvt. " alt="boost::locale::generic_codecvt_base" shape="rect" coords="367,0,724,24"/>
  90. </map>
  91. </div></div>
  92. <table class="memberdecls">
  93. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
  94. Public Types</h2></td></tr>
  95. <tr class="memitem:a7a7bfedcd737a468fbc662352c8b16e8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7a7bfedcd737a468fbc662352c8b16e8"></a>
  96. typedef CharType&#160;</td><td class="memItemRight" valign="bottom"><b>uchar</b></td></tr>
  97. <tr class="separator:a7a7bfedcd737a468fbc662352c8b16e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="inherit_header pub_types_classboost_1_1locale_1_1generic__codecvt__base"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classboost_1_1locale_1_1generic__codecvt__base')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="classboost_1_1locale_1_1generic__codecvt__base.html">boost::locale::generic_codecvt_base</a></td></tr>
  99. <tr class="memitem:af28c4b64af6cbf2eb01c444e2cdf08c3 inherit pub_types_classboost_1_1locale_1_1generic__codecvt__base"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1generic__codecvt__base.html#af28c4b64af6cbf2eb01c444e2cdf08c3">initial_convertion_state</a> { <a class="el" href="classboost_1_1locale_1_1generic__codecvt__base.html#af28c4b64af6cbf2eb01c444e2cdf08c3a07029d87e1c62675db6b857d7b6214ec">to_unicode_state</a>,
  100. <a class="el" href="classboost_1_1locale_1_1generic__codecvt__base.html#af28c4b64af6cbf2eb01c444e2cdf08c3a2386c685ac9676370a20d2802184fed1">from_unicode_state</a>
  101. }</td></tr>
  102. <tr class="separator:af28c4b64af6cbf2eb01c444e2cdf08c3 inherit pub_types_classboost_1_1locale_1_1generic__codecvt__base"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. </table><table class="memberdecls">
  104. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  105. Public Member Functions</h2></td></tr>
  106. <tr class="memitem:ae0bf8a3f96c872d116180d624d5fefe6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae0bf8a3f96c872d116180d624d5fefe6"></a>
  107. &#160;</td><td class="memItemRight" valign="bottom"><b>generic_codecvt</b> (size_t refs=0)</td></tr>
  108. <tr class="separator:ae0bf8a3f96c872d116180d624d5fefe6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:ac791c7c243c94d531e03355d0542c07d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac791c7c243c94d531e03355d0542c07d"></a>
  110. CodecvtImpl const &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>implementation</b> () const </td></tr>
  111. <tr class="separator:ac791c7c243c94d531e03355d0542c07d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. </table><table class="memberdecls">
  113. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
  114. Protected Member Functions</h2></td></tr>
  115. <tr class="memitem:a84f7fe1ae2d0cb219ac0e0bffe2ee5fe"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a84f7fe1ae2d0cb219ac0e0bffe2ee5fe"></a>
  116. virtual std::codecvt_base::result&#160;</td><td class="memItemRight" valign="bottom"><b>do_unshift</b> (std::mbstate_t &amp;s, char *from, char *, char *&amp;next) const </td></tr>
  117. <tr class="separator:a84f7fe1ae2d0cb219ac0e0bffe2ee5fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:af8417b06caaf0bb1162ae6762fe4b3e6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af8417b06caaf0bb1162ae6762fe4b3e6"></a>
  119. virtual int&#160;</td><td class="memItemRight" valign="bottom"><b>do_encoding</b> () const throw ()</td></tr>
  120. <tr class="separator:af8417b06caaf0bb1162ae6762fe4b3e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:a0f497585138528c91eeece9d506a9661"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0f497585138528c91eeece9d506a9661"></a>
  122. virtual int&#160;</td><td class="memItemRight" valign="bottom"><b>do_max_length</b> () const throw ()</td></tr>
  123. <tr class="separator:a0f497585138528c91eeece9d506a9661"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:a4932099df788bb2992762aef8cd97079"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4932099df788bb2992762aef8cd97079"></a>
  125. virtual bool&#160;</td><td class="memItemRight" valign="bottom"><b>do_always_noconv</b> () const throw ()</td></tr>
  126. <tr class="separator:a4932099df788bb2992762aef8cd97079"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:a55bf86bfcf596f01b6390d300720b7f2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a55bf86bfcf596f01b6390d300720b7f2"></a>
  128. virtual int&#160;</td><td class="memItemRight" valign="bottom"><b>do_length</b> (std::mbstate_t &amp;std_state, char const *from, char const *from_end, size_t max) const </td></tr>
  129. <tr class="separator:a55bf86bfcf596f01b6390d300720b7f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="memitem:a40fecddd1d876887e8d696af02936b85"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a40fecddd1d876887e8d696af02936b85"></a>
  131. virtual std::codecvt_base::result&#160;</td><td class="memItemRight" valign="bottom"><b>do_in</b> (std::mbstate_t &amp;std_state, char const *from, char const *from_end, char const *&amp;from_next, uchar *to, uchar *to_end, uchar *&amp;to_next) const </td></tr>
  132. <tr class="separator:a40fecddd1d876887e8d696af02936b85"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:aacf028cb7760885bea33dbddf8b82cf1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aacf028cb7760885bea33dbddf8b82cf1"></a>
  134. virtual std::codecvt_base::result&#160;</td><td class="memItemRight" valign="bottom"><b>do_out</b> (std::mbstate_t &amp;std_state, uchar const *from, uchar const *from_end, uchar const *&amp;from_next, char *to, char *to_end, char *&amp;to_next) const </td></tr>
  135. <tr class="separator:aacf028cb7760885bea33dbddf8b82cf1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. </table>
  137. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  138. <div class="textblock"><h3>template&lt;typename CharType, typename CodecvtImpl&gt;<br/>
  139. class boost::locale::generic_codecvt&lt; CharType, CodecvtImpl, 2 &gt;</h3>
  140. <p>UTF-16 to/from UTF-8 codecvt facet to use with char16_t or wchar_t on Windows. </p>
  141. <p>Note in order to fit the requirements of usability by std::wfstream it uses mbstate_t to handle intermediate states in handling of variable length UTF-16 sequences</p>
  142. <p>Its member functions implement standard virtual functions of basic codecvt </p>
  143. </div><hr/>The documentation for this class was generated from the following file:<ul>
  144. <li>boost/locale/<a class="el" href="generic__codecvt_8hpp_source.html">generic_codecvt.hpp</a></li>
  145. </ul>
  146. </div><!-- contents -->
  147. </div><!-- doc-content -->
  148. <li class="footer">
  149. &copy; Copyright 2009-2012 Artyom Beilis, Distributed under the <a href="http://www.boost.org/LICENSE_1_0.txt">Boost Software License</a>, Version 1.0.
  150. </li>
  151. </ul>
  152. </div>
  153. </body>
  154. </html>