Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r71301 - in trunk/libs/spirit/repository/doc/html: . spirit_repository spirit_repository/karma_components/directives spirit_repository/karma_components/nonterminal spirit_repository/qi_components spirit_repository/qi_components/directives spirit_repository/qi_components/nonterminal spirit_repository/qi_components/operators spirit_repository/qi_components/primitive
From: hartmut.kaiser_at_[hidden]
Date: 2011-04-15 19:36:49

Author: hkaiser
Date: 2011-04-15 19:36:47 EDT (Fri, 15 Apr 2011)
New Revision: 71301
URL: http://svn.boost.org/trac/boost/changeset/71301

Log:
Spirit: regenerated repository docs
Added:
   trunk/libs/spirit/repository/doc/html/spirit_repository/qi_components/directives/kwd.html (contents, props changed)
   trunk/libs/spirit/repository/doc/html/spirit_repository/qi_components/operators/
   trunk/libs/spirit/repository/doc/html/spirit_repository/qi_components/operators.html (contents, props changed)
   trunk/libs/spirit/repository/doc/html/spirit_repository/qi_components/operators/keyword_list.html (contents, props changed)
Text files modified:
   trunk/libs/spirit/repository/doc/html/index.html | 4 ++--
   trunk/libs/spirit/repository/doc/html/spirit_repository/karma_components/directives/karma_confix_generator.html | 18 +++++++++---------
   trunk/libs/spirit/repository/doc/html/spirit_repository/karma_components/nonterminal/subrule.html | 24 ++++++++++++------------
   trunk/libs/spirit/repository/doc/html/spirit_repository/preface.html | 10 +++++-----
   trunk/libs/spirit/repository/doc/html/spirit_repository/qi_components/directives/confix.html | 18 +++++++++---------
   trunk/libs/spirit/repository/doc/html/spirit_repository/qi_components/directives/distinct.html | 16 ++++++++--------
   trunk/libs/spirit/repository/doc/html/spirit_repository/qi_components/nonterminal/subrule.html | 26 +++++++++++++-------------
   trunk/libs/spirit/repository/doc/html/spirit_repository/qi_components/primitive/advance.html | 22 +++++++++++-----------
   trunk/libs/spirit/repository/doc/html/spirit_repository/qi_components/primitive/flush_multi_pass.html | 16 ++++++++--------
   9 files changed, 77 insertions(+), 77 deletions(-)

Modified: trunk/libs/spirit/repository/doc/html/index.html
==============================================================================
--- trunk/libs/spirit/repository/doc/html/index.html (original)
+++ trunk/libs/spirit/repository/doc/html/index.html 2011-04-15 19:36:47 EDT (Fri, 15 Apr 2011)
@@ -33,7 +33,7 @@
</div></div>
<div>Copyright © 2001-2011 Joel de Guzman, Hartmut Kaiser</div>
<div><div class="legalnotice">
-<a name="id863156"></a>
+<a name="id820812"></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)
 
@@ -90,7 +90,7 @@
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left">Last revised: March 26, 2011 at 19:23:38 GMT</td>
+<td align="left">Last revised: April 15, 2011 at 23:36:10 GMT</td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>

Modified: trunk/libs/spirit/repository/doc/html/spirit_repository/karma_components/directives/karma_confix_generator.html
==============================================================================
--- trunk/libs/spirit/repository/doc/html/spirit_repository/karma_components/directives/karma_confix_generator.html (original)
+++ trunk/libs/spirit/repository/doc/html/spirit_repository/karma_components/directives/karma_confix_generator.html 2011-04-15 19:36:47 EDT (Fri, 15 Apr 2011)
@@ -28,7 +28,7 @@
 Confix Generator</a>
</h4></div></div></div>
<a name="spirit_repository.karma_components.directives.karma_confix_generator.description"></a><h6>
-<a name="id898353"></a>
+<a name="spirit_repository.karma_components.directives.karma_confix_generator.description-heading"></a>
 <a class="link" href="karma_confix_generator.html#spirit_repository.karma_components.directives.karma_confix_generator.description">Description</a>
 </h6>

@@ -93,20 +93,20 @@
 tag using a simple: <code class="computeroutput">ol["Some text"]</code> (which results in <code class="computeroutput"><ol>Some text</ol></code>).
 
<a name="spirit_repository.karma_components.directives.karma_confix_generator.header"></a><h6>
-<a name="id899318"></a>
+<a name="spirit_repository.karma_components.directives.karma_confix_generator.header-heading"></a>
 <a class="link" href="karma_confix_generator.html#spirit_repository.karma_components.directives.karma_confix_generator.header">Header</a>
 </h6>
<pre class="programlisting">// forwards to <boost/spirit/repository/home/karma/directive/confix.hpp>
#include <boost/spirit/repository/include/karma_confix.hpp>
</pre>
<a name="spirit_repository.karma_components.directives.karma_confix_generator.synopsis"></a><h6>
-<a name="id899392"></a>
+<a name="spirit_repository.karma_components.directives.karma_confix_generator.synopsis-heading"></a>
 <a class="link" href="karma_confix_generator.html#spirit_repository.karma_components.directives.karma_confix_generator.synopsis">Synopsis</a>
 </h6>
<pre class="programlisting">confix(prefix, suffix)[subject]
</pre>
<a name="spirit_repository.karma_components.directives.karma_confix_generator.parameters"></a><h6>
-<a name="id899440"></a>
+<a name="spirit_repository.karma_components.directives.karma_confix_generator.parameters-heading"></a>
 <a class="link" href="karma_confix_generator.html#spirit_repository.karma_components.directives.karma_confix_generator.parameters">Parameters</a>
 </h6>
<div class="informaltable"><table class="table">
@@ -175,7 +175,7 @@
 All three parameters can be arbitrary complex generators themselves.
 
<a name="spirit_repository.karma_components.directives.karma_confix_generator.attribute"></a><h6>
-<a name="id899603"></a>
+<a name="spirit_repository.karma_components.directives.karma_confix_generator.attribute-heading"></a>
 <a class="link" href="karma_confix_generator.html#spirit_repository.karma_components.directives.karma_confix_generator.attribute">Attribute</a>
 </h6>

@@ -202,7 +202,7 @@
 </td></tr>
</table></div>
<a name="spirit_repository.karma_components.directives.karma_confix_generator.example"></a><h6>
-<a name="id899778"></a>
+<a name="spirit_repository.karma_components.directives.karma_confix_generator.example-heading"></a>
 <a class="link" href="karma_confix_generator.html#spirit_repository.karma_components.directives.karma_confix_generator.example">Example</a>
 </h6>

@@ -211,7 +211,7 @@
 styles and a function prototype (for the full example code see here: confix.cpp)
 
<a name="spirit_repository.karma_components.directives.karma_confix_generator.prerequisites"></a><h6>
-<a name="id899808"></a>
+<a name="spirit_repository.karma_components.directives.karma_confix_generator.prerequisites-heading"></a>
 <a class="link" href="karma_confix_generator.html#spirit_repository.karma_components.directives.karma_confix_generator.prerequisites">Prerequisites</a>
 </h6>

@@ -241,7 +241,7 @@

 
<a name="spirit_repository.karma_components.directives.karma_confix_generator.generating_different_comment_styles"></a><h6>
-<a name="id900044"></a>
+<a name="spirit_repository.karma_components.directives.karma_confix_generator.generating_different_comment_styles-heading"></a>
 <a class="link" href="karma_confix_generator.html#spirit_repository.karma_components.directives.karma_confix_generator.generating_different_comment_styles">Generating
 Different Comment Styles</a>
 </h6>
