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