123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415 |
- <!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< CharType, size > 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 Page</span></a></li>
- <li><a href="pages.html"><span>Related 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 List</span></a></li>
- <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
- <li><a href="functions.html"><span>Class 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> |
- <a href="#pub-static-methods">Static Public Member Functions</a> |
- <a href="#pub-static-attribs">Static Public Attributes</a> |
- <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< CharType, size > 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 <<a class="el" href="utf_8hpp_source.html">boost/locale/utf.hpp</a>></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 </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"> </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<typename Iterator > </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> </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>
- <tr class="separator:a9b6b01fa6705ba67ac78359ddee03213"><td class="memSeparator" colspan="2"> </td></tr>
- <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>
- <tr class="separator:a26c106ec8816f48431f882017ab46763"><td class="memSeparator" colspan="2"> </td></tr>
- <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>
- <tr class="separator:a8a6b72ba87a817652f522018df51a9a7"><td class="memSeparator" colspan="2"> </td></tr>
- <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>
- <tr class="separator:ae2cb78fcb8a58bed3e0ce1d6528a719a"><td class="memSeparator" colspan="2"> </td></tr>
- <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>
- <tr class="separator:a19789c4c26c8d9f576de5272f3d41a11"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:acd59f628af084f800f8a86cdd8124fd8"><td class="memTemplParams" colspan="2">template<typename Iterator > </td></tr>
- <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>
- <tr class="separator:acd59f628af084f800f8a86cdd8124fd8"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8ff625b2c19b0d4132f7ec9e6303cb36"><td class="memTemplParams" colspan="2">template<typename Iterator > </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> </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>
- <tr class="separator:a8ff625b2c19b0d4132f7ec9e6303cb36"><td class="memSeparator" colspan="2"> </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 </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"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><h3>template<typename CharType, int size = sizeof(CharType)><br/>
- struct boost::locale::utf::utf_traits< CharType, size ></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<typename CharType, int size = sizeof(CharType)> </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>< CharType, size >::<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<typename CharType, int size = sizeof(CharType)> </div>
- <div class="memtemplate">
- template<typename Iterator > </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>< CharType, size >::decode </td>
- <td>(</td>
- <td class="paramtype">Iterator & </td>
- <td class="paramname"><em>p</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">Iterator </td>
- <td class="paramname"><em>e</em> </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<typename CharType, int size = sizeof(CharType)> </div>
- <div class="memtemplate">
- template<typename Iterator > </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>< CharType, size >::decode_valid </td>
- <td>(</td>
- <td class="paramtype">Iterator & </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<typename CharType, int size = sizeof(CharType)> </div>
- <div class="memtemplate">
- template<typename Iterator > </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>< CharType, size >::encode </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="namespaceboost_1_1locale_1_1utf.html#a068111a6b9d6d465a63893ed5c05e2f8">code_point</a> </td>
- <td class="paramname"><em>value</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">Iterator </td>
- <td class="paramname"><em>out</em> </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<typename CharType, int size = sizeof(CharType)> </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>< CharType, size >::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> </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<typename CharType, int size = sizeof(CharType)> </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>< CharType, size >::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> </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<typename CharType, int size = sizeof(CharType)> </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>< CharType, size >::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> </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<typename CharType, int size = sizeof(CharType)> </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>< CharType, size >::width </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="namespaceboost_1_1locale_1_1utf.html#a068111a6b9d6d465a63893ed5c05e2f8">code_point</a> </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<typename CharType, int size = sizeof(CharType)> </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>< CharType, size >::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">
- © 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>
|