@@ -285,7 +285,7 @@
 */ </code>.
 
<a name="spirit_repository.karma_components.directives.karma_confix_generator.generating_a_function_prototype"></a><h6>
-<a name="id900338"></a>
+<a name="spirit_repository.karma_components.directives.karma_confix_generator.generating_a_function_prototype-heading"></a>
 <a class="link" href="karma_confix_generator.html#spirit_repository.karma_components.directives.karma_confix_generator.generating_a_function_prototype">Generating
 a Function Prototype</a>
 </h6>

Modified: trunk/libs/spirit/repository/doc/html/spirit_repository/karma_components/nonterminal/subrule.html
==============================================================================
--- trunk/libs/spirit/repository/doc/html/spirit_repository/karma_components/nonterminal/subrule.html (original)
+++ trunk/libs/spirit/repository/doc/html/spirit_repository/karma_components/nonterminal/subrule.html 2011-04-15 19:36:47 EDT (Fri, 15 Apr 2011)
@@ -28,7 +28,7 @@
 subrules</a>
</h4></div></div></div>
<a name="spirit_repository.karma_components.nonterminal.subrule.description"></a><h6>
-<a name="id900667"></a>
+<a name="spirit_repository.karma_components.nonterminal.subrule.description-heading"></a>
 <a class="link" href="subrule.html#spirit_repository.karma_components.nonterminal.subrule.description">Description</a>
 </h6>

@@ -86,21 +86,21 @@
 parts), whereas the rest can use rules and grammars.
 
<a name="spirit_repository.karma_components.nonterminal.subrule.header"></a><h6>
-<a name="id900934"></a>
+<a name="spirit_repository.karma_components.nonterminal.subrule.header-heading"></a>
 <a class="link" href="subrule.html#spirit_repository.karma_components.nonterminal.subrule.header">Header</a>
 </h6>
<pre class="programlisting">// forwards to <boost/spirit/repository/home/karma/nonterminal/subrule.hpp>
#include <boost/spirit/repository/include/karma_subrule.hpp>
</pre>
<a name="spirit_repository.karma_components.nonterminal.subrule.synopsis__declaration_"></a><h6>
-<a name="id901009"></a>
+<a name="spirit_repository.karma_components.nonterminal.subrule.synopsis__declaration_-heading"></a>
 <a class="link" href="subrule.html#spirit_repository.karma_components.nonterminal.subrule.synopsis__declaration_">Synopsis
 (declaration)</a>
 </h6>
<pre class="programlisting">subrule<ID, A1, A2> sr(name);
</pre>
<a name="spirit_repository.karma_components.nonterminal.subrule.parameters__declaration_"></a><h6>
-<a name="id901074"></a>
+<a name="spirit_repository.karma_components.nonterminal.subrule.parameters__declaration_-heading"></a>
 <a class="link" href="subrule.html#spirit_repository.karma_components.nonterminal.subrule.parameters__declaration_">Parameters
 (declaration)</a>
 </h6>
@@ -170,7 +170,7 @@
</tbody>
</table></div>
<a name="spirit_repository.karma_components.nonterminal.subrule.synopsis__usage_"></a><h6>
-<a name="id902369"></a>
+<a name="spirit_repository.karma_components.nonterminal.subrule.synopsis__usage_-heading"></a>
 <a class="link" href="subrule.html#spirit_repository.karma_components.nonterminal.subrule.synopsis__usage_">Synopsis
 (usage)</a>
 </h6>
@@ -199,7 +199,7 @@
)(a1, a2, ...) // Arguments to group, i.e. to start subrule srA
</pre>
<a name="spirit_repository.karma_components.nonterminal.subrule.parameters__usage_"></a><h6>
-<a name="id902605"></a>
+<a name="spirit_repository.karma_components.nonterminal.subrule.parameters__usage_-heading"></a>
 <a class="link" href="subrule.html#spirit_repository.karma_components.nonterminal.subrule.parameters__usage_">Parameters
 (usage)</a>
 </h6>
@@ -323,7 +323,7 @@
</tbody>
</table></div>
<a name="spirit_repository.karma_components.nonterminal.subrule.groups"></a><h6>
-<a name="id902931"></a>
+<a name="spirit_repository.karma_components.nonterminal.subrule.groups-heading"></a>
 <a class="link" href="subrule.html#spirit_repository.karma_components.nonterminal.subrule.groups">Groups</a>
 </h6>

@@ -368,7 +368,7 @@
;
</pre>
<a name="spirit_repository.karma_components.nonterminal.subrule.attributes"></a><h6>
-<a name="id903325"></a>
+<a name="spirit_repository.karma_components.nonterminal.subrule.attributes-heading"></a>
 <a class="link" href="subrule.html#spirit_repository.karma_components.nonterminal.subrule.attributes">Attributes</a>
 </h6>

@@ -397,7 +397,7 @@
 </li>
</ul></div>
<a name="spirit_repository.karma_components.nonterminal.subrule.locals"></a><h6>
-<a name="id903412"></a>
+<a name="spirit_repository.karma_components.nonterminal.subrule.locals-heading"></a>
 <a class="link" href="subrule.html#spirit_repository.karma_components.nonterminal.subrule.locals">Locals</a>
 </h6>

@@ -407,7 +407,7 @@
 refer to the subrule's locals, if present.
 
<a name="spirit_repository.karma_components.nonterminal.subrule.example"></a><h6>
-<a name="id903448"></a>
+<a name="spirit_repository.karma_components.nonterminal.subrule.example-heading"></a>
 <a class="link" href="subrule.html#spirit_repository.karma_components.nonterminal.subrule.example">Example</a>
 </h6>

@@ -473,7 +473,7 @@
 <a href="../../../../../example/karma/mini_xml_karma_sr.cpp" target="_top">../../example/karma/mini_xml_karma_sr.cpp</a>
 
<a name="spirit_repository.karma_components.nonterminal.subrule.performance"></a><h6>
-<a name="id904333"></a>
+<a name="spirit_repository.karma_components.nonterminal.subrule.performance-heading"></a>
 <a class="link" href="subrule.html#spirit_repository.karma_components.nonterminal.subrule.performance">Performance</a>
 </h6>

@@ -484,7 +484,7 @@
 subrules is very similar, so performance is very similar too).
 
<a name="spirit_repository.karma_components.nonterminal.subrule.notes"></a><h6>
-<a name="id904370"></a>
+<a name="spirit_repository.karma_components.nonterminal.subrule.notes-heading"></a>
 <a class="link" href="subrule.html#spirit_repository.karma_components.nonterminal.subrule.notes">Notes</a>
 </h6>

Modified: trunk/libs/spirit/repository/doc/html/spirit_repository/preface.html
==============================================================================
--- trunk/libs/spirit/repository/doc/html/spirit_repository/preface.html (original)
+++ trunk/libs/spirit/repository/doc/html/spirit_repository/preface.html 2011-04-15 19:36:47 EDT (Fri, 15 Apr 2011)
@@ -27,7 +27,7 @@
<a name="spirit_repository.preface"></a><a class="link" href="preface.html" title="Preface">Preface</a>
</h2></div></div></div>
<a name="spirit_repository.preface.the_spirit_repository"></a><h4>
-<a name="id863183"></a>
+<a name="spirit_repository.preface.the_spirit_repository-heading"></a>
 <a class="link" href="preface.html#spirit_repository.preface.the_spirit_repository">The Spirit
 Repository</a>
 </h4>
