Imported Upstream version 1.72.0
[platform/upstream/boost.git] / libs / spirit / doc / html / index.html
1 <html>
2 <head>
3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4 <title>Spirit 2.5.8</title>
5 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
7 <link rel="home" href="index.html" title="Spirit 2.5.8">
8 <link rel="next" href="spirit/preface.html" title="Preface">
9 </head>
10 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
11 <table cellpadding="2" width="100%"><tr>
12 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
13 <td align="center"><a href="../../../../index.html">Home</a></td>
14 <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
15 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
16 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
17 <td align="center"><a href="../../../../more/index.htm">More</a></td>
18 </tr></table>
19 <hr>
20 <div class="spirit-nav"><a accesskey="n" href="spirit/preface.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a></div>
21 <div class="article">
22 <div class="titlepage">
23 <div>
24 <div><h2 class="title">
25 <a name="spirit"></a>Spirit 2.5.8</h2></div>
26 <div><div class="authorgroup">
27 <div class="author"><h3 class="author">
28 <span class="firstname">Joel</span> <span class="surname">de Guzman</span>
29 </h3></div>
30 <div class="author"><h3 class="author">
31 <span class="firstname">Hartmut</span> <span class="surname">Kaiser</span>
32 </h3></div>
33 </div></div>
34 <div><p class="copyright">Copyright &#169; 2001-2011 Joel de Guzman, Hartmut Kaiser</p></div>
35 <div><div class="legalnotice">
36 <a name="spirit.legal"></a><p>
37         Distributed under the Boost Software License, Version 1.0. (See accompanying
38         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>)
39       </p>
40 </div></div>
41 </div>
42 <hr>
43 </div>
44 <div class="toc">
45 <p><b>Table of Contents</b></p>
46 <dl class="toc">
47 <dt><span class="section"><a href="spirit/preface.html">Preface</a></span></dt>
48 <dt><span class="section"><a href="spirit/what_s_new.html">What's New</a></span></dt>
49 <dd><dl>
50 <dt><span class="section"><a href="spirit/what_s_new/spirit_2_5_8.html">Spirit V2.5.8</a></span></dt>
51 <dt><span class="section"><a href="spirit/what_s_new/spirit_2_5_7.html">Spirit V2.5.7</a></span></dt>
52 <dt><span class="section"><a href="spirit/what_s_new/spirit_2_5_6.html">Spirit V2.5.6</a></span></dt>
53 <dt><span class="section"><a href="spirit/what_s_new/spirit_2_5_5.html">Spirit V2.5.5</a></span></dt>
54 <dt><span class="section"><a href="spirit/what_s_new/spirit_2_5_4.html">Spirit V2.5.4</a></span></dt>
55 <dt><span class="section"><a href="spirit/what_s_new/spirit_2_5_3.html">Spirit V2.5.3</a></span></dt>
56 <dt><span class="section"><a href="spirit/what_s_new/spirit_2_5_2.html">Spirit V2.5.2</a></span></dt>
57 <dt><span class="section"><a href="spirit/what_s_new/spirit_2_5_1.html">Spirit V2.5.1</a></span></dt>
58 <dt><span class="section"><a href="spirit/what_s_new/spirit_2_5.html">Spirit V2.5</a></span></dt>
59 <dt><span class="section"><a href="spirit/what_s_new/spirit_2_4_2.html">Spirit V2.4.2</a></span></dt>
60 <dt><span class="section"><a href="spirit/what_s_new/spirit_2_4_1.html">Spirit V2.4.1</a></span></dt>
61 <dt><span class="section"><a href="spirit/what_s_new/spirit_2_4.html">Spirit V2.4</a></span></dt>
62 <dt><span class="section"><a href="spirit/what_s_new/spirit_2_3.html">Spirit V2.3</a></span></dt>
63 <dt><span class="section"><a href="spirit/what_s_new/spirit_2_2.html">Spirit V2.2</a></span></dt>
64 <dt><span class="section"><a href="spirit/what_s_new/spirit_2_1.html">Spirit V2.1</a></span></dt>
65 <dt><span class="section"><a href="spirit/what_s_new/spirit_1_x.html">Spirit Classic</a></span></dt>
66 </dl></dd>
67 <dt><span class="section"><a href="spirit/introduction.html">Introduction</a></span></dt>
68 <dt><span class="section"><a href="spirit/structure.html">Structure</a></span></dt>
69 <dd><dl><dt><span class="section"><a href="spirit/structure/include.html">Include</a></span></dt></dl></dd>
70 <dt><span class="section"><a href="spirit/abstracts.html">Abstracts</a></span></dt>
71 <dd><dl>
72 <dt><span class="section"><a href="spirit/abstracts/syntax_diagram.html">Syntax Diagram</a></span></dt>
73 <dt><span class="section"><a href="spirit/abstracts/parsing_expression_grammar.html">Parsing
74       Expression Grammar</a></span></dt>
75 <dt><span class="section"><a href="spirit/abstracts/attributes.html">Attributes</a></span></dt>
76 <dd><dl>
77 <dt><span class="section"><a href="spirit/abstracts/attributes/primitive_attributes.html">Attributes
78         of Primitive Components</a></span></dt>
79 <dt><span class="section"><a href="spirit/abstracts/attributes/compound_attributes.html">Attributes
80         of Compound Components</a></span></dt>
81 <dt><span class="section"><a href="spirit/abstracts/attributes/more_compound_attributes.html">More
82         About Attributes of Compound Components</a></span></dt>
83 <dt><span class="section"><a href="spirit/abstracts/attributes/nonterminal_attributes.html">Attributes
84         of Rules and Grammars</a></span></dt>
85 </dl></dd>
86 </dl></dd>
87 <dt><span class="section"><a href="spirit/qi.html">Qi - Writing Parsers</a></span></dt>
88 <dd><dl>
89 <dt><span class="section"><a href="spirit/qi/tutorials.html">Tutorials</a></span></dt>
90 <dd><dl>
91 <dt><span class="section"><a href="spirit/qi/tutorials/quick_start.html">Quick Start</a></span></dt>
92 <dt><span class="section"><a href="spirit/qi/tutorials/warming_up.html">Warming up</a></span></dt>
93 <dt><span class="section"><a href="spirit/qi/tutorials/semantic_actions.html">Parser Semantic
94         Actions</a></span></dt>
95 <dt><span class="section"><a href="spirit/qi/tutorials/complex___our_first_complex_parser.html">Complex
96         - Our first complex parser</a></span></dt>
97 <dt><span class="section"><a href="spirit/qi/tutorials/sum___adding_numbers.html">Sum - adding
98         numbers</a></span></dt>
99 <dt><span class="section"><a href="spirit/qi/tutorials/number_list___stuffing_numbers_into_a_std__vector.html">Number
100         List - stuffing numbers into a std::vector</a></span></dt>
101 <dt><span class="section"><a href="spirit/qi/tutorials/number_list_redux___list_syntax.html">Number
102         List Redux - list syntax</a></span></dt>
103 <dt><span class="section"><a href="spirit/qi/tutorials/number_list_attribute___one_more__with_style.html">Number
104         List Attribute - one more, with style</a></span></dt>
105 <dt><span class="section"><a href="spirit/qi/tutorials/roman_numerals.html">Roman Numerals</a></span></dt>
106 <dt><span class="section"><a href="spirit/qi/tutorials/employee___parsing_into_structs.html">Employee
107         - Parsing into structs</a></span></dt>
108 <dt><span class="section"><a href="spirit/qi/tutorials/mini_xml___asts_.html">Mini XML - ASTs!</a></span></dt>
109 <dt><span class="section"><a href="spirit/qi/tutorials/mini_xml___error_handling.html">Mini
110         XML - Error Handling</a></span></dt>
111 </dl></dd>
112 <dt><span class="section"><a href="spirit/qi/quick_reference.html">Quick Reference</a></span></dt>
113 <dd><dl>
114 <dt><span class="section"><a href="spirit/qi/quick_reference/common_notation.html">Common Notation</a></span></dt>
115 <dt><span class="section"><a href="spirit/qi/quick_reference/qi_parsers.html">Qi Parsers</a></span></dt>
116 <dt><span class="section"><a href="spirit/qi/quick_reference/compound_attribute_rules.html">Compound
117         Attribute Rules</a></span></dt>
118 <dt><span class="section"><a href="spirit/qi/quick_reference/non_terminals.html">Nonterminals</a></span></dt>
119 <dt><span class="section"><a href="spirit/qi/quick_reference/semantic_actions.html">Parser
120         Semantic Actions</a></span></dt>
121 <dt><span class="section"><a href="spirit/qi/quick_reference/phoenix.html">Phoenix</a></span></dt>
122 </dl></dd>
123 <dt><span class="section"><a href="spirit/qi/reference.html">Reference</a></span></dt>
124 <dd><dl>
125 <dt><span class="section"><a href="spirit/qi/reference/parser_concepts.html">Parser Concepts</a></span></dt>
126 <dt><span class="section"><a href="spirit/qi/reference/basics.html">Parser Basics</a></span></dt>
127 <dt><span class="section"><a href="spirit/qi/reference/parse_api.html">Parser API</a></span></dt>
128 <dt><span class="section"><a href="spirit/qi/reference/action.html">Semantic Actions with Parsers</a></span></dt>
129 <dt><span class="section"><a href="spirit/qi/reference/auto.html">Auto Parser</a></span></dt>
130 <dt><span class="section"><a href="spirit/qi/reference/auxiliary.html">Auxiliary Parsers</a></span></dt>
131 <dt><span class="section"><a href="spirit/qi/reference/binary.html">Binary Parsers</a></span></dt>
132 <dt><span class="section"><a href="spirit/qi/reference/char.html">Character Parsers</a></span></dt>
133 <dt><span class="section"><a href="spirit/qi/reference/directive.html">Parser Directives</a></span></dt>
134 <dt><span class="section"><a href="spirit/qi/reference/nonterminal.html">Nonterminal Parsers</a></span></dt>
135 <dt><span class="section"><a href="spirit/qi/reference/numeric.html">Numeric Parsers</a></span></dt>
136 <dt><span class="section"><a href="spirit/qi/reference/operator.html">Parser Operators</a></span></dt>
137 <dt><span class="section"><a href="spirit/qi/reference/stream.html">Stream Parsers</a></span></dt>
138 <dt><span class="section"><a href="spirit/qi/reference/string.html">String Parsers</a></span></dt>
139 </dl></dd>
140 <dt><span class="section"><a href="spirit/qi/s04.html">Qi Index</a></span></dt>
141 </dl></dd>
142 <dt><span class="section"><a href="spirit/karma.html">Karma - Writing Generators</a></span></dt>
143 <dd><dl>
144 <dt><span class="section"><a href="spirit/karma/tutorials.html">Tutorials</a></span></dt>
145 <dd><dl>
146 <dt><span class="section"><a href="spirit/karma/tutorials/quick_start.html">Quick Start</a></span></dt>
147 <dt><span class="section"><a href="spirit/karma/tutorials/warming_up.html">Warming up</a></span></dt>
148 <dt><span class="section"><a href="spirit/karma/tutorials/semantic_actions.html">Generator
149         Semantic Actions</a></span></dt>
150 <dt><span class="section"><a href="spirit/karma/tutorials/karma_complex.html">Complex - A first
151         more complex generator</a></span></dt>
152 <dt><span class="section"><a href="spirit/karma/tutorials/karma_easier_complex.html">Complex
153         - Made easier</a></span></dt>
154 <dt><span class="section"><a href="spirit/karma/tutorials/karma_adapted_complex.html">Complex
155         - Fully Integrated</a></span></dt>
156 <dt><span class="section"><a href="spirit/karma/tutorials/num_list.html">Number List - Printing
157         Numbers From a std::vector</a></span></dt>
158 <dt><span class="section"><a href="spirit/karma/tutorials/num_matrix.html">Matrix of Numbers
159         - Printing Numbers From a Matrix</a></span></dt>
160 </dl></dd>
161 <dt><span class="section"><a href="spirit/karma/quick_reference.html">Quick Reference</a></span></dt>
162 <dd><dl>
163 <dt><span class="section"><a href="spirit/karma/quick_reference/common_notation.html">Common
164         Notation</a></span></dt>
165 <dt><span class="section"><a href="spirit/karma/quick_reference/primitive_generators.html">Karma
166         Generators</a></span></dt>
167 <dt><span class="section"><a href="spirit/karma/quick_reference/compound_attribute_rules.html">Compound
168         Attribute Rules</a></span></dt>
169 <dt><span class="section"><a href="spirit/karma/quick_reference/non_terminals.html">Nonterminals</a></span></dt>
170 <dt><span class="section"><a href="spirit/karma/quick_reference/semantic_actions.html">Generator
171         Semantic Actions</a></span></dt>
172 <dt><span class="section"><a href="spirit/karma/quick_reference/phoenix.html">Phoenix</a></span></dt>
173 </dl></dd>
174 <dt><span class="section"><a href="spirit/karma/reference.html">Reference</a></span></dt>
175 <dd><dl>
176 <dt><span class="section"><a href="spirit/karma/reference/generator_concepts.html">Generator
177         Concepts</a></span></dt>
178 <dt><span class="section"><a href="spirit/karma/reference/basics.html">Generator Basics</a></span></dt>
179 <dt><span class="section"><a href="spirit/karma/reference/generate_api.html">Generator API</a></span></dt>
180 <dt><span class="section"><a href="spirit/karma/reference/action.html">Semantic Actions with
181         Generators</a></span></dt>
182 <dt><span class="section"><a href="spirit/karma/reference/auto.html">Auto Generator</a></span></dt>
183 <dt><span class="section"><a href="spirit/karma/reference/auxiliary.html">Auxiliary Generators</a></span></dt>
184 <dt><span class="section"><a href="spirit/karma/reference/binary.html">Binary Generators</a></span></dt>
185 <dt><span class="section"><a href="spirit/karma/reference/char.html">Char Generators</a></span></dt>
186 <dt><span class="section"><a href="spirit/karma/reference/directive.html">Generator Directives</a></span></dt>
187 <dt><span class="section"><a href="spirit/karma/reference/nonterminal.html">Nonterminal Generators</a></span></dt>
188 <dt><span class="section"><a href="spirit/karma/reference/numeric.html">Numeric Generators</a></span></dt>
189 <dt><span class="section"><a href="spirit/karma/reference/operator.html">Generator Operators</a></span></dt>
190 <dt><span class="section"><a href="spirit/karma/reference/stream.html">Stream Generators</a></span></dt>
191 <dt><span class="section"><a href="spirit/karma/reference/string.html">String Generators</a></span></dt>
192 </dl></dd>
193 <dt><span class="section"><a href="spirit/karma/performance_measurements.html">Performance Measurements</a></span></dt>
194 <dd><dl><dt><span class="section"><a href="spirit/karma/performance_measurements/numeric_performance.html">Performance
195         of Numeric Generators</a></span></dt></dl></dd>
196 <dt><span class="section"><a href="spirit/karma/s05.html">Karma Index</a></span></dt>
197 </dl></dd>
198 <dt><span class="section"><a href="spirit/lex.html">Lex - Writing Lexical Analyzers</a></span></dt>
199 <dd><dl>
200 <dt><span class="section"><a href="spirit/lex/lexer_introduction.html">Introduction to <span class="emphasis"><em>Spirit.Lex</em></span></a></span></dt>
201 <dt><span class="section"><a href="spirit/lex/tutorials.html"><span class="emphasis"><em>Spirit.Lex</em></span>
202       Tutorials</a></span></dt>
203 <dd><dl>
204 <dt><span class="section"><a href="spirit/lex/tutorials/lexer_tutorials.html"><span class="emphasis"><em>Spirit.Lex</em></span>
205         Tutorials Overview</a></span></dt>
206 <dt><span class="section"><a href="spirit/lex/tutorials/lexer_quickstart1.html">Quickstart
207         1 - A word counter using <span class="emphasis"><em>Spirit.Lex</em></span></a></span></dt>
208 <dt><span class="section"><a href="spirit/lex/tutorials/lexer_quickstart2.html">Quickstart
209         2 - A better word counter using <span class="emphasis"><em>Spirit.Lex</em></span></a></span></dt>
210 <dt><span class="section"><a href="spirit/lex/tutorials/lexer_quickstart3.html">Quickstart
211         3 - Counting Words Using a Parser</a></span></dt>
212 </dl></dd>
213 <dt><span class="section"><a href="spirit/lex/abstracts.html">Abstracts</a></span></dt>
214 <dd><dl>
215 <dt><span class="section"><a href="spirit/lex/abstracts/lexer_primitives.html">Lexer Primitives</a></span></dt>
216 <dt><span class="section"><a href="spirit/lex/abstracts/lexer_tokenizing.html">Tokenizing Input
217         Data</a></span></dt>
218 <dt><span class="section"><a href="spirit/lex/abstracts/lexer_semantic_actions.html">Lexer
219         Semantic Actions</a></span></dt>
220 <dt><span class="section"><a href="spirit/lex/abstracts/lexer_static_model.html">The <span class="emphasis"><em>Static</em></span>
221         Lexer Model</a></span></dt>
222 </dl></dd>
223 <dt><span class="section"><a href="spirit/lex/quick_reference.html">Quick Reference</a></span></dt>
224 <dd><dl>
225 <dt><span class="section"><a href="spirit/lex/quick_reference/common_notation.html">Common
226         Notation</a></span></dt>
227 <dt><span class="section"><a href="spirit/lex/quick_reference/lexers.html">Primitive Lexer
228         Components</a></span></dt>
229 <dt><span class="section"><a href="spirit/lex/quick_reference/semantic_actions.html">Semantic
230         Actions</a></span></dt>
231 <dt><span class="section"><a href="spirit/lex/quick_reference/phoenix.html">Phoenix</a></span></dt>
232 <dt><span class="section"><a href="spirit/lex/quick_reference/lexer.html">Supported Regular
233         Expressions</a></span></dt>
234 </dl></dd>
235 <dt><span class="section"><a href="spirit/lex/reference.html">Reference</a></span></dt>
236 <dd><dl>
237 <dt><span class="section"><a href="spirit/lex/reference/lexer_concepts.html">Lexer Concepts</a></span></dt>
238 <dt><span class="section"><a href="spirit/lex/reference/lex_basics.html">Basics</a></span></dt>
239 <dt><span class="section"><a href="spirit/lex/reference/lexer_api.html">Lexer API</a></span></dt>
240 <dt><span class="section"><a href="spirit/lex/reference/primitives.html">Token definition Primitives</a></span></dt>
241 </dl></dd>
242 </dl></dd>
243 <dt><span class="section"><a href="spirit/advanced.html">Advanced</a></span></dt>
244 <dd><dl>
245 <dt><span class="section"><a href="spirit/advanced/indepth.html">In Depth</a></span></dt>
246 <dd><dl><dt><span class="section"><a href="spirit/advanced/indepth/parsers_indepth.html">Parsers in
247         Depth</a></span></dt></dl></dd>
248 <dt><span class="section"><a href="spirit/advanced/customize.html">Customization of Spirit's
249       Attribute Handling</a></span></dt>
250 <dd><dl>
251 <dt><span class="section"><a href="spirit/advanced/customize/is_container.html">Determine if
252         a Type Should be Treated as a Container (Qi and Karma)</a></span></dt>
253 <dt><span class="section"><a href="spirit/advanced/customize/is_string.html">Determine if a
254         Type Should be Treated as a String (Qi and Karma)</a></span></dt>
255 <dt><span class="section"><a href="spirit/advanced/customize/handles_container.html">Determine
256         Whether a Component Handles Container Attributes (Qi and Karma)</a></span></dt>
257 <dt><span class="section"><a href="spirit/advanced/customize/transform.html">Transform an Attribute
258         to a Different Type (Qi and Karma)</a></span></dt>
259 <dt><span class="section"><a href="spirit/advanced/customize/assign_to.html">Store a Parsed
260         Attribute Value (Qi)</a></span></dt>
261 <dt><span class="section"><a href="spirit/advanced/customize/store_value.html">Store Parsed
262         Attribute Values into a Container (Qi)</a></span></dt>
263 <dt><span class="section"><a href="spirit/advanced/customize/clear_value.html">Re-Initialize
264         an Attribute Value before Parsing (Qi)</a></span></dt>
265 <dt><span class="section"><a href="spirit/advanced/customize/extract_from.html">Extract an
266         Attribute Value to Generate Output (Karma)</a></span></dt>
267 <dt><span class="section"><a href="spirit/advanced/customize/extract_from_container.html">Extract
268         From a Container Attribute Value to Generate Output (Karma)</a></span></dt>
269 <dt><span class="section"><a href="spirit/advanced/customize/iterate.html">Extract Attribute
270         Values to Generate Output from a Container (Karma)</a></span></dt>
271 <dt><span class="section"><a href="spirit/advanced/customize/string_traits.html">Extract a
272         C-Style String to Generate Output from a String Type (Karma)</a></span></dt>
273 <dt><span class="section"><a href="spirit/advanced/customize/attribute_as.html">Atomically
274         Extract an Attribute Value from a Container (Karma)</a></span></dt>
275 <dt><span class="section"><a href="spirit/advanced/customize/auto.html">Create Components from
276         Attributes (Qi and Karma)</a></span></dt>
277 </dl></dd>
278 </dl></dd>
279 <dt><span class="section"><a href="spirit/support.html">Supporting Libraries</a></span></dt>
280 <dd><dl>
281 <dt><span class="section"><a href="spirit/support/multi_pass.html">The multi pass iterator</a></span></dt>
282 <dt><span class="section"><a href="spirit/support/line_pos_iterator.html">The line position iterator</a></span></dt>
283 <dt><span class="section"><a href="spirit/support/utree.html">The utree data structure</a></span></dt>
284 </dl></dd>
285 <dt><span class="section"><a href="spirit/faq.html">Spirit FAQ</a></span></dt>
286 <dt><span class="section"><a href="spirit/notes.html">Notes</a></span></dt>
287 <dd><dl>
288 <dt><span class="section"><a href="spirit/notes/porting_from_spirit_1_8_x.html">Porting from
289       Spirit 1.8.x</a></span></dt>
290 <dt><span class="section"><a href="spirit/notes/style_guide.html">Style Guide</a></span></dt>
291 </dl></dd>
292 <dt><span class="section"><a href="spirit/rationale.html">Rationale</a></span></dt>
293 <dt><span class="section"><a href="spirit/repository.html">Spirit Repository</a></span></dt>
294 <dt><span class="section"><a href="spirit/acknowledgments.html">Acknowledgments</a></span></dt>
295 <dt><span class="section"><a href="spirit/references.html">References</a></span></dt>
296 </dl>
297 </div>
298 <p>
299     This is the documentation of the latest <a href="https://en.wikipedia.org/wiki/Long-term_support" target="_top">LTS</a>
300     (C++03) version of <a href="http://boost-spirit.com" target="_top">Spirit</a> (currently,
301     V2.5.8). For the newest (C++14) version, please follow to <a href="../../../../libs/spirit/doc/x3/html/index.html" target="_top"><span class="emphasis"><em>Spirit.X3</em></span></a>.
302     If you're looking for the documentation of Spirit's first generation version
303     (formerly Spirit V1.8), see <a href="../../../../libs/spirit/classic/index.html" target="_top"><span class="emphasis"><em>Spirit.Classic</em></span></a>.
304   </p>
305 </div>
306 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
307 <td align="left"><p><small>Last revised: December 10, 2019 at 00:21:52 GMT</small></p></td>
308 <td align="right"><div class="copyright-footer"></div></td>
309 </tr></table>
310 <hr>
311 <div class="spirit-nav"><a accesskey="n" href="spirit/preface.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a></div>
312 </body>
313 </html>