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/encoding_utf.hpp Source File</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 Page</span></a></li> 40 <li><a href="pages.html"><span>Related 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><a href="annotated.html"><span>Classes</span></a></li> 44 <li class="current"><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="files.html"><span>File List</span></a></li> 51 </ul> 52 </div> 53</div><!-- top --> 54<div id="side-nav" class="ui-resizable side-nav-resizable"> 55 <div id="nav-tree"> 56 <div id="nav-tree-contents"> 57 <div id="nav-sync" class="sync"></div> 58 </div> 59 </div> 60 <div id="splitbar" style="-moz-user-select:none;" 61 class="ui-resizable-handle"> 62 </div> 63</div> 64<script type="text/javascript"> 65$(document).ready(function(){initNavTree('encoding__utf_8hpp_source.html','');}); 66</script> 67<div id="doc-content"> 68<div class="header"> 69 <div class="headertitle"> 70<div class="title">encoding_utf.hpp</div> </div> 71</div><!--header--> 72<div class="contents"> 73<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//</span></div> 74<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// Copyright (c) 2009-2011 Artyom Beilis (Tonkikh)</span></div> 75<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">//</span></div> 76<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// Distributed under the Boost Software License, Version 1.0. (See</span></div> 77<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// accompanying file LICENSE_1_0.txt or copy at</span></div> 78<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">// http://www.boost.org/LICENSE_1_0.txt)</span></div> 79<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">//</span></div> 80<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#ifndef BOOST_LOCALE_ENCODING_UTF_HPP_INCLUDED</span></div> 81<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor"></span><span class="preprocessor">#define BOOST_LOCALE_ENCODING_UTF_HPP_INCLUDED</span></div> 82<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor"></span></div> 83<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include <boost/locale/utf.hpp></span></div> 84<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include <boost/locale/encoding_errors.hpp></span></div> 85<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <iterator></span></div> 86<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#ifdef BOOST_MSVC</span></div> 87<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor"></span><span class="preprocessor"># pragma warning(push)</span></div> 88<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor"></span><span class="preprocessor"># pragma warning(disable : 4275 4251 4231 4660)</span></div> 89<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor"></span><span class="preprocessor">#endif</span></div> 90<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor"></span></div> 91<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div> 92<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div> 93<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">namespace </span>boost {</div> 94<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  <span class="keyword">namespace </span>locale {</div> 95<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  <span class="keyword">namespace </span>conv {</div> 96<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div> 97<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keyword">template</span><<span class="keyword">typename</span> CharOut,<span class="keyword">typename</span> CharIn></div> 98<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  std::basic_string<CharOut></div> 99<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="group__codepage.html#gaf0ad39959911b000706e0538ec059d44"> 34</a></span>  <a class="code" href="group__codepage.html#gaf0ad39959911b000706e0538ec059d44">utf_to_utf</a>(CharIn <span class="keyword">const</span> *begin,CharIn <span class="keyword">const</span> *end,<a class="code" href="group__codepage.html#ga8e3c5a274f57107ec5745e227c26ba84">method_type</a> how = <a class="code" href="group__codepage.html#gga8e3c5a274f57107ec5745e227c26ba84adcdc34a57dd2a3ca917f73c13f18b559">default_method</a>)</div> 100<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  {</div> 101<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  std::basic_string<CharOut> result;</div> 102<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  result.reserve(end-begin);</div> 103<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keyword">typedef</span> std::back_insert_iterator<std::basic_string<CharOut> > inserter_type;</div> 104<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  inserter_type inserter(result);</div> 105<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <a class="code" href="namespaceboost_1_1locale_1_1utf.html#a068111a6b9d6d465a63893ed5c05e2f8">utf::code_point</a> c;</div> 106<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keywordflow">while</span>(begin!=end) {</div> 107<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  c=<a class="code" href="structboost_1_1locale_1_1utf_1_1utf__traits.html">utf::utf_traits<CharIn>::template</a> decode<CharIn const *>(begin,end);</div> 108<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordflow">if</span>(c==<a class="code" href="namespaceboost_1_1locale_1_1utf.html#a30010000878c7732340bda8956b844fb">utf::illegal</a> || c==<a class="code" href="namespaceboost_1_1locale_1_1utf.html#a20dbe458fd18229a0e6c09888d031b38">utf::incomplete</a>) {</div> 109<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keywordflow">if</span>(how==<a class="code" href="group__codepage.html#gga8e3c5a274f57107ec5745e227c26ba84aab08f9ee241c405ef40bd3cedb43b383">stop</a>)</div> 110<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keywordflow">throw</span> <a class="code" href="classboost_1_1locale_1_1conv_1_1conversion__error.html">conversion_error</a>();</div> 111<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  }</div> 112<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordflow">else</span> {</div> 113<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <a class="code" href="structboost_1_1locale_1_1utf_1_1utf__traits.html">utf::utf_traits<CharOut>::template</a> encode<inserter_type>(c,inserter);</div> 114<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  }</div> 115<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  }</div> 116<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keywordflow">return</span> result;</div> 117<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  }</div> 118<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div> 119<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keyword">template</span><<span class="keyword">typename</span> CharOut,<span class="keyword">typename</span> CharIn></div> 120<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  std::basic_string<CharOut></div> 121<div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="group__codepage.html#gaa4de44e37cbe5ec4a4b79e1d9bbaf4a7"> 59</a></span>  <a class="code" href="group__codepage.html#gaf0ad39959911b000706e0538ec059d44">utf_to_utf</a>(CharIn <span class="keyword">const</span> *str,<a class="code" href="group__codepage.html#ga8e3c5a274f57107ec5745e227c26ba84">method_type</a> how = <a class="code" href="group__codepage.html#gga8e3c5a274f57107ec5745e227c26ba84adcdc34a57dd2a3ca917f73c13f18b559">default_method</a>)</div> 122<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  {</div> 123<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  CharIn <span class="keyword">const</span> *end = str;</div> 124<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordflow">while</span>(*end)</div> 125<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  end++;</div> 126<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordflow">return</span> utf_to_utf<CharOut,CharIn>(str,end,how);</div> 127<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  }</div> 128<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div> 129<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div> 130<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keyword">template</span><<span class="keyword">typename</span> CharOut,<span class="keyword">typename</span> CharIn></div> 131<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  std::basic_string<CharOut></div> 132<div class="line"><a name="l00073"></a><span class="lineno"><a class="line" href="group__codepage.html#ga1951228e7f528a20e40258d73cf17f5c"> 73</a></span>  <a class="code" href="group__codepage.html#gaf0ad39959911b000706e0538ec059d44">utf_to_utf</a>(std::basic_string<CharIn> <span class="keyword">const</span> &str,<a class="code" href="group__codepage.html#ga8e3c5a274f57107ec5745e227c26ba84">method_type</a> how = <a class="code" href="group__codepage.html#gga8e3c5a274f57107ec5745e227c26ba84adcdc34a57dd2a3ca917f73c13f18b559">default_method</a>)</div> 133<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  {</div> 134<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordflow">return</span> utf_to_utf<CharOut,CharIn>(str.c_str(),str.c_str()+str.size(),how);</div> 135<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  }</div> 136<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div> 137<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div> 138<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div> 139<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  } <span class="comment">// conv</span></div> 140<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div> 141<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  } <span class="comment">// locale</span></div> 142<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> } <span class="comment">// boost</span></div> 143<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div> 144<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="preprocessor">#ifdef BOOST_MSVC</span></div> 145<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="preprocessor"></span><span class="preprocessor">#pragma warning(pop)</span></div> 146<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="preprocessor"></span><span class="preprocessor">#endif</span></div> 147<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="preprocessor"></span></div> 148<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="preprocessor">#endif</span></div> 149<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="preprocessor"></span></div> 150<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment">// vim: tabstop=4 expandtab shiftwidth=4 softtabstop=4</span></div> 151<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> </div> 152<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> 153<div class="ttc" id="classboost_1_1locale_1_1conv_1_1conversion__error_html"><div class="ttname"><a href="classboost_1_1locale_1_1conv_1_1conversion__error.html">boost::locale::conv::conversion_error</a></div><div class="ttdoc">The excepton that is thrown in case of conversion error. </div><div class="ttdef"><b>Definition:</b> encoding_errors.hpp:31</div></div> 154<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> 155<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> 156<div class="ttc" id="structboost_1_1locale_1_1utf_1_1utf__traits_html"><div class="ttname"><a href="structboost_1_1locale_1_1utf_1_1utf__traits.html">boost::locale::utf::utf_traits</a></div><div class="ttdoc">UTF Traits class - functions to convert UTF sequences to and from Unicode code points. </div><div class="ttdef"><b>Definition:</b> utf.hpp:63</div></div> 157<div class="ttc" id="group__codepage_html_gaf0ad39959911b000706e0538ec059d44"><div class="ttname"><a href="group__codepage.html#gaf0ad39959911b000706e0538ec059d44">boost::locale::conv::utf_to_utf</a></div><div class="ttdeci">std::basic_string< CharOut > utf_to_utf(CharIn const *begin, CharIn const *end, method_type how=default_method)</div><div class="ttdef"><b>Definition:</b> encoding_utf.hpp:34</div></div> 158<div class="ttc" id="group__codepage_html_gga8e3c5a274f57107ec5745e227c26ba84adcdc34a57dd2a3ca917f73c13f18b559"><div class="ttname"><a href="group__codepage.html#gga8e3c5a274f57107ec5745e227c26ba84adcdc34a57dd2a3ca917f73c13f18b559">boost::locale::conv::default_method</a></div><div class="ttdoc">Default method - skip. </div><div class="ttdef"><b>Definition:</b> encoding_errors.hpp:57</div></div> 159<div class="ttc" id="group__codepage_html_gga8e3c5a274f57107ec5745e227c26ba84aab08f9ee241c405ef40bd3cedb43b383"><div class="ttname"><a href="group__codepage.html#gga8e3c5a274f57107ec5745e227c26ba84aab08f9ee241c405ef40bd3cedb43b383">boost::locale::conv::stop</a></div><div class="ttdoc">Stop conversion and throw conversion_error. </div><div class="ttdef"><b>Definition:</b> encoding_errors.hpp:56</div></div> 160<div class="ttc" id="group__codepage_html_ga8e3c5a274f57107ec5745e227c26ba84"><div class="ttname"><a href="group__codepage.html#ga8e3c5a274f57107ec5745e227c26ba84">boost::locale::conv::method_type</a></div><div class="ttdeci">method_type</div><div class="ttdef"><b>Definition:</b> encoding_errors.hpp:54</div></div> 161</div><!-- fragment --></div><!-- contents --> 162</div><!-- doc-content --> 163 164 <li class="footer"> 165© 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. 166 </li> 167 </ul> 168 </div> 169</body> 170</html> 171
