summaryrefslogtreecommitdiff
path: root/libs/spirit/doc/html/spirit/qi/reference/stream/stream.html
blob: 65a133e764fa2980f672404a3ca1b4e2298d807b (plain)
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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Stream Parsers (stream, wstream, etc.)</title>
<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="../../../../index.html" title="Spirit 2.5.2">
<link rel="up" href="../stream.html" title="Stream Parsers">
<link rel="prev" href="../stream.html" title="Stream Parsers">
<link rel="next" href="../string.html" title="String Parsers">
</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="../stream.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../stream.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="../string.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="spirit.qi.reference.stream.stream"></a><a class="link" href="stream.html" title="Stream Parsers (stream, wstream, etc.)">Stream Parsers
          (<code class="computeroutput"><span class="identifier">stream</span></code>, <code class="computeroutput"><span class="identifier">wstream</span></code>, etc.)</a>
</h5></div></div></div>
<h6>
<a name="spirit.qi.reference.stream.stream.h0"></a>
            <span><a name="spirit.qi.reference.stream.stream.description"></a></span><a class="link" href="stream.html#spirit.qi.reference.stream.stream.description">Description</a>
          </h6>
<p>
            The <code class="computeroutput"><span class="identifier">stream_parser</span></code> is
            a primitive which allows to use pre-existing standard streaming operators
            for input parsing integrated with <span class="emphasis"><em>Spirit.Qi</em></span>. It
            provides a wrapper parser dispatching the underlying input stream to
            the stream operator of the corresponding attribute type to be parsed.
            Any value <code class="computeroutput"><span class="identifier">a</span></code> to be parsed
            using the <code class="computeroutput"><span class="identifier">stream_parser</span></code>
            will result in invoking the standard streaming operator for its type
            <code class="computeroutput"><span class="identifier">A</span></code>, for instance:
          </p>
<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">istream</span><span class="special">&amp;</span> <span class="keyword">operator</span><span class="special">&gt;&gt;</span> <span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">istream</span><span class="special">&amp;,</span> <span class="identifier">A</span><span class="special">&amp;);</span>
</pre>
<h6>
<a name="spirit.qi.reference.stream.stream.h1"></a>
            <span><a name="spirit.qi.reference.stream.stream.header"></a></span><a class="link" href="stream.html#spirit.qi.reference.stream.stream.header">Header</a>
          </h6>
<pre class="programlisting"><span class="comment">// forwards to &lt;boost/spirit/home/qi/stream.hpp&gt;</span>
<span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">spirit</span><span class="special">/</span><span class="identifier">include</span><span class="special">/</span><span class="identifier">qi_stream</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
</pre>
<p>
            Also, see <a class="link" href="../../../structure/include.html" title="Include">Include Structure</a>.
          </p>
<h6>
<a name="spirit.qi.reference.stream.stream.h2"></a>
            <span><a name="spirit.qi.reference.stream.stream.namespace"></a></span><a class="link" href="stream.html#spirit.qi.reference.stream.stream.namespace">Namespace</a>
          </h6>
<div class="informaltable"><table class="table">
<colgroup><col></colgroup>
<thead><tr><th>
                    <p>
                      Name
                    </p>
                  </th></tr></thead>
<tbody>
<tr><td>
                    <p>
                      <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">spirit</span><span class="special">::</span><span class="identifier">stream</span> <span class="comment">//
                      alias: boost::spirit::qi::stream</span></code>
                    </p>
                  </td></tr>
<tr><td>
                    <p>
                      <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">spirit</span><span class="special">::</span><span class="identifier">wstream</span> <span class="comment">//
                      alias: boost::spirit::qi::wstream</span></code>
                    </p>
                  </td></tr>
</tbody>
</table></div>
<h6>
<a name="spirit.qi.reference.stream.stream.h3"></a>
            <span><a name="spirit.qi.reference.stream.stream.synopsis"></a></span><a class="link" href="stream.html#spirit.qi.reference.stream.stream.synopsis">Synopsis</a>
          </h6>
<pre class="programlisting"><span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Char</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Attrib</span><span class="special">&gt;</span>
<span class="keyword">struct</span> <span class="identifier">stream_parser</span><span class="special">;</span>
</pre>
<h6>
<a name="spirit.qi.reference.stream.stream.h4"></a>
            <span><a name="spirit.qi.reference.stream.stream.template_parameters"></a></span><a class="link" href="stream.html#spirit.qi.reference.stream.stream.template_parameters">Template
            parameters</a>
          </h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                    <p>
                      Parameter
                    </p>
                  </th>
