Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r53987 - in trunk/libs/spirit: doc doc/abstracts doc/html doc/html/spirit doc/html/spirit/abstracts doc/html/spirit/karma doc/html/spirit/karma/quick_reference doc/html/spirit/lex doc/html/spirit/lex/abstracts doc/html/spirit/lex/abstracts/lexer_primitives doc/html/spirit/lex/reference doc/html/spirit/lex/reference/concepts doc/html/spirit/lex/tutorials doc/html/spirit/notes doc/html/spirit/qi doc/html/spirit/qi/quick_reference doc/html/spirit/qi/tutorials doc/html/spirit/structure test/qi
From: joel_at_[hidden]
Date: 2009-06-16 22:59:10

Author: djowel
Date: 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
New Revision: 53987
URL: http://svn.boost.org/trac/boost/changeset/53987

Log:
Doc updates
Added:
   trunk/libs/spirit/doc/html/spirit/abstracts/syntax_diagram.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/karma/
   trunk/libs/spirit/doc/html/spirit/karma/quick_reference/
   trunk/libs/spirit/doc/html/spirit/karma/quick_reference.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/karma/quick_reference/common_notation.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/karma/quick_reference/compound_attribute_rules.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/karma/quick_reference/lazy_arguments.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/karma/quick_reference/non_terminals.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/karma/quick_reference/phoenix.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/karma/quick_reference/predefined_primitive_generators.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/karma/quick_reference/semantic_actions.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/lex/abstracts/lexer_primitives/
   trunk/libs/spirit/doc/html/spirit/lex/abstracts/lexer_primitives.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/lex/abstracts/lexer_primitives/lexer_primitives.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/lex/abstracts/lexer_primitives/lexer_token_definition.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/lex/abstracts/lexer_primitives/lexer_token_values.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/lex/lexer_introduction.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/lex/reference/concepts/
   trunk/libs/spirit/doc/html/spirit/lex/reference/concepts.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/lex/reference/concepts/lexer.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/lex/reference/concepts/token.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/lex/reference/concepts/tokendef.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/lex/reference/concepts/tokenset.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/lex/tutorials/lexer_tutorials.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/notes/
   trunk/libs/spirit/doc/html/spirit/notes/style_guide.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/preface.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/qi/quick_reference/common_notation.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/qi/tutorials/
   trunk/libs/spirit/doc/html/spirit/qi/tutorials.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/qi/tutorials/complex___our_first_complex_parser.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/qi/tutorials/employee___parsing_into_structs.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/qi/tutorials/mini_xml___asts_.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/qi/tutorials/mini_xml___error_handling.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/qi/tutorials/number_list___stuffing_numbers_into_a_std__vector.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/qi/tutorials/number_list_attribute___one_more__with_style.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/qi/tutorials/number_list_redux___list_syntax.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/qi/tutorials/quick_start.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/qi/tutorials/roman_numerals.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/qi/tutorials/semantic_actions.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/qi/tutorials/sum___adding_numbers.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/qi/tutorials/warming_up.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/structure/
   trunk/libs/spirit/doc/html/spirit/structure/include.html (contents, props changed)
Text files modified:
   trunk/libs/spirit/doc/Jamfile | 2
   trunk/libs/spirit/doc/abstracts/peg.qbk | 18
   trunk/libs/spirit/doc/abstracts/syntax_diagram.qbk | 43
   trunk/libs/spirit/doc/html/index.html | 379 -----
   trunk/libs/spirit/doc/html/spirit/abstracts.html | 205 ---
   trunk/libs/spirit/doc/html/spirit/abstracts/parsing_expression_grammar.html | 57
   trunk/libs/spirit/doc/html/spirit/acknowledgments.html | 8
   trunk/libs/spirit/doc/html/spirit/faq.html | 2
   trunk/libs/spirit/doc/html/spirit/introduction.html | 8
   trunk/libs/spirit/doc/html/spirit/karma.html | 1495 ----------------------
   trunk/libs/spirit/doc/html/spirit/lex.html | 233 ---
   trunk/libs/spirit/doc/html/spirit/lex/abstracts.html | 375 -----
   trunk/libs/spirit/doc/html/spirit/lex/abstracts/lexer_states.html | 6
   trunk/libs/spirit/doc/html/spirit/lex/abstracts/lexer_static_model.html | 4
   trunk/libs/spirit/doc/html/spirit/lex/abstracts/lexer_tokenizing.html | 11
   trunk/libs/spirit/doc/html/spirit/lex/reference.html | 411 ------
   trunk/libs/spirit/doc/html/spirit/lex/reference/lexer_class.html | 14
   trunk/libs/spirit/doc/html/spirit/lex/tutorials.html | 102 -
   trunk/libs/spirit/doc/html/spirit/lex/tutorials/lexer_quickstart1.html | 18
   trunk/libs/spirit/doc/html/spirit/lex/tutorials/lexer_quickstart2.html | 8
   trunk/libs/spirit/doc/html/spirit/lex/tutorials/lexer_quickstart3.html | 10
   trunk/libs/spirit/doc/html/spirit/notes.html | 119 -
   trunk/libs/spirit/doc/html/spirit/qi.html | 2627 ---------------------------------------
   trunk/libs/spirit/doc/html/spirit/qi/quick_reference.html | 122 -
   trunk/libs/spirit/doc/html/spirit/qi/quick_reference/compound_attribute_rules.html | 2
   trunk/libs/spirit/doc/html/spirit/qi/quick_reference/predefined_primitive_parsers.html | 6
   trunk/libs/spirit/doc/html/spirit/structure.html | 194 --
   trunk/libs/spirit/doc/html/spirit/what_s_new.html | 14
   trunk/libs/spirit/doc/spirit2.qbk | 11
   trunk/libs/spirit/test/qi/debug.cpp | 128 -
   30 files changed, 251 insertions(+), 6381 deletions(-)

Modified: trunk/libs/spirit/doc/Jamfile
==============================================================================
--- trunk/libs/spirit/doc/Jamfile (original)
+++ trunk/libs/spirit/doc/Jamfile 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -20,7 +20,7 @@
 <xsl:param>boost.libraries=../../../libraries.htm
 <xsl:param>html.stylesheet=../../../../doc/html/boostbook.css
 <xsl:param>chunk.section.depth=4
- #<xsl:param>chunk.first.sections=1
+ <xsl:param>chunk.first.sections=1
 <xsl:param>toc.section.depth=3
 <xsl:param>toc.max.depth=3
 <xsl:param>generate.section.toc.level=4

Modified: trunk/libs/spirit/doc/abstracts/peg.qbk
==============================================================================
--- trunk/libs/spirit/doc/abstracts/peg.qbk (original)
+++ trunk/libs/spirit/doc/abstracts/peg.qbk 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -5,7 +5,6 @@
     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)
===============================================================================/]
-
[section Parsing Expression Grammar]

Parsing Expression Grammars (PEG) are a derivative of Extended
@@ -26,7 +25,11 @@
     a b

The PEG expression above states that, in order for this to succeed,
-`a` must follow `b`. Here's a trivial example:
+`a` must follow `b`. Here's the syntax diagram:
+
+[:__sd_sequence__]
+
+Here's a trivial example:

     'x' digit

@@ -46,7 +49,9 @@
Alternatives allow for choices. The expression above reads: try to match
`a`. If `a` succeeds, success, if not try to match `b`. This is a bit of
a deviation from the usual EBNF interpretation where you simply match
-`a` *or* `b`.
+`a` *or* `b`. Here's the syntax diagram:
+
+[:__sd_choice__]

PEGs allow for ambiguity in the alternatives. In the expression above,
both `a` or `b` can both match an input string. However, only the first
@@ -59,11 +64,16 @@
plus loops:

     a*
- b+
+ a+

[note Spirit.Qi uses the prefix star and plus since there is no postfix
star or plus in C++.]

+Here are the syntax diagrams:
+
+[:__sd_kleene__]
+[:__sd_plus__]
+
The first, called the Kleene star, matches zero or more of its subject
`a`. The second, plus, matches one ore more of its subject `a`.

Modified: trunk/libs/spirit/doc/abstracts/syntax_diagram.qbk
==============================================================================
--- trunk/libs/spirit/doc/abstracts/syntax_diagram.qbk (original)
+++ trunk/libs/spirit/doc/abstracts/syntax_diagram.qbk 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -7,27 +7,16 @@
===============================================================================/]
[section Syntax Diagram]

-[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]]
-
-In the following section, we will deal with Parsing Expression Grammars
+In the next section, we will deal with Parsing Expression Grammars
(PEG), a variant of Extended Backus-Naur Form (EBNF) with a different
interpretation. It is easier to understand PEG using Syntax Diagrams.
Syntax diagrams represent a grammar graphically. It was used extensibly
by Niklaus Wirth [footnote Niklaus Wirth: The Programming Language
Pascal. (July 1973)] in the "Pascal User Manual". Syntax Diagrams are
easily understandable with programmers due to its similarity to flow
-charts. Also, the one to one mapping between the diagrams and functions
-make it ideal for representing __rd__ parsers.
+charts. The isomorphism of the diagrams and functions make it ideal for
+representing __rd__ parsers which are essentially mutually recursive
+functions.

[heading Elements]

@@ -54,10 +43,10 @@

[:__sd_sequence__]

-The ordered choice, hencforth we will call alternatives. In PEG, ordered
-choice and alternatives are not quite the same. PEG allows ambiguity of
-choice where one ore more branches can succeed. In PEG, in case of
-ambiguity, the first one always wins.
+The ordered choice, henceforth we will call /alternatives/. In PEG,
+ordered choice and alternatives are not quite the same. PEG allows
+ambiguity of choice where one or more branches can succeed. In PEG, in
+case of ambiguity, the first one always wins.

[:__sd_choice__]

@@ -70,18 +59,18 @@
[:__sd_kleene__]
[:__sd_plus__]

-Take note that, as in PEG, these behave greedily. If there is another
-'A' just before the end-point, it will always fail because the preceding
-loop has already exhausted all the 'A's and there is nothing more to
-get. This is a crucial difference between PEG and general Context Free
-Grammars (PEGs). This behavior is quite obvious with syntax diagrams as
+Take note that, as in PEG, these loops behave greedily. If there is
+another 'A' just before the end-point, it will always fail because the
+preceding loop has already exhausted all 'A's and there is nothing more
+left. This is a crucial difference between PEG and general Context Free
+Grammars (CFGs). This behavior is quite obvious with syntax diagrams as
they resemble flow-charts.

[heading Predicates]

-Now, the following are Syntax Diagram versions PEG predicates. While
-these are not really included in usual Syntax Diagrams, we have it here
-to closely follow PEGs.
+Now, the following are Syntax Diagram versions of PEG predicates. These
+are not traditionally found in Syntax Diagrams. These are special
+extensions we invented to closely follow PEGs.

First, we introduce a new element, the Predicate:

Modified: trunk/libs/spirit/doc/html/index.html
==============================================================================
--- trunk/libs/spirit/doc/html/index.html (original)
+++ trunk/libs/spirit/doc/html/index.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -5,7 +5,7 @@
<link rel="stylesheet" href="../../../../doc/html/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
<link rel="home" href="index.html" title="Spirit 2.1">
-<link rel="next" href="spirit/what_s_new.html" title="What's New">
+<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>
@@ -17,7 +17,7 @@
<td align="center">More</td>
</tr></table>
<hr>
-<div class="spirit-nav"><a accesskey="n" href="spirit/what_s_new.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a></div>
+<div class="spirit-nav"><a accesskey="n" href="spirit/preface.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a></div>
<div class="article" lang="en">
<div class="titlepage">
<div>
@@ -44,44 +44,44 @@
<div class="toc">
Table of Contents
<dl>
-<dt>Preface</dt>
+<dt>Preface</dt>
<dt>What's New</dt>
<dt>Introduction</dt>
<dt>Structure</dt>
-<dd><dl><dt>Include</dt></dl></dd>
+<dd><dl><dt>Include</dt></dl></dd>
<dt>Abstracts</dt>
<dd><dl>
-<dt>Syntax Diagram</dt>
+<dt>Syntax Diagram</dt>
<dt><a href="spirit/abstracts/parsing_expression_grammar.html">Parsing
 Expression Grammar</a></dt>
</dl></dd>
<dt> Qi</dt>
<dd><dl>
-<dt>Tutorials</dt>
+<dt>Tutorials</dt>
<dd><dl>
-<dt>Quick Start</dt>
-<dt>Warming up</dt>
-<dt>Semantic Actions</dt>
-<dt><a href="spirit/qi.html#spirit.qi.tutorials.complex___our_first_complex_parser">Complex
+<dt>Quick Start</dt>
+<dt>Warming up</dt>
+<dt>Semantic Actions</dt>
+<dt><a href="spirit/qi/tutorials/complex___our_first_complex_parser.html">Complex
 - Our first complex parser</a></dt>
-<dt><a href="spirit/qi.html#spirit.qi.tutorials.sum___adding_numbers">Sum - adding
+<dt><a href="spirit/qi/tutorials/sum___adding_numbers.html">Sum - adding
 numbers</a></dt>
-<dt><a href="spirit/qi.html#spirit.qi.tutorials.number_list___stuffing_numbers_into_a_std__vector">Number
+<dt><a href="spirit/qi/tutorials/number_list___stuffing_numbers_into_a_std__vector.html">Number
 List - stuffing numbers into a std::vector</a></dt>
-<dt><a href="spirit/qi.html#spirit.qi.tutorials.number_list_redux___list_syntax">Number
+<dt><a href="spirit/qi/tutorials/number_list_redux___list_syntax.html">Number
 List Redux - list syntax</a></dt>
-<dt><a href="spirit/qi.html#spirit.qi.tutorials.number_list_attribute___one_more__with_style">Number
+<dt><a href="spirit/qi/tutorials/number_list_attribute___one_more__with_style.html">Number
 List Attribute - one more, with style</a></dt>
-<dt>Roman Numerals</dt>
-<dt><a href="spirit/qi.html#spirit.qi.tutorials.employee___parsing_into_structs">Employee
+<dt>Roman Numerals</dt>
+<dt><a href="spirit/qi/tutorials/employee___parsing_into_structs.html">Employee
 - Parsing into structs</a></dt>
-<dt>Mini XML - ASTs!</dt>
-<dt><a href="spirit/qi.html#spirit.qi.tutorials.mini_xml___error_handling">Mini
+<dt>Mini XML - ASTs!</dt>
+<dt><a href="spirit/qi/tutorials/mini_xml___error_handling.html">Mini
 XML - Error Handling</a></dt>
</dl></dd>
<dt>Quick Reference</dt>
<dd><dl>
-<dt>Common Notation</dt>
+<dt>Common Notation</dt>
<dt><a href="spirit/qi/quick_reference/predefined_primitive_parsers.html">Predefined
 Primitive Parsers</a></dt>
<dt><a href="spirit/qi/quick_reference/compound_attribute_rules.html">Compound
@@ -95,28 +95,28 @@
</dl></dd>
<dt> Karma</dt>
<dd><dl>
-<dt>Quick Reference</dt>
+<dt>Quick Reference</dt>
<dd><dl>
-<dt><a href="spirit/karma.html#spirit.karma.quick_reference.common_notation">Common
+<dt><a href="spirit/karma/quick_reference/common_notation.html">Common
 Notation</a></dt>
-<dt><a href="spirit/karma.html#spirit.karma.quick_reference.predefined_primitive_generators">Predefined
+<dt><a href="spirit/karma/quick_reference/predefined_primitive_generators.html">Predefined
 Primitive Generators</a></dt>
-<dt><a href="spirit/karma.html#spirit.karma.quick_reference.compound_attribute_rules">Compound
+<dt><a href="spirit/karma/quick_reference/compound_attribute_rules.html">Compound
 Attribute Rules</a></dt>
-<dt>Lazy Arguments</dt>
-<dt>Non-terminals</dt>
-<dt><a href="spirit/karma.html#spirit.karma.quick_reference.semantic_actions">Semantic
+<dt>Lazy Arguments</dt>
+<dt>Non-terminals</dt>
+<dt><a href="spirit/karma/quick_reference/semantic_actions.html">Semantic
 Actions</a></dt>
-<dt>Phoenix</dt>
+<dt>Phoenix</dt>
</dl></dd>
</dl></dd>
<dt> Spirit.Lex</dt>
<dd><dl>
-<dt> Introduction to Spirit.Lex</dt>
+<dt> Introduction to Spirit.Lex</dt>
<dt><a href="spirit/lex/tutorials.html"> Spirit.Lex
 Tutorials</a></dt>
<dd><dl>
-<dt><a href="spirit/lex/tutorials.html#spirit.lex.tutorials.lexer_tutorials"> Spirit.Lex
+<dt><a href="spirit/lex/tutorials/lexer_tutorials.html"> Spirit.Lex
 Tutorials Overview</a></dt>
<dt><a href="spirit/lex/tutorials/lexer_quickstart1.html"> Quickstart
 1 - A word counter using Spirit.Lex</a></dt>
@@ -127,7 +127,7 @@
</dl></dd>
<dt> Abstracts</dt>
<dd><dl>
-<dt>Lexer Primitives</dt>
+<dt>Lexer Primitives</dt>
<dt><a href="spirit/lex/abstracts/lexer_tokenizing.html"> Tokenizing
 Input Data</a></dt>
<dt><a href="spirit/lex/abstracts/lexer_semantic_actions.html"> Lexer
@@ -142,7 +142,7 @@
<dt> Quick Reference</dt>
<dt> Reference</dt>
<dd><dl>
-<dt> Concepts</dt>
+<dt> Concepts</dt>
<dt>Lexer Class</dt>
<dt>Token Class</dt>
<dt>TokenDef Class</dt>
@@ -151,328 +151,17 @@
</dl></dd>
<dt>FAQ</dt>
<dt>Notes</dt>
-<dd><dl><dt>Style Guide</dt></dl></dd>
+<dd><dl><dt>Style Guide</dt></dl></dd>
<dt>Acknowledgments</dt>
<dt>References</dt>
</dl>
</div>
-<div class="section" lang="en">
-<div class="titlepage">
-<div><div><h2 class="title" style="clear: both">
-<a name="spirit.preface"></a>Preface
-</h2></div></div>
-<div></div>
-</div>
-<div class="blockquote"><blockquote class="blockquote">
-
- 
-
- “Examples of designs that meet most of the criteria for
- "goodness" (easy to understand, flexible, efficient) are a recursive-
- descent parser, which is traditional procedural code. Another example is
- the STL, which is a generic library of containers and algorithms depending
- crucially on both traditional procedural code and on parametric polymorphism.”
- --Bjarne Stroustrup
- 
-
- 
-</blockquote></div>
-<a name="spirit.preface.history"></a><h3>
-<a name="id355261"></a>
- History
- </h3>
-<a name="spirit.preface._emphasis_80s__emphasis_"></a><h3>
-<a name="id398000"></a>
- 80s
- </h3>
-
- In the Mid 80s, Joel wrote his first calculator in Pascal. It has been an unforgettable
- coding experience. He was amazed how a mutually recursive set of functions
- can model a grammar specification. In time, the skills he acquired from that
- academic experience became very practical. Periodically Joel was tasked to
- do some parsing. For instance, whenever he needs to perform any form of I/O,
- even in binary, he tries to approach the task somewhat formally by writing
- a grammar using Pascal- like syntax diagrams and then write a corresponding
- recursive-descent parser. This worked very well.
- 
-<a name="spirit.preface._emphasis_90s__emphasis_"></a><h3>
-<a name="id398029"></a>
- 90s
- </h3>
-
- The arrival of the Internet and the World Wide Web magnified this thousand-fold.
- At one point Joel had to write an HTML parser for a Web browser project. He
- got a recursive-descent HTML parser working based on the W3C formal specifications
- easily. He was certainly glad that HTML had a formal grammar specification.
- Because of the influence of the Internet, Joel then had to do more parsing.
- RFC specifications were everywhere. SGML, HTML, XML, even email addresses and
- those seemingly trivial URLs were all formally specified using small EBNF-
- style grammar specifications. This made him wish for a tool similar to big-
- time parser generators such as YACC and ANTLR, where a parser is built automatically
- from a grammar specification. Yet, he wants it to be extremely small; small
- enough to fit in my pocket, yet scalable.
- 
-
- It must be able to practically parse simple grammars such as email addresses
- to moderately complex grammars such as XML and perhaps some small to medium-sized
- scripting languages. Scalability is a prime goal. You should be able to use
- it for small tasks such as parsing command lines without incurring a heavy
- payload, as you do when you are using YACC or PCCTS. Even now that it has evolved
- and matured to become a multi-module library, true to its original intent,
- Spirit can still be used for extreme micro-parsing tasks. You only pay for
- features that you need. The power of Spirit comes from its modularity and extensibility.
- Instead of giving you a sledgehammer, it gives you the right ingredients to
- create a sledgehammer easily.
- 
-
- The result was Spirit. Spirit was a personal project that was conceived when
- Joel was doing R&D in Japan. Inspired by the GoF's composite and interpreter
- patterns, he realized that he can model a recursive-descent parser with hierarchical-object
- composition of primitives (terminals) and composites (productions). The original
- version was implemented with run-time polymorphic classes. A parser is generated
- at run time by feeding in production rule strings such as:
- 
-<pre class="programlisting">"prod ::= {'A' | 'B'} 'C';"
-</pre>
-
- A compile function compiled the parser, dynamically creating a hierarchy of
- objects and linking semantic actions on the fly. A very early text can be found
- here: pre-Spirit.
- 
-<a name="spirit.preface._emphasis_2001_to_2006__emphasis_"></a><h3>
-<a name="id353888"></a>
- <a href="index.html#spirit.preface._emphasis_2001_to_2006__emphasis_">2001
- to 2006</a>
- </h3>
-
- Version 1.0 to 1.8 was a complete rewrite of the original Spirit parser using
- expression templates and static polymorphism, inspired by the works of Todd
- Veldhuizen (<a href="http://ubiety.uwaterloo.ca/~tveldhui/papers/Expression-Templates/exprtmpl.html" target="_top">Expression
- Templates</a>, C++ Report, June 1995). Initially, the static-Spirit version
- was meant only to replace the core of the original dynamic-Spirit. Dynamic-spirit
- needed a parser to implement itself anyway. The original employed a hand-coded
- recursive-descent parser to parse the input grammar specification strings.
- Incidentially it was the time, when Hartmut joined the Spirit development.
- 
-
- After its initial "open-source" debut in May 2001, static-Spirit
- became a success. At around November 2001, the Spirit website had an activity
- percentile of 98%, making it the number one parser tool at Source Forge at
- the time. Not bad for such a niche project such as a parser library. The "static"
- portion of Spirit was forgotten and static-Spirit simply became Spirit. The
- library soon evolved to acquire more dynamic features.
- 
-
- Spirit was formally accepted into Boost
- in October 2002. Boost is a peer-reviewed, open collaborative development effort
- that is a collection of free Open Source C++ libraries covering a wide range
- of domains. The Boost Libraries have become widely known as an industry standard
- for design and implementation quality, robustness, and reusability.
- 
-<a name="spirit.preface._emphasis_2007__emphasis_"></a><h3>
-<a name="id355419"></a>
- 2007
- </h3>
-
- Over the years, especially after Spirit was accepted into Boost, Spirit has
- served its purpose quite admirably. The focus of what we'll now call Classic-Spirit (versions prior
- to 2.0) was on transduction parsing where the input string is merely translated
- to an output string. A lot of parsers are of the transduction type. When the
- time came to add attributes to the parser library, it was done rather in an
- ad-hoc manner, with the goal being 100% backward compatible with classic Spirit.
- Some parsers have attributes, some don't.
- 
-
- Spirit V2 is another major rewrite. Spirit V2 grammars are fully attributed
- (see <a href="http://en.wikipedia.org/wiki/Attribute_grammar" target="_top">Attribute
- Grammar</a>). All parser components have attributes. To do this efficiently
- and ellegantly, we had to use a couple of infrastructure libraries. Some of
- which haven't been written yet at the time, some were quite new when Spirit
- debuted, and some needed work. MPL
- is an important infrastructure library, yet is not sufficient to implement
- Spirit V2. Another library had to be written: Fusion.
- Fusion sits between MPL and STL --between compile time and runtime -- mapping
- types to values. Fusion is a direct descendant of both MPL and Boost.Tuples
- (Fusion is now a full fledged Boost
- library). Phoenix also
- had to be beefed up to support Spirit V2. The result is Phoenix2.
- Last but not least, Spirit V2 uses an <a href="http://ubiety.uwaterloo.ca/~tveldhui/papers/Expression-Templates/exprtmpl.html" target="_top">Expression
- Templates</a> library called Boost.Proto.
- 
-<a name="spirit.preface.new_ideas__spirit_v2"></a><h3>
-<a name="id355529"></a>
- New Ideas: Spirit V2
- </h3>
-
- Just before the development of Spirit V2 began, Hartmut came across the StringTemplate library which is
- a part of the ANTLR parser framework. It is a Java template engine (with ports
- for C# and Python) for generating source code, web pages, emails, or any other
- formatted text output. With it, he got the the idea of using a formal notation
- (a grammar) to describe the expected structure of an input character sequence.
- The same grammar may be used to formalize the structure of a corresponding
- output character sequence. This is possible because parsing, most of the time,
- is implemented by comparing the input with the patterns defined by the grammar.
- If we use the same patterns to format a matching output, the generated sequence
- will follow the rules of the grammar as well.
- 
-
- This insight lead to the implementation of a grammar driven output generation
- library compatibile with the Spirit parser library. As it turned out, parsing
- and generation are tightly connected and have very similar concepts. The duality
- of these two sides of the same medal is ubiquitous, which allowed us to build
- the parser library Spirit.Qi and the generator library
- Spirit.Karma using the same component infastructure.
- 
-
- The idea of creating a lexer library well integrated with the Spirit parsers
- is not new. This has been discussed almost for the whole time of the existence
- of Classic-Spirit (pre V2) now. Several attempts to integrate existing lexer
- libraries and frameworks with Spirit have been made and served as a proof of
- concept and usability (for example see Wave:
- The Boost C/C++ Preprocessor Library, and SLex:
- a fully dynamic C++ lexer implemented with Spirit). Based on these experiences
- we added Spirit.Lex: a fully integrated lexer library
- to the mix, allowing to take advantage of the power of regular expressions
- for token matching, removing pressure from the parser components, simplifying
- parser grammars. Again, Spirit's modular structure allowed us to reuse the
- same underlying component library as for the parser and generator libraries.
- 
-<a name="spirit.preface.how_to_use_this_manual"></a><h3>
-<a name="id355599"></a>
- How to use this manual
- </h3>
-
- Each major section (there are 3: Qi, Karma, and Lex)
- is roughly divided into 3 parts:
- 
-<div class="orderedlist"><ol type="1">
-<li>
- Tutorials: A step by step guide with heavily annotated code. These are meant
- to get the user acquainted with the library as quickly as possible. The objective
- is to build the confidence of the user in using the library using abundant
- examples and detailed instructions. Examples speak volumes.
- </li>
-<li>
- Abstracts: A high level summary of key topics. The objective is to give the
- user a high level view of the library, the key concepts, background and theories.
- </li>
-<li>
- Reference: Detailed formal technical reference. We start with a quick reference
- -- an easy to use table that maps into the reference proper. The reference
- proper starts with C++ Concepts
- followed by models of the concepts.
- </li>
-</ol></div>
-
- Some icons are used to mark certain topics indicative of their relevance. These
- icons precede some text to indicate:
- 
-<div class="table">
-<a name="id355670"></a>Table 1. Icons
-<table class="table" summary="Icons">
-<colgroup>
-<col>
-<col>
-<col>
-</colgroup>
-<thead><tr>
-<th>
- Icon
- </th>
-<th>
- Name
- </th>
-<th>
- Meaning
- </th>
-</tr></thead>
-<tbody>
-<tr>
-<td>
- <img src="images/note.png" alt="note">
- </td>
-<td>
- Note
- </td>
-<td>
- Generally useful information (an aside that doesn't fit in the flow of
- the text)
- </td>
-</tr>
-<tr>
-<td>
- <img src="images/tip.png" alt="tip">
- </td>
-<td>
- Tip
- </td>
-<td>
- Suggestion on how to do something (especially something that not be obvious)
- </td>
-</tr>
-<tr>
-<td>
- <img src="images/important.png" alt="important">
- </td>
-<td>
- Important
- </td>
-<td>
- Important note on something to take particular notice of
- </td>
-</tr>
-<tr>
-<td>
- <img src="images/caution.png" alt="caution">
- </td>
-<td>
- Caution
- </td>
-<td>
- Take special care with this - it may not be what you expect and may cause
- bad results
- </td>
-</tr>
-<tr>
-<td>
- <img src="images/alert.png" alt="alert">
- </td>
-<td>
- Danger
- </td>
-<td>
- This is likely to cause serious trouble if ignored
- </td>
-</tr>
-</tbody>
-</table>
-</div>
-
- This documentation is automatically generated by Boost QuickBook documentation
- tool. QuickBook can be found in the <a href="http://www.boost.org/tools/index.html" target="_top">Boost
- Tools</a>.
- 
-<a name="spirit.preface.support"></a><h3>
-<a name="id353462"></a>
- Support
- </h3>
-
- Please direct all questions to Spirit's mailing list. You can subscribe to
- the <a href="http://www.nabble.com/The-Spirit-Parser-Library-f3430.html" target="_top">Spirit
- General List</a>. The mailing list has a searchable archive. A search link
- to this archive is provided in Spirit's
- home page. You may also read and post messages to the mailing list through
- <a href="news://news.gmane.org/gmane.comp.spirit.general" target="_top">Spirit General
- NNTP news portal</a> (thanks to Gmane).
- The news group mirrors the mailing list. Here is a link to the archives: http://news.gmane.org/gmane.comp.parsers.spirit.general.
- 
-</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left">Last revised: June 16, 2009 at 03:57:03 GMT</td>
+<td align="left">Last revised: June 17, 2009 at 02:54:49 GMT</td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>
-<div class="spirit-nav"><a accesskey="n" href="spirit/what_s_new.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a></div>
+<div class="spirit-nav"><a accesskey="n" href="spirit/preface.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a></div>
</body>
</html>

Modified: trunk/libs/spirit/doc/html/spirit/abstracts.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/abstracts.html (original)
+++ trunk/libs/spirit/doc/html/spirit/abstracts.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -6,9 +6,8 @@
<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
<link rel="home" href="../index.html" title="Spirit 2.1">
<link rel="up" href="../index.html" title="Spirit 2.1">
-<link rel="previous" href="structure.html" title="Structure">
-<link rel="next" href="abstracts/parsing_expression_grammar.html" title="Parsing
- Expression Grammar">
+<link rel="previous" href="structure/include.html" title="Include">
+<link rel="next" href="abstracts/syntax_diagram.html" title="Syntax Diagram">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
@@ -21,7 +20,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="structure.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="abstracts/parsing_expression_grammar.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="structure/include.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="abstracts/syntax_diagram.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage">
@@ -31,204 +30,10 @@
<div></div>
</div>
<div class="toc"><dl>
-<dt>Syntax Diagram</dt>
+<dt>Syntax Diagram</dt>
<dt><a href="abstracts/parsing_expression_grammar.html">Parsing
Expression Grammar</a></dt>
</dl></div>
-<div class="section" lang="en">
-<div class="titlepage">
-<div><div><h3 class="title">
-<a name="spirit.abstracts.syntax_diagram"></a>Syntax Diagram
-</h3></div></div>
-<div></div>
-</div>
-
- In the following section, we will deal with Parsing Expression Grammars (PEG),
- a variant of Extended Backus-Naur Form (EBNF) with a different interpretation.
- It is easier to understand PEG using Syntax Diagrams. Syntax diagrams represent
- a grammar graphically. It was used extensibly by Niklaus Wirth
- [<a name="id414442" href="#ftn.id414442">1</a>]
- in the "Pascal User Manual". Syntax Diagrams are easily understandable
- with programmers due to its similarity to flow charts. Also, the one to one
- mapping between the diagrams and functions make it ideal for representing
- [Recursive Descent parsers.
- 
-<a name="spirit.abstracts.syntax_diagram.elements"></a><h4>
-<a name="id414460"></a>
- Elements
- </h4>
-
- All diagrams have one entry and exit point. Arrows connect all possible paths
- through the grammar from the entry point to the exit point.
- 
-<div class="blockquote"><blockquote class="blockquote">
-
- 
-
- <img src="../images/start_stop.png" alt="start_stop">
- 
-
- 
-</blockquote></div>
-
- Terminals are represented by round boxes. Terminals are atomic and usually
- represent plain characters, strings or tokens.
- 
-<div class="blockquote"><blockquote class="blockquote">
-
- 
-
- <img src="../images/terminal.png" alt="terminal">
- 
-
- 
-</blockquote></div>
-
- Non-terminals are represented by boxes. Diagrams are modularized using named
- non-terminals. A complex diagram can be broken down into a set of non-terminals.
- Non-terminals also allow recursion (i.e. a non-terminal can call itself).
- 
-<div class="blockquote"><blockquote class="blockquote">
-
- 
-
- <img src="../images/non-terminal.png" alt="non-terminal">
- 
-
- 
-</blockquote></div>
-<a name="spirit.abstracts.syntax_diagram.constructs"></a><h4>
-<a name="id414579"></a>
- Constructs
- </h4>
-
- The most basic composition is the Sequence. B follows A:
- 
-<div class="blockquote"><blockquote class="blockquote">
-
- 
-
- <img src="../images/sequence.png" alt="sequence">
- 
-
- 
-</blockquote></div>
-
- The ordered choice, hencforth we will call alternatives. In PEG, ordered
- choice and alternatives are not quite the same. PEG allows ambiguity of choice
- where one ore more branches can succeed. In PEG, in case of ambiguity, the
- first one always wins.
- 
-<div class="blockquote"><blockquote class="blockquote">
-
- 
-
- <img src="../images/alternative.png" alt="alternative">
- 
-
- 
-</blockquote></div>
-
- The optional (zero-or-one):
- 
-<div class="blockquote"><blockquote class="blockquote">
-
- 
-
- <img src="../images/optional.png" alt="optional">
- 
-
- 
-</blockquote></div>
-
- Now, the loops. We have the zero-or-more and one-or-more:
- 
-<div class="blockquote"><blockquote class="blockquote">
-
- 
-
- <img src="../images/kleene.png" alt="kleene">
- 
-
- 
-</blockquote></div>
-<div class="blockquote"><blockquote class="blockquote">
-
- 
-
- <img src="../images/plus.png" alt="plus">
- 
-
- 
-</blockquote></div>
-
- Take note that, as in PEG, these behave greedily. If there is another 'A'
- just before the end-point, it will always fail because the preceding loop
- has already exhausted all the 'A's and there is nothing more to get. This
- is a crucial difference between PEG and general Context Free Grammars (PEGs).
- This behavior is quite obvious with syntax diagrams as they resemble flow-charts.
- 
-<a name="spirit.abstracts.syntax_diagram.predicates"></a><h4>
-<a name="id414757"></a>
- Predicates
- </h4>
-
- Now, the following are Syntax Diagram versions PEG predicates. While these
- are not really included in usual Syntax Diagrams, we have it here to closely
- follow PEGs.
- 
-
- First, we introduce a new element, the Predicate:
- 
-<div class="blockquote"><blockquote class="blockquote">
-
- 
-
- <img src="../images/predicate.png" alt="predicate">
- 
-
- 
-</blockquote></div>
-
- This is similar to the conditionals in flow charts where the 'No' branch
- is absent and always signals a failed parse.
- 
-
- We have two versions of the predicate, the And-Predicate
- and the Not-Predicate:
- 
-<div class="blockquote"><blockquote class="blockquote">
-
- 
-
- <img src="../images/and_predicate.png" alt="and_predicate">
- 
-
- 
-</blockquote></div>
-<div class="blockquote"><blockquote class="blockquote">
-
- 
-
- <img src="../images/not_predicate.png" alt="not_predicate">
- 
-
- 
-</blockquote></div>
-
- The And-Predicate tries the predicate, P, and succeeds
- if P succeeds, or otherwise fail. The opposite is true with the Not-Predicate.
- It tries the predicate, P, and fails if P succeeds, or otherwise succeeds.
- Both versions do a look-ahead but do not consume any input regardless if
- P succeeds or not.
- 
-</div>
-<div class="footnotes">
- <hr width="100" align="left">
-<div class="footnote">[<a name="ftn.id414442" href="#id414442">1</a>] 
- Niklaus Wirth: The Programming Language Pascal. (July 1973)
- </div>
-</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
@@ -241,7 +46,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="structure.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="abstracts/parsing_expression_grammar.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="structure/include.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="abstracts/syntax_diagram.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>

Modified: trunk/libs/spirit/doc/html/spirit/abstracts/parsing_expression_grammar.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/abstracts/parsing_expression_grammar.html (original)
+++ trunk/libs/spirit/doc/html/spirit/abstracts/parsing_expression_grammar.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -7,7 +7,7 @@
<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
<link rel="home" href="../../index.html" title="Spirit 2.1">
<link rel="up" href="../abstracts.html" title="Abstracts">
-<link rel="previous" href="../abstracts.html" title="Abstracts">
+<link rel="previous" href="syntax_diagram.html" title="Syntax Diagram">
<link rel="next" href="../qi.html" title=" Qi">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@@ -21,7 +21,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../abstracts.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../abstracts.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../qi.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="syntax_diagram.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../abstracts.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../qi.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage">
@@ -45,7 +45,7 @@
 [Abstract Syntax Tree) for each PEG grammar.
 
<a name="spirit.abstracts.parsing_expression_grammar.sequences"></a><h4>
-<a name="id414933"></a>
+<a name="id414932"></a>
 <a href="parsing_expression_grammar.html#spirit.abstracts.parsing_expression_grammar.sequences">Sequences</a>
 </h4>

@@ -55,6 +55,18 @@
</pre>

 The PEG expression above states that, in order for this to succeed, <tt class="computeroutput">a</tt> must follow <tt class="computeroutput">b</tt>.
+ Here's the syntax diagram:
+ 
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ <img src="../../images/sequence.png" alt="sequence">
+ 
+
+ 
+</blockquote></div>
+
 Here's a trivial example:
 
<pre class="programlisting">'x' digit
@@ -74,7 +86,7 @@
 </td></tr>
</table></div>
<a name="spirit.abstracts.parsing_expression_grammar.alternatives"></a><h4>
-<a name="id415052"></a>
+<a name="id415082"></a>
 <a href="parsing_expression_grammar.html#spirit.abstracts.parsing_expression_grammar.alternatives">Alternatives</a>
 </h4>

@@ -98,7 +110,17 @@
 succeeds, success, if not try to match <tt class="computeroutput">b</tt>.
 This is a bit of a deviation from the usual EBNF interpretation where you
 simply match <tt class="computeroutput">a</tt> or <tt class="computeroutput">b</tt>.
+ Here's the syntax diagram:
 
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ <img src="../../images/alternative.png" alt="alternative">
+ 
+
+ 
+</blockquote></div>

 PEGs allow for ambiguity in the alternatives. In the expression above, both
 <tt class="computeroutput">a</tt> or <tt class="computeroutput">b</tt>
@@ -107,7 +129,7 @@
 about this $$$).
 
<a name="spirit.abstracts.parsing_expression_grammar.loops"></a><h4>
-<a name="id415210"></a>
+<a name="id415268"></a>
 <a href="parsing_expression_grammar.html#spirit.abstracts.parsing_expression_grammar.loops">Loops</a>
 </h4>

@@ -128,6 +150,27 @@
 </td></tr>
</table></div>

+ Here are the syntax diagrams:
+ 
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ <img src="../../images/kleene.png" alt="kleene">
+ 
+
+ 
+</blockquote></div>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ <img src="../../images/plus.png" alt="plus">
+ 
+
+ 
+</blockquote></div>
+
 The first, called the Kleene star, matches zero or more of its subject <tt class="computeroutput">a</tt>. The second, plus, matches one ore more
 of its subject <tt class="computeroutput">a</tt>.
 
@@ -149,7 +192,7 @@
 We will see more of these other mechanisms shortly.
 
<a name="spirit.abstracts.parsing_expression_grammar.difference"></a><h4>
-<a name="id415330"></a>
+<a name="id415445"></a>
 <a href="parsing_expression_grammar.html#spirit.abstracts.parsing_expression_grammar.difference">Difference</a>
 </h4>

@@ -175,7 +218,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../abstracts.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../abstracts.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../qi.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="syntax_diagram.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../abstracts.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../qi.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>

Added: trunk/libs/spirit/doc/html/spirit/abstracts/syntax_diagram.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/abstracts/syntax_diagram.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -0,0 +1,234 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Syntax Diagram</title>
+<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
+<link rel="home" href="../../index.html" title="Spirit 2.1">
+<link rel="up" href="../abstracts.html" title="Abstracts">
+<link rel="previous" href="../abstracts.html" title="Abstracts">
+<link rel="next" href="parsing_expression_grammar.html" title="Parsing
+ Expression Grammar">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../abstracts.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../abstracts.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="parsing_expression_grammar.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h3 class="title">
+<a name="spirit.abstracts.syntax_diagram"></a>Syntax Diagram
+</h3></div></div>
+<div></div>
+</div>
+
+ In the next section, we will deal with Parsing Expression Grammars (PEG),
+ a variant of Extended Backus-Naur Form (EBNF) with a different interpretation.
+ It is easier to understand PEG using Syntax Diagrams. Syntax diagrams represent
+ a grammar graphically. It was used extensibly by Niklaus Wirth
+ [<a name="id414434" href="#ftn.id414434">1</a>]
+ in the "Pascal User Manual". Syntax Diagrams are easily understandable
+ with programmers due to its similarity to flow charts. The isomorphism of
+ the diagrams and functions make it ideal for representing [Recursive Descent
+ parsers which are essentially mutually recursive functions.
+ 
+<a name="spirit.abstracts.syntax_diagram.elements"></a><h4>
+<a name="id414452"></a>
+ Elements
+ </h4>
+
+ All diagrams have one entry and exit point. Arrows connect all possible paths
+ through the grammar from the entry point to the exit point.
+ 
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ <img src="../../images/start_stop.png" alt="start_stop">
+ 
+
+ 
+</blockquote></div>
+
+ Terminals are represented by round boxes. Terminals are atomic and usually
+ represent plain characters, strings or tokens.
+ 
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ <img src="../../images/terminal.png" alt="terminal">
+ 
+
+ 
+</blockquote></div>
+
+ Non-terminals are represented by boxes. Diagrams are modularized using named
+ non-terminals. A complex diagram can be broken down into a set of non-terminals.
+ Non-terminals also allow recursion (i.e. a non-terminal can call itself).
+ 
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ <img src="../../images/non-terminal.png" alt="non-terminal">
+ 
+
+ 
+</blockquote></div>
+<a name="spirit.abstracts.syntax_diagram.constructs"></a><h4>
+<a name="id414572"></a>
+ Constructs
+ </h4>
+
+ The most basic composition is the Sequence. B follows A:
+ 
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ <img src="../../images/sequence.png" alt="sequence">
+ 
+
+ 
+</blockquote></div>
+
+ The ordered choice, henceforth we will call alternatives.
+ In PEG, ordered choice and alternatives are not quite the same. PEG allows
+ ambiguity of choice where one or more branches can succeed. In PEG, in case
+ of ambiguity, the first one always wins.
+ 
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ <img src="../../images/alternative.png" alt="alternative">
+ 
+
+ 
+</blockquote></div>
+
+ The optional (zero-or-one):
+ 
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ <img src="../../images/optional.png" alt="optional">
+ 
+
+ 
+</blockquote></div>
+
+ Now, the loops. We have the zero-or-more and one-or-more:
+ 
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ <img src="../../images/kleene.png" alt="kleene">
+ 
+
+ 
+</blockquote></div>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ <img src="../../images/plus.png" alt="plus">
+ 
+
+ 
+</blockquote></div>
+
+ Take note that, as in PEG, these loops behave greedily. If there is another
+ 'A' just before the end-point, it will always fail because the preceding
+ loop has already exhausted all 'A's and there is nothing more left. This
+ is a crucial difference between PEG and general Context Free Grammars (CFGs).
+ This behavior is quite obvious with syntax diagrams as they resemble flow-charts.
+ 
+<a name="spirit.abstracts.syntax_diagram.predicates"></a><h4>
+<a name="id414755"></a>
+ Predicates
+ </h4>
+
+ Now, the following are Syntax Diagram versions of PEG predicates. These are
+ not traditionally found in Syntax Diagrams. These are special extensions
+ we invented to closely follow PEGs.
+ 
+
+ First, we introduce a new element, the Predicate:
+ 
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ <img src="../../images/predicate.png" alt="predicate">
+ 
+
+ 
+</blockquote></div>
+
+ This is similar to the conditionals in flow charts where the 'No' branch
+ is absent and always signals a failed parse.
+ 
+
+ We have two versions of the predicate, the And-Predicate
+ and the Not-Predicate:
+ 
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ <img src="../../images/and_predicate.png" alt="and_predicate">
+ 
+
+ 
+</blockquote></div>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ <img src="../../images/not_predicate.png" alt="not_predicate">
+ 
+
+ 
+</blockquote></div>
+
+ The And-Predicate tries the predicate, P, and succeeds
+ if P succeeds, or otherwise fail. The opposite is true with the Not-Predicate.
+ It tries the predicate, P, and fails if P succeeds, or otherwise succeeds.
+ Both versions do a look-ahead but do not consume any input regardless if
+ P succeeds or not.
+ 
+<div class="footnotes">
+ <hr width="100" align="left">
+<div class="footnote">[<a name="ftn.id414434" href="#id414434">1</a>] 
+ Niklaus Wirth: The Programming Language Pascal. (July 1973)
+ </div>
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2001-2009 Joel
+ de Guzman, 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../abstracts.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../abstracts.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="parsing_expression_grammar.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Modified: trunk/libs/spirit/doc/html/spirit/acknowledgments.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/acknowledgments.html (original)
+++ trunk/libs/spirit/doc/html/spirit/acknowledgments.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -6,7 +6,7 @@
<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
<link rel="home" href="../index.html" title="Spirit 2.1">
<link rel="up" href="../index.html" title="Spirit 2.1">
-<link rel="previous" href="notes.html" title="Notes">
+<link rel="previous" href="notes/style_guide.html" title="Style Guide">
<link rel="next" href="references.html" title="References">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@@ -20,7 +20,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="notes.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="references.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="notes/style_guide.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="references.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage">
@@ -50,7 +50,7 @@
 FIXME: Add more people
 
<a name="spirit.acknowledgments.acknowledgements_from_the_spirit_v1__emphasis_classic__emphasis__documentation"></a><h3>
-<a name="id487188"></a>
+<a name="id487336"></a>
 <a href="acknowledgments.html#spirit.acknowledgments.acknowledgements_from_the_spirit_v1__emphasis_classic__emphasis__documentation">Acknowledgements
 from the Spirit V1 classic Documentation</a>
 </h3>
@@ -237,7 +237,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="notes.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="references.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="notes/style_guide.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="references.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>

Modified: trunk/libs/spirit/doc/html/spirit/faq.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/faq.html (original)
+++ trunk/libs/spirit/doc/html/spirit/faq.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -30,7 +30,7 @@
<div></div>
</div>
<a name="spirit.faq.i_m_very_confused_about_the_header_hell_in_my_boost_spirit_directory__what_s_all_this_about_"></a><h3>
-<a name="id485631"></a>
+<a name="id485771"></a>
 <a href="faq.html#spirit.faq.i_m_very_confused_about_the_header_hell_in_my_boost_spirit_directory__what_s_all_this_about_">I'm
 very confused about the header hell in my boost/spirit directory. What's all
 this about?</a>

Modified: trunk/libs/spirit/doc/html/spirit/introduction.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/introduction.html (original)
+++ trunk/libs/spirit/doc/html/spirit/introduction.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -137,7 +137,7 @@

 
<a name="spirit.introduction.a_quick_overview_of_parsing_with__emphasis_spirit_qi__emphasis_"></a><h3>
-<a name="id411298"></a>
+<a name="id411290"></a>
 <a href="introduction.html#spirit.introduction.a_quick_overview_of_parsing_with__emphasis_spirit_qi__emphasis_">A
 Quick Overview of Parsing with Spirit.Qi</a>
 </h3>
@@ -227,7 +227,7 @@
 <tt class="computeroutput">;</tt>.
 
<a name="spirit.introduction.a_quick_overview_of_output_generation_with__emphasis_spirit_karma__emphasis_"></a><h3>
-<a name="id412505"></a>
+<a name="id412498"></a>
 <a href="introduction.html#spirit.introduction.a_quick_overview_of_output_generation_with__emphasis_spirit_karma__emphasis_">A
 Quick Overview of Output Generation with Spirit.Karma</a>
 </h3>
@@ -260,7 +260,7 @@
 of the same <tt class="computeroutput">std::vector<int></tt>:
 
<div class="table">
-<a name="id412942"></a>Table 2. Different output formats for `std::vector<int>`
+<a name="id412935"></a>Table 2. Different output formats for `std::vector<int>`
<table class="table" summary="Different output formats for `std::vector<int>`">
<colgroup>
<col>
@@ -345,7 +345,7 @@
 next table gives some related examples.
 
<div class="table">
-<a name="id413388"></a>Table 3. Different data types usable with the output format
+<a name="id413381"></a>Table 3. Different data types usable with the output format
 `*(int_ << eol)`
<table class="table" summary="Different data types usable with the output format
 `*(int_ << eol)`">

Modified: trunk/libs/spirit/doc/html/spirit/karma.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/karma.html (original)
+++ trunk/libs/spirit/doc/html/spirit/karma.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -7,7 +7,7 @@
<link rel="home" href="../index.html" title="Spirit 2.1">
<link rel="up" href="../index.html" title="Spirit 2.1">
<link rel="previous" href="qi/quick_reference/phoenix.html" title="Phoenix">
-<link rel="next" href="lex.html" title=" Spirit.Lex">
+<link rel="next" href="karma/quick_reference.html" title="Quick Reference">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
@@ -20,7 +20,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="qi/quick_reference/phoenix.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="lex.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="qi/quick_reference/phoenix.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="karma/quick_reference.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage">
@@ -30,1494 +30,21 @@
<div></div>
</div>
<div class="toc"><dl>
-<dt>Quick Reference</dt>
+<dt>Quick Reference</dt>
<dd><dl>
-<dt><a href="karma.html#spirit.karma.quick_reference.common_notation">Common
+<dt><a href="karma/quick_reference/common_notation.html">Common
 Notation</a></dt>
-<dt><a href="karma.html#spirit.karma.quick_reference.predefined_primitive_generators">Predefined
+<dt><a href="karma/quick_reference/predefined_primitive_generators.html">Predefined
 Primitive Generators</a></dt>
-<dt><a href="karma.html#spirit.karma.quick_reference.compound_attribute_rules">Compound
+<dt><a href="karma/quick_reference/compound_attribute_rules.html">Compound
 Attribute Rules</a></dt>
-<dt>Lazy Arguments</dt>
-<dt>Non-terminals</dt>
-<dt><a href="karma.html#spirit.karma.quick_reference.semantic_actions">Semantic
+<dt>Lazy Arguments</dt>
+<dt>Non-terminals</dt>
+<dt><a href="karma/quick_reference/semantic_actions.html">Semantic
 Actions</a></dt>
-<dt>Phoenix</dt>
+<dt>Phoenix</dt>
</dl></dd>
</dl></div>
-<div class="section" lang="en">
-<div class="titlepage">
-<div><div><h3 class="title">
-<a name="spirit.karma.quick_reference"></a>Quick Reference
-</h3></div></div>
-<div></div>
-</div>
-<div class="toc"><dl>
-<dt><a href="karma.html#spirit.karma.quick_reference.common_notation">Common
- Notation</a></dt>
-<dt><a href="karma.html#spirit.karma.quick_reference.predefined_primitive_generators">Predefined
- Primitive Generators</a></dt>
-<dt><a href="karma.html#spirit.karma.quick_reference.compound_attribute_rules">Compound
- Attribute Rules</a></dt>
-<dt>Lazy Arguments</dt>
-<dt>Non-terminals</dt>
-<dt><a href="karma.html#spirit.karma.quick_reference.semantic_actions">Semantic
- Actions</a></dt>
-<dt>Phoenix</dt>
-</dl></div>
-
- This quick reference section is provided for convenience. You can use this
- section as a sort of a "cheat-sheet" on the most commonly used
- Karma components. It is not intended to be complete, but should give you
- an easy way to recall a particular component without having to dig up on
- pages and pages of reference doumentation.
- 
-<div class="section" lang="en">
-<div class="titlepage">
-<div><div><h4 class="title">
-<a name="spirit.karma.quick_reference.common_notation"></a><a href="karma.html#spirit.karma.quick_reference.common_notation" title="Common
- Notation">Common
- Notation</a>
-</h4></div></div>
-<div></div>
-</div>
-<div class="variablelist">
-Notation
-<dl>
-<dt><tt class="computeroutput">P</tt></dt>
-<dd>
- Parser type
- </dd>
-<dt><tt class="computeroutput">p, a,
- b,
- c</tt></dt>
-<dd>
- Parser objects
- </dd>
-<dt><tt class="computeroutput">A, B,
- C</tt></dt>
-<dd>
- Attribute types of parsers A, B and C
- </dd>
-<dt><tt class="computeroutput">I</tt></dt>
-<dd>
- The iterator type used for parsing
- </dd>
-<dt><tt class="computeroutput">Unused</tt></dt>
-<dd>
- An <tt class="computeroutput">unused_type</tt>
- </dd>
-<dt><tt class="computeroutput">Context</tt></dt>
-<dd>
- The enclosing rule's <tt class="computeroutput">Context</tt>
- type
- </dd>
-<dt><tt class="computeroutput">Attr</tt></dt>
-<dd>
- An attribute type
- </dd>
-<dt><tt class="computeroutput">b</tt></dt>
-<dd>
- A boolean expression
- </dd>
-<dt><tt class="computeroutput">fp</tt></dt>
-<dd>
- A (lazy parser) function with signature <tt class="computeroutput">P(Unused, Context)</tt>
- </dd>
-<dt><tt class="computeroutput">fa</tt></dt>
-<dd>
- A (semantic action) function with signature <tt class="computeroutput">void(Attr, Context, bool&)</tt>. The third parameter is a boolean
- flag that can be set to false to force the parse to fail. Both <tt class="computeroutput">Context</tt> and the boolean flag are
- optional.
- </dd>
-<dt><tt class="computeroutput">first</tt></dt>
-<dd>
- An iterator pointing to the start of input
- </dd>
-<dt><tt class="computeroutput">last</tt></dt>
-<dd>
- An iterator pointing to the end of input
- </dd>
-<dt><tt class="computeroutput">Ch</tt></dt>
-<dd>
- Character-class specific character type (See __char_classtypes_)
- </dd>
-<dt><tt class="computeroutput">ch</tt></dt>
-<dd>
- Character-class specific character (See __char_classtypes_)
- </dd>
-<dt><tt class="computeroutput">ch2</tt></dt>
-<dd>
- Character-class specific character (See __char_classtypes_)
- </dd>
-<dt><tt class="computeroutput">chset</tt></dt>
-<dd>
- Character-set specifier string (example: "a-z0-9")
- </dd>
-<dt><tt class="computeroutput">str</tt></dt>
-<dd>
- Character-class specific string (See __char_classtypes_)
- </dd>
-<dt><tt class="computeroutput">Str</tt></dt>
-<dd>
- Attribute of <tt class="computeroutput">str</tt>:
- <tt class="computeroutput">std::basic_string<T></tt>
- where <tt class="computeroutput">T</tt> is the underlying
- character type of <tt class="computeroutput">str</tt>
- </dd>
-<dt><tt class="computeroutput">tuple<></tt></dt>
-<dd>
- Used as a placeholder for a fusion sequence
- </dd>
-<dt><tt class="computeroutput">vector<></tt></dt>
-<dd>
- Used as a placeholder for an STL container
- </dd>
-<dt><tt class="computeroutput">variant<></tt></dt>
-<dd>
- Used as a placeholder for a boost::variant
- </dd>
-<dt><tt class="computeroutput">optional<></tt></dt>
-<dd>
- Used as a placeholder for a boost::optional
- </dd>
-</dl>
-</div>
-</div>
-<div class="section" lang="en">
-<div class="titlepage">
-<div><div><h4 class="title">
-<a name="spirit.karma.quick_reference.predefined_primitive_generators"></a><a href="karma.html#spirit.karma.quick_reference.predefined_primitive_generators" title="Predefined
- Primitive Generators">Predefined
- Primitive Generators</a>
-</h4></div></div>
-<div></div>
-</div>
-<div class="informaltable"><table class="table">
-<colgroup>
-<col>
-<col>
-<col>
-</colgroup>
-<thead><tr>
-<th>
- Expression
- </th>
-<th>
- Attribute
- </th>
-<th>
- Description
- </th>
-</tr></thead>
-<tbody>
-<tr>
-<td>
- <tt class="computeroutput">eol</tt>
- </td>
-<td>
- <tt class="computeroutput">Unused</tt>
- </td>
-<td>
- Generates the end of line (<tt class="computeroutput">\n</tt>)
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">eps</tt>
- </td>
-<td>
- <tt class="computeroutput">Unused</tt>
- </td>
-<td>
- Generate an empty string
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">eps(b)</tt>
- </td>
-<td>
- <tt class="computeroutput">Unused</tt>
- </td>
-<td>
- If <tt class="computeroutput">b</tt> is true, generate
- an empty string
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">lazy(fg)</tt>
- </td>
-<td>
- Attribute of <tt class="computeroutput">G</tt>
- where <tt class="computeroutput">G</tt> is the
- return type of <tt class="computeroutput">fg</tt>
- </td>
-<td>
- Invoke <tt class="computeroutput">fg</tt> at generation
- time, returning a generator <tt class="computeroutput">g</tt>
- which is then called to generate.
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">fg</tt>
- </td>
-<td>
- see <tt class="computeroutput">lazy(fg)</tt>
- above
- </td>
-<td>
- Equivalent to <tt class="computeroutput">lazy[fp]</tt>
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">g[fa]</tt>
- </td>
-<td>
- Attribute of <tt class="computeroutput">g</tt>
- </td>
-<td>
- Call semantic action <tt class="computeroutput">fa</tt>
- (before executing <tt class="computeroutput">g</tt>).
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">byte_</tt>
- </td>
-<td>
- 8 bits native endian
- </td>
-<td>
- Generates an 8 bit binary
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">word</tt>
- </td>
-<td>
- 16 bits native endian
- </td>
-<td>
- Generates a 16 bit binary
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">big_word</tt>
- </td>
-<td>
- 16 bits big endian
- </td>
-<td>
- Generates a 16 bit binary
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">little_word</tt>
- </td>
-<td>
- 16 bits little endian
- </td>
-<td>
- Generates a 16 bit binary
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">dword</tt>
- </td>
-<td>
- 32 bits native endian
- </td>
-<td>
- Generates a 32 bit binary
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">big_dword</tt>
- </td>
-<td>
- 32 bits big endian
- </td>
-<td>
- Generates a 32 bit binary
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">little_dword</tt>
- </td>
-<td>
- 32 bits little endian
- </td>
-<td>
- Generates a 32 bit binary
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">qword</tt>
- </td>
-<td>
- 64 bits native endian
- </td>
-<td>
- Generates a 64 bit binary
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">big_qword</tt>
- </td>
-<td>
- 64 bits big endian
- </td>
-<td>
- Generates a 64 bit binary
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">little_qword</tt>
- </td>
-<td>
- 64 bits little endian
- </td>
-<td>
- Generates a 64 bit binary
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">char_(ch)</tt>
- </td>
-<td>
- <tt class="computeroutput">Ch</tt>
- </td>
-<td>
- Generates <tt class="computeroutput">ch</tt>
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">char_("c")</tt>
- </td>
-<td>
- <tt class="computeroutput">Ch</tt>
- </td>
-<td>
- Generates a single char string literal, <tt class="computeroutput">c</tt>
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">ch</tt>
- </td>
-<td>
- <tt class="computeroutput">Unused</tt>
- </td>
-<td>
- Generates <tt class="computeroutput">ch</tt>
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">str</tt>
- </td>
-<td>
- <tt class="computeroutput">Unused</tt>
- </td>
-<td>
- Generates <tt class="computeroutput">str</tt>
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">lit(ch)</tt>
- </td>
-<td>
- <tt class="computeroutput">Unused</tt>
- </td>
-<td>
- Generates <tt class="computeroutput">ch</tt>
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">lit(str)</tt>
- </td>
-<td>
- <tt class="computeroutput">Unused</tt>
- </td>
-<td>
- Generates <tt class="computeroutput">str</tt>
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">string(str)</tt>
- </td>
-<td>
- <tt class="computeroutput">Str</tt>
- </td>
-<td>
- Generates <tt class="computeroutput">str</tt>
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">lower[a]</tt>
- </td>
-<td>
- <tt class="computeroutput">A</tt>
- </td>
-<td>
- Generate <tt class="computeroutput">a</tt> as lower
- case
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">upper[a]</tt>
- </td>
-<td>
- <tt class="computeroutput">A</tt>
- </td>
-<td>
- Generate <tt class="computeroutput">a</tt> as upper
- case
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">left_align[a]</tt>
- </td>
-<td>
- <tt class="computeroutput">A</tt>
- </td>
-<td>
- Generate <tt class="computeroutput">a</tt> left
- aligned in column of width BOOST_KARMA_DEFAULT_FIELD_LENGTH
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">left_align(N)[a]</tt>
- </td>
-<td>
- <tt class="computeroutput">A</tt>
- </td>
-<td>
- Generate <tt class="computeroutput">a</tt> left
- aligned in column of width <tt class="computeroutput">N</tt>
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">left_align(N,
- g)[a]</tt>
- </td>
-<td>
- <tt class="computeroutput">A</tt>
- </td>
-<td>
- Generate <tt class="computeroutput">a</tt> left
- aligned in column of width <tt class="computeroutput">N</tt>
- while using <tt class="computeroutput">g</tt> to
- generate the necesssary padding
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">right_align[a]</tt>
- </td>
-<td>
- <tt class="computeroutput">A</tt>
- </td>
-<td>
- Generate <tt class="computeroutput">a</tt> right
- aligned in column of width BOOST_KARMA_DEFAULT_FIELD_LENGTH
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">right_align(N)[a]</tt>
- </td>
-<td>
- <tt class="computeroutput">A</tt>
- </td>
-<td>
- Generate <tt class="computeroutput">a</tt> right
- aligned in column of width <tt class="computeroutput">N</tt>
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">right_align(N,
- g)[a]</tt>
- </td>
-<td>
- <tt class="computeroutput">A</tt>
- </td>
-<td>
- Generate <tt class="computeroutput">a</tt> right
- aligned in column of width <tt class="computeroutput">N</tt>
- while using <tt class="computeroutput">g</tt> to
- generate the necesssary padding
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">center[a]</tt>
- </td>
-<td>
- <tt class="computeroutput">A</tt>
- </td>
-<td>
- Generate <tt class="computeroutput">a</tt> centered
- in column of width BOOST_KARMA_DEFAULT_FIELD_LENGTH
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">center(N)[a]</tt>
- </td>
-<td>
- <tt class="computeroutput">A</tt>
- </td>
-<td>
- Generate <tt class="computeroutput">a</tt> centered
- in column of width <tt class="computeroutput">N</tt>
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">center(N,
- g)[a]</tt>
- </td>
-<td>
- <tt class="computeroutput">A</tt>
- </td>
-<td>
- Generate <tt class="computeroutput">a</tt> centered
- in column of width <tt class="computeroutput">N</tt>
- while using <tt class="computeroutput">g</tt> to
- generate the necesssary padding
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">maxwidth[a]</tt>
- </td>
-<td>
- <tt class="computeroutput">A</tt>
- </td>
-<td>
- Generate <tt class="computeroutput">a</tt> truncated
- to column of width BOOST_KARMA_DEFAULT_FIELD_MAXWIDTH
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">maxwidth(N)[a]</tt>
- </td>
-<td>
- <tt class="computeroutput">A</tt>
- </td>
-<td>
- Generate <tt class="computeroutput">a</tt> truncated
- to column of width <tt class="computeroutput">N</tt>
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">repeat[a]</tt>
- </td>
-<td>
- <tt class="computeroutput">vector<A></tt>
- </td>
-<td>
- Repeat <tt class="computeroutput">a</tt> zero or
- more times
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">repeat(N)[a]</tt>
- </td>
-<td>
- <tt class="computeroutput">vector<A></tt>
- </td>
-<td>
- Repeat <tt class="computeroutput">a</tt> <tt class="computeroutput">N</tt> times
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">repeat(N,
- M)[a]</tt>
- </td>
-<td>
- <tt class="computeroutput">vector<A></tt>
- </td>
-<td>
- Repeat <tt class="computeroutput">a</tt> <tt class="computeroutput">N</tt> to <tt class="computeroutput">M</tt>
- times
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">repeat(N,
- inf)[a]</tt>
- </td>
-<td>
- <tt class="computeroutput">vector<A></tt>
- </td>
-<td>
- Repeat <tt class="computeroutput">a</tt> <tt class="computeroutput">N</tt> or more times
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">verbatim[a]</tt>
- </td>
-<td>
- <tt class="computeroutput">A</tt>
- </td>
-<td>
- Disable delimited generation for <tt class="computeroutput">a</tt>
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">delimit[a]</tt>
- </td>
-<td>
- <tt class="computeroutput">A</tt>
- </td>
-<td>
- Reestablish the delimiter that got inhibited by verbatim
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">delimit(g)[a]</tt>
- </td>
-<td>
- <tt class="computeroutput">A</tt>
- </td>
-<td>
- Use <tt class="computeroutput">g</tt> as a skipper
- for generating <tt class="computeroutput">a</tt>
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">float_</tt>
- </td>
-<td>
- <tt class="computeroutput">float</tt>
- </td>
-<td>
- Generate a floating point number from a <tt class="computeroutput">float</tt>
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">double_</tt>
- </td>
-<td>
- <tt class="computeroutput">double</tt>
- </td>
-<td>
- Generate a floating point number from a <tt class="computeroutput">double</tt>
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">long_double</tt>
- </td>
-<td>
- <tt class="computeroutput">long double</tt>
- </td>
-<td>
- Generate a floating point number from a <tt class="computeroutput">long
- double</tt>
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">bin</tt>
- </td>
-<td>
- <tt class="computeroutput">unsigned</tt>
- </td>
-<td>
- Generate a binary integer from an <tt class="computeroutput">unsigned</tt>
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">oct</tt>
- </td>
-<td>
- <tt class="computeroutput">unsigned</tt>
- </td>
-<td>
- Generate an octal integer from an <tt class="computeroutput">unsigned</tt>
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">hex</tt>
- </td>
-<td>
- <tt class="computeroutput">unsigned</tt>
- </td>
-<td>
- Generate a hexadecimal integer from an <tt class="computeroutput">unsigned</tt>
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">ushort_</tt>
- </td>
-<td>
- <tt class="computeroutput">unsigned short</tt>
- </td>
-<td>
- Generate an unsigned short integer
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">ulong_</tt>
- </td>
-<td>
- <tt class="computeroutput">unsigned long</tt>
- </td>
-<td>
- Generate an unsigned long integer
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">uint_</tt>
- </td>
-<td>
- <tt class="computeroutput">unsigned int</tt>
- </td>
-<td>
- Generate an unsigned int
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">ulong_long</tt>
- </td>
-<td>
- <tt class="computeroutput">unsigned long
- long</tt>
- </td>
-<td>
- Generate an unsigned long long
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">short_</tt>
- </td>
-<td>
- <tt class="computeroutput">short</tt>
- </td>
-<td>
- Generate a short integer
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">long_</tt>
- </td>
-<td>
- <tt class="computeroutput">long</tt>
- </td>
-<td>
- Generate a long integer
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">int_</tt>
- </td>
-<td>
- <tt class="computeroutput">int</tt>
- </td>
-<td>
- Generate an int
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">long_long</tt>
- </td>
-<td>
- <tt class="computeroutput">long long</tt>
- </td>
-<td>
- Generate a long long
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">!a</tt>
- </td>
-<td>
- <tt class="computeroutput">Unused</tt>
- </td>
-<td>
- Not predicate. Ensure that <tt class="computeroutput">a</tt>
- does not succeed generating but don't create any output
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">&a</tt>
- </td>
-<td>
- <tt class="computeroutput">Unused</tt>
- </td>
-<td>
- And predicate. Ensure that <tt class="computeroutput">a</tt>
- does succeed generating but don't create any output
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">-a</tt>
- </td>
-<td>
- <tt class="computeroutput">optional<A></tt>
- </td>
-<td>
- Optional. Generate <tt class="computeroutput">a</tt>
- zero or one time
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">*a</tt>
- </td>
-<td>
- <tt class="computeroutput">vector<A></tt>
- </td>
-<td>
- Kleene. Generate <tt class="computeroutput">a</tt>
- zero or more times
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">+a</tt>
- </td>
-<td>
- <tt class="computeroutput">vector<A></tt>
- </td>
-<td>
- Plus. Generate <tt class="computeroutput">a</tt>
- one or more times
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">a |
- b</tt>
- </td>
-<td>
- <tt class="computeroutput">variant<A,
- B></tt>
- </td>
-<td>
- Alternative. Generate <tt class="computeroutput">a</tt>
- or <tt class="computeroutput">b</tt>
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">a <<
- b</tt>
- </td>
-<td>
- <tt class="computeroutput">tuple<A,
- B></tt>
- </td>
-<td>
- Sequence. Generate <tt class="computeroutput">a</tt>
- followed by <tt class="computeroutput">b</tt>
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">a %
- b</tt>
- </td>
-<td>
- <tt class="computeroutput">vector<A></tt>
- </td>
-<td>
- List. Generate <tt class="computeroutput">a</tt>
- delimited <tt class="computeroutput">b</tt> one
- or more times
- </td>
-</tr>
-</tbody>
-</table></div>
-</div>
-<div class="section" lang="en">
-<div class="titlepage">
-<div><div><h4 class="title">
-<a name="spirit.karma.quick_reference.compound_attribute_rules"></a><a href="karma.html#spirit.karma.quick_reference.compound_attribute_rules" title="Compound
- Attribute Rules">Compound
- Attribute Rules</a>
-</h4></div></div>
-<div></div>
-</div>
-
- The notation will be for instance:
- 
-<pre class="programlisting">a: A, b: B --> (a >> b): tuple<A, B>
-</pre>
-
- which reads as: given, <tt class="computeroutput">a</tt>
- and <tt class="computeroutput">b</tt> are parsers/generators,
- and <tt class="computeroutput">A</tt> is the type of the
- attribute of <tt class="computeroutput">a</tt>, and <tt class="computeroutput">B</tt> is the type of the attribute of <tt class="computeroutput">b</tt>, then the type of the attribute of
- <tt class="computeroutput">a >>
- b</tt> will be <tt class="computeroutput">tuple<A, B></tt>.
- 
-<div class="table">
-<a name="id456546"></a>Table 5. /Spirit.Karma/ compound generator attribute types
-<table class="table" summary="/Spirit.Karma/ compound generator attribute types">
-<colgroup>
-<col>
-<col>
-</colgroup>
-<thead><tr>
-<th>
- Expression
- </th>
-<th>
- Attribute
- </th>
-</tr></thead>
-<tbody>
-<tr>
-<td>
- sequence (<tt class="computeroutput"><<</tt>)
- </td>
-<td>
-
-
-
-<pre class="programlisting">a: A, b: B --> (a << b): tuple<A, B>
-a: A, b: Unused --> (a << b): A
-a: Unused, b: B --> (a << b): B
-a: Unused, b: Unused --> (a << b): Unused
-a: A, b: A --> (a << b): vector<A></pre>
-
- 
-</td>
-</tr>
-<tr>
-<td>
- alternative (<tt class="computeroutput">|</tt>)
- </td>
-<td>
-
-
-
-<pre class="programlisting">a: A, b: B --> (a | b): variant<A, B>
-a: A, b: Unused --> (a | b): variant<Unused, A>
-a: Unused, b: B --> (a | b): variant<Unused, B>
-a: Unused, b: Unused --> (a | b): Unused</pre>
-
- a: A, b: A --> (a | b): A`
- 
-</td>
-</tr>
-<tr>
-<td>
- kleene (<tt class="computeroutput">*</tt>)
- </td>
-<td>
-
-
-
-<pre class="programlisting">a: A --> *a: vector<A>
-a: Unused --> a: Unused</pre>
-
- 
-</td>
-</tr>
-<tr>
-<td>
- plus (<tt class="computeroutput">+</tt>)
- </td>
-<td>
-
-
-
-<pre class="programlisting">a: A --> +a: vector<A>
-a: Unused --> a: Unused</pre>
-
- 
-</td>
-</tr>
-<tr>
-<td>
- list (<tt class="computeroutput">%</tt>)
- </td>
-<td>
-
-
-
-<pre class="programlisting">a: A, b: B --> (a % b): vector<A>
-a: Unused, b: B --> (a % b): Unused</pre>
-
- 
-</td>
-</tr>
-<tr>
-<td>
- repetition
- </td>
-<td>
-
-
-
-<pre class="programlisting">a: A --> repeat(...,...)[a]: vector<A>
-a: Unused --> repeat(...,...)[a]: Unused</pre>
-
- 
-</td>
-</tr>
-<tr>
-<td>
- optional (<tt class="computeroutput">-</tt>)
- </td>
-<td>
-
-
-
-<pre class="programlisting">a: A --> -a: optional<A>
-a: Unused --> -a: Unused</pre>
-
- 
-</td>
-</tr>
-<tr>
-<td>
- and predicate (<tt class="computeroutput">&</tt>)
- </td>
-<td>
- <tt class="computeroutput">a:
- A -->
- &a: Unused</tt>
- </td>
-</tr>
-<tr>
-<td>
- not predicate (<tt class="computeroutput">!</tt>)
- </td>
-<td>
- <tt class="computeroutput">a:
- A -->
- !a: Unused</tt>
- </td>
-</tr>
-</tbody>
-</table>
-</div>
-</div>
-<div class="section" lang="en">
-<div class="titlepage">
-<div><div><h4 class="title">
-<a name="spirit.karma.quick_reference.lazy_arguments"></a>Lazy Arguments
-</h4></div></div>
-<div></div>
-</div>
-
- For all expressions of the form:
- 
-<pre class="programlisting">p(a1, a2,... aN)
-</pre>
-
- where <tt class="computeroutput">p</tt> is a parser, each
- of the arguments (a1...aN) can either be an immediate value, or a lazy
- function with signature:
- 
-<pre class="programlisting">T(Unused, Context)
-</pre>
-
- where <tt class="computeroutput">T</tt>, the function's
- return value, is compatible with the argument type expected. For example,
- this is a valid expression:
- 
-<pre class="programlisting">eps(false) // this will always fail
-</pre>
-
- And so is this:
- 
-<pre class="programlisting">bool flag = true;
-eps(phoenix::var(flag)) // success or fail depending on the value
- // of flag at parse time
-</pre>
-
- since <tt class="computeroutput">phoenix::ref(f)</tt> is
- a function that returns a <tt class="computeroutput">bool</tt>.
- 
-</div>
-<div class="section" lang="en">
-<div class="titlepage">
-<div><div><h4 class="title">
-<a name="spirit.karma.quick_reference.non_terminals"></a>Non-terminals
-</h4></div></div>
-<div></div>
-</div>
-<div class="variablelist">
-Notation
-<dl>
-<dt><tt class="computeroutput">RT</tt></dt>
-<dd>
- Synthesized attribute. The rule or grammar's return type.
- </dd>
-<dt><tt class="computeroutput">Arg1</tt>,
- <tt class="computeroutput">Arg2</tt>, <tt class="computeroutput">ArgN</tt></dt>
-<dd>
- Inherited attributes. Zero or more or arguments.
- </dd>
-<dt><tt class="computeroutput">L1</tt>,
- <tt class="computeroutput">L2</tt>, <tt class="computeroutput">LN</tt></dt>
-<dd>
- Zero or more local variables.
- </dd>
-<dt><tt class="computeroutput">r, r2</tt></dt>
-<dd>
- Rules
- </dd>
-<dt><tt class="computeroutput">g</tt></dt>
-<dd>
- A grammar
- </dd>
-<dt><tt class="computeroutput">p</tt></dt>
-<dd>
- A parser expression
- </dd>
-<dt><tt class="computeroutput">my_grammar</tt></dt>
-<dd>
- A user defined grammar
- </dd>
-</dl>
-</div>
-<div class="variablelist">
-Terminology
-<dl>
-<dt>Signature</dt>
-<dd>
- <tt class="computeroutput">RT(Arg1, Arg2 ...
- ,ArgN)</tt>. The signature specifies the synthesized
- (return value) and inherited (arguments) attributes.
- </dd>
-<dt>Locals</dt>
-<dd>
- <tt class="computeroutput">locals<L1, L2 ...,
- LN></tt>.
- The local variables.
- </dd>
-<dt>Skipper</dt>
-<dd>
- The skip-parser type
- </dd>
-</dl>
-</div>
-<div class="variablelist">
-Template Arguments
-<dl>
-<dt><tt class="computeroutput">Iterator</tt></dt>
-<dd>
- The iterator type you will use for parsing.
- </dd>
-<dt><tt class="computeroutput">A1</tt>,
- <tt class="computeroutput">A2</tt>, <tt class="computeroutput">A3</tt></dt>
-<dd>
- Can be one of 1)Signature 2)Locals 3)Skipper.
- </dd>
-</dl>
-</div>
-<div class="informaltable"><table class="table">
-<colgroup>
-<col>
-<col>
-</colgroup>
-<thead><tr>
-<th>
- Expression
- </th>
-<th>
- Description
- </th>
-</tr></thead>
-<tbody>
-<tr>
-<td>
- <tt class="computeroutput">rule<Iterator,
- A1,
- A2,
- A3>
- r(name);</tt>
- </td>
-<td>
- Rule declaration. <tt class="computeroutput">Iterator</tt>
- is required. <tt class="computeroutput">A1, A2, A3</tt>
- are optional and can be specified in any order. <tt class="computeroutput">name</tt>
- is an optional string that gives the rule its name, useful for
- debugging and error handling.
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">rule<Iterator,
- A1,
- A2,
- A3>
- r(r2);</tt>
- </td>
-<td>
- Copy construct rule <tt class="computeroutput">r</tt>
- from rule <tt class="computeroutput">r2</tt>.
- <tt class="computeroutput">boost::shared_ptr</tt> semantics.
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">r =
- r2;</tt>
- </td>
-<td>
- Assign rule <tt class="computeroutput">r2</tt>
- to <tt class="computeroutput">r</tt>. <tt class="computeroutput">boost::shared_ptr</tt> semantics.
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">r.alias()</tt>
- </td>
-<td>
- return an alias of <tt class="computeroutput">r</tt>.
- The alias is a parser that holds a reference to <tt class="computeroutput">r</tt>.
- Reference semantics.
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">r.copy()</tt>
- </td>
-<td>
- Get a copy of <tt class="computeroutput">r</tt>.
- <tt class="computeroutput">boost::shared_ptr</tt> semantics.
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">r.name(name)</tt>
- </td>
-<td>
- Naming a rule
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">r.name()</tt>
- </td>
-<td>
- Getting the name of a rule
- </td>
-</tr>
-<tr>
-<td>
- debug(r)
- </td>
-<td>
- Debug rule <tt class="computeroutput">r</tt>
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">r =
- p;</tt>
- </td>
-<td>
- Rule definition
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">r %=
- p;</tt>
- </td>
-<td>
- Auto-rule definition. The attribute of <tt class="computeroutput">p</tt>
- should be compatible with the synthesized attribute of <tt class="computeroutput">r</tt>. When <tt class="computeroutput">p</tt>
- is successful, its attribute is automatically propagated to <tt class="computeroutput">r</tt>'s synthesized attribute.
- </td>
-</tr>
-<tr>
-<td>
-
-
-
-<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">template <typename Iterator>
-struct my_grammar : grammar<Iterator, A1, A2, A3>
-{
- my_grammar() : my_grammar::base_type(start, name)
- {
- // Rule definitions
- start = /* ... */;
- }
-
- rule<Iterator, A1, A2, A3> start;
- // more rule declarations...
-};
-</pre>
-
- 
-</td>
-<td>
- Grammar definition. <tt class="computeroutput">name</tt>
- is an optional string that gives the grammar its name, useful for
- debugging and error handling.
- </td>
-</tr>
-<tr>
-<td>
- my_grammar<Iterator> g
- </td>
-<td>
- Instantiating a grammar
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">g.name(name)</tt>
- </td>
-<td>
- Naming a grammar
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">g.name()</tt>
- </td>
-<td>
- Getting the name of a grammar
- </td>
-</tr>
-</tbody>
-</table></div>
-</div>
-<div class="section" lang="en">
-<div class="titlepage">
-<div><div><h4 class="title">
-<a name="spirit.karma.quick_reference.semantic_actions"></a><a href="karma.html#spirit.karma.quick_reference.semantic_actions" title="Semantic
- Actions">Semantic
- Actions</a>
-</h4></div></div>
-<div></div>
-</div>
-
- Has the form:
- 
-<pre class="programlisting">p[f]
-</pre>
-
- where <tt class="computeroutput">f</tt> is a function with
- the signatures:
- 
-<pre class="programlisting">void f(Attr const&);
-void f(Attr const&, Context&);
-void f(Attr const&, Context&, bool&);
-</pre>
-
- You can use <tt class="computeroutput">Boost.Bind</tt>
- to bind member functions. For function objects, the allowed signatures
- are:
- 
-<pre class="programlisting">void operator()(Attr const&, unused_type, unused_type) const;
-void operator()(Attr const&, Context&, unused_type) const;
-void operator()(Attr const&, Context&, bool&) const;
-</pre>
-
- The <tt class="computeroutput">unused_type</tt> is used
- in the signatures above to signify 'don't care'.
- 
-</div>
-<div class="section" lang="en">
-<div class="titlepage">
-<div><div><h4 class="title">
-<a name="spirit.karma.quick_reference.phoenix"></a>Phoenix
-</h4></div></div>
-<div></div>
-</div>
-
- __boostphoenix_ makes it easier to
- attach semantic actions. You just inline your lambda expressions:
- 
-<pre class="programlisting">p[phoenix-lambda-expression]
-</pre>
-
- Spirit.Qi provides some __boostphoenix_
- placeholders to important information from the <tt class="computeroutput">Attr</tt>
- and <tt class="computeroutput">Context</tt> that are otherwise
- fiddly to extract.
- 
-<div class="variablelist">
-Spirit.Qi specific Phoenix placeholders
-<dl>
-<dt><tt class="computeroutput">_1, _2... , _N</tt></dt>
-<dd>
- Nth attribute of <tt class="computeroutput">p</tt>
- </dd>
-<dt><tt class="computeroutput">_val</tt></dt>
-<dd>
- The enclosing rule's synthesized attribute.
- </dd>
-<dt><tt class="computeroutput">_r1, _r2... , _rN</tt></dt>
-<dd>
- The enclosing rule's Nth inherited attribute.
- </dd>
-<dt><tt class="computeroutput">_a, _b... , _j</tt></dt>
-<dd>
- The enclosing rule's local variables (<tt class="computeroutput">_a</tt>
- refers to the first).
- </dd>
-<dt><tt class="computeroutput">_val</tt></dt>
-<dd>
- The enclosing rule's synthesized attribute.
- </dd>
-<dt><tt class="computeroutput">_pass</tt></dt>
-<dd>
- Assign <tt class="computeroutput">false</tt> to <tt class="computeroutput">_pass</tt> to force a parser failure.
- </dd>
-</dl>
-</div>
-</div>
-</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
@@ -1530,7 +57,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="qi/quick_reference/phoenix.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="lex.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="qi/quick_reference/phoenix.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="karma/quick_reference.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>

Added: trunk/libs/spirit/doc/html/spirit/karma/quick_reference.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/karma/quick_reference.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -0,0 +1,68 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Quick Reference</title>
+<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
+<link rel="home" href="../../index.html" title="Spirit 2.1">
+<link rel="up" href="../karma.html" title=" Karma">
+<link rel="previous" href="../karma.html" title=" Karma">
+<link rel="next" href="quick_reference/common_notation.html" title="Common
+ Notation">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../karma.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../karma.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="quick_reference/common_notation.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h3 class="title">
+<a name="spirit.karma.quick_reference"></a>Quick Reference
+</h3></div></div>
+<div></div>
+</div>
+<div class="toc"><dl>
+<dt><a href="quick_reference/common_notation.html">Common
+ Notation</a></dt>
+<dt><a href="quick_reference/predefined_primitive_generators.html">Predefined
+ Primitive Generators</a></dt>
+<dt><a href="quick_reference/compound_attribute_rules.html">Compound
+ Attribute Rules</a></dt>
+<dt>Lazy Arguments</dt>
+<dt>Non-terminals</dt>
+<dt><a href="quick_reference/semantic_actions.html">Semantic
+ Actions</a></dt>
+<dt>Phoenix</dt>
+</dl></div>
+
+ This quick reference section is provided for convenience. You can use this
+ section as a sort of a "cheat-sheet" on the most commonly used
+ Karma components. It is not intended to be complete, but should give you
+ an easy way to recall a particular component without having to dig up on
+ pages and pages of reference doumentation.
+ 
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2001-2009 Joel
+ de Guzman, 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../karma.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../karma.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="quick_reference/common_notation.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/karma/quick_reference/common_notation.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/karma/quick_reference/common_notation.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -0,0 +1,153 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Common
+ Notation</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
+<link rel="home" href="../../../index.html" title="Spirit 2.1">
+<link rel="up" href="../quick_reference.html" title="Quick Reference">
+<link rel="previous" href="../quick_reference.html" title="Quick Reference">
+<link rel="next" href="predefined_primitive_generators.html" title="Predefined
+ Primitive Generators">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../quick_reference.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../quick_reference.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="predefined_primitive_generators.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h4 class="title">
+<a name="spirit.karma.quick_reference.common_notation"></a><a href="common_notation.html" title="Common
+ Notation">Common
+ Notation</a>
+</h4></div></div>
+<div></div>
+</div>
+<div class="variablelist">
+Notation
+<dl>
+<dt><tt class="computeroutput">P</tt></dt>
+<dd>
+ Parser type
+ </dd>
+<dt><tt class="computeroutput">p, a,
+ b,
+ c</tt></dt>
+<dd>
+ Parser objects
+ </dd>
+<dt><tt class="computeroutput">A, B,
+ C</tt></dt>
+<dd>
+ Attribute types of parsers A, B and C
+ </dd>
+<dt><tt class="computeroutput">I</tt></dt>
+<dd>
+ The iterator type used for parsing
+ </dd>
+<dt><tt class="computeroutput">Unused</tt></dt>
+<dd>
+ An <tt class="computeroutput">unused_type</tt>
+ </dd>
+<dt><tt class="computeroutput">Context</tt></dt>
+<dd>
+ The enclosing rule's <tt class="computeroutput">Context</tt>
+ type
+ </dd>
+<dt><tt class="computeroutput">Attr</tt></dt>
+<dd>
+ An attribute type
+ </dd>
+<dt><tt class="computeroutput">b</tt></dt>
+<dd>
+ A boolean expression
+ </dd>
+<dt><tt class="computeroutput">fp</tt></dt>
+<dd>
+ A (lazy parser) function with signature <tt class="computeroutput">P(Unused, Context)</tt>
+ </dd>
+<dt><tt class="computeroutput">fa</tt></dt>
+<dd>
+ A (semantic action) function with signature <tt class="computeroutput">void(Attr, Context, bool&)</tt>. The third parameter is a boolean
+ flag that can be set to false to force the parse to fail. Both <tt class="computeroutput">Context</tt> and the boolean flag are
+ optional.
+ </dd>
+<dt><tt class="computeroutput">first</tt></dt>
+<dd>
+ An iterator pointing to the start of input
+ </dd>
+<dt><tt class="computeroutput">last</tt></dt>
+<dd>
+ An iterator pointing to the end of input
+ </dd>
+<dt><tt class="computeroutput">Ch</tt></dt>
+<dd>
+ Character-class specific character type (See __char_classtypes_)
+ </dd>
+<dt><tt class="computeroutput">ch</tt></dt>
+<dd>
+ Character-class specific character (See __char_classtypes_)
+ </dd>
+<dt><tt class="computeroutput">ch2</tt></dt>
+<dd>
+ Character-class specific character (See __char_classtypes_)
+ </dd>
+<dt><tt class="computeroutput">chset</tt></dt>
+<dd>
+ Character-set specifier string (example: "a-z0-9")
+ </dd>
+<dt><tt class="computeroutput">str</tt></dt>
+<dd>
+ Character-class specific string (See __char_classtypes_)
+ </dd>
+<dt><tt class="computeroutput">Str</tt></dt>
+<dd>
+ Attribute of <tt class="computeroutput">str</tt>:
+ <tt class="computeroutput">std::basic_string<T></tt>
+ where <tt class="computeroutput">T</tt> is the underlying
+ character type of <tt class="computeroutput">str</tt>
+ </dd>
+<dt><tt class="computeroutput">tuple<></tt></dt>
+<dd>
+ Used as a placeholder for a fusion sequence
+ </dd>
+<dt><tt class="computeroutput">vector<></tt></dt>
+<dd>
+ Used as a placeholder for an STL container
+ </dd>
+<dt><tt class="computeroutput">variant<></tt></dt>
+<dd>
+ Used as a placeholder for a boost::variant
+ </dd>
+<dt><tt class="computeroutput">optional<></tt></dt>
+<dd>
+ Used as a placeholder for a boost::optional
+ </dd>
+</dl>
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2001-2009 Joel
+ de Guzman, 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../quick_reference.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../quick_reference.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="predefined_primitive_generators.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/karma/quick_reference/compound_attribute_rules.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/karma/quick_reference/compound_attribute_rules.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -0,0 +1,207 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Compound
+ Attribute Rules</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
+<link rel="home" href="../../../index.html" title="Spirit 2.1">
+<link rel="up" href="../quick_reference.html" title="Quick Reference">
+<link rel="previous" href="predefined_primitive_generators.html" title="Predefined
+ Primitive Generators">
+<link rel="next" href="lazy_arguments.html" title="Lazy Arguments">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="predefined_primitive_generators.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../quick_reference.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="lazy_arguments.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h4 class="title">
+<a name="spirit.karma.quick_reference.compound_attribute_rules"></a><a href="compound_attribute_rules.html" title="Compound
+ Attribute Rules">Compound
+ Attribute Rules</a>
+</h4></div></div>
+<div></div>
+</div>
+
+ The notation will be for instance:
+ 
+<pre class="programlisting">a: A, b: B --> (a >> b): tuple<A, B>
+</pre>
+
+ which reads as: given, <tt class="computeroutput">a</tt>
+ and <tt class="computeroutput">b</tt> are parsers/generators,
+ and <tt class="computeroutput">A</tt> is the type of the
+ attribute of <tt class="computeroutput">a</tt>, and <tt class="computeroutput">B</tt> is the type of the attribute of <tt class="computeroutput">b</tt>, then the type of the attribute of
+ <tt class="computeroutput">a >>
+ b</tt> will be <tt class="computeroutput">tuple<A, B></tt>.
+ 
+<div class="table">
+<a name="id456662"></a>Table 5. /Spirit.Karma/ compound generator attribute types
+<table class="table" summary="/Spirit.Karma/ compound generator attribute types">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Attribute
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ sequence (<tt class="computeroutput"><<</tt>)
+ </td>
+<td>
+
+
+
+<pre class="programlisting">a: A, b: B --> (a << b): tuple<A, B>
+a: A, b: Unused --> (a << b): A
+a: Unused, b: B --> (a << b): B
+a: Unused, b: Unused --> (a << b): Unused
+a: A, b: A --> (a << b): vector<A></pre>
+
+ 
+</td>
+</tr>
+<tr>
+<td>
+ alternative (<tt class="computeroutput">|</tt>)
+ </td>
+<td>
+
+
+
+<pre class="programlisting">a: A, b: B --> (a | b): variant<A, B>
+a: A, b: Unused --> (a | b): variant<Unused, A>
+a: Unused, b: B --> (a | b): variant<Unused, B>
+a: Unused, b: Unused --> (a | b): Unused</pre>
+
+ a: A, b: A --> (a | b): A`
+ 
+</td>
+</tr>
+<tr>
+<td>
+ kleene (<tt class="computeroutput">*</tt>)
+ </td>
+<td>
+
+
+
+<pre class="programlisting">a: A --> *a: vector<A>
+a: Unused --> a: Unused</pre>
+
+ 
+</td>
+</tr>
+<tr>
+<td>
+ plus (<tt class="computeroutput">+</tt>)
+ </td>
+<td>
+
+
+
+<pre class="programlisting">a: A --> +a: vector<A>
+a: Unused --> a: Unused</pre>
+
+ 
+</td>
+</tr>
+<tr>
+<td>
+ list (<tt class="computeroutput">%</tt>)
+ </td>
+<td>
+
+
+
+<pre class="programlisting">a: A, b: B --> (a % b): vector<A>
+a: Unused, b: B --> (a % b): Unused</pre>
+
+ 
+</td>
+</tr>
+<tr>
+<td>
+ repetition
+ </td>
+<td>
+
+
+
+<pre class="programlisting">a: A --> repeat(...,...)[a]: vector<A>
+a: Unused --> repeat(...,...)[a]: Unused</pre>
+
+ 
+</td>
+</tr>
+<tr>
+<td>
+ optional (<tt class="computeroutput">-</tt>)
+ </td>
+<td>
+
+
+
+<pre class="programlisting">a: A --> -a: optional<A>
+a: Unused --> -a: Unused</pre>
+
+ 
+</td>
+</tr>
+<tr>
+<td>
+ and predicate (<tt class="computeroutput">&</tt>)
+ </td>
+<td>
+ <tt class="computeroutput">a:
+ A -->
+ &a: Unused</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ not predicate (<tt class="computeroutput">!</tt>)
+ </td>
+<td>
+ <tt class="computeroutput">a:
+ A -->
+ !a: Unused</tt>
+ </td>
+</tr>
+</tbody>
+</table>
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2001-2009 Joel
+ de Guzman, 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="predefined_primitive_generators.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../quick_reference.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="lazy_arguments.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/karma/quick_reference/lazy_arguments.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/karma/quick_reference/lazy_arguments.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -0,0 +1,78 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Lazy Arguments</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
+<link rel="home" href="../../../index.html" title="Spirit 2.1">
+<link rel="up" href="../quick_reference.html" title="Quick Reference">
+<link rel="previous" href="compound_attribute_rules.html" title="Compound
+ Attribute Rules">
+<link rel="next" href="non_terminals.html" title="Non-terminals">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="compound_attribute_rules.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../quick_reference.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="non_terminals.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h4 class="title">
+<a name="spirit.karma.quick_reference.lazy_arguments"></a>Lazy Arguments
+</h4></div></div>
+<div></div>
+</div>
+
+ For all expressions of the form:
+ 
+<pre class="programlisting">p(a1, a2,... aN)
+</pre>
+
+ where <tt class="computeroutput">p</tt> is a parser, each
+ of the arguments (a1...aN) can either be an immediate value, or a lazy
+ function with signature:
+ 
+<pre class="programlisting">T(Unused, Context)
+</pre>
+
+ where <tt class="computeroutput">T</tt>, the function's
+ return value, is compatible with the argument type expected. For example,
+ this is a valid expression:
+ 
+<pre class="programlisting">eps(false) // this will always fail
+</pre>
+
+ And so is this:
+ 
+<pre class="programlisting">bool flag = true;
+eps(phoenix::var(flag)) // success or fail depending on the value
+ // of flag at parse time
+</pre>
+
+ since <tt class="computeroutput">phoenix::ref(f)</tt> is
+ a function that returns a <tt class="computeroutput">bool</tt>.
+ 
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2001-2009 Joel
+ de Guzman, 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="compound_attribute_rules.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../quick_reference.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="non_terminals.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/karma/quick_reference/non_terminals.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/karma/quick_reference/non_terminals.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -0,0 +1,288 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Non-terminals</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
+<link rel="home" href="../../../index.html" title="Spirit 2.1">
+<link rel="up" href="../quick_reference.html" title="Quick Reference">
+<link rel="previous" href="lazy_arguments.html" title="Lazy Arguments">
+<link rel="next" href="semantic_actions.html" title="Semantic
+ Actions">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="lazy_arguments.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../quick_reference.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="semantic_actions.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h4 class="title">
+<a name="spirit.karma.quick_reference.non_terminals"></a>Non-terminals
+</h4></div></div>
+<div></div>
+</div>
+<div class="variablelist">
+Notation
+<dl>
+<dt><tt class="computeroutput">RT</tt></dt>
+<dd>
+ Synthesized attribute. The rule or grammar's return type.
+ </dd>
+<dt><tt class="computeroutput">Arg1</tt>,
+ <tt class="computeroutput">Arg2</tt>, <tt class="computeroutput">ArgN</tt></dt>
+<dd>
+ Inherited attributes. Zero or more or arguments.
+ </dd>
+<dt><tt class="computeroutput">L1</tt>,
+ <tt class="computeroutput">L2</tt>, <tt class="computeroutput">LN</tt></dt>
+<dd>
+ Zero or more local variables.
+ </dd>
+<dt><tt class="computeroutput">r, r2</tt></dt>
+<dd>
+ Rules
+ </dd>
+<dt><tt class="computeroutput">g</tt></dt>
+<dd>
+ A grammar
+ </dd>
+<dt><tt class="computeroutput">p</tt></dt>
+<dd>
+ A parser expression
+ </dd>
+<dt><tt class="computeroutput">my_grammar</tt></dt>
+<dd>
+ A user defined grammar
+ </dd>
+</dl>
+</div>
+<div class="variablelist">
+Terminology
+<dl>
+<dt>Signature</dt>
+<dd>
+ <tt class="computeroutput">RT(Arg1, Arg2 ...
+ ,ArgN)</tt>. The signature specifies the synthesized
+ (return value) and inherited (arguments) attributes.
+ </dd>
+<dt>Locals</dt>
+<dd>
+ <tt class="computeroutput">locals<L1, L2 ...,
+ LN></tt>.
+ The local variables.
+ </dd>
+<dt>Skipper</dt>
+<dd>
+ The skip-parser type
+ </dd>
+</dl>
+</div>
+<div class="variablelist">
+Template Arguments
+<dl>
+<dt><tt class="computeroutput">Iterator</tt></dt>
+<dd>
+ The iterator type you will use for parsing.
+ </dd>
+<dt><tt class="computeroutput">A1</tt>,
+ <tt class="computeroutput">A2</tt>, <tt class="computeroutput">A3</tt></dt>
+<dd>
+ Can be one of 1)Signature 2)Locals 3)Skipper.
+ </dd>
+</dl>
+</div>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Description
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <tt class="computeroutput">rule<Iterator,
+ A1,
+ A2,
+ A3>
+ r(name);</tt>
+ </td>
+<td>
+ Rule declaration. <tt class="computeroutput">Iterator</tt>
+ is required. <tt class="computeroutput">A1, A2, A3</tt>
+ are optional and can be specified in any order. <tt class="computeroutput">name</tt>
+ is an optional string that gives the rule its name, useful for
+ debugging and error handling.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">rule<Iterator,
+ A1,
+ A2,
+ A3>
+ r(r2);</tt>
+ </td>
+<td>
+ Copy construct rule <tt class="computeroutput">r</tt>
+ from rule <tt class="computeroutput">r2</tt>.
+ <tt class="computeroutput">boost::shared_ptr</tt> semantics.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">r =
+ r2;</tt>
+ </td>
+<td>
+ Assign rule <tt class="computeroutput">r2</tt>
+ to <tt class="computeroutput">r</tt>. <tt class="computeroutput">boost::shared_ptr</tt> semantics.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">r.alias()</tt>
+ </td>
+<td>
+ return an alias of <tt class="computeroutput">r</tt>.
+ The alias is a parser that holds a reference to <tt class="computeroutput">r</tt>.
+ Reference semantics.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">r.copy()</tt>
+ </td>
+<td>
+ Get a copy of <tt class="computeroutput">r</tt>.
+ <tt class="computeroutput">boost::shared_ptr</tt> semantics.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">r.name(name)</tt>
+ </td>
+<td>
+ Naming a rule
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">r.name()</tt>
+ </td>
+<td>
+ Getting the name of a rule
+ </td>
+</tr>
+<tr>
+<td>
+ debug(r)
+ </td>
+<td>
+ Debug rule <tt class="computeroutput">r</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">r =
+ p;</tt>
+ </td>
+<td>
+ Rule definition
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">r %=
+ p;</tt>
+ </td>
+<td>
+ Auto-rule definition. The attribute of <tt class="computeroutput">p</tt>
+ should be compatible with the synthesized attribute of <tt class="computeroutput">r</tt>. When <tt class="computeroutput">p</tt>
+ is successful, its attribute is automatically propagated to <tt class="computeroutput">r</tt>'s synthesized attribute.
+ </td>
+</tr>
+<tr>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">template <typename Iterator>
+struct my_grammar : grammar<Iterator, A1, A2, A3>
+{
+ my_grammar() : my_grammar::base_type(start, name)
+ {
+ // Rule definitions
+ start = /* ... */;
+ }
+
+ rule<Iterator, A1, A2, A3> start;
+ // more rule declarations...
+};
+</pre>
+
+ 
+</td>
+<td>
+ Grammar definition. <tt class="computeroutput">name</tt>
+ is an optional string that gives the grammar its name, useful for
+ debugging and error handling.
+ </td>
+</tr>
+<tr>
+<td>
+ my_grammar<Iterator> g
+ </td>
+<td>
+ Instantiating a grammar
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">g.name(name)</tt>
+ </td>
+<td>
+ Naming a grammar
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">g.name()</tt>
+ </td>
+<td>
+ Getting the name of a grammar
+ </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2001-2009 Joel
+ de Guzman, 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="lazy_arguments.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../quick_reference.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="semantic_actions.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/karma/quick_reference/phoenix.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/karma/quick_reference/phoenix.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -0,0 +1,90 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Phoenix</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
+<link rel="home" href="../../../index.html" title="Spirit 2.1">
+<link rel="up" href="../quick_reference.html" title="Quick Reference">
+<link rel="previous" href="semantic_actions.html" title="Semantic
+ Actions">
+<link rel="next" href="../../lex.html" title=" Spirit.Lex">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="semantic_actions.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../quick_reference.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../../lex.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h4 class="title">
+<a name="spirit.karma.quick_reference.phoenix"></a>Phoenix
+</h4></div></div>
+<div></div>
+</div>
+
+ __boostphoenix_ makes it easier to
+ attach semantic actions. You just inline your lambda expressions:
+ 
+<pre class="programlisting">p[phoenix-lambda-expression]
+</pre>
+
+ Spirit.Qi provides some __boostphoenix_
+ placeholders to important information from the <tt class="computeroutput">Attr</tt>
+ and <tt class="computeroutput">Context</tt> that are otherwise
+ fiddly to extract.
+ 
+<div class="variablelist">
+Spirit.Qi specific Phoenix placeholders
+<dl>
+<dt><tt class="computeroutput">_1, _2... , _N</tt></dt>
+<dd>
+ Nth attribute of <tt class="computeroutput">p</tt>
+ </dd>
+<dt><tt class="computeroutput">_val</tt></dt>
+<dd>
+ The enclosing rule's synthesized attribute.
+ </dd>
+<dt><tt class="computeroutput">_r1, _r2... , _rN</tt></dt>
+<dd>
+ The enclosing rule's Nth inherited attribute.
+ </dd>
+<dt><tt class="computeroutput">_a, _b... , _j</tt></dt>
+<dd>
+ The enclosing rule's local variables (<tt class="computeroutput">_a</tt>
+ refers to the first).
+ </dd>
+<dt><tt class="computeroutput">_val</tt></dt>
+<dd>
+ The enclosing rule's synthesized attribute.
+ </dd>
+<dt><tt class="computeroutput">_pass</tt></dt>
+<dd>
+ Assign <tt class="computeroutput">false</tt> to <tt class="computeroutput">_pass</tt> to force a parser failure.
+ </dd>
+</dl>
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2001-2009 Joel
+ de Guzman, 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="semantic_actions.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../quick_reference.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../../lex.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/karma/quick_reference/predefined_primitive_generators.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/karma/quick_reference/predefined_primitive_generators.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -0,0 +1,837 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Predefined
+ Primitive Generators</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
+<link rel="home" href="../../../index.html" title="Spirit 2.1">
+<link rel="up" href="../quick_reference.html" title="Quick Reference">
+<link rel="previous" href="common_notation.html" title="Common
+ Notation">
+<link rel="next" href="compound_attribute_rules.html" title="Compound
+ Attribute Rules">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="common_notation.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../quick_reference.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="compound_attribute_rules.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h4 class="title">
+<a name="spirit.karma.quick_reference.predefined_primitive_generators"></a><a href="predefined_primitive_generators.html" title="Predefined
+ Primitive Generators">Predefined
+ Primitive Generators</a>
+</h4></div></div>
+<div></div>
+</div>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Attribute
+ </th>
+<th>
+ Description
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <tt class="computeroutput">eol</tt>
+ </td>
+<td>
+ <tt class="computeroutput">Unused</tt>
+ </td>
+<td>
+ Generates the end of line (<tt class="computeroutput">\n</tt>)
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">eps</tt>
+ </td>
+<td>
+ <tt class="computeroutput">Unused</tt>
+ </td>
+<td>
+ Generate an empty string
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">eps(b)</tt>
+ </td>
+<td>
+ <tt class="computeroutput">Unused</tt>
+ </td>
+<td>
+ If <tt class="computeroutput">b</tt> is true, generate
+ an empty string
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">lazy(fg)</tt>
+ </td>
+<td>
+ Attribute of <tt class="computeroutput">G</tt>
+ where <tt class="computeroutput">G</tt> is the
+ return type of <tt class="computeroutput">fg</tt>
+ </td>
+<td>
+ Invoke <tt class="computeroutput">fg</tt> at generation
+ time, returning a generator <tt class="computeroutput">g</tt>
+ which is then called to generate.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">fg</tt>
+ </td>
+<td>
+ see <tt class="computeroutput">lazy(fg)</tt>
+ above
+ </td>
+<td>
+ Equivalent to <tt class="computeroutput">lazy[fp]</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">g[fa]</tt>
+ </td>
+<td>
+ Attribute of <tt class="computeroutput">g</tt>
+ </td>
+<td>
+ Call semantic action <tt class="computeroutput">fa</tt>
+ (before executing <tt class="computeroutput">g</tt>).
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">byte_</tt>
+ </td>
+<td>
+ 8 bits native endian
+ </td>
+<td>
+ Generates an 8 bit binary
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">word</tt>
+ </td>
+<td>
+ 16 bits native endian
+ </td>
+<td>
+ Generates a 16 bit binary
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">big_word</tt>
+ </td>
+<td>
+ 16 bits big endian
+ </td>
+<td>
+ Generates a 16 bit binary
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">little_word</tt>
+ </td>
+<td>
+ 16 bits little endian
+ </td>
+<td>
+ Generates a 16 bit binary
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">dword</tt>
+ </td>
+<td>
+ 32 bits native endian
+ </td>
+<td>
+ Generates a 32 bit binary
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">big_dword</tt>
+ </td>
+<td>
+ 32 bits big endian
+ </td>
+<td>
+ Generates a 32 bit binary
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">little_dword</tt>
+ </td>
+<td>
+ 32 bits little endian
+ </td>
+<td>
+ Generates a 32 bit binary
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">qword</tt>
+ </td>
+<td>
+ 64 bits native endian
+ </td>
+<td>
+ Generates a 64 bit binary
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">big_qword</tt>
+ </td>
+<td>
+ 64 bits big endian
+ </td>
+<td>
+ Generates a 64 bit binary
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">little_qword</tt>
+ </td>
+<td>
+ 64 bits little endian
+ </td>
+<td>
+ Generates a 64 bit binary
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">char_(ch)</tt>
+ </td>
+<td>
+ <tt class="computeroutput">Ch</tt>
+ </td>
+<td>
+ Generates <tt class="computeroutput">ch</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">char_("c")</tt>
+ </td>
+<td>
+ <tt class="computeroutput">Ch</tt>
+ </td>
+<td>
+ Generates a single char string literal, <tt class="computeroutput">c</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ch</tt>
+ </td>
+<td>
+ <tt class="computeroutput">Unused</tt>
+ </td>
+<td>
+ Generates <tt class="computeroutput">ch</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">str</tt>
+ </td>
+<td>
+ <tt class="computeroutput">Unused</tt>
+ </td>
+<td>
+ Generates <tt class="computeroutput">str</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">lit(ch)</tt>
+ </td>
+<td>
+ <tt class="computeroutput">Unused</tt>
+ </td>
+<td>
+ Generates <tt class="computeroutput">ch</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">lit(str)</tt>
+ </td>
+<td>
+ <tt class="computeroutput">Unused</tt>
+ </td>
+<td>
+ Generates <tt class="computeroutput">str</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">string(str)</tt>
+ </td>
+<td>
+ <tt class="computeroutput">Str</tt>
+ </td>
+<td>
+ Generates <tt class="computeroutput">str</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">lower[a]</tt>
+ </td>
+<td>
+ <tt class="computeroutput">A</tt>
+ </td>
+<td>
+ Generate <tt class="computeroutput">a</tt> as lower
+ case
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">upper[a]</tt>
+ </td>
+<td>
+ <tt class="computeroutput">A</tt>
+ </td>
+<td>
+ Generate <tt class="computeroutput">a</tt> as upper
+ case
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">left_align[a]</tt>
+ </td>
+<td>
+ <tt class="computeroutput">A</tt>
+ </td>
+<td>
+ Generate <tt class="computeroutput">a</tt> left
+ aligned in column of width BOOST_KARMA_DEFAULT_FIELD_LENGTH
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">left_align(N)[a]</tt>
+ </td>
+<td>
+ <tt class="computeroutput">A</tt>
+ </td>
+<td>
+ Generate <tt class="computeroutput">a</tt> left
+ aligned in column of width <tt class="computeroutput">N</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">left_align(N,
+ g)[a]</tt>
+ </td>
+<td>
+ <tt class="computeroutput">A</tt>
+ </td>
+<td>
+ Generate <tt class="computeroutput">a</tt> left
+ aligned in column of width <tt class="computeroutput">N</tt>
+ while using <tt class="computeroutput">g</tt> to
+ generate the necesssary padding
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">right_align[a]</tt>
+ </td>
+<td>
+ <tt class="computeroutput">A</tt>
+ </td>
+<td>
+ Generate <tt class="computeroutput">a</tt> right
+ aligned in column of width BOOST_KARMA_DEFAULT_FIELD_LENGTH
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">right_align(N)[a]</tt>
+ </td>
+<td>
+ <tt class="computeroutput">A</tt>
+ </td>
+<td>
+ Generate <tt class="computeroutput">a</tt> right
+ aligned in column of width <tt class="computeroutput">N</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">right_align(N,
+ g)[a]</tt>
+ </td>
+<td>
+ <tt class="computeroutput">A</tt>
+ </td>
+<td>
+ Generate <tt class="computeroutput">a</tt> right
+ aligned in column of width <tt class="computeroutput">N</tt>
+ while using <tt class="computeroutput">g</tt> to
+ generate the necesssary padding
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">center[a]</tt>
+ </td>
+<td>
+ <tt class="computeroutput">A</tt>
+ </td>
+<td>
+ Generate <tt class="computeroutput">a</tt> centered
+ in column of width BOOST_KARMA_DEFAULT_FIELD_LENGTH
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">center(N)[a]</tt>
+ </td>
+<td>
+ <tt class="computeroutput">A</tt>
+ </td>
+<td>
+ Generate <tt class="computeroutput">a</tt> centered
+ in column of width <tt class="computeroutput">N</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">center(N,
+ g)[a]</tt>
+ </td>
+<td>
+ <tt class="computeroutput">A</tt>
+ </td>
+<td>
+ Generate <tt class="computeroutput">a</tt> centered
+ in column of width <tt class="computeroutput">N</tt>
+ while using <tt class="computeroutput">g</tt> to
+ generate the necesssary padding
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">maxwidth[a]</tt>
+ </td>
+<td>
+ <tt class="computeroutput">A</tt>
+ </td>
+<td>
+ Generate <tt class="computeroutput">a</tt> truncated
+ to column of width BOOST_KARMA_DEFAULT_FIELD_MAXWIDTH
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">maxwidth(N)[a]</tt>
+ </td>
+<td>
+ <tt class="computeroutput">A</tt>
+ </td>
+<td>
+ Generate <tt class="computeroutput">a</tt> truncated
+ to column of width <tt class="computeroutput">N</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">repeat[a]</tt>
+ </td>
+<td>
+ <tt class="computeroutput">vector<A></tt>
+ </td>
+<td>
+ Repeat <tt class="computeroutput">a</tt> zero or
+ more times
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">repeat(N)[a]</tt>
+ </td>
+<td>
+ <tt class="computeroutput">vector<A></tt>
+ </td>
+<td>
+ Repeat <tt class="computeroutput">a</tt> <tt class="computeroutput">N</tt> times
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">repeat(N,
+ M)[a]</tt>
+ </td>
+<td>
+ <tt class="computeroutput">vector<A></tt>
+ </td>
+<td>
+ Repeat <tt class="computeroutput">a</tt> <tt class="computeroutput">N</tt> to <tt class="computeroutput">M</tt>
+ times
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">repeat(N,
+ inf)[a]</tt>
+ </td>
+<td>
+ <tt class="computeroutput">vector<A></tt>
+ </td>
+<td>
+ Repeat <tt class="computeroutput">a</tt> <tt class="computeroutput">N</tt> or more times
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">verbatim[a]</tt>
+ </td>
+<td>
+ <tt class="computeroutput">A</tt>
+ </td>
+<td>
+ Disable delimited generation for <tt class="computeroutput">a</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">delimit[a]</tt>
+ </td>
+<td>
+ <tt class="computeroutput">A</tt>
+ </td>
+<td>
+ Reestablish the delimiter that got inhibited by verbatim
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">delimit(g)[a]</tt>
+ </td>
+<td>
+ <tt class="computeroutput">A</tt>
+ </td>
+<td>
+ Use <tt class="computeroutput">g</tt> as a skipper
+ for generating <tt class="computeroutput">a</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">float_</tt>
+ </td>
+<td>
+ <tt class="computeroutput">float</tt>
+ </td>
+<td>
+ Generate a floating point number from a <tt class="computeroutput">float</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">double_</tt>
+ </td>
+<td>
+ <tt class="computeroutput">double</tt>
+ </td>
+<td>
+ Generate a floating point number from a <tt class="computeroutput">double</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">long_double</tt>
+ </td>
+<td>
+ <tt class="computeroutput">long double</tt>
+ </td>
+<td>
+ Generate a floating point number from a <tt class="computeroutput">long
+ double</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">bin</tt>
+ </td>
+<td>
+ <tt class="computeroutput">unsigned</tt>
+ </td>
+<td>
+ Generate a binary integer from an <tt class="computeroutput">unsigned</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">oct</tt>
+ </td>
+<td>
+ <tt class="computeroutput">unsigned</tt>
+ </td>
+<td>
+ Generate an octal integer from an <tt class="computeroutput">unsigned</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">hex</tt>
+ </td>
+<td>
+ <tt class="computeroutput">unsigned</tt>
+ </td>
+<td>
+ Generate a hexadecimal integer from an <tt class="computeroutput">unsigned</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ushort_</tt>
+ </td>
+<td>
+ <tt class="computeroutput">unsigned short</tt>
+ </td>
+<td>
+ Generate an unsigned short integer
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ulong_</tt>
+ </td>
+<td>
+ <tt class="computeroutput">unsigned long</tt>
+ </td>
+<td>
+ Generate an unsigned long integer
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">uint_</tt>
+ </td>
+<td>
+ <tt class="computeroutput">unsigned int</tt>
+ </td>
+<td>
+ Generate an unsigned int
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ulong_long</tt>
+ </td>
+<td>
+ <tt class="computeroutput">unsigned long
+ long</tt>
+ </td>
+<td>
+ Generate an unsigned long long
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">short_</tt>
+ </td>
+<td>
+ <tt class="computeroutput">short</tt>
+ </td>
+<td>
+ Generate a short integer
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">long_</tt>
+ </td>
+<td>
+ <tt class="computeroutput">long</tt>
+ </td>
+<td>
+ Generate a long integer
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">int_</tt>
+ </td>
+<td>
+ <tt class="computeroutput">int</tt>
+ </td>
+<td>
+ Generate an int
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">long_long</tt>
+ </td>
+<td>
+ <tt class="computeroutput">long long</tt>
+ </td>
+<td>
+ Generate a long long
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">!a</tt>
+ </td>
+<td>
+ <tt class="computeroutput">Unused</tt>
+ </td>
+<td>
+ Not predicate. Ensure that <tt class="computeroutput">a</tt>
+ does not succeed generating but don't create any output
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">&a</tt>
+ </td>
+<td>
+ <tt class="computeroutput">Unused</tt>
+ </td>
+<td>
+ And predicate. Ensure that <tt class="computeroutput">a</tt>
+ does succeed generating but don't create any output
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">-a</tt>
+ </td>
+<td>
+ <tt class="computeroutput">optional<A></tt>
+ </td>
+<td>
+ Optional. Generate <tt class="computeroutput">a</tt>
+ zero or one time
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">*a</tt>
+ </td>
+<td>
+ <tt class="computeroutput">vector<A></tt>
+ </td>
+<td>
+ Kleene. Generate <tt class="computeroutput">a</tt>
+ zero or more times
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">+a</tt>
+ </td>
+<td>
+ <tt class="computeroutput">vector<A></tt>
+ </td>
+<td>
+ Plus. Generate <tt class="computeroutput">a</tt>
+ one or more times
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">a |
+ b</tt>
+ </td>
+<td>
+ <tt class="computeroutput">variant<A,
+ B></tt>
+ </td>
+<td>
+ Alternative. Generate <tt class="computeroutput">a</tt>
+ or <tt class="computeroutput">b</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">a <<
+ b</tt>
+ </td>
+<td>
+ <tt class="computeroutput">tuple<A,
+ B></tt>
+ </td>
+<td>
+ Sequence. Generate <tt class="computeroutput">a</tt>
+ followed by <tt class="computeroutput">b</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">a %
+ b</tt>
+ </td>
+<td>
+ <tt class="computeroutput">vector<A></tt>
+ </td>
+<td>
+ List. Generate <tt class="computeroutput">a</tt>
+ delimited <tt class="computeroutput">b</tt> one
+ or more times
+ </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2001-2009 Joel
+ de Guzman, 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="common_notation.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../quick_reference.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="compound_attribute_rules.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/karma/quick_reference/semantic_actions.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/karma/quick_reference/semantic_actions.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -0,0 +1,76 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Semantic
+ Actions</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
+<link rel="home" href="../../../index.html" title="Spirit 2.1">
+<link rel="up" href="../quick_reference.html" title="Quick Reference">
+<link rel="previous" href="non_terminals.html" title="Non-terminals">
+<link rel="next" href="phoenix.html" title="Phoenix">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="non_terminals.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../quick_reference.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="phoenix.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h4 class="title">
+<a name="spirit.karma.quick_reference.semantic_actions"></a><a href="semantic_actions.html" title="Semantic
+ Actions">Semantic
+ Actions</a>
+</h4></div></div>
+<div></div>
+</div>
+
+ Has the form:
+ 
+<pre class="programlisting">p[f]
+</pre>
+
+ where <tt class="computeroutput">f</tt> is a function with
+ the signatures:
+ 
+<pre class="programlisting">void f(Attr const&);
+void f(Attr const&, Context&);
+void f(Attr const&, Context&, bool&);
+</pre>
+
+ You can use <tt class="computeroutput">Boost.Bind</tt>
+ to bind member functions. For function objects, the allowed signatures
+ are:
+ 
+<pre class="programlisting">void operator()(Attr const&, unused_type, unused_type) const;
+void operator()(Attr const&, Context&, unused_type) const;
+void operator()(Attr const&, Context&, bool&) const;
+</pre>
+
+ The <tt class="computeroutput">unused_type</tt> is used
+ in the signatures above to signify 'don't care'.
+ 
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2001-2009 Joel
+ de Guzman, 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="non_terminals.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../quick_reference.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="phoenix.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Modified: trunk/libs/spirit/doc/html/spirit/lex.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/lex.html (original)
+++ trunk/libs/spirit/doc/html/spirit/lex.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -6,9 +6,8 @@
<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
<link rel="home" href="../index.html" title="Spirit 2.1">
<link rel="up" href="../index.html" title="Spirit 2.1">
-<link rel="previous" href="karma.html" title=" Karma">
-<link rel="next" href="lex/tutorials.html" title=" Spirit.Lex
- Tutorials">
+<link rel="previous" href="karma/quick_reference/phoenix.html" title="Phoenix">
+<link rel="next" href="lex/lexer_introduction.html" title=" Introduction to Spirit.Lex">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
@@ -21,7 +20,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="karma.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="lex/tutorials.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="karma/quick_reference/phoenix.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="lex/lexer_introduction.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage">
@@ -31,11 +30,11 @@
<div></div>
</div>
<div class="toc"><dl>
-<dt> Introduction to Spirit.Lex</dt>
+<dt> Introduction to Spirit.Lex</dt>
<dt><a href="lex/tutorials.html"> Spirit.Lex
 Tutorials</a></dt>
<dd><dl>
-<dt><a href="lex/tutorials.html#spirit.lex.tutorials.lexer_tutorials"> Spirit.Lex
+<dt><a href="lex/tutorials/lexer_tutorials.html"> Spirit.Lex
 Tutorials Overview</a></dt>
<dt><a href="lex/tutorials/lexer_quickstart1.html"> Quickstart
 1 - A word counter using Spirit.Lex</a></dt>
@@ -46,7 +45,7 @@
</dl></dd>
<dt> Abstracts</dt>
<dd><dl>
-<dt>Lexer Primitives</dt>
+<dt>Lexer Primitives</dt>
<dt><a href="lex/abstracts/lexer_tokenizing.html"> Tokenizing
 Input Data</a></dt>
<dt><a href="lex/abstracts/lexer_semantic_actions.html"> Lexer
@@ -61,229 +60,13 @@
<dt> Quick Reference</dt>
<dt> Reference</dt>
<dd><dl>
-<dt> Concepts</dt>
+<dt> Concepts</dt>
<dt>Lexer Class</dt>
<dt>Token Class</dt>
<dt>TokenDef Class</dt>
<dt>TokenSet Class</dt>
</dl></dd>
</dl></div>
-<div class="section" lang="en">
-<div class="titlepage">
-<div><div><h3 class="title">
-<a name="spirit.lex.lexer_introduction"></a> Introduction to Spirit.Lex
-</h3></div></div>
-<div></div>
-</div>
-
- Lexical scanning is the process of analyzing the stream of input characters
- and separating it into strings called tokens, separated by whitespace. Most
- compiler texts start here, and devote several chapters to discussing various
- ways to build scanners. Spirit.Lex is a library built
- to take care of the complexities of creating a lexer for your grammar (in
- this documentation we will use the terms 'lexical analyzer', 'lexer' and
- 'scanner' interchangably). All it needs to create a lexer is to know the
- set of patterns describing the different tokens you want to recognize in
- the input. To make this a bit more formal, here are some definitions:
- 
-<div class="itemizedlist"><ul type="disc">
-<li>
- A token is a sequence of consecutive characters having a collective meaning.
- Tokens may have attributes specific to the token type, carrying additional
- information about the matched character sequence.
- </li>
-<li>
- A pattern is a rule expressed as a regular expression and describing how
- a particular token can be formed. For example, <tt class="literal">[A-Za-z][A-Za-z_0-9]*</tt>
- is a pattern for a rule matching C++ identifiers.
- </li>
-<li>
- Characters between tokens are called whitespace; these include spaces,
- tabs, newlines, and formfeeds. Many people also count comments as whitespace,
- though since some tools such as lint look at comments, this conflation
- is not perfect.
- </li>
-</ul></div>
-<a name="spirit.lex.lexer_introduction.why_use_a_separate_lexer_"></a><h4>
-<a name="id461463"></a>
- <a href="lex.html#spirit.lex.lexer_introduction.why_use_a_separate_lexer_">Why
- Use a Separate Lexer?</a>
- </h4>
-
- Typically, lexical scanning is done in a separate module from the parser,
- feeding the parser with a stream of input tokens only. Theoretically it is
- not necessary implement this separation as in the end there is only one set
- of syntactical rules defining the language, so in theory we could write the
- whole parser in one module. In fact, Spirit.Qi allows
- you to write parsers without using a lexer, parsing the input character stream
- directly, and for the most part this is the way Spirit
- has been used since its invention.
- 
-
- However, this separation has both practical and theoretical bases and proves
- to be very useful in practical applications. In 1956, Noam Chomsky defined
- the "Chomsky Hierarchy" of grammars:
- 
-<div class="itemizedlist"><ul type="disc">
-<li>
- Type 0: Unrestricted grammars (e.g., natural languages)
- </li>
-<li>
- Type 1: Context-Sensitive grammars
- </li>
-<li>
- Type 2: Context-Free grammars
- </li>
-<li>
- Type 3: Regular grammars
- </li>
-</ul></div>
-
- The complexity of these grammars increases from regular grammars being the
- simplest to unrestricted grammars being the most complex. Similarly, the
- complexity of the recognizers for these grammars increases. Although, a few
- features of some programming languages (such as C++) are Type 1, fortunately
- for the most part programming languages can be described using only the Types
- 3 and 2. The neat part about these two types is that they are well known
- and the ways to parse them are well understood. It has been shown that any
- regular grammar can be parsed using a state machine (finite automaton). Similarly,
- context-free grammars can always be parsed using a push-down automaton (essentially
- a state machine augmented by a stack).
- 
-
- In real programming languages and practical grammars the parts that can be
- handled as regular expressions tend to be the lower-level parts, such as
- the definition of an identifier or of an integer value:
- 
-<pre class="programlisting">letter := [a-zA-Z]
-digit := [0-9]
-
-identifier := letter [ letter | digit ]*
-integer := digit+
-</pre>
-
- Higher level parts of practical grammars tend to be more complex and can't
- be implemented using plain regular expressions. We need to store information
- on the built-in hardware stack while recursing the grammar hierarchy, and
- that in fact this is the preferred approach used for top-down parsing. Since
- it takes a different kind of abstract machine to parse the two types of grammars,
- it proved to be efficient to separate the lexical scanner into a separate
- module which is built around the idea of a state machine. The goal here is
- to use the simplest parsing technique needed for the job.
- 
-
- Another, more practical, reason for separating the scanner from the parser
- is the need for backtracking during parsing. The input data is a stream of
- characters, which is often thought to be processed left to right without
- any backtracking. Unfortunately, in practice most of the time that isn't
- possible. Almost every language has certain keywords such as IF, FOR, and
- WHILE. The decision if a certain character sequence actually comprises a
- keyword or just an identifier often can be made only after seeing the first
- delimiter after it. This already is a limited form of
- backtracking, since we need to store the string long enough to be able to
- make the decision. The same is true for more coarse grained language features
- such as nested IF/ELSE statements, where the decision about to which IF belongs
- the last ELSE statement can be made only after seeing the whole construct.
- 
-
- So the structure of a conventional compiler often involves splitting up the
- functions of the lower-level and higher-level parsing. The lexical scanner
- deals with things at the character level, collecting characters into strings,
- converting character sequence into different representations as integers,
- etc., and passing them along to the parser proper as indivisible tokens.
- It's also considered normal to let the scanner do additional jobs, such as
- identifying keywords, storing identifiers in tables, etc.
- 
-
- Now, Spirit follows this
- structure, where Spirit.Lex can be used to implement
- state machine based recognizers, while Spirit.Qi can
- be used to build recognizers for context free grammars. Since both modules
- are seemlessly integrated with each other and with the C++ target language
- it is even possible to use the provided functionality to build more complex
- grammar recognizers.
- 
-<a name="spirit.lex.lexer_introduction.advantages_of_using__emphasis_spirit_lex__emphasis_"></a><h4>
-<a name="id461807"></a>
- <a href="lex.html#spirit.lex.lexer_introduction.advantages_of_using__emphasis_spirit_lex__emphasis_">Advantages
- of using Spirit.Lex</a>
- </h4>
-
- The advantage of using Spirit.Lex to create the lexical
- analyzer over using more traditional tools such as Flex
- is its carefully crafted integration with the Spirit
- library and the C++ host language. You don't need any external tools to generate
- the code, your lexer will be perfectly integrated with the rest of your program,
- making it possible to freely access any context information and data structure.
- Since the C++ compiler sees all the code it will generate optimal code nomatter
- what configuration options have been chosen by the user. Spirit.Lex
- gives you the vast majority of features you could get from a similar Flex program without the need
- to leave C++ as a host language:
- 
-<div class="itemizedlist"><ul type="disc">
-<li>
- The definition of tokens is done using regular expressions (patterns)
- </li>
-<li>
- The token definitions can refer to special substitution strings (pattern
- macros) simplifying pattern definitions
- </li>
-<li>
- The generated lexical scanner may have multiple start states
- </li>
-<li>
- It is possible to attach code to any of the token definitions; this code
- gets executed whenever the corresponding token pattern has been matched
- </li>
-</ul></div>
-
- Even if it is possible to use Spirit.Lex to generate
- C++ code representing the lexical analyzer (we will refer to that as the
- static model, described in more detail in the section
- <a href="lex/abstracts/lexer_static_model.html" title=" The Static
- Lexer Model">The Static
- Model</a>) - a model very similar to the way Flex
- operates - we will mainly focus on the opposite, the dynamic
- model. You can directly integrate the token definitions into your C++ program,
- building the lexical analyzer dynamically at runtime. The dynamic model is
- something not supported by Flex
- or other lexical scanner generators (such as re2c,
- Ragel, etc.).
- But it is very flexible and allows you to speed up the development of your
- application.
- 
-<a name="spirit.lex.lexer_introduction.the_library_structure_of__emphasis_spirit_lex__emphasis_"></a><h4>
-<a name="id461977"></a>
- <a href="lex.html#spirit.lex.lexer_introduction.the_library_structure_of__emphasis_spirit_lex__emphasis_">The
- Library Structure of Spirit.Lex</a>
- </h4>
-
- The <a href="lex.html#spirit.lexerflow" title="Figure 3. The Library structure and Common Flow of Information while
- using Spirit.Lex in an application">figure</a> below shows a high level
- overview of how the Spirit.Lex library might be used
- in an application. Spirit.Lex allows to create lexical
- analyzers based on patterns. These patterns are regular expression based
- rules used to define the different tokens to be recognized in the character
- input sequence. The input sequence is expected to be provided to the lexical
- analyzer as an arbitrary standard forward iterator. The lexical analyzer
- itself exposes a standard forward iterator as well. The difference here is
- that the exposed iterator provides access to the token sequence instead of
- to the character sequence. The tokens in this sequence are constructed on
- the fly by analyzing the underlying character sequence and matching this
- to the patterns as defined by the application.
- 
-
- 
-<div class="figure">
-<a name="spirit.lexerflow"></a>Figure 3. The Library structure and Common Flow of Information while
- using Spirit.Lex in an application
-<img src="./images/lexerflow.png" alt="The
- Library structure and Common Flow of Information while using Spirit.Lex
- in an application">
-</div>
-
- 
-</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
@@ -296,7 +79,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="karma.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="lex/tutorials.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="karma/quick_reference/phoenix.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="lex/lexer_introduction.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>

Modified: trunk/libs/spirit/doc/html/spirit/lex/abstracts.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/lex/abstracts.html (original)
+++ trunk/libs/spirit/doc/html/spirit/lex/abstracts.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -8,8 +8,7 @@
<link rel="up" href="../lex.html" title=" Spirit.Lex">
<link rel="previous" href="tutorials/lexer_quickstart3.html" title=" Quickstart
3 - Counting Words Using a Parser">
-<link rel="next" href="abstracts/lexer_tokenizing.html" title=" Tokenizing
- Input Data">
+<link rel="next" href="abstracts/lexer_primitives.html" title="Lexer Primitives">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
@@ -22,7 +21,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="tutorials/lexer_quickstart3.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../lex.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="abstracts/lexer_tokenizing.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="tutorials/lexer_quickstart3.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../lex.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="abstracts/lexer_primitives.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage">
@@ -32,7 +31,7 @@
<div></div>
</div>
<div class="toc"><dl>
-<dt>Lexer Primitives</dt>
+<dt>Lexer Primitives</dt>
<dt><a href="abstracts/lexer_tokenizing.html"> Tokenizing
Input Data</a></dt>
<dt><a href="abstracts/lexer_semantic_actions.html"> Lexer
@@ -44,372 +43,6 @@
<dt> Lexer Attributes</dt>
<dt> Lexer States</dt>
</dl></div>
-<div class="section" lang="en">
-<div class="titlepage">
-<div><div><h4 class="title">
-<a name="spirit.lex.abstracts.lexer_primitives"></a>Lexer Primitives
-</h4></div></div>
-<div></div>
-</div>
-<div class="toc"><dl>
-<dt><a href="abstracts.html#spirit.lex.abstracts.lexer_primitives.lexer_primitives">
- Lexer Primitives</a></dt>
-<dt><a href="abstracts.html#spirit.lex.abstracts.lexer_primitives.lexer_token_values">
- About Tokens and Token Values</a></dt>
-<dt><a href="abstracts.html#spirit.lex.abstracts.lexer_primitives.lexer_token_definition">
- Ways to define Tokens</a></dt>
-</dl></div>
-<div class="section" lang="en"><div class="titlepage">
-<div><div><h5 class="title">
-<a name="spirit.lex.abstracts.lexer_primitives.lexer_primitives"></a><a href="abstracts.html#spirit.lex.abstracts.lexer_primitives.lexer_primitives" title="
- Lexer Primitives">
- Lexer Primitives</a>
-</h5></div></div>
-<div></div>
-</div></div>
-<div class="section" lang="en">
-<div class="titlepage">
-<div><div><h5 class="title">
-<a name="spirit.lex.abstracts.lexer_primitives.lexer_token_values"></a><a href="abstracts.html#spirit.lex.abstracts.lexer_primitives.lexer_token_values" title="
- About Tokens and Token Values">
- About Tokens and Token Values</a>
-</h5></div></div>
-<div></div>
-</div>
-
- As already discussed, lexical scanning is the process of analyzing the
- stream of input characters and separating it into strings called tokens,
- most of the time separated by whitespace. The different token types recognized
- by a lexical analyzer often get assigned unique integer token identifiers
- (token ids). These token ids arenormally used by the parser to identifiy
- the current token without having to look at the matched string again.
- The Spirit.Lex library is not different with respect
- to this, as it uses the token ids as the main means of identification
- of the different token types defined for a particular lexical analyzer.
- However, it is different from commonly used lexical analyzers in the
- sense that it returns (references to) instances of a (user defined) token
- class to the user. The only real limitation posed on this token class
- is consequently, that it has to carry at least the token id of the token
- it represents. For more information about the interface a user defined
- token type has to expose please look at the <a href="reference.html#spirit.lex.reference.concepts.token" title="Token">Token
- Reference</a> reference. The library provides a default token type
- based on the Lexertl
- library which should be sufficient in most use cases: the lexertl_token<>
- type. This section focusses on the description of general features a
- token class may implement and how this integrates with the other parts
- of the Spirit.Lex library.
- 
-<a name="spirit.lex.abstracts.lexer_primitives.lexer_token_values.the_anatomy_of_a_token"></a><h6>
-<a name="id474330"></a>
- <a href="abstracts.html#spirit.lex.abstracts.lexer_primitives.lexer_token_values.the_anatomy_of_a_token">The
- Anatomy of a Token</a>
- </h6>
-
- It is very important to understand the difference between a token definition
- (represented by the token_def<>
- template) and a token itself (for instance represented by the lexertl_token<>
- template).
- 
-
- The token definition is used to describe the main features of a particular
- token type, especially:
- 
-<div class="itemizedlist"><ul type="disc">
-<li>
- to simplify the definition of a token type using a regular expression
- pattern applied while matching this token type,
- </li>
-<li>
- to associate a token type with a particular lexer state,
- </li>
-<li>
- to optionally assign a token id to a token type,
- </li>
-<li>
- to optionally associate some code to execute whenever an instance of
- this token type has been matched,
- </li>
-<li>
- and to optionally specify the attribute type of the token value.
- </li>
-</ul></div>
-
- The token itself is a data structure returned by the lexer iterators.
- Dereferencing a lexer iterator returns a reference to the last matched
- token instance. It encapsulates the part of the underlying input sequence
- matched by the regular expression used during the definiton of this token
- type. Incrementing the lexer iterator invokes the lexical analyzer to
- match the next token by advancing the underlying input stream. The token
- data structure contains at least the token id of the matched token type,
- allowing to identify the matched character sequence. Optionally, the
- token instance may contain a token value and/or the lexer state this
- token instance was matched in. The following figure
- shows the schematic structure of a token.
- 
-
- 
-<div class="figure">
-<a name="spirit.lex.tokenstructure"></a>Figure 5. The structure of a token
-<img src="./images/tokenstructure.png" alt="The
- structure of a token">
-</div>
-
- 
-
- The token value and the token state may be omitted for optimization reasons,
- avoiding the token to carry more data than actually required. This configuration
- can be achieved by supplying appropriate template parameters for the
- lexertl_token<> template while defining
- the token type.
- 
-
- The lexer iterator returns the same token type for each of the different
- matched token definitions. To accomodate for the possibly different token
- value types exposed by the various token types (token
- definitions), the general type of the token value is a boost.variant<>.
- As a minimum (for the default configuration) this token value variant
- will be configured to always hold a boost::iterator_range<>
- containing the pair of iterators pointing to the matched input sequence
- for this token instance.
- 
-<div class="note"><table border="0" summary="Note">
-<tr>
-<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../images/note.png"></td>
-<th align="left">Note</th>
-</tr>
-<tr><td colspan="2" align="left" valign="top">
- If the lexical analyzer is used in conjunction with a Spirit.Qi
- parser, the stored boost::iterator_range<>
- token value will be converted to the requested token type (parser attribute)
- exactly once. This happens at the time of the first access to the token
- value requiring the corresponding type conversion. The converted token
- value will be stored in the boost.variant<>
- replacing the initially stored iterator range. This avoids to convert
- the input sequence to the token value more than once, thus optimizing
- the integration of the lexer with Spirit.Qi, even
- during parser backtracking.
- </td></tr>
-</table></div>
-
- Here is the template prototype of the lexertl_token<>
- template:
- 
-<pre class="programlisting">template <
- typename Iterator = char const*,
- typename AttributeTypes = mpl::vector0<>,
- typename HasState = mpl::true_
->
-struct lexertl_token;
-</pre>
-<div class="variablelist">
-where:
-<dl>
-<dt>Iterator</dt>
-<dd>
- This is the type of the iterator used to access the underlying input
- stream. It defaults to a plain <tt class="computeroutput">char
- const*</tt>.
- </dd>
-<dt>AttributeTypes</dt>
-<dd>
- This is either a mpl sequence containing all attribute types used
- for the token definitions or the type <tt class="computeroutput">omitted</tt>.
- If the mpl sequence is empty (which is the default), all token instances
- will store a <tt class="computeroutput">boost::iterator_range<Iterator></tt> pointing to the start and the
- end of the matched section in the input stream. If the type is <tt class="computeroutput">omitted</tt>, the generated tokens will
- contain no token value (attribute) at all.
- </dd>
-<dt>HasState</dt>
-<dd>
- This is either <tt class="computeroutput">mpl::true_</tt>
- or <tt class="computeroutput">mpl::false_</tt>, allowing to control whether
- the generated token instances will contain the lexer state they were
- generated in. The default is mpl::true_, so all token instances will
- contain the lexer state.
- </dd>
-</dl>
-</div>
-
- Normally, during its construction, a token instance always holds the
- boost::iterator_range<>
- as its token value (except, if it has been defined using the <tt class="computeroutput">omitted</tt> token value type). This iterator
- range then is converted in place to the requested token value type (attribute)
- when it is requested for the first time.
- 
-<a name="spirit.lex.abstracts.lexer_primitives.lexer_token_values.the_physiognomy_of_a_token_definition"></a><h6>
-<a name="id475137"></a>
- <a href="abstracts.html#spirit.lex.abstracts.lexer_primitives.lexer_token_values.the_physiognomy_of_a_token_definition">The
- Physiognomy of a Token Definition</a>
- </h6>
-
- The token definitions (represented by the token_def<>
- template) are normally used as part of the definition of the lexical
- analyzer. At the same time a token definition instance may be used as
- a parser component in Spirit.Qi.
- 
-
- The template prototype of this class is shown here:
- 
-<pre class="programlisting">template<
- typename Attribute = unused_type,
- typename Char = char
->
-class token_def;
-</pre>
-<div class="variablelist">
-where:
-<dl>
-<dt>Attribute</dt>
-<dd>
- This is the type of the token value (attribute) supported by token
- instances representing this token type. This attribute type is exposed
- to the Spirit.Qi library, whenever this token
- definition is used as a parser component. The default attribute type
- is <tt class="computeroutput">unused_type</tt>, which
- means the token instance holds a boost::iterator_range<>
- pointing to the start and the end of the matched section in the input
- stream. If the attribute is <tt class="computeroutput">omitted</tt>
- the token instance will expose no token type at all. Any other type
- will be used directly as the token value type.
- </dd>
-<dt>Char</dt>
-<dd>
- This is the value type of the iterator for the underlying input sequence.
- It defaults to <tt class="computeroutput">char</tt>.
- </dd>
-</dl>
-</div>
-
- The semantics of the template parameters for the token type and the token
- definition type are very similar and interdependent. As a rule of thumb
- you can think of the token definition type as the means of specifying
- everything related to a single specific token type (such as <tt class="computeroutput">identifier</tt> or <tt class="computeroutput">integer</tt>).
- On the other hand the token type is used to define the general proerties
- of all token instances generated by the Spirit.Lex
- library.
- 
-<div class="important"><table border="0" summary="Important">
-<tr>
-<td rowspan="2" align="center" valign="top" width="25"><img alt="[Important]" src="../../images/important.png"></td>
-<th align="left">Important</th>
-</tr>
-<tr><td colspan="2" align="left" valign="top">
-
- If you don't list any token value types in the token type definition
- declaration (resulting in the usage of the default boost::iterator_range<>
- token type) everything will compile and work just fine, just a bit
- less efficient. This is because the token value will be converted from
- the matched input sequence every time it is requested.
- 
-
- But as soon as you specify at least one token value type while defining
- the token type you'll have to list all value types used for token_def<>
- declarations in the token definition class, otherwise compilation errors
- will occur.
- 
-</td></tr>
-</table></div>
-<a name="spirit.lex.abstracts.lexer_primitives.lexer_token_values.examples_of_using__link_linkend__spirit_lex_reference_token_class___code__phrase_role__identifier__lexertl_token__phrase__phrase_role__special___lt__gt___phrase___code___link_"></a><h6>
-<a name="id475547"></a>
- <a href="abstracts.html#spirit.lex.abstracts.lexer_primitives.lexer_token_values.examples_of_using__link_linkend__spirit_lex_reference_token_class___code__phrase_role__identifier__lexertl_token__phrase__phrase_role__special___lt__gt___phrase___code___link_">Examples
- of using lexertl_token<></a>
- </h6>
-
- Let's start with some examples. We refer to one of the Spirit.Lex
- examples (for the full source code of this example please see example4.cpp).
- 
-
- The first code snippet shows an excerpt of the token definition class,
- the definition of a couple of token types. Some of the token types do
- not expose a special token value (<tt class="computeroutput">if_</tt>,
- <tt class="computeroutput">else_</tt>, and <tt class="computeroutput">while_</tt>). Their token value will always
- hold the iterator range of the matched input sequence only. The token
- definitions for the <tt class="computeroutput">identifier</tt>
- and the integer <tt class="computeroutput">constant</tt>
- are specialized to expose an explicit token type each: <tt class="computeroutput">std::string</tt> and <tt class="computeroutput">unsigned
- int</tt>.
- 
-
- 
-
-
-
-<pre class="programlisting">// these tokens expose the iterator_range of the matched input sequence
-token_def<> if_, else_, while_;
-
-// The following two tokens have an associated attribute type, 'identifier'
-// carries a string (the identifier name) and 'constant' carries the
-// matched integer value.
-//
-// Note: any token attribute type explicitly specified in a token_def<>
-// declaration needs to be listed during token type definition as
-// well (see the typedef for the token_type below).
-//
-// The conversion of the matched input to an instance of this type occurs
-// once (on first access), which makes token attributes as efficient as
-// possible. Moreover, token instances are constructed once by the lexer
-// library. From this point on tokens are passed by reference only,
-// avoiding them being copied around.
-token_def<std::string> identifier;
-token_def<unsigned int> constant;
-</pre>
-
- 
-
- 
-
- As the parsers generated by Spirit.Qi are fully
- attributed, any Spirit.Qi parser component needs
- to expose a certain type as its parser attribute. Naturally, the token_def<> exposes the token value
- type as its parser attribute, enabling a smooth integration with Spirit.Qi.
- 
-
- The next code snippet demonstrates how the required token value types
- are specified while defining the token type to use. All of the token
- value types used for at least one of the token definitions have to be
- re-iterated for the token definition as well.
- 
-
- 
-
-
-
-<pre class="programlisting">// This is the lexer token type to use. The second template parameter lists
-// all attribute types used for token_def's during token definition (see
-// calculator_tokens<> above). Here we use the predefined lexertl token
-// type, but any compatible token type may be used instead.
-//
-// If you don't list any token attribute types in the following declaration
-// (or just use the default token type: lexertl_token<base_iterator_type>)
-// it will compile and work just fine, just a bit less efficient. This is
-// because the token attribute will be generated from the matched input
-// sequence every time it is requested. But as soon as you specify at
-// least one token attribute type you'll have to list all attribute types
-// used for token_def<> declarations in the token definition class above,
-// otherwise compilation errors will occur.
-typedef lexertl::token<
- base_iterator_type, boost::mpl::vector<unsigned int, std::string>
-> token_type;
-</pre>
-
- 
-
- 
-
- To avoid the token to have a token value at all, the special tag <tt class="computeroutput">omitted</tt> can be used: <tt class="computeroutput">token_def<omitted></tt>
- and <tt class="computeroutput">lexertl_token<base_iterator_type,
- omitted></tt>.
- 
-</div>
-<div class="section" lang="en"><div class="titlepage">
-<div><div><h5 class="title">
-<a name="spirit.lex.abstracts.lexer_primitives.lexer_token_definition"></a><a href="abstracts.html#spirit.lex.abstracts.lexer_primitives.lexer_token_definition" title="
- Ways to define Tokens">
- Ways to define Tokens</a>
-</h5></div></div>
-<div></div>
-</div></div>
-</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
@@ -422,7 +55,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="tutorials/lexer_quickstart3.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../lex.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="abstracts/lexer_tokenizing.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="tutorials/lexer_quickstart3.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../lex.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="abstracts/lexer_primitives.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>

Added: trunk/libs/spirit/doc/html/spirit/lex/abstracts/lexer_primitives.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/lex/abstracts/lexer_primitives.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -0,0 +1,56 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Lexer Primitives</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
+<link rel="home" href="../../../index.html" title="Spirit 2.1">
+<link rel="up" href="../abstracts.html" title=" Abstracts">
+<link rel="previous" href="../abstracts.html" title=" Abstracts">
+<link rel="next" href="lexer_primitives/lexer_primitives.html" title="
+ Lexer Primitives">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../abstracts.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../abstracts.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="lexer_primitives/lexer_primitives.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h4 class="title">
+<a name="spirit.lex.abstracts.lexer_primitives"></a>Lexer Primitives
+</h4></div></div>
+<div></div>
+</div>
+<div class="toc"><dl>
+<dt><a href="lexer_primitives/lexer_primitives.html">
+ Lexer Primitives</a></dt>
+<dt><a href="lexer_primitives/lexer_token_values.html">
+ About Tokens and Token Values</a></dt>
+<dt><a href="lexer_primitives/lexer_token_definition.html">
+ Ways to define Tokens</a></dt>
+</dl></div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2001-2009 Joel
+ de Guzman, 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../abstracts.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../abstracts.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="lexer_primitives/lexer_primitives.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/lex/abstracts/lexer_primitives/lexer_primitives.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/lex/abstracts/lexer_primitives/lexer_primitives.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -0,0 +1,49 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>
+ Lexer Primitives</title>
+<link rel="stylesheet" href="../../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
+<link rel="home" href="../../../../index.html" title="Spirit 2.1">
+<link rel="up" href="../lexer_primitives.html" title="Lexer Primitives">
+<link rel="previous" href="../lexer_primitives.html" title="Lexer Primitives">
+<link rel="next" href="lexer_token_values.html" title="
+ About Tokens and Token Values">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../lexer_primitives.html"><img src="../../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../lexer_primitives.html"><img src="../../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="lexer_token_values.html"><img src="../../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en"><div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.lex.abstracts.lexer_primitives.lexer_primitives"></a><a href="lexer_primitives.html" title="
+ Lexer Primitives">
+ Lexer Primitives</a>
+</h5></div></div>
+<div></div>
+</div></div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2001-2009 Joel
+ de Guzman, 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../lexer_primitives.html"><img src="../../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../lexer_primitives.html"><img src="../../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="lexer_token_values.html"><img src="../../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/lex/abstracts/lexer_primitives/lexer_token_definition.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/lex/abstracts/lexer_primitives/lexer_token_definition.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -0,0 +1,50 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>
+ Ways to define Tokens</title>
+<link rel="stylesheet" href="../../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
+<link rel="home" href="../../../../index.html" title="Spirit 2.1">
+<link rel="up" href="../lexer_primitives.html" title="Lexer Primitives">
+<link rel="previous" href="lexer_token_values.html" title="
+ About Tokens and Token Values">
+<link rel="next" href="../lexer_tokenizing.html" title=" Tokenizing
+ Input Data">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="lexer_token_values.html"><img src="../../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../lexer_primitives.html"><img src="../../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../lexer_tokenizing.html"><img src="../../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en"><div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.lex.abstracts.lexer_primitives.lexer_token_definition"></a><a href="lexer_token_definition.html" title="
+ Ways to define Tokens">
+ Ways to define Tokens</a>
+</h5></div></div>
+<div></div>
+</div></div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2001-2009 Joel
+ de Guzman, 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="lexer_token_values.html"><img src="../../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../lexer_primitives.html"><img src="../../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../lexer_tokenizing.html"><img src="../../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/lex/abstracts/lexer_primitives/lexer_token_values.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/lex/abstracts/lexer_primitives/lexer_token_values.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -0,0 +1,376 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>
+ About Tokens and Token Values</title>
+<link rel="stylesheet" href="../../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
+<link rel="home" href="../../../../index.html" title="Spirit 2.1">
+<link rel="up" href="../lexer_primitives.html" title="Lexer Primitives">
+<link rel="previous" href="lexer_primitives.html" title="
+ Lexer Primitives">
+<link rel="next" href="lexer_token_definition.html" title="
+ Ways to define Tokens">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="lexer_primitives.html"><img src="../../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../lexer_primitives.html"><img src="../../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="lexer_token_definition.html"><img src="../../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.lex.abstracts.lexer_primitives.lexer_token_values"></a><a href="lexer_token_values.html" title="
+ About Tokens and Token Values">
+ About Tokens and Token Values</a>
+</h5></div></div>
+<div></div>
+</div>
+
+ As already discussed, lexical scanning is the process of analyzing the
+ stream of input characters and separating it into strings called tokens,
+ most of the time separated by whitespace. The different token types recognized
+ by a lexical analyzer often get assigned unique integer token identifiers
+ (token ids). These token ids arenormally used by the parser to identifiy
+ the current token without having to look at the matched string again.
+ The Spirit.Lex library is not different with respect
+ to this, as it uses the token ids as the main means of identification
+ of the different token types defined for a particular lexical analyzer.
+ However, it is different from commonly used lexical analyzers in the
+ sense that it returns (references to) instances of a (user defined) token
+ class to the user. The only real limitation posed on this token class
+ is consequently, that it has to carry at least the token id of the token
+ it represents. For more information about the interface a user defined
+ token type has to expose please look at the <a href="../../reference/concepts/token.html" title="Token">Token
+ Reference</a> reference. The library provides a default token type
+ based on the Lexertl
+ library which should be sufficient in most use cases: the lexertl_token<>
+ type. This section focusses on the description of general features a
+ token class may implement and how this integrates with the other parts
+ of the Spirit.Lex library.
+ 
+<a name="spirit.lex.abstracts.lexer_primitives.lexer_token_values.the_anatomy_of_a_token"></a><h6>
+<a name="id474470"></a>
+ <a href="lexer_token_values.html#spirit.lex.abstracts.lexer_primitives.lexer_token_values.the_anatomy_of_a_token">The
+ Anatomy of a Token</a>
+ </h6>
+
+ It is very important to understand the difference between a token definition
+ (represented by the token_def<>
+ template) and a token itself (for instance represented by the lexertl_token<>
+ template).
+ 
+
+ The token definition is used to describe the main features of a particular
+ token type, especially:
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ to simplify the definition of a token type using a regular expression
+ pattern applied while matching this token type,
+ </li>
+<li>
+ to associate a token type with a particular lexer state,
+ </li>
+<li>
+ to optionally assign a token id to a token type,
+ </li>
+<li>
+ to optionally associate some code to execute whenever an instance of
+ this token type has been matched,
+ </li>
+<li>
+ and to optionally specify the attribute type of the token value.
+ </li>
+</ul></div>
+
+ The token itself is a data structure returned by the lexer iterators.
+ Dereferencing a lexer iterator returns a reference to the last matched
+ token instance. It encapsulates the part of the underlying input sequence
+ matched by the regular expression used during the definiton of this token
+ type. Incrementing the lexer iterator invokes the lexical analyzer to
+ match the next token by advancing the underlying input stream. The token
+ data structure contains at least the token id of the matched token type,
+ allowing to identify the matched character sequence. Optionally, the
+ token instance may contain a token value and/or the lexer state this
+ token instance was matched in. The following figure
+ shows the schematic structure of a token.
+ 
+
+ 
+<div class="figure">
+<a name="spirit.lex.tokenstructure"></a>Figure 5. The structure of a token
+<img src="./images/tokenstructure.png" alt="The
+ structure of a token">
+</div>
+
+ 
+
+ The token value and the token state may be omitted for optimization reasons,
+ avoiding the token to carry more data than actually required. This configuration
+ can be achieved by supplying appropriate template parameters for the
+ lexertl_token<> template while defining
+ the token type.
+ 
+
+ The lexer iterator returns the same token type for each of the different
+ matched token definitions. To accomodate for the possibly different token
+ value types exposed by the various token types (token
+ definitions), the general type of the token value is a boost.variant<>.
+ As a minimum (for the default configuration) this token value variant
+ will be configured to always hold a boost::iterator_range<>
+ containing the pair of iterators pointing to the matched input sequence
+ for this token instance.
+ 
+<div class="note"><table border="0" summary="Note">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../images/note.png"></td>
+<th align="left">Note</th>
+</tr>
+<tr><td colspan="2" align="left" valign="top">
+ If the lexical analyzer is used in conjunction with a Spirit.Qi
+ parser, the stored boost::iterator_range<>
+ token value will be converted to the requested token type (parser attribute)
+ exactly once. This happens at the time of the first access to the token
+ value requiring the corresponding type conversion. The converted token
+ value will be stored in the boost.variant<>
+ replacing the initially stored iterator range. This avoids to convert
+ the input sequence to the token value more than once, thus optimizing
+ the integration of the lexer with Spirit.Qi, even
+ during parser backtracking.
+ </td></tr>
+</table></div>
+
+ Here is the template prototype of the lexertl_token<>
+ template:
+ 
+<pre class="programlisting">template <
+ typename Iterator = char const*,
+ typename AttributeTypes = mpl::vector0<>,
+ typename HasState = mpl::true_
+>
+struct lexertl_token;
+</pre>
+<div class="variablelist">
+where:
+<dl>
+<dt>Iterator</dt>
+<dd>
+ This is the type of the iterator used to access the underlying input
+ stream. It defaults to a plain <tt class="computeroutput">char
+ const*</tt>.
+ </dd>
+<dt>AttributeTypes</dt>
+<dd>
+ This is either a mpl sequence containing all attribute types used
+ for the token definitions or the type <tt class="computeroutput">omitted</tt>.
+ If the mpl sequence is empty (which is the default), all token instances
+ will store a <tt class="computeroutput">boost::iterator_range<Iterator></tt> pointing to the start and the
+ end of the matched section in the input stream. If the type is <tt class="computeroutput">omitted</tt>, the generated tokens will
+ contain no token value (attribute) at all.
+ </dd>
+<dt>HasState</dt>
+<dd>
+ This is either <tt class="computeroutput">mpl::true_</tt>
+ or <tt class="computeroutput">mpl::false_</tt>, allowing to control whether
+ the generated token instances will contain the lexer state they were
+ generated in. The default is mpl::true_, so all token instances will
+ contain the lexer state.
+ </dd>
+</dl>
+</div>
+
+ Normally, during its construction, a token instance always holds the
+ boost::iterator_range<>
+ as its token value (except, if it has been defined using the <tt class="computeroutput">omitted</tt> token value type). This iterator
+ range then is converted in place to the requested token value type (attribute)
+ when it is requested for the first time.
+ 
+<a name="spirit.lex.abstracts.lexer_primitives.lexer_token_values.the_physiognomy_of_a_token_definition"></a><h6>
+<a name="id475277"></a>
+ <a href="lexer_token_values.html#spirit.lex.abstracts.lexer_primitives.lexer_token_values.the_physiognomy_of_a_token_definition">The
+ Physiognomy of a Token Definition</a>
+ </h6>
+
+ The token definitions (represented by the token_def<>
+ template) are normally used as part of the definition of the lexical
+ analyzer. At the same time a token definition instance may be used as
+ a parser component in Spirit.Qi.
+ 
+
+ The template prototype of this class is shown here:
+ 
+<pre class="programlisting">template<
+ typename Attribute = unused_type,
+ typename Char = char
+>
+class token_def;
+</pre>
+<div class="variablelist">
+where:
+<dl>
+<dt>Attribute</dt>
+<dd>
+ This is the type of the token value (attribute) supported by token
+ instances representing this token type. This attribute type is exposed
+ to the Spirit.Qi library, whenever this token
+ definition is used as a parser component. The default attribute type
+ is <tt class="computeroutput">unused_type</tt>, which
+ means the token instance holds a boost::iterator_range<>
+ pointing to the start and the end of the matched section in the input
+ stream. If the attribute is <tt class="computeroutput">omitted</tt>
+ the token instance will expose no token type at all. Any other type
+ will be used directly as the token value type.
+ </dd>
+<dt>Char</dt>
+<dd>
+ This is the value type of the iterator for the underlying input sequence.
+ It defaults to <tt class="computeroutput">char</tt>.
+ </dd>
+</dl>
+</div>
+
+ The semantics of the template parameters for the token type and the token
+ definition type are very similar and interdependent. As a rule of thumb
+ you can think of the token definition type as the means of specifying
+ everything related to a single specific token type (such as <tt class="computeroutput">identifier</tt> or <tt class="computeroutput">integer</tt>).
+ On the other hand the token type is used to define the general proerties
+ of all token instances generated by the Spirit.Lex
+ library.
+ 
+<div class="important"><table border="0" summary="Important">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Important]" src="../../../../images/important.png"></td>
+<th align="left">Important</th>
+</tr>
+<tr><td colspan="2" align="left" valign="top">
+
+ If you don't list any token value types in the token type definition
+ declaration (resulting in the usage of the default boost::iterator_range<>
+ token type) everything will compile and work just fine, just a bit
+ less efficient. This is because the token value will be converted from
+ the matched input sequence every time it is requested.
+ 
+
+ But as soon as you specify at least one token value type while defining
+ the token type you'll have to list all value types used for token_def<>
+ declarations in the token definition class, otherwise compilation errors
+ will occur.
+ 
+</td></tr>
+</table></div>
+<a name="spirit.lex.abstracts.lexer_primitives.lexer_token_values.examples_of_using__link_linkend__spirit_lex_reference_token_class___code__phrase_role__identifier__lexertl_token__phrase__phrase_role__special___lt__gt___phrase___code___link_"></a><h6>
+<a name="id475687"></a>
+ <a href="lexer_token_values.html#spirit.lex.abstracts.lexer_primitives.lexer_token_values.examples_of_using__link_linkend__spirit_lex_reference_token_class___code__phrase_role__identifier__lexertl_token__phrase__phrase_role__special___lt__gt___phrase___code___link_">Examples
+ of using lexertl_token<></a>
+ </h6>
+
+ Let's start with some examples. We refer to one of the Spirit.Lex
+ examples (for the full source code of this example please see example4.cpp).
+ 
+
+ The first code snippet shows an excerpt of the token definition class,
+ the definition of a couple of token types. Some of the token types do
+ not expose a special token value (<tt class="computeroutput">if_</tt>,
+ <tt class="computeroutput">else_</tt>, and <tt class="computeroutput">while_</tt>). Their token value will always
+ hold the iterator range of the matched input sequence only. The token
+ definitions for the <tt class="computeroutput">identifier</tt>
+ and the integer <tt class="computeroutput">constant</tt>
+ are specialized to expose an explicit token type each: <tt class="computeroutput">std::string</tt> and <tt class="computeroutput">unsigned
+ int</tt>.
+ 
+
+ 
+
+
+
+<pre class="programlisting">// these tokens expose the iterator_range of the matched input sequence
+token_def<> if_, else_, while_;
+
+// The following two tokens have an associated attribute type, 'identifier'
+// carries a string (the identifier name) and 'constant' carries the
+// matched integer value.
+//
+// Note: any token attribute type explicitly specified in a token_def<>
+// declaration needs to be listed during token type definition as
+// well (see the typedef for the token_type below).
+//
+// The conversion of the matched input to an instance of this type occurs
+// once (on first access), which makes token attributes as efficient as
+// possible. Moreover, token instances are constructed once by the lexer
+// library. From this point on tokens are passed by reference only,
+// avoiding them being copied around.
+token_def<std::string> identifier;
+token_def<unsigned int> constant;
+</pre>
+
+ 
+
+ 
+
+ As the parsers generated by Spirit.Qi are fully
+ attributed, any Spirit.Qi parser component needs
+ to expose a certain type as its parser attribute. Naturally, the token_def<> exposes the token value
+ type as its parser attribute, enabling a smooth integration with Spirit.Qi.
+ 
+
+ The next code snippet demonstrates how the required token value types
+ are specified while defining the token type to use. All of the token
+ value types used for at least one of the token definitions have to be
+ re-iterated for the token definition as well.
+ 
+
+ 
+
+
+
+<pre class="programlisting">// This is the lexer token type to use. The second template parameter lists
+// all attribute types used for token_def's during token definition (see
+// calculator_tokens<> above). Here we use the predefined lexertl token
+// type, but any compatible token type may be used instead.
+//
+// If you don't list any token attribute types in the following declaration
+// (or just use the default token type: lexertl_token<base_iterator_type>)
+// it will compile and work just fine, just a bit less efficient. This is
+// because the token attribute will be generated from the matched input
+// sequence every time it is requested. But as soon as you specify at
+// least one token attribute type you'll have to list all attribute types
+// used for token_def<> declarations in the token definition class above,
+// otherwise compilation errors will occur.
+typedef lexertl::token<
+ base_iterator_type, boost::mpl::vector<unsigned int, std::string>
+> token_type;
+</pre>
+
+ 
+
+ 
+
+ To avoid the token to have a token value at all, the special tag <tt class="computeroutput">omitted</tt> can be used: <tt class="computeroutput">token_def<omitted></tt>
+ and <tt class="computeroutput">lexertl_token<base_iterator_type,
+ omitted></tt>.
+ 
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2001-2009 Joel
+ de Guzman, 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="lexer_primitives.html"><img src="../../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../lexer_primitives.html"><img src="../../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="lexer_token_definition.html"><img src="../../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Modified: trunk/libs/spirit/doc/html/spirit/lex/abstracts/lexer_states.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/lex/abstracts/lexer_states.html (original)
+++ trunk/libs/spirit/doc/html/spirit/lex/abstracts/lexer_states.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -30,17 +30,17 @@
<div></div>
</div>
<a name="spirit.lex.abstracts.lexer_states.controlling_the_lexer_state_from_lexer_semantic_actions"></a><h5>
-<a name="id482844"></a>
+<a name="id482984"></a>
 <a href="lexer_states.html#spirit.lex.abstracts.lexer_states.controlling_the_lexer_state_from_lexer_semantic_actions">Controlling
 the Lexer State from Lexer Semantic Actions</a>
 </h5>
<a name="spirit.lex.abstracts.lexer_states.controlling_the_lexer_state_from_parser_semantic_actions"></a><h5>
-<a name="id482871"></a>
+<a name="id483010"></a>
 <a href="lexer_states.html#spirit.lex.abstracts.lexer_states.controlling_the_lexer_state_from_parser_semantic_actions">Controlling
 the Lexer State from Parser Semantic Actions</a>
 </h5>
<a name="spirit.lex.abstracts.lexer_states.using_a_lexer_state_for_the_skip_parser"></a><h5>
-<a name="id482898"></a>
+<a name="id483038"></a>
 <a href="lexer_states.html#spirit.lex.abstracts.lexer_states.using_a_lexer_state_for_the_skip_parser">Using
 a Lexer State for the Skip Parser</a>
 </h5>

Modified: trunk/libs/spirit/doc/html/spirit/lex/abstracts/lexer_static_model.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/lex/abstracts/lexer_static_model.html (original)
+++ trunk/libs/spirit/doc/html/spirit/lex/abstracts/lexer_static_model.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -183,7 +183,7 @@

 
<a name="spirit.lex.abstracts.lexer_static_model.generating_the_static_analyzer"></a><h5>
-<a name="id480984"></a>
+<a name="id481125"></a>
 <a href="lexer_static_model.html#spirit.lex.abstracts.lexer_static_model.generating_the_static_analyzer">Generating
 the Static Analyzer</a>
 </h5>
@@ -232,7 +232,7 @@
 the next topic (the full generated code can be viewed here).
 
<a name="spirit.lex.abstracts.lexer_static_model.modifying_the_dynamic_analyzer"></a><h5>
-<a name="id481449"></a>
+<a name="id481589"></a>
 <a href="lexer_static_model.html#spirit.lex.abstracts.lexer_static_model.modifying_the_dynamic_analyzer">Modifying
 the Dynamic Analyzer</a>
 </h5>

Modified: trunk/libs/spirit/doc/html/spirit/lex/abstracts/lexer_tokenizing.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/lex/abstracts/lexer_tokenizing.html (original)
+++ trunk/libs/spirit/doc/html/spirit/lex/abstracts/lexer_tokenizing.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -7,7 +7,8 @@
<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
<link rel="home" href="../../../index.html" title="Spirit 2.1">
<link rel="up" href="../abstracts.html" title=" Abstracts">
-<link rel="previous" href="../abstracts.html" title=" Abstracts">
+<link rel="previous" href="lexer_primitives/lexer_token_definition.html" title="
+ Ways to define Tokens">
<link rel="next" href="lexer_semantic_actions.html" title=" Lexer
 Semantic Actions">
</head>
@@ -22,7 +23,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../abstracts.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../abstracts.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="lexer_semantic_actions.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="lexer_primitives/lexer_token_definition.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../abstracts.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="lexer_semantic_actions.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage">
@@ -34,7 +35,7 @@
<div></div>
</div>
<a name="spirit.lex.abstracts.lexer_tokenizing.the_tokenize_function"></a><h5>
-<a name="id476355"></a>
+<a name="id476495"></a>
 <a href="lexer_tokenizing.html#spirit.lex.abstracts.lexer_tokenizing.the_tokenize_function">The
 tokenize function</a>
 </h5>
@@ -236,7 +237,7 @@
</dl>
</div>
<a name="spirit.lex.abstracts.lexer_tokenizing.the_generate_static_function"></a><h5>
-<a name="id479360"></a>
+<a name="id479500"></a>
 <a href="lexer_tokenizing.html#spirit.lex.abstracts.lexer_tokenizing.the_generate_static_function">The
 generate_static function</a>
 </h5>
@@ -252,7 +253,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../abstracts.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../abstracts.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="lexer_semantic_actions.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="lexer_primitives/lexer_token_definition.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../abstracts.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="lexer_semantic_actions.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>

Added: trunk/libs/spirit/doc/html/spirit/lex/lexer_introduction.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/lex/lexer_introduction.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -0,0 +1,256 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> Introduction to Spirit.Lex</title>
+<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
+<link rel="home" href="../../index.html" title="Spirit 2.1">
+<link rel="up" href="../lex.html" title=" Spirit.Lex">
+<link rel="previous" href="../lex.html" title=" Spirit.Lex">
+<link rel="next" href="tutorials.html" title=" Spirit.Lex
+ Tutorials">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../lex.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../lex.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="tutorials.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h3 class="title">
+<a name="spirit.lex.lexer_introduction"></a> Introduction to Spirit.Lex
+</h3></div></div>
+<div></div>
+</div>
+
+ Lexical scanning is the process of analyzing the stream of input characters
+ and separating it into strings called tokens, separated by whitespace. Most
+ compiler texts start here, and devote several chapters to discussing various
+ ways to build scanners. Spirit.Lex is a library built
+ to take care of the complexities of creating a lexer for your grammar (in
+ this documentation we will use the terms 'lexical analyzer', 'lexer' and
+ 'scanner' interchangably). All it needs to create a lexer is to know the
+ set of patterns describing the different tokens you want to recognize in
+ the input. To make this a bit more formal, here are some definitions:
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ A token is a sequence of consecutive characters having a collective meaning.
+ Tokens may have attributes specific to the token type, carrying additional
+ information about the matched character sequence.
+ </li>
+<li>
+ A pattern is a rule expressed as a regular expression and describing how
+ a particular token can be formed. For example, <tt class="literal">[A-Za-z][A-Za-z_0-9]*</tt>
+ is a pattern for a rule matching C++ identifiers.
+ </li>
+<li>
+ Characters between tokens are called whitespace; these include spaces,
+ tabs, newlines, and formfeeds. Many people also count comments as whitespace,
+ though since some tools such as lint look at comments, this conflation
+ is not perfect.
+ </li>
+</ul></div>
+<a name="spirit.lex.lexer_introduction.why_use_a_separate_lexer_"></a><h4>
+<a name="id461595"></a>
+ <a href="lexer_introduction.html#spirit.lex.lexer_introduction.why_use_a_separate_lexer_">Why
+ Use a Separate Lexer?</a>
+ </h4>
+
+ Typically, lexical scanning is done in a separate module from the parser,
+ feeding the parser with a stream of input tokens only. Theoretically it is
+ not necessary implement this separation as in the end there is only one set
+ of syntactical rules defining the language, so in theory we could write the
+ whole parser in one module. In fact, Spirit.Qi allows
+ you to write parsers without using a lexer, parsing the input character stream
+ directly, and for the most part this is the way Spirit
+ has been used since its invention.
+ 
+
+ However, this separation has both practical and theoretical bases and proves
+ to be very useful in practical applications. In 1956, Noam Chomsky defined
+ the "Chomsky Hierarchy" of grammars:
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ Type 0: Unrestricted grammars (e.g., natural languages)
+ </li>
+<li>
+ Type 1: Context-Sensitive grammars
+ </li>
+<li>
+ Type 2: Context-Free grammars
+ </li>
+<li>
+ Type 3: Regular grammars
+ </li>
+</ul></div>
+
+ The complexity of these grammars increases from regular grammars being the
+ simplest to unrestricted grammars being the most complex. Similarly, the
+ complexity of the recognizers for these grammars increases. Although, a few
+ features of some programming languages (such as C++) are Type 1, fortunately
+ for the most part programming languages can be described using only the Types
+ 3 and 2. The neat part about these two types is that they are well known
+ and the ways to parse them are well understood. It has been shown that any
+ regular grammar can be parsed using a state machine (finite automaton). Similarly,
+ context-free grammars can always be parsed using a push-down automaton (essentially
+ a state machine augmented by a stack).
+ 
+
+ In real programming languages and practical grammars the parts that can be
+ handled as regular expressions tend to be the lower-level parts, such as
+ the definition of an identifier or of an integer value:
+ 
+<pre class="programlisting">letter := [a-zA-Z]
+digit := [0-9]
+
+identifier := letter [ letter | digit ]*
+integer := digit+
+</pre>
+
+ Higher level parts of practical grammars tend to be more complex and can't
+ be implemented using plain regular expressions. We need to store information
+ on the built-in hardware stack while recursing the grammar hierarchy, and
+ that in fact this is the preferred approach used for top-down parsing. Since
+ it takes a different kind of abstract machine to parse the two types of grammars,
+ it proved to be efficient to separate the lexical scanner into a separate
+ module which is built around the idea of a state machine. The goal here is
+ to use the simplest parsing technique needed for the job.
+ 
+
+ Another, more practical, reason for separating the scanner from the parser
+ is the need for backtracking during parsing. The input data is a stream of
+ characters, which is often thought to be processed left to right without
+ any backtracking. Unfortunately, in practice most of the time that isn't
+ possible. Almost every language has certain keywords such as IF, FOR, and
+ WHILE. The decision if a certain character sequence actually comprises a
+ keyword or just an identifier often can be made only after seeing the first
+ delimiter after it. This already is a limited form of
+ backtracking, since we need to store the string long enough to be able to
+ make the decision. The same is true for more coarse grained language features
+ such as nested IF/ELSE statements, where the decision about to which IF belongs
+ the last ELSE statement can be made only after seeing the whole construct.
+ 
+
+ So the structure of a conventional compiler often involves splitting up the
+ functions of the lower-level and higher-level parsing. The lexical scanner
+ deals with things at the character level, collecting characters into strings,
+ converting character sequence into different representations as integers,
+ etc., and passing them along to the parser proper as indivisible tokens.
+ It's also considered normal to let the scanner do additional jobs, such as
+ identifying keywords, storing identifiers in tables, etc.
+ 
+
+ Now, Spirit follows this
+ structure, where Spirit.Lex can be used to implement
+ state machine based recognizers, while Spirit.Qi can
+ be used to build recognizers for context free grammars. Since both modules
+ are seemlessly integrated with each other and with the C++ target language
+ it is even possible to use the provided functionality to build more complex
+ grammar recognizers.
+ 
+<a name="spirit.lex.lexer_introduction.advantages_of_using__emphasis_spirit_lex__emphasis_"></a><h4>
+<a name="id461933"></a>
+ <a href="lexer_introduction.html#spirit.lex.lexer_introduction.advantages_of_using__emphasis_spirit_lex__emphasis_">Advantages
+ of using Spirit.Lex</a>
+ </h4>
+
+ The advantage of using Spirit.Lex to create the lexical
+ analyzer over using more traditional tools such as Flex
+ is its carefully crafted integration with the Spirit
+ library and the C++ host language. You don't need any external tools to generate
+ the code, your lexer will be perfectly integrated with the rest of your program,
+ making it possible to freely access any context information and data structure.
+ Since the C++ compiler sees all the code it will generate optimal code nomatter
+ what configuration options have been chosen by the user. Spirit.Lex
+ gives you the vast majority of features you could get from a similar Flex program without the need
+ to leave C++ as a host language:
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ The definition of tokens is done using regular expressions (patterns)
+ </li>
+<li>
+ The token definitions can refer to special substitution strings (pattern
+ macros) simplifying pattern definitions
+ </li>
+<li>
+ The generated lexical scanner may have multiple start states
+ </li>
+<li>
+ It is possible to attach code to any of the token definitions; this code
+ gets executed whenever the corresponding token pattern has been matched
+ </li>
+</ul></div>
+
+ Even if it is possible to use Spirit.Lex to generate
+ C++ code representing the lexical analyzer (we will refer to that as the
+ static model, described in more detail in the section
+ <a href="abstracts/lexer_static_model.html" title=" The Static
+ Lexer Model">The Static
+ Model</a>) - a model very similar to the way Flex
+ operates - we will mainly focus on the opposite, the dynamic
+ model. You can directly integrate the token definitions into your C++ program,
+ building the lexical analyzer dynamically at runtime. The dynamic model is
+ something not supported by Flex
+ or other lexical scanner generators (such as re2c,
+ Ragel, etc.).
+ But it is very flexible and allows you to speed up the development of your
+ application.
+ 
+<a name="spirit.lex.lexer_introduction.the_library_structure_of__emphasis_spirit_lex__emphasis_"></a><h4>
+<a name="id462104"></a>
+ <a href="lexer_introduction.html#spirit.lex.lexer_introduction.the_library_structure_of__emphasis_spirit_lex__emphasis_">The
+ Library Structure of Spirit.Lex</a>
+ </h4>
+
+ The <a href="lexer_introduction.html#spirit.lexerflow" title="Figure 3. The Library structure and Common Flow of Information while
+ using Spirit.Lex in an application">figure</a> below shows a high level
+ overview of how the Spirit.Lex library might be used
+ in an application. Spirit.Lex allows to create lexical
+ analyzers based on patterns. These patterns are regular expression based
+ rules used to define the different tokens to be recognized in the character
+ input sequence. The input sequence is expected to be provided to the lexical
+ analyzer as an arbitrary standard forward iterator. The lexical analyzer
+ itself exposes a standard forward iterator as well. The difference here is
+ that the exposed iterator provides access to the token sequence instead of
+ to the character sequence. The tokens in this sequence are constructed on
+ the fly by analyzing the underlying character sequence and matching this
+ to the patterns as defined by the application.
+ 
+
+ 
+<div class="figure">
+<a name="spirit.lexerflow"></a>Figure 3. The Library structure and Common Flow of Information while
+ using Spirit.Lex in an application
+<img src="./images/lexerflow.png" alt="The
+ Library structure and Common Flow of Information while using Spirit.Lex
+ in an application">
+</div>
+
+ 
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2001-2009 Joel
+ de Guzman, 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../lex.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../lex.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="tutorials.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Modified: trunk/libs/spirit/doc/html/spirit/lex/reference.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/lex/reference.html (original)
+++ trunk/libs/spirit/doc/html/spirit/lex/reference.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -7,7 +7,7 @@
<link rel="home" href="../../index.html" title="Spirit 2.1">
<link rel="up" href="../lex.html" title=" Spirit.Lex">
<link rel="previous" href="quick_reference.html" title=" Quick Reference">
-<link rel="next" href="reference/lexer_class.html" title="Lexer Class">
+<link rel="next" href="reference/concepts.html" title=" Concepts">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
@@ -20,7 +20,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="quick_reference.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../lex.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="reference/lexer_class.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="quick_reference.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../lex.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="reference/concepts.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage">
@@ -30,415 +30,12 @@
<div></div>
</div>
<div class="toc"><dl>
-<dt> Concepts</dt>
+<dt> Concepts</dt>
<dt>Lexer Class</dt>
<dt>Token Class</dt>
<dt>TokenDef Class</dt>
<dt>TokenSet Class</dt>
</dl></div>
-<div class="section" lang="en">
-<div class="titlepage">
-<div><div><h4 class="title">
-<a name="spirit.lex.reference.concepts"></a> Concepts
-</h4></div></div>
-<div></div>
-</div>
-<div class="toc"><dl>
-<dt>Lexer</dt>
-<dt>Token</dt>
-<dt>TokenDef</dt>
-<dt>TokenSet</dt>
-</dl></div>
-<div class="section" lang="en">
-<div class="titlepage">
-<div><div><h5 class="title">
-<a name="spirit.lex.reference.concepts.lexer"></a>Lexer
-</h5></div></div>
-<div></div>
-</div>
-<div class="table">
-<a name="id482991"></a>Table 6. Regular expressions support
-<table class="table" summary="Regular expressions support">
-<colgroup>
-<col>
-<col>
-</colgroup>
-<thead><tr>
-<th>
- Expression
- </th>
-<th>
- Meaning
- </th>
-</tr></thead>
-<tbody>
-<tr>
-<td>
- <tt class="computeroutput">x</tt>
- </td>
-<td>
- Match any character <tt class="computeroutput">x</tt>
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">.</tt>
- </td>
-<td>
- Match any except newline (or optionally any
- character)
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">[xyz]</tt>
- </td>
-<td>
- A character class; in this case matches <tt class="computeroutput">x</tt>,
- <tt class="computeroutput">y</tt> or <tt class="computeroutput">z</tt>
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">[abj-oZ]</tt>
- </td>
-<td>
- A character class with a range in it; matches <tt class="computeroutput">a</tt>,
- <tt class="computeroutput">b</tt> any letter from
- <tt class="computeroutput">j</tt> through <tt class="computeroutput">o</tt> or a <tt class="computeroutput">Z</tt>
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">[^A-Z]</tt>
- </td>
-<td>
- A negated character class i.e. any character but those in the class.
- In this case, any character except an uppercase letter
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">r*</tt>
- </td>
-<td>
- Zero or more r's (greedy), where r is any regular expression
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">r*?</tt>
- </td>
-<td>
- Zero or more r's (abstemious), where r is any regular expression
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">r+</tt>
- </td>
-<td>
- One or more r's (greedy)
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">r+?</tt>
- </td>
-<td>
- One or more r's (abstemious)
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">r?</tt>
- </td>
-<td>
- Zero or one r's (greedy), i.e. optional
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">r??</tt>
- </td>
-<td>
- Zero or one r's (abstemious), i.e. optional
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">r{2,5}</tt>
- </td>
-<td>
- Anywhere between two and five r's (greedy)
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">r{2,5}?</tt>
- </td>
-<td>
- Anywhere between two and five r's (abstemious)
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">r{2,}</tt>
- </td>
-<td>
- Two or more r's (greedy)
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">r{2,}?</tt>
- </td>
-<td>
- Two or more r's (abstemious)
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">r{4}</tt>
- </td>
-<td>
- Exactly four r's
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">{NAME}</tt>
- </td>
-<td>
- The macro <tt class="computeroutput">NAME</tt>
- (see below)
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">"[xyz]\"foo"</tt>
- </td>
-<td>
- The literal string <tt class="computeroutput">[xyz]\"foo</tt>
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">\X</tt>
- </td>
-<td>
- If X is <tt class="computeroutput">a</tt>, <tt class="computeroutput">b</tt>, <tt class="computeroutput">e</tt>,
- <tt class="computeroutput">n</tt>, <tt class="computeroutput">r</tt>, <tt class="computeroutput">f</tt>,
- <tt class="computeroutput">t</tt>, <tt class="computeroutput">v</tt> then the ANSI-C interpretation
- of <tt class="computeroutput">\x</tt>.
- Otherwise a literal <tt class="computeroutput">X</tt>
- (used to escape operators such as <tt class="computeroutput">*</tt>)
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">\0</tt>
- </td>
-<td>
- A NUL character (ASCII code 0)
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">\123</tt>
- </td>
-<td>
- The character with octal value 123
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">\x2a</tt>
- </td>
-<td>
- The character with hexadecimal value 2a
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">\cX</tt>
- </td>
-<td>
- A named control character <tt class="computeroutput">X</tt>.
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">\d</tt>
- </td>
-<td>
- A shortcut for <tt class="computeroutput">[0-9]</tt>
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">\D</tt>
- </td>
-<td>
- A shortcut for <tt class="computeroutput">[^0-9]</tt>
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">\s</tt>
- </td>
-<td>
- A shortcut for <tt class="computeroutput">[\x20\t\n\r\f\v]</tt>
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">\S</tt>
- </td>
-<td>
- A shortcut for <tt class="computeroutput">[^\x20\t\n\r\f\v]</tt>
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">\w</tt>
- </td>
-<td>
- A shortcut for <tt class="computeroutput">[a-zA-Z0-9_]</tt>
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">\W</tt>
- </td>
-<td>
- A shortcut for <tt class="computeroutput">[^a-zA-Z0-9_]</tt>
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">(r)</tt>
- </td>
-<td>
- Match an <tt class="computeroutput">r</tt>; parenthesis
- are used to override precedence (see below)
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">(?r-s:pattern)</tt>
- </td>
-<td>
- apply option 'r' and omit option 's' while interpreting pattern.
- Options may be zero or more of the characters 'i' or 's'. 'i' means
- case-insensitive. '-i' means case-sensitive. 's' alters the meaning
- of the '.' syntax to match any single character whatsoever. '-s'
- alters the meaning of '.' to match any character except '<tt class="computeroutput">\n</tt>'.
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">rs</tt>
- </td>
-<td>
- The regular expression <tt class="computeroutput">r</tt>
- followed by the regular expression <tt class="computeroutput">s</tt>
- (a sequence)
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">r|s</tt>
- </td>
-<td>
- Either an <tt class="computeroutput">r</tt> or
- and <tt class="computeroutput">s</tt>
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">^r</tt>
- </td>
-<td>
- An <tt class="computeroutput">r</tt> but only at
- the beginning of a line (i.e. when just starting to scan, or right
- after a newline has been scanned)
- </td>
-</tr>
-<tr>
-<td>
- <tt class="computeroutput">r</tt>$
- </td>
-<td>
- An <tt class="computeroutput">r</tt> but only at
- the end of a line (i.e. just before a newline)
- </td>
-</tr>
-</tbody>
-</table>
-</div>
-<div class="note"><table border="0" summary="Note">
-<tr>
-<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../images/note.png"></td>
-<th align="left">Note</th>
-</tr>
-<tr><td colspan="2" align="left" valign="top">
- POSIX character classes are not currently supported, due to performance
- issues when creating them in wide character mode.
- </td></tr>
-</table></div>
-<a name="spirit.lex.reference.concepts.lexer.regular_expression_precedence"></a><h6>
-<a name="id485081"></a>
- <a href="reference.html#spirit.lex.reference.concepts.lexer.regular_expression_precedence">Regular
- Expression Precedence</a>
- </h6>
-<div class="itemizedlist"><ul type="disc">
-<li>
-<tt class="computeroutput">rs</tt> has highest precedence
- </li>
-<li>
-<tt class="computeroutput">r*</tt>
- has next highest (<tt class="computeroutput">+</tt>,
- <tt class="computeroutput">?</tt>, <tt class="computeroutput">{n,m}</tt>
- have the same precedence as <tt class="computeroutput">*</tt>)
- </li>
-<li>
-<tt class="computeroutput">r|s</tt> has the lowest precedence
- </li>
-</ul></div>
-<a name="spirit.lex.reference.concepts.lexer.macros"></a><h6>
-<a name="id485237"></a>
- Macros
- </h6>
-
- Regular expressions can be given a name and referred to in rules using
- the syntax <tt class="computeroutput">{NAME}</tt> where <tt class="computeroutput">NAME</tt>
- is the name you have given to the macro. A macro name can be at most
- 30 characters long and must start with a <tt class="computeroutput">_</tt>
- or a letter. Subsequent characters can be <tt class="computeroutput">_</tt>,
- <tt class="computeroutput">-</tt>, a letter or a decimal
- digit. Use the <tt class="computeroutput">rules::add_macro()</tt> method to define a macro.
- 
-</div>
-<div class="section" lang="en"><div class="titlepage">
-<div><div><h5 class="title">
-<a name="spirit.lex.reference.concepts.token"></a>Token
-</h5></div></div>
-<div></div>
-</div></div>
-<div class="section" lang="en"><div class="titlepage">
-<div><div><h5 class="title">
-<a name="spirit.lex.reference.concepts.tokendef"></a>TokenDef
-</h5></div></div>
-<div></div>
-</div></div>
-<div class="section" lang="en"><div class="titlepage">
-<div><div><h5 class="title">
-<a name="spirit.lex.reference.concepts.tokenset"></a>TokenSet
-</h5></div></div>
-<div></div>
-</div></div>
-</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
@@ -451,7 +48,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="quick_reference.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../lex.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="reference/lexer_class.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="quick_reference.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../lex.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="reference/concepts.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>

Added: trunk/libs/spirit/doc/html/spirit/lex/reference/concepts.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/lex/reference/concepts.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -0,0 +1,53 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> Concepts</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
+<link rel="home" href="../../../index.html" title="Spirit 2.1">
+<link rel="up" href="../reference.html" title=" Reference">
+<link rel="previous" href="../reference.html" title=" Reference">
+<link rel="next" href="concepts/lexer.html" title="Lexer">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../reference.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="concepts/lexer.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h4 class="title">
+<a name="spirit.lex.reference.concepts"></a> Concepts
+</h4></div></div>
+<div></div>
+</div>
+<div class="toc"><dl>
+<dt>Lexer</dt>
+<dt>Token</dt>
+<dt>TokenDef</dt>
+<dt>TokenSet</dt>
+</dl></div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2001-2009 Joel
+ de Guzman, 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../reference.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="concepts/lexer.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/lex/reference/concepts/lexer.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/lex/reference/concepts/lexer.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -0,0 +1,410 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Lexer</title>
+<link rel="stylesheet" href="../../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
+<link rel="home" href="../../../../index.html" title="Spirit 2.1">
+<link rel="up" href="../concepts.html" title=" Concepts">
+<link rel="previous" href="../concepts.html" title=" Concepts">
+<link rel="next" href="token.html" title="Token">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../concepts.html"><img src="../../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../concepts.html"><img src="../../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="token.html"><img src="../../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.lex.reference.concepts.lexer"></a>Lexer
+</h5></div></div>
+<div></div>
+</div>
+<div class="table">
+<a name="id483131"></a>Table 6. Regular expressions support
+<table class="table" summary="Regular expressions support">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Meaning
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <tt class="computeroutput">x</tt>
+ </td>
+<td>
+ Match any character <tt class="computeroutput">x</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">.</tt>
+ </td>
+<td>
+ Match any except newline (or optionally any
+ character)
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">[xyz]</tt>
+ </td>
+<td>
+ A character class; in this case matches <tt class="computeroutput">x</tt>,
+ <tt class="computeroutput">y</tt> or <tt class="computeroutput">z</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">[abj-oZ]</tt>
+ </td>
+<td>
+ A character class with a range in it; matches <tt class="computeroutput">a</tt>,
+ <tt class="computeroutput">b</tt> any letter from
+ <tt class="computeroutput">j</tt> through <tt class="computeroutput">o</tt> or a <tt class="computeroutput">Z</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">[^A-Z]</tt>
+ </td>
+<td>
+ A negated character class i.e. any character but those in the class.
+ In this case, any character except an uppercase letter
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">r*</tt>
+ </td>
+<td>
+ Zero or more r's (greedy), where r is any regular expression
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">r*?</tt>
+ </td>
+<td>
+ Zero or more r's (abstemious), where r is any regular expression
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">r+</tt>
+ </td>
+<td>
+ One or more r's (greedy)
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">r+?</tt>
+ </td>
+<td>
+ One or more r's (abstemious)
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">r?</tt>
+ </td>
+<td>
+ Zero or one r's (greedy), i.e. optional
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">r??</tt>
+ </td>
+<td>
+ Zero or one r's (abstemious), i.e. optional
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">r{2,5}</tt>
+ </td>
+<td>
+ Anywhere between two and five r's (greedy)
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">r{2,5}?</tt>
+ </td>
+<td>
+ Anywhere between two and five r's (abstemious)
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">r{2,}</tt>
+ </td>
+<td>
+ Two or more r's (greedy)
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">r{2,}?</tt>
+ </td>
+<td>
+ Two or more r's (abstemious)
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">r{4}</tt>
+ </td>
+<td>
+ Exactly four r's
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">{NAME}</tt>
+ </td>
+<td>
+ The macro <tt class="computeroutput">NAME</tt>
+ (see below)
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">"[xyz]\"foo"</tt>
+ </td>
+<td>
+ The literal string <tt class="computeroutput">[xyz]\"foo</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">\X</tt>
+ </td>
+<td>
+ If X is <tt class="computeroutput">a</tt>, <tt class="computeroutput">b</tt>, <tt class="computeroutput">e</tt>,
+ <tt class="computeroutput">n</tt>, <tt class="computeroutput">r</tt>, <tt class="computeroutput">f</tt>,
+ <tt class="computeroutput">t</tt>, <tt class="computeroutput">v</tt> then the ANSI-C interpretation
+ of <tt class="computeroutput">\x</tt>.
+ Otherwise a literal <tt class="computeroutput">X</tt>
+ (used to escape operators such as <tt class="computeroutput">*</tt>)
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">\0</tt>
+ </td>
+<td>
+ A NUL character (ASCII code 0)
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">\123</tt>
+ </td>
+<td>
+ The character with octal value 123
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">\x2a</tt>
+ </td>
+<td>
+ The character with hexadecimal value 2a
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">\cX</tt>
+ </td>
+<td>
+ A named control character <tt class="computeroutput">X</tt>.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">\d</tt>
+ </td>
+<td>
+ A shortcut for <tt class="computeroutput">[0-9]</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">\D</tt>
+ </td>
+<td>
+ A shortcut for <tt class="computeroutput">[^0-9]</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">\s</tt>
+ </td>
+<td>
+ A shortcut for <tt class="computeroutput">[\x20\t\n\r\f\v]</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">\S</tt>
+ </td>
+<td>
+ A shortcut for <tt class="computeroutput">[^\x20\t\n\r\f\v]</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">\w</tt>
+ </td>
+<td>
+ A shortcut for <tt class="computeroutput">[a-zA-Z0-9_]</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">\W</tt>
+ </td>
+<td>
+ A shortcut for <tt class="computeroutput">[^a-zA-Z0-9_]</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">(r)</tt>
+ </td>
+<td>
+ Match an <tt class="computeroutput">r</tt>; parenthesis
+ are used to override precedence (see below)
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">(?r-s:pattern)</tt>
+ </td>
+<td>
+ apply option 'r' and omit option 's' while interpreting pattern.
+ Options may be zero or more of the characters 'i' or 's'. 'i' means
+ case-insensitive. '-i' means case-sensitive. 's' alters the meaning
+ of the '.' syntax to match any single character whatsoever. '-s'
+ alters the meaning of '.' to match any character except '<tt class="computeroutput">\n</tt>'.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">rs</tt>
+ </td>
+<td>
+ The regular expression <tt class="computeroutput">r</tt>
+ followed by the regular expression <tt class="computeroutput">s</tt>
+ (a sequence)
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">r|s</tt>
+ </td>
+<td>
+ Either an <tt class="computeroutput">r</tt> or
+ and <tt class="computeroutput">s</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">^r</tt>
+ </td>
+<td>
+ An <tt class="computeroutput">r</tt> but only at
+ the beginning of a line (i.e. when just starting to scan, or right
+ after a newline has been scanned)
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">r</tt>$
+ </td>
+<td>
+ An <tt class="computeroutput">r</tt> but only at
+ the end of a line (i.e. just before a newline)
+ </td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="note"><table border="0" summary="Note">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../images/note.png"></td>
+<th align="left">Note</th>
+</tr>
+<tr><td colspan="2" align="left" valign="top">
+ POSIX character classes are not currently supported, due to performance
+ issues when creating them in wide character mode.
+ </td></tr>
+</table></div>
+<a name="spirit.lex.reference.concepts.lexer.regular_expression_precedence"></a><h6>
+<a name="id485221"></a>
+ <a href="lexer.html#spirit.lex.reference.concepts.lexer.regular_expression_precedence">Regular
+ Expression Precedence</a>
+ </h6>
+<div class="itemizedlist"><ul type="disc">
+<li>
+<tt class="computeroutput">rs</tt> has highest precedence
+ </li>
+<li>
+<tt class="computeroutput">r*</tt>
+ has next highest (<tt class="computeroutput">+</tt>,
+ <tt class="computeroutput">?</tt>, <tt class="computeroutput">{n,m}</tt>
+ have the same precedence as <tt class="computeroutput">*</tt>)
+ </li>
+<li>
+<tt class="computeroutput">r|s</tt> has the lowest precedence
+ </li>
+</ul></div>
+<a name="spirit.lex.reference.concepts.lexer.macros"></a><h6>
+<a name="id485378"></a>
+ Macros
+ </h6>
+
+ Regular expressions can be given a name and referred to in rules using
+ the syntax <tt class="computeroutput">{NAME}</tt> where <tt class="computeroutput">NAME</tt>
+ is the name you have given to the macro. A macro name can be at most
+ 30 characters long and must start with a <tt class="computeroutput">_</tt>
+ or a letter. Subsequent characters can be <tt class="computeroutput">_</tt>,
+ <tt class="computeroutput">-</tt>, a letter or a decimal
+ digit. Use the <tt class="computeroutput">rules::add_macro()</tt> method to define a macro.
+ 
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2001-2009 Joel
+ de Guzman, 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../concepts.html"><img src="../../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../concepts.html"><img src="../../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="token.html"><img src="../../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/lex/reference/concepts/token.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/lex/reference/concepts/token.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -0,0 +1,45 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Token</title>
+<link rel="stylesheet" href="../../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
+<link rel="home" href="../../../../index.html" title="Spirit 2.1">
+<link rel="up" href="../concepts.html" title=" Concepts">
+<link rel="previous" href="lexer.html" title="Lexer">
+<link rel="next" href="tokendef.html" title="TokenDef">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="lexer.html"><img src="../../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../concepts.html"><img src="../../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="tokendef.html"><img src="../../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en"><div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.lex.reference.concepts.token"></a>Token
+</h5></div></div>
+<div></div>
+</div></div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2001-2009 Joel
+ de Guzman, 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="lexer.html"><img src="../../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../concepts.html"><img src="../../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="tokendef.html"><img src="../../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/lex/reference/concepts/tokendef.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/lex/reference/concepts/tokendef.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -0,0 +1,45 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>TokenDef</title>
+<link rel="stylesheet" href="../../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
+<link rel="home" href="../../../../index.html" title="Spirit 2.1">
+<link rel="up" href="../concepts.html" title=" Concepts">
+<link rel="previous" href="token.html" title="Token">
+<link rel="next" href="tokenset.html" title="TokenSet">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="token.html"><img src="../../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../concepts.html"><img src="../../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="tokenset.html"><img src="../../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en"><div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.lex.reference.concepts.tokendef"></a>TokenDef
+</h5></div></div>
+<div></div>
+</div></div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2001-2009 Joel
+ de Guzman, 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="token.html"><img src="../../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../concepts.html"><img src="../../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="tokenset.html"><img src="../../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/lex/reference/concepts/tokenset.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/lex/reference/concepts/tokenset.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -0,0 +1,45 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>TokenSet</title>
+<link rel="stylesheet" href="../../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
+<link rel="home" href="../../../../index.html" title="Spirit 2.1">
+<link rel="up" href="../concepts.html" title=" Concepts">
+<link rel="previous" href="tokendef.html" title="TokenDef">
+<link rel="next" href="../lexer_class.html" title="Lexer Class">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="tokendef.html"><img src="../../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../concepts.html"><img src="../../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../lexer_class.html"><img src="../../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en"><div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.lex.reference.concepts.tokenset"></a>TokenSet
+</h5></div></div>
+<div></div>
+</div></div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2001-2009 Joel
+ de Guzman, 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="tokendef.html"><img src="../../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../concepts.html"><img src="../../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../lexer_class.html"><img src="../../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Modified: trunk/libs/spirit/doc/html/spirit/lex/reference/lexer_class.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/lex/reference/lexer_class.html (original)
+++ trunk/libs/spirit/doc/html/spirit/lex/reference/lexer_class.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -6,7 +6,7 @@
<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
<link rel="home" href="../../../index.html" title="Spirit 2.1">
<link rel="up" href="../reference.html" title=" Reference">
-<link rel="previous" href="../reference.html" title=" Reference">
+<link rel="previous" href="concepts/tokenset.html" title="TokenSet">
<link rel="next" href="token_class.html" title="Token Class">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@@ -20,7 +20,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../reference.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="token_class.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="concepts/tokenset.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="token_class.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage">
@@ -30,22 +30,22 @@
<div></div>
</div>
<a name="spirit.lex.reference.lexer_class.the_lexertl_lexer_class_implementing_the_dynamic_model"></a><h5>
-<a name="id485444"></a>
+<a name="id485584"></a>
 <a href="lexer_class.html#spirit.lex.reference.lexer_class.the_lexertl_lexer_class_implementing_the_dynamic_model">The
 lexertl_lexer Class Implementing the Dynamic Model</a>
 </h5>
<a name="spirit.lex.reference.lexer_class.the_lexertl_actor_lexer_class_implementing_the_dynamic_model"></a><h5>
-<a name="id485471"></a>
+<a name="id485611"></a>
 <a href="lexer_class.html#spirit.lex.reference.lexer_class.the_lexertl_actor_lexer_class_implementing_the_dynamic_model">The
 lexertl_actor_lexer Class Implementing the Dynamic Model</a>
 </h5>
<a name="spirit.lex.reference.lexer_class.the_lexertl_static_lexer_class_implementing_the_static_model"></a><h5>
-<a name="id485497"></a>
+<a name="id485637"></a>
 <a href="lexer_class.html#spirit.lex.reference.lexer_class.the_lexertl_static_lexer_class_implementing_the_static_model">The
 lexertl_static_lexer Class Implementing the Static Model</a>
 </h5>
<a name="spirit.lex.reference.lexer_class.the_lexertl_static_actor_lexer_class_implementing_the_static_model"></a><h5>
-<a name="id485527"></a>
+<a name="id485667"></a>
 <a href="lexer_class.html#spirit.lex.reference.lexer_class.the_lexertl_static_actor_lexer_class_implementing_the_static_model">The
 lexertl_static_actor_lexer Class Implementing the Static Model</a>
 </h5>
@@ -61,7 +61,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../reference.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="token_class.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="concepts/tokenset.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="token_class.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>

Modified: trunk/libs/spirit/doc/html/spirit/lex/tutorials.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/lex/tutorials.html (original)
+++ trunk/libs/spirit/doc/html/spirit/lex/tutorials.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -7,9 +7,9 @@
<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
<link rel="home" href="../../index.html" title="Spirit 2.1">
<link rel="up" href="../lex.html" title=" Spirit.Lex">
-<link rel="previous" href="../lex.html" title=" Spirit.Lex">
-<link rel="next" href="tutorials/lexer_quickstart1.html" title=" Quickstart
- 1 - A word counter using Spirit.Lex">
+<link rel="previous" href="lexer_introduction.html" title=" Introduction to Spirit.Lex">
+<link rel="next" href="tutorials/lexer_tutorials.html" title=" Spirit.Lex
+ Tutorials Overview">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
@@ -22,7 +22,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../lex.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../lex.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="tutorials/lexer_quickstart1.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="lexer_introduction.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../lex.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="tutorials/lexer_tutorials.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage">
@@ -34,7 +34,7 @@
<div></div>
</div>
<div class="toc"><dl>
-<dt><a href="tutorials.html#spirit.lex.tutorials.lexer_tutorials"> Spirit.Lex
+<dt><a href="tutorials/lexer_tutorials.html"> Spirit.Lex
 Tutorials Overview</a></dt>
<dt><a href="tutorials/lexer_quickstart1.html"> Quickstart
 1 - A word counter using Spirit.Lex</a></dt>
@@ -43,96 +43,6 @@
<dt><a href="tutorials/lexer_quickstart3.html"> Quickstart
 3 - Counting Words Using a Parser</a></dt>
</dl></div>
-<div class="section" lang="en">
-<div class="titlepage">
-<div><div><h4 class="title">
-<a name="spirit.lex.tutorials.lexer_tutorials"></a><a href="tutorials.html#spirit.lex.tutorials.lexer_tutorials" title=" Spirit.Lex
- Tutorials Overview"> Spirit.Lex
- Tutorials Overview</a>
-</h4></div></div>
-<div></div>
-</div>
-
- The Spirit.Lex library implements several components
- on top of possibly different lexer generator libraries. It exposes a pair
- of iterators, which, when dereferenced, return a stream of tokens generated
- from the underlying character stream. The generated tokens are based on
- the token definitions supplied by the user.
- 
-
- Currently, Spirit.Lex is built on top of Ben Hansons
- excellent Lexertl
- library (which is a proposed Boost library). Lexertl
- provides the necessary functionality to build state machines based on a
- set of supplied regular expressions. But Spirit.Lex
- is not restricted to be used with Lexertl.
- We expect it to be usable in conjunction with any other lexical scanner
- generator library, all what needs to be implemented is a set of wrapper
- objects exposing a well defined interface as described in this documentation.
- 
-<div class="note"><table border="0" summary="Note">
-<tr>
-<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../images/note.png"></td>
-<th align="left">Note</th>
-</tr>
-<tr><td colspan="2" align="left" valign="top">
- For the sake of clarity all examples in this documentation assume Spirit.Lex
- to be used on top of Lexertl.
- </td></tr>
-</table></div>
-
- Building a lexer using Spirit.Lex is highly configurable,
- where most of this configuration has to be done at compile time. Almost
- all of the configurable parameters have generally useful default values,
- though, which means that starting a project is easy and straightforward.
- Here is a (non-complete) list of features you can tweak to adjust the generated
- lexer instance to the actual needs:
- 
-<div class="itemizedlist"><ul type="disc">
-<li>
- Select and customize the token type to be generated by the lexer instance.
- </li>
-<li>
- Select and customize the token value types the generated token instances
- will be able to hold.
- </li>
-<li>
- Select the iterator type of the underlying input stream, which will be
- used as the source for the character stream to tokenize.
- </li>
-<li>
- Customize the iterator type returned by the lexer to enable debug support,
- special handling of certain input sequences, etc.
- </li>
-<li>
- Select the dynamic or the static
- runtime model for the lexical analyzer.
- </li>
-</ul></div>
-
- Special care has been taken during the development of the library that
- optimal code will be generated regardless of the configuration options
- selected.
- 
-
- The series of tutorial examples of this section will guide you through
- some common use cases helping to understand the big picture. The first
- two quick start examples (<a href="tutorials/lexer_quickstart1.html" title=" Quickstart
- 1 - A word counter using Spirit.Lex">Lex
- Quickstart 1 - A word counter using Spirit.Lex</a>
- and <a href="tutorials/lexer_quickstart2.html" title=" Quickstart
- 2 - A better word counter using Spirit.Lex">Lex Quickstart
- 2 - A better word counter using Spirit.Lex</a>)
- introduce the Spirit.Lex library while building two
- standalone applications, not being connected to or depending on any other
- part of Spirit. The
- section <a href="tutorials/lexer_quickstart3.html" title=" Quickstart
- 3 - Counting Words Using a Parser">Lex Quickstart
- 3 - Counting Words Using a Parser</a> demonstrates how to use a lexer
- in conjunction with a parser (where certainly the parser is built using
- Spirit.Qi).
- 
-</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
@@ -145,7 +55,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../lex.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../lex.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="tutorials/lexer_quickstart1.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="lexer_introduction.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../lex.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="tutorials/lexer_tutorials.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>

Modified: trunk/libs/spirit/doc/html/spirit/lex/tutorials/lexer_quickstart1.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/lex/tutorials/lexer_quickstart1.html (original)
+++ trunk/libs/spirit/doc/html/spirit/lex/tutorials/lexer_quickstart1.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -8,8 +8,8 @@
<link rel="home" href="../../../index.html" title="Spirit 2.1">
<link rel="up" href="../tutorials.html" title=" Spirit.Lex
 Tutorials">
-<link rel="previous" href="../tutorials.html" title=" Spirit.Lex
- Tutorials">
+<link rel="previous" href="lexer_tutorials.html" title=" Spirit.Lex
+ Tutorials Overview">
<link rel="next" href="lexer_quickstart2.html" title=" Quickstart
 2 - A better word counter using Spirit.Lex">
</head>
@@ -24,7 +24,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../tutorials.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorials.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="lexer_quickstart2.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="lexer_tutorials.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorials.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="lexer_quickstart2.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage">
@@ -47,7 +47,7 @@
 (for the full example code see here: word_count_functor.cpp).
 
<a name="spirit.lex.tutorials.lexer_quickstart1.prerequisites"></a><h5>
-<a name="id462418"></a>
+<a name="id462569"></a>
 <a href="lexer_quickstart1.html#spirit.lex.tutorials.lexer_quickstart1.prerequisites">Prerequisites</a>
 </h5>

@@ -86,7 +86,7 @@

 
<a name="spirit.lex.tutorials.lexer_quickstart1.defining_tokens"></a><h5>
-<a name="id462765"></a>
+<a name="id462916"></a>
 <a href="lexer_quickstart1.html#spirit.lex.tutorials.lexer_quickstart1.defining_tokens">Defining
 Tokens</a>
 </h5>
@@ -141,7 +141,7 @@

 
<a name="spirit.lex.tutorials.lexer_quickstart1.doing_the_useful_work"></a><h5>
-<a name="id463213"></a>
+<a name="id463365"></a>
 <a href="lexer_quickstart1.html#spirit.lex.tutorials.lexer_quickstart1.doing_the_useful_work">Doing
 the Useful Work</a>
 </h5>
@@ -206,7 +206,7 @@
 as well.
 
<a name="spirit.lex.tutorials.lexer_quickstart1.pulling_everything_together"></a><h5>
-<a name="id463911"></a>
+<a name="id464062"></a>
 <a href="lexer_quickstart1.html#spirit.lex.tutorials.lexer_quickstart1.pulling_everything_together">Pulling
 Everything Together</a>
 </h5>
@@ -259,7 +259,7 @@

 
<a name="spirit.lex.tutorials.lexer_quickstart1.comparing__emphasis_spirit_lex__emphasis__with__ulink_url__http___flex_sourceforge_net___flex__ulink_"></a><h5>
-<a name="id465041"></a>
+<a name="id465192"></a>
 <a href="lexer_quickstart1.html#spirit.lex.tutorials.lexer_quickstart1.comparing__emphasis_spirit_lex__emphasis__with__ulink_url__http___flex_sourceforge_net___flex__ulink_">Comparing
 Spirit.Lex with Flex</a>
 </h5>
@@ -350,7 +350,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../tutorials.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorials.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="lexer_quickstart2.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="lexer_tutorials.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorials.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="lexer_quickstart2.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>

Modified: trunk/libs/spirit/doc/html/spirit/lex/tutorials/lexer_quickstart2.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/lex/tutorials/lexer_quickstart2.html (original)
+++ trunk/libs/spirit/doc/html/spirit/lex/tutorials/lexer_quickstart2.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -49,7 +49,7 @@
 options along the lines (for the full example code see here: word_count_lexer.cpp).
 
<a name="spirit.lex.tutorials.lexer_quickstart2.prerequisites"></a><h5>
-<a name="id466097"></a>
+<a name="id466248"></a>
 <a href="lexer_quickstart2.html#spirit.lex.tutorials.lexer_quickstart2.prerequisites">Prerequisites</a>
 </h5>

@@ -123,7 +123,7 @@

 
<a name="spirit.lex.tutorials.lexer_quickstart2.semantic_actions_in__emphasis_spirit_lex__emphasis_"></a><h5>
-<a name="id466986"></a>
+<a name="id467138"></a>
 <a href="lexer_quickstart2.html#spirit.lex.tutorials.lexer_quickstart2.semantic_actions_in__emphasis_spirit_lex__emphasis_">Semantic
 Actions in Spirit.Lex</a>
 </h5>
@@ -248,7 +248,7 @@
 to the internal lexer context.
 
<a name="spirit.lex.tutorials.lexer_quickstart2.associating_token_definitions_with_the_lexer"></a><h5>
-<a name="id468624"></a>
+<a name="id468776"></a>
 <a href="lexer_quickstart2.html#spirit.lex.tutorials.lexer_quickstart2.associating_token_definitions_with_the_lexer">Associating
 Token Definitions with the Lexer</a>
 </h5>
@@ -285,7 +285,7 @@
 with the constant defined by <tt class="computeroutput">boost::spirit::lex::min_token_id</tt>.
 
<a name="spirit.lex.tutorials.lexer_quickstart2.pulling_everything_together"></a><h5>
-<a name="id469051"></a>
+<a name="id469203"></a>
 <a href="lexer_quickstart2.html#spirit.lex.tutorials.lexer_quickstart2.pulling_everything_together">Pulling
 everything together</a>
 </h5>

Modified: trunk/libs/spirit/doc/html/spirit/lex/tutorials/lexer_quickstart3.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/lex/tutorials/lexer_quickstart3.html (original)
+++ trunk/libs/spirit/doc/html/spirit/lex/tutorials/lexer_quickstart3.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -74,7 +74,7 @@
 code see here: word_count.cpp).
 
<a name="spirit.lex.tutorials.lexer_quickstart3.prerequisites"></a><h5>
-<a name="id470466"></a>
+<a name="id470618"></a>
 <a href="lexer_quickstart3.html#spirit.lex.tutorials.lexer_quickstart3.prerequisites">Prerequisites</a>
 </h5>

@@ -124,7 +124,7 @@

 
<a name="spirit.lex.tutorials.lexer_quickstart3.defining_tokens"></a><h5>
-<a name="id471071"></a>
+<a name="id471222"></a>
 <a href="lexer_quickstart3.html#spirit.lex.tutorials.lexer_quickstart3.defining_tokens">Defining
 Tokens</a>
 </h5>
@@ -179,7 +179,7 @@

 
<a name="spirit.lex.tutorials.lexer_quickstart3.using_token_definition_instances_as_parsers"></a><h5>
-<a name="id471545"></a>
+<a name="id471697"></a>
 <a href="lexer_quickstart3.html#spirit.lex.tutorials.lexer_quickstart3.using_token_definition_instances_as_parsers">Using
 Token Definition Instances as Parsers</a>
 </h5>
@@ -304,7 +304,7 @@
 do support the this attribute model as well. The most natural way of implementing
 this was to use the token values as the attributes exposed by the parser
 component corresponding to the token definition (you can read more about
- this topic here: <a href="../abstracts.html#spirit.lex.abstracts.lexer_primitives.lexer_token_values" title="
+ this topic here: <a href="../abstracts/lexer_primitives/lexer_token_values.html" title="
 About Tokens and Token Values">About
 Tokens and Token Values</a>). The example above takes advantage of the
 full integration of the token values as the <tt class="computeroutput">token_def<></tt>'s parser attributes: the <tt class="computeroutput">word</tt> token definition is declared as
@@ -335,7 +335,7 @@
 </td></tr>
</table></div>
<a name="spirit.lex.tutorials.lexer_quickstart3.pulling_everything_together"></a><h5>
-<a name="id472880"></a>
+<a name="id473032"></a>
 <a href="lexer_quickstart3.html#spirit.lex.tutorials.lexer_quickstart3.pulling_everything_together">Pulling
 Everything Together</a>
 </h5>

Added: trunk/libs/spirit/doc/html/spirit/lex/tutorials/lexer_tutorials.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/lex/tutorials/lexer_tutorials.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -0,0 +1,133 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> Spirit.Lex
+ Tutorials Overview</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
+<link rel="home" href="../../../index.html" title="Spirit 2.1">
+<link rel="up" href="../tutorials.html" title=" Spirit.Lex
+ Tutorials">
+<link rel="previous" href="../tutorials.html" title=" Spirit.Lex
+ Tutorials">
+<link rel="next" href="lexer_quickstart1.html" title=" Quickstart
+ 1 - A word counter using Spirit.Lex">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../tutorials.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorials.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="lexer_quickstart1.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h4 class="title">
+<a name="spirit.lex.tutorials.lexer_tutorials"></a><a href="lexer_tutorials.html" title=" Spirit.Lex
+ Tutorials Overview"> Spirit.Lex
+ Tutorials Overview</a>
+</h4></div></div>
+<div></div>
+</div>
+
+ The Spirit.Lex library implements several components
+ on top of possibly different lexer generator libraries. It exposes a pair
+ of iterators, which, when dereferenced, return a stream of tokens generated
+ from the underlying character stream. The generated tokens are based on
+ the token definitions supplied by the user.
+ 
+
+ Currently, Spirit.Lex is built on top of Ben Hansons
+ excellent Lexertl
+ library (which is a proposed Boost library). Lexertl
+ provides the necessary functionality to build state machines based on a
+ set of supplied regular expressions. But Spirit.Lex
+ is not restricted to be used with Lexertl.
+ We expect it to be usable in conjunction with any other lexical scanner
+ generator library, all what needs to be implemented is a set of wrapper
+ objects exposing a well defined interface as described in this documentation.
+ 
+<div class="note"><table border="0" summary="Note">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../images/note.png"></td>
+<th align="left">Note</th>
+</tr>
+<tr><td colspan="2" align="left" valign="top">
+ For the sake of clarity all examples in this documentation assume Spirit.Lex
+ to be used on top of Lexertl.
+ </td></tr>
+</table></div>
+
+ Building a lexer using Spirit.Lex is highly configurable,
+ where most of this configuration has to be done at compile time. Almost
+ all of the configurable parameters have generally useful default values,
+ though, which means that starting a project is easy and straightforward.
+ Here is a (non-complete) list of features you can tweak to adjust the generated
+ lexer instance to the actual needs:
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ Select and customize the token type to be generated by the lexer instance.
+ </li>
+<li>
+ Select and customize the token value types the generated token instances
+ will be able to hold.
+ </li>
+<li>
+ Select the iterator type of the underlying input stream, which will be
+ used as the source for the character stream to tokenize.
+ </li>
+<li>
+ Customize the iterator type returned by the lexer to enable debug support,
+ special handling of certain input sequences, etc.
+ </li>
+<li>
+ Select the dynamic or the static
+ runtime model for the lexical analyzer.
+ </li>
+</ul></div>
+
+ Special care has been taken during the development of the library that
+ optimal code will be generated regardless of the configuration options
+ selected.
+ 
+
+ The series of tutorial examples of this section will guide you through
+ some common use cases helping to understand the big picture. The first
+ two quick start examples (<a href="lexer_quickstart1.html" title=" Quickstart
+ 1 - A word counter using Spirit.Lex">Lex
+ Quickstart 1 - A word counter using Spirit.Lex</a>
+ and <a href="lexer_quickstart2.html" title=" Quickstart
+ 2 - A better word counter using Spirit.Lex">Lex Quickstart
+ 2 - A better word counter using Spirit.Lex</a>)
+ introduce the Spirit.Lex library while building two
+ standalone applications, not being connected to or depending on any other
+ part of Spirit. The
+ section <a href="lexer_quickstart3.html" title=" Quickstart
+ 3 - Counting Words Using a Parser">Lex Quickstart
+ 3 - Counting Words Using a Parser</a> demonstrates how to use a lexer
+ in conjunction with a parser (where certainly the parser is built using
+ Spirit.Qi).
+ 
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2001-2009 Joel
+ de Guzman, 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../tutorials.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorials.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="lexer_quickstart1.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Modified: trunk/libs/spirit/doc/html/spirit/notes.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/notes.html (original)
+++ trunk/libs/spirit/doc/html/spirit/notes.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -7,7 +7,7 @@
<link rel="home" href="../index.html" title="Spirit 2.1">
<link rel="up" href="../index.html" title="Spirit 2.1">
<link rel="previous" href="faq.html" title="FAQ">
-<link rel="next" href="acknowledgments.html" title="Acknowledgments">
+<link rel="next" href="notes/style_guide.html" title="Style Guide">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
@@ -20,7 +20,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="faq.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="acknowledgments.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="faq.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="notes/style_guide.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage">
@@ -29,118 +29,7 @@
</h2></div></div>
<div></div>
</div>
-<div class="toc"><dl><dt>Style Guide</dt></dl></div>
-<div class="section" lang="en">
-<div class="titlepage">
-<div><div><h3 class="title">
-<a name="spirit.notes.style_guide"></a>Style Guide
-</h3></div></div>
-<div></div>
-</div>
-
- At some point, especially when there are lots of semantic actions attached
- to various points, the grammar tends to be quite difficult to follow. In
- order to keep an easy-to-read, consistent en aesthetically pleasing look
- to the Spirit code, the following coding styleguide is advised.
- 
-
- This coding style is adapted and extended from the ANTLR/PCCTS style and
- <a href="http://www.boost.org/development/requirements.html" target="_top">Boost Library
- Requirements and Guidelines</a> and is the combined work of Joel de Guzman,
- Chris Uzdavinis, and Hartmut Kaiser.
- 
-<div class="itemizedlist"><ul type="disc">
-<li>
- Rule names use std C++ (Boost) convention. The rule name may be very long.
- </li>
-<li>
- The '=' is neatly indented 4 spaces below. Like in Boost, use spaces instead
- of tabs.
- </li>
-<li>
- Breaking the operands into separate lines puts the semantic actions neatly
- to the right.
- </li>
-<li>
- Semicolon at the last line terminates the rule.
- </li>
-<li>
- The adjacent parts of a sequence should be indented accordingly to have
- all, what belongs to one level, at one indentation level.
- </li>
-</ul></div>
-<pre class="programlisting">program
- = program_heading [heading_action]
- >> block [block_action]
- >> '.'
- | another_sequence
- >> etc
- ;
-</pre>
-<div class="itemizedlist"><ul type="disc">
-<li>
- Prefer literals in the grammar instead of identifiers. e.g. <tt class="computeroutput">"program"</tt> instead of <tt class="computeroutput">PROGRAM</tt>, <tt class="computeroutput">'>='</tt>
- instead of <tt class="computeroutput">GTE</tt> and <tt class="computeroutput">'.'</tt> instead of <tt class="computeroutput">DOT</tt>.
- This makes it much easier to read. If this isn't possible (for instance
- where the used tokens must be identified through integers) capitalized
- identifiers should be used instead.
- </li>
-<li>
- Breaking the operands may not be needed for short expressions. e.g. <tt class="computeroutput">*(',' >>
- file_identifier)</tt>
- as long as the line does not exceed 80 characters.
- </li>
-<li>
- If a sequence fits on one line, put spaces inside the parentheses to clearly
- separate them from the rules.
- </li>
-</ul></div>
-<pre class="programlisting">program_heading
- = no_case["program"]
- >> identifier
- >> '('
- >> file_identifier
- >> *( ',' >> file_identifier )
- >> ')'
- >> ';'
- ;
-</pre>
-<div class="itemizedlist"><ul type="disc"><li>
- Nesting directives: If a rule does not fit on one line (80 characters)
- it should be continued on the next line intended by one level. The brackets
- of directives, semantic expressions (using Phoenix or LL lambda expressions)
- or parsers should be placed as follows.
- </li></ul></div>
-<pre class="programlisting">identifier
- = no_case
- [
- lexeme
- [
- alpha >> *(alnum | '_') [id_action]
- ]
- ]
- ;
-</pre>
-<div class="itemizedlist"><ul type="disc"><li>
- Nesting unary operators (e.g.Kleene star): Unary rule operators (Kleene
- star, <tt class="computeroutput">'!'</tt>, <tt class="computeroutput">'+'</tt>
- etc.) should be moved out one space before the corresponding indentation
- level, if this rule has a body or a sequence after it, which does not fit
- on on line. This makes the formatting more consistent and moves the rule
- 'body' at the same indentation level as the rule itself, highlighting the
- unary operator.
- </li></ul></div>
-<pre class="programlisting">block
- = *( label_declaration_part
- | constant_definition_part
- | type_definition_part
- | variable_declaration_part
- | procedure_and_function_declaration_part
- )
- >> statement_part
- ;
-</pre>
-</div>
+<div class="toc"><dl><dt>Style Guide</dt></dl></div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
@@ -153,7 +42,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="faq.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="acknowledgments.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="faq.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="notes/style_guide.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>

Added: trunk/libs/spirit/doc/html/spirit/notes/style_guide.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/notes/style_guide.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -0,0 +1,150 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Style Guide</title>
+<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
+<link rel="home" href="../../index.html" title="Spirit 2.1">
+<link rel="up" href="../notes.html" title="Notes">
+<link rel="previous" href="../notes.html" title="Notes">
+<link rel="next" href="../acknowledgments.html" title="Acknowledgments">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../notes.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../notes.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../acknowledgments.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h3 class="title">
+<a name="spirit.notes.style_guide"></a>Style Guide
+</h3></div></div>
+<div></div>
+</div>
+
+ At some point, especially when there are lots of semantic actions attached
+ to various points, the grammar tends to be quite difficult to follow. In
+ order to keep an easy-to-read, consistent en aesthetically pleasing look
+ to the Spirit code, the following coding styleguide is advised.
+ 
+
+ This coding style is adapted and extended from the ANTLR/PCCTS style and
+ <a href="http://www.boost.org/development/requirements.html" target="_top">Boost Library
+ Requirements and Guidelines</a> and is the combined work of Joel de Guzman,
+ Chris Uzdavinis, and Hartmut Kaiser.
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ Rule names use std C++ (Boost) convention. The rule name may be very long.
+ </li>
+<li>
+ The '=' is neatly indented 4 spaces below. Like in Boost, use spaces instead
+ of tabs.
+ </li>
+<li>
+ Breaking the operands into separate lines puts the semantic actions neatly
+ to the right.
+ </li>
+<li>
+ Semicolon at the last line terminates the rule.
+ </li>
+<li>
+ The adjacent parts of a sequence should be indented accordingly to have
+ all, what belongs to one level, at one indentation level.
+ </li>
+</ul></div>
+<pre class="programlisting">program
+ = program_heading [heading_action]
+ >> block [block_action]
+ >> '.'
+ | another_sequence
+ >> etc
+ ;
+</pre>
+<div class="itemizedlist"><ul type="disc">
+<li>
+ Prefer literals in the grammar instead of identifiers. e.g. <tt class="computeroutput">"program"</tt> instead of <tt class="computeroutput">PROGRAM</tt>, <tt class="computeroutput">'>='</tt>
+ instead of <tt class="computeroutput">GTE</tt> and <tt class="computeroutput">'.'</tt> instead of <tt class="computeroutput">DOT</tt>.
+ This makes it much easier to read. If this isn't possible (for instance
+ where the used tokens must be identified through integers) capitalized
+ identifiers should be used instead.
+ </li>
+<li>
+ Breaking the operands may not be needed for short expressions. e.g. <tt class="computeroutput">*(',' >>
+ file_identifier)</tt>
+ as long as the line does not exceed 80 characters.
+ </li>
+<li>
+ If a sequence fits on one line, put spaces inside the parentheses to clearly
+ separate them from the rules.
+ </li>
+</ul></div>
+<pre class="programlisting">program_heading
+ = no_case["program"]
+ >> identifier
+ >> '('
+ >> file_identifier
+ >> *( ',' >> file_identifier )
+ >> ')'
+ >> ';'
+ ;
+</pre>
+<div class="itemizedlist"><ul type="disc"><li>
+ Nesting directives: If a rule does not fit on one line (80 characters)
+ it should be continued on the next line intended by one level. The brackets
+ of directives, semantic expressions (using Phoenix or LL lambda expressions)
+ or parsers should be placed as follows.
+ </li></ul></div>
+<pre class="programlisting">identifier
+ = no_case
+ [
+ lexeme
+ [
+ alpha >> *(alnum | '_') [id_action]
+ ]
+ ]
+ ;
+</pre>
+<div class="itemizedlist"><ul type="disc"><li>
+ Nesting unary operators (e.g.Kleene star): Unary rule operators (Kleene
+ star, <tt class="computeroutput">'!'</tt>, <tt class="computeroutput">'+'</tt>
+ etc.) should be moved out one space before the corresponding indentation
+ level, if this rule has a body or a sequence after it, which does not fit
+ on on line. This makes the formatting more consistent and moves the rule
+ 'body' at the same indentation level as the rule itself, highlighting the
+ unary operator.
+ </li></ul></div>
+<pre class="programlisting">block
+ = *( label_declaration_part
+ | constant_definition_part
+ | type_definition_part
+ | variable_declaration_part
+ | procedure_and_function_declaration_part
+ )
+ >> statement_part
+ ;
+</pre>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2001-2009 Joel
+ de Guzman, 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../notes.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../notes.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../acknowledgments.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/preface.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/preface.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -0,0 +1,350 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Preface</title>
+<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
+<link rel="home" href="../index.html" title="Spirit 2.1">
+<link rel="up" href="../index.html" title="Spirit 2.1">
+<link rel="previous" href="../index.html" title="Spirit 2.1">
+<link rel="next" href="what_s_new.html" title="What's New">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../index.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="what_s_new.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h2 class="title" style="clear: both">
+<a name="spirit.preface"></a>Preface
+</h2></div></div>
+<div></div>
+</div>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ “Examples of designs that meet most of the criteria for
+ "goodness" (easy to understand, flexible, efficient) are a recursive-
+ descent parser, which is traditional procedural code. Another example is
+ the STL, which is a generic library of containers and algorithms depending
+ crucially on both traditional procedural code and on parametric polymorphism.”
+ --Bjarne Stroustrup
+ 
+
+ 
+</blockquote></div>
+<a name="spirit.preface.history"></a><h3>
+<a name="id355311"></a>
+ History
+ </h3>
+<a name="spirit.preface._emphasis_80s__emphasis_"></a><h3>
+<a name="id355325"></a>
+ 80s
+ </h3>
+
+ In the Mid 80s, Joel wrote his first calculator in Pascal. It has been an unforgettable
+ coding experience. He was amazed how a mutually recursive set of functions
+ can model a grammar specification. In time, the skills he acquired from that
+ academic experience became very practical. Periodically Joel was tasked to
+ do some parsing. For instance, whenever he needs to perform any form of I/O,
+ even in binary, he tries to approach the task somewhat formally by writing
+ a grammar using Pascal- like syntax diagrams and then write a corresponding
+ recursive-descent parser. This worked very well.
+ 
+<a name="spirit.preface._emphasis_90s__emphasis_"></a><h3>
+<a name="id353704"></a>
+ 90s
+ </h3>
+
+ The arrival of the Internet and the World Wide Web magnified this thousand-fold.
+ At one point Joel had to write an HTML parser for a Web browser project. He
+ got a recursive-descent HTML parser working based on the W3C formal specifications
+ easily. He was certainly glad that HTML had a formal grammar specification.
+ Because of the influence of the Internet, Joel then had to do more parsing.
+ RFC specifications were everywhere. SGML, HTML, XML, even email addresses and
+ those seemingly trivial URLs were all formally specified using small EBNF-
+ style grammar specifications. This made him wish for a tool similar to big-
+ time parser generators such as YACC and ANTLR, where a parser is built automatically
+ from a grammar specification. Yet, he wants it to be extremely small; small
+ enough to fit in my pocket, yet scalable.
+ 
+
+ It must be able to practically parse simple grammars such as email addresses
+ to moderately complex grammars such as XML and perhaps some small to medium-sized
+ scripting languages. Scalability is a prime goal. You should be able to use
+ it for small tasks such as parsing command lines without incurring a heavy
+ payload, as you do when you are using YACC or PCCTS. Even now that it has evolved
+ and matured to become a multi-module library, true to its original intent,
+ Spirit can still be used for extreme micro-parsing tasks. You only pay for
+ features that you need. The power of Spirit comes from its modularity and extensibility.
+ Instead of giving you a sledgehammer, it gives you the right ingredients to
+ create a sledgehammer easily.
+ 
+
+ The result was Spirit. Spirit was a personal project that was conceived when
+ Joel was doing R&D in Japan. Inspired by the GoF's composite and interpreter
+ patterns, he realized that he can model a recursive-descent parser with hierarchical-object
+ composition of primitives (terminals) and composites (productions). The original
+ version was implemented with run-time polymorphic classes. A parser is generated
+ at run time by feeding in production rule strings such as:
+ 
+<pre class="programlisting">"prod ::= {'A' | 'B'} 'C';"
+</pre>
+
+ A compile function compiled the parser, dynamically creating a hierarchy of
+ objects and linking semantic actions on the fly. A very early text can be found
+ here: pre-Spirit.
+ 
+<a name="spirit.preface._emphasis_2001_to_2006__emphasis_"></a><h3>
+<a name="id353805"></a>
+ <a href="preface.html#spirit.preface._emphasis_2001_to_2006__emphasis_">2001
+ to 2006</a>
+ </h3>
+
+ Version 1.0 to 1.8 was a complete rewrite of the original Spirit parser using
+ expression templates and static polymorphism, inspired by the works of Todd
+ Veldhuizen (<a href="http://ubiety.uwaterloo.ca/~tveldhui/papers/Expression-Templates/exprtmpl.html" target="_top">Expression
+ Templates</a>, C++ Report, June 1995). Initially, the static-Spirit version
+ was meant only to replace the core of the original dynamic-Spirit. Dynamic-spirit
+ needed a parser to implement itself anyway. The original employed a hand-coded
+ recursive-descent parser to parse the input grammar specification strings.
+ Incidentially it was the time, when Hartmut joined the Spirit development.
+ 
+
+ After its initial "open-source" debut in May 2001, static-Spirit
+ became a success. At around November 2001, the Spirit website had an activity
+ percentile of 98%, making it the number one parser tool at Source Forge at
+ the time. Not bad for such a niche project such as a parser library. The "static"
+ portion of Spirit was forgotten and static-Spirit simply became Spirit. The
+ library soon evolved to acquire more dynamic features.
+ 
+
+ Spirit was formally accepted into Boost
+ in October 2002. Boost is a peer-reviewed, open collaborative development effort
+ that is a collection of free Open Source C++ libraries covering a wide range
+ of domains. The Boost Libraries have become widely known as an industry standard
+ for design and implementation quality, robustness, and reusability.
+ 
+<a name="spirit.preface._emphasis_2007__emphasis_"></a><h3>
+<a name="id353862"></a>
+ 2007
+ </h3>
+
+ Over the years, especially after Spirit was accepted into Boost, Spirit has
+ served its purpose quite admirably. The focus of what we'll now call Classic-Spirit (versions prior
+ to 2.0) was on transduction parsing where the input string is merely translated
+ to an output string. A lot of parsers are of the transduction type. When the
+ time came to add attributes to the parser library, it was done rather in an
+ ad-hoc manner, with the goal being 100% backward compatible with classic Spirit.
+ Some parsers have attributes, some don't.
+ 
+
+ Spirit V2 is another major rewrite. Spirit V2 grammars are fully attributed
+ (see <a href="http://en.wikipedia.org/wiki/Attribute_grammar" target="_top">Attribute
+ Grammar</a>). All parser components have attributes. To do this efficiently
+ and ellegantly, we had to use a couple of infrastructure libraries. Some of
+ which haven't been written yet at the time, some were quite new when Spirit
+ debuted, and some needed work. MPL
+ is an important infrastructure library, yet is not sufficient to implement
+ Spirit V2. Another library had to be written: Fusion.
+ Fusion sits between MPL and STL --between compile time and runtime -- mapping
+ types to values. Fusion is a direct descendant of both MPL and Boost.Tuples
+ (Fusion is now a full fledged Boost
+ library). Phoenix also
+ had to be beefed up to support Spirit V2. The result is Phoenix2.
+ Last but not least, Spirit V2 uses an <a href="http://ubiety.uwaterloo.ca/~tveldhui/papers/Expression-Templates/exprtmpl.html" target="_top">Expression
+ Templates</a> library called Boost.Proto.
+ 
+<a name="spirit.preface.new_ideas__spirit_v2"></a><h3>
+<a name="id355502"></a>
+ New Ideas: Spirit V2
+ </h3>
+
+ Just before the development of Spirit V2 began, Hartmut came across the StringTemplate library which is
+ a part of the ANTLR parser framework. It is a Java template engine (with ports
+ for C# and Python) for generating source code, web pages, emails, or any other
+ formatted text output. With it, he got the the idea of using a formal notation
+ (a grammar) to describe the expected structure of an input character sequence.
+ The same grammar may be used to formalize the structure of a corresponding
+ output character sequence. This is possible because parsing, most of the time,
+ is implemented by comparing the input with the patterns defined by the grammar.
+ If we use the same patterns to format a matching output, the generated sequence
+ will follow the rules of the grammar as well.
+ 
+
+ This insight lead to the implementation of a grammar driven output generation
+ library compatibile with the Spirit parser library. As it turned out, parsing
+ and generation are tightly connected and have very similar concepts. The duality
+ of these two sides of the same medal is ubiquitous, which allowed us to build
+ the parser library Spirit.Qi and the generator library
+ Spirit.Karma using the same component infastructure.
+ 
+
+ The idea of creating a lexer library well integrated with the Spirit parsers
+ is not new. This has been discussed almost for the whole time of the existence
+ of Classic-Spirit (pre V2) now. Several attempts to integrate existing lexer
+ libraries and frameworks with Spirit have been made and served as a proof of
+ concept and usability (for example see Wave:
+ The Boost C/C++ Preprocessor Library, and SLex:
+ a fully dynamic C++ lexer implemented with Spirit). Based on these experiences
+ we added Spirit.Lex: a fully integrated lexer library
+ to the mix, allowing to take advantage of the power of regular expressions
+ for token matching, removing pressure from the parser components, simplifying
+ parser grammars. Again, Spirit's modular structure allowed us to reuse the
+ same underlying component library as for the parser and generator libraries.
+ 
+<a name="spirit.preface.how_to_use_this_manual"></a><h3>
+<a name="id355572"></a>
+ How to use this manual
+ </h3>
+
+ Each major section (there are 3: Qi, Karma, and Lex)
+ is roughly divided into 3 parts:
+ 
+<div class="orderedlist"><ol type="1">
+<li>
+ Tutorials: A step by step guide with heavily annotated code. These are meant
+ to get the user acquainted with the library as quickly as possible. The objective
+ is to build the confidence of the user in using the library using abundant
+ examples and detailed instructions. Examples speak volumes.
+ </li>
+<li>
+ Abstracts: A high level summary of key topics. The objective is to give the
+ user a high level view of the library, the key concepts, background and theories.
+ </li>
+<li>
+ Reference: Detailed formal technical reference. We start with a quick reference
+ -- an easy to use table that maps into the reference proper. The reference
+ proper starts with C++ Concepts
+ followed by models of the concepts.
+ </li>
+</ol></div>
+
+ Some icons are used to mark certain topics indicative of their relevance. These
+ icons precede some text to indicate:
+ 
+<div class="table">
+<a name="id355643"></a>Table 1. Icons
+<table class="table" summary="Icons">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Icon
+ </th>
+<th>
+ Name
+ </th>
+<th>
+ Meaning
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <img src="images/note.png" alt="note">
+ </td>
+<td>
+ Note
+ </td>
+<td>
+ Generally useful information (an aside that doesn't fit in the flow of
+ the text)
+ </td>
+</tr>
+<tr>
+<td>
+ <img src="images/tip.png" alt="tip">
+ </td>
+<td>
+ Tip
+ </td>
+<td>
+ Suggestion on how to do something (especially something that not be obvious)
+ </td>
+</tr>
+<tr>
+<td>
+ <img src="images/important.png" alt="important">
+ </td>
+<td>
+ Important
+ </td>
+<td>
+ Important note on something to take particular notice of
+ </td>
+</tr>
+<tr>
+<td>
+ <img src="images/caution.png" alt="caution">
+ </td>
+<td>
+ Caution
+ </td>
+<td>
+ Take special care with this - it may not be what you expect and may cause
+ bad results
+ </td>
+</tr>
+<tr>
+<td>
+ <img src="images/alert.png" alt="alert">
+ </td>
+<td>
+ Danger
+ </td>
+<td>
+ This is likely to cause serious trouble if ignored
+ </td>
+</tr>
+</tbody>
+</table>
+</div>
+
+ This documentation is automatically generated by Boost QuickBook documentation
+ tool. QuickBook can be found in the <a href="http://www.boost.org/tools/index.html" target="_top">Boost
+ Tools</a>.
+ 
+<a name="spirit.preface.support"></a><h3>
+<a name="id353379"></a>
+ Support
+ </h3>
+
+ Please direct all questions to Spirit's mailing list. You can subscribe to
+ the <a href="http://www.nabble.com/The-Spirit-Parser-Library-f3430.html" target="_top">Spirit
+ General List</a>. The mailing list has a searchable archive. A search link
+ to this archive is provided in Spirit's
+ home page. You may also read and post messages to the mailing list through
+ <a href="news://news.gmane.org/gmane.comp.spirit.general" target="_top">Spirit General
+ NNTP news portal</a> (thanks to Gmane).
+ The news group mirrors the mailing list. Here is a link to the archives: http://news.gmane.org/gmane.comp.parsers.spirit.general.
+ 
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2001-2009 Joel
+ de Guzman, 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../index.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="what_s_new.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Modified: trunk/libs/spirit/doc/html/spirit/qi.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/qi.html (original)
+++ trunk/libs/spirit/doc/html/spirit/qi.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -8,7 +8,7 @@
<link rel="up" href="../index.html" title="Spirit 2.1">
<link rel="previous" href="abstracts/parsing_expression_grammar.html" title="Parsing
 Expression Grammar">
-<link rel="next" href="qi/quick_reference.html" title="Quick Reference">
+<link rel="next" href="qi/tutorials.html" title="Tutorials">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
@@ -21,7 +21,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="abstracts/parsing_expression_grammar.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="qi/quick_reference.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="abstracts/parsing_expression_grammar.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="qi/tutorials.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage">
@@ -31,31 +31,31 @@
<div></div>
</div>
<div class="toc"><dl>
-<dt>Tutorials</dt>
+<dt>Tutorials</dt>
<dd><dl>
-<dt>Quick Start</dt>
-<dt>Warming up</dt>
-<dt>Semantic Actions</dt>
-<dt><a href="qi.html#spirit.qi.tutorials.complex___our_first_complex_parser">Complex
+<dt>Quick Start</dt>
+<dt>Warming up</dt>
+<dt>Semantic Actions</dt>
+<dt><a href="qi/tutorials/complex___our_first_complex_parser.html">Complex
 - Our first complex parser</a></dt>
-<dt><a href="qi.html#spirit.qi.tutorials.sum___adding_numbers">Sum - adding
+<dt><a href="qi/tutorials/sum___adding_numbers.html">Sum - adding
 numbers</a></dt>
-<dt><a href="qi.html#spirit.qi.tutorials.number_list___stuffing_numbers_into_a_std__vector">Number
+<dt><a href="qi/tutorials/number_list___stuffing_numbers_into_a_std__vector.html">Number
 List - stuffing numbers into a std::vector</a></dt>
-<dt><a href="qi.html#spirit.qi.tutorials.number_list_redux___list_syntax">Number
+<dt><a href="qi/tutorials/number_list_redux___list_syntax.html">Number
 List Redux - list syntax</a></dt>
-<dt><a href="qi.html#spirit.qi.tutorials.number_list_attribute___one_more__with_style">Number
+<dt><a href="qi/tutorials/number_list_attribute___one_more__with_style.html">Number
 List Attribute - one more, with style</a></dt>
-<dt>Roman Numerals</dt>
-<dt><a href="qi.html#spirit.qi.tutorials.employee___parsing_into_structs">Employee
+<dt>Roman Numerals</dt>
+<dt><a href="qi/tutorials/employee___parsing_into_structs.html">Employee
 - Parsing into structs</a></dt>
-<dt>Mini XML - ASTs!</dt>
-<dt><a href="qi.html#spirit.qi.tutorials.mini_xml___error_handling">Mini
+<dt>Mini XML - ASTs!</dt>
+<dt><a href="qi/tutorials/mini_xml___error_handling.html">Mini
 XML - Error Handling</a></dt>
</dl></dd>
<dt>Quick Reference</dt>
<dd><dl>
-<dt>Common Notation</dt>
+<dt>Common Notation</dt>
<dt><a href="qi/quick_reference/predefined_primitive_parsers.html">Predefined
 Primitive Parsers</a></dt>
<dt><a href="qi/quick_reference/compound_attribute_rules.html">Compound
@@ -67,2599 +67,6 @@
<dt>Phoenix</dt>
</dl></dd>
</dl></div>
-<div class="section" lang="en">
-<div class="titlepage">
-<div><div><h3 class="title">
-<a name="spirit.qi.tutorials"></a>Tutorials
-</h3></div></div>
-<div></div>
-</div>
-<div class="toc"><dl>
-<dt>Quick Start</dt>
-<dt>Warming up</dt>
-<dt>Semantic Actions</dt>
-<dt><a href="qi.html#spirit.qi.tutorials.complex___our_first_complex_parser">Complex
- - Our first complex parser</a></dt>
-<dt><a href="qi.html#spirit.qi.tutorials.sum___adding_numbers">Sum - adding
- numbers</a></dt>
-<dt><a href="qi.html#spirit.qi.tutorials.number_list___stuffing_numbers_into_a_std__vector">Number
- List - stuffing numbers into a std::vector</a></dt>
-<dt><a href="qi.html#spirit.qi.tutorials.number_list_redux___list_syntax">Number
- List Redux - list syntax</a></dt>
-<dt><a href="qi.html#spirit.qi.tutorials.number_list_attribute___one_more__with_style">Number
- List Attribute - one more, with style</a></dt>
-<dt>Roman Numerals</dt>
-<dt><a href="qi.html#spirit.qi.tutorials.employee___parsing_into_structs">Employee
- - Parsing into structs</a></dt>
-<dt>Mini XML - ASTs!</dt>
-<dt><a href="qi.html#spirit.qi.tutorials.mini_xml___error_handling">Mini
- XML - Error Handling</a></dt>
-</dl></div>
-<div class="section" lang="en">
-<div class="titlepage">
-<div><div><h4 class="title">
-<a name="spirit.qi.tutorials.quick_start"></a>Quick Start
-</h4></div></div>
-<div></div>
-</div>
-<a name="spirit.qi.tutorials.quick_start.why_would_you_want_to_use_spirit_qi_"></a><h5>
-<a name="id415447"></a>
- <a href="qi.html#spirit.qi.tutorials.quick_start.why_would_you_want_to_use_spirit_qi_">Why
- would you want to use Spirit.Qi?</a>
- </h5>
-
- Spirit.Qi is designed to be a practical parsing tool. The ability to generate
- a fully-working parser from a formal EBNF specification inlined in C++
- significantly reduces development time. Programmers typically approach
- parsing using ad hoc hacks with primitive tools such as scanf. Even regular-expression
- libraries (such as boost regex) or scanners (such as Boost tokenizer) do
- not scale well when we need to write more elaborate parsers. Attempting
- to write even a moderately-complex parser using these tools leads to code
- that is hard to understand and maintain.
- 
-
- One prime objective is to make the tool easy to use. When one thinks of
- a parser generator, the usual reaction is "it must be big and complex
- with a steep learning curve." Not so. Spirit is designed to be fully
- scalable. The framework is structured in layers. This permits learning
- on an as-needed basis, after only learning the minimal core and basic concepts.
- 
-
- For development simplicity and ease in deployment, the entire framework
- consists of only header files, with no libraries to link against or build.
- Just put the spirit distribution in your include path, compile and run.
- Code size? -very tight -essentially comparable to hand written recursive
- descent code.
- 
-
- Our tutorials will walk you through the simplest Spirit examples, incrementally
- building on top of the earlier examples as we expose more and more features
- and techniques. We will try to be as gentle as possible with the learning
- curve. We will present the tutorials in a cookbook style approach. This
- style of presentation is based on our BoostCon '07 and BoostCon '08 slides.
- 
-
- Have fun!
- 
-</div>
-<div class="section" lang="en">
-<div class="titlepage">
-<div><div><h4 class="title">
-<a name="spirit.qi.tutorials.warming_up"></a>Warming up
-</h4></div></div>
-<div></div>
-</div>
-
- We'll start by showing examples of parser expressions to give you a feel
- on how to build parsers from the simplest parser, building up as we go.
- 
-<a name="spirit.qi.tutorials.warming_up.trivial_example__1_parsing_a_number"></a><h5>
-<a name="id415527"></a>
- <a href="qi.html#spirit.qi.tutorials.warming_up.trivial_example__1_parsing_a_number">Trivial
- Example #1 Parsing a number</a>
- </h5>
-
- Create a parser that will parse a floating-point number.
- 
-<pre class="programlisting">double_
-</pre>
-
- (You've got to admit, that's trivial!) The above code actually generates
- a Spirit floating point parser (a built-in parser). Spirit has many pre-defined
- parsers and consistent naming conventions help you keep from going insane!
- 
-<a name="spirit.qi.tutorials.warming_up.trivial_example__2_parsing_two_numbers"></a><h5>
-<a name="id415573"></a>
- <a href="qi.html#spirit.qi.tutorials.warming_up.trivial_example__2_parsing_two_numbers">Trivial
- Example #2 Parsing two numbers</a>
- </h5>
-
- Create a parser that will accept a line consisting of two floating-point
- numbers.
- 
-<pre class="programlisting">double_ >> double_
-</pre>
-
- Here you see the familiar floating-point numeric parser <tt class="computeroutput">double_</tt>
- used twice, once for each number. What's that <tt class="computeroutput">>></tt>
- operator doing in there? Well, they had to be separated by something, and
- this was chosen as the "followed by" sequence operator. The above
- program creates a parser from two simpler parsers, glueing them together
- with the sequence operator. The result is a parser that is a composition
- of smaller parsers. Whitespace between numbers can implicitly be consumed
- depending on how the parser is invoked (see below).
- 
-<div class="note"><table border="0" summary="Note">
-<tr>
-<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../images/note.png"></td>
-<th align="left">Note</th>
-</tr>
-<tr><td colspan="2" align="left" valign="top">
- When we combine parsers, we end up with a "bigger" parser,
- but it's still a parser. Parsers can get bigger and bigger, nesting more
- and more, but whenever you glue two parsers together, you end up with
- one bigger parser. This is an important concept.
- </td></tr>
-</table></div>
-<a name="spirit.qi.tutorials.warming_up.trivial_example__3_parsing_one_or_more_numbers"></a><h5>
-<a name="id415661"></a>
- <a href="qi.html#spirit.qi.tutorials.warming_up.trivial_example__3_parsing_one_or_more_numbers">Trivial
- Example #3 Parsing one or more numbers</a>
- </h5>
-
- Create a parser that will accept zero or more floating-point numbers.
- 
-<pre class="programlisting">*double_
-</pre>
-
- This is like a regular-expression Kleene Star, though the syntax might
- look a bit odd for a C++ programmer not used to seeing the <tt class="computeroutput">*</tt> operator overloaded like this. Actually,
- if you know regular expressions it may look odd too since the star is before
- the expression it modifies. C'est la vie. Blame it on the fact that we
- must work with the syntax rules of C++.
- 
-
- Any expression that evaluates to a parser may be used with the Kleene Star.
- Keep in mind, though, that due to C++ operator precedence rules you may
- need to put the expression in parentheses for complex expressions. The
- Kleene Star is also known as a Kleene Closure, but we call it the Star
- in most places.
- 
-<a name="spirit.qi.tutorials.warming_up.trivial_example__4_parsing_a_comma_delimited_list_of_numbers"></a><h5>
-<a name="id415738"></a>
- <a href="qi.html#spirit.qi.tutorials.warming_up.trivial_example__4_parsing_a_comma_delimited_list_of_numbers">Trivial
- Example #4 Parsing a comma-delimited list of numbers</a>
- </h5>
-
- This example will create a parser that accepts a comma-delimited list of
- numbers.
- 
-<pre class="programlisting">double_ >> *(char_(',') >> double_)
-</pre>
-
- Notice <tt class="computeroutput">char_(',')</tt>. It is
- a literal character parser that can recognize the comma <tt class="computeroutput">','</tt>.
- In this case, the Kleene Star is modifying a more complex parser, namely,
- the one generated by the expression:
- 
-<pre class="programlisting">(char_(',') >> double_)
-</pre>
-
- Note that this is a case where the parentheses are necessary. The Kleene
- star encloses the complete expression above.
- 
-<a name="spirit.qi.tutorials.warming_up.let_s_parse_"></a><h5>
-<a name="id415914"></a>
- Let's Parse!
- </h5>
-
- We're done with defining the parser. So the next step is now invoking this
- parser to do its work. There are a couple of ways to do this. For now,
- we will use the <tt class="computeroutput">phrase_parse</tt>
- function. One overload of this function accepts four arguments:
- 
-<div class="orderedlist"><ol type="1">
-<li>
- An iterator pointing to the start of the input
- </li>
-<li>
- An iterator pointing to one past the end of the input
- </li>
-<li>
- The parser object
- </li>
-<li>
- Another parser called the skip parser
- </li>
-</ol></div>
-
- In our example, we wish to skip spaces and tabs. Another parser named
- <tt class="computeroutput">space</tt> is included in Spirit's
- repertoire of predefined parsers. It is a very simple parser that simply
- recognizes whitespace. We will use <tt class="computeroutput">space</tt>
- as our skip parser. The skip parser is the one responsible for skipping
- characters in between parser elements such as the <tt class="computeroutput">double_</tt>
- and <tt class="computeroutput">char_</tt>.
- 
-
- Ok, so now let's parse!
- 
-
- 
-
-
-
-<pre class="programlisting">template <typename Iterator>
-bool parse_numbers(Iterator first, Iterator last)
-{
- using qi::double_;
- using qi::phrase_parse;
- using ascii::space;
-
- bool r = phrase_parse(
- first, <a name="spirit0co" href="qi.html#spirit0"><img src="../../../../../doc/src/images/callouts/1.png" alt="1" border="0"></a>
- last, <a name="spirit1co" href="qi.html#spirit1"><img src="../../../../../doc/src/images/callouts/2.png" alt="2" border="0"></a>
- double_ >> *(',' >> double_), <a name="spirit2co" href="qi.html#spirit2"><img src="../../../../../doc/src/images/callouts/3.png" alt="3" border="0"></a>
- space <a name="spirit3co" href="qi.html#spirit3"><img src="../../../../../doc/src/images/callouts/4.png" alt="4" border="0"></a>
- );
- if (first != last) // fail if we did not get a full match
- return false;
- return r;
-}
-</pre>
-
- 
-
- 
-
- 
-<div class="calloutlist"><table border="0" summary="Callout list">
-<tr>
-<td width="5%" valign="top" align="left">
-<a name="spirit0"></a> </td>
-<td valign="top" align="left"> start iterator </td>
-</tr>
-<tr>
-<td width="5%" valign="top" align="left">
-<a name="spirit1"></a> </td>
-<td valign="top" align="left"> end iterator </td>
-</tr>
-<tr>
-<td width="5%" valign="top" align="left">
-<a name="spirit2"></a> </td>
-<td valign="top" align="left"> the parser </td>
-</tr>
-<tr>
-<td width="5%" valign="top" align="left">
-<a name="spirit3"></a> </td>
-<td valign="top" align="left"> the skip-parser </td>
-</tr>
-</table></div>
-
- 
-
- 
-
- The parse function returns <tt class="computeroutput">true</tt>
- or <tt class="computeroutput">false</tt> depending on the
- result of the parse. The first iterator is passed by reference. On a successful
- parse, this iterator is repositioned to the rightmost position consumed
- by the parser. If this becomes equal to str.end(), then we have a full
- match. If not, then we have a partial match. A partial match happens when
- the parser is only able to parse a portion of the input.
- 
-
- Note that we inlined the parser directly in the call to parse. Upon calling
- parse, the expression evaluates into a temporary, unnamed parser which
- is passed into the parse() function, used, and then destroyed.
- 
-
- Here, we opted to make the parser generic by making it a template, parameterized
- by the iterator type. By doing so, it can take in data coming from any
- STL conforming sequence as long as the iterators conform to a forward iterator.
- 
-
- You can find the full cpp file here: ../../example/qi/num_list1.cpp
- 
-<div class="note"><table border="0" summary="Note">
-<tr>
-<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../images/note.png"></td>
-<th align="left">Note</th>
-</tr>
-<tr><td colspan="2" align="left" valign="top">
-
- <tt class="computeroutput">char</tt> and <tt class="computeroutput">wchar_t</tt>
- operands
- 
-
- The careful reader may notice that the parser expression has <tt class="computeroutput">','</tt> instead of <tt class="computeroutput">char_(',')</tt>
- as the previous examples did. This is ok due to C++ syntax rules of conversion.
- There are <tt class="computeroutput">>></tt> operators
- that are overloaded to accept a <tt class="computeroutput">char</tt>
- or <tt class="computeroutput">wchar_t</tt> argument on its
- left or right (but not both). An operator may be overloaded if at least
- one of its parameters is a user-defined type. In this case, the <tt class="computeroutput">double_</tt> is the 2nd argument to <tt class="computeroutput">operator>></tt>,
- and so the proper overload of <tt class="computeroutput">>></tt>
- is used, converting <tt class="computeroutput">','</tt> into
- a character literal parser.
- 
-
- The problem with omiting the <tt class="computeroutput">char_</tt>
- should be obvious: <tt class="computeroutput">'a' >>
- 'b'</tt> is not a spirit parser, it is
- a numeric expression, right-shifting the ASCII (or another encoding)
- value of <tt class="computeroutput">'a'</tt> by the ASCII value
- of <tt class="computeroutput">'b'</tt>. However, both <tt class="computeroutput">char_('a') >>
- 'b'</tt> and <tt class="computeroutput">'a'
- >> char_('b')</tt>
- are Spirit sequence parsers for the letter <tt class="computeroutput">'a'</tt>
- followed by <tt class="computeroutput">'b'</tt>. You'll get
- used to it, sooner or later.
- 
-</td></tr>
-</table></div>
-
- Finally, take note that we test for a full match (i.e. the parser fully
- parsed the input) by checking if the first iterator, after parsing, is
- equal to the end iterator. You may strike out this part if partial matches
- are to be allowed.
- 
-</div>
-<div class="section" lang="en">
-<div class="titlepage">
-<div><div><h4 class="title">
-<a name="spirit.qi.tutorials.semantic_actions"></a>Semantic Actions
-</h4></div></div>
-<div></div>
-</div>
-
- Our parser above is really nothing but a recognizer. It answers the question
- "did the input match our grammar?", but it does not do anything
- other than that. It does not extract any information from what was parsed.
- For example, whenever we parse a real number, we wish to store the parsed
- number after a successful match.
- 
-
- Enter Semantic actions. Semantic actions may be attached to any point in
- the grammar specification. These actions are C++ functions or function
- objects that are called whenever a part of the parser successfully recognizes
- a portion of the input. Say you have a parser <tt class="computeroutput">P</tt>,
- and a C++ function <tt class="computeroutput">F</tt>, you
- can make the parser call <tt class="computeroutput">F</tt>
- whenever it matches an input by attaching <tt class="computeroutput">F</tt>:
- 
-<pre class="programlisting">P[F]
-</pre>
-
- The expression above links <tt class="computeroutput">F</tt>
- to the parser, <tt class="computeroutput">P</tt>.
- 
-
- The function/function object signature depends on the type of the parser
- to which it is attached. The parser <tt class="computeroutput">double_</tt>
- passes the parsed number. Thus, if we were to attach a function <tt class="computeroutput">F</tt> to <tt class="computeroutput">double_</tt>,
- we need <tt class="computeroutput">F</tt> to be declared
- as:
- 
-<pre class="programlisting">void F(double n);
-</pre>
-
- There are actually 2 more arguments being passed (the parser context and
- a reference to a boolean 'hit' parameter). We don't need these, for now,
- but we'll see more on these other arguments later. Spirit.Qi allows us
- to bind a single argument function, like above. The other arguments are
- simply ignored.
- 
-
- Presented are various ways to attach semantic actions:
- 
-<div class="itemizedlist"><ul type="disc">
-<li>
- Using plain function pointer
- </li>
-<li>
- Using simple function object
- </li>
-<li>
- Using Boost.Bind
- with a plain function
- </li>
-<li>
- Using Boost.Bind
- with a member function
- </li>
-<li>
- Using Boost.Lambda
-</li>
-</ul></div>
-
- Given:
- 
-
- 
-
-
-
-<pre class="programlisting">namespace client
-{
- namespace qi = boost::spirit::qi;
-
- // A plain function
- void print(int const& i)
- {
- std::cout << i << std::endl;
- }
-
- // A member function
- struct writer
- {
- void print(int const& i) const
- {
- std::cout << i << std::endl;
- }
- };
-
- // A function object
- struct print_action
- {
- void operator()(int const& i, qi::unused_type, qi::unused_type) const
- {
- std::cout << i << std::endl;
- }
- };
-}
-</pre>
-
- 
-
- 
-
- Take note that with function objects, we need to have an <tt class="computeroutput">operator()</tt>
- with 3 arguments. Since we don't care about the other two, we can use
- <tt class="computeroutput">unused_type</tt> for these.
- We'll see more of <tt class="computeroutput">unused_type</tt>
- elsewhere. Get used to it. <tt class="computeroutput">unused_type</tt>
- is a Spirit supplied support class.
- 
-
- All examples parse inputs of the form:
- 
-<pre class="programlisting">"{integer}"
-</pre>
-
- An integer inside the curly braces.
- 
-
- The first example shows how to attach a plain function:
- 
-
- 
-
-
-
-<pre class="programlisting">parse(first, last, '{' >> int_[&print] >> '}');
-</pre>
-
- 
-
- 
-
- What's new? Well <tt class="computeroutput">int_</tt> is
- the sibbling of <tt class="computeroutput">double_</tt>.
- I'm sure you can guess what this parser does.
- 
-
- The next example shows how to attach a simple function object:
- 
-
- 
-
-
-
-<pre class="programlisting">parse(first, last, '{' >> int_[print_action()] >> '}');
-</pre>
-
- 
-
- 
-
- We can use Boost.Bind
- to 'bind' member functions:
- 
-
- 
-
-
-
-<pre class="programlisting">writer w;
-parse(first, last, '{' >> int_[boost::bind(&writer::print, &w, _1)] >> '}');
-</pre>
-
- 
-
- 
-
- Likewise, we can also use Boost.Bind
- to 'bind' plain functions:
- 
-
- 
-
-
-
-<pre class="programlisting">parse(first, last, '{' >> int_[boost::bind(&print, _1)] >> '}');
-</pre>
-
- 
-
- 
-
- Yep, we can also use Boost.Lambda:
- 
-
- 
-
-
-
-<pre class="programlisting">parse(first, last, '{' >> int_[std::cout << _1 << '\n'] >> '}');
-</pre>
-
- 
-
- 
-
- There are more ways to bind semantic action functions, but the examples
- above are the most common. Attaching semantic actions is the first hurdle
- one has to tackle when getting started with parsing with Spirit. Familiarize
- yourself with this task and get intimate with the tools behind it such
- as Boost.Bind
- and Boost.Lambda.
- 
-
- The examples above can be found here: ../../example/qi/actions.cpp
- 
-<a name="spirit.qi.tutorials.semantic_actions.phoenix"></a><h5>
-<a name="id418385"></a>
- Phoenix
- </h5>
-
- Phoenix, a companion
- library bundled with Spirit, is specifically suited for binding semantic
- actions. It is like Boost.Lambda
- in steroids, with special custom features that make it easy to integrate
- semantic actions with Spirit. If your requirements go beyond simple to
- moderate parsing, I suggest you use this library. Examples presented henceforth
- shall be using the library exclusively
- 
-</div>
-<div class="section" lang="en">
-<div class="titlepage">
-<div><div><h4 class="title">
-<a name="spirit.qi.tutorials.complex___our_first_complex_parser"></a><a href="qi.html#spirit.qi.tutorials.complex___our_first_complex_parser" title="Complex
- - Our first complex parser">Complex
- - Our first complex parser</a>
-</h4></div></div>
-<div></div>
-</div>
-
- Well, not really a complex parser, but a parser that parses complex numbers.
- This time, we're using Phoenix
- to do the semantic actions.
- 
-
- Here's a simple parser expression for complex numbers:
- 
-<pre class="programlisting"> '(' >> double_ >> -(',' >> double_) >> ')'
-| double_
-</pre>
-
- What's new? Well, we have:
- 
-<div class="orderedlist"><ol type="1">
-<li>
- Alternates: e.g. <tt class="computeroutput">a |
- b</tt>. Try <tt class="computeroutput">a</tt>
- first. If it succeeds, good. If not, try the next alternative, <tt class="computeroutput">b</tt>.
- </li>
-<li>
- Optionals: e.g. -p. Match the parser p zero or one time.
- </li>
-</ol></div>
-
- The complex parser presented above reads as:
- 
-<div class="itemizedlist"><ul type="disc">
-<li>
- One or two real number in parantheses, separated by comma (the second
- number is optional)
- </li>
-<li>
-OR a single real number.
- </li>
-</ul></div>
-
- This parser can parse complex numbers of the form:
- 
-<pre class="programlisting">(123.45, 987.65)
-(123.45)
-123.45
-</pre>
-
- Here goes, this time with actions:
- 
-
- 
-
-
-
-<pre class="programlisting">namespace client
-{
- template <typename Iterator>
- bool parse_complex(Iterator first, Iterator last, std::complex<double>& c)
- {
- using boost::spirit::qi::double_;
- using boost::spirit::qi::_1;
- using boost::spirit::qi::phrase_parse;
- using boost::spirit::ascii::space;
- using boost::phoenix::ref;
-
- double rN = 0.0;
- double iN = 0.0;
- bool r = phrase_parse(first, last,
-
- // Begin grammar
- (
- '(' >> double_[ref(rN) = _1]
- >> -(',' >> double_[ref(iN) = _1]) >> ')'
- | double_[ref(rN) = _1]
- ),
- // End grammar
-
- space);
-
- if (!r || first != last) // fail if we did not get a full match
- return false;
- c = std::complex<double>(rN, iN);
- return r;
- }
-}
-</pre>
-
- 
-
- 
-
- The full cpp file for this example can be found here: ../../example/qi/complex_number.cpp
- 
-
- The <tt class="computeroutput">double_</tt> parser attaches
- this action:
- 
-<pre class="programlisting">ref(n) = _1
-</pre>
-
- This assigns the parsed result (actually, the attribute of <tt class="computeroutput">double_</tt>) to n. <tt class="computeroutput">ref(n)</tt>
- tells Phoenix that <tt class="computeroutput">n</tt> is
- a mutable reference. <tt class="computeroutput">_1</tt>
- is a Phoenix placeholder for the parsed result attribute.
- 
-</div>
-<div class="section" lang="en">
-<div class="titlepage">
-<div><div><h4 class="title">
-<a name="spirit.qi.tutorials.sum___adding_numbers"></a><a href="qi.html#spirit.qi.tutorials.sum___adding_numbers" title="Sum - adding
- numbers">Sum - adding
- numbers</a>
-</h4></div></div>
-<div></div>
-</div>
-
- Here's a parser that sums a comma-separated list of numbers.
- 
-
- Ok we've glossed over some details in our previous examples. First, our
- includes:
- 
-
- 
-
-
-
-<pre class="programlisting">#include <boost/spirit/include/qi.hpp>
-#include <boost/spirit/include/phoenix_core.hpp>
-#include <boost/spirit/include/phoenix_operator.hpp>
-#include <iostream>
-#include <string>
-</pre>
-
- 
-
- 
-
- Then some using directives:
- 
-
- 
-
-
-
-<pre class="programlisting">namespace qi = boost::spirit::qi;
-namespace ascii = boost::spirit::ascii;
-namespace phoenix = boost::phoenix;
-
-using qi::double_;
-using qi::_1;
-using ascii::space;
-using phoenix::ref;
-</pre>
-
- 
-
- 
-<div class="informaltable"><table class="table">
-<colgroup>
-<col>
-<col>
-</colgroup>
-<thead><tr>
-<th>
- Namespace
- </th>
-<th>
- Description
- </th>
-</tr></thead>
-<tbody>
-<tr>
-<td>
- boost::phoenix
- </td>
-<td>
- All of phoenix
- </td>
-</tr>
-<tr>
-<td>
- boost::spirit
- </td>
-<td>
- All of spirit
- </td>
-</tr>
-<tr>
-<td>
- boost::spirit::qi
- </td>
-<td>
- All of spirit.qi
- </td>
-</tr>
-<tr>
-<td>
- boost::spirit::ascii
- </td>
-<td>
- ASCII version of <tt class="computeroutput">char_</tt>
- and all char related parsers. Other encodings are also provided
- (e.g. also an ISO8859.1)
- </td>
-</tr>
-<tr>
-<td>
- boost::spirit::arg_names
- </td>
-<td>
- Special phoenix placeholders for spirit
- </td>
-</tr>
-</tbody>
-</table></div>
-<div class="note"><table border="0" summary="Note">
-<tr>
-<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../images/note.png"></td>
-<th align="left">Note</th>
-</tr>
-<tr><td colspan="2" align="left" valign="top">
- If you feel uneasy with using whole namespaces, feel free to qualify
- your code, use namespace aliases, etc. For the purpose of this tutorial,
- we will be presenting unqualified names for both Spirit and Phoenix.
- No worries, we will always present the full working code, so you won't
- get lost. In fact, all examples in this tutorial have a corresponding
- cpp file that QuickBook (the documentation tool we are using) imports
- in here as code snippets.
- </td></tr>
-</table></div>
-
- Now the actual parser:
- 
-
- 
-
-
-
-<pre class="programlisting">template <typename Iterator>
-bool adder(Iterator first, Iterator last, double& n)
-{
- bool r = qi::phrase_parse(first, last,
-
- // Begin grammar
- (
- double_[ref(n) = _1] >> *(',' >> double_[ref(n) += _1])
- )
- ,
- // End grammar
-
- space);
-
- if (first != last) // fail if we did not get a full match
- return false;
- return r;
-}
-</pre>
-
- 
-
- 
-
- The full cpp file for this example can be found here: ../../example/qi/sum.cpp
- 
-
- This is almost like our original numbers list example. We're incrementally
- building on top of our examples. This time though, like in the complex
- number example, we'll be adding the smarts. There's an accumulator (`double&
- n) that adds the numbers parsed. On a successful parse, this number is
- the sum of all the parsed numbers.
- 
-
- The first <tt class="computeroutput">double_</tt> parser
- attaches this action:
- 
-<pre class="programlisting">ref(n) = _1
-</pre>
-
- This assigns the parsed result (actually, the attribute of <tt class="computeroutput">double_</tt>) to <tt class="computeroutput">n</tt>.
- <tt class="computeroutput">ref(n)</tt> tells
- Phoenix that <tt class="computeroutput">n</tt> is a mutable reference. <tt class="computeroutput">_1</tt> is a Phoenix
- placeholder for the parsed result attribute.
- 
-
- The second <tt class="computeroutput">double_</tt> parser
- attaches this action:
- 
-<pre class="programlisting">ref(n) += _1
-</pre>
-
- So, subsequent numbers add into <tt class="computeroutput">n</tt>.
- 
-
- That wasn't too bad, was it :-) ?
- 
-</div>
-<div class="section" lang="en">
-<div class="titlepage">
-<div><div><h4 class="title">
-<a name="spirit.qi.tutorials.number_list___stuffing_numbers_into_a_std__vector"></a><a href="qi.html#spirit.qi.tutorials.number_list___stuffing_numbers_into_a_std__vector" title="Number
- List - stuffing numbers into a std::vector">Number
- List - stuffing numbers into a std::vector</a>
-</h4></div></div>
-<div></div>
-</div>
-
- This sample demontrates a parser for a comma separated list of numbers.
- The numbers are inserted in a vector using phoenix.
- 
-
- 
-
-
-
-<pre class="programlisting">template <typename Iterator>
-bool parse_numbers(Iterator first, Iterator last, std::vector<double>& v)
-{
- using qi::double_;
- using qi::phrase_parse;
- using qi::_1;
- using ascii::space;
- using phoenix::push_back;
- using phoenix::ref;
-
- bool r = phrase_parse(first, last,
-
- // Begin grammar
- (
- double_[push_back(ref(v), _1)]
- >> *(',' >> double_[push_back(ref(v), _1)])
- )
- ,
- // End grammar
-
- space);
-
- if (first != last) // fail if we did not get a full match
- return false;
- return r;
-}
-</pre>
-
- 
-
- 
-
- The full cpp file for this example can be found here: ../../example/qi/num_list2.cpp
- 
-
- This, again, is the same parser as before. This time, instead of summing
- up the numbers, we stuff them in a <tt class="computeroutput">std::vector</tt>.
- <tt class="computeroutput">push_back</tt> is supplied by
- Phoenix. The expression:
- 
-<pre class="programlisting">push_back(ref(v), _1)
-</pre>
-
- appends the parsed number. Like before, <tt class="computeroutput">_1</tt>
- is a Phoenix placeholder
- for the parsed result attribute. Also, like before, <tt class="computeroutput">ref(v)</tt>
- tells Phoenix that
- <tt class="computeroutput">v</tt>, the <tt class="computeroutput">std::vector</tt>,
- is a mutable reference.
- 
-</div>
-<div class="section" lang="en">
-<div class="titlepage">
-<div><div><h4 class="title">
-<a name="spirit.qi.tutorials.number_list_redux___list_syntax"></a><a href="qi.html#spirit.qi.tutorials.number_list_redux___list_syntax" title="Number
- List Redux - list syntax">Number
- List Redux - list syntax</a>
-</h4></div></div>
-<div></div>
-</div>
-
- So far, we've been using the syntax:
- 
-<pre class="programlisting">double_ >> *(',' >> double_)
-</pre>
-
- to parse a comma-delimited list of numbers. Such lists are common in parsing
- and Spirit provides a simpler shortcut for them. The expression above can
- be simplified to:
- 
-<pre class="programlisting">double_ % ','
-</pre>
-
- read as: a list of doubles separated by <tt class="computeroutput">','</tt>.
- 
-
- This sample, again a variation of our previous example, demonstrates just
- that:
- 
-
- 
-
-
-
-<pre class="programlisting">template <typename Iterator>
-bool parse_numbers(Iterator first, Iterator last, std::vector<double>& v)
-{
- using qi::double_;
- using qi::phrase_parse;
- using qi::_1;
- using ascii::space;
- using phoenix::push_back;
- using phoenix::ref;
-
- bool r = phrase_parse(first, last,
-
- // Begin grammar
- (
- double_[push_back(ref(v), _1)] % ','
- )
- ,
- // End grammar
-
- space);
-
- if (first != last) // fail if we did not get a full match
- return false;
- return r;
-}
-</pre>
-
- 
-
- 
-
- The full cpp file for this example can be found here: ../../example/qi/num_list3.cpp
- 
-</div>
-<div class="section" lang="en">
-<div class="titlepage">
-<div><div><h4 class="title">
-<a name="spirit.qi.tutorials.number_list_attribute___one_more__with_style"></a><a href="qi.html#spirit.qi.tutorials.number_list_attribute___one_more__with_style" title="Number
- List Attribute - one more, with style">Number
- List Attribute - one more, with style</a>
-</h4></div></div>
-<div></div>
-</div>
-
- You've seen that the <tt class="computeroutput">double_</tt>
- parser has a <tt class="computeroutput">double</tt> attribute.
- All parsers have an attribute, even complex parsers, those that are composed
- from primitives using operators, like the list parser, also have an attribute.
- It so happens that the the attribute of a list parser:
- 
-<pre class="programlisting">p % d
-</pre>
-
- is a <tt class="computeroutput">std::vector</tt> of the attribute of <tt class="computeroutput">p</tt>. So, for our parser:
- 
-<pre class="programlisting">double_ % ','
-</pre>
-
- we'll have an attribute of:
- 
-<pre class="programlisting">std::vector<double>
-</pre>
-
- So, what does this give us? Well, we can simply pass in a <tt class="computeroutput">std::vector<double></tt>
- to our number list parser and it will happily churn out our result in our
- vector. For that to happen, we'll use a variation of the <tt class="computeroutput">phrase_parse</tt> with an additional argument:
- the parser's attribute:
- 
-<div class="orderedlist"><ol type="1">
-<li>
- An iterator pointing to the start of the input
- </li>
-<li>
- An iterator pointing to one past the end of the input
- </li>
-<li>
- The parser object
- </li>
-<li>
- The parser's attribute
- </li>
-<li>
- Another parser called the skip parser
- </li>
-</ol></div>
-
- So, our parser now is further simplified to:
- 
-
- 
-
-
-
-<pre class="programlisting">template <typename Iterator>
-bool parse_numbers(Iterator first, Iterator last, std::vector<double>& v)
-{
- using qi::double_;
- using qi::phrase_parse;
- using qi::_1;
- using ascii::space;
-
- bool r = phrase_parse(first, last,
-
- // Begin grammar
- (
- double_ % ','
- )
- ,
- // End grammar
-
- space, v);
-
- if (first != last) // fail if we did not get a full match
- return false;
- return r;
-}
-</pre>
-
- 
-
- 
-
- The full cpp file for this example can be found here: ../../example/qi/num_list4.cpp
- 
-
- Hey, no more actions!!! Now we're entering
- the realm of attribute grammars. Cool eh?
- 
-</div>
-<div class="section" lang="en">
-<div class="titlepage">
-<div><div><h4 class="title">
-<a name="spirit.qi.tutorials.roman_numerals"></a>Roman Numerals
-</h4></div></div>
-<div></div>
-</div>
-
- This example demonstrates:
- 
-<div class="itemizedlist"><ul type="disc">
-<li>
- symbol table
- </li>
-<li>
- rule
- </li>
-<li>
- grammar
- </li>
-</ul></div>
-<a name="spirit.qi.tutorials.roman_numerals.symbol_table"></a><h5>
-<a name="id423432"></a>
- <a href="qi.html#spirit.qi.tutorials.roman_numerals.symbol_table">Symbol
- Table</a>
- </h5>
-
- The symbol table holds a dictionary of symbols where each symbol is a sequence
- of characters (a <tt class="computeroutput">char</tt>, <tt class="computeroutput">wchar_t</tt>, <tt class="computeroutput">int</tt>,
- enumeration etc.) . The template class, parameterized by the character
- type, can work efficiently with 8, 16, 32 and even 64 bit characters. Mutable
- data of type T is associated with each symbol.
- 
-
- Traditionally, symbol table management is maintained seperately outside
- the BNF grammar through semantic actions. Contrary to standard practice,
- the Spirit symbol table class symbols is-a parser. An object of which may
- be used anywhere in the EBNF grammar specification. It is an example of
- a dynamic parser. A dynamic parser is characterized by its ability to modify
- its behavior at run time. Initially, an empty symbols object matches nothing.
- At any time, symbols may be added or removed, thus, dynamically altering
- its behavior.
- 
-
- Each entry in a symbol table has an associated mutable data slot. In this
- regard, one can view the symbol table as an associative container (or map)
- of key-value pairs where the keys are strings.
- 
-
- The symbols class expects two template parameters. The first parameter
- specifies the character type of the symbols. The second specifies the data
- type associated with each symbol: its attribute.
- 
-
- Here's a parser for roman hundreds (100..900) using the symbol table. Keep
- in mind that the data associated with each slot is the parser's attribute
- (which is passed to attached semantic actions).
- 
-
- 
-
-
-
-<pre class="programlisting">struct hundreds_ : qi::symbols<char, unsigned>
-{
- hundreds_()
- {
- add
- ("C" , 100)
- ("CC" , 200)
- ("CCC" , 300)
- ("CD" , 400)
- ("D" , 500)
- ("DC" , 600)
- ("DCC" , 700)
- ("DCCC" , 800)
- ("CM" , 900)
- ;
- }
-
-} hundreds;
-</pre>
-
- 
-
- 
-
- Here's a parser for roman tens (10..90):
- 
-
- 
-
-
-
-<pre class="programlisting">struct tens_ : qi::symbols<char, unsigned>
-{
- tens_()
- {
- add
- ("X" , 10)
- ("XX" , 20)
- ("XXX" , 30)
- ("XL" , 40)
- ("L" , 50)
- ("LX" , 60)
- ("LXX" , 70)
- ("LXXX" , 80)
- ("XC" , 90)
- ;
- }
-
-} tens;
-</pre>
-
- 
-
- 
-
- and, finally, for ones (1..9):
- 
-
- 
-
-
-
-<pre class="programlisting">struct ones_ : qi::symbols<char, unsigned>
-{
- ones_()
- {
- add
- ("I" , 1)
- ("II" , 2)
- ("III" , 3)
- ("IV" , 4)
- ("V" , 5)
- ("VI" , 6)
- ("VII" , 7)
- ("VIII" , 8)
- ("IX" , 9)
- ;
- }
-
-} ones;
-</pre>
-
- 
-
- 
-
- Now we can use <tt class="computeroutput">hundreds</tt>,
- <tt class="computeroutput">tens</tt> and <tt class="computeroutput">ones</tt> anywhere in our parser expressions.
- They are all parsers.
- 
-<a name="spirit.qi.tutorials.roman_numerals.rules"></a><h5>
-<a name="id424745"></a>
- Rules
- </h5>
-
- Up until now, we've been inlining our parser expressions, passing them
- directly to the <tt class="computeroutput">phrase_parse</tt>
- function. The expression evaluates into a temporary, unnamed parser which
- is passed into the <tt class="computeroutput">phrase_parse</tt>
- function, used, and then destroyed. This is fine for small parsers. When
- the expressions get complicated, you'd want to break the expressions into
- smaller easier to understand pieces, name them, and refer to them from
- other parser expressions by name.
- 
-
- A parser expression can be assigned to, what is called, a "rule".
- There are various ways to declare rules. The simplest form is:
- 
-<pre class="programlisting">rule<Iterator> r;
-</pre>
-
- At the very least, the rule needs to know the iterator type it will be
- working on. This rule cannot be used with <tt class="computeroutput">phrase_parse</tt>.
- It can only be used with the <tt class="computeroutput">parse</tt>
- function -- a version that does not do white space skipping (does not have
- the skipper argument). If you want to have it skip white spaces, you need
- to pass in the type skip parser, as in the next form:
- 
-<pre class="programlisting">rule<Iterator, Skipper> r;
-</pre>
-
- Example:
- 
-<pre class="programlisting">rule<std::string::iterator, space_type> r;
-</pre>
-
- This type of rule can be used for both <tt class="computeroutput">phrase_parse</tt>
- and <tt class="computeroutput">parse</tt>.
- 
-
- For our next example, there's one more rule form you should know about:
- 
-<pre class="programlisting">rule<Iterator, Signature> r;
-</pre>
-
- or
- 
-<pre class="programlisting">rule<Iterator, Signature, Skipper> r;
-</pre>
-<div class="tip"><table border="0" summary="Tip">
-<tr>
-<td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="../images/tip.png"></td>
-<th align="left">Tip</th>
-</tr>
-<tr><td colspan="2" align="left" valign="top">
- All rule template arguments after Iterator can be supplied in any order.
- </td></tr>
-</table></div>
-
- The Signature specifies the attributes of the rule. You've seen that our
- parsers can have an attribute. Recall that the <tt class="computeroutput">double_</tt>
- parser has an attribute of <tt class="computeroutput">double</tt>.
- To be precise, these are synthesized attributes. The
- parser "synthesizes" the attribute value. Think of them as function
- return values.
- 
-
- There's another type of attribute called "inherited" attribute.
- We won't need them for now, but it's good that you be aware of such attributes.
- You can think of them as function arguments. And, rightly so, the rule
- signature is a function signature of the form:
- 
-<pre class="programlisting">result(argN, argN,..., argN)
-</pre>
-
- After having declared a rule, you can now assign any parser expression
- to it. Example:
- 
-<pre class="programlisting">r = double_ >> *(',' >> double_);
-</pre>
-<a name="spirit.qi.tutorials.roman_numerals.grammars"></a><h5>
-<a name="id425327"></a>
- Grammars
- </h5>
-
- A grammar encapsulates one or more rules. It has the same template parameters
- as the rule. You declare a grammar by:
- 
-<div class="orderedlist"><ol type="1">
-<li>
- deriving a struct (or class) from the <tt class="computeroutput">grammar</tt>
- class template
- </li>
-<li>
- declare one or more rules as member variables
- </li>
-<li>
- initialize the base grammar class by giving it the start rule (its the
- first rule that gets called when the grammar starts parsing)
- </li>
-<li>
- initialize your rules in your constructor
- </li>
-</ol></div>
-
- The roman numeral grammar is a very nice and simple example of a grammar:
- 
-
- 
-
-
-
-<pre class="programlisting">template <typename Iterator>
-struct roman : qi::grammar<Iterator, unsigned()>
-{
- roman() : roman::base_type(start)
- {
- using qi::eps;
- using qi::lit;
- using qi::_val;
- using qi::_1;
- using ascii::char_;
-
- start = eps [_val = 0] >>
- (
- +lit('M') [_val += 1000]
- || hundreds [_val += _1]
- || tens [_val += _1]
- || ones [_val += _1]
- )
- ;
- }
-
- qi::rule<Iterator, unsigned()> start;
-};
-</pre>
-
- 
-
- 
-
- Things to take notice of:
- 
-<div class="itemizedlist"><ul type="disc">
-<li>
- The grammar and start rule signature is <tt class="computeroutput">unsigned()</tt>. It has a synthesized attribute (return
- value) of type <tt class="computeroutput">unsigned</tt>
- with no inherited attributes (arguments).
- </li>
-<li>
- We did not specify a skip-parser. We don't want to skip in between the
- numerals.
- </li>
-<li>
-<tt class="computeroutput">roman::base_type</tt> is a typedef for <tt class="computeroutput">grammar<Iterator,
- unsigned()></tt>.
- If <tt class="computeroutput">roman</tt> was not a template,
- you can simply write: base_type(start)
- </li>
-<li>
- But it's best to make your grammar templates, so that they can be reused
- for different iterator types.
- </li>
-<li>
-<tt class="computeroutput">_val</tt> is another Phoenix placeholder representing
- the rule's synthesized attribute.
- </li>
-<li>
-<tt class="computeroutput">eps</tt> is a special spirit
- parser that consumes no input but is always successful. We use it to
- initialize <tt class="computeroutput">_val</tt>, the
- rule's synthesized attribute, to zero before anything else. The actual
- parser starts at <tt class="computeroutput">+char_('M')</tt>,
- parsing roman thousands. Using <tt class="computeroutput">eps</tt>
- this way is good for doing pre and post initializations.
- </li>
-<li>
- The expression <tt class="computeroutput">a ||
- b</tt> reads: match a or b and in
- sequence. That is, if both <tt class="computeroutput">a</tt>
- and <tt class="computeroutput">b</tt> match, it must
- be in sequence; this is equivalent to <tt class="computeroutput">a
- >> -b | b</tt>, but more efficient.
- </li>
-</ul></div>
-<a name="spirit.qi.tutorials.roman_numerals.let_s_parse_"></a><h5>
-<a name="id426344"></a>
- Let's Parse!
- </h5>
-
- 
-
-
-
-<pre class="programlisting">bool r = parse(iter, end, roman_parser, result);
-
-if (r && iter == end)
-{
- std::cout << "-------------------------\n";
- std::cout << "Parsing succeeded\n";
- std::cout << "result = " << result << std::endl;
- std::cout << "-------------------------\n";
-}
-else
-{
- std::string rest(iter, end);
- std::cout << "-------------------------\n";
- std::cout << "Parsing failed\n";
- std::cout << "stopped at: \": " << rest << "\"\n";
- std::cout << "-------------------------\n";
-}
-</pre>
-
- 
-
- 
-
- <tt class="computeroutput">roman_parser</tt> is an object
- of type <tt class="computeroutput">roman</tt> -our roman
- numeral parser. This time around, we are using the no-skipping version
- of the parse functions. We do not want to skip any spaces! We are also
- passing in an attribute, <tt class="computeroutput">unsigned
- result</tt>, which will receive the
- parsed value.
- 
-
- The full cpp file for this example can be found here: ../../example/qi/roman.cpp
- 
-</div>
-<div class="section" lang="en">
-<div class="titlepage">
-<div><div><h4 class="title">
-<a name="spirit.qi.tutorials.employee___parsing_into_structs"></a><a href="qi.html#spirit.qi.tutorials.employee___parsing_into_structs" title="Employee
- - Parsing into structs">Employee
- - Parsing into structs</a>
-</h4></div></div>
-<div></div>
-</div>
-
- It's a common question in the <a href="http://www.nabble.com/The-Spirit-Parser-Library-f3430.html" target="_top">Spirit
- General List</a>: how do I parse and place the results into a C++ struct?
- Of course, at this point, you already know various ways to do it, using
- semantic actions. There are many ways to skin a cat. Spirit2, being fully
- attributed, makes it even easier. The next example demonstrates some features
- of Spirit2 that makes this easy. In the process, you'll learn about:
- 
-<div class="itemizedlist"><ul type="disc">
-<li>
- More about attributes
- </li>
-<li>
- Auto rules
- </li>
-<li>
- Some more built-in parsers
- </li>
-<li>
- Directives
- </li>
-</ul></div>
-
- First, let's create a struct representing an employee:
- 
-
- 
-
-
-
-<pre class="programlisting">struct employee
-{
- int age;
- std::string surname;
- std::string forename;
- double salary;
-};
-</pre>
-
- 
-
- 
-
- Then, we need to tell Fusion
- about our employee struct to make it a first- class fusion citizen. If
- you don't know fusion yet, it is a Boost
- library for working with heterogenous collections of data, commonly referred
- to as tuples. Spirit uses fusion extensively as part of its infrastructure.
- 
-
- In fusion's view, a struct is just a form of a tuple. You can adapt any
- struct to be a fully conforming fusion tuple:
- 
-
- 
-
-
-
-<pre class="programlisting">BOOST_FUSION_ADAPT_STRUCT(
- client::employee,
- (int, age)
- (std::string, surname)
- (std::string, forename)
- (double, salary)
-)
-</pre>
-
- 
-
- 
-
- Now we'll write a parser for our employee. Inputs will be of the form:
- 
-<pre class="programlisting">employee{ age, "surname", "forename", salary }
-</pre>
-
- Here goes:
- 
-
- 
-
-
-
-<pre class="programlisting">template <typename Iterator>
-struct employee_parser : qi::grammar<Iterator, employee(), ascii::space_type>
-{
- employee_parser() : employee_parser::base_type(start)
- {
- using qi::int_;
- using qi::lit;
- using qi::double_;
- using qi::lexeme;
- using ascii::char_;
-
- quoted_string %= lexeme['"' >> +(char_ - '"') >> '"'];
-
- start %=
- lit("employee")
- >> '{'
- >> int_ >> ','
- >> quoted_string >> ','
- >> quoted_string >> ','
- >> double_
- >> '}'
- ;
- }
-
- qi::rule<Iterator, std::string(), ascii::space_type> quoted_string;
- qi::rule<Iterator, employee(), ascii::space_type> start;
-};
-</pre>
-
- 
-
- 
-
- The full cpp file for this example can be found here: ../../example/qi/employee.cpp
- 
-
- Let's walk through this one step at a time (not necessarily from top to
- bottom).
- 
-<pre class="programlisting">template <typename Iterator>
-struct employee_parser : grammar<Iterator, employee(), space_type>
-</pre>
-
- <tt class="computeroutput">employee_parser</tt> is a grammar.
- Like before, we make it a template so that we can reuse it for different
- iterator types. The grammar's signature is:
- 
-<pre class="programlisting">employee()
-</pre>
-
- meaning, the parser generates employee structs. <tt class="computeroutput">employee_parser</tt>
- skips white spaces using <tt class="computeroutput">space_type</tt>
- as its skip parser.
- 
-<pre class="programlisting">employee_parser() : employee_parser::base_type(start)
-</pre>
-
- Initializes the base class.
- 
-<pre class="programlisting">rule<Iterator, std::string(), space_type> quoted_string;
-rule<Iterator, employee(), space_type> start;
-</pre>
-
- Declares two rules: <tt class="computeroutput">quoted_string</tt>
- and <tt class="computeroutput">start</tt>. <tt class="computeroutput">start</tt> has the same template parameters
- as the grammar itself. <tt class="computeroutput">quoted_string</tt>
- has a <tt class="computeroutput">std::string</tt> attribute.
- 
-<a name="spirit.qi.tutorials.employee___parsing_into_structs.lexeme"></a><h5>
-<a name="id428623"></a>
- Lexeme
- </h5>
-<pre class="programlisting">lexeme['"' >> +(char_ - '"') >> '"'];
-</pre>
-
- <tt class="computeroutput">lexeme</tt> inhibits space skipping
- from the open brace to the closing brace. The expression parses quoted
- strings.
- 
-<pre class="programlisting">+(char_ - '"')
-</pre>
-
- parses one or more chars, except the double quote. It stops when it sees
- a double quote.
- 
-<a name="spirit.qi.tutorials.employee___parsing_into_structs.difference"></a><h5>
-<a name="id428779"></a>
- Difference
- </h5>
-
- The expression:
- 
-<pre class="programlisting">a - b
-</pre>
-
- parses <tt class="computeroutput">a</tt> but not <tt class="computeroutput">b</tt>. Its attribute is just <tt class="computeroutput">A</tt>, the attribute of <tt class="computeroutput">a</tt>.
- <tt class="computeroutput">b</tt>'s attribute is ignored.
- Hence, the attribute of:
- 
-<pre class="programlisting">char_ - '"'
-</pre>
-
- is just <tt class="computeroutput">char</tt>.
- 
-<a name="spirit.qi.tutorials.employee___parsing_into_structs.plus"></a><h5>
-<a name="id428937"></a>
- Plus
- </h5>
-<pre class="programlisting">+a
-</pre>
-
- is the close kin of the kleene star we got so used to in our tutorial.
- Like it's kin, the kleene star, its attribute is a <tt class="computeroutput">std::vector<A></tt> where <tt class="computeroutput">A</tt>
- is the attribute of <tt class="computeroutput">a</tt>.
- So, putting all these together, the attribute of
- 
-<pre class="programlisting">+(char_ - '"')
-</pre>
-
- is then:
- 
-<pre class="programlisting">std::vector<char>
-</pre>
-<a name="spirit.qi.tutorials.employee___parsing_into_structs.sequence_attribute"></a><h5>
-<a name="id429123"></a>
- <a href="qi.html#spirit.qi.tutorials.employee___parsing_into_structs.sequence_attribute">Sequence
- Attribute</a>
- </h5>
-
- Now what's the attribute of
- 
-<pre class="programlisting">'"' >> +(char_ - '"') >> '"'
-</pre>
-
- ?
- 
-
- Well, typically, the attribute of:
- 
-<pre class="programlisting">a >> b >> c
-</pre>
-
- is:
- 
-<pre class="programlisting">fusion::vector<A, B, C>
-</pre>
-
- where <tt class="computeroutput">A</tt> is the attribute
- of <tt class="computeroutput">a</tt>, <tt class="computeroutput">B</tt>
- is the attribute of <tt class="computeroutput">b</tt> and
- <tt class="computeroutput">C</tt> is the attribute of
- <tt class="computeroutput">c</tt>. What is <tt class="computeroutput">fusion::vector</tt>? - a tuple.
- 
-<div class="note"><table border="0" summary="Note">
-<tr>
-<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../images/note.png"></td>
-<th align="left">Note</th>
-</tr>
-<tr><td colspan="2" align="left" valign="top">
- If you don't know what I am talking about, see: <a href="http://tinyurl.com/6xun4j" target="_top">Fusion
- Vector</a>. It might be a good idea to have a look into Fusion
- at this point. You'll definitely see more of it in the coming pages.
- </td></tr>
-</table></div>
-<a name="spirit.qi.tutorials.employee___parsing_into_structs.attribute_collapsing"></a><h5>
-<a name="id429446"></a>
- <a href="qi.html#spirit.qi.tutorials.employee___parsing_into_structs.attribute_collapsing">Attribute
- Collapsing</a>
- </h5>
-
- Some parsers, especially those very little literal parsers you see, like
- <tt class="computeroutput">'"'</tt>, do not have attributes.
- 
-
- Nodes without attributes are disregarded. In a sequence, like above, all
- nodes with no attributes are filtered out of the <tt class="computeroutput">fusion:vector</tt>.
- So, since <tt class="computeroutput">'"'</tt> has no attribute,
- and <tt class="computeroutput">+(char_
- - '"')</tt> has a <tt class="computeroutput">std::vector<char></tt> attribute, the whole expression's attribute
- should have been:
- 
-<pre class="programlisting">fusion::vector<std::vector<char> >
-</pre>
-
- But wait, there's one more collapsing rule: If after the attribute is a
- single element <tt class="computeroutput">fusion::vector</tt>, The element is stripped naked
- from its container. So, to make a long story short, the attribute of the
- expression:
- 
-<pre class="programlisting">'"' >> +(char_ - '"') >> '"'
-</pre>
-
- is:
- 
-<pre class="programlisting">std::vector<char>
-</pre>
-<a name="spirit.qi.tutorials.employee___parsing_into_structs.auto_rules"></a><h5>
-<a name="id429795"></a>
- <a href="qi.html#spirit.qi.tutorials.employee___parsing_into_structs.auto_rules">Auto
- Rules</a>
- </h5>
-
- It is typical to see rules like:
- 
-<pre class="programlisting">r = p[_val = _1];
-</pre>
-
- If you have a rule definition like above where the attribute of the RHS
- (right hand side) of the rule is compatibe with the attribute of the LHS
- (left hand side), then you can rewrite it as:
- 
-<pre class="programlisting">r %= p;
-</pre>
-
- The attribute of <tt class="computeroutput">p</tt> automatically
- uses the attribute of <tt class="computeroutput">r</tt>.
- 
-
- So, going back to our <tt class="computeroutput">quoted_string</tt>
- rule:
- 
-<pre class="programlisting">quoted_string %= lexeme['"' >> +(char_ - '"') >> '"'];
-</pre>
-
- is a simplified version of:
- 
-<pre class="programlisting">quoted_string = lexeme['"' >> +(char_ - '"') >> '"'][val_ = _1];
-</pre>
-
- The attribute of the <tt class="computeroutput">quoted_string</tt>
- rule: <tt class="computeroutput">std::string</tt> is compatible
- with the attribute of the RHS: <tt class="computeroutput">std::vector<char></tt>. The RHS extracts the parsed attribute
- directly into the rule's attribute, in-situ.
- 
-<a name="spirit.qi.tutorials.employee___parsing_into_structs.finally"></a><h5>
-<a name="id430240"></a>
- Finally
- </h5>
-
- We're down to one rule, the start rule:
- 
-<pre class="programlisting">start %=
- lit("employee")
- >> '{'
- >> int_ >> ','
- >> quoted_string >> ','
- >> quoted_string >> ','
- >> double_
- >> '}'
- ;
-</pre>
-
- Applying our collapsing rules above, the RHS has an attribute of:
- 
-<pre class="programlisting">fusion::vector<int, std::string, std::string, double>
-</pre>
-
- These nodes do not have an attribute:
- 
-<div class="itemizedlist"><ul type="disc">
-<li><tt class="computeroutput">lit("employee")</tt></li>
-<li><tt class="computeroutput">'{'</tt></li>
-<li><tt class="computeroutput">'}'</tt></li>
-</ul></div>
-<div class="note"><table border="0" summary="Note">
-<tr>
-<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../images/note.png"></td>
-<th align="left">Note</th>
-</tr>
-<tr><td colspan="2" align="left" valign="top">
- In case you are wondering, <tt class="computeroutput">lit("employee")</tt> is the same as "employee".
- We had to wrap it inside <tt class="computeroutput">lit</tt>
- because immediately after it is <tt class="computeroutput">>>
- '{'</tt>. You can't right-shift a <tt class="computeroutput">char[]</tt>
- and a <tt class="computeroutput">char</tt> - you know, C++
- syntax rules.
- </td></tr>
-</table></div>
-
- Recall that the attribute of <tt class="computeroutput">start</tt>
- is the <tt class="computeroutput">employee</tt> struct:
- 
-
- 
-
-
-
-<pre class="programlisting">struct employee
-{
- int age;
- std::string surname;
- std::string forename;
- double salary;
-};
-</pre>
-
- 
-
- 
-
- Now everything is clear, right? The <tt class="computeroutput">struct
- employee</tt> IS
- compatible with <tt class="computeroutput">fusion::vector<int, std::string, std::string, double></tt>. So, the RHS of <tt class="computeroutput">start</tt>
- uses start's attribute (a <tt class="computeroutput">struct
- employee</tt>) in-situ when it does
- its work.
- 
-</div>
-<div class="section" lang="en">
-<div class="titlepage">
-<div><div><h4 class="title">
-<a name="spirit.qi.tutorials.mini_xml___asts_"></a>Mini XML - ASTs!
-</h4></div></div>
-<div></div>
-</div>
-
- Stop and think about it... We've come very close to generating an AST in
- our last example. We parsed a single structure and generated an in-memory
- representation of it in the form of a struct: the <tt class="computeroutput">struct
- employee</tt>. If we changed the implementation
- to parse one or more employees, the result would be a <tt class="computeroutput">std::vector<employee></tt>. We can go on and add more hierarchy:
- teams, departments, corporations. Then we'll have an AST representation
- of it all.
- 
-
- In this example (actually two examples), we'll now explore parsers how
- to create ASTs. We will parse a minimalistic XML like language and compile
- the results into our data structures in the form of a tree.
- 
-
- Along the way, we'll see new features:
- 
-<div class="itemizedlist"><ul type="disc">
-<li>
- Inherited attributes
- </li>
-<li>
- Variant attributes
- </li>
-<li>
- Local Variables
- </li>
-<li>
- Not Predicate
- </li>
-<li>
- Lazy Lit
- </li>
-</ul></div>
-
- The full cpp files for these examples can be found here: ../../example/qi/mini_xml1.cpp
- and here: ../../example/qi/mini_xml2.cpp
- 
-
- There are a couple of sample toy-xml files in: ../../example/qi/mini_xml_samples
- for testing purposes. "4.toyxml" has an error in it.
- 
-<a name="spirit.qi.tutorials.mini_xml___asts_.first_cut"></a><h5>
-<a name="id431146"></a>
- First Cut
- </h5>
-
- Without further delay, here's the first version of the XML grammar:
- 
-
- 
-
-
-
-<pre class="programlisting">template <typename Iterator>
-struct mini_xml_grammar : qi::grammar<Iterator, mini_xml(), ascii::space_type>
-{
- mini_xml_grammar() : mini_xml_grammar::base_type(xml)
- {
- using qi::lit;
- using qi::lexeme;
- using ascii::char_;
- using ascii::string;
- using namespace qi::labels;
-
- using phoenix::at_c;
- using phoenix::push_back;
-
- text = lexeme[+(char_ - '<') [_val += _1]];
- node = (xml | text) [_val = _1];
-
- start_tag =
- '<'
- >> !lit('/')
- >> lexeme[+(char_ - '>') [_val += _1]]
- >> '>'
- ;
-
- end_tag =
- "</"
- >> string(_r1)
- >> '>'
- ;
-
- xml =
- start_tag [at_c<0>(_val) = _1]
- >> *node [push_back(at_c<1>(_val), _1)]
- >> end_tag(at_c<0>(_val))
- ;
- }
-
- qi::rule<Iterator, mini_xml(), ascii::space_type> xml;
- qi::rule<Iterator, mini_xml_node(), ascii::space_type> node;
- qi::rule<Iterator, std::string(), ascii::space_type> text;
- qi::rule<Iterator, std::string(), ascii::space_type> start_tag;
- qi::rule<Iterator, void(std::string), ascii::space_type> end_tag;
-};
-</pre>
-
- 
-
- 
-
- Going bottom up, let's examine the <tt class="computeroutput">text</tt>
- rule:
- 
-<pre class="programlisting">rule<Iterator, std::string(), space_type> text;
-</pre>
-
- and its definition:
- 
-<pre class="programlisting">text = lexeme[+(char_ - '<') [_val += _1]];
-</pre>
-
- The semantic action collects the chars and appends them (via +=) to the
- <tt class="computeroutput">std::string</tt> attribute of the rule (represented
- by the placeholder <tt class="computeroutput">_val</tt>).
- 
-<a name="spirit.qi.tutorials.mini_xml___asts_.alternates"></a><h5>
-<a name="id432747"></a>
- Alternates
- </h5>
-<pre class="programlisting">rule<Iterator, mini_xml_node(), space_type> node;
-</pre>
-
- and its definition:
- 
-<pre class="programlisting">node = (xml | text) [_val = _1];
-</pre>
-
- We'll see what a <tt class="computeroutput">mini_xml_node</tt>
- structure later. Looking at the rule definition, we see some alternation
- goiing on here. An xml <tt class="computeroutput">node</tt>
- is either an <tt class="computeroutput">xml</tt> OR <tt class="computeroutput">text</tt>. Hmmm... hold on to that thought...
- 
-<pre class="programlisting">rule<Iterator, std::string(), space_type> start_tag;
-</pre>
-
- Again, with an attribute of <tt class="computeroutput">std::string</tt>.
- Then, it's definition:
- 
-<pre class="programlisting">start_tag =
- '<'
- >> !char_('/')
- >> lexeme[+(char_ - '>') [_val += _1]]
- >> '>'
-;
-</pre>
-<a name="spirit.qi.tutorials.mini_xml___asts_.not_predicate"></a><h5>
-<a name="id433208"></a>
- <a href="qi.html#spirit.qi.tutorials.mini_xml___asts_.not_predicate">Not
- Predicate</a>
- </h5>
-
- <tt class="computeroutput">start_tag</tt> is similar to
- the <tt class="computeroutput">text</tt> rule apart from
- the added <tt class="computeroutput">'<'</tt> and <tt class="computeroutput">'>'</tt>. But wait, to make sure that the <tt class="computeroutput">start_tag</tt> does not parse <tt class="computeroutput">end_tag</tt>s too, we add: <tt class="computeroutput">!char_('/')</tt>. This
- is a "Not Predicate":
- 
-<pre class="programlisting">!p
-</pre>
-
- It will try the parser, <tt class="computeroutput">p</tt>.
- If it is successful, fail, otherwise, pass. In other words, it negates
- the result of <tt class="computeroutput">p</tt>. Like the
- <tt class="computeroutput">eps</tt>, it does not consume
- any input though. It will always rewind the iterator position to where
- it was upon entry. So, the expression:
- 
-<pre class="programlisting">!char_('/')
-</pre>
-
- basically says: we should not have a <tt class="computeroutput">'/'</tt>
- at this point.
- 
-<a name="spirit.qi.tutorials.mini_xml___asts_.inherited_attribute"></a><h5>
-<a name="id433449"></a>
- <a href="qi.html#spirit.qi.tutorials.mini_xml___asts_.inherited_attribute">Inherited
- Attribute</a>
- </h5>
-
- The <tt class="computeroutput">end_tag</tt>:
- 
-<pre class="programlisting">rule<Iterator, void(std::string), space_type> end_tag;
-</pre>
-
- Ohh! Now we see an inherited attribute there: <tt class="computeroutput">std::string</tt>.
- The <tt class="computeroutput">end_tag</tt> does not have
- a synthesized attribute. Let's see its definition:
- 
-<pre class="programlisting">end_tag =
- "</"
- >> lit(_r1)
- >> '>'
-;
-</pre>
-
- <tt class="computeroutput">_r1</tt> is yet another Phoenix placeholder for
- the 1st inherited attribute (we have only one, use <tt class="computeroutput">_r2</tt>,
- <tt class="computeroutput">_r3</tt>, etc. if you have more).
- 
-<a name="spirit.qi.tutorials.mini_xml___asts_.a_lazy_lit"></a><h5>
-<a name="id433728"></a>
- <a href="qi.html#spirit.qi.tutorials.mini_xml___asts_.a_lazy_lit">A Lazy
- Lit</a>
- </h5>
-
- Check out how we used <tt class="computeroutput">lit</tt>
- here, this time, not with a literal string, but with the value of the 1st
- inherited attribute, which is specified as <tt class="computeroutput">std::string</tt>
- in our rule declaration.
- 
-
- Finally, our <tt class="computeroutput">xml</tt> rule:
- 
-<pre class="programlisting">rule<Iterator, mini_xml(), space_type> xml;
-</pre>
-
- <tt class="computeroutput">mini_xml</tt> is our attribute
- here. We'll see later what it is. Let's see its definition:
- 
-<pre class="programlisting">xml =
- start_tag [at_c<0>(_val) = _1]
- >> *node [push_back(at_c<1>(_val), _1)]
- >> end_tag(at_c<0>(_val))
-;
-</pre>
-
- Those who know Fusion
- now will notice <tt class="computeroutput">at_c<0></tt> and
- <tt class="computeroutput">at_c<1></tt>. This
- gives us a hint that <tt class="computeroutput">mini_xml</tt>
- is a sort of a tuple - a fusion sequence. <tt class="computeroutput">at_c<N></tt> here is a lazy version of the tuple
- accessors, provided by Phoenix.
- 
-<a name="spirit.qi.tutorials.mini_xml___asts_.how_it_all_works"></a><h5>
-<a name="id434208"></a>
- <a href="qi.html#spirit.qi.tutorials.mini_xml___asts_.how_it_all_works">How
- it all works</a>
- </h5>
-
- So, what's happening?
- 
-<div class="orderedlist"><ol type="1">
-<li>
- Upon parsing <tt class="computeroutput">start_tag</tt>,
- the parsed start-tag string is placed in <tt class="computeroutput">at_c<0>(_val)</tt>.
- </li>
-<li>
- Then we parse zero or more <tt class="computeroutput">node</tt>s.
- At each step, we <tt class="computeroutput">push_back</tt>
- the result into <tt class="computeroutput">at_c<1>(_val)</tt>.
- </li>
-<li>
- Finally, we parse the <tt class="computeroutput">end_tag</tt>
- giving it an inherited attribute: <tt class="computeroutput">at_c<0>(_val)</tt>.
- This is the string we obtained from the <tt class="computeroutput">start_tag</tt>.
- Investigate <tt class="computeroutput">end_tag</tt> above.
- It will fail to parse if it gets something different from what we got
- from the <tt class="computeroutput">start_tag</tt>. This
- ensures that our tags are balanced.
- </li>
-</ol></div>
-
- To give the last item some more light, what happens is this:
- 
-<pre class="programlisting">end_tag(at_c<0>(_val))
-</pre>
-
- calls:
- 
-<pre class="programlisting">end_tag =
- "</"
- >> lit(_r1)
- >> '>'
-;
-</pre>
-
- passing in <tt class="computeroutput">at_c<0>(_val)</tt>, the string from start tag. This is referred
- to in the <tt class="computeroutput">end_tag</tt> body
- as <tt class="computeroutput">_r1</tt>.
- 
-<a name="spirit.qi.tutorials.mini_xml___asts_.the_structures"></a><h5>
-<a name="id434651"></a>
- <a href="qi.html#spirit.qi.tutorials.mini_xml___asts_.the_structures">The
- Structures</a>
- </h5>
-
- Let's see our structures. It will definitely be hierarchical: xml is hierarchical.
- It will also be recursive: xml is recursive.
- 
-
- 
-
-
-
-<pre class="programlisting">struct mini_xml;
-
-typedef
- boost::variant<
- boost::recursive_wrapper<mini_xml>
- , std::string
- >
-mini_xml_node;
-
-struct mini_xml
-{
- std::string name; // tag name
- std::vector<mini_xml_node> children; // children
-};
-</pre>
-
- 
-
- 
-<a name="spirit.qi.tutorials.mini_xml___asts_.of_alternates_and_variants"></a><h5>
-<a name="id434919"></a>
- <a href="qi.html#spirit.qi.tutorials.mini_xml___asts_.of_alternates_and_variants">Of
- Alternates and Variants</a>
- </h5>
-
- So that's how a <tt class="computeroutput">mini_xml_node</tt>
- looks like. We had a hint that it is either a <tt class="computeroutput">string</tt>
- or a <tt class="computeroutput">mini_xml</tt>. For this,
- we use boost.variant<>.
- <tt class="computeroutput">boost::recursive_wrapper</tt> wraps <tt class="computeroutput">mini_xml</tt>, making it a recursive data
- structure.
- 
-
- Yep, you got that right: the attribute of an alternate:
- 
-<pre class="programlisting">a | b
-</pre>
-
- is a
- 
-<pre class="programlisting">boost::variant<A, B>
-</pre>
-
- where <tt class="computeroutput">A</tt> is the attribute
- of <tt class="computeroutput">a</tt> and <tt class="computeroutput">B</tt> is the attribute of <tt class="computeroutput">b</tt>.
- 
-<a name="spirit.qi.tutorials.mini_xml___asts_.adapting_structs_again"></a><h5>
-<a name="id435186"></a>
- <a href="qi.html#spirit.qi.tutorials.mini_xml___asts_.adapting_structs_again">Adapting
- structs again</a>
- </h5>
-
- <tt class="computeroutput">mini_xml</tt> is no brainier.
- It is a plain ol' struct. But as we've seen in our employee example, we
- can adapt that to be a Fusion
- sequence:
- 
-
- 
-
-
-
-<pre class="programlisting">BOOST_FUSION_ADAPT_STRUCT(
- client::mini_xml,
- (std::string, name)
- (std::vector<client::mini_xml_node>, children)
-)
-</pre>
-
- 
-
- 
-<a name="spirit.qi.tutorials.mini_xml___asts_.one_more_take"></a><h5>
-<a name="id435384"></a>
- <a href="qi.html#spirit.qi.tutorials.mini_xml___asts_.one_more_take">One
- More Take</a>
- </h5>
-
- Here's another version. The AST structure remains the same, but this time,
- you'll see that we make use of auto-rules making the grammar semantic-action-
- less. Here it is:
- 
-
- 
-
-
-
-<pre class="programlisting">template <typename Iterator>
-struct mini_xml_grammar
- : qi::grammar<Iterator, mini_xml(), qi::locals<std::string>, ascii::space_type>
-{
- mini_xml_grammar()
- : mini_xml_grammar::base_type(xml)
- {
- using qi::lit;
- using qi::lexeme;
- using ascii::char_;
- using ascii::string;
- using namespace qi::labels;
-
- text %= lexeme[+(char_ - '<')];
- node %= xml | text;
-
- start_tag %=
- '<'
- >> !lit('/')
- >> lexeme[+(char_ - '>')]
- >> '>'
- ;
-
- end_tag =
- "</"
- >> string(_r1)
- >> '>'
- ;
-
- xml %=
- start_tag[_a = _1]
- >> *node
- >> end_tag(_a)
- ;
- }
-
- qi::rule<Iterator, mini_xml(), qi::locals<std::string>, ascii::space_type> xml;
- qi::rule<Iterator, mini_xml_node(), ascii::space_type> node;
- qi::rule<Iterator, std::string(), ascii::space_type> text;
- qi::rule<Iterator, std::string(), ascii::space_type> start_tag;
- qi::rule<Iterator, void(std::string), ascii::space_type> end_tag;
-};
-</pre>
-
- 
-
- 
-
- This one shouldn't be any more difficult to understand after going through
- the first xml parser example. The rules are almost the same, except that,
- we got rid of semantic actions and used auto-rules (see the employee example
- if you missed that). There are a couple of new stuff, though. It's all
- in the <tt class="computeroutput">xml</tt> rule:
- 
-<a name="spirit.qi.tutorials.mini_xml___asts_.local_variables"></a><h5>
-<a name="id436628"></a>
- <a href="qi.html#spirit.qi.tutorials.mini_xml___asts_.local_variables">Local
- Variables</a>
- </h5>
-<pre class="programlisting">rule<Iterator, mini_xml(), locals<std::string>, space_type> xml;
-</pre>
-
- Wow, we have four template parameters now. What's that <tt class="computeroutput">locals</tt>
- guy doing there? Well, it declares that the rule <tt class="computeroutput">xml</tt>
- will have one local variable: a <tt class="computeroutput">string</tt>.
- Let's see how this is used in action:
- 
-<pre class="programlisting">xml %=
- start_tag[_a = _1]
- >> *node
- >> end_tag(_a)
-;
-</pre>
-<div class="orderedlist"><ol type="1">
-<li>
- Upon parsing <tt class="computeroutput">start_tag</tt>,
- the parsed start-tag string is placed in the local variable specified
- by (yet another) Phoenix
- placeholder: <tt class="computeroutput">_a</tt>. We have
- only one local variable. If we had more, these are designated by <tt class="computeroutput">_b</tt>..<tt class="computeroutput">_z</tt>.
- </li>
-<li>
- Then we parse zero or more <tt class="computeroutput">node</tt>s.
- </li>
-<li>
- Finally, we parse the <tt class="computeroutput">end_tag</tt>
- giving it an inherited attribute: <tt class="computeroutput">_a</tt>,
- our local variable.
- </li>
-</ol></div>
-
- There are no actions involved in stuffing data into our <tt class="computeroutput">xml</tt>
- attribute. It's all taken cared of thatnks to the auto-rule.
- 
-</div>
-<div class="section" lang="en">
-<div class="titlepage">
-<div><div><h4 class="title">
-<a name="spirit.qi.tutorials.mini_xml___error_handling"></a><a href="qi.html#spirit.qi.tutorials.mini_xml___error_handling" title="Mini
- XML - Error Handling">Mini
- XML - Error Handling</a>
-</h4></div></div>
-<div></div>
-</div>
-
- A parser will not be complete without error handling. Spirit2 provides
- some facilities to make it easy to adapt a grammar for error handling.
- We'll wrap up the Qi tutorial with another version of the mini xml parser,
- this time, with error handling.
- 
-
- ../../example/qi/mini_xml1.cpp
- and here: ../../example/qi/mini_xml2.cpp
- 
-
- Here's the grammar:
- 
-
- What's new?
- 
-<a name="spirit.qi.tutorials.mini_xml___error_handling.readable_names"></a><h5>
-<a name="id437081"></a>
- <a href="qi.html#spirit.qi.tutorials.mini_xml___error_handling.readable_names">Readable
- Names</a>
- </h5>
-
- First, when we call the base class, we give the grammar a name:
- 
-<pre class="programlisting">: mini_xml_grammar::base_type(xml, "xml")
-</pre>
-
- Then, we name all our rules:
- 
-<pre class="programlisting">xml.name("xml");
-node.name("node");
-text.name("text");
-start_tag.name("start_tag");
-end_tag.name("end_tag");
-</pre>
-<a name="spirit.qi.tutorials.mini_xml___error_handling.on_error"></a><h5>
-<a name="id437332"></a>
- <a href="qi.html#spirit.qi.tutorials.mini_xml___error_handling.on_error">On
- Error</a>
- </h5>
-
- <tt class="computeroutput">on_error</tt> declares our error
- handler:
- 
-<pre class="programlisting">on_error<Action>(rule, handler)
-</pre>
-
- This will specify what we will do when we get an error. We will print out
- an error message using phoenix:
- 
-<pre class="programlisting">on_error<fail>
-(
- xml
- , std::cout
- << val("Error! Expecting ")
- << _4 // what failed?
- << val(" here: \"")
- << construct<std::string>(_3, _2) // iterators to error-pos, end
- << val("\"")
- << std::endl
-);
-</pre>
-
- we choose to <tt class="computeroutput">fail</tt> in our
- example for the <tt class="computeroutput">Action</tt>:
- Quit and fail. Return a no_match (false). It can be one of:
- 
-<div class="informaltable"><table class="table">
-<colgroup>
-<col>
-<col>
-</colgroup>
-<thead><tr>
-<th>
- <tt class="computeroutput">Action</tt>
- </th>
-<th>
- Description
- </th>
-</tr></thead>
-<tbody>
-<tr>
-<td>
- fail
- </td>
-<td>
- Quit and fail. Return a no_match.
- </td>
-</tr>
-<tr>
-<td>
- retry
- </td>
-<td>
- Attempt error recovery, possibly moving the iterator position.
- </td>
-</tr>
-<tr>
-<td>
- accept
- </td>
-<td>
- Force success, moving the iterator position appropriately.
- </td>
-</tr>
-<tr>
-<td>
- rethrow
- </td>
-<td>
- Rethrows the error.
- </td>
-</tr>
-</tbody>
-</table></div>
-
- <tt class="computeroutput">rule</tt> is the rule we attach
- the handler to. In our case, we are attaching to the <tt class="computeroutput">xml</tt>
- rule.
- 
-
- <tt class="computeroutput">handler</tt> is the actual error
- handling function. It expects 4 arguments:
- 
-<div class="informaltable"><table class="table">
-<colgroup>
-<col>
-<col>
-</colgroup>
-<thead><tr>
-<th>
- Arg
- </th>
-<th>
- Description
- </th>
-</tr></thead>
-<tbody>
-<tr>
-<td>
- first
- </td>
-<td>
- The position of the iterator when the rule with the handler was
- entered.
- </td>
-</tr>
-<tr>
-<td>
- last
- </td>
-<td>
- The end of input.
- </td>
-</tr>
-<tr>
-<td>
- error-pos
- </td>
-<td>
- The actual position of the iterator where the error occurred.
- </td>
-</tr>
-<tr>
-<td>
- what
- </td>
-<td>
- What failed: a string decribing the failure.
- </td>
-</tr>
-</tbody>
-</table></div>
-<a name="spirit.qi.tutorials.mini_xml___error_handling.expectation_points"></a><h5>
-<a name="id438002"></a>
- <a href="qi.html#spirit.qi.tutorials.mini_xml___error_handling.expectation_points">Expectation
- Points</a>
- </h5>
-
- You might not have noticed it, but some of our expressions changed from
- using the <tt class="computeroutput">>></tt> to <tt class="computeroutput">></tt>. Look, for example:
- 
-<pre class="programlisting">end_tag =
- "</"
- > lit(_r1)
- > '>'
-;
-</pre>
-
- What is it? It's the expectation operator. You will
- have some "deterministic points" in the grammar. Those are the
- places where backtracking cannot occur.
- For our example above, when you get a <tt class="computeroutput">"</"</tt>,
- you definitely must see a valid end-tag label next. It should be the one
- you got from the start-tag. After that, you definitely must have a <tt class="computeroutput">'>'</tt> next. Otherwise, there is no point in
- proceeding forward and trying other branches, regardless where they are.
- The input is definitely erroneous. When this happens, an expectation_failure
- exception is thrown. Somewhere outward, the error handler will catch the
- exception.
- 
-
- Try building the parser: ../../example/qi/mini_xml2.cpp.
- You can find some examples in: ../../example/qi/mini_xml_samples
- for testing purposes. "4.toyxml" has an error in it:
- 
-<pre class="programlisting"><foo><bar></foo></bar>
-</pre>
-
- Running the example with this gives you:
- 
-<pre class="programlisting">Error! Expecting "bar" here: "foo></bar>"
-Error! Expecting end_tag here: "<bar></foo></bar>"
--------------------------
-Parsing failed
--------------------------
-</pre>
-</div>
-</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
@@ -2672,7 +79,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="abstracts/parsing_expression_grammar.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="qi/quick_reference.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="abstracts/parsing_expression_grammar.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="qi/tutorials.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>

Modified: trunk/libs/spirit/doc/html/spirit/qi/quick_reference.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/qi/quick_reference.html (original)
+++ trunk/libs/spirit/doc/html/spirit/qi/quick_reference.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -6,9 +6,9 @@
<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
<link rel="home" href="../../index.html" title="Spirit 2.1">
<link rel="up" href="../qi.html" title=" Qi">
-<link rel="previous" href="../qi.html" title=" Qi">
-<link rel="next" href="quick_reference/predefined_primitive_parsers.html" title="Predefined
- Primitive Parsers">
+<link rel="previous" href="tutorials/mini_xml___error_handling.html" title="Mini
+ XML - Error Handling">
+<link rel="next" href="quick_reference/common_notation.html" title="Common Notation">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
@@ -21,7 +21,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../qi.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../qi.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="quick_reference/predefined_primitive_parsers.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="tutorials/mini_xml___error_handling.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../qi.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="quick_reference/common_notation.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage">
@@ -31,7 +31,7 @@
<div></div>
</div>
<div class="toc"><dl>
-<dt>Common Notation</dt>
+<dt>Common Notation</dt>
<dt><a href="quick_reference/predefined_primitive_parsers.html">Predefined
 Primitive Parsers</a></dt>
<dt><a href="quick_reference/compound_attribute_rules.html">Compound
@@ -49,116 +49,6 @@
 easy way to recall a particular component without having to dig up on pages
 and pages of reference doumentation.
 
-<div class="section" lang="en">
-<div class="titlepage">
-<div><div><h4 class="title">
-<a name="spirit.qi.quick_reference.common_notation"></a>Common Notation
-</h4></div></div>
-<div></div>
-</div>
-<div class="variablelist">
-Notation
-<dl>
-<dt><tt class="computeroutput">P</tt></dt>
-<dd>
- Parser type
- </dd>
-<dt><tt class="computeroutput">p, a,
- b,
- c</tt></dt>
-<dd>
- Parser objects
- </dd>
-<dt><tt class="computeroutput">A, B,
- C</tt></dt>
-<dd>
- Attribute types of parsers A, B and C
- </dd>
-<dt><tt class="computeroutput">I</tt></dt>
-<dd>
- The iterator type used for parsing
- </dd>
-<dt><tt class="computeroutput">Unused</tt></dt>
-<dd>
- An <tt class="computeroutput">unused_type</tt>
- </dd>
-<dt><tt class="computeroutput">Context</tt></dt>
-<dd>
- The enclosing rule's <tt class="computeroutput">Context</tt>
- type
- </dd>
-<dt><tt class="computeroutput">Attr</tt></dt>
-<dd>
- An attribute type
- </dd>
-<dt><tt class="computeroutput">b</tt></dt>
-<dd>
- A boolean expression
- </dd>
-<dt><tt class="computeroutput">fp</tt></dt>
-<dd>
- A (lazy parser) function with signature <tt class="computeroutput">P(Unused, Context)</tt>
- </dd>
-<dt><tt class="computeroutput">fa</tt></dt>
-<dd>
- A (semantic action) function with signature <tt class="computeroutput">void(Attr, Context, bool&)</tt>. The third parameter is a boolean
- flag that can be set to false to force the parse to fail. Both <tt class="computeroutput">Context</tt> and the boolean flag are
- optional.
- </dd>
-<dt><tt class="computeroutput">first</tt></dt>
-<dd>
- An iterator pointing to the start of input
- </dd>
-<dt><tt class="computeroutput">last</tt></dt>
-<dd>
- An iterator pointing to the end of input
- </dd>
-<dt><tt class="computeroutput">Ch</tt></dt>
-<dd>
- Character-class specific character type (See __char_classtypes_)
- </dd>
-<dt><tt class="computeroutput">ch</tt></dt>
-<dd>
- Character-class specific character (See __char_classtypes_)
- </dd>
-<dt><tt class="computeroutput">ch2</tt></dt>
-<dd>
- Character-class specific character (See __char_classtypes_)
- </dd>
-<dt><tt class="computeroutput">chset</tt></dt>
-<dd>
- Character-set specifier string (example: "a-z0-9")
- </dd>
-<dt><tt class="computeroutput">str</tt></dt>
-<dd>
- Character-class specific string (See __char_classtypes_)
- </dd>
-<dt><tt class="computeroutput">Str</tt></dt>
-<dd>
- Attribute of <tt class="computeroutput">str</tt>:
- <tt class="computeroutput">std::basic_string<T></tt>
- where <tt class="computeroutput">T</tt> is the underlying
- character type of <tt class="computeroutput">str</tt>
- </dd>
-<dt><tt class="computeroutput">tuple<></tt></dt>
-<dd>
- Used as a placeholder for a fusion sequence
- </dd>
-<dt><tt class="computeroutput">vector<></tt></dt>
-<dd>
- Used as a placeholder for an STL container
- </dd>
-<dt><tt class="computeroutput">variant<></tt></dt>
-<dd>
- Used as a placeholder for a boost::variant
- </dd>
-<dt><tt class="computeroutput">optional<></tt></dt>
-<dd>
- Used as a placeholder for a boost::optional
- </dd>
-</dl>
-</div>
-</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
@@ -171,7 +61,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../qi.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../qi.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="quick_reference/predefined_primitive_parsers.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="tutorials/mini_xml___error_handling.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../qi.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="quick_reference/common_notation.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>

Added: trunk/libs/spirit/doc/html/spirit/qi/quick_reference/common_notation.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/qi/quick_reference/common_notation.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -0,0 +1,150 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Common Notation</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
+<link rel="home" href="../../../index.html" title="Spirit 2.1">
+<link rel="up" href="../quick_reference.html" title="Quick Reference">
+<link rel="previous" href="../quick_reference.html" title="Quick Reference">
+<link rel="next" href="predefined_primitive_parsers.html" title="Predefined
+ Primitive Parsers">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../quick_reference.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../quick_reference.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="predefined_primitive_parsers.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h4 class="title">
+<a name="spirit.qi.quick_reference.common_notation"></a>Common Notation
+</h4></div></div>
+<div></div>
+</div>
+<div class="variablelist">
+Notation
+<dl>
+<dt><tt class="computeroutput">P</tt></dt>
+<dd>
+ Parser type
+ </dd>
+<dt><tt class="computeroutput">p, a,
+ b,
+ c</tt></dt>
+<dd>
+ Parser objects
+ </dd>
+<dt><tt class="computeroutput">A, B,
+ C</tt></dt>
+<dd>
+ Attribute types of parsers A, B and C
+ </dd>
+<dt><tt class="computeroutput">I</tt></dt>
+<dd>
+ The iterator type used for parsing
+ </dd>
+<dt><tt class="computeroutput">Unused</tt></dt>
+<dd>
+ An <tt class="computeroutput">unused_type</tt>
+ </dd>
+<dt><tt class="computeroutput">Context</tt></dt>
+<dd>
+ The enclosing rule's <tt class="computeroutput">Context</tt>
+ type
+ </dd>
+<dt><tt class="computeroutput">Attr</tt></dt>
+<dd>
+ An attribute type
+ </dd>
+<dt><tt class="computeroutput">b</tt></dt>
+<dd>
+ A boolean expression
+ </dd>
+<dt><tt class="computeroutput">fp</tt></dt>
+<dd>
+ A (lazy parser) function with signature <tt class="computeroutput">P(Unused, Context)</tt>
+ </dd>
+<dt><tt class="computeroutput">fa</tt></dt>
+<dd>
+ A (semantic action) function with signature <tt class="computeroutput">void(Attr, Context, bool&)</tt>. The third parameter is a boolean
+ flag that can be set to false to force the parse to fail. Both <tt class="computeroutput">Context</tt> and the boolean flag are
+ optional.
+ </dd>
+<dt><tt class="computeroutput">first</tt></dt>
+<dd>
+ An iterator pointing to the start of input
+ </dd>
+<dt><tt class="computeroutput">last</tt></dt>
+<dd>
+ An iterator pointing to the end of input
+ </dd>
+<dt><tt class="computeroutput">Ch</tt></dt>
+<dd>
+ Character-class specific character type (See __char_classtypes_)
+ </dd>
+<dt><tt class="computeroutput">ch</tt></dt>
+<dd>
+ Character-class specific character (See __char_classtypes_)
+ </dd>
+<dt><tt class="computeroutput">ch2</tt></dt>
+<dd>
+ Character-class specific character (See __char_classtypes_)
+ </dd>
+<dt><tt class="computeroutput">chset</tt></dt>
+<dd>
+ Character-set specifier string (example: "a-z0-9")
+ </dd>
+<dt><tt class="computeroutput">str</tt></dt>
+<dd>
+ Character-class specific string (See __char_classtypes_)
+ </dd>
+<dt><tt class="computeroutput">Str</tt></dt>
+<dd>
+ Attribute of <tt class="computeroutput">str</tt>:
+ <tt class="computeroutput">std::basic_string<T></tt>
+ where <tt class="computeroutput">T</tt> is the underlying
+ character type of <tt class="computeroutput">str</tt>
+ </dd>
+<dt><tt class="computeroutput">tuple<></tt></dt>
+<dd>
+ Used as a placeholder for a fusion sequence
+ </dd>
+<dt><tt class="computeroutput">vector<></tt></dt>
+<dd>
+ Used as a placeholder for an STL container
+ </dd>
+<dt><tt class="computeroutput">variant<></tt></dt>
+<dd>
+ Used as a placeholder for a boost::variant
+ </dd>
+<dt><tt class="computeroutput">optional<></tt></dt>
+<dd>
+ Used as a placeholder for a boost::optional
+ </dd>
+</dl>
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2001-2009 Joel
+ de Guzman, 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../quick_reference.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../quick_reference.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="predefined_primitive_parsers.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Modified: trunk/libs/spirit/doc/html/spirit/qi/quick_reference/compound_attribute_rules.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/qi/quick_reference/compound_attribute_rules.html (original)
+++ trunk/libs/spirit/doc/html/spirit/qi/quick_reference/compound_attribute_rules.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -47,7 +47,7 @@
b</tt> will be <tt class="computeroutput">tuple<A, B></tt>.

<div class="table">
-<a name="id444347"></a>Table 4. compound parser attribute types
+<a name="id444464"></a>Table 4. compound parser attribute types
<table class="table" summary="compound parser attribute types">
<colgroup>
<col>

Modified: trunk/libs/spirit/doc/html/spirit/qi/quick_reference/predefined_primitive_parsers.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/qi/quick_reference/predefined_primitive_parsers.html (original)
+++ trunk/libs/spirit/doc/html/spirit/qi/quick_reference/predefined_primitive_parsers.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -7,7 +7,7 @@
<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
<link rel="home" href="../../../index.html" title="Spirit 2.1">
<link rel="up" href="../quick_reference.html" title="Quick Reference">
-<link rel="previous" href="../quick_reference.html" title="Quick Reference">
+<link rel="previous" href="common_notation.html" title="Common Notation">
<link rel="next" href="compound_attribute_rules.html" title="Compound
Attribute Rules">
</head>
@@ -22,7 +22,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../quick_reference.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../quick_reference.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="compound_attribute_rules.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="common_notation.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../quick_reference.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="compound_attribute_rules.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage">
@@ -856,7 +856,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../quick_reference.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../quick_reference.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="compound_attribute_rules.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="common_notation.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../quick_reference.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="compound_attribute_rules.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>

Added: trunk/libs/spirit/doc/html/spirit/qi/tutorials.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/qi/tutorials.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -0,0 +1,68 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Tutorials</title>
+<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
+<link rel="home" href="../../index.html" title="Spirit 2.1">
+<link rel="up" href="../qi.html" title=" Qi">
+<link rel="previous" href="../qi.html" title=" Qi">
+<link rel="next" href="tutorials/quick_start.html" title="Quick Start">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../qi.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../qi.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="tutorials/quick_start.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h3 class="title">
+<a name="spirit.qi.tutorials"></a>Tutorials
+</h3></div></div>
+<div></div>
+</div>
+<div class="toc"><dl>
+<dt>Quick Start</dt>
+<dt>Warming up</dt>
+<dt>Semantic Actions</dt>
+<dt><a href="tutorials/complex___our_first_complex_parser.html">Complex
+ - Our first complex parser</a></dt>
+<dt><a href="tutorials/sum___adding_numbers.html">Sum - adding
+ numbers</a></dt>
+<dt><a href="tutorials/number_list___stuffing_numbers_into_a_std__vector.html">Number
+ List - stuffing numbers into a std::vector</a></dt>
+<dt><a href="tutorials/number_list_redux___list_syntax.html">Number
+ List Redux - list syntax</a></dt>
+<dt><a href="tutorials/number_list_attribute___one_more__with_style.html">Number
+ List Attribute - one more, with style</a></dt>
+<dt>Roman Numerals</dt>
+<dt><a href="tutorials/employee___parsing_into_structs.html">Employee
+ - Parsing into structs</a></dt>
+<dt>Mini XML - ASTs!</dt>
+<dt><a href="tutorials/mini_xml___error_handling.html">Mini
+ XML - Error Handling</a></dt>
+</dl></div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2001-2009 Joel
+ de Guzman, 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../qi.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../qi.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="tutorials/quick_start.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/qi/tutorials/complex___our_first_complex_parser.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/qi/tutorials/complex___our_first_complex_parser.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -0,0 +1,153 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Complex
+ - Our first complex parser</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
+<link rel="home" href="../../../index.html" title="Spirit 2.1">
+<link rel="up" href="../tutorials.html" title="Tutorials">
+<link rel="previous" href="semantic_actions.html" title="Semantic Actions">
+<link rel="next" href="sum___adding_numbers.html" title="Sum - adding
+ numbers">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="semantic_actions.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorials.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="sum___adding_numbers.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h4 class="title">
+<a name="spirit.qi.tutorials.complex___our_first_complex_parser"></a><a href="complex___our_first_complex_parser.html" title="Complex
+ - Our first complex parser">Complex
+ - Our first complex parser</a>
+</h4></div></div>
+<div></div>
+</div>
+
+ Well, not really a complex parser, but a parser that parses complex numbers.
+ This time, we're using Phoenix
+ to do the semantic actions.
+ 
+
+ Here's a simple parser expression for complex numbers:
+ 
+<pre class="programlisting"> '(' >> double_ >> -(',' >> double_) >> ')'
+| double_
+</pre>
+
+ What's new? Well, we have:
+ 
+<div class="orderedlist"><ol type="1">
+<li>
+ Alternates: e.g. <tt class="computeroutput">a |
+ b</tt>. Try <tt class="computeroutput">a</tt>
+ first. If it succeeds, good. If not, try the next alternative, <tt class="computeroutput">b</tt>.
+ </li>
+<li>
+ Optionals: e.g. -p. Match the parser p zero or one time.
+ </li>
+</ol></div>
+
+ The complex parser presented above reads as:
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ One or two real number in parantheses, separated by comma (the second
+ number is optional)
+ </li>
+<li>
+OR a single real number.
+ </li>
+</ul></div>
+
+ This parser can parse complex numbers of the form:
+ 
+<pre class="programlisting">(123.45, 987.65)
+(123.45)
+123.45
+</pre>
+
+ Here goes, this time with actions:
+ 
+
+ 
+
+
+
+<pre class="programlisting">namespace client
+{
+ template <typename Iterator>
+ bool parse_complex(Iterator first, Iterator last, std::complex<double>& c)
+ {
+ using boost::spirit::qi::double_;
+ using boost::spirit::qi::_1;
+ using boost::spirit::qi::phrase_parse;
+ using boost::spirit::ascii::space;
+ using boost::phoenix::ref;
+
+ double rN = 0.0;
+ double iN = 0.0;
+ bool r = phrase_parse(first, last,
+
+ // Begin grammar
+ (
+ '(' >> double_[ref(rN) = _1]
+ >> -(',' >> double_[ref(iN) = _1]) >> ')'
+ | double_[ref(rN) = _1]
+ ),
+ // End grammar
+
+ space);
+
+ if (!r || first != last) // fail if we did not get a full match
+ return false;
+ c = std::complex<double>(rN, iN);
+ return r;
+ }
+}
+</pre>
+
+ 
+
+ 
+
+ The full cpp file for this example can be found here: ../../example/qi/complex_number.cpp
+ 
+
+ The <tt class="computeroutput">double_</tt> parser attaches
+ this action:
+ 
+<pre class="programlisting">ref(n) = _1
+</pre>
+
+ This assigns the parsed result (actually, the attribute of <tt class="computeroutput">double_</tt>) to n. <tt class="computeroutput">ref(n)</tt>
+ tells Phoenix that <tt class="computeroutput">n</tt> is
+ a mutable reference. <tt class="computeroutput">_1</tt>
+ is a Phoenix placeholder for the parsed result attribute.
+ 
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2001-2009 Joel
+ de Guzman, 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="semantic_actions.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorials.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="sum___adding_numbers.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/qi/tutorials/employee___parsing_into_structs.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/qi/tutorials/employee___parsing_into_structs.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -0,0 +1,440 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Employee
+ - Parsing into structs</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
+<link rel="home" href="../../../index.html" title="Spirit 2.1">
+<link rel="up" href="../tutorials.html" title="Tutorials">
+<link rel="previous" href="roman_numerals.html" title="Roman Numerals">
+<link rel="next" href="mini_xml___asts_.html" title="Mini XML - ASTs!">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="roman_numerals.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorials.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="mini_xml___asts_.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h4 class="title">
+<a name="spirit.qi.tutorials.employee___parsing_into_structs"></a><a href="employee___parsing_into_structs.html" title="Employee
+ - Parsing into structs">Employee
+ - Parsing into structs</a>
+</h4></div></div>
+<div></div>
+</div>
+
+ It's a common question in the <a href="http://www.nabble.com/The-Spirit-Parser-Library-f3430.html" target="_top">Spirit
+ General List</a>: how do I parse and place the results into a C++ struct?
+ Of course, at this point, you already know various ways to do it, using
+ semantic actions. There are many ways to skin a cat. Spirit2, being fully
+ attributed, makes it even easier. The next example demonstrates some features
+ of Spirit2 that makes this easy. In the process, you'll learn about:
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ More about attributes
+ </li>
+<li>
+ Auto rules
+ </li>
+<li>
+ Some more built-in parsers
+ </li>
+<li>
+ Directives
+ </li>
+</ul></div>
+
+ First, let's create a struct representing an employee:
+ 
+
+ 
+
+
+
+<pre class="programlisting">struct employee
+{
+ int age;
+ std::string surname;
+ std::string forename;
+ double salary;
+};
+</pre>
+
+ 
+
+ 
+
+ Then, we need to tell Fusion
+ about our employee struct to make it a first- class fusion citizen. If
+ you don't know fusion yet, it is a Boost
+ library for working with heterogenous collections of data, commonly referred
+ to as tuples. Spirit uses fusion extensively as part of its infrastructure.
+ 
+
+ In fusion's view, a struct is just a form of a tuple. You can adapt any
+ struct to be a fully conforming fusion tuple:
+ 
+
+ 
+
+
+
+<pre class="programlisting">BOOST_FUSION_ADAPT_STRUCT(
+ client::employee,
+ (int, age)
+ (std::string, surname)
+ (std::string, forename)
+ (double, salary)
+)
+</pre>
+
+ 
+
+ 
+
+ Now we'll write a parser for our employee. Inputs will be of the form:
+ 
+<pre class="programlisting">employee{ age, "surname", "forename", salary }
+</pre>
+
+ Here goes:
+ 
+
+ 
+
+
+
+<pre class="programlisting">template <typename Iterator>
+struct employee_parser : qi::grammar<Iterator, employee(), ascii::space_type>
+{
+ employee_parser() : employee_parser::base_type(start)
+ {
+ using qi::int_;
+ using qi::lit;
+ using qi::double_;
+ using qi::lexeme;
+ using ascii::char_;
+
+ quoted_string %= lexeme['"' >> +(char_ - '"') >> '"'];
+
+ start %=
+ lit("employee")
+ >> '{'
+ >> int_ >> ','
+ >> quoted_string >> ','
+ >> quoted_string >> ','
+ >> double_
+ >> '}'
+ ;
+ }
+
+ qi::rule<Iterator, std::string(), ascii::space_type> quoted_string;
+ qi::rule<Iterator, employee(), ascii::space_type> start;
+};
+</pre>
+
+ 
+
+ 
+
+ The full cpp file for this example can be found here: ../../example/qi/employee.cpp
+ 
+
+ Let's walk through this one step at a time (not necessarily from top to
+ bottom).
+ 
+<pre class="programlisting">template <typename Iterator>
+struct employee_parser : grammar<Iterator, employee(), space_type>
+</pre>
+
+ <tt class="computeroutput">employee_parser</tt> is a grammar.
+ Like before, we make it a template so that we can reuse it for different
+ iterator types. The grammar's signature is:
+ 
+<pre class="programlisting">employee()
+</pre>
+
+ meaning, the parser generates employee structs. <tt class="computeroutput">employee_parser</tt>
+ skips white spaces using <tt class="computeroutput">space_type</tt>
+ as its skip parser.
+ 
+<pre class="programlisting">employee_parser() : employee_parser::base_type(start)
+</pre>
+
+ Initializes the base class.
+ 
+<pre class="programlisting">rule<Iterator, std::string(), space_type> quoted_string;
+rule<Iterator, employee(), space_type> start;
+</pre>
+
+ Declares two rules: <tt class="computeroutput">quoted_string</tt>
+ and <tt class="computeroutput">start</tt>. <tt class="computeroutput">start</tt> has the same template parameters
+ as the grammar itself. <tt class="computeroutput">quoted_string</tt>
+ has a <tt class="computeroutput">std::string</tt> attribute.
+ 
+<a name="spirit.qi.tutorials.employee___parsing_into_structs.lexeme"></a><h5>
+<a name="id428735"></a>
+ Lexeme
+ </h5>
+<pre class="programlisting">lexeme['"' >> +(char_ - '"') >> '"'];
+</pre>
+
+ <tt class="computeroutput">lexeme</tt> inhibits space skipping
+ from the open brace to the closing brace. The expression parses quoted
+ strings.
+ 
+<pre class="programlisting">+(char_ - '"')
+</pre>
+
+ parses one or more chars, except the double quote. It stops when it sees
+ a double quote.
+ 
+<a name="spirit.qi.tutorials.employee___parsing_into_structs.difference"></a><h5>
+<a name="id428891"></a>
+ Difference
+ </h5>
+
+ The expression:
+ 
+<pre class="programlisting">a - b
+</pre>
+
+ parses <tt class="computeroutput">a</tt> but not <tt class="computeroutput">b</tt>. Its attribute is just <tt class="computeroutput">A</tt>, the attribute of <tt class="computeroutput">a</tt>.
+ <tt class="computeroutput">b</tt>'s attribute is ignored.
+ Hence, the attribute of:
+ 
+<pre class="programlisting">char_ - '"'
+</pre>
+
+ is just <tt class="computeroutput">char</tt>.
+ 
+<a name="spirit.qi.tutorials.employee___parsing_into_structs.plus"></a><h5>
+<a name="id429050"></a>
+ Plus
+ </h5>
+<pre class="programlisting">+a
+</pre>
+
+ is the close kin of the kleene star we got so used to in our tutorial.
+ Like it's kin, the kleene star, its attribute is a <tt class="computeroutput">std::vector<A></tt> where <tt class="computeroutput">A</tt>
+ is the attribute of <tt class="computeroutput">a</tt>.
+ So, putting all these together, the attribute of
+ 
+<pre class="programlisting">+(char_ - '"')
+</pre>
+
+ is then:
+ 
+<pre class="programlisting">std::vector<char>
+</pre>
+<a name="spirit.qi.tutorials.employee___parsing_into_structs.sequence_attribute"></a><h5>
+<a name="id429236"></a>
+ <a href="employee___parsing_into_structs.html#spirit.qi.tutorials.employee___parsing_into_structs.sequence_attribute">Sequence
+ Attribute</a>
+ </h5>
+
+ Now what's the attribute of
+ 
+<pre class="programlisting">'"' >> +(char_ - '"') >> '"'
+</pre>
+
+ ?
+ 
+
+ Well, typically, the attribute of:
+ 
+<pre class="programlisting">a >> b >> c
+</pre>
+
+ is:
+ 
+<pre class="programlisting">fusion::vector<A, B, C>
+</pre>
+
+ where <tt class="computeroutput">A</tt> is the attribute
+ of <tt class="computeroutput">a</tt>, <tt class="computeroutput">B</tt>
+ is the attribute of <tt class="computeroutput">b</tt> and
+ <tt class="computeroutput">C</tt> is the attribute of
+ <tt class="computeroutput">c</tt>. What is <tt class="computeroutput">fusion::vector</tt>? - a tuple.
+ 
+<div class="note"><table border="0" summary="Note">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../images/note.png"></td>
+<th align="left">Note</th>
+</tr>
+<tr><td colspan="2" align="left" valign="top">
+ If you don't know what I am talking about, see: <a href="http://tinyurl.com/6xun4j" target="_top">Fusion
+ Vector</a>. It might be a good idea to have a look into Fusion
+ at this point. You'll definitely see more of it in the coming pages.
+ </td></tr>
+</table></div>
+<a name="spirit.qi.tutorials.employee___parsing_into_structs.attribute_collapsing"></a><h5>
+<a name="id429558"></a>
+ <a href="employee___parsing_into_structs.html#spirit.qi.tutorials.employee___parsing_into_structs.attribute_collapsing">Attribute
+ Collapsing</a>
+ </h5>
+
+ Some parsers, especially those very little literal parsers you see, like
+ <tt class="computeroutput">'"'</tt>, do not have attributes.
+ 
+
+ Nodes without attributes are disregarded. In a sequence, like above, all
+ nodes with no attributes are filtered out of the <tt class="computeroutput">fusion:vector</tt>.
+ So, since <tt class="computeroutput">'"'</tt> has no attribute,
+ and <tt class="computeroutput">+(char_
+ - '"')</tt> has a <tt class="computeroutput">std::vector<char></tt> attribute, the whole expression's attribute
+ should have been:
+ 
+<pre class="programlisting">fusion::vector<std::vector<char> >
+</pre>
+
+ But wait, there's one more collapsing rule: If after the attribute is a
+ single element <tt class="computeroutput">fusion::vector</tt>, The element is stripped naked
+ from its container. So, to make a long story short, the attribute of the
+ expression:
+ 
+<pre class="programlisting">'"' >> +(char_ - '"') >> '"'
+</pre>
+
+ is:
+ 
+<pre class="programlisting">std::vector<char>
+</pre>
+<a name="spirit.qi.tutorials.employee___parsing_into_structs.auto_rules"></a><h5>
+<a name="id429907"></a>
+ <a href="employee___parsing_into_structs.html#spirit.qi.tutorials.employee___parsing_into_structs.auto_rules">Auto
+ Rules</a>
+ </h5>
+
+ It is typical to see rules like:
+ 
+<pre class="programlisting">r = p[_val = _1];
+</pre>
+
+ If you have a rule definition like above where the attribute of the RHS
+ (right hand side) of the rule is compatibe with the attribute of the LHS
+ (left hand side), then you can rewrite it as:
+ 
+<pre class="programlisting">r %= p;
+</pre>
+
+ The attribute of <tt class="computeroutput">p</tt> automatically
+ uses the attribute of <tt class="computeroutput">r</tt>.
+ 
+
+ So, going back to our <tt class="computeroutput">quoted_string</tt>
+ rule:
+ 
+<pre class="programlisting">quoted_string %= lexeme['"' >> +(char_ - '"') >> '"'];
+</pre>
+
+ is a simplified version of:
+ 
+<pre class="programlisting">quoted_string = lexeme['"' >> +(char_ - '"') >> '"'][val_ = _1];
+</pre>
+
+ The attribute of the <tt class="computeroutput">quoted_string</tt>
+ rule: <tt class="computeroutput">std::string</tt> is compatible
+ with the attribute of the RHS: <tt class="computeroutput">std::vector<char></tt>. The RHS extracts the parsed attribute
+ directly into the rule's attribute, in-situ.
+ 
+<a name="spirit.qi.tutorials.employee___parsing_into_structs.finally"></a><h5>
+<a name="id430351"></a>
+ Finally
+ </h5>
+
+ We're down to one rule, the start rule:
+ 
+<pre class="programlisting">start %=
+ lit("employee")
+ >> '{'
+ >> int_ >> ','
+ >> quoted_string >> ','
+ >> quoted_string >> ','
+ >> double_
+ >> '}'
+ ;
+</pre>
+
+ Applying our collapsing rules above, the RHS has an attribute of:
+ 
+<pre class="programlisting">fusion::vector<int, std::string, std::string, double>
+</pre>
+
+ These nodes do not have an attribute:
+ 
+<div class="itemizedlist"><ul type="disc">
+<li><tt class="computeroutput">lit("employee")</tt></li>
+<li><tt class="computeroutput">'{'</tt></li>
+<li><tt class="computeroutput">'}'</tt></li>
+</ul></div>
+<div class="note"><table border="0" summary="Note">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../images/note.png"></td>
+<th align="left">Note</th>
+</tr>
+<tr><td colspan="2" align="left" valign="top">
+ In case you are wondering, <tt class="computeroutput">lit("employee")</tt> is the same as "employee".
+ We had to wrap it inside <tt class="computeroutput">lit</tt>
+ because immediately after it is <tt class="computeroutput">>>
+ '{'</tt>. You can't right-shift a <tt class="computeroutput">char[]</tt>
+ and a <tt class="computeroutput">char</tt> - you know, C++
+ syntax rules.
+ </td></tr>
+</table></div>
+
+ Recall that the attribute of <tt class="computeroutput">start</tt>
+ is the <tt class="computeroutput">employee</tt> struct:
+ 
+
+ 
+
+
+
+<pre class="programlisting">struct employee
+{
+ int age;
+ std::string surname;
+ std::string forename;
+ double salary;
+};
+</pre>
+
+ 
+
+ 
+
+ Now everything is clear, right? The <tt class="computeroutput">struct
+ employee</tt> IS
+ compatible with <tt class="computeroutput">fusion::vector<int, std::string, std::string, double></tt>. So, the RHS of <tt class="computeroutput">start</tt>
+ uses start's attribute (a <tt class="computeroutput">struct
+ employee</tt>) in-situ when it does
+ its work.
+ 
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2001-2009 Joel
+ de Guzman, 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="roman_numerals.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorials.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="mini_xml___asts_.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/qi/tutorials/mini_xml___asts_.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/qi/tutorials/mini_xml___asts_.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -0,0 +1,526 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Mini XML - ASTs!</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
+<link rel="home" href="../../../index.html" title="Spirit 2.1">
+<link rel="up" href="../tutorials.html" title="Tutorials">
+<link rel="previous" href="employee___parsing_into_structs.html" title="Employee
+ - Parsing into structs">
+<link rel="next" href="mini_xml___error_handling.html" title="Mini
+ XML - Error Handling">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="employee___parsing_into_structs.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorials.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="mini_xml___error_handling.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h4 class="title">
+<a name="spirit.qi.tutorials.mini_xml___asts_"></a>Mini XML - ASTs!
+</h4></div></div>
+<div></div>
+</div>
+
+ Stop and think about it... We've come very close to generating an AST in
+ our last example. We parsed a single structure and generated an in-memory
+ representation of it in the form of a struct: the <tt class="computeroutput">struct
+ employee</tt>. If we changed the implementation
+ to parse one or more employees, the result would be a <tt class="computeroutput">std::vector<employee></tt>. We can go on and add more hierarchy:
+ teams, departments, corporations. Then we'll have an AST representation
+ of it all.
+ 
+
+ In this example (actually two examples), we'll now explore parsers how
+ to create ASTs. We will parse a minimalistic XML like language and compile
+ the results into our data structures in the form of a tree.
+ 
+
+ Along the way, we'll see new features:
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ Inherited attributes
+ </li>
+<li>
+ Variant attributes
+ </li>
+<li>
+ Local Variables
+ </li>
+<li>
+ Not Predicate
+ </li>
+<li>
+ Lazy Lit
+ </li>
+</ul></div>
+
+ The full cpp files for these examples can be found here: ../../example/qi/mini_xml1.cpp
+ and here: ../../example/qi/mini_xml2.cpp
+ 
+
+ There are a couple of sample toy-xml files in: ../../example/qi/mini_xml_samples
+ for testing purposes. "4.toyxml" has an error in it.
+ 
+<a name="spirit.qi.tutorials.mini_xml___asts_.first_cut"></a><h5>
+<a name="id431258"></a>
+ First Cut
+ </h5>
+
+ Without further delay, here's the first version of the XML grammar:
+ 
+
+ 
+
+
+
+<pre class="programlisting">template <typename Iterator>
+struct mini_xml_grammar : qi::grammar<Iterator, mini_xml(), ascii::space_type>
+{
+ mini_xml_grammar() : mini_xml_grammar::base_type(xml)
+ {
+ using qi::lit;
+ using qi::lexeme;
+ using ascii::char_;
+ using ascii::string;
+ using namespace qi::labels;
+
+ using phoenix::at_c;
+ using phoenix::push_back;
+
+ text = lexeme[+(char_ - '<') [_val += _1]];
+ node = (xml | text) [_val = _1];
+
+ start_tag =
+ '<'
+ >> !lit('/')
+ >> lexeme[+(char_ - '>') [_val += _1]]
+ >> '>'
+ ;
+
+ end_tag =
+ "</"
+ >> string(_r1)
+ >> '>'
+ ;
+
+ xml =
+ start_tag [at_c<0>(_val) = _1]
+ >> *node [push_back(at_c<1>(_val), _1)]
+ >> end_tag(at_c<0>(_val))
+ ;
+ }
+
+ qi::rule<Iterator, mini_xml(), ascii::space_type> xml;
+ qi::rule<Iterator, mini_xml_node(), ascii::space_type> node;
+ qi::rule<Iterator, std::string(), ascii::space_type> text;
+ qi::rule<Iterator, std::string(), ascii::space_type> start_tag;
+ qi::rule<Iterator, void(std::string), ascii::space_type> end_tag;
+};
+</pre>
+
+ 
+
+ 
+
+ Going bottom up, let's examine the <tt class="computeroutput">text</tt>
+ rule:
+ 
+<pre class="programlisting">rule<Iterator, std::string(), space_type> text;
+</pre>
+
+ and its definition:
+ 
+<pre class="programlisting">text = lexeme[+(char_ - '<') [_val += _1]];
+</pre>
+
+ The semantic action collects the chars and appends them (via +=) to the
+ <tt class="computeroutput">std::string</tt> attribute of the rule (represented
+ by the placeholder <tt class="computeroutput">_val</tt>).
+ 
+<a name="spirit.qi.tutorials.mini_xml___asts_.alternates"></a><h5>
+<a name="id432858"></a>
+ Alternates
+ </h5>
+<pre class="programlisting">rule<Iterator, mini_xml_node(), space_type> node;
+</pre>
+
+ and its definition:
+ 
+<pre class="programlisting">node = (xml | text) [_val = _1];
+</pre>
+
+ We'll see what a <tt class="computeroutput">mini_xml_node</tt>
+ structure later. Looking at the rule definition, we see some alternation
+ goiing on here. An xml <tt class="computeroutput">node</tt>
+ is either an <tt class="computeroutput">xml</tt> OR <tt class="computeroutput">text</tt>. Hmmm... hold on to that thought...
+ 
+<pre class="programlisting">rule<Iterator, std::string(), space_type> start_tag;
+</pre>
+
+ Again, with an attribute of <tt class="computeroutput">std::string</tt>.
+ Then, it's definition:
+ 
+<pre class="programlisting">start_tag =
+ '<'
+ >> !char_('/')
+ >> lexeme[+(char_ - '>') [_val += _1]]
+ >> '>'
+;
+</pre>
+<a name="spirit.qi.tutorials.mini_xml___asts_.not_predicate"></a><h5>
+<a name="id433320"></a>
+ <a href="mini_xml___asts_.html#spirit.qi.tutorials.mini_xml___asts_.not_predicate">Not
+ Predicate</a>
+ </h5>
+
+ <tt class="computeroutput">start_tag</tt> is similar to
+ the <tt class="computeroutput">text</tt> rule apart from
+ the added <tt class="computeroutput">'<'</tt> and <tt class="computeroutput">'>'</tt>. But wait, to make sure that the <tt class="computeroutput">start_tag</tt> does not parse <tt class="computeroutput">end_tag</tt>s too, we add: <tt class="computeroutput">!char_('/')</tt>. This
+ is a "Not Predicate":
+ 
+<pre class="programlisting">!p
+</pre>
+
+ It will try the parser, <tt class="computeroutput">p</tt>.
+ If it is successful, fail, otherwise, pass. In other words, it negates
+ the result of <tt class="computeroutput">p</tt>. Like the
+ <tt class="computeroutput">eps</tt>, it does not consume
+ any input though. It will always rewind the iterator position to where
+ it was upon entry. So, the expression:
+ 
+<pre class="programlisting">!char_('/')
+</pre>
+
+ basically says: we should not have a <tt class="computeroutput">'/'</tt>
+ at this point.
+ 
+<a name="spirit.qi.tutorials.mini_xml___asts_.inherited_attribute"></a><h5>
+<a name="id433560"></a>
+ <a href="mini_xml___asts_.html#spirit.qi.tutorials.mini_xml___asts_.inherited_attribute">Inherited
+ Attribute</a>
+ </h5>
+
+ The <tt class="computeroutput">end_tag</tt>:
+ 
+<pre class="programlisting">rule<Iterator, void(std::string), space_type> end_tag;
+</pre>
+
+ Ohh! Now we see an inherited attribute there: <tt class="computeroutput">std::string</tt>.
+ The <tt class="computeroutput">end_tag</tt> does not have
+ a synthesized attribute. Let's see its definition:
+ 
+<pre class="programlisting">end_tag =
+ "</"
+ >> lit(_r1)
+ >> '>'
+;
+</pre>
+
+ <tt class="computeroutput">_r1</tt> is yet another Phoenix placeholder for
+ the 1st inherited attribute (we have only one, use <tt class="computeroutput">_r2</tt>,
+ <tt class="computeroutput">_r3</tt>, etc. if you have more).
+ 
+<a name="spirit.qi.tutorials.mini_xml___asts_.a_lazy_lit"></a><h5>
+<a name="id433840"></a>
+ <a href="mini_xml___asts_.html#spirit.qi.tutorials.mini_xml___asts_.a_lazy_lit">A Lazy
+ Lit</a>
+ </h5>
+
+ Check out how we used <tt class="computeroutput">lit</tt>
+ here, this time, not with a literal string, but with the value of the 1st
+ inherited attribute, which is specified as <tt class="computeroutput">std::string</tt>
+ in our rule declaration.
+ 
+
+ Finally, our <tt class="computeroutput">xml</tt> rule:
+ 
+<pre class="programlisting">rule<Iterator, mini_xml(), space_type> xml;
+</pre>
+
+ <tt class="computeroutput">mini_xml</tt> is our attribute
+ here. We'll see later what it is. Let's see its definition:
+ 
+<pre class="programlisting">xml =
+ start_tag [at_c<0>(_val) = _1]
+ >> *node [push_back(at_c<1>(_val), _1)]
+ >> end_tag(at_c<0>(_val))
+;
+</pre>
+
+ Those who know Fusion
+ now will notice <tt class="computeroutput">at_c<0></tt> and
+ <tt class="computeroutput">at_c<1></tt>. This
+ gives us a hint that <tt class="computeroutput">mini_xml</tt>
+ is a sort of a tuple - a fusion sequence. <tt class="computeroutput">at_c<N></tt> here is a lazy version of the tuple
+ accessors, provided by Phoenix.
+ 
+<a name="spirit.qi.tutorials.mini_xml___asts_.how_it_all_works"></a><h5>
+<a name="id434319"></a>
+ <a href="mini_xml___asts_.html#spirit.qi.tutorials.mini_xml___asts_.how_it_all_works">How
+ it all works</a>
+ </h5>
+
+ So, what's happening?
+ 
+<div class="orderedlist"><ol type="1">
+<li>
+ Upon parsing <tt class="computeroutput">start_tag</tt>,
+ the parsed start-tag string is placed in <tt class="computeroutput">at_c<0>(_val)</tt>.
+ </li>
+<li>
+ Then we parse zero or more <tt class="computeroutput">node</tt>s.
+ At each step, we <tt class="computeroutput">push_back</tt>
+ the result into <tt class="computeroutput">at_c<1>(_val)</tt>.
+ </li>
+<li>
+ Finally, we parse the <tt class="computeroutput">end_tag</tt>
+ giving it an inherited attribute: <tt class="computeroutput">at_c<0>(_val)</tt>.
+ This is the string we obtained from the <tt class="computeroutput">start_tag</tt>.
+ Investigate <tt class="computeroutput">end_tag</tt> above.
+ It will fail to parse if it gets something different from what we got
+ from the <tt class="computeroutput">start_tag</tt>. This
+ ensures that our tags are balanced.
+ </li>
+</ol></div>
+
+ To give the last item some more light, what happens is this:
+ 
+<pre class="programlisting">end_tag(at_c<0>(_val))
+</pre>
+
+ calls:
+ 
+<pre class="programlisting">end_tag =
+ "</"
+ >> lit(_r1)
+ >> '>'
+;
+</pre>
+
+ passing in <tt class="computeroutput">at_c<0>(_val)</tt>, the string from start tag. This is referred
+ to in the <tt class="computeroutput">end_tag</tt> body
+ as <tt class="computeroutput">_r1</tt>.
+ 
+<a name="spirit.qi.tutorials.mini_xml___asts_.the_structures"></a><h5>
+<a name="id434763"></a>
+ <a href="mini_xml___asts_.html#spirit.qi.tutorials.mini_xml___asts_.the_structures">The
+ Structures</a>
+ </h5>
+
+ Let's see our structures. It will definitely be hierarchical: xml is hierarchical.
+ It will also be recursive: xml is recursive.
+ 
+
+ 
+
+
+
+<pre class="programlisting">struct mini_xml;
+
+typedef
+ boost::variant<
+ boost::recursive_wrapper<mini_xml>
+ , std::string
+ >
+mini_xml_node;
+
+struct mini_xml
+{
+ std::string name; // tag name
+ std::vector<mini_xml_node> children; // children
+};
+</pre>
+
+ 
+
+ 
+<a name="spirit.qi.tutorials.mini_xml___asts_.of_alternates_and_variants"></a><h5>
+<a name="id435031"></a>
+ <a href="mini_xml___asts_.html#spirit.qi.tutorials.mini_xml___asts_.of_alternates_and_variants">Of
+ Alternates and Variants</a>
+ </h5>
+
+ So that's how a <tt class="computeroutput">mini_xml_node</tt>
+ looks like. We had a hint that it is either a <tt class="computeroutput">string</tt>
+ or a <tt class="computeroutput">mini_xml</tt>. For this,
+ we use boost.variant<>.
+ <tt class="computeroutput">boost::recursive_wrapper</tt> wraps <tt class="computeroutput">mini_xml</tt>, making it a recursive data
+ structure.
+ 
+
+ Yep, you got that right: the attribute of an alternate:
+ 
+<pre class="programlisting">a | b
+</pre>
+
+ is a
+ 
+<pre class="programlisting">boost::variant<A, B>
+</pre>
+
+ where <tt class="computeroutput">A</tt> is the attribute
+ of <tt class="computeroutput">a</tt> and <tt class="computeroutput">B</tt> is the attribute of <tt class="computeroutput">b</tt>.
+ 
+<a name="spirit.qi.tutorials.mini_xml___asts_.adapting_structs_again"></a><h5>
+<a name="id435297"></a>
+ <a href="mini_xml___asts_.html#spirit.qi.tutorials.mini_xml___asts_.adapting_structs_again">Adapting
+ structs again</a>
+ </h5>
+
+ <tt class="computeroutput">mini_xml</tt> is no brainier.
+ It is a plain ol' struct. But as we've seen in our employee example, we
+ can adapt that to be a Fusion
+ sequence:
+ 
+
+ 
+
+
+
+<pre class="programlisting">BOOST_FUSION_ADAPT_STRUCT(
+ client::mini_xml,
+ (std::string, name)
+ (std::vector<client::mini_xml_node>, children)
+)
+</pre>
+
+ 
+
+ 
+<a name="spirit.qi.tutorials.mini_xml___asts_.one_more_take"></a><h5>
+<a name="id435495"></a>
+ <a href="mini_xml___asts_.html#spirit.qi.tutorials.mini_xml___asts_.one_more_take">One
+ More Take</a>
+ </h5>
+
+ Here's another version. The AST structure remains the same, but this time,
+ you'll see that we make use of auto-rules making the grammar semantic-action-
+ less. Here it is:
+ 
+
+ 
+
+
+
+<pre class="programlisting">template <typename Iterator>
+struct mini_xml_grammar
+ : qi::grammar<Iterator, mini_xml(), qi::locals<std::string>, ascii::space_type>
+{
+ mini_xml_grammar()
+ : mini_xml_grammar::base_type(xml)
+ {
+ using qi::lit;
+ using qi::lexeme;
+ using ascii::char_;
+ using ascii::string;
+ using namespace qi::labels;
+
+ text %= lexeme[+(char_ - '<')];
+ node %= xml | text;
+
+ start_tag %=
+ '<'
+ >> !lit('/')
+ >> lexeme[+(char_ - '>')]
+ >> '>'
+ ;
+
+ end_tag =
+ "</"
+ >> string(_r1)
+ >> '>'
+ ;
+
+ xml %=
+ start_tag[_a = _1]
+ >> *node
+ >> end_tag(_a)
+ ;
+ }
+
+ qi::rule<Iterator, mini_xml(), qi::locals<std::string>, ascii::space_type> xml;
+ qi::rule<Iterator, mini_xml_node(), ascii::space_type> node;
+ qi::rule<Iterator, std::string(), ascii::space_type> text;
+ qi::rule<Iterator, std::string(), ascii::space_type> start_tag;
+ qi::rule<Iterator, void(std::string), ascii::space_type> end_tag;
+};
+</pre>
+
+ 
+
+ 
+
+ This one shouldn't be any more difficult to understand after going through
+ the first xml parser example. The rules are almost the same, except that,
+ we got rid of semantic actions and used auto-rules (see the employee example
+ if you missed that). There are a couple of new stuff, though. It's all
+ in the <tt class="computeroutput">xml</tt> rule:
+ 
+<a name="spirit.qi.tutorials.mini_xml___asts_.local_variables"></a><h5>
+<a name="id436739"></a>
+ <a href="mini_xml___asts_.html#spirit.qi.tutorials.mini_xml___asts_.local_variables">Local
+ Variables</a>
+ </h5>
+<pre class="programlisting">rule<Iterator, mini_xml(), locals<std::string>, space_type> xml;
+</pre>
+
+ Wow, we have four template parameters now. What's that <tt class="computeroutput">locals</tt>
+ guy doing there? Well, it declares that the rule <tt class="computeroutput">xml</tt>
+ will have one local variable: a <tt class="computeroutput">string</tt>.
+ Let's see how this is used in action:
+ 
+<pre class="programlisting">xml %=
+ start_tag[_a = _1]
+ >> *node
+ >> end_tag(_a)
+;
+</pre>
+<div class="orderedlist"><ol type="1">
+<li>
+ Upon parsing <tt class="computeroutput">start_tag</tt>,
+ the parsed start-tag string is placed in the local variable specified
+ by (yet another) Phoenix
+ placeholder: <tt class="computeroutput">_a</tt>. We have
+ only one local variable. If we had more, these are designated by <tt class="computeroutput">_b</tt>..<tt class="computeroutput">_z</tt>.
+ </li>
+<li>
+ Then we parse zero or more <tt class="computeroutput">node</tt>s.
+ </li>
+<li>
+ Finally, we parse the <tt class="computeroutput">end_tag</tt>
+ giving it an inherited attribute: <tt class="computeroutput">_a</tt>,
+ our local variable.
+ </li>
+</ol></div>
+
+ There are no actions involved in stuffing data into our <tt class="computeroutput">xml</tt>
+ attribute. It's all taken cared of thatnks to the auto-rule.
+ 
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2001-2009 Joel
+ de Guzman, 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="employee___parsing_into_structs.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorials.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="mini_xml___error_handling.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/qi/tutorials/mini_xml___error_handling.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/qi/tutorials/mini_xml___error_handling.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -0,0 +1,266 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Mini
+ XML - Error Handling</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
+<link rel="home" href="../../../index.html" title="Spirit 2.1">
+<link rel="up" href="../tutorials.html" title="Tutorials">
+<link rel="previous" href="mini_xml___asts_.html" title="Mini XML - ASTs!">
+<link rel="next" href="../quick_reference.html" title="Quick Reference">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="mini_xml___asts_.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorials.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../quick_reference.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h4 class="title">
+<a name="spirit.qi.tutorials.mini_xml___error_handling"></a><a href="mini_xml___error_handling.html" title="Mini
+ XML - Error Handling">Mini
+ XML - Error Handling</a>
+</h4></div></div>
+<div></div>
+</div>
+
+ A parser will not be complete without error handling. Spirit2 provides
+ some facilities to make it easy to adapt a grammar for error handling.
+ We'll wrap up the Qi tutorial with another version of the mini xml parser,
+ this time, with error handling.
+ 
+
+ ../../example/qi/mini_xml1.cpp
+ and here: ../../example/qi/mini_xml2.cpp
+ 
+
+ Here's the grammar:
+ 
+
+ What's new?
+ 
+<a name="spirit.qi.tutorials.mini_xml___error_handling.readable_names"></a><h5>
+<a name="id437192"></a>
+ <a href="mini_xml___error_handling.html#spirit.qi.tutorials.mini_xml___error_handling.readable_names">Readable
+ Names</a>
+ </h5>
+
+ First, when we call the base class, we give the grammar a name:
+ 
+<pre class="programlisting">: mini_xml_grammar::base_type(xml, "xml")
+</pre>
+
+ Then, we name all our rules:
+ 
+<pre class="programlisting">xml.name("xml");
+node.name("node");
+text.name("text");
+start_tag.name("start_tag");
+end_tag.name("end_tag");
+</pre>
+<a name="spirit.qi.tutorials.mini_xml___error_handling.on_error"></a><h5>
+<a name="id437443"></a>
+ <a href="mini_xml___error_handling.html#spirit.qi.tutorials.mini_xml___error_handling.on_error">On
+ Error</a>
+ </h5>
+
+ <tt class="computeroutput">on_error</tt> declares our error
+ handler:
+ 
+<pre class="programlisting">on_error<Action>(rule, handler)
+</pre>
+
+ This will specify what we will do when we get an error. We will print out
+ an error message using phoenix:
+ 
+<pre class="programlisting">on_error<fail>
+(
+ xml
+ , std::cout
+ << val("Error! Expecting ")
+ << _4 // what failed?
+ << val(" here: \"")
+ << construct<std::string>(_3, _2) // iterators to error-pos, end
+ << val("\"")
+ << std::endl
+);
+</pre>
+
+ we choose to <tt class="computeroutput">fail</tt> in our
+ example for the <tt class="computeroutput">Action</tt>:
+ Quit and fail. Return a no_match (false). It can be one of:
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <tt class="computeroutput">Action</tt>
+ </th>
+<th>
+ Description
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ fail
+ </td>
+<td>
+ Quit and fail. Return a no_match.
+ </td>
+</tr>
+<tr>
+<td>
+ retry
+ </td>
+<td>
+ Attempt error recovery, possibly moving the iterator position.
+ </td>
+</tr>
+<tr>
+<td>
+ accept
+ </td>
+<td>
+ Force success, moving the iterator position appropriately.
+ </td>
+</tr>
+<tr>
+<td>
+ rethrow
+ </td>
+<td>
+ Rethrows the error.
+ </td>
+</tr>
+</tbody>
+</table></div>
+
+ <tt class="computeroutput">rule</tt> is the rule we attach
+ the handler to. In our case, we are attaching to the <tt class="computeroutput">xml</tt>
+ rule.
+ 
+
+ <tt class="computeroutput">handler</tt> is the actual error
+ handling function. It expects 4 arguments:
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Arg
+ </th>
+<th>
+ Description
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ first
+ </td>
+<td>
+ The position of the iterator when the rule with the handler was
+ entered.
+ </td>
+</tr>
+<tr>
+<td>
+ last
+ </td>
+<td>
+ The end of input.
+ </td>
+</tr>
+<tr>
+<td>
+ error-pos
+ </td>
+<td>
+ The actual position of the iterator where the error occurred.
+ </td>
+</tr>
+<tr>
+<td>
+ what
+ </td>
+<td>
+ What failed: a string decribing the failure.
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="spirit.qi.tutorials.mini_xml___error_handling.expectation_points"></a><h5>
+<a name="id438113"></a>
+ <a href="mini_xml___error_handling.html#spirit.qi.tutorials.mini_xml___error_handling.expectation_points">Expectation
+ Points</a>
+ </h5>
+
+ You might not have noticed it, but some of our expressions changed from
+ using the <tt class="computeroutput">>></tt> to <tt class="computeroutput">></tt>. Look, for example:
+ 
+<pre class="programlisting">end_tag =
+ "</"
+ > lit(_r1)
+ > '>'
+;
+</pre>
+
+ What is it? It's the expectation operator. You will
+ have some "deterministic points" in the grammar. Those are the
+ places where backtracking cannot occur.
+ For our example above, when you get a <tt class="computeroutput">"</"</tt>,
+ you definitely must see a valid end-tag label next. It should be the one
+ you got from the start-tag. After that, you definitely must have a <tt class="computeroutput">'>'</tt> next. Otherwise, there is no point in
+ proceeding forward and trying other branches, regardless where they are.
+ The input is definitely erroneous. When this happens, an expectation_failure
+ exception is thrown. Somewhere outward, the error handler will catch the
+ exception.
+ 
+
+ Try building the parser: ../../example/qi/mini_xml2.cpp.
+ You can find some examples in: ../../example/qi/mini_xml_samples
+ for testing purposes. "4.toyxml" has an error in it:
+ 
+<pre class="programlisting"><foo><bar></foo></bar>
+</pre>
+
+ Running the example with this gives you:
+ 
+<pre class="programlisting">Error! Expecting "bar" here: "foo></bar>"
+Error! Expecting end_tag here: "<bar></foo></bar>"
+-------------------------
+Parsing failed
+-------------------------
+</pre>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2001-2009 Joel
+ de Guzman, 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="mini_xml___asts_.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorials.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../quick_reference.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/qi/tutorials/number_list___stuffing_numbers_into_a_std__vector.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/qi/tutorials/number_list___stuffing_numbers_into_a_std__vector.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -0,0 +1,111 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Number
+ List - stuffing numbers into a std::vector</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
+<link rel="home" href="../../../index.html" title="Spirit 2.1">
+<link rel="up" href="../tutorials.html" title="Tutorials">
+<link rel="previous" href="sum___adding_numbers.html" title="Sum - adding
+ numbers">
+<link rel="next" href="number_list_redux___list_syntax.html" title="Number
+ List Redux - list syntax">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="sum___adding_numbers.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorials.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="number_list_redux___list_syntax.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h4 class="title">
+<a name="spirit.qi.tutorials.number_list___stuffing_numbers_into_a_std__vector"></a><a href="number_list___stuffing_numbers_into_a_std__vector.html" title="Number
+ List - stuffing numbers into a std::vector">Number
+ List - stuffing numbers into a std::vector</a>
+</h4></div></div>
+<div></div>
+</div>
+
+ This sample demontrates a parser for a comma separated list of numbers.
+ The numbers are inserted in a vector using phoenix.
+ 
+
+ 
+
+
+
+<pre class="programlisting">template <typename Iterator>
+bool parse_numbers(Iterator first, Iterator last, std::vector<double>& v)
+{
+ using qi::double_;
+ using qi::phrase_parse;
+ using qi::_1;
+ using ascii::space;
+ using phoenix::push_back;
+ using phoenix::ref;
+
+ bool r = phrase_parse(first, last,
+
+ // Begin grammar
+ (
+ double_[push_back(ref(v), _1)]
+ >> *(',' >> double_[push_back(ref(v), _1)])
+ )
+ ,
+ // End grammar
+
+ space);
+
+ if (first != last) // fail if we did not get a full match
+ return false;
+ return r;
+}
+</pre>
+
+ 
+
+ 
+
+ The full cpp file for this example can be found here: ../../example/qi/num_list2.cpp
+ 
+
+ This, again, is the same parser as before. This time, instead of summing
+ up the numbers, we stuff them in a <tt class="computeroutput">std::vector</tt>.
+ <tt class="computeroutput">push_back</tt> is supplied by
+ Phoenix. The expression:
+ 
+<pre class="programlisting">push_back(ref(v), _1)
+</pre>
+
+ appends the parsed number. Like before, <tt class="computeroutput">_1</tt>
+ is a Phoenix placeholder
+ for the parsed result attribute. Also, like before, <tt class="computeroutput">ref(v)</tt>
+ tells Phoenix that
+ <tt class="computeroutput">v</tt>, the <tt class="computeroutput">std::vector</tt>,
+ is a mutable reference.
+ 
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2001-2009 Joel
+ de Guzman, 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="sum___adding_numbers.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorials.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="number_list_redux___list_syntax.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/qi/tutorials/number_list_attribute___one_more__with_style.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/qi/tutorials/number_list_attribute___one_more__with_style.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -0,0 +1,136 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Number
+ List Attribute - one more, with style</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
+<link rel="home" href="../../../index.html" title="Spirit 2.1">
+<link rel="up" href="../tutorials.html" title="Tutorials">
+<link rel="previous" href="number_list_redux___list_syntax.html" title="Number
+ List Redux - list syntax">
+<link rel="next" href="roman_numerals.html" title="Roman Numerals">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="number_list_redux___list_syntax.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorials.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="roman_numerals.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h4 class="title">
+<a name="spirit.qi.tutorials.number_list_attribute___one_more__with_style"></a><a href="number_list_attribute___one_more__with_style.html" title="Number
+ List Attribute - one more, with style">Number
+ List Attribute - one more, with style</a>
+</h4></div></div>
+<div></div>
+</div>
+
+ You've seen that the <tt class="computeroutput">double_</tt>
+ parser has a <tt class="computeroutput">double</tt> attribute.
+ All parsers have an attribute, even complex parsers, those that are composed
+ from primitives using operators, like the list parser, also have an attribute.
+ It so happens that the the attribute of a list parser:
+ 
+<pre class="programlisting">p % d
+</pre>
+
+ is a <tt class="computeroutput">std::vector</tt> of the attribute of <tt class="computeroutput">p</tt>. So, for our parser:
+ 
+<pre class="programlisting">double_ % ','
+</pre>
+
+ we'll have an attribute of:
+ 
+<pre class="programlisting">std::vector<double>
+</pre>
+
+ So, what does this give us? Well, we can simply pass in a <tt class="computeroutput">std::vector<double></tt>
+ to our number list parser and it will happily churn out our result in our
+ vector. For that to happen, we'll use a variation of the <tt class="computeroutput">phrase_parse</tt> with an additional argument:
+ the parser's attribute:
+ 
+<div class="orderedlist"><ol type="1">
+<li>
+ An iterator pointing to the start of the input
+ </li>
+<li>
+ An iterator pointing to one past the end of the input
+ </li>
+<li>
+ The parser object
+ </li>
+<li>
+ The parser's attribute
+ </li>
+<li>
+ Another parser called the skip parser
+ </li>
+</ol></div>
+
+ So, our parser now is further simplified to:
+ 
+
+ 
+
+
+
+<pre class="programlisting">template <typename Iterator>
+bool parse_numbers(Iterator first, Iterator last, std::vector<double>& v)
+{
+ using qi::double_;
+ using qi::phrase_parse;
+ using qi::_1;
+ using ascii::space;
+
+ bool r = phrase_parse(first, last,
+
+ // Begin grammar
+ (
+ double_ % ','
+ )
+ ,
+ // End grammar
+
+ space, v);
+
+ if (first != last) // fail if we did not get a full match
+ return false;
+ return r;
+}
+</pre>
+
+ 
+
+ 
+
+ The full cpp file for this example can be found here: ../../example/qi/num_list4.cpp
+ 
+
+ Hey, no more actions!!! Now we're entering
+ the realm of attribute grammars. Cool eh?
+ 
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2001-2009 Joel
+ de Guzman, 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="number_list_redux___list_syntax.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorials.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="roman_numerals.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/qi/tutorials/number_list_redux___list_syntax.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/qi/tutorials/number_list_redux___list_syntax.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -0,0 +1,109 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Number
+ List Redux - list syntax</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
+<link rel="home" href="../../../index.html" title="Spirit 2.1">
+<link rel="up" href="../tutorials.html" title="Tutorials">
+<link rel="previous" href="number_list___stuffing_numbers_into_a_std__vector.html" title="Number
+ List - stuffing numbers into a std::vector">
+<link rel="next" href="number_list_attribute___one_more__with_style.html" title="Number
+ List Attribute - one more, with style">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="number_list___stuffing_numbers_into_a_std__vector.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorials.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="number_list_attribute___one_more__with_style.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h4 class="title">
+<a name="spirit.qi.tutorials.number_list_redux___list_syntax"></a><a href="number_list_redux___list_syntax.html" title="Number
+ List Redux - list syntax">Number
+ List Redux - list syntax</a>
+</h4></div></div>
+<div></div>
+</div>
+
+ So far, we've been using the syntax:
+ 
+<pre class="programlisting">double_ >> *(',' >> double_)
+</pre>
+
+ to parse a comma-delimited list of numbers. Such lists are common in parsing
+ and Spirit provides a simpler shortcut for them. The expression above can
+ be simplified to:
+ 
+<pre class="programlisting">double_ % ','
+</pre>
+
+ read as: a list of doubles separated by <tt class="computeroutput">','</tt>.
+ 
+
+ This sample, again a variation of our previous example, demonstrates just
+ that:
+ 
+
+ 
+
+
+
+<pre class="programlisting">template <typename Iterator>
+bool parse_numbers(Iterator first, Iterator last, std::vector<double>& v)
+{
+ using qi::double_;
+ using qi::phrase_parse;
+ using qi::_1;
+ using ascii::space;
+ using phoenix::push_back;
+ using phoenix::ref;
+
+ bool r = phrase_parse(first, last,
+
+ // Begin grammar
+ (
+ double_[push_back(ref(v), _1)] % ','
+ )
+ ,
+ // End grammar
+
+ space);
+
+ if (first != last) // fail if we did not get a full match
+ return false;
+ return r;
+}
+</pre>
+
+ 
+
+ 
+
+ The full cpp file for this example can be found here: ../../example/qi/num_list3.cpp
+ 
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2001-2009 Joel
+ de Guzman, 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="number_list___stuffing_numbers_into_a_std__vector.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorials.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="number_list_attribute___one_more__with_style.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/qi/tutorials/quick_start.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/qi/tutorials/quick_start.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -0,0 +1,86 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Quick Start</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
+<link rel="home" href="../../../index.html" title="Spirit 2.1">
+<link rel="up" href="../tutorials.html" title="Tutorials">
+<link rel="previous" href="../tutorials.html" title="Tutorials">
+<link rel="next" href="warming_up.html" title="Warming up">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../tutorials.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorials.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="warming_up.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h4 class="title">
+<a name="spirit.qi.tutorials.quick_start"></a>Quick Start
+</h4></div></div>
+<div></div>
+</div>
+<a name="spirit.qi.tutorials.quick_start.why_would_you_want_to_use_spirit_qi_"></a><h5>
+<a name="id415562"></a>
+ <a href="quick_start.html#spirit.qi.tutorials.quick_start.why_would_you_want_to_use_spirit_qi_">Why
+ would you want to use Spirit.Qi?</a>
+ </h5>
+
+ Spirit.Qi is designed to be a practical parsing tool. The ability to generate
+ a fully-working parser from a formal EBNF specification inlined in C++
+ significantly reduces development time. Programmers typically approach
+ parsing using ad hoc hacks with primitive tools such as scanf. Even regular-expression
+ libraries (such as boost regex) or scanners (such as Boost tokenizer) do
+ not scale well when we need to write more elaborate parsers. Attempting
+ to write even a moderately-complex parser using these tools leads to code
+ that is hard to understand and maintain.
+ 
+
+ One prime objective is to make the tool easy to use. When one thinks of
+ a parser generator, the usual reaction is "it must be big and complex
+ with a steep learning curve." Not so. Spirit is designed to be fully
+ scalable. The framework is structured in layers. This permits learning
+ on an as-needed basis, after only learning the minimal core and basic concepts.
+ 
+
+ For development simplicity and ease in deployment, the entire framework
+ consists of only header files, with no libraries to link against or build.
+ Just put the spirit distribution in your include path, compile and run.
+ Code size? -very tight -essentially comparable to hand written recursive
+ descent code.
+ 
+
+ Our tutorials will walk you through the simplest Spirit examples, incrementally
+ building on top of the earlier examples as we expose more and more features
+ and techniques. We will try to be as gentle as possible with the learning
+ curve. We will present the tutorials in a cookbook style approach. This
+ style of presentation is based on our BoostCon '07 and BoostCon '08 slides.
+ 
+
+ Have fun!
+ 
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2001-2009 Joel
+ de Guzman, 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../tutorials.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorials.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="warming_up.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/qi/tutorials/roman_numerals.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/qi/tutorials/roman_numerals.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -0,0 +1,423 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Roman Numerals</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
+<link rel="home" href="../../../index.html" title="Spirit 2.1">
+<link rel="up" href="../tutorials.html" title="Tutorials">
+<link rel="previous" href="number_list_attribute___one_more__with_style.html" title="Number
+ List Attribute - one more, with style">
+<link rel="next" href="employee___parsing_into_structs.html" title="Employee
+ - Parsing into structs">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="number_list_attribute___one_more__with_style.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorials.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="employee___parsing_into_structs.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h4 class="title">
+<a name="spirit.qi.tutorials.roman_numerals"></a>Roman Numerals
+</h4></div></div>
+<div></div>
+</div>
+
+ This example demonstrates:
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ symbol table
+ </li>
+<li>
+ rule
+ </li>
+<li>
+ grammar
+ </li>
+</ul></div>
+<a name="spirit.qi.tutorials.roman_numerals.symbol_table"></a><h5>
+<a name="id423543"></a>
+ <a href="roman_numerals.html#spirit.qi.tutorials.roman_numerals.symbol_table">Symbol
+ Table</a>
+ </h5>
+
+ The symbol table holds a dictionary of symbols where each symbol is a sequence
+ of characters (a <tt class="computeroutput">char</tt>, <tt class="computeroutput">wchar_t</tt>, <tt class="computeroutput">int</tt>,
+ enumeration etc.) . The template class, parameterized by the character
+ type, can work efficiently with 8, 16, 32 and even 64 bit characters. Mutable
+ data of type T is associated with each symbol.
+ 
+
+ Traditionally, symbol table management is maintained seperately outside
+ the BNF grammar through semantic actions. Contrary to standard practice,
+ the Spirit symbol table class symbols is-a parser. An object of which may
+ be used anywhere in the EBNF grammar specification. It is an example of
+ a dynamic parser. A dynamic parser is characterized by its ability to modify
+ its behavior at run time. Initially, an empty symbols object matches nothing.
+ At any time, symbols may be added or removed, thus, dynamically altering
+ its behavior.
+ 
+
+ Each entry in a symbol table has an associated mutable data slot. In this
+ regard, one can view the symbol table as an associative container (or map)
+ of key-value pairs where the keys are strings.
+ 
+
+ The symbols class expects two template parameters. The first parameter
+ specifies the character type of the symbols. The second specifies the data
+ type associated with each symbol: its attribute.
+ 
+
+ Here's a parser for roman hundreds (100..900) using the symbol table. Keep
+ in mind that the data associated with each slot is the parser's attribute
+ (which is passed to attached semantic actions).
+ 
+
+ 
+
+
+
+<pre class="programlisting">struct hundreds_ : qi::symbols<char, unsigned>
+{
+ hundreds_()
+ {
+ add
+ ("C" , 100)
+ ("CC" , 200)
+ ("CCC" , 300)
+ ("CD" , 400)
+ ("D" , 500)
+ ("DC" , 600)
+ ("DCC" , 700)
+ ("DCCC" , 800)
+ ("CM" , 900)
+ ;
+ }
+
+} hundreds;
+</pre>
+
+ 
+
+ 
+
+ Here's a parser for roman tens (10..90):
+ 
+
+ 
+
+
+
+<pre class="programlisting">struct tens_ : qi::symbols<char, unsigned>
+{
+ tens_()
+ {
+ add
+ ("X" , 10)
+ ("XX" , 20)
+ ("XXX" , 30)
+ ("XL" , 40)
+ ("L" , 50)
+ ("LX" , 60)
+ ("LXX" , 70)
+ ("LXXX" , 80)
+ ("XC" , 90)
+ ;
+ }
+
+} tens;
+</pre>
+
+ 
+
+ 
+
+ and, finally, for ones (1..9):
+ 
+
+ 
+
+
+
+<pre class="programlisting">struct ones_ : qi::symbols<char, unsigned>
+{
+ ones_()
+ {
+ add
+ ("I" , 1)
+ ("II" , 2)
+ ("III" , 3)
+ ("IV" , 4)
+ ("V" , 5)
+ ("VI" , 6)
+ ("VII" , 7)
+ ("VIII" , 8)
+ ("IX" , 9)
+ ;
+ }
+
+} ones;
+</pre>
+
+ 
+
+ 
+
+ Now we can use <tt class="computeroutput">hundreds</tt>,
+ <tt class="computeroutput">tens</tt> and <tt class="computeroutput">ones</tt> anywhere in our parser expressions.
+ They are all parsers.
+ 
+<a name="spirit.qi.tutorials.roman_numerals.rules"></a><h5>
+<a name="id424857"></a>
+ Rules
+ </h5>
+
+ Up until now, we've been inlining our parser expressions, passing them
+ directly to the <tt class="computeroutput">phrase_parse</tt>
+ function. The expression evaluates into a temporary, unnamed parser which
+ is passed into the <tt class="computeroutput">phrase_parse</tt>
+ function, used, and then destroyed. This is fine for small parsers. When
+ the expressions get complicated, you'd want to break the expressions into
+ smaller easier to understand pieces, name them, and refer to them from
+ other parser expressions by name.
+ 
+
+ A parser expression can be assigned to, what is called, a "rule".
+ There are various ways to declare rules. The simplest form is:
+ 
+<pre class="programlisting">rule<Iterator> r;
+</pre>
+
+ At the very least, the rule needs to know the iterator type it will be
+ working on. This rule cannot be used with <tt class="computeroutput">phrase_parse</tt>.
+ It can only be used with the <tt class="computeroutput">parse</tt>
+ function -- a version that does not do white space skipping (does not have
+ the skipper argument). If you want to have it skip white spaces, you need
+ to pass in the type skip parser, as in the next form:
+ 
+<pre class="programlisting">rule<Iterator, Skipper> r;
+</pre>
+
+ Example:
+ 
+<pre class="programlisting">rule<std::string::iterator, space_type> r;
+</pre>
+
+ This type of rule can be used for both <tt class="computeroutput">phrase_parse</tt>
+ and <tt class="computeroutput">parse</tt>.
+ 
+
+ For our next example, there's one more rule form you should know about:
+ 
+<pre class="programlisting">rule<Iterator, Signature> r;
+</pre>
+
+ or
+ 
+<pre class="programlisting">rule<Iterator, Signature, Skipper> r;
+</pre>
+<div class="tip"><table border="0" summary="Tip">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="../../../images/tip.png"></td>
+<th align="left">Tip</th>
+</tr>
+<tr><td colspan="2" align="left" valign="top">
+ All rule template arguments after Iterator can be supplied in any order.
+ </td></tr>
+</table></div>
+
+ The Signature specifies the attributes of the rule. You've seen that our
+ parsers can have an attribute. Recall that the <tt class="computeroutput">double_</tt>
+ parser has an attribute of <tt class="computeroutput">double</tt>.
+ To be precise, these are synthesized attributes. The
+ parser "synthesizes" the attribute value. Think of them as function
+ return values.
+ 
+
+ There's another type of attribute called "inherited" attribute.
+ We won't need them for now, but it's good that you be aware of such attributes.
+ You can think of them as function arguments. And, rightly so, the rule
+ signature is a function signature of the form:
+ 
+<pre class="programlisting">result(argN, argN,..., argN)
+</pre>
+
+ After having declared a rule, you can now assign any parser expression
+ to it. Example:
+ 
+<pre class="programlisting">r = double_ >> *(',' >> double_);
+</pre>
+<a name="spirit.qi.tutorials.roman_numerals.grammars"></a><h5>
+<a name="id425438"></a>
+ Grammars
+ </h5>
+
+ A grammar encapsulates one or more rules. It has the same template parameters
+ as the rule. You declare a grammar by:
+ 
+<div class="orderedlist"><ol type="1">
+<li>
+ deriving a struct (or class) from the <tt class="computeroutput">grammar</tt>
+ class template
+ </li>
+<li>
+ declare one or more rules as member variables
+ </li>
+<li>
+ initialize the base grammar class by giving it the start rule (its the
+ first rule that gets called when the grammar starts parsing)
+ </li>
+<li>
+ initialize your rules in your constructor
+ </li>
+</ol></div>
+
+ The roman numeral grammar is a very nice and simple example of a grammar:
+ 
+
+ 
+
+
+
+<pre class="programlisting">template <typename Iterator>
+struct roman : qi::grammar<Iterator, unsigned()>
+{
+ roman() : roman::base_type(start)
+ {
+ using qi::eps;
+ using qi::lit;
+ using qi::_val;
+ using qi::_1;
+ using ascii::char_;
+
+ start = eps [_val = 0] >>
+ (
+ +lit('M') [_val += 1000]
+ || hundreds [_val += _1]
+ || tens [_val += _1]
+ || ones [_val += _1]
+ )
+ ;
+ }
+
+ qi::rule<Iterator, unsigned()> start;
+};
+</pre>
+
+ 
+
+ 
+
+ Things to take notice of:
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ The grammar and start rule signature is <tt class="computeroutput">unsigned()</tt>. It has a synthesized attribute (return
+ value) of type <tt class="computeroutput">unsigned</tt>
+ with no inherited attributes (arguments).
+ </li>
+<li>
+ We did not specify a skip-parser. We don't want to skip in between the
+ numerals.
+ </li>
+<li>
+<tt class="computeroutput">roman::base_type</tt> is a typedef for <tt class="computeroutput">grammar<Iterator,
+ unsigned()></tt>.
+ If <tt class="computeroutput">roman</tt> was not a template,
+ you can simply write: base_type(start)
+ </li>
+<li>
+ But it's best to make your grammar templates, so that they can be reused
+ for different iterator types.
+ </li>
+<li>
+<tt class="computeroutput">_val</tt> is another Phoenix placeholder representing
+ the rule's synthesized attribute.
+ </li>
+<li>
+<tt class="computeroutput">eps</tt> is a special spirit
+ parser that consumes no input but is always successful. We use it to
+ initialize <tt class="computeroutput">_val</tt>, the
+ rule's synthesized attribute, to zero before anything else. The actual
+ parser starts at <tt class="computeroutput">+char_('M')</tt>,
+ parsing roman thousands. Using <tt class="computeroutput">eps</tt>
+ this way is good for doing pre and post initializations.
+ </li>
+<li>
+ The expression <tt class="computeroutput">a ||
+ b</tt> reads: match a or b and in
+ sequence. That is, if both <tt class="computeroutput">a</tt>
+ and <tt class="computeroutput">b</tt> match, it must
+ be in sequence; this is equivalent to <tt class="computeroutput">a
+ >> -b | b</tt>, but more efficient.
+ </li>
+</ul></div>
+<a name="spirit.qi.tutorials.roman_numerals.let_s_parse_"></a><h5>
+<a name="id426455"></a>
+ Let's Parse!
+ </h5>
+
+ 
+
+
+
+<pre class="programlisting">bool r = parse(iter, end, roman_parser, result);
+
+if (r && iter == end)
+{
+ std::cout << "-------------------------\n";
+ std::cout << "Parsing succeeded\n";
+ std::cout << "result = " << result << std::endl;
+ std::cout << "-------------------------\n";
+}
+else
+{
+ std::string rest(iter, end);
+ std::cout << "-------------------------\n";
+ std::cout << "Parsing failed\n";
+ std::cout << "stopped at: \": " << rest << "\"\n";
+ std::cout << "-------------------------\n";
+}
+</pre>
+
+ 
+
+ 
+
+ <tt class="computeroutput">roman_parser</tt> is an object
+ of type <tt class="computeroutput">roman</tt> -our roman
+ numeral parser. This time around, we are using the no-skipping version
+ of the parse functions. We do not want to skip any spaces! We are also
+ passing in an attribute, <tt class="computeroutput">unsigned
+ result</tt>, which will receive the
+ parsed value.
+ 
+
+ The full cpp file for this example can be found here: ../../example/qi/roman.cpp
+ 
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2001-2009 Joel
+ de Guzman, 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="number_list_attribute___one_more__with_style.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorials.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="employee___parsing_into_structs.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/qi/tutorials/semantic_actions.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/qi/tutorials/semantic_actions.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -0,0 +1,267 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Semantic Actions</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
+<link rel="home" href="../../../index.html" title="Spirit 2.1">
+<link rel="up" href="../tutorials.html" title="Tutorials">
+<link rel="previous" href="warming_up.html" title="Warming up">
+<link rel="next" href="complex___our_first_complex_parser.html" title="Complex
+ - Our first complex parser">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="warming_up.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorials.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="complex___our_first_complex_parser.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h4 class="title">
+<a name="spirit.qi.tutorials.semantic_actions"></a>Semantic Actions
+</h4></div></div>
+<div></div>
+</div>
+
+ Our parser above is really nothing but a recognizer. It answers the question
+ "did the input match our grammar?", but it does not do anything
+ other than that. It does not extract any information from what was parsed.
+ For example, whenever we parse a real number, we wish to store the parsed
+ number after a successful match.
+ 
+
+ Enter Semantic actions. Semantic actions may be attached to any point in
+ the grammar specification. These actions are C++ functions or function
+ objects that are called whenever a part of the parser successfully recognizes
+ a portion of the input. Say you have a parser <tt class="computeroutput">P</tt>,
+ and a C++ function <tt class="computeroutput">F</tt>, you
+ can make the parser call <tt class="computeroutput">F</tt>
+ whenever it matches an input by attaching <tt class="computeroutput">F</tt>:
+ 
+<pre class="programlisting">P[F]
+</pre>
+
+ The expression above links <tt class="computeroutput">F</tt>
+ to the parser, <tt class="computeroutput">P</tt>.
+ 
+
+ The function/function object signature depends on the type of the parser
+ to which it is attached. The parser <tt class="computeroutput">double_</tt>
+ passes the parsed number. Thus, if we were to attach a function <tt class="computeroutput">F</tt> to <tt class="computeroutput">double_</tt>,
+ we need <tt class="computeroutput">F</tt> to be declared
+ as:
+ 
+<pre class="programlisting">void F(double n);
+</pre>
+
+ There are actually 2 more arguments being passed (the parser context and
+ a reference to a boolean 'hit' parameter). We don't need these, for now,
+ but we'll see more on these other arguments later. Spirit.Qi allows us
+ to bind a single argument function, like above. The other arguments are
+ simply ignored.
+ 
+
+ Presented are various ways to attach semantic actions:
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ Using plain function pointer
+ </li>
+<li>
+ Using simple function object
+ </li>
+<li>
+ Using Boost.Bind
+ with a plain function
+ </li>
+<li>
+ Using Boost.Bind
+ with a member function
+ </li>
+<li>
+ Using Boost.Lambda
+</li>
+</ul></div>
+
+ Given:
+ 
+
+ 
+
+
+
+<pre class="programlisting">namespace client
+{
+ namespace qi = boost::spirit::qi;
+
+ // A plain function
+ void print(int const& i)
+ {
+ std::cout << i << std::endl;
+ }
+
+ // A member function
+ struct writer
+ {
+ void print(int const& i) const
+ {
+ std::cout << i << std::endl;
+ }
+ };
+
+ // A function object
+ struct print_action
+ {
+ void operator()(int const& i, qi::unused_type, qi::unused_type) const
+ {
+ std::cout << i << std::endl;
+ }
+ };
+}
+</pre>
+
+ 
+
+ 
+
+ Take note that with function objects, we need to have an <tt class="computeroutput">operator()</tt>
+ with 3 arguments. Since we don't care about the other two, we can use
+ <tt class="computeroutput">unused_type</tt> for these.
+ We'll see more of <tt class="computeroutput">unused_type</tt>
+ elsewhere. Get used to it. <tt class="computeroutput">unused_type</tt>
+ is a Spirit supplied support class.
+ 
+
+ All examples parse inputs of the form:
+ 
+<pre class="programlisting">"{integer}"
+</pre>
+
+ An integer inside the curly braces.
+ 
+
+ The first example shows how to attach a plain function:
+ 
+
+ 
+
+
+
+<pre class="programlisting">parse(first, last, '{' >> int_[&print] >> '}');
+</pre>
+
+ 
+
+ 
+
+ What's new? Well <tt class="computeroutput">int_</tt> is
+ the sibbling of <tt class="computeroutput">double_</tt>.
+ I'm sure you can guess what this parser does.
+ 
+
+ The next example shows how to attach a simple function object:
+ 
+
+ 
+
+
+
+<pre class="programlisting">parse(first, last, '{' >> int_[print_action()] >> '}');
+</pre>
+
+ 
+
+ 
+
+ We can use Boost.Bind
+ to 'bind' member functions:
+ 
+
+ 
+
+
+
+<pre class="programlisting">writer w;
+parse(first, last, '{' >> int_[boost::bind(&writer::print, &w, _1)] >> '}');
+</pre>
+
+ 
+
+ 
+
+ Likewise, we can also use Boost.Bind
+ to 'bind' plain functions:
+ 
+
+ 
+
+
+
+<pre class="programlisting">parse(first, last, '{' >> int_[boost::bind(&print, _1)] >> '}');
+</pre>
+
+ 
+
+ 
+
+ Yep, we can also use Boost.Lambda:
+ 
+
+ 
+
+
+
+<pre class="programlisting">parse(first, last, '{' >> int_[std::cout << _1 << '\n'] >> '}');
+</pre>
+
+ 
+
+ 
+
+ There are more ways to bind semantic action functions, but the examples
+ above are the most common. Attaching semantic actions is the first hurdle
+ one has to tackle when getting started with parsing with Spirit. Familiarize
+ yourself with this task and get intimate with the tools behind it such
+ as Boost.Bind
+ and Boost.Lambda.
+ 
+
+ The examples above can be found here: ../../example/qi/actions.cpp
+ 
+<a name="spirit.qi.tutorials.semantic_actions.phoenix"></a><h5>
+<a name="id418498"></a>
+ Phoenix
+ </h5>
+
+ Phoenix, a companion
+ library bundled with Spirit, is specifically suited for binding semantic
+ actions. It is like Boost.Lambda
+ in steroids, with special custom features that make it easy to integrate
+ semantic actions with Spirit. If your requirements go beyond simple to
+ moderate parsing, I suggest you use this library. Examples presented henceforth
+ shall be using the library exclusively
+ 
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2001-2009 Joel
+ de Guzman, 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="warming_up.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorials.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="complex___our_first_complex_parser.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/qi/tutorials/sum___adding_numbers.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/qi/tutorials/sum___adding_numbers.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -0,0 +1,233 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Sum - adding
+ numbers</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
+<link rel="home" href="../../../index.html" title="Spirit 2.1">
+<link rel="up" href="../tutorials.html" title="Tutorials">
+<link rel="previous" href="complex___our_first_complex_parser.html" title="Complex
+ - Our first complex parser">
+<link rel="next" href="number_list___stuffing_numbers_into_a_std__vector.html" title="Number
+ List - stuffing numbers into a std::vector">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="complex___our_first_complex_parser.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorials.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="number_list___stuffing_numbers_into_a_std__vector.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h4 class="title">
+<a name="spirit.qi.tutorials.sum___adding_numbers"></a><a href="sum___adding_numbers.html" title="Sum - adding
+ numbers">Sum - adding
+ numbers</a>
+</h4></div></div>
+<div></div>
+</div>
+
+ Here's a parser that sums a comma-separated list of numbers.
+ 
+
+ Ok we've glossed over some details in our previous examples. First, our
+ includes:
+ 
+
+ 
+
+
+
+<pre class="programlisting">#include <boost/spirit/include/qi.hpp>
+#include <boost/spirit/include/phoenix_core.hpp>
+#include <boost/spirit/include/phoenix_operator.hpp>
+#include <iostream>
+#include <string>
+</pre>
+
+ 
+
+ 
+
+ Then some using directives:
+ 
+
+ 
+
+
+
+<pre class="programlisting">namespace qi = boost::spirit::qi;
+namespace ascii = boost::spirit::ascii;
+namespace phoenix = boost::phoenix;
+
+using qi::double_;
+using qi::_1;
+using ascii::space;
+using phoenix::ref;
+</pre>
+
+ 
+
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Namespace
+ </th>
+<th>
+ Description
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ boost::phoenix
+ </td>
+<td>
+ All of phoenix
+ </td>
+</tr>
+<tr>
+<td>
+ boost::spirit
+ </td>
+<td>
+ All of spirit
+ </td>
+</tr>
+<tr>
+<td>
+ boost::spirit::qi
+ </td>
+<td>
+ All of spirit.qi
+ </td>
+</tr>
+<tr>
+<td>
+ boost::spirit::ascii
+ </td>
+<td>
+ ASCII version of <tt class="computeroutput">char_</tt>
+ and all char related parsers. Other encodings are also provided
+ (e.g. also an ISO8859.1)
+ </td>
+</tr>
+<tr>
+<td>
+ boost::spirit::arg_names
+ </td>
+<td>
+ Special phoenix placeholders for spirit
+ </td>
+</tr>
+</tbody>
+</table></div>
+<div class="note"><table border="0" summary="Note">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../images/note.png"></td>
+<th align="left">Note</th>
+</tr>
+<tr><td colspan="2" align="left" valign="top">
+ If you feel uneasy with using whole namespaces, feel free to qualify
+ your code, use namespace aliases, etc. For the purpose of this tutorial,
+ we will be presenting unqualified names for both Spirit and Phoenix.
+ No worries, we will always present the full working code, so you won't
+ get lost. In fact, all examples in this tutorial have a corresponding
+ cpp file that QuickBook (the documentation tool we are using) imports
+ in here as code snippets.
+ </td></tr>
+</table></div>
+
+ Now the actual parser:
+ 
+
+ 
+
+
+
+<pre class="programlisting">template <typename Iterator>
+bool adder(Iterator first, Iterator last, double& n)
+{
+ bool r = qi::phrase_parse(first, last,
+
+ // Begin grammar
+ (
+ double_[ref(n) = _1] >> *(',' >> double_[ref(n) += _1])
+ )
+ ,
+ // End grammar
+
+ space);
+
+ if (first != last) // fail if we did not get a full match
+ return false;
+ return r;
+}
+</pre>
+
+ 
+
+ 
+
+ The full cpp file for this example can be found here: ../../example/qi/sum.cpp
+ 
+
+ This is almost like our original numbers list example. We're incrementally
+ building on top of our examples. This time though, like in the complex
+ number example, we'll be adding the smarts. There's an accumulator (`double&
+ n) that adds the numbers parsed. On a successful parse, this number is
+ the sum of all the parsed numbers.
+ 
+
+ The first <tt class="computeroutput">double_</tt> parser
+ attaches this action:
+ 
+<pre class="programlisting">ref(n) = _1
+</pre>
+
+ This assigns the parsed result (actually, the attribute of <tt class="computeroutput">double_</tt>) to <tt class="computeroutput">n</tt>.
+ <tt class="computeroutput">ref(n)</tt> tells
+ Phoenix that <tt class="computeroutput">n</tt> is a mutable reference. <tt class="computeroutput">_1</tt> is a Phoenix
+ placeholder for the parsed result attribute.
+ 
+
+ The second <tt class="computeroutput">double_</tt> parser
+ attaches this action:
+ 
+<pre class="programlisting">ref(n) += _1
+</pre>
+
+ So, subsequent numbers add into <tt class="computeroutput">n</tt>.
+ 
+
+ That wasn't too bad, was it :-) ?
+ 
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2001-2009 Joel
+ de Guzman, 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="complex___our_first_complex_parser.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorials.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="number_list___stuffing_numbers_into_a_std__vector.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/qi/tutorials/warming_up.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/qi/tutorials/warming_up.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -0,0 +1,302 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Warming up</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
+<link rel="home" href="../../../index.html" title="Spirit 2.1">
+<link rel="up" href="../tutorials.html" title="Tutorials">
+<link rel="previous" href="quick_start.html" title="Quick Start">
+<link rel="next" href="semantic_actions.html" title="Semantic Actions">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="quick_start.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorials.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="semantic_actions.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h4 class="title">
+<a name="spirit.qi.tutorials.warming_up"></a>Warming up
+</h4></div></div>
+<div></div>
+</div>
+
+ We'll start by showing examples of parser expressions to give you a feel
+ on how to build parsers from the simplest parser, building up as we go.
+ 
+<a name="spirit.qi.tutorials.warming_up.trivial_example__1_parsing_a_number"></a><h5>
+<a name="id415635"></a>
+ <a href="warming_up.html#spirit.qi.tutorials.warming_up.trivial_example__1_parsing_a_number">Trivial
+ Example #1 Parsing a number</a>
+ </h5>
+
+ Create a parser that will parse a floating-point number.
+ 
+<pre class="programlisting">double_
+</pre>
+
+ (You've got to admit, that's trivial!) The above code actually generates
+ a Spirit floating point parser (a built-in parser). Spirit has many pre-defined
+ parsers and consistent naming conventions help you keep from going insane!
+ 
+<a name="spirit.qi.tutorials.warming_up.trivial_example__2_parsing_two_numbers"></a><h5>
+<a name="id415681"></a>
+ <a href="warming_up.html#spirit.qi.tutorials.warming_up.trivial_example__2_parsing_two_numbers">Trivial
+ Example #2 Parsing two numbers</a>
+ </h5>
+
+ Create a parser that will accept a line consisting of two floating-point
+ numbers.
+ 
+<pre class="programlisting">double_ >> double_
+</pre>
+
+ Here you see the familiar floating-point numeric parser <tt class="computeroutput">double_</tt>
+ used twice, once for each number. What's that <tt class="computeroutput">>></tt>
+ operator doing in there? Well, they had to be separated by something, and
+ this was chosen as the "followed by" sequence operator. The above
+ program creates a parser from two simpler parsers, glueing them together
+ with the sequence operator. The result is a parser that is a composition
+ of smaller parsers. Whitespace between numbers can implicitly be consumed
+ depending on how the parser is invoked (see below).
+ 
+<div class="note"><table border="0" summary="Note">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../images/note.png"></td>
+<th align="left">Note</th>
+</tr>
+<tr><td colspan="2" align="left" valign="top">
+ When we combine parsers, we end up with a "bigger" parser,
+ but it's still a parser. Parsers can get bigger and bigger, nesting more
+ and more, but whenever you glue two parsers together, you end up with
+ one bigger parser. This is an important concept.
+ </td></tr>
+</table></div>
+<a name="spirit.qi.tutorials.warming_up.trivial_example__3_parsing_one_or_more_numbers"></a><h5>
+<a name="id415769"></a>
+ <a href="warming_up.html#spirit.qi.tutorials.warming_up.trivial_example__3_parsing_one_or_more_numbers">Trivial
+ Example #3 Parsing one or more numbers</a>
+ </h5>
+
+ Create a parser that will accept zero or more floating-point numbers.
+ 
+<pre class="programlisting">*double_
+</pre>
+
+ This is like a regular-expression Kleene Star, though the syntax might
+ look a bit odd for a C++ programmer not used to seeing the <tt class="computeroutput">*</tt> operator overloaded like this. Actually,
+ if you know regular expressions it may look odd too since the star is before
+ the expression it modifies. C'est la vie. Blame it on the fact that we
+ must work with the syntax rules of C++.
+ 
+
+ Any expression that evaluates to a parser may be used with the Kleene Star.
+ Keep in mind, though, that due to C++ operator precedence rules you may
+ need to put the expression in parentheses for complex expressions. The
+ Kleene Star is also known as a Kleene Closure, but we call it the Star
+ in most places.
+ 
+<a name="spirit.qi.tutorials.warming_up.trivial_example__4_parsing_a_comma_delimited_list_of_numbers"></a><h5>
+<a name="id415845"></a>
+ <a href="warming_up.html#spirit.qi.tutorials.warming_up.trivial_example__4_parsing_a_comma_delimited_list_of_numbers">Trivial
+ Example #4 Parsing a comma-delimited list of numbers</a>
+ </h5>
+
+ This example will create a parser that accepts a comma-delimited list of
+ numbers.
+ 
+<pre class="programlisting">double_ >> *(char_(',') >> double_)
+</pre>
+
+ Notice <tt class="computeroutput">char_(',')</tt>. It is
+ a literal character parser that can recognize the comma <tt class="computeroutput">','</tt>.
+ In this case, the Kleene Star is modifying a more complex parser, namely,
+ the one generated by the expression:
+ 
+<pre class="programlisting">(char_(',') >> double_)
+</pre>
+
+ Note that this is a case where the parentheses are necessary. The Kleene
+ star encloses the complete expression above.
+ 
+<a name="spirit.qi.tutorials.warming_up.let_s_parse_"></a><h5>
+<a name="id416022"></a>
+ Let's Parse!
+ </h5>
+
+ We're done with defining the parser. So the next step is now invoking this
+ parser to do its work. There are a couple of ways to do this. For now,
+ we will use the <tt class="computeroutput">phrase_parse</tt>
+ function. One overload of this function accepts four arguments:
+ 
+<div class="orderedlist"><ol type="1">
+<li>
+ An iterator pointing to the start of the input
+ </li>
+<li>
+ An iterator pointing to one past the end of the input
+ </li>
+<li>
+ The parser object
+ </li>
+<li>
+ Another parser called the skip parser
+ </li>
+</ol></div>
+
+ In our example, we wish to skip spaces and tabs. Another parser named
+ <tt class="computeroutput">space</tt> is included in Spirit's
+ repertoire of predefined parsers. It is a very simple parser that simply
+ recognizes whitespace. We will use <tt class="computeroutput">space</tt>
+ as our skip parser. The skip parser is the one responsible for skipping
+ characters in between parser elements such as the <tt class="computeroutput">double_</tt>
+ and <tt class="computeroutput">char_</tt>.
+ 
+
+ Ok, so now let's parse!
+ 
+
+ 
+
+
+
+<pre class="programlisting">template <typename Iterator>
+bool parse_numbers(Iterator first, Iterator last)
+{
+ using qi::double_;
+ using qi::phrase_parse;
+ using ascii::space;
+
+ bool r = phrase_parse(
+ first, <a name="spirit0co" href="warming_up.html#spirit0"><img src="../../../../../../../doc/src/images/callouts/1.png" alt="1" border="0"></a>
+ last, <a name="spirit1co" href="warming_up.html#spirit1"><img src="../../../../../../../doc/src/images/callouts/2.png" alt="2" border="0"></a>
+ double_ >> *(',' >> double_), <a name="spirit2co" href="warming_up.html#spirit2"><img src="../../../../../../../doc/src/images/callouts/3.png" alt="3" border="0"></a>
+ space <a name="spirit3co" href="warming_up.html#spirit3"><img src="../../../../../../../doc/src/images/callouts/4.png" alt="4" border="0"></a>
+ );
+ if (first != last) // fail if we did not get a full match
+ return false;
+ return r;
+}
+</pre>
+
+ 
+
+ 
+
+ 
+<div class="calloutlist"><table border="0" summary="Callout list">
+<tr>
+<td width="5%" valign="top" align="left">
+<a name="spirit0"></a> </td>
+<td valign="top" align="left"> start iterator </td>
+</tr>
+<tr>
+<td width="5%" valign="top" align="left">
+<a name="spirit1"></a> </td>
+<td valign="top" align="left"> end iterator </td>
+</tr>
+<tr>
+<td width="5%" valign="top" align="left">
+<a name="spirit2"></a> </td>
+<td valign="top" align="left"> the parser </td>
+</tr>
+<tr>
+<td width="5%" valign="top" align="left">
+<a name="spirit3"></a> </td>
+<td valign="top" align="left"> the skip-parser </td>
+</tr>
+</table></div>
+
+ 
+
+ 
+
+ The parse function returns <tt class="computeroutput">true</tt>
+ or <tt class="computeroutput">false</tt> depending on the
+ result of the parse. The first iterator is passed by reference. On a successful
+ parse, this iterator is repositioned to the rightmost position consumed
+ by the parser. If this becomes equal to str.end(), then we have a full
+ match. If not, then we have a partial match. A partial match happens when
+ the parser is only able to parse a portion of the input.
+ 
+
+ Note that we inlined the parser directly in the call to parse. Upon calling
+ parse, the expression evaluates into a temporary, unnamed parser which
+ is passed into the parse() function, used, and then destroyed.
+ 
+
+ Here, we opted to make the parser generic by making it a template, parameterized
+ by the iterator type. By doing so, it can take in data coming from any
+ STL conforming sequence as long as the iterators conform to a forward iterator.
+ 
+
+ You can find the full cpp file here: ../../example/qi/num_list1.cpp
+ 
+<div class="note"><table border="0" summary="Note">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../images/note.png"></td>
+<th align="left">Note</th>
+</tr>
+<tr><td colspan="2" align="left" valign="top">
+
+ <tt class="computeroutput">char</tt> and <tt class="computeroutput">wchar_t</tt>
+ operands
+ 
+
+ The careful reader may notice that the parser expression has <tt class="computeroutput">','</tt> instead of <tt class="computeroutput">char_(',')</tt>
+ as the previous examples did. This is ok due to C++ syntax rules of conversion.
+ There are <tt class="computeroutput">>></tt> operators
+ that are overloaded to accept a <tt class="computeroutput">char</tt>
+ or <tt class="computeroutput">wchar_t</tt> argument on its
+ left or right (but not both). An operator may be overloaded if at least
+ one of its parameters is a user-defined type. In this case, the <tt class="computeroutput">double_</tt> is the 2nd argument to <tt class="computeroutput">operator>></tt>,
+ and so the proper overload of <tt class="computeroutput">>></tt>
+ is used, converting <tt class="computeroutput">','</tt> into
+ a character literal parser.
+ 
+
+ The problem with omiting the <tt class="computeroutput">char_</tt>
+ should be obvious: <tt class="computeroutput">'a' >>
+ 'b'</tt> is not a spirit parser, it is
+ a numeric expression, right-shifting the ASCII (or another encoding)
+ value of <tt class="computeroutput">'a'</tt> by the ASCII value
+ of <tt class="computeroutput">'b'</tt>. However, both <tt class="computeroutput">char_('a') >>
+ 'b'</tt> and <tt class="computeroutput">'a'
+ >> char_('b')</tt>
+ are Spirit sequence parsers for the letter <tt class="computeroutput">'a'</tt>
+ followed by <tt class="computeroutput">'b'</tt>. You'll get
+ used to it, sooner or later.
+ 
+</td></tr>
+</table></div>
+
+ Finally, take note that we test for a full match (i.e. the parser fully
+ parsed the input) by checking if the first iterator, after parsing, is
+ equal to the end iterator. You may strike out this part if partial matches
+ are to be allowed.
+ 
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2001-2009 Joel
+ de Guzman, 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="quick_start.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../tutorials.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="semantic_actions.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Modified: trunk/libs/spirit/doc/html/spirit/structure.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/structure.html (original)
+++ trunk/libs/spirit/doc/html/spirit/structure.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -7,7 +7,7 @@
<link rel="home" href="../index.html" title="Spirit 2.1">
<link rel="up" href="../index.html" title="Spirit 2.1">
<link rel="previous" href="introduction.html" title="Introduction">
-<link rel="next" href="abstracts.html" title="Abstracts">
+<link rel="next" href="structure/include.html" title="Include">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
@@ -20,7 +20,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="introduction.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="abstracts.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="introduction.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="structure/include.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage">
@@ -29,193 +29,7 @@
</h2></div></div>
<div></div>
</div>
-<div class="toc"><dl><dt>Include</dt></dl></div>
-<div class="section" lang="en">
-<div class="titlepage">
-<div><div><h3 class="title">
-<a name="spirit.structure.include"></a>Include
-</h3></div></div>
-<div></div>
-</div>
-
- Spirit is a header file only library. There are no libraries to link to.
- This section documents the structure of the Spirit headers.
- 
-
- Spirit contains five sub-libraries plus a 'support' module where common support
- classes are placed:
- 
-<div class="itemizedlist"><ul type="disc">
-<li>
- Classic
- </li>
-<li>
- Qi
- </li>
-<li>
- Karma
- </li>
-<li>
- Lex
- </li>
-<li>
- Phoenix
- </li>
-<li>
- Support
- </li>
-</ul></div>
-
- The top spirit directory is:
- 
-<pre class="programlisting">BOOST_ROOT/boost/spirit
-</pre>
-
- Currently, the directory contains:
- 
-<pre class="programlisting">[actor] [attribute] [core] [dynamic]
-[debug] [error_handling][home] [include]
-[iterator] [meta] [phoenix] [symbols]
-[tree] [utility]
-</pre>
-
- These include some old v1.8 directories that are now depracated. These are:
- actor, attribute, core, dynamic, debug, error_handling, iterator, meta, phoenix,
- symbols, tree and utility. There is no guarantee that these directories will
- still be present in future versions of Spirit. We only keep them for backward
- compatibility. Please be warned.
- 
-
- Each directory (except include and home) have a corresponding header file
- that contains forwarding includes of each relevant include files that the
- directory contains. For example, there exists a <boost/spirit/actor.hpp>
- header file.
- 
-
- To distinguish between Spirit versions, you can inspect the version file:
- 
-<pre class="programlisting"><boost/spirit/version.hpp>
-</pre>
-
- using the preprocessor define
- 
-<pre class="programlisting">SPIRIT_VERSION
-</pre>
-
- It is a hex number where the first two digits determine the major version
- while the last two digits determine the minor version. For example:
- 
-<pre class="programlisting">#define SPIRIT_VERSION 0x2010 // version 2.1
-</pre>
-
- The include directory at:
- 
-<pre class="programlisting">BOOST_ROOT/boost/spirit/include
-</pre>
-
- is a special flat-structured directory that contains all the spirit headers.
- The accomodate the flat structure, the headers are prefixed with the sub-
- library name:
- 
-<div class="itemizedlist"><ul type="disc">
-<li>
- classic_
- </li>
-<li>
- karma_
- </li>
-<li>
- lex_
- </li>
-<li>
- phoenix1_
- </li>
-<li>
- phoenix_
- </li>
-<li>
- qi_
- </li>
-<li>
- support_
- </li>
-</ul></div>
-
- For example, if you used to include <boost/spirit/actor.hpp>, which
- is now a deprecated header, you should instead include <boost/spirit/include/classic_actor.hpp>
- 
-
- If you want to simply include the main sub-library name, then you can include:
- 
-<div class="itemizedlist"><ul type="disc">
-<li>
- <boost/spirit/include/classic.hpp>
- </li>
-<li>
- <boost/spirit/include/karma.hpp>
- </li>
-<li>
- <boost/spirit/include/lex.hpp>
- </li>
-<li>
- <boost/spirit/include/phoenix1.hpp>
- </li>
-<li>
- <boost/spirit/include/phoenix.hpp>
- </li>
-<li>
- <boost/spirit/include/qi.hpp>
- </li>
-<li>
- <boost/spirit/include/support.hpp>
- </li>
-</ul></div>
-
- The home directory:
- 
-<pre class="programlisting">BOOST_ROOT/boost/spirit/home
-</pre>
-
- is the real home of spirit. It is the place where the
- various sub-libraries actually exist. The home directory contains:
- 
-<pre class="programlisting">[classic] [karma] [lex]
-[phoenix] [qi] [support]
-</pre>
-
- As usual, these directories have their corresponding include files:
- 
-<div class="itemizedlist"><ul type="disc">
-<li>
- <boost/spirit/home/classic.hpp>
- </li>
-<li>
- <boost/spirit/home/karma.hpp>
- </li>
-<li>
- <boost/spirit/home/lex.hpp>
- </li>
-<li>
- <boost/spirit/home/phoenix.hpp>
- </li>
-<li>
- <boost/spirit/home/qi.hpp>
- </li>
-<li>
- <boost/spirit/home/support.hpp>
- </li>
-</ul></div>
-
- The various sub-libraries include files can be found in each sub-directory
- containing the particular sub-library. The include structure of each sub-library
- are documented in each (sub)libraries' documentation. Each sub-library follows
- the same consistent scheme as above.
- 
-
- To keep it simple for you, the client, you can simply use the main flat include
- directory where all include files are all placed together.
- 
-</div>
+<div class="toc"><dl><dt>Include</dt></dl></div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
@@ -228,7 +42,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="introduction.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="abstracts.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="introduction.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="structure/include.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>

Added: trunk/libs/spirit/doc/html/spirit/structure/include.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/structure/include.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -0,0 +1,225 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Include</title>
+<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
+<link rel="home" href="../../index.html" title="Spirit 2.1">
+<link rel="up" href="../structure.html" title="Structure">
+<link rel="previous" href="../structure.html" title="Structure">
+<link rel="next" href="../abstracts.html" title="Abstracts">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../structure.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../structure.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../abstracts.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h3 class="title">
+<a name="spirit.structure.include"></a>Include
+</h3></div></div>
+<div></div>
+</div>
+
+ Spirit is a header file only library. There are no libraries to link to.
+ This section documents the structure of the Spirit headers.
+ 
+
+ Spirit contains five sub-libraries plus a 'support' module where common support
+ classes are placed:
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ Classic
+ </li>
+<li>
+ Qi
+ </li>
+<li>
+ Karma
+ </li>
+<li>
+ Lex
+ </li>
+<li>
+ Phoenix
+ </li>
+<li>
+ Support
+ </li>
+</ul></div>
+
+ The top spirit directory is:
+ 
+<pre class="programlisting">BOOST_ROOT/boost/spirit
+</pre>
+
+ Currently, the directory contains:
+ 
+<pre class="programlisting">[actor] [attribute] [core] [dynamic]
+[debug] [error_handling][home] [include]
+[iterator] [meta] [phoenix] [symbols]
+[tree] [utility]
+</pre>
+
+ These include some old v1.8 directories that are now depracated. These are:
+ actor, attribute, core, dynamic, debug, error_handling, iterator, meta, phoenix,
+ symbols, tree and utility. There is no guarantee that these directories will
+ still be present in future versions of Spirit. We only keep them for backward
+ compatibility. Please be warned.
+ 
+
+ Each directory (except include and home) have a corresponding header file
+ that contains forwarding includes of each relevant include files that the
+ directory contains. For example, there exists a <boost/spirit/actor.hpp>
+ header file.
+ 
+
+ To distinguish between Spirit versions, you can inspect the version file:
+ 
+<pre class="programlisting"><boost/spirit/version.hpp>
+</pre>
+
+ using the preprocessor define
+ 
+<pre class="programlisting">SPIRIT_VERSION
+</pre>
+
+ It is a hex number where the first two digits determine the major version
+ while the last two digits determine the minor version. For example:
+ 
+<pre class="programlisting">#define SPIRIT_VERSION 0x2010 // version 2.1
+</pre>
+
+ The include directory at:
+ 
+<pre class="programlisting">BOOST_ROOT/boost/spirit/include
+</pre>
+
+ is a special flat-structured directory that contains all the spirit headers.
+ The accomodate the flat structure, the headers are prefixed with the sub-
+ library name:
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ classic_
+ </li>
+<li>
+ karma_
+ </li>
+<li>
+ lex_
+ </li>
+<li>
+ phoenix1_
+ </li>
+<li>
+ phoenix_
+ </li>
+<li>
+ qi_
+ </li>
+<li>
+ support_
+ </li>
+</ul></div>
+
+ For example, if you used to include <boost/spirit/actor.hpp>, which
+ is now a deprecated header, you should instead include <boost/spirit/include/classic_actor.hpp>
+ 
+
+ If you want to simply include the main sub-library name, then you can include:
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ <boost/spirit/include/classic.hpp>
+ </li>
+<li>
+ <boost/spirit/include/karma.hpp>
+ </li>
+<li>
+ <boost/spirit/include/lex.hpp>
+ </li>
+<li>
+ <boost/spirit/include/phoenix1.hpp>
+ </li>
+<li>
+ <boost/spirit/include/phoenix.hpp>
+ </li>
+<li>
+ <boost/spirit/include/qi.hpp>
+ </li>
+<li>
+ <boost/spirit/include/support.hpp>
+ </li>
+</ul></div>
+
+ The home directory:
+ 
+<pre class="programlisting">BOOST_ROOT/boost/spirit/home
+</pre>
+
+ is the real home of spirit. It is the place where the
+ various sub-libraries actually exist. The home directory contains:
+ 
+<pre class="programlisting">[classic] [karma] [lex]
+[phoenix] [qi] [support]
+</pre>
+
+ As usual, these directories have their corresponding include files:
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ <boost/spirit/home/classic.hpp>
+ </li>
+<li>
+ <boost/spirit/home/karma.hpp>
+ </li>
+<li>
+ <boost/spirit/home/lex.hpp>
+ </li>
+<li>
+ <boost/spirit/home/phoenix.hpp>
+ </li>
+<li>
+ <boost/spirit/home/qi.hpp>
+ </li>
+<li>
+ <boost/spirit/home/support.hpp>
+ </li>
+</ul></div>
+
+ The various sub-libraries include files can be found in each sub-directory
+ containing the particular sub-library. The include structure of each sub-library
+ are documented in each (sub)libraries' documentation. Each sub-library follows
+ the same consistent scheme as above.
+ 
+
+ To keep it simple for you, the client, you can simply use the main flat include
+ directory where all include files are all placed together.
+ 
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2001-2009 Joel
+ de Guzman, 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../structure.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../structure.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../abstracts.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Modified: trunk/libs/spirit/doc/html/spirit/what_s_new.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/what_s_new.html (original)
+++ trunk/libs/spirit/doc/html/spirit/what_s_new.html 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -6,7 +6,7 @@
<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
<link rel="home" href="../index.html" title="Spirit 2.1">
<link rel="up" href="../index.html" title="Spirit 2.1">
-<link rel="previous" href="../index.html" title="Spirit 2.1">
+<link rel="previous" href="preface.html" title="Preface">
<link rel="next" href="introduction.html" title="Introduction">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@@ -20,7 +20,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../index.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="introduction.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="preface.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="introduction.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage">
@@ -30,7 +30,7 @@
<div></div>
</div>
<a name="spirit.what_s_new.spirit_classic"></a><h3>
-<a name="id353537"></a>
+<a name="id353454"></a>
 <a href="what_s_new.html#spirit.what_s_new.spirit_classic">Spirit Classic</a>
 </h3>

@@ -69,11 +69,11 @@
 for existing applications.
 
<a name="spirit.what_s_new.spirit_v2_1"></a><h3>
-<a name="id353664"></a>
+<a name="id353512"></a>
 <a href="what_s_new.html#spirit.what_s_new.spirit_v2_1">Spirit V2.1</a>
 </h3>
<a name="spirit.what_s_new.what_s_changed_in__emphasis_spirit_qi__emphasis__and__emphasis_spirit_karma__emphasis__from_v2_0_to_2_x"></a><h3>
-<a name="id353688"></a>
+<a name="id353536"></a>
 <a href="what_s_new.html#spirit.what_s_new.what_s_changed_in__emphasis_spirit_qi__emphasis__and__emphasis_spirit_karma__emphasis__from_v2_0_to_2_x">What's
 changed in Spirit.Qi and Spirit.Karma
 from V2.0 to 2.x</a>
@@ -160,7 +160,7 @@
 </li>
</ul></div>
<a name="spirit.what_s_new.what_s_changed_in__emphasis_spirit_lex__emphasis__from_v2_0_to_2_x"></a><h3>
-<a name="id410213"></a>
+<a name="id410200"></a>
 <a href="what_s_new.html#spirit.what_s_new.what_s_changed_in__emphasis_spirit_lex__emphasis__from_v2_0_to_2_x">What's
 changed in Spirit.Lex from V2.0 to 2.x</a>
 </h3>
@@ -255,7 +255,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../index.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="introduction.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="preface.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="introduction.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>

Modified: trunk/libs/spirit/doc/spirit2.qbk
==============================================================================
--- trunk/libs/spirit/doc/spirit2.qbk (original)
+++ trunk/libs/spirit/doc/spirit2.qbk 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -138,6 +138,17 @@
</figure>
''']

+[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]]

[/ Here we go ]

Modified: trunk/libs/spirit/test/qi/debug.cpp
==============================================================================
--- trunk/libs/spirit/test/qi/debug.cpp (original)
+++ trunk/libs/spirit/test/qi/debug.cpp 2009-06-16 22:59:03 EDT (Tue, 16 Jun 2009)
@@ -76,134 +76,6 @@
 BOOST_TEST(test(" a a a a b a b a b a a a b b a ", start, space, false));
 }

-// { // alias tests
-//
-// rule<char const*> a, b, c, d, start;
-//
-// a = 'a';
-// b = 'b';
-// c = 'c';
-// d = start.alias(); // d will always track start
-//
-// start = *(a | b | c);
-// BOOST_TEST(test("abcabcacb", d));
-//
-// start = (a | b) >> (start | b);
-// BOOST_TEST(test("aaaabababaaabbb", d));
-// }
-//
-// { // copy tests
-//
-// rule<char const*> a, b, c, start;
-//
-// a = 'a';
-// b = 'b';
-// c = 'c';
-//
-// // The FF is the dynamic equivalent of start = *(a | b | c);
-// start = a;
-// start = start.copy() | b;
-// start = start.copy() | c;
-// start = *(start.copy());
-//
-// BOOST_TEST(test("abcabcacb", start));
-//
-// // The FF is the dynamic equivalent of start = (a | b) >> (start | b);
-// start = b;
-// start = a | start.copy();
-// start = start.copy() >> (start | b);
-//
-// BOOST_TEST(test("aaaabababaaabbb", start));
-// BOOST_TEST(test("aaaabababaaabba", start, false));
-// }
-//
-// { // context tests
-//
-// using namespace boost::phoenix;
-// using namespace boost::spirit::ascii;
-// using boost::spirit::arg_names::_1;
-// using boost::spirit::arg_names::_val;
-//
-// char ch;
-// rule<char const*, char()> a;
-// a = alpha[_val = _1];
-//
-// BOOST_TEST(test("x", a[ref(ch) = _1]));
-// BOOST_TEST(ch == 'x');
-//
-// BOOST_TEST(test_attr("z", a, ch)); // attribute is given.
-// BOOST_TEST(ch == 'z');
-// }
-//
-// { // context (w/arg) tests
-//
-// using namespace boost::phoenix;
-// using namespace boost::spirit::ascii;
-// using boost::spirit::arg_names::_1;
-// using boost::spirit::arg_names::_r1;
-// using boost::spirit::arg_names::_r2;
-// using boost::spirit::arg_names::_val;
-//
-// char ch;
-// rule<char const*, char(int)> a; // 1 arg
-// a = alpha[_val = _1 + _r1];
-//
-// BOOST_TEST(test("x", a(val(1))[ref(ch) = _1]));
-// BOOST_TEST(ch == 'x' + 1);
-//
-// BOOST_TEST(test_attr("a", a(1), ch)); // allow scalars as rule args too.
-// BOOST_TEST(ch == 'a' + 1);
-//
-// rule<char const*, char(int, int)> b; // 2 args
-// b = alpha[_val = _1 + _r1 + _r2];
-// BOOST_TEST(test_attr("a", b(1, 2), ch));
-// BOOST_TEST(ch == 'a' + 1 + 2);
-// }
-//
-// { // context (w/locals) tests
-// using namespace boost::phoenix;
-// using namespace boost::spirit::ascii;
-// using boost::spirit::arg_names::_1;
-// using boost::spirit::arg_names::_a;
-// using boost::spirit::char_;
-// using boost::spirit::locals;
-//
-// rule<char const*, locals<char> > a; // 1 local
-// a = alpha[_a = _1] >> char_(_a);
-// BOOST_TEST(test("aa", a));
-// BOOST_TEST(!test("ax", a));
-// }
-//
-// { // context (w/args and locals) tests
-// using namespace boost::phoenix;
-// using namespace boost::spirit::ascii;
-// using boost::spirit::arg_names::_1;
-// using boost::spirit::arg_names::_r1;
-// using boost::spirit::arg_names::_a;
-// using boost::spirit::char_;
-// using boost::spirit::locals;
-//
-// rule<char const*, void(int), locals<char> > a; // 1 arg + 1 local
-// a = alpha[_a = _1 + _r1] >> char_(_a);
-// BOOST_TEST(test("ab", a(val(1))));
-// BOOST_TEST(test("xy", a(val(1))));
-// BOOST_TEST(!test("ax", a(val(1))));
-// }
-//
-// { // bug: test that injected attributes are ok
-// using namespace boost::phoenix;
-// using namespace boost::spirit::ascii;
-// using boost::spirit::arg_names::_1;
-// using boost::spirit::arg_names::_r1;
-// using boost::spirit::arg_names::_val;
-// using boost::spirit::char_;
-//
-// rule<char const*, char(int) > r;
-//
-// // problem code:
-// r = char_(_r1)[_val = _1];
-// }
-
 { // error handling

 using namespace boost::phoenix;

Date view	Thread view	Subject view	Author view

Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk