Boost-Commit :

Date view	Thread view	Subject view	Author view

From: joel_at_[hidden]
Date: 2008-07-12 01:23:55

Author: djowel
Date: 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
New Revision: 47333
URL: http://svn.boost.org/trac/boost/changeset/47333

Log:
tutorial updates
Added:
   trunk/libs/spirit/doc/html/spirit/
   trunk/libs/spirit/doc/html/spirit/__lex__/
   trunk/libs/spirit/doc/html/spirit/__lex__.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/__lex__/__lex___tutorials/
   trunk/libs/spirit/doc/html/spirit/__lex__/__lex___tutorials.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/__lex__/__lex___tutorials/quickstart_1___a_word_counter_using___lex__.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/__lex__/__lex___tutorials/quickstart_2___a_better_word_counter_using___lex__.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/__lex__/__lex___tutorials/quickstart_3___counting_words_using_a_parser.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/__lex__/abstracts/
   trunk/libs/spirit/doc/html/spirit/__lex__/abstracts.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/__lex__/abstracts/lexer_attributes.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/__lex__/abstracts/lexer_semantic_actions.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/__lex__/abstracts/lexer_states.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/__lex__/abstracts/parsing_using_a_lexer.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/__lex__/abstracts/the__static__lexer_model.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/__lex__/abstracts/tokenizing_input_data.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/__lex__/quick_reference.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/__lex__/reference/
   trunk/libs/spirit/doc/html/spirit/__lex__/reference.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/__lex__/reference/lexer_class.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/__lex__/reference/token_class.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/__lex__/reference/tokendef_class.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/__lex__/reference/tokenset_class.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/acknowledgments.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/faq.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/introduction.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/notes/
   trunk/libs/spirit/doc/html/spirit/notes.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/notes/porting_from_spirit_1_8_x.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/notes/style_guide.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/notes/techniques.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/qi_and_karma/
   trunk/libs/spirit/doc/html/spirit/qi_and_karma.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/qi_and_karma/abstracts/
   trunk/libs/spirit/doc/html/spirit/qi_and_karma/abstracts.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/qi_and_karma/abstracts/attributes.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/qi_and_karma/abstracts/debugging.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/qi_and_karma/abstracts/directives.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/qi_and_karma/abstracts/error_handling.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/qi_and_karma/abstracts/grammars.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/qi_and_karma/abstracts/operators.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/qi_and_karma/abstracts/parse_trees_and_asts.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/qi_and_karma/abstracts/parsing.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/qi_and_karma/abstracts/parsing_and_generating.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/qi_and_karma/abstracts/primitives.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/qi_and_karma/abstracts/rules.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/qi_and_karma/abstracts/semantic_actions.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/qi_and_karma/quick_reference.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/qi_and_karma/reference/
   trunk/libs/spirit/doc/html/spirit/qi_and_karma/reference.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/qi_and_karma/reference/action.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/qi_and_karma/reference/auxiliary.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/qi_and_karma/reference/binary.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/qi_and_karma/reference/char.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/qi_and_karma/reference/debug.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/qi_and_karma/reference/directive.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/qi_and_karma/reference/nonterminal.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/qi_and_karma/reference/numeric.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/qi_and_karma/reference/operators.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/qi_and_karma/reference/stream.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/qi_and_karma/reference/string.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/rationale.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/references.html (contents, props changed)
   trunk/libs/spirit/doc/html/spirit/what_s_new.html (contents, props changed)
Text files modified:
   trunk/libs/spirit/doc/html/index.html | 22 +++---
   trunk/libs/spirit/doc/qi_and_karma/roman.qbk | 111 +++++++++++++++++++++++++++++++++++++++
   trunk/libs/spirit/example/qi/calc1.cpp | 2
   trunk/libs/spirit/example/qi/calc2.cpp | 2
   trunk/libs/spirit/example/qi/calc2_ast.cpp | 2
   trunk/libs/spirit/example/qi/calc3.cpp | 2
   trunk/libs/spirit/example/qi/calc3_lexer.cpp | 2
   trunk/libs/spirit/example/qi/calc4.cpp | 2
   trunk/libs/spirit/example/qi/calc5.cpp | 2
   trunk/libs/spirit/example/qi/calc6/calc6b.hpp | 2
   trunk/libs/spirit/example/qi/calc6/calc6c.hpp | 2
   trunk/libs/spirit/example/qi/calc7/calc7b.hpp | 2
   trunk/libs/spirit/example/qi/calc7/calc7c.hpp | 2
   trunk/libs/spirit/example/qi/employee.cpp | 2
   trunk/libs/spirit/example/qi/mini_c/mini_c.hpp | 2
   trunk/libs/spirit/example/qi/mini_c/mini_cb.hpp | 2
   trunk/libs/spirit/example/qi/mini_c/mini_cc.hpp | 2
   trunk/libs/spirit/example/qi/mini_c/mini_cd.hpp | 2
   trunk/libs/spirit/example/qi/mini_xml1.cpp | 2
   trunk/libs/spirit/example/qi/mini_xml2.cpp | 2
   trunk/libs/spirit/example/qi/roman.cpp | 31 ++++++----
   21 files changed, 157 insertions(+), 43 deletions(-)

Modified: trunk/libs/spirit/doc/html/index.html
==============================================================================
--- trunk/libs/spirit/doc/html/index.html (original)
+++ trunk/libs/spirit/doc/html/index.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -34,7 +34,7 @@
<div>Copyright © 2001-2008 Joel de Guzman,
 Hartmut Kaiser</div>
<div><div class="legalnotice">
-<a name="id385790"></a>
+<a name="id455998"></a>
 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)
 
@@ -179,11 +179,11 @@
 
</blockquote></div>
<a name="spirit.preface.history"></a><h3>
-<a name="id387005"></a>
+<a name="id385825"></a>
 <a href="index.html#spirit.preface.history">History</a>
 </h3>
<a name="spirit.preface._emphasis_80s__emphasis_"></a><h3>
-<a name="id385807"></a>
+<a name="id385846"></a>
 <a href="index.html#spirit.preface._emphasis_80s__emphasis_">80s</a>
 </h3>

@@ -197,7 +197,7 @@
 recursive-descent parser. This worked very well.
 
<a name="spirit.preface._emphasis_90s__emphasis_"></a><h3>
-<a name="id385846"></a>
+<a name="id386884"></a>
 <a href="index.html#spirit.preface._emphasis_90s__emphasis_">90s</a>
 </h3>

@@ -242,7 +242,7 @@
 here: pre-Spirit.
 
<a name="spirit.preface._emphasis_2001_to_2006__emphasis_"></a><h3>
-<a name="id387238"></a>
+<a name="id387194"></a>
 <a href="index.html#spirit.preface._emphasis_2001_to_2006__emphasis_">2001
 to 2006</a>
 </h3>
@@ -272,7 +272,7 @@
 for design and implementation quality, robustness, and reusability.
 
<a name="spirit.preface._emphasis_2007__emphasis_"></a><h3>
-<a name="id387314"></a>
+<a name="id387270"></a>
 <a href="index.html#spirit.preface._emphasis_2007__emphasis_">2007</a>
 </h3>

@@ -302,7 +302,7 @@
 Templates</a> library called -Boost.Proto-.
 
<a name="spirit.preface.new_ideas__spirit_v2"></a><h3>
-<a name="id387434"></a>
+<a name="id387389"></a>
 <a href="index.html#spirit.preface.new_ideas__spirit_v2">New Ideas: Spirit V2</a>
 </h3>

@@ -340,7 +340,7 @@
 same underlying component library as for the parser and generator libraries.
 
<a name="spirit.preface.how_to_use_this_manual"></a><h3>
-<a name="id387536"></a>
+<a name="id387492"></a>
 <a href="index.html#spirit.preface.how_to_use_this_manual">How to use this manual</a>
 </h3>

@@ -371,7 +371,7 @@
 icons precede some text to indicate:
 
<div class="table">
-<a name="id385325"></a>Table 1. Icons
+<a name="id387578"></a>Table 1. Icons
<table class="table" summary="Icons">
<colgroup>
<col>
@@ -492,7 +492,7 @@
 Tools</a>.
 
<a name="spirit.preface.support"></a><h3>
-<a name="id385595"></a>
+<a name="id385560"></a>
 <a href="index.html#spirit.preface.support">Support</a>
 </h3>

@@ -508,7 +508,7 @@
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left">Last revised: July 10, 2008 at 15:45:10 GMT</td>
+<td align="left">Last revised: July 12, 2008 at 05:15:37 GMT</td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>

