[ceph.git] / ceph / src / boost / libs / spirit / doc / x3 / spirit_x3.qbk

[/==============================================================================
    Copyright (C) 2001-2015 Joel de Guzman
    Copyright (C) 2001-2011 Hartmut Kaiser

    Distributed under the Boost Software License, Version 1.0. (See accompanying
    file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
===============================================================================/]

[article Spirit
    [quickbook 1.5]
    [version 3.0.0]
    [authors [de Guzman, Joel], [Kaiser, Hartmut]]
    [copyright 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 Joel de Guzman, Hartmut Kaiser]
    [/ purpose Parser Library]
    [license
        Distributed under the Boost Software License, Version 1.0.
        (See accompanying file LICENSE_1_0.txt or copy at
        [@http://www.boost.org/LICENSE_1_0.txt])
    ]
]

[/ May 12, 2015 ]

[/==============================================================================
    Some links and defines
===============================================================================/]

[def __version__                V3.0.0]

[/ external]

[def __boost__                  [@http://www.boost.org/ Boost]]
[def __spirit__                 [@http://boost-spirit.com Spirit]]
[def __spirit_list__            [@https://lists.sourceforge.net/lists/listinfo/spirit-general Spirit Mailing List]]
[def __spirit_general__         [@news://news.gmane.org/gmane.comp.spirit.general Spirit General NNTP news portal]]
[def __gmane__                  [@http://www.gmane.org Gmane]]
[def __mlist_archive__          [@http://news.gmane.org/gmane.comp.parsers.spirit.general]]
[def __boost_tools__            [@http://www.boost.org/tools/index.html Boost Tools]]
[def __fusion__                 [@boost:/libs/fusion/doc/html/index.html Boost.Fusion]]
[def __boost_variant__          [@http://www.boost.org/doc/html/variant.html Boost.Variant]]
[def __fwditer__                [@http://www.sgi.com/tech/stl/ForwardIterator.html `ForwardIterator`]]
[def __outputiter__             [@http://www.sgi.com/tech/stl/OutputIterator.html `OutputIterator`]]
[def __concepts__               [@http://www.boost.org/community/generic_programming.html#concept concepts]]
[def __endianness__             [@http://en.wikipedia.org/wiki/Endianness endianness]]
[def __iomanip__                [@http://www.cppreference.com/wiki/io/io_flags#manipulators Manipulators]]
[def __boost_iterator_range__   [@boost:/libs/range/doc/html/range/reference/utilities/iterator_range.html `boost::iterator_range`]]

[/ Some images ]

[def __note__                   [$./images/note.png]]
[def __tip__                    [$./images/tip.png]]
[def __important__              [$./images/important.png]]
[def __caution__                [$./images/caution.png]]
[def __danger__                 [$./images/alert.png]]

[def __x3__                     /Spirit.X3/]

[def __sd_start_stop__          [$./images/start_stop.png]]
[def __sd_terminals__           [$./images/terminal.png]]
[def __sd_non_terminals__       [$./images/non-terminal.png]]
[def __sd_sequence__            [$./images/sequence.png]]
[def __sd_choice__              [$./images/alternative.png]]
[def __sd_optional__            [$./images/optional.png]]
[def __sd_plus__                [$./images/plus.png]]
[def __sd_kleene__              [$./images/kleene.png]]
[def __sd_predicate__           [$./images/predicate.png]]
[def __sd_and_predicate__       [$./images/and_predicate.png]]
[def __sd_not_predicate__       [$./images/not_predicate.png]]
[def __pascal_string__          [$./images/pascal_string.png]]

[def __rd__                     Recursive Descent] [/$$$ TODO: link me $$$]
[def __syntax_diagrams__        [link spirit.abstracts.syntax_diagrams Syntax Diagram]]
[def __peg__                    [link spirit.abstracts.parsing_expression_grammar Parsing Expression Grammar]]
[def __ast__                    Abstract Syntax Tree] [/$$$ TODO: link me $$$]

[def __sec_x3_reference__       [/ link spirit.x3.reference] X3 Reference]
[def __sec_x3_primitive__       [/ link spirit.x3.quick_reference.x3_parsers] X3 Parsers]
[def __sec_x3_compound__        [/ link spirit.x3.quick_reference.compound_attribute_rules] Parser Compound Attribute Rules]

[/ support]
[def __info__                   `info`] [/ TODO Link Me]
[def __x3_error_handler__       Error Handler] [/ TODO Link Me]
[def __unused_type__            `unused_type`] [/$$$ TODO: link me $$$]
[def __unused__                 `unused`] [/$$$ TODO: link me $$$]
[def __char_class_types__       Character Class Types] [/$$$ TODO: link me $$$]

[/ quick-ref]
[def __x3_quickref__                [link spirit.x3.quick_reference X3 Quick Reference]]
[def __x3_comp_attr_notation__      [link spirit.x3.quick_reference.compound_attribute_rules.notation Compound Attribute Notation]]

[/ concepts]
[def __parser_concept__             [/ link spirit.x3.reference.parser_concepts.parser] `Parser`]
[def __primitive_parser_concept__   [/ link spirit.x3.reference.parser_concepts.primitiveparser] `PrimitiveParser`]
[def __unary_parser_concept__       [/ link spirit.x3.reference.parser_concepts.unaryparser] `UnaryParser`]
[def __binary_parser_concept__      [/ link spirit.x3.reference.parser_concepts.binaryparser] `BinaryParser`]
[def __nary_parser_concept__        [/ link spirit.x3.reference.parser_concepts.naryparser] `NaryParser`]
[def __x3_nonterminal__             [/ link spirit.x3.reference.parser_concepts.nonterminal] `Nonterminal`]
[def __x3_nonterminal_attribute__   [/ link spirit.x3.reference.parser_concepts.nonterminal.attributes] `Attribute`]

[/ basics]
[def __x3_lazy_argument__           [/ link spirit.x3.reference.basics.lazy_argument] Lazy Argument]
[def __x3_lazy_arguments__          [/ link spirit.x3.reference.basics.lazy_argument] Lazy Arguments]
[def __char_encoding_namespace__    [/ link spirit.x3.reference.basics.character_encoding_namespace] Character Encoding Namespace]
[def __x3_basics_examples__         [/ link spirit.x3.reference.basics.examples] Basics Examples]

[/ string]
[template x3_lit_string[str]        [[/ link spirit.x3.reference.string.string] str]]
[def __string__                     [/ link spirit.x3.reference.basics.string] String]
[def __x3_symbols__                 [/ link spirit.x3.reference.string.symbols] `symbols<T>`]

[/ action]
[def __x3_semantic_actions__        Semantic Actions] [/ TODO Link Me]

[/ char]
[template x3_char[str]              [/ link spirit.x3.reference.char.char] [str]]
[template x3_char_class[str]        [/ link spirit.x3.reference.char.char_class] [str]]
[template x3_lit_char[char]         [/ link spirit.x3.reference.char.char] [char]]

[/ numerics]
[template x3_signed_int[str]        [/ link spirit.x3.reference.numeric.int] [str]]
[template x3_unsigned_int[str]      [/ link spirit.x3.reference.numeric.uint] [str]]
[template x3_real_number[str]       [/ link spirit.x3.reference.numeric.real] [str]]
[template x3_boolean[str]           [/ link spirit.x3.reference.numeric.boolean] [str]]

[/ binary]
[template x3_native_binary[str]     [/ link spirit.x3.reference.binary.binary_native] [str]]
[template x3_little_binary[str]     [/ link spirit.x3.reference.binary.binary_little] [str]]
[template x3_big_binary[str]        [/ link spirit.x3.reference.binary.binary_big] [str]]

[/ auxiliary]
[def __x3_attr__                    [/ link spirit.x3.reference.auxiliary.attr] `attr(attrib)`]
[def __x3_eol__                     [/ link spirit.x3.reference.auxiliary.eol] `eol`]
[def __x3_eoi__                     [/ link spirit.x3.reference.auxiliary.eoi] `eoi`]
[def __x3_eps__                     [/ link spirit.x3.reference.auxiliary.eps] `eps`]
[def __x3_lazy__                    [/ link spirit.x3.reference.auxiliary.lazy] `lazy`]

[/ directives]
[def __x3_lexeme__                  [/ link spirit.x3.reference.directive.lexeme] `lexeme`]
[def __x3_no_case__                 [/ link spirit.x3.reference.directive.no_case] `no_case`]
[def __x3_omit__                    [/ link spirit.x3.reference.directive.omit] `omit`]
[def __x3_matches__                 [/ link spirit.x3.reference.directive.matches] `matches`]
[def __x3_raw__                     [/ link spirit.x3.reference.directive.raw] `raw`]
[def __x3_repeat__                  [/ link spirit.x3.reference.directive.repeat] `repeat`]
[template x3_repeat[str]            [[/ link spirit.x3.reference.directive.repeat] str]]
[def __x3_skip__                    [/ link spirit.x3.reference.directive.skip] `skip`]
[template x3_no_skip[str]           [[/ link spirit.x3.reference.directive.no_skip] str]]
[def __x3_hold__                    [/ link spirit.x3.reference.directive.hold] `hold`]
[def __x3_as__                      [/ link spirit.x3.reference.directive.as] `as<T>[]`]
[def __x3_as_string__               [/ link spirit.x3.reference.directive.as] `as_string[]`]
[def __x3_as_wstring__              [/ link spirit.x3.reference.directive.as] `as_wstring[]`]

[/ operator]
[def __x3_alternative__             [/ link spirit.x3.reference.operator.alternative] `a | b`]
[def __x3_and_predicate__           [/ link spirit.x3.reference.operator.and_predicate] `&a`]
[def __x3_difference__              [/ link spirit.x3.reference.operator.difference] `a - b`]
[def __x3_expect__                  [/ link spirit.x3.reference.operator.expect] `a > b`]
[def __x3_expectation_failure__     [/ link spirit.x3.reference.operator.expect.expectation_failure] `expectation_failure`]
[def __x3_kleene__                  [/ link spirit.x3.reference.operator.kleene] `*a`]
[def __x3_list__                    [/ link spirit.x3.reference.operator.list] `a % b`]
[def __x3_not_predicate__           [/ link spirit.x3.reference.operator.not_predicate] `!a`]
[def __x3_optional__                [/ link spirit.x3.reference.operator.optional] `-a`]
[def __x3_plus__                    [/ link spirit.x3.reference.operator.plus] `+a`]
[def __x3_sequence__                [/ link spirit.x3.reference.operator.sequence] `a >> b`]

[def __x3_stream__                  [/ link spirit.x3.reference.stream.stream] `stream`]

[/ nonterminal]
[def __x3_rule__                    [/ link spirit.x3.reference.nonterminal.rule] rule]
[def __x3_rules__                   [/ link spirit.x3.reference.nonterminal.rule] rules]
[def __x3_grammar__                 [/ link spirit.x3.reference.nonterminal.grammar] grammar]
[def __x3_grammars__                [/ link spirit.x3.reference.nonterminal.grammar] grammars]

[/ stream]
[template x3_match[str]             [/ link spirit.x3.reference.parse_api.stream_api] str]
[template x3_auto[str]              [/ link spirit.x3.reference.auto] str]
[def __create_parser__              [/ link spirit.x3.reference.parse_api.create_parser] `create_parser`]

[def __parse_api__                  [/ link spirit.x3.reference.parse_api] The Parse API]

[/==============================================================================
    Documentation Start
===============================================================================/]

This is the documentation of the newest version of __spirit__ (currently,
__version__).

[include preface.qbk]
[include introduction.qbk]
[include include.qbk]
[include abstracts.qbk]

[section    Tutorials]
[include        tutorial/tutorial_intro.qbk]
[include        tutorial/warming_up.qbk]
[include        tutorial/actions.qbk]
[include        tutorial/complex.qbk]
[include        tutorial/sum_tutorial.qbk]
[include        tutorial/num_list2.qbk]
[include        tutorial/num_list3.qbk]
[include        tutorial/num_list4.qbk]
[include        tutorial/roman.qbk]
[include        tutorial/employee.qbk]
[include        tutorial/rexpr.qbk]
[endsect]

[section    Quick Reference]
[include        quick_reference.qbk]
[endsect]

[/ section    Reference]
[/ include        concepts.qbk]
[/ include        basics.qbk]
[/ include        parse_api.qbk]
[/ include        action.qbk]
[/ include        auto.qbk]
[/ include        auxiliary.qbk]
[/ include        binary.qbk]
[/ include        char.qbk]
[/ include        directive.qbk]
[/ include        nonterminal.qbk]
[/ include        numeric.qbk]
[/ include        operator.qbk]
[/ include        stream.qbk]
[/ include        string.qbk]
[/ endsect]

[/ include x3.qbk]
[/ include karma.qbk]
[/ include lex.qbk]
[/ include advanced.qbk]
[/ include support.qbk]
[/ include faq.qbk]
[/ include notes.qbk]
[/ include rationale.qbk]
[/ include repository.qbk]
[/ include acknowledgments.qbk]
[/ include references.qbk]
Commit	Line	Data
7c673cae FG	1	[/==============================================================================
	2	Copyright (C) 2001-2015 Joel de Guzman
	3	Copyright (C) 2001-2011 Hartmut Kaiser
	4
	5	Distributed under the Boost Software License, Version 1.0. (See accompanying
	6	file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
	7	===============================================================================/]
	8
	9	[article Spirit
	10	[quickbook 1.5]
	11	[version 3.0.0]
	12	[authors [de Guzman, Joel], [Kaiser, Hartmut]]
	13	[copyright 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 Joel de Guzman, Hartmut Kaiser]
	14	[/ purpose Parser Library]
	15	[license
	16	Distributed under the Boost Software License, Version 1.0.
	17	(See accompanying file LICENSE_1_0.txt or copy at
	18	[@http://www.boost.org/LICENSE_1_0.txt])
	19	]
	20	]
	21
	22	[/ May 12, 2015 ]
	23
	24	[/==============================================================================
	25	Some links and defines
	26	===============================================================================/]
	27
	28	[def __version__ V3.0.0]
	29
	30	[/ external]
	31
	32	[def __boost__ [@http://www.boost.org/ Boost]]
	33	[def __spirit__ [@http://boost-spirit.com Spirit]]
	34	[def __spirit_list__ [@https://lists.sourceforge.net/lists/listinfo/spirit-general Spirit Mailing List]]
	35	[def __spirit_general__ [@news://news.gmane.org/gmane.comp.spirit.general Spirit General NNTP news portal]]
	36	[def __gmane__ [@http://www.gmane.org Gmane]]
	37	[def __mlist_archive__ [@http://news.gmane.org/gmane.comp.parsers.spirit.general]]
	38	[def __boost_tools__ [@http://www.boost.org/tools/index.html Boost Tools]]
	39	[def __fusion__ [@boost:/libs/fusion/doc/html/index.html Boost.Fusion]]
	40	[def __boost_variant__ [@http://www.boost.org/doc/html/variant.html Boost.Variant]]
	41	[def __fwditer__ [@http://www.sgi.com/tech/stl/ForwardIterator.html `ForwardIterator`]]
	42	[def __outputiter__ [@http://www.sgi.com/tech/stl/OutputIterator.html `OutputIterator`]]
	43	[def __concepts__ [@http://www.boost.org/community/generic_programming.html#concept concepts]]
	44	[def __endianness__ [@http://en.wikipedia.org/wiki/Endianness endianness]]
	45	[def __iomanip__ [@http://www.cppreference.com/wiki/io/io_flags#manipulators Manipulators]]
	46	[def __boost_iterator_range__ [@boost:/libs/range/doc/html/range/reference/utilities/iterator_range.html `boost::iterator_range`]]
	47
	48	[/ Some images ]
	49
	50	[def __note__ [$./images/note.png]]
	51	[def __tip__ [$./images/tip.png]]
	52	[def __important__ [$./images/important.png]]
	53	[def __caution__ [$./images/caution.png]]
	54	[def __danger__ [$./images/alert.png]]
	55
	56	[def __x3__ /Spirit.X3/]
	57
	58	[def __sd_start_stop__ [$./images/start_stop.png]]
	59	[def __sd_terminals__ [$./images/terminal.png]]
	60	[def __sd_non_terminals__ [$./images/non-terminal.png]]
	61	[def __sd_sequence__ [$./images/sequence.png]]
	62	[def __sd_choice__ [$./images/alternative.png]]
	63	[def __sd_optional__ [$./images/optional.png]]
	64	[def __sd_plus__ [$./images/plus.png]]
65	[def __sd_kleene__ [$./images/kleene.png]]
66	[def __sd_predicate__ [$./images/predicate.png]]
67	[def __sd_and_predicate__ [$./images/and_predicate.png]]
68	[def __sd_not_predicate__ [$./images/not_predicate.png]]
69	[def __pascal_string__ [$./images/pascal_string.png]]
70
71	[def __rd__ Recursive Descent] [/$$$ TODO: link me $$$]
72	[def __syntax_diagrams__ [link spirit.abstracts.syntax_diagrams Syntax Diagram]]
73	[def __peg__ [link spirit.abstracts.parsing_expression_grammar Parsing Expression Grammar]]
74	[def __ast__ Abstract Syntax Tree] [/$$$ TODO: link me $$$]
75
76	[def __sec_x3_reference__ [/ link spirit.x3.reference] X3 Reference]
77	[def __sec_x3_primitive__ [/ link spirit.x3.quick_reference.x3_parsers] X3 Parsers]
78	[def __sec_x3_compound__ [/ link spirit.x3.quick_reference.compound_attribute_rules] Parser Compound Attribute Rules]
79
80	[/ support]
81	[def __info__ `info`] [/ TODO Link Me]
82	[def __x3_error_handler__ Error Handler] [/ TODO Link Me]
83	[def __unused_type__ `unused_type`] [/$$$ TODO: link me $$$]
84	[def __unused__ `unused`] [/$$$ TODO: link me $$$]
85	[def __char_class_types__ Character Class Types] [/$$$ TODO: link me $$$]
86
87	[/ quick-ref]
88	[def __x3_quickref__ [link spirit.x3.quick_reference X3 Quick Reference]]
89	[def __x3_comp_attr_notation__ [link spirit.x3.quick_reference.compound_attribute_rules.notation Compound Attribute Notation]]
90
91	[/ concepts]
92	[def __parser_concept__ [/ link spirit.x3.reference.parser_concepts.parser] `Parser`]
93	[def __primitive_parser_concept__ [/ link spirit.x3.reference.parser_concepts.primitiveparser] `PrimitiveParser`]
94	[def __unary_parser_concept__ [/ link spirit.x3.reference.parser_concepts.unaryparser] `UnaryParser`]
95	[def __binary_parser_concept__ [/ link spirit.x3.reference.parser_concepts.binaryparser] `BinaryParser`]
96	[def __nary_parser_concept__ [/ link spirit.x3.reference.parser_concepts.naryparser] `NaryParser`]
97	[def __x3_nonterminal__ [/ link spirit.x3.reference.parser_concepts.nonterminal] `Nonterminal`]
98	[def __x3_nonterminal_attribute__ [/ link spirit.x3.reference.parser_concepts.nonterminal.attributes] `Attribute`]
99
100	[/ basics]
101	[def __x3_lazy_argument__ [/ link spirit.x3.reference.basics.lazy_argument] Lazy Argument]
102	[def __x3_lazy_arguments__ [/ link spirit.x3.reference.basics.lazy_argument] Lazy Arguments]
103	[def __char_encoding_namespace__ [/ link spirit.x3.reference.basics.character_encoding_namespace] Character Encoding Namespace]
104	[def __x3_basics_examples__ [/ link spirit.x3.reference.basics.examples] Basics Examples]
105
106	[/ string]
107	[template x3_lit_string[str] [[/ link spirit.x3.reference.string.string] str]]
108	[def __string__ [/ link spirit.x3.reference.basics.string] String]
109	[def __x3_symbols__ [/ link spirit.x3.reference.string.symbols] `symbols<T>`]
110
111	[/ action]
112	[def __x3_semantic_actions__ Semantic Actions] [/ TODO Link Me]
113
114	[/ char]
115	[template x3_char[str] [/ link spirit.x3.reference.char.char] [str]]
116	[template x3_char_class[str] [/ link spirit.x3.reference.char.char_class] [str]]
117	[template x3_lit_char[char] [/ link spirit.x3.reference.char.char] [char]]
118
119	[/ numerics]
120	[template x3_signed_int[str] [/ link spirit.x3.reference.numeric.int] [str]]
121	[template x3_unsigned_int[str] [/ link spirit.x3.reference.numeric.uint] [str]]
122	[template x3_real_number[str] [/ link spirit.x3.reference.numeric.real] [str]]
123	[template x3_boolean[str] [/ link spirit.x3.reference.numeric.boolean] [str]]
124
125	[/ binary]
126	[template x3_native_binary[str] [/ link spirit.x3.reference.binary.binary_native] [str]]
127	[template x3_little_binary[str] [/ link spirit.x3.reference.binary.binary_little] [str]]
128	[template x3_big_binary[str] [/ link spirit.x3.reference.binary.binary_big] [str]]
129
130	[/ auxiliary]
131	[def __x3_attr__ [/ link spirit.x3.reference.auxiliary.attr] `attr(attrib)`]
132	[def __x3_eol__ [/ link spirit.x3.reference.auxiliary.eol] `eol`]
133	[def __x3_eoi__ [/ link spirit.x3.reference.auxiliary.eoi] `eoi`]
134	[def __x3_eps__ [/ link spirit.x3.reference.auxiliary.eps] `eps`]
135	[def __x3_lazy__ [/ link spirit.x3.reference.auxiliary.lazy] `lazy`]
136
137	[/ directives]
138	[def __x3_lexeme__ [/ link spirit.x3.reference.directive.lexeme] `lexeme`]
139	[def __x3_no_case__ [/ link spirit.x3.reference.directive.no_case] `no_case`]
140	[def __x3_omit__ [/ link spirit.x3.reference.directive.omit] `omit`]
141	[def __x3_matches__ [/ link spirit.x3.reference.directive.matches] `matches`]
142	[def __x3_raw__ [/ link spirit.x3.reference.directive.raw] `raw`]
143	[def __x3_repeat__ [/ link spirit.x3.reference.directive.repeat] `repeat`]
144	[template x3_repeat[str] [[/ link spirit.x3.reference.directive.repeat] str]]
145	[def __x3_skip__ [/ link spirit.x3.reference.directive.skip] `skip`]
146	[template x3_no_skip[str] [[/ link spirit.x3.reference.directive.no_skip] str]]
147	[def __x3_hold__ [/ link spirit.x3.reference.directive.hold] `hold`]
148	[def __x3_as__ [/ link spirit.x3.reference.directive.as] `as<T>[]`]
149	[def __x3_as_string__ [/ link spirit.x3.reference.directive.as] `as_string[]`]
150	[def __x3_as_wstring__ [/ link spirit.x3.reference.directive.as] `as_wstring[]`]
151
152	[/ operator]
153	[def __x3_alternative__ [/ link spirit.x3.reference.operator.alternative] `a \| b`]
154	[def __x3_and_predicate__ [/ link spirit.x3.reference.operator.and_predicate] `&a`]
155	[def __x3_difference__ [/ link spirit.x3.reference.operator.difference] `a - b`]
156	[def __x3_expect__ [/ link spirit.x3.reference.operator.expect] `a > b`]
157	[def __x3_expectation_failure__ [/ link spirit.x3.reference.operator.expect.expectation_failure] `expectation_failure`]
158	[def __x3_kleene__ [/ link spirit.x3.reference.operator.kleene] `*a`]
159	[def __x3_list__ [/ link spirit.x3.reference.operator.list] `a % b`]
160	[def __x3_not_predicate__ [/ link spirit.x3.reference.operator.not_predicate] `!a`]
161	[def __x3_optional__ [/ link spirit.x3.reference.operator.optional] `-a`]
162	[def __x3_plus__ [/ link spirit.x3.reference.operator.plus] `+a`]
163	[def __x3_sequence__ [/ link spirit.x3.reference.operator.sequence] `a >> b`]
164
165	[def __x3_stream__ [/ link spirit.x3.reference.stream.stream] `stream`]
166
167	[/ nonterminal]
168	[def __x3_rule__ [/ link spirit.x3.reference.nonterminal.rule] rule]
169	[def __x3_rules__ [/ link spirit.x3.reference.nonterminal.rule] rules]
170	[def __x3_grammar__ [/ link spirit.x3.reference.nonterminal.grammar] grammar]
171	[def __x3_grammars__ [/ link spirit.x3.reference.nonterminal.grammar] grammars]
172
173	[/ stream]
174	[template x3_match[str] [/ link spirit.x3.reference.parse_api.stream_api] str]
175	[template x3_auto[str] [/ link spirit.x3.reference.auto] str]
176	[def __create_parser__ [/ link spirit.x3.reference.parse_api.create_parser] `create_parser`]
177
178	[def __parse_api__ [/ link spirit.x3.reference.parse_api] The Parse API]
179
180	[/==============================================================================
181	Documentation Start
182	===============================================================================/]
183
184	This is the documentation of the newest version of __spirit__ (currently,
185	__version__).
186
187	[include preface.qbk]
188	[include introduction.qbk]
189	[include include.qbk]
190	[include abstracts.qbk]
191
192	[section Tutorials]
193	[include tutorial/tutorial_intro.qbk]
194	[include tutorial/warming_up.qbk]
195	[include tutorial/actions.qbk]
196	[include tutorial/complex.qbk]
197	[include tutorial/sum_tutorial.qbk]
198	[include tutorial/num_list2.qbk]
199	[include tutorial/num_list3.qbk]
200	[include tutorial/num_list4.qbk]
201	[include tutorial/roman.qbk]
202	[include tutorial/employee.qbk]
203	[include tutorial/rexpr.qbk]
204	[endsect]
205
206	[section Quick Reference]
207	[include quick_reference.qbk]
208	[endsect]
209
210	[/ section Reference]
211	[/ include concepts.qbk]
212	[/ include basics.qbk]
213	[/ include parse_api.qbk]
214	[/ include action.qbk]
215	[/ include auto.qbk]
216	[/ include auxiliary.qbk]
217	[/ include binary.qbk]
218	[/ include char.qbk]
219	[/ include directive.qbk]
220	[/ include nonterminal.qbk]
221	[/ include numeric.qbk]
222	[/ include operator.qbk]
223	[/ include stream.qbk]
224	[/ include string.qbk]
225	[/ endsect]
226
227	[/ include x3.qbk]
228	[/ include karma.qbk]
229	[/ include lex.qbk]
230	[/ include advanced.qbk]
231	[/ include support.qbk]
232	[/ include faq.qbk]
233	[/ include notes.qbk]
234	[/ include rationale.qbk]
235	[/ include repository.qbk]
236	[/ include acknowledgments.qbk]
237	[/ include references.qbk]