[ceph.git] / ceph / src / boost / libs / locale / doc / html / structboost_1_1locale_1_1utf_1_1utf__traits.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::utf::utf_traits&lt; CharType, size &gt; Struct Template 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="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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><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="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</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('structboost_1_1locale_1_1utf_1_1utf__traits.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="structboost_1_1locale_1_1utf_1_1utf__traits-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">boost::locale::utf::utf_traits&lt; CharType, size &gt; Struct Template Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>UTF Traits class - functions to convert UTF sequences to and from Unicode code points.  
 <a href="structboost_1_1locale_1_1utf_1_1utf__traits.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="utf_8hpp_source.html">boost/locale/utf.hpp</a>&gt;</code></p>
<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:accca9dc2d8fe018b9b5640c48e3470e4"><td class="memItemLeft" align="right" valign="top">typedef CharType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html#accca9dc2d8fe018b9b5640c48e3470e4">char_type</a></td></tr>
<tr class="separator:accca9dc2d8fe018b9b5640c48e3470e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a9b6b01fa6705ba67ac78359ddee03213"><td class="memTemplParams" colspan="2">template&lt;typename Iterator &gt; </td></tr>
<tr class="memitem:a9b6b01fa6705ba67ac78359ddee03213"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="namespaceboost_1_1locale_1_1utf.html#a068111a6b9d6d465a63893ed5c05e2f8">code_point</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html#a9b6b01fa6705ba67ac78359ddee03213">decode</a> (Iterator &amp;p, Iterator e)</td></tr>
<tr class="separator:a9b6b01fa6705ba67ac78359ddee03213"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a26c106ec8816f48431f882017ab46763"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html#a26c106ec8816f48431f882017ab46763">width</a> (<a class="el" href="namespaceboost_1_1locale_1_1utf.html#a068111a6b9d6d465a63893ed5c05e2f8">code_point</a> value)</td></tr>
<tr class="separator:a26c106ec8816f48431f882017ab46763"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8a6b72ba87a817652f522018df51a9a7"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html#a8a6b72ba87a817652f522018df51a9a7">trail_length</a> (<a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html#accca9dc2d8fe018b9b5640c48e3470e4">char_type</a> c)</td></tr>
<tr class="separator:a8a6b72ba87a817652f522018df51a9a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae2cb78fcb8a58bed3e0ce1d6528a719a"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html#ae2cb78fcb8a58bed3e0ce1d6528a719a">is_trail</a> (<a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html#accca9dc2d8fe018b9b5640c48e3470e4">char_type</a> c)</td></tr>
<tr class="separator:ae2cb78fcb8a58bed3e0ce1d6528a719a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a19789c4c26c8d9f576de5272f3d41a11"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html#a19789c4c26c8d9f576de5272f3d41a11">is_lead</a> (<a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html#accca9dc2d8fe018b9b5640c48e3470e4">char_type</a> c)</td></tr>
<tr class="separator:a19789c4c26c8d9f576de5272f3d41a11"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acd59f628af084f800f8a86cdd8124fd8"><td class="memTemplParams" colspan="2">template&lt;typename Iterator &gt; </td></tr>
<tr class="memitem:acd59f628af084f800f8a86cdd8124fd8"><td class="memTemplItemLeft" align="right" valign="top">static Iterator&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html#acd59f628af084f800f8a86cdd8124fd8">encode</a> (<a class="el" href="namespaceboost_1_1locale_1_1utf.html#a068111a6b9d6d465a63893ed5c05e2f8">code_point</a> value, Iterator out)</td></tr>
<tr class="separator:acd59f628af084f800f8a86cdd8124fd8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8ff625b2c19b0d4132f7ec9e6303cb36"><td class="memTemplParams" colspan="2">template&lt;typename Iterator &gt; </td></tr>
<tr class="memitem:a8ff625b2c19b0d4132f7ec9e6303cb36"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="namespaceboost_1_1locale_1_1utf.html#a068111a6b9d6d465a63893ed5c05e2f8">code_point</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html#a8ff625b2c19b0d4132f7ec9e6303cb36">decode_valid</a> (Iterator &amp;p)</td></tr>
<tr class="separator:a8ff625b2c19b0d4132f7ec9e6303cb36"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:abb4cb63a924d19505c2cb6e930c68a13"><td class="memItemLeft" align="right" valign="top">static const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html#abb4cb63a924d19505c2cb6e930c68a13">max_width</a></td></tr>
<tr class="separator:abb4cb63a924d19505c2cb6e930c68a13"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename CharType, int size = sizeof(CharType)&gt;<br/>
struct boost::locale::utf::utf_traits&lt; CharType, size &gt;</h3>

<p>UTF Traits class - functions to convert UTF sequences to and from Unicode code points. </p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a class="anchor" id="accca9dc2d8fe018b9b5640c48e3470e4"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename CharType, int size = sizeof(CharType)&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">typedef CharType <a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html">boost::locale::utf::utf_traits</a>&lt; CharType, size &gt;::<a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html#accca9dc2d8fe018b9b5640c48e3470e4">char_type</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The type of the character </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a9b6b01fa6705ba67ac78359ddee03213"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename CharType, int size = sizeof(CharType)&gt; </div>
<div class="memtemplate">
template&lt;typename Iterator &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="namespaceboost_1_1locale_1_1utf.html#a068111a6b9d6d465a63893ed5c05e2f8">code_point</a> <a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html">boost::locale::utf::utf_traits</a>&lt; CharType, size &gt;::decode </td>
          <td>(</td>
          <td class="paramtype">Iterator &amp;&#160;</td>
          <td class="paramname"><em>p</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">Iterator&#160;</td>
          <td class="paramname"><em>e</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Read one code point from the range [p,e) and return it.</p>
<ul>
<li>If the sequence that was read is incomplete sequence returns <a class="el" href="namespaceboost_1_1locale_1_1utf.html#a20dbe458fd18229a0e6c09888d031b38">incomplete</a>,</li>
<li>If illegal sequence detected returns <a class="el" href="namespaceboost_1_1locale_1_1utf.html#a30010000878c7732340bda8956b844fb">illegal</a></li>
</ul>
<p>Requirements</p>
<ul>
<li>Iterator is valid input iterator</li>
</ul>
<p>Postconditions</p>
<ul>
<li>p points to the last consumed character </li>
</ul>

</div>
</div>
<a class="anchor" id="a8ff625b2c19b0d4132f7ec9e6303cb36"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename CharType, int size = sizeof(CharType)&gt; </div>
<div class="memtemplate">
template&lt;typename Iterator &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="namespaceboost_1_1locale_1_1utf.html#a068111a6b9d6d465a63893ed5c05e2f8">code_point</a> <a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html">boost::locale::utf::utf_traits</a>&lt; CharType, size &gt;::decode_valid </td>
          <td>(</td>
          <td class="paramtype">Iterator &amp;&#160;</td>
          <td class="paramname"><em>p</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Decodes valid UTF sequence that is pointed by p into code point.</p>
<p>If the sequence is invalid or points to end the behavior is undefined </p>

</div>
</div>
<a class="anchor" id="acd59f628af084f800f8a86cdd8124fd8"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename CharType, int size = sizeof(CharType)&gt; </div>
<div class="memtemplate">
template&lt;typename Iterator &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static Iterator <a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html">boost::locale::utf::utf_traits</a>&lt; CharType, size &gt;::encode </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="namespaceboost_1_1locale_1_1utf.html#a068111a6b9d6d465a63893ed5c05e2f8">code_point</a>&#160;</td>
          <td class="paramname"><em>value</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">Iterator&#160;</td>
          <td class="paramname"><em>out</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Convert valid Unicode code point <em>value</em> to the UTF sequence.</p>
<p>Requirements:</p>
<ul>
<li><em>value</em> is valid code point</li>
<li><em>out</em> is an output iterator should be able to accept at least width(value) units</li>
</ul>
<p>Returns the iterator past the last written code unit. </p>

</div>
</div>
<a class="anchor" id="a19789c4c26c8d9f576de5272f3d41a11"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename CharType, int size = sizeof(CharType)&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static bool <a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html">boost::locale::utf::utf_traits</a>&lt; CharType, size &gt;::is_lead </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html#accca9dc2d8fe018b9b5640c48e3470e4">char_type</a>&#160;</td>
          <td class="paramname"><em>c</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Returns true if c is lead code unit, always true of UTF-32 </p>

</div>
</div>
<a class="anchor" id="ae2cb78fcb8a58bed3e0ce1d6528a719a"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename CharType, int size = sizeof(CharType)&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static bool <a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html">boost::locale::utf::utf_traits</a>&lt; CharType, size &gt;::is_trail </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html#accca9dc2d8fe018b9b5640c48e3470e4">char_type</a>&#160;</td>
          <td class="paramname"><em>c</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Returns true if c is trail code unit, always false for UTF-32 </p>

</div>
</div>
<a class="anchor" id="a8a6b72ba87a817652f522018df51a9a7"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename CharType, int size = sizeof(CharType)&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static int <a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html">boost::locale::utf::utf_traits</a>&lt; CharType, size &gt;::trail_length </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html#accca9dc2d8fe018b9b5640c48e3470e4">char_type</a>&#160;</td>
          <td class="paramname"><em>c</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Get the size of the trail part of variable length encoded sequence.</p>
<p>Returns -1 if C is not valid lead character </p>

</div>
</div>
<a class="anchor" id="a26c106ec8816f48431f882017ab46763"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename CharType, int size = sizeof(CharType)&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static int <a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html">boost::locale::utf::utf_traits</a>&lt; CharType, size &gt;::width </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="namespaceboost_1_1locale_1_1utf.html#a068111a6b9d6d465a63893ed5c05e2f8">code_point</a>&#160;</td>
          <td class="paramname"><em>value</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>The width of specific code point in the code units.</p>
<p>Requirement: value is a valid Unicode code point Returns value in range [1..max_width] </p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="abb4cb63a924d19505c2cb6e930c68a13"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename CharType, int size = sizeof(CharType)&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const int <a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html">boost::locale::utf::utf_traits</a>&lt; CharType, size &gt;::max_width</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Maximal width of valid sequence in the code units:</p>
<ul>
<li>UTF-8 - 4</li>
<li>UTF-16 - 2</li>
<li>UTF-32 - 1 </li>
</ul>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>boost/locale/<a class="el" href="utf_8hpp_source.html">utf.hpp</a></li>
</ul>
</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>
Commit	Line	Data
7c673cae FG	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::utf::utf_traits< CharType, size > Struct 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 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 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 List</span></a></li>
	51	<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
	52	<li><a href="functions.html"><span>Class 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('structboost_1_1locale_1_1utf_1_1utf__traits.html','');});
68	</script>
69	<div id="doc-content">
70	<div class="header">
71	<div class="summary">
72	<a href="#pub-types">Public Types</a> \|
73	<a href="#pub-static-methods">Static Public Member Functions</a> \|
74	<a href="#pub-static-attribs">Static Public Attributes</a> \|
75	<a href="structboost_1_1locale_1_1utf_1_1utf__traits-members.html">List of all members</a> </div>
76	<div class="headertitle">
77	<div class="title">boost::locale::utf::utf_traits< CharType, size > Struct Template Reference</div> </div>
78	</div><!--header-->
79	<div class="contents">
80
81	<p>UTF Traits class - functions to convert UTF sequences to and from Unicode code points.
82	<a href="structboost_1_1locale_1_1utf_1_1utf__traits.html#details">More...</a></p>
83
84	<p><code>#include <<a class="el" href="utf_8hpp_source.html">boost/locale/utf.hpp</a>></code></p>
85	<table class="memberdecls">
86	<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
87	Public Types</h2></td></tr>
88	<tr class="memitem:accca9dc2d8fe018b9b5640c48e3470e4"><td class="memItemLeft" align="right" valign="top">typedef CharType </td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html#accca9dc2d8fe018b9b5640c48e3470e4">char_type</a></td></tr>
89	<tr class="separator:accca9dc2d8fe018b9b5640c48e3470e4"><td class="memSeparator" colspan="2"> </td></tr>
90	</table><table class="memberdecls">
91	<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
92	Static Public Member Functions</h2></td></tr>
93	<tr class="memitem:a9b6b01fa6705ba67ac78359ddee03213"><td class="memTemplParams" colspan="2">template<typename Iterator > </td></tr>
94	<tr class="memitem:a9b6b01fa6705ba67ac78359ddee03213"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="namespaceboost_1_1locale_1_1utf.html#a068111a6b9d6d465a63893ed5c05e2f8">code_point</a> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html#a9b6b01fa6705ba67ac78359ddee03213">decode</a> (Iterator &p, Iterator e)</td></tr>
95	<tr class="separator:a9b6b01fa6705ba67ac78359ddee03213"><td class="memSeparator" colspan="2"> </td></tr>
96	<tr class="memitem:a26c106ec8816f48431f882017ab46763"><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html#a26c106ec8816f48431f882017ab46763">width</a> (<a class="el" href="namespaceboost_1_1locale_1_1utf.html#a068111a6b9d6d465a63893ed5c05e2f8">code_point</a> value)</td></tr>
97	<tr class="separator:a26c106ec8816f48431f882017ab46763"><td class="memSeparator" colspan="2"> </td></tr>
98	<tr class="memitem:a8a6b72ba87a817652f522018df51a9a7"><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html#a8a6b72ba87a817652f522018df51a9a7">trail_length</a> (<a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html#accca9dc2d8fe018b9b5640c48e3470e4">char_type</a> c)</td></tr>
99	<tr class="separator:a8a6b72ba87a817652f522018df51a9a7"><td class="memSeparator" colspan="2"> </td></tr>
100	<tr class="memitem:ae2cb78fcb8a58bed3e0ce1d6528a719a"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html#ae2cb78fcb8a58bed3e0ce1d6528a719a">is_trail</a> (<a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html#accca9dc2d8fe018b9b5640c48e3470e4">char_type</a> c)</td></tr>
101	<tr class="separator:ae2cb78fcb8a58bed3e0ce1d6528a719a"><td class="memSeparator" colspan="2"> </td></tr>
102	<tr class="memitem:a19789c4c26c8d9f576de5272f3d41a11"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html#a19789c4c26c8d9f576de5272f3d41a11">is_lead</a> (<a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html#accca9dc2d8fe018b9b5640c48e3470e4">char_type</a> c)</td></tr>
103	<tr class="separator:a19789c4c26c8d9f576de5272f3d41a11"><td class="memSeparator" colspan="2"> </td></tr>
104	<tr class="memitem:acd59f628af084f800f8a86cdd8124fd8"><td class="memTemplParams" colspan="2">template<typename Iterator > </td></tr>
105	<tr class="memitem:acd59f628af084f800f8a86cdd8124fd8"><td class="memTemplItemLeft" align="right" valign="top">static Iterator </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html#acd59f628af084f800f8a86cdd8124fd8">encode</a> (<a class="el" href="namespaceboost_1_1locale_1_1utf.html#a068111a6b9d6d465a63893ed5c05e2f8">code_point</a> value, Iterator out)</td></tr>
106	<tr class="separator:acd59f628af084f800f8a86cdd8124fd8"><td class="memSeparator" colspan="2"> </td></tr>
107	<tr class="memitem:a8ff625b2c19b0d4132f7ec9e6303cb36"><td class="memTemplParams" colspan="2">template<typename Iterator > </td></tr>
108	<tr class="memitem:a8ff625b2c19b0d4132f7ec9e6303cb36"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="namespaceboost_1_1locale_1_1utf.html#a068111a6b9d6d465a63893ed5c05e2f8">code_point</a> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html#a8ff625b2c19b0d4132f7ec9e6303cb36">decode_valid</a> (Iterator &p)</td></tr>
109	<tr class="separator:a8ff625b2c19b0d4132f7ec9e6303cb36"><td class="memSeparator" colspan="2"> </td></tr>
110	</table><table class="memberdecls">
111	<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
112	Static Public Attributes</h2></td></tr>
113	<tr class="memitem:abb4cb63a924d19505c2cb6e930c68a13"><td class="memItemLeft" align="right" valign="top">static const int </td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html#abb4cb63a924d19505c2cb6e930c68a13">max_width</a></td></tr>
114	<tr class="separator:abb4cb63a924d19505c2cb6e930c68a13"><td class="memSeparator" colspan="2"> </td></tr>
115	</table>
116	<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
117	<div class="textblock"><h3>template<typename CharType, int size = sizeof(CharType)><br/>
118	struct boost::locale::utf::utf_traits< CharType, size ></h3>
119
120	<p>UTF Traits class - functions to convert UTF sequences to and from Unicode code points. </p>
121	</div><h2 class="groupheader">Member Typedef Documentation</h2>
122	<a class="anchor" id="accca9dc2d8fe018b9b5640c48e3470e4"></a>
123	<div class="memitem">
124	<div class="memproto">
125	<div class="memtemplate">
126	template<typename CharType, int size = sizeof(CharType)> </div>
127	<table class="memname">
128	<tr>
129	<td class="memname">typedef CharType <a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html">boost::locale::utf::utf_traits</a>< CharType, size >::<a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html#accca9dc2d8fe018b9b5640c48e3470e4">char_type</a></td>
130	</tr>
131	</table>
132	</div><div class="memdoc">
133	<p>The type of the character </p>
134
135	</div>
136	</div>
137	<h2 class="groupheader">Member Function Documentation</h2>
138	<a class="anchor" id="a9b6b01fa6705ba67ac78359ddee03213"></a>
139	<div class="memitem">
140	<div class="memproto">
141	<div class="memtemplate">
142	template<typename CharType, int size = sizeof(CharType)> </div>
143	<div class="memtemplate">
144	template<typename Iterator > </div>
145	<table class="mlabels">
146	<tr>
147	<td class="mlabels-left">
148	<table class="memname">
149	<tr>
150	<td class="memname">static <a class="el" href="namespaceboost_1_1locale_1_1utf.html#a068111a6b9d6d465a63893ed5c05e2f8">code_point</a> <a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html">boost::locale::utf::utf_traits</a>< CharType, size >::decode </td>
151	<td>(</td>
152	<td class="paramtype">Iterator & </td>
153	<td class="paramname"><em>p</em>, </td>
154	</tr>
155	<tr>
156	<td class="paramkey"></td>
157	<td></td>
158	<td class="paramtype">Iterator </td>
159	<td class="paramname"><em>e</em> </td>
160	</tr>
161	<tr>
162	<td></td>
163	<td>)</td>
164	<td></td><td></td>
165	</tr>
166	</table>
167	</td>
168	<td class="mlabels-right">
169	<span class="mlabels"><span class="mlabel">static</span></span> </td>
170	</tr>
171	</table>
172	</div><div class="memdoc">
173	<p>Read one code point from the range [p,e) and return it.</p>
174	<ul>
175	<li>If the sequence that was read is incomplete sequence returns <a class="el" href="namespaceboost_1_1locale_1_1utf.html#a20dbe458fd18229a0e6c09888d031b38">incomplete</a>,</li>
176	<li>If illegal sequence detected returns <a class="el" href="namespaceboost_1_1locale_1_1utf.html#a30010000878c7732340bda8956b844fb">illegal</a></li>
177	</ul>
178	<p>Requirements</p>
179	<ul>
180	<li>Iterator is valid input iterator</li>
181	</ul>
182	<p>Postconditions</p>
183	<ul>
184	<li>p points to the last consumed character </li>
185	</ul>
186
187	</div>
188	</div>
189	<a class="anchor" id="a8ff625b2c19b0d4132f7ec9e6303cb36"></a>
190	<div class="memitem">
191	<div class="memproto">
192	<div class="memtemplate">
193	template<typename CharType, int size = sizeof(CharType)> </div>
194	<div class="memtemplate">
195	template<typename Iterator > </div>
196	<table class="mlabels">
197	<tr>
198	<td class="mlabels-left">
199	<table class="memname">
200	<tr>
201	<td class="memname">static <a class="el" href="namespaceboost_1_1locale_1_1utf.html#a068111a6b9d6d465a63893ed5c05e2f8">code_point</a> <a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html">boost::locale::utf::utf_traits</a>< CharType, size >::decode_valid </td>
202	<td>(</td>
203	<td class="paramtype">Iterator & </td>
204	<td class="paramname"><em>p</em></td><td>)</td>
205	<td></td>
206	</tr>
207	</table>
208	</td>
209	<td class="mlabels-right">
210	<span class="mlabels"><span class="mlabel">static</span></span> </td>
211	</tr>
212	</table>
213	</div><div class="memdoc">
214	<p>Decodes valid UTF sequence that is pointed by p into code point.</p>
215	<p>If the sequence is invalid or points to end the behavior is undefined </p>
216
217	</div>
218	</div>
219	<a class="anchor" id="acd59f628af084f800f8a86cdd8124fd8"></a>
220	<div class="memitem">
221	<div class="memproto">
222	<div class="memtemplate">
223	template<typename CharType, int size = sizeof(CharType)> </div>
224	<div class="memtemplate">
225	template<typename Iterator > </div>
226	<table class="mlabels">
227	<tr>
228	<td class="mlabels-left">
229	<table class="memname">
230	<tr>
231	<td class="memname">static Iterator <a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html">boost::locale::utf::utf_traits</a>< CharType, size >::encode </td>
232	<td>(</td>
233	<td class="paramtype"><a class="el" href="namespaceboost_1_1locale_1_1utf.html#a068111a6b9d6d465a63893ed5c05e2f8">code_point</a> </td>
234	<td class="paramname"><em>value</em>, </td>
235	</tr>
236	<tr>
237	<td class="paramkey"></td>
238	<td></td>
239	<td class="paramtype">Iterator </td>
240	<td class="paramname"><em>out</em> </td>
241	</tr>
242	<tr>
243	<td></td>
244	<td>)</td>
245	<td></td><td></td>
246	</tr>
247	</table>
248	</td>
249	<td class="mlabels-right">
250	<span class="mlabels"><span class="mlabel">static</span></span> </td>
251	</tr>
252	</table>
253	</div><div class="memdoc">
254	<p>Convert valid Unicode code point <em>value</em> to the UTF sequence.</p>
255	<p>Requirements:</p>
256	<ul>
257	<li><em>value</em> is valid code point</li>
258	<li><em>out</em> is an output iterator should be able to accept at least width(value) units</li>
259	</ul>
260	<p>Returns the iterator past the last written code unit. </p>
261
262	</div>
263	</div>
264	<a class="anchor" id="a19789c4c26c8d9f576de5272f3d41a11"></a>
265	<div class="memitem">
266	<div class="memproto">
267	<div class="memtemplate">
268	template<typename CharType, int size = sizeof(CharType)> </div>
269	<table class="mlabels">
270	<tr>
271	<td class="mlabels-left">
272	<table class="memname">
273	<tr>
274	<td class="memname">static bool <a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html">boost::locale::utf::utf_traits</a>< CharType, size >::is_lead </td>
275	<td>(</td>
276	<td class="paramtype"><a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html#accca9dc2d8fe018b9b5640c48e3470e4">char_type</a> </td>
277	<td class="paramname"><em>c</em></td><td>)</td>
278	<td></td>
279	</tr>
280	</table>
281	</td>
282	<td class="mlabels-right">
283	<span class="mlabels"><span class="mlabel">static</span></span> </td>
284	</tr>
285	</table>
286	</div><div class="memdoc">
287	<p>Returns true if c is lead code unit, always true of UTF-32 </p>
288
289	</div>
290	</div>
291	<a class="anchor" id="ae2cb78fcb8a58bed3e0ce1d6528a719a"></a>
292	<div class="memitem">
293	<div class="memproto">
294	<div class="memtemplate">
295	template<typename CharType, int size = sizeof(CharType)> </div>
296	<table class="mlabels">
297	<tr>
298	<td class="mlabels-left">
299	<table class="memname">
300	<tr>
301	<td class="memname">static bool <a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html">boost::locale::utf::utf_traits</a>< CharType, size >::is_trail </td>
302	<td>(</td>
303	<td class="paramtype"><a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html#accca9dc2d8fe018b9b5640c48e3470e4">char_type</a> </td>
304	<td class="paramname"><em>c</em></td><td>)</td>
305	<td></td>
306	</tr>
307	</table>
308	</td>
309	<td class="mlabels-right">
310	<span class="mlabels"><span class="mlabel">static</span></span> </td>
311	</tr>
312	</table>
313	</div><div class="memdoc">
314	<p>Returns true if c is trail code unit, always false for UTF-32 </p>
315
316	</div>
317	</div>
318	<a class="anchor" id="a8a6b72ba87a817652f522018df51a9a7"></a>
319	<div class="memitem">
320	<div class="memproto">
321	<div class="memtemplate">
322	template<typename CharType, int size = sizeof(CharType)> </div>
323	<table class="mlabels">
324	<tr>
325	<td class="mlabels-left">
326	<table class="memname">
327	<tr>
328	<td class="memname">static int <a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html">boost::locale::utf::utf_traits</a>< CharType, size >::trail_length </td>
329	<td>(</td>
330	<td class="paramtype"><a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html#accca9dc2d8fe018b9b5640c48e3470e4">char_type</a> </td>
331	<td class="paramname"><em>c</em></td><td>)</td>
332	<td></td>
333	</tr>
334	</table>
335	</td>
336	<td class="mlabels-right">
337	<span class="mlabels"><span class="mlabel">static</span></span> </td>
338	</tr>
339	</table>
340	</div><div class="memdoc">
341	<p>Get the size of the trail part of variable length encoded sequence.</p>
342	<p>Returns -1 if C is not valid lead character </p>
343
344	</div>
345	</div>
346	<a class="anchor" id="a26c106ec8816f48431f882017ab46763"></a>
347	<div class="memitem">
348	<div class="memproto">
349	<div class="memtemplate">
350	template<typename CharType, int size = sizeof(CharType)> </div>
351	<table class="mlabels">
352	<tr>
353	<td class="mlabels-left">
354	<table class="memname">
355	<tr>
356	<td class="memname">static int <a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html">boost::locale::utf::utf_traits</a>< CharType, size >::width </td>
357	<td>(</td>
358	<td class="paramtype"><a class="el" href="namespaceboost_1_1locale_1_1utf.html#a068111a6b9d6d465a63893ed5c05e2f8">code_point</a> </td>
359	<td class="paramname"><em>value</em></td><td>)</td>
360	<td></td>
361	</tr>
362	</table>
363	</td>
364	<td class="mlabels-right">
365	<span class="mlabels"><span class="mlabel">static</span></span> </td>
366	</tr>
367	</table>
368	</div><div class="memdoc">
369	<p>The width of specific code point in the code units.</p>
370	<p>Requirement: value is a valid Unicode code point Returns value in range [1..max_width] </p>
371
372	</div>
373	</div>
374	<h2 class="groupheader">Member Data Documentation</h2>
375	<a class="anchor" id="abb4cb63a924d19505c2cb6e930c68a13"></a>
376	<div class="memitem">
377	<div class="memproto">
378	<div class="memtemplate">
379	template<typename CharType, int size = sizeof(CharType)> </div>
380	<table class="mlabels">
381	<tr>
382	<td class="mlabels-left">
383	<table class="memname">
384	<tr>
385	<td class="memname">const int <a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html">boost::locale::utf::utf_traits</a>< CharType, size >::max_width</td>
386	</tr>
387	</table>
388	</td>
389	<td class="mlabels-right">
390	<span class="mlabels"><span class="mlabel">static</span></span> </td>
391	</tr>
392	</table>
393	</div><div class="memdoc">
394	<p>Maximal width of valid sequence in the code units:</p>
395	<ul>
396	<li>UTF-8 - 4</li>
397	<li>UTF-16 - 2</li>
398	<li>UTF-32 - 1 </li>
399	</ul>
400
401	</div>
402	</div>
403	<hr/>The documentation for this struct was generated from the following file:<ul>
404	<li>boost/locale/<a class="el" href="utf_8hpp_source.html">utf.hpp</a></li>
405	</ul>
406	</div><!-- contents -->
407	</div><!-- doc-content -->
408
409	<li class="footer">
410	© 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.
411	</li>
412	</ul>
413	</div>
414	</body>
415	</html>