locale/doc/html/utf8__codecvt_8hpp_source.html
2015-10-18 17:31:48 +03:00

158 lines
17 KiB
HTML

<!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.6"/>
<title>Boost.Locale: boost/locale/utf8_codecvt.hpp Source File</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</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 id="projectlogo"><img alt="Logo" src="boost-small.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">Boost.Locale
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</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>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('utf8__codecvt_8hpp_source.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">utf8_codecvt.hpp</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// Copyright (c) 2015 Artyom Beilis (Tonkikh)</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">// Distributed under the Boost Software License, Version 1.0. (See</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">// accompanying file LICENSE_1_0.txt or copy at</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">// http://www.boost.org/LICENSE_1_0.txt)</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#ifndef BOOST_LOCALE_UTF8_CODECVT_HPP</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define BOOST_LOCALE_UTF8_CODECVT_HPP</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#include &lt;boost/locale/utf.hpp&gt;</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#include &lt;boost/locale/generic_codecvt.hpp&gt;</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#include &lt;boost/cstdint.hpp&gt;</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#include &lt;locale&gt;</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="keyword">namespace </span>boost {</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="keyword">namespace </span>locale {</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> CharType&gt;</div>
<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="classboost_1_1locale_1_1utf8__codecvt.html"> 23</a></span>&#160;<span class="keyword">class </span><a class="code" href="classboost_1_1locale_1_1utf8__codecvt.html">utf8_codecvt</a> : <span class="keyword">public</span> <a class="code" href="classboost_1_1locale_1_1generic__codecvt.html">generic_codecvt</a>&lt;CharType,utf8_codecvt&lt;CharType&gt; &gt; </div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;{</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; </div>
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="structboost_1_1locale_1_1utf8__codecvt_1_1state__type.html"> 27</a></span>&#160; <span class="keyword">struct </span><a class="code" href="structboost_1_1locale_1_1utf8__codecvt_1_1state__type.html">state_type</a> {};</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <a class="code" href="classboost_1_1locale_1_1utf8__codecvt.html">utf8_codecvt</a>(<span class="keywordtype">size_t</span> refs = 0) : <a class="code" href="classboost_1_1locale_1_1generic__codecvt.html">generic_codecvt</a>&lt;CharType,<a class="code" href="classboost_1_1locale_1_1utf8__codecvt.html">utf8_codecvt</a>&lt;CharType&gt; &gt;(refs)</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; {</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; }</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keyword">static</span> <span class="keywordtype">int</span> max_encoding_length()</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; {</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keywordflow">return</span> 4;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; }</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keyword">static</span> state_type initial_state(<a class="code" href="classboost_1_1locale_1_1generic__codecvt__base.html#af28c4b64af6cbf2eb01c444e2cdf08c3">generic_codecvt_base::initial_convertion_state</a> <span class="comment">/* unused */</span>)</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; {</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keywordflow">return</span> state_type();</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; }</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keyword">static</span> <a class="code" href="namespaceboost_1_1locale_1_1utf.html#a068111a6b9d6d465a63893ed5c05e2f8">utf::code_point</a> to_unicode(state_type &amp;,<span class="keywordtype">char</span> <span class="keyword">const</span> *&amp;begin,<span class="keywordtype">char</span> <span class="keyword">const</span> *end) </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; {</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keywordtype">char</span> <span class="keyword">const</span> *p=begin;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <a class="code" href="namespaceboost_1_1locale_1_1utf.html#a068111a6b9d6d465a63893ed5c05e2f8">utf::code_point</a> c = <a class="code" href="structboost_1_1locale_1_1utf_1_1utf__traits.html#a9b6b01fa6705ba67ac78359ddee03213">utf::utf_traits&lt;char&gt;::decode</a>(p,end);</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keywordflow">if</span>(c!=<a class="code" href="namespaceboost_1_1locale_1_1utf.html#a30010000878c7732340bda8956b844fb">utf::illegal</a> &amp;&amp; c!=<a class="code" href="namespaceboost_1_1locale_1_1utf.html#a20dbe458fd18229a0e6c09888d031b38">utf::incomplete</a>)</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; begin = p;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keywordflow">return</span> c;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; }</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keyword">static</span> <a class="code" href="namespaceboost_1_1locale_1_1utf.html#a068111a6b9d6d465a63893ed5c05e2f8">utf::code_point</a> from_unicode(state_type &amp;,<a class="code" href="namespaceboost_1_1locale_1_1utf.html#a068111a6b9d6d465a63893ed5c05e2f8">utf::code_point</a> u,<span class="keywordtype">char</span> *begin,<span class="keywordtype">char</span> <span class="keyword">const</span> *end) </div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; {</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keywordflow">if</span>(!<a class="code" href="namespaceboost_1_1locale_1_1utf.html#a189805c4e9f4c033ce5f88daf780e08e">utf::is_valid_codepoint</a>(u))</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keywordflow">return</span> <a class="code" href="namespaceboost_1_1locale_1_1utf.html#a30010000878c7732340bda8956b844fb">utf::illegal</a>;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="keywordtype">int</span> width;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keywordflow">if</span>((width=utf::utf_traits&lt;char&gt;::width(u)) &gt; end - begin)</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keywordflow">return</span> <a class="code" href="namespaceboost_1_1locale_1_1utf.html#a20dbe458fd18229a0e6c09888d031b38">utf::incomplete</a>;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <a class="code" href="structboost_1_1locale_1_1utf_1_1utf__traits.html#acd59f628af084f800f8a86cdd8124fd8">utf::utf_traits&lt;char&gt;::encode</a>(u,begin);</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keywordflow">return</span> width;</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; }</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;};</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;} <span class="comment">// locale</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;} <span class="comment">// namespace boost</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;<span class="preprocessor"></span><span class="comment">// vim: tabstop=4 expandtab shiftwidth=4 softtabstop=4</span></div>
<div class="ttc" id="structboost_1_1locale_1_1utf_1_1utf__traits_html_a9b6b01fa6705ba67ac78359ddee03213"><div class="ttname"><a href="structboost_1_1locale_1_1utf_1_1utf__traits.html#a9b6b01fa6705ba67ac78359ddee03213">boost::locale::utf::utf_traits::decode</a></div><div class="ttdeci">static code_point decode(Iterator &amp;p, Iterator e)</div></div>
<div class="ttc" id="namespaceboost_1_1locale_1_1utf_html_a189805c4e9f4c033ce5f88daf780e08e"><div class="ttname"><a href="namespaceboost_1_1locale_1_1utf.html#a189805c4e9f4c033ce5f88daf780e08e">boost::locale::utf::is_valid_codepoint</a></div><div class="ttdeci">bool is_valid_codepoint(code_point v)</div><div class="ttdoc">the function checks if v is a valid code point </div><div class="ttdef"><b>Definition:</b> utf.hpp:49</div></div>
<div class="ttc" id="structboost_1_1locale_1_1utf_1_1utf__traits_html_acd59f628af084f800f8a86cdd8124fd8"><div class="ttname"><a href="structboost_1_1locale_1_1utf_1_1utf__traits.html#acd59f628af084f800f8a86cdd8124fd8">boost::locale::utf::utf_traits::encode</a></div><div class="ttdeci">static Iterator encode(code_point value, Iterator out)</div></div>
<div class="ttc" id="namespaceboost_1_1locale_1_1utf_html_a20dbe458fd18229a0e6c09888d031b38"><div class="ttname"><a href="namespaceboost_1_1locale_1_1utf.html#a20dbe458fd18229a0e6c09888d031b38">boost::locale::utf::incomplete</a></div><div class="ttdeci">static const code_point incomplete</div><div class="ttdoc">Special constant that defines incomplete code point. </div><div class="ttdef"><b>Definition:</b> utf.hpp:44</div></div>
<div class="ttc" id="classboost_1_1locale_1_1utf8__codecvt_html"><div class="ttname"><a href="classboost_1_1locale_1_1utf8__codecvt.html">boost::locale::utf8_codecvt</a></div><div class="ttdoc">Geneneric utf8 codecvt facet, it allows to convert UTF-8 strings to UTF-16 and UTF-32 using wchar_t...</div><div class="ttdef"><b>Definition:</b> utf8_codecvt.hpp:23</div></div>
<div class="ttc" id="namespaceboost_1_1locale_1_1utf_html_a068111a6b9d6d465a63893ed5c05e2f8"><div class="ttname"><a href="namespaceboost_1_1locale_1_1utf.html#a068111a6b9d6d465a63893ed5c05e2f8">boost::locale::utf::code_point</a></div><div class="ttdeci">uint32_t code_point</div><div class="ttdoc">The integral type that can hold a Unicode code point. </div><div class="ttdef"><b>Definition:</b> utf.hpp:34</div></div>
<div class="ttc" id="classboost_1_1locale_1_1generic__codecvt__base_html_af28c4b64af6cbf2eb01c444e2cdf08c3"><div class="ttname"><a href="classboost_1_1locale_1_1generic__codecvt__base.html#af28c4b64af6cbf2eb01c444e2cdf08c3">boost::locale::generic_codecvt_base::initial_convertion_state</a></div><div class="ttdeci">initial_convertion_state</div><div class="ttdef"><b>Definition:</b> generic_codecvt.hpp:39</div></div>
<div class="ttc" id="namespaceboost_1_1locale_1_1utf_html_a30010000878c7732340bda8956b844fb"><div class="ttname"><a href="namespaceboost_1_1locale_1_1utf.html#a30010000878c7732340bda8956b844fb">boost::locale::utf::illegal</a></div><div class="ttdeci">static const code_point illegal</div><div class="ttdoc">Special constant that defines illegal code point. </div><div class="ttdef"><b>Definition:</b> utf.hpp:39</div></div>
<div class="ttc" id="structboost_1_1locale_1_1utf8__codecvt_1_1state__type_html"><div class="ttname"><a href="structboost_1_1locale_1_1utf8__codecvt_1_1state__type.html">boost::locale::utf8_codecvt::state_type</a></div><div class="ttdef"><b>Definition:</b> utf8_codecvt.hpp:27</div></div>
<div class="ttc" id="classboost_1_1locale_1_1generic__codecvt_html"><div class="ttname"><a href="classboost_1_1locale_1_1generic__codecvt.html">boost::locale::generic_codecvt</a></div><div class="ttdoc">Geneneric generic codecvt facet, various stateless encodings to UTF-16 and UTF-32 using wchar_t...</div><div class="ttdef"><b>Definition:</b> generic_codecvt.hpp:140</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<li class="footer">
&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.
</li>
</ul>
</div>
</body>
</html>