@@ -73,11 +73,11 @@
 

 Based on the user feedback and general usability of things it it possible over
- time to move repository componentsgrammars into the /Spirit
+ time to move repository components/grammars into the Spirit
 core library.
 
<a name="spirit_repository.preface.how_to_use_this_manual"></a><h4>
-<a name="id863271"></a>
+<a name="spirit_repository.preface.how_to_use_this_manual-heading"></a>
 <a class="link" href="preface.html#spirit_repository.preface.how_to_use_this_manual">How to use
 this manual</a>
 </h4>
@@ -86,7 +86,7 @@
 icons precede some text to indicate:
 
<div class="table">
-<a name="id863285"></a>Table 1. Icons
+<a name="id820945"></a>Table 1. Icons
<div class="table-contents"><table class="table" summary="Icons">
<colgroup>
<col>
@@ -208,7 +208,7 @@
 Tools</a>.
 
<a name="spirit_repository.preface.support"></a><h4>
-<a name="id863540"></a>
+<a name="spirit_repository.preface.support-heading"></a>
 <a class="link" href="preface.html#spirit_repository.preface.support">Support</a>
 </h4>

Modified: trunk/libs/spirit/repository/doc/html/spirit_repository/qi_components/directives/confix.html
==============================================================================
--- trunk/libs/spirit/repository/doc/html/spirit_repository/qi_components/directives/confix.html (original)
+++ trunk/libs/spirit/repository/doc/html/spirit_repository/qi_components/directives/confix.html 2011-04-15 19:36:47 EDT (Fri, 15 Apr 2011)
@@ -28,7 +28,7 @@
 Confix Parser Directive</a>
</h4></div></div></div>
<a name="spirit_repository.qi_components.directives.confix.description"></a><h6>
-<a name="id876299"></a>
+<a name="spirit_repository.qi_components.directives.confix.description-heading"></a>
 <a class="link" href="confix.html#spirit_repository.qi_components.directives.confix.description">Description</a>
 </h6>

@@ -95,20 +95,20 @@
 </td></tr>
</table></div>
<a name="spirit_repository.qi_components.directives.confix.header"></a><h6>
-<a name="id878160"></a>
+<a name="spirit_repository.qi_components.directives.confix.header-heading"></a>
 <a class="link" href="confix.html#spirit_repository.qi_components.directives.confix.header">Header</a>
 </h6>
<pre class="programlisting">// forwards to <boost/spirit/repository/home/qi/directive/confix.hpp>
#include <boost/spirit/repository/include/qi_confix.hpp>
</pre>
<a name="spirit_repository.qi_components.directives.confix.synopsis"></a><h6>
-<a name="id878238"></a>
+<a name="spirit_repository.qi_components.directives.confix.synopsis-heading"></a>
 <a class="link" href="confix.html#spirit_repository.qi_components.directives.confix.synopsis">Synopsis</a>
 </h6>
<pre class="programlisting">confix(prefix, suffix)[subject]
</pre>
<a name="spirit_repository.qi_components.directives.confix.parameters"></a><h6>
-<a name="id878291"></a>
+<a name="spirit_repository.qi_components.directives.confix.parameters-heading"></a>
 <a class="link" href="confix.html#spirit_repository.qi_components.directives.confix.parameters">Parameters</a>
 </h6>
<div class="informaltable"><table class="table">
@@ -172,7 +172,7 @@
 All three parameters can be arbitrarily complex parsers themselves.
 
<a name="spirit_repository.qi_components.directives.confix.attribute"></a><h6>
-<a name="id878437"></a>
+<a name="spirit_repository.qi_components.directives.confix.attribute-heading"></a>
 <a class="link" href="confix.html#spirit_repository.qi_components.directives.confix.attribute">Attribute</a>
 </h6>

@@ -198,7 +198,7 @@
 </td></tr>
</table></div>
<a name="spirit_repository.qi_components.directives.confix.example"></a><h6>
-<a name="id878675"></a>
+<a name="spirit_repository.qi_components.directives.confix.example-heading"></a>
 <a class="link" href="confix.html#spirit_repository.qi_components.directives.confix.example">Example</a>
 </h6>

@@ -208,7 +208,7 @@
 see confix.cpp)
 
<a name="spirit_repository.qi_components.directives.confix.prerequisites"></a><h6>
-<a name="id878710"></a>
+<a name="spirit_repository.qi_components.directives.confix.prerequisites-heading"></a>
 <a class="link" href="confix.html#spirit_repository.qi_components.directives.confix.prerequisites">Prerequisites</a>
 </h6>

@@ -243,7 +243,7 @@

 
<a name="spirit_repository.qi_components.directives.confix.parsing_different_comment_styles"></a><h6>
-<a name="id879120"></a>
+<a name="spirit_repository.qi_components.directives.confix.parsing_different_comment_styles-heading"></a>
 <a class="link" href="confix.html#spirit_repository.qi_components.directives.confix.parsing_different_comment_styles">Parsing
 Different Comment Styles</a>
 </h6>
@@ -295,7 +295,7 @@
 This is a comment */ </code>".
 
<a name="spirit_repository.qi_components.directives.confix.parsing_tagged_data"></a><h6>
-<a name="id879691"></a>
+<a name="spirit_repository.qi_components.directives.confix.parsing_tagged_data-heading"></a>
 <a class="link" href="confix.html#spirit_repository.qi_components.directives.confix.parsing_tagged_data">Parsing
 Tagged Data</a>
 </h6>

Modified: trunk/libs/spirit/repository/doc/html/spirit_repository/qi_components/directives/distinct.html
==============================================================================
--- trunk/libs/spirit/repository/doc/html/spirit_repository/qi_components/directives/distinct.html (original)
+++ trunk/libs/spirit/repository/doc/html/spirit_repository/qi_components/directives/distinct.html 2011-04-15 19:36:47 EDT (Fri, 15 Apr 2011)
@@ -28,7 +28,7 @@
 Distinct Parser Directive</a>
</h4></div></div></div>
<a name="spirit_repository.qi_components.directives.distinct.description"></a><h6>
-<a name="id880040"></a>
+<a name="spirit_repository.qi_components.directives.distinct.description-heading"></a>
 <a class="link" href="distinct.html#spirit_repository.qi_components.directives.distinct.description">Description</a>
 </h6>

@@ -140,20 +140,20 @@
 above.
 
<a name="spirit_repository.qi_components.directives.distinct.header"></a><h6>
-<a name="id881275"></a>
+<a name="spirit_repository.qi_components.directives.distinct.header-heading"></a>
 <a class="link" href="distinct.html#spirit_repository.qi_components.directives.distinct.header">Header</a>
 </h6>
<pre class="programlisting">// forwards to <boost/spirit/repository/home/qi/directive/distinct.hpp>
#include <boost/spirit/repository/include/qi_distinct.hpp>
</pre>
<a name="spirit_repository.qi_components.directives.distinct.synopsis"></a><h6>
-<a name="id881353"></a>
+<a name="spirit_repository.qi_components.directives.distinct.synopsis-heading"></a>
 <a class="link" href="distinct.html#spirit_repository.qi_components.directives.distinct.synopsis">Synopsis</a>
 </h6>
<pre class="programlisting">distinct(tail)[subject]
</pre>
<a name="spirit_repository.qi_components.directives.distinct.parameters"></a><h6>
-<a name="id881397"></a>
+<a name="spirit_repository.qi_components.directives.distinct.parameters-heading"></a>
 <a class="link" href="distinct.html#spirit_repository.qi_components.directives.distinct.parameters">Parameters</a>
 </h6>