Added: trunk/libs/spirit/doc/html/spirit/__lex__.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/__lex__.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,266 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Spirit.Lex</title>
+<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../index.html" title="Spirit 2.0">
+<link rel="up" href="../index.html" title="Spirit 2.0">
+<link rel="prev" href="qi_and_karma/reference/debug.html" title="Debug">
+<link rel="next" href="__lex__/__lex___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="qi_and_karma/reference/debug.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__/__lex___tutorials.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.__lex__"></a>Spirit.Lex</h2></div></div></div>
+<div class="toc"><dl>
+<dt><a href="__lex__.html#spirit.__lex__.introduction_to___lex__">Introduction
+ to Spirit.Lex</a></dt>
+<dt><a href="__lex__/__lex___tutorials.html">Spirit.Lex
+ Tutorials</a></dt>
+<dd><dl>
+<dt><a href="__lex__/__lex___tutorials.html#spirit.__lex__.__lex___tutorials.__lex___tutorials_overview">Spirit.Lex
+ Tutorials Overview</a></dt>
+<dt><a href="__lex__/__lex___tutorials/quickstart_1___a_word_counter_using___lex__.html">Quickstart
+ 1 - A word counter using Spirit.Lex</a></dt>
+<dt><a href="__lex__/__lex___tutorials/quickstart_2___a_better_word_counter_using___lex__.html">Quickstart
+ 2 - A better word counter using Spirit.Lex</a></dt>
+<dt><a href="__lex__/__lex___tutorials/quickstart_3___counting_words_using_a_parser.html">Quickstart
+ 3 - Counting Words Using a Parser</a></dt>
+</dl></dd>
+<dt>Abstracts</dt>
+<dd><dl>
+<dt>Lexer Primitives</dt>
+<dt><a href="__lex__/abstracts/tokenizing_input_data.html">Tokenizing
+ Input Data</a></dt>
+<dt><a href="__lex__/abstracts/lexer_semantic_actions.html">Lexer
+ Semantic Actions</a></dt>
+<dt><a href="__lex__/abstracts/the__static__lexer_model.html">The
+ Static Lexer Model</a></dt>
+<dt><a href="__lex__/abstracts/parsing_using_a_lexer.html">Parsing
+ using a Lexer</a></dt>
+<dt>Lexer Attributes</dt>
+<dt>Lexer States</dt>
+</dl></dd>
+<dt>Quick Reference</dt>
+<dt>Reference</dt>
+<dd><dl>
+<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__.introduction_to___lex__"></a><a href="__lex__.html#spirit.__lex__.introduction_to___lex__" title="Introduction
+ to Spirit.Lex">Introduction
+ to Spirit.Lex</a></h3></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__.introduction_to___lex__.why_using_a_separate_lexer"></a><h4>
+<a name="id472482"></a>
+ <a href="__lex__.html#spirit.__lex__.introduction_to___lex__.why_using_a_separate_lexer">Why
+ Using 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. Now, theoretically
+ it is not necessary to do this separation. 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
+ 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, the 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. Similarily, 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 anymore. 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__.introduction_to___lex__.advantages_of_using__emphasis_spirit_lex__emphasis_"></a><h4>
+<a name="id472834"></a>
+ <a href="__lex__.html#spirit.__lex__.introduction_to___lex__.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 all the 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 string (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/the__static__lexer_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 dynamicly 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 to speed up the development of your 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-2008 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_and_karma/reference/debug.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__/__lex___tutorials.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/__lex__/__lex___tutorials.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/__lex__/__lex___tutorials.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,143 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Spirit.Lex
+ Tutorials</title>
+<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../../index.html" title="Spirit 2.0">
+<link rel="up" href="../__lex__.html" title="Spirit.Lex">
+<link rel="prev" href="../__lex__.html" title="Spirit.Lex">
+<link rel="next" href="__lex___tutorials/quickstart_1___a_word_counter_using___lex__.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="../__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="__lex___tutorials/quickstart_1___a_word_counter_using___lex__.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__.__lex___tutorials"></a><a href="__lex___tutorials.html" title="Spirit.Lex
+ Tutorials">Spirit.Lex
+ Tutorials</a></h3></div></div></div>
+<div class="toc"><dl>
+<dt><a href="__lex___tutorials.html#spirit.__lex__.__lex___tutorials.__lex___tutorials_overview">Spirit.Lex
+ Tutorials Overview</a></dt>
+<dt><a href="__lex___tutorials/quickstart_1___a_word_counter_using___lex__.html">Quickstart
+ 1 - A word counter using Spirit.Lex</a></dt>
+<dt><a href="__lex___tutorials/quickstart_2___a_better_word_counter_using___lex__.html">Quickstart
+ 2 - A better word counter using Spirit.Lex</a></dt>
+<dt><a href="__lex___tutorials/quickstart_3___counting_words_using_a_parser.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__.__lex___tutorials.__lex___tutorials_overview"></a><a href="__lex___tutorials.html#spirit.__lex__.__lex___tutorials.__lex___tutorials_overview" title="Spirit.Lex
+ Tutorials Overview">Spirit.Lex
+ Tutorials Overview</a></h4></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="__lex___tutorials/quickstart_1___a_word_counter_using___lex__.html" title="Quickstart
+ 1 - A word counter using Spirit.Lex">Lex
+ Quickstart 1 - A word counter using Spirit.Lex</a>
+ and <a href="__lex___tutorials/quickstart_2___a_better_word_counter_using___lex__.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="__lex___tutorials/quickstart_3___counting_words_using_a_parser.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>
+<td align="right"><div class="copyright-footer">Copyright © 2001-2008 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="__lex___tutorials/quickstart_1___a_word_counter_using___lex__.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/__lex__/__lex___tutorials/quickstart_1___a_word_counter_using___lex__.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/__lex__/__lex___tutorials/quickstart_1___a_word_counter_using___lex__.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,362 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Quickstart
+ 1 - A word counter using Spirit.Lex</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../../../index.html" title="Spirit 2.0">
+<link rel="up" href="../__lex___tutorials.html" title="Spirit.Lex
+ Tutorials">
+<link rel="prev" href="../__lex___tutorials.html" title="Spirit.Lex
+ Tutorials">
+<link rel="next" href="quickstart_2___a_better_word_counter_using___lex__.html" title="Quickstart
+ 2 - A better 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="../__lex___tutorials.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../__lex___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="quickstart_2___a_better_word_counter_using___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.__lex__.__lex___tutorials.quickstart_1___a_word_counter_using___lex__"></a><a href="quickstart_1___a_word_counter_using___lex__.html" title="Quickstart
+ 1 - A word counter using Spirit.Lex">Quickstart
+ 1 - A word counter using Spirit.Lex</a></h4></div></div></div>
+
+ Spirit.Lex is very modular, which follows the general
+ building principle of the Spirit
+ libraries. You never pay for features you don't use. It is nicely integrated
+ with the other parts of Spirit
+ but nevertheless can be used separately to build standalone lexical analyzers.
+ The first quick start example describes a standalone application: counting
+ characters, words and lines in a file, very similar to what the well known
+ Unix command <tt class="computeroutput">wc</tt> is doing
+ (for the full example code see here: word_count_functor.cpp).
+ 
+<a name="spirit.__lex__.__lex___tutorials.quickstart_1___a_word_counter_using___lex__.prerequisites"></a><h5>
+<a name="id473345"></a>
+ Prerequisites
+ </h5>
+
+ The only required <tt class="computeroutput">#include</tt>
+ specific to Spirit.Lex follows. It is a wrapper for
+ all necessary definitions to use Spirit.Lex in a standalone
+ fashion, and on top of the Lexertl
+ library. Additionally we <tt class="computeroutput">#include</tt>
+ two of the Boost headers to define <tt class="computeroutput">boost::bind()</tt> and <tt class="computeroutput">boost::ref()</tt>.
+ 
+
+ 
+
+
+
+<pre class="programlisting">
+#include <boost/spirit/include/lex_lexer_lexertl.hpp>
+#include <boost/bind.hpp>
+#include <boost/ref.hpp>
+</pre>
+
+ 
+
+ 
+
+ To make all the code below more readable we introduce the following namespaces.
+ 
+
+ 
+
+
+
+<pre class="programlisting">
+using namespace boost::spirit;
+using namespace boost::spirit::lex;
+</pre>
+
+ 
+
+ 
+<a name="spirit.__lex__.__lex___tutorials.quickstart_1___a_word_counter_using___lex__.defining_tokens"></a><h5>
+<a name="id473734"></a>
+ <a href="quickstart_1___a_word_counter_using___lex__.html#spirit.__lex__.__lex___tutorials.quickstart_1___a_word_counter_using___lex__.defining_tokens">Defining
+ Tokens</a>
+ </h5>
+
+ The most important step while creating a lexer using Spirit.Lex
+ is to define the tokens to be recognized in the input sequence. This is
+ normally done by defining the regular expressions describing the matching
+ character sequences, and optionally their corresponding token ids. Additionally
+ the defined tokens need to be associated with an instance of a lexer object
+ as provided by the library. The following code snippet shows how this can
+ be done using Spirit.Lex.
+ 
+
+ 
+
+ The template <tt class="computeroutput">word_count_tokens</tt>
+ defines three different tokens: <tt class="computeroutput">ID_WORD</tt>,
+ <tt class="computeroutput">ID_EOL</tt>, and <tt class="computeroutput">ID_CHAR</tt>, representing a word (anything
+ except a whitespace or a newline), a newline character, and any other
+ character (<tt class="computeroutput">ID_WORD</tt>,
+ <tt class="computeroutput">ID_EOL</tt>, and <tt class="computeroutput">ID_CHAR</tt> are enum values representing
+ the token ids, but could be anything else convertible to an integer as
+ well). The direct base class of any token definition class needs to be
+ the template <tt class="computeroutput">lexer_def<></tt>, where the corresponding template
+ parameter (here: <tt class="computeroutput">lexertl_lexer<BaseIterator></tt>) defines which underlying lexer engine
+ has to be used to provide the required state machine functionality. In
+ this example we use the Lexertl based lexer engine as the underlying
+ lexer type.
+ 
+
+ 
+
+
+
+<pre class="programlisting">
+template <typename Lexer>
+struct word_count_tokens : lexer_def<Lexer>
+{
+ template <typename Self>
+ void def (Self& self)
+ {
+ // define tokens (the regular expression to match and the corresponding
+ // token id) and add them to the lexer
+ self.add
+ ("[^ \t\n]+", ID_WORD) // words (anything except ' ', '\t' or '\n')
+ ("\n", ID_EOL) // newline characters
+ (".", ID_CHAR) // anything else is a plain character
+ ;
+ }
+};
+</pre>
+
+ 
+
+ 
+<a name="spirit.__lex__.__lex___tutorials.quickstart_1___a_word_counter_using___lex__.doing_the_useful_work"></a><h5>
+<a name="id474246"></a>
+ <a href="quickstart_1___a_word_counter_using___lex__.html#spirit.__lex__.__lex___tutorials.quickstart_1___a_word_counter_using___lex__.doing_the_useful_work">Doing
+ the Useful Work</a>
+ </h5>
+
+ We will use a setup, where we want the Spirit.Lex
+ library to invoke a given function after any of of the generated tokens
+ is recognized. For this reason we need to implement a functor taking at
+ least the generated token as an argument and returning a boolean value
+ allowing to stop the tokenization process. The default token type used
+ in this example carries a token value of the type <tt class="computeroutput">iterator_range<BaseIterator></tt> pointing to the matched range in the
+ underlying input sequence.
+ 
+
+ 
+
+ In this example the struct 'counter' is used as a functor counting the
+ characters, words and lines in the analyzed input sequence by identifying
+ the matched tokens as passed from the Spirit.Lex
+ library.
+ 
+
+ 
+
+
+
+<pre class="programlisting">
+struct counter
+{
+ // the function operator gets called for each of the matched tokens
+ // c, l, w are references to the counters used to keep track of the numbers
+ template <typename Token>
+ bool operator()(Token const& t, std::size_t& c, std::size_t& w, std::size_t& l) const
+ {
+ switch (t.id()) {
+ case ID_WORD: // matched a word
+ // since we're using a default token type in this example, every
+ // token instance contains a `iterator_range<BaseIterator>` as its
+ // token value pointing to the matched character sequence in the input
+ ++w; c += t.value().size();
+ break;
+ case ID_EOL: // matched a newline character
+ ++l; ++c;
+ break;
+ case ID_CHAR: // matched something else
+ ++c;
+ break;
+ }
+ return true; // always continue to tokenize
+ }
+};
+</pre>
+
+ 
+
+ 
+
+ All what's left is to write some boilerplate code helping to tie together
+ the pieces described so far. To simplify this example we call the <tt class="computeroutput">lex::tokenize()</tt>
+ function implemented in Spirit.Lex (for a more detailed
+ description of this function see here: FIXME),
+ even if we could have written a loop to iterate over the lexer iterators
+ [<tt class="computeroutput">first</tt>, <tt class="computeroutput">last</tt>)
+ as well.
+ 
+<a name="spirit.__lex__.__lex___tutorials.quickstart_1___a_word_counter_using___lex__.pulling_everything_together"></a><h5>
+<a name="id474950"></a>
+ <a href="quickstart_1___a_word_counter_using___lex__.html#spirit.__lex__.__lex___tutorials.quickstart_1___a_word_counter_using___lex__.pulling_everything_together">Pulling
+ Everything Together</a>
+ </h5>
+
+ 
+
+ The main function simply loads the given file into memory (as a <tt class="computeroutput">std::string</tt>), instantiates an instance of
+ the token definition template using the correct iterator type (<tt class="computeroutput">word_count_tokens<char const*></tt>), and finally calls <tt class="computeroutput">lex::tokenize</tt>, passing an instance of the
+ counter functor defined above. The return value of <tt class="computeroutput">lex::tokenize</tt>
+ will be <tt class="computeroutput">true</tt> if the whole
+ input sequence has been successfully tokenized, and <tt class="computeroutput">false</tt>
+ otherwise.
+ 
+
+ 
+
+
+
+<pre class="programlisting">
+int main(int argc, char* argv[])
+{
+ // these variables are used to count characters, words and lines
+ std::size_t c = 0, w = 0, l = 0;
+
+ // read input from the given file
+ std::string str (read_from_file(1 == argc ? "word_count.input" : argv[1]));
+
+ // create the token definition instance needed to invoke the lexical analyzer
+ word_count_tokens<lexertl_lexer<> > word_count_functor;
+
+ // tokenize the given string, the bound functor gets invoked for each of
+ // the matched tokens
+ char const* first = str.c_str();
+ char const* last = &first[str.size()];
+ bool r = lex::tokenize(first, last, make_lexer(word_count_functor),
+ boost::bind(counter(), _1, boost::ref(c), boost::ref(w), boost::ref(l)));
+
+ // print results
+ if (r) {
+ std::cout << "lines: " << l << ", words: " << w
+ << ", characters: " << c << "\n";
+ }
+ else {
+ std::string rest(first, last);
+ std::cout << "Lexical analysis failed\n" << "stopped at: \""
+ << rest << "\"\n";
+ }
+ return 0;
+}
+</pre>
+
+ 
+
+ 
+<a name="spirit.__lex__.__lex___tutorials.quickstart_1___a_word_counter_using___lex__.comparing__emphasis_spirit_lex__emphasis__with__ulink_url__http___flex_sourceforge_net___flex__ulink_"></a><h5>
+<a name="id476093"></a>
+ <a href="quickstart_1___a_word_counter_using___lex__.html#spirit.__lex__.__lex___tutorials.quickstart_1___a_word_counter_using___lex__.comparing__emphasis_spirit_lex__emphasis__with__ulink_url__http___flex_sourceforge_net___flex__ulink_">Comparing
+ Spirit.Lex with Flex</a>
+ </h5>
+
+ This example was deliberately chosen to be similar as much as possible
+ to the equivalent Flex
+ program (see below), which isn't too different from what has to be written
+ when using Spirit.Lex.
+ 
+<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">
+ Interestingly enough, performance comparisons of lexical analyzers written
+ using Spirit.Lex with equivalent programs generated
+ by Flex show that both
+ have comparable execution speeds! Generally, thanks to the highly optimized
+ Lexertl library
+ and due its carefully designed integration with Spirit
+ the abstraction penalty to be paid for using Spirit.Lex
+ is neglectible.
+ </td></tr>
+</table></div>
+
+ The remaining examples in this tutorial will use more sophisticated features
+ of Spirit.Lex, mainly to allow further simplification
+ of the code to be written, while maintaining the similarity with corresponding
+ features of Flex. Spirit.Lex
+ has been designed to be as much as possible similar to Flex,
+ that is why this documentation will provide the corresponding Flex
+ code for the shown Spirit.Lex examples almost everywhere.
+ So consequently, here is the Flex
+ code corresponding to the example as shown above.
+ 
+
+ 
+
+
+
+<pre class="programlisting">
+%{
+ #define ID_WORD 1000
+ #define ID_EOL 1001
+ #define ID_CHAR 1002
+ int c = 0, w = 0, l = 0;
+%}
+%%
+[^ \t\n]+ { return ID_WORD; }
+\n { return ID_EOL; }
+. { return ID_CHAR; }
+%%
+bool count(int tok)
+{
+ switch (tok) {
+ case ID_WORD: ++w; c += yyleng; break;
+ case ID_EOL: ++l; ++c; break;
+ case ID_CHAR: ++c; break;
+ default:
+ return false;
+ }
+ return true;
+}
+void main()
+{
+ int tok = EOF;
+ do {
+ tok = yylex();
+ if (!count(tok))
+ break;
+ } while (EOF != tok);
+ printf("%d %d %d\n", l, w, c);
+}
+</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-2008 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___tutorials.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../__lex___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="quickstart_2___a_better_word_counter_using___lex__.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/__lex__/__lex___tutorials/quickstart_2___a_better_word_counter_using___lex__.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/__lex__/__lex___tutorials/quickstart_2___a_better_word_counter_using___lex__.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,295 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Quickstart
+ 2 - A better word counter using Spirit.Lex</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../../../index.html" title="Spirit 2.0">
+<link rel="up" href="../__lex___tutorials.html" title="Spirit.Lex
+ Tutorials">
+<link rel="prev" href="quickstart_1___a_word_counter_using___lex__.html" title="Quickstart
+ 1 - A word counter using Spirit.Lex">
+<link rel="next" href="quickstart_3___counting_words_using_a_parser.html" title="Quickstart
+ 3 - Counting Words Using a 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="quickstart_1___a_word_counter_using___lex__.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../__lex___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="quickstart_3___counting_words_using_a_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.__lex__.__lex___tutorials.quickstart_2___a_better_word_counter_using___lex__"></a><a href="quickstart_2___a_better_word_counter_using___lex__.html" title="Quickstart
+ 2 - A better word counter using Spirit.Lex">Quickstart
+ 2 - A better word counter using Spirit.Lex</a></h4></div></div></div>
+
+ People knowing Flex will
+ probably complain about the example from the section <a href="quickstart_1___a_word_counter_using___lex__.html" title="Quickstart
+ 1 - A word counter using Spirit.Lex">Lex
+ Quickstart 1 - A word counter using Spirit.Lex</a>
+ as being overly complex and not being written to leverage the possibilities
+ provided by this tool. In particular the previous example did not directly
+ use the lexer actions to count the lines, words and characters. So the
+ example provided in this step of the tutorial will show how to use semantic
+ actions in Spirit.Lex. Even if it still will allow
+ to count text elements only it introduces other new concepts and configuration
+ options along the lines (for the full example code see here: word_count_lexer.cpp).
+ 
+<a name="spirit.__lex__.__lex___tutorials.quickstart_2___a_better_word_counter_using___lex__.prerequisites"></a><h5>
+<a name="id477173"></a>
+ Prerequisites
+ </h5>
+
+ In addition to the only required <tt class="computeroutput">#include</tt>
+ specific to Spirit.Lex this example needs to include
+ a couple of header files from the Phoenix2
+ library. This example shows how to attach functors to token definitions,
+ which could be done using any type of C++ technique resulting in a callable
+ object. Using Phoenix2
+ for this task simplifies things and avoids adding dependencies to other
+ libraries (Phoenix2
+ is already in use for Spirit
+ anyway).
+ 
+
+ 
+
+
+
+<pre class="programlisting">
+#include <boost/spirit/include/support_argument.hpp>
+#include <boost/spirit/include/lex_lexer_lexertl.hpp>
+#include <boost/spirit/include/phoenix_operator.hpp>
+#include <boost/spirit/include/phoenix_statement.hpp>
+#include <boost/spirit/include/phoenix_algorithm.hpp>
+#include <boost/spirit/include/phoenix_core.hpp>
+</pre>
+
+ 
+
+ 
+
+ To make all the code below more readable we introduce the following namespaces.
+ 
+
+ 
+
+
+
+<pre class="programlisting">
+using namespace boost::spirit;
+using namespace boost::spirit::lex;
+</pre>
+
+ 
+
+ 
+
+ To give a preview at what to expect from this example, here is the flex
+ program which has been used as the starting point. The useful code is directly
+ included inside the actions associated with each of the token definitions.
+ 
+
+ 
+
+
+
+<pre class="programlisting">
+%{
+ int c = 0, w = 0, l = 0;
+%}
+%%
+[^ \t\n]+ { ++w; c += yyleng; }
+\n { ++c; ++l; }
+. { ++c; }
+%%
+main()
+{
+ yylex();
+ printf("%d %d %d\n", l, w, c);
+}
+</pre>
+
+ 
+
+ 
+<a name="spirit.__lex__.__lex___tutorials.quickstart_2___a_better_word_counter_using___lex__.semantic_actions_in__emphasis_spirit_lex__emphasis_"></a><h5>
+<a name="id478130"></a>
+ <a href="quickstart_2___a_better_word_counter_using___lex__.html#spirit.__lex__.__lex___tutorials.quickstart_2___a_better_word_counter_using___lex__.semantic_actions_in__emphasis_spirit_lex__emphasis_">Semantic
+ Actions in Spirit.Lex</a>
+ </h5>
+
+ Spirit.Lex uses a very similar way of associating
+ actions with the token definitions (which should look familiar to anybody
+ knowlegdeable with Spirit
+ as well): specifying the operations to execute inside of a pair of <tt class="computeroutput">[]</tt> brackets. In order to be able to attach
+ semantic actions to token definitions for each of them there is defined
+ an instance of a <tt class="computeroutput">token_def<></tt>.
+ 
+
+ 
+
+
+
+<pre class="programlisting">
+template <typename Lexer>
+struct word_count_tokens : lexer_def<Lexer>
+{
+ word_count_tokens()
+ : c(0), w(0), l(0),
+ word("[^ \t\n]+"), eol("\n"), any(".") // define tokens
+ {}
+
+ template <typename Self>
+ void def (Self& self)
+ {
+ using boost::phoenix::ref;
+ using boost::phoenix::distance;
+ using boost::spirit::arg_names::_1;
+
+ // associate tokens with the lexer
+ self = word [++ref(w), ref(c) += distance(_1)]
+ | eol [++ref(c), ++ref(l)]
+ | any [++ref(c)]
+ ;
+ }
+
+ std::size_t c, w, l;
+ token_def<> word, eol, any;
+};
+</pre>
+
+ 
+
+ 
+
+ The semantics of the shown code is as follows. The code inside the <tt class="computeroutput">[]</tt> brackets will be executed whenever the
+ corresponding token has been matched by the lexical analyzer. This is very
+ similar to Flex, where
+ the action code associated with a token definition gets executed after
+ the recognition of a matching input sequence. The code above uses function
+ objects constructed using Phoenix2,
+ but it is possible to insert any C++ function or function object as long
+ as it exposes the interface:
+ 
+<pre class="programlisting">
+void f (Range r, Idtype id, bool& matched, Context& ctx);
+</pre>
+<div class="variablelist">
+where:
+<dl>
+<dt><tt class="computeroutput">Range
+ r</tt></dt>
+<dd>
+ This is a <tt class="computeroutput">boost::iterator_range</tt> holding two iterators
+ pointing to the matched range in the underlying input sequence. The
+ type of the held iterators is the same as specified while defining
+ the type of the <tt class="computeroutput">lexertl_lexer<...></tt> (its first template parameter).
+ </dd>
+<dt><tt class="computeroutput">Idtype
+ id</tt></dt>
+<dd>
+ This is the token id of the type <tt class="computeroutput">std::size_t</tt>
+ for the matched token.
+ </dd>
+<dt><tt class="computeroutput">bool& matched</tt></dt>
+<dd>
+ This boolean value is pre/initialized to <tt class="computeroutput">true</tt>.
+ If the functor sets it to <tt class="computeroutput">false</tt>
+ the lexer stops calling any semantic actions attached to this token
+ and behaves as if the token have not been matched in the first place.
+ </dd>
+<dt><tt class="computeroutput">Context& ctx</tt></dt>
+<dd>
+ This is a reference to a lexer specific, unspecified type, providing
+ the context for the current lexer state. It can be used to access different
+ internal data items and is needed for lexer state control from inside
+ a semantic action.
+ </dd>
+</dl>
+</div>
+
+ When using a C++ function as the semantic action the following prototypes
+ are allowed as well:
+ 
+<pre class="programlisting">
+void f (Range r, Idtype id, bool& matched);
+void f (Range r, Idtype id);
+void f (Range r);
+</pre>
+
+ Even if it is possible to write your own function object implementations
+ (i.e. using Boost.Lambda or Boost.Bind), the preferred way of defining
+ lexer semantic actions is to use Phoenix2.
+ In this case you can access the four parameters described in the table
+ above by using the predefined Spirit
+ placeholders: <tt class="computeroutput">_1</tt> for the
+ iterator range, <tt class="computeroutput">_2</tt> for
+ the token id, <tt class="computeroutput">_3</tt> for the
+ reference to the boolean value signaling the outcome of the semantic action,
+ and <tt class="computeroutput">_4</tt> for the reference
+ to the internal lexer context.
+ 
+<a name="spirit.__lex__.__lex___tutorials.quickstart_2___a_better_word_counter_using___lex__.associating_token_definitions_with_the_lexer"></a><h5>
+<a name="id479590"></a>
+ <a href="quickstart_2___a_better_word_counter_using___lex__.html#spirit.__lex__.__lex___tutorials.quickstart_2___a_better_word_counter_using___lex__.associating_token_definitions_with_the_lexer">Associating
+ Token Definitions with the Lexer</a>
+ </h5>
+
+ If you compare the with the code from <a href="quickstart_1___a_word_counter_using___lex__.html" title="Quickstart
+ 1 - A word counter using Spirit.Lex">Lex
+ Quickstart 1 - A word counter using Spirit.Lex</a>
+ with regard to the way how token definitions are associated with the lexer,
+ you will notice a different syntax being used here. If in the previous
+ example we have been using the <tt class="computeroutput">self.add()</tt> style of the API, then here we directly
+ assign the token definitions to <tt class="computeroutput">self</tt>,
+ combining the different token definitions using the <tt class="computeroutput">|</tt>
+ operator. Here is the code snippet again:
+ 
+<pre class="programlisting">
+self = word [++ref(w), ref(c) += distance(_1)]
+ | eol [++ref(c), ++ref(l)]
+ | any [++ref(c)]
+ ;
+</pre>
+
+ This way we have a very powerful and natural way of building the lexical
+ analyzer. If translated into English this may be read as: The lexical analyer
+ will recognize ('<tt class="computeroutput">=</tt>') tokens
+ as defined by any of ('<tt class="computeroutput">|</tt>')
+ the token definitions <tt class="computeroutput">word</tt>,
+ <tt class="computeroutput">eol</tt>, and <tt class="computeroutput">any</tt>.
+ 
+
+ A second difference to the previous example is that we do not explicitly
+ specify any token ids to use for the separate tokens. Using semantic actions
+ to trigger some useful work free'd us from the need to define these. To
+ ensure every token gets assigned a id the Spirit.Lex
+ library internally assigns unique numbers to the token definitions, starting
+ with the constant defined by <tt class="computeroutput">boost::spirit::lex::min_token_id</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-2008 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="quickstart_1___a_word_counter_using___lex__.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../__lex___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="quickstart_3___counting_words_using_a_parser.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/__lex__/__lex___tutorials/quickstart_3___counting_words_using_a_parser.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/__lex__/__lex___tutorials/quickstart_3___counting_words_using_a_parser.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,461 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Quickstart
+ 3 - Counting Words Using a Parser</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../../../index.html" title="Spirit 2.0">
+<link rel="up" href="../__lex___tutorials.html" title="Spirit.Lex
+ Tutorials">
+<link rel="prev" href="quickstart_2___a_better_word_counter_using___lex__.html" title="Quickstart
+ 2 - A better word counter using Spirit.Lex">
+<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="quickstart_2___a_better_word_counter_using___lex__.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../__lex___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="../abstracts.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__.__lex___tutorials.quickstart_3___counting_words_using_a_parser"></a><a href="quickstart_3___counting_words_using_a_parser.html" title="Quickstart
+ 3 - Counting Words Using a Parser">Quickstart
+ 3 - Counting Words Using a Parser</a></h4></div></div></div>
+
+ The whole purpose of integrating Spirit.Lex as part
+ of the Spirit library
+ was to add a library allowing to merge lexical analysis with the parsing
+ process as defined by a Spirit
+ grammar. Spirit parsers
+ read their input from an input sequence accessed by iterators. So naturally,
+ we chose iterators to be used as the interface beween the lexer and the
+ parser. A second goal of the lexer/parser integration was to enable the
+ usage of possibly different lexical analyzer libraries. The utilization
+ of iterators seemed to be the right choice from this standpoint as well,
+ mainly because these can be used as an abstraction layer hiding implementation
+ specifics of the used lexer library. The <a href="quickstart_3___counting_words_using_a_parser.html#spirit.lex.flowcontrol" title="Figure 3. The common flow control implemented while parsing
+ combined with lexical analysis">picture</a>
+ below shows the common flow control implemented while parsing combined
+ with lexical analysis.
+ 
+
+ 
+<div class="figure">
+<a name="spirit.lex.flowcontrol"></a>Figure 3. The common flow control implemented while parsing
+ combined with lexical analysis
+<img src="../../.././images/FlowOfControl.png" alt="The common flow
+ control implemented while parsing combined with lexical analysis">
+</div>
+
+ 
+
+ Another problem related to the integration of the lexical analyzer with
+ the parser was to find a way how the defined tokens syntactically could
+ be blended with the grammar definition syntax of Spirit.
+ For tokens defined as instances of the <tt class="computeroutput">token_def<></tt> class the most natural way of integration
+ was to allow to directly use these as parser components. Semantically these
+ parser components succeed matching their input whenever the corresponding
+ token type has been matched by the lexer. This quick start example will
+ demonstrate this (and more) by counting words again, simply by adding up
+ the numbers inside of semantic actions of a parser (for the full example
+ code see here: word_count.cpp).
+ 
+<a name="spirit.__lex__.__lex___tutorials.quickstart_3___counting_words_using_a_parser.prerequisites"></a><h5>
+<a name="id480180"></a>
+ Prerequisites
+ </h5>
+
+ This example uses two of the Spirit
+ library components: Spirit.Lex and Spirit.Qi,
+ consequently we have to <tt class="computeroutput">#include</tt>
+ the corresponding header files. Again, we need to include a couple of header
+ files from the Phoenix2
+ library. This example shows how to attach functors to parser components,
+ which could be done using any type of C++ technique resulting in a callable
+ object. Using Phoenix2
+ for this task simplifies things and avoids adding dependencies to other
+ libraries (Phoenix2
+ is already in use for Spirit
+ anyway).
+ 
+
+ 
+
+
+
+<pre class="programlisting">
+#include <boost/spirit/include/qi.hpp>
+#include <boost/spirit/include/lex_lexer_lexertl.hpp>
+#include <boost/spirit/include/phoenix_operator.hpp>
+#include <boost/spirit/include/phoenix_statement.hpp>
+#include <boost/spirit/include/phoenix_container.hpp>
+</pre>
+
+ 
+
+ 
+
+ To make all the code below more readable we introduce the following namespaces.
+ 
+
+ 
+
+
+
+<pre class="programlisting">
+using namespace boost::spirit;
+using namespace boost::spirit::qi;
+using namespace boost::spirit::lex;
+</pre>
+
+ 
+
+ 
+<a name="spirit.__lex__.__lex___tutorials.quickstart_3___counting_words_using_a_parser.defining_tokens"></a><h5>
+<a name="id480747"></a>
+ <a href="quickstart_3___counting_words_using_a_parser.html#spirit.__lex__.__lex___tutorials.quickstart_3___counting_words_using_a_parser.defining_tokens">Defining
+ Tokens</a>
+ </h5>
+
+ If compared to the two previous quick start examples (<a href="quickstart_1___a_word_counter_using___lex__.html" title="Quickstart
+ 1 - A word counter using Spirit.Lex">Lex
+ Quickstart 1 - A word counter using Spirit.Lex</a>
+ and <a href="quickstart_2___a_better_word_counter_using___lex__.html" title="Quickstart
+ 2 - A better word counter using Spirit.Lex">Lex
+ Quickstart 2 - A better word counter using Spirit.Lex</a>)
+ the token definition class for this example does not reveal any surprises.
+ However, it uses lexer token definition macros to simplify the composition
+ of the regular expressions, which will be described in more detail in the
+ section FIXME. Generally, any token definition
+ is usable without modification either for a standalone lexical analyzer
+ or in conjunction with a parser.
+ 
+
+ 
+
+
+
+<pre class="programlisting">
+template <typename Lexer>
+struct word_count_tokens : lexer_def<Lexer>
+{
+ template <typename Self>
+ void def (Self& self)
+ {
+ // define patterns (lexer macros) to be used during token definition
+ // below
+ self.add_pattern
+ ("WORD", "[^ \t\n]+")
+ ;
+
+ // define tokens and associate them with the lexer
+ word = "{WORD}"; // reference the pattern 'WORD' as defined above
+
+ // this lexer will recognize 3 token types: words, newlines, and
+ // everything else
+ self.add
+ (word) // no token id is needed here
+ ('\n') // characters are usable as tokens as well
+ (".", IDANY)
+ ;
+ }
+
+ token_def<std::string> word;
+};
+</pre>
+
+ 
+
+ 
+<a name="spirit.__lex__.__lex___tutorials.quickstart_3___counting_words_using_a_parser.using_token_definition_instances_as_parsers"></a><h5>
+<a name="id481254"></a>
+ <a href="quickstart_3___counting_words_using_a_parser.html#spirit.__lex__.__lex___tutorials.quickstart_3___counting_words_using_a_parser.using_token_definition_instances_as_parsers">Using
+ Token Definition Instances as Parsers</a>
+ </h5>
+
+ While the integration of lexer and parser in the control flow is achieved
+ by using special iterators wrapping the lexical analyzer, we still nead
+ a means of expressing in the grammar what tokens to match and where. The
+ token definition class above uses three different ways of defining a token:
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ Using an instance of a <tt class="computeroutput">token_def<></tt>, which is handy whenever you
+ need to specify a token attribute (for more information about lexer related
+ attributes please look here: <a href="../abstracts/lexer_attributes.html" title="Lexer Attributes">Lexer
+ Attributes</a>).
+ </li>
+<li>
+ Using a single character as the token, in this case the character represents
+ itself as a token, where the token id is the ASCII character value.
+ </li>
+<li>
+ Using a regular expression represented as a string, where the token id
+ needs to be specified explicitly to make the token accessible from the
+ grammar level.
+ </li>
+</ul></div>
+
+ All three token definition methods require a different method of grammar
+ integration. But as you can see from the following code snippet, each of
+ this methods is straightforward and blends the corresponding token instance
+ naturally with the surrounding Spirit.Qi grammar syntax.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Token definition
+ 
+ </th>
+<th>
+ 
+ Parser integration
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <tt class="computeroutput">token_def<></tt>
+ 
+ </td>
+<td>
+ 
+ The <tt class="computeroutput">token_def<></tt>
+ instance is directly usable as a parser component. Parsing of this
+ component will succeed if the regular expression used to define
+ this has been matched successfully.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ single character
+ 
+ </td>
+<td>
+ 
+ The single character is directly usable in the grammar, under certain
+ circumstances it needs to be wrapped by a <tt class="computeroutput">char_()</tt> parser component, though. Parsing
+ of this component will succeed if the single character has been
+ matched.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ explicit token id
+ 
+ </td>
+<td>
+ 
+ To use an explicit token id in a Spirit.Qi
+ grammar you are required to wrap it with the special <tt class="computeroutput">token()</tt>
+ parser component. Parsing of this component will succeed if the
+ current token has the same token id as specified in the expression
+ <tt class="computeroutput">token(<id>)</tt>.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+
+ The grammar definition below uses each of the three types demonstrating
+ their usage.
+ 
+
+ 
+
+
+
+<pre class="programlisting">
+template <typename Iterator>
+struct word_count_grammar : grammar_def<Iterator>
+{
+ template <typename TokenDef>
+ word_count_grammar(TokenDef const& tok)
+ : c(0), w(0), l(0)
+ {
+ using boost::phoenix::ref;
+ using boost::phoenix::size;
+
+ // As documented in the Spirit.Qi documentation, any placeholders
+ // (_1 et.al.) used in semantic actions inside a grammar need to be
+ // imported from the namespace boost::spirit::arg_names, and not from
+ // the corresponding namespace in Phoenix.
+ using boost::spirit::arg_names::_1;
+
+ start = *( tok.word [++ref(w), ref(c) += size(_1)]
+ | char_('\n') [++ref(c), ++ref(l)]
+ | token(IDANY) [++ref(c)]
+ )
+ ;
+ }
+
+ std::size_t c, w, l;
+ rule<Iterator> start;
+};
+</pre>
+
+ 
+
+ 
+
+ As already described (see: Attributes),
+ the Spirit.Qi parser library builds upon a set of
+ of fully attributed parser components. Consequently, all the token definitions
+ 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.about_tokens_and_token_values" 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
+ a <tt class="computeroutput">token_def<std::string></tt>,
+ making every instance of a <tt class="computeroutput">word</tt>
+ token carry the string representation of the matched input sequence as
+ its value. The semantic action attached to <tt class="computeroutput">tok.word</tt>
+ receives this string (represented by the <tt class="computeroutput">_1</tt>
+ placeholder) and uses it to calculate the number of matched characters:
+ <tt class="computeroutput">ref(c) +=
+ size(_1)</tt>.
+ 
+<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">
+ All placeholders (<tt class="computeroutput">_1</tt>,
+ <tt class="computeroutput">_2</tt>, etc.) used in parser
+ semantic actions in conjunction with functors created based on Phoenix2 need to be imported
+ from the <tt class="computeroutput">namespace boost::spirit::arg_names</tt>
+ (and not <tt class="computeroutput">namespace
+ boost::phoenix::arg_names</tt>, which is different from
+ using placeholders in Spirit.Lex). Using the wrong
+ placeholders leads to subtle compilation errors which are difficult to
+ backtrack to their cause.
+ </td></tr>
+</table></div>
+<a name="spirit.__lex__.__lex___tutorials.quickstart_3___counting_words_using_a_parser.pulling_everything_together"></a><h5>
+<a name="id482642"></a>
+ <a href="quickstart_3___counting_words_using_a_parser.html#spirit.__lex__.__lex___tutorials.quickstart_3___counting_words_using_a_parser.pulling_everything_together">Pulling
+ Everything Together</a>
+ </h5>
+
+ The main function needs to implement a bit more logic now as we have to
+ initialize and start not only the lexical analysis but the parsing process
+ as well. The three type definitions (<tt class="computeroutput">typedef</tt>
+ statements) simplify the creation of the lexical analyzer and the grammar.
+ After reading the contents of the given file into memory it calls the function
+ tokenize_and_parse()
+ to initialize the lexical analysis and parsing processes.
+ 
+
+ 
+
+
+
+<pre class="programlisting">
+int main(int argc, char* argv[])
+{
+<a name="spirit4co" href="quickstart_3___counting_words_using_a_parser.html#spirit4"><img src="../../../images/callouts/1.png" alt="1" border="0"></a> typedef lexertl_token<
+ char const*, boost::mpl::vector<std::string>
+ > token_type;
+
+<a name="spirit5co" href="quickstart_3___counting_words_using_a_parser.html#spirit5"><img src="../../../images/callouts/2.png" alt="2" border="0"></a> typedef lexertl_lexer<token_type> lexer_type;
+
+<a name="spirit6co" href="quickstart_3___counting_words_using_a_parser.html#spirit6"><img src="../../../images/callouts/3.png" alt="3" border="0"></a> typedef lexer_iterator<word_count_tokens<lexer_type> >::type iterator_type;
+
+ // now we use the types defined above to create the lexer and grammar
+ // object instances needed to invoke the parsing process
+ word_count_tokens<lexer_type> word_count; // Our token definition
+ word_count_grammar<iterator_type> def (word_count); // Our grammar definition
+
+ // read in the file int memory
+ std::string str (read_from_file(1 == argc ? "word_count.input" : argv[1]));
+ char const* first = str.c_str();
+ char const* last = &first[str.size()];
+
+ // Parsing is done based on the the token stream, not the character
+ // stream read from the input. The function `tokenize_and_parse()` wraps
+ // the passed iterator range `[first, last)` by the lexical analyzer and
+ // uses its exposed iterators to parse the toke stream.
+ qi::grammar<word_count_grammar<iterator_type> > g(def);
+ bool r = tokenize_and_parse(first, last, make_lexer(word_count), g);
+
+ if (r) {
+ std::cout << "lines: " << def.l << ", words: " << def.w
+ << ", characters: " << def.c << "\n";
+ }
+ else {
+ std::string rest(first, last);
+ std::cerr << "Parsing failed\n" << "stopped at: \""
+ << rest << "\"\n";
+ }
+ return 0;
+}
+</pre>
+
+ 
+
+ 
+
+ 
+<div class="calloutlist"><table border="0" summary="Callout list">
+<tr>
+<td width="5%" valign="top" align="left">
+<a name="spirit4"></a> </td>
+<td valign="top" align="left"> define the token type to be used: <tt class="computeroutput">std::string</tt>
+ is available as the type of the token value </td>
+</tr>
+<tr>
+<td width="5%" valign="top" align="left">
+<a name="spirit5"></a> </td>
+<td valign="top" align="left"> define the lexer type to
+ use implementing the state machine </td>
+</tr>
+<tr>
+<td width="5%" valign="top" align="left">
+<a name="spirit6"></a> </td>
+<td valign="top" align="left"> define the iterator type exposed by
+ the lexer type </td>
+</tr>
+</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-2008 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="quickstart_2___a_better_word_counter_using___lex__.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../__lex___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="../abstracts.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/__lex__/abstracts.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/__lex__/abstracts.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,412 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Abstracts</title>
+<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../../index.html" title="Spirit 2.0">
+<link rel="up" href="../__lex__.html" title="Spirit.Lex">
+<link rel="prev" href="__lex___tutorials/quickstart_3___counting_words_using_a_parser.html" title="Quickstart
+ 3 - Counting Words Using a Parser">
+<link rel="next" href="abstracts/tokenizing_input_data.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="__lex___tutorials/quickstart_3___counting_words_using_a_parser.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/tokenizing_input_data.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__.abstracts"></a>Abstracts</h3></div></div></div>
+<div class="toc"><dl>
+<dt>Lexer Primitives</dt>
+<dt><a href="abstracts/tokenizing_input_data.html">Tokenizing
+ Input Data</a></dt>
+<dt><a href="abstracts/lexer_semantic_actions.html">Lexer
+ Semantic Actions</a></dt>
+<dt><a href="abstracts/the__static__lexer_model.html">The
+ Static Lexer Model</a></dt>
+<dt><a href="abstracts/parsing_using_a_lexer.html">Parsing
+ using a Lexer</a></dt>
+<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 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.about_tokens_and_token_values">About
+ Tokens and Token Values</a></dt>
+<dt><a href="abstracts.html#spirit.__lex__.abstracts.lexer_primitives.ways_to_define_tokens">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 class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="spirit.__lex__.abstracts.lexer_primitives.about_tokens_and_token_values"></a><a href="abstracts.html#spirit.__lex__.abstracts.lexer_primitives.about_tokens_and_token_values" title="About
+ Tokens and Token Values">About
+ Tokens and Token Values</a></h5></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.about_tokens_and_token_values.the_anatomy_of_a_token"></a><h6>
+<a name="id484124"></a>
+ <a href="abstracts.html#spirit.__lex__.abstracts.lexer_primitives.about_tokens_and_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 4. 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.about_tokens_and_token_values.the_physiognomy_of_a_token_definition"></a><h6>
+<a name="id484928"></a>
+ <a href="abstracts.html#spirit.__lex__.abstracts.lexer_primitives.about_tokens_and_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.about_tokens_and_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="id485342"></a>
+ <a href="abstracts.html#spirit.__lex__.abstracts.lexer_primitives.about_tokens_and_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 value type, 'identifier'
+// carries a string (the identifier name) and 'constant' carries the
+// matched integer value.
+//
+// Note: any token value type specified explicitly during 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 values 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 tokens 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 value 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 value will be generated from the matched input
+// sequence every time it is requested. But as soon as you specify at
+// least one token value type you'll have to list all value 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.ways_to_define_tokens"></a><a href="abstracts.html#spirit.__lex__.abstracts.lexer_primitives.ways_to_define_tokens" 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-2008 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___tutorials/quickstart_3___counting_words_using_a_parser.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/tokenizing_input_data.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/__lex__/abstracts/lexer_attributes.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/__lex__/abstracts/lexer_attributes.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,42 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Lexer Attributes</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../../../index.html" title="Spirit 2.0">
+<link rel="up" href="../abstracts.html" title="Abstracts">
+<link rel="prev" href="parsing_using_a_lexer.html" title="Parsing
+ using a Lexer">
+<link rel="next" href="lexer_states.html" title="Lexer States">
+</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="parsing_using_a_lexer.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_states.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_attributes"></a>Lexer Attributes</h4></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-2008 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="parsing_using_a_lexer.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_states.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/__lex__/abstracts/lexer_semantic_actions.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/__lex__/abstracts/lexer_semantic_actions.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,46 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Lexer
+ Semantic Actions</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../../../index.html" title="Spirit 2.0">
+<link rel="up" href="../abstracts.html" title="Abstracts">
+<link rel="prev" href="tokenizing_input_data.html" title="Tokenizing
+ Input Data">
+<link rel="next" href="the__static__lexer_model.html" title="The
+ Static Lexer Model">
+</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="tokenizing_input_data.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="the__static__lexer_model.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_semantic_actions"></a><a href="lexer_semantic_actions.html" title="Lexer
+ Semantic Actions">Lexer
+ Semantic Actions</a></h4></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-2008 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="tokenizing_input_data.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="the__static__lexer_model.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/__lex__/abstracts/lexer_states.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/__lex__/abstracts/lexer_states.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,58 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Lexer States</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../../../index.html" title="Spirit 2.0">
+<link rel="up" href="../abstracts.html" title="Abstracts">
+<link rel="prev" href="lexer_attributes.html" title="Lexer Attributes">
+<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="lexer_attributes.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="../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.__lex__.abstracts.lexer_states"></a>Lexer States</h4></div></div></div>
+<a name="spirit.__lex__.abstracts.lexer_states.controlling_the_lexer_state_from_lexer_semantic_actions"></a><h5>
+<a name="id489692"></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="id489723"></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="id489754"></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>
+</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-2008 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_attributes.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="../quick_reference.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/__lex__/abstracts/parsing_using_a_lexer.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/__lex__/abstracts/parsing_using_a_lexer.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,45 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Parsing
+ using a Lexer</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../../../index.html" title="Spirit 2.0">
+<link rel="up" href="../abstracts.html" title="Abstracts">
+<link rel="prev" href="the__static__lexer_model.html" title="The
+ Static Lexer Model">
+<link rel="next" href="lexer_attributes.html" title="Lexer Attributes">
+</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="the__static__lexer_model.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_attributes.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.parsing_using_a_lexer"></a><a href="parsing_using_a_lexer.html" title="Parsing
+ using a Lexer">Parsing
+ using a Lexer</a></h4></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-2008 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="the__static__lexer_model.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_attributes.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/__lex__/abstracts/the__static__lexer_model.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/__lex__/abstracts/the__static__lexer_model.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,338 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>The
+ Static Lexer Model</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../../../index.html" title="Spirit 2.0">
+<link rel="up" href="../abstracts.html" title="Abstracts">
+<link rel="prev" href="lexer_semantic_actions.html" title="Lexer
+ Semantic Actions">
+<link rel="next" href="parsing_using_a_lexer.html" title="Parsing
+ using a 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="lexer_semantic_actions.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_using_a_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__.abstracts.the__static__lexer_model"></a><a href="the__static__lexer_model.html" title="The
+ Static Lexer Model">The
+ Static Lexer Model</a></h4></div></div></div>
+
+ The documentation of Spirit.Lex so far mostly was
+ about describing the features of the dynamic model,
+ where the tables needed for lexical analysis are generated from the regular
+ expressions at runtime. The big advantage of the dynamic model is its flexibility,
+ and its integration with the Spirit
+ library and the C++ host language. Its big disadvantage is the need to
+ spend additional runtime to generate the tables, which especially might
+ be a limitation for larger lexical analyers. The static
+ model strives to build upon the smooth integration with Spirit
+ and C++, and reuses large parts of the Spirit.Lex
+ library as described so far, while overcoming the additional runtime requirements
+ by using pre-generated tables and tokenizer routines. To make the code
+ generation as simple as possible, it is possible reuse the token definition
+ types developed using the dynamic model without any
+ changes. As will be shown in this section, building a code generator based
+ on an existing token definition type is a matter of writing 3 lines of
+ code.
+ 
+
+ Assuming you already built a dynamic lexer for your problem, there are
+ two more steps needed to create a static lexical analyzer using Spirit.Lex:
+ 
+<div class="orderedlist"><ol type="1">
+<li>
+ generating the C++ code for the static analyzer (including the tokenization
+ function and corresponding tables), and
+ </li>
+<li>
+ modifying the dynamic lexical anlyzer to use the generated code.
+ </li>
+</ol></div>
+
+ Both steps are described in more detail in the two sections below (for
+ the full source code used in this example see the code here: <a href="../../../../../example/lex/static_lexer/word_count_tokens.hpp" target="_top">the
+ common token definition</a>, <a href="../../../../../example/lex/static_lexer/word_count_generate.cpp" target="_top">the
+ code generator</a>, <a href="../../../../../example/lex/static_lexer/word_count_static.hpp" target="_top">the
+ generated code</a>, and <a href="../../../../../example/lex/static_lexer/word_count_static.cpp" target="_top">the
+ static lexical analyzer</a>).
+ 
+
+ But first we provide the code snippets needed to understand the further
+ descriptions. Both, the definition of the used token identifier and the
+ of the token definition class in this example are put into a separate header
+ file to make these available to the code generator and the static lexical
+ analyzer.
+ 
+
+ 
+
+
+
+<pre class="programlisting">
+enum tokenids
+{
+ IDANY = boost::spirit::lex::min_token_id + 1,
+};
+</pre>
+
+ 
+
+ 
+
+ The important point here is, that the token definition class is not different
+ from a similar class to be used for a dynamic lexical analyzer. The library
+ has been designed in a way, that all components (dynamic lexical analyzer,
+ code generator, and static lexical analyzer) can reuse the very same token
+ definition syntax.
+ 
+
+ 
+
+
+
+<pre class="programlisting">
+// This token definition class can be used without any change for all three
+// possible use cases: a dynamic lexical analyzer, a code generator, and a
+// static lexical analyzer.
+template <typename BaseLexer>
+struct word_count_tokens : boost::spirit::lex::lexer_def<BaseLexer>
+{
+ template <typename Self>
+ void def (Self& self)
+ {
+ // define tokens and associate them with the lexer
+ word = "[^ \t\n]+";
+ self = word | '\n' | token_def<>(".", IDANY);
+ }
+
+ boost::spirit::lex::token_def<std::string> word;
+};
+</pre>
+
+ 
+
+ 
+
+ The only thing changing between the three different use cases is the template
+ parameter used to instantiate a concrete token definition. Fot the dynamic
+ model and the code generator you probably will use the lexertl_lexer<>
+ template, where for the static model you will use the lexertl_static_lexer<>
+ type as the template parameter.
+ 
+
+ This example not only shows how to build a static lexer, but it additionally
+ demonstrates, how such a lexer can be used for parsing in conjunction with
+ a Spirit.Qi grammar. For completeness we provide the
+ simple grammar used in this example. As you can see, this grammar does
+ not have any dependencies on the static lexical analyzer, and for this
+ reason it is not different from a grammar used either without a lexer or
+ using a dynamic lexical analyzer as described before.
+ 
+
+ 
+
+
+
+<pre class="programlisting">
+// This is an ordinary grammar definition following the rules defined by
+// Spirit.Qi. There is nothing specific about it, except it gets the token
+// definition class instance passed to the constructor to allow accessing the
+// embedded token_def<> instances.
+template <typename Iterator>
+struct word_count_grammar : grammar_def<Iterator>
+{
+ template <typename TokenDef>
+ word_count_grammar(TokenDef const& tok)
+ : c(0), w(0), l(0)
+ {
+ using boost::spirit::arg_names::_1;
+ using boost::phoenix::ref;
+ using boost::phoenix::size;
+
+ // associate the defined tokens with the lexer, at the same time
+ // defining the actions to be executed
+ start = *( tok.word [++ref(w), ref(c) += size(_1)]
+ | char_('\n') [++ref(l), ++ref(c)]
+ | token(IDANY) [++ref(c)]
+ )
+ ;
+ }
+
+ std::size_t c, w, l; // counter for characters, words, and lines
+ rule<Iterator> start;
+};
+</pre>
+
+ 
+
+ 
+<a name="spirit.__lex__.abstracts.the__static__lexer_model.generating_the_static_analyzer"></a><h5>
+<a name="id487732"></a>
+ <a href="the__static__lexer_model.html#spirit.__lex__.abstracts.the__static__lexer_model.generating_the_static_analyzer">Generating
+ the Static Analyzer</a>
+ </h5>
+
+ The first additional step to perform in order to create a static lexical
+ analyzer is to create a small standalone program for creating the lexer
+ tables and the corresponding tokenization function. For this purpose the
+ Spirit.Lex library exposes a special API - the function
+ generate_static().
+ It implements the whole code generator, no further code is needed. All
+ what it takes to invoke this function is to supply a token definition instance,
+ an output stream to use to generate the code to, and an optional string
+ to be used as a prefix for the name of the generated function. All in all
+ just a couple lines of code.
+ 
+
+ 
+
+
+
+<pre class="programlisting">
+int main(int argc, char* argv[])
+{
+ // create the lexer object instance needed to invoke the generator
+ word_count_tokens<lexertl_lexer<> > word_count; // the token definition
+
+ // open the output file, where the generated tokenizer function will be
+ // written to
+ std::ofstream out(argc < 2 ? "word_count_static.hpp" : argv[1]);
+
+ // invoke the generator, passing the token definition, the output stream
+ // and the name prefix of the tokenizing function to be generated
+ char const* function_name = (argc < 3 ? "" : argv[2]);
+ return generate_static(make_lexer(word_count), out, function_name) ? 0 : -1;
+}
+</pre>
+
+ 
+
+ 
+
+ The shown code generator will generate output, which should be stored in
+ a file for later inclusion into the static lexical analzyer as shown in
+ the next topic (the full generated code can be viewed here).
+ 
+<a name="spirit.__lex__.abstracts.the__static__lexer_model.modifying_the_dynamic_analyzer"></a><h5>
+<a name="id488256"></a>
+ <a href="the__static__lexer_model.html#spirit.__lex__.abstracts.the__static__lexer_model.modifying_the_dynamic_analyzer">Modifying
+ the Dynamic Analyzer</a>
+ </h5>
+
+ The second required step to convert an existing dynamic lexer into a static
+ one is to change your main program at two places. First, you need to change
+ the type of the used lexer (that is the template parameter used while instantiating
+ your token definition class). While in the dynamic model we have been using
+ the lexertl_lexer<>
+ template, we now need to change that to the lexertl_static_lexer<>
+ type. The second change is tightly related to the first one and involves
+ correcting the corresponding <tt class="computeroutput">#include</tt>
+ statement to:
+ 
+
+ 
+
+
+
+<pre class="programlisting">
+#include <boost/spirit/include/lex_lexer_static_lexertl.hpp>
+</pre>
+
+ 
+
+ 
+
+ Otherwise the main program is not different from an equivalent program
+ using the dynamic model. This feature makes it really easy for instance
+ to develop the lexer in dynamic mode and to switch to the static mode after
+ the code has been stabilized. The simple generator application showed above
+ enables the integration of the code generator into any existing build process.
+ The following code snippet provides the overall main function, highlighting
+ the code to be changed.
+ 
+
+ 
+
+
+
+<pre class="programlisting">
+int main(int argc, char* argv[])
+{
+ // Define the token type to be used: 'std::string' is available as the type
+ // of the token value.
+ typedef lexertl_token<
+ char const*, boost::mpl::vector<std::string>
+ > token_type;
+
+ // Define the lexer type to be used as the base class for our token
+ // definition.
+ //
+ // This is the only place where the code is different from an equivalent
+ // dynamic lexical analyzer. We use the `lexertl_static_lexer<>` instead of
+ // the `lexertl_lexer<>` as the base class for our token defintion type.
+ //
+ typedef lexertl_static_lexer<token_type> lexer_type;
+
+ // Define the iterator type exposed by the lexer.
+ typedef lexer_iterator<word_count_tokens<lexer_type> >::type iterator_type;
+
+ // Now we use the types defined above to create the lexer and grammar
+ // object instances needed to invoke the parsing process.
+ word_count_tokens<lexer_type> word_count; // Our token definition
+ word_count_grammar<iterator_type> def (word_count); // Our grammar definition
+
+ // Read in the file into memory.
+ std::string str (read_from_file(1 == argc ? "word_count.input" : argv[1]));
+ char const* first = str.c_str();
+ char const* last = &first[str.size()];
+
+ // Parsing is done based on the the token stream, not the character stream.
+ qi::grammar<word_count_grammar<iterator_type> > g(def);
+ bool r = tokenize_and_parse(first, last, make_lexer(word_count), g);
+
+ if (r) { // success
+ std::cout << "lines: " << def.l << ", words: " << def.w
+ << ", characters: " << def.c << "\n";
+ }
+ else {
+ std::string rest(first, last);
+ std::cerr << "Parsing failed\n" << "stopped at: \""
+ << rest << "\"\n";
+ }
+ return 0;
+}
+</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-2008 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_semantic_actions.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_using_a_lexer.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/__lex__/abstracts/tokenizing_input_data.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/__lex__/abstracts/tokenizing_input_data.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,57 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Tokenizing
+ Input Data</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../../../index.html" title="Spirit 2.0">
+<link rel="up" href="../abstracts.html" title="Abstracts">
+<link rel="prev" href="../abstracts.html" title="Abstracts">
+<link rel="next" href="lexer_semantic_actions.html" title="Lexer
+ 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="../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>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="spirit.__lex__.abstracts.tokenizing_input_data"></a><a href="tokenizing_input_data.html" title="Tokenizing
+ Input Data">Tokenizing
+ Input Data</a></h4></div></div></div>
+<a name="spirit.__lex__.abstracts.tokenizing_input_data.the_tokenize___function"></a><h5>
+<a name="id486149"></a>
+ <a href="tokenizing_input_data.html#spirit.__lex__.abstracts.tokenizing_input_data.the_tokenize___function">The
+ tokenize() function</a>
+ </h5>
+<a name="spirit.__lex__.abstracts.tokenizing_input_data.the_generate_static___function"></a><h5>
+<a name="id486177"></a>
+ <a href="tokenizing_input_data.html#spirit.__lex__.abstracts.tokenizing_input_data.the_generate_static___function">The
+ generate_static() function</a>
+ </h5>
+</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-2008 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_semantic_actions.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/__lex__/quick_reference.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/__lex__/quick_reference.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,41 @@
+<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.66.1">
+<link rel="start" href="../../index.html" title="Spirit 2.0">
+<link rel="up" href="../__lex__.html" title="Spirit.Lex">
+<link rel="prev" href="abstracts/lexer_states.html" title="Lexer States">
+<link rel="next" href="reference.html" title="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="abstracts/lexer_states.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.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__.quick_reference"></a>Quick Reference</h3></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-2008 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/lexer_states.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.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/__lex__/reference.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/__lex__/reference.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,68 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Reference</title>
+<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../../index.html" title="Spirit 2.0">
+<link rel="up" href="../__lex__.html" title="Spirit.Lex">
+<link rel="prev" href="quick_reference.html" title="Quick Reference">
+<link rel="next" href="reference/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="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>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="spirit.__lex__.reference"></a>Reference</h3></div></div></div>
+<div class="toc"><dl>
+<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 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 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 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 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-2008 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="../__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>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/__lex__/reference/lexer_class.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/__lex__/reference/lexer_class.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,63 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Lexer Class</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../../../index.html" title="Spirit 2.0">
+<link rel="up" href="../reference.html" title="Reference">
+<link rel="prev" href="../reference.html" title="Reference">
+<link rel="next" href="token_class.html" title="Token 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="../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>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="spirit.__lex__.reference.lexer_class"></a>Lexer Class</h4></div></div></div>
+<a name="spirit.__lex__.reference.lexer_class.the_lexertl_lexer_class_implementing_the_dynamic_model"></a><h5>
+<a name="id489945"></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="id489974"></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="id490005"></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="id490034"></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>
+</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-2008 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="token_class.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/__lex__/reference/token_class.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/__lex__/reference/token_class.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,41 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Token Class</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../../../index.html" title="Spirit 2.0">
+<link rel="up" href="../reference.html" title="Reference">
+<link rel="prev" href="lexer_class.html" title="Lexer Class">
+<link rel="next" href="tokendef_class.html" title="TokenDef 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="lexer_class.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="tokendef_class.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.token_class"></a>Token Class</h4></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-2008 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_class.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="tokendef_class.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/__lex__/reference/tokendef_class.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/__lex__/reference/tokendef_class.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,41 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>TokenDef Class</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../../../index.html" title="Spirit 2.0">
+<link rel="up" href="../reference.html" title="Reference">
+<link rel="prev" href="token_class.html" title="Token Class">
+<link rel="next" href="tokenset_class.html" title="TokenSet 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="token_class.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="tokenset_class.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.tokendef_class"></a>TokenDef Class</h4></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-2008 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_class.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="tokenset_class.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/__lex__/reference/tokenset_class.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/__lex__/reference/tokenset_class.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,41 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>TokenSet Class</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../../../index.html" title="Spirit 2.0">
+<link rel="up" href="../reference.html" title="Reference">
+<link rel="prev" href="tokendef_class.html" title="TokenDef Class">
+<link rel="next" href="../../faq.html" title="FAQ">
+</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_class.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="../../faq.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.tokenset_class"></a>TokenSet Class</h4></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-2008 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_class.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="../../faq.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/acknowledgments.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/acknowledgments.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,239 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Acknowledgments</title>
+<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../index.html" title="Spirit 2.0">
+<link rel="up" href="../index.html" title="Spirit 2.0">
+<link rel="prev" href="rationale.html" title="Rationale">
+<link rel="next" href="references.html" title="References">
+</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="rationale.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"><div><div><h2 class="title" style="clear: both">
+<a name="spirit.acknowledgments"></a>Acknowledgments</h2></div></div></div>
+
+ This version of Spirit is a complete rewrite of the classic
+ Spirit many people have been contributing to (see below). But there are a couple
+ of people who already managed to help significantly during this rewrite. We
+ would like to express our special acknowledgement to:
+ 
+
+ Eric Niebler for writing Boost.Proto, without
+ which this rewrite wouldn't have been possible, and helping with examples,
+ advices, and suggestions on how to use Boost.Proto in the best possible way.
+ 
+
+ Ben Hanson for providing us with an early
+ version of his Lexertl library, which is proposed to be included into Boost
+ (as Boost.Lexer), but at the time of this writing the Boost review for this
+ library is still pending.
+ 
+
+ FIXME: Add more people
+ 
+<a name="spirit.acknowledgments.acknowledgements_from_the_spirit_v1__emphasis_classic__emphasis__documentation"></a><h3>
+<a name="id491052"></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>
+
+ Special thanks for working on Spirit classic to:
+ 
+
+ Dan Nuffer for his work on lexers, parse trees,
+ ASTs, XML parsers, the multi-pass iterator as well as administering Spirit's
+ site, editing, maintaining the CVS and doing the releases plus a zillion of
+ other chores that were almost taken for granted.
+ 
+
+ Hartmut Kaiser for his work on the C parser,
+ the work on the C/C++ preprocessor, utility parsers, the original port to Intel
+ 5.0, various work on Phoenix, porting to v1.5, the meta-parsers, the grouping-parsers,
+ extensive testing and painstaking attention to details.
+ 
+
+ Martin Wille who improved grammar multi thread
+ safety, contributed the eol_p parser, the dynamic parsers, documentation and
+ for taking an active role in almost every aspect from brainstorming and design
+ to coding. And, as always, helps keep the regression tests for g++ on Linux
+ as green as ever :-).
+ 
+
+ Martijn W. Van Der Lee our Web site administrator
+ and for contributing the RFC821 parser.
+ 
+
+ Giovanni Bajo for last minute tweaks of Spirit
+ 1.8.0 for CodeWarrior 8.3. Actually, I'm ashamed Giovanni was not in this list
+ already. He's done a lot since Spirit 1.5, the first Boost.Spirit release.
+ He's instrumental in the porting of the Spirit iterators stuff to the new Boost
+ Iterators Library (version 2). He also did various bug fixes and wrote some
+ tests here and there.
+ 
+
+ Juan Carlos Arevalo-Baeza (JCAB)* for his
+ work on the C++ parser, the position iterator, ports to v1.5 and keeping the
+ mailing list discussions alive and kicking.
+ 
+
+ Vaclav Vesely, lots of stuff, the no_actions
+ directive, various patches fixes, the distinct parsers, the lazy parser, some
+ phoenix tweaks and add-ons (e.g. new_). Also, *Stefan Slapeta] and wife for
+ editing Vaclav's distinct parser doc.
+ 
+
+ Raghavendra Satish for doing the original
+ v1.3 port to VC++ and his work on Phoenix.
+ 
+
+ Noah Stein for following up and helping Ragav
+ on the VC++ ports.
+ 
+
+ Hakki Dogusan, for his original v1.0 Pascal
+ parser.
+ 
+
+ John (EBo) David for his work on the VM and
+ watching over my shoulder as I code giving the impression of distance eXtreme
+ programming.
+ 
+
+ Chris Uzdavinis for feeding in comments and
+ valuable suggestions as well as editing the documentation.
+ 
+
+ Carsten Stoll, for his work on dynamic parsers.
+ 
+
+ Andy Elvey and his conifer parser.
+ 
+
+ Bruce Florman, who did the original v1.0 port
+ to VC++.
+ 
+
+ Jeff Westfahl for porting the loop parsers
+ to v1.5 and contributing the file iterator.
+ 
+
+ Peter Simons for the RFC date parser example
+ and tutorial plus helping out with some nitty gritty details.
+ 
+
+ Markus Schöpflin for suggesting the end_p parser
+ and lots of other nifty things and his active presence in the mailing list.
+ 
+
+ Doug Gregor for mentoring and his ability
+ to see things that others don't.
+ 
+
+ David Abrahams for giving Joel a job that
+ allows him to still work on Spirit, plus countless advice and help on C++ and
+ specifically template metaprogramming.
+ 
+
+ Aleksey Gurtovoy for his MPL library from
+ which we stole many metaprogramming tricks especially for less conforming compilers
+ such as Borland and VC6/7.
+ 
+
+ Gustavo Guerra for his last minute review
+ of Spirit and constant feedback, plus patches here and there (e.g. proposing
+ the new dot behavior of the real numerics parsers).
+ 
+
+ Nicola Musatti, Paul
+ Snively, Alisdair Meredith and
+ Hugo Duncan for testing and sending in various
+ patches.
+ 
+
+ Steve Rowe for his splendid work on the TSTs
+ that will soon be taken into Spirit.
+ 
+
+ Jonathan de Halleux for his work on actors.
+ 
+
+ Angus Leeming for last minute editing work
+ on the 1.8.0 release documentation, his work on Phoenix and his active presence
+ in the Spirit mailing list.
+ 
+
+ Joao Abecasis for his active presence in the
+ Spirit mailing list, providing user support, participating in the discussions
+ and so on.
+ 
+
+ Guillaume Melquiond for a last minute patch
+ to multi_pass for 1.8.1.
+ 
+
+ Peder Holt for his porting work on Phoenix,
+ Fusion and Spirit to VC6.
+ 
+
+ To Joels wife Mariel who did the graphics in this document.
+ 
+
+ My, there's a lot in this list! And it's a continuing list. We add people to
+ this list everytime. We hope we did not forget anyone. If we missed someone
+ you know who has helped in any way, please inform us.
+ 
+
+ Special thanks also to people who gave feedback and valuable comments, particularly
+ members of Boost and Spirit mailing lists. This includes all those who participated
+ in the review:
+ 
+
+ John Maddock, our review manager, Aleksey Gurtovoy, Andre Hentz,
+ Beman Dawes, Carl Daniel,
+ Christopher Currie, Dan
+ Gohman, Dan Nuffer, Daryle
+ Walker, David Abrahams, David B. Held, Dirk Gerrits,
+ Douglas Gregor, Hartmut
+ Kaiser, Iain K.Hanson, Juan Carlos Arevalo-Baeza, Larry
+ Evans, Martin Wille, Mattias Flodin, Noah Stein,
+ Nuno Lucas, Peter Dimov,
+ Peter Simons, Petr Kocmid,
+ Ross Smith, Scott Kirkwood,
+ Steve Cleary, Thorsten
+ Ottosen, Tom Wenisch, Vladimir Prus
+ 
+
+ Finally thanks to SourceForge for hosting the Spirit project and Boost: a C++
+ community comprised of extremely talented library authors who participate in
+ the discussion and peer review of well crafted C++ libraries.
+ 
+</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-2008 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="rationale.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>