<th>
                    <p>
                      Description
                    </p>
                  </th>
<th>
                    <p>
                      Default
                    </p>
                  </th>
</tr></thead>
<tbody>
<tr>
<td>
                    <p>
                      <code class="computeroutput"><span class="identifier">Char</span></code>
                    </p>
                  </td>
<td>
                    <p>
                      The character type to use to generate the input. This type
                      will be used while assigning the generated characters to the
                      underlying input iterator.
                    </p>
                  </td>
<td>
                    <p>
                      <code class="computeroutput"><span class="keyword">char</span></code>
                    </p>
                  </td>
</tr>
<tr>
<td>
                    <p>
                      <code class="computeroutput"><span class="identifier">Attrib</span></code>
                    </p>
                  </td>
<td>
                    <p>
                      The type of the attribute the <code class="computeroutput"><span class="identifier">stream_parser</span></code>
                      is expected to parse its input into.
                    </p>
                  </td>
<td>
                    <p>
                      <code class="computeroutput"><span class="identifier">spirit</span><span class="special">::</span><span class="identifier">basic_hold_any</span><span class="special">&lt;</span><span class="identifier">Char</span><span class="special">&gt;</span></code>
                    </p>
                  </td>
</tr>
</tbody>
</table></div>
<h6>
<a name="spirit.qi.reference.stream.stream.h5"></a>
            <span><a name="spirit.qi.reference.stream.stream.model_of"></a></span><a class="link" href="stream.html#spirit.qi.reference.stream.stream.model_of">Model
            of</a>
          </h6>
<div class="blockquote"><blockquote class="blockquote"><p>
              <a class="link" href="../parser_concepts/primitiveparser.html" title="PrimitiveParser"><code class="computeroutput"><span class="identifier">PrimitiveParser</span></code></a>
            </p></blockquote></div>
<div class="variablelist">
<p class="title"><b>Notation</b></p>
<dl>
<dt><span class="term"><code class="computeroutput"><span class="identifier">s</span></code></span></dt>
<dd><p>
                  A variable instance of any type with a defined matching streaming
                  <code class="computeroutput"><span class="keyword">operator</span><span class="special">&gt;&gt;()</span></code>
                  or a <a class="link" href="../basics.html#spirit.qi.reference.basics.lazy_argument">Lazy
                  Argument</a> that evaluates to any type with a defined matching
                  streaming <code class="computeroutput"><span class="keyword">operator</span><span class="special">&gt;&gt;()</span></code>.
                </p></dd>
</dl>
</div>
<h6>
<a name="spirit.qi.reference.stream.stream.h6"></a>
            <span><a name="spirit.qi.reference.stream.stream.expression_semantics"></a></span><a class="link" href="stream.html#spirit.qi.reference.stream.stream.expression_semantics">Expression
            Semantics</a>
          </h6>
<p>
            Semantics of an expression is defined only where it differs from, or
            is not defined in <a class="link" href="../parser_concepts/primitiveparser.html" title="PrimitiveParser"><code class="computeroutput"><span class="identifier">PrimitiveParser</span></code></a>.
          </p>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                    <p>
                      Expression
                    </p>
                  </th>
<th>
                    <p>
                      Description
                    </p>
                  </th>
</tr></thead>
<tbody>
<tr>
<td>
                    <p>
                      <code class="computeroutput"><span class="identifier">stream</span></code>
                    </p>
                  </td>
<td>
                    <p>
                      Call the streaming <code class="computeroutput"><span class="keyword">operator</span><span class="special">&gt;&gt;()</span></code> for the type of the
                      mandatory attribute. The input recognized by this operator
                      will be the result of the <code class="computeroutput"><span class="identifier">stream</span></code>
                      parser. This parser never fails (unless the underlying input
                      stream reports an error). The character type of the I/O istream
                      is assumed to be <code class="computeroutput"><span class="keyword">char</span></code>.
                    </p>
                  </td>
</tr>
<tr>
<td>
                    <p>
                      <code class="computeroutput"><span class="identifier">wstream</span></code>
                    </p>
                  </td>