<div class="informaltable"><table class="table">
@@ -206,7 +206,7 @@
 All two parameters can be arbitrary complex parsers themselves.
 
<a name="spirit_repository.qi_components.directives.distinct.attribute"></a><h6>
-<a name="id881504"></a>
+<a name="spirit_repository.qi_components.directives.distinct.attribute-heading"></a>
 <a class="link" href="distinct.html#spirit_repository.qi_components.directives.distinct.attribute">Attribute</a>
 </h6>

@@ -220,7 +220,7 @@
<pre class="programlisting">a: A, b: B --> distinct(b)[a]: A
</pre>
<a name="spirit_repository.qi_components.directives.distinct.example"></a><h6>
-<a name="id881621"></a>
+<a name="spirit_repository.qi_components.directives.distinct.example-heading"></a>
 <a class="link" href="distinct.html#spirit_repository.qi_components.directives.distinct.example">Example</a>
 </h6>

@@ -228,7 +228,7 @@
 parser. distinct.cpp)
 
<a name="spirit_repository.qi_components.directives.distinct.prerequisites"></a><h6>
-<a name="id881654"></a>
+<a name="spirit_repository.qi_components.directives.distinct.prerequisites-heading"></a>
 <a class="link" href="distinct.html#spirit_repository.qi_components.directives.distinct.prerequisites">Prerequisites</a>
 </h6>

@@ -257,7 +257,7 @@

 
<a name="spirit_repository.qi_components.directives.distinct.using_the_distinct_directive_to_match_keywords"></a><h6>
-<a name="id881890"></a>
+<a name="spirit_repository.qi_components.directives.distinct.using_the_distinct_directive_to_match_keywords-heading"></a>
 <a class="link" href="distinct.html#spirit_repository.qi_components.directives.distinct.using_the_distinct_directive_to_match_keywords">Using
 The Distinct Directive to Match keywords</a>
 </h6>

Added: trunk/libs/spirit/repository/doc/html/spirit_repository/qi_components/directives/kwd.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/repository/doc/html/spirit_repository/qi_components/directives/kwd.html 2011-04-15 19:36:47 EDT (Fri, 15 Apr 2011)
@@ -0,0 +1,371 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Qi Keyword Parser Directive</title>
+<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.0">
+<link rel="home" href="../../../index.html" title="Spirit Repository 0.2">
+<link rel="up" href="../directives.html" title="Qi Parser Directives">
+<link rel="prev" href="distinct.html" title="Qi Distinct Parser Directive">
+<link rel="next" href="../nonterminal.html" title="Qi Parser Non-terminals">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="distinct.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../directives.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../nonterminal.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="spirit_repository.qi_components.directives.kwd"></a><a class="link" href="kwd.html" title="Qi Keyword Parser Directive">Qi
+ Keyword Parser Directive </a>
+</h4></div></div></div>
+<a name="spirit_repository.qi_components.directives.kwd.description"></a><h6>
+<a name="spirit_repository.qi_components.directives.kwd.description-heading"></a>
+ <a class="link" href="kwd.html#spirit_repository.qi_components.directives.kwd.description">Description</a>
+ </h6>
+
+ The <code class="computeroutput">kwd[]</code>
+ and <code class="computeroutput">ikwd[]</code>
+ provide a powerful and flexible mechanism for parsing keyword based input.
+ It works in conjuction with the / operator to create an effective keyword
+ parsing loop. The keyword parsing loop doesn't require the keywords to
+ appear in a defined order in the input but also provides the possibility
+ to check how many times a keyword appears in the input.
+ 
+
+ The kwd directive will parse the keywords respecting case sensitivity whereas
+ the ikwd direcive is case insensitive. You can mix the kwd and ikwd directives
+ inside a set of keywords, but be aware that this has a small overhead.
+ It should be prefered not to mix the kwd and ikwd directives.
+ 
+
+ The kwd directive is very similar to the repeat directive in that it enables
+ to enforce keyword occurence constraints but also provides very interesting
+ speed improvement over the pure EBNF syntax or the Nabialek-Trick.
+ 
+<a name="spirit_repository.qi_components.directives.kwd.header"></a><h6>
+<a name="spirit_repository.qi_components.directives.kwd.header-heading"></a>
+ <a class="link" href="kwd.html#spirit_repository.qi_components.directives.kwd.header">Header</a>
+ </h6>
+<pre class="programlisting">// forwards to <boost/spirit/repository/home/qi/directive/kwd.hpp>
+#include <boost/spirit/repository/include/qi_kwd.hpp>
+</pre>
+<a name="spirit_repository.qi_components.directives.kwd.synopsis"></a><h6>
+<a name="spirit_repository.qi_components.directives.kwd.synopsis-heading"></a>
+ <a class="link" href="kwd.html#spirit_repository.qi_components.directives.kwd.synopsis">Synopsis</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Expression
+ 
+ </th>
+<th>
+ 
+ Semantics
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">kwd(keyword)[subject]</code>
+ 
+ </td>
+<td>
+ 
+ Parse ( <code class="computeroutput">"keyword"</code>
+ > <code class="computeroutput">subject</code>)
+ zero or more times.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">kwd(keyword,n)[subject]</code>
+ 
+ </td>
+<td>
+ 
+ Parse ( <code class="computeroutput">"keyword"</code>
+ > <code class="computeroutput">subject</code>)
+ exactly <code class="computeroutput">n</code> times.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">kwd(keyword,min,
+ max)[subject]</code>
+ 
+ </td>
+<td>
+ 
+ Parse ( <code class="computeroutput">"keyword"</code>
+ > <code class="computeroutput">subject</code>)
+ at least <code class="computeroutput">min</code>
+ times and at most <code class="computeroutput">max</code>
+ times.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">kwd(keyword,min,
+ inf)[subject]</code>
+ 
+ </td>
+<td>
+ 
+ Parse ( <code class="computeroutput">"keyword"</code>
+ > <code class="computeroutput">subject</code>)
+ at least <code class="computeroutput">min</code>
+ or more.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+
+ For non case sensitive keywords use the ikwd directive.
+ 
+<a name="spirit_repository.qi_components.directives.kwd.parameters"></a><h6>
+<a name="spirit_repository.qi_components.directives.kwd.parameters-heading"></a>
+ <a class="link" href="kwd.html#spirit_repository.qi_components.directives.kwd.parameters">Parameters</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Parameter
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">keyword</code>
+ 
+ </td>
+<td>
+ 
+ The parser for the opening (the prefix).
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">subject</code>
+ 
+ </td>
+<td>
+ 
+ The parser for the input sequence following the keyword part.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">n</code>
+ 
+ </td>
+<td>
+ 
+ Int representing the exact number of times the keyword must be
+ repeated.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">min</code>
+ 
+ </td>
+<td>
+ 
+ Int representing the minimum number of times the keyword must
+ be repeated.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">max</code>
+ 
+ </td>
+<td>
+ 
+ Int representing the maximum number of times the keyword must
+ be repeated.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+
+ All three parameters can be arbitrarily complex parsers themselves.
+ 
+<a name="spirit_repository.qi_components.directives.kwd.attributes"></a><h6>
+<a name="spirit_repository.qi_components.directives.kwd.attributes-heading"></a>
+ <a class="link" href="kwd.html#spirit_repository.qi_components.directives.kwd.attributes">Attributes</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Expression
+ 
+ </th>
+<th>
+ 
+ Attribute
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">kwd(k1)[a]</code>
+ 
+ </td>
+<td>
+ 
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">a: A --> kwd(k1)[a]: optional<A> or vector<A>
+a: Unused --> kwd(k1)[a]: Unused</pre>
+
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">kwd(k1,n)[a]</code>
+ 
+ </td>
+<td>
+ 
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">a: A --> kwd(k1,n)[a]: optional<A> or vector<A>
+a: Unused --> kwd(k1,n)[a]: Unused</pre>
+
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">kwd(k1,min,
+ max)[a]</code>
+ 
+ </td>
+<td>
+ 
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">a: A --> kwd(k1,min, max)[a]: optional<A> or vector<A>
+a: Unused --> kwd(k1,min, max)[a]: Unused</pre>
+
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">kwd(k1,min,
+ inf)[a]</code>
+ 
+ </td>
+<td>
+ 
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">a: A --> kwd(k1,min, inf)[a]: optional<A> or vector<A>
+a: Unused --> kwd(k1,min, inf)[a]: Unused</pre>
+
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="spirit_repository.qi_components.directives.kwd.complexity"></a><h6>
+<a name="spirit_repository.qi_components.directives.kwd.complexity-heading"></a>
+ <a class="link" href="kwd.html#spirit_repository.qi_components.directives.kwd.complexity">Complexity</a>
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ The overall complexity is defined by the complexity of its subject parser.
+ The complexity of the keyword list construct <code class="computeroutput">kwd</code>
+ itself is O(N), where N is the number of repetitions executed.
+ 
+
+ The complexity of the keyword list itself determined by the complexity
+ of the internal TST contents :
+ 
+
+ O(log n+k)
+ 
+
+ Where k is the length of the string to be searched in a TST with n strings.
+ 
+</blockquote></div>
+<a name="spirit_repository.qi_components.directives.kwd.example"></a><h6>
+<a name="spirit_repository.qi_components.directives.kwd.example-heading"></a>
+ <a class="link" href="kwd.html#spirit_repository.qi_components.directives.kwd.example">Example</a>
+ </h6>
+
+ Please refer to keyword_list.
+ 
+</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-2011 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="distinct.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../directives.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../nonterminal.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Modified: trunk/libs/spirit/repository/doc/html/spirit_repository/qi_components/nonterminal/subrule.html
==============================================================================
--- trunk/libs/spirit/repository/doc/html/spirit_repository/qi_components/nonterminal/subrule.html (original)
+++ trunk/libs/spirit/repository/doc/html/spirit_repository/qi_components/nonterminal/subrule.html 2011-04-15 19:36:47 EDT (Fri, 15 Apr 2011)
@@ -28,7 +28,7 @@
 subrules</a>
