summaryrefslogtreecommitdiff
path: root/libs/spirit/doc/html/index.html
blob: 873e3009fc8288ec862ffcae9acb0bd20e7e5340 (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
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Spirit 2.5.2</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="next" href="spirit/preface.html" title="Preface">
</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="n" href="spirit/preface.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a></div>
<div class="article">
<div class="titlepage">
<div>
<div><h2 class="title">
<a name="spirit"></a>Spirit 2.5.2</h2></div>
<div><div class="authorgroup">
<div class="author"><h3 class="author">
<span class="firstname">Joel</span> <span class="surname">de Guzman</span>
</h3></div>
<div class="author"><h3 class="author">
<span class="firstname">Hartmut</span> <span class="surname">Kaiser</span>
</h3></div>
</div></div>
<div><p class="copyright">Copyright &#169; 2001-2011 Joel de Guzman, Hartmut Kaiser</p></div>
<div><div class="legalnotice">
<a name="spirit.legal"></a><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></div>
</div>
<hr>
</div>
<div class="toc">
<p><b>Table of Contents</b></p>
<dl>
<dt><span class="section"><a href="spirit/preface.html">Preface</a></span></dt>
<dt><span class="section"><a href="spirit/what_s_new.html">What's New</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="spirit/what_s_new/spirit_2_5_2.html">Spirit V2.5.2</a></span></dt>
<dt><span class="section"><a href="spirit/what_s_new/spirit_2_5_1.html">Spirit V2.5.1</a></span></dt>
<dt><span class="section"><a href="spirit/what_s_new/spirit_2_5.html">Spirit V2.5</a></span></dt>
<dt><span class="section"><a href="spirit/what_s_new/spirit_2_4_2.html">Spirit V2.4.2</a></span></dt>
<dt><span class="section"><a href="spirit/what_s_new/spirit_2_4_1.html">Spirit V2.4.1</a></span></dt>
<dt><span class="section"><a href="spirit/what_s_new/spirit_2_4.html">Spirit V2.4</a></span></dt>
<dt><span class="section"><a href="spirit/what_s_new/spirit_2_3.html">Spirit V2.3</a></span></dt>
<dt><span class="section"><a href="spirit/what_s_new/spirit_2_2.html">Spirit V2.2</a></span></dt>
<dt><span class="section"><a href="spirit/what_s_new/spirit_2_1.html">Spirit V2.1</a></span></dt>
<dt><span class="section"><a href="spirit/what_s_new/spirit_1_x.html">Spirit Classic</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="spirit/introduction.html">Introduction</a></span></dt>
<dt><span class="section"><a href="spirit/structure.html">Structure</a></span></dt>
<dd><dl><dt><span class="section"><a href="spirit/structure/include.html">Include</a></span></dt></dl></dd>
<dt><span class="section"><a href="spirit/abstracts.html">Abstracts</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="spirit/abstracts/syntax_diagram.html">Syntax Diagram</a></span></dt>
<dt><span class="section"><a href="spirit/abstracts/parsing_expression_grammar.html">Parsing
      Expression Grammar</a></span></dt>
<dt><span class="section"><a href="spirit/abstracts/attributes.html">Attributes</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="spirit/abstracts/attributes/primitive_attributes.html">Attributes
        of Primitive Components</a></span></dt>
<dt><span class="section"><a href="spirit/abstracts/attributes/compound_attributes.html">Attributes
        of Compound Components</a></span></dt>
<dt><span class="section"><a href="spirit/abstracts/attributes/more_compound_attributes.html">More
        About Attributes of Compound Components</a></span></dt>
<dt><span class="section"><a href="spirit/abstracts/attributes/nonterminal_attributes.html">Attributes
        of Rules and Grammars</a></span></dt>
</dl></dd>
</dl></dd>
<dt><span class="section"><a href="spirit/qi.html">Qi - Writing Parsers</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="spirit/qi/tutorials.html">Tutorials</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="spirit/qi/tutorials/quick_start.html">Quick Start</a></span></dt>
<dt><span class="section"><a href="spirit/qi/tutorials/warming_up.html">Warming up</a></span></dt>
<dt><span class="section"><a href="spirit/qi/tutorials/semantic_actions.html">Parser Semantic
        Actions</a></span></dt>
<dt><span class="section"><a href="spirit/qi/tutorials/complex___our_first_complex_parser.html">Complex
        - Our first complex parser</a></span></dt>
<dt><span class="section"><a href="spirit/qi/tutorials/sum___adding_numbers.html">Sum - adding
        numbers</a></span></dt>
<dt><span class="section"><a href="spirit/qi/tutorials/number_list___stuffing_numbers_into_a_std__vector.html">Number
        List - stuffing numbers into a std::vector</a></span></dt>
<dt><span class="section"><a href="spirit/qi/tutorials/number_list_redux___list_syntax.html">Number
        List Redux - list syntax</a></span></dt>
<dt><span class="section"><a href="spirit/qi/tutorials/number_list_attribute___one_more__with_style.html">Number
        List Attribute - one more, with style</a></span></dt>
<dt><span class="section"><a href="spirit/qi/tutorials/roman_numerals.html">Roman Numerals</a></span></dt>
<dt><span class="section"><a href="spirit/qi/tutorials/employee___parsing_into_structs.html">Employee
        - Parsing into structs</a></span></dt>
<dt><span class="section"><a href="spirit/qi/tutorials/mini_xml___asts_.html">Mini XML - ASTs!</a></span></dt>
<dt><span class="section"><a href="spirit/qi/tutorials/mini_xml___error_handling.html">Mini
        XML - Error Handling</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="spirit/qi/quick_reference.html">Quick Reference</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="spirit/qi/quick_reference/common_notation.html">Common Notation</a></span></dt>
<dt><span class="section"><a href="spirit/qi/quick_reference/qi_parsers.html">Qi Parsers</a></span></dt>
<dt><span class="section"><a href="spirit/qi/quick_reference/compound_attribute_rules.html">Compound
        Attribute Rules</a></span></dt>
<dt><span class="section"><a href="spirit/qi/quick_reference/non_terminals.html">Nonterminals</a></span></dt>
<dt><span class="section"><a href="spirit/qi/quick_reference/semantic_actions.html">Parser
        Semantic Actions</a></span></dt>
<dt><span class="section"><a href="spirit/qi/quick_reference/phoenix.html">Phoenix</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="spirit/qi/reference.html">Reference</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="spirit/qi/reference/parser_concepts.html">Parser Concepts</a></span></dt>
<dt><span class="section"><a href="spirit/qi/reference/basics.html">Parser Basics</a></span></dt>
<dt><span class="section"><a href="spirit/qi/reference/parse_api.html">Parser API</a></span></dt>
<dt><span class="section"><a href="spirit/qi/reference/action.html">Semantic Actions with Parsers</a></span></dt>
<dt><span class="section"><a href="spirit/qi/reference/auto.html">Auto Parser</a></span></dt>
<dt><span class="section"><a href="spirit/qi/reference/auxiliary.html">Auxiliary Parsers</a></span></dt>
<dt><span class="section"><a href="spirit/qi/reference/binary.html">Binary Parsers</a></span></dt>
<dt><span class="section"><a href="spirit/qi/reference/char.html">Character Parsers</a></span></dt>
<dt><span class="section"><a href="spirit/qi/reference/directive.html">Parser Directives</a></span></dt>
<dt><span class="section"><a href="spirit/qi/reference/nonterminal.html">Nonterminal Parsers</a></span></dt>
<dt><span class="section"><a href="spirit/qi/reference/numeric.html">Numeric Parsers</a></span></dt>
<dt><span class="section"><a href="spirit/qi/reference/operator.html">Parser Operators</a></span></dt>
<dt><span class="section"><a href="spirit/qi/reference/stream.html">Stream Parsers</a></span></dt>
<dt><span class="section"><a href="spirit/qi/reference/string.html">String Parsers</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="spirit/qi/s04.html">Qi Index</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="spirit/karma.html">Karma - Writing Generators</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="spirit/karma/tutorials.html">Tutorials</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="spirit/karma/tutorials/quick_start.html">Quick Start</a></span></dt>
<dt><span class="section"><a href="spirit/karma/tutorials/warming_up.html">Warming up</a></span></dt>
<dt><span class="section"><a href="spirit/karma/tutorials/semantic_actions.html">Generator
        Semantic Actions</a></span></dt>
<dt><span class="section"><a href="spirit/karma/tutorials/karma_complex.html">Complex - A first
        more complex generator</a></span></dt>
<dt><span class="section"><a href="spirit/karma/tutorials/karma_easier_complex.html">Complex
        - Made easier</a></span></dt>
<dt><span class="section"><a href="spirit/karma/tutorials/karma_adapted_complex.html">Complex
        - Fully Integrated</a></span></dt>
<dt><span class="section"><a href="spirit/karma/tutorials/num_list.html">Number List - Printing
        Numbers From a std::vector</a></span></dt>
<dt><span class="section"><a href="spirit/karma/tutorials/num_matrix.html">Matrix of Numbers
        - Printing Numbers From a Matrix</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="spirit/karma/quick_reference.html">Quick Reference</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="spirit/karma/quick_reference/common_notation.html">Common
        Notation</a></span></dt>
<dt><span class="section"><a href="spirit/karma/quick_reference/primitive_generators.html">Karma
        Generators</a></span></dt>
<dt><span class="section"><a href="spirit/karma/quick_reference/compound_attribute_rules.html">Compound
        Attribute Rules</a></span></dt>
<dt><span class="section"><a href="spirit/karma/quick_reference/non_terminals.html">Nonterminals</a></span></dt>
<dt><span class="section"><a href="spirit/karma/quick_reference/semantic_actions.html">Generator
        Semantic Actions</a></span></dt>
<dt><span class="section"><a href="spirit/karma/quick_reference/phoenix.html">Phoenix</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="spirit/karma/reference.html">Reference</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="spirit/karma/reference/generator_concepts.html">Generator
        Concepts</a></span></dt>
<dt><span class="section"><a href="spirit/karma/reference/basics.html">Generator Basics</a></span></dt>
<dt><span class="section"><a href="spirit/karma/reference/generate_api.html">Generator API</a></span></dt>
<dt><span class="section"><a href="spirit/karma/reference/action.html">Semantic Actions with
        Generators</a></span></dt>
<dt><span class="section"><a href="spirit/karma/reference/auto.html">Auto Generator</a></span></dt>
<dt><span class="section"><a href="spirit/karma/reference/auxiliary.html">Auxiliary Generators</a></span></dt>
<dt><span class="section"><a href="spirit/karma/reference/binary.html">Binary Generators</a></span></dt>
<dt><span class="section"><a href="spirit/karma/reference/char.html">Char Generators</a></span></dt>
<dt><span class="section"><a href="spirit/karma/reference/directive.html">Generator Directives</a></span></dt>
<dt><span class="section"><a href="spirit/karma/reference/nonterminal.html">Nonterminal Generators</a></span></dt>
<dt><span class="section"><a href="spirit/karma/reference/numeric.html">Numeric Generators</a></span></dt>
<dt><span class="section"><a href="spirit/karma/reference/operator.html">Generator Operators</a></span></dt>
<dt><span class="section"><a href="spirit/karma/reference/stream.html">Stream Generators</a></span></dt>
<dt><span class="section"><a href="spirit/karma/reference/string.html">String Generators</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="spirit/karma/performance_measurements.html">Performance Measurements</a></span></dt>
<dd><dl><dt><span class="section"><a href="spirit/karma/performance_measurements/numeric_performance.html">Performance
        of Numeric Generators</a></span></dt></dl></dd>
<dt><span class="section"><a href="spirit/karma/s05.html">Karma Index</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="spirit/lex.html">Lex - Writing Lexical Analyzers</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="spirit/lex/lexer_introduction.html">Introduction to <span class="emphasis"><em>Spirit.Lex</em></span></a></span></dt>
<dt><span class="section"><a href="spirit/lex/tutorials.html"><span class="emphasis"><em>Spirit.Lex</em></span>
      Tutorials</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="spirit/lex/tutorials/lexer_tutorials.html"><span class="emphasis"><em>Spirit.Lex</em></span>
        Tutorials Overview</a></span></dt>
<dt><span class="section"><a href="spirit/lex/tutorials/lexer_quickstart1.html">Quickstart
        1 - A word counter using <span class="emphasis"><em>Spirit.Lex</em></span></a></span></dt>
<dt><span class="section"><a href="spirit/lex/tutorials/lexer_quickstart2.html">Quickstart
        2 - A better word counter using <span class="emphasis"><em>Spirit.Lex</em></span></a></span></dt>
<dt><span class="section"><a href="spirit/lex/tutorials/lexer_quickstart3.html">Quickstart
        3 - Counting Words Using a Parser</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="spirit/lex/abstracts.html">Abstracts</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="spirit/lex/abstracts/lexer_primitives.html">Lexer Primitives</a></span></dt>
<dt><span class="section"><a href="spirit/lex/abstracts/lexer_tokenizing.html">Tokenizing Input
        Data</a></span></dt>
<dt><span class="section"><a href="spirit/lex/abstracts/lexer_semantic_actions.html">Lexer
        Semantic Actions</a></span></dt>
<dt><span class="section"><a href="spirit/lex/abstracts/lexer_static_model.html">The <span class="emphasis"><em>Static</em></span>
        Lexer Model</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="spirit/lex/quick_reference.html">Quick Reference</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="spirit/lex/quick_reference/common_notation.html">Common
        Notation</a></span></dt>
<dt><span class="section"><a href="spirit/lex/quick_reference/lexers.html">Primitive Lexer
        Components</a></span></dt>
<dt><span class="section"><a href="spirit/lex/quick_reference/semantic_actions.html">Semantic
        Actions</a></span></dt>
<dt><span class="section"><a href="spirit/lex/quick_reference/phoenix.html">Phoenix</a></span></dt>
<dt><span class="section"><a href="spirit/lex/quick_reference/lexer.html">Supported Regular
        Expressions</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="spirit/lex/reference.html">Reference</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="spirit/lex/reference/lexer_concepts.html">Lexer Concepts</a></span></dt>
<dt><span class="section"><a href="spirit/lex/reference/lex_basics.html">Basics</a></span></dt>
<dt><span class="section"><a href="spirit/lex/reference/lexer_api.html">Lexer API</a></span></dt>
<dt><span class="section"><a href="spirit/lex/reference/primitives.html">Token definition Primitives</a></span></dt>
</dl></dd>
</dl></dd>
<dt><span class="section"><a href="spirit/advanced.html">Advanced</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="spirit/advanced/indepth.html">In Depth</a></span></dt>
<dd><dl><dt><span class="section"><a href="spirit/advanced/indepth/parsers_indepth.html">Parsers in
        Depth</a></span></dt></dl></dd>
<dt><span class="section"><a href="spirit/advanced/customize.html">Customization of Spirit's
      Attribute Handling</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="spirit/advanced/customize/is_container.html">Determine if
        a Type Should be Treated as a Container (Qi and Karma)</a></span></dt>
<dt><span class="section"><a href="spirit/advanced/customize/is_string.html">Determine if a
        Type Should be Treated as a String (Qi and Karma)</a></span></dt>
<dt><span class="section"><a href="spirit/advanced/customize/handles_container.html">Determine
        Whether a Component Handles Container Attributes (Qi and Karma)</a></span></dt>
<dt><span class="section"><a href="spirit/advanced/customize/transform.html">Transform an Attribute
        to a Different Type (Qi and Karma)</a></span></dt>
<dt><span class="section"><a href="spirit/advanced/customize/assign_to.html">Store a Parsed
        Attribute Value (Qi)</a></span></dt>
<dt><span class="section"><a href="spirit/advanced/customize/store_value.html">Store Parsed
        Attribute Values into a Container (Qi)</a></span></dt>
<dt><span class="section"><a href="spirit/advanced/customize/clear_value.html">Re-Initialize
        an Attribute Value before Parsing (Qi)</a></span></dt>
<dt><span class="section"><a href="spirit/advanced/customize/extract_from.html">Extract an
        Attribute Value to Generate Output (Karma)</a></span></dt>
<dt><span class="section"><a href="spirit/advanced/customize/extract_from_container.html">Extract
        From a Container Attribute Value to Generate Output (Karma)</a></span></dt>
<dt><span class="section"><a href="spirit/advanced/customize/iterate.html">Extract Attribute
        Values to Generate Output from a Container (Karma)</a></span></dt>
<dt><span class="section"><a href="spirit/advanced/customize/string_traits.html">Extract a
        C-Style String to Generate Output from a String Type (Karma)</a></span></dt>
<dt><span class="section"><a href="spirit/advanced/customize/attribute_as.html">Atomically
        Extract an Attribute Value from a Container (Karma)</a></span></dt>
<dt><span class="section"><a href="spirit/advanced/customize/auto.html">Create Components from
        Attributes (Qi and Karma)</a></span></dt>
</dl></dd>
</dl></dd>
<dt><span class="section"><a href="spirit/support.html">Supporting Libraries</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="spirit/support/multi_pass.html">The multi pass iterator</a></span></dt>
<dt><span class="section"><a href="spirit/support/line_pos_iterator.html">The line position iterator</a></span></dt>
<dt><span class="section"><a href="spirit/support/utree.html">The utree data structure</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="spirit/faq.html">Spirit FAQ</a></span></dt>
<dt><span class="section"><a href="spirit/notes.html">Notes</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="spirit/notes/porting_from_spirit_1_8_x.html">Porting from
      Spirit 1.8.x</a></span></dt>
<dt><span class="section"><a href="spirit/notes/style_guide.html">Style Guide</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="spirit/rationale.html">Rationale</a></span></dt>
<dt><span class="section"><a href="spirit/repository.html">Spirit Repository</a></span></dt>
<dt><span class="section"><a href="spirit/acknowledgments.html">Acknowledgments</a></span></dt>
<dt><span class="section"><a href="spirit/references.html">References</a></span></dt>
</dl>
</div>
<p>
    This is the documentation of the newest version of <a href="http://boost-spirit.com" target="_top">Spirit</a>
    (currently, V2.5.2). If you're looking for the documentation of Spirit's previous
    version (formerly Spirit V1.8), see <a href="../../../../libs/spirit/classic/index.html" target="_top"><span class="emphasis"><em>Spirit.Classic</em></span></a>.
  </p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"><p><small>Last revised: August 15, 2012 at 23:35:12 GMT</small></p></td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>
<div class="spirit-nav"><a accesskey="n" href="spirit/preface.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a></div>
</body>
</html>