<td>
                    <p>
                      Call the streaming <code class="computeroutput"><span class="keyword">operator</span><span class="special">&gt;&gt;()</span></code> for the type of the
                      mandatory attribute. The input recognized by this operator
                      will be the result of the <code class="computeroutput"><span class="identifier">wstream</span></code>
                      parser. This parser never fails (unless the underlying input
                      stream reports an error). The character type of the I/O istream
                      is assumed to be <code class="computeroutput"><span class="keyword">wchar_t</span></code>.
                    </p>
                  </td>
</tr>
</tbody>
</table></div>
<p>
            All parsers listed in the table above are predefined specializations
            of the <code class="computeroutput"><span class="identifier">stream_parser</span><span class="special">&lt;</span><span class="identifier">Char</span><span class="special">&gt;</span></code> basic stream parser type described
            below. It is possible to directly use this type to create stream parsers
            using an arbitrary underlying character type.
          </p>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                    <p>
                      Expression
                    </p>
                  </th>
<th>
                    <p>
                      Semantics
                    </p>
                  </th>
</tr></thead>
<tbody><tr>
<td>
                    <p>
</p>
<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">stream_parser</span><span class="special">&lt;</span>
    <span class="identifier">Char</span><span class="special">,</span> <span class="identifier">Attrib</span>
<span class="special">&gt;()</span></pre>
<p>
                    </p>
                  </td>
<td>
                    <p>
                      Call the streaming <code class="computeroutput"><span class="keyword">operator</span><span class="special">&gt;&gt;()</span></code> for the type of the
                      optional attribute, <code class="computeroutput"><span class="identifier">Attrib</span></code>.
                      The input recognized by this operator will be the result of
                      the <code class="computeroutput"><span class="identifier">stream_parser</span><span class="special">&lt;&gt;</span></code> parser. This parser
                      never fails (unless the underlying input stream reports an
                      error). The character type of the I/O istream is assumed to
                      be <code class="computeroutput"><span class="identifier">Char</span></code>
                    </p>
                  </td>
</tr></tbody>
</table></div>
<h6>
<a name="spirit.qi.reference.stream.stream.h7"></a>
            <span><a name="spirit.qi.reference.stream.stream.additional_requirements"></a></span><a class="link" href="stream.html#spirit.qi.reference.stream.stream.additional_requirements">Additional
            Requirements</a>
          </h6>
<p>
            All of the stream parsers listed above require the type of the value
            to parse (the associated attribute) to implement a streaming operator
            conforming to the usual I/O streams conventions (where <code class="computeroutput"><span class="identifier">attribute_type</span></code> is the type of the value
            to recognize while parse):
          </p>
<pre class="programlisting"><span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Istream</span><span class="special">&gt;</span>
<span class="identifier">Istream</span><span class="special">&amp;</span> <span class="keyword">operator</span><span class="special">&gt;&gt;</span> <span class="special">(</span><span class="identifier">Istream</span><span class="special">&amp;</span> <span class="identifier">os</span><span class="special">,</span> <span class="identifier">attribute_type</span><span class="special">&amp;</span> <span class="identifier">attr</span><span class="special">)</span>
<span class="special">{</span>
    <span class="comment">// type specific input parsing</span>
    <span class="keyword">return</span> <span class="identifier">os</span><span class="special">;</span>
<span class="special">}</span>
</pre>
<p>
            This operator will be called by the stream parsers to gather the input
            for the attribute of type <code class="computeroutput"><span class="identifier">attribute_type</span></code>.
          </p>
<div class="note"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top"><p>
              If the <code class="computeroutput"><span class="identifier">stream</span></code> parser
              is invoked inside a <a class="link" href="../parse_api/stream_api.html" title="Stream Based Parser API"><code class="computeroutput"><span class="identifier">match</span></code></a> (or <a class="link" href="../parse_api/stream_api.html" title="Stream Based Parser API"><code class="computeroutput"><span class="identifier">phrase_match</span></code></a>) stream manipulator
              the <code class="computeroutput"><span class="identifier">Istream</span></code> passed
              to the <code class="computeroutput"><span class="keyword">operator</span><span class="special">&gt;&gt;()</span></code>
              will have registered (imbued) the same standard locale instance as
              the stream the <a class="link" href="../parse_api/stream_api.html" title="Stream Based Parser API"><code class="computeroutput"><span class="identifier">match</span></code></a> (or <a class="link" href="../parse_api/stream_api.html" title="Stream Based Parser API"><code class="computeroutput"><span class="identifier">phrase_match</span></code></a>) manipulator
              has been used with. This ensures all facets registered (imbued) with
              the original I/O stream object are used during input parsing.
            </p></td></tr>
