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
|
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Sequential Or Parser (a || b)</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="../operator.html" title="Parser Operators">
<link rel="prev" href="sequence.html" title="Sequence Parser (a >> b)">
<link rel="next" href="../stream.html" title="Stream 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="sequence.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../operator.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="../stream.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.operator.sequential_or"></a><a class="link" href="sequential_or.html" title="Sequential Or Parser (a || b)">Sequential
Or Parser (<code class="computeroutput"><span class="identifier">a</span> <span class="special">||</span>
<span class="identifier">b</span></code>)</a>
</h5></div></div></div>
<h6>
<a name="spirit.qi.reference.operator.sequential_or.h0"></a>
<span><a name="spirit.qi.reference.operator.sequential_or.description"></a></span><a class="link" href="sequential_or.html#spirit.qi.reference.operator.sequential_or.description">Description</a>
</h6>
<p>
The sequential-or operator, <code class="computeroutput"><span class="identifier">a</span>
<span class="special">||</span> <span class="identifier">b</span></code>,
matches <code class="computeroutput"><span class="identifier">a</span></code> or <code class="computeroutput"><span class="identifier">b</span></code> or <code class="computeroutput"><span class="identifier">a</span></code>
followed by <code class="computeroutput"><span class="identifier">b</span></code>. That is,
if both <code class="computeroutput"><span class="identifier">a</span></code> and <code class="computeroutput"><span class="identifier">b</span></code> match, it must be in sequence; this
is equivalent to <code class="computeroutput"><span class="identifier">a</span> <span class="special">>></span>
<span class="special">-</span><span class="identifier">b</span>
<span class="special">|</span> <span class="identifier">b</span></code>:
</p>
<pre class="programlisting"><span class="identifier">a</span> <span class="special">||</span> <span class="identifier">b</span> <span class="special">||</span> <span class="special">...</span>
</pre>
<h6>
<a name="spirit.qi.reference.operator.sequential_or.h1"></a>
<span><a name="spirit.qi.reference.operator.sequential_or.header"></a></span><a class="link" href="sequential_or.html#spirit.qi.reference.operator.sequential_or.header">Header</a>
</h6>
<pre class="programlisting"><span class="comment">// forwards to <boost/spirit/home/qi/operator/sequential_or.hpp></span>
<span class="preprocessor">#include</span> <span class="special"><</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_sequential_or</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
</pre>
<p>
Also, see <a class="link" href="../../../structure/include.html" title="Include">Include Structure</a>.
</p>
<h6>
<a name="spirit.qi.reference.operator.sequential_or.h2"></a>
<span><a name="spirit.qi.reference.operator.sequential_or.model_of"></a></span><a class="link" href="sequential_or.html#spirit.qi.reference.operator.sequential_or.model_of">Model of</a>
</h6>
<div class="blockquote"><blockquote class="blockquote"><p>
<a class="link" href="../parser_concepts/naryparser.html" title="NaryParser"><code class="computeroutput"><span class="identifier">NaryParser</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">a</span></code>, <code class="computeroutput"><span class="identifier">b</span></code></span></dt>
<dd><p>
A <a class="link" href="../parser_concepts/parser.html" title="Parser"><code class="computeroutput"><span class="identifier">Parser</span></code></a>
</p></dd>
</dl>
</div>
<h6>
<a name="spirit.qi.reference.operator.sequential_or.h3"></a>
<span><a name="spirit.qi.reference.operator.sequential_or.expression_semantics"></a></span><a class="link" href="sequential_or.html#spirit.qi.reference.operator.sequential_or.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/naryparser.html" title="NaryParser"><code class="computeroutput"><span class="identifier">NaryParser</span></code></a>.
</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>
<code class="computeroutput"><span class="identifier">a</span> <span class="special">||</span>
<span class="identifier">b</span></code>
</p>
</td>
<td>
<p>
Match <code class="computeroutput"><span class="identifier">a</span></code> or
<code class="computeroutput"><span class="identifier">b</span></code> in sequence.
equivalent to <code class="computeroutput"><span class="identifier">a</span> <span class="special">>></span> <span class="special">-</span><span class="identifier">b</span> <span class="special">|</span>
<span class="identifier">b</span></code>
</p>
</td>
</tr></tbody>
</table></div>
<h6>
<a name="spirit.qi.reference.operator.sequential_or.h4"></a>
<span><a name="spirit.qi.reference.operator.sequential_or.attributes"></a></span><a class="link" href="sequential_or.html#spirit.qi.reference.operator.sequential_or.attributes">Attributes</a>
</h6>
<p>
See <a class="link" href="../../quick_reference/compound_attribute_rules.html#spirit.qi.quick_reference.compound_attribute_rules.notation">Compound
Attribute Notation</a>.
</p>
<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">a</span> <span class="special">||</span>
<span class="identifier">b</span></code>
</p>
</td>
<td>
<p>
</p>
<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><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="identifier">a</span> <span class="special">||</span> <span class="identifier">b</span><span class="special">):</span> <span class="identifier">tuple</span><span class="special"><</span><span class="identifier">optional</span><span class="special"><</span><span class="identifier">A</span><span class="special">>,</span> <span class="identifier">optional</span><span class="special"><</span><span class="identifier">B</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">Unused</span> <span class="special">--></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">optional</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">Unused</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="identifier">a</span> <span class="special">||</span> <span class="identifier">b</span><span class="special">):</span> <span class="identifier">optional</span><span class="special"><</span><span class="identifier">B</span><span class="special">></span>
<span class="identifier">a</span><span class="special">:</span> <span class="identifier">Unused</span><span class="special">,</span> <span class="identifier">b</span><span class="special">:</span> <span class="identifier">Unused</span> <span class="special">--></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">Unused</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">A</span> <span class="special">--></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">vector</span><span class="special"><</span><span class="identifier">optional</span><span class="special"><</span><span class="identifier">A</span><span class="special">></span> <span class="special">></span></pre>
<p>
</p>
</td>
</tr></tbody>
</table></div>
<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 sequential-or parser behaves attribute-wise very similar to the
plain sequence parser (<code class="computeroutput"><span class="identifier">a</span>
<span class="special">>></span> <span class="identifier">b</span></code>)
in the sense that it exposes the attributes of its elements separately.
For instance, if you attach a semantic action to the whole sequential-or:
</p>
<pre class="programlisting"><span class="special">(</span><span class="identifier">int_</span> <span class="special">||</span> <span class="identifier">int_</span><span class="special">)[</span><span class="identifier">print_pair</span><span class="special">(</span><span class="identifier">_1</span><span class="special">,</span> <span class="identifier">_2</span><span class="special">)]</span>
</pre>
<p>
the function object <code class="computeroutput"><span class="identifier">print_pair</span></code>
would be invoked with the attribute of the first <code class="computeroutput"><span class="identifier">int_</span></code>
(<code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">optional</span><span class="special"><</span><span class="keyword">int</span><span class="special">></span></code>)
as its first parameter and the attribute of the second <code class="computeroutput"><span class="identifier">int_</span></code> (<code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">optional</span><span class="special"><</span><span class="keyword">int</span><span class="special">></span></code> as well) as its second parameter.
</p>
</td></tr>
</table></div>
<h6>
<a name="spirit.qi.reference.operator.sequential_or.h5"></a>
<span><a name="spirit.qi.reference.operator.sequential_or.complexity"></a></span><a class="link" href="sequential_or.html#spirit.qi.reference.operator.sequential_or.complexity">Complexity</a>
</h6>
<div class="blockquote"><blockquote class="blockquote"><p>
The overall complexity of the sequential-or parser is defined by the
sum of the complexities of its elements. The complexity of the sequential-or
itself is O(N), where N is the number of elements in the sequence.
</p></blockquote></div>
<h6>
<a name="spirit.qi.reference.operator.sequential_or.h6"></a>
<span><a name="spirit.qi.reference.operator.sequential_or.example"></a></span><a class="link" href="sequential_or.html#spirit.qi.reference.operator.sequential_or.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>
Some using declarations:
</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">int_</span><span class="special">;</span>
</pre>
<p>
</p>
<p>
Correctly parsing a number with optional fractional digits:
</p>
<p>
</p>
<pre class="programlisting"><span class="identifier">test_parser</span><span class="special">(</span><span class="string">"123.456"</span><span class="special">,</span> <span class="identifier">int_</span> <span class="special">||</span> <span class="special">(</span><span class="char">'.'</span> <span class="special">>></span> <span class="identifier">int_</span><span class="special">));</span> <span class="comment">// full</span>
<span class="identifier">test_parser</span><span class="special">(</span><span class="string">"123"</span><span class="special">,</span> <span class="identifier">int_</span> <span class="special">||</span> <span class="special">(</span><span class="char">'.'</span> <span class="special">>></span> <span class="identifier">int_</span><span class="special">));</span> <span class="comment">// just the whole number</span>
<span class="identifier">test_parser</span><span class="special">(</span><span class="string">".456"</span><span class="special">,</span> <span class="identifier">int_</span> <span class="special">||</span> <span class="special">(</span><span class="char">'.'</span> <span class="special">>></span> <span class="identifier">int_</span><span class="special">));</span> <span class="comment">// just the fraction</span>
</pre>
<p>
</p>
<p>
A naive but incorrect solution would try to do this using optionals (e.g.):
</p>
<pre class="programlisting"><span class="identifier">int_</span> <span class="special">>></span> <span class="special">-(</span><span class="char">'.'</span> <span class="special">>></span> <span class="identifier">int_</span><span class="special">)</span> <span class="comment">// will not match ".456"</span>
<span class="special">-</span><span class="identifier">int_</span> <span class="special">>></span> <span class="special">(</span><span class="char">'.'</span> <span class="special">>></span> <span class="identifier">int_</span><span class="special">)</span> <span class="comment">// will not match "123"</span>
<span class="special">-</span><span class="identifier">int_</span> <span class="special">>></span> <span class="special">-(</span><span class="char">'.'</span> <span class="special">>></span> <span class="identifier">int_</span><span class="special">)</span> <span class="comment">// will match empty strings! Ooops.</span>
</pre>
</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 © 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="sequence.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../operator.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="../stream.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
|