</h4></div></div></div>
<a name="spirit_repository.qi_components.nonterminal.subrule.description"></a><h6>
-<a name="id890393"></a>
+<a name="spirit_repository.qi_components.nonterminal.subrule.description-heading"></a>
 <a class="link" href="subrule.html#spirit_repository.qi_components.nonterminal.subrule.description">Description</a>
 </h6>

@@ -97,21 +97,21 @@
 most performance-critical parts), whereas the rest can use rules and grammars.
 
<a name="spirit_repository.qi_components.nonterminal.subrule.header"></a><h6>
-<a name="id891331"></a>
+<a name="spirit_repository.qi_components.nonterminal.subrule.header-heading"></a>
 <a class="link" href="subrule.html#spirit_repository.qi_components.nonterminal.subrule.header">Header</a>
 </h6>
<pre class="programlisting">// forwards to <boost/spirit/repository/home/qi/nonterminal/subrule.hpp>
#include <boost/spirit/repository/include/qi_subrule.hpp>
</pre>
<a name="spirit_repository.qi_components.nonterminal.subrule.synopsis__declaration_"></a><h6>
-<a name="id891406"></a>
+<a name="spirit_repository.qi_components.nonterminal.subrule.synopsis__declaration_-heading"></a>
 <a class="link" href="subrule.html#spirit_repository.qi_components.nonterminal.subrule.synopsis__declaration_">Synopsis
 (declaration)</a>
 </h6>
<pre class="programlisting">subrule<ID, A1, A2> sr(name);
</pre>
<a name="spirit_repository.qi_components.nonterminal.subrule.parameters__declaration_"></a><h6>
-<a name="id891471"></a>
+<a name="spirit_repository.qi_components.nonterminal.subrule.parameters__declaration_-heading"></a>
 <a class="link" href="subrule.html#spirit_repository.qi_components.nonterminal.subrule.parameters__declaration_">Parameters
 (declaration)</a>
 </h6>
@@ -181,7 +181,7 @@
</tbody>
</table></div>
<a name="spirit_repository.qi_components.nonterminal.subrule.synopsis__usage_"></a><h6>
-<a name="id891606"></a>
+<a name="spirit_repository.qi_components.nonterminal.subrule.synopsis__usage_-heading"></a>
 <a class="link" href="subrule.html#spirit_repository.qi_components.nonterminal.subrule.synopsis__usage_">Synopsis
 (usage)</a>
 </h6>
@@ -210,7 +210,7 @@
)(a1, a2, ...) // Arguments to group, i.e. to start subrule srA
</pre>
<a name="spirit_repository.qi_components.nonterminal.subrule.parameters__usage_"></a><h6>
-<a name="id891841"></a>
+<a name="spirit_repository.qi_components.nonterminal.subrule.parameters__usage_-heading"></a>
 <a class="link" href="subrule.html#spirit_repository.qi_components.nonterminal.subrule.parameters__usage_">Parameters
 (usage)</a>
 </h6>
@@ -334,7 +334,7 @@
</tbody>
</table></div>
<a name="spirit_repository.qi_components.nonterminal.subrule.groups"></a><h6>
-<a name="id892166"></a>
+<a name="spirit_repository.qi_components.nonterminal.subrule.groups-heading"></a>
 <a class="link" href="subrule.html#spirit_repository.qi_components.nonterminal.subrule.groups">Groups</a>
 </h6>

@@ -379,7 +379,7 @@
;
</pre>
<a name="spirit_repository.qi_components.nonterminal.subrule.attributes"></a><h6>
-<a name="id892567"></a>
+<a name="spirit_repository.qi_components.nonterminal.subrule.attributes-heading"></a>
 <a class="link" href="subrule.html#spirit_repository.qi_components.nonterminal.subrule.attributes">Attributes</a>
 </h6>

@@ -408,7 +408,7 @@
 </li>
</ul></div>
<a name="spirit_repository.qi_components.nonterminal.subrule.locals"></a><h6>
-<a name="id892657"></a>
+<a name="spirit_repository.qi_components.nonterminal.subrule.locals-heading"></a>
 <a class="link" href="subrule.html#spirit_repository.qi_components.nonterminal.subrule.locals">Locals</a>
 </h6>

@@ -418,7 +418,7 @@
 refer to the subrule's locals, if present.
 
<a name="spirit_repository.qi_components.nonterminal.subrule.example"></a><h6>
-<a name="id892693"></a>
+<a name="spirit_repository.qi_components.nonterminal.subrule.example-heading"></a>
 <a class="link" href="subrule.html#spirit_repository.qi_components.nonterminal.subrule.example">Example</a>
 </h6>

@@ -506,7 +506,7 @@
 <a href="../../../../../example/qi/mini_xml2_sr.cpp" target="_top">../../example/qi/mini_xml2_sr.cpp</a>
 
