3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4 <title>Repetition Parser Directive (repeat[])</title>
5 <link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7 <link rel="home" href="../../../../index.html" title="Spirit 2.5.2">
8 <link rel="up" href="../directive.html" title="Parser Directives">
9 <link rel="prev" href="raw.html" title="Directive for Transduction Parsing (raw[])">
10 <link rel="next" href="matches.html" title="Directive Testing if Parser Succeeded (matches[])">
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>
22 <div class="spirit-nav">
23 <a accesskey="p" href="raw.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../directive.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="matches.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
26 <div class="titlepage"><div><div><h5 class="title">
27 <a name="spirit.qi.reference.directive.repeat"></a><a class="link" href="repeat.html" title="Repetition Parser Directive (repeat[])">Repetition
28 Parser Directive (<code class="computeroutput"><span class="identifier">repeat</span><span class="special">[]</span></code>)</a>
29 </h5></div></div></div>
31 <a name="spirit.qi.reference.directive.repeat.h0"></a>
32 <span class="phrase"><a name="spirit.qi.reference.directive.repeat.description"></a></span><a class="link" href="repeat.html#spirit.qi.reference.directive.repeat.description">Description</a>
35 The <code class="computeroutput"><span class="identifier">repeat</span><span class="special">[]</span></code>
36 provides a more powerful and flexible mechanism for repeating a parser.
37 There are grammars that are impractical and cumbersome, if not impossible,
38 for the basic EBNF iteration syntax (<a class="link" href="../operator/kleene.html" title="Kleene Parser (*a)">Kleene</a>
39 and the <a class="link" href="../operator/plus.html" title="Plus Parser (+a)">Plus</a>)
42 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
44 A file name may have a maximum of 255 characters only.
47 A specific bitmap file format has exactly 4096 RGB color information.
50 A 256 bit binary string (1..256 1s or 0s).
54 <a name="spirit.qi.reference.directive.repeat.h1"></a>
55 <span class="phrase"><a name="spirit.qi.reference.directive.repeat.header"></a></span><a class="link" href="repeat.html#spirit.qi.reference.directive.repeat.header">Header</a>
57 <pre class="programlisting"><span class="comment">// forwards to <boost/spirit/home/qi/directive/repeat.hpp></span>
58 <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_repeat</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
61 Also, see <a class="link" href="../../../structure/include.html" title="Include">Include Structure</a>.
64 <a name="spirit.qi.reference.directive.repeat.h2"></a>
65 <span class="phrase"><a name="spirit.qi.reference.directive.repeat.namespace"></a></span><a class="link" href="repeat.html#spirit.qi.reference.directive.repeat.namespace">Namespace</a>
67 <div class="informaltable"><table class="table">
68 <colgroup><col></colgroup>
77 <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">spirit</span><span class="special">::</span><span class="identifier">repeat</span> <span class="comment">//
78 alias: boost::spirit::qi::repeat</span></code>
83 <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">spirit</span><span class="special">::</span><span class="identifier">inf</span> <span class="comment">// alias:
84 boost::spirit::qi::inf</span></code>
90 <a name="spirit.qi.reference.directive.repeat.h3"></a>
91 <span class="phrase"><a name="spirit.qi.reference.directive.repeat.model_of"></a></span><a class="link" href="repeat.html#spirit.qi.reference.directive.repeat.model_of">Model
94 <div class="blockquote"><blockquote class="blockquote"><p>
95 <a class="link" href="../parser_concepts/unaryparser.html" title="UnaryParser"><code class="computeroutput"><span class="identifier">UnaryParser</span></code></a>
96 </p></blockquote></div>
97 <div class="variablelist">
98 <p class="title"><b>Notation</b></p>
99 <dl class="variablelist">
100 <dt><span class="term"><code class="computeroutput"><span class="identifier">a</span></code></span></dt>
102 A <a class="link" href="../parser_concepts/parser.html" title="Parser"><code class="computeroutput"><span class="identifier">Parser</span></code></a>.
104 <dt><span class="term"><code class="computeroutput"><span class="identifier">n</span></code>, <code class="computeroutput"><span class="identifier">min</span></code>, <code class="computeroutput"><span class="identifier">max</span></code></span></dt>
106 An <code class="computeroutput"><span class="keyword">int</span></code> anything that
107 can be converted to an <code class="computeroutput"><span class="keyword">int</span></code>,
108 or a <a class="link" href="../basics.html#spirit.qi.reference.basics.lazy_argument">Lazy
109 Argument</a> that evaluates to anything that can be converted
110 to an <code class="computeroutput"><span class="keyword">int</span></code>.
115 <a name="spirit.qi.reference.directive.repeat.h4"></a>
116 <span class="phrase"><a name="spirit.qi.reference.directive.repeat.expression_semantics"></a></span><a class="link" href="repeat.html#spirit.qi.reference.directive.repeat.expression_semantics">Expression
120 Semantics of an expression is defined only where it differs from, or
121 is not defined in <a class="link" href="../parser_concepts/unaryparser.html" title="UnaryParser"><code class="computeroutput"><span class="identifier">UnaryParser</span></code></a>.
123 <div class="informaltable"><table class="table">
144 <code class="computeroutput"><span class="identifier">repeat</span><span class="special">[</span><span class="identifier">a</span><span class="special">]</span></code>
149 Repeat <code class="computeroutput"><span class="identifier">a</span></code> zero
150 or more times. Same as <a class="link" href="../operator/kleene.html" title="Kleene Parser (*a)">Kleene</a>.
157 <code class="computeroutput"><span class="identifier">repeat</span><span class="special">(</span><span class="identifier">n</span><span class="special">)[</span><span class="identifier">a</span><span class="special">]</span></code>
162 Repeat <code class="computeroutput"><span class="identifier">a</span></code> exactly
163 <code class="computeroutput"><span class="identifier">n</span></code> times.
170 <code class="computeroutput"><span class="identifier">repeat</span><span class="special">(</span><span class="identifier">min</span><span class="special">,</span>
171 <span class="identifier">max</span><span class="special">)[</span><span class="identifier">a</span><span class="special">]</span></code>
176 Repeat <code class="computeroutput"><span class="identifier">a</span></code> at
177 least <code class="computeroutput"><span class="identifier">min</span></code> times
178 and at most <code class="computeroutput"><span class="identifier">max</span></code>
186 <code class="computeroutput"><span class="identifier">repeat</span><span class="special">(</span><span class="identifier">min</span><span class="special">,</span>
187 <span class="identifier">inf</span><span class="special">)[</span><span class="identifier">a</span><span class="special">]</span></code>
192 Repeat <code class="computeroutput"><span class="identifier">a</span></code> at
193 least <code class="computeroutput"><span class="identifier">min</span></code> or
194 more (continuing until <code class="computeroutput"><span class="identifier">a</span></code>
195 fails or the input is consumed).
202 <a name="spirit.qi.reference.directive.repeat.h5"></a>
203 <span class="phrase"><a name="spirit.qi.reference.directive.repeat.attributes"></a></span><a class="link" href="repeat.html#spirit.qi.reference.directive.repeat.attributes">Attributes</a>
206 See <a class="link" href="../../quick_reference/compound_attribute_rules.html#spirit.qi.quick_reference.compound_attribute_rules.notation">Compound
207 Attribute Notation</a>.
209 <div class="informaltable"><table class="table">
230 <code class="computeroutput"><span class="identifier">repeat</span><span class="special">[</span><span class="identifier">a</span><span class="special">]</span></code>
236 <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">repeat</span><span class="special">[</span><span class="identifier">a</span><span class="special">]:</span> <span class="identifier">vector</span><span class="special"><</span><span class="identifier">A</span><span class="special">></span>
237 <span class="identifier">a</span><span class="special">:</span> <span class="identifier">Unused</span> <span class="special">--></span> <span class="identifier">repeat</span><span class="special">[</span><span class="identifier">a</span><span class="special">]:</span> <span class="identifier">Unused</span></pre>
245 <code class="computeroutput"><span class="identifier">repeat</span><span class="special">(</span><span class="identifier">n</span><span class="special">)[</span><span class="identifier">a</span><span class="special">]</span></code>
251 <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">repeat</span><span class="special">(</span><span class="identifier">n</span><span class="special">)[</span><span class="identifier">a</span><span class="special">]:</span> <span class="identifier">vector</span><span class="special"><</span><span class="identifier">A</span><span class="special">></span>
252 <span class="identifier">a</span><span class="special">:</span> <span class="identifier">Unused</span> <span class="special">--></span> <span class="identifier">repeat</span><span class="special">(</span><span class="identifier">n</span><span class="special">)[</span><span class="identifier">a</span><span class="special">]:</span> <span class="identifier">Unused</span></pre>
260 <code class="computeroutput"><span class="identifier">repeat</span><span class="special">(</span><span class="identifier">min</span><span class="special">,</span>
261 <span class="identifier">max</span><span class="special">)[</span><span class="identifier">a</span><span class="special">]</span></code>
267 <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">repeat</span><span class="special">(</span><span class="identifier">min</span><span class="special">,</span> <span class="identifier">max</span><span class="special">)[</span><span class="identifier">a</span><span class="special">]:</span> <span class="identifier">vector</span><span class="special"><</span><span class="identifier">A</span><span class="special">></span>
268 <span class="identifier">a</span><span class="special">:</span> <span class="identifier">Unused</span> <span class="special">--></span> <span class="identifier">repeat</span><span class="special">(</span><span class="identifier">min</span><span class="special">,</span> <span class="identifier">max</span><span class="special">)[</span><span class="identifier">a</span><span class="special">]:</span> <span class="identifier">Unused</span></pre>
276 <code class="computeroutput"><span class="identifier">repeat</span><span class="special">(</span><span class="identifier">min</span><span class="special">,</span>
277 <span class="identifier">inf</span><span class="special">)[</span><span class="identifier">a</span><span class="special">]</span></code>
283 <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">repeat</span><span class="special">(</span><span class="identifier">min</span><span class="special">,</span> <span class="identifier">inf</span><span class="special">)[</span><span class="identifier">a</span><span class="special">]:</span> <span class="identifier">vector</span><span class="special"><</span><span class="identifier">A</span><span class="special">></span>
284 <span class="identifier">a</span><span class="special">:</span> <span class="identifier">Unused</span> <span class="special">--></span> <span class="identifier">repeat</span><span class="special">(</span><span class="identifier">min</span><span class="special">,</span> <span class="identifier">inf</span><span class="special">)[</span><span class="identifier">a</span><span class="special">]:</span> <span class="identifier">Unused</span></pre>
292 <a name="spirit.qi.reference.directive.repeat.h6"></a>
293 <span class="phrase"><a name="spirit.qi.reference.directive.repeat.complexity"></a></span><a class="link" href="repeat.html#spirit.qi.reference.directive.repeat.complexity">Complexity</a>
295 <div class="blockquote"><blockquote class="blockquote"><p>
296 The overall complexity is defined by the complexity of its subject
297 parser. The complexity of <code class="computeroutput"><span class="identifier">repeat</span></code>
298 itself is O(N), where N is the number of repetitions to execute.
299 </p></blockquote></div>
301 <a name="spirit.qi.reference.directive.repeat.h7"></a>
302 <span class="phrase"><a name="spirit.qi.reference.directive.repeat.example"></a></span><a class="link" href="repeat.html#spirit.qi.reference.directive.repeat.example">Example</a>
304 <div class="note"><table border="0" summary="Note">
306 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../images/note.png"></td>
307 <th align="left">Note</th>
309 <tr><td align="left" valign="top"><p>
310 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>
315 Using the repeat directive, we can now write our examples above.
318 Some using declarations:
322 <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">repeat</span><span class="special">;</span>
323 <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">lit</span><span class="special">;</span>
324 <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">uint_parser</span><span class="special">;</span>
325 <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">_1</span><span class="special">;</span>
326 <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">ascii</span><span class="special">::</span><span class="identifier">char_</span><span class="special">;</span>
327 <span class="keyword">namespace</span> <span class="identifier">phx</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">phoenix</span><span class="special">;</span>
332 A parser for a file name with a maximum of 255 characters:
336 <pre class="programlisting"><span class="identifier">test_parser</span><span class="special">(</span><span class="string">"batman.jpeg"</span><span class="special">,</span> <span class="identifier">repeat</span><span class="special">(</span><span class="number">1</span><span class="special">,</span> <span class="number">255</span><span class="special">)[</span><span class="identifier">char_</span><span class="special">(</span><span class="string">"a-zA-Z_./"</span><span class="special">)]);</span>
341 A parser for a specific bitmap file format which has exactly 4096 RGB
342 color information. (for the purpose of this example, we will be testing
343 only 3 RGB color information.)
347 <pre class="programlisting"><span class="identifier">uint_parser</span><span class="special"><</span><span class="keyword">unsigned</span><span class="special">,</span> <span class="number">16</span><span class="special">,</span> <span class="number">6</span><span class="special">,</span> <span class="number">6</span><span class="special">></span> <span class="identifier">rgb</span><span class="special">;</span>
348 <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="keyword">unsigned</span><span class="special">></span> <span class="identifier">colors</span><span class="special">;</span>
349 <span class="identifier">test_parser_attr</span><span class="special">(</span><span class="string">"ffffff0000003f3f3f"</span><span class="special">,</span> <span class="identifier">repeat</span><span class="special">(</span><span class="number">3</span><span class="special">)[</span><span class="identifier">rgb</span><span class="special">],</span> <span class="identifier">colors</span><span class="special">);</span>
350 <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span>
351 <span class="special"><<</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">hex</span>
352 <span class="special"><<</span> <span class="identifier">colors</span><span class="special">[</span><span class="number">0</span><span class="special">]</span> <span class="special"><<</span> <span class="char">','</span>
353 <span class="special"><<</span> <span class="identifier">colors</span><span class="special">[</span><span class="number">1</span><span class="special">]</span> <span class="special"><<</span> <span class="char">','</span>
354 <span class="special"><<</span> <span class="identifier">colors</span><span class="special">[</span><span class="number">2</span><span class="special">]</span> <span class="special"><<</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
359 A 256 bit binary string (1..256 1s or 0s). (For the purpose of this example,
360 we will be testing only 16 bits.)
364 <pre class="programlisting"><span class="identifier">test_parser</span><span class="special">(</span><span class="string">"1011101011110010"</span><span class="special">,</span> <span class="identifier">repeat</span><span class="special">(</span><span class="number">16</span><span class="special">)[</span><span class="identifier">lit</span><span class="special">(</span><span class="char">'1'</span><span class="special">)</span> <span class="special">|</span> <span class="char">'0'</span><span class="special">]);</span>
369 The Loop parsers can be dynamic. Consider the parsing of a binary file
370 of Pascal-style length prefixed string, where the first byte determines
371 the length of the incoming string. Here's a sample input:
373 <div class="blockquote"><blockquote class="blockquote"><p>
374 <span class="inlinemediaobject"><img src="../../../.././images/pascal_string.png" alt="pascal_string"></span>
375 </p></blockquote></div>
377 This trivial example cannot be practically defined in traditional EBNF.
378 Although some EBNF variants allow more powerful repetition constructs
379 other than the Kleene Star, we are still limited to parsing fixed strings.
380 The nature of EBNF forces the repetition factor to be a constant. On
381 the other hand, Spirit allows the repetition factor to be variable at
382 run time. We could write a grammar that accepts the input string above.
383 Example using phoenix:
387 <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>
388 <span class="keyword">int</span> <span class="identifier">n</span><span class="special">;</span>
389 <span class="identifier">test_parser_attr</span><span class="special">(</span><span class="string">"\x0bHello World"</span><span class="special">,</span>
390 <span class="identifier">char_</span><span class="special">[</span><span class="identifier">phx</span><span class="special">::</span><span class="identifier">ref</span><span class="special">(</span><span class="identifier">n</span><span class="special">)</span> <span class="special">=</span> <span class="identifier">_1</span><span class="special">]</span> <span class="special">>></span> <span class="identifier">repeat</span><span class="special">(</span><span class="identifier">phx</span><span class="special">::</span><span class="identifier">ref</span><span class="special">(</span><span class="identifier">n</span><span class="special">))[</span><span class="identifier">char_</span><span class="special">],</span> <span class="identifier">str</span><span class="special">);</span>
391 <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special"><<</span> <span class="identifier">n</span> <span class="special"><<</span> <span class="char">','</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">endl</span><span class="special">;</span> <span class="comment">// will print "11,Hello World"</span>
396 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
397 <td align="left"></td>
398 <td align="right"><div class="copyright-footer">Copyright © 2001-2011 Joel de Guzman, Hartmut Kaiser<p>
399 Distributed under the Boost Software License, Version 1.0. (See accompanying
400 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>)
405 <div class="spirit-nav">
406 <a accesskey="p" href="raw.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../directive.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="matches.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>