ceph/src/boost/libs/regex/doc/html/boost_regex/ref/internal_details/uni_iter.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Unicode Iterators</title>
   5 <link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
   7 <link rel="home" href="../../../index.html" title="Boost.Regex 5.1.2">
   8 <link rel="up" href="../internal_details.html" title="Internal Details">
   9 <link rel="prev" href="../internal_details.html" title="Internal Details">
  10 <link rel="next" href="../../background_information.html" title="Background Information">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="../internal_details.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../internal_details.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../../background_information.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h4 class="title">
  27 <a name="boost_regex.ref.internal_details.uni_iter"></a><a class="link" href="uni_iter.html" title="Unicode Iterators">Unicode
  28         Iterators</a>
  29 </h4></div></div></div>
  30 <h5>
  31 <a name="boost_regex.ref.internal_details.uni_iter.h0"></a>
  32           <span class="phrase"><a name="boost_regex.ref.internal_details.uni_iter.synopsis"></a></span><a class="link" href="uni_iter.html#boost_regex.ref.internal_details.uni_iter.synopsis">Synopsis</a>
  33         </h5>
  34 <pre class="programlisting"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">regex</span><span class="special">/</span><span class="identifier">pending</span><span class="special">/</span><span class="identifier">unicode_iterator</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></pre>
  35 <pre class="programlisting"><span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">BaseIterator</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">U16Type</span> <span class="special">=</span> <span class="special">::</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">uint16_t</span><span class="special">&gt;</span>
  36 <span class="keyword">class</span> <span class="identifier">u32_to_u16_iterator</span><span class="special">;</span>
  37
  38 <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">BaseIterator</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">U32Type</span> <span class="special">=</span> <span class="special">::</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">uint32_t</span><span class="special">&gt;</span>
  39 <span class="keyword">class</span> <span class="identifier">u16_to_u32_iterator</span><span class="special">;</span>
  40
  41 <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">BaseIterator</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">U8Type</span> <span class="special">=</span> <span class="special">::</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">uint8_t</span><span class="special">&gt;</span>
  42 <span class="keyword">class</span> <span class="identifier">u32_to_u8_iterator</span><span class="special">;</span>
  43
  44 <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">BaseIterator</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">U32Type</span> <span class="special">=</span> <span class="special">::</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">uint32_t</span><span class="special">&gt;</span>
  45 <span class="keyword">class</span> <span class="identifier">u8_to_u32_iterator</span><span class="special">;</span>
  46
  47 <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">BaseIterator</span><span class="special">&gt;</span>
  48 <span class="keyword">class</span> <span class="identifier">utf16_output_iterator</span><span class="special">;</span>
  49
  50 <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">BaseIterator</span><span class="special">&gt;</span>
  51 <span class="keyword">class</span> <span class="identifier">utf8_output_iterator</span><span class="special">;</span>
  52 </pre>
  53 <h5>
  54 <a name="boost_regex.ref.internal_details.uni_iter.h1"></a>
  55           <span class="phrase"><a name="boost_regex.ref.internal_details.uni_iter.description"></a></span><a class="link" href="uni_iter.html#boost_regex.ref.internal_details.uni_iter.description">Description</a>
  56         </h5>
  57 <p>
  58           This header contains a selection of iterator adaptors that make a sequence
  59           of characters in one encoding "look like" a read-only sequence
  60           of characters in another encoding.
  61         </p>
  62 <pre class="programlisting"><span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">BaseIterator</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">U16Type</span> <span class="special">=</span> <span class="special">::</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">uint16_t</span><span class="special">&gt;</span>
  63 <span class="keyword">class</span> <span class="identifier">u32_to_u16_iterator</span>
  64 <span class="special">{</span>
  65    <span class="identifier">u32_to_u16_iterator</span><span class="special">();</span>
  66    <span class="identifier">u32_to_u16_iterator</span><span class="special">(</span><span class="identifier">BaseIterator</span> <span class="identifier">start_position</span><span class="special">);</span>
  67
  68    <span class="comment">// Other standard BidirectionalIterator members here...</span>
  69 <span class="special">};</span>
  70 </pre>
  71 <p>
  72           A Bidirectional iterator adapter that makes an underlying sequence of UTF32
  73           characters look like a (read-only) sequence of UTF16 characters. The UTF16
  74           characters are encoded in the platforms native byte order.
  75         </p>
  76 <pre class="programlisting"><span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">BaseIterator</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">U32Type</span> <span class="special">=</span> <span class="special">::</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">uint32_t</span><span class="special">&gt;</span>
  77 <span class="keyword">class</span> <span class="identifier">u16_to_u32_iterator</span>
  78 <span class="special">{</span>
  79    <span class="identifier">u16_to_u32_iterator</span><span class="special">();</span>
  80    <span class="identifier">u16_to_u32_iterator</span><span class="special">(</span><span class="identifier">BaseIterator</span> <span class="identifier">start_position</span><span class="special">);</span>
  81    <span class="identifier">u16_to_u32_iterator</span><span class="special">(</span><span class="identifier">BaseIterator</span> <span class="identifier">start_position</span><span class="special">,</span> <span class="identifier">BaseIterator</span> <span class="identifier">start_range</span><span class="special">,</span> <span class="identifier">BaseIterator</span> <span class="identifier">end_range</span><span class="special">);</span>
  82
  83    <span class="comment">// Other standard BidirectionalIterator members here...</span>
  84 <span class="special">};</span>
  85 </pre>
  86 <p>
  87           A Bidirectional iterator adapter that makes an underlying sequence of UTF16
  88           characters (in the platforms native byte order) look like a (read-only)
  89           sequence of UTF32 characters.
  90         </p>
  91 <p>
  92           The three-arg constructor of this class takes the start and end of the
  93           underlying sequence as well as the position to start iteration from. This
  94           constructor validates that the underlying sequence has validly encoded
  95           endpoints: this prevents accidentally incrementing/decrementing past the
  96           end of the underlying sequence as a result of invalid UTF16 code sequences
  97           at the endpoints of the underlying range.
  98         </p>
  99 <pre class="programlisting"><span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">BaseIterator</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">U8Type</span> <span class="special">=</span> <span class="special">::</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">uint8_t</span><span class="special">&gt;</span>
 100 <span class="keyword">class</span> <span class="identifier">u32_to_u8_iterator</span>
 101 <span class="special">{</span>
 102    <span class="identifier">u32_to_u8_iterator</span><span class="special">();</span>
 103    <span class="identifier">u32_to_u8_iterator</span><span class="special">(</span><span class="identifier">BaseIterator</span> <span class="identifier">start_position</span><span class="special">);</span>
 104
 105    <span class="comment">// Other standard BidirectionalIterator members here...</span>
 106 <span class="special">};</span>
 107 </pre>
 108 <p>
 109           A Bidirectional iterator adapter that makes an underlying sequence of UTF32
 110           characters look like a (read-only) sequence of UTF8 characters.
 111         </p>
 112 <pre class="programlisting"><span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">BaseIterator</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">U32Type</span> <span class="special">=</span> <span class="special">::</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">uint32_t</span><span class="special">&gt;</span>
 113 <span class="keyword">class</span> <span class="identifier">u8_to_u32_iterator</span>
 114 <span class="special">{</span>
 115    <span class="identifier">u8_to_u32_iterator</span><span class="special">();</span>
 116    <span class="identifier">u8_to_u32_iterator</span><span class="special">(</span><span class="identifier">BaseIterator</span> <span class="identifier">start_position</span><span class="special">);</span>
 117    <span class="identifier">u8_to_u32_iterator</span><span class="special">(</span><span class="identifier">BaseIterator</span> <span class="identifier">start_position</span><span class="special">,</span> <span class="identifier">BaseIterator</span> <span class="identifier">start_range</span><span class="special">,</span> <span class="identifier">BaseIterator</span> <span class="identifier">end_range</span><span class="special">);</span>
 118
 119    <span class="comment">// Other standard BidirectionalIterator members here...</span>
 120 <span class="special">};</span>
 121 </pre>
 122 <p>
 123           A Bidirectional iterator adapter that makes an underlying sequence of UTF8
 124           characters look like a (read-only) sequence of UTF32 characters.
 125         </p>
 126 <p>
 127           The three-arg constructor of this class takes the start and end of the
 128           underlying sequence as well as the position to start iteration from. This
 129           constructor validates that the underlying sequence has validly encoded
 130           endpoints: this prevents accidentally incrementing/decrementing past the
 131           end of the underlying sequence as a result of invalid UTF8 code sequences
 132           at the endpoints of the underlying range.
 133         </p>
 134 <pre class="programlisting"><span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">BaseIterator</span><span class="special">&gt;</span>
 135 <span class="keyword">class</span> <span class="identifier">utf16_output_iterator</span>
 136 <span class="special">{</span>
 137    <span class="identifier">utf16_output_iterator</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">BaseIterator</span><span class="special">&amp;</span> <span class="identifier">b</span><span class="special">);</span>
 138    <span class="identifier">utf16_output_iterator</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">utf16_output_iterator</span><span class="special">&amp;</span> <span class="identifier">that</span><span class="special">);</span>
 139    <span class="identifier">utf16_output_iterator</span><span class="special">&amp;</span> <span class="keyword">operator</span><span class="special">=(</span><span class="keyword">const</span> <span class="identifier">utf16_output_iterator</span><span class="special">&amp;</span> <span class="identifier">that</span><span class="special">);</span>
 140
 141    <span class="comment">// Other standard OutputIterator members here...</span>
 142 <span class="special">};</span>
 143 </pre>
 144 <p>
 145           Simple OutputIterator adapter - accepts UTF32 values as input, and forwards
 146           them to <span class="emphasis"><em>BaseIterator b</em></span> as UTF16. Both UTF32 and UTF16
 147           values are in native byte order.
 148         </p>
 149 <pre class="programlisting"><span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">BaseIterator</span><span class="special">&gt;</span>
 150 <span class="keyword">class</span> <span class="identifier">utf8_output_iterator</span>
 151 <span class="special">{</span>
 152    <span class="identifier">utf8_output_iterator</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">BaseIterator</span><span class="special">&amp;</span> <span class="identifier">b</span><span class="special">);</span>
 153    <span class="identifier">utf8_output_iterator</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">utf8_output_iterator</span><span class="special">&amp;</span> <span class="identifier">that</span><span class="special">);</span>
 154    <span class="identifier">utf8_output_iterator</span><span class="special">&amp;</span> <span class="keyword">operator</span><span class="special">=(</span><span class="keyword">const</span> <span class="identifier">utf8_output_iterator</span><span class="special">&amp;</span> <span class="identifier">that</span><span class="special">);</span>
 155
 156    <span class="comment">// Other standard OutputIterator members here...</span>
 157 <span class="special">};</span>
 158 </pre>
 159 <p>
 160           Simple OutputIterator adapter - accepts UTF32 values as input, and forwards
 161           them to <span class="emphasis"><em>BaseIterator b</em></span> as UTF8. The UTF32 input values
 162           must be in native byte order.
 163         </p>
 164 </div>
 165 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 166 <td align="left"></td>
 167 <td align="right"><div class="copyright-footer">Copyright &#169; 1998-2013 John Maddock<p>
 168         Distributed under the Boost Software License, Version 1.0. (See accompanying
 169         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
 170       </p>
 171 </div></td>
 172 </tr></table>
 173 <hr>
 174 <div class="spirit-nav">
 175 <a accesskey="p" href="../internal_details.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../internal_details.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../../background_information.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 176 </div>
 177 </body>
 178 </html>