<a name="spirit_repository.qi_components.nonterminal.subrule.performance"></a><h6>
-<a name="id895182"></a>
+<a name="spirit_repository.qi_components.nonterminal.subrule.performance-heading"></a>
 <a class="link" href="subrule.html#spirit_repository.qi_components.nonterminal.subrule.performance">Performance</a>
 </h6>

@@ -514,7 +514,7 @@
 examples to subrules, with various compilers.
 
<div class="table">
-<a name="id895198"></a>Table 2. Subrules performance
+<a name="id840665"></a>Table 2. Subrules performance
<div class="table-contents"><table class="table" summary="Subrules performance">
<colgroup>
<col>
@@ -761,7 +761,7 @@
 </li>
</ul></div>
<a name="spirit_repository.qi_components.nonterminal.subrule.notes"></a><h6>
-<a name="id895590"></a>
+<a name="spirit_repository.qi_components.nonterminal.subrule.notes-heading"></a>
 <a class="link" href="subrule.html#spirit_repository.qi_components.nonterminal.subrule.notes">Notes</a>
 </h6>

Added: trunk/libs/spirit/repository/doc/html/spirit_repository/qi_components/operators.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/repository/doc/html/spirit_repository/qi_components/operators.html 2011-04-15 19:36:47 EDT (Fri, 15 Apr 2011)
@@ -0,0 +1,46 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Qi Parser Operators</title>
+<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.0">
+<link rel="home" href="../../index.html" title="Spirit Repository 0.2">
+<link rel="up" href="../qi_components.html" title="Qi Components">
+<link rel="prev" href="nonterminal/subrule.html" title="Qi subrules">
+<link rel="next" href="operators/keyword_list.html" title="Keyword List Operator">
+</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/subrule.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../qi_components.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="operators/keyword_list.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="spirit_repository.qi_components.operators"></a><a class="link" href="operators.html" title="Qi Parser Operators">Qi Parser
+ Operators</a>
+</h3></div></div></div>
+<div class="toc"><dl><dt><a href="operators/keyword_list.html">Keyword
+ List Operator</a></dt></dl></div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2001-2011 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/subrule.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../qi_components.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="operators/keyword_list.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: trunk/libs/spirit/repository/doc/html/spirit_repository/qi_components/operators/keyword_list.html
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/repository/doc/html/spirit_repository/qi_components/operators/keyword_list.html 2011-04-15 19:36:47 EDT (Fri, 15 Apr 2011)
@@ -0,0 +1,368 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Keyword List Operator</title>
+<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.0">
+<link rel="home" href="../../../index.html" title="Spirit Repository 0.2">
+<link rel="up" href="../operators.html" title="Qi Parser Operators">
+<link rel="prev" href="../operators.html" title="Qi Parser Operators">
+<link rel="next" href="../../karma_components.html" title="Karma Components">
+</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/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../operators.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../../karma_components.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="spirit_repository.qi_components.operators.keyword_list"></a><a class="link" href="keyword_list.html" title="Keyword List Operator">Keyword
+ List Operator</a>
+</h4></div></div></div>
+<a name="spirit_repository.qi_components.operators.keyword_list.description"></a><h6>
+<a name="spirit_repository.qi_components.operators.keyword_list.description-heading"></a>
+ <a class="link" href="keyword_list.html#spirit_repository.qi_components.operators.keyword_list.description">Description</a>
+ </h6>
+
+ The keyword list operator, <code class="computeroutput">kwd("k1")[a]
+ / kwd("k2")[b]</code>,
+ works tightly with the kwd, ikwd directives to effeciently match keyword
+ lists. As long as one of the keywords specified through the kwd or ikwd
+ directive matches, the keyword will be immediatly followed by the the keyword's
+ associated subject parser. The parser will continue parsing input as long
+ as the one of the keywords and it's associated parser succeed. Writing
+ : (kwd("k1")[a] / kwd("k2")[b] / ... ) is equivalent
+ to: *( "k1" > a | "k2" > b ... ).
+ 
+<a name="spirit_repository.qi_components.operators.keyword_list.header"></a><h6>
+<a name="spirit_repository.qi_components.operators.keyword_list.header-heading"></a>
+ <a class="link" href="keyword_list.html#spirit_repository.qi_components.operators.keyword_list.header">Header</a>
+ </h6>
+<pre class="programlisting">// forwards to <boost/spirit/repository/home/qi/operator/keywords.hpp>
+#include <boost/spirit/repository/include/qi_keywords.hpp>
+</pre>
+<a name="spirit_repository.qi_components.operators.keyword_list.expression_semantics"></a><h6>
+<a name="spirit_repository.qi_components.operators.keyword_list.expression_semantics-heading"></a>
+ <a class="link" href="keyword_list.html#spirit_repository.qi_components.operators.keyword_list.expression_semantics">Expression
+ Semantics</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Expression
+ 
+ </th>
+<th>
+ 
+ Semantics
+ 
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ 
+ <code class="computeroutput">kwd(k1)[a]
+ / kwd(k2)[b]</code>
+ 
+ </td>
+<td>
+ 
+ Match <code class="computeroutput">lit(k1)
+ > a</code>
+ or <code class="computeroutput">lit(k2)
+ > b</code>,
+ equivalent to <code class="computeroutput">lit(k1) >
+ a |
+ lit(k2)
+ > b</code>
+ 
+ </td>
+</tr></tbody>
+</table></div>
+<a name="spirit_repository.qi_components.operators.keyword_list.attributes"></a><h6>
+<a name="spirit_repository.qi_components.operators.keyword_list.attributes-heading"></a>
+ <a class="link" href="keyword_list.html#spirit_repository.qi_components.operators.keyword_list.attributes">Attributes</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Expression
+ 
+ </th>
+<th>
+ 
+ Attribute
+ 
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ 
+ <code class="computeroutput">kwd("k1")[a]
+ / kwd("k2")[b]</code>
+ 
+ </td>
+<td>
+ 
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">a: A, b: B --> (kwd(k1)[a] / kwd(k2)[b]): tuple<A, B>
+a: A, b: Unused --> (kwd(k1)[a] / kwd(k2)[b]): optional<A>
+a: Unused, b: B --> (kwd("k1")[a] / kwd(k2)[b]): optional<B>
+a: Unused, b: Unused --> (kwd(k1)[a] / kwd(k2)[b]): Unused
+
+a: A, b: A -->(kwd(k1)[a] / kwd(k2)[b]): tuple<A, A></pre>
+
+ 
+ </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 align="left" valign="top">
+ The keyword list parser works tightly with the kwd and ikwd directives
+ and can't be used without it. A compile time error will warn you of any
+ mistakes. This parser collects all the kwd directives and extracts the
+ keyword literals from the directives to internaly build a Ternary Search
+ Tree (TST) to effectively parse the keywords. Because you we can't mix
+ character types inside a TST you must take care not to mix wide strings
+ with normal strings in the keyword you supply to a keyword list. Should
+ it happen the compiler will trap the mistake for you.
+ </td></tr>
+</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 align="left" valign="top">
+ The kwd directive also works a bit like the repeat directive and can
+ be used to formulate additional contraints on the number of times a keyword
+ can occur while parsing a keyword list.
+ </td></tr>
+</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 align="left" valign="top">
+ The kwd and ikwd directives can be mixed inside a keyword list. This
+ has however a small overhead and should be avoided when possible.
+ </td></tr>
+</table></div>
+<a name="spirit_repository.qi_components.operators.keyword_list.complexity"></a><h6>
+<a name="spirit_repository.qi_components.operators.keyword_list.complexity-heading"></a>
+ <a class="link" href="keyword_list.html#spirit_repository.qi_components.operators.keyword_list.complexity">Complexity</a>
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ The overall complexity of the keyword list parser is defined by the sum
+ of the complexities of its elements. The complexity of the keyword list
+ itself is determined by the complexity of the internal TST contents :
+ 
+
+ O(log n+k)
+ 
+
+ Where k is the length of the string to be searched in a TST with n strings.
+ 
+</blockquote></div>
+<a name="spirit_repository.qi_components.operators.keyword_list.example"></a><h6>
+<a name="spirit_repository.qi_components.operators.keyword_list.example-heading"></a>
+ <a class="link" href="keyword_list.html#spirit_repository.qi_components.operators.keyword_list.example">Example</a>
+ </h6>
+<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 align="left" valign="top">
+ The test harness for the example(s) below is presented in the _qi_basics_examples_ section.
+ </td></tr>
+</table></div>
+
+ Declare a small data structure representing a person:
+ 
+
+
+
+<pre class="programlisting">// Data structure definitions to test the kwd directive
+// and the keywords list operator
+
+struct person {
+ std::string name;
+ int age;
+ double size;
+ std::vector<std::string> favorite_colors;
+
+};
+
+std::ostream &operator<<(std::ostream &os, const person &p)
+{
+ os<<"Person : "<<p.name<<", "<<p.age<<", "<<p.size<<std::endl;
+ std::copy(p.favorite_colors.begin(),p.favorite_colors.end(),std::ostream_iterator<std::string>(os,"\n"));
+ return os;
+}
+
+BOOST_FUSION_ADAPT_STRUCT( person,
+ (std::string, name)
+ (int, age)
+ (double, size)
+ (std::vector<std::string>, favorite_colors)
+)
+</pre>
+
+ 
+
+ Some using declarations:
+ 
+
+
+
+<pre class="programlisting">using boost::spirit::repository::qi::kwd;
+using boost::spirit::qi::inf;
+using boost::spirit::ascii::space_type;
+using boost::spirit::ascii::char_;
+using boost::spirit::qi::double_;
+using boost::spirit::qi::int_;
+using boost::spirit::qi::rule;
+</pre>
+
+ 
+
+ Now let's declare a keyword parser:
+ 
+
+
+
+<pre class="programlisting">no_constraint_person_rule %=
+ kwd("name")['=' > parse_string ]
+ / kwd("age") ['=' > int_]
+ / kwd("size") ['=' > double_ > 'm']
+ ;
+</pre>
+
+ 
+
+ A couple of input string variations run on the same parser:
+ 
+
+ Parsing a keyword list:
+ 
+
+
+
+<pre class="programlisting">// Let's declare a small list of people for which we want to collect information.
+person John,Mary,Mike,Hellen,Johny;
+test_phrase_parser_attr(
+ "name = \"John\" \n age = 10 \n size = 1.69m "
+ ,no_constraint_person_rule
+ ,John); // full in orginal order
+std::cout<<John;
+
+test_phrase_parser_attr(
+ "age = 10 \n size = 1.69m \n name = \"Mary\""
+ ,no_constraint_person_rule
+ ,Mary); // keyword oder doesn't matter
+std::cout<<Mary;
+
+test_phrase_parser_attr(
+ "size = 1.69m \n name = \"Mike\" \n age = 10 "
+ ,no_constraint_person_rule
+ ,Mike); // still the same result
+
+std::cout<<Mike;</pre>
+
+ 
+
+ The code above will print:
+ 
+<pre class="programlisting">Person : John, 10, 1.69
+Person : Mary, 10, 1.69
+Person : Mike, 10, 1.69
+</pre>
+
+ Now let's delcare a parser with some occurence constraints:
+ 
+
+ The parser definition below uses the kwd directive occurence constraint
+ variants to make sure that the name and age keyword occur only once and
+ allows the favorite color entry to appear 0 or more times.
+ 
+
+
+
+<pre class="programlisting">constraint_person_rule %=
+ kwd("name",1) ['=' > parse_string ]
+ / kwd("age" ,1) ['=' > int_]
+ / kwd("size" ,1) ['=' > double_ > 'm']
+ / kwd("favorite color",0,inf) [ '=' > parse_string ]
+ ;
+</pre>
+
+ 
+
+ And see how it works in these two cases:
+ 
+
+
+
+<pre class="programlisting"> // Here all the give constraint are resepected : parsing will succeed.
+ test_phrase_parser_attr(
+ "name = \"Hellen\" \n age = 10 \n size = 1.80m \n favorite color = \"blue\" \n favorite color = \"green\" "
+ ,constraint_person_rule
+ ,Hellen);
+ std::cout<<Hellen;
+
+// Parsing this string will fail because the age and size minimum occurence requirements aren't met.
+test_phrase_parser_attr(
+ "name = \"Johny\" \n favorite color = \"blue\" \n favorite color = \"green\" "
+ ,constraint_person_rule
+ ,Johny );</pre>
+
+ 
+
+ Parsing the first string will succeed but fail for the second string as
+ the occurence constraints aren't met. This code should print:
+ 
+<pre class="programlisting">Person : Hellen, 10, 1.8
+blue
+green
+</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-2011 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/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../operators.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../../karma_components.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Modified: trunk/libs/spirit/repository/doc/html/spirit_repository/qi_components/primitive/advance.html
==============================================================================
--- trunk/libs/spirit/repository/doc/html/spirit_repository/qi_components/primitive/advance.html (original)
+++ trunk/libs/spirit/repository/doc/html/spirit_repository/qi_components/primitive/advance.html 2011-04-15 19:36:47 EDT (Fri, 15 Apr 2011)
@@ -28,7 +28,7 @@
 advance Parser</a>