Added: trunk/libs/spirit/doc/html/spirit/faq.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/faq.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,41 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>FAQ</title>
+<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../index.html" title="Spirit 2.0">
+<link rel="up" href="../index.html" title="Spirit 2.0">
+<link rel="prev" href="__lex__/reference/tokenset_class.html" title="TokenSet Class">
+<link rel="next" href="notes.html" title="Notes">
+</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__/reference/tokenset_class.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.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.faq"></a>FAQ</h2></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-2008 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__/reference/tokenset_class.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.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/introduction.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/introduction.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,464 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Introduction</title>
+<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../index.html" title="Spirit 2.0">
+<link rel="up" href="../index.html" title="Spirit 2.0">
+<link rel="prev" href="what_s_new.html" title="What's New">
+<link rel="next" href="qi_and_karma.html" title="Qi and Karma">
+</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="what_s_new.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_and_karma.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.introduction"></a>Introduction</h2></div></div></div>
+
+ Boost Spirit is an object oriented, recursive-descent parser and output generation
+ library for C++. It allows to write grammars and format descriptions using
+ a format very similar to EBNF (Extended Backus Naur Form, see [4]) directly
+ in C++. These inline grammar specifications can mix freely with other C++ code
+ and, thanks to the generative power of C++ templates, are immediately executable.
+ In retrospect, conventional compiler-compilers or parser-generators have to
+ perform an additional translation step from the source EBNF code to C or C++
+ code.
+ 
+
+ The syntax and semantics of the libraries API directly form domain specific
+ embedded languages (DSEL). In fact, Spirit exposes 3 different DSEL's to the
+ user:
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ one for creating parser grammars,
+ </li>
+<li>
+ one for the specification of the required tokens to be used for parsing,
+ </li>
+<li>
+ and one for the description of the required output formats.
+ </li>
+</ul></div>
+
+ Since the target input grammars and output formats are written entirely in
+ C++ we do not need any separate tools to compile, preprocess, or integrate
+ those into the build process. Spirit
+ allows seamless integration of the parsing and output generation process with
+ other C++ code. Often this allows for simpler and more efficient code.
+ 
+
+ Both, the created parsers and generators, are fully attributed which allows
+ to easily build and handle hierarchical data structures in memory. These data
+ structures resemble the structure of the input data and can directly be used
+ to generate arbitrarily formatted output.
+ 
+
+ The figure below depicts the
+ overall structure of the Boost Spirit library. The library consists out of
+ 4 major parts:
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+Spirit.Classic: This is the almost unchanged code base
+ taken from the former Boost Spirit V1.8 distribution. It has been moved into
+ the namespace boost::spirit::classic. A special compatibility layer has been
+ added to ensure complete compatibility with existing code using Spirit V1.8.
+ </li>
+<li>
+Spirit.Qi: This is the parser library allowing to build
+ recursive descent parsers. The exposed domain specific language can be used
+ to describe the grammars to implement, and the rules for storing the parsed
+ information.
+ </li>
+<li>
+Spirit.Lex: This is the library usable to create tokinizers
+ (lexers). The domain specific language exposed by Spirit.Lex
+</li>
+<li>
+Spirit.Karma: This is the generator library allowing
+ to create code for recursive descent, data type driven output formatting.
+ The exposed domain specific language is almost equivalent to the parser description
+ language used in Spirit.Qi, except that it is used to
+ describe the required output format to generate from a given data structure.
+ </li>
+</ul></div>
+
+ 
+<div class="figure">
+<a name="spirit.spiritstructure"></a>Figure 1. The overall structure of the Boost Spirit library
+<img src=".././images/spiritstructure.png" alt="The
+ overall structure of the Boost Spirit library">
+</div>
+
+ 
+
+ The separate sublibraries Spirit.Qi, Spirit.Karma
+ and Spirit.Lex are well integrated with any of the other
+ parts. Because of their similar structure and identical underlying technology
+ these are usable either separately or together at the same time. For instance
+ is it possible to directly feed the hierarchical data structures generated
+ by Spirit.Qi into output generators created using Spirit.Karma;
+ or to use the token sequence generated by Spirit.Lex as
+ the input for a parser generated by Spirit.Qi.
+ 
+
+ The <a href="introduction.html#spirit.spiritkarmaflow" title="Figure 2. The place of Spirit.Qi and Spirit.Karma
+ in a data transformation flow of a typical application">figure</a> below shows the typical
+ data flow of some input being converted to some internal representation. After
+ some (optional) transformation this data is converted back into some different,
+ external representation. The picture highlights Spirit's the place in this
+ data transformation flow.
+ 
+
+ 
+<div class="figure">
+<a name="spirit.spiritkarmaflow"></a>Figure 2. The place of Spirit.Qi and Spirit.Karma
+ in a data transformation flow of a typical application
+<img src=".././images/spiritkarmaflow.png" alt="The
+ place of Spirit.Qi and Spirit.Karma
+ in a data transformation flow of a typical application">
+</div>
+
+ 
+<a name="spirit.introduction.a_quick_overview_about_parsing_with__emphasis_spirit_qi__emphasis_"></a><h3>
+<a name="id456629"></a>
+ <a href="introduction.html#spirit.introduction.a_quick_overview_about_parsing_with__emphasis_spirit_qi__emphasis_">A
+ quick overview about Parsing with Spirit.Qi</a>
+ </h3>
+
+ Spirit.Qi is Spirit's sublibrary dealing with generating
+ parsers based on a given target grammar (essentially a format description of
+ the input data to read).
+ 
+
+ A simple EBNF grammar snippet:
+ 
+<pre class="programlisting">
+group ::= '(' expression ')'
+factor ::= integer | group
+term ::= factor (('*' factor) | ('/' factor))*
+expression ::= term (('+' term) | ('-' term))*
+</pre>
+
+ is approximated using facilities of Spirit's Qi sublibrary
+ as seen in this code snippet:
+ 
+<pre class="programlisting">
+group = '(' >> expression >> ')';
+factor = integer | group;
+term = factor >> *(('*' >> factor) | ('/' >> factor));
+expression = term >> *(('+' >> term) | ('-' >> term));
+</pre>
+
+ Through the magic of expression templates, this is perfectly valid and executable
+ C++ code. The production rule <tt class="computeroutput">expression</tt>
+ is in fact an object that has a member function parse that does the work given
+ a source code written in the grammar that we have just declared. Yes, it's
+ a calculator. We shall simplify for now by skipping the type declarations and
+ the definition of the rule integer invoked by factor. Now, the production rule
+ <tt class="computeroutput">expression</tt> in our grammar specification,
+ traditionally called the start symbol, can recognize inputs such as:
+ 
+<pre class="programlisting">
+12345
+-12345
++12345
+1 + 2
+1 * 2
+1/2 + 3/4
+1 + 2 + 3 + 4
+1 * 2 * 3 * 4
+(1 + 2) * (3 + 4)
+(-1 + 2) * (3 + -4)
+1 + ((6 * 200) - 20) / 6
+(1 + (2 + (3 + (4 + 5))))
+</pre>
+
+ Certainly we have done some modifications to the original EBNF syntax. This
+ is done to conform to C++ syntax rules. Most notably we see the abundance of
+ shift >> operators. Since there are no 'empty' operators in C++, it is
+ simply not possible to write something like:
+ 
+<pre class="programlisting">
+a b
+</pre>
+
+ as seen in math syntax, for example, to mean multiplication or, in our case,
+ as seen in EBNF syntax to mean sequencing (b should follow a). Spirit uses
+ the shift <tt class="computeroutput">>></tt> operator instead
+ for this purpose. We take the <tt class="computeroutput">>></tt>
+ operator, with arrows pointing to the right, to mean "is followed by".
+ Thus we write:
+ 
+<pre class="programlisting">
+a >> b
+</pre>
+
+ The alternative operator <tt class="computeroutput">|</tt> and
+ the parentheses <tt class="computeroutput">()</tt> remain as is.
+ The assignment operator <tt class="computeroutput">=</tt> is used
+ in place of EBNF's <tt class="computeroutput">::=</tt>. Last but
+ not least, the Kleene star <tt class="computeroutput">*</tt> which
+ used to be a postfix operator in EBNF becomes a prefix. Instead of:
+ 
+<pre class="programlisting">
+a* //... in EBNF syntax,
+</pre>
+
+ we write:
+ 
+<pre class="programlisting">
+*a //... in Spirit.
+</pre>
+
+ since there are no postfix stars, <tt class="computeroutput">*</tt>,
+ in C/C++. Finally, we terminate each rule with the ubiquitous semi-colon,
+ <tt class="computeroutput">;</tt>.
+ 
+<a name="spirit.introduction.a_quick_overview_about_output_generation_with__emphasis_spirit_karma__emphasis_"></a><h3>
+<a name="id457889"></a>
+ <a href="introduction.html#spirit.introduction.a_quick_overview_about_output_generation_with__emphasis_spirit_karma__emphasis_">A
+ quick overview about Output Generation with Spirit.Karma</a>
+ </h3>
+
+ Spirit not only allows to describe the structure of the input. Starting with
+ Version 2.0 it enables the specification of the output format for your data
+ in a very similar way, and based on a single syntax and compatible semantics.
+ 
+
+ Let's assume we need to generate a textual representation from a simple data
+ structure as a <tt class="computeroutput">std::vector<int></tt>. Conventional
+ code probably would look like:
+ 
+<pre class="programlisting">
+std::vector<int> v (initialize_and_fill());
+std::vector<int>::iterator end = v.end();
+for (std::vector<int>::iterator it = v.begin(); it != end; ++it)
+ std::cout << *it << std::endl;
+</pre>
+
+ which is not very flexible and quite difficult to maintain when it comes to
+ changing the required output format. Spirit's sublibrary Karma
+ allows to specify output formats for arbitrary data structures in a very flexible
+ way. following snippet is the Karma format description
+ used to create the very The same output as the traditional code above:
+ 
+<pre class="programlisting">
+*(int_ << eol)
+</pre>
+
+ Here are some more examples of format descriptions for different output representations
+ of the same <tt class="computeroutput">std::vector<int></tt>:
+ 
+<div class="table">
+<a name="id458364"></a>Table 2. Different output formats for `std::vector<int>`
+<table class="table" summary="Different output formats for `std::vector<int>`">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Format
+ 
+ </th>
+<th>
+ 
+ Example
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <tt class="computeroutput">'[' <<
+ *(int_
+ << ',') << ']'</tt>
+ 
+ </td>
+<td>
+ 
+ <tt class="computeroutput">[1,8,10,]</tt>
+ 
+ </td>
+<td>
+ 
+ Comma separated list of integers
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <tt class="computeroutput">*('('
+ << int_
+ << ')'
+ << ',')</tt>
+ 
+ </td>
+<td>
+ 
+ <tt class="computeroutput">(1),(8),(10),]</tt>
+ 
+ </td>
+<td>
+ 
+ Comma separated list of integers in parenthesis
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <tt class="computeroutput">*hex</tt>
+ 
+ </td>
+<td>
+ 
+ <tt class="computeroutput">18a</tt>
+ 
+ </td>
+<td>
+ 
+ A list of hexadecimal numbers
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <tt class="computeroutput">*(double_
+ << ',')</tt>
+ 
+ </td>
+<td>
+ 
+ <tt class="computeroutput">1.0,8.0,10.0,</tt>
+ 
+ </td>
+<td>
+ 
+ A list of floating point numbers
+ 
+ </td>
+</tr>
+</tbody>
+</table>
+</div>
+
+ The syntax is very similar to Qi with the exception that
+ we use the <tt class="computeroutput"><<</tt> operator for
+ output concatenation. This should be easy to understand as it follows the conventions
+ used in the Standard's I/O streams.
+ 
+
+ Another important feature of karma is to allow to fully
+ decouple the data type from the output format. You can use the same output
+ format with different data types as long as these conforma conceptually. The
+ next table gives some related examples.
+ 
+<div class="table">
+<a name="id458834"></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)`">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Data type
+ 
+ </th>
+<td class="auto-generated"> </td>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <tt class="computeroutput">int i[4]</tt>
+ 
+ </td>
+<td>
+ 
+ C style arrays
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <tt class="computeroutput">std::vector<int></tt>
+ 
+ </td>
+<td>
+ 
+ Standard vector
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <tt class="computeroutput">std::list<int></tt>
+ 
+ </td>
+<td>
+ 
+ Standard list
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <tt class="computeroutput">boost::array<long, 20></tt>
+ 
+ </td>
+<td>
+ 
+ Boost array
+ 
+ </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-2008 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="what_s_new.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_and_karma.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/notes.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/notes.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,53 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Notes</title>
+<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../index.html" title="Spirit 2.0">
+<link rel="up" href="../index.html" title="Spirit 2.0">
+<link rel="prev" href="faq.html" title="FAQ">
+<link rel="next" href="notes/porting_from_spirit_1_8_x.html" title="Porting from
+ Spirit 1.8.x">
+</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="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/porting_from_spirit_1_8_x.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.notes"></a>Notes</h2></div></div></div>
+<div class="toc"><dl>
+<dt>Portability</dt>
+<dt><a href="notes/porting_from_spirit_1_8_x.html">Porting from
+ Spirit 1.8.x</a></dt>
+<dt>Style Guide</dt>
+<dt>Techniques</dt>
+</dl></div>
+<div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title">
+<a name="spirit.notes.portability"></a>Portability</h3></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-2008 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="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/porting_from_spirit_1_8_x.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/notes/porting_from_spirit_1_8_x.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/notes/porting_from_spirit_1_8_x.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,44 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Porting from
+ Spirit 1.8.x</title>
+<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../../index.html" title="Spirit 2.0">
+<link rel="up" href="../notes.html" title="Notes">
+<link rel="prev" href="../notes.html" title="Notes">
+<link rel="next" href="style_guide.html" title="Style Guide">
+</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="style_guide.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.porting_from_spirit_1_8_x"></a><a href="porting_from_spirit_1_8_x.html" title="Porting from
+ Spirit 1.8.x">Porting from
+ Spirit 1.8.x</a></h3></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-2008 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="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 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,151 @@
+<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.66.1">
+<link rel="start" href="../../index.html" title="Spirit 2.0">
+<link rel="up" href="../notes.html" title="Notes">
+<link rel="prev" href="porting_from_spirit_1_8_x.html" title="Porting from
+ Spirit 1.8.x">
+<link rel="next" href="techniques.html" title="Techniques">
+</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="porting_from_spirit_1_8_x.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="techniques.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>
+
+ 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 (Terrence
+ Parr) and <a href="http://groups.yahoo.com/group/boost/files/coding_guidelines.html" target="_top">Boost
+ coding guidelines</a> (David Abrahams and Nathan Myers) 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-2008 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="porting_from_spirit_1_8_x.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="techniques.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/notes/techniques.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/notes/techniques.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,41 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Techniques</title>
+<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../../index.html" title="Spirit 2.0">
+<link rel="up" href="../notes.html" title="Notes">
+<link rel="prev" href="style_guide.html" title="Style Guide">
+<link rel="next" href="../rationale.html" title="Rationale">
+</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="style_guide.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="../rationale.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.techniques"></a>Techniques</h3></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-2008 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="style_guide.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="../rationale.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/qi_and_karma.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/qi_and_karma.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,1566 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Qi and Karma</title>
+<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../index.html" title="Spirit 2.0">
+<link rel="up" href="../index.html" title="Spirit 2.0">
+<link rel="prev" href="introduction.html" title="Introduction">
+<link rel="next" href="qi_and_karma/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="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="qi_and_karma/abstracts.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.qi_and_karma"></a>Qi and Karma</h2></div></div></div>
+<div class="toc"><dl>
+<dt>Tutorials</dt>
+<dd><dl>
+<dt>Quick Start</dt>
+<dt>Warming up</dt>
+<dt><a href="qi_and_karma.html#spirit.qi_and_karma.tutorials.semantic_actions">Semantic
+ Actions</a></dt>
+<dt><a href="qi_and_karma.html#spirit.qi_and_karma.tutorials.complex___our_first_complex_parser">Complex
+ - Our first complex parser</a></dt>
+<dt><a href="qi_and_karma.html#spirit.qi_and_karma.tutorials.sum___adding_numbers">Sum
+ - adding numbers</a></dt>
+<dt><a href="qi_and_karma.html#spirit.qi_and_karma.tutorials.number_list___stuffing_numbers_into_a_std__vector">Number
+ List - stuffing numbers into a std::vector</a></dt>
+<dt><a href="qi_and_karma.html#spirit.qi_and_karma.tutorials.number_list_redux___list_syntax">Number
+ List Redux - list syntax</a></dt>
+<dt><a href="qi_and_karma.html#spirit.qi_and_karma.tutorials.number_list_attribute___one_more__with_style">Number
+ List Attribute - one more, with style</a></dt>
+<dt><a href="qi_and_karma.html#spirit.qi_and_karma.tutorials.roman_numerals">Roman
+ Numerals</a></dt>
+</dl></dd>
+<dt>Abstracts</dt>
+<dd><dl>
+<dt><a href="qi_and_karma/abstracts.html#spirit.qi_and_karma.abstracts.parsing_expression_grammar">Parsing
+ Expression Grammar</a></dt>
+<dt>Parsing</dt>
+<dt><a href="qi_and_karma/abstracts/parsing_and_generating.html">Parsing
+ and Generating</a></dt>
+<dt>Primitives</dt>
+<dt>Operators</dt>
+<dt>Attributes</dt>
+<dt><a href="qi_and_karma/abstracts/semantic_actions.html">Semantic
+ Actions</a></dt>
+<dt>Directives</dt>
+<dt>Rules</dt>
+<dt>Grammars</dt>
+<dt>Debugging</dt>
+<dt><a href="qi_and_karma/abstracts/error_handling.html">Error
+ Handling</a></dt>
+<dt><a href="qi_and_karma/abstracts/parse_trees_and_asts.html">Parse
+ Trees and ASTs</a></dt>
+</dl></dd>
+<dt>Quick Reference</dt>
+<dt>Reference</dt>
+<dd><dl>
+<dt>Concepts</dt>
+<dt>Char</dt>
+<dt>String</dt>
+<dt>Numeric</dt>
+<dt>Binary</dt>
+<dt>Directive</dt>
+<dt>Action</dt>
+<dt>Nonterminal</dt>
+<dt>Operators</dt>
+<dt>Stream</dt>
+<dt>Auxiliary</dt>
+<dt>Debug</dt>
+</dl></dd>
+</dl></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="spirit.qi_and_karma.tutorials"></a>Tutorials</h3></div></div></div>
+<div class="toc"><dl>
+<dt>Quick Start</dt>
+<dt>Warming up</dt>
+<dt><a href="qi_and_karma.html#spirit.qi_and_karma.tutorials.semantic_actions">Semantic
+ Actions</a></dt>
+<dt><a href="qi_and_karma.html#spirit.qi_and_karma.tutorials.complex___our_first_complex_parser">Complex
+ - Our first complex parser</a></dt>
+<dt><a href="qi_and_karma.html#spirit.qi_and_karma.tutorials.sum___adding_numbers">Sum
+ - adding numbers</a></dt>
+<dt><a href="qi_and_karma.html#spirit.qi_and_karma.tutorials.number_list___stuffing_numbers_into_a_std__vector">Number
+ List - stuffing numbers into a std::vector</a></dt>
+<dt><a href="qi_and_karma.html#spirit.qi_and_karma.tutorials.number_list_redux___list_syntax">Number
+ List Redux - list syntax</a></dt>
+<dt><a href="qi_and_karma.html#spirit.qi_and_karma.tutorials.number_list_attribute___one_more__with_style">Number
+ List Attribute - one more, with style</a></dt>
+<dt><a href="qi_and_karma.html#spirit.qi_and_karma.tutorials.roman_numerals">Roman
+ Numerals</a></dt>
+</dl></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="spirit.qi_and_karma.tutorials.quick_start"></a>Quick Start</h4></div></div></div>
+<a name="spirit.qi_and_karma.tutorials.quick_start.why_would_you_want_to_use_spirit_qi_"></a><h5>
+<a name="id459151"></a>
+ <a href="qi_and_karma.html#spirit.qi_and_karma.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_and_karma.tutorials.warming_up"></a>Warming up</h4></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_and_karma.tutorials.warming_up.trivial_example__1_parsing_a_number"></a><h5>
+<a name="id459523"></a>
+ <a href="qi_and_karma.html#spirit.qi_and_karma.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_and_karma.tutorials.warming_up.trivial_example__2_parsing_two_numbers"></a><h5>
+<a name="id385053"></a>
+ <a href="qi_and_karma.html#spirit.qi_and_karma.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_and_karma.tutorials.warming_up.trivial_example__3_parsing_one_or_more_numbers"></a><h5>
+<a name="id385164"></a>
+ <a href="qi_and_karma.html#spirit.qi_and_karma.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 one 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_and_karma.tutorials.warming_up.trivial_example__4_parsing_a_comma_delimited_list_of_numbers"></a><h5>
+<a name="id459640"></a>
+ <a href="qi_and_karma.html#spirit.qi_and_karma.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_and_karma.tutorials.warming_up.let_s_parse_"></a><h5>
+<a name="id459835"></a>
+ <a href="qi_and_karma.html#spirit.qi_and_karma.tutorials.warming_up.let_s_parse_">Let's
+ Parse!</a>
+ </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)
+{
+ bool r = phrase_parse(
+ first, <a name="spirit0co" href="qi_and_karma.html#spirit0"><img src="../images/callouts/1.png" alt="1" border="0"></a>
+ last, <a name="spirit1co" href="qi_and_karma.html#spirit1"><img src="../images/callouts/2.png" alt="2" border="0"></a>
+ double_ >> *(',' >> double_), <a name="spirit2co" href="qi_and_karma.html#spirit2"><img src="../images/callouts/3.png" alt="3" border="0"></a>
+ space <a name="spirit3co" href="qi_and_karma.html#spirit3"><img 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_and_karma.tutorials.semantic_actions"></a><a href="qi_and_karma.html#spirit.qi_and_karma.tutorials.semantic_actions" title="Semantic
+ Actions">Semantic
+ Actions</a></h4></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">
+// A plain function
+void write(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 write_action
+{
+ void operator()(int const& i, unused_type, 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">
+qi::parse(first, last, '{' >> int_[&write] >> '}');
+</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">
+qi::parse(first, last, '{' >> int_[write_action()] >> '}');
+</pre>
+
+ 
+
+ 
+
+ We can use Boost.Bind
+ to 'bind' member functions:
+ 
+
+ 
+
+
+
+<pre class="programlisting">
+writer w;
+qi::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">
+qi::parse(first, last, '{' >> int_[boost::bind(&write, _1)] >> '}');
+</pre>
+
+ 
+
+ 
+
+ Yep, we can also use Boost.Lambda:
+ 
+
+ 
+
+
+
+<pre class="programlisting">
+qi::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_and_karma.tutorials.semantic_actions.phoenix"></a><h5>
+<a name="id462372"></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_and_karma.tutorials.complex___our_first_complex_parser"></a><a href="qi_and_karma.html#spirit.qi_and_karma.tutorials.complex___our_first_complex_parser" title="Complex
+ - Our first complex parser">Complex
+ - Our first complex parser</a></h4></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">
+template <typename Iterator>
+bool parse_complex(Iterator first, Iterator last, std::complex<double>& c)
+{
+ 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_and_karma.tutorials.sum___adding_numbers"></a><a href="qi_and_karma.html#spirit.qi_and_karma.tutorials.sum___adding_numbers" title="Sum
+ - adding numbers">Sum
+ - adding numbers</a></h4></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">
+using namespace boost::phoenix;
+using namespace boost::spirit;
+using namespace boost::spirit::qi;
+using namespace boost::spirit::ascii;
+using namespace boost::spirit::arg_names;
+</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 = 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/actions.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_and_karma.tutorials.number_list___stuffing_numbers_into_a_std__vector"></a><a href="qi_and_karma.html#spirit.qi_and_karma.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>
+
+ 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)
+{
+ 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_and_karma.tutorials.number_list_redux___list_syntax"></a><a href="qi_and_karma.html#spirit.qi_and_karma.tutorials.number_list_redux___list_syntax" title="Number
+ List Redux - list syntax">Number
+ List Redux - list syntax</a></h4></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)
+{
+ 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_and_karma.tutorials.number_list_attribute___one_more__with_style"></a><a href="qi_and_karma.html#spirit.qi_and_karma.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>
+
+ 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)
+{
+ bool r = phrase_parse(first, last,
+
+ // Begin grammar
+ (
+ double_ % ','
+ )
+ ,
+ // End grammar
+
+ v, 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_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_and_karma.tutorials.roman_numerals"></a><a href="qi_and_karma.html#spirit.qi_and_karma.tutorials.roman_numerals" title="Roman
+ Numerals">Roman
+ Numerals</a></h4></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_and_karma.tutorials.roman_numerals.symbol_table"></a><h5>
+<a name="id466741"></a>
+ <a href="qi_and_karma.html#spirit.qi_and_karma.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_ : 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_ : 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_ : 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_and_karma.tutorials.roman_numerals.rules"></a><h5>
+<a name="id468029"></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_and_karma.tutorials.roman_numerals.grammars"></a><h5>
+<a name="id468623"></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 : grammar<Iterator, unsigned()>
+{
+ roman() : roman::base_type(start)
+ {
+ start = eps [_val = 0] >>
+ (
+ +char_('M') [_val += 1000]
+ || hundreds [_val += _1]
+ || tens [_val += _1]
+ || ones [_val += _1]
+ )
+ ;
+ }
+
+ 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_and_karma.tutorials.roman_numerals.let_s_parse_"></a><h5>
+<a name="id469487"></a>
+ <a href="qi_and_karma.html#spirit.qi_and_karma.tutorials.roman_numerals.let_s_parse_">Let's
+ Parse!</a>
+ </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.
+ 
+</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-2008 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="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="qi_and_karma/abstracts.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/qi_and_karma/abstracts.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/qi_and_karma/abstracts.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,67 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Abstracts</title>
+<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../../index.html" title="Spirit 2.0">
+<link rel="up" href="../qi_and_karma.html" title="Qi and Karma">
+<link rel="prev" href="../qi_and_karma.html" title="Qi and Karma">
+<link rel="next" href="abstracts/parsing.html" title="Parsing">
+</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_and_karma.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../qi_and_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="abstracts/parsing.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_and_karma.abstracts"></a>Abstracts</h3></div></div></div>
+<div class="toc"><dl>
+<dt><a href="abstracts.html#spirit.qi_and_karma.abstracts.parsing_expression_grammar">Parsing
+ Expression Grammar</a></dt>
+<dt>Parsing</dt>
+<dt><a href="abstracts/parsing_and_generating.html">Parsing
+ and Generating</a></dt>
+<dt>Primitives</dt>
+<dt>Operators</dt>
+<dt>Attributes</dt>
+<dt><a href="abstracts/semantic_actions.html">Semantic
+ Actions</a></dt>
+<dt>Directives</dt>
+<dt>Rules</dt>
+<dt>Grammars</dt>
+<dt>Debugging</dt>
+<dt><a href="abstracts/error_handling.html">Error
+ Handling</a></dt>
+<dt><a href="abstracts/parse_trees_and_asts.html">Parse
+ Trees and ASTs</a></dt>
+</dl></div>
+<div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title">
+<a name="spirit.qi_and_karma.abstracts.parsing_expression_grammar"></a><a href="abstracts.html#spirit.qi_and_karma.abstracts.parsing_expression_grammar" title="Parsing
+ Expression Grammar">Parsing
+ Expression Grammar</a></h4></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-2008 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_and_karma.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../qi_and_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="abstracts/parsing.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/qi_and_karma/abstracts/attributes.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/qi_and_karma/abstracts/attributes.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,42 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Attributes</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../../../index.html" title="Spirit 2.0">
+<link rel="up" href="../abstracts.html" title="Abstracts">
+<link rel="prev" href="operators.html" title="Operators">
+<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="operators.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="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_and_karma.abstracts.attributes"></a>Attributes</h4></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-2008 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="operators.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="semantic_actions.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/qi_and_karma/abstracts/debugging.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/qi_and_karma/abstracts/debugging.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,42 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Debugging</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../../../index.html" title="Spirit 2.0">
+<link rel="up" href="../abstracts.html" title="Abstracts">
+<link rel="prev" href="grammars.html" title="Grammars">
+<link rel="next" href="error_handling.html" title="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="grammars.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="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_and_karma.abstracts.debugging"></a>Debugging</h4></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-2008 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="grammars.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="error_handling.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/qi_and_karma/abstracts/directives.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/qi_and_karma/abstracts/directives.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,42 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Directives</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../../../index.html" title="Spirit 2.0">
+<link rel="up" href="../abstracts.html" title="Abstracts">
+<link rel="prev" href="semantic_actions.html" title="Semantic
+ Actions">
+<link rel="next" href="rules.html" title="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="semantic_actions.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="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.qi_and_karma.abstracts.directives"></a>Directives</h4></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-2008 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="../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="rules.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/qi_and_karma/abstracts/error_handling.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/qi_and_karma/abstracts/error_handling.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,45 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Error
+ Handling</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../../../index.html" title="Spirit 2.0">
+<link rel="up" href="../abstracts.html" title="Abstracts">
+<link rel="prev" href="debugging.html" title="Debugging">
+<link rel="next" href="parse_trees_and_asts.html" title="Parse
+ Trees and 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="debugging.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="parse_trees_and_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_and_karma.abstracts.error_handling"></a><a href="error_handling.html" title="Error
+ Handling">Error
+ Handling</a></h4></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-2008 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="debugging.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="parse_trees_and_asts.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/qi_and_karma/abstracts/grammars.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/qi_and_karma/abstracts/grammars.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,41 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Grammars</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../../../index.html" title="Spirit 2.0">
+<link rel="up" href="../abstracts.html" title="Abstracts">
+<link rel="prev" href="rules.html" title="Rules">
+<link rel="next" href="debugging.html" title="Debugging">
+</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="rules.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="debugging.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_and_karma.abstracts.grammars"></a>Grammars</h4></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-2008 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="rules.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="debugging.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/qi_and_karma/abstracts/operators.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/qi_and_karma/abstracts/operators.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,41 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Operators</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../../../index.html" title="Spirit 2.0">
+<link rel="up" href="../abstracts.html" title="Abstracts">
+<link rel="prev" href="primitives.html" title="Primitives">
+<link rel="next" href="attributes.html" title="Attributes">
+</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="primitives.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="attributes.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_and_karma.abstracts.operators"></a>Operators</h4></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-2008 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="primitives.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="attributes.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/qi_and_karma/abstracts/parse_trees_and_asts.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/qi_and_karma/abstracts/parse_trees_and_asts.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,45 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Parse
+ Trees and ASTs</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../../../index.html" title="Spirit 2.0">
+<link rel="up" href="../abstracts.html" title="Abstracts">
+<link rel="prev" href="error_handling.html" title="Error
+ Handling">
+<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="error_handling.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="../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_and_karma.abstracts.parse_trees_and_asts"></a><a href="parse_trees_and_asts.html" title="Parse
+ Trees and ASTs">Parse
+ Trees and ASTs</a></h4></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-2008 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="error_handling.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="../quick_reference.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/qi_and_karma/abstracts/parsing.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/qi_and_karma/abstracts/parsing.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,98 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Parsing</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../../../index.html" title="Spirit 2.0">
+<link rel="up" href="../abstracts.html" title="Abstracts">
+<link rel="prev" href="../abstracts.html" title="Abstracts">
+<link rel="next" href="parsing_and_generating.html" title="Parsing
+ and Generating">
+</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_and_generating.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_and_karma.abstracts.parsing"></a>Parsing</h4></div></div></div>
+
+ Central to the library is the parser. The parser does the actual work of
+ recognizing a linear input stream of data read sequentially from start
+ to end by the supplied iterators. The parser attempts to match the input
+ following a well-defined set of specifications known as grammar rules.
+ The parser returns a <tt class="computeroutput">bool</tt>
+ to report the success or failure. When successful, the parser calls a client-supplied
+ semantic action, if there is one. The semantic action extracts structural
+ information depending on the data passed by the parser and the hierarchical
+ context of the parser it is attached to.
+ 
+
+ Parsers come in different flavors. The Spirit library comes bundled with
+ an extensive set of pre-defined parsers that perform various parsing tasks
+ from the trivial to the complex. The parser, as a concept, has a public
+ conceptual interface contract. Following the contract, anyone can write
+ a conforming parser that will play along well with the library's predefined
+ components. We shall provide a blueprint detailing the conceptual interface
+ of the parser later.
+ 
+
+ Clients of the library generally do not need to write their own hand-coded
+ parsers at all. Spirit has an immense repertoire of pre-defined parsers
+ covering all aspects of syntax and semantic analysis. We shall examine
+ this repertoire of parsers in the following sections. In the rare case
+ where a specific functionality is not available, it is extremely easy to
+ write a user-defined parser. The ease in writing a parser entity is the
+ main reason for Spirit's extensibility.
+ 
+<a name="spirit.qi_and_karma.abstracts.parsing.the_api_functions_exposed_by__emphasis_spirit_qi__emphasis__"></a><h5>
+<a name="id470217"></a>
+ <a href="parsing.html#spirit.qi_and_karma.abstracts.parsing.the_api_functions_exposed_by__emphasis_spirit_qi__emphasis__">The
+ API functions exposed by Spirit.Qi </a>
+ </h5>
+<a name="spirit.qi_and_karma.abstracts.parsing.the_parse___function"></a><h5>
+<a name="id470249"></a>
+ <a href="parsing.html#spirit.qi_and_karma.abstracts.parsing.the_parse___function">The
+ parse() function</a>
+ </h5>
+<a name="spirit.qi_and_karma.abstracts.parsing.the_phrase_parse___function"></a><h5>
+<a name="id470278"></a>
+ <a href="parsing.html#spirit.qi_and_karma.abstracts.parsing.the_phrase_parse___function">The
+ phrase_parse() function</a>
+ </h5>
+<a name="spirit.qi_and_karma.abstracts.parsing.the_tokenize_and_parse___function"></a><h5>
+<a name="id470305"></a>
+ <a href="parsing.html#spirit.qi_and_karma.abstracts.parsing.the_tokenize_and_parse___function">The
+ tokenize_and_parse() function</a>
+ </h5>
+<a name="spirit.qi_and_karma.abstracts.parsing.the_tokenize_and_phrase_parse___function"></a><h5>
+<a name="id470334"></a>
+ <a href="parsing.html#spirit.qi_and_karma.abstracts.parsing.the_tokenize_and_phrase_parse___function">The
+ tokenize_and_phrase_parse() function</a>
+ </h5>
+</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-2008 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_and_generating.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/qi_and_karma/abstracts/parsing_and_generating.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/qi_and_karma/abstracts/parsing_and_generating.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,71 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Parsing
+ and Generating</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../../../index.html" title="Spirit 2.0">
+<link rel="up" href="../abstracts.html" title="Abstracts">
+<link rel="prev" href="parsing.html" title="Parsing">
+<link rel="next" href="primitives.html" title="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="parsing.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="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.qi_and_karma.abstracts.parsing_and_generating"></a><a href="parsing_and_generating.html" title="Parsing
+ and Generating">Parsing
+ and Generating</a></h4></div></div></div>
+<a name="spirit.qi_and_karma.abstracts.parsing_and_generating.the_api_functions_exposed_by__emphasis_spirit_qi__emphasis__"></a><h5>
+<a name="id470392"></a>
+ <a href="parsing_and_generating.html#spirit.qi_and_karma.abstracts.parsing_and_generating.the_api_functions_exposed_by__emphasis_spirit_qi__emphasis__">The
+ API functions exposed by Spirit.Qi </a>
+ </h5>
+<a name="spirit.qi_and_karma.abstracts.parsing_and_generating.the_parse___function"></a><h5>
+<a name="id470427"></a>
+ <a href="parsing_and_generating.html#spirit.qi_and_karma.abstracts.parsing_and_generating.the_parse___function">The
+ parse() function</a>
+ </h5>
+<a name="spirit.qi_and_karma.abstracts.parsing_and_generating.the_phrase_parse___function"></a><h5>
+<a name="id470457"></a>
+ <a href="parsing_and_generating.html#spirit.qi_and_karma.abstracts.parsing_and_generating.the_phrase_parse___function">The
+ phrase_parse() function</a>
+ </h5>
+<a name="spirit.qi_and_karma.abstracts.parsing_and_generating.the_tokenize_and_parse___function"></a><h5>
+<a name="id470486"></a>
+ <a href="parsing_and_generating.html#spirit.qi_and_karma.abstracts.parsing_and_generating.the_tokenize_and_parse___function">The
+ tokenize_and_parse() function</a>
+ </h5>
+<a name="spirit.qi_and_karma.abstracts.parsing_and_generating.the_tokenize_and_phrase_parse___function"></a><h5>
+<a name="id470518"></a>
+ <a href="parsing_and_generating.html#spirit.qi_and_karma.abstracts.parsing_and_generating.the_tokenize_and_phrase_parse___function">The
+ tokenize_and_phrase_parse() function</a>
+ </h5>
+</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-2008 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="parsing.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="primitives.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/qi_and_karma/abstracts/primitives.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/qi_and_karma/abstracts/primitives.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,42 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Primitives</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../../../index.html" title="Spirit 2.0">
+<link rel="up" href="../abstracts.html" title="Abstracts">
+<link rel="prev" href="parsing_and_generating.html" title="Parsing
+ and Generating">
+<link rel="next" href="operators.html" title="Operators">
+</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="parsing_and_generating.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="operators.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_and_karma.abstracts.primitives"></a>Primitives</h4></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-2008 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="parsing_and_generating.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="operators.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/qi_and_karma/abstracts/rules.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/qi_and_karma/abstracts/rules.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,41 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Rules</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../../../index.html" title="Spirit 2.0">
+<link rel="up" href="../abstracts.html" title="Abstracts">
+<link rel="prev" href="directives.html" title="Directives">
+<link rel="next" href="grammars.html" title="Grammars">
+</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="directives.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="grammars.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_and_karma.abstracts.rules"></a>Rules</h4></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-2008 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="directives.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="grammars.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/qi_and_karma/abstracts/semantic_actions.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/qi_and_karma/abstracts/semantic_actions.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,44 @@
+<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.66.1">
+<link rel="start" href="../../../index.html" title="Spirit 2.0">
+<link rel="up" href="../abstracts.html" title="Abstracts">
+<link rel="prev" href="attributes.html" title="Attributes">
+<link rel="next" href="directives.html" title="Directives">
+</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="attributes.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="directives.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_and_karma.abstracts.semantic_actions"></a><a href="semantic_actions.html" title="Semantic
+ Actions">Semantic
+ Actions</a></h4></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-2008 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="attributes.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="directives.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/qi_and_karma/quick_reference.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/qi_and_karma/quick_reference.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,364 @@
+<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.66.1">
+<link rel="start" href="../../index.html" title="Spirit 2.0">
+<link rel="up" href="../qi_and_karma.html" title="Qi and Karma">
+<link rel="prev" href="abstracts/parse_trees_and_asts.html" title="Parse
+ Trees and ASTs">
+<link rel="next" href="reference.html" title="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="abstracts/parse_trees_and_asts.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../qi_and_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="reference.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_and_karma.quick_reference"></a>Quick Reference</h3></div></div></div>
+
+ The following tables use some conventions to encode the attribute type exposed
+ by a component
+ 
+<div class="variablelist">
+
+<dl>
+<dt><tt class="computeroutput">attribute_of(P)</tt></dt>
+<dd>
+ The component exposes the same attribute as the component 'P' used as
+ part of the overall construct
+ </dd>
+<dt><tt class="computeroutput">value_type(I)</tt></dt>
+<dd>
+ The component exposes the value_type of the underlying iterator 'I' as
+ its attribute type
+ </dd>
+</dl>
+</div>
+<div class="table">
+<a name="id470857"></a>Table 4. Character Parsers
+<table class="table" summary="Character Parsers">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Component
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+<th>
+ 
+ Attribute
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <tt class="computeroutput">char_</tt>
+ 
+ </td>
+<td>
+ 
+ 
+ </td>
+<td>
+ 
+ <tt class="computeroutput">char</tt>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <tt class="computeroutput">wchar</tt>
+ 
+ </td>
+<td>
+ 
+ 
+ </td>
+<td>
+ 
+ <tt class="computeroutput">wchar_t</tt>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <tt class="computeroutput">lit</tt>
+ 
+ </td>
+<td>
+ 
+ 
+ </td>
+<td>
+ 
+ <tt class="computeroutput">unused</tt>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <tt class="computeroutput">wlit</tt>
+ 
+ </td>
+<td>
+ 
+ 
+ </td>
+<td>
+ 
+ <tt class="computeroutput">unused</tt>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <tt class="computeroutput">'x'</tt>
+ 
+ </td>
+<td>
+ 
+ 
+ </td>
+<td>
+ 
+ <tt class="computeroutput">unused</tt>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <tt class="computeroutput">L'x'</tt>
+ 
+ </td>
+<td>
+ 
+ 
+ </td>
+<td>
+ 
+ <tt class="computeroutput">unused</tt>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <tt class="computeroutput">alnum</tt>
+ 
+ </td>
+<td>
+ 
+ 
+ </td>
+<td>
+ 
+ <tt class="computeroutput">Char</tt>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <tt class="computeroutput">alpha</tt>
+ 
+ </td>
+<td>
+ 
+ 
+ </td>
+<td>
+ 
+ <tt class="computeroutput">Char</tt>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <tt class="computeroutput">blank</tt>
+ 
+ </td>
+<td>
+ 
+ 
+ </td>
+<td>
+ 
+ <tt class="computeroutput">Char</tt>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <tt class="computeroutput">cntrl</tt>
+ 
+ </td>
+<td>
+ 
+ 
+ </td>
+<td>
+ 
+ <tt class="computeroutput">Char</tt>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <tt class="computeroutput">digit</tt>
+ 
+ </td>
+<td>
+ 
+ 
+ </td>
+<td>
+ 
+ <tt class="computeroutput">Char</tt>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <tt class="computeroutput">graph</tt>
+ 
+ </td>
+<td>
+ 
+ 
+ </td>
+<td>
+ 
+ <tt class="computeroutput">Char</tt>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <tt class="computeroutput">print</tt>
+ 
+ </td>
+<td>
+ 
+ 
+ </td>
+<td>
+ 
+ <tt class="computeroutput">Char</tt>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <tt class="computeroutput">punct</tt>
+ 
+ </td>
+<td>
+ 
+ 
+ </td>
+<td>
+ 
+ <tt class="computeroutput">Char</tt>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <tt class="computeroutput">space</tt>
+ 
+ </td>
+<td>
+ 
+ 
+ </td>
+<td>
+ 
+ <tt class="computeroutput">Char</tt>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <tt class="computeroutput">xdigit</tt>
+ 
+ </td>
+<td>
+ 
+ 
+ </td>
+<td>
+ 
+ <tt class="computeroutput">Char</tt>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <tt class="computeroutput">~P</tt>
+ 
+ </td>
+<td>
+ 
+ 
+ </td>
+<td>
+ 
+ <tt class="computeroutput">attribute_of(P)</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-2008 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/parse_trees_and_asts.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../qi_and_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="reference.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/qi_and_karma/reference.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/qi_and_karma/reference.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,196 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Reference</title>
+<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../../index.html" title="Spirit 2.0">
+<link rel="up" href="../qi_and_karma.html" title="Qi and Karma">
+<link rel="prev" href="quick_reference.html" title="Quick Reference">
+<link rel="next" href="reference/char.html" title="Char">
+</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="../qi_and_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="reference/char.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_and_karma.reference"></a>Reference</h3></div></div></div>
+<div class="toc"><dl>
+<dt>Concepts</dt>
+<dt>Char</dt>
+<dt>String</dt>
+<dt>Numeric</dt>
+<dt>Binary</dt>
+<dt>Directive</dt>
+<dt>Action</dt>
+<dt>Nonterminal</dt>
+<dt>Operators</dt>
+<dt>Stream</dt>
+<dt>Auxiliary</dt>
+<dt>Debug</dt>
+</dl></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="spirit.qi_and_karma.reference.concepts"></a>Concepts</h4></div></div></div>
+<div class="toc"><dl>
+<dt>Parser</dt>
+<dt>Generator</dt>
+</dl></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="spirit.qi_and_karma.reference.concepts.parser"></a>Parser</h5></div></div></div>
+<a name="spirit.qi_and_karma.reference.concepts.parser.description"></a><h6>
+<a name="id471774"></a>
+ Description
+ </h6>
+
+ Description of Parser concept
+ 
+<div class="variablelist">
+Notation
+<dl>
+<dt><tt class="computeroutput">p</tt></dt>
+<dd>
+ A Parser
+ </dd>
+</dl>
+</div>
+<a name="spirit.qi_and_karma.reference.concepts.parser.valid_expressions"></a><h6>
+<a name="id471834"></a>
+ <a href="reference.html#spirit.qi_and_karma.reference.concepts.parser.valid_expressions">Valid
+ Expressions</a>
+ </h6>
+
+ For any Parser the following expressions must be valid:
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Expression
+ 
+ </th>
+<th>
+ 
+ Semantics
+ 
+ </th>
+<th>
+ 
+ Return type
+ 
+ </th>
+<th>
+ 
+ Complexity
+ 
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ 
+ <tt class="computeroutput">xxx</tt>
+ 
+ </td>
+<td>
+ 
+ Semantics of <tt class="computeroutput">xxx</tt>
+ 
+ </td>
+<td>
+ 
+ Parser
+ 
+ </td>
+<td>
+ 
+ Constant
+ 
+ </td>
+</tr></tbody>
+</table></div>
+<a name="spirit.qi_and_karma.reference.concepts.parser.type_requirements"></a><h6>
+<a name="id471970"></a>
+ <a href="reference.html#spirit.qi_and_karma.reference.concepts.parser.type_requirements">Type
+ Requirements</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Expression
+ 
+ </th>
+<th>
+ 
+ Requirements
+ 
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ 
+ <tt class="computeroutput">xxx</tt>
+ 
+ </td>
+<td>
+ 
+ Requirements for <tt class="computeroutput">xxx</tt>
+ 
+ </td>
+</tr></tbody>
+</table></div>
+<a name="spirit.qi_and_karma.reference.concepts.parser.invariants"></a><h6>
+<a name="id472074"></a>
+ Invariants
+ </h6>
+
+ For any Parser xxx the following invariants always hold:
+ 
+<a name="spirit.qi_and_karma.reference.concepts.parser.models"></a><h6>
+<a name="id472104"></a>
+ Models
+ </h6>
+
+ Links to models of Parser concept
+ 
+</div>
+<div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title">
+<a name="spirit.qi_and_karma.reference.concepts.generator"></a>Generator</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-2008 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="../qi_and_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="reference/char.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/qi_and_karma/reference/action.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/qi_and_karma/reference/action.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,41 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Action</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../../../index.html" title="Spirit 2.0">
+<link rel="up" href="../reference.html" title="Reference">
+<link rel="prev" href="directive.html" title="Directive">
+<link rel="next" href="nonterminal.html" title="Nonterminal">
+</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="directive.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="nonterminal.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_and_karma.reference.action"></a>Action</h4></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-2008 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="directive.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="nonterminal.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/qi_and_karma/reference/auxiliary.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/qi_and_karma/reference/auxiliary.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,41 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Auxiliary</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../../../index.html" title="Spirit 2.0">
+<link rel="up" href="../reference.html" title="Reference">
+<link rel="prev" href="stream.html" title="Stream">
+<link rel="next" href="debug.html" title="Debug">
+</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="stream.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="debug.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_and_karma.reference.auxiliary"></a>Auxiliary</h4></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-2008 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="stream.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="debug.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/qi_and_karma/reference/binary.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/qi_and_karma/reference/binary.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,41 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Binary</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../../../index.html" title="Spirit 2.0">
+<link rel="up" href="../reference.html" title="Reference">
+<link rel="prev" href="numeric.html" title="Numeric">
+<link rel="next" href="directive.html" title="Directive">
+</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="numeric.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="directive.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_and_karma.reference.binary"></a>Binary</h4></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-2008 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="numeric.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="directive.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/qi_and_karma/reference/char.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/qi_and_karma/reference/char.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,41 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Char</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../../../index.html" title="Spirit 2.0">
+<link rel="up" href="../reference.html" title="Reference">
+<link rel="prev" href="../reference.html" title="Reference">
+<link rel="next" href="string.html" title="String">
+</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="string.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_and_karma.reference.char"></a>Char</h4></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-2008 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="string.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/qi_and_karma/reference/debug.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/qi_and_karma/reference/debug.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,41 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Debug</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../../../index.html" title="Spirit 2.0">
+<link rel="up" href="../reference.html" title="Reference">
+<link rel="prev" href="auxiliary.html" title="Auxiliary">
+<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="auxiliary.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="../../__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.qi_and_karma.reference.debug"></a>Debug</h4></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-2008 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="auxiliary.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="../../__lex__.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/qi_and_karma/reference/directive.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/qi_and_karma/reference/directive.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,41 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Directive</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../../../index.html" title="Spirit 2.0">
+<link rel="up" href="../reference.html" title="Reference">
+<link rel="prev" href="binary.html" title="Binary">
+<link rel="next" href="action.html" title="Action">
+</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="binary.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="action.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_and_karma.reference.directive"></a>Directive</h4></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-2008 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="binary.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="action.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/qi_and_karma/reference/nonterminal.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/qi_and_karma/reference/nonterminal.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,41 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Nonterminal</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../../../index.html" title="Spirit 2.0">
+<link rel="up" href="../reference.html" title="Reference">
+<link rel="prev" href="action.html" title="Action">
+<link rel="next" href="operators.html" title="Operators">
+</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="action.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="operators.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_and_karma.reference.nonterminal"></a>Nonterminal</h4></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-2008 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="action.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="operators.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/qi_and_karma/reference/numeric.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/qi_and_karma/reference/numeric.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,41 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Numeric</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../../../index.html" title="Spirit 2.0">
+<link rel="up" href="../reference.html" title="Reference">
+<link rel="prev" href="string.html" title="String">
+<link rel="next" href="binary.html" title="Binary">
+</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="string.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="binary.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_and_karma.reference.numeric"></a>Numeric</h4></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-2008 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="string.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="binary.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/qi_and_karma/reference/operators.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/qi_and_karma/reference/operators.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,41 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Operators</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../../../index.html" title="Spirit 2.0">
+<link rel="up" href="../reference.html" title="Reference">
+<link rel="prev" href="nonterminal.html" title="Nonterminal">
+<link rel="next" href="stream.html" title="Stream">
+</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="nonterminal.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="stream.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_and_karma.reference.operators"></a>Operators</h4></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-2008 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="nonterminal.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="stream.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/qi_and_karma/reference/stream.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/qi_and_karma/reference/stream.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,41 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Stream</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../../../index.html" title="Spirit 2.0">
+<link rel="up" href="../reference.html" title="Reference">
+<link rel="prev" href="operators.html" title="Operators">
+<link rel="next" href="auxiliary.html" title="Auxiliary">
+</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="operators.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="auxiliary.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_and_karma.reference.stream"></a>Stream</h4></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-2008 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="operators.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="auxiliary.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/qi_and_karma/reference/string.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/qi_and_karma/reference/string.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,41 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>String</title>
+<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../../../index.html" title="Spirit 2.0">
+<link rel="up" href="../reference.html" title="Reference">
+<link rel="prev" href="char.html" title="Char">
+<link rel="next" href="numeric.html" title="Numeric">
+</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="char.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="numeric.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_and_karma.reference.string"></a>String</h4></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-2008 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="char.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="numeric.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/rationale.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/rationale.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,41 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Rationale</title>
+<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../index.html" title="Spirit 2.0">
+<link rel="up" href="../index.html" title="Spirit 2.0">
+<link rel="prev" href="notes/techniques.html" title="Techniques">
+<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/techniques.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>
+</div>
+<div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="spirit.rationale"></a>Rationale</h2></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-2008 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/techniques.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>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/references.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/references.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,490 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>References</title>
+<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../index.html" title="Spirit 2.0">
+<link rel="up" href="../index.html" title="Spirit 2.0">
+<link rel="prev" 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="acknowledgments.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>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="spirit.references"></a>References</h2></div></div></div>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ 
+ </th>
+<th>
+ 
+ Authors
+ 
+ </th>
+<th>
+ 
+ Title, Publisher/link, Date Published
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ 1.
+ 
+ </td>
+<td>
+ 
+ Todd Veldhuizen
+ 
+ </td>
+<td>
+ 
+ <a href="http://www.extreme.indiana.edu/%7Etveldhui/papers/Expression-Templates/exprtmpl.html" target="_top">"Expression
+ Templates"</a>. C++ Report, June 1995.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ 2.
+ 
+ </td>
+<td>
+ 
+ Peter Naur (ed.)
+ 
+ </td>
+<td>
+ 
+ <a href="http://www.masswerk.at/algol60/report.htm" target="_top">"Report
+ on the Algorithmic Language ALGOL 60"</a>. CACM, May 1960.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ 3.
+ 
+ </td>
+<td>
+ 
+ ISO/IEC
+ 
+ </td>
+<td>
+ 
+ "ISO-EBNF",
+ ISO/IEC 14977: 1996(E).
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ 4.
+ 
+ </td>
+<td>
+ 
+ Richard J.Botting, Ph.D.
+ 
+ </td>
+<td>
+ 
+ "XBNF"
+ (citing Leu-Weiner, 1973). California State University, San Bernardino,
+ 1998.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ 5.
+ 
+ </td>
+<td>
+ 
+ James Coplien.
+ 
+ </td>
+<td>
+ 
+ "Curiously Recurring Template Pattern". C++ Report, Feb.
+ 1995.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ 6.
+ 
+ </td>
+<td>
+ 
+ Thierry Geraud and Alexandre Duret-Lutz
+ 
+ </td>
+<td>
+ 
+ <a href="http://www.coldewey.com/europlop2000/papers/geraud%2Bduret.zip" target="_top">Generic
+ Programming Redesign of Patterns</a> Proceedings of the 5th European
+ Conference on Pattern Languages of Programs(EuroPLoP'2000) Irsee, Germany,
+ July 2000.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ 7.
+ 
+ </td>
+<td>
+ 
+ Geoffrey Furnish
+ 
+ </td>
+<td>
+ 
+ <a href="http://www.adtmag.com/joop/carticle.aspx?ID=627" target="_top">"Disambiguated
+ Glommable Expression Templates Reintroduced"</a> C++ Report,
+ May 2000
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ 8.
+ 
+ </td>
+<td>
+ 
+ Erich Gamma, Richard Helm, Ralph Jhonson, and John Vlissides
+ 
+ </td>
+<td>
+ 
+ Design Patterns, Elements of Reusable Object-Oriented Software. Addison-Wesley,
+ 1995.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ 9.
+ 
+ </td>
+<td>
+ 
+ Alfred V. Aho, Revi Sethi, Feffrey D. Ulman
+ 
+ </td>
+<td>
+ 
+ Compilers, Principles, Techniques and Tools Addison-Wesley, June 1987.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ 10.
+ 
+ </td>
+<td>
+ 
+ Dick Grune and Ceriel Jacobs
+ 
+ </td>
+<td>
+ 
+ <a href="http://www.cs.vu.nl/%7Edick/PTAPG.html" target="_top">Parsing Techniques:
+ A Practical Guide.</a> Ellis Horwood Ltd.: West Sussex, England,
+ 1990. (electronic copy, 1998).
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ 11.
+ 
+ </td>
+<td>
+ 
+ T. J. Parr, H. G. Dietz, and W. E. Cohen
+ 
+ </td>
+<td>
+ 
+ <a href="http://citeseer.ist.psu.edu/6885.html" target="_top">PCCTS Reference
+ Manual (Version 1.00)</a>. School of Electrical Engineering, Purdue
+ University, West Lafayette, August 1991.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ 12.
+ 
+ </td>
+<td>
+ 
+ Adrian Johnstone and Elizabeth Scott.
+ 
+ </td>
+<td>
+ 
+ <a href="ftp://ftp.cs.rhul.ac.uk/pub/rdp" target="_top">RDP, A Recursive Descent
+ Compiler Compiler</a>. Technical Report CSD TR 97 25, Dept. of
+ Computer Science, Egham, Surrey, England, Dec. 20, 1997.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ 13.
+ 
+ </td>
+<td>
+ 
+ Adrian Johnstone
+ 
+ </td>
+<td>
+ 
+ <a href="http://www.cs.rhul.ac.uk/research/languages/projects/lookahead_backtrack.shtml" target="_top">Languages
+ and Architectures, Parser generators with backtrack or extended lookahead
+ capability</a> Department of Computer Science, Royal Holloway,
+ University of London, Egham, Surrey, England
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ 14.
+ 
+ </td>
+<td>
+ 
+ Damian Conway
+ 
+ </td>
+<td>
+ 
+ <a href="http://www.csse.monash.edu.au/%7Edamian/papers/#Embedded_Input_Parsing_for_C" target="_top">Parsing
+ with C++ Classes</a>. ACM SIGPLAN Notices, 29:1, 1994.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ 15.
+ 
+ </td>
+<td>
+ 
+ Joel de Guzman
+ 
+ </td>
+<td>
+ 
+ <a href="http://spirit.sourceforge.net/distrib/spirit_1_8_5/libs/spirit/index.html" target="_top">"Spirit
+ Version 1.8"</a>, 1998-2003.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ 16.
+ 
+ </td>
+<td>
+ 
+ S. Doaitse Swierstra and Luc Duponcheel
+ 
+ </td>
+<td>
+ 
+ <a href="http://citeseer.ist.psu.edu/448665.html" target="_top">Deterministic,
+ Error-Correcting Combinator Parsers</a> Dept. of Computer Science,
+ Utrecht University P.O.Box 80.089, 3508 TB Utrecht, The Netherland
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ 17.
+ 
+ </td>
+<td>
+ 
+ Bjarne Stroustrup
+ 
+ </td>
+<td>
+ 
+ <a href="http://www.research.att.com/%7Ebs/whitespace98.pdf" target="_top">Generalizing
+ Overloading for C++2000</a> Overload, Issue 25. April 1, 1998.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ 18.
+ 
+ </td>
+<td>
+ 
+ Dr. John Maddock
+ 
+ </td>
+<td>
+ 
+ Regex++ Documentation
+ http://www.boost.org/libs/regex/index.htm
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ 19.
+ 
+ </td>
+<td>
+ 
+ Anonymous Edited by Graham Hutton
+ 
+ </td>
+<td>
+ 
+ <a href="http://www.cs.nott.ac.uk/~gmh//faq.html" target="_top">Frequently Asked
+ Questions for comp.lang.functional</a>. Edited by Graham Hutton,
+ University of Nottingham.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ 20.
+ 
+ </td>
+<td>
+ 
+ Hewlett-Packard
+ 
+ </td>
+<td>
+ 
+ <a href="http://www.sgi.com/tech/stl/" target="_top">Standard Template Library
+ Programmer's Guide.</a>, Hewlett-Packard Company, 1994
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ 21.
+ 
+ </td>
+<td>
+ 
+ Boost Libraries
+ 
+ </td>
+<td>
+ 
+ Boost Libraries Documentation.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ 22.
+ 
+ </td>
+<td>
+ 
+ Brian McNamara and Yannis Smaragdakis
+ 
+ </td>
+<td>
+ 
+ <a href="http://www.cc.gatech.edu/~yannis/fc++/" target="_top">FC++:Functional
+ Programming in C++</a>.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ 23.
+ 
+ </td>
+<td>
+ 
+ Todd Veldhuizen
+ 
+ </td>
+<td>
+ 
+ <a href="ftp://ftp.cs.indiana.edu/pub/techreports/TR542.pdf" target="_top">Techniques
+ for Scientic C++.</a>
+ 
+ </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-2008 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="acknowledgments.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>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/doc/html/spirit/what_s_new.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/doc/html/spirit/what_s_new.html 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -0,0 +1,84 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>What's New</title>
+<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
+<link rel="start" href="../index.html" title="Spirit 2.0">
+<link rel="up" href="../index.html" title="Spirit 2.0">
+<link rel="prev" href="../index.html" title="Spirit 2.0">
+<link rel="next" href="introduction.html" title="Introduction">
+</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="introduction.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.what_s_new"></a>What's New</h2></div></div></div>
+<a name="spirit.what_s_new.spirit_classic"></a><h3>
+<a name="id456029"></a>
+ Spirit Classic
+ </h3>
+
+ The Spirit V1.8.x code base has been integrated with Spirit V2. It is now called
+ Spirit.Classic. Even if the directory structure has changed
+ (the Spirit Classic headers are now moved to the $BOOST_ROOT/boost/spirit/home/classic directory), we created forwarding
+ headers allowing to compile existing applications without any change. These
+ forwarding headers are deprecated, though, which will result in corresponding
+ warnings generated for each of the headers starting with Boost V1.38. The forwarding
+ headers are expected to be removed in the future.
+ 
+
+ The recommended way of using Spirit Classic now is to include header files
+ from the directory $BOOST_ROOT/boost/spirit/include. All files of Spirit Classic in this directory have a 'classic_'
+ prefixed to their name. For example the include
+ 
+<pre class="programlisting">
+#include <boost/spirit/core/core.hpp>
+</pre>
+
+ now should be written as:
+ 
+<pre class="programlisting">
+#include <boost/spirit/include/classic_core.hpp>
+</pre>
+
+ To avoid namespace conflicts with the new Spirit V2 library we moved Spirit
+ Classic into the namespace <tt class="computeroutput">boost::spirit::classic</tt>.
+ All references to the former namespace <tt class="computeroutput">boost::spirit</tt>
+ need to be adjusted as soon as the header names are corrected as described
+ above. As an alternative you can define the preprocessor constant <tt class="computeroutput">BOOST_SPIRIT_USE_OLD_NAMESPACE</tt>, which will
+ force the Spirit Classic code to be in the namespace <tt class="computeroutput">boost::spirit</tt>
+ as before. This is not recommended, though, as it may result in naming clashes.
+ 
+
+ The change of the namespace will be automatically deactivated whenever the
+ deprecated include files are being used. This ensures full backwards compatibility
+ for existing applications.
+ 
+</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-2008 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="introduction.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Modified: trunk/libs/spirit/doc/qi_and_karma/roman.qbk
==============================================================================
--- trunk/libs/spirit/doc/qi_and_karma/roman.qbk (original)
+++ trunk/libs/spirit/doc/qi_and_karma/roman.qbk 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -17,14 +17,14 @@
[heading Symbol Table]

The symbol table holds a dictionary of symbols where each symbol is a sequence
-of characters (a `char`, `wchar\_t`, `int`, enumeration etc.) . The template
+of characters (a `char`, `wchar_t`, `int`, 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 instance of which may be used
+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,
@@ -57,4 +57,111 @@
Now we can use `hundreds`, `tens` and `ones` anywhere in our parser expressions.
They are all parsers.

+[heading Rules]
+
+Up until now, we've been inlining our parser expressions, passing them directly
+to the `phrase_parse` function. The expression evaluates into a temporary,
+unnamed parser which is passed into the `phrase_parse` 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:
+
+ rule<Iterator> r;
+
+At the very least, the rule needs to know the iterator type it will be working
+on. This rule cannot be used with `phrase_parse`. It can only be used with the
+`parse` 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:
+
+ rule<Iterator, Skipper> r;
+
+Example:
+
+ rule<std::string::iterator, space_type> r;
+
+This type of rule can be used for both `phrase_parse` and `parse`.
+
+For our next example, there's one more rule form you should know about:
+
+ rule<Iterator, Signature> r;
+
+or
+
+ rule<Iterator, Signature, Skipper> r;
+
+[tip All rule template arguments after Iterator can be supplied in any order.]
+
+The Signature specifies the attributes of the rule. You've seen that our parsers
+can have an attribute. Recall that the `double_` parser has an attribute of
+`double`. 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:
+
+ result(argN, argN,..., argN)
+
+After having declared a rule, you can now assign any parser expression to it.
+Example:
+
+ r = double_ >> *(',' >> double_);
+
+[heading Grammars]
+
+A grammar encapsulates one or more rules. It has the same template parameters as
+the rule. You declare a grammar by:
+
+# deriving a struct (or class) from the `grammar` class template
+# declare one or more rules as member variables
+# initialize the base grammar class by giving it the start rule (its the first
+ rule that gets called when the grammar starts parsing)
+# initialize your rules in your constructor
+
+The roman numeral grammar is a very nice and simple example of a grammar:
+
+[tutorial_roman_grammar]
+
+Things to take notice of:
+
+* The grammar and start rule signature is `unsigned()`. It has a synthesized
+ attribute (return value) of type `unsigned` with no inherited attributes
+ (arguments).
+
+* We did not specify a skip-parser. We don't want to skip in between the
+ numerals.
+
+* `roman::base_type` is a typedef for `grammar<Iterator, unsigned()>`. If
+ `roman` was not a template, you can simply write: base_type(start)
+
+* But it's best to make your grammar templates, so that they can be reused
+ for different iterator types.
+
+* `_val` is another __phoenix__ placeholder representing the rule's synthesized
+ attribute.
+
+* `eps` is a special spirit parser that consumes no input but is always
+ successful. We use it to initialize `_val`, the rule's synthesized
+ attribute, to zero before anything else. The actual parser starts at
+ `+char_('M')`, parsing roman thousands. Using `eps` this way is good
+ for doing pre and post initializations.
+
+* The expression `a || b` reads: match a or b and in sequence. That is, if both
+ `a` and `b` match, it must be in sequence; this is equivalent to `a >> !b | b`,
+ but more efficient.
+
+[heading Let's Parse!]
+
+[tutorial_roman_grammar_parse]
+
+`roman_parser` is an object of type `roman` -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, `unsigned result`,
+which will receive the parsed value.
+
[endsect]

Modified: trunk/libs/spirit/example/qi/calc1.cpp
==============================================================================
--- trunk/libs/spirit/example/qi/calc1.cpp (original)
+++ trunk/libs/spirit/example/qi/calc1.cpp 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -29,7 +29,7 @@
template <typename Iterator>
struct calculator : grammar<Iterator, space_type>
{
- calculator() : grammar<Iterator, space_type>(expression)
+ calculator() : calculator::base_type(expression)
 {
 expression =
 term

Modified: trunk/libs/spirit/example/qi/calc2.cpp
==============================================================================
--- trunk/libs/spirit/example/qi/calc2.cpp (original)
+++ trunk/libs/spirit/example/qi/calc2.cpp 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -44,7 +44,7 @@
template <typename Iterator>
struct calculator : grammar<Iterator, space_type>
{
- calculator() : grammar<Iterator, space_type>(expression)
+ calculator() : calculator::base_type(expression)
 {
 expression =
 term

Modified: trunk/libs/spirit/example/qi/calc2_ast.cpp
==============================================================================
--- trunk/libs/spirit/example/qi/calc2_ast.cpp (original)
+++ trunk/libs/spirit/example/qi/calc2_ast.cpp 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -132,7 +132,7 @@
template <typename Iterator>
struct calculator : grammar<Iterator, expression_ast(), space_type>
{
- calculator() : grammar<Iterator, expression_ast(), space_type>(expression)
+ calculator() : calculator::base_type(expression)
 {
 expression =
 term [_val = _1]

Modified: trunk/libs/spirit/example/qi/calc3.cpp
==============================================================================
--- trunk/libs/spirit/example/qi/calc3.cpp (original)
+++ trunk/libs/spirit/example/qi/calc3.cpp 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -33,7 +33,7 @@
template <typename Iterator>
struct calculator : grammar<Iterator, int(), space_type>
{
- calculator() : grammar<Iterator, int(), space_type>(expression)
+ calculator() : calculator::base_type(expression)
 {
 expression =
 term [_val = _1]

Modified: trunk/libs/spirit/example/qi/calc3_lexer.cpp
==============================================================================
--- trunk/libs/spirit/example/qi/calc3_lexer.cpp (original)
+++ trunk/libs/spirit/example/qi/calc3_lexer.cpp 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -92,7 +92,7 @@
{
 template <typename TokenDef>
 calculator(TokenDef const& tok)
- : grammar<Iterator, int(), typename Lexer::token_set>(expression)
+ : calculator::base_type(expression)
 {
 // grammar
 expression =

Modified: trunk/libs/spirit/example/qi/calc4.cpp
==============================================================================
--- trunk/libs/spirit/example/qi/calc4.cpp (original)
+++ trunk/libs/spirit/example/qi/calc4.cpp 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -35,7 +35,7 @@
template <typename Iterator>
struct calculator : grammar<Iterator, int(), space_type>
{
- calculator() : grammar<Iterator, int(), space_type>(expression)
+ calculator() : calculator::base_type(expression)
 {
 expression =
 term [_val = _1]

Modified: trunk/libs/spirit/example/qi/calc5.cpp
==============================================================================
--- trunk/libs/spirit/example/qi/calc5.cpp (original)
+++ trunk/libs/spirit/example/qi/calc5.cpp 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -117,7 +117,7 @@
struct calculator : grammar<Iterator, space_type>
{
 calculator(std::vector<int>& code)
- : grammar<Iterator, space_type>(expression)
+ : calculator::base_type(expression)
 , code(code)
 {
 expression =

Modified: trunk/libs/spirit/example/qi/calc6/calc6b.hpp
==============================================================================
--- trunk/libs/spirit/example/qi/calc6/calc6b.hpp (original)
+++ trunk/libs/spirit/example/qi/calc6/calc6b.hpp 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -14,7 +14,7 @@
///////////////////////////////////////////////////////////////////////////////
template <typename Iterator>
expression<Iterator>::expression(std::vector<int>& code, symbols<char, int>& vars)
- : grammar<Iterator, space_type>(expr)
+ : expression::base_type(expr)
 , code(code)
 , vars(vars)
 , op(code)

Modified: trunk/libs/spirit/example/qi/calc6/calc6c.hpp
==============================================================================
--- trunk/libs/spirit/example/qi/calc6/calc6c.hpp (original)
+++ trunk/libs/spirit/example/qi/calc6/calc6c.hpp 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -14,7 +14,7 @@
///////////////////////////////////////////////////////////////////////////////
template <typename Iterator>
statement<Iterator>::statement(std::vector<int>& code)
- : grammar<Iterator, space_type>(start)
+ : statement::base_type(start)
 , code(code)
 , nvars(0)
 , expr(code, vars)

Modified: trunk/libs/spirit/example/qi/calc7/calc7b.hpp
==============================================================================
--- trunk/libs/spirit/example/qi/calc7/calc7b.hpp (original)
+++ trunk/libs/spirit/example/qi/calc7/calc7b.hpp 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -14,7 +14,7 @@
///////////////////////////////////////////////////////////////////////////////
template <typename Iterator>
expression<Iterator>::expression(std::vector<int>& code, symbols<char, int>& vars)
- : grammar<Iterator, space_type>(expr)
+ : expression::base_type(expr)
 , code(code)
 , vars(vars)
 , op(code)

Modified: trunk/libs/spirit/example/qi/calc7/calc7c.hpp
==============================================================================
--- trunk/libs/spirit/example/qi/calc7/calc7c.hpp (original)
+++ trunk/libs/spirit/example/qi/calc7/calc7c.hpp 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -14,7 +14,7 @@
///////////////////////////////////////////////////////////////////////////////
template <typename Iterator>
statement<Iterator>::statement(std::vector<int>& code)
- : grammar<Iterator, space_type>(statement_list)
+ : statement::base_type(statement_list)
 , code(code)
 , nvars(0)
 , expr(code, vars)

Modified: trunk/libs/spirit/example/qi/employee.cpp
==============================================================================
--- trunk/libs/spirit/example/qi/employee.cpp (original)
+++ trunk/libs/spirit/example/qi/employee.cpp 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -58,7 +58,7 @@
template <typename Iterator>
struct employee_parser : grammar<Iterator, employee(), space_type>
{
- employee_parser() : grammar<Iterator, employee(), space_type>(start)
+ employee_parser() : employee_parser::base_type(start)
{
quoted_string %= lexeme['"' >> +(char_ - '"') >> '"'];

Modified: trunk/libs/spirit/example/qi/mini_c/mini_c.hpp
==============================================================================
--- trunk/libs/spirit/example/qi/mini_c/mini_c.hpp (original)
+++ trunk/libs/spirit/example/qi/mini_c/mini_c.hpp 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -248,7 +248,7 @@
template <typename Iterator>
struct white_space : grammar<Iterator>
{
- white_space() : grammar<Iterator>(start)
+ white_space() : white_space::base_type(start)
 {
 start =
 space // tab/space/cr/lf

Modified: trunk/libs/spirit/example/qi/mini_c/mini_cb.hpp
==============================================================================
--- trunk/libs/spirit/example/qi/mini_c/mini_cb.hpp (original)
+++ trunk/libs/spirit/example/qi/mini_c/mini_cb.hpp 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -17,7 +17,7 @@
 std::vector<int>& code
 , symbols<char, int>& vars
 , symbols<char, function_info>& functions)
- : grammar<Iterator, white_space>(expr)
+ : expression::base_type(expr)
 , code(code)
 , vars(vars)
 , functions(functions)

Modified: trunk/libs/spirit/example/qi/mini_c/mini_cc.hpp
==============================================================================
--- trunk/libs/spirit/example/qi/mini_c/mini_cc.hpp (original)
+++ trunk/libs/spirit/example/qi/mini_c/mini_cc.hpp 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -15,7 +15,7 @@
template <typename Iterator>
statement<Iterator>::statement(
 std::vector<int>& code, symbols<char, function_info>& functions)
- : grammar<Iterator, white_space>(statement_list)
+ : statement::base_type(statement_list)
 , code(code)
 , functions(functions)
 , nvars(0)

Modified: trunk/libs/spirit/example/qi/mini_c/mini_cd.hpp
==============================================================================
--- trunk/libs/spirit/example/qi/mini_c/mini_cd.hpp (original)
+++ trunk/libs/spirit/example/qi/mini_c/mini_cd.hpp 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -14,7 +14,7 @@
///////////////////////////////////////////////////////////////////////////////
template <typename Iterator>
program<Iterator>::program(std::vector<int>& code)
- : grammar<Iterator, white_space>(start)
+ : program::base_type(start)
 , code(code)
 , statement(code, functions)
 , add_function(function_adder(functions))

Modified: trunk/libs/spirit/example/qi/mini_xml1.cpp
==============================================================================
--- trunk/libs/spirit/example/qi/mini_xml1.cpp (original)
+++ trunk/libs/spirit/example/qi/mini_xml1.cpp 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -130,7 +130,7 @@
template <typename Iterator>
struct mini_xml_grammar : grammar<Iterator, mini_xml(), space_type>
{
- mini_xml_grammar() : grammar<Iterator, mini_xml(), space_type>(xml)
+ mini_xml_grammar() : mini_xml_grammar::base_type(xml)
 {
 text = lexeme[+(char_ - '<') [_val += _1]];
 node = (xml | text) [_val = _1];

Modified: trunk/libs/spirit/example/qi/mini_xml2.cpp
==============================================================================
--- trunk/libs/spirit/example/qi/mini_xml2.cpp (original)
+++ trunk/libs/spirit/example/qi/mini_xml2.cpp 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -132,7 +132,7 @@
 : grammar<Iterator, mini_xml(), locals<std::string>, space_type>
{
 mini_xml_grammar()
- : grammar<Iterator, mini_xml(), locals<std::string>, space_type>(xml)
+ : mini_xml_grammar::base_type(xml)
 {
 text %= lexeme[+(char_ - '<')];
 node %= xml | text;

Modified: trunk/libs/spirit/example/qi/roman.cpp
==============================================================================
--- trunk/libs/spirit/example/qi/roman.cpp (original)
+++ trunk/libs/spirit/example/qi/roman.cpp 2008-07-12 01:23:48 EDT (Sat, 12 Jul 2008)
@@ -103,26 +103,31 @@

///////////////////////////////////////////////////////////////////////////////
// roman (numerals) grammar
+//
+// Note the use of the || operator. The expression
+// a || b reads match a or b and in sequence. Try
+// defining the roman numerals grammar in YACC or
+// PCCTS. Spirit rules! :-)
///////////////////////////////////////////////////////////////////////////////
+//[tutorial_roman_grammar
template <typename Iterator>
struct roman : grammar<Iterator, unsigned()>
{
- roman() : grammar<Iterator, unsigned()>(start)
+ roman() : roman::base_type(start)
 {
- start
- = +char_('M') [_val += 1000]
- || hundreds [_val += _1]
- || tens [_val += _1]
- || ones [_val += _1];
-
- // Note the use of the || operator. The expression
- // a || b reads match a or b and in sequence. Try
- // defining the roman numerals grammar in YACC or
- // PCCTS. Spirit rules! :-)
+ start = eps [_val = 0] >>
+ (
+ +char_('M') [_val += 1000]
+ || hundreds [_val += _1]
+ || tens [_val += _1]
+ || ones [_val += _1]
+ )
+ ;
 }

 rule<Iterator, unsigned()> start;
};
+//]

///////////////////////////////////////////////////////////////////////////////
// Main program
@@ -149,7 +154,8 @@

 std::string::const_iterator iter = str.begin();
 std::string::const_iterator end = str.end();
- bool r = parse(iter, end, roman_parser[ref(result) = _1]);
+ //[tutorial_roman_grammar_parse
+ bool r = parse(iter, end, roman_parser, result);

 if (r && iter == end)
 {
@@ -166,6 +172,7 @@
 std::cout << "stopped at: \": " << rest << "\"\n";
 std::cout << "-------------------------\n";
 }
+ //]
 }

 std::cout << "Bye... :-) \n\n";

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