File: uni_iter.html

package info (click to toggle)
boost1.62 1.62.0%2Bdfsg-4
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 686,420 kB
  • sloc: cpp: 2,609,004; xml: 972,558; ansic: 53,674; python: 32,437; sh: 8,829; asm: 3,071; cs: 2,121; makefile: 964; perl: 859; yacc: 472; php: 132; ruby: 94; f90: 55; sql: 13; csh: 6
file content (178 lines) | stat: -rw-r--r-- 17,199 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Unicode Iterators</title>
<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../../index.html" title="Boost.Regex 5.1.2">
<link rel="up" href="../internal_details.html" title="Internal Details">
<link rel="prev" href="../internal_details.html" title="Internal Details">
<link rel="next" href="../../background_information.html" title="Background Information">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<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>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="boost_regex.ref.internal_details.uni_iter"></a><a class="link" href="uni_iter.html" title="Unicode Iterators">Unicode
        Iterators</a>
</h4></div></div></div>
<h5>
<a name="boost_regex.ref.internal_details.uni_iter.h0"></a>
          <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>
        </h5>
<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>
<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>
<span class="keyword">class</span> <span class="identifier">u32_to_u16_iterator</span><span class="special">;</span>

<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>
<span class="keyword">class</span> <span class="identifier">u16_to_u32_iterator</span><span class="special">;</span>

<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>
<span class="keyword">class</span> <span class="identifier">u32_to_u8_iterator</span><span class="special">;</span>

<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>
<span class="keyword">class</span> <span class="identifier">u8_to_u32_iterator</span><span class="special">;</span>

<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>
<span class="keyword">class</span> <span class="identifier">utf16_output_iterator</span><span class="special">;</span>

<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>
<span class="keyword">class</span> <span class="identifier">utf8_output_iterator</span><span class="special">;</span>
</pre>
<h5>
<a name="boost_regex.ref.internal_details.uni_iter.h1"></a>
          <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>
        </h5>
<p>
          This header contains a selection of iterator adaptors that make a sequence
          of characters in one encoding "look like" a read-only sequence
          of characters in another encoding.
        </p>
<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>
<span class="keyword">class</span> <span class="identifier">u32_to_u16_iterator</span>
<span class="special">{</span>
   <span class="identifier">u32_to_u16_iterator</span><span class="special">();</span>
   <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>

   <span class="comment">// Other standard BidirectionalIterator members here...</span>
<span class="special">};</span>
</pre>
<p>
          A Bidirectional iterator adapter that makes an underlying sequence of UTF32
          characters look like a (read-only) sequence of UTF16 characters. The UTF16
          characters are encoded in the platforms native byte order.
        </p>
<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>
<span class="keyword">class</span> <span class="identifier">u16_to_u32_iterator</span>
<span class="special">{</span>
   <span class="identifier">u16_to_u32_iterator</span><span class="special">();</span>
   <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">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>

   <span class="comment">// Other standard BidirectionalIterator members here...</span>
<span class="special">};</span>
</pre>
<p>
          A Bidirectional iterator adapter that makes an underlying sequence of UTF16
          characters (in the platforms native byte order) look like a (read-only)
          sequence of UTF32 characters.
        </p>
<p>
          The three-arg constructor of this class takes the start and end of the
          underlying sequence as well as the position to start iteration from. This
          constructor validates that the underlying sequence has validly encoded
          endpoints: this prevents accidentally incrementing/decrementing past the
          end of the underlying sequence as a result of invalid UTF16 code sequences
          at the endpoints of the underlying range.
        </p>
<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>
<span class="keyword">class</span> <span class="identifier">u32_to_u8_iterator</span>
<span class="special">{</span>
   <span class="identifier">u32_to_u8_iterator</span><span class="special">();</span>
   <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>

   <span class="comment">// Other standard BidirectionalIterator members here...</span>
<span class="special">};</span>
</pre>
<p>
          A Bidirectional iterator adapter that makes an underlying sequence of UTF32
          characters look like a (read-only) sequence of UTF8 characters.
        </p>
<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>
<span class="keyword">class</span> <span class="identifier">u8_to_u32_iterator</span>
<span class="special">{</span>
   <span class="identifier">u8_to_u32_iterator</span><span class="special">();</span>
   <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">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>

   <span class="comment">// Other standard BidirectionalIterator members here...</span>
<span class="special">};</span>
</pre>
<p>
          A Bidirectional iterator adapter that makes an underlying sequence of UTF8
          characters look like a (read-only) sequence of UTF32 characters.
        </p>
<p>
          The three-arg constructor of this class takes the start and end of the
          underlying sequence as well as the position to start iteration from. This
          constructor validates that the underlying sequence has validly encoded
          endpoints: this prevents accidentally incrementing/decrementing past the
          end of the underlying sequence as a result of invalid UTF8 code sequences
          at the endpoints of the underlying range.
        </p>
<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>
<span class="keyword">class</span> <span class="identifier">utf16_output_iterator</span>
<span class="special">{</span>
   <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>
   <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>
   <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>

   <span class="comment">// Other standard OutputIterator members here...</span>
<span class="special">};</span>
</pre>
<p>
          Simple OutputIterator adapter - accepts UTF32 values as input, and forwards
          them to <span class="emphasis"><em>BaseIterator b</em></span> as UTF16. Both UTF32 and UTF16
          values are in native byte order.
        </p>
<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>
<span class="keyword">class</span> <span class="identifier">utf8_output_iterator</span>
<span class="special">{</span>
   <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>
   <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>
   <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>

   <span class="comment">// Other standard OutputIterator members here...</span>
<span class="special">};</span>
</pre>
<p>
          Simple OutputIterator adapter - accepts UTF32 values as input, and forwards
          them to <span class="emphasis"><em>BaseIterator b</em></span> as UTF8. The UTF32 input values
          must be in native byte order.
        </p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 1998-2013 John Maddock<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        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>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<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>
</div>
</body>
</html>