</table></div>
<h6>
<a name="spirit.qi.reference.stream.stream.h8"></a>
            <span><a name="spirit.qi.reference.stream.stream.attributes"></a></span><a class="link" href="stream.html#spirit.qi.reference.stream.stream.attributes">Attributes</a>
          </h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                    <p>
                      Expression
                    </p>
                  </th>
<th>
                    <p>
                      Attribute
                    </p>
                  </th>
</tr></thead>
<tbody>
<tr>
<td>
                    <p>
                      <code class="computeroutput"><span class="identifier">stream</span></code>
                    </p>
                  </td>
<td>
                    <p>
                      <code class="computeroutput"><span class="identifier">spirit</span><span class="special">::</span><span class="identifier">hold_any</span></code>
                    </p>
                  </td>
</tr>
<tr>
<td>
                    <p>
                      <code class="computeroutput"><span class="identifier">wstream</span></code>
                    </p>
                  </td>
<td>
                    <p>
                      <code class="computeroutput"><span class="identifier">spirit</span><span class="special">::</span><span class="identifier">whold_any</span></code>
                    </p>
                  </td>
</tr>
<tr>
<td>
                    <p>
                      <code class="computeroutput"><span class="identifier">stream_parser</span><span class="special">&lt;</span><span class="identifier">Char</span><span class="special">,</span> <span class="identifier">Attrib</span><span class="special">&gt;()</span></code>
                    </p>
                  </td>
<td>
                    <p>
                      <code class="computeroutput"><span class="identifier">Attrib</span></code>
                    </p>
                  </td>
</tr>
</tbody>
</table></div>
<div class="important"><table border="0" summary="Important">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Important]" src="../../../../images/important.png"></td>
<th align="left">Important</th>
</tr>
<tr><td align="left" valign="top"><p>
              The attribute type <code class="computeroutput"><span class="identifier">spirit</span><span class="special">::</span><span class="identifier">hold_any</span></code>
              exposed by some of the stream parsers is semantically and syntactically
              equivalent to the type implemented by <a href="../../../../../../../../libs/any/index.html" target="_top">Boost.Any</a>.
              It has been added to <span class="emphasis"><em>Spirit</em></span> as it has better performance
              and a smaller footprint than <a href="../../../../../../../../libs/any/index.html" target="_top">Boost.Any</a>.
            </p></td></tr>
</table></div>
<h6>
<a name="spirit.qi.reference.stream.stream.h9"></a>
            <span><a name="spirit.qi.reference.stream.stream.complexity"></a></span><a class="link" href="stream.html#spirit.qi.reference.stream.stream.complexity">Complexity</a>
          </h6>
<div class="blockquote"><blockquote class="blockquote"><p>
              O(N), where N is the number of characters consumed by the stream parser
            </p></blockquote></div>
<h6>
<a name="spirit.qi.reference.stream.stream.h10"></a>
            <span><a name="spirit.qi.reference.stream.stream.example"></a></span><a class="link" href="stream.html#spirit.qi.reference.stream.stream.example">Example</a>
          </h6>
<div class="note"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top"><p>
              The test harness for the example(s) below is presented in the <a class="link" href="../basics.html#spirit.qi.reference.basics.examples">Basics Examples</a>
              section.
            </p></td></tr>
</table></div>
<p>
            A class definition used in the examples:
          </p>
<p>
</p>
<pre class="programlisting"><span class="comment">// a simple complex number representation z = a + bi</span>
<span class="keyword">struct</span> <span class="identifier">complex</span>
<span class="special">{</span>
    <span class="identifier">complex</span> <span class="special">(</span><span class="keyword">double</span> <span class="identifier">a</span> <span class="special">=</span> <span class="number">0.0</span><span class="special">,</span> <span class="keyword">double</span> <span class="identifier">b</span> <span class="special">=</span> <span class="number">0.0</span><span class="special">)</span>
      <span class="special">:</span> <span class="identifier">a</span><span class="special">(</span><span class="identifier">a</span><span class="special">),</span> <span class="identifier">b</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span>
    <span class="special">{}</span>

    <span class="keyword">double</span> <span class="identifier">a</span><span class="special">;</span>
    <span class="keyword">double</span> <span class="identifier">b</span><span class="special">;</span>
<span class="special">};</span>
</pre>
<p>
          </p>