</h4></div></div></div>
<a name="spirit_repository.qi_components.primitive.advance.description"></a><h6>
-<a name="id863615"></a>
+<a name="spirit_repository.qi_components.primitive.advance.description-heading"></a>
 <a class="link" href="advance.html#spirit_repository.qi_components.primitive.advance.description">Description</a>
 </h6>

@@ -66,20 +66,20 @@
<pre class="programlisting">little_dword[_a = _1] >> advance(_a) >> little_dword...
</pre>
<a name="spirit_repository.qi_components.primitive.advance.header"></a><h6>
-<a name="id871597"></a>
+<a name="spirit_repository.qi_components.primitive.advance.header-heading"></a>
 <a class="link" href="advance.html#spirit_repository.qi_components.primitive.advance.header">Header</a>
 </h6>
<pre class="programlisting">// forwards to <boost/spirit/repository/home/qi/primitive/advance.hpp>
#include <boost/spirit/repository/include/qi_advance.hpp>
</pre>
<a name="spirit_repository.qi_components.primitive.advance.synopsis"></a><h6>
-<a name="id871675"></a>
+<a name="spirit_repository.qi_components.primitive.advance.synopsis-heading"></a>
 <a class="link" href="advance.html#spirit_repository.qi_components.primitive.advance.synopsis">Synopsis</a>
 </h6>
<pre class="programlisting">advance(distance)
</pre>
<a name="spirit_repository.qi_components.primitive.advance.parameters"></a><h6>
-<a name="id871712"></a>
+<a name="spirit_repository.qi_components.primitive.advance.parameters-heading"></a>
 <a class="link" href="advance.html#spirit_repository.qi_components.primitive.advance.parameters">Parameters</a>
 </h6>
