boost/libs/nowide/doc/html/utf_2convert_8hpp_source.html
2021-10-05 21:37:46 +02:00

70 lines
19 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Boost.Nowide: boost/nowide/utf/convert.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="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="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Boost.Nowide
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_1878a3f4746a95c6aad317458cc7ef80.html">boost</a></li><li class="navelem"><a class="el" href="dir_ab65964b154f94b8b1ef0b053897b905.html">nowide</a></li><li class="navelem"><a class="el" href="dir_6de37c9759f3b231287b6a4ec502d447.html">utf</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">convert.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) 2012 Artyom Beilis (Tonkikh)</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// Copyright (c) 2020 Alexander Grund</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">// Distributed under the Boost Software License, Version 1.0. (See</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">// accompanying file LICENSE or copy at</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">// http://www.boost.org/LICENSE_1_0.txt)</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#ifndef BOOST_NOWIDE_UTF_CONVERT_HPP_INCLUDED</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#define BOOST_NOWIDE_UTF_CONVERT_HPP_INCLUDED</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#include &lt;boost/nowide/detail/is_string_container.hpp&gt;</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="replacement_8hpp.html">boost/nowide/replacement.hpp</a>&gt;</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#include &lt;boost/nowide/utf/utf.hpp&gt;</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#include &lt;iterator&gt;</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="keyword">namespace </span>boost {</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="keyword">namespace </span>nowide {</div><div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="namespaceboost_1_1nowide_1_1utf.html"> 20</a></span>&#160; <span class="keyword">namespace </span><a class="code" href="namespaceboost_1_1nowide_1_1utf.html">utf</a> {</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Char&gt;</div><div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="namespaceboost_1_1nowide_1_1utf.html#af88d6b53b99aec7da32bd67087e7fdcd"> 26</a></span>&#160; <span class="keywordtype">size_t</span> <a class="code" href="namespaceboost_1_1nowide_1_1utf.html#af88d6b53b99aec7da32bd67087e7fdcd">strlen</a>(<span class="keyword">const</span> Char* s)</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; {</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <span class="keyword">const</span> Char* end = s;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="keywordflow">while</span>(*end)</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; end++;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="keywordflow">return</span> end - s;</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;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> CharOut, <span class="keyword">typename</span> CharIn&gt;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; CharOut*</div><div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="namespaceboost_1_1nowide_1_1utf.html#a105f0d686d048295780f66696222391c"> 43</a></span>&#160; <a class="code" href="namespaceboost_1_1nowide_1_1utf.html#a105f0d686d048295780f66696222391c">convert_buffer</a>(CharOut* buffer, <span class="keywordtype">size_t</span> buffer_size, <span class="keyword">const</span> CharIn* source_begin, <span class="keyword">const</span> CharIn* source_end)</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; {</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; CharOut* rv = buffer;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keywordflow">if</span>(buffer_size == 0)</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keywordflow">return</span> <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; buffer_size--;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keywordflow">while</span>(source_begin != source_end)</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; <a class="code" href="namespaceboost_1_1nowide_1_1utf.html#a4bd651000593bf73be05d50278e2c1e3">code_point</a> c = <a class="code" href="structboost_1_1nowide_1_1utf_1_1utf__traits.html#a0fbc086e7c1640206ee55c4a467c1ea3">utf_traits&lt;CharIn&gt;::decode</a>(source_begin, source_end);</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keywordflow">if</span>(c == <a class="code" href="namespaceboost_1_1nowide_1_1utf.html#aaaf1f34f7f0c7d3c98f6896e737873ae">illegal</a> || c == <a class="code" href="namespaceboost_1_1nowide_1_1utf.html#a80a0fd866c8fa2791c400dc501a4e25f">incomplete</a>)</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; c = <a class="code" href="replacement_8hpp.html#a51c35d4bbf84bc443caab9afce302447">BOOST_NOWIDE_REPLACEMENT_CHARACTER</a>;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; }</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="keywordtype">size_t</span> width = <a class="code" href="structboost_1_1nowide_1_1utf_1_1utf__traits.html#ad16265222c92f2efdacabf0efc32117d">utf_traits&lt;CharOut&gt;::width</a>(c);</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keywordflow">if</span>(buffer_size &lt; width)</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; {</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; rv = NULL;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keywordflow">break</span>;</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; buffer = <a class="code" href="structboost_1_1nowide_1_1utf_1_1utf__traits.html#a72a312248fc248101ea00af58eb7e835">utf_traits&lt;CharOut&gt;::encode</a>(c, buffer);</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; buffer_size -= width;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; }</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; *buffer++ = 0;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keywordflow">return</span> rv;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; }</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> CharOut, <span class="keyword">typename</span> CharIn&gt;</div><div class="line"><a name="l00075"></a><span class="lineno"><a class="line" href="namespaceboost_1_1nowide_1_1utf.html#ab23f248c3a3a7f5adffb89e155e5a0fe"> 75</a></span>&#160; std::basic_string&lt;CharOut&gt; <a class="code" href="namespaceboost_1_1nowide_1_1utf.html#ab23f248c3a3a7f5adffb89e155e5a0fe">convert_string</a>(<span class="keyword">const</span> CharIn* begin, <span class="keyword">const</span> CharIn* end)</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; {</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; std::basic_string&lt;CharOut&gt; result;</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; result.reserve(end - begin);</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="keyword">using</span> inserter_type = std::back_insert_iterator&lt;std::basic_string&lt;CharOut&gt;&gt;;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; inserter_type inserter(result);</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <a class="code" href="namespaceboost_1_1nowide_1_1utf.html#a4bd651000593bf73be05d50278e2c1e3">code_point</a> c;</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <span class="keywordflow">while</span>(begin != end)</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; {</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; c = <a class="code" href="structboost_1_1nowide_1_1utf_1_1utf__traits.html#a0fbc086e7c1640206ee55c4a467c1ea3">utf_traits&lt;CharIn&gt;::decode</a>(begin, end);</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="keywordflow">if</span>(c == <a class="code" href="namespaceboost_1_1nowide_1_1utf.html#aaaf1f34f7f0c7d3c98f6896e737873ae">illegal</a> || c == <a class="code" href="namespaceboost_1_1nowide_1_1utf.html#a80a0fd866c8fa2791c400dc501a4e25f">incomplete</a>)</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; {</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; c = <a class="code" href="replacement_8hpp.html#a51c35d4bbf84bc443caab9afce302447">BOOST_NOWIDE_REPLACEMENT_CHARACTER</a>;</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; }</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; <a class="code" href="structboost_1_1nowide_1_1utf_1_1utf__traits.html#a72a312248fc248101ea00af58eb7e835">utf_traits&lt;CharOut&gt;::encode</a>(c, inserter);</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; }</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <span class="keywordflow">return</span> result;</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; }</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; } <span class="comment">// namespace utf</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;} <span class="comment">// namespace nowide</span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;} <span class="comment">// namespace boost</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160;</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="namespaceboost_1_1nowide_1_1utf_html_ab23f248c3a3a7f5adffb89e155e5a0fe"><div class="ttname"><a href="namespaceboost_1_1nowide_1_1utf.html#ab23f248c3a3a7f5adffb89e155e5a0fe">boost::nowide::utf::convert_string</a></div><div class="ttdeci">std::basic_string&lt; CharOut &gt; convert_string(const CharIn *begin, const CharIn *end)</div><div class="ttdef"><b>Definition:</b> convert.hpp:75</div></div>
<div class="ttc" id="namespaceboost_1_1nowide_1_1utf_html"><div class="ttname"><a href="namespaceboost_1_1nowide_1_1utf.html">boost::nowide::utf</a></div><div class="ttdoc">Namespace that holds basic operations on UTF encoded sequences.</div><div class="ttdef"><b>Definition:</b> convert.hpp:20</div></div>
<div class="ttc" id="structboost_1_1nowide_1_1utf_1_1utf__traits_html_a72a312248fc248101ea00af58eb7e835"><div class="ttname"><a href="structboost_1_1nowide_1_1utf_1_1utf__traits.html#a72a312248fc248101ea00af58eb7e835">boost::nowide::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_1nowide_1_1utf_html_aaaf1f34f7f0c7d3c98f6896e737873ae"><div class="ttname"><a href="namespaceboost_1_1nowide_1_1utf.html#aaaf1f34f7f0c7d3c98f6896e737873ae">boost::nowide::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:33</div></div>
<div class="ttc" id="namespaceboost_1_1nowide_1_1utf_html_a4bd651000593bf73be05d50278e2c1e3"><div class="ttname"><a href="namespaceboost_1_1nowide_1_1utf.html#a4bd651000593bf73be05d50278e2c1e3">boost::nowide::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:28</div></div>
<div class="ttc" id="namespaceboost_1_1nowide_1_1utf_html_af88d6b53b99aec7da32bd67087e7fdcd"><div class="ttname"><a href="namespaceboost_1_1nowide_1_1utf.html#af88d6b53b99aec7da32bd67087e7fdcd">boost::nowide::utf::strlen</a></div><div class="ttdeci">size_t strlen(const Char *s)</div><div class="ttdef"><b>Definition:</b> convert.hpp:26</div></div>
<div class="ttc" id="replacement_8hpp_html_a51c35d4bbf84bc443caab9afce302447"><div class="ttname"><a href="replacement_8hpp.html#a51c35d4bbf84bc443caab9afce302447">BOOST_NOWIDE_REPLACEMENT_CHARACTER</a></div><div class="ttdeci">#define BOOST_NOWIDE_REPLACEMENT_CHARACTER</div><div class="ttdef"><b>Definition:</b> replacement.hpp:16</div></div>
<div class="ttc" id="replacement_8hpp_html"><div class="ttname"><a href="replacement_8hpp.html">replacement.hpp</a></div></div>
<div class="ttc" id="namespaceboost_1_1nowide_1_1utf_html_a105f0d686d048295780f66696222391c"><div class="ttname"><a href="namespaceboost_1_1nowide_1_1utf.html#a105f0d686d048295780f66696222391c">boost::nowide::utf::convert_buffer</a></div><div class="ttdeci">CharOut * convert_buffer(CharOut *buffer, size_t buffer_size, const CharIn *source_begin, const CharIn *source_end)</div><div class="ttdef"><b>Definition:</b> convert.hpp:43</div></div>
<div class="ttc" id="namespaceboost_1_1nowide_1_1utf_html_a80a0fd866c8fa2791c400dc501a4e25f"><div class="ttname"><a href="namespaceboost_1_1nowide_1_1utf.html#a80a0fd866c8fa2791c400dc501a4e25f">boost::nowide::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:38</div></div>
<div class="ttc" id="structboost_1_1nowide_1_1utf_1_1utf__traits_html_ad16265222c92f2efdacabf0efc32117d"><div class="ttname"><a href="structboost_1_1nowide_1_1utf_1_1utf__traits.html#ad16265222c92f2efdacabf0efc32117d">boost::nowide::utf::utf_traits::width</a></div><div class="ttdeci">static int width(code_point value)</div></div>
<div class="ttc" id="structboost_1_1nowide_1_1utf_1_1utf__traits_html_a0fbc086e7c1640206ee55c4a467c1ea3"><div class="ttname"><a href="structboost_1_1nowide_1_1utf_1_1utf__traits.html#a0fbc086e7c1640206ee55c4a467c1ea3">boost::nowide::utf::utf_traits::decode</a></div><div class="ttdeci">static code_point decode(Iterator &amp;p, Iterator e)</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>