<p>
</p>
<pre class="programlisting"><span class="comment">// define streaming operator for the type complex</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">istream</span><span class="special">&amp;</span>
<span class="keyword">operator</span><span class="special">&gt;&gt;</span> <span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">istream</span><span class="special">&amp;</span> <span class="identifier">is</span><span class="special">,</span> <span class="identifier">complex</span><span class="special">&amp;</span> <span class="identifier">z</span><span class="special">)</span>
<span class="special">{</span>
    <span class="keyword">char</span> <span class="identifier">lbrace</span> <span class="special">=</span> <span class="char">'\0'</span><span class="special">,</span> <span class="identifier">comma</span> <span class="special">=</span> <span class="char">'\0'</span><span class="special">,</span> <span class="identifier">rbrace</span> <span class="special">=</span> <span class="char">'\0'</span><span class="special">;</span>
    <span class="identifier">is</span> <span class="special">&gt;&gt;</span> <span class="identifier">lbrace</span> <span class="special">&gt;&gt;</span> <span class="identifier">z</span><span class="special">.</span><span class="identifier">a</span> <span class="special">&gt;&gt;</span> <span class="identifier">comma</span> <span class="special">&gt;&gt;</span> <span class="identifier">z</span><span class="special">.</span><span class="identifier">b</span> <span class="special">&gt;&gt;</span> <span class="identifier">rbrace</span><span class="special">;</span>
    <span class="keyword">if</span> <span class="special">(</span><span class="identifier">lbrace</span> <span class="special">!=</span> <span class="char">'{'</span> <span class="special">||</span> <span class="identifier">comma</span> <span class="special">!=</span> <span class="char">','</span> <span class="special">||</span> <span class="identifier">rbrace</span> <span class="special">!=</span> <span class="char">'}'</span><span class="special">)</span>
        <span class="identifier">is</span><span class="special">.</span><span class="identifier">setstate</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">failbit</span><span class="special">);</span>
    <span class="keyword">return</span> <span class="identifier">is</span><span class="special">;</span>
<span class="special">}</span>
</pre>
<p>
          </p>
<p>
            Using declarations and variables:
          </p>
<p>
</p>
<pre class="programlisting"><span class="keyword">using</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">spirit</span><span class="special">::</span><span class="identifier">qi</span><span class="special">::</span><span class="identifier">stream</span><span class="special">;</span>
<span class="keyword">using</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">spirit</span><span class="special">::</span><span class="identifier">qi</span><span class="special">::</span><span class="identifier">stream_parser</span><span class="special">;</span>
</pre>
<p>
          </p>
<p>
            Parse a simple string using the operator&gt;&gt;(istream&amp;, std::string&amp;);
          </p>
<p>
</p>
<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="identifier">str</span><span class="special">;</span>
<span class="identifier">test_parser_attr</span><span class="special">(</span><span class="string">"abc"</span><span class="special">,</span> <span class="identifier">stream</span><span class="special">,</span> <span class="identifier">str</span><span class="special">);</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <span class="identifier">str</span> <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>                  <span class="comment">// prints: abc</span>
</pre>
<p>
          </p>
<p>
            Parse our complex type using the operator&gt;&gt;(istream&amp;, complex&amp;);
          </p>
<p>
</p>
<pre class="programlisting"><span class="identifier">complex</span> <span class="identifier">c</span><span class="special">;</span>
<span class="identifier">test_parser_attr</span><span class="special">(</span><span class="string">"{1.0,2.5}"</span><span class="special">,</span> <span class="identifier">stream_parser</span><span class="special">&lt;</span><span class="keyword">char</span><span class="special">,</span> <span class="identifier">complex</span><span class="special">&gt;(),</span> <span class="identifier">c</span><span class="special">);</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">a</span> <span class="special">&lt;&lt;</span> <span class="string">","</span> <span class="special">&lt;&lt;</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">b</span> <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>    <span class="comment">// prints: 1.0,2.5</span>
</pre>
<p>
          </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; 2001-2011 Joel de Guzman, Hartmut Kaiser<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="../stream.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../stream.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="../string.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>