<div class="informaltable"><table class="table">
@@ -113,7 +113,7 @@
</tr></tbody>
</table></div>
<a name="spirit_repository.qi_components.primitive.advance.attribute"></a><h6>
-<a name="id871783"></a>
+<a name="spirit_repository.qi_components.primitive.advance.attribute-heading"></a>
 <a class="link" href="advance.html#spirit_repository.qi_components.primitive.advance.attribute">Attribute</a>
 </h6>

@@ -123,7 +123,7 @@
<pre class="programlisting">advance --> unused
</pre>
<a name="spirit_repository.qi_components.primitive.advance.example"></a><h6>
-<a name="id871837"></a>
+<a name="spirit_repository.qi_components.primitive.advance.example-heading"></a>
 <a class="link" href="advance.html#spirit_repository.qi_components.primitive.advance.example">Example</a>
 </h6>

@@ -132,7 +132,7 @@
 binary data (for the full example code see advance.cpp)
 
<a name="spirit_repository.qi_components.primitive.advance.prerequisites"></a><h6>
-<a name="id871872"></a>
+<a name="spirit_repository.qi_components.primitive.advance.prerequisites-heading"></a>
 <a class="link" href="advance.html#spirit_repository.qi_components.primitive.advance.prerequisites">Prerequisites</a>
 </h6>

@@ -162,7 +162,7 @@

 
<a name="spirit_repository.qi_components.primitive.advance.setting_up_the_grammar"></a><h6>
-<a name="id872143"></a>
+<a name="spirit_repository.qi_components.primitive.advance.setting_up_the_grammar-heading"></a>
 <a class="link" href="advance.html#spirit_repository.qi_components.primitive.advance.setting_up_the_grammar">Setting
 up the Grammar</a>
 </h6>
@@ -206,7 +206,7 @@
 descend into alternatives.
 
<a name="spirit_repository.qi_components.primitive.advance.parsing_a_correctly_delimited_string_of_data"></a><h6>
-<a name="id872598"></a>
+<a name="spirit_repository.qi_components.primitive.advance.parsing_a_correctly_delimited_string_of_data-heading"></a>
 <a class="link" href="advance.html#spirit_repository.qi_components.primitive.advance.parsing_a_correctly_delimited_string_of_data">Parsing
 a Correctly-delimited String of Data</a>
 </h6>
@@ -245,7 +245,7 @@

 
<a name="spirit_repository.qi_components.primitive.advance.parsing_the_alternative_representation"></a><h6>
-<a name="id873282"></a>
+<a name="spirit_repository.qi_components.primitive.advance.parsing_the_alternative_representation-heading"></a>
 <a class="link" href="advance.html#spirit_repository.qi_components.primitive.advance.parsing_the_alternative_representation">Parsing
 the Alternative Representation</a>
 </h6>
@@ -284,7 +284,7 @@

 
<a name="spirit_repository.qi_components.primitive.advance.notes"></a><h6>
-<a name="id875038"></a>
+<a name="spirit_repository.qi_components.primitive.advance.notes-heading"></a>
 <a class="link" href="advance.html#spirit_repository.qi_components.primitive.advance.notes">Notes</a>
 </h6>

Modified: trunk/libs/spirit/repository/doc/html/spirit_repository/qi_components/primitive/flush_multi_pass.html
==============================================================================
--- trunk/libs/spirit/repository/doc/html/spirit_repository/qi_components/primitive/flush_multi_pass.html (original)
+++ trunk/libs/spirit/repository/doc/html/spirit_repository/qi_components/primitive/flush_multi_pass.html 2011-04-15 19:36:47 EDT (Fri, 15 Apr 2011)
@@ -28,7 +28,7 @@
 flush_multi_pass parser</a>
</h4></div></div></div>
<a name="spirit_repository.qi_components.primitive.flush_multi_pass.description"></a><h6>
-<a name="id875078"></a>
+<a name="spirit_repository.qi_components.primitive.flush_multi_pass.description-heading"></a>
 <a class="link" href="flush_multi_pass.html#spirit_repository.qi_components.primitive.flush_multi_pass.description">Description</a>
 </h6>

@@ -53,20 +53,20 @@
 <code class="computeroutput">eps</code>).
 
<a name="spirit_repository.qi_components.primitive.flush_multi_pass.header"></a><h6>
-<a name="id875186"></a>
+<a name="spirit_repository.qi_components.primitive.flush_multi_pass.header-heading"></a>
 <a class="link" href="flush_multi_pass.html#spirit_repository.qi_components.primitive.flush_multi_pass.header">Header</a>
 </h6>
<pre class="programlisting">// forwards to <boost/spirit/repository/home/qi/primitive/flush_multi_pass.hpp>
#include <boost/spirit/repository/include/qi_flush_multi_pass.hpp>
</pre>
<a name="spirit_repository.qi_components.primitive.flush_multi_pass.synopsis"></a><h6>
-<a name="id875259"></a>
+<a name="spirit_repository.qi_components.primitive.flush_multi_pass.synopsis-heading"></a>
 <a class="link" href="flush_multi_pass.html#spirit_repository.qi_components.primitive.flush_multi_pass.synopsis">Synopsis</a>
 </h6>
<pre class="programlisting">flush_multi_pass
</pre>
<a name="spirit_repository.qi_components.primitive.flush_multi_pass.parameters"></a><h6>
-<a name="id875280"></a>
+<a name="spirit_repository.qi_components.primitive.flush_multi_pass.parameters-heading"></a>
 <a class="link" href="flush_multi_pass.html#spirit_repository.qi_components.primitive.flush_multi_pass.parameters">Parameters</a>
 </h6>

@@ -74,7 +74,7 @@
 not require any parameters.
 
<a name="spirit_repository.qi_components.primitive.flush_multi_pass.attribute"></a><h6>
-<a name="id875304"></a>
+<a name="spirit_repository.qi_components.primitive.flush_multi_pass.attribute-heading"></a>
 <a class="link" href="flush_multi_pass.html#spirit_repository.qi_components.primitive.flush_multi_pass.attribute">Attribute</a>
 </h6>

@@ -84,7 +84,7 @@
<pre class="programlisting">flush_multi_pass --> unused
</pre>
<a name="spirit_repository.qi_components.primitive.flush_multi_pass.example"></a><h6>
-<a name="id875354"></a>
+<a name="spirit_repository.qi_components.primitive.flush_multi_pass.example-heading"></a>
 <a class="link" href="flush_multi_pass.html#spirit_repository.qi_components.primitive.flush_multi_pass.example">Example</a>
 </h6>

@@ -96,7 +96,7 @@
 a function prototype (for the full example code see here: flush_multi_pass.cpp)
 
<a name="spirit_repository.qi_components.primitive.flush_multi_pass.prerequisites"></a><h6>
-<a name="id875386"></a>
+<a name="spirit_repository.qi_components.primitive.flush_multi_pass.prerequisites-heading"></a>
 <a class="link" href="flush_multi_pass.html#spirit_repository.qi_components.primitive.flush_multi_pass.prerequisites">Prerequisites</a>
 </h6>

@@ -125,7 +125,7 @@

 
<a name="spirit_repository.qi_components.primitive.flush_multi_pass.clearing_the_internal_buffer"></a><h6>
-<a name="id875595"></a>
+<a name="spirit_repository.qi_components.primitive.flush_multi_pass.clearing_the_internal_buffer-heading"></a>
 <a class="link" href="flush_multi_pass.html#spirit_repository.qi_components.primitive.flush_multi_pass.clearing_the_internal_buffer">Clearing
 the internal buffer</a>
 </h6>

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