Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r55710 - in trunk/libs/spirit/doc: . html html/spirit html/spirit/karma html/spirit/karma/performance_measurements html/spirit/karma/performance_measurements/numeric_performance html/spirit/karma/quick_reference html/spirit/karma/reference html/spirit/karma/reference/auxiliary html/spirit/karma/reference/char html/spirit/karma/reference/directive html/spirit/karma/reference/generator_concepts html/spirit/karma/reference/numeric html/spirit/karma/reference/operator html/spirit/karma/tutorials html/spirit/lex html/spirit/lex/abstracts html/spirit/lex/abstracts/lexer_primitives html/spirit/lex/reference html/spirit/lex/reference/concepts html/spirit/lex/tutorials html/spirit/qi/quick_reference html/spirit/qi/reference html/spirit/qi/reference/auxiliary html/spirit/qi/reference/directive html/spirit/qi/reference/parser_concepts html/spirit/qi/reference/string html/spirit/support qi
From: joel_at_[hidden]
Date: 2009-08-22 01:26:54

Author: djowel
Date: 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
New Revision: 55710
URL: http://svn.boost.org/trac/boost/changeset/55710

Log:
tweaks to chunking
Text files modified:
   trunk/libs/spirit/doc/Jamfile | 2
   trunk/libs/spirit/doc/html/index.html | 2
   trunk/libs/spirit/doc/html/spirit/acknowledgments.html | 2
   trunk/libs/spirit/doc/html/spirit/faq.html | 12
   trunk/libs/spirit/doc/html/spirit/karma.html | 6
   trunk/libs/spirit/doc/html/spirit/karma/performance_measurements.html | 6
   trunk/libs/spirit/doc/html/spirit/karma/performance_measurements/numeric_performance.html | 802 +++++++++++
   trunk/libs/spirit/doc/html/spirit/karma/performance_measurements/numeric_performance/double_performance.html | 2
   trunk/libs/spirit/doc/html/spirit/karma/performance_measurements/numeric_performance/format_performance.html | 2
   trunk/libs/spirit/doc/html/spirit/karma/performance_measurements/numeric_performance/int_performance.html | 2
   trunk/libs/spirit/doc/html/spirit/karma/quick_reference/compound_attribute_rules.html | 20
   trunk/libs/spirit/doc/html/spirit/karma/quick_reference/predefined_primitive_generators.html | 190 +-
   trunk/libs/spirit/doc/html/spirit/karma/reference/auxiliary.html | 486 ++++++
   trunk/libs/spirit/doc/html/spirit/karma/reference/auxiliary/eol.html | 14
   trunk/libs/spirit/doc/html/spirit/karma/reference/auxiliary/eps.html | 14
   trunk/libs/spirit/doc/html/spirit/karma/reference/auxiliary/lazy.html | 14
   trunk/libs/spirit/doc/html/spirit/karma/reference/char.html | 1070 +++++++++++++++
   trunk/libs/spirit/doc/html/spirit/karma/reference/char/char_class.html | 14
   trunk/libs/spirit/doc/html/spirit/karma/reference/char/char_generator.html | 14
   trunk/libs/spirit/doc/html/spirit/karma/reference/directive.html | 2308 +++++++++++++++++++++++++++++++++
   trunk/libs/spirit/doc/html/spirit/karma/reference/directive/alignment.html | 14
   trunk/libs/spirit/doc/html/spirit/karma/reference/directive/buffer.html | 14
   trunk/libs/spirit/doc/html/spirit/karma/reference/directive/delimit.html | 14
   trunk/libs/spirit/doc/html/spirit/karma/reference/directive/maxwidth.html | 14
   trunk/libs/spirit/doc/html/spirit/karma/reference/directive/omit.html | 14
   trunk/libs/spirit/doc/html/spirit/karma/reference/directive/repeat.html | 14
   trunk/libs/spirit/doc/html/spirit/karma/reference/directive/upperlower.html | 14
   trunk/libs/spirit/doc/html/spirit/karma/reference/generator_concepts.html | 870 ++++++++++++
   trunk/libs/spirit/doc/html/spirit/karma/reference/generator_concepts/binarygenerator.html | 12
   trunk/libs/spirit/doc/html/spirit/karma/reference/generator_concepts/generator.html | 10
   trunk/libs/spirit/doc/html/spirit/karma/reference/generator_concepts/narygenerator.html | 12
   trunk/libs/spirit/doc/html/spirit/karma/reference/generator_concepts/primitivegenerator.html | 10
   trunk/libs/spirit/doc/html/spirit/karma/reference/generator_concepts/unarygenerator.html | 12
   trunk/libs/spirit/doc/html/spirit/karma/reference/karma_basics.html | 11
   trunk/libs/spirit/doc/html/spirit/karma/reference/numeric.html | 2734 +++++++++++++++++++++++++++++++++++++++
   trunk/libs/spirit/doc/html/spirit/karma/reference/numeric/floating_point.html | 20
   trunk/libs/spirit/doc/html/spirit/karma/reference/numeric/signed_int.html | 16
   trunk/libs/spirit/doc/html/spirit/karma/reference/numeric/unsigned_int.html | 16
   trunk/libs/spirit/doc/html/spirit/karma/reference/operator.html | 2095 ++++++++++++++++++++++++++++++
   trunk/libs/spirit/doc/html/spirit/karma/reference/operator/alternative.html | 14
   trunk/libs/spirit/doc/html/spirit/karma/reference/operator/and_predicate.html | 14
   trunk/libs/spirit/doc/html/spirit/karma/reference/operator/kleene.html | 14
   trunk/libs/spirit/doc/html/spirit/karma/reference/operator/list.html | 14
   trunk/libs/spirit/doc/html/spirit/karma/reference/operator/not_predicate.html | 14
   trunk/libs/spirit/doc/html/spirit/karma/reference/operator/optional.html | 14
   trunk/libs/spirit/doc/html/spirit/karma/reference/operator/plus.html | 14
   trunk/libs/spirit/doc/html/spirit/karma/reference/operator/sequence.html | 14
   trunk/libs/spirit/doc/html/spirit/karma/tutorials/karma_attributes.html | 12
   trunk/libs/spirit/doc/html/spirit/karma/tutorials/quick_start.html | 2
   trunk/libs/spirit/doc/html/spirit/karma/tutorials/semantic_actions.html | 2
   trunk/libs/spirit/doc/html/spirit/karma/tutorials/warming_up.html | 10
   trunk/libs/spirit/doc/html/spirit/lex.html | 8
   trunk/libs/spirit/doc/html/spirit/lex/abstracts/lexer_primitives.html | 364 +++++
   trunk/libs/spirit/doc/html/spirit/lex/abstracts/lexer_primitives/lexer_token_values.html | 6
   trunk/libs/spirit/doc/html/spirit/lex/abstracts/lexer_semantic_actions.html | 10
   trunk/libs/spirit/doc/html/spirit/lex/abstracts/lexer_states.html | 6
   trunk/libs/spirit/doc/html/spirit/lex/abstracts/lexer_static_model.html | 4
   trunk/libs/spirit/doc/html/spirit/lex/abstracts/lexer_tokenizing.html | 11
   trunk/libs/spirit/doc/html/spirit/lex/lexer_introduction.html | 6
   trunk/libs/spirit/doc/html/spirit/lex/reference/concepts.html | 395 +++++
   trunk/libs/spirit/doc/html/spirit/lex/reference/concepts/lexer.html | 6
   trunk/libs/spirit/doc/html/spirit/lex/reference/lexer_class.html | 14
   trunk/libs/spirit/doc/html/spirit/lex/tutorials/lexer_quickstart1.html | 10
   trunk/libs/spirit/doc/html/spirit/lex/tutorials/lexer_quickstart2.html | 8
   trunk/libs/spirit/doc/html/spirit/lex/tutorials/lexer_quickstart3.html | 10
   trunk/libs/spirit/doc/html/spirit/qi/quick_reference/compound_attribute_rules.html | 2
   trunk/libs/spirit/doc/html/spirit/qi/quick_reference/qi_parsers.html | 1282 +++++++++--------
   trunk/libs/spirit/doc/html/spirit/qi/reference/auxiliary.html | 267 +++
   trunk/libs/spirit/doc/html/spirit/qi/reference/auxiliary/attr.html | 14
   trunk/libs/spirit/doc/html/spirit/qi/reference/basics.html | 10
   trunk/libs/spirit/doc/html/spirit/qi/reference/directive.html | 267 +++
   trunk/libs/spirit/doc/html/spirit/qi/reference/directive/no_case.html | 14
   trunk/libs/spirit/doc/html/spirit/qi/reference/parser_concepts.html | 765 +++++++++++
   trunk/libs/spirit/doc/html/spirit/qi/reference/parser_concepts/binaryparser.html | 12
   trunk/libs/spirit/doc/html/spirit/qi/reference/parser_concepts/naryparser.html | 12
   trunk/libs/spirit/doc/html/spirit/qi/reference/parser_concepts/parser.html | 10
   trunk/libs/spirit/doc/html/spirit/qi/reference/parser_concepts/primitiveparser.html | 10
   trunk/libs/spirit/doc/html/spirit/qi/reference/parser_concepts/unaryparser.html | 12
   trunk/libs/spirit/doc/html/spirit/qi/reference/string.html | 821 +++++++++++
   trunk/libs/spirit/doc/html/spirit/qi/reference/string/lit_string.html | 14
   trunk/libs/spirit/doc/html/spirit/qi/reference/string/symbols.html | 16
   trunk/libs/spirit/doc/html/spirit/support/multi_pass.html | 28
   trunk/libs/spirit/doc/html/spirit/what_s_new.html | 6
   trunk/libs/spirit/doc/qi/quick_reference.qbk | 40
   84 files changed, 14305 insertions(+), 1191 deletions(-)

Modified: trunk/libs/spirit/doc/Jamfile
==============================================================================
--- trunk/libs/spirit/doc/Jamfile (original)
+++ trunk/libs/spirit/doc/Jamfile 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -19,7 +19,7 @@
 <xsl:param>boost.root=../../../..
 <xsl:param>boost.libraries=../../../libraries.htm
 <xsl:param>html.stylesheet=../../../../doc/html/boostbook.css
- <xsl:param>chunk.section.depth=4
+ <xsl:param>chunk.section.depth=3
 <xsl:param>chunk.first.sections=1
 <xsl:param>toc.section.depth=3
 <xsl:param>toc.max.depth=3

Modified: trunk/libs/spirit/doc/html/index.html
==============================================================================
--- trunk/libs/spirit/doc/html/index.html (original)
+++ trunk/libs/spirit/doc/html/index.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -191,7 +191,7 @@
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left">Last revised: August 22, 2009 at 05:06:06 GMT</td>
+<td align="left">Last revised: August 22, 2009 at 05:23:16 GMT</td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>

Modified: trunk/libs/spirit/doc/html/spirit/acknowledgments.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/acknowledgments.html (original)
+++ trunk/libs/spirit/doc/html/spirit/acknowledgments.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -50,7 +50,7 @@
 FIXME: Add more people
 
<a name="spirit.acknowledgments.acknowledgements_from_the_spirit_v1__emphasis_classic__emphasis__documentation"></a><h3>
-<a name="id616101"></a>
+<a name="id616291"></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>

Modified: trunk/libs/spirit/doc/html/spirit/faq.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/faq.html (original)
+++ trunk/libs/spirit/doc/html/spirit/faq.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -30,7 +30,7 @@
<div></div>
</div>
<a name="spirit.faq.i_m_getting_multiple_symbol_definition_errors_while_using_visual_c____anything_i_could_do_about_that_"></a><h3>
-<a name="id613806"></a>
+<a name="id613986"></a>
 <a href="faq.html#spirit.faq.i_m_getting_multiple_symbol_definition_errors_while_using_visual_c____anything_i_could_do_about_that_">I'm
 getting multiple symbol definition errors while using Visual C++. Anything
 I could do about that?</a>
@@ -67,7 +67,7 @@
 static_assert.
 
<a name="spirit.faq.i_m_very_confused_about_the_header_hell_in_my_boost_spirit_directory__what_s_all_this_about_"></a><h3>
-<a name="id614070"></a>
+<a name="id614250"></a>
 <a href="faq.html#spirit.faq.i_m_very_confused_about_the_header_hell_in_my_boost_spirit_directory__what_s_all_this_about_">I'm
 very confused about the header hell in my boost/spirit directory. What's all
 this about?</a>
@@ -175,19 +175,19 @@
 are available.
 
<a name="spirit.faq.why_doesn_t_my_symbol_table_work_in_a__code__phrase_role__identifier__no_case__phrase___code__directive_"></a><h3>
-<a name="id614815"></a>
+<a name="id614999"></a>
 <a href="faq.html#spirit.faq.why_doesn_t_my_symbol_table_work_in_a__code__phrase_role__identifier__no_case__phrase___code__directive_">Why
 doesn't my symbol table work in a <tt class="computeroutput">no_case</tt>
 directive?</a>
 </h3>

- In order to perform case-insensitive parsing (using no_case[a])
- with a symbol table (i.e. use a symbols<Ch, T> parser in a <tt class="computeroutput">no_case</tt>
+ In order to perform case-insensitive parsing (using no_case[a])
+ with a symbol table (i.e. use a symbols<Ch, T> parser in a <tt class="computeroutput">no_case</tt>
 directive), that symbol table needs to be filled with all-lowercase contents.
 Entries containing one or more uppercase characters will not match any input.
 
<a name="spirit.faq.i_m_getting_a_compilation_error_mentioning__code__phrase_role__identifier__boost__phrase__phrase_role__special______phrase__phrase_role__identifier__function__phrase___code__and_or___________code__phrase_role__identifier__boost__phrase__phrase_role__special______phrase__phrase_role__identifier__function4__phrase___code___what_does_this_mean_"></a><h3>
-<a name="id614967"></a>
+<a name="id615151"></a>
 <a href="faq.html#spirit.faq.i_m_getting_a_compilation_error_mentioning__code__phrase_role__identifier__boost__phrase__phrase_role__special______phrase__phrase_role__identifier__function__phrase___code__and_or___________code__phrase_role__identifier__boost__phrase__phrase_role__special______phrase__phrase_role__identifier__function4__phrase___code___what_does_this_mean_">I'm
 getting a compilation error mentioning <tt class="computeroutput">boost::function</tt>
 and/or <tt class="computeroutput">boost::function4</tt>. What does this mean?</a>

Modified: trunk/libs/spirit/doc/html/spirit/karma.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/karma.html (original)
+++ trunk/libs/spirit/doc/html/spirit/karma.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -6,7 +6,7 @@
<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
<link rel="home" href="../index.html" title="Spirit 2.1">
<link rel="up" href="../index.html" title="Spirit 2.1">
-<link rel="previous" href="qi/reference/string/symbols.html" title="symbols">
+<link rel="previous" href="qi/reference/string.html" title="String">
<link rel="next" href="karma/tutorials.html" title="Tutorials">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@@ -20,7 +20,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="qi/reference/string/symbols.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="karma/tutorials.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="qi/reference/string.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="karma/tutorials.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage">
@@ -82,7 +82,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="qi/reference/string/symbols.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="karma/tutorials.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="qi/reference/string.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="karma/tutorials.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>

Modified: trunk/libs/spirit/doc/html/spirit/karma/performance_measurements.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/karma/performance_measurements.html (original)
+++ trunk/libs/spirit/doc/html/spirit/karma/performance_measurements.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -6,7 +6,7 @@
<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
<link rel="home" href="../../index.html" title="Spirit 2.1">
<link rel="up" href="../karma.html" title=" Karma - Writing Generators">
-<link rel="previous" href="reference/auxiliary/lazy.html" title="lazy">
+<link rel="previous" href="reference/auxiliary.html" title="Auxiliary">
<link rel="next" href="performance_measurements/numeric_performance.html" title="
Performance of Numeric Generators">
</head>
@@ -21,7 +21,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="reference/auxiliary/lazy.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../karma.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="performance_measurements/numeric_performance.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="reference/auxiliary.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../karma.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="performance_measurements/numeric_performance.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage">
@@ -44,7 +44,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="reference/auxiliary/lazy.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../karma.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="performance_measurements/numeric_performance.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="reference/auxiliary.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../karma.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="performance_measurements/numeric_performance.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>

Modified: trunk/libs/spirit/doc/html/spirit/karma/performance_measurements/numeric_performance.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/karma/performance_measurements/numeric_performance.html (original)
+++ trunk/libs/spirit/doc/html/spirit/karma/performance_measurements/numeric_performance.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -8,8 +8,7 @@
<link rel="home" href="../../../index.html" title="Spirit 2.1">
<link rel="up" href="../performance_measurements.html" title="Performance Measurements">
<link rel="previous" href="../performance_measurements.html" title="Performance Measurements">
-<link rel="next" href="numeric_performance/int_performance.html" title="
- Comparing the performance of a single int_ generator">
+<link rel="next" href="../../lex.html" title=" Lex - Writing Lexical Analyzers">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
@@ -22,7 +21,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../performance_measurements.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../performance_measurements.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_performance/int_performance.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="../performance_measurements.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../performance_measurements.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">
@@ -34,13 +33,802 @@
<div></div>
</div>
<div class="toc"><dl>
-<dt><a href="numeric_performance/int_performance.html">
+<dt><a href="numeric_performance.html#spirit.karma.performance_measurements.numeric_performance.int_performance">
 Comparing the performance of a single int_ generator</a></dt>
-<dt><a href="numeric_performance/double_performance.html">
+<dt><a href="numeric_performance.html#spirit.karma.performance_measurements.numeric_performance.double_performance">
 Comparing the performance of a single double_ generator</a></dt>
-<dt><a href="numeric_performance/format_performance.html">
+<dt><a href="numeric_performance.html#spirit.karma.performance_measurements.numeric_performance.format_performance">
 Comparing the performance of a sequence of several generators</a></dt>
</dl></div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.karma.performance_measurements.numeric_performance.int_performance"></a><a href="numeric_performance.html#spirit.karma.performance_measurements.numeric_performance.int_performance" title="
+ Comparing the performance of a single int_ generator">
+ Comparing the performance of a single int_ generator</a>
+</h5></div></div>
+<div></div>
+</div>
+
+ This performance measurements are centered around default formatting
+ of a single <tt class="computeroutput">int</tt> integer
+ number using different libraries and methods. The overall execution times
+ for those examples are compared below. We compare using <tt class="computeroutput">sprintf</tt>, C++ iostreams, Boost.Format,
+ and Spirit.Karma.
+ 
+
+ For the full source code of the performance test please see here: int_generator.cpp).
+ All the measurements have been done by executing 10000000 iterations
+ for each formatting type (NUMITERATIONS is set to 10000000 in the code
+ shown below).
+ 
+
+ Code used to measure the performance for <tt class="computeroutput">ltoa</tt>:
+ 
+
+ 
+
+
+
+<pre class="programlisting">char buffer[65]; // we don't expect more than 64 bytes to be generated here
+for (int i = 0; i < MAX_ITERATION; ++i)
+{
+ ltoa(v[i], buffer, 10);
+}
+</pre>
+
+ 
+
+ 
+
+ Code used to measure the performance for standard C++ iostreams:
+ 
+
+ 
+
+
+
+<pre class="programlisting">std::stringstream str;
+for (int i = 0; i < MAX_ITERATION; ++i)
+{
+ str.str("");
+ str << v[i];
+}
+</pre>
+
+ 
+
+ 
+
+ Code used to measure the performance for Boost.Format:
+ 
+
+ 
+
+
+
+<pre class="programlisting">std::string str;
+boost::format int_format("%d");
+for (int i = 0; i < MAX_ITERATION; ++i)
+{
+ str = boost::str(int_format % v[i]);
+}
+</pre>
+
+ 
+
+ 
+
+ Code used to measure the performance for Spirit.Karma
+ using a plain character buffer:
+ 
+
+ 
+
+
+
+<pre class="programlisting">char buffer[65]; // we don't expect more than 64 bytes to be generated here
+for (int i = 0; i < MAX_ITERATION; ++i)
+{
+ char *ptr = buffer;
+ karma::generate(ptr, int_, v[i]);
+ *ptr = '\0';
+}
+</pre>
+
+ 
+
+ 
+
+ The following table shows the overall performance results collected while
+ using different compilers. All times are in seconds measured for 10000000
+ iterations (platform: Windows7, Intel Core Duo(tm) Processor, 2.8GHz,
+ 4GByte RAM). For a more readable comparison of the results see this
+ figure.
+ 
+<div class="table">
+<a name="id570938"></a>Table 15. Performance comparison for a single int (all
+ times in [s], 10000000 iterations)
+<table class="table" summary="Performance comparison for a single int (all
+ times in [s], 10000000 iterations)">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Library
+ </th>
+<th>
+ gcc 4.4.0 (32 bit)
+ </th>
+<th>
+ VC++ 10 (32 bit)
+ </th>
+<th>
+ Intel 11.1 (32 bit)
+ </th>
+<th>
+ gcc 4.4.0 (64 bit)
+ </th>
+<th>
+ VC++ 10 (64 bit)
+ </th>
+<th>
+ Intel 11.1 (64 bit)
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ ltoa
+ </td>
+<td>
+ 1.542
+ </td>
+<td>
+ 0.895
+ </td>
+<td>
+ 0.884
+ </td>
+<td>
+ 1.163
+ </td>
+<td>
+ 1.099
+ </td>
+<td>
+ 0.906
+ </td>
+</tr>
+<tr>
+<td>
+ iostreams
+ </td>
+<td>
+ 6.548
+ </td>
+<td>
+ 13.727
+ </td>
+<td>
+ 11.898
+ </td>
+<td>
+ 3.464
+ </td>
+<td>
+ 8.316
+ </td>
+<td>
+ 8.115
+ </td>
+</tr>
+<tr>
+<td>
+ Boost.Format
+ </td>
+<td>
+ 16.998
+ </td>
+<td>
+ 21.813
+ </td>
+<td>
+ 20.477
+ </td>
+<td>
+ 17.464
+ </td>
+<td>
+ 14.662
+ </td>
+<td>
+ 13.646
+ </td>
+</tr>
+<tr>
+<td>
+ Spirit.Karma int_
+ </td>
+<td>
+ 1.421
+ </td>
+<td>
+ 0.744
+ </td>
+<td>
+ 0.697
+ </td>
+<td>
+ 1.072
+ </td>
+<td>
+ 0.953
+ </td>
+<td>
+ 0.606
+ </td>
+</tr>
+</tbody>
+</table>
+</div>
+
+ 
+<div class="figure">
+<a name="spirit.karma.int_performance"></a>Figure 3. Performance comparison for a single int
+<img src="./images/int_performance.png" alt="Performance
+ comparison for a single int">
+</div>
+
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.karma.performance_measurements.numeric_performance.double_performance"></a><a href="numeric_performance.html#spirit.karma.performance_measurements.numeric_performance.double_performance" title="
+ Comparing the performance of a single double_ generator">
+ Comparing the performance of a single double_ generator</a>
+</h5></div></div>
+<div></div>
+</div>
+
+ This performance measurements are centered around default formatting
+ of a single <tt class="computeroutput">double</tt> floating
+ point number using different libraries and methods. The overall execution
+ times for those examples are compared below. We compare using <tt class="computeroutput">sprintf</tt>, C++ iostreams, Boost.Format,
+ and Spirit.Karma.
+ 
+
+ For the full source code of the performance test please see here: double_performance.cpp).
+ All the measurements have been done by executing 1000000 iterations for
+ each formatting type (NUMITERATIONS is set to 1000000 in the code shown
+ below).
+ 
+
+ Code used to measure the performance for <tt class="computeroutput">sprintf</tt>:
+ 
+
+ 
+
+
+
+<pre class="programlisting">char buffer[256];
+for (int i = 0; i < NUMITERATIONS; ++i) {
+ sprintf(buffer, "%f", 12345.12345);
+}
+</pre>
+
+ 
+
+ 
+
+ Code used to measure the performance for standard C++ iostreams:
+ 
+
+ 
+
+
+
+<pre class="programlisting">std::stringstream strm;
+for (int i = 0; i < NUMITERATIONS; ++i) {
+ strm.str("");
+ strm << 12345.12345;
+}
+</pre>
+
+ 
+
+ 
+
+ Code used to measure the performance for Boost.Format:
+ 
+
+ 
+
+
+
+<pre class="programlisting">std::string generated;
+boost::format double_format("%f");
+for (int i = 0; i < NUMITERATIONS; ++i)
+ generated = boost::str(double_format % 12345.12345);
+</pre>
+
+ 
+
+ 
+
+ The following code shows the common definitions used by all Spirit.Karma
+ performance measurements as listed below:
+ 
+
+ 
+
+
+
+<pre class="programlisting">using boost::spirit::karma::double_;
+</pre>
+
+ 
+
+ 
+
+ Code used to measure the performance for Spirit.Karma
+ using a plain character buffer:
+ 
+
+ 
+
+
+
+<pre class="programlisting">char buffer[256];
+for (int i = 0; i < NUMITERATIONS; ++i) {
+ char *p = buffer;
+ generate(p, double_, 12345.12345);
+ *p = '\0';
+}
+</pre>
+
+ 
+
+ 
+
+ The following table shows the overall performance results collected while
+ using different compilers. All times are in seconds measured for 1000000
+ iterations (platform: Windows7, Intel Core Duo(tm) Processor, 2.8GHz,
+ 4GByte RAM). For a more readable comparison of the results see this
+ figure.
+ 
+<div class="table">
+<a name="id572317"></a>Table 16. Performance comparison for a single double (all
+ times in [s], 1000000 iterations)
+<table class="table" summary="Performance comparison for a single double (all
+ times in [s], 1000000 iterations)">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Library
+ </th>
+<th>
+ gcc 4.4.0 (32 bit)
+ </th>
+<th>
+ VC++ 10 (32 bit)
+ </th>
+<th>
+ Intel 11.1 (32 bit)
+ </th>
+<th>
+ gcc 4.4.0 (64 bit)
+ </th>
+<th>
+ VC++ 10 (64 bit)
+ </th>
+<th>
+ Intel 11.1 (64 bit)
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ sprintf
+ </td>
+<td>
+ 0.755
+ </td>
+<td>
+ 0.965
+ </td>
+<td>
+ 0.880
+ </td>
+<td>
+ 0.713
+ </td>
+<td>
+ 0.807
+ </td>
+<td>
+ 0.694
+ </td>
+</tr>
+<tr>
+<td>
+ iostreams
+ </td>
+<td>
+ 2.316
+ </td>
+<td>
+ 2.624
+ </td>
+<td>
+ 1.964
+ </td>
+<td>
+ 1.634
+ </td>
+<td>
+ 1.468
+ </td>
+<td>
+ 1.354
+ </td>
+</tr>
+<tr>
+<td>
+ Boost.Format
+ </td>
+<td>
+ 3.188
+ </td>
+<td>
+ 3.737
+ </td>
+<td>
+ 2.878
+ </td>
+<td>
+ 3.217
+ </td>
+<td>
+ 2.672
+ </td>
+<td>
+ 2.011
+ </td>
+</tr>
+<tr>
+<td>
+ Spirit.Karma double_
+ </td>
+<td>
+ 0.813
+ </td>
+<td>
+ 0.561
+ </td>
+<td>
+ 0.368
+ </td>
+<td>
+ 0.426
+ </td>
+<td>
+ 0.260
+ </td>
+<td>
+ 0.218
+ </td>
+</tr>
+</tbody>
+</table>
+</div>
+
+ 
+<div class="figure">
+<a name="spirit.karma.double_performance"></a>Figure 4. Performance comparison for a single double
+<img src="./images/double_performance.png" alt="Performance
+ comparison for a single double">
+</div>
+
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.karma.performance_measurements.numeric_performance.format_performance"></a><a href="numeric_performance.html#spirit.karma.performance_measurements.numeric_performance.format_performance" title="
+ Comparing the performance of a sequence of several generators">
+ Comparing the performance of a sequence of several generators</a>
+</h5></div></div>
+<div></div>
+</div>
+
+ This performance measurements are centered around formatting of a sequence
+ of different items, including 2 <tt class="computeroutput">double</tt>
+ floating point numbers using different libraries and methods. The overall
+ execution times for those examples are compared below. We compare using
+ <tt class="computeroutput">sprintf</tt>, C++ iostreams,
+ Boost.Format,
+ and Spirit.Karma.
+ 
+
+ For the full source code of the performance test please see here: format_performance.cpp).
+ All the measurements have been done by doing 1000000 iterations for each
+ formatting type (NUMITERATIONS is set to 1000000).
+ 
+
+ Code used to measure the performance for sprintf:
+ 
+
+ 
+
+
+
+<pre class="programlisting">char buffer[256];
+for (int i = 0; i < NUMITERATIONS; ++i) {
+ sprintf(buffer, "[%-14.3f%-14.3f]", 12345.12345, 12345.12345);
+}
+</pre>
+
+ 
+
+ 
+
+ Code used to measure the performance for standard iostreams:
+ 
+
+ 
+
+
+
+<pre class="programlisting">std::stringstream strm;
+for (int i = 0; i < NUMITERATIONS; ++i) {
+ strm.str("");
+ strm << '['
+ << std::setiosflags(std::ios::fixed)
+ << std::left
+ << std::setprecision(3)
+ << std::setw(14)
+ << 12345.12345
+ << std::setw(14)
+ << 12345.12345
+ << ']';
+}
+</pre>
+
+ 
+
+ 
+
+ Code used to measure the performance for Boost.Format:
+ 
+
+ 
+
+
+
+<pre class="programlisting">std::string generated;
+boost::format outformat("[%-14.3f%-14.3f]");
+for (int i = 0; i < NUMITERATIONS; ++i)
+ generated = boost::str(outformat % 12345.12345 % 12345.12345);
+</pre>
+
+ 
+
+ 
+
+ The following code shows the common definitions used by all Spirit.Karma
+ performance measurements as listed below:
+ 
+
+ 
+
+
+
+<pre class="programlisting">template <typename T>
+struct double3_policy : boost::spirit::karma::real_policies<T>
+{
+ // we want to generate up to 3 fractional digits
+ static unsigned int precision(T) { return 3; }
+};
+
+typedef boost::spirit::karma::real_generator<double, double3_policy<double> >
+ double3_type;
+double3_type const double3 = double3_type();
+</pre>
+
+ 
+
+ 
+
+ Code used to measure the performance for Spirit.Karma
+ using a plain character buffer:
+ 
+
+ 
+
+
+
+<pre class="programlisting">char buffer[256];
+for (int i = 0; i < NUMITERATIONS; ++i) {
+ char *p = buffer;
+ generate(p
+ , '[' << left_align(14)[double3] << left_align(14)[double3] << ']'
+ , 12345.12345, 12345.12345);
+ *p = '\0';
+}
+</pre>
+
+ 
+
+ 
+
+ The following table shows the overall performance results collected while
+ using different compilers. All times are in seconds measured for 1000000
+ iterations (platform: Windows7, Intel Core Duo(tm) Processor, 2.8GHz,
+ 4GByte RAM). For a more readable comparison of the results see this
+ <a href="numeric_performance.html#spirit.karma.format_performance" title="Figure 5. Performance comparison for a sequence
+ of several items">figure</a>.
+ 
+<div class="table">
+<a name="id574309"></a>Table 17. Performance comparison for a sequence of several
+ items (all times in [s], 1000000 iterations)
+<table class="table" summary="Performance comparison for a sequence of several
+ items (all times in [s], 1000000 iterations)">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Library
+ </th>
+<th>
+ gcc 4.4.0 (32 bit)
+ </th>
+<th>
+ VC++ 10 (32 bit)
+ </th>
+<th>
+ Intel 11.1 (32 bit)
+ </th>
+<th>
+ gcc 4.4.0 (64 bit)
+ </th>
+<th>
+ VC++ 10 (64 bit)
+ </th>
+<th>
+ Intel 11.1 (64 bit)
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ sprintf
+ </td>
+<td>
+ 1.725
+ </td>
+<td>
+ 1.892
+ </td>
+<td>
+ 1.903
+ </td>
+<td>
+ 1.469
+ </td>
+<td>
+ 1.608
+ </td>
+<td>
+ 1.493
+ </td>
+</tr>
+<tr>
+<td>
+ iostreams
+ </td>
+<td>
+ 4.827
+ </td>
+<td>
+ 5.287
+ </td>
+<td>
+ 4.444
+ </td>
+<td>
+ 3.112
+ </td>
+<td>
+ 3.319
+ </td>
+<td>
+ 2.877
+ </td>
+</tr>
+<tr>
+<td>
+ Boost.Format
+ </td>
+<td>
+ 5.881
+ </td>
+<td>
+ 7.089
+ </td>
+<td>
+ 5.801
+ </td>
+<td>
+ 5.455
+ </td>
+<td>
+ 5.254
+ </td>
+<td>
+ 4.164
+ </td>
+</tr>
+<tr>
+<td>
+ Spirit.Karma
+ </td>
+<td>
+ 1.942
+ </td>
+<td>
+ 1.242
+ </td>
+<td>
+ 0.999
+ </td>
+<td>
+ 1.334
+ </td>
+<td>
+ 0.758
+ </td>
+<td>
+ 0.686
+ </td>
+</tr>
+</tbody>
+</table>
+</div>
+
+ 
+<div class="figure">
+<a name="spirit.karma.format_performance"></a>Figure 5. Performance comparison for a sequence
+ of several items
+<img src="./images/format_performance.png" alt="Performance comparison
+ for a sequence of several items">
+</div>
+
+ 
+</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
@@ -53,7 +841,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../performance_measurements.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../performance_measurements.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_performance/int_performance.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="../performance_measurements.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../performance_measurements.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>

Modified: trunk/libs/spirit/doc/html/spirit/karma/performance_measurements/numeric_performance/double_performance.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/karma/performance_measurements/numeric_performance/double_performance.html (original)
+++ trunk/libs/spirit/doc/html/spirit/karma/performance_measurements/numeric_performance/double_performance.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -143,7 +143,7 @@
 <a href="double_performance.html#spirit.karma.double_performance" title="Figure 4. Performance comparison for a single double">figure</a>.
 
<div class="table">
-<a name="id572008"></a>Table 24. Performance comparison for a single double (all
+<a name="id572317"></a>Table 16. Performance comparison for a single double (all
 times in [s], 1000000 iterations)
<table class="table" summary="Performance comparison for a single double (all
 times in [s], 1000000 iterations)">

Modified: trunk/libs/spirit/doc/html/spirit/karma/performance_measurements/numeric_performance/format_performance.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/karma/performance_measurements/numeric_performance/format_performance.html (original)
+++ trunk/libs/spirit/doc/html/spirit/karma/performance_measurements/numeric_performance/format_performance.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -163,7 +163,7 @@
 of several items">figure</a>.
 
<div class="table">
-<a name="id573999"></a>Table 25. Performance comparison for a sequence of several
+<a name="id574309"></a>Table 17. Performance comparison for a sequence of several
 items (all times in [s], 1000000 iterations)
<table class="table" summary="Performance comparison for a sequence of several
 items (all times in [s], 1000000 iterations)">

Modified: trunk/libs/spirit/doc/html/spirit/karma/performance_measurements/numeric_performance/int_performance.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/karma/performance_measurements/numeric_performance/int_performance.html (original)
+++ trunk/libs/spirit/doc/html/spirit/karma/performance_measurements/numeric_performance/int_performance.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -133,7 +133,7 @@
 <a href="int_performance.html#spirit.karma.int_performance" title="Figure 3. Performance comparison for a single int">figure</a>.
 
<div class="table">
-<a name="id570634"></a>Table 23. Performance comparison for a single int (all
+<a name="id570938"></a>Table 15. Performance comparison for a single int (all
 times in [s], 10000000 iterations)
<table class="table" summary="Performance comparison for a single int (all
 times in [s], 10000000 iterations)">

Modified: trunk/libs/spirit/doc/html/spirit/karma/quick_reference/compound_attribute_rules.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/karma/quick_reference/compound_attribute_rules.html (original)
+++ trunk/libs/spirit/doc/html/spirit/karma/quick_reference/compound_attribute_rules.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -47,7 +47,7 @@
 b</tt> will be <tt class="computeroutput">tuple<A, B></tt>.
 
<div class="table">
-<a name="id487486"></a>Table 22. Spirit.Karma compound generator attribute types
+<a name="id487797"></a>Table 14. Spirit.Karma compound generator attribute types
<table class="table" summary="Spirit.Karma compound generator attribute types">
<colgroup>
<col>
@@ -64,7 +64,7 @@
<tbody>
<tr>
<td>
- <a href="../reference/operator/sequence.html" title=" Sequences
+ <a href="../reference/operator.html#spirit.karma.reference.operator.sequence" title=" Sequences
 (operator<<())">sequence
 (<tt class="computeroutput"><<</tt>)</a>
 </td>
@@ -87,7 +87,7 @@
</tr>
<tr>
<td>
- <a href="../reference/operator/alternative.html" title=" Alternatives
+ <a href="../reference/operator.html#spirit.karma.reference.operator.alternative" title=" Alternatives
 (operator|())">alternative
 (<tt class="computeroutput">|</tt>)</a>
 </td>
@@ -106,7 +106,7 @@
</tr>
<tr>
<td>
- <a href="../reference/operator/kleene.html" title=" Kleene Star
+ <a href="../reference/operator.html#spirit.karma.reference.operator.kleene" title=" Kleene Star
 (unary operator*())">kleene (unary
 <tt class="computeroutput">*</tt>)</a>
 </td>
@@ -122,7 +122,7 @@
</tr>
<tr>
<td>
- <a href="../reference/operator/plus.html" title=" Plus (unary
+ <a href="../reference/operator.html#spirit.karma.reference.operator.plus" title=" Plus (unary
 operator+())">plus (unary
 <tt class="computeroutput">+</tt>)</a>
 </td>
@@ -138,7 +138,7 @@
</tr>
<tr>
<td>
- list (%)
+ list (%)
 </td>
<td>

@@ -152,7 +152,7 @@
</tr>
<tr>
<td>
- <a href="../reference/directive/repeat.html" title=" Repetition
+ <a href="../reference/directive.html#spirit.karma.reference.directive.repeat" title=" Repetition
 Directive (repeat[])">repetition</a>
 </td>
<td>
@@ -167,7 +167,7 @@
</tr>
<tr>
<td>
- <a href="../reference/operator/optional.html" title=" Optional
+ <a href="../reference/operator.html#spirit.karma.reference.operator.optional" title=" Optional
 (unary operator-())">optional
 (unary <tt class="computeroutput">-</tt>)</a>
 </td>
@@ -183,7 +183,7 @@
</tr>
<tr>
<td>
- <a href="../reference/operator/and_predicate.html" title=" And
+ <a href="../reference/operator.html#spirit.karma.reference.operator.and_predicate" title=" And
 Predicate (unary operator&())">and
 predicate (unary <tt class="computeroutput">&</tt>)</a>
 </td>
@@ -195,7 +195,7 @@
</tr>
<tr>
<td>
- <a href="../reference/operator/not_predicate.html" title=" Not
+ <a href="../reference/operator.html#spirit.karma.reference.operator.not_predicate" title=" Not
 Predicate (unary operator!())">not
 predicate (unary <tt class="computeroutput">!</tt>)</a>
 </td>

Modified: trunk/libs/spirit/doc/html/spirit/karma/quick_reference/predefined_primitive_generators.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/karma/quick_reference/predefined_primitive_generators.html (original)
+++ trunk/libs/spirit/doc/html/spirit/karma/quick_reference/predefined_primitive_generators.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -39,7 +39,7 @@
 Generators</a>.
 
<div class="table">
-<a name="id478488"></a>Table 13. Predefined Character Generators
+<a name="id478798"></a>Table 5. Predefined Character Generators
<table class="table" summary="Predefined Character Generators">
<colgroup>
<col>
@@ -60,7 +60,7 @@
<tbody>
<tr>
<td>
- <a href="../reference/char/char_generator.html" title=" Character
+ <a href="../reference/char.html#spirit.karma.reference.char.char_generator" title=" Character
 Generators"><tt class="computeroutput">ch</tt></a>
 </td>
<td>
@@ -72,7 +72,7 @@
</tr>
<tr>
<td>
- <a href="../reference/char/char_generator.html" title=" Character
+ <a href="../reference/char.html#spirit.karma.reference.char.char_generator" title=" Character
 Generators"><tt class="computeroutput">lit(ch)</tt></a>
 </td>
<td>
@@ -84,7 +84,7 @@
</tr>
<tr>
<td>
- <a href="../reference/char/char_generator.html" title=" Character
+ <a href="../reference/char.html#spirit.karma.reference.char.char_generator" title=" Character
 Generators"><tt class="computeroutput">char_(ch)</tt></a>
 </td>
<td>
@@ -97,7 +97,7 @@
</tr>
<tr>
<td>
- <a href="../reference/char/char_generator.html" title=" Character
+ <a href="../reference/char.html#spirit.karma.reference.char.char_generator" title=" Character
 Generators"><tt class="computeroutput">char_("c")</tt></a>
 </td>
<td>
@@ -110,7 +110,7 @@
</tr>
<tr>
<td>
- <a href="../reference/char/char_generator.html" title=" Character
+ <a href="../reference/char.html#spirit.karma.reference.char.char_generator" title=" Character
 Generators"><tt class="computeroutput">char_(ch, ch2)</tt></a>
 </td>
<td>
@@ -125,7 +125,7 @@
</tr>
<tr>
<td>
- <a href="../reference/char/char_generator.html" title=" Character
+ <a href="../reference/char.html#spirit.karma.reference.char.char_generator" title=" Character
 Generators"><tt class="computeroutput">char_(charset)</tt></a>
 </td>
<td>
@@ -139,7 +139,7 @@
</tr>
<tr>
<td>
- <a href="../reference/char/char_class.html" title=" Character
+ <a href="../reference/char.html#spirit.karma.reference.char.char_class" title=" Character
 Class Generators"><tt class="computeroutput">alnum</tt></a>
 </td>
<td>
@@ -153,7 +153,7 @@
</tr>
<tr>
<td>
- <a href="../reference/char/char_class.html" title=" Character
+ <a href="../reference/char.html#spirit.karma.reference.char.char_class" title=" Character
 Class Generators"><tt class="computeroutput">alpha</tt></a>
 </td>
<td>
@@ -167,7 +167,7 @@
</tr>
<tr>
<td>
- <a href="../reference/char/char_class.html" title=" Character
+ <a href="../reference/char.html#spirit.karma.reference.char.char_class" title=" Character
 Class Generators"><tt class="computeroutput">blank</tt></a>
 </td>
<td>
@@ -181,7 +181,7 @@
</tr>
<tr>
<td>
- <a href="../reference/char/char_class.html" title=" Character
+ <a href="../reference/char.html#spirit.karma.reference.char.char_class" title=" Character
 Class Generators"><tt class="computeroutput">cntrl</tt></a>
 </td>
<td>
@@ -195,7 +195,7 @@
</tr>
<tr>
<td>
- <a href="../reference/char/char_class.html" title=" Character
+ <a href="../reference/char.html#spirit.karma.reference.char.char_class" title=" Character
 Class Generators"><tt class="computeroutput">digit</tt></a>
 </td>
<td>
@@ -209,7 +209,7 @@
</tr>
<tr>
<td>
- <a href="../reference/char/char_class.html" title=" Character
+ <a href="../reference/char.html#spirit.karma.reference.char.char_class" title=" Character
 Class Generators"><tt class="computeroutput">graph</tt></a>
 </td>
<td>
@@ -223,7 +223,7 @@
</tr>
<tr>
<td>
- <a href="../reference/char/char_class.html" title=" Character
+ <a href="../reference/char.html#spirit.karma.reference.char.char_class" title=" Character
 Class Generators"><tt class="computeroutput">print</tt></a>
 </td>
<td>
@@ -237,7 +237,7 @@
</tr>
<tr>
<td>
- <a href="../reference/char/char_class.html" title=" Character
+ <a href="../reference/char.html#spirit.karma.reference.char.char_class" title=" Character
 Class Generators"><tt class="computeroutput">punct</tt></a>
 </td>
<td>
@@ -251,7 +251,7 @@
</tr>
<tr>
<td>
- <a href="../reference/char/char_class.html" title=" Character
+ <a href="../reference/char.html#spirit.karma.reference.char.char_class" title=" Character
 Class Generators"><tt class="computeroutput">space</tt></a>
 </td>
<td>
@@ -265,7 +265,7 @@
</tr>
<tr>
<td>
- <a href="../reference/char/char_class.html" title=" Character
+ <a href="../reference/char.html#spirit.karma.reference.char.char_class" title=" Character
 Class Generators"><tt class="computeroutput">xdigit</tt></a>
 </td>
<td>
@@ -279,7 +279,7 @@
</tr>
<tr>
<td>
- <a href="../reference/char/char_class.html" title=" Character
+ <a href="../reference/char.html#spirit.karma.reference.char.char_class" title=" Character
 Class Generators"><tt class="computeroutput">lower</tt></a>
 </td>
<td>
@@ -293,7 +293,7 @@
</tr>
<tr>
<td>
- <a href="../reference/char/char_class.html" title=" Character
+ <a href="../reference/char.html#spirit.karma.reference.char.char_class" title=" Character
 Class Generators"><tt class="computeroutput">upper</tt></a>
 </td>
<td>
@@ -312,7 +312,7 @@
 See here for more information about String Generators .
 
<div class="table">
-<a name="id480119"></a>Table 14. Predefined String Generators
+<a name="id480430"></a>Table 6. Predefined String Generators
<table class="table" summary="Predefined String Generators">
<colgroup>
<col>
@@ -373,7 +373,7 @@
 Directives</a>.
 
<div class="table">
-<a name="id480386"></a>Table 15. Predefined Generator Directives
+<a name="id480696"></a>Table 7. Predefined Generator Directives
<table class="table" summary="Predefined Generator Directives">
<colgroup>
<col>
@@ -394,7 +394,7 @@
<tbody>
<tr>
<td>
- <a href="../reference/directive/upperlower.html" title=" Directives
+ <a href="../reference/directive.html#spirit.karma.reference.directive.upperlower" title=" Directives
 Controlling Case Sensitivity (upper[] and lower[])"><tt class="computeroutput">lower[a]</tt></a>
 </td>
<td>
@@ -407,7 +407,7 @@
</tr>
<tr>
<td>
- <a href="../reference/directive/upperlower.html" title=" Directives
+ <a href="../reference/directive.html#spirit.karma.reference.directive.upperlower" title=" Directives
 Controlling Case Sensitivity (upper[] and lower[])"><tt class="computeroutput">upper[a]</tt></a>
 </td>
<td>
@@ -420,7 +420,7 @@
</tr>
<tr>
<td>
- <a href="../reference/directive/alignment.html" title=" Alignment
+ <a href="../reference/directive.html#spirit.karma.reference.directive.alignment" title=" Alignment
 Directives (left_align[], center[], and right_align[])"><tt class="computeroutput">left_align[a]</tt></a>
 </td>
<td>
@@ -433,7 +433,7 @@
</tr>
<tr>
<td>
- <a href="../reference/directive/alignment.html" title=" Alignment
+ <a href="../reference/directive.html#spirit.karma.reference.directive.alignment" title=" Alignment
 Directives (left_align[], center[], and right_align[])"><tt class="computeroutput">left_align(num)[a]</tt></a>
 </td>
<td>
@@ -446,7 +446,7 @@
</tr>
<tr>
<td>
- <a href="../reference/directive/alignment.html" title=" Alignment
+ <a href="../reference/directive.html#spirit.karma.reference.directive.alignment" title=" Alignment
 Directives (left_align[], center[], and right_align[])"><tt class="computeroutput">left_align(num,
 g)[a]</tt></a>
 </td>
@@ -462,7 +462,7 @@
</tr>
<tr>
<td>
- <a href="../reference/directive/alignment.html" title=" Alignment
+ <a href="../reference/directive.html#spirit.karma.reference.directive.alignment" title=" Alignment
 Directives (left_align[], center[], and right_align[])"><tt class="computeroutput">center[a]</tt></a>
 </td>
<td>
@@ -475,7 +475,7 @@
</tr>
<tr>
<td>
- <a href="../reference/directive/alignment.html" title=" Alignment
+ <a href="../reference/directive.html#spirit.karma.reference.directive.alignment" title=" Alignment
 Directives (left_align[], center[], and right_align[])"><tt class="computeroutput">center(num)[a]</tt></a>
 </td>
<td>
@@ -488,7 +488,7 @@
</tr>
<tr>
<td>
- <a href="../reference/directive/alignment.html" title=" Alignment
+ <a href="../reference/directive.html#spirit.karma.reference.directive.alignment" title=" Alignment
 Directives (left_align[], center[], and right_align[])"><tt class="computeroutput">center(num,
 g)[a]</tt></a>
 </td>
@@ -504,7 +504,7 @@
</tr>
<tr>
<td>
- <a href="../reference/directive/alignment.html" title=" Alignment
+ <a href="../reference/directive.html#spirit.karma.reference.directive.alignment" title=" Alignment
 Directives (left_align[], center[], and right_align[])"><tt class="computeroutput">right_align[a]</tt></a>
 </td>
<td>
@@ -517,7 +517,7 @@
</tr>
<tr>
<td>
- <a href="../reference/directive/alignment.html" title=" Alignment
+ <a href="../reference/directive.html#spirit.karma.reference.directive.alignment" title=" Alignment
 Directives (left_align[], center[], and right_align[])"><tt class="computeroutput">right_align(num)[a]</tt></a>
 </td>
<td>
@@ -530,7 +530,7 @@
</tr>
<tr>
<td>
- <a href="../reference/directive/alignment.html" title=" Alignment
+ <a href="../reference/directive.html#spirit.karma.reference.directive.alignment" title=" Alignment
 Directives (left_align[], center[], and right_align[])"><tt class="computeroutput">right_align(num,
 g)[a]</tt></a>
 </td>
@@ -546,7 +546,7 @@
</tr>
<tr>
<td>
- <a href="../reference/directive/maxwidth.html" title=" Controlling
+ <a href="../reference/directive.html#spirit.karma.reference.directive.maxwidth" title=" Controlling
 the Maximum Field Wield (maxwidth[])"><tt class="computeroutput">maxwidth[a]</tt></a>
 </td>
<td>
@@ -559,7 +559,7 @@
</tr>
<tr>
<td>
- <a href="../reference/directive/maxwidth.html" title=" Controlling
+ <a href="../reference/directive.html#spirit.karma.reference.directive.maxwidth" title=" Controlling
 the Maximum Field Wield (maxwidth[])"><tt class="computeroutput">maxwidth(num)[a]</tt></a>
 </td>
<td>
@@ -572,7 +572,7 @@
</tr>
<tr>
<td>
- <a href="../reference/directive/repeat.html" title=" Repetition
+ <a href="../reference/directive.html#spirit.karma.reference.directive.repeat" title=" Repetition
 Directive (repeat[])"><tt class="computeroutput">repeat[a]</tt></a>
 </td>
<td>
@@ -585,7 +585,7 @@
</tr>
<tr>
<td>
- <a href="../reference/directive/repeat.html" title=" Repetition
+ <a href="../reference/directive.html#spirit.karma.reference.directive.repeat" title=" Repetition
 Directive (repeat[])"><tt class="computeroutput">repeat(num)[a]</tt></a>
 </td>
<td>
@@ -597,7 +597,7 @@
</tr>
<tr>
<td>
- <a href="../reference/directive/repeat.html" title=" Repetition
+ <a href="../reference/directive.html#spirit.karma.reference.directive.repeat" title=" Repetition
 Directive (repeat[])"><tt class="computeroutput">repeat(num1,
 num2)[a]</tt></a>
 </td>
@@ -611,7 +611,7 @@
</tr>
<tr>
<td>
- <a href="../reference/directive/repeat.html" title=" Repetition
+ <a href="../reference/directive.html#spirit.karma.reference.directive.repeat" title=" Repetition
 Directive (repeat[])"><tt class="computeroutput">repeat(num,
 inf)[a]</tt></a>
 </td>
@@ -624,7 +624,7 @@
</tr>
<tr>
<td>
- <a href="../reference/directive/delimit.html" title=" Directives
+ <a href="../reference/directive.html#spirit.karma.reference.directive.delimit" title=" Directives
 Controlling Automatic Delimiting (verbatim[] and delimit[])"><tt class="computeroutput">verbatim[a]</tt></a>
 </td>
<td>
@@ -636,7 +636,7 @@
</tr>
<tr>
<td>
- <a href="../reference/directive/delimit.html" title=" Directives
+ <a href="../reference/directive.html#spirit.karma.reference.directive.delimit" title=" Directives
 Controlling Automatic Delimiting (verbatim[] and delimit[])"><tt class="computeroutput">delimit[a]</tt></a>
 </td>
<td>
@@ -648,7 +648,7 @@
</tr>
<tr>
<td>
- <a href="../reference/directive/delimit.html" title=" Directives
+ <a href="../reference/directive.html#spirit.karma.reference.directive.delimit" title=" Directives
 Controlling Automatic Delimiting (verbatim[] and delimit[])"><tt class="computeroutput">delimit(d)[a]</tt></a>
 </td>
<td>
@@ -661,7 +661,7 @@
</tr>
<tr>
<td>
- <a href="../reference/directive/omit.html" title=" Consume Attribute
+ <a href="../reference/directive.html#spirit.karma.reference.directive.omit" title=" Consume Attribute
 (omit[])"><tt class="computeroutput">omit[a]</tt></a>
 </td>
<td>
@@ -674,7 +674,7 @@
</tr>
<tr>
<td>
- <a href="../reference/directive/buffer.html" title=" Temporary
+ <a href="../reference/directive.html#spirit.karma.reference.directive.buffer" title=" Temporary
 Output Buffering (buffer[])"><tt class="computeroutput">buffer[a]</tt></a>
 </td>
<td>
@@ -694,7 +694,7 @@
 Generators</a>.
 
<div class="table">
-<a name="id482640"></a>Table 16. Predefined Floating Point Number Generators
+<a name="id482950"></a>Table 8. Predefined Floating Point Number Generators
<table class="table" summary="Predefined Floating Point Number Generators">
<colgroup>
<col>
@@ -726,7 +726,7 @@
</tr>
<tr>
<td>
- <a href="../reference/numeric/floating_point.html" title=" Floating
+ <a href="../reference/numeric.html#spirit.karma.reference.numeric.floating_point" title=" Floating
 Point Number Generators"><tt class="computeroutput">float_</tt></a>
 </td>
<td>
@@ -738,7 +738,7 @@
</tr>
<tr>
<td>
- <a href="../reference/numeric/floating_point.html" title=" Floating
+ <a href="../reference/numeric.html#spirit.karma.reference.numeric.floating_point" title=" Floating
 Point Number Generators"><tt class="computeroutput">float_(num)</tt></a>
 </td>
<td>
@@ -752,7 +752,7 @@
</tr>
<tr>
<td>
- <a href="../reference/numeric/floating_point.html" title=" Floating
+ <a href="../reference/numeric.html#spirit.karma.reference.numeric.floating_point" title=" Floating
 Point Number Generators"><tt class="computeroutput">double_</tt></a>
 </td>
<td>
@@ -764,7 +764,7 @@
</tr>
<tr>
<td>
- <a href="../reference/numeric/floating_point.html" title=" Floating
+ <a href="../reference/numeric.html#spirit.karma.reference.numeric.floating_point" title=" Floating
 Point Number Generators"><tt class="computeroutput">double_(num)</tt></a>
 </td>
<td>
@@ -778,7 +778,7 @@
</tr>
<tr>
<td>
- <a href="../reference/numeric/floating_point.html" title=" Floating
+ <a href="../reference/numeric.html#spirit.karma.reference.numeric.floating_point" title=" Floating
 Point Number Generators"><tt class="computeroutput">long_double</tt></a>
 </td>
<td>
@@ -791,7 +791,7 @@
</tr>
<tr>
<td>
- <a href="../reference/numeric/floating_point.html" title=" Floating
+ <a href="../reference/numeric.html#spirit.karma.reference.numeric.floating_point" title=" Floating
 Point Number Generators"><tt class="computeroutput">long_double(num)</tt></a>
 </td>
<td>
@@ -806,7 +806,7 @@
</tr>
<tr>
<td>
- <a href="../reference/numeric/floating_point.html" title=" Floating
+ <a href="../reference/numeric.html#spirit.karma.reference.numeric.floating_point" title=" Floating
 Point Number Generators">
<pre class="programlisting">real_generator<
 Num, Policies
@@ -823,7 +823,7 @@
</tr>
<tr>
<td>
- <a href="../reference/numeric/floating_point.html" title=" Floating
+ <a href="../reference/numeric.html#spirit.karma.reference.numeric.floating_point" title=" Floating
 Point Number Generators">
<pre class="programlisting">real_generator<
 Num, Policies
@@ -844,7 +844,7 @@
</table>
</div>
<div class="table">
-<a name="id483479"></a>Table 17. Predefined Unsigned Integer Generators
+<a name="id483789"></a>Table 9. Predefined Unsigned Integer Generators
<table class="table" summary="Predefined Unsigned Integer Generators">
<colgroup>
<col>
@@ -865,7 +865,7 @@
<tbody>
<tr>
<td>
- <a href="../reference/numeric/unsigned_int.html" title=" Unsigned
+ <a href="../reference/numeric.html#spirit.karma.reference.numeric.unsigned_int" title=" Unsigned
 Integer Number Generators"><tt class="computeroutput">ushort_</tt></a>
 </td>
<td>
@@ -877,7 +877,7 @@
</tr>
<tr>
<td>
- <a href="../reference/numeric/unsigned_int.html" title=" Unsigned
+ <a href="../reference/numeric.html#spirit.karma.reference.numeric.unsigned_int" title=" Unsigned
 Integer Number Generators"><tt class="computeroutput">ushort_(num)</tt></a>
 </td>
<td>
@@ -890,7 +890,7 @@
</tr>
<tr>
<td>
- <a href="../reference/numeric/unsigned_int.html" title=" Unsigned
+ <a href="../reference/numeric.html#spirit.karma.reference.numeric.unsigned_int" title=" Unsigned
 Integer Number Generators"><tt class="computeroutput">uint_</tt></a>
 </td>
<td>
@@ -902,7 +902,7 @@
</tr>
<tr>
<td>
- <a href="../reference/numeric/unsigned_int.html" title=" Unsigned
+ <a href="../reference/numeric.html#spirit.karma.reference.numeric.unsigned_int" title=" Unsigned
 Integer Number Generators"><tt class="computeroutput">uint_(num)</tt></a>
 </td>
<td>
@@ -915,7 +915,7 @@
</tr>
<tr>
<td>
- <a href="../reference/numeric/unsigned_int.html" title=" Unsigned
+ <a href="../reference/numeric.html#spirit.karma.reference.numeric.unsigned_int" title=" Unsigned
 Integer Number Generators"><tt class="computeroutput">ulong_</tt></a>
 </td>
<td>
@@ -927,7 +927,7 @@
</tr>
<tr>
<td>
- <a href="../reference/numeric/unsigned_int.html" title=" Unsigned
+ <a href="../reference/numeric.html#spirit.karma.reference.numeric.unsigned_int" title=" Unsigned
 Integer Number Generators"><tt class="computeroutput">ulong_(num)</tt></a>
 </td>
<td>
@@ -940,7 +940,7 @@
</tr>
<tr>
<td>
- <a href="../reference/numeric/unsigned_int.html" title=" Unsigned
+ <a href="../reference/numeric.html#spirit.karma.reference.numeric.unsigned_int" title=" Unsigned
 Integer Number Generators"><tt class="computeroutput">ulong_long</tt></a>
 </td>
<td>
@@ -953,7 +953,7 @@
</tr>
<tr>
<td>
- <a href="../reference/numeric/unsigned_int.html" title=" Unsigned
+ <a href="../reference/numeric.html#spirit.karma.reference.numeric.unsigned_int" title=" Unsigned
 Integer Number Generators"><tt class="computeroutput">ulong_long(num)</tt></a>
 </td>
<td>
@@ -967,7 +967,7 @@
</tr>
<tr>
<td>
- <a href="../reference/numeric/unsigned_int.html" title=" Unsigned
+ <a href="../reference/numeric.html#spirit.karma.reference.numeric.unsigned_int" title=" Unsigned
 Integer Number Generators"><tt class="computeroutput">bin</tt></a>
 </td>
<td>
@@ -980,7 +980,7 @@
</tr>
<tr>
<td>
- <a href="../reference/numeric/unsigned_int.html" title=" Unsigned
+ <a href="../reference/numeric.html#spirit.karma.reference.numeric.unsigned_int" title=" Unsigned
 Integer Number Generators"><tt class="computeroutput">oct</tt></a>
 </td>
<td>
@@ -993,7 +993,7 @@
</tr>
<tr>
<td>
- <a href="../reference/numeric/unsigned_int.html" title=" Unsigned
+ <a href="../reference/numeric.html#spirit.karma.reference.numeric.unsigned_int" title=" Unsigned
 Integer Number Generators"><tt class="computeroutput">hex</tt></a>
 </td>
<td>
@@ -1006,7 +1006,7 @@
</tr>
<tr>
<td>
- <a href="../reference/numeric/unsigned_int.html" title=" Unsigned
+ <a href="../reference/numeric.html#spirit.karma.reference.numeric.unsigned_int" title=" Unsigned
 Integer Number Generators">
<pre class="programlisting">uint_generator<
 Num, Radix
@@ -1022,7 +1022,7 @@
</tr>
<tr>
<td>
- <a href="../reference/numeric/unsigned_int.html" title=" Unsigned
+ <a href="../reference/numeric.html#spirit.karma.reference.numeric.unsigned_int" title=" Unsigned
 Integer Number Generators">
<pre class="programlisting">uint_generator<
 Num, Radix
@@ -1042,7 +1042,7 @@
</table>
</div>
<div class="table">
-<a name="id484564"></a>Table 18. Predefined Integer Generators
+<a name="id484875"></a>Table 10. Predefined Integer Generators
<table class="table" summary="Predefined Integer Generators">
<colgroup>
<col>
@@ -1063,7 +1063,7 @@
<tbody>
<tr>
<td>
- <a href="../reference/numeric/signed_int.html" title=" Signed
+ <a href="../reference/numeric.html#spirit.karma.reference.numeric.signed_int" title=" Signed
 Integer Number Generators"><tt class="computeroutput">short_</tt></a>
 </td>
<td>
@@ -1075,7 +1075,7 @@
</tr>
<tr>
<td>
- <a href="../reference/numeric/signed_int.html" title=" Signed
+ <a href="../reference/numeric.html#spirit.karma.reference.numeric.signed_int" title=" Signed
 Integer Number Generators"><tt class="computeroutput">short_(num)</tt></a>
 </td>
<td>
@@ -1088,7 +1088,7 @@
</tr>
<tr>
<td>
- <a href="../reference/numeric/signed_int.html" title=" Signed
+ <a href="../reference/numeric.html#spirit.karma.reference.numeric.signed_int" title=" Signed
 Integer Number Generators"><tt class="computeroutput">int_</tt></a>
 </td>
<td>
@@ -1100,7 +1100,7 @@
</tr>
<tr>
<td>
- <a href="../reference/numeric/signed_int.html" title=" Signed
+ <a href="../reference/numeric.html#spirit.karma.reference.numeric.signed_int" title=" Signed
 Integer Number Generators"><tt class="computeroutput">int_(num)</tt></a>
 </td>
<td>
@@ -1113,7 +1113,7 @@
</tr>
<tr>
<td>
- <a href="../reference/numeric/signed_int.html" title=" Signed
+ <a href="../reference/numeric.html#spirit.karma.reference.numeric.signed_int" title=" Signed
 Integer Number Generators"><tt class="computeroutput">long_</tt></a>
 </td>
<td>
@@ -1125,7 +1125,7 @@
</tr>
<tr>
<td>
- <a href="../reference/numeric/signed_int.html" title=" Signed
+ <a href="../reference/numeric.html#spirit.karma.reference.numeric.signed_int" title=" Signed
 Integer Number Generators"><tt class="computeroutput">long_(num)</tt></a>
 </td>
<td>
@@ -1138,7 +1138,7 @@
</tr>
<tr>
<td>
- <a href="../reference/numeric/signed_int.html" title=" Signed
+ <a href="../reference/numeric.html#spirit.karma.reference.numeric.signed_int" title=" Signed
 Integer Number Generators"><tt class="computeroutput">long_long</tt></a>
 </td>
<td>
@@ -1150,7 +1150,7 @@
</tr>
<tr>
<td>
- <a href="../reference/numeric/signed_int.html" title=" Signed
+ <a href="../reference/numeric.html#spirit.karma.reference.numeric.signed_int" title=" Signed
 Integer Number Generators"><tt class="computeroutput">long_long(num)</tt></a>
 </td>
<td>
@@ -1163,7 +1163,7 @@
</tr>
<tr>
<td>
- <a href="../reference/numeric/signed_int.html" title=" Signed
+ <a href="../reference/numeric.html#spirit.karma.reference.numeric.signed_int" title=" Signed
 Integer Number Generators">
<pre class="programlisting">int_generator<
 Num, Radix, force_sign
@@ -1179,7 +1179,7 @@
</tr>
<tr>
<td>
- <a href="../reference/numeric/signed_int.html" title=" Signed
+ <a href="../reference/numeric.html#spirit.karma.reference.numeric.signed_int" title=" Signed
 Integer Number Generators">
<pre class="programlisting">int_generator<
 Num, Radix, force_sign
@@ -1202,7 +1202,7 @@
 See here for more information about Binary Generators .
 
<div class="table">
-<a name="id485396"></a>Table 19. Predefined Binary Generators
+<a name="id485707"></a>Table 11. Predefined Binary Generators
<table class="table" summary="Predefined Binary Generators">
<colgroup>
<col>
@@ -1339,7 +1339,7 @@
 Operators</a>.
 
<div class="table">
-<a name="id485830"></a>Table 20. Predefined Generator Operators
+<a name="id486141"></a>Table 12. Predefined Generator Operators
<table class="table" summary="Predefined Generator Operators">
<colgroup>
<col>
@@ -1360,7 +1360,7 @@
<tbody>
<tr>
<td>
- <a href="../reference/operator/not_predicate.html" title=" Not
+ <a href="../reference/operator.html#spirit.karma.reference.operator.not_predicate" title=" Not
 Predicate (unary operator!())"><tt class="computeroutput">!a</tt></a>
 </td>
<td>
@@ -1373,7 +1373,7 @@
</tr>
<tr>
<td>
- <a href="../reference/operator/not_predicate.html" title=" Not
+ <a href="../reference/operator.html#spirit.karma.reference.operator.not_predicate" title=" Not
 Predicate (unary operator!())"><tt class="computeroutput">&a</tt></a>
 </td>
<td>
@@ -1386,7 +1386,7 @@
</tr>
<tr>
<td>
- <a href="../reference/operator/optional.html" title=" Optional
+ <a href="../reference/operator.html#spirit.karma.reference.operator.optional" title=" Optional
 (unary operator-())"><tt class="computeroutput">-a</tt></a>
 </td>
<td>
@@ -1399,7 +1399,7 @@
</tr>
<tr>
<td>
- <a href="../reference/operator/kleene.html" title=" Kleene Star
+ <a href="../reference/operator.html#spirit.karma.reference.operator.kleene" title=" Kleene Star
 (unary operator*())"><tt class="computeroutput">*a</tt></a>
 </td>
<td>
@@ -1412,7 +1412,7 @@
</tr>
<tr>
<td>
- <a href="../reference/operator/plus.html" title=" Plus (unary
+ <a href="../reference/operator.html#spirit.karma.reference.operator.plus" title=" Plus (unary
 operator+())"><tt class="computeroutput">+a</tt></a>
 </td>
<td>
@@ -1425,7 +1425,7 @@
</tr>
<tr>
<td>
- <a href="../reference/operator/alternative.html" title=" Alternatives
+ <a href="../reference/operator.html#spirit.karma.reference.operator.alternative" title=" Alternatives
 (operator|())"><tt class="computeroutput">a | b</tt></a>
 </td>
<td>
@@ -1438,7 +1438,7 @@
</tr>
<tr>
<td>
- <a href="../reference/operator/sequence.html" title=" Sequences
+ <a href="../reference/operator.html#spirit.karma.reference.operator.sequence" title=" Sequences
 (operator<<())"><tt class="computeroutput">a <<
 b</tt></a>
 </td>
@@ -1452,7 +1452,7 @@
</tr>
<tr>
<td>
- a % b
+ a % b
 </td>
<td>
 <tt class="computeroutput">vector<A></tt>
@@ -1483,7 +1483,7 @@
 Generators</a>.
 
<div class="table">
-<a name="id486654"></a>Table 21. Predefined Auxiliary Generators
+<a name="id486964"></a>Table 13. Predefined Auxiliary Generators
<table class="table" summary="Predefined Auxiliary Generators">
<colgroup>
<col>
@@ -1504,7 +1504,7 @@
<tbody>
<tr>
<td>
- eol
+ eol
 </td>
<td>
 <tt class="computeroutput">Unused</tt>
@@ -1515,7 +1515,7 @@
</tr>
<tr>
<td>
- eps
+ eps
 </td>
<td>
 <tt class="computeroutput">Unused</tt>
@@ -1526,7 +1526,7 @@
</tr>
<tr>
<td>
- eps(b)
+ eps(b)
 </td>
<td>
 <tt class="computeroutput">Unused</tt>
@@ -1538,7 +1538,7 @@
</tr>
<tr>
<td>
- lazy(fg)
+ lazy(fg)
 </td>
<td>
 Attribute of <tt class="computeroutput">G</tt> where
@@ -1553,14 +1553,14 @@
</tr>
<tr>
<td>
- fg
+ fg
 </td>
<td>
- see lazy(fg)
+ see lazy(fg)
 above
 </td>
<td>
- Equivalent to lazy(fg)
+ Equivalent to lazy(fg)
 </td>
</tr>
<tr>

Modified: trunk/libs/spirit/doc/html/spirit/karma/reference/auxiliary.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/karma/reference/auxiliary.html (original)
+++ trunk/libs/spirit/doc/html/spirit/karma/reference/auxiliary.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -6,9 +6,8 @@
<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
<link rel="home" href="../../../index.html" title="Spirit 2.1">
<link rel="up" href="../reference.html" title="Reference">
-<link rel="previous" href="operator/not_predicate.html" title=" Not
- Predicate (unary operator!())">
-<link rel="next" href="auxiliary/eol.html" title="eol">
+<link rel="previous" href="operator.html" title="Operator">
+<link rel="next" href="../performance_measurements.html" title="Performance Measurements">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
@@ -21,7 +20,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="operator/not_predicate.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/eol.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="operator.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="../performance_measurements.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage">
@@ -31,9 +30,9 @@
<div></div>
</div>
<div class="toc"><dl>
-<dt>eol</dt>
-<dt>eps</dt>
-<dt>lazy</dt>
+<dt>eol</dt>
+<dt>eps</dt>
+<dt>lazy</dt>
</dl></div>

 This module includes different auxiliary generators not fitting into any
@@ -41,12 +40,481 @@
 and <tt class="computeroutput">eps</tt>, <tt class="computeroutput">lazy</tt> generators.
 
<a name="spirit.karma.reference.auxiliary.module_header"></a><h5>
-<a name="id567076"></a>
+<a name="id567378"></a>
 <a href="auxiliary.html#spirit.karma.reference.auxiliary.module_header">Module Header</a>
 </h5>
<pre class="programlisting">// forwards to <boost/spirit/home/karma/auxiliary.hpp>
#include <boost/spirit/include/karma_auxiliary.hpp>
</pre>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.karma.reference.auxiliary.eol"></a>eol
+</h5></div></div>
+<div></div>
+</div>
+<a name="spirit.karma.reference.auxiliary.eol.description"></a><h6>
+<a name="id567495"></a>
+ Description
+ </h6>
+
+ The <tt class="computeroutput">eol</tt> component generates
+ a single newline character. It is equivalent to <tt class="computeroutput">lit('\n')</tt>
+ or simply '\n' (please see the <a href="char.html#spirit.karma.reference.char.char_generator" title=" Character
+ Generators"><tt class="computeroutput">char_</tt></a> generator module for more
+ details).
+ 
+<a name="spirit.karma.reference.auxiliary.eol.header"></a><h6>
+<a name="id567582"></a>
+ Header
+ </h6>
+<pre class="programlisting">// forwards to <boost/spirit/home/karma/auxiliary/eol.hpp>
+#include <boost/spirit/include/karma_eol.hpp>
+</pre>
+
+ Also, see Include Structure.
+ 
+<a name="spirit.karma.reference.auxiliary.eol.model_of"></a><h6>
+<a name="id567696"></a>
+ Model of
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ PrimitiveGenerator
+ 
+
+ 
+</blockquote></div>
+<a name="spirit.karma.reference.auxiliary.eol.expression_semantics"></a><h6>
+<a name="id567749"></a>
+ <a href="auxiliary.html#spirit.karma.reference.auxiliary.eol.expression_semantics">Expression
+ Semantics</a>
+ </h6>
+
+ Semantics of an expression is defined only where it differs from, or
+ is not defined in PrimitiveGenerator.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Semantics
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ <tt class="computeroutput">eol</tt>
+ </td>
+<td>
+ Create a component generating a single end of line character
+ in the output
+ </td>
+</tr></tbody>
+</table></div>
+<a name="spirit.karma.reference.auxiliary.eol.attributes"></a><h6>
+<a name="id567865"></a>
+ Attributes
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Attribute
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ <tt class="computeroutput">eol</tt>
+ </td>
+<td>
+ <tt class="computeroutput">unused</tt>
+ </td>
+</tr></tbody>
+</table></div>
+<a name="spirit.karma.reference.auxiliary.eol.complexity"></a><h6>
+<a name="id567966"></a>
+ Complexity
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ O(1)
+ 
+
+ 
+</blockquote></div>
+
+ The complexity is constant as a single character is generated in the
+ output.
+ 
+<a name="spirit.karma.reference.auxiliary.eol.example"></a><h6>
+<a name="id568007"></a>
+ Example
+ </h6>
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.karma.reference.auxiliary.eps"></a>eps
+</h5></div></div>
+<div></div>
+</div>
+
+ The family of <tt class="computeroutput">eps</tt> components
+ allows to create pseudo generators generating an empty string. This feature
+ is sometimes useful either to force a generator to fail or to succeed
+ or to insert semantic actions into the generation process.
+ 
+<a name="spirit.karma.reference.auxiliary.eps.description"></a><h6>
+<a name="id568071"></a>
+ Description
+ </h6>
+
+ The <tt class="computeroutput">eps</tt> creates a component
+ generating an empty string while always succeeding. The <tt class="computeroutput">eps(b)</tt>
+ component generates an empty string as well, but succeeds only if <tt class="computeroutput">b</tt> is <tt class="computeroutput">true</tt>
+ and fails otherwise. It's lazy variant <tt class="computeroutput">eps(fb)</tt> is equivalent to <tt class="computeroutput">eps(b)</tt> except it evaluates the supplied function
+ <tt class="computeroutput">fb</tt> at generate time,
+ while using the return value as the criteria to succeed.
+ 
+<a name="spirit.karma.reference.auxiliary.eps.header"></a><h6>
+<a name="id568230"></a>
+ Header
+ </h6>
+<pre class="programlisting">// forwards to <boost/spirit/home/karma/auxiliary/eps.hpp>
+#include <boost/spirit/include/karma_eps.hpp>
+</pre>
+
+ Also, see Include Structure.
+ 
+<a name="spirit.karma.reference.auxiliary.eps.model_of"></a><h6>
+<a name="id568343"></a>
+ Model of
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ PrimitiveGenerator
+ 
+
+ 
+</blockquote></div>
+<div class="variablelist">
+Notation
+<dl>
+<dt><tt class="computeroutput">b</tt></dt>
+<dd>
+ A boolean value.
+ </dd>
+<dt><tt class="computeroutput">fb</tt></dt>
+<dd>
+ A <a href="karma_basics.html#spirit.karma.reference.karma_basics.lazy_argument">Lazy
+ Argument</a> that evaluates to a boolean value.
+ </dd>
+</dl>
+</div>
+<a name="spirit.karma.reference.auxiliary.eps.expression_semantics"></a><h6>
+<a name="id568459"></a>
+ <a href="auxiliary.html#spirit.karma.reference.auxiliary.eps.expression_semantics">Expression
+ Semantics</a>
+ </h6>
+
+ Semantics of an expression is defined only where it differs from, or
+ is not defined in PrimitiveGenerator.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Semantics
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <tt class="computeroutput">eps</tt>
+ </td>
+<td>
+ Creates a component generating an empty string. Succeeds always.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">eps(b)</tt>
+ </td>
+<td>
+ Creates a component generating an empty string. Succeeds if
+ <tt class="computeroutput">b</tt> is <tt class="computeroutput">true</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">eps(fb)</tt>
+ </td>
+<td>
+ Creates a component generating an empty string. Succeeds if
+ <tt class="computeroutput">fb</tt> returns <tt class="computeroutput">true</tt> at generate time.
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="spirit.karma.reference.auxiliary.eps.attributes"></a><h6>
+<a name="id568712"></a>
+ Attributes
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Attribute
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <tt class="computeroutput">eps</tt>
+ </td>
+<td>
+ <tt class="computeroutput">unused</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">eps(b)</tt>
+ </td>
+<td>
+ <tt class="computeroutput">unused</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">eps(fb)</tt>
+ </td>
+<td>
+ <tt class="computeroutput">unused</tt>
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="spirit.karma.reference.auxiliary.eps.complexity"></a><h6>
+<a name="id568921"></a>
+ Complexity
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ O(1)
+ 
+
+ 
+</blockquote></div>
+
+ The complexity is constant as no output is generated.
+ 
+<a name="spirit.karma.reference.auxiliary.eps.example"></a><h6>
+<a name="id568961"></a>
+ Example
+ </h6>
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.karma.reference.auxiliary.lazy"></a>lazy
+</h5></div></div>
+<div></div>
+</div>
+<a name="spirit.karma.reference.auxiliary.lazy.description"></a><h6>
+<a name="id569004"></a>
+ Description
+ </h6>
+
+ The familiy of <tt class="computeroutput">lazy</tt> components
+ allows to use a dynamically returned generator component for output generation.
+ It calls the provided function or function object at generate time using
+ its return value as the actual generator to produce the output.
+ 
+<a name="spirit.karma.reference.auxiliary.lazy.header"></a><h6>
+<a name="id569051"></a>
+ Header
+ </h6>
+<pre class="programlisting">// forwards to <boost/spirit/home/karma/auxiliary/lazy.hpp>
+#include <boost/spirit/include/karma_lazy.hpp>
+</pre>
+
+ Also, see Include Structure.
+ 
+<a name="spirit.karma.reference.auxiliary.lazy.model_of"></a><h6>
+<a name="id569164"></a>
+ <a href="auxiliary.html#spirit.karma.reference.auxiliary.lazy.model_of">Model
+ of</a>
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ Generator
+ 
+
+ 
+</blockquote></div>
+<div class="variablelist">
+Notation
+<dl>
+<dt><tt class="computeroutput">fg</tt></dt>
+<dd>
+ A function or function object that evaluates to a generator object.
+ This function will be invoked at generate time.
+ </dd>
+</dl>
+</div>
+
+ The signature of <tt class="computeroutput">fg</tt> is
+ expected to be
+ 
+<pre class="programlisting">G f(Unused, Context)
+</pre>
+
+ where <tt class="computeroutput">G</tt>, the function's
+ return value, is the type of the generator to be invoked, and <tt class="computeroutput">Context</tt> is the generators's Context
+ type (The first argument is <tt class="computeroutput">unused</tt>
+ to make the <tt class="computeroutput">Context</tt> the
+ second argument. This is done for uniformity with <a href="../tutorials/semantic_actions.html" title="Semantic Actions">Semantic
+ Actions</a>).
+ 
+<a name="spirit.karma.reference.auxiliary.lazy.expression_semantics"></a><h6>
+<a name="id569373"></a>
+ <a href="auxiliary.html#spirit.karma.reference.auxiliary.lazy.expression_semantics">Expression
+ Semantics</a>
+ </h6>
+
+ Semantics of an expression is defined only where it differs from, or
+ is not defined in Generator.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Semantics
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <tt class="computeroutput">fg</tt>
+ </td>
+<td>
+ The Boost.Phoenix
+ function object <tt class="computeroutput">fg</tt>
+ will be invoked at generate time. It is expected to return a
+ generator instance. This generator is then invoked in order to
+ generate the output.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">lazy(fg)</tt>
+ </td>
+<td>
+ The function or function object will be invoked at generate time.
+ It is expected to return a generator instance (note this version
+ of <tt class="computeroutput">lazy</tt> does
+ not require <tt class="computeroutput">fg</tt>
+ to be a Boost.Phoenix
+ function object). This generator is then invoked in order to
+ generate the output.
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="spirit.karma.reference.auxiliary.lazy.attributes"></a><h6>
+<a name="id569590"></a>
+ Attributes
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Attribute
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <tt class="computeroutput">fg</tt>
+ </td>
+<td>
+ The attribute type <tt class="computeroutput">G</tt>
+ as exposed by the generator <tt class="computeroutput">g</tt>
+ returned from <tt class="computeroutput">fg</tt>.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">lazy(fg)</tt>
+ </td>
+<td>
+ The attribute type <tt class="computeroutput">G</tt>
+ as exposed by the generator <tt class="computeroutput">g</tt>
+ returned from <tt class="computeroutput">fg</tt>.
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="spirit.karma.reference.auxiliary.lazy.complexity"></a><h6>
+<a name="id569798"></a>
+ Complexity
+ </h6>
+
+ The complexity of the <tt class="computeroutput">lazy</tt>
+ component is determined by the complexity of the generator returned from
+ <tt class="computeroutput">fg</tt>.
+ 
+<a name="spirit.karma.reference.auxiliary.lazy.example"></a><h6>
+<a name="id569852"></a>
+ Example
+ </h6>
+</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
@@ -59,7 +527,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="operator/not_predicate.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/eol.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="operator.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="../performance_measurements.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>

Modified: trunk/libs/spirit/doc/html/spirit/karma/reference/auxiliary/eol.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/karma/reference/auxiliary/eol.html (original)
+++ trunk/libs/spirit/doc/html/spirit/karma/reference/auxiliary/eol.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -30,7 +30,7 @@
<div></div>
</div>
<a name="spirit.karma.reference.auxiliary.eol.description"></a><h6>
-<a name="id567192"></a>
+<a name="id567495"></a>
 <a href="eol.html#spirit.karma.reference.auxiliary.eol.description">Description</a>
 </h6>

@@ -41,7 +41,7 @@
 details).
 
<a name="spirit.karma.reference.auxiliary.eol.header"></a><h6>
-<a name="id567280"></a>
+<a name="id567582"></a>
 <a href="eol.html#spirit.karma.reference.auxiliary.eol.header">Header</a>
 </h6>
<pre class="programlisting">// forwards to <boost/spirit/home/karma/auxiliary/eol.hpp>
@@ -51,7 +51,7 @@
 Also, see Include Structure.
 
<a name="spirit.karma.reference.auxiliary.eol.model_of"></a><h6>
-<a name="id567394"></a>
+<a name="id567696"></a>
 <a href="eol.html#spirit.karma.reference.auxiliary.eol.model_of">Model of</a>
 </h6>
<div class="blockquote"><blockquote class="blockquote">
@@ -64,7 +64,7 @@
 
</blockquote></div>
<a name="spirit.karma.reference.auxiliary.eol.expression_semantics"></a><h6>
-<a name="id567446"></a>
+<a name="id567749"></a>
 <a href="eol.html#spirit.karma.reference.auxiliary.eol.expression_semantics">Expression
 Semantics</a>
 </h6>
@@ -96,7 +96,7 @@
</tr></tbody>
</table></div>
<a name="spirit.karma.reference.auxiliary.eol.attributes"></a><h6>
-<a name="id567563"></a>
+<a name="id567865"></a>
 <a href="eol.html#spirit.karma.reference.auxiliary.eol.attributes">Attributes</a>
 </h6>
<div class="informaltable"><table class="table">
@@ -122,7 +122,7 @@
</tr></tbody>
</table></div>
<a name="spirit.karma.reference.auxiliary.eol.complexity"></a><h6>
-<a name="id567664"></a>
+<a name="id567966"></a>
 <a href="eol.html#spirit.karma.reference.auxiliary.eol.complexity">Complexity</a>
 </h6>
<div class="blockquote"><blockquote class="blockquote">
@@ -139,7 +139,7 @@
 output.
 
<a name="spirit.karma.reference.auxiliary.eol.example"></a><h6>
-<a name="id567705"></a>
+<a name="id568007"></a>
 <a href="eol.html#spirit.karma.reference.auxiliary.eol.example">Example</a>
 </h6>
</div>

Modified: trunk/libs/spirit/doc/html/spirit/karma/reference/auxiliary/eps.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/karma/reference/auxiliary/eps.html (original)
+++ trunk/libs/spirit/doc/html/spirit/karma/reference/auxiliary/eps.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -36,7 +36,7 @@
 or to insert semantic actions into the generation process.
 
<a name="spirit.karma.reference.auxiliary.eps.description"></a><h6>
-<a name="id567768"></a>
+<a name="id568071"></a>
 <a href="eps.html#spirit.karma.reference.auxiliary.eps.description">Description</a>
 </h6>

@@ -48,7 +48,7 @@
 while using the return value as the criteria to succeed.
 
<a name="spirit.karma.reference.auxiliary.eps.header"></a><h6>
-<a name="id567927"></a>
+<a name="id568230"></a>
 <a href="eps.html#spirit.karma.reference.auxiliary.eps.header">Header</a>
 </h6>
<pre class="programlisting">// forwards to <boost/spirit/home/karma/auxiliary/eps.hpp>
@@ -58,7 +58,7 @@
 Also, see Include Structure.
 
<a name="spirit.karma.reference.auxiliary.eps.model_of"></a><h6>
-<a name="id568041"></a>
+<a name="id568343"></a>
 <a href="eps.html#spirit.karma.reference.auxiliary.eps.model_of">Model of</a>
 </h6>
<div class="blockquote"><blockquote class="blockquote">
@@ -85,7 +85,7 @@
</dl>
</div>
<a name="spirit.karma.reference.auxiliary.eps.expression_semantics"></a><h6>
-<a name="id568157"></a>
+<a name="id568459"></a>
 <a href="eps.html#spirit.karma.reference.auxiliary.eps.expression_semantics">Expression
 Semantics</a>
 </h6>
@@ -136,7 +136,7 @@
</tbody>
</table></div>
<a name="spirit.karma.reference.auxiliary.eps.attributes"></a><h6>
-<a name="id568410"></a>
+<a name="id568712"></a>
 <a href="eps.html#spirit.karma.reference.auxiliary.eps.attributes">Attributes</a>
 </h6>
<div class="informaltable"><table class="table">
@@ -180,7 +180,7 @@
</tbody>
</table></div>
<a name="spirit.karma.reference.auxiliary.eps.complexity"></a><h6>
-<a name="id568618"></a>
+<a name="id568921"></a>
 <a href="eps.html#spirit.karma.reference.auxiliary.eps.complexity">Complexity</a>
 </h6>
<div class="blockquote"><blockquote class="blockquote">
@@ -196,7 +196,7 @@
 The complexity is constant as no output is generated.
 
<a name="spirit.karma.reference.auxiliary.eps.example"></a><h6>
-<a name="id568658"></a>
+<a name="id568961"></a>
 <a href="eps.html#spirit.karma.reference.auxiliary.eps.example">Example</a>
 </h6>
</div>

Modified: trunk/libs/spirit/doc/html/spirit/karma/reference/auxiliary/lazy.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/karma/reference/auxiliary/lazy.html (original)
+++ trunk/libs/spirit/doc/html/spirit/karma/reference/auxiliary/lazy.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -30,7 +30,7 @@
<div></div>
</div>
<a name="spirit.karma.reference.auxiliary.lazy.description"></a><h6>
-<a name="id568701"></a>
+<a name="id569004"></a>
 <a href="lazy.html#spirit.karma.reference.auxiliary.lazy.description">Description</a>
 </h6>

@@ -40,7 +40,7 @@
 its return value as the actual generator to produce the output.
 
<a name="spirit.karma.reference.auxiliary.lazy.header"></a><h6>
-<a name="id568748"></a>
+<a name="id569051"></a>
 <a href="lazy.html#spirit.karma.reference.auxiliary.lazy.header">Header</a>
 </h6>
<pre class="programlisting">// forwards to <boost/spirit/home/karma/auxiliary/lazy.hpp>
@@ -50,7 +50,7 @@
 Also, see Include Structure.
 
<a name="spirit.karma.reference.auxiliary.lazy.model_of"></a><h6>
-<a name="id568861"></a>
+<a name="id569164"></a>
 <a href="lazy.html#spirit.karma.reference.auxiliary.lazy.model_of">Model
 of</a>
 </h6>
@@ -88,7 +88,7 @@
 Actions</a>).
 
<a name="spirit.karma.reference.auxiliary.lazy.expression_semantics"></a><h6>
-<a name="id569070"></a>
+<a name="id569373"></a>
 <a href="lazy.html#spirit.karma.reference.auxiliary.lazy.expression_semantics">Expression
 Semantics</a>
 </h6>
@@ -139,7 +139,7 @@
</tbody>
</table></div>
<a name="spirit.karma.reference.auxiliary.lazy.attributes"></a><h6>
-<a name="id569287"></a>
+<a name="id569590"></a>
 <a href="lazy.html#spirit.karma.reference.auxiliary.lazy.attributes">Attributes</a>
 </h6>
<div class="informaltable"><table class="table">
@@ -179,7 +179,7 @@
</tbody>
</table></div>
<a name="spirit.karma.reference.auxiliary.lazy.complexity"></a><h6>
-<a name="id569494"></a>
+<a name="id569798"></a>
 <a href="lazy.html#spirit.karma.reference.auxiliary.lazy.complexity">Complexity</a>
 </h6>

@@ -188,7 +188,7 @@
 <tt class="computeroutput">fg</tt>.
 
<a name="spirit.karma.reference.auxiliary.lazy.example"></a><h6>
-<a name="id569549"></a>
+<a name="id569852"></a>
 <a href="lazy.html#spirit.karma.reference.auxiliary.lazy.example">Example</a>
 </h6>
</div>

Modified: trunk/libs/spirit/doc/html/spirit/karma/reference/char.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/karma/reference/char.html (original)
+++ trunk/libs/spirit/doc/html/spirit/karma/reference/char.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -7,8 +7,7 @@
<link rel="home" href="../../../index.html" title="Spirit 2.1">
<link rel="up" href="../reference.html" title="Reference">
<link rel="previous" href="karma_basics.html" title=" Basics">
-<link rel="next" href="char/char_generator.html" title=" Character
- Generators">
+<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>
@@ -21,7 +20,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="karma_basics.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="char/char_generator.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="karma_basics.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">
@@ -31,9 +30,9 @@
<div></div>
</div>
<div class="toc"><dl>
-<dt><a href="char/char_generator.html"> Character
+<dt><a href="char.html#spirit.karma.reference.char.char_generator"> Character
 Generators</a></dt>
-<dt><a href="char/char_class.html"> Character
+<dt><a href="char.html#spirit.karma.reference.char.char_class"> Character
 Class Generators</a></dt>
</dl></div>

@@ -42,12 +41,1069 @@
 generators.
 
<a name="spirit.karma.reference.char.module_header"></a><h5>
-<a name="id497674"></a>
+<a name="id497985"></a>
 <a href="char.html#spirit.karma.reference.char.module_header">Module Header</a>
 </h5>
<pre class="programlisting">// forwards to <boost/spirit/home/karma/char.hpp>
#include <boost/spirit/include/karma_char.hpp>
</pre>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.karma.reference.char.char_generator"></a><a href="char.html#spirit.karma.reference.char.char_generator" title=" Character
+ Generators"> Character
+ Generators</a>
+</h5></div></div>
+<div></div>
+</div>
+<a name="spirit.karma.reference.char.char_generator.description"></a><h6>
+<a name="id498103"></a>
+ Description
+ </h6>
+
+ The character generators described in this section are:
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Description
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <tt class="computeroutput">ch</tt>
+ </td>
+<td>
+ Generates <tt class="computeroutput">ch</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">lit(ch)</tt>
+ </td>
+<td>
+ Generates <tt class="computeroutput">ch</tt>,
+ same as <tt class="computeroutput">boost::spirit::karma::lit</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ns::char_</tt>
+ </td>
+<td>
+ Generates the mandatory attribute as a single character interpreted
+ in the character set define by <tt class="computeroutput">ns</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ns::char_(ch)</tt>
+ </td>
+<td>
+ Generates <tt class="computeroutput">ch</tt>
+ as a character interpreted in the character set defined by <tt class="computeroutput">ns</tt>, if an attribute is supplied
+ it must match
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ns::char_("c")</tt>
+ </td>
+<td>
+ Generates <tt class="computeroutput">c</tt> as
+ a character interpreted in the character set defined by <tt class="computeroutput">ns</tt>, if an attribute is supplied
+ it must match, equivalent to <tt class="computeroutput">char_('c')</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ns::char_(ch1,
+ ch2)</tt>
+ </td>
+<td>
+ Generates the character supplied as the attribute if it belongs
+ to the character range interpreted in the character set defined
+ by <tt class="computeroutput">ns</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ns::char_(charset)</tt>
+ </td>
+<td>
+ Generates the character supplied as the attribute if it belongs
+ to <tt class="computeroutput">charset</tt> interpreted
+ in the character set defined by <tt class="computeroutput">ns</tt>
+ </td>
+</tr>
+</tbody>
+</table></div>
+
+ In the table above, <tt class="computeroutput">ns</tt>
+ is a <a href="karma_basics.html#spirit.karma.reference.karma_basics.character_encoding_namespace">Character
+ Encoding Namespace</a> used by the corresponding character generator.
+ 
+<a name="spirit.karma.reference.char.char_generator.header"></a><h6>
+<a name="id498726"></a>
+ Header
+ </h6>
+<pre class="programlisting">// forwards to <boost/spirit/home/karma/char/char.hpp>
+#include <boost/spirit/include/karma_char_.hpp>
+</pre>
+
+ Also, see Include Structure.
+ 
+<a name="spirit.karma.reference.char.char_generator.model_of"></a><h6>
+<a name="id498840"></a>
+ <a href="char.html#spirit.karma.reference.char.char_generator.model_of">Model
+ of</a>
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ PrimitiveGenerator
+ 
+
+ 
+</blockquote></div>
+<div class="variablelist">
+Notation
+<dl>
+<dt><tt class="computeroutput">ch</tt>,
+ <tt class="computeroutput">ch1</tt>, <tt class="computeroutput">ch2</tt></dt>
+<dd>
+ Character-class specific character (See Character Class Types), or
+ a <a href="karma_basics.html#spirit.karma.reference.karma_basics.lazy_argument">Lazy
+ Argument</a> that evaluates to a character-class specific character
+ value
+ </dd>
+<dt><tt class="computeroutput">charset</tt></dt>
+<dd>
+ Character-set specifier string (See Character Class Types), or a
+ <a href="karma_basics.html#spirit.karma.reference.karma_basics.lazy_argument">Lazy
+ Argument</a> that evaluates to a character-set specifier string,
+ or a pointer/reference to a null-terminated array of characters.
+ </dd>
+<dt><tt class="computeroutput">ns</tt></dt>
+<dd>
+ A <a href="../../qi/reference/basics.html#spirit.qi.reference.basics.character_encoding_namespace">Character
+ Encoding Namespace</a>.
+ </dd>
+</dl>
+</div>
+<a name="spirit.karma.reference.char.char_generator.expression_semantics"></a><h6>
+<a name="id499029"></a>
+ <a href="char.html#spirit.karma.reference.char.char_generator.expression_semantics">Expression
+ Semantics</a>
+ </h6>
+
+ Semantics of an expression is defined only where it differs from, or
+ is not defined in PrimitiveGenerator.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Description
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <tt class="computeroutput">ch</tt>
+ </td>
+<td>
+ Generate the character literal <tt class="computeroutput">ch</tt>.
+ This generator never fails (except if the underlying output stream
+ reports an error).
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">lit(ch)</tt>
+ </td>
+<td>
+ Generate the character literal <tt class="computeroutput">ch</tt>.
+ This generator never fails (except if the underlying output stream
+ reports an error).
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ns::char_</tt>
+ </td>
+<td>
+ Generate the character provided by a mandatory attribute interpreted
+ in the character set defined by <tt class="computeroutput">ns</tt>.
+ This generator never fails (except if the underlying output stream
+ reports an error).
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ns::char_(ch)</tt>
+ </td>
+<td>
+ Generate the character <tt class="computeroutput">ch</tt>
+ as provided by the immediate literal value the generator is initialized
+ from. If this generator has an associated attribute it succeeds
+ only as long as the attribute is equal to the immediate literal
+ (except if the underlying output stream reports an error). Otherwise
+ this generator fails and does not generate any output.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ns::char_("c")</tt>
+ </td>
+<td>
+ Generate the character <tt class="computeroutput">c</tt>
+ as provided by the immediate literal value the generator is initialized
+ from. If this generator has an associated attribute it succeeds
+ only as long as the attribute is equal to the immediate literal
+ (except if the underlying output stream reports an error). Otherwise
+ this generator fails and does not generate any output.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ns::char_(ch1,
+ ch2)</tt>
+ </td>
+<td>
+ Generate the character provided by a mandatory attribute interpreted
+ in the character set defined by <tt class="computeroutput">ns</tt>.
+ The generator succeeds as long as the attribute belongs to the
+ character range <tt class="computeroutput">[ch1,
+ ch2]</tt>
+ (except if the underlying output stream reports an error). Otherwise
+ this generator fails and does not generate any output.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ns::char_(charset)</tt>
+ </td>
+<td>
+ Generate the character provided by a mandatory attribute interpreted
+ in the character set defined by <tt class="computeroutput">ns</tt>.
+ The generator succeeds as long as the attribute belongs to the
+ character set <tt class="computeroutput">charset</tt>
+ (except if the underlying output stream reports an error). Otherwise
+ this generator fails and does not generate any output.
+ </td>
+</tr>
+</tbody>
+</table></div>
+
+ A character <tt class="computeroutput">ch</tt> is assumed
+ to belong to the character range defined by <tt class="computeroutput">ns::char_(ch1, ch2)</tt> if its character value (binary representation)
+ interpreted in the character set defined by <tt class="computeroutput">ns</tt>
+ is not smaller than the character value of <tt class="computeroutput">ch1</tt>
+ and not larger then the character value of <tt class="computeroutput">ch2</tt>
+ (i.e. <tt class="computeroutput">ch1 <=
+ ch <=
+ ch2</tt>).
+ 
+
+ The <tt class="computeroutput">charset</tt> parameter
+ passed to <tt class="computeroutput">ns::char_(charset)</tt>
+ must be a string containing more than one character. Every single character
+ in this string is assumed to belong to the character set defined by this
+ expression. An exception to this is the <tt class="computeroutput">'-'</tt>
+ character which has a special meaning if it is not specified as the first
+ and not the last character in <tt class="computeroutput">charset</tt>.
+ If the <tt class="computeroutput">'-'</tt> is used in between
+ to characters it is interpreted as spanning a character range. A character
+ <tt class="computeroutput">ch</tt> is considered to belong
+ to the defined character set <tt class="computeroutput">charset</tt>
+ if it matches one of the characters as specified by the string parameter
+ described above. For example
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Example
+ </th>
+<th>
+ Description
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <tt class="computeroutput">char_("abc")</tt>
+ </td>
+<td>
+ 'a', 'b', and 'c'
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">char_("a-z")</tt>
+ </td>
+<td>
+ all characters (and including) from 'a' to 'z'
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">char_("a-zA-Z")</tt>
+ </td>
+<td>
+ all characters (and including) from 'a' to 'z' and 'A' and 'Z'
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">char_("-1-9")</tt>
+ </td>
+<td>
+ '-' and all characters (and including) from '1' to '9'
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="spirit.karma.reference.char.char_generator.attributes"></a><h6>
+<a name="id500073"></a>
+ Attributes
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Attribute
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <tt class="computeroutput">ch</tt>
+ </td>
+<td>
+ <tt class="computeroutput">unused</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">lit(ch)</tt>
+ </td>
+<td>
+ <tt class="computeroutput">unused</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ns::char_</tt>
+ </td>
+<td>
+ <tt class="computeroutput">Ch</tt>, attribute
+ is mandatory (otherwise compilation will fail)
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ns::char_(ch)</tt>
+ </td>
+<td>
+ <tt class="computeroutput">Ch</tt>, attribute
+ is optional, if it is supplied, the generator compares the attribute
+ with <tt class="computeroutput">ch</tt> and succeeds
+ only if both are equal, failing otherwise
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ns::char_("c")</tt>
+ </td>
+<td>
+ <tt class="computeroutput">Ch</tt>, attribute
+ is optional, if it is supplied, the generator compares the attribute
+ with <tt class="computeroutput">c</tt> and succeeds
+ only if both are equal, failing otherwise
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ns::char_(ch1,
+ ch2)</tt>
+ </td>
+<td>
+ <tt class="computeroutput">Ch</tt>, attribute
+ is mandatory (otherwise compilation will fail), the generator
+ succeeds if the attribute belongs to the character range <tt class="computeroutput">[ch1, ch2]</tt> interpreted in the character
+ set defined by <tt class="computeroutput">ns</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ns::char_(charset)</tt>
+ </td>
+<td>
+ <tt class="computeroutput">Ch</tt>, attribute
+ is mandatory (otherwise compilation will fail), the generator
+ succeeds if the attribute belongs to the character set <tt class="computeroutput">charset</tt>, interpreted in the
+ character set defined by <tt class="computeroutput">ns</tt>
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="spirit.karma.reference.char.char_generator.complexity"></a><h6>
+<a name="id500651"></a>
+ Complexity
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ O(1)
+ 
+
+ 
+</blockquote></div>
+
+ The complexity of <tt class="computeroutput">ch</tt>,
+ <tt class="computeroutput">lit(ch)</tt>,
+ <tt class="computeroutput">ns::char_</tt>, <tt class="computeroutput">ns::char_(ch)</tt>, and <tt class="computeroutput">ns::char_("c")</tt> is constant as all generators emit exactly
+ one character per invocation.
+ 
+
+ The character range generator (<tt class="computeroutput">ns::char_(ch1, ch2)</tt>) additionally requires constant lookup
+ time for the verification whether the attribute belongs to the character
+ range.
+ 
+
+ The character set generator (<tt class="computeroutput">ns::char_(charset)</tt>) additionally requires O(log N) lookup
+ time for the verification whether the attribute belongs to the character
+ set, where N is the number of characters in the character set.
+ 
+<a name="spirit.karma.reference.char.char_generator.example"></a><h6>
+<a name="id500921"></a>
+ Example
+ </h6>
+
+ Some includes:
+ 
+
+ 
+
+
+
+<pre class="programlisting">#include <boost/spirit/include/karma.hpp>
+#include <boost/spirit/include/phoenix_core.hpp>
+#include <boost/spirit/include/phoenix_operator.hpp>
+#include <boost/fusion/include/std_pair.hpp>
+#include <iostream>
+#include <string>
+</pre>
+
+ 
+
+ 
+
+ All code snippets below use these common test functions:
+ 
+
+ 
+
+
+
+<pre class="programlisting">template <typename G>
+void test_generator(char const* expected, G const& g)
+{
+ std::string s;
+ std::back_insert_iterator<std::string> out(s);
+ if (boost::spirit::karma::generate(out, g) && str == expected)
+ std::cout << "ok" << std::endl;
+ else
+ std::cout << "fail" << std::endl;
+}
+</pre>
+
+ 
+
+ 
+
+
+
+<pre class="programlisting">template <typename G, typename T>
+void test_generator_attr(char const* expected, G const& g, T const& attr)
+{
+ std::string s;
+ std::back_insert_iterator<std::string> out(s);
+ if (boost::spirit::karma::generate(out, g, attr) && str == expected)
+ std::cout << "ok" << std::endl;
+ else
+ std::cout << "fail" << std::endl;
+}
+</pre>
+
+ 
+
+ 
+
+ Some using declarations:
+ 
+
+ 
+
+
+
+<pre class="programlisting">using boost::spirit::karma::generate;
+using boost::spirit::ascii::char_;
+</pre>
+
+ 
+
+ 
+
+ Basic usage of <tt class="computeroutput">char_</tt>
+ generators:
+ 
+
+ 
+
+
+
+<pre class="programlisting">test_generator("A", 'A');
+test_generator("A", lit('A'));
+
+test_generator_attr("a", char_, 'a');
+test_generator("A", char_('A'));
+test_generator_attr("A", char_('A'), 'A');
+test_generator_attr("", char_('A'), 'B'); // fails (as 'A' != 'B')
+
+test_generator_attr("A", char_('A', 'Z'), 'A');
+test_generator_attr("", char_('A', 'Z'), 'a'); // fails (as 'a' does not belong to 'A'...'Z')
+
+test_generator_attr("k", char_("a-z0-9"), 'k');
+test_generator_attr("", char_("a-z0-9"), 'A'); // fails (as 'A' does not belong to "a-z0-9")
+</pre>
+
+ 
+
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.karma.reference.char.char_class"></a><a href="char.html#spirit.karma.reference.char.char_class" title=" Character
+ Class Generators"> Character
+ Class Generators</a>
+</h5></div></div>
+<div></div>
+</div>
+<a name="spirit.karma.reference.char.char_class.description"></a><h6>
+<a name="id502878"></a>
+ Description
+ </h6>
+
+ The character class generators described in this section are:
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Description
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <tt class="computeroutput">ns::alnum</tt>
+ </td>
+<td>
+ Generates the character supplied as the attribute if it satisfies
+ the concept of <tt class="computeroutput">std::isalnum</tt>
+ in the character set defined by <tt class="computeroutput">ns</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ns::alpha</tt>
+ </td>
+<td>
+ Generates the character supplied as the attribute if it satisfies
+ thh concept of <tt class="computeroutput">std::isalpha</tt>
+ in the character set defined by <tt class="computeroutput">ns</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ns::blank</tt>
+ </td>
+<td>
+ Generates the character supplied as the attribute if it satisfies
+ the concept of <tt class="computeroutput">std::isblank</tt>
+ in the character set defined by <tt class="computeroutput">ns</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ns::cntrl</tt>
+ </td>
+<td>
+ Generates the character supplied as the attribute if it satisfies
+ the concept of <tt class="computeroutput">std::iscntrl</tt>
+ in the character set defined by <tt class="computeroutput">ns</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ns::digit</tt>
+ </td>
+<td>
+ Generates the character supplied as the attribute if it satisfies
+ the concept of <tt class="computeroutput">std::isdigit</tt>
+ in the character set defined by <tt class="computeroutput">ns</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ns::graph</tt>
+ </td>
+<td>
+ Generates the character supplied as the attribute if it satisfies
+ the concept of <tt class="computeroutput">std::isgraph</tt>
+ in the character set defined by <tt class="computeroutput">ns</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ns::print</tt>
+ </td>
+<td>
+ Generates the character supplied as the attribute if it satisfies
+ the concept of <tt class="computeroutput">std::isprint</tt>
+ in the character set defined by <tt class="computeroutput">ns</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ns::punct</tt>
+ </td>
+<td>
+ Generates the character supplied as the attribute if it satisfies
+ the concept of <tt class="computeroutput">std::ispunct</tt>
+ in the character set defined by <tt class="computeroutput">ns</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ns::xdigit</tt>
+ </td>
+<td>
+ Generates the character supplied as the attribute if it satisfies
+ the concept of <tt class="computeroutput">std::isxdigit</tt>
+ in the character set defined by <tt class="computeroutput">ns</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ns::lower</tt>
+ </td>
+<td>
+ Generates the character supplied as the attribute if it satisfies
+ the concept of <tt class="computeroutput">std::islower</tt>
+ in the character set defined by <tt class="computeroutput">ns</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ns::upper</tt>
+ </td>
+<td>
+ Generates the character supplied as the attribute if it satisfies
+ the concept of <tt class="computeroutput">std::isupper</tt>
+ in the character set defined by <tt class="computeroutput">ns</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ns::space</tt>
+ </td>
+<td>
+ Generates the character supplied as the attribute if it satisfies
+ the concept of <tt class="computeroutput">std::isspace</tt>
+ in or a single space character the character set defined by
+ <tt class="computeroutput">ns</tt>
+ </td>
+</tr>
+</tbody>
+</table></div>
+
+ In the table above, <tt class="computeroutput">ns</tt>
+ is a <a href="karma_basics.html#spirit.karma.reference.karma_basics.character_encoding_namespace">Character
+ Encoding Namespace</a> used by the corresponding character class generator.
+ All listed generators have a mandatory attribute <tt class="computeroutput">Ch</tt>
+ and will not compile if no attribute is associated.
+ 
+<a name="spirit.karma.reference.char.char_class.header"></a><h6>
+<a name="id503874"></a>
+ Header
+ </h6>
+<pre class="programlisting">// forwards to <boost/spirit/home/karma/char/char_class.hpp>
+#include <boost/spirit/include/karma_char_class.hpp>
+</pre>
+
+ Also, see Include Structure.
+ 
+<a name="spirit.karma.reference.char.char_class.model_of"></a><h6>
+<a name="id503988"></a>
+ <a href="char.html#spirit.karma.reference.char.char_class.model_of">Model
+ of</a>
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ PrimitiveGenerator
+ 
+
+ 
+</blockquote></div>
+<div class="variablelist">
+Notation
+<dl>
+<dt><tt class="computeroutput">ns</tt></dt>
+<dd>
+ A <a href="../../qi/reference/basics.html#spirit.qi.reference.basics.character_encoding_namespace">Character
+ Encoding Namespace</a>.
+ </dd>
+</dl>
+</div>
+<a name="spirit.karma.reference.char.char_class.expression_semantics"></a><h6>
+<a name="id504081"></a>
+ <a href="char.html#spirit.karma.reference.char.char_class.expression_semantics">Expression
+ Semantics</a>
+ </h6>
+
+ Semantics of an expression is defined only where it differs from, or
+ is not defined in PrimitiveGenerator.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Semantics
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <tt class="computeroutput">ns::alnum</tt>
+ </td>
+<td>
+ If the mandatory attribute satisfies the concept of <tt class="computeroutput">std::isalnum</tt> the generator succeeds
+ after emitting its attribute (except if the underlying output
+ stream reports an error). This generator fails otherwise while
+ not generating anything.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ns::alpha</tt>
+ </td>
+<td>
+ If the mandatory attribute satisfies the concept of <tt class="computeroutput">std::isalpha</tt> the generator succeeds
+ after emitting its attribute (except if the underlying output
+ stream reports an error). This generator fails otherwise while
+ not generating anything.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ns::blank</tt>
+ </td>
+<td>
+ If the mandatory attribute satisfies the concept of <tt class="computeroutput">std::isblank</tt> the generator succeeds
+ after emitting its attribute (except if the underlying output
+ stream reports an error). This generator fails otherwise while
+ not generating anything.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ns::cntrl</tt>
+ </td>
+<td>
+ If the mandatory attribute satisfies the concept of <tt class="computeroutput">std::iscntrl</tt> the generator succeeds
+ after emitting its attribute (except if the underlying output
+ stream reports an error). This generator fails otherwise while
+ not generating anything.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ns::digit</tt>
+ </td>
+<td>
+ If the mandatory attribute satisfies the concept of <tt class="computeroutput">std::isdigit</tt> the generator succeeds
+ after emitting its attribute (except if the underlying output
+ stream reports an error). This generator fails otherwise while
+ not generating anything.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ns::graph</tt>
+ </td>
+<td>
+ If the mandatory attribute satisfies the concept of <tt class="computeroutput">std::isgraph</tt> the generator succeeds
+ after emitting its attribute (except if the underlying output
+ stream reports an error). This generator fails otherwise while
+ not generating anything.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ns::print</tt>
+ </td>
+<td>
+ If the mandatory attribute satisfies the concept of <tt class="computeroutput">std::isprint</tt> the generator succeeds
+ after emitting its attribute (except if the underlying output
+ stream reports an error). This generator fails otherwise while
+ not generating anything.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ns::punct</tt>
+ </td>
+<td>
+ If the mandatory attribute satisfies the concept of <tt class="computeroutput">std::ispunct</tt> the generator succeeds
+ after emitting its attribute (except if the underlying output
+ stream reports an error). This generator fails otherwise while
+ not generating anything.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ns::xdigit</tt>
+ </td>
+<td>
+ If the mandatory attribute satisfies the concept of <tt class="computeroutput">std::isxdigit</tt> the generator succeeds
+ after emitting its attribute (except if the underlying output
+ stream reports an error). This generator fails otherwise while
+ not generating anything.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ns::lower</tt>
+ </td>
+<td>
+ If the mandatory attribute satisfies the concept of <tt class="computeroutput">std::islower</tt> the generator succeeds
+ after emitting its attribute (except if the underlying output
+ stream reports an error). This generator fails otherwise while
+ not generating anything.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ns::upper</tt>
+ </td>
+<td>
+ If the mandatory attribute satisfies the concept of <tt class="computeroutput">std::isupper</tt> the generator succeeds
+ after emitting its attribute (except if the underlying output
+ stream reports an error). This generator fails otherwise while
+ not generating anything.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ns::space</tt>
+ </td>
+<td>
+ If the optional attribute satisfies the concept of <tt class="computeroutput">std::isspace</tt> the generator succeeds
+ after emitting its attribute (except if the underlying output
+ stream reports an error). This generator fails otherwise while
+ not generating anything.If no attribute is supplied this generator
+ emits a single space character in the character set defined by
+ <tt class="computeroutput">ns</tt>.
+ </td>
+</tr>
+</tbody>
+</table></div>
+
+ Possible values for <tt class="computeroutput">ns</tt>
+ are described in the section <a href="karma_basics.html#spirit.karma.reference.karma_basics.character_encoding_namespace">Character
+ Encoding Namespace</a>.
+ 
+<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">
+
+ The generators <tt class="computeroutput">alpha</tt>
+ and <tt class="computeroutput">alnum</tt> might seem
+ to behave unexpected if used inside a <tt class="computeroutput">lower[]</tt> or <tt class="computeroutput">upper[]</tt> directive. Both directives additionally
+ apply the semanitics of <tt class="computeroutput">std::islower</tt>
+ or <tt class="computeroutput">std::isupper</tt> to the respective character
+ class. Some examples:
+
+<pre class="programlisting">std::string s;
+std::back_insert_iterator<std::string> out(s);
+generate(out, lower[alpha], 'a'); // succeeds emitting 'a'
+generate(out, lower[alpha], 'A'); // fails
+</pre>
+
+ The generator directive <tt class="computeroutput">upper[]</tt> behaves correspondingly.
+ 
+</td></tr>
+</table></div>
+<a name="spirit.karma.reference.char.char_class.attributes"></a><h6>
+<a name="id505331"></a>
+ Attributes
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ All listed character class generators can take any attribute <tt class="computeroutput">Ch</tt>. All character class generators
+ (except <tt class="computeroutput">space</tt>) require
+ an attribute and will fail compiling otherwise.
+ 
+
+ 
+</blockquote></div>
+<a name="spirit.karma.reference.char.char_class.complexity"></a><h6>
+<a name="id505394"></a>
+ Complexity
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ O(1)
+ 
+
+ 
+</blockquote></div>
+
+ The complexity is constant as the generators emit not more than one character
+ per invocation.
+ 
+<a name="spirit.karma.reference.char.char_class.example"></a><h6>
+<a name="id505437"></a>
+ Example
+ </h6>
+
+ Some includes:
+ 
+
+ 
+
+
+
+<pre class="programlisting">#include <boost/spirit/include/karma.hpp>
+#include <boost/spirit/include/phoenix_core.hpp>
+#include <boost/spirit/include/phoenix_operator.hpp>
+#include <boost/fusion/include/std_pair.hpp>
+#include <iostream>
+#include <string>
+</pre>
+
+ 
+
+ 
+
+ All code snippets below use these common test functions:
+ 
+
+ 
+
+
+
+<pre class="programlisting">template <typename G, typename T>
+void test_generator_attr(char const* expected, G const& g, T const& attr)
+{
+ std::string s;
+ std::back_insert_iterator<std::string> out(s);
+ if (boost::spirit::karma::generate(out, g, attr) && str == expected)
+ std::cout << "ok" << std::endl;
+ else
+ std::cout << "fail" << std::endl;
+}
+</pre>
+
+ 
+
+ 
+
+ Some using declarations:
+ 
+
+ 
+
+
+
+<pre class="programlisting">using boost::spirit::karma::generate;
+using boost::spirit::karma::alpha;
+</pre>
+
+ 
+
+ 
+
+ Basic usage of an <tt class="computeroutput">alpha</tt>
+ generator:
+ 
+
+ 
+
+
+
+<pre class="programlisting">test_generator_attr("a", alpha, 'a');
+test_generator_attr("A", alpha, 'A');
+test_generator_attr("", alpha, '1'); // fails (as isalpha('1') is false)
+test_generator_attr("A", upper[alpha], 'a');
+test_generator_attr("", upper[alpha], 'a'); // fails (as isupper('a') is false)
+</pre>
+
+ 
+
+ 
+</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
@@ -60,7 +1116,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="karma_basics.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="char/char_generator.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="karma_basics.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>

Modified: trunk/libs/spirit/doc/html/spirit/karma/reference/char/char_class.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/karma/reference/char/char_class.html (original)
+++ trunk/libs/spirit/doc/html/spirit/karma/reference/char/char_class.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -34,7 +34,7 @@
<div></div>
</div>
<a name="spirit.karma.reference.char.char_class.description"></a><h6>
-<a name="id502567"></a>
+<a name="id502878"></a>
 <a href="char_class.html#spirit.karma.reference.char.char_class.description">Description</a>
 </h6>

@@ -185,7 +185,7 @@
 and will not compile if no attribute is associated.
 
<a name="spirit.karma.reference.char.char_class.header"></a><h6>
-<a name="id503563"></a>
+<a name="id503874"></a>
 <a href="char_class.html#spirit.karma.reference.char.char_class.header">Header</a>
 </h6>
<pre class="programlisting">// forwards to <boost/spirit/home/karma/char/char_class.hpp>
@@ -195,7 +195,7 @@
 Also, see Include Structure.
 
<a name="spirit.karma.reference.char.char_class.model_of"></a><h6>
-<a name="id503677"></a>
+<a name="id503988"></a>
 <a href="char_class.html#spirit.karma.reference.char.char_class.model_of">Model
 of</a>
 </h6>
@@ -219,7 +219,7 @@
</dl>
</div>
<a name="spirit.karma.reference.char.char_class.expression_semantics"></a><h6>
-<a name="id503770"></a>
+<a name="id504081"></a>
 <a href="char_class.html#spirit.karma.reference.char.char_class.expression_semantics">Expression
 Semantics</a>
 </h6>
@@ -407,7 +407,7 @@
</td></tr>
</table></div>
<a name="spirit.karma.reference.char.char_class.attributes"></a><h6>
-<a name="id505020"></a>
+<a name="id505331"></a>
 <a href="char_class.html#spirit.karma.reference.char.char_class.attributes">Attributes</a>
 </h6>
<div class="blockquote"><blockquote class="blockquote">
@@ -422,7 +422,7 @@
 
</blockquote></div>
<a name="spirit.karma.reference.char.char_class.complexity"></a><h6>
-<a name="id505083"></a>
+<a name="id505394"></a>
 <a href="char_class.html#spirit.karma.reference.char.char_class.complexity">Complexity</a>
 </h6>
<div class="blockquote"><blockquote class="blockquote">
@@ -439,7 +439,7 @@
 per invocation.
 
<a name="spirit.karma.reference.char.char_class.example"></a><h6>
-<a name="id505126"></a>
+<a name="id505437"></a>
 <a href="char_class.html#spirit.karma.reference.char.char_class.example">Example</a>
 </h6>

Modified: trunk/libs/spirit/doc/html/spirit/karma/reference/char/char_generator.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/karma/reference/char/char_generator.html (original)
+++ trunk/libs/spirit/doc/html/spirit/karma/reference/char/char_generator.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -34,7 +34,7 @@
<div></div>
</div>
<a name="spirit.karma.reference.char.char_generator.description"></a><h6>
-<a name="id497792"></a>
+<a name="id498103"></a>
 <a href="char_generator.html#spirit.karma.reference.char.char_generator.description">Description</a>
 </h6>

@@ -129,7 +129,7 @@
 Encoding Namespace</a> used by the corresponding character generator.
 
<a name="spirit.karma.reference.char.char_generator.header"></a><h6>
-<a name="id498415"></a>
+<a name="id498726"></a>
 <a href="char_generator.html#spirit.karma.reference.char.char_generator.header">Header</a>
 </h6>
<pre class="programlisting">// forwards to <boost/spirit/home/karma/char/char.hpp>
@@ -139,7 +139,7 @@
 Also, see Include Structure.
 
<a name="spirit.karma.reference.char.char_generator.model_of"></a><h6>
-<a name="id498529"></a>
+<a name="id498840"></a>
 <a href="char_generator.html#spirit.karma.reference.char.char_generator.model_of">Model
 of</a>
 </h6>
@@ -178,7 +178,7 @@
</dl>
</div>
<a name="spirit.karma.reference.char.char_generator.expression_semantics"></a><h6>
-<a name="id498718"></a>
+<a name="id499029"></a>
 <a href="char_generator.html#spirit.karma.reference.char.char_generator.expression_semantics">Expression
 Semantics</a>
 </h6>
@@ -361,7 +361,7 @@
</tbody>
</table></div>
<a name="spirit.karma.reference.char.char_generator.attributes"></a><h6>
-<a name="id499762"></a>
+<a name="id500073"></a>
 <a href="char_generator.html#spirit.karma.reference.char.char_generator.attributes">Attributes</a>
 </h6>
<div class="informaltable"><table class="table">
@@ -451,7 +451,7 @@
</tbody>
</table></div>
<a name="spirit.karma.reference.char.char_generator.complexity"></a><h6>
-<a name="id500340"></a>
+<a name="id500651"></a>
 <a href="char_generator.html#spirit.karma.reference.char.char_generator.complexity">Complexity</a>
 </h6>
<div class="blockquote"><blockquote class="blockquote">
@@ -480,7 +480,7 @@
 set, where N is the number of characters in the character set.
 
<a name="spirit.karma.reference.char.char_generator.example"></a><h6>
-<a name="id500610"></a>
+<a name="id500921"></a>
 <a href="char_generator.html#spirit.karma.reference.char.char_generator.example">Example</a>
 </h6>

Modified: trunk/libs/spirit/doc/html/spirit/karma/reference/directive.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/karma/reference/directive.html (original)
+++ trunk/libs/spirit/doc/html/spirit/karma/reference/directive.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -6,10 +6,8 @@
<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
<link rel="home" href="../../../index.html" title="Spirit 2.1">
<link rel="up" href="../reference.html" title="Reference">
-<link rel="previous" href="numeric/floating_point.html" title=" Floating
- Point Number Generators">
-<link rel="next" href="directive/alignment.html" title=" Alignment
- Directives (left_align[], center[], and right_align[])">
+<link rel="previous" href="numeric.html" title=" Numeric">
+<link rel="next" href="operator.html" title="Operator">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
@@ -22,7 +20,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="numeric/floating_point.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/alignment.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+<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="operator.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage">
@@ -32,19 +30,19 @@
<div></div>
</div>
<div class="toc"><dl>
-<dt><a href="directive/alignment.html"> Alignment
+<dt><a href="directive.html#spirit.karma.reference.directive.alignment"> Alignment
 Directives (<tt class="computeroutput">left_align[]</tt>, <tt class="computeroutput">center[]</tt>, and <tt class="computeroutput">right_align[]</tt>)</a></dt>
-<dt><a href="directive/repeat.html"> Repetition
+<dt><a href="directive.html#spirit.karma.reference.directive.repeat"> Repetition
 Directive (<tt class="computeroutput">repeat[]</tt>)</a></dt>
-<dt><a href="directive/delimit.html"> Directives
+<dt><a href="directive.html#spirit.karma.reference.directive.delimit"> Directives
 Controlling Automatic Delimiting (<tt class="computeroutput">verbatim[]</tt> and <tt class="computeroutput">delimit[]</tt>)</a></dt>
-<dt><a href="directive/upperlower.html"> Directives
+<dt><a href="directive.html#spirit.karma.reference.directive.upperlower"> Directives
 Controlling Case Sensitivity (<tt class="computeroutput">upper[]</tt> and <tt class="computeroutput">lower[]</tt>)</a></dt>
-<dt><a href="directive/maxwidth.html"> Controlling
+<dt><a href="directive.html#spirit.karma.reference.directive.maxwidth"> Controlling
 the Maximum Field Wield (<tt class="computeroutput">maxwidth[]</tt>)</a></dt>
-<dt><a href="directive/buffer.html"> Temporary
+<dt><a href="directive.html#spirit.karma.reference.directive.buffer"> Temporary
 Output Buffering (<tt class="computeroutput">buffer[]</tt>)</a></dt>
-<dt><a href="directive/omit.html"> Consume Attribute
+<dt><a href="directive.html#spirit.karma.reference.directive.omit"> Consume Attribute
 (<tt class="computeroutput">omit[]</tt>)</a></dt>
</dl></div>

@@ -55,12 +53,2294 @@
 controlling case sensitivity (<tt class="computeroutput">upper[]</tt> and <tt class="computeroutput">lower[]</tt>), field width (<tt class="computeroutput">maxwidth[]</tt>), buffering (<tt class="computeroutput">buffer[]</tt>), and attribute handling (<tt class="computeroutput">omit[]</tt>).
 
<a name="spirit.karma.reference.directive.module_header"></a><h5>
-<a name="id527080"></a>
+<a name="id527376"></a>
 <a href="directive.html#spirit.karma.reference.directive.module_header">Module Header</a>
 </h5>
<pre class="programlisting">// forwards to <boost/spirit/home/karma/directive.hpp>
#include <boost/spirit/include/karma_directive.hpp>
</pre>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.karma.reference.directive.alignment"></a><a href="directive.html#spirit.karma.reference.directive.alignment" title=" Alignment
+ Directives (left_align[], center[], and right_align[])"> Alignment
+ Directives (<tt class="computeroutput">left_align[]</tt>, <tt class="computeroutput">center[]</tt>, and <tt class="computeroutput">right_align[]</tt>)</a>
+</h5></div></div>
+<div></div>
+</div>
+<a name="spirit.karma.reference.directive.alignment.description"></a><h6>
+<a name="id527544"></a>
+ Description
+ </h6>
+
+ The alignment directives allow to left align, right align or center output
+ emitted by other generators into columns of a specified width while using
+ an arbitrary generator to create the padding.
+ 
+<a name="spirit.karma.reference.directive.alignment.header"></a><h6>
+<a name="id527576"></a>
+ Header
+ </h6>
+
+ For the <tt class="computeroutput">left_align[]</tt>
+ directive:
+ 
+<pre class="programlisting">// forwards to <boost/spirit/home/karma/directive/left_alignment.hpp>
+#include <boost/spirit/include/karma_left_alignment.hpp>
+</pre>
+
+ For the <tt class="computeroutput">center[]</tt>
+ directive:
+ 
+<pre class="programlisting">// forwards to <boost/spirit/home/karma/directive/center_alignment.hpp>
+#include <boost/spirit/include/karma_center_alignment.hpp>
+</pre>
+
+ For the <tt class="computeroutput">right_align[]</tt>
+ directive:
+ 
+<pre class="programlisting">// forwards to <boost/spirit/home/karma/directive/right_alignment.hpp>
+#include <boost/spirit/include/karma_right_alignment.hpp>
+</pre>
+
+ Also, see Include Structure.
+ 
+<a name="spirit.karma.reference.directive.alignment.model_of"></a><h6>
+<a name="id527910"></a>
+ <a href="directive.html#spirit.karma.reference.directive.alignment.model_of">Model
+ of</a>
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ UnaryGenerator
+ 
+
+ 
+</blockquote></div>
+<div class="variablelist">
+Notation
+<dl>
+<dt><tt class="computeroutput">a</tt></dt>
+<dd>
+ A generator object
+ </dd>
+<dt><tt class="computeroutput">pad</tt></dt>
+<dd>
+ A generator object, or a <a href="karma_basics.html#spirit.karma.reference.karma_basics.lazy_argument">Lazy
+ Argument</a> that evaluates to a generator object
+ </dd>
+<dt><tt class="computeroutput">A</tt>,
+ <tt class="computeroutput">Pad</tt></dt>
+<dd>
+ Attribute types of the generators <tt class="computeroutput">a</tt>
+ and <tt class="computeroutput">pad</tt>
+ </dd>
+<dt><tt class="computeroutput">width</tt></dt>
+<dd>
+ Numeric literal, any unsigned integer value, or a <a href="karma_basics.html#spirit.karma.reference.karma_basics.lazy_argument">Lazy
+ Argument</a> that evaluates to an unsigned integer value
+ </dd>
+</dl>
+</div>
+<a name="spirit.karma.reference.directive.alignment.expression_semantics"></a><h6>
+<a name="id528121"></a>
+ <a href="directive.html#spirit.karma.reference.directive.alignment.expression_semantics">Expression
+ Semantics</a>
+ </h6>
+
+ Semantics of an expression is defined only where it differs from, or
+ is not defined in UnaryGenerator.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Semantics
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <tt class="computeroutput">left_align[a]</tt>
+ </td>
+<td>
+ Generate <tt class="computeroutput">a</tt> left
+ aligned in a column of width as defined by the preprocessor constant
+ <tt class="computeroutput">BOOST_KARMA_DEFAULT_FIELD_LENGTH</tt>
+ (default: 10), while using <tt class="computeroutput">space</tt>
+ to emit the necessary padding. This generator succeeds as long
+ as its embedded generator <tt class="computeroutput">a</tt>
+ does not fail (except if the underlying output stream reports
+ an error).
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">left_align(width)[a]</tt>
+ </td>
+<td>
+ Generate <tt class="computeroutput">a</tt> left
+ aligned in a column of the given <tt class="computeroutput">width</tt>,
+ while using <tt class="computeroutput">space</tt>
+ to emit the necessary padding. This generator succeeds as long
+ as its embedded generator <tt class="computeroutput">a</tt>
+ does not fail (except if the underlying output stream reports
+ an error).
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">left_align(pad)[a]</tt>
+ </td>
+<td>
+ Generate <tt class="computeroutput">a</tt> left
+ aligned in a column of width as defined by the preprocessor constant
+ <tt class="computeroutput">BOOST_KARMA_DEFAULT_FIELD_LENGTH</tt>
+ (default: 10), while using the generator <tt class="computeroutput">pad</tt>
+ to emit the necessary padding. This generator succeeds as long
+ as its embedded and padding generators <tt class="computeroutput">a</tt>
+ and <tt class="computeroutput">pad</tt> do not
+ fail (except if the underlying output stream reports an error).
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">left_align(pad,
+ width)[a]</tt>
+ </td>
+<td>
+ Generate <tt class="computeroutput">a</tt> left
+ aligned in a column of the given <tt class="computeroutput">width</tt>,
+ while using the generator <tt class="computeroutput">pad</tt>
+ to emit the necessary padding. This generator succeeds as long
+ as its embedded and padding generators <tt class="computeroutput">a</tt>
+ and <tt class="computeroutput">pad</tt> do not
+ fail (except if the underlying output stream reports an error).
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">center[a]</tt>
+ </td>
+<td>
+ Generate <tt class="computeroutput">a</tt> centered
+ in a column of width as defined by the preprocessor constant
+ <tt class="computeroutput">BOOST_KARMA_DEFAULT_FIELD_LENGTH</tt>
+ (default: 10), while using <tt class="computeroutput">space</tt>
+ to emit the necessary padding. This generator succeeds as long
+ as its embedded generator <tt class="computeroutput">a</tt>
+ does not fail (except if the underlying output stream reports
+ an error).
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">center(width)[a]</tt>
+ </td>
+<td>
+ Generate <tt class="computeroutput">a</tt> centered
+ in a column of the given <tt class="computeroutput">width</tt>,
+ while using <tt class="computeroutput">space</tt>
+ to emit the necessary padding. This generator succeeds as long
+ as its embedded generator <tt class="computeroutput">a</tt>
+ does not fail (except if the underlying output stream reports
+ an error).
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">center(pad)[a]</tt>
+ </td>
+<td>
+ Generate <tt class="computeroutput">a</tt> centered
+ in a column of width as defined by the preprocessor constant
+ <tt class="computeroutput">BOOST_KARMA_DEFAULT_FIELD_LENGTH</tt>
+ (default: 10), while using the generator <tt class="computeroutput">pad</tt>
+ to emit the necessary padding. This generator succeeds as long
+ as its embedded and padding generators <tt class="computeroutput">a</tt>
+ and <tt class="computeroutput">pad</tt> do not
+ fail (except if the underlying output stream reports an error).
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">center(pad,
+ width)[a]</tt>
+ </td>
+<td>
+ Generate <tt class="computeroutput">a</tt> centered
+ in a column of the given <tt class="computeroutput">width</tt>,
+ while using the generator <tt class="computeroutput">pad</tt>
+ to emit the necessary padding. This generator succeeds as long
+ as its embedded and padding generators <tt class="computeroutput">a</tt>
+ and <tt class="computeroutput">pad</tt> do not
+ fail (except if the underlying output stream reports an error).
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">right_align[a]</tt>
+ </td>
+<td>
+ Generate <tt class="computeroutput">a</tt> right
+ aligned in a column of width as defined by the preprocessor constant
+ <tt class="computeroutput">BOOST_KARMA_DEFAULT_FIELD_LENGTH</tt>
+ (default: 10), while using <tt class="computeroutput">space</tt>
+ to emit the necessary padding. This generator succeeds as long
+ as its embedded generator <tt class="computeroutput">a</tt>
+ does not fail (except if the underlying output stream reports
+ an error).
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">right_align(width)[a]</tt>
+ </td>
+<td>
+ Generate <tt class="computeroutput">a</tt> right
+ aligned in a column of the given <tt class="computeroutput">width</tt>,
+ while using <tt class="computeroutput">space</tt>
+ to emit the necessary padding. This generator succeeds as long
+ as its embedded generator <tt class="computeroutput">a</tt>
+ does not fail (except if the underlying output stream reports
+ an error).
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">right_align(pad)[a]</tt>
+ </td>
+<td>
+ Generate <tt class="computeroutput">a</tt> right
+ aligned in a column of width as defined by the preprocessor constant
+ <tt class="computeroutput">BOOST_KARMA_DEFAULT_FIELD_LENGTH</tt>
+ (default: 10), while using the generator <tt class="computeroutput">pad</tt>
+ to emit the necessary padding. This generator succeeds as long
+ as its embedded and padding generators <tt class="computeroutput">a</tt>
+ and <tt class="computeroutput">pad</tt> do not
+ fail (except if the underlying output stream reports an error).
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">right_align(pad,
+ width)[a]</tt>
+ </td>
+<td>
+ Generate <tt class="computeroutput">a</tt> right
+ aligned in a column of the given <tt class="computeroutput">width</tt>,
+ while using the generator <tt class="computeroutput">pad</tt>
+ to emit the necessary padding. This generator succeeds as long
+ as its embedded and padding generators <tt class="computeroutput">a</tt>
+ and <tt class="computeroutput">pad</tt> do not
+ fail (except if the underlying output stream reports an error).
+ </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">
+
+ None of the generator directives listed above limit the emitted output
+ to the respective column width. If the emitted output is longer than
+ the specified (or implied) column width, the generated output overruns
+ the column to the right.
+ 
+
+ If the output needs to be limitted to a specified column width, use
+ the <tt class="computeroutput">maxwidth[]</tt>
+ directive, for instance:
+
+<pre class="programlisting">maxwidth(8)[right_align(12)["1234567890"]]
+</pre>
+
+ which will output: <tt class="computeroutput">" 123456"</tt>
+ (without the quotes).
+ 
+</td></tr>
+</table></div>
+<a name="spirit.karma.reference.directive.alignment.attributes"></a><h6>
+<a name="id529664"></a>
+ Attributes
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Attribute
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <tt class="computeroutput">left_align[]</tt>
+ </td>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">a: A --> left_align[a]: A
+a: Unused --> left_align[a]: Unused</pre>
+
+ 
+</td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">left_align(width)[]</tt>
+ </td>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">a: A --> left_align(width)[a]: A
+a: Unused --> left_align(width)[a]: Unused</pre>
+
+ 
+</td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">left_align(pad)[]</tt>
+ </td>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">a: A, pad: Pad --> left_align(pad)[a]: A
+a: Unused, pad: Pad --> left_align(pad)[a]: Unused</pre>
+
+ 
+</td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">left_align(pad,
+ width)[]</tt>
+ </td>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">a: A, pad: Pad --> left_align(pad, width)[a]: A
+a: Unused, pad: Pad --> left_align(pad, width)[a]: Unused</pre>
+
+ 
+</td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">center[]</tt>
+ </td>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">a: A --> center[a]: A
+a: Unused --> center[a]: Unused</pre>
+
+ 
+</td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">center(width)[]</tt>
+ </td>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">a: A --> center(width)[a]: A
+a: Unused --> center(width)[a]: Unused</pre>
+
+ 
+</td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">center(pad)[]</tt>
+ </td>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">a: A, pad: Pad --> center(pad)[a]: A
+a: Unused, pad: Pad --> center(pad)[a]: Unused</pre>
+
+ 
+</td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">center(pad,
+ width)[]</tt>
+ </td>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">a: A, pad: Pad --> center(pad, width)[a]: A
+a: Unused, pad: Pad --> center(pad, width)[a]: Unused</pre>
+
+ 
+</td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">right_align[]</tt>
+ </td>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">a: A --> right_align[a]: A
+a: Unused --> right_align[a]: Unused</pre>
+
+ 
+</td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">right_align(width)[]</tt>
+ </td>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">a: A --> right_align(width)[a]: A
+a: Unused --> right_align(width)[a]: Unused</pre>
+
+ 
+</td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">right_align(pad)[]</tt>
+ </td>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">a: A, pad: Pad --> right_align(pad)[a]: A
+a: Unused, pad: Pad --> right_align(pad)[a]: Unused</pre>
+
+ 
+</td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">right_align(pad,
+ width)[]</tt>
+ </td>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">a: A, pad: Pad --> right_align(pad, width)[a]: A
+a: Unused, pad: Pad --> right_align(pad, width)[a]: Unused</pre>
+
+ 
+</td>
+</tr>
+</tbody>
+</table></div>
+<a name="spirit.karma.reference.directive.alignment.complexity"></a><h6>
+<a name="id532034"></a>
+ Complexity
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ The overall complexity of the alignment generator directives is defined
+ by the complexity of its embedded and padding generator. The complexity
+ of the left alignment directive generator itself is O(1). The complexity
+ of the center and right alignment directive generators itself is
+ O(N). where <tt class="computeroutput">N</tt> is
+ the number of characters emitted by the embedded and padding generators.
+ 
+
+ 
+</blockquote></div>
+<a name="spirit.karma.reference.directive.alignment.example"></a><h6>
+<a name="id532088"></a>
+ Example
+ </h6>
+
+ Some includes:
+ 
+
+ 
+
+
+
+<pre class="programlisting">#include <boost/spirit/include/karma.hpp>
+#include <boost/spirit/include/phoenix_core.hpp>
+#include <boost/spirit/include/phoenix_operator.hpp>
+#include <boost/fusion/include/std_pair.hpp>
+#include <iostream>
+#include <string>
+</pre>
+
+ 
+
+ 
+
+ All code snippets below use this common test function:
+ 
+
+ 
+
+
+
+<pre class="programlisting">template <typename G, typename T>
+void test_generator_attr(char const* expected, G const& g, T const& attr)
+{
+ std::string s;
+ std::back_insert_iterator<std::string> out(s);
+ if (boost::spirit::karma::generate(out, g, attr) && str == expected)
+ std::cout << "ok" << std::endl;
+ else
+ std::cout << "fail" << std::endl;
+}
+</pre>
+
+ 
+
+ 
+
+ Some using declarations:
+ 
+
+ 
+
+
+
+<pre class="programlisting">using boost::spirit::karma::generate;
+using boost::spirit::karma::double_;
+using boost::spirit::karma::left_align;
+using boost::spirit::karma::center;
+using boost::spirit::karma::right_align;
+</pre>
+
+ 
+
+ 
+
+ Basic usage of the alignment generators:
+ 
+
+ 
+
+
+
+<pre class="programlisting">std::pair<double, double> p (1.0, 2.0);
+test_generator_attr("1.0 |2.0", left_align(8)[double_] << '|' << double_, p);
+test_generator_attr(" 1.0 |2.0", center(8)[double_] << '|' << double_, p);
+test_generator_attr(" 1.0|2.0", right_align(8)[double_] << '|' << double_, p);
+</pre>
+
+ 
+
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.karma.reference.directive.repeat"></a><a href="directive.html#spirit.karma.reference.directive.repeat" title=" Repetition
+ Directive (repeat[])"> Repetition
+ Directive (<tt class="computeroutput">repeat[]</tt>)</a>
+</h5></div></div>
+<div></div>
+</div>
+<a name="spirit.karma.reference.directive.repeat.description"></a><h6>
+<a name="id533592"></a>
+ Description
+ </h6>
+
+ The repetition directive allows to repeat an arbitrary generator expression
+ while optionally specifying the lower and upper repetition counts.
+ 
+<a name="spirit.karma.reference.directive.repeat.header"></a><h6>
+<a name="id533624"></a>
+ Header
+ </h6>
+<pre class="programlisting">// forwards to <boost/spirit/home/karma/directive/repeat.hpp>
+#include <boost/spirit/include/karma_repeat.hpp>
+</pre>
+
+ Also, see Include Structure.
+ 
+<a name="spirit.karma.reference.directive.repeat.model_of"></a><h6>
+<a name="id533737"></a>
+ <a href="directive.html#spirit.karma.reference.directive.repeat.model_of">Model
+ of</a>
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ UnaryGenerator
+ 
+
+ 
+</blockquote></div>
+<div class="variablelist">
+Notation
+<dl>
+<dt><tt class="computeroutput">a</tt></dt>
+<dd>
+ A generator object
+ </dd>
+<dt><tt class="computeroutput">num, num1, num2</tt></dt>
+<dd>
+ Numeric literals, any unsigned integer value, or a <a href="karma_basics.html#spirit.karma.reference.karma_basics.lazy_argument">Lazy
+ Argument</a> that evaluates to an unsigned integer value
+ </dd>
+<dt><tt class="computeroutput">inf</tt></dt>
+<dd>
+ Placeholder expression standing for 'no upper repeat limit'
+ </dd>
+</dl>
+</div>
+<a name="spirit.karma.reference.directive.repeat.expression_semantics"></a><h6>
+<a name="id533901"></a>
+ <a href="directive.html#spirit.karma.reference.directive.repeat.expression_semantics">Expression
+ Semantics</a>
+ </h6>
+
+ Semantics of an expression is defined only where it differs from, or
+ is not defined in UnaryGenerator.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Semantics
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <tt class="computeroutput">repeat[a]</tt>
+ </td>
+<td>
+ Repeat the generator <tt class="computeroutput">a</tt>
+ zero or more times. This generator succeeds as long as its embedded
+ generator <tt class="computeroutput">a</tt> does
+ not fail (except if the underlying output stream reports an error).
+ This variant of <tt class="computeroutput">repeat[]</tt> is semantically equivalent
+ to the <a href="operator.html#spirit.karma.reference.operator.kleene" title=" Kleene Star
+ (unary operator*())">Kleene
+ Star operator <tt class="computeroutput">*a</tt></a>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">repeat(num)[a]</tt>
+ </td>
+<td>
+ Repeat the generator <tt class="computeroutput">a</tt>
+ exactly <tt class="computeroutput">num</tt> times.
+ This generator succeeds as long as its embedded generator <tt class="computeroutput">a</tt> does not fail and as long
+ as the associated attribute (container) contains at least <tt class="computeroutput">num</tt> elements (except if the
+ underlying output stream reports an error).
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">repeat(num1,
+ num2)[a]</tt>
+ </td>
+<td>
+ Repeat the generator <tt class="computeroutput">a</tt>
+ at least <tt class="computeroutput">num1</tt>
+ times but not more than <tt class="computeroutput">num2</tt>
+ times. This generator succeeds as long as its embedded generator
+ <tt class="computeroutput">a</tt> does not fail
+ and as long as the associated attribute (container) contains
+ at least <tt class="computeroutput">num1</tt>
+ elements (except if the underlying output stream reports an error).
+ If the associated attribute (container) does contain more than
+ <tt class="computeroutput">num2</tt> elements,
+ this directive limits the repeat count to <tt class="computeroutput">num2</tt>.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">repeat(num,
+ inf)[a]</tt>
+ </td>
+<td>
+ Repeat the generator <tt class="computeroutput">a</tt>
+ at least <tt class="computeroutput">num1</tt>
+ times. No upper limit for the repeat count is set. This generator
+ succeeds as long as its embedded generator <tt class="computeroutput">a</tt>
+ does not fail and as long as the associated attribute (container)
+ contains at least <tt class="computeroutput">num</tt>
+ elements (except if the underlying output stream reports an error).
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="spirit.karma.reference.directive.repeat.attributes"></a><h6>
+<a name="id534479"></a>
+ Attributes
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Attribute
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <tt class="computeroutput">repeat[a]</tt>
+ </td>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">a: A --> repeat[a]: vector<A>
+a: Unused --> repeat[a]: Unused</pre>
+
+ 
+</td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">repeat(num)[a]</tt>
+ </td>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">a: A --> repeat(num)[a]: vector<A>
+a: Unused --> repeat(num)[a]: Unused</pre>
+
+ 
+</td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">repeat(num1,
+ num2)[a]</tt>
+ </td>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">a: A --> repeat(num1, num2)[a]: vector<A>
+a: Unused --> repeat(num1, num2)[a]: Unused</pre>
+
+ 
+</td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">repeat(num,
+ inf)[a]</tt>
+ </td>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">a: A --> repeat(num, inf)[a]: vector<A>
+a: Unused --> repeat(num, inf)[a]: Unused</pre>
+
+ 
+</td>
+</tr>
+</tbody>
+</table></div>
+<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">
+
+ The table above uses <tt class="computeroutput">vector<A></tt> as placeholders only.
+ 
+
+ The notation of <tt class="computeroutput">vector<A></tt> stands for any STL container
+ holding elements of type <tt class="computeroutput">A</tt>.
+ 
+</td></tr>
+</table></div>
+<a name="spirit.karma.reference.directive.repeat.complexity"></a><h6>
+<a name="id535436"></a>
+ Complexity
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ The overall complexity of the repetition generator is defined by
+ the complexity of its embedded generator. The complexity of the repeat
+ itself is O(N), where N is the number of repetitions to execute.
+ 
+
+ 
+</blockquote></div>
+<a name="spirit.karma.reference.directive.repeat.example"></a><h6>
+<a name="id535476"></a>
+ Example
+ </h6>
+
+ Some includes:
+ 
+
+ 
+
+
+
+<pre class="programlisting">#include <boost/spirit/include/karma.hpp>
+#include <boost/spirit/include/phoenix_core.hpp>
+#include <boost/spirit/include/phoenix_operator.hpp>
+#include <boost/fusion/include/std_pair.hpp>
+#include <iostream>
+#include <string>
+</pre>
+
+ 
+
+ 
+
+ All code snippets below use this common test function:
+ 
+
+ 
+
+
+
+<pre class="programlisting">template <typename G, typename T>
+void test_generator_attr(char const* expected, G const& g, T const& attr)
+{
+ std::string s;
+ std::back_insert_iterator<std::string> out(s);
+ if (boost::spirit::karma::generate(out, g, attr) && str == expected)
+ std::cout << "ok" << std::endl;
+ else
+ std::cout << "fail" << std::endl;
+}
+</pre>
+
+ 
+
+ 
+
+ Some using declarations:
+ 
+
+ 
+
+
+
+<pre class="programlisting">using boost::spirit::karma::generate;
+using boost::spirit::karma::double_;
+using boost::spirit::karma::repeat;
+</pre>
+
+ 
+
+ 
+
+ Basic usage of <tt class="computeroutput">repeat</tt>
+ generator directive:
+ 
+
+ 
+
+
+
+<pre class="programlisting">std::vector<double> v;
+v.push_back(1.0);
+v.push_back(2.0);
+v.push_back(3.0);
+
+test_generator_attr("[1.0][2.0][3.0]", repeat['[' << double_ << ']'], v);
+test_generator_attr("[1.0][2.0]", repeat(2)['[' << double_ << ']'], v);
+
+// fails because of insufficient number of items
+test_generator_attr("", repeat(4)['[' << double_ << ']'], v);
+</pre>
+
+ 
+
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.karma.reference.directive.delimit"></a><a href="directive.html#spirit.karma.reference.directive.delimit" title=" Directives
+ Controlling Automatic Delimiting (verbatim[] and delimit[])"> Directives
+ Controlling Automatic Delimiting (<tt class="computeroutput">verbatim[]</tt> and <tt class="computeroutput">delimit[]</tt>)</a>
+</h5></div></div>
+<div></div>
+</div>
+<a name="spirit.karma.reference.directive.delimit.description"></a><h6>
+<a name="id536954"></a>
+ Description
+ </h6>
+
+ The directives <tt class="computeroutput">delimit[]</tt> and <tt class="computeroutput">verbatim[]</tt> can be used to control automatic delimiting.
+ The directive <tt class="computeroutput">verbatim[]</tt> disabled any automatic delimiting,
+ while the directive <tt class="computeroutput">delimit[]</tt> (re-)enable automatic delimiting.
+ 
+<a name="spirit.karma.reference.directive.delimit.header"></a><h6>
+<a name="id537053"></a>
+ Header
+ </h6>
+
+ For the <tt class="computeroutput">verbatim[]</tt>
+ directive:
+ 
+<pre class="programlisting">// forwards to <boost/spirit/home/karma/directive/verbatim.hpp>
+#include <boost/spirit/include/karma_verbatim.hpp>
+</pre>
+
+ For the <tt class="computeroutput">delimit[]</tt>
+ directive:
+ 
+<pre class="programlisting">// forwards to <boost/spirit/home/karma/directive/delimit.hpp>
+#include <boost/spirit/include/karma_delimit.hpp>
+</pre>
+
+ Also, see Include Structure.
+ 
+<a name="spirit.karma.reference.directive.delimit.model_of"></a><h6>
+<a name="id537285"></a>
+ <a href="directive.html#spirit.karma.reference.directive.delimit.model_of">Model
+ of</a>
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ UnaryGenerator
+ 
+
+ 
+</blockquote></div>
+<div class="variablelist">
+Notation
+<dl>
+<dt><tt class="computeroutput">a</tt></dt>
+<dd>
+ A generator object
+ </dd>
+<dt><tt class="computeroutput">d</tt></dt>
+<dd>
+ A generator object, or a <a href="karma_basics.html#spirit.karma.reference.karma_basics.lazy_argument">Lazy
+ Argument</a> that evaluates to a generator object
+ </dd>
+<dt><tt class="computeroutput">A</tt>,
+ <tt class="computeroutput">D</tt></dt>
+<dd>
+ Attribute types of the generators <tt class="computeroutput">a</tt>
+ and <tt class="computeroutput">d</tt>
+ </dd>
+</dl>
+</div>
+<a name="spirit.karma.reference.directive.delimit.expression_semantics"></a><h6>
+<a name="id537459"></a>
+ <a href="directive.html#spirit.karma.reference.directive.delimit.expression_semantics">Expression
+ Semantics</a>
+ </h6>
+
+ Semantics of an expression is defined only where it differs from, or
+ is not defined in UnaryGenerator.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Semantics
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <tt class="computeroutput">delimit[a]</tt>
+ </td>
+<td>
+ Enable automatic delimiting for the embedded generator <tt class="computeroutput">a</tt> while using the <tt class="computeroutput">space</tt> generator as the delimiting
+ generator. If used inside a <tt class="computeroutput">verbatim[]</tt> directive it re-enables the
+ delimiter generator as used outside of this <tt class="computeroutput">verbatim[]</tt> instead. The directive succeeds
+ as long as the embedded generator succeeded (except if the underlying
+ output stream reports an error).
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">delimit(d)[a]</tt>
+ </td>
+<td>
+ Enable automatic delimiting for the embedded generator <tt class="computeroutput">a</tt> while using the generator
+ <tt class="computeroutput">d</tt> as the delimiting
+ generator. The directive succeeds as long as the embedded generator
+ succeeded (except if the underlying output stream reports an
+ error).
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">verbatim[a]</tt>
+ </td>
+<td>
+ Disable automatic delimiting for the embedded generator <tt class="computeroutput">a</tt>. The directive succeeds as
+ long as the embedded generator succeeded (except if the underlying
+ output stream reports an error). This directive it has no effect
+ if it is used when no delimiting is active.
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="spirit.karma.reference.directive.delimit.attributes"></a><h6>
+<a name="id537796"></a>
+ Attributes
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Attribute
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <tt class="computeroutput">delimit[a]</tt>
+ </td>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">a: A --> delimit[a]: A
+a: Unused --> delimit[a]: Unused</pre>
+
+ 
+</td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">delimit(d)[a]</tt>
+ </td>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">a: A, d: D --> delimit(d)[a]: A
+a: Unused, d: D --> delimit(d)[a]: Unused</pre>
+
+ 
+</td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">verbatim[a]</tt>
+ </td>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">a: A --> verbatim[a]: A
+a: Unused --> verbatim[a]: Unused</pre>
+
+ 
+</td>
+</tr>
+</tbody>
+</table></div>
+<a name="spirit.karma.reference.directive.delimit.complexity"></a><h6>
+<a name="id538380"></a>
+ Complexity
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ The overall complexity of the generator directives <tt class="computeroutput">delimit[]</tt>
+ and <tt class="computeroutput">verbatim[]</tt>
+ is defined by the complexity of its embedded generators. The complexity
+ of the directives themselves is O(1).
+ 
+
+ 
+</blockquote></div>
+<a name="spirit.karma.reference.directive.delimit.example"></a><h6>
+<a name="id538452"></a>
+ Example
+ </h6>
+
+ Some includes:
+ 
+
+ 
+
+
+
+<pre class="programlisting">#include <boost/spirit/include/karma.hpp>
+#include <iostream>
+#include <string>
+</pre>
+
+ 
+
+ 
+
+ All code snippets below use this common test function:
+ 
+
+ 
+
+
+
+<pre class="programlisting">template <typename G, typename T1, typename T2>
+void test_generator_attr(char const* expected, G const& g, T1 const& attr1,
+ T2 const& attr2)
+{
+ std::string s;
+ std::back_insert_iterator<std::string> out(s);
+ if (boost::spirit::karma::generate(out, g, attr1, attr2) && str == expected)
+ std::cout << "ok" << std::endl;
+ else
+ std::cout << "fail" << std::endl;
+}
+</pre>
+
+ 
+
+ 
+
+ Some using declarations:
+ 
+
+ 
+
+
+
+<pre class="programlisting">using boost::spirit::karma::generate;
+using boost::spirit::karma::double_;
+using boost::spirit::karma::delimit;
+using boost::spirit::karma::verbatim;
+</pre>
+
+ 
+
+ 
+
+ Basic usage of <tt class="computeroutput">delimit</tt>
+ generator directive:
+ 
+
+ 
+
+
+
+<pre class="programlisting">test_generator_attr("[ 2.0 , 4.3 ] ",
+ delimit['[' << double_ << ',' << double_ << ']'], 2.0, 4.3);
+test_generator_attr("[*2.0*,*4.3*]*",
+ delimit('*')['[' << double_ << ',' << double_ << ']'], 2.0, 4.3);
+test_generator_attr("[2.0, 4.3 ] ",
+ delimit[verbatim['[' << double_ << ','] << double_ << ']'], 2.0, 4.3);
+</pre>
+
+ 
+
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.karma.reference.directive.upperlower"></a><a href="directive.html#spirit.karma.reference.directive.upperlower" title=" Directives
+ Controlling Case Sensitivity (upper[] and lower[])"> Directives
+ Controlling Case Sensitivity (<tt class="computeroutput">upper[]</tt> and <tt class="computeroutput">lower[]</tt>)</a>
+</h5></div></div>
+<div></div>
+</div>
+<a name="spirit.karma.reference.directive.upperlower.description"></a><h6>
+<a name="id539818"></a>
+ Description
+ </h6>
+
+ The generator directives <tt class="computeroutput">ns::lower[]</tt> and <tt class="computeroutput">ns::upper[]</tt> force their embedded generators to
+ emit lower case or upper case only characters based on the interpretation
+ of the generated characters in the character set defined by <tt class="computeroutput">ns</tt> (see <a href="../../qi/reference/basics.html#spirit.qi.reference.basics.character_encoding_namespace">Character
+ Encoding Namespace</a>).
+ 
+<a name="spirit.karma.reference.directive.upperlower.header"></a><h6>
+<a name="id539924"></a>
+ Header
+ </h6>
+<pre class="programlisting">// forwards to <boost/spirit/home/karma/directive/upper_lower_case.hpp>
+#include <boost/spirit/include/karma_upper_lower_case.hpp>
+</pre>
+
+ Also, see Include Structure.
+ 
+<a name="spirit.karma.reference.directive.upperlower.model_of"></a><h6>
+<a name="id540038"></a>
+ <a href="directive.html#spirit.karma.reference.directive.upperlower.model_of">Model
+ of</a>
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ UnaryGenerator
+ 
+
+ 
+</blockquote></div>
+<div class="variablelist">
+Notation
+<dl>
+<dt><tt class="computeroutput">a</tt></dt>
+<dd>
+ A generator object
+ </dd>
+<dt><tt class="computeroutput">A</tt></dt>
+<dd>
+ Attribute type of the generator <tt class="computeroutput">a</tt>
+ </dd>
+<dt><tt class="computeroutput">ns</tt></dt>
+<dd>
+ A <a href="../../qi/reference/basics.html#spirit.qi.reference.basics.character_encoding_namespace">Character
+ Encoding Namespace</a>.
+ </dd>
+</dl>
+</div>
+<a name="spirit.karma.reference.directive.upperlower.expression_semantics"></a><h6>
+<a name="id540190"></a>
+ <a href="directive.html#spirit.karma.reference.directive.upperlower.expression_semantics">Expression
+ Semantics</a>
+ </h6>
+
+ Semantics of an expression is defined only where it differs from, or
+ is not defined in UnaryGenerator.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Semantics
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <tt class="computeroutput">ns::lower[a]</tt>
+ </td>
+<td>
+ Generate <tt class="computeroutput">a</tt> as
+ lower case, interpreted in the character set defined by <tt class="computeroutput">ns</tt>. The directive succeeds
+ as long as the embedded generator succeeded (except if the underlying
+ output stream reports an error).
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ns::upper[a]</tt>
+ </td>
+<td>
+ Generate <tt class="computeroutput">a</tt> as
+ upper case, interpreted in the character set defined by <tt class="computeroutput">ns</tt>. The directive succeeds
+ as long as the embedded generator succeeded (except if the underlying
+ output stream reports an error).
+ </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 both directives are 'active' with regard to a generator, the innermost
+ of those directives takes precendence. For instance:
+
+<pre class="programlisting">generate(sink, ascii::lower['A' << ascii::upper['b']])
+</pre>
+
+ will generate <tt class="computeroutput">"aB"</tt>
+ (without the quotes).
+ 
+
+ Further, the directives will have no effect on generators not emitting
+ characters having an upper case or lower case equivalent in the character
+ set defined by <tt class="computeroutput">ns</tt>.
+ 
+</td></tr>
+</table></div>
+<a name="spirit.karma.reference.directive.upperlower.attributes"></a><h6>
+<a name="id540572"></a>
+ Attributes
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Attribute
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <tt class="computeroutput">ns:lower[a]</tt>
+ </td>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">a: A --> ns:lower[a]: A
+a: Unused --> ns:lower[a]: Unused</pre>
+
+ 
+</td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ns:upper[a]</tt>
+ </td>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">a: A --> ns:upper[a]: A
+a: Unused --> ns:upper[a]: Unused</pre>
+
+ 
+</td>
+</tr>
+</tbody>
+</table></div>
+<a name="spirit.karma.reference.directive.upperlower.complexity"></a><h6>
+<a name="id540991"></a>
+ Complexity
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ The overall complexity of the generator directives <tt class="computeroutput">ns::lower[]</tt>
+ and <tt class="computeroutput">ns::upper[]</tt>
+ is defined by the complexity of its embedded generators. The directives
+ themselves are compile time only directives, having no impact on
+ runtime performance.
+ 
+
+ 
+</blockquote></div>
+<a name="spirit.karma.reference.directive.upperlower.example"></a><h6>
+<a name="id541082"></a>
+ Example
+ </h6>
+
+ Some includes:
+ 
+
+ 
+
+
+
+<pre class="programlisting">#include <boost/spirit/include/karma.hpp>
+#include <iostream>
+#include <string>
+</pre>
+
+ 
+
+ 
+
+ All code snippets below use this common test function:
+ 
+
+ 
+
+
+
+<pre class="programlisting">template <typename G, typename T>
+void test_generator_attr(char const* expected, G const& g, T const& attr)
+{
+ std::string s;
+ std::back_insert_iterator<std::string> out(s);
+ if (boost::spirit::karma::generate(out, g, attr) && str == expected)
+ std::cout << "ok" << std::endl;
+ else
+ std::cout << "fail" << std::endl;
+}
+</pre>
+
+ 
+
+ 
+
+ Some using declarations:
+ 
+
+ 
+
+
+
+<pre class="programlisting">using boost::spirit::karma::generate;
+using boost::spirit::karma::double_;
+using boost::spirit::ascii::upper;
+using boost::spirit::ascii::lower;
+</pre>
+
+ 
+
+ 
+
+ Basic usage of the <tt class="computeroutput">upper</tt>
+ and <tt class="computeroutput">lower</tt> generator directives:
+ 
+
+ 
+
+
+
+<pre class="programlisting">test_generator_attr("abc:2.0e-06", lower["ABC:" << double_], 2e-6);
+test_generator_attr("ABC:2.0E-06", upper["abc:" << double_], 2e-6);
+</pre>
+
+ 
+
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.karma.reference.directive.maxwidth"></a><a href="directive.html#spirit.karma.reference.directive.maxwidth" title=" Controlling
+ the Maximum Field Wield (maxwidth[])"> Controlling
+ the Maximum Field Wield (<tt class="computeroutput">maxwidth[]</tt>)</a>
+</h5></div></div>
+<div></div>
+</div>
+<a name="spirit.karma.reference.directive.maxwidth.description"></a><h6>
+<a name="id542153"></a>
+ Description
+ </h6>
+
+ The <tt class="computeroutput">maxwidth[]</tt>
+ directive allows to limit (truncate) the overall length of the output
+ generated by the embedded generator.
+ 
+<a name="spirit.karma.reference.directive.maxwidth.header"></a><h6>
+<a name="id542200"></a>
+ Header
+ </h6>
+<pre class="programlisting">// forwards to <boost/spirit/home/karma/directive/maxwidth.hpp>
+#include <boost/spirit/include/karma_maxwidth.hpp>
+</pre>
+
+ Also, see Include Structure.
+ 
+<a name="spirit.karma.reference.directive.maxwidth.model_of"></a><h6>
+<a name="id542314"></a>
+ <a href="directive.html#spirit.karma.reference.directive.maxwidth.model_of">Model
+ of</a>
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ UnaryGenerator
+ 
+
+ 
+</blockquote></div>
+<div class="variablelist">
+Notation
+<dl>
+<dt><tt class="computeroutput">a</tt></dt>
+<dd>
+ A generator object
+ </dd>
+<dt><tt class="computeroutput">A</tt></dt>
+<dd>
+ Attribute type of the generator <tt class="computeroutput">a</tt>
+ </dd>
+<dt><tt class="computeroutput">num</tt></dt>
+<dd>
+ Numeric literal, any unsigned integer value, or a <a href="karma_basics.html#spirit.karma.reference.karma_basics.lazy_argument">Lazy
+ Argument</a> that evaluates to an unsigned integer value
+ </dd>
+</dl>
+</div>
+<a name="spirit.karma.reference.directive.maxwidth.expression_semantics"></a><h6>
+<a name="id542466"></a>
+ <a href="directive.html#spirit.karma.reference.directive.maxwidth.expression_semantics">Expression
+ Semantics</a>
+ </h6>
+
+ Semantics of an expression is defined only where it differs from, or
+ is not defined in UnaryGenerator.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Semantics
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <tt class="computeroutput">maxwidth[a]</tt>
+ </td>
+<td>
+ Limit the overall length of the emitted output of the embedded
+ generator (including characters generated by automatic delimiting)
+ to the number of characters as defined by the preprocessor constant
+ <tt class="computeroutput">BOOST_KARMA_DEFAULT_FIELD_MAXWIDTH</tt>.
+ Any additional output is truncated. The directive succeeds as
+ long as the embedded generator succeeded (except if the underlying
+ output stream reports an error).
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">maxwidth(num)[a]</tt>
+ </td>
+<td>
+ Limit the overall length of the emitted output of the embedded
+ generator (including characters generated by automatic delimiting)
+ to the number of characters as defined by <tt class="computeroutput">num</tt>.
+ Any additional output is truncated. The directive succeeds as
+ long as the embedded generator succeeded (except if the underlying
+ output stream reports an error).
+ </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">
+
+ The <tt class="computeroutput">maxwidth[]</tt>
+ generator directive does not pads the generated output to fill the
+ specified column width. If the emitted output is shorter than the specified
+ (or implied) column width, the generated output will be more narrow
+ than the column width.
+ 
+
+ If the output needs to always be equal to a specified column width,
+ use one of the alignment directives <tt class="computeroutput">left-align[]</tt>, <tt class="computeroutput">center[]</tt>, or <tt class="computeroutput">right_align[]</tt>, for instance:
+
+<pre class="programlisting">maxwidth(8)[left_align(8)["1234"]]
+</pre>
+
+ which will output: <tt class="computeroutput">"1234 "</tt>
+ (without the quotes).
+ 
+</td></tr>
+</table></div>
+<a name="spirit.karma.reference.directive.maxwidth.attributes"></a><h6>
+<a name="id542855"></a>
+ Attributes
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Attribute
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <tt class="computeroutput">maxwidth[a]</tt>
+ </td>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">a: A --> maxwidth[a]: A
+a: Unused --> maxwidth[a]: Unused</pre>
+
+ 
+</td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">maxwidth(num)[a]</tt>
+ </td>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">a: A --> maxwidth(num)[a]: A
+a: Unused --> maxwidth(num)[a]: Unused</pre>
+
+ 
+</td>
+</tr>
+</tbody>
+</table></div>
+<a name="spirit.karma.reference.directive.maxwidth.complexity"></a><h6>
+<a name="id543244"></a>
+ Complexity
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ The overall complexity of the generator directive <tt class="computeroutput">maxwidth[]</tt> is defined by the complexity of
+ its embedded generator. The complexity of the directive itself is
+ O(N), where <tt class="computeroutput">N</tt> is
+ the number of characters generated by the maxwidth directive.
+ 
+
+ 
+</blockquote></div>
+<a name="spirit.karma.reference.directive.maxwidth.example"></a><h6>
+<a name="id543314"></a>
+ Example
+ </h6>
+
+ Some includes:
+ 
+
+ 
+
+
+
+<pre class="programlisting">#include <boost/spirit/include/karma.hpp>
+#include <iostream>
+#include <string>
+</pre>
+
+ 
+
+ 
+
+ All code snippets below use this common test function:
+ 
+
+ 
+
+
+
+<pre class="programlisting">template <typename G>
+void test_generator(char const* expected, G const& g)
+{
+ std::string s;
+ std::back_insert_iterator<std::string> out(s);
+ if (boost::spirit::karma::generate(out, g) && str == expected)
+ std::cout << "ok" << std::endl;
+ else
+ std::cout << "fail" << std::endl;
+}
+</pre>
+
+ 
+
+ 
+
+ Some using declarations:
+ 
+
+ 
+
+
+
+<pre class="programlisting">using boost::spirit::karma::generate;
+using boost::spirit::karma::double_;
+using boost::spirit::karma::maxwidth;
+using boost::spirit::karma::left_align;
+using boost::spirit::karma::right_align;
+</pre>
+
+ 
+
+ 
+
+ Basic usage of <tt class="computeroutput">maxwidth</tt>
+ generator directive:
+ 
+
+ 
+
+
+
+<pre class="programlisting">test_generator("01234", maxwidth(5)["0123456789"]);
+test_generator(" 012", maxwidth(5)[right_align(12)["0123456789"]]);
+test_generator("0123 ", maxwidth(8)[left_align(8)["0123"]]);
+</pre>
+
+ 
+
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.karma.reference.directive.buffer"></a><a href="directive.html#spirit.karma.reference.directive.buffer" title=" Temporary
+ Output Buffering (buffer[])"> Temporary
+ Output Buffering (<tt class="computeroutput">buffer[]</tt>)</a>
+</h5></div></div>
+<div></div>
+</div>
+<a name="spirit.karma.reference.directive.buffer.description"></a><h6>
+<a name="id544426"></a>
+ Description
+ </h6>
+
+ All generator components (except the <a href="operator.html#spirit.karma.reference.operator.alternative" title=" Alternatives
+ (operator|())">alternative
+ (<tt class="computeroutput">|</tt>)</a> generator) pass
+ their generated output directly to the underlying output stream. If a
+ generator fails halfway through, the output generated so far is not 'rolled
+ back'. The buffering generator directive allows to avoid this unwanted
+ output to be generated. It temporarily redirects the output produced
+ by the embedded generator into a buffer. This buffer is flushed to the
+ underlying stream only after the embedded generator succeeded.
+ 
+<a name="spirit.karma.reference.directive.buffer.header"></a><h6>
+<a name="id544475"></a>
+ Header
+ </h6>
+<pre class="programlisting">// forwards to <boost/spirit/home/karma/directive/buffer.hpp>
+#include <boost/spirit/include/karma_buffer.hpp>
+</pre>
+
+ Also, see Include Structure.
+ 
+<a name="spirit.karma.reference.directive.buffer.model_of"></a><h6>
+<a name="id544589"></a>
+ <a href="directive.html#spirit.karma.reference.directive.buffer.model_of">Model
+ of</a>
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ UnaryGenerator
+ 
+
+ 
+</blockquote></div>
+<div class="variablelist">
+Notation
+<dl>
+<dt><tt class="computeroutput">a</tt></dt>
+<dd>
+ A generator object
+ </dd>
+<dt><tt class="computeroutput">A</tt></dt>
+<dd>
+ Attribute type of generator <tt class="computeroutput">a</tt>
+ </dd>
+</dl>
+</div>
+<a name="spirit.karma.reference.directive.buffer.expression_semantics"></a><h6>
+<a name="id544706"></a>
+ <a href="directive.html#spirit.karma.reference.directive.buffer.expression_semantics">Expression
+ Semantics</a>
+ </h6>
+
+ Semantics of an expression is defined only where it differs from, or
+ is not defined in UnaryGenerator.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Semantics
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ <tt class="computeroutput">buffer[a]</tt>
+ </td>
+<td>
+ The embedded generator <tt class="computeroutput">a</tt>
+ is invoked but its output is temporarily intercepted and stored
+ in an internal buffer. If <tt class="computeroutput">a</tt>
+ succeeds the buffer content is flushed to the underlying output
+ stream, otherwise the buffer content is discarded. The buffer
+ directive succeeds as long as the embedded generator succeeded
+ (except if the underlying output stream reports an error).
+ </td>
+</tr></tbody>
+</table></div>
+<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">
+ If you want to make the buffered generator succeed regardless of the
+ outcome of the embedded generator, simply wrap the <tt class="computeroutput">buffer[a]</tt> into an additional optional: <tt class="computeroutput">-buffer[a]</tt> (see <a href="operator.html#spirit.karma.reference.operator.optional" title=" Optional
+ (unary operator-())">optional
+ (unary <tt class="computeroutput">-</tt>)</a>).
+ </td></tr>
+</table></div>
+<a name="spirit.karma.reference.directive.buffer.attributes"></a><h6>
+<a name="id544957"></a>
+ Attributes
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Attribute
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ <tt class="computeroutput">buffer[a]</tt>
+ </td>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">a: A --> buffer[a]: A
+a: Unused --> buffer[a]: Unused</pre>
+
+ 
+</td>
+</tr></tbody>
+</table></div>
+<a name="spirit.karma.reference.directive.buffer.complexity"></a><h6>
+<a name="id545169"></a>
+ Complexity
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ The overall complexity of the buffering generator directive is defined
+ by the complexity of its embedded generator. The complexity of the
+ buffering directive generator itself is O(1).
+ 
+
+ 
+</blockquote></div>
+<a name="spirit.karma.reference.directive.buffer.example"></a><h6>
+<a name="id545209"></a>
+ Example
+ </h6>
+
+ Some includes:
+ 
+
+ 
+
+
+
+<pre class="programlisting">#include <boost/spirit/include/karma.hpp>
+#include <boost/spirit/include/phoenix_core.hpp>
+#include <boost/spirit/include/phoenix_operator.hpp>
+#include <boost/fusion/include/std_pair.hpp>
+#include <iostream>
+#include <string>
+</pre>
+
+ 
+
+ 
+
+ All code snippets below use this common test function:
+ 
+
+ 
+
+
+
+<pre class="programlisting">template <typename G, typename T>
+void test_generator_attr(char const* expected, G const& g, T const& attr)
+{
+ std::string s;
+ std::back_insert_iterator<std::string> out(s);
+ if (boost::spirit::karma::generate(out, g, attr) && str == expected)
+ std::cout << "ok" << std::endl;
+ else
+ std::cout << "fail" << std::endl;
+}
+</pre>
+
+ 
+
+ 
+
+ Some using declarations:
+ 
+
+ 
+
+
+
+<pre class="programlisting">using boost::spirit::karma::generate;
+using boost::spirit::karma::double_;
+using boost::spirit::karma::buffer;
+</pre>
+
+ 
+
+ 
+
+ Basic usage of a buffering generator directive. It shows how the partial
+ output generated in the first example does not show up in the generated
+ output as the plus generator fails (no data is available, see <a href="operator.html#spirit.karma.reference.operator.plus" title=" Plus (unary
+ operator+())">plus
+ (unary <tt class="computeroutput">+</tt>)</a>).
+ 
+
+ 
+
+
+
+<pre class="programlisting">std::vector<double> v; // empty container
+test_generator_attr("", -buffer['[' << +double_ << ']'], v);
+
+v.push_back(1.0); // now, fill the container
+v.push_back(2.0);
+test_generator_attr("[1.02.0]", buffer['[' << +double_ << ']'], v);
+</pre>
+
+ 
+
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.karma.reference.directive.omit"></a><a href="directive.html#spirit.karma.reference.directive.omit" title=" Consume Attribute
+ (omit[])"> Consume Attribute
+ (<tt class="computeroutput">omit[]</tt>)</a>
+</h5></div></div>
+<div></div>
+</div>
+<a name="spirit.karma.reference.directive.omit.description"></a><h6>
+<a name="id546572"></a>
+ Description
+ </h6>
+
+ Consumes the attribute type of the embedded generator without generating
+ any output.
+ 
+<a name="spirit.karma.reference.directive.omit.header"></a><h6>
+<a name="id546602"></a>
+ Header
+ </h6>
+<pre class="programlisting">// forwards to <boost/spirit/home/karma/directive/omit.hpp>
+#include <boost/spirit/include/karma_omit.hpp>
+</pre>
+
+ Also, see Include Structure.
+ 
+<a name="spirit.karma.reference.directive.omit.model_of"></a><h6>
+<a name="id546717"></a>
+ <a href="directive.html#spirit.karma.reference.directive.omit.model_of">Model
+ of</a>
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ UnaryGenerator
+ 
+
+ 
+</blockquote></div>
+<div class="variablelist">
+Notation
+<dl>
+<dt><tt class="computeroutput">a</tt></dt>
+<dd>
+ A generator object
+ </dd>
+<dt><tt class="computeroutput">A</tt></dt>
+<dd>
+ Attribute type of generator <tt class="computeroutput">a</tt>
+ </dd>
+</dl>
+</div>
+<a name="spirit.karma.reference.directive.omit.expression_semantics"></a><h6>
+<a name="id546834"></a>
+ <a href="directive.html#spirit.karma.reference.directive.omit.expression_semantics">Expression
+ Semantics</a>
+ </h6>
+
+ Semantics of an expression is defined only where it differs from, or
+ is not defined in UnaryGenerator.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Semantics
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ <tt class="computeroutput">omit[a]</tt>
+ </td>
+<td>
+ The <tt class="computeroutput">omit</tt> directive
+ consumes the attribute type of the embedded generator <tt class="computeroutput">A</tt> without generating any output.
+ It succeeds always.
+ </td>
+</tr></tbody>
+</table></div>
+<a name="spirit.karma.reference.directive.omit.attributes"></a><h6>
+<a name="id546990"></a>
+ Attributes
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Attribute
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ <tt class="computeroutput">omit[a]</tt>
+ </td>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">a: A --> omit[a]: A
+a: Unused --> omit[a]: Unused</pre>
+
+ 
+</td>
+</tr></tbody>
+</table></div>
+<a name="spirit.karma.reference.directive.omit.complexity"></a><h6>
+<a name="id547201"></a>
+ Complexity
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ The overall complexity of the <tt class="computeroutput">omit</tt>
+ generator directive is O(1) as it does not generate any output.
+ 
+
+ 
+</blockquote></div>
+<a name="spirit.karma.reference.directive.omit.example"></a><h6>
+<a name="id547251"></a>
+ Example
+ </h6>
+
+ Some includes:
+ 
+
+ 
+
+
+
+<pre class="programlisting">#include <boost/spirit/include/karma.hpp>
+#include <boost/spirit/include/phoenix_core.hpp>
+#include <boost/spirit/include/phoenix_operator.hpp>
+#include <boost/fusion/include/std_pair.hpp>
+#include <iostream>
+#include <string>
+</pre>
+
+ 
+
+ 
+
+ All code snippets below use this common test function:
+ 
+
+ 
+
+
+
+<pre class="programlisting">template <typename G, typename T>
+void test_generator_attr(char const* expected, G const& g, T const& attr)
+{
+ std::string s;
+ std::back_insert_iterator<std::string> out(s);
+ if (boost::spirit::karma::generate(out, g, attr) && str == expected)
+ std::cout << "ok" << std::endl;
+ else
+ std::cout << "fail" << std::endl;
+}
+</pre>
+
+ 
+
+ 
+
+ Some using declarations:
+ 
+
+ 
+
+
+
+<pre class="programlisting">using boost::spirit::karma::generate;
+using boost::spirit::karma::double_;
+using boost::spirit::karma::buffer;
+</pre>
+
+ 
+
+ 
+
+ Basic usage of a <tt class="computeroutput">omit</tt>
+ generator directive. It shows how it consumes the first element of the
+ provided attribute without generating anything, leaving the second element
+ of the attribute to the non-wrapped <tt class="computeroutput">double_</tt>
+ generator.
+ 
+
+ 
+
+
+
+<pre class="programlisting">std::pair<double, double> p (1.0, 2.0);
+test_generator_attr("2.0", omit[double_] << double_, p);
+</pre>
+
+ 
+
+ 
+
+ Generally, this directive is helpful in situations, where the attribute
+ type contains more information (elements) than need to be used to generate
+ the required output. Normally in such situations we would resolve to
+ use semantic actions to explicitly pass the correct parts of the overall
+ attribute to the generators. The <tt class="computeroutput">omit</tt>
+ directive helps achieving the same without having to use semantic actions.
+ 
+
+ Consider the attribute type:
+ 
+<pre class="programlisting">typedef fusion::vector<int, double, std::string> attribute_type;
+</pre>
+
+ where we need to generate output only from the first and last element:
+ 
+<pre class="programlisting">typedef std::back_insert:iterator<std::string> iterator_type;
+
+karma::rule<iterator_type, attribute_type()> r;
+r = int_[_1 = phoenix::at_c<0>(_val)] << string[_1 = phoenix::at_c<2>(_val)];
+
+std::string str;
+iterator_type sink(str);
+generate(sink, r, attribute_type(1, 2.0, "example")); // will generate: '1example'
+</pre>
+
+ This is error prone and not really readable. The same can be achieved
+ by using the <tt class="computeroutput">omit</tt> directive:
+ 
+<pre class="programlisting">r = int_ << omit[double_] << string;
+</pre>
+
+ which is at the same time more readable and more efficient as we don't
+ have to use semantic actions.
+ 
+</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
@@ -73,7 +2353,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="numeric/floating_point.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/alignment.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+<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="operator.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>

Modified: trunk/libs/spirit/doc/html/spirit/karma/reference/directive/alignment.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/karma/reference/directive/alignment.html (original)
+++ trunk/libs/spirit/doc/html/spirit/karma/reference/directive/alignment.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -34,7 +34,7 @@
<div></div>
</div>
<a name="spirit.karma.reference.directive.alignment.description"></a><h6>
-<a name="id527248"></a>
+<a name="id527544"></a>
 <a href="alignment.html#spirit.karma.reference.directive.alignment.description">Description</a>
 </h6>

@@ -43,7 +43,7 @@
 an arbitrary generator to create the padding.
 
<a name="spirit.karma.reference.directive.alignment.header"></a><h6>
-<a name="id527280"></a>
+<a name="id527576"></a>
 <a href="alignment.html#spirit.karma.reference.directive.alignment.header">Header</a>
 </h6>

@@ -71,7 +71,7 @@
 Also, see Include Structure.
 
<a name="spirit.karma.reference.directive.alignment.model_of"></a><h6>
-<a name="id527614"></a>
+<a name="id527910"></a>
 <a href="alignment.html#spirit.karma.reference.directive.alignment.model_of">Model
 of</a>
 </h6>
@@ -110,7 +110,7 @@
</dl>
</div>
<a name="spirit.karma.reference.directive.alignment.expression_semantics"></a><h6>
-<a name="id527825"></a>
+<a name="id528121"></a>
 <a href="alignment.html#spirit.karma.reference.directive.alignment.expression_semantics">Expression
 Semantics</a>
 </h6>
@@ -337,7 +337,7 @@
</td></tr>
</table></div>
<a name="spirit.karma.reference.directive.alignment.attributes"></a><h6>
-<a name="id529369"></a>
+<a name="id529664"></a>
 <a href="alignment.html#spirit.karma.reference.directive.alignment.attributes">Attributes</a>
 </h6>
<div class="informaltable"><table class="table">
@@ -528,7 +528,7 @@
</tbody>
</table></div>
<a name="spirit.karma.reference.directive.alignment.complexity"></a><h6>
-<a name="id531738"></a>
+<a name="id532034"></a>
 <a href="alignment.html#spirit.karma.reference.directive.alignment.complexity">Complexity</a>
 </h6>
<div class="blockquote"><blockquote class="blockquote">
@@ -546,7 +546,7 @@
 
</blockquote></div>
<a name="spirit.karma.reference.directive.alignment.example"></a><h6>
-<a name="id531792"></a>
+<a name="id532088"></a>
 <a href="alignment.html#spirit.karma.reference.directive.alignment.example">Example</a>
 </h6>

Modified: trunk/libs/spirit/doc/html/spirit/karma/reference/directive/buffer.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/karma/reference/directive/buffer.html (original)
+++ trunk/libs/spirit/doc/html/spirit/karma/reference/directive/buffer.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -35,7 +35,7 @@
<div></div>
</div>
<a name="spirit.karma.reference.directive.buffer.description"></a><h6>
-<a name="id544125"></a>
+<a name="id544426"></a>
 <a href="buffer.html#spirit.karma.reference.directive.buffer.description">Description</a>
 </h6>

@@ -50,7 +50,7 @@
 underlying stream only after the embedded generator succeeded.
 
<a name="spirit.karma.reference.directive.buffer.header"></a><h6>
-<a name="id544174"></a>
+<a name="id544475"></a>
 <a href="buffer.html#spirit.karma.reference.directive.buffer.header">Header</a>
 </h6>
<pre class="programlisting">// forwards to <boost/spirit/home/karma/directive/buffer.hpp>
@@ -60,7 +60,7 @@
 Also, see Include Structure.
 
<a name="spirit.karma.reference.directive.buffer.model_of"></a><h6>
-<a name="id544289"></a>
+<a name="id544589"></a>
 <a href="buffer.html#spirit.karma.reference.directive.buffer.model_of">Model
 of</a>
 </h6>
@@ -87,7 +87,7 @@
</dl>
</div>
<a name="spirit.karma.reference.directive.buffer.expression_semantics"></a><h6>
-<a name="id544406"></a>
+<a name="id544706"></a>
 <a href="buffer.html#spirit.karma.reference.directive.buffer.expression_semantics">Expression
 Semantics</a>
 </h6>
@@ -136,7 +136,7 @@
 </td></tr>
</table></div>
<a name="spirit.karma.reference.directive.buffer.attributes"></a><h6>
-<a name="id544657"></a>
+<a name="id544957"></a>
 <a href="buffer.html#spirit.karma.reference.directive.buffer.attributes">Attributes</a>
 </h6>
<div class="informaltable"><table class="table">
@@ -168,7 +168,7 @@
</tr></tbody>
</table></div>
<a name="spirit.karma.reference.directive.buffer.complexity"></a><h6>
-<a name="id544868"></a>
+<a name="id545169"></a>
 <a href="buffer.html#spirit.karma.reference.directive.buffer.complexity">Complexity</a>
 </h6>
<div class="blockquote"><blockquote class="blockquote">
@@ -183,7 +183,7 @@
 
</blockquote></div>
<a name="spirit.karma.reference.directive.buffer.example"></a><h6>
-<a name="id544909"></a>
+<a name="id545209"></a>
 <a href="buffer.html#spirit.karma.reference.directive.buffer.example">Example</a>
 </h6>

Modified: trunk/libs/spirit/doc/html/spirit/karma/reference/directive/delimit.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/karma/reference/directive/delimit.html (original)
+++ trunk/libs/spirit/doc/html/spirit/karma/reference/directive/delimit.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -35,7 +35,7 @@
<div></div>
</div>
<a name="spirit.karma.reference.directive.delimit.description"></a><h6>
-<a name="id536658"></a>
+<a name="id536954"></a>
 <a href="delimit.html#spirit.karma.reference.directive.delimit.description">Description</a>
 </h6>

@@ -44,7 +44,7 @@
 while the directive <tt class="computeroutput">delimit[]</tt> (re-)enable automatic delimiting.
 
<a name="spirit.karma.reference.directive.delimit.header"></a><h6>
-<a name="id536757"></a>
+<a name="id537053"></a>
 <a href="delimit.html#spirit.karma.reference.directive.delimit.header">Header</a>
 </h6>

@@ -65,7 +65,7 @@
 Also, see Include Structure.
 
<a name="spirit.karma.reference.directive.delimit.model_of"></a><h6>
-<a name="id536989"></a>
+<a name="id537285"></a>
 <a href="delimit.html#spirit.karma.reference.directive.delimit.model_of">Model
 of</a>
 </h6>
@@ -99,7 +99,7 @@
</dl>
</div>
<a name="spirit.karma.reference.directive.delimit.expression_semantics"></a><h6>
-<a name="id537163"></a>
+<a name="id537459"></a>
 <a href="delimit.html#spirit.karma.reference.directive.delimit.expression_semantics">Expression
 Semantics</a>
 </h6>
@@ -159,7 +159,7 @@
</tbody>
</table></div>
<a name="spirit.karma.reference.directive.delimit.attributes"></a><h6>
-<a name="id537496"></a>
+<a name="id537796"></a>
 <a href="delimit.html#spirit.karma.reference.directive.delimit.attributes">Attributes</a>
 </h6>
<div class="informaltable"><table class="table">
@@ -221,7 +221,7 @@
</tbody>
</table></div>
<a name="spirit.karma.reference.directive.delimit.complexity"></a><h6>
-<a name="id538079"></a>
+<a name="id538380"></a>
 <a href="delimit.html#spirit.karma.reference.directive.delimit.complexity">Complexity</a>
 </h6>
<div class="blockquote"><blockquote class="blockquote">
@@ -237,7 +237,7 @@
 
</blockquote></div>
<a name="spirit.karma.reference.directive.delimit.example"></a><h6>
-<a name="id538151"></a>
+<a name="id538452"></a>
 <a href="delimit.html#spirit.karma.reference.directive.delimit.example">Example</a>
 </h6>

Modified: trunk/libs/spirit/doc/html/spirit/karma/reference/directive/maxwidth.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/karma/reference/directive/maxwidth.html (original)
+++ trunk/libs/spirit/doc/html/spirit/karma/reference/directive/maxwidth.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -35,7 +35,7 @@
<div></div>
</div>
<a name="spirit.karma.reference.directive.maxwidth.description"></a><h6>
-<a name="id541852"></a>
+<a name="id542153"></a>
 <a href="maxwidth.html#spirit.karma.reference.directive.maxwidth.description">Description</a>
 </h6>

@@ -44,7 +44,7 @@
 generated by the embedded generator.
 
<a name="spirit.karma.reference.directive.maxwidth.header"></a><h6>
-<a name="id541899"></a>
+<a name="id542200"></a>
 <a href="maxwidth.html#spirit.karma.reference.directive.maxwidth.header">Header</a>
 </h6>
<pre class="programlisting">// forwards to <boost/spirit/home/karma/directive/maxwidth.hpp>
@@ -54,7 +54,7 @@
 Also, see Include Structure.
 
<a name="spirit.karma.reference.directive.maxwidth.model_of"></a><h6>
-<a name="id542014"></a>
+<a name="id542314"></a>
 <a href="maxwidth.html#spirit.karma.reference.directive.maxwidth.model_of">Model
 of</a>
 </h6>
@@ -86,7 +86,7 @@
</dl>
</div>
<a name="spirit.karma.reference.directive.maxwidth.expression_semantics"></a><h6>
-<a name="id542166"></a>
+<a name="id542466"></a>
 <a href="maxwidth.html#spirit.karma.reference.directive.maxwidth.expression_semantics">Expression
 Semantics</a>
 </h6>
@@ -163,7 +163,7 @@
</td></tr>
</table></div>
<a name="spirit.karma.reference.directive.maxwidth.attributes"></a><h6>
-<a name="id542554"></a>
+<a name="id542855"></a>
 <a href="maxwidth.html#spirit.karma.reference.directive.maxwidth.attributes">Attributes</a>
 </h6>
<div class="informaltable"><table class="table">
@@ -211,7 +211,7 @@
</tbody>
</table></div>
<a name="spirit.karma.reference.directive.maxwidth.complexity"></a><h6>
-<a name="id542944"></a>
+<a name="id543244"></a>
 <a href="maxwidth.html#spirit.karma.reference.directive.maxwidth.complexity">Complexity</a>
 </h6>
<div class="blockquote"><blockquote class="blockquote">
@@ -227,7 +227,7 @@
 
</blockquote></div>
<a name="spirit.karma.reference.directive.maxwidth.example"></a><h6>
-<a name="id543013"></a>
+<a name="id543314"></a>
 <a href="maxwidth.html#spirit.karma.reference.directive.maxwidth.example">Example</a>
 </h6>

Modified: trunk/libs/spirit/doc/html/spirit/karma/reference/directive/omit.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/karma/reference/directive/omit.html (original)
+++ trunk/libs/spirit/doc/html/spirit/karma/reference/directive/omit.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -34,7 +34,7 @@
<div></div>
</div>
<a name="spirit.karma.reference.directive.omit.description"></a><h6>
-<a name="id546272"></a>
+<a name="id546572"></a>
 <a href="omit.html#spirit.karma.reference.directive.omit.description">Description</a>
 </h6>

@@ -42,7 +42,7 @@
 any output.
 
<a name="spirit.karma.reference.directive.omit.header"></a><h6>
-<a name="id546302"></a>
+<a name="id546602"></a>
 <a href="omit.html#spirit.karma.reference.directive.omit.header">Header</a>
 </h6>
<pre class="programlisting">// forwards to <boost/spirit/home/karma/directive/omit.hpp>
@@ -52,7 +52,7 @@
 Also, see Include Structure.
 
<a name="spirit.karma.reference.directive.omit.model_of"></a><h6>
-<a name="id546416"></a>
+<a name="id546717"></a>
 <a href="omit.html#spirit.karma.reference.directive.omit.model_of">Model
 of</a>
 </h6>
@@ -79,7 +79,7 @@
</dl>
</div>
<a name="spirit.karma.reference.directive.omit.expression_semantics"></a><h6>
-<a name="id546533"></a>
+<a name="id546834"></a>
 <a href="omit.html#spirit.karma.reference.directive.omit.expression_semantics">Expression
 Semantics</a>
 </h6>
@@ -112,7 +112,7 @@
</tr></tbody>
</table></div>
<a name="spirit.karma.reference.directive.omit.attributes"></a><h6>
-<a name="id546690"></a>
+<a name="id546990"></a>
 <a href="omit.html#spirit.karma.reference.directive.omit.attributes">Attributes</a>
 </h6>
<div class="informaltable"><table class="table">
@@ -144,7 +144,7 @@
</tr></tbody>
</table></div>
<a name="spirit.karma.reference.directive.omit.complexity"></a><h6>
-<a name="id546900"></a>
+<a name="id547201"></a>
 <a href="omit.html#spirit.karma.reference.directive.omit.complexity">Complexity</a>
 </h6>
<div class="blockquote"><blockquote class="blockquote">
@@ -158,7 +158,7 @@
 
</blockquote></div>
<a name="spirit.karma.reference.directive.omit.example"></a><h6>
-<a name="id546951"></a>
+<a name="id547251"></a>
 <a href="omit.html#spirit.karma.reference.directive.omit.example">Example</a>
 </h6>

Modified: trunk/libs/spirit/doc/html/spirit/karma/reference/directive/repeat.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/karma/reference/directive/repeat.html (original)
+++ trunk/libs/spirit/doc/html/spirit/karma/reference/directive/repeat.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -35,7 +35,7 @@
<div></div>
</div>
<a name="spirit.karma.reference.directive.repeat.description"></a><h6>
-<a name="id533296"></a>
+<a name="id533592"></a>
 <a href="repeat.html#spirit.karma.reference.directive.repeat.description">Description</a>
 </h6>

@@ -43,7 +43,7 @@
 while optionally specifying the lower and upper repetition counts.
 
<a name="spirit.karma.reference.directive.repeat.header"></a><h6>
-<a name="id533328"></a>
+<a name="id533624"></a>
 <a href="repeat.html#spirit.karma.reference.directive.repeat.header">Header</a>
 </h6>
<pre class="programlisting">// forwards to <boost/spirit/home/karma/directive/repeat.hpp>
@@ -53,7 +53,7 @@
 Also, see Include Structure.
 
<a name="spirit.karma.reference.directive.repeat.model_of"></a><h6>
-<a name="id533441"></a>
+<a name="id533737"></a>
 <a href="repeat.html#spirit.karma.reference.directive.repeat.model_of">Model
 of</a>
 </h6>
@@ -85,7 +85,7 @@
</dl>
</div>
<a name="spirit.karma.reference.directive.repeat.expression_semantics"></a><h6>
-<a name="id533606"></a>
+<a name="id533901"></a>
 <a href="repeat.html#spirit.karma.reference.directive.repeat.expression_semantics">Expression
 Semantics</a>
 </h6>
@@ -171,7 +171,7 @@
</tbody>
</table></div>
<a name="spirit.karma.reference.directive.repeat.attributes"></a><h6>
-<a name="id534183"></a>
+<a name="id534479"></a>
 <a href="repeat.html#spirit.karma.reference.directive.repeat.attributes">Attributes</a>
 </h6>
<div class="informaltable"><table class="table">
@@ -264,7 +264,7 @@
</td></tr>
</table></div>
<a name="spirit.karma.reference.directive.repeat.complexity"></a><h6>
-<a name="id535140"></a>
+<a name="id535436"></a>
 <a href="repeat.html#spirit.karma.reference.directive.repeat.complexity">Complexity</a>
 </h6>
<div class="blockquote"><blockquote class="blockquote">
@@ -279,7 +279,7 @@
 
</blockquote></div>
<a name="spirit.karma.reference.directive.repeat.example"></a><h6>
-<a name="id535180"></a>
+<a name="id535476"></a>
 <a href="repeat.html#spirit.karma.reference.directive.repeat.example">Example</a>
 </h6>

Modified: trunk/libs/spirit/doc/html/spirit/karma/reference/directive/upperlower.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/karma/reference/directive/upperlower.html (original)
+++ trunk/libs/spirit/doc/html/spirit/karma/reference/directive/upperlower.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -35,7 +35,7 @@
<div></div>
</div>
<a name="spirit.karma.reference.directive.upperlower.description"></a><h6>
-<a name="id539518"></a>
+<a name="id539818"></a>
 <a href="upperlower.html#spirit.karma.reference.directive.upperlower.description">Description</a>
 </h6>

@@ -45,7 +45,7 @@
 Encoding Namespace</a>).
 
<a name="spirit.karma.reference.directive.upperlower.header"></a><h6>
-<a name="id539623"></a>
+<a name="id539924"></a>
 <a href="upperlower.html#spirit.karma.reference.directive.upperlower.header">Header</a>
 </h6>
<pre class="programlisting">// forwards to <boost/spirit/home/karma/directive/upper_lower_case.hpp>
@@ -55,7 +55,7 @@
 Also, see Include Structure.
 
<a name="spirit.karma.reference.directive.upperlower.model_of"></a><h6>
-<a name="id539737"></a>
+<a name="id540038"></a>
 <a href="upperlower.html#spirit.karma.reference.directive.upperlower.model_of">Model
 of</a>
 </h6>
@@ -87,7 +87,7 @@
</dl>
</div>
<a name="spirit.karma.reference.directive.upperlower.expression_semantics"></a><h6>
-<a name="id539889"></a>
+<a name="id540190"></a>
 <a href="upperlower.html#spirit.karma.reference.directive.upperlower.expression_semantics">Expression
 Semantics</a>
 </h6>
@@ -157,7 +157,7 @@
</td></tr>
</table></div>
<a name="spirit.karma.reference.directive.upperlower.attributes"></a><h6>
-<a name="id540271"></a>
+<a name="id540572"></a>
 <a href="upperlower.html#spirit.karma.reference.directive.upperlower.attributes">Attributes</a>
 </h6>
<div class="informaltable"><table class="table">
@@ -205,7 +205,7 @@
</tbody>
</table></div>
<a name="spirit.karma.reference.directive.upperlower.complexity"></a><h6>
-<a name="id540690"></a>
+<a name="id540991"></a>
 <a href="upperlower.html#spirit.karma.reference.directive.upperlower.complexity">Complexity</a>
 </h6>
<div class="blockquote"><blockquote class="blockquote">
@@ -222,7 +222,7 @@
 
</blockquote></div>
<a name="spirit.karma.reference.directive.upperlower.example"></a><h6>
-<a name="id540781"></a>
+<a name="id541082"></a>
 <a href="upperlower.html#spirit.karma.reference.directive.upperlower.example">Example</a>
 </h6>

Modified: trunk/libs/spirit/doc/html/spirit/karma/reference/generator_concepts.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/karma/reference/generator_concepts.html (original)
+++ trunk/libs/spirit/doc/html/spirit/karma/reference/generator_concepts.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -8,7 +8,7 @@
<link rel="home" href="../../../index.html" title="Spirit 2.1">
<link rel="up" href="../reference.html" title="Reference">
<link rel="previous" href="../reference.html" title="Reference">
-<link rel="next" href="generator_concepts/generator.html" title="Generator">
+<link rel="next" href="karma_basics.html" title=" Basics">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
@@ -21,7 +21,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../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="generator_concepts/generator.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+<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="karma_basics.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage">
@@ -33,11 +33,11 @@
<div></div>
</div>
<div class="toc"><dl>
-<dt>Generator</dt>
-<dt>PrimitiveGenerator</dt>
-<dt>UnaryGenerator</dt>
-<dt>BinaryGenerator</dt>
-<dt>NaryGenerator</dt>
+<dt>Generator</dt>
+<dt>PrimitiveGenerator</dt>
+<dt>UnaryGenerator</dt>
+<dt>BinaryGenerator</dt>
+<dt>NaryGenerator</dt>
</dl></div>

 Spirit.Karma generators fall into a couple of generalized
@@ -50,6 +50,860 @@

 The following sections provide details on these concepts.
 
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.karma.reference.generator_concepts.generator"></a>Generator
+</h5></div></div>
+<div></div>
+</div>
+<a name="spirit.karma.reference.generator_concepts.generator.description"></a><h6>
+<a name="id492787"></a>
+ Description
+ </h6>
+
+ The Generator is the most fundamental concept. A
+ Generator has a member function, <tt class="computeroutput">generate</tt>,
+ that accepts an <tt class="computeroutput">OutputIterator</tt>
+ and returns bool as its result. The iterator receives the data being
+ generated. The Generator's <tt class="computeroutput">generate</tt>
+ member function returns <tt class="computeroutput">true</tt>
+ if the generator succeeds. Each Generator can represent a specific pattern
+ or algorithm, or it can be a more complex generator formed as a composition
+ of other Generator's.
+ 
+<div class="variablelist">
+Notation
+<dl>
+<dt><tt class="computeroutput">g</tt></dt>
+<dd>
+ A <tt class="computeroutput">Generator</tt>.
+ </dd>
+<dt><tt class="computeroutput">G</tt></dt>
+<dd>
+ A <tt class="computeroutput">Generator</tt> type.
+ </dd>
+<dt><tt class="computeroutput">OutIter</tt></dt>
+<dd>
+ An <tt class="computeroutput">OutputIterator</tt>
+ type.
+ </dd>
+<dt><tt class="computeroutput">sink</tt></dt>
+<dd>
+ An <tt class="computeroutput">OutputIterator</tt>
+ instance.
+ </dd>
+<dt><tt class="computeroutput">Context</tt></dt>
+<dd>
+ The generator's Context type.
+ </dd>
+<dt><tt class="computeroutput">context</tt></dt>
+<dd>
+ The generator's Context, or <tt class="computeroutput">unused</tt>.
+ </dd>
+<dt><tt class="computeroutput">delimit</tt></dt>
+<dd>
+ A delimiter Generator, or <tt class="computeroutput">unused</tt>.
+ </dd>
+<dt><tt class="computeroutput">attrib</tt></dt>
+<dd>
+ A Compatible Attributes, or <tt class="computeroutput">unused</tt>.
+ </dd>
+</dl>
+</div>
+<a name="spirit.karma.reference.generator_concepts.generator.valid_expressions"></a><h6>
+<a name="id493155"></a>
+ <a href="generator_concepts.html#spirit.karma.reference.generator_concepts.generator.valid_expressions">Valid
+ Expressions</a>
+ </h6>
+
+ In the expressions below, the behavior of the generator, <tt class="computeroutput">g</tt>, as well as how <tt class="computeroutput">delimit</tt>
+ and <tt class="computeroutput">attrib</tt> are handled
+ by <tt class="computeroutput">g</tt>, are left unspecified
+ in the base <tt class="computeroutput">Generator</tt>
+ concept. These are specified in subsequent, more refined concepts and
+ by the actual models therof.
+ 
+
+ For any Generator the following expressions must be valid:
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Semantics
+ </th>
+<th>
+ Return type
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">g.generate(sink, context, delimit, attr)</pre>
+
+ 
+</td>
+<td>
+ Generate the output sequence by inserting the generated characters/tokens
+ into <tt class="computeroutput">sink</tt>. Use
+ the <tt class="computeroutput">delimit</tt> generator
+ for delimiting. Return <tt class="computeroutput">true</tt>
+ if successful, otherwise return <tt class="computeroutput">false</tt>.
+ </td>
+<td>
+ <tt class="computeroutput">bool</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">g.what(context)</tt>
+ </td>
+<td>
+ Get information about a Generator.
+ </td>
+<td>
+ <tt class="computeroutput">info</tt>
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="spirit.karma.reference.generator_concepts.generator.type_expressions"></a><h6>
+<a name="id493523"></a>
+ <a href="generator_concepts.html#spirit.karma.reference.generator_concepts.generator.type_expressions">Type
+ Expressions</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Description
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <tt class="computeroutput">G::template attribute<Context>::type</tt>
+ </td>
+<td>
+ The Generator's attribute.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">traits::is_generator<G>::type</tt>
+ </td>
+<td>
+ Metafunction that evaluates to <tt class="computeroutput">mpl::true_</tt>
+ if a certain type, <tt class="computeroutput">G</tt>
+ is a Generator, <tt class="computeroutput">mpl::false_</tt>
+ otherwise (See <a href="../../../../../../../libs/mpl/doc/refmanual/integral-constant.html" target="_top">MPL
+ Boolean Constant</a>).
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">G::properties</tt>
+ </td>
+<td>
+ A <tt class="computeroutput">mpl::int_</tt> (See <a href="../../../../../../../libs/mpl/doc/refmanual/integral-constant.html" target="_top">MPL
+ Integral Constant</a>) holding a value from the <tt class="computeroutput">karma::generator_properties</tt> enumeration.
+ The default value is <tt class="computeroutput">generator_properties::no_properties</tt>
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="spirit.karma.reference.generator_concepts.generator.postcondition"></a><h6>
+<a name="id493889"></a>
+ Postcondition
+ </h6>
+
+ Upon return from <tt class="computeroutput">g.generate</tt> the following post conditions
+ should hold:
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ On successful generation, <tt class="computeroutput">sink</tt>
+ receives the generated characters/tokens sequence.
+ </li>
+<li>
+ No pre-delimits: <tt class="computeroutput">delimit</tt>
+ characters/tokens will not be emitted in front of any other output.
+ </li>
+<li>
+ The attribute <tt class="computeroutput">attrib</tt>
+ has not been modified.
+ </li>
+</ul></div>
+<a name="spirit.karma.reference.generator_concepts.generator.models"></a><h6>
+<a name="id493996"></a>
+ Models
+ </h6>
+
+ All generators in Spirit.Karma are models of the
+ Generator concept.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.karma.reference.generator_concepts.primitivegenerator"></a>PrimitiveGenerator
+</h5></div></div>
+<div></div>
+</div>
+<a name="spirit.karma.reference.generator_concepts.primitivegenerator.description"></a><h6>
+<a name="id494057"></a>
+ Description
+ </h6>
+
+ PrimitiveGenerator is the most basic building block
+ that the client uses to build more complex generators.
+ 
+<a name="spirit.karma.reference.generator_concepts.primitivegenerator.refinement_of"></a><h6>
+<a name="id494092"></a>
+ <a href="generator_concepts.html#spirit.karma.reference.generator_concepts.primitivegenerator.refinement_of">Refinement
+ of</a>
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ Generator
+ 
+
+ 
+</blockquote></div>
+<a name="spirit.karma.reference.generator_concepts.primitivegenerator.post_delimit"></a><h6>
+<a name="id494149"></a>
+ Post-delimit
+ </h6>
+
+ Before exiting the <tt class="computeroutput">generate</tt>
+ member function, a PrimitiveGenerator is required to do a post-delimit.
+ This will generate a single delimiting character/token sequence. Only
+ PrimitiveGenerator's are required to perform this post-delimit. This
+ is typically carried out through a call to <tt class="computeroutput">karma::delimit_out</tt>:
+ 
+<pre class="programlisting">karma::delimit_out(sink, delimit);
+</pre>
+<a name="spirit.karma.reference.generator_concepts.primitivegenerator.type_expressions"></a><h6>
+<a name="id494267"></a>
+ <a href="generator_concepts.html#spirit.karma.reference.generator_concepts.primitivegenerator.type_expressions">Type
+ Expressions</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Description
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ <tt class="computeroutput">traits::is_primitive_generator<G>::type</tt>
+ </td>
+<td>
+ Metafunction that evaluates to <tt class="computeroutput">mpl::true_</tt>
+ if a certain type, <tt class="computeroutput">G</tt>,
+ is a PrimitiveGenerator, <tt class="computeroutput">mpl::false_</tt>
+ otherwise (See <a href="../../../../../../../libs/mpl/doc/refmanual/integral-constant.html" target="_top">MPL
+ Boolean Constant</a>).
+ </td>
+</tr></tbody>
+</table></div>
+<a name="spirit.karma.reference.generator_concepts.primitivegenerator.models"></a><h6>
+<a name="id494456"></a>
+ Models
+ </h6>
+
+ The following generators conform to this model:
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+eol ,
+ </li>
+<li>
+eps,
+ </li>
+<li>
+Numeric generators,
+ </li>
+<li>
+<a href="char.html#spirit.karma.reference.char.char_generator" title=" Character
+ Generators">Character
+ generators</a>.
+ </li>
+</ul></div>
+
+ FIXME Add more links to PrimitiveGenerator
+ models here.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.karma.reference.generator_concepts.unarygenerator"></a>UnaryGenerator
+</h5></div></div>
+<div></div>
+</div>
+<a name="spirit.karma.reference.generator_concepts.unarygenerator.description"></a><h6>
+<a name="id494594"></a>
+ Description
+ </h6>
+
+ UnaryGenerator is a composite generator that has
+ a single subject. The UnaryGenerator may change the behavior of its subject
+ following the Delegate Design Pattern.
+ 
+<a name="spirit.karma.reference.generator_concepts.unarygenerator.refinement_of"></a><h6>
+<a name="id494630"></a>
+ <a href="generator_concepts.html#spirit.karma.reference.generator_concepts.unarygenerator.refinement_of">Refinement
+ of</a>
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ Generator
+ 
+
+ 
+</blockquote></div>
+<div class="variablelist">
+Notation
+<dl>
+<dt><tt class="computeroutput">g</tt></dt>
+<dd>
+ A UnaryGenerator.
+ </dd>
+<dt><tt class="computeroutput">G</tt></dt>
+<dd>
+ A UnaryGenerator type.
+ </dd>
+</dl>
+</div>
+<a name="spirit.karma.reference.generator_concepts.unarygenerator.valid_expressions"></a><h6>
+<a name="id494739"></a>
+ <a href="generator_concepts.html#spirit.karma.reference.generator_concepts.unarygenerator.valid_expressions">Valid
+ Expressions</a>
+ </h6>
+
+ In addition to the requirements defined in Generator, for any UnaryGenerator
+ the following must be met:
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Semantics
+ </th>
+<th>
+ Return type
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ <tt class="computeroutput">g.subject</tt>
+ </td>
+<td>
+ Subject generator.
+ </td>
+<td>
+ Generator
+ </td>
+</tr></tbody>
+</table></div>
+<a name="spirit.karma.reference.generator_concepts.unarygenerator.type_expressions"></a><h6>
+<a name="id494898"></a>
+ <a href="generator_concepts.html#spirit.karma.reference.generator_concepts.unarygenerator.type_expressions">Type
+ Expressions</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Description
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <tt class="computeroutput">G::subject_type</tt>
+ </td>
+<td>
+ The subject generator type.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">traits::is_unary_generator<G>::type</tt>
+ </td>
+<td>
+ Metafunction that evaluates to <tt class="computeroutput">mpl::true_</tt>
+ if a certain type, <tt class="computeroutput">G</tt>
+ is a UnaryGenerator, <tt class="computeroutput">mpl::false_</tt>
+ otherwise (See <a href="../../../../../../../libs/mpl/doc/refmanual/integral-constant.html" target="_top">MPL
+ Boolean Constant</a>).
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="spirit.karma.reference.generator_concepts.unarygenerator.invariants"></a><h6>
+<a name="id495124"></a>
+ Invariants
+ </h6>
+
+ For any UnaryGenerator, <tt class="computeroutput">G</tt>,
+ the following invariant always holds:
+ 
+<div class="itemizedlist"><ul type="disc"><li>
+<tt class="computeroutput">traits::is_generator<G::subject_type>::type</tt> evaluates to <tt class="computeroutput">mpl::true_</tt>
+</li></ul></div>
+<a name="spirit.karma.reference.generator_concepts.unarygenerator.models"></a><h6>
+<a name="id495247"></a>
+ Models
+ </h6>
+
+ The following generators conform to this model:
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+<a href="operator.html#spirit.karma.reference.operator.kleene" title=" Kleene Star
+ (unary operator*())">Kleene Star
+ (unary <tt class="computeroutput">*</tt>)</a>,
+ </li>
+<li>
+<a href="operator.html#spirit.karma.reference.operator.plus" title=" Plus (unary
+ operator+())">plus (unary <tt class="computeroutput">+</tt>)</a> operator,
+ </li>
+<li>
+<a href="operator.html#spirit.karma.reference.operator.optional" title=" Optional
+ (unary operator-())">optional (unary
+ <tt class="computeroutput">-</tt>)</a> operator,
+ </li>
+<li>
+<a href="operator.html#spirit.karma.reference.operator.and_predicate" title=" And
+ Predicate (unary operator&())">and predicate
+ (unary <tt class="computeroutput">&</tt>)</a> and
+ <a href="operator.html#spirit.karma.reference.operator.not_predicate" title=" Not
+ Predicate (unary operator!())">not predicate
+ (unary <tt class="computeroutput">!</tt>)</a> operators,
+ </li>
+<li>
+<a href="directive.html#spirit.karma.reference.directive.alignment" title=" Alignment
+ Directives (left_align[], center[], and right_align[])"><tt class="computeroutput">left_align</tt></a>, <a href="directive.html#spirit.karma.reference.directive.alignment" title=" Alignment
+ Directives (left_align[], center[], and right_align[])"><tt class="computeroutput">center</tt></a>, and <a href="directive.html#spirit.karma.reference.directive.alignment" title=" Alignment
+ Directives (left_align[], center[], and right_align[])"><tt class="computeroutput">right_align</tt></a> directives,
+ </li>
+<li>
+<a href="directive.html#spirit.karma.reference.directive.repeat" title=" Repetition
+ Directive (repeat[])"><tt class="computeroutput">repeat</tt></a> directive,
+ </li>
+<li>
+<a href="directive.html#spirit.karma.reference.directive.delimit" title=" Directives
+ Controlling Automatic Delimiting (verbatim[] and delimit[])"><tt class="computeroutput">verbatim[a]</tt></a>
+ directive,
+ </li>
+<li>
+<a href="directive.html#spirit.karma.reference.directive.delimit" title=" Directives
+ Controlling Automatic Delimiting (verbatim[] and delimit[])"><tt class="computeroutput">delimit</tt></a> directive,
+ </li>
+<li>
+<a href="directive.html#spirit.karma.reference.directive.upperlower" title=" Directives
+ Controlling Case Sensitivity (upper[] and lower[])"><tt class="computeroutput">lower</tt></a> and <a href="directive.html#spirit.karma.reference.directive.upperlower" title=" Directives
+ Controlling Case Sensitivity (upper[] and lower[])"><tt class="computeroutput">upper</tt></a> directives,
+ </li>
+<li>
+<a href="directive.html#spirit.karma.reference.directive.maxwidth" title=" Controlling
+ the Maximum Field Wield (maxwidth[])"><tt class="computeroutput">maxwidth</tt></a> directive,
+ </li>
+<li>
+<a href="directive.html#spirit.karma.reference.directive.buffer" title=" Temporary
+ Output Buffering (buffer[])"><tt class="computeroutput">buffer[a]</tt></a>
+ directive,
+ </li>
+<li>
+<a href="directive.html#spirit.karma.reference.directive.omit" title=" Consume Attribute
+ (omit[])"><tt class="computeroutput">omit[a]</tt></a>
+ directive.
+ </li>
+</ul></div>
+
+ FIXME Add more links to models of UnaryGenerator
+ concept
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.karma.reference.generator_concepts.binarygenerator"></a>BinaryGenerator
+</h5></div></div>
+<div></div>
+</div>
+<a name="spirit.karma.reference.generator_concepts.binarygenerator.description"></a><h6>
+<a name="id495702"></a>
+ Description
+ </h6>
+
+ BinaryGenerator is a composite parser that has a
+ two subjects, <tt class="computeroutput">left</tt> and
+ <tt class="computeroutput">right</tt>. The BinaryGenerator
+ allows its subjects to be treated in the same way as a single instance
+ of a Generator following the Composite
+ Design Pattern.
+ 
+<a name="spirit.karma.reference.generator_concepts.binarygenerator.refinement_of"></a><h6>
+<a name="id495782"></a>
+ <a href="generator_concepts.html#spirit.karma.reference.generator_concepts.binarygenerator.refinement_of">Refinement
+ of</a>
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ Generator
+ 
+
+ 
+</blockquote></div>
+<div class="variablelist">
+Notation
+<dl>
+<dt><tt class="computeroutput">g</tt></dt>
+<dd>
+ A BinaryGenerator.
+ </dd>
+<dt><tt class="computeroutput">G</tt></dt>
+<dd>
+ A BinaryGenerator type.
+ </dd>
+</dl>
+</div>
+<a name="spirit.karma.reference.generator_concepts.binarygenerator.valid_expressions"></a><h6>
+<a name="id495892"></a>
+ <a href="generator_concepts.html#spirit.karma.reference.generator_concepts.binarygenerator.valid_expressions">Valid
+ Expressions</a>
+ </h6>
+
+ In addition to the requirements defined in Generator, for any BinaryGenerator
+ the following must be met:
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Semantics
+ </th>
+<th>
+ Return type
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <tt class="computeroutput">g.left</tt>
+ </td>
+<td>
+ Left generator.
+ </td>
+<td>
+ Generator
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">g.right</tt>
+ </td>
+<td>
+ Right generator.
+ </td>
+<td>
+ Generator
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="spirit.karma.reference.generator_concepts.binarygenerator.type_expressions"></a><h6>
+<a name="id496114"></a>
+ <a href="generator_concepts.html#spirit.karma.reference.generator_concepts.binarygenerator.type_expressions">Type
+ Expressions</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Description
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <tt class="computeroutput">G::left_type</tt>
+ </td>
+<td>
+ The left parser type.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">G::right_type</tt>
+ </td>
+<td>
+ The right parser type.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">traits::is_binary_generator<G>::type</tt>
+ </td>
+<td>
+ Metafunction that evaluates to <tt class="computeroutput">mpl::true_</tt>
+ if a certain type, <tt class="computeroutput">G</tt>
+ is a BinaryGenerator, <tt class="computeroutput">mpl::false_</tt>
+ otherwise (See <a href="../../../../../../../libs/mpl/doc/refmanual/integral-constant.html" target="_top">MPL
+ Boolean Constant</a>).
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="spirit.karma.reference.generator_concepts.binarygenerator.invariants"></a><h6>
+<a name="id496379"></a>
+ Invariants
+ </h6>
+
+ For any BinaryGenerator, <tt class="computeroutput">G</tt>,
+ the following invariants always hold:
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+<tt class="computeroutput">traits::is_generator<G::left_type>::type</tt> evaluates to <tt class="computeroutput">mpl::true_</tt>
+</li>
+<li>
+<tt class="computeroutput">traits::is_generator<G::right_type>::type</tt> evaluates to <tt class="computeroutput">mpl::true_</tt>
+</li>
+</ul></div>
+<a name="spirit.karma.reference.generator_concepts.binarygenerator.models"></a><h6>
+<a name="id496580"></a>
+ Models
+ </h6>
+
+ The following generators conform to this model:
+ 
+<div class="itemizedlist"><ul type="disc"><li>
+list (%).
+ </li></ul></div>
+
+ FIXME Add more links to models of BinaryGenerator
+ concept
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.karma.reference.generator_concepts.narygenerator"></a>NaryGenerator
+</h5></div></div>
+<div></div>
+</div>
+<a name="spirit.karma.reference.generator_concepts.narygenerator.description"></a><h6>
+<a name="id496668"></a>
+ Description
+ </h6>
+
+ NaryGenerator is a composite generator that has
+ one or more subjects. The NaryGenerator allows its subjects to be treated
+ in the same way as a single instance of a Generator following the Composite
+ Design Pattern.
+ 
+<a name="spirit.karma.reference.generator_concepts.narygenerator.refinement_of"></a><h6>
+<a name="id496723"></a>
+ <a href="generator_concepts.html#spirit.karma.reference.generator_concepts.narygenerator.refinement_of">Refinement
+ of</a>
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ Generator
+ 
+
+ 
+</blockquote></div>
+<div class="variablelist">
+Notation
+<dl>
+<dt><tt class="computeroutput">g</tt></dt>
+<dd>
+ A NaryGenerator.
+ </dd>
+<dt><tt class="computeroutput">G</tt></dt>
+<dd>
+ A NaryGenerator type.
+ </dd>
+</dl>
+</div>
+<a name="spirit.karma.reference.generator_concepts.narygenerator.valid_expressions"></a><h6>
+<a name="id496833"></a>
+ <a href="generator_concepts.html#spirit.karma.reference.generator_concepts.narygenerator.valid_expressions">Valid
+ Expressions</a>
+ </h6>
+
+ In addition to the requirements defined in Generator, for any NaryGenerator
+ the following must be met:
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Semantics
+ </th>
+<th>
+ Return type
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ <tt class="computeroutput">g.elements</tt>
+ </td>
+<td>
+ The tuple of elements.
+ </td>
+<td>
+ A Fusion
+ Sequence of Generator types.
+ </td>
+</tr></tbody>
+</table></div>
+<a name="spirit.karma.reference.generator_concepts.narygenerator.type_expressions"></a><h6>
+<a name="id497001"></a>
+ <a href="generator_concepts.html#spirit.karma.reference.generator_concepts.narygenerator.type_expressions">Type
+ Expressions</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Description
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <tt class="computeroutput">g.elements_type</tt>
+ </td>
+<td>
+ Elements tuple type.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">traits::is_nary_generator<G>::type</tt>
+ </td>
+<td>
+ Metafunction that evaluates to <tt class="computeroutput">mpl::true_</tt>
+ if a certain type, <tt class="computeroutput">G</tt>
+ is a NaryGenerator, <tt class="computeroutput">mpl::false_</tt>
+ otherwise (See <a href="../../../../../../../libs/mpl/doc/refmanual/integral-constant.html" target="_top">MPL
+ Boolean Constant</a>).
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="spirit.karma.reference.generator_concepts.narygenerator.invariants"></a><h6>
+<a name="id497227"></a>
+ Invariants
+ </h6>
+
+ For each element, <tt class="computeroutput">E</tt>,
+ in any NaryGenerator, <tt class="computeroutput">G</tt>,
+ the following invariant always holds:
+ 
+<div class="itemizedlist"><ul type="disc"><li>
+<tt class="computeroutput">traits::is_generator<E>::type</tt> evaluates to <tt class="computeroutput">mpl::true_</tt>
+</li></ul></div>
+<a name="spirit.karma.reference.generator_concepts.narygenerator.models"></a><h6>
+<a name="id497351"></a>
+ Models
+ </h6>
+
+ The following generators conform to this model:
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+<a href="operator.html#spirit.karma.reference.operator.sequence" title=" Sequences
+ (operator<<())">sequence (<tt class="computeroutput"><<</tt>)</a>,
+ </li>
+<li>
+<a href="operator.html#spirit.karma.reference.operator.alternative" title=" Alternatives
+ (operator|())">alternative
+ (<tt class="computeroutput">|</tt>)</a>.
+ </li>
+</ul></div>
+
+ FIXME Add more links to models of NaryGenerator
+ concept
+ 
+</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
@@ -62,7 +916,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../reference.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="generator_concepts/generator.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+<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="karma_basics.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>

Modified: trunk/libs/spirit/doc/html/spirit/karma/reference/generator_concepts/binarygenerator.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/karma/reference/generator_concepts/binarygenerator.html (original)
+++ trunk/libs/spirit/doc/html/spirit/karma/reference/generator_concepts/binarygenerator.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -31,7 +31,7 @@
<div></div>
</div>
<a name="spirit.karma.reference.generator_concepts.binarygenerator.description"></a><h6>
-<a name="id495391"></a>
+<a name="id495702"></a>
 <a href="binarygenerator.html#spirit.karma.reference.generator_concepts.binarygenerator.description">Description</a>
 </h6>

@@ -43,7 +43,7 @@
 Design Pattern.
 
<a name="spirit.karma.reference.generator_concepts.binarygenerator.refinement_of"></a><h6>
-<a name="id495471"></a>
+<a name="id495782"></a>
 <a href="binarygenerator.html#spirit.karma.reference.generator_concepts.binarygenerator.refinement_of">Refinement
 of</a>
 </h6>
@@ -70,7 +70,7 @@
</dl>
</div>
<a name="spirit.karma.reference.generator_concepts.binarygenerator.valid_expressions"></a><h6>
-<a name="id495581"></a>
+<a name="id495892"></a>
 <a href="binarygenerator.html#spirit.karma.reference.generator_concepts.binarygenerator.valid_expressions">Valid
 Expressions</a>
 </h6>
@@ -121,7 +121,7 @@
</tbody>
</table></div>
<a name="spirit.karma.reference.generator_concepts.binarygenerator.type_expressions"></a><h6>
-<a name="id495803"></a>
+<a name="id496114"></a>
 <a href="binarygenerator.html#spirit.karma.reference.generator_concepts.binarygenerator.type_expressions">Type
 Expressions</a>
 </h6>
@@ -170,7 +170,7 @@
</tbody>
</table></div>
<a name="spirit.karma.reference.generator_concepts.binarygenerator.invariants"></a><h6>
-<a name="id496068"></a>
+<a name="id496379"></a>
 <a href="binarygenerator.html#spirit.karma.reference.generator_concepts.binarygenerator.invariants">Invariants</a>
 </h6>

@@ -186,7 +186,7 @@
</li>
</ul></div>
<a name="spirit.karma.reference.generator_concepts.binarygenerator.models"></a><h6>
-<a name="id496269"></a>
+<a name="id496580"></a>
 <a href="binarygenerator.html#spirit.karma.reference.generator_concepts.binarygenerator.models">Models</a>
 </h6>

Modified: trunk/libs/spirit/doc/html/spirit/karma/reference/generator_concepts/generator.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/karma/reference/generator_concepts/generator.html (original)
+++ trunk/libs/spirit/doc/html/spirit/karma/reference/generator_concepts/generator.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -32,7 +32,7 @@
<div></div>
</div>
<a name="spirit.karma.reference.generator_concepts.generator.description"></a><h6>
-<a name="id492477"></a>
+<a name="id492787"></a>
 <a href="generator.html#spirit.karma.reference.generator_concepts.generator.description">Description</a>
 </h6>

@@ -86,7 +86,7 @@
</dl>
</div>
<a name="spirit.karma.reference.generator_concepts.generator.valid_expressions"></a><h6>
-<a name="id492844"></a>
+<a name="id493155"></a>
 <a href="generator.html#spirit.karma.reference.generator_concepts.generator.valid_expressions">Valid
 Expressions</a>
 </h6>
@@ -153,7 +153,7 @@
</tbody>
</table></div>
<a name="spirit.karma.reference.generator_concepts.generator.type_expressions"></a><h6>
-<a name="id493212"></a>
+<a name="id493523"></a>
 <a href="generator.html#spirit.karma.reference.generator_concepts.generator.type_expressions">Type
 Expressions</a>
 </h6>
@@ -204,7 +204,7 @@
</tbody>
</table></div>
<a name="spirit.karma.reference.generator_concepts.generator.postcondition"></a><h6>
-<a name="id493579"></a>
+<a name="id493889"></a>
 <a href="generator.html#spirit.karma.reference.generator_concepts.generator.postcondition">Postcondition</a>
 </h6>

@@ -226,7 +226,7 @@
 </li>
</ul></div>
<a name="spirit.karma.reference.generator_concepts.generator.models"></a><h6>
-<a name="id493685"></a>
+<a name="id493996"></a>
 <a href="generator.html#spirit.karma.reference.generator_concepts.generator.models">Models</a>
 </h6>

Modified: trunk/libs/spirit/doc/html/spirit/karma/reference/generator_concepts/narygenerator.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/karma/reference/generator_concepts/narygenerator.html (original)
+++ trunk/libs/spirit/doc/html/spirit/karma/reference/generator_concepts/narygenerator.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -31,7 +31,7 @@
<div></div>
</div>
<a name="spirit.karma.reference.generator_concepts.narygenerator.description"></a><h6>
-<a name="id496358"></a>
+<a name="id496668"></a>
 <a href="narygenerator.html#spirit.karma.reference.generator_concepts.narygenerator.description">Description</a>
 </h6>

@@ -41,7 +41,7 @@
 Design Pattern.
 
<a name="spirit.karma.reference.generator_concepts.narygenerator.refinement_of"></a><h6>
-<a name="id496412"></a>
+<a name="id496723"></a>
 <a href="narygenerator.html#spirit.karma.reference.generator_concepts.narygenerator.refinement_of">Refinement
 of</a>
 </h6>
@@ -68,7 +68,7 @@
</dl>
</div>
<a name="spirit.karma.reference.generator_concepts.narygenerator.valid_expressions"></a><h6>
-<a name="id496522"></a>
+<a name="id496833"></a>
 <a href="narygenerator.html#spirit.karma.reference.generator_concepts.narygenerator.valid_expressions">Valid
 Expressions</a>
 </h6>
@@ -107,7 +107,7 @@
</tr></tbody>
</table></div>
<a name="spirit.karma.reference.generator_concepts.narygenerator.type_expressions"></a><h6>
-<a name="id496690"></a>
+<a name="id497001"></a>
 <a href="narygenerator.html#spirit.karma.reference.generator_concepts.narygenerator.type_expressions">Type
 Expressions</a>
 </h6>
@@ -148,7 +148,7 @@
</tbody>
</table></div>
<a name="spirit.karma.reference.generator_concepts.narygenerator.invariants"></a><h6>
-<a name="id496916"></a>
+<a name="id497227"></a>
 <a href="narygenerator.html#spirit.karma.reference.generator_concepts.narygenerator.invariants">Invariants</a>
 </h6>

@@ -160,7 +160,7 @@
<tt class="computeroutput">traits::is_generator<E>::type</tt> evaluates to <tt class="computeroutput">mpl::true_</tt>
</li></ul></div>
<a name="spirit.karma.reference.generator_concepts.narygenerator.models"></a><h6>
-<a name="id497040"></a>
+<a name="id497351"></a>
 <a href="narygenerator.html#spirit.karma.reference.generator_concepts.narygenerator.models">Models</a>
 </h6>

Modified: trunk/libs/spirit/doc/html/spirit/karma/reference/generator_concepts/primitivegenerator.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/karma/reference/generator_concepts/primitivegenerator.html (original)
+++ trunk/libs/spirit/doc/html/spirit/karma/reference/generator_concepts/primitivegenerator.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -31,7 +31,7 @@
<div></div>
</div>
<a name="spirit.karma.reference.generator_concepts.primitivegenerator.description"></a><h6>
-<a name="id493746"></a>
+<a name="id494057"></a>
 <a href="primitivegenerator.html#spirit.karma.reference.generator_concepts.primitivegenerator.description">Description</a>
 </h6>

@@ -39,7 +39,7 @@
 that the client uses to build more complex generators.
 
<a name="spirit.karma.reference.generator_concepts.primitivegenerator.refinement_of"></a><h6>
-<a name="id493782"></a>
+<a name="id494092"></a>
 <a href="primitivegenerator.html#spirit.karma.reference.generator_concepts.primitivegenerator.refinement_of">Refinement
 of</a>
 </h6>
@@ -53,7 +53,7 @@
 
</blockquote></div>
<a name="spirit.karma.reference.generator_concepts.primitivegenerator.post_delimit"></a><h6>
-<a name="id493838"></a>
+<a name="id494149"></a>
 <a href="primitivegenerator.html#spirit.karma.reference.generator_concepts.primitivegenerator.post_delimit">Post-delimit</a>
 </h6>

@@ -66,7 +66,7 @@
<pre class="programlisting">karma::delimit_out(sink, delimit);
</pre>
<a name="spirit.karma.reference.generator_concepts.primitivegenerator.type_expressions"></a><h6>
-<a name="id493957"></a>
+<a name="id494267"></a>
 <a href="primitivegenerator.html#spirit.karma.reference.generator_concepts.primitivegenerator.type_expressions">Type
 Expressions</a>
 </h6>
@@ -97,7 +97,7 @@
</tr></tbody>
</table></div>
<a name="spirit.karma.reference.generator_concepts.primitivegenerator.models"></a><h6>
-<a name="id494145"></a>
+<a name="id494456"></a>
 <a href="primitivegenerator.html#spirit.karma.reference.generator_concepts.primitivegenerator.models">Models</a>
 </h6>

Modified: trunk/libs/spirit/doc/html/spirit/karma/reference/generator_concepts/unarygenerator.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/karma/reference/generator_concepts/unarygenerator.html (original)
+++ trunk/libs/spirit/doc/html/spirit/karma/reference/generator_concepts/unarygenerator.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -31,7 +31,7 @@
<div></div>
</div>
<a name="spirit.karma.reference.generator_concepts.unarygenerator.description"></a><h6>
-<a name="id494283"></a>
+<a name="id494594"></a>
 <a href="unarygenerator.html#spirit.karma.reference.generator_concepts.unarygenerator.description">Description</a>
 </h6>

@@ -40,7 +40,7 @@
 following the Delegate Design Pattern.
 
<a name="spirit.karma.reference.generator_concepts.unarygenerator.refinement_of"></a><h6>
-<a name="id494320"></a>
+<a name="id494630"></a>
 <a href="unarygenerator.html#spirit.karma.reference.generator_concepts.unarygenerator.refinement_of">Refinement
 of</a>
 </h6>
@@ -67,7 +67,7 @@
</dl>
</div>
<a name="spirit.karma.reference.generator_concepts.unarygenerator.valid_expressions"></a><h6>
-<a name="id494428"></a>
+<a name="id494739"></a>
 <a href="unarygenerator.html#spirit.karma.reference.generator_concepts.unarygenerator.valid_expressions">Valid
 Expressions</a>
 </h6>
@@ -105,7 +105,7 @@
</tr></tbody>
</table></div>
<a name="spirit.karma.reference.generator_concepts.unarygenerator.type_expressions"></a><h6>
-<a name="id494587"></a>
+<a name="id494898"></a>
 <a href="unarygenerator.html#spirit.karma.reference.generator_concepts.unarygenerator.type_expressions">Type
 Expressions</a>
 </h6>
@@ -146,7 +146,7 @@
</tbody>
</table></div>
<a name="spirit.karma.reference.generator_concepts.unarygenerator.invariants"></a><h6>
-<a name="id494813"></a>
+<a name="id495124"></a>
 <a href="unarygenerator.html#spirit.karma.reference.generator_concepts.unarygenerator.invariants">Invariants</a>
 </h6>

@@ -157,7 +157,7 @@
<tt class="computeroutput">traits::is_generator<G::subject_type>::type</tt> evaluates to <tt class="computeroutput">mpl::true_</tt>
</li></ul></div>
<a name="spirit.karma.reference.generator_concepts.unarygenerator.models"></a><h6>
-<a name="id494936"></a>
+<a name="id495247"></a>
 <a href="unarygenerator.html#spirit.karma.reference.generator_concepts.unarygenerator.models">Models</a>
 </h6>

Modified: trunk/libs/spirit/doc/html/spirit/karma/reference/karma_basics.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/karma/reference/karma_basics.html (original)
+++ trunk/libs/spirit/doc/html/spirit/karma/reference/karma_basics.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -6,7 +6,8 @@
<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
<link rel="home" href="../../../index.html" title="Spirit 2.1">
<link rel="up" href="../reference.html" title="Reference">
-<link rel="previous" href="generator_concepts/narygenerator.html" title="NaryGenerator">
+<link rel="previous" href="generator_concepts.html" title="Generator
+ Concepts">
<link rel="next" href="char.html" title=" Char">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@@ -20,7 +21,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="generator_concepts/narygenerator.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="char.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="generator_concepts.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="char.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage">
@@ -30,7 +31,7 @@
<div></div>
</div>
<a name="spirit.karma.reference.karma_basics.lazy_argument"></a><h5>
-<a name="id497152"></a>
+<a name="id497463"></a>
 <a href="karma_basics.html#spirit.karma.reference.karma_basics.lazy_argument">Lazy
 Argument</a>
 </h5>
@@ -56,7 +57,7 @@
 Actions</a>).
 
<a name="spirit.karma.reference.karma_basics.character_encoding_namespace"></a><h5>
-<a name="id497373"></a>
+<a name="id497684"></a>
 <a href="karma_basics.html#spirit.karma.reference.karma_basics.character_encoding_namespace">Character
 Encoding Namespace</a>
 </h5>
@@ -128,7 +129,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="generator_concepts/narygenerator.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="char.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="generator_concepts.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="char.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>

Modified: trunk/libs/spirit/doc/html/spirit/karma/reference/numeric.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/karma/reference/numeric.html (original)
+++ trunk/libs/spirit/doc/html/spirit/karma/reference/numeric.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -6,10 +6,8 @@
<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
<link rel="home" href="../../../index.html" title="Spirit 2.1">
<link rel="up" href="../reference.html" title="Reference">
-<link rel="previous" href="char/char_class.html" title=" Character
- Class Generators">
-<link rel="next" href="numeric/signed_int.html" title=" Signed
- Integer Number Generators">
+<link rel="previous" href="char.html" title=" Char">
+<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>
@@ -22,7 +20,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="char/char_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="numeric/signed_int.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+<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="directive.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage">
@@ -32,11 +30,11 @@
<div></div>
</div>
<div class="toc"><dl>
-<dt><a href="numeric/signed_int.html"> Signed
+<dt><a href="numeric.html#spirit.karma.reference.numeric.signed_int"> Signed
 Integer Number Generators</a></dt>
-<dt><a href="numeric/unsigned_int.html"> Unsigned
+<dt><a href="numeric.html#spirit.karma.reference.numeric.unsigned_int"> Unsigned
 Integer Number Generators</a></dt>
-<dt><a href="numeric/floating_point.html"> Floating
+<dt><a href="numeric.html#spirit.karma.reference.numeric.floating_point"> Floating
 Point Number Generators</a></dt>
</dl></div>

@@ -45,12 +43,2728 @@
 integer, and floating point number generators.
 
<a name="spirit.karma.reference.numeric.module_header"></a><h5>
-<a name="id506383"></a>
+<a name="id506694"></a>
 <a href="numeric.html#spirit.karma.reference.numeric.module_header">Module Header</a>
 </h5>
<pre class="programlisting">// forwards to <boost/spirit/home/karma/numeric.hpp>
#include <boost/spirit/include/karma_numeric.hpp>
</pre>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.karma.reference.numeric.signed_int"></a><a href="numeric.html#spirit.karma.reference.numeric.signed_int" title=" Signed
+ Integer Number Generators"> Signed
+ Integer Number Generators</a>
+</h5></div></div>
+<div></div>
+</div>
+<a name="spirit.karma.reference.numeric.signed_int.description"></a><h6>
+<a name="id506811"></a>
+ Description
+ </h6>
+
+ The signed integer number generators described in this section are:
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Attribute
+ </th>
+<th>
+ Description
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <tt class="computeroutput">lit(num)</tt>
+ </td>
+<td>
+ <tt class="computeroutput">Unused</tt>
+ </td>
+<td>
+ Generates <tt class="computeroutput">num</tt>,
+ where <tt class="computeroutput">num</tt> can
+ be a <tt class="computeroutput">short</tt>, <tt class="computeroutput">int</tt>, <tt class="computeroutput">long</tt>,
+ or <tt class="computeroutput">long long</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">short_</tt>
+ </td>
+<td>
+ <tt class="computeroutput">short</tt>
+ </td>
+<td>
+ Generate a <tt class="computeroutput">short int</tt> as given by the mandatory
+ attribute
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">short_(num)</tt>
+ </td>
+<td>
+ <tt class="computeroutput">short</tt>
+ </td>
+<td>
+ Generate <tt class="computeroutput">num</tt>
+ as a <tt class="computeroutput">short int</tt>,
+ if an attribute is supplied it must match
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">int_</tt>
+ </td>
+<td>
+ <tt class="computeroutput">int</tt>
+ </td>
+<td>
+ Generate an <tt class="computeroutput">int</tt>
+ as given by the mandatory attribute
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">int_(num)</tt>
+ </td>
+<td>
+ <tt class="computeroutput">int</tt>
+ </td>
+<td>
+ Generate <tt class="computeroutput">num</tt>
+ as an <tt class="computeroutput">int</tt>, if an
+ attribute is supplied it must match
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">long_</tt>
+ </td>
+<td>
+ <tt class="computeroutput">long</tt>
+ </td>
+<td>
+ Generate a <tt class="computeroutput">long int</tt> as given by the mandatory
+ attribute
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">long_(num)</tt>
+ </td>
+<td>
+ <tt class="computeroutput">long</tt>
+ </td>
+<td>
+ Generate <tt class="computeroutput">num</tt>
+ as <tt class="computeroutput">long int</tt>,
+ if an attribute is supplied it must match
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">long_long</tt>
+ </td>
+<td>
+ <tt class="computeroutput">long long</tt>
+ </td>
+<td>
+ Generate a <tt class="computeroutput">long long</tt> as given by the mandatory
+ attribute
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">long_long(num)</tt>
+ </td>
+<td>
+ <tt class="computeroutput">long long</tt>
+ </td>
+<td>
+ Generate <tt class="computeroutput">num</tt>
+ as an <tt class="computeroutput">long long</tt>,
+ if an attribute is supplied it must match
+ </td>
+</tr>
+<tr>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">int_generator<
+ Num, Radix, force_sign
+>()</pre>
+
+ 
+</td>
+<td>
+ <tt class="computeroutput">Num</tt>
+ </td>
+<td>
+ Generate a <tt class="computeroutput">Num</tt>
+ </td>
+</tr>
+<tr>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">int_generator<
+ Num, Radix, force_sign
+>()(num)</pre>
+
+ 
+</td>
+<td>
+ <tt class="computeroutput">Num</tt>
+ </td>
+<td>
+ Generate <tt class="computeroutput">num</tt>
+ as a <tt class="computeroutput">Num</tt>, if
+ an attribute is supplied it must match
+ </td>
+</tr>
+</tbody>
+</table></div>
+
+ These can be used to flexibly format any integer number of any compatible
+ type (for more information about the requirements, see below).
+ 
+
+ The interger number generators are very fast. For measurement results
+ comparing the Spirit.Karma integer number generators
+ with equivalent constructs provided by other libraries see the section
+ <a href="../performance_measurements/numeric_performance.html#spirit.karma.performance_measurements.numeric_performance.int_performance" title="
+ Comparing the performance of a single int_ generator">Performance
+ of Numeric Generators</a>
+ 
+<a name="spirit.karma.reference.numeric.signed_int.header"></a><h6>
+<a name="id507913"></a>
+ Header
+ </h6>
+<pre class="programlisting">// forwards to <boost/spirit/home/karma/numeric/int.hpp>
+#include <boost/spirit/include/karma_int.hpp>
+</pre>
+
+ Also, see Include Structure.
+ 
+<a name="spirit.karma.reference.numeric.signed_int.model_of"></a><h6>
+<a name="id508027"></a>
+ <a href="numeric.html#spirit.karma.reference.numeric.signed_int.model_of">Model
+ of</a>
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ PrimitiveGenerator
+ 
+
+ 
+</blockquote></div>
+<div class="variablelist">
+Notation
+<dl>
+<dt><tt class="computeroutput">num</tt></dt>
+<dd>
+ Numeric literal, any signed integer value, or a <a href="karma_basics.html#spirit.karma.reference.karma_basics.lazy_argument">Lazy
+ Argument</a> that evaluates to a signed integer value of type
+ <tt class="computeroutput">Num</tt>
+ </dd>
+<dt><tt class="computeroutput">Num</tt></dt>
+<dd>
+ Type of <tt class="computeroutput">num</tt>: any
+ signed integer type
+ </dd>
+</dl>
+</div>
+<a name="spirit.karma.reference.numeric.signed_int.expression_semantics"></a><h6>
+<a name="id508167"></a>
+ <a href="numeric.html#spirit.karma.reference.numeric.signed_int.expression_semantics">Expression
+ Semantics</a>
+ </h6>
+
+ Semantics of an expression is defined only where it differs from, or
+ is not defined in PrimitiveGenerator.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Semantics
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <tt class="computeroutput">lit(num)</tt>
+ </td>
+<td>
+ Generate the integer literal <tt class="computeroutput">num</tt>
+ using the default formatting (radix is 10, sign is only printed
+ for negative literals). This generator never fails (except if
+ the underlying output stream reports an error).
+ </td>
+</tr>
+<tr>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">short_
+int_
+long_
+long_long</pre>
+
+ 
+</td>
+<td>
+ Generate the integer provided by a mandatory attribute using
+ the default formatting (radix is 10, sign is only printed for
+ negative literals). This generator never fails (except if the
+ underlying output stream reports an error).
+ </td>
+</tr>
+<tr>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">short_(num)
+int_(num)
+long_(num)
+long_long(num)</pre>
+
+ 
+</td>
+<td>
+ Generate the integer provided by the immediate literal value
+ the generator is initialized from using the default formatting
+ (radix is 10, sign is only printed for negative literals). If
+ this generator has an associated attribute it succeeds only as
+ long as the attribute is equal to the immediate literal (except
+ if the underlying output stream reports an error). Otherwise
+ this generator fails and does not generate any output.
+ </td>
+</tr>
+</tbody>
+</table></div>
+
+ All generators listed in the table above (except <tt class="computeroutput">lit(num)</tt>) are predefined specializations of the
+ <tt class="computeroutput">int_generator<Num, Radix, force_sign></tt>
+ basic integer number generator type described below. It is possible to
+ directly use this type to create integer generators using a wide range
+ of formatting options.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Semantics
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">int_generator<
+ Num, Radix, force_sign
+>()</pre>
+
+ 
+</td>
+<td>
+ Generate the integer of type <tt class="computeroutput">Num</tt>
+ provided by a mandatory attribute using the specified <tt class="computeroutput">Radix</tt> (possible values are
+ <tt class="computeroutput">2</tt>, <tt class="computeroutput">8</tt>, <tt class="computeroutput">10</tt>,
+ and <tt class="computeroutput">16</tt>, the default
+ value is <tt class="computeroutput">10</tt>). If
+ <tt class="computeroutput">force_sign</tt> is
+ <tt class="computeroutput">false</tt> (the default),
+ a sign is only printed for negative literals. If <tt class="computeroutput">force_sign</tt> is <tt class="computeroutput">true</tt>, all numbers will be printed
+ using a sign, i.e. <tt class="computeroutput">'-'</tt>
+ for negative numbers, <tt class="computeroutput">'+'</tt>
+ for positive numbers, and <tt class="computeroutput">' '</tt>
+ for zeros. This generator never fails (except if the underlying
+ output stream reports an error).
+ </td>
+</tr>
+<tr>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">int_generator<
+ Num, Radix, force_sign
+>()(num)</pre>
+
+ 
+</td>
+<td>
+ Generate the integer of type <tt class="computeroutput">Num</tt>
+ provided by the immediate literal value the generator is initialized
+ from, using the specified <tt class="computeroutput">Radix</tt>
+ (possible values are <tt class="computeroutput">2</tt>,
+ <tt class="computeroutput">8</tt>, <tt class="computeroutput">10</tt>, and <tt class="computeroutput">16</tt>,
+ the default value is <tt class="computeroutput">10</tt>).
+ If <tt class="computeroutput">force_sign</tt>
+ is <tt class="computeroutput">false</tt> (the default),
+ a sign is only printed for negative literals. If <tt class="computeroutput">force_sign</tt> is <tt class="computeroutput">true</tt>, all numbers will be printed
+ using a sign, i.e. <tt class="computeroutput">'-'</tt>
+ for negative numbers, <tt class="computeroutput">'+'</tt>
+ for positive numbers, and <tt class="computeroutput">' '</tt>
+ for zeros. If this generator has an associated attribute it succeeds
+ only as long as the attribute is equal to the immediate literal
+ (except if the underlying output stream reports an error). Otherwise
+ this generator fails and does not generate any output.
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="spirit.karma.reference.numeric.signed_int.additional_requirements"></a><h6>
+<a name="id509099"></a>
+ <a href="numeric.html#spirit.karma.reference.numeric.signed_int.additional_requirements">Additional
+ Requirements</a>
+ </h6>
+
+ The following lists enumerate the requirements which must be met in order
+ to use a certain type <tt class="computeroutput">Num</tt>
+ to instantiate and use a <tt class="computeroutput">int_generator<Num, Radix, force_sign></tt>.
+ 
+
+ If <tt class="computeroutput">boost::is_integral<Num>::value</tt> is <tt class="computeroutput">true</tt>
+ the type <tt class="computeroutput">Num</tt> must have
+ defined:
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ comparison operators for: <tt class="computeroutput"><</tt>,
+ <tt class="computeroutput"><=</tt>, <tt class="computeroutput">==</tt>,
+ <tt class="computeroutput">!=</tt>, <tt class="computeroutput">></tt>,
+ and <tt class="computeroutput">>=</tt>
+</li>
+<li>
+ numeric operators for: <tt class="computeroutput">+</tt>,
+ <tt class="computeroutput">-</tt>, <tt class="computeroutput">/</tt>,
+ <tt class="computeroutput">*</tt>, <tt class="computeroutput">%</tt>,
+ and unary <tt class="computeroutput">-</tt>
+</li>
+</ul></div>
+
+ If <tt class="computeroutput">boost::is_integral<Num>::value</tt> is <tt class="computeroutput">false</tt>
+ the type <tt class="computeroutput">Num</tt> must have
+ defined:
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ comparison operators for: <tt class="computeroutput"><</tt>,
+ <tt class="computeroutput"><=</tt>, <tt class="computeroutput">==</tt>,
+ <tt class="computeroutput">!=</tt>, <tt class="computeroutput">></tt>,
+ and <tt class="computeroutput">>=</tt>
+</li>
+<li>
+ numeric operators for: <tt class="computeroutput">+</tt>,
+ <tt class="computeroutput">-</tt>, <tt class="computeroutput">/</tt>,
+ <tt class="computeroutput">*</tt>, <tt class="computeroutput">%</tt>,
+ and unary <tt class="computeroutput">-</tt>
+</li>
+<li>
+ helper functions implementing the interface and the semantics of:
+ <tt class="computeroutput">std::fmod</tt>, <tt class="computeroutput">std::fabs</tt>,
+ <tt class="computeroutput">std::pow</tt>, <tt class="computeroutput">std::lround</tt>,
+ <tt class="computeroutput">std::ltrunc</tt>, <tt class="computeroutput">std::floor</tt>,
+ and <tt class="computeroutput">std::ceil</tt>.
+ </li>
+</ul></div>
+<a name="spirit.karma.reference.numeric.signed_int.attributes"></a><h6>
+<a name="id509787"></a>
+ Attributes
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Attribute
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <tt class="computeroutput">lit(num)</tt>
+ </td>
+<td>
+ <tt class="computeroutput">unused</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">short_</tt>
+ </td>
+<td>
+ <tt class="computeroutput">short</tt>, attribute
+ is mandatory (otherwise compilation will fail)
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">short_(num)</tt>
+ </td>
+<td>
+ <tt class="computeroutput">short</tt>, attribute
+ is optional, if it is supplied, the generator compares the attribute
+ with <tt class="computeroutput">num</tt> and
+ succeeds only if both are equal, failing otherwise.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">int_</tt>
+ </td>
+<td>
+ <tt class="computeroutput">int</tt>, attribute is
+ mandatory (otherwise compilation will fail)
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">int_(num)</tt>
+ </td>
+<td>
+ <tt class="computeroutput">int</tt>, attribute is
+ optional, if it is supplied, the generator compares the attribute
+ with <tt class="computeroutput">num</tt> and
+ succeeds only if both are equal, failing otherwise.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">long_</tt>
+ </td>
+<td>
+ <tt class="computeroutput">long</tt>, attribute
+ is mandatory (otherwise compilation will fail)
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">long_(num)</tt>
+ </td>
+<td>
+ <tt class="computeroutput">long</tt>, attribute
+ is optional, if it is supplied, the generator compares the attribute
+ with <tt class="computeroutput">num</tt> and
+ succeeds only if both are equal, failing otherwise.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">long_long</tt>
+ </td>
+<td>
+ <tt class="computeroutput">long long</tt>,
+ attribute is mandatory (otherwise compilation will fail)
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">long_long(num)</tt>
+ </td>
+<td>
+ <tt class="computeroutput">long long</tt>,
+ attribute is optional, if it is supplied, the generator compares
+ the attribute with <tt class="computeroutput">num</tt>
+ and succeeds only if both are equal, failing otherwise.
+ </td>
+</tr>
+<tr>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">int_generator<
+ Num, Radix, force_sign
+>()</pre>
+
+ 
+</td>
+<td>
+ <tt class="computeroutput">Num</tt>, attribute
+ is mandatory (otherwise compilation will fail)
+ </td>
+</tr>
+<tr>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">int_generator<
+ Num, Radix, force_sign
+>()(num)</pre>
+
+ 
+</td>
+<td>
+ <tt class="computeroutput">Num</tt>, attribute
+ is optional, if it is supplied, the generator compares the attribute
+ with <tt class="computeroutput">num</tt> and
+ succeeds only if both are equal, failing otherwise.
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="spirit.karma.reference.numeric.signed_int.complexity"></a><h6>
+<a name="id510546"></a>
+ Complexity
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ O(N), where <tt class="computeroutput">N</tt> is
+ the number of digits needed to represent the generated integer number
+ 
+
+ 
+</blockquote></div>
+<a name="spirit.karma.reference.numeric.signed_int.example"></a><h6>
+<a name="id510595"></a>
+ Example
+ </h6>
+
+ Some includes:
+ 
+
+ 
+
+
+
+<pre class="programlisting">#include <boost/spirit/include/karma.hpp>
+#include <boost/spirit/include/phoenix_core.hpp>
+#include <boost/spirit/include/phoenix_operator.hpp>
+#include <boost/fusion/include/std_pair.hpp>
+#include <iostream>
+#include <string>
+</pre>
+
+ 
+
+ 
+
+ All code snippets below use these common test functions:
+ 
+
+ 
+
+
+
+<pre class="programlisting">template <typename G>
+void test_generator(char const* expected, G const& g)
+{
+ std::string s;
+ std::back_insert_iterator<std::string> out(s);
+ if (boost::spirit::karma::generate(out, g) && str == expected)
+ std::cout << "ok" << std::endl;
+ else
+ std::cout << "fail" << std::endl;
+}
+</pre>
+
+ 
+
+ 
+
+
+
+<pre class="programlisting">template <typename G, typename T>
+void test_generator_attr(char const* expected, G const& g, T const& attr)
+{
+ std::string s;
+ std::back_insert_iterator<std::string> out(s);
+ if (boost::spirit::karma::generate(out, g, attr) && str == expected)
+ std::cout << "ok" << std::endl;
+ else
+ std::cout << "fail" << std::endl;
+}
+</pre>
+
+ 
+
+ 
+
+ Some using declarations:
+ 
+
+ 
+
+
+
+<pre class="programlisting">using boost::spirit::karma::generate;
+using boost::spirit::karma::int_;
+</pre>
+
+ 
+
+ 
+
+ Basic usage of an <tt class="computeroutput">int_</tt>
+ generator:
+ 
+
+ 
+
+
+
+<pre class="programlisting">test_generator("-2", lit(-2));
+test_generator("-2", int_(-2));
+test_generator_attr("-2", int_(-2), -2);
+test_generator_attr("", int_(-2), 3); // fails (as -2 != 3)!
+test_generator_attr("-2", int_, -2);
+</pre>
+
+ 
+
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.karma.reference.numeric.unsigned_int"></a><a href="numeric.html#spirit.karma.reference.numeric.unsigned_int" title=" Unsigned
+ Integer Number Generators"> Unsigned
+ Integer Number Generators</a>
+</h5></div></div>
+<div></div>
+</div>
+<a name="spirit.karma.reference.numeric.unsigned_int.description"></a><h6>
+<a name="id512280"></a>
+ Description
+ </h6>
+
+ The signed integer number generators described in this section are:
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Attribute
+ </th>
+<th>
+ Description
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <tt class="computeroutput">lit(num)</tt>
+ </td>
+<td>
+ <tt class="computeroutput">unused</tt>
+ </td>
+<td>
+ Generates <tt class="computeroutput">num</tt>,
+ where <tt class="computeroutput">num</tt> can
+ be a <tt class="computeroutput">unsigned short</tt>,
+ <tt class="computeroutput">unsigned int</tt>,
+ <tt class="computeroutput">unsigned long</tt>,
+ or <tt class="computeroutput">unsigned long
+ long</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ushort</tt>
+ </td>
+<td>
+ <tt class="computeroutput">unsigned short</tt>
+ </td>
+<td>
+ Generate a short integer
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ushort(num)</tt>
+ </td>
+<td>
+ <tt class="computeroutput">unsigned short</tt>
+ </td>
+<td>
+ Generate <tt class="computeroutput">num</tt>
+ as a short integer, if an attribute is supplied it must match
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">uint</tt>
+ </td>
+<td>
+ <tt class="computeroutput">unsigned int</tt>
+ </td>
+<td>
+ Generate an int
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">uint(num)</tt>
+ </td>
+<td>
+ <tt class="computeroutput">unsigned int</tt>
+ </td>
+<td>
+ Generate <tt class="computeroutput">num</tt>
+ as an int, if an attribute is supplied it must match
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ulong</tt>
+ </td>
+<td>
+ <tt class="computeroutput">unsigned long</tt>
+ </td>
+<td>
+ Generate a long integer
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ulong(num)</tt>
+ </td>
+<td>
+ <tt class="computeroutput">unsigned long</tt>
+ </td>
+<td>
+ Generate <tt class="computeroutput">num</tt>
+ as long integer, if an attribute is supplied it must match
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ulong_long</tt>
+ </td>
+<td>
+ <tt class="computeroutput">unsigned long
+ long</tt>
+ </td>
+<td>
+ Generate a long long
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ulong_long(num)</tt>
+ </td>
+<td>
+ <tt class="computeroutput">unsigned long
+ long</tt>
+ </td>
+<td>
+ Generate <tt class="computeroutput">num</tt>
+ as an long long, if an attribute is supplied it must match
+ </td>
+</tr>
+<tr>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">uint_generator<
+ Num, Radix
+>()</pre>
+
+ 
+</td>
+<td>
+ <tt class="computeroutput">Num</tt>
+ </td>
+<td>
+ Generate an unsigned <tt class="computeroutput">Num</tt>
+ </td>
+</tr>
+<tr>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">uint_generator<
+ Num, Radix
+>()(num)</pre>
+
+ 
+</td>
+<td>
+ <tt class="computeroutput">Num</tt>
+ </td>
+<td>
+ Generate an unsigned <tt class="computeroutput">num</tt>
+ as a <tt class="computeroutput">Num</tt>, if
+ an attribute is supplied it must match
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">bin</tt>
+ </td>
+<td>
+ <tt class="computeroutput">unsigned int</tt>
+ </td>
+<td>
+ Generate an unsigned integer in binary (base 2) representation
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">bin(num)</tt>
+ </td>
+<td>
+ <tt class="computeroutput">unsigned int</tt>
+ </td>
+<td>
+ Generate <tt class="computeroutput">num</tt>
+ as an unsigned integer in binary (base 2) representation, if
+ an attribute is supplied it must match
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">oct</tt>
+ </td>
+<td>
+ <tt class="computeroutput">unsigned int</tt>
+ </td>
+<td>
+ Generate an unsigned integer in octal (base 8) representation
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">oct(num)</tt>
+ </td>
+<td>
+ <tt class="computeroutput">unsigned int</tt>
+ </td>
+<td>
+ Generate <tt class="computeroutput">num</tt>
+ as an unsigned integer in octal (base 8) representation, if an
+ attribute is supplied it must match
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">hex</tt>
+ </td>
+<td>
+ <tt class="computeroutput">unsigned int</tt>
+ </td>
+<td>
+ Generate an unsigned integer in hexadecimal (base 16) representation
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">hex(num)</tt>
+ </td>
+<td>
+ <tt class="computeroutput">unsigned int</tt>
+ </td>
+<td>
+ Generate <tt class="computeroutput">num</tt>
+ as an unsigned integer in hexadecimal (base 16) representation,
+ if an attribute is supplied it must match
+ </td>
+</tr>
+</tbody>
+</table></div>
+
+ These can be used to flexibly format any unsigned integer number of any
+ compatible type (for more information about the requirements, see below).
+ 
+
+ The interger number generators are very fast. For measurement results
+ comparing the Spirit.Karma integer number generators
+ with equivalent constructs provided by other libraries see the section
+ <a href="../performance_measurements/numeric_performance.html#spirit.karma.performance_measurements.numeric_performance.int_performance" title="
+ Comparing the performance of a single int_ generator">Performance
+ of Numeric Generators</a>
+ 
+<a name="spirit.karma.reference.numeric.unsigned_int.header"></a><h6>
+<a name="id513705"></a>
+ Header
+ </h6>
+<pre class="programlisting">// forwards to <boost/spirit/home/karma/numeric/uint.hpp>
+#include <boost/spirit/include/karma_uint.hpp>
+</pre>
+
+ Also, see Include Structure.
+ 
+<a name="spirit.karma.reference.numeric.unsigned_int.model_of"></a><h6>
+<a name="id513820"></a>
+ <a href="numeric.html#spirit.karma.reference.numeric.unsigned_int.model_of">Model
+ of</a>
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ PrimitiveGenerator
+ 
+
+ 
+</blockquote></div>
+<div class="variablelist">
+Notation
+<dl>
+<dt><tt class="computeroutput">num</tt></dt>
+<dd>
+ Numeric literal, any unsigned integer value, or a <a href="karma_basics.html#spirit.karma.reference.karma_basics.lazy_argument">Lazy
+ Argument</a> that evaluates to an unsigned integer value of type
+ <tt class="computeroutput">Num</tt>
+ </dd>
+<dt><tt class="computeroutput">Num</tt></dt>
+<dd>
+ Type of <tt class="computeroutput">num</tt>: any
+ unsigned integer type
+ </dd>
+</dl>
+</div>
+<a name="spirit.karma.reference.numeric.unsigned_int.expression_semantics"></a><h6>
+<a name="id513962"></a>
+ <a href="numeric.html#spirit.karma.reference.numeric.unsigned_int.expression_semantics">Expression
+ Semantics</a>
+ </h6>
+
+ Semantics of an expression is defined only where it differs from, or
+ is not defined in PrimitiveGenerator.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Semantics
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <tt class="computeroutput">lit(num)</tt>
+ </td>
+<td>
+ Generate the integer literal <tt class="computeroutput">num</tt>
+ using the default formatting (radix is 10, sign is only printed
+ for negative literals). This generator never fails (except if
+ the underlying output stream reports an error).
+ </td>
+</tr>
+<tr>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">ushort
+uint
+ulong
+ulong_long</pre>
+
+ 
+</td>
+<td>
+ Generate the unsigned integer provided by a mandatory attribute
+ using the default formatting (radix is 10). This generator never
+ fails (except if the underlying output stream reports an error).
+ </td>
+</tr>
+<tr>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">ushort(num)
+uint(num)
+ulong(num)
+ulong_long(num)</pre>
+
+ 
+</td>
+<td>
+ Generate the unsigned integer provided by the immediate literal
+ value the generator is initialized from using the default formatting
+ (radix is 10). If this generator has an associated attribute
+ it succeeds only as long as the attribute is equal to the immediate
+ literal (except if the underlying output stream reports an error).
+ Otherwise this generator fails and does not generate any output.
+ </td>
+</tr>
+<tr>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">bin
+oct
+hex</pre>
+
+ 
+</td>
+<td>
+ Generate the unsigned integer provided by a mandatory attribute
+ using the default formatting and the corresponding radix (<tt class="computeroutput">bin</tt>: radix is 2, <tt class="computeroutput">oct</tt>: radix is 8, <tt class="computeroutput">hex</tt>: radix is 16). This generator
+ never fails (except if the underlying output stream reports an
+ error).
+ </td>
+</tr>
+<tr>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">bin(num)
+oct(num)
+hex(num)</pre>
+
+ 
+</td>
+<td>
+ Generate the unsigned integer provided by the immediate literal
+ value the generator is initialized from using the default formatting
+ and the corresponding radix (<tt class="computeroutput">bin</tt>:
+ radix is 2, <tt class="computeroutput">oct</tt>:
+ radix is 8, <tt class="computeroutput">hex</tt>:
+ radix is 16). If this generator has an associated attribute it
+ succeeds only as long as the attribute is equal to the immediate
+ literal (except if the underlying output stream reports an error).
+ Otherwise this generator fails and does not generate any output.
+ </td>
+</tr>
+</tbody>
+</table></div>
+
+ All generators listed in the table above (except <tt class="computeroutput">lit(num)</tt>) are predefined specializations of the
+ <tt class="computeroutput">uint_generator<Num, Radix></tt>
+ basic unsigned integer number generator type described below. It is possible
+ to directly use this type to create unsigned integer generators using
+ a wide range of formatting options.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Semantics
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">uint_generator<
+ Num, Radix
+>()</pre>
+
+ 
+</td>
+<td>
+ Generate the unsigned integer of type <tt class="computeroutput">Num</tt>
+ provided by a mandatory attribute using the specified <tt class="computeroutput">Radix</tt> (possible values are
+ <tt class="computeroutput">2</tt>, <tt class="computeroutput">8</tt>, <tt class="computeroutput">10</tt>,
+ and <tt class="computeroutput">16</tt>, the default
+ value is <tt class="computeroutput">10</tt>).This
+ generator never fails (except if the underlying output stream
+ reports an error).
+ </td>
+</tr>
+<tr>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">uint_generator<
+ Num, Radix
+>()(num)</pre>
+
+ 
+</td>
+<td>
+ Generate the unsigned integer of type <tt class="computeroutput">Num</tt>
+ provided by the immediate literal value the generator is initialized
+ from, using the specified <tt class="computeroutput">Radix</tt>
+ (possible values are <tt class="computeroutput">2</tt>,
+ <tt class="computeroutput">8</tt>, <tt class="computeroutput">10</tt>, and <tt class="computeroutput">16</tt>,
+ the default value is <tt class="computeroutput">10</tt>).
+ If this generator has an associated attribute it succeeds only
+ as long as the attribute is equal to the immediate literal (except
+ if the underlying output stream reports an error). Otherwise
+ this generator fails and does not generate any output.
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="spirit.karma.reference.numeric.unsigned_int.additional_requirements"></a><h6>
+<a name="id514892"></a>
+ <a href="numeric.html#spirit.karma.reference.numeric.unsigned_int.additional_requirements">Additional
+ Requirements</a>
+ </h6>
+
+ The following lists enumerate the requirements which must be met in order
+ to use a certain type <tt class="computeroutput">Num</tt>
+ to instantiate and use a <tt class="computeroutput">uint_generator<Num, Radix></tt>.
+ 
+
+ If <tt class="computeroutput">boost::is_integral<Num>::value</tt> is <tt class="computeroutput">true</tt>
+ the type <tt class="computeroutput">Num</tt> must have
+ defined:
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ comparison operators for: <tt class="computeroutput"><</tt>,
+ <tt class="computeroutput"><=</tt>, <tt class="computeroutput">==</tt>,
+ <tt class="computeroutput">!=</tt>, <tt class="computeroutput">></tt>,
+ and <tt class="computeroutput">>=</tt>
+</li>
+<li>
+ numeric operators for: <tt class="computeroutput">+</tt>,
+ <tt class="computeroutput">-</tt>, <tt class="computeroutput">/</tt>,
+ <tt class="computeroutput">*</tt>, and <tt class="computeroutput">%</tt>
+</li>
+</ul></div>
+
+ If <tt class="computeroutput">boost::is_integral<Num>::value</tt> is <tt class="computeroutput">false</tt>
+ the type <tt class="computeroutput">Num</tt> must have
+ defined:
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ comparison operators for: <tt class="computeroutput"><</tt>,
+ <tt class="computeroutput"><=</tt>, <tt class="computeroutput">==</tt>,
+ <tt class="computeroutput">!=</tt>, <tt class="computeroutput">></tt>,
+ and <tt class="computeroutput">>=</tt>
+</li>
+<li>
+ numeric operators for: <tt class="computeroutput">+</tt>,
+ <tt class="computeroutput">-</tt>, <tt class="computeroutput">/</tt>,
+ <tt class="computeroutput">*</tt>, and <tt class="computeroutput">%</tt>
+</li>
+<li>
+ helper functions implementing the interface and the semantics of:
+ <tt class="computeroutput">std::fmod</tt>, <tt class="computeroutput">std::pow</tt>,
+ <tt class="computeroutput">std::lround</tt>, <tt class="computeroutput">std::ltrunc</tt>,
+ <tt class="computeroutput">std::floor</tt>, and <tt class="computeroutput">std::ceil</tt>.
+ </li>
+</ul></div>
+<a name="spirit.karma.reference.numeric.unsigned_int.attributes"></a><h6>
+<a name="id515523"></a>
+ Attributes
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Attribute
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <tt class="computeroutput">lit(num)</tt>
+ </td>
+<td>
+ <tt class="computeroutput">unused</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ushort</tt>
+ </td>
+<td>
+ <tt class="computeroutput">unsigned short</tt>,
+ attribute is mandatory (otherwise compilation will fail)
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ushort(num)</tt>
+ </td>
+<td>
+ <tt class="computeroutput">unsigned short</tt>,
+ attribute is optional, if it is supplied, the generator compares
+ the attribute with <tt class="computeroutput">num</tt>
+ and succeeds only if both are equal, failing otherwise.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">uint</tt>
+ </td>
+<td>
+ <tt class="computeroutput">unsigned int</tt>,
+ attribute is mandatory (otherwise compilation will fail)
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">uint(num)</tt>
+ </td>
+<td>
+ <tt class="computeroutput">unsigned int</tt>,
+ attribute is optional, if it is supplied, the generator compares
+ the attribute with <tt class="computeroutput">num</tt>
+ and succeeds only if both are equal, failing otherwise.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ulong</tt>
+ </td>
+<td>
+ <tt class="computeroutput">unsigned long</tt>,
+ attribute is mandatory (otherwise compilation will fail)
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ulong(num)</tt>
+ </td>
+<td>
+ <tt class="computeroutput">unsigned long</tt>,
+ attribute is optional, if it is supplied, the generator compares
+ the attribute with <tt class="computeroutput">num</tt>
+ and succeeds only if both are equal, failing otherwise.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ulong_long</tt>
+ </td>
+<td>
+ <tt class="computeroutput">unsigned long
+ long</tt>, attribute is mandatory
+ (otherwise compilation will fail)
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ulong_long(num)</tt>
+ </td>
+<td>
+ <tt class="computeroutput">unsigned long
+ long</tt>, attribute is optional,
+ if it is supplied, the generator compares the attribute with
+ <tt class="computeroutput">num</tt> and succeeds
+ only if both are equal, failing otherwise.
+ </td>
+</tr>
+<tr>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">bin
+oct
+hex</pre>
+
+ 
+</td>
+<td>
+ <tt class="computeroutput">unsigned int</tt>,
+ attribute is mandatory (otherwise compilation will fail)
+ </td>
+</tr>
+<tr>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">bin(num)
+oct(num)
+hex(num)</pre>
+
+ 
+</td>
+<td>
+ <tt class="computeroutput">unsigned int</tt>,
+ attribute is optional, if it is supplied, the generator compares
+ the attribute with <tt class="computeroutput">num</tt>
+ and succeeds only if both are equal, failing otherwise.
+ </td>
+</tr>
+<tr>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">uint_generator<
+ Num, Radix
+>()</pre>
+
+ 
+</td>
+<td>
+ <tt class="computeroutput">Num</tt>, attribute
+ is mandatory (otherwise compilation will fail)
+ </td>
+</tr>
+<tr>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">uint_generator<
+ Num, Radix
+>()(num)</pre>
+
+ 
+</td>
+<td>
+ <tt class="computeroutput">Num</tt>, attribute
+ is optional, if it is supplied, the generator compares the attribute
+ with <tt class="computeroutput">num</tt> and
+ succeeds only if both are equal, failing otherwise.
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="spirit.karma.reference.numeric.unsigned_int.complexity"></a><h6>
+<a name="id516486"></a>
+ Complexity
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ O(N), where <tt class="computeroutput">N</tt> is
+ the number of digits needed to represent the generated integer number
+ 
+
+ 
+</blockquote></div>
+<a name="spirit.karma.reference.numeric.unsigned_int.example"></a><h6>
+<a name="id516534"></a>
+ Example
+ </h6>
+
+ Some includes:
+ 
+
+ 
+
+
+
+<pre class="programlisting">#include <boost/spirit/include/karma.hpp>
+#include <boost/spirit/include/phoenix_core.hpp>
+#include <boost/spirit/include/phoenix_operator.hpp>
+#include <boost/fusion/include/std_pair.hpp>
+#include <iostream>
+#include <string>
+</pre>
+
+ 
+
+ 
+
+ All code snippets below use these common test functions:
+ 
+
+ 
+
+
+
+<pre class="programlisting">template <typename G>
+void test_generator(char const* expected, G const& g)
+{
+ std::string s;
+ std::back_insert_iterator<std::string> out(s);
+ if (boost::spirit::karma::generate(out, g) && str == expected)
+ std::cout << "ok" << std::endl;
+ else
+ std::cout << "fail" << std::endl;
+}
+</pre>
+
+ 
+
+ 
+
+
+
+<pre class="programlisting">template <typename G, typename T>
+void test_generator_attr(char const* expected, G const& g, T const& attr)
+{
+ std::string s;
+ std::back_insert_iterator<std::string> out(s);
+ if (boost::spirit::karma::generate(out, g, attr) && str == expected)
+ std::cout << "ok" << std::endl;
+ else
+ std::cout << "fail" << std::endl;
+}
+</pre>
+
+ 
+
+ 
+
+ Some using declarations:
+ 
+
+ 
+
+
+
+<pre class="programlisting">using boost::spirit::karma::generate;
+using boost::spirit::karma::uint;
+</pre>
+
+ 
+
+ 
+
+ Basic usage of an <tt class="computeroutput">uint</tt>
+ generator:
+ 
+
+ 
+
+
+
+<pre class="programlisting">test_generator("2", lit(2U));
+test_generator("2", uint(2));
+test_generator_attr("2", uint(2), 2);
+test_generator_attr("", uint(2), 3); // fails (as 2 != 3)!
+test_generator_attr("2", uint, 2);
+</pre>
+
+ 
+
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.karma.reference.numeric.floating_point"></a><a href="numeric.html#spirit.karma.reference.numeric.floating_point" title=" Floating
+ Point Number Generators"> Floating
+ Point Number Generators</a>
+</h5></div></div>
+<div></div>
+</div>
+<a name="spirit.karma.reference.numeric.floating_point.description"></a><h6>
+<a name="id518209"></a>
+ Description
+ </h6>
+
+ The floating point number generators described in this section are:
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Attribute
+ </th>
+<th>
+ Description
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <tt class="computeroutput">lit(num)</tt>
+ </td>
+<td>
+ <tt class="computeroutput">Unused</tt>
+ </td>
+<td>
+ Generates <tt class="computeroutput">num</tt>,
+ where <tt class="computeroutput">num</tt> can
+ be a <tt class="computeroutput">float</tt>, <tt class="computeroutput">double</tt>, or <tt class="computeroutput">long
+ double</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">float_</tt>
+ </td>
+<td>
+ <tt class="computeroutput">float</tt>
+ </td>
+<td>
+ Generate a <tt class="computeroutput">float</tt>
+ as given by the mandatory attribute
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">float_(num)</tt>
+ </td>
+<td>
+ <tt class="computeroutput">float</tt>
+ </td>
+<td>
+ Generate <tt class="computeroutput">num</tt>
+ as a <tt class="computeroutput">float</tt>, if an
+ attribute is supplied it must match
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">double_</tt>
+ </td>
+<td>
+ <tt class="computeroutput">double</tt>
+ </td>
+<td>
+ Generate a <tt class="computeroutput">double</tt>
+ as given by the mandatory attribute
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">double_(num)</tt>
+ </td>
+<td>
+ <tt class="computeroutput">double</tt>
+ </td>
+<td>
+ Generate <tt class="computeroutput">num</tt>
+ as a <tt class="computeroutput">double</tt>, if
+ an attribute is supplied it must match
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">long_double</tt>
+ </td>
+<td>
+ <tt class="computeroutput">long double</tt>
+ </td>
+<td>
+ Generate a <tt class="computeroutput">double</tt>
+ as given by the mandatory attribute
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">long_double(num)</tt>
+ </td>
+<td>
+ <tt class="computeroutput">long double</tt>
+ </td>
+<td>
+ Generate <tt class="computeroutput">num</tt>
+ as a <tt class="computeroutput">double</tt>, if
+ an attribute is supplied it must match
+ </td>
+</tr>
+<tr>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">real_generator<
+ Num, Policies
+>()</pre>
+
+ 
+</td>
+<td>
+ <tt class="computeroutput">Num</tt>
+ </td>
+<td>
+ Generate a <tt class="computeroutput">Num</tt>
+ using the provided policies <tt class="computeroutput">Policies</tt>
+ </td>
+</tr>
+<tr>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">real_generator<
+ Num, Policies
+>()(num)</pre>
+
+ 
+</td>
+<td>
+ <tt class="computeroutput">Num</tt>
+ </td>
+<td>
+ Generate <tt class="computeroutput">num</tt>
+ as a <tt class="computeroutput">Num</tt> using
+ the provided policies <tt class="computeroutput">Policies</tt>,
+ if an attribute is supplied it must match
+ </td>
+</tr>
+</tbody>
+</table></div>
+
+ These can be used to flexibly format any floating point number of any
+ compatible type (for more information about the requirements, see below).
+ 
+
+ The floating point number generators are very fast. For measurement results
+ comparing the Spirit.Karma floating point number
+ generators with equivalent constructs provided by other libraries see
+ the section <a href="../performance_measurements/numeric_performance.html#spirit.karma.performance_measurements.numeric_performance.double_performance" title="
+ Comparing the performance of a single double_ generator">Performance
+ of Floating Point Numeric Generators</a>
+ 
+<a name="spirit.karma.reference.numeric.floating_point.header"></a><h6>
+<a name="id519124"></a>
+ Header
+ </h6>
+<pre class="programlisting">// forwards to <boost/spirit/home/karma/numeric/real.hpp>
+#include <boost/spirit/include/karma_real.hpp>
+</pre>
+
+ Also, see Include Structure.
+ 
+<a name="spirit.karma.reference.numeric.floating_point.model_of"></a><h6>
+<a name="id519238"></a>
+ <a href="numeric.html#spirit.karma.reference.numeric.floating_point.model_of">Model
+ of</a>
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ PrimitiveGenerator
+ 
+
+ 
+</blockquote></div>
+<div class="variablelist">
+Notation
+<dl>
+<dt><tt class="computeroutput">num</tt></dt>
+<dd>
+ Numeric literal, any floating point value, or a <a href="karma_basics.html#spirit.karma.reference.karma_basics.lazy_argument">Lazy
+ Argument</a> that evaluates to a floating point value of type
+ <tt class="computeroutput">Num</tt>
+ </dd>
+<dt><tt class="computeroutput">Num</tt></dt>
+<dd>
+ Type of <tt class="computeroutput">num</tt>: any
+ floating point type
+ </dd>
+</dl>
+</div>
+<a name="spirit.karma.reference.numeric.floating_point.expression_semantics"></a><h6>
+<a name="id519379"></a>
+ <a href="numeric.html#spirit.karma.reference.numeric.floating_point.expression_semantics">Expression
+ Semantics</a>
+ </h6>
+
+ Semantics of an expression is defined only where it differs from, or
+ is not defined in PrimitiveGenerator.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Semantics
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <tt class="computeroutput">lit(num)</tt>
+ </td>
+<td>
+ Generate the floating point literal <tt class="computeroutput">num</tt>
+ using the default formatting (no trailing zeros, <tt class="computeroutput">fixed</tt> representation for numbers
+ <tt class="computeroutput">fabs(n)
+ <= 1e5
+ && fabs(n) >
+ 1e-3</tt>, scientific representation
+ otherwise, 3 fractional digits, sign is only printed for negative
+ literals). This generator never fails (except if the underlying
+ output stream reports an error).
+ </td>
+</tr>
+<tr>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">float_
+double_
+long_double</pre>
+
+ 
+</td>
+<td>
+ Generate the floating point number provided by a mandatory attribute
+ using the default formatting (no trailing zeros, <tt class="computeroutput">fixed</tt> representation for numbers
+ <tt class="computeroutput">fabs(n)
+ <= 1e5
+ && fabs(n) >
+ 1e-3</tt>, scientific representation
+ otherwise, 3 fractional digits, sign is only printed for negative
+ literals). This generator never fails (except if the underlying
+ output stream reports an error).
+ </td>
+</tr>
+<tr>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">float_(num)
+double_(num)
+long_double(num)</pre>
+
+ 
+</td>
+<td>
+ Generate the floating point number provided by the immediate
+ literal value the generator is initialized from using the default
+ formatting (no trailing zeros, <tt class="computeroutput">fixed</tt>
+ representation for numbers <tt class="computeroutput">fabs(n) <=
+ 1e5 &&
+ fabs(n)
+ > 1e-3</tt>,
+ scientific representation otherwise, 3 fractional digits, sign
+ is only printed for negative literals). If this generator has
+ an associated attribute it succeeds only as long as the attribute
+ is equal to the immediate literal (except if the underlying output
+ stream reports an error). Otherwise this generator fails and
+ does not generate any output.
+ </td>
+</tr>
+</tbody>
+</table></div>
+
+ All generators listed in the table above (except <tt class="computeroutput">lit(num)</tt>) are predefined specializations of the
+ <tt class="computeroutput">real_generator<Num, Policies></tt>
+ basic floating point number generator type described below. It is possible
+ to directly use this type to create floating point generators using a
+ wide range of formatting options.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Semantics
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">real_generator<
+ Num, Policies
+>()</pre>
+
+ 
+</td>
+<td>
+ Generate the floating point number of type <tt class="computeroutput">Num</tt>
+ provided by a mandatory attribute using the specified <tt class="computeroutput">Policies</tt>. This generator never
+ fails (except if the underlying output stream reports an error).
+ </td>
+</tr></tbody>
+</table></div>
+
+ For more information about the type <tt class="computeroutput">Policies</tt>
+ see below).
+ 
+<a name="spirit.karma.reference.numeric.floating_point.additional_requirements"></a><h6>
+<a name="id520170"></a>
+ <a href="numeric.html#spirit.karma.reference.numeric.floating_point.additional_requirements">Additional
+ Requirements</a>
+ </h6>
+
+ The following list enumerate the requirements which must be met in order
+ to use a certain type <tt class="computeroutput">Num</tt>
+ to instantiate a <tt class="computeroutput">real_generator<Num, Policies></tt>.
+ 
+
+ In order to be usable as the first template parameter for <tt class="computeroutput">real_generator<></tt>
+ the type <tt class="computeroutput">Num</tt> must have
+ defined:
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ comparison operators for: <tt class="computeroutput"><</tt>,
+ <tt class="computeroutput"><=</tt>, <tt class="computeroutput">==</tt>,
+ <tt class="computeroutput">!=</tt>, <tt class="computeroutput">></tt>,
+ and <tt class="computeroutput">>=</tt>
+</li>
+<li>
+ numeric operators for: <tt class="computeroutput">+</tt>,
+ <tt class="computeroutput">-</tt>, <tt class="computeroutput">/</tt>,
+ <tt class="computeroutput">*</tt>, and <tt class="computeroutput">%</tt>
+</li>
+<li>
+ functions implementing the interface and the semantics of: <tt class="computeroutput">std::fmod</tt>, <tt class="computeroutput">std::pow</tt>,
+ <tt class="computeroutput">std::log10</tt>, <tt class="computeroutput">std::lround</tt>,
+ <tt class="computeroutput">std::ltrunc</tt>, <tt class="computeroutput">std::modf</tt>,
+ <tt class="computeroutput">std::floor</tt>, and <tt class="computeroutput">std::ceil</tt>
+</li>
+<li>
+ a valid specialization of the type <tt class="computeroutput">std::numeric_limits<Num></tt> allowing for numeric property inspection.
+ </li>
+</ul></div>
+<a name="spirit.karma.reference.numeric.floating_point.attributes"></a><h6>
+<a name="id520641"></a>
+ Attributes
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Attribute
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <tt class="computeroutput">lit(num)</tt>
+ </td>
+<td>
+ <tt class="computeroutput">unused</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">float_</tt>
+ </td>
+<td>
+ <tt class="computeroutput">float</tt>, attribute
+ is mandatory (otherwise compilation will fail)
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">float_(num)</tt>
+ </td>
+<td>
+ <tt class="computeroutput">float_</tt>, attribute
+ is optional, if it is supplied, the generator compares the attribute
+ with <tt class="computeroutput">num</tt> and
+ succeeds only if both are equal, failing otherwise.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">double_</tt>
+ </td>
+<td>
+ <tt class="computeroutput">double</tt>, attribute
+ is mandatory (otherwise compilation will fail)
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">double_(num)</tt>
+ </td>
+<td>
+ <tt class="computeroutput">double</tt>, attribute
+ is optional, if it is supplied, the generator compares the attribute
+ with <tt class="computeroutput">num</tt> and
+ succeeds only if both are equal, failing otherwise.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">long_double</tt>
+ </td>
+<td>
+ <tt class="computeroutput">long double</tt>,
+ attribute is mandatory (otherwise compilation will fail)
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">long_double(num)</tt>
+ </td>
+<td>
+ <tt class="computeroutput">long double</tt>,
+ attribute is optional, if it is supplied, the generator compares
+ the attribute with <tt class="computeroutput">num</tt>
+ and succeeds only if both are equal, failing otherwise.
+ </td>
+</tr>
+<tr>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">real_generator<
+ Num, Policies
+>()</pre>
+
+ 
+</td>
+<td>
+ <tt class="computeroutput">Num</tt>, attribute
+ is mandatory (otherwise compilation will fail)
+ </td>
+</tr>
+<tr>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">real_generator<
+ Num, Policies
+>()(num)</pre>
+
+ 
+</td>
+<td>
+ <tt class="computeroutput">Num</tt>, attribute
+ is optional, if it is supplied, the generator compares the attribute
+ with <tt class="computeroutput">num</tt> and
+ succeeds only if both are equal, failing otherwise.
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="spirit.karma.reference.numeric.floating_point.floating_point_formatting_policies"></a><h6>
+<a name="id521268"></a>
+ <a href="numeric.html#spirit.karma.reference.numeric.floating_point.floating_point_formatting_policies">Floating
+ Point Formatting Policies</a>
+ </h6>
+
+ If special formatting of a floating point number is needed, just overload
+ the policy class <tt class="computeroutput">real_policies<Num></tt> and use it as a template parameter
+ to the <tt class="computeroutput">real_generator<></tt> floating point generator. For
+ instance:
+ 
+<pre class="programlisting">// define a new floating point formatting policy
+template <typename T>
+struct scientific_policy : real_policies<T>
+{
+ // we want the numbers always to be in scientific format
+ static int floatfield(T n) { return fmtflags::scientific; }
+};
+
+// define a new generator type based on the new policy
+typedef real_generator<double, scientific_policy<double> > science_type;
+science_type const scientific = science_type();
+
+// use the new generator
+generate(sink, science_type(), 1.0); // will output: 1.0e00
+generate(sink, scientific, 0.1); // will output: 1.0e-01
+</pre>
+
+ The template parameter <tt class="computeroutput">T</tt>
+ should be the type to be formatted using the overloaded policy type.
+ At the same time <tt class="computeroutput">T</tt> will
+ be used as the attribute type of the created floating point generator.
+ 
+<a name="spirit.karma.reference.numeric.floating_point.floating_point_formatting_policy_expression_semantics"></a><h6>
+<a name="id521772"></a>
+ <a href="numeric.html#spirit.karma.reference.numeric.floating_point.floating_point_formatting_policy_expression_semantics">Floating
+ Point Formatting Policy Expression Semantics</a>
+ </h6>
+
+ A floating point formatting policy should expose the following variables
+ and functions:
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Description
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">template <typename Inserter
+ , typename OutputIterator
+ , typename Policies>
+bool call (OutputIterator& sink, T n
+ , Policies const& p);
+</pre>
+
+ 
+</td>
+<td>
+
+ This is the main function used to generate the output for a floating
+ point number. It is called by the real generator in order to
+ perform the conversion. In theory all of the work can be implemented
+ here, but it is the easiest to use existing functionality provided
+ by the type specified by the template parameter <tt class="computeroutput">Inserter</tt>. The default implementation
+ of this functions is:
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">template <typename Inserter, typename OutputIterator
+ , typename Policies>
+static bool
+call (OutputIterator& sink, T n, Policies const& p)
+{
+ return Inserter::call_n(sink, n, p);
+}
+</pre>
+
+ <tt class="computeroutput">sink</tt>: is the
+ output iterator to use for generation
+ 
+
+ <tt class="computeroutput">n</tt>: is the floating
+ point number to convert
+ 
+
+ <tt class="computeroutput">p</tt>: the instance
+ of the policy type used to instantiate this floating point generator.
+ 
+</td>
+</tr>
+<tr>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">bool force_sign(T n);
+</pre>
+
+ 
+</td>
+<td>
+
+ The default behavior is to not to require generating a sign.
+ If the function <tt class="computeroutput">force_sign()</tt> returns true, then all generated
+ numbers will have a sign (<tt class="computeroutput">'+'</tt>
+ or <tt class="computeroutput">'-'</tt>, zeros will
+ have a space instead of a sign).
+ 
+
+ <tt class="computeroutput">n</tt> is the floating
+ point number to output. This can be used to adjust the required
+ behavior depending on the value of this number.
+ 
+</td>
+</tr>
+<tr>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">bool trailing_zeros(T n);
+</pre>
+
+ 
+</td>
+<td>
+
+ Return whether trailing zero digits have to be emitted in the
+ fractional part of the output. If set, this flag instructs the
+ floating point generator to emit trailing zeros up to the required
+ precision digits (as returned by the <tt class="computeroutput">precision()</tt> function).
+ 
+
+ <tt class="computeroutput">n</tt> is the floating
+ point number to output. This can be used to adjust the required
+ behavior depending on the value of this number.
+ 
+</td>
+</tr>
+<tr>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">int floatfield(T n);
+</pre>
+
+ 
+</td>
+<td>
+
+ Decide, which representation type to use in the generated output.
+ 
+
+ By default all numbers having an absolute value of zero or in
+ between <tt class="computeroutput">0.001</tt> and
+ <tt class="computeroutput">100000</tt> will be generated
+ using the fixed format, all others will be generated using the
+ scientific representation.
+ 
+
+ The <tt class="computeroutput">trailing_zeros()</tt> can be used to force the output
+ of trailing zeros in the fractional part up to the number of
+ digits returned by the <tt class="computeroutput">precision()</tt> member function. The default
+ is not to generate the trailing zeros.
+ 
+
+ <tt class="computeroutput">n</tt>: is the floating
+ point number to output. This can be used to adjust the formatting
+ flags depending on the value of this number.
+ 
+
+ The return value has to be either <tt class="computeroutput">fmtflags::scientific</tt>
+ (generate floating point values in scientific notation) or <tt class="computeroutput">fmtflags::fixed</tt> (generate floating point
+ values in fixed-point notation).
+ 
+</td>
+</tr>
+<tr>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">unsigned precision(T n);
+</pre>
+
+ 
+</td>
+<td>
+
+ Return the maximum number of decimal digits to generate in the
+ fractional part of the output.
+ 
+
+ <tt class="computeroutput">n</tt>: is the floating
+ point number to output. This can be used to adjust the required
+ precision depending on the value of this number. If the trailing
+ zeros flag is specified the fractional part of the output will
+ be 'filled' with zeros, if appropriate.
+ 
+
+ Note: If the trailing_zeros
+ flag is not in effect additional semantics apply. See the description
+ for the <tt class="computeroutput">fraction_part()</tt> function below. Moreover, this
+ precision will be limited to the value of <tt class="computeroutput">std::numeric_limits<T>::digits10
+ + 1</tt>.
+ 
+</td>
+</tr>
+<tr>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">template <bool ForceSign,
+ typename OutputIterator>
+bool integer_part(OutputIterator& sink
+ , T n, bool sign, bool force_sign);
+</pre>
+
+ 
+</td>
+<td>
+
+ This function is called to generate the integer part of the floating
+ point number.
+ 
+
+ <tt class="computeroutput">sink</tt>: is the
+ output iterator to use for generation
+ 
+
+ <tt class="computeroutput">n</tt>: is the absolute
+ value of the integer part of the floating point number to convert
+ (always non-negative)
+ 
+
+ <tt class="computeroutput">sign</tt>: is the
+ sign of the overall floating point number to convert.
+ 
+
+ <tt class="computeroutput">force_sign</tt>: is
+ a flag whether a sign has to be generated even for non- negative
+ numbers (this is the same as has been returned from the function
+ <tt class="computeroutput">force_sign()</tt>
+ described above)
+ 
+
+ The return value defines the outcome of the whole generator.
+ If it is <tt class="computeroutput">false</tt>,
+ no further output is generated, imediatly returning <tt class="computeroutput">false</tt> from the calling <tt class="computeroutput">real_generator</tt> as well. If
+ it is <tt class="computeroutput">true</tt>, normal
+ output generation continues.
+ 
+</td>
+</tr>
+<tr>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">template <typename OutputIterator>
+bool dot(OutputIterator& sink, T n,
+ unsigned precision);
+</pre>
+
+ 
+</td>
+<td>
+
+ This function is called to generate the decimal point.
+ 
+
+ <tt class="computeroutput">sink</tt>: is the
+ output iterator to use for generation
+ 
+
+ <tt class="computeroutput">n</tt>: The fractional
+ part of the floating point number to convert. Note that this
+ number is scaled such, that it represents the number of units
+ which correspond to the value returned from the <tt class="computeroutput">precision()</tt>
+ function earlier. I.e. a fractional part of <tt class="computeroutput">0.01234</tt>
+ is represented as <tt class="computeroutput">1234</tt>
+ when the function <tt class="computeroutput">precision()</tt> returned <tt class="computeroutput">5</tt>.
+ 
+
+ <tt class="computeroutput">precision</tt>: The
+ number of digits to emit as returned by the function <tt class="computeroutput">precision()</tt>
+ described above
+ 
+
+ This is given to allow to decide, whether a decimal point has
+ to be generated at all.
+ 
+
+ Note: If the <tt class="computeroutput">trailing_zeros</tt>
+ flag is not in effect additional comments apply. See the description
+ for the <tt class="computeroutput">fraction_part()</tt> function below.
+ 
+
+ The return value defines the outcome of the whole generator.
+ If it is <tt class="computeroutput">false</tt>,
+ no further output is generated, imediatly returning <tt class="computeroutput">false</tt> from the calling <tt class="computeroutput">real_generator</tt> as well. If
+ it is <tt class="computeroutput">true</tt>, normal
+ output generation continues.
+ 
+</td>
+</tr>
+<tr>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">template <typename OutputIterator>
+bool fraction_part(OutputIterator& sink, T n
+ , unsigned adjprec, unsigned precision);
+</pre>
+
+ 
+</td>
+<td>
+
+ This function is called to generate the fractional part of the
+ number.
+ 
+
+ <tt class="computeroutput">sink</tt>: is the
+ output iterator to use for generation
+ 
+
+ <tt class="computeroutput">n</tt>: The fractional
+ part of the floating point number to convert. Note that this
+ number is scaled such, that it represents the number of units
+ which correspond to the value returned from the <tt class="computeroutput">precision()</tt>
+ function earlier. I.e. a fractional part of <tt class="computeroutput">0.01234</tt>
+ is represented as <tt class="computeroutput">1234</tt>
+ when the function <tt class="computeroutput">precision()</tt> returned <tt class="computeroutput">5</tt>.
+ 
+
+ <tt class="computeroutput">adjprec</tt>: The
+ corrected number of digits to emit (see note below)
+ 
+
+ <tt class="computeroutput">precision</tt>: The
+ number of digits to emit as returned by the function <tt class="computeroutput">precision()</tt>
+ described above
+ 
+
+ Note: If <tt class="computeroutput">trailing_zeros()</tt> returns <tt class="computeroutput">false</tt>
+ the <tt class="computeroutput">adjprec</tt> parameter
+ will have been corrected from the value the <tt class="computeroutput">precision()</tt> function returned earlier (defining
+ the maximal number of fractional digits) in the sense, that it
+ takes into account trailing zeros. I.e. a floating point number
+ <tt class="computeroutput">0.0123</tt> and a value
+ of <tt class="computeroutput">5</tt> returned from
+ <tt class="computeroutput">precision()</tt>
+ will result in:
+ 
+
+ <tt class="computeroutput">trailing_zeros()</tt> returned <tt class="computeroutput">false</tt>:
+ <tt class="computeroutput">n</tt> will be <tt class="computeroutput">123</tt>, and <tt class="computeroutput">adjprec</tt>
+ will be <tt class="computeroutput">4</tt> (as we
+ need to print <tt class="computeroutput">0123</tt>)
+ 
+
+ <tt class="computeroutput">trailing_zeros()</tt> returned <tt class="computeroutput">true</tt>:
+ <tt class="computeroutput">n</tt> will be <tt class="computeroutput">1230</tt>, and <tt class="computeroutput">adjprec</tt>
+ will be <tt class="computeroutput">5</tt> (as we
+ need to print <tt class="computeroutput">01230</tt>)
+ 
+
+ The missing preceding zeros in the fractional part have to be
+ supplied by the implementation of this policy function.
+ 
+
+ The return value defines the outcome of the whole generator.
+ If it is <tt class="computeroutput">false</tt>,
+ no further output is generated, imediatly returning <tt class="computeroutput">false</tt> from the calling <tt class="computeroutput">real_generator</tt> as well. If
+ it is <tt class="computeroutput">true</tt>, normal
+ output generation continues.
+ 
+</td>
+</tr>
+<tr>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">template <typename CharEncoding,
+ typename Tag, typename OutputIterator>
+bool exponent(
+ OutputIterator& sink, long n);
+</pre>
+
+ 
+</td>
+<td>
+
+ This function is called to generate the exponential part of the
+ number (this is called only if the <tt class="computeroutput">floatfield()</tt> function returned the <tt class="computeroutput">fmtflags::scientific</tt> flag).
+ 
+
+ <tt class="computeroutput">sink</tt>: is the
+ output iterator to use for generation
+ 
+
+ <tt class="computeroutput">n</tt>: The (signed)
+ exponential part of the floating point number to convert.
+ 
+
+ The template parameters <tt class="computeroutput">CharEncoding</tt>
+ and <tt class="computeroutput">Tag</tt> are either
+ of the type <tt class="computeroutput">unused_type</tt>
+ or describe the character class and conversion to be applied
+ to any output possibly influenced by either the <tt class="computeroutput">lower[]</tt>
+ or <tt class="computeroutput">upper[]</tt>
+ directives.
+ 
+
+ The return value defines the outcome of the whole generator.
+ If it is <tt class="computeroutput">false</tt>,
+ no further output is generated, imediatly returning <tt class="computeroutput">false</tt> from the calling <tt class="computeroutput">real_generator</tt> as well. If
+ it is <tt class="computeroutput">true</tt>, normal
+ output generation continues.
+ 
+</td>
+</tr>
+<tr>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">template <typename CharEncoding
+ , typename Tag, typename OutputIterator>
+bool nan (OutputIterator& sink, T n
+ , bool force_sign);
+</pre>
+
+ 
+</td>
+<td>
+
+ This function is called whenever the number to print is a non-normal
+ floats of type NaN.
+ 
+
+ <tt class="computeroutput">sink</tt>: is the
+ output iterator to use for generation
+ 
+
+ <tt class="computeroutput">n</tt>: is the (signed)
+ floating point number to convert
+ 
+
+ <tt class="computeroutput">force_sign</tt>: is
+ a flag whether a sign has to be generated even for non- negative
+ numbers (this is the same as has been returned from the function
+ <tt class="computeroutput">force_sign()</tt>
+ described above)
+ 
+
+ The template parameters <tt class="computeroutput">CharEncoding</tt>
+ and <tt class="computeroutput">Tag</tt> are either
+ of the type <tt class="computeroutput">unused_type</tt>
+ or describe the character class and conversion to be applied
+ to any output possibly influenced by either the <tt class="computeroutput">lower[]</tt>
+ or <tt class="computeroutput">upper[]</tt>
+ directives.
+ 
+
+ The return value defines the outcome of the whole generator.
+ If it is <tt class="computeroutput">false</tt>,
+ no further output is generated, imediatly returning <tt class="computeroutput">false</tt> from the calling <tt class="computeroutput">real_generator</tt> as well. If
+ it is <tt class="computeroutput">true</tt>, normal
+ output generation continues.
+ 
+</td>
+</tr>
+<tr>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">template <typename CharEncoding
+ , typename Tag, typename OutputIterator>
+bool inf (OutputIterator& sink, T n
+ , bool force_sign);
+</pre>
+
+ 
+</td>
+<td>
+
+ This function is called whenever the number to print is a non-normal
+ floats of type Inf.
+ 
+
+ <tt class="computeroutput">sink</tt>: is the
+ output iterator to use for generation
+ 
+
+ <tt class="computeroutput">n</tt>: is the (signed)
+ floating point number to convert
+ 
+
+ <tt class="computeroutput">force_sign</tt>: is
+ a flag whether a sign has to be generated even for non- negative
+ numbers (this is the same as has been returned from the function
+ <tt class="computeroutput">force_sign()</tt>
+ described above)
+ 
+
+ The template parameters <tt class="computeroutput">CharEncoding</tt>
+ and <tt class="computeroutput">Tag</tt> are either
+ of the type <tt class="computeroutput">unused_type</tt>
+ or describe the character class and conversion to be applied
+ to any output possibly influenced by either the <tt class="computeroutput">lower[]</tt>
+ or <tt class="computeroutput">upper[]</tt>
+ directives.
+ 
+
+ The return value defines the outcome of the whole generator.
+ If it is <tt class="computeroutput">false</tt>,
+ no further output is generated, imediatly returning <tt class="computeroutput">false</tt> from the calling <tt class="computeroutput">real_generator</tt> as well. If
+ it is <tt class="computeroutput">true</tt>, normal
+ output generation continues.
+ 
+</td>
+</tr>
+</tbody>
+</table></div>
+
+ The easiest way to implement a proper floating point formatting policy
+ is to derive a new type from the the type <tt class="computeroutput">real_policies<></tt> while overriding the aspects
+ of the formatting which need to be changed.
+ 
+<a name="spirit.karma.reference.numeric.floating_point.complexity"></a><h6>
+<a name="id525365"></a>
+ Complexity
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ O(N), where <tt class="computeroutput">N</tt> is
+ the number of digits needed to represent the generated floating point
+ number.
+ 
+
+ 
+</blockquote></div>
+<a name="spirit.karma.reference.numeric.floating_point.example"></a><h6>
+<a name="id525416"></a>
+ Example
+ </h6>
+
+ Some includes:
+ 
+
+ 
+
+
+
+<pre class="programlisting">#include <boost/spirit/include/karma.hpp>
+#include <boost/spirit/include/phoenix_core.hpp>
+#include <boost/spirit/include/phoenix_operator.hpp>
+#include <boost/fusion/include/std_pair.hpp>
+#include <iostream>
+#include <string>
+</pre>
+
+ 
+
+ 
+
+ All code snippets below use these common test functions:
+ 
+
+ 
+
+
+
+<pre class="programlisting">template <typename G>
+void test_generator(char const* expected, G const& g)
+{
+ std::string s;
+ std::back_insert_iterator<std::string> out(s);
+ if (boost::spirit::karma::generate(out, g) && str == expected)
+ std::cout << "ok" << std::endl;
+ else
+ std::cout << "fail" << std::endl;
+}
+</pre>
+
+ 
+
+ 
+
+
+
+<pre class="programlisting">template <typename G, typename T>
+void test_generator_attr(char const* expected, G const& g, T const& attr)
+{
+ std::string s;
+ std::back_insert_iterator<std::string> out(s);
+ if (boost::spirit::karma::generate(out, g, attr) && str == expected)
+ std::cout << "ok" << std::endl;
+ else
+ std::cout << "fail" << std::endl;
+}
+</pre>
+
+ 
+
+ 
+
+ Some using declarations:
+ 
+
+ 
+
+
+
+<pre class="programlisting">using boost::spirit::karma::generate;
+using boost::spirit::karma::double_;
+</pre>
+
+ 
+
+ 
+
+ Basic usage of an <tt class="computeroutput">double_</tt>
+ generator:
+ 
+
+ 
+
+
+
+<pre class="programlisting">test_generator("2.0", lit(2.0));
+test_generator("2.0", double_(2));
+test_generator_attr("2.0", double_(2.0), 2.0);
+test_generator_attr("", double_(2.0), 3.0); // fails (as 2.0 != 3.0)!
+test_generator_attr("-2.0", double_, -2.0);
+
+test_generator_attr("1.234e05", double_, 1234.0e2);
+test_generator_attr("1.234e-06", double_, 0.000001234);
+</pre>
+
+ 
+
+ 
+</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
@@ -63,7 +2777,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="char/char_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="numeric/signed_int.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+<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="directive.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>

Modified: trunk/libs/spirit/doc/html/spirit/karma/reference/numeric/floating_point.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/karma/reference/numeric/floating_point.html (original)
+++ trunk/libs/spirit/doc/html/spirit/karma/reference/numeric/floating_point.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -34,7 +34,7 @@
<div></div>
</div>
<a name="spirit.karma.reference.numeric.floating_point.description"></a><h6>
-<a name="id517914"></a>
+<a name="id518209"></a>
 <a href="floating_point.html#spirit.karma.reference.numeric.floating_point.description">Description</a>
 </h6>

@@ -202,7 +202,7 @@
 of Floating Point Numeric Generators</a>
 
<a name="spirit.karma.reference.numeric.floating_point.header"></a><h6>
-<a name="id518828"></a>
+<a name="id519124"></a>
 <a href="floating_point.html#spirit.karma.reference.numeric.floating_point.header">Header</a>
 </h6>
<pre class="programlisting">// forwards to <boost/spirit/home/karma/numeric/real.hpp>
@@ -212,7 +212,7 @@
 Also, see Include Structure.
 
<a name="spirit.karma.reference.numeric.floating_point.model_of"></a><h6>
-<a name="id518942"></a>
+<a name="id519238"></a>
 <a href="floating_point.html#spirit.karma.reference.numeric.floating_point.model_of">Model
 of</a>
 </h6>
@@ -242,7 +242,7 @@
</dl>
</div>
<a name="spirit.karma.reference.numeric.floating_point.expression_semantics"></a><h6>
-<a name="id519083"></a>
+<a name="id519379"></a>
 <a href="floating_point.html#spirit.karma.reference.numeric.floating_point.expression_semantics">Expression
 Semantics</a>
 </h6>
@@ -375,7 +375,7 @@
 see below).
 
<a name="spirit.karma.reference.numeric.floating_point.additional_requirements"></a><h6>
-<a name="id519874"></a>
+<a name="id520170"></a>
 <a href="floating_point.html#spirit.karma.reference.numeric.floating_point.additional_requirements">Additional
 Requirements</a>
 </h6>
@@ -412,7 +412,7 @@
 </li>
</ul></div>
<a name="spirit.karma.reference.numeric.floating_point.attributes"></a><h6>
-<a name="id520344"></a>
+<a name="id520641"></a>
 <a href="floating_point.html#spirit.karma.reference.numeric.floating_point.attributes">Attributes</a>
 </h6>
<div class="informaltable"><table class="table">
@@ -534,7 +534,7 @@
</tbody>
</table></div>
<a name="spirit.karma.reference.numeric.floating_point.floating_point_formatting_policies"></a><h6>
-<a name="id520972"></a>
+<a name="id521268"></a>
 <a href="floating_point.html#spirit.karma.reference.numeric.floating_point.floating_point_formatting_policies">Floating
 Point Formatting Policies</a>
 </h6>
@@ -567,7 +567,7 @@
 be used as the attribute type of the created floating point generator.
 
<a name="spirit.karma.reference.numeric.floating_point.floating_point_formatting_policy_expression_semantics"></a><h6>
-<a name="id521475"></a>
+<a name="id521772"></a>
 <a href="floating_point.html#spirit.karma.reference.numeric.floating_point.floating_point_formatting_policy_expression_semantics">Floating
 Point Formatting Policy Expression Semantics</a>
 </h6>
@@ -1081,7 +1081,7 @@
 of the formatting which need to be changed.
 
<a name="spirit.karma.reference.numeric.floating_point.complexity"></a><h6>
-<a name="id525069"></a>
+<a name="id525365"></a>
 <a href="floating_point.html#spirit.karma.reference.numeric.floating_point.complexity">Complexity</a>
 </h6>
<div class="blockquote"><blockquote class="blockquote">
@@ -1096,7 +1096,7 @@
 
</blockquote></div>
<a name="spirit.karma.reference.numeric.floating_point.example"></a><h6>
-<a name="id525120"></a>
+<a name="id525416"></a>
 <a href="floating_point.html#spirit.karma.reference.numeric.floating_point.example">Example</a>
 </h6>

Modified: trunk/libs/spirit/doc/html/spirit/karma/reference/numeric/signed_int.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/karma/reference/numeric/signed_int.html (original)
+++ trunk/libs/spirit/doc/html/spirit/karma/reference/numeric/signed_int.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -34,7 +34,7 @@
<div></div>
</div>
<a name="spirit.karma.reference.numeric.signed_int.description"></a><h6>
-<a name="id506500"></a>
+<a name="id506811"></a>
 <a href="signed_int.html#spirit.karma.reference.numeric.signed_int.description">Description</a>
 </h6>

@@ -225,7 +225,7 @@
 of Numeric Generators</a>
 
<a name="spirit.karma.reference.numeric.signed_int.header"></a><h6>
-<a name="id507602"></a>
+<a name="id507913"></a>
 <a href="signed_int.html#spirit.karma.reference.numeric.signed_int.header">Header</a>
 </h6>
<pre class="programlisting">// forwards to <boost/spirit/home/karma/numeric/int.hpp>
@@ -235,7 +235,7 @@
 Also, see Include Structure.
 
<a name="spirit.karma.reference.numeric.signed_int.model_of"></a><h6>
-<a name="id507717"></a>
+<a name="id508027"></a>
 <a href="signed_int.html#spirit.karma.reference.numeric.signed_int.model_of">Model
 of</a>
 </h6>
@@ -265,7 +265,7 @@
</dl>
</div>
<a name="spirit.karma.reference.numeric.signed_int.expression_semantics"></a><h6>
-<a name="id507857"></a>
+<a name="id508167"></a>
 <a href="signed_int.html#spirit.karma.reference.numeric.signed_int.expression_semantics">Expression
 Semantics</a>
 </h6>
@@ -422,7 +422,7 @@
</tbody>
</table></div>
<a name="spirit.karma.reference.numeric.signed_int.additional_requirements"></a><h6>
-<a name="id508799"></a>
+<a name="id509099"></a>
 <a href="signed_int.html#spirit.karma.reference.numeric.signed_int.additional_requirements">Additional
 Requirements</a>
 </h6>
@@ -477,7 +477,7 @@
 </li>
</ul></div>
<a name="spirit.karma.reference.numeric.signed_int.attributes"></a><h6>
-<a name="id509487"></a>
+<a name="id509787"></a>
 <a href="signed_int.html#spirit.karma.reference.numeric.signed_int.attributes">Attributes</a>
 </h6>
<div class="informaltable"><table class="table">
@@ -619,7 +619,7 @@
</tbody>
</table></div>
<a name="spirit.karma.reference.numeric.signed_int.complexity"></a><h6>
-<a name="id510245"></a>
+<a name="id510546"></a>
 <a href="signed_int.html#spirit.karma.reference.numeric.signed_int.complexity">Complexity</a>
 </h6>
<div class="blockquote"><blockquote class="blockquote">
@@ -633,7 +633,7 @@
 
</blockquote></div>
<a name="spirit.karma.reference.numeric.signed_int.example"></a><h6>
-<a name="id510294"></a>
+<a name="id510595"></a>
 <a href="signed_int.html#spirit.karma.reference.numeric.signed_int.example">Example</a>
 </h6>

Modified: trunk/libs/spirit/doc/html/spirit/karma/reference/numeric/unsigned_int.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/karma/reference/numeric/unsigned_int.html (original)
+++ trunk/libs/spirit/doc/html/spirit/karma/reference/numeric/unsigned_int.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -35,7 +35,7 @@
<div></div>
</div>
<a name="spirit.karma.reference.numeric.unsigned_int.description"></a><h6>
-<a name="id511980"></a>
+<a name="id512280"></a>
 <a href="unsigned_int.html#spirit.karma.reference.numeric.unsigned_int.description">Description</a>
 </h6>

@@ -295,7 +295,7 @@
 of Numeric Generators</a>
 
<a name="spirit.karma.reference.numeric.unsigned_int.header"></a><h6>
-<a name="id513405"></a>
+<a name="id513705"></a>
 <a href="unsigned_int.html#spirit.karma.reference.numeric.unsigned_int.header">Header</a>
 </h6>
<pre class="programlisting">// forwards to <boost/spirit/home/karma/numeric/uint.hpp>
@@ -305,7 +305,7 @@
 Also, see Include Structure.
 
<a name="spirit.karma.reference.numeric.unsigned_int.model_of"></a><h6>
-<a name="id513520"></a>
+<a name="id513820"></a>
 <a href="unsigned_int.html#spirit.karma.reference.numeric.unsigned_int.model_of">Model
 of</a>
 </h6>
@@ -335,7 +335,7 @@
</dl>
</div>
<a name="spirit.karma.reference.numeric.unsigned_int.expression_semantics"></a><h6>
-<a name="id513663"></a>
+<a name="id513962"></a>
 <a href="unsigned_int.html#spirit.karma.reference.numeric.unsigned_int.expression_semantics">Expression
 Semantics</a>
 </h6>
@@ -519,7 +519,7 @@
</tbody>
</table></div>
<a name="spirit.karma.reference.numeric.unsigned_int.additional_requirements"></a><h6>
-<a name="id514596"></a>
+<a name="id514892"></a>
 <a href="unsigned_int.html#spirit.karma.reference.numeric.unsigned_int.additional_requirements">Additional
 Requirements</a>
 </h6>
@@ -571,7 +571,7 @@
 </li>
</ul></div>
<a name="spirit.karma.reference.numeric.unsigned_int.attributes"></a><h6>
-<a name="id515227"></a>
+<a name="id515523"></a>
 <a href="unsigned_int.html#spirit.karma.reference.numeric.unsigned_int.attributes">Attributes</a>
 </h6>
<div class="informaltable"><table class="table">
@@ -749,7 +749,7 @@
</tbody>
</table></div>
<a name="spirit.karma.reference.numeric.unsigned_int.complexity"></a><h6>
-<a name="id516190"></a>
+<a name="id516486"></a>
 <a href="unsigned_int.html#spirit.karma.reference.numeric.unsigned_int.complexity">Complexity</a>
 </h6>
<div class="blockquote"><blockquote class="blockquote">
@@ -763,7 +763,7 @@
 
</blockquote></div>
<a name="spirit.karma.reference.numeric.unsigned_int.example"></a><h6>
-<a name="id516238"></a>
+<a name="id516534"></a>
 <a href="unsigned_int.html#spirit.karma.reference.numeric.unsigned_int.example">Example</a>
 </h6>

Modified: trunk/libs/spirit/doc/html/spirit/karma/reference/operator.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/karma/reference/operator.html (original)
+++ trunk/libs/spirit/doc/html/spirit/karma/reference/operator.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -6,10 +6,8 @@
<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
<link rel="home" href="../../../index.html" title="Spirit 2.1">
<link rel="up" href="../reference.html" title="Reference">
-<link rel="previous" href="directive/omit.html" title=" Consume Attribute
- (omit[])">
-<link rel="next" href="operator/sequence.html" title=" Sequences
- (operator<<())">
+<link rel="previous" href="directive.html" title="Directive">
+<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>
@@ -22,7 +20,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="directive/omit.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="operator/sequence.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+<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="auxiliary.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage">
@@ -32,20 +30,20 @@
<div></div>
</div>
<div class="toc"><dl>
-<dt><a href="operator/sequence.html"> Sequences
+<dt><a href="operator.html#spirit.karma.reference.operator.sequence"> Sequences
 (<tt class="computeroutput">operator<<()</tt>)</a></dt>
-<dt><a href="operator/alternative.html"> Alternatives
+<dt><a href="operator.html#spirit.karma.reference.operator.alternative"> Alternatives
 (<tt class="computeroutput">operator|()</tt>)</a></dt>
-<dt><a href="operator/kleene.html"> Kleene Star
+<dt><a href="operator.html#spirit.karma.reference.operator.kleene"> Kleene Star
 (unary <tt class="computeroutput">operator*()</tt>)</a></dt>
-<dt><a href="operator/plus.html"> Plus (unary
+<dt><a href="operator.html#spirit.karma.reference.operator.plus"> Plus (unary
 <tt class="computeroutput">operator+()</tt>)</a></dt>
-<dt> Lists (operator%())</dt>
-<dt><a href="operator/optional.html"> Optional
+<dt> Lists (operator%())</dt>
+<dt><a href="operator.html#spirit.karma.reference.operator.optional"> Optional
 (unary <tt class="computeroutput">operator-()</tt>)</a></dt>
-<dt><a href="operator/and_predicate.html"> And
+<dt><a href="operator.html#spirit.karma.reference.operator.and_predicate"> And
 Predicate (unary <tt class="computeroutput">operator&()</tt>)</a></dt>
-<dt><a href="operator/not_predicate.html"> Not
+<dt><a href="operator.html#spirit.karma.reference.operator.not_predicate"> Not
 Predicate (unary <tt class="computeroutput">operator!()</tt>)</a></dt>
</dl></div>

@@ -59,12 +57,2079 @@
 and the not predicate (unary <tt class="computeroutput">!</tt>).
 
<a name="spirit.karma.reference.operator.module_header"></a><h5>
-<a name="id548894"></a>
+<a name="id549195"></a>
 <a href="operator.html#spirit.karma.reference.operator.module_header">Module Header</a>
 </h5>
<pre class="programlisting">// forwards to <boost/spirit/home/karma/operator.hpp>
#include <boost/spirit/include/karma_operator.hpp>
</pre>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.karma.reference.operator.sequence"></a><a href="operator.html#spirit.karma.reference.operator.sequence" title=" Sequences
+ (operator<<())"> Sequences
+ (<tt class="computeroutput">operator<<()</tt>)</a>
+</h5></div></div>
+<div></div>
+</div>
+<a name="spirit.karma.reference.operator.sequence.description"></a><h6>
+<a name="id549331"></a>
+ Description
+ </h6>
+
+ Generator sequences are used to consecutively combine different, more
+ primitive generators. All generators in a sequence are invoked from left
+ to right as long as they succeed.
+ 
+<a name="spirit.karma.reference.operator.sequence.header"></a><h6>
+<a name="id549363"></a>
+ Header
+ </h6>
+<pre class="programlisting">// forwards to <boost/spirit/home/karma/operator/sequence.hpp>
+#include <boost/spirit/include/karma_sequence.hpp>
+</pre>
+
+ Also, see Include Structure.
+ 
+<a name="spirit.karma.reference.operator.sequence.model_of"></a><h6>
+<a name="id549476"></a>
+ <a href="operator.html#spirit.karma.reference.operator.sequence.model_of">Model
+ of</a>
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ NaryGenerator
+ 
+
+ 
+</blockquote></div>
+<a name="spirit.karma.reference.operator.sequence.expression_semantics"></a><h6>
+<a name="id549529"></a>
+ <a href="operator.html#spirit.karma.reference.operator.sequence.expression_semantics">Expression
+ Semantics</a>
+ </h6>
+
+ Semantics of an expression is defined only where it differs from, or
+ is not defined in NaryGenerator.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Semantics
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ <tt class="computeroutput">a <<
+ b</tt>
+ </td>
+<td>
+ The generators <tt class="computeroutput">a</tt>
+ and <tt class="computeroutput">b</tt> are executed
+ sequentially from left to right and as long as they succeed.
+ A failed generator stops the execution of the entire sequence
+ and makes the sequence fail as well.
+ </td>
+</tr></tbody>
+</table></div>
+
+ It is important to note, that sequences don't perform any buffering of
+ the output generated by its elements. That means that any failing sequence
+ might have already generated some output, which is not
+ rolled back.
+ 
+<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">
+
+ The simplest way to force a sequence to behave as if it did buffering
+ is to wrap it into a buffering directive (see <a href="directive.html#spirit.karma.reference.directive.buffer" title=" Temporary
+ Output Buffering (buffer[])"><tt class="computeroutput">buffer[a]</tt></a>):
+ 
+
+
+
+<pre class="programlisting">buffer[a << b << c]</pre>
+
+ 
+
+ which will not generate any output in case of
+ a failing sequence.
+ 
+</td></tr>
+</table></div>
+<a name="spirit.karma.reference.operator.sequence.attributes"></a><h6>
+<a name="id549803"></a>
+ Attributes
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Attribute
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ sequence (<tt class="computeroutput"><<</tt>)
+ </td>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">a: A, b: B --> (a << b): tuple<A, B>
+a: A, b: Unused --> (a << b): A
+a: Unused, b: B --> (a << b): B
+a: Unused, b: Unused --> (a << b): Unused
+
+a: A, b: A --> (a << b): vector<A>
+a: vector<A>, b: A --> (a << b): vector<A>
+a: A, b: vector<A> --> (a << b): vector<A>
+a: vector<A>, b: vector<A> --> (a << b): vector<A></pre>
+
+ 
+</td>
+</tr></tbody>
+</table></div>
+<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">
+
+ The table above uses <tt class="computeroutput">tuple<A, B></tt> and <tt class="computeroutput">vector<A></tt> as placeholders only.
+ 
+
+ The notation <tt class="computeroutput">tuple<A, B></tt> stands for any fusion
+ sequence of two elements, where <tt class="computeroutput">A</tt>
+ is the type of its first element and <tt class="computeroutput">B</tt>
+ is the type of its second element.
+ 
+
+ The notation of <tt class="computeroutput">vector<A></tt> stands for any STL container
+ holding elements of type <tt class="computeroutput">A</tt>.
+ 
+</td></tr>
+</table></div>
+
+ The attribute composition and propagation rules as shown in the table
+ above make sequences somewhat special as - if all elements have the same
+ attribute type - they can operate in two modes: consuming fusion sequences
+ and consuming STL containers. The selected mode depends on the type of
+ the attribute supplied
+ 
+<a name="spirit.karma.reference.operator.sequence.complexity"></a><h6>
+<a name="id550879"></a>
+ Complexity
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ The overall complexity of the sequence generator is defined by the
+ sum of the complexities of its elements. The complexity of the sequence
+ itself is O(N), where N is the number of elements in the sequence.
+ 
+
+ 
+</blockquote></div>
+<a name="spirit.karma.reference.operator.sequence.example"></a><h6>
+<a name="id550918"></a>
+ Example
+ </h6>
+
+ Some includes:
+ 
+
+ 
+
+
+
+<pre class="programlisting">#include <boost/spirit/include/karma.hpp>
+#include <boost/spirit/include/phoenix_core.hpp>
+#include <boost/spirit/include/phoenix_operator.hpp>
+#include <boost/fusion/include/std_pair.hpp>
+#include <iostream>
+#include <string>
+</pre>
+
+ 
+
+ 
+
+ All code snippets below use this common test function:
+ 
+
+ 
+
+
+
+<pre class="programlisting">template <typename G, typename T>
+void test_generator_attr(char const* expected, G const& g, T const& attr)
+{
+ std::string s;
+ std::back_insert_iterator<std::string> out(s);
+ if (boost::spirit::karma::generate(out, g, attr) && str == expected)
+ std::cout << "ok" << std::endl;
+ else
+ std::cout << "fail" << std::endl;
+}
+</pre>
+
+ 
+
+ 
+
+ Some using declarations:
+ 
+
+ 
+
+
+
+<pre class="programlisting">using boost::spirit::karma::generate;
+using boost::spirit::karma::double_;
+</pre>
+
+ 
+
+ 
+
+ Basic usage of a sequence:
+ 
+
+ 
+
+
+
+<pre class="programlisting">test_generator_attr("1.0,2.0", double_ << ',' << double_, std::make_pair(1.0, 2.0));
+</pre>
+
+ 
+
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.karma.reference.operator.alternative"></a><a href="operator.html#spirit.karma.reference.operator.alternative" title=" Alternatives
+ (operator|())"> Alternatives
+ (<tt class="computeroutput">operator|()</tt>)</a>
+</h5></div></div>
+<div></div>
+</div>
+<a name="spirit.karma.reference.operator.alternative.description"></a><h6>
+<a name="id552025"></a>
+ Description
+ </h6>
+
+ Generator alternatives are used to combine different, more primitive
+ generators into alternatives. All generators in an alternative are invoked
+ from left to right until one of them succeeds.
+ 
+<a name="spirit.karma.reference.operator.alternative.header"></a><h6>
+<a name="id552057"></a>
+ Header
+ </h6>
+<pre class="programlisting">// forwards to <boost/spirit/home/karma/operator/alternative.hpp>
+#include <boost/spirit/include/karma_alternative.hpp>
+</pre>
+
+ Also, see Include Structure.
+ 
+<a name="spirit.karma.reference.operator.alternative.model_of"></a><h6>
+<a name="id552172"></a>
+ <a href="operator.html#spirit.karma.reference.operator.alternative.model_of">Model
+ of</a>
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ NaryGenerator
+ 
+
+ 
+</blockquote></div>
+<a name="spirit.karma.reference.operator.alternative.expression_semantics"></a><h6>
+<a name="id552226"></a>
+ <a href="operator.html#spirit.karma.reference.operator.alternative.expression_semantics">Expression
+ Semantics</a>
+ </h6>
+
+ Semantics of an expression is defined only where it differs from, or
+ is not defined in NaryGenerator.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Semantics
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ <tt class="computeroutput">a |
+ b</tt>
+ </td>
+<td>
+ The generators <tt class="computeroutput">a</tt>
+ and <tt class="computeroutput">b</tt> are executed
+ sequentially from left to right and until one of them succeeds.
+ A failed generator forces the alternative generator to try the
+ next one. The alternative fails as a whole only if all elements
+ of the alternative fail. Each element of the alternative gets
+ passed the whole attribute of the alternative.
+ </td>
+</tr></tbody>
+</table></div>
+
+ Alternatives intercept and buffer the output of the currently executed
+ element. This allows to avoid partial outputs from failing elements as
+ the buffered content will be forwarded to the actual output only after
+ an element succeeded.
+ 
+<a name="spirit.karma.reference.operator.alternative.attributes"></a><h6>
+<a name="id552394"></a>
+ Attributes
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Attribute
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ alternative (<tt class="computeroutput">|</tt>)
+ </td>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">a: A, b: B --> (a | b): variant<A, B>
+a: A, b: Unused --> (a | b): A
+a: Unused, b: B --> (a | b): B
+a: Unused, b: Unused --> (a | b): Unused
+a: A, b: A --> (a | b): A</pre>
+
+ 
+</td>
+</tr></tbody>
+</table></div>
+<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">
+ The table above uses <tt class="computeroutput">variant<A, B></tt> as a placeholder only. The notation
+ <tt class="computeroutput">variant<A, B></tt>
+ stands for the type <tt class="computeroutput">boost::variant<A, B></tt>.
+ </td></tr>
+</table></div>
+
+ Alternatives are special in terms of attribute handling as their behavior
+ is not completely compile time defined. First of all the selected alternative
+ element depends on the actual type of the attribute supplied to the alternative
+ generator (i.e. what is stored in the variant). The attribute type supplied
+ at runtime narrows the set of considered alternatives
+ to those being compatible attribute wise. The remaining alternatives
+ are tried sequentially until the first of them succeeds. See below for
+ an example of this behavior.
+ 
+<a name="spirit.karma.reference.operator.alternative.complexity"></a><h6>
+<a name="id553065"></a>
+ Complexity
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ The overall complexity of the alternative generator is defined by
+ the sum of the complexities of its elements. The complexity of the
+ alternative itself is O(N), where N is the number of elements in
+ the alternative.
+ 
+
+ 
+</blockquote></div>
+<a name="spirit.karma.reference.operator.alternative.example"></a><h6>
+<a name="id553105"></a>
+ Example
+ </h6>
+
+ Some includes:
+ 
+
+ 
+
+
+
+<pre class="programlisting">#include <boost/spirit/include/karma.hpp>
+#include <boost/spirit/include/phoenix_core.hpp>
+#include <boost/spirit/include/phoenix_operator.hpp>
+#include <boost/fusion/include/std_pair.hpp>
+#include <iostream>
+#include <string>
+</pre>
+
+ 
+
+ 
+
+ All code snippets below use this common test function:
+ 
+
+ 
+
+
+
+<pre class="programlisting">template <typename G, typename T>
+void test_generator_attr(char const* expected, G const& g, T const& attr)
+{
+ std::string s;
+ std::back_insert_iterator<std::string> out(s);
+ if (boost::spirit::karma::generate(out, g, attr) && str == expected)
+ std::cout << "ok" << std::endl;
+ else
+ std::cout << "fail" << std::endl;
+}
+</pre>
+
+ 
+
+ 
+
+ Some using declarations:
+ 
+
+ 
+
+
+
+<pre class="programlisting">using boost::spirit::karma::generate;
+using boost::spirit::karma::double_;
+using boost::spirit::karma::ascii::string;
+</pre>
+
+ 
+
+ 
+
+ Basic usage of an alternative. While being only the second alternative,
+ the <tt class="computeroutput">double_</tt> generator
+ is chosen for output formatting because the supplied attribute type is
+ not compatible (i.e. not convertible) to the attribute type of the <tt class="computeroutput">string</tt> alternative.
+ 
+
+ 
+
+
+
+<pre class="programlisting">boost::variant<std::string, double> v1(1.0);
+test_generator_attr("1.0", string | double_, v1);
+test_generator_attr("2.0", string | double_, 2.0);
+</pre>
+
+ 
+
+ 
+
+ The same formatting rules may be used to output a string. This time we
+ supply the string <tt class="computeroutput">"example"</tt>,
+ resulting in the first alternative to be chosen for the generated output.
+ 
+
+ 
+
+
+
+<pre class="programlisting">boost::variant<std::string, double> v2("example");
+test_generator_attr("example", string | double_, v2);
+test_generator_attr("example", string | double_, "example");
+</pre>
+
+ 
+
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.karma.reference.operator.kleene"></a><a href="operator.html#spirit.karma.reference.operator.kleene" title=" Kleene Star
+ (unary operator*())"> Kleene Star
+ (unary <tt class="computeroutput">operator*()</tt>)</a>
+</h5></div></div>
+<div></div>
+</div>
+<a name="spirit.karma.reference.operator.kleene.description"></a><h6>
+<a name="id554601"></a>
+ Description
+ </h6>
+
+ Kleene star generators are used to repeat the execution of an embedded
+ generator zero or more times. Regardless of the success of the embedded
+ generator, the Kleene star generator always succeeds.
+ 
+<a name="spirit.karma.reference.operator.kleene.header"></a><h6>
+<a name="id554634"></a>
+ Header
+ </h6>
+<pre class="programlisting">// forwards to <boost/spirit/home/karma/operator/kleene.hpp>
+#include <boost/spirit/include/karma_kleene.hpp>
+</pre>
+
+ Also, see Include Structure.
+ 
+<a name="spirit.karma.reference.operator.kleene.model_of"></a><h6>
+<a name="id554748"></a>
+ <a href="operator.html#spirit.karma.reference.operator.kleene.model_of">Model
+ of</a>
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ UnaryGenerator
+ 
+
+ 
+</blockquote></div>
+<a name="spirit.karma.reference.operator.kleene.expression_semantics"></a><h6>
+<a name="id554799"></a>
+ <a href="operator.html#spirit.karma.reference.operator.kleene.expression_semantics">Expression
+ Semantics</a>
+ </h6>
+
+ Semantics of an expression is defined only where it differs from, or
+ is not defined in UnaryGenerator.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Semantics
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ <tt class="computeroutput">*a</tt>
+ </td>
+<td>
+ The generator <tt class="computeroutput">a</tt>
+ is executed zero or more times depending on the availability
+ of an attribute. The execution of <tt class="computeroutput">a</tt>
+ stops after the attribute values passed to the Kleene star generator
+ are exhausted. The Kleene star always succeeds (except if the
+ underlying output stream reports an error).
+ </td>
+</tr></tbody>
+</table></div>
+<a name="spirit.karma.reference.operator.kleene.attributes"></a><h6>
+<a name="id554948"></a>
+ Attributes
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Attribute
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ kleene (unary <tt class="computeroutput">*</tt>)
+ </td>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">a: A --> *a: vector<A>
+a: Unused --> *a: Unused</pre>
+
+ 
+</td>
+</tr></tbody>
+</table></div>
+<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">
+ The table above uses <tt class="computeroutput">vector<A></tt> as a placeholder only. The notation
+ of <tt class="computeroutput">vector<A></tt>
+ stands for any STL container holding elements
+ of type <tt class="computeroutput">A</tt>.
+ </td></tr>
+</table></div>
+
+ The Kleene star generator will execute its embedded generator once for
+ each element in the provided container attribute and as long as the embedded
+ generator succeeds. On each iteration it will pass the next consecutive
+ element from the container attribute to the embedded generator. Therefor
+ the number of iterations will not be larger than the number of elements
+ in the container passed as its attribute. An empty container will make
+ the Kleene star to not generate any output at all.
+ 
+
+ It is important to note, that the Kleene star does not perform any buffering
+ of the output generated by its embedded elements. That means that any
+ failing element generator might have already generated some output, which
+ is not rolled back.
+ 
+<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">
+
+ The simplest way to force a Kleene star to behave as if it did buffering
+ is to wrap it into a buffering directive (see <a href="directive.html#spirit.karma.reference.directive.buffer" title=" Temporary
+ Output Buffering (buffer[])"><tt class="computeroutput">buffer[a]</tt></a>):
+ 
+
+
+
+<pre class="programlisting">buffer[*a]</pre>
+
+ 
+
+ which will not generate any output in case of
+ a failing generator <tt class="computeroutput">a</tt>.
+ The expression:
+ 
+
+
+
+<pre class="programlisting">*(buffer[a])</pre>
+
+ 
+
+ will not generate any partial output from a generator <tt class="computeroutput">a</tt> if it fails generating in the middle
+ of its output. The overall expression will still generate the output
+ as produced by all succeeded invocations of the generator <tt class="computeroutput">a</tt>.
+ 
+</td></tr>
+</table></div>
+<a name="spirit.karma.reference.operator.kleene.complexity"></a><h6>
+<a name="id555415"></a>
+ Complexity
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ The overall complexity of the Kleene star generator is defined by
+ the complexity of its embedded generator multiplied by the number
+ of executed iterations. The complexity of the Kleene star itself
+ is O(N), where N is the number of elements in the container passed
+ as its attribute.
+ 
+
+ 
+</blockquote></div>
+<a name="spirit.karma.reference.operator.kleene.example"></a><h6>
+<a name="id555457"></a>
+ Example
+ </h6>
+
+ Some includes:
+ 
+
+ 
+
+
+
+<pre class="programlisting">#include <boost/spirit/include/karma.hpp>
+#include <boost/spirit/include/phoenix_core.hpp>
+#include <boost/spirit/include/phoenix_operator.hpp>
+#include <boost/fusion/include/std_pair.hpp>
+#include <iostream>
+#include <string>
+</pre>
+
+ 
+
+ 
+
+ All code snippets below use this common test function:
+ 
+
+ 
+
+
+
+<pre class="programlisting">template <typename G, typename T>
+void test_generator_attr(char const* expected, G const& g, T const& attr)
+{
+ std::string s;
+ std::back_insert_iterator<std::string> out(s);
+ if (boost::spirit::karma::generate(out, g, attr) && str == expected)
+ std::cout << "ok" << std::endl;
+ else
+ std::cout << "fail" << std::endl;
+}
+</pre>
+
+ 
+
+ 
+
+ Some using declarations:
+ 
+
+ 
+
+
+
+<pre class="programlisting">using boost::spirit::karma::generate;
+using boost::spirit::karma::double_;
+using boost::spirit::karma::space;
+</pre>
+
+ 
+
+ 
+
+ Basic usage of a Kleene star generator:
+ 
+
+ 
+
+
+
+<pre class="programlisting">std::vector<double> v;
+v.push_back(1.0);
+v.push_back(2.0);
+v.push_back(3.0);
+test_generator_attr("1.0 2.0 3.0 ", *double_, space, v);
+</pre>
+
+ 
+
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.karma.reference.operator.plus"></a><a href="operator.html#spirit.karma.reference.operator.plus" title=" Plus (unary
+ operator+())"> Plus (unary
+ <tt class="computeroutput">operator+()</tt>)</a>
+</h5></div></div>
+<div></div>
+</div>
+<a name="spirit.karma.reference.operator.plus.description"></a><h6>
+<a name="id556706"></a>
+ Description
+ </h6>
+
+ The plus generator is used to repeat the execution of an embedded generator
+ one or more times. It succeeds if the embedded generator has been successfully
+ executed at least once.
+ 
+<a name="spirit.karma.reference.operator.plus.header"></a><h6>
+<a name="id556739"></a>
+ Header
+ </h6>
+<pre class="programlisting">// forwards to <boost/spirit/home/karma/operator/plus.hpp>
+#include <boost/spirit/include/karma_plus.hpp>
+</pre>
+
+ Also, see Include Structure.
+ 
+<a name="spirit.karma.reference.operator.plus.model_of"></a><h6>
+<a name="id556853"></a>
+ Model of
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ UnaryGenerator
+ 
+
+ 
+</blockquote></div>
+<a name="spirit.karma.reference.operator.plus.expression_semantics"></a><h6>
+<a name="id556904"></a>
+ <a href="operator.html#spirit.karma.reference.operator.plus.expression_semantics">Expression
+ Semantics</a>
+ </h6>
+
+ Semantics of an expression is defined only where it differs from, or
+ is not defined in UnaryGenerator.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Semantics
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ <tt class="computeroutput">+a</tt>
+ </td>
+<td>
+ The generator <tt class="computeroutput">a</tt>
+ is executed one or more times depending on the availability of
+ an attribute. The execution of <tt class="computeroutput">a</tt>
+ stops after the attribute values passed to the plus generator
+ are exhausted. The plus generator succeeds as long as its embedded
+ generator has been successfully executed at least once (except
+ if the underlying output stream reports an error).
+ </td>
+</tr></tbody>
+</table></div>
+<a name="spirit.karma.reference.operator.plus.attributes"></a><h6>
+<a name="id557048"></a>
+ Attributes
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Attribute
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ plus (unary <tt class="computeroutput">+</tt>)
+ </td>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">a: A --> +a: vector<A>
+a: Unused --> +a: Unused</pre>
+
+ 
+</td>
+</tr></tbody>
+</table></div>
+<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">
+ The table above uses <tt class="computeroutput">vector<A></tt> as a placeholder only. The notation
+ of <tt class="computeroutput">vector<A></tt>
+ stands for any STL container holding elements
+ of type <tt class="computeroutput">A</tt>.
+ </td></tr>
+</table></div>
+
+ The plus generator will execute its embedded generator once for each
+ element in the provided container attribute and as long as the embedded
+ generator succeeds. On each iteration it will pass the next consecutive
+ element from the container attribute to the embedded generator. Therefor
+ the number of iterations will not be larger than the number of elements
+ in the container passed as its attribute. An empty container will make
+ the plus generator fail.
+ 
+
+ It is important to note, that the plus generator does not perform any
+ buffering of the output generated by its embedded elements. That means
+ that any failing element generator might have already generated some
+ output, which is not rolled back.
+ 
+<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">
+
+ The simplest way to force a plus generator to behave as if it did buffering
+ is to wrap it into a buffering directive (see <a href="directive.html#spirit.karma.reference.directive.buffer" title=" Temporary
+ Output Buffering (buffer[])"><tt class="computeroutput">buffer[a]</tt></a>):
+ 
+
+
+
+<pre class="programlisting">buffer[+a]</pre>
+
+ 
+
+ which will not generate any output in case of
+ a failing generator <tt class="computeroutput">a</tt>.
+ The expression:
+ 
+
+
+
+<pre class="programlisting">+(buffer[a])</pre>
+
+ 
+
+ will not generate any partial output from a generator <tt class="computeroutput">a</tt> if it fails generating in the middle
+ of its output. The overall expression will still generate the output
+ as produced by all succeeded invocations of the generator <tt class="computeroutput">a</tt>.
+ 
+</td></tr>
+</table></div>
+<a name="spirit.karma.reference.operator.plus.complexity"></a><h6>
+<a name="id557516"></a>
+ Complexity
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ The overall complexity of the plus generator is defined by the complexity
+ of its embedded generator multiplied by the number of executed iterations.
+ The complexity of the plus generator itself is O(N), where N is the
+ number of elements in the container passed as its attribute.
+ 
+
+ 
+</blockquote></div>
+<a name="spirit.karma.reference.operator.plus.example"></a><h6>
+<a name="id557557"></a>
+ Example
+ </h6>
+
+ Some includes:
+ 
+
+ 
+
+
+
+<pre class="programlisting">#include <boost/spirit/include/karma.hpp>
+#include <boost/spirit/include/phoenix_core.hpp>
+#include <boost/spirit/include/phoenix_operator.hpp>
+#include <boost/fusion/include/std_pair.hpp>
+#include <iostream>
+#include <string>
+</pre>
+
+ 
+
+ 
+
+ All code snippets below use this common test function:
+ 
+
+ 
+
+
+
+<pre class="programlisting">template <typename G, typename T>
+void test_generator_attr(char const* expected, G const& g, T const& attr)
+{
+ std::string s;
+ std::back_insert_iterator<std::string> out(s);
+ if (boost::spirit::karma::generate(out, g, attr) && str == expected)
+ std::cout << "ok" << std::endl;
+ else
+ std::cout << "fail" << std::endl;
+}
+</pre>
+
+ 
+
+ 
+
+ Some using declarations:
+ 
+
+ 
+
+
+
+<pre class="programlisting">using boost::spirit::karma::generate;
+using boost::spirit::karma::double_;
+using boost::spirit::karma::space;
+</pre>
+
+ 
+
+ 
+
+ Basic usage of a plus generator:
+ 
+
+ 
+
+
+
+<pre class="programlisting">std::vector<double> v1;
+v1.push_back(1.0);
+v1.push_back(2.0);
+v1.push_back(3.0);
+test_generator_attr("1.0 2.0 3.0 ", +double_, space, v1);
+</pre>
+
+ 
+
+ 
+
+ A more sophisticated use case showing how to leverage the fact that plus
+ is failing for empty containers passed as its attribute:
+ 
+
+ 
+
+
+
+<pre class="programlisting">std::vector<double> v2; // empty container
+test_generator_attr("empty", +double_ | "empty", v2);
+</pre>
+
+ 
+
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.karma.reference.operator.list"></a> Lists (operator%())
+</h5></div></div>
+<div></div>
+</div>
+<a name="spirit.karma.reference.operator.list.description"></a><h6>
+<a name="id558935"></a>
+ Description
+ </h6>
+
+ The list generator is used to repeat the execution of an embedded generator
+ and interspace it with the output of anyother generator one or more times.
+ It succeeds if the embedded generator has been successfully executed
+ at least once.
+ 
+<a name="spirit.karma.reference.operator.list.header"></a><h6>
+<a name="id558968"></a>
+ Header
+ </h6>
+<pre class="programlisting">// forwards to <boost/spirit/home/karma/operator/list.hpp>
+#include <boost/spirit/include/karma_list.hpp>
+</pre>
+
+ Also, see Include Structure.
+ 
+<a name="spirit.karma.reference.operator.list.model_of"></a><h6>
+<a name="id559082"></a>
+ Model of
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ BinaryGenerator
+ 
+
+ 
+</blockquote></div>
+<a name="spirit.karma.reference.operator.list.expression_semantics"></a><h6>
+<a name="id559134"></a>
+ <a href="operator.html#spirit.karma.reference.operator.list.expression_semantics">Expression
+ Semantics</a>
+ </h6>
+
+ Semantics of an expression is defined only where it differs from, or
+ is not defined in BinaryGenerator.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Semantics
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ <tt class="computeroutput">a %
+ b</tt>
+ </td>
+<td>
+ The generator <tt class="computeroutput">a</tt>
+ is executed one or more times depending on the availability of
+ an attribute. The output generated by <tt class="computeroutput">a</tt>
+ is interspaced with the output generated by <tt class="computeroutput">b</tt>.
+ The list generator succeeds as long as both its first embedded
+ generator has been successfully executed at least once (except
+ if the underlying output stream reports an error).
+ </td>
+</tr></tbody>
+</table></div>
+
+ The list expression <tt class="computeroutput">a % b</tt>
+ is a shortcut for <tt class="computeroutput">a << *(b <<
+ a)</tt>.
+ It is almost semantically equivalent, except for the attribute of <tt class="computeroutput">b</tt>, which gets ignored in the case of
+ the list generator.
+ 
+<a name="spirit.karma.reference.operator.list.attributes"></a><h6>
+<a name="id559392"></a>
+ Attributes
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Attribute
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ list (<tt class="computeroutput">%</tt>)
+ </td>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">a: A, b: B --> (a % b): vector<A>
+a: Unused, b: B --> (a % b): Unused</pre>
+
+ 
+</td>
+</tr></tbody>
+</table></div>
+<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">
+ The table above uses <tt class="computeroutput">vector<A></tt> as a placeholder only. The notation
+ of <tt class="computeroutput">vector<A></tt>
+ stands for any STL container holding elements
+ of type <tt class="computeroutput">A</tt>.
+ </td></tr>
+</table></div>
+
+ The list generator will execute its embedded generator once for each
+ element in the provided container attribute and as long as the embedded
+ generator succeeds. The output generated by its first generator will
+ be interspaced by the output generated by the second generator. On each
+ iteration it will pass the next consecutive element from the container
+ attribute to the first embedded generator. The second embedded generator
+ does not get passed any attributes (it gets invoked using an <tt class="computeroutput">unused_type</tt> as its attribute). Therefor
+ the number of iterations will not be larger than the number of elements
+ in the container passed as its attribute. An empty container will make
+ the list generator fail.
+ 
+<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">
+
+ If you want to use the list generator and still allow for an empty
+ attribute, you can use the optional operator (see <a href="operator.html#spirit.karma.reference.operator.optional" title=" Optional
+ (unary operator-())">optional
+ (unary <tt class="computeroutput">-</tt>)</a>):
+ 
+
+
+
+<pre class="programlisting">-(a % b)</pre>
+
+ 
+
+ which will succeed even if the provided container attribute does not
+ contain any elements.
+ 
+</td></tr>
+</table></div>
+
+ It is important to note, that the list generator does not perform any
+ buffering of the output generated by its embedded elements. That means
+ that any failing element generator might have already generated some
+ output, which is not rolled back.
+ 
+<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">
+
+ The simplest way to force a list generator to behave as if it did buffering
+ is to wrap it into a buffering directive (see <a href="directive.html#spirit.karma.reference.directive.buffer" title=" Temporary
+ Output Buffering (buffer[])"><tt class="computeroutput">buffer[a]</tt></a>):
+ 
+
+
+
+<pre class="programlisting">buffer[a % b]</pre>
+
+ 
+
+ which will not generate any output in case of
+ a failing generator <tt class="computeroutput">a</tt>.
+ 
+</td></tr>
+</table></div>
+<a name="spirit.karma.reference.operator.list.complexity"></a><h6>
+<a name="id559962"></a>
+ Complexity
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ The overall complexity of the list generator is defined by the complexity
+ of its embedded generators multiplied by the number of executed iterations.
+ The complexity of the list generator itself is O(N), where N is the
+ number of elements in the container passed as its attribute.
+ 
+
+ 
+</blockquote></div>
+<a name="spirit.karma.reference.operator.list.example"></a><h6>
+<a name="id560003"></a>
+ Example
+ </h6>
+
+ Some includes:
+ 
+
+ 
+
+
+
+<pre class="programlisting">#include <boost/spirit/include/karma.hpp>
+#include <boost/spirit/include/phoenix_core.hpp>
+#include <boost/spirit/include/phoenix_operator.hpp>
+#include <boost/fusion/include/std_pair.hpp>
+#include <iostream>
+#include <string>
+</pre>
+
+ 
+
+ 
+
+ All code snippets below use this common test function:
+ 
+
+ 
+
+
+
+<pre class="programlisting">template <typename G, typename T>
+void test_generator_attr(char const* expected, G const& g, T const& attr)
+{
+ std::string s;
+ std::back_insert_iterator<std::string> out(s);
+ if (boost::spirit::karma::generate(out, g, attr) && str == expected)
+ std::cout << "ok" << std::endl;
+ else
+ std::cout << "fail" << std::endl;
+}
+</pre>
+
+ 
+
+ 
+
+ Some using declarations:
+ 
+
+ 
+
+
+
+<pre class="programlisting">using boost::spirit::karma::generate;
+using boost::spirit::karma::double_;
+</pre>
+
+ 
+
+ 
+
+ Basic usage of a list generator:
+ 
+
+ 
+
+
+
+<pre class="programlisting">std::vector<double> v1;
+v1.push_back(1.0);
+test_generator_attr("1.0", double_ % ',', v1);
+
+v1.push_back(2.0);
+test_generator_attr("1.0,2.0", double_ % ',', v1);
+</pre>
+
+ 
+
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.karma.reference.operator.optional"></a><a href="operator.html#spirit.karma.reference.operator.optional" title=" Optional
+ (unary operator-())"> Optional
+ (unary <tt class="computeroutput">operator-()</tt>)</a>
+</h5></div></div>
+<div></div>
+</div>
+<a name="spirit.karma.reference.operator.optional.description"></a><h6>
+<a name="id561226"></a>
+ Description
+ </h6>
+
+ The optional generator is used to conditionally execute an embedded generator.
+ It succeeds always.
+ 
+<a name="spirit.karma.reference.operator.optional.header"></a><h6>
+<a name="id561257"></a>
+ Header
+ </h6>
+<pre class="programlisting">// forwards to <boost/spirit/home/karma/operator/optional.hpp>
+#include <boost/spirit/include/karma_optional.hpp>
+</pre>
+
+ Also, see Include Structure.
+ 
+<a name="spirit.karma.reference.operator.optional.model_of"></a><h6>
+<a name="id561371"></a>
+ <a href="operator.html#spirit.karma.reference.operator.optional.model_of">Model
+ of</a>
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ UnaryGenerator
+ 
+
+ 
+</blockquote></div>
+<a name="spirit.karma.reference.operator.optional.expression_semantics"></a><h6>
+<a name="id561424"></a>
+ <a href="operator.html#spirit.karma.reference.operator.optional.expression_semantics">Expression
+ Semantics</a>
+ </h6>
+
+ Semantics of an expression is defined only where it differs from, or
+ is not defined in UnaryGenerator.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Semantics
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ <tt class="computeroutput">-a</tt>
+ </td>
+<td>
+ The generator <tt class="computeroutput">a</tt>
+ is executed depending on the availability of an attribute. The
+ optional generator succeeds as long as its embedded generator
+ succeeds (except if the underlying output stream reports an error).
+ </td>
+</tr></tbody>
+</table></div>
+<a name="spirit.karma.reference.operator.optional.attributes"></a><h6>
+<a name="id561561"></a>
+ Attributes
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Attribute
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ optional (unary <tt class="computeroutput">-</tt>)
+ </td>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">a: A --> -a: optional<A>
+a: Unused --> -a: Unused</pre>
+
+ 
+</td>
+</tr></tbody>
+</table></div>
+<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">
+ The table above uses <tt class="computeroutput">optional<A></tt> as a placeholder only. The notation
+ of <tt class="computeroutput">optional<A></tt>
+ stands for the data type <tt class="computeroutput">boost::optional<A></tt>.
+ </td></tr>
+</table></div>
+
+ The optional generator will execute its embedded generator once if the
+ provided attribute holds a valid value. It forwards the value held in
+ its attribute to the embedded generator.
+ 
+
+ It is important to note, that the optional generator does not perform
+ any buffering of the output generated by its embedded elements. That
+ means that any failing element might have already generated some output,
+ which is not rolled back.
+ 
+<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">
+
+ The simplest way to force a optional generator to behave as if it did
+ buffering is to wrap it into a buffering directive (see <a href="directive.html#spirit.karma.reference.directive.buffer" title=" Temporary
+ Output Buffering (buffer[])"><tt class="computeroutput">buffer[a]</tt></a>):
+ 
+
+
+
+<pre class="programlisting">buffer[-a]</pre>
+
+ 
+
+ which will not generate any output in case of
+ a failing generator <tt class="computeroutput">a</tt>.
+ 
+</td></tr>
+</table></div>
+<a name="spirit.karma.reference.operator.optional.complexity"></a><h6>
+<a name="id561977"></a>
+ Complexity
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ The overall complexity of the optional generator is defined by the
+ complexity of its embedded generator. The complexity of the optional
+ generator itself is O(1).
+ 
+
+ 
+</blockquote></div>
+<a name="spirit.karma.reference.operator.optional.example"></a><h6>
+<a name="id562016"></a>
+ Example
+ </h6>
+
+ Some includes:
+ 
+
+ 
+
+
+
+<pre class="programlisting">#include <boost/spirit/include/karma.hpp>
+#include <boost/spirit/include/phoenix_core.hpp>
+#include <boost/spirit/include/phoenix_operator.hpp>
+#include <boost/fusion/include/std_pair.hpp>
+#include <iostream>
+#include <string>
+</pre>
+
+ 
+
+ 
+
+ All code snippets below use this common test function:
+ 
+
+ 
+
+
+
+<pre class="programlisting">template <typename G, typename T>
+void test_generator_attr(char const* expected, G const& g, T const& attr)
+{
+ std::string s;
+ std::back_insert_iterator<std::string> out(s);
+ if (boost::spirit::karma::generate(out, g, attr) && str == expected)
+ std::cout << "ok" << std::endl;
+ else
+ std::cout << "fail" << std::endl;
+}
+</pre>
+
+ 
+
+ 
+
+ Some using declarations:
+ 
+
+ 
+
+
+
+<pre class="programlisting">using boost::spirit::karma::generate;
+using boost::spirit::karma::double_;
+</pre>
+
+ 
+
+ 
+
+ Basic usage of an optional generator:
+ 
+
+ 
+
+
+
+<pre class="programlisting">boost::optional<double> val(1.0);
+test_generator_attr("1.0", -double_, val);
+test_generator_attr("2.0", -double_, 2.0);
+</pre>
+
+ 
+
+ 
+
+ Usage and result of an empty optional generator:
+ 
+
+ 
+
+
+
+<pre class="programlisting">boost::optional<double> val; // empty optional
+test_generator_attr("", -double_, val);
+</pre>
+
+ 
+
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.karma.reference.operator.and_predicate"></a><a href="operator.html#spirit.karma.reference.operator.and_predicate" title=" And
+ Predicate (unary operator&())"> And
+ Predicate (unary <tt class="computeroutput">operator&()</tt>)</a>
+</h5></div></div>
+<div></div>
+</div>
+<a name="spirit.karma.reference.operator.and_predicate.description"></a><h6>
+<a name="id563286"></a>
+ Description
+ </h6>
+
+ The and predicate generator is used to test, whether the embedded generator
+ succeeds without generating any output. It succeeds if the embedded generator
+ succeeds.
+ 
+<a name="spirit.karma.reference.operator.and_predicate.header"></a><h6>
+<a name="id563319"></a>
+ Header
+ </h6>
+<pre class="programlisting">// forwards to <boost/spirit/home/karma/operator/and_predicate.hpp>
+#include <boost/spirit/include/karma_and_predicate.hpp>
+</pre>
+
+ Also, see Include Structure.
+ 
+<a name="spirit.karma.reference.operator.and_predicate.model_of"></a><h6>
+<a name="id563435"></a>
+ <a href="operator.html#spirit.karma.reference.operator.and_predicate.model_of">Model
+ of</a>
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ UnaryGenerator
+ 
+
+ 
+</blockquote></div>
+<a name="spirit.karma.reference.operator.and_predicate.expression_semantics"></a><h6>
+<a name="id563490"></a>
+ <a href="operator.html#spirit.karma.reference.operator.and_predicate.expression_semantics">Expression
+ Semantics</a>
+ </h6>
+
+ Semantics of an expression is defined only where it differs from, or
+ is not defined in UnaryGenerator.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Semantics
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ <tt class="computeroutput">&a</tt>
+ </td>
+<td>
+ The generator <tt class="computeroutput">a</tt>
+ is executed for the sole purpose of testing whether it succeeds.
+ The and predicate generator succeeds as long as its embedded
+ generator succeeds (except if the underlying output stream reports
+ an error). The and predicate never produces any output.
+ </td>
+</tr></tbody>
+</table></div>
+
+ The and generator is implemented by redirecting all output produced by
+ its embedded generator into a discarding device.
+ 
+<a name="spirit.karma.reference.operator.and_predicate.attributes"></a><h6>
+<a name="id563634"></a>
+ Attributes
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Attribute
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ and predicate (unary <tt class="computeroutput">&</tt>)
+ </td>
+<td>
+ <tt class="computeroutput">a:
+ A -->
+ &a: A</tt>
+ </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">
+ The attribute of the and predicate is not always <tt class="computeroutput">Unused</tt>,
+ which is different from Qi's and predicate. This is necessary as the
+ generator the and predicate is attached to most of the time needs an
+ attribute.
+ </td></tr>
+</table></div>
+<a name="spirit.karma.reference.operator.and_predicate.complexity"></a><h6>
+<a name="id563799"></a>
+ Complexity
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ The overall complexity of the and predicate generator is defined
+ by the complexity of its embedded generator. The complexity of the
+ and predicate generator itself is O(1).
+ 
+
+ 
+</blockquote></div>
+<a name="spirit.karma.reference.operator.and_predicate.example"></a><h6>
+<a name="id563839"></a>
+ Example
+ </h6>
+
+ Some includes:
+ 
+
+ 
+
+
+
+<pre class="programlisting">#include <boost/spirit/include/karma.hpp>
+#include <boost/spirit/include/phoenix_core.hpp>
+#include <boost/spirit/include/phoenix_operator.hpp>
+#include <boost/fusion/include/std_pair.hpp>
+#include <iostream>
+#include <string>
+</pre>
+
+ 
+
+ 
+
+ All code snippets below use this common test function:
+ 
+
+ 
+
+
+
+<pre class="programlisting">template <typename G>
+void test_generator(char const* expected, G const& g)
+{
+ std::string s;
+ std::back_insert_iterator<std::string> out(s);
+ if (boost::spirit::karma::generate(out, g) && str == expected)
+ std::cout << "ok" << std::endl;
+ else
+ std::cout << "fail" << std::endl;
+}
+</pre>
+
+ 
+
+ 
+
+ Some using declarations:
+ 
+
+ 
+
+
+
+<pre class="programlisting">using boost::spirit::karma::generate;
+using boost::spirit::karma::double_;
+using boost::spirit::karma::ascii::char_;
+using boost::spirit::karma::ascii::string;
+using boost::phoenix::ref;
+</pre>
+
+ 
+
+ 
+
+ Basic usage of an and predicate generator:
+ 
+
+ 
+
+
+
+<pre class="programlisting">test_generator_attr("b", &char_('a') << 'b' | 'c', 'a');
+test_generator_attr("c", &char_('a') << 'b' | 'c', 'x');
+
+test_generator_attr("abc", &string("123") << "abc" | "def", "123");
+test_generator_attr("def", &string("123") << "abc" | "def", "456");
+</pre>
+
+ 
+
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.karma.reference.operator.not_predicate"></a><a href="operator.html#spirit.karma.reference.operator.not_predicate" title=" Not
+ Predicate (unary operator!())"> Not
+ Predicate (unary <tt class="computeroutput">operator!()</tt>)</a>
+</h5></div></div>
+<div></div>
+</div>
+<a name="spirit.karma.reference.operator.not_predicate.description"></a><h6>
+<a name="id565292"></a>
+ Description
+ </h6>
+
+ The not predicate generator is used to test, whether the embedded generator
+ fails, without generating any output. It succeeds if the embedded generator
+ fails.
+ 
+<a name="spirit.karma.reference.operator.not_predicate.header"></a><h6>
+<a name="id565324"></a>
+ Header
+ </h6>
+<pre class="programlisting">// forwards to <boost/spirit/home/karma/operator/not_predicate.hpp>
+#include <boost/spirit/include/karma_not_predicate.hpp>
+</pre>
+
+ Also, see Include Structure.
+ 
+<a name="spirit.karma.reference.operator.not_predicate.model_of"></a><h6>
+<a name="id565438"></a>
+ <a href="operator.html#spirit.karma.reference.operator.not_predicate.model_of">Model
+ of</a>
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ UnaryGenerator
+ 
+
+ 
+</blockquote></div>
+<a name="spirit.karma.reference.operator.not_predicate.expression_semantics"></a><h6>
+<a name="id565493"></a>
+ <a href="operator.html#spirit.karma.reference.operator.not_predicate.expression_semantics">Expression
+ Semantics</a>
+ </h6>
+
+ Semantics of an expression is defined only where it differs from, or
+ is not defined in UnaryGenerator.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Semantics
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ <tt class="computeroutput">!a</tt>
+ </td>
+<td>
+ The generator <tt class="computeroutput">a</tt>
+ is executed for the sole purpose of testing whether it succeeds.
+ The not predicate generator succeeds as long as its embedded
+ generator fails (except if the underlying output stream reports
+ an error). The not predicate never produces any output.
+ </td>
+</tr></tbody>
+</table></div>
+
+ The not generator is implemented by redirecting all output produced by
+ its embedded generator into a discarding device.
+ 
+<a name="spirit.karma.reference.operator.not_predicate.attributes"></a><h6>
+<a name="id565638"></a>
+ Attributes
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Attribute
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ not predicate (unary <tt class="computeroutput">!</tt>)
+ </td>
+<td>
+ <tt class="computeroutput">a:
+ A -->
+ !a: A</tt>
+ </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">
+ The attribute of the and predicate is not always <tt class="computeroutput">Unused</tt>,
+ which is different from Qi's and predicate. This is necessary as the
+ generator the and predicate is attached to most of the time needs an
+ attribute.
+ </td></tr>
+</table></div>
+<a name="spirit.karma.reference.operator.not_predicate.complexity"></a><h6>
+<a name="id565803"></a>
+ Complexity
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ The overall complexity of the not predicate generator is defined
+ by the complexity of its embedded generator. The complexity of the
+ not predicate generator itself is O(1).
+ 
+
+ 
+</blockquote></div>
+<a name="spirit.karma.reference.operator.not_predicate.example"></a><h6>
+<a name="id565843"></a>
+ Example
+ </h6>
+
+ Some includes:
+ 
+
+ 
+
+
+
+<pre class="programlisting">#include <boost/spirit/include/karma.hpp>
+#include <boost/spirit/include/phoenix_core.hpp>
+#include <boost/spirit/include/phoenix_operator.hpp>
+#include <boost/fusion/include/std_pair.hpp>
+#include <iostream>
+#include <string>
+</pre>
+
+ 
+
+ 
+
+ All code snippets below use this common test function:
+ 
+
+ 
+
+
+
+<pre class="programlisting">template <typename G, typename T>
+void test_generator_attr(char const* expected, G const& g, T const& attr)
+{
+ std::string s;
+ std::back_insert_iterator<std::string> out(s);
+ if (boost::spirit::karma::generate(out, g, attr) && str == expected)
+ std::cout << "ok" << std::endl;
+ else
+ std::cout << "fail" << std::endl;
+}
+</pre>
+
+ 
+
+ 
+
+ Some using declarations:
+ 
+
+ 
+
+
+
+<pre class="programlisting">using boost::spirit::karma::generate;
+using boost::spirit::karma::double_;
+using boost::spirit::karma::ascii::char_;
+using boost::spirit::karma::ascii::string;
+using boost::phoenix::ref;
+</pre>
+
+ 
+
+ 
+
+ Basic usage of a not predicate generator:
+ 
+
+ 
+
+
+
+<pre class="programlisting">test_generator_attr("c", !char_('a') << 'b' | 'c', 'a');
+test_generator_attr("b", !char_('a') << 'b' | 'c', 'x');
+
+test_generator_attr("def", !string("123") << "abc" | "def", "123");
+test_generator_attr("abc", !string("123") << "abc" | "def", "456");
+</pre>
+
+ 
+
+ 
+</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
@@ -77,7 +2142,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="directive/omit.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="operator/sequence.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+<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="auxiliary.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>

Modified: trunk/libs/spirit/doc/html/spirit/karma/reference/operator/alternative.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/karma/reference/operator/alternative.html (original)
+++ trunk/libs/spirit/doc/html/spirit/karma/reference/operator/alternative.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -35,7 +35,7 @@
<div></div>
</div>
<a name="spirit.karma.reference.operator.alternative.description"></a><h6>
-<a name="id551724"></a>
+<a name="id552025"></a>
 <a href="alternative.html#spirit.karma.reference.operator.alternative.description">Description</a>
 </h6>

@@ -44,7 +44,7 @@
 from left to right until one of them succeeds.
 
<a name="spirit.karma.reference.operator.alternative.header"></a><h6>
-<a name="id551756"></a>
+<a name="id552057"></a>
 <a href="alternative.html#spirit.karma.reference.operator.alternative.header">Header</a>
 </h6>
<pre class="programlisting">// forwards to <boost/spirit/home/karma/operator/alternative.hpp>
@@ -54,7 +54,7 @@
 Also, see Include Structure.
 
<a name="spirit.karma.reference.operator.alternative.model_of"></a><h6>
-<a name="id551871"></a>
+<a name="id552172"></a>
 <a href="alternative.html#spirit.karma.reference.operator.alternative.model_of">Model
 of</a>
 </h6>
@@ -68,7 +68,7 @@
 
</blockquote></div>
<a name="spirit.karma.reference.operator.alternative.expression_semantics"></a><h6>
-<a name="id551925"></a>
+<a name="id552226"></a>
 <a href="alternative.html#spirit.karma.reference.operator.alternative.expression_semantics">Expression
 Semantics</a>
 </h6>
@@ -112,7 +112,7 @@
 an element succeeded.
 
<a name="spirit.karma.reference.operator.alternative.attributes"></a><h6>
-<a name="id552092"></a>
+<a name="id552394"></a>
 <a href="alternative.html#spirit.karma.reference.operator.alternative.attributes">Attributes</a>
 </h6>
<div class="informaltable"><table class="table">
@@ -168,7 +168,7 @@
 an example of this behavior.
 
<a name="spirit.karma.reference.operator.alternative.complexity"></a><h6>
-<a name="id552763"></a>
+<a name="id553065"></a>
 <a href="alternative.html#spirit.karma.reference.operator.alternative.complexity">Complexity</a>
 </h6>
<div class="blockquote"><blockquote class="blockquote">
@@ -184,7 +184,7 @@
 
</blockquote></div>
<a name="spirit.karma.reference.operator.alternative.example"></a><h6>
-<a name="id552803"></a>
+<a name="id553105"></a>
 <a href="alternative.html#spirit.karma.reference.operator.alternative.example">Example</a>
 </h6>

Modified: trunk/libs/spirit/doc/html/spirit/karma/reference/operator/and_predicate.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/karma/reference/operator/and_predicate.html (original)
+++ trunk/libs/spirit/doc/html/spirit/karma/reference/operator/and_predicate.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -35,7 +35,7 @@
<div></div>
</div>
<a name="spirit.karma.reference.operator.and_predicate.description"></a><h6>
-<a name="id562984"></a>
+<a name="id563286"></a>
 <a href="and_predicate.html#spirit.karma.reference.operator.and_predicate.description">Description</a>
 </h6>

@@ -44,7 +44,7 @@
 succeeds.
 
<a name="spirit.karma.reference.operator.and_predicate.header"></a><h6>
-<a name="id563017"></a>
+<a name="id563319"></a>
 <a href="and_predicate.html#spirit.karma.reference.operator.and_predicate.header">Header</a>
 </h6>
<pre class="programlisting">// forwards to <boost/spirit/home/karma/operator/and_predicate.hpp>
@@ -54,7 +54,7 @@
 Also, see Include Structure.
 
<a name="spirit.karma.reference.operator.and_predicate.model_of"></a><h6>
-<a name="id563133"></a>
+<a name="id563435"></a>
 <a href="and_predicate.html#spirit.karma.reference.operator.and_predicate.model_of">Model
 of</a>
 </h6>
@@ -68,7 +68,7 @@
 
</blockquote></div>
<a name="spirit.karma.reference.operator.and_predicate.expression_semantics"></a><h6>
-<a name="id563188"></a>
+<a name="id563490"></a>
 <a href="and_predicate.html#spirit.karma.reference.operator.and_predicate.expression_semantics">Expression
 Semantics</a>
 </h6>
@@ -107,7 +107,7 @@
 its embedded generator into a discarding device.
 
<a name="spirit.karma.reference.operator.and_predicate.attributes"></a><h6>
-<a name="id563332"></a>
+<a name="id563634"></a>
 <a href="and_predicate.html#spirit.karma.reference.operator.and_predicate.attributes">Attributes</a>
 </h6>
<div class="informaltable"><table class="table">
@@ -147,7 +147,7 @@
 </td></tr>
</table></div>
<a name="spirit.karma.reference.operator.and_predicate.complexity"></a><h6>
-<a name="id563498"></a>
+<a name="id563799"></a>
 <a href="and_predicate.html#spirit.karma.reference.operator.and_predicate.complexity">Complexity</a>
 </h6>
<div class="blockquote"><blockquote class="blockquote">
@@ -162,7 +162,7 @@
 
</blockquote></div>
<a name="spirit.karma.reference.operator.and_predicate.example"></a><h6>
-<a name="id563538"></a>
+<a name="id563839"></a>
 <a href="and_predicate.html#spirit.karma.reference.operator.and_predicate.example">Example</a>
 </h6>

Modified: trunk/libs/spirit/doc/html/spirit/karma/reference/operator/kleene.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/karma/reference/operator/kleene.html (original)
+++ trunk/libs/spirit/doc/html/spirit/karma/reference/operator/kleene.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -35,7 +35,7 @@
<div></div>
</div>
<a name="spirit.karma.reference.operator.kleene.description"></a><h6>
-<a name="id554299"></a>
+<a name="id554601"></a>
 <a href="kleene.html#spirit.karma.reference.operator.kleene.description">Description</a>
 </h6>

@@ -44,7 +44,7 @@
 generator, the Kleene star generator always succeeds.
 
<a name="spirit.karma.reference.operator.kleene.header"></a><h6>
-<a name="id554332"></a>
+<a name="id554634"></a>
 <a href="kleene.html#spirit.karma.reference.operator.kleene.header">Header</a>
 </h6>
<pre class="programlisting">// forwards to <boost/spirit/home/karma/operator/kleene.hpp>
@@ -54,7 +54,7 @@
 Also, see Include Structure.
 
<a name="spirit.karma.reference.operator.kleene.model_of"></a><h6>
-<a name="id554446"></a>
+<a name="id554748"></a>
 <a href="kleene.html#spirit.karma.reference.operator.kleene.model_of">Model
 of</a>
 </h6>
@@ -68,7 +68,7 @@
 
</blockquote></div>
<a name="spirit.karma.reference.operator.kleene.expression_semantics"></a><h6>
-<a name="id554497"></a>
+<a name="id554799"></a>
 <a href="kleene.html#spirit.karma.reference.operator.kleene.expression_semantics">Expression
 Semantics</a>
 </h6>
@@ -104,7 +104,7 @@
</tr></tbody>
</table></div>
<a name="spirit.karma.reference.operator.kleene.attributes"></a><h6>
-<a name="id554646"></a>
+<a name="id554948"></a>
 <a href="kleene.html#spirit.karma.reference.operator.kleene.attributes">Attributes</a>
 </h6>
<div class="informaltable"><table class="table">
@@ -198,7 +198,7 @@
</td></tr>
</table></div>
<a name="spirit.karma.reference.operator.kleene.complexity"></a><h6>
-<a name="id555113"></a>
+<a name="id555415"></a>
 <a href="kleene.html#spirit.karma.reference.operator.kleene.complexity">Complexity</a>
 </h6>
<div class="blockquote"><blockquote class="blockquote">
@@ -215,7 +215,7 @@
 
</blockquote></div>
<a name="spirit.karma.reference.operator.kleene.example"></a><h6>
-<a name="id555156"></a>
+<a name="id555457"></a>
 <a href="kleene.html#spirit.karma.reference.operator.kleene.example">Example</a>
 </h6>

Modified: trunk/libs/spirit/doc/html/spirit/karma/reference/operator/list.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/karma/reference/operator/list.html (original)
+++ trunk/libs/spirit/doc/html/spirit/karma/reference/operator/list.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -32,7 +32,7 @@
<div></div>
</div>
<a name="spirit.karma.reference.operator.list.description"></a><h6>
-<a name="id558633"></a>
+<a name="id558935"></a>
 <a href="list.html#spirit.karma.reference.operator.list.description">Description</a>
 </h6>

@@ -42,7 +42,7 @@
 at least once.
 
<a name="spirit.karma.reference.operator.list.header"></a><h6>
-<a name="id558667"></a>
+<a name="id558968"></a>
 <a href="list.html#spirit.karma.reference.operator.list.header">Header</a>
 </h6>
<pre class="programlisting">// forwards to <boost/spirit/home/karma/operator/list.hpp>
@@ -52,7 +52,7 @@
 Also, see Include Structure.
 
<a name="spirit.karma.reference.operator.list.model_of"></a><h6>
-<a name="id558781"></a>
+<a name="id559082"></a>
 <a href="list.html#spirit.karma.reference.operator.list.model_of">Model of</a>
 </h6>
<div class="blockquote"><blockquote class="blockquote">
@@ -65,7 +65,7 @@
 
</blockquote></div>
<a name="spirit.karma.reference.operator.list.expression_semantics"></a><h6>
-<a name="id558834"></a>
+<a name="id559134"></a>
 <a href="list.html#spirit.karma.reference.operator.list.expression_semantics">Expression
 Semantics</a>
 </h6>
@@ -110,7 +110,7 @@
 the list generator.
 
<a name="spirit.karma.reference.operator.list.attributes"></a><h6>
-<a name="id559090"></a>
+<a name="id559392"></a>
 <a href="list.html#spirit.karma.reference.operator.list.attributes">Attributes</a>
 </h6>
<div class="informaltable"><table class="table">
@@ -219,7 +219,7 @@
</td></tr>
</table></div>
<a name="spirit.karma.reference.operator.list.complexity"></a><h6>
-<a name="id559660"></a>
+<a name="id559962"></a>
 <a href="list.html#spirit.karma.reference.operator.list.complexity">Complexity</a>
 </h6>
<div class="blockquote"><blockquote class="blockquote">
@@ -235,7 +235,7 @@
 
</blockquote></div>
<a name="spirit.karma.reference.operator.list.example"></a><h6>
-<a name="id559702"></a>
+<a name="id560003"></a>
 <a href="list.html#spirit.karma.reference.operator.list.example">Example</a>
 </h6>

Modified: trunk/libs/spirit/doc/html/spirit/karma/reference/operator/not_predicate.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/karma/reference/operator/not_predicate.html (original)
+++ trunk/libs/spirit/doc/html/spirit/karma/reference/operator/not_predicate.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -34,7 +34,7 @@
<div></div>
</div>
<a name="spirit.karma.reference.operator.not_predicate.description"></a><h6>
-<a name="id564990"></a>
+<a name="id565292"></a>
 <a href="not_predicate.html#spirit.karma.reference.operator.not_predicate.description">Description</a>
 </h6>

@@ -43,7 +43,7 @@
 fails.
 
<a name="spirit.karma.reference.operator.not_predicate.header"></a><h6>
-<a name="id565022"></a>
+<a name="id565324"></a>
 <a href="not_predicate.html#spirit.karma.reference.operator.not_predicate.header">Header</a>
 </h6>
<pre class="programlisting">// forwards to <boost/spirit/home/karma/operator/not_predicate.hpp>
@@ -53,7 +53,7 @@
 Also, see Include Structure.
 
<a name="spirit.karma.reference.operator.not_predicate.model_of"></a><h6>
-<a name="id565137"></a>
+<a name="id565438"></a>
 <a href="not_predicate.html#spirit.karma.reference.operator.not_predicate.model_of">Model
 of</a>
 </h6>
@@ -67,7 +67,7 @@
 
</blockquote></div>
<a name="spirit.karma.reference.operator.not_predicate.expression_semantics"></a><h6>
-<a name="id565192"></a>
+<a name="id565493"></a>
 <a href="not_predicate.html#spirit.karma.reference.operator.not_predicate.expression_semantics">Expression
 Semantics</a>
 </h6>
@@ -106,7 +106,7 @@
 its embedded generator into a discarding device.
 
<a name="spirit.karma.reference.operator.not_predicate.attributes"></a><h6>
-<a name="id565336"></a>
+<a name="id565638"></a>
 <a href="not_predicate.html#spirit.karma.reference.operator.not_predicate.attributes">Attributes</a>
 </h6>
<div class="informaltable"><table class="table">
@@ -146,7 +146,7 @@
 </td></tr>
</table></div>
<a name="spirit.karma.reference.operator.not_predicate.complexity"></a><h6>
-<a name="id565501"></a>
+<a name="id565803"></a>
 <a href="not_predicate.html#spirit.karma.reference.operator.not_predicate.complexity">Complexity</a>
 </h6>
<div class="blockquote"><blockquote class="blockquote">
@@ -161,7 +161,7 @@
 
</blockquote></div>
<a name="spirit.karma.reference.operator.not_predicate.example"></a><h6>
-<a name="id565542"></a>
+<a name="id565843"></a>
 <a href="not_predicate.html#spirit.karma.reference.operator.not_predicate.example">Example</a>
 </h6>

Modified: trunk/libs/spirit/doc/html/spirit/karma/reference/operator/optional.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/karma/reference/operator/optional.html (original)
+++ trunk/libs/spirit/doc/html/spirit/karma/reference/operator/optional.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -34,7 +34,7 @@
<div></div>
</div>
<a name="spirit.karma.reference.operator.optional.description"></a><h6>
-<a name="id560925"></a>
+<a name="id561226"></a>
 <a href="optional.html#spirit.karma.reference.operator.optional.description">Description</a>
 </h6>

@@ -42,7 +42,7 @@
 It succeeds always.
 
<a name="spirit.karma.reference.operator.optional.header"></a><h6>
-<a name="id560956"></a>
+<a name="id561257"></a>
 <a href="optional.html#spirit.karma.reference.operator.optional.header">Header</a>
 </h6>
<pre class="programlisting">// forwards to <boost/spirit/home/karma/operator/optional.hpp>
@@ -52,7 +52,7 @@
 Also, see Include Structure.
 
<a name="spirit.karma.reference.operator.optional.model_of"></a><h6>
-<a name="id561069"></a>
+<a name="id561371"></a>
 <a href="optional.html#spirit.karma.reference.operator.optional.model_of">Model
 of</a>
 </h6>
@@ -66,7 +66,7 @@
 
</blockquote></div>
<a name="spirit.karma.reference.operator.optional.expression_semantics"></a><h6>
-<a name="id561123"></a>
+<a name="id561424"></a>
 <a href="optional.html#spirit.karma.reference.operator.optional.expression_semantics">Expression
 Semantics</a>
 </h6>
@@ -100,7 +100,7 @@
</tr></tbody>
</table></div>
<a name="spirit.karma.reference.operator.optional.attributes"></a><h6>
-<a name="id561259"></a>
+<a name="id561561"></a>
 <a href="optional.html#spirit.karma.reference.operator.optional.attributes">Attributes</a>
 </h6>
<div class="informaltable"><table class="table">
@@ -177,7 +177,7 @@
</td></tr>
</table></div>
<a name="spirit.karma.reference.operator.optional.complexity"></a><h6>
-<a name="id561676"></a>
+<a name="id561977"></a>
 <a href="optional.html#spirit.karma.reference.operator.optional.complexity">Complexity</a>
 </h6>
<div class="blockquote"><blockquote class="blockquote">
@@ -192,7 +192,7 @@
 
</blockquote></div>
<a name="spirit.karma.reference.operator.optional.example"></a><h6>
-<a name="id561714"></a>
+<a name="id562016"></a>
 <a href="optional.html#spirit.karma.reference.operator.optional.example">Example</a>
 </h6>

Modified: trunk/libs/spirit/doc/html/spirit/karma/reference/operator/plus.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/karma/reference/operator/plus.html (original)
+++ trunk/libs/spirit/doc/html/spirit/karma/reference/operator/plus.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -34,7 +34,7 @@
<div></div>
</div>
<a name="spirit.karma.reference.operator.plus.description"></a><h6>
-<a name="id556404"></a>
+<a name="id556706"></a>
 <a href="plus.html#spirit.karma.reference.operator.plus.description">Description</a>
 </h6>

@@ -43,7 +43,7 @@
 executed at least once.
 
<a name="spirit.karma.reference.operator.plus.header"></a><h6>
-<a name="id556437"></a>
+<a name="id556739"></a>
 <a href="plus.html#spirit.karma.reference.operator.plus.header">Header</a>
 </h6>
<pre class="programlisting">// forwards to <boost/spirit/home/karma/operator/plus.hpp>
@@ -53,7 +53,7 @@
 Also, see Include Structure.
 
<a name="spirit.karma.reference.operator.plus.model_of"></a><h6>
-<a name="id556551"></a>
+<a name="id556853"></a>
 <a href="plus.html#spirit.karma.reference.operator.plus.model_of">Model of</a>
 </h6>
<div class="blockquote"><blockquote class="blockquote">
@@ -66,7 +66,7 @@
 
</blockquote></div>
<a name="spirit.karma.reference.operator.plus.expression_semantics"></a><h6>
-<a name="id556602"></a>
+<a name="id556904"></a>
 <a href="plus.html#spirit.karma.reference.operator.plus.expression_semantics">Expression
 Semantics</a>
 </h6>
@@ -103,7 +103,7 @@
</tr></tbody>
</table></div>
<a name="spirit.karma.reference.operator.plus.attributes"></a><h6>
-<a name="id556747"></a>
+<a name="id557048"></a>
 <a href="plus.html#spirit.karma.reference.operator.plus.attributes">Attributes</a>
 </h6>
<div class="informaltable"><table class="table">
@@ -197,7 +197,7 @@
</td></tr>
</table></div>
<a name="spirit.karma.reference.operator.plus.complexity"></a><h6>
-<a name="id557214"></a>
+<a name="id557516"></a>
 <a href="plus.html#spirit.karma.reference.operator.plus.complexity">Complexity</a>
 </h6>
<div class="blockquote"><blockquote class="blockquote">
@@ -213,7 +213,7 @@
 
</blockquote></div>
<a name="spirit.karma.reference.operator.plus.example"></a><h6>
-<a name="id557255"></a>
+<a name="id557557"></a>
 <a href="plus.html#spirit.karma.reference.operator.plus.example">Example</a>
 </h6>

Modified: trunk/libs/spirit/doc/html/spirit/karma/reference/operator/sequence.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/karma/reference/operator/sequence.html (original)
+++ trunk/libs/spirit/doc/html/spirit/karma/reference/operator/sequence.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -34,7 +34,7 @@
<div></div>
</div>
<a name="spirit.karma.reference.operator.sequence.description"></a><h6>
-<a name="id549030"></a>
+<a name="id549331"></a>
 <a href="sequence.html#spirit.karma.reference.operator.sequence.description">Description</a>
 </h6>

@@ -43,7 +43,7 @@
 to right as long as they succeed.
 
<a name="spirit.karma.reference.operator.sequence.header"></a><h6>
-<a name="id549062"></a>
+<a name="id549363"></a>
 <a href="sequence.html#spirit.karma.reference.operator.sequence.header">Header</a>
 </h6>
<pre class="programlisting">// forwards to <boost/spirit/home/karma/operator/sequence.hpp>
@@ -53,7 +53,7 @@
 Also, see Include Structure.
 
<a name="spirit.karma.reference.operator.sequence.model_of"></a><h6>
-<a name="id549175"></a>
+<a name="id549476"></a>
 <a href="sequence.html#spirit.karma.reference.operator.sequence.model_of">Model
 of</a>
 </h6>
@@ -67,7 +67,7 @@
 
</blockquote></div>
<a name="spirit.karma.reference.operator.sequence.expression_semantics"></a><h6>
-<a name="id549228"></a>
+<a name="id549529"></a>
 <a href="sequence.html#spirit.karma.reference.operator.sequence.expression_semantics">Expression
 Semantics</a>
 </h6>
@@ -132,7 +132,7 @@
</td></tr>
</table></div>
<a name="spirit.karma.reference.operator.sequence.attributes"></a><h6>
-<a name="id549502"></a>
+<a name="id549803"></a>
 <a href="sequence.html#spirit.karma.reference.operator.sequence.attributes">Attributes</a>
 </h6>
<div class="informaltable"><table class="table">
@@ -199,7 +199,7 @@
 the attribute supplied
 
<a name="spirit.karma.reference.operator.sequence.complexity"></a><h6>
-<a name="id550577"></a>
+<a name="id550879"></a>
 <a href="sequence.html#spirit.karma.reference.operator.sequence.complexity">Complexity</a>
 </h6>
<div class="blockquote"><blockquote class="blockquote">
@@ -214,7 +214,7 @@
 
</blockquote></div>
<a name="spirit.karma.reference.operator.sequence.example"></a><h6>
-<a name="id550617"></a>
+<a name="id550918"></a>
 <a href="sequence.html#spirit.karma.reference.operator.sequence.example">Example</a>
 </h6>

Modified: trunk/libs/spirit/doc/html/spirit/karma/tutorials/karma_attributes.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/karma/tutorials/karma_attributes.html (original)
+++ trunk/libs/spirit/doc/html/spirit/karma/tutorials/karma_attributes.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -35,7 +35,7 @@
<div></div>
</div>
<a name="spirit.karma.tutorials.karma_attributes.attributes_of_primitive_generators"></a><h5>
-<a name="id474636"></a>
+<a name="id474928"></a>
 <a href="karma_attributes.html#spirit.karma.tutorials.karma_attributes.attributes_of_primitive_generators">Attributes
 of Primitive Generators</a>
 </h5>
@@ -67,7 +67,7 @@
generate(out, double_, 1);
</pre>
<a name="spirit.karma.tutorials.karma_attributes.attributes_of_compound_generators"></a><h5>
-<a name="id474932"></a>
+<a name="id475243"></a>
 <a href="karma_attributes.html#spirit.karma.tutorials.karma_attributes.attributes_of_compound_generators">Attributes
 of Compound Generators</a>
 </h5>
@@ -127,7 +127,7 @@
 Attribute Rules</a>.
 
<a name="spirit.karma.tutorials.karma_attributes.the_attribute_of_sequence_generators"></a><h5>
-<a name="id475436"></a>
+<a name="id475747"></a>
 <a href="karma_attributes.html#spirit.karma.tutorials.karma_attributes.the_attribute_of_sequence_generators">The
 Attribute of Sequence Generators</a>
 </h5>
@@ -194,7 +194,7 @@
</td></tr>
</table></div>
<a name="spirit.karma.tutorials.karma_attributes.the_attribute_of_alternative_generators"></a><h5>
-<a name="id476051"></a>
+<a name="id476362"></a>
 <a href="karma_attributes.html#spirit.karma.tutorials.karma_attributes.the_attribute_of_alternative_generators">The
 Attribute of Alternative Generators</a>
 </h5>
@@ -223,7 +223,7 @@
 well. We will apply this rule later for our complex number generators.
 
<a name="spirit.karma.tutorials.karma_attributes.more_about_attributes_of_compound_generators"></a><h5>
-<a name="id476340"></a>
+<a name="id476650"></a>
 <a href="karma_attributes.html#spirit.karma.tutorials.karma_attributes.more_about_attributes_of_compound_generators">More
 About Attributes of Compound Generators</a>
 </h5>
@@ -330,7 +330,7 @@
 again, allowing to simplify the overall attribute type of an expression.
 
<a name="spirit.karma.tutorials.karma_attributes.attributes_of_rules_and_grammars"></a><h5>
-<a name="id477414"></a>
+<a name="id477725"></a>
 <a href="karma_attributes.html#spirit.karma.tutorials.karma_attributes.attributes_of_rules_and_grammars">Attributes
 of Rules and Grammars</a>
 </h5>

Modified: trunk/libs/spirit/doc/html/spirit/karma/tutorials/quick_start.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/karma/tutorials/quick_start.html (original)
+++ trunk/libs/spirit/doc/html/spirit/karma/tutorials/quick_start.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -30,7 +30,7 @@
<div></div>
</div>
<a name="spirit.karma.tutorials.quick_start.spirit_karma___what_s_that_"></a><h5>
-<a name="id469822"></a>
+<a name="id470105"></a>
 <a href="quick_start.html#spirit.karma.tutorials.quick_start.spirit_karma___what_s_that_">Spirit.Karma
 - what's that?</a>
 </h5>

Modified: trunk/libs/spirit/doc/html/spirit/karma/tutorials/semantic_actions.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/karma/tutorials/semantic_actions.html (original)
+++ trunk/libs/spirit/doc/html/spirit/karma/tutorials/semantic_actions.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -273,7 +273,7 @@
 The examples above can be found here: actions.cpp
 
<a name="spirit.karma.tutorials.semantic_actions.phoenix"></a><h5>
-<a name="id473334"></a>
+<a name="id473626"></a>
 <a href="semantic_actions.html#spirit.karma.tutorials.semantic_actions.phoenix">Phoenix</a>
 </h5>

Modified: trunk/libs/spirit/doc/html/spirit/karma/tutorials/warming_up.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/karma/tutorials/warming_up.html (original)
+++ trunk/libs/spirit/doc/html/spirit/karma/tutorials/warming_up.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -34,7 +34,7 @@
 We will start from trivial examples, ramping up as we go.
 
<a name="spirit.karma.tutorials.warming_up.trivial_example__1_generating_a_number"></a><h5>
-<a name="id470027"></a>
+<a name="id470321"></a>
 <a href="warming_up.html#spirit.karma.tutorials.warming_up.trivial_example__1_generating_a_number">Trivial
 Example #1 Generating a number</a>
 </h5>
@@ -54,7 +54,7 @@
 to a floating point generator or parser: <tt class="computeroutput">double_</tt>.
 
<a name="spirit.karma.tutorials.warming_up.trivial_example__2_generating_two_numbers"></a><h5>
-<a name="id470113"></a>
+<a name="id470392"></a>
 <a href="warming_up.html#spirit.karma.tutorials.warming_up.trivial_example__2_generating_two_numbers">Trivial
 Example #2 Generating two numbers</a>
 </h5>
@@ -92,7 +92,7 @@
 </td></tr>
</table></div>
<a name="spirit.karma.tutorials.warming_up.trivial_example__3_generating_one_or_more_numbers"></a><h5>
-<a name="id470260"></a>
+<a name="id470539"></a>
 <a href="warming_up.html#spirit.karma.tutorials.warming_up.trivial_example__3_generating_one_or_more_numbers">Trivial
 Example #3 Generating one or more numbers</a>
 </h5>
@@ -117,7 +117,7 @@
 numbers, if needed.
 
<a name="spirit.karma.tutorials.warming_up.trivial_example__4_generating_a_comma_delimited_list_of_numbers"></a><h5>
-<a name="id470342"></a>
+<a name="id470634"></a>
 <a href="warming_up.html#spirit.karma.tutorials.warming_up.trivial_example__4_generating_a_comma_delimited_list_of_numbers">Trivial
 Example #4 Generating a comma-delimited list of numbers</a>
 </h5>
@@ -140,7 +140,7 @@
 in the generated output zero or more times.
 
<a name="spirit.karma.tutorials.warming_up.let_s_generate_"></a><h5>
-<a name="id470541"></a>
+<a name="id470833"></a>
 <a href="warming_up.html#spirit.karma.tutorials.warming_up.let_s_generate_">Let's
 Generate!</a>
 </h5>

Modified: trunk/libs/spirit/doc/html/spirit/lex.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/lex.html (original)
+++ trunk/libs/spirit/doc/html/spirit/lex.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -6,8 +6,8 @@
<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
<link rel="home" href="../index.html" title="Spirit 2.1">
<link rel="up" href="../index.html" title="Spirit 2.1">
-<link rel="previous" href="karma/performance_measurements/numeric_performance/format_performance.html" title="
- Comparing the performance of a sequence of several generators">
+<link rel="previous" href="karma/performance_measurements/numeric_performance.html" title="
+ Performance of Numeric Generators">
<link rel="next" href="lex/lexer_introduction.html" title=" Introduction to Spirit.Lex">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@@ -21,7 +21,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="karma/performance_measurements/numeric_performance/format_performance.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="lex/lexer_introduction.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="karma/performance_measurements/numeric_performance.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="lex/lexer_introduction.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage">
@@ -79,7 +79,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="karma/performance_measurements/numeric_performance/format_performance.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="lex/lexer_introduction.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="karma/performance_measurements/numeric_performance.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="lex/lexer_introduction.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>

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

Modified: trunk/libs/spirit/doc/html/spirit/lex/abstracts/lexer_primitives/lexer_token_values.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/lex/abstracts/lexer_primitives/lexer_token_values.html (original)
+++ trunk/libs/spirit/doc/html/spirit/lex/abstracts/lexer_primitives/lexer_token_values.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -58,7 +58,7 @@
 of the Spirit.Lex library.
 
<a name="spirit.lex.abstracts.lexer_primitives.lexer_token_values.the_anatomy_of_a_token"></a><h6>
-<a name="id586586"></a>
+<a name="id586760"></a>
 <a href="lexer_token_values.html#spirit.lex.abstracts.lexer_primitives.lexer_token_values.the_anatomy_of_a_token">The
 Anatomy of a Token</a>
 </h6>
@@ -195,7 +195,7 @@
 when it is requested for the first time.
 
<a name="spirit.lex.abstracts.lexer_primitives.lexer_token_values.the_physiognomy_of_a_token_definition"></a><h6>
-<a name="id587348"></a>
+<a name="id587528"></a>
 <a href="lexer_token_values.html#spirit.lex.abstracts.lexer_primitives.lexer_token_values.the_physiognomy_of_a_token_definition">The
 Physiognomy of a Token Definition</a>
 </h6>
@@ -268,7 +268,7 @@
</td></tr>
</table></div>
<a name="spirit.lex.abstracts.lexer_primitives.lexer_token_values.examples_of_using__link_linkend__spirit_lex_reference_token_class___code__phrase_role__identifier__lexertl_token__phrase__phrase_role__special___lt__gt___phrase___code___link_"></a><h6>
-<a name="id587760"></a>
+<a name="id587938"></a>
 <a href="lexer_token_values.html#spirit.lex.abstracts.lexer_primitives.lexer_token_values.examples_of_using__link_linkend__spirit_lex_reference_token_class___code__phrase_role__identifier__lexertl_token__phrase__phrase_role__special___lt__gt___phrase___code___link_">Examples
 of using lexertl_token<></a>
 </h6>

Modified: trunk/libs/spirit/doc/html/spirit/lex/abstracts/lexer_semantic_actions.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/lex/abstracts/lexer_semantic_actions.html (original)
+++ trunk/libs/spirit/doc/html/spirit/lex/abstracts/lexer_semantic_actions.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -112,7 +112,7 @@
void f ();
</pre>
<a name="spirit.lex.abstracts.lexer_semantic_actions.the_context_of_a_lexer_semantic_action"></a><h5>
-<a name="id592477"></a>
+<a name="id592656"></a>
 <a href="lexer_semantic_actions.html#spirit.lex.abstracts.lexer_semantic_actions.the_context_of_a_lexer_semantic_action">The
 context of a lexer semantic action</a>
 </h5>
@@ -127,7 +127,7 @@
 of the available functionality.
 
<div class="table">
-<a name="id592521"></a>Table 26. Functions exposed by any context passed to a lexer
+<a name="id592700"></a>Table 18. Functions exposed by any context passed to a lexer
 semantic action
<table class="table" summary="Functions exposed by any context passed to a lexer
 semantic action">
@@ -220,7 +220,7 @@
</table>
</div>
<a name="spirit.lex.abstracts.lexer_semantic_actions.lexer_semantic_actions_using_phoenix"></a><h5>
-<a name="id593245"></a>
+<a name="id593424"></a>
 <a href="lexer_semantic_actions.html#spirit.lex.abstracts.lexer_semantic_actions.lexer_semantic_actions_using_phoenix">Lexer
 Semantic Actions Using Phoenix</a>
 </h5>
@@ -232,7 +232,7 @@
 predefined Spirit placeholders:
 
<div class="table">
-<a name="id593287"></a>Table 27. Predefined Phoenix placeholders for lexer semantic
+<a name="id593466"></a>Table 19. Predefined Phoenix placeholders for lexer semantic
 actions
<table class="table" summary="Predefined Phoenix placeholders for lexer semantic
 actions">
@@ -331,7 +331,7 @@
 table lists the available support functions and describes their functionality:
 
<div class="table">
-<a name="id593667"></a>Table 28. Support functions usable from Phoenix expressions
+<a name="id593846"></a>Table 20. Support functions usable from Phoenix expressions
 inside lexer semantic actions
<table class="table" summary="Support functions usable from Phoenix expressions
 inside lexer semantic actions">

Modified: trunk/libs/spirit/doc/html/spirit/lex/abstracts/lexer_states.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/lex/abstracts/lexer_states.html (original)
+++ trunk/libs/spirit/doc/html/spirit/lex/abstracts/lexer_states.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -30,17 +30,17 @@
<div></div>
</div>
<a name="spirit.lex.abstracts.lexer_states.controlling_the_lexer_state_from_lexer_semantic_actions"></a><h5>
-<a name="id597570"></a>
+<a name="id602017"></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="id597598"></a>
+<a name="id602045"></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="id597627"></a>
+<a name="id602073"></a>
 <a href="lexer_states.html#spirit.lex.abstracts.lexer_states.using_a_lexer_state_for_the_skip_parser">Using
 a Lexer State for the Skip Parser</a>
 </h5>

Modified: trunk/libs/spirit/doc/html/spirit/lex/abstracts/lexer_static_model.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/lex/abstracts/lexer_static_model.html (original)
+++ trunk/libs/spirit/doc/html/spirit/lex/abstracts/lexer_static_model.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -183,7 +183,7 @@

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

Modified: trunk/libs/spirit/doc/html/spirit/lex/abstracts/lexer_tokenizing.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/lex/abstracts/lexer_tokenizing.html (original)
+++ trunk/libs/spirit/doc/html/spirit/lex/abstracts/lexer_tokenizing.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -7,8 +7,7 @@
<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
<link rel="home" href="../../../index.html" title="Spirit 2.1">
<link rel="up" href="../abstracts.html" title=" Abstracts">
-<link rel="previous" href="lexer_primitives/lexer_token_definition.html" title="
- Ways to define Tokens">
+<link rel="previous" href="lexer_primitives.html" title="Lexer Primitives">
<link rel="next" href="lexer_semantic_actions.html" title=" Lexer
 Semantic Actions">
</head>
@@ -23,7 +22,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="lexer_primitives/lexer_token_definition.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../abstracts.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="lexer_semantic_actions.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="lexer_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="lexer_semantic_actions.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage">
@@ -35,7 +34,7 @@
<div></div>
</div>
<a name="spirit.lex.abstracts.lexer_tokenizing.the_tokenize_function"></a><h5>
-<a name="id588567"></a>
+<a name="id588746"></a>
 <a href="lexer_tokenizing.html#spirit.lex.abstracts.lexer_tokenizing.the_tokenize_function">The
 tokenize function</a>
 </h5>
@@ -237,7 +236,7 @@
</dl>
</div>
<a name="spirit.lex.abstracts.lexer_tokenizing.the_generate_static_function"></a><h5>
-<a name="id591572"></a>
+<a name="id591751"></a>
 <a href="lexer_tokenizing.html#spirit.lex.abstracts.lexer_tokenizing.the_generate_static_function">The
 generate_static function</a>
 </h5>
@@ -253,7 +252,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="lexer_primitives/lexer_token_definition.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../abstracts.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="lexer_semantic_actions.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="lexer_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="lexer_semantic_actions.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>

Modified: trunk/libs/spirit/doc/html/spirit/lex/lexer_introduction.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/lex/lexer_introduction.html (original)
+++ trunk/libs/spirit/doc/html/spirit/lex/lexer_introduction.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -60,7 +60,7 @@
 </li>
</ul></div>
<a name="spirit.lex.lexer_introduction.why_use_a_separate_lexer_"></a><h4>
-<a name="id574440"></a>
+<a name="id574757"></a>
 <a href="lexer_introduction.html#spirit.lex.lexer_introduction.why_use_a_separate_lexer_">Why
 Use a Separate Lexer?</a>
 </h4>
@@ -159,7 +159,7 @@
 grammar recognizers.
 
<a name="spirit.lex.lexer_introduction.advantages_of_using__emphasis_spirit_lex__emphasis_"></a><h4>
-<a name="id574818"></a>
+<a name="id575108"></a>
 <a href="lexer_introduction.html#spirit.lex.lexer_introduction.advantages_of_using__emphasis_spirit_lex__emphasis_">Advantages
 of using Spirit.Lex</a>
 </h4>
@@ -208,7 +208,7 @@
 application.
 
<a name="spirit.lex.lexer_introduction.the_library_structure_of__emphasis_spirit_lex__emphasis_"></a><h4>
-<a name="id574989"></a>
+<a name="id575280"></a>
 <a href="lexer_introduction.html#spirit.lex.lexer_introduction.the_library_structure_of__emphasis_spirit_lex__emphasis_">The
 Library Structure of Spirit.Lex</a>
 </h4>

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

Modified: trunk/libs/spirit/doc/html/spirit/lex/reference/concepts/lexer.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/lex/reference/concepts/lexer.html (original)
+++ trunk/libs/spirit/doc/html/spirit/lex/reference/concepts/lexer.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -30,7 +30,7 @@
<div></div>
</div>
<div class="table">
-<a name="id597723"></a>Table 29. Regular expressions support
+<a name="id602169"></a>Table 21. Regular expressions support
<table class="table" summary="Regular expressions support">
<colgroup>
<col>
@@ -361,7 +361,7 @@
 </td></tr>
</table></div>
<a name="spirit.lex.reference.concepts.lexer.regular_expression_precedence"></a><h6>
-<a name="id604080"></a>
+<a name="id604258"></a>
 <a href="lexer.html#spirit.lex.reference.concepts.lexer.regular_expression_precedence">Regular
 Expression Precedence</a>
 </h6>
@@ -380,7 +380,7 @@
 </li>
</ul></div>
<a name="spirit.lex.reference.concepts.lexer.macros"></a><h6>
-<a name="id604236"></a>
+<a name="id604415"></a>
 <a href="lexer.html#spirit.lex.reference.concepts.lexer.macros">Macros</a>
 </h6>

Modified: trunk/libs/spirit/doc/html/spirit/lex/reference/lexer_class.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/lex/reference/lexer_class.html (original)
+++ trunk/libs/spirit/doc/html/spirit/lex/reference/lexer_class.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -6,7 +6,7 @@
<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
<link rel="home" href="../../../index.html" title="Spirit 2.1">
<link rel="up" href="../reference.html" title=" Reference">
-<link rel="previous" href="concepts/tokendef.html" title="TokenDef">
+<link rel="previous" href="concepts.html" title=" Concepts">
<link rel="next" href="token_class.html" title="Token Class">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@@ -20,7 +20,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="concepts/tokendef.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="token_class.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="concepts.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="token_class.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage">
@@ -30,22 +30,22 @@
<div></div>
</div>
<a name="spirit.lex.reference.lexer_class.the_lexertl_lexer_class_implementing_the_dynamic_model"></a><h5>
-<a name="id604426"></a>
+<a name="id604605"></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="id604453"></a>
+<a name="id604632"></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="id604481"></a>
+<a name="id604660"></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="id604510"></a>
+<a name="id604689"></a>
 <a href="lexer_class.html#spirit.lex.reference.lexer_class.the_lexertl_static_actor_lexer_class_implementing_the_static_model">The
 lexertl_static_actor_lexer Class Implementing the Static Model</a>
 </h5>
@@ -61,7 +61,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="concepts/tokendef.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="token_class.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="concepts.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="token_class.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>

Modified: trunk/libs/spirit/doc/html/spirit/lex/tutorials/lexer_quickstart1.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/lex/tutorials/lexer_quickstart1.html (original)
+++ trunk/libs/spirit/doc/html/spirit/lex/tutorials/lexer_quickstart1.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -47,7 +47,7 @@
 (for the full example code see here: word_count_functor.cpp).
 
<a name="spirit.lex.tutorials.lexer_quickstart1.prerequisites"></a><h5>
-<a name="id353166"></a>
+<a name="id575736"></a>
 <a href="lexer_quickstart1.html#spirit.lex.tutorials.lexer_quickstart1.prerequisites">Prerequisites</a>
 </h5>

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

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

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

 
<a name="spirit.lex.tutorials.lexer_quickstart1.comparing__emphasis_spirit_lex__emphasis__with__ulink_url__http___flex_sourceforge_net___flex__ulink_"></a><h5>
-<a name="id578189"></a>
+<a name="id578362"></a>
 <a href="lexer_quickstart1.html#spirit.lex.tutorials.lexer_quickstart1.comparing__emphasis_spirit_lex__emphasis__with__ulink_url__http___flex_sourceforge_net___flex__ulink_">Comparing
 Spirit.Lex with Flex</a>
 </h5>

Modified: trunk/libs/spirit/doc/html/spirit/lex/tutorials/lexer_quickstart2.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/lex/tutorials/lexer_quickstart2.html (original)
+++ trunk/libs/spirit/doc/html/spirit/lex/tutorials/lexer_quickstart2.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -49,7 +49,7 @@
 options along the lines (for the full example code see here: word_count_lexer.cpp).
 
<a name="spirit.lex.tutorials.lexer_quickstart2.prerequisites"></a><h5>
-<a name="id579247"></a>
+<a name="id579419"></a>
 <a href="lexer_quickstart2.html#spirit.lex.tutorials.lexer_quickstart2.prerequisites">Prerequisites</a>
 </h5>

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

 
<a name="spirit.lex.tutorials.lexer_quickstart2.semantic_actions_in__emphasis_spirit_lex__emphasis_"></a><h5>
-<a name="id580136"></a>
+<a name="id580309"></a>
 <a href="lexer_quickstart2.html#spirit.lex.tutorials.lexer_quickstart2.semantic_actions_in__emphasis_spirit_lex__emphasis_">Semantic
 Actions in Spirit.Lex</a>
 </h5>
@@ -183,7 +183,7 @@
 Semantic Actions</a>.
 
<a name="spirit.lex.tutorials.lexer_quickstart2.associating_token_definitions_with_the_lexer"></a><h5>
-<a name="id580992"></a>
+<a name="id581165"></a>
 <a href="lexer_quickstart2.html#spirit.lex.tutorials.lexer_quickstart2.associating_token_definitions_with_the_lexer">Associating
 Token Definitions with the Lexer</a>
 </h5>
@@ -220,7 +220,7 @@
 with the constant defined by <tt class="computeroutput">boost::spirit::lex::min_token_id</tt>.
 
<a name="spirit.lex.tutorials.lexer_quickstart2.pulling_everything_together"></a><h5>
-<a name="id581418"></a>
+<a name="id581591"></a>
 <a href="lexer_quickstart2.html#spirit.lex.tutorials.lexer_quickstart2.pulling_everything_together">Pulling
 everything together</a>
 </h5>

Modified: trunk/libs/spirit/doc/html/spirit/lex/tutorials/lexer_quickstart3.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/lex/tutorials/lexer_quickstart3.html (original)
+++ trunk/libs/spirit/doc/html/spirit/lex/tutorials/lexer_quickstart3.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -74,7 +74,7 @@
 code see here: word_count.cpp).
 
<a name="spirit.lex.tutorials.lexer_quickstart3.prerequisites"></a><h5>
-<a name="id582845"></a>
+<a name="id583018"></a>
 <a href="lexer_quickstart3.html#spirit.lex.tutorials.lexer_quickstart3.prerequisites">Prerequisites</a>
 </h5>

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

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

 
<a name="spirit.lex.tutorials.lexer_quickstart3.using_token_definition_instances_as_parsers"></a><h5>
-<a name="id583925"></a>
+<a name="id584098"></a>
 <a href="lexer_quickstart3.html#spirit.lex.tutorials.lexer_quickstart3.using_token_definition_instances_as_parsers">Using
 Token Definition Instances as Parsers</a>
 </h5>
@@ -304,7 +304,7 @@
 do support the this attribute model as well. The most natural way of implementing
 this was to use the token values as the attributes exposed by the parser
 component corresponding to the token definition (you can read more about
- this topic here: <a href="../abstracts/lexer_primitives/lexer_token_values.html" title="
+ this topic here: <a href="../abstracts/lexer_primitives.html#spirit.lex.abstracts.lexer_primitives.lexer_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
@@ -318,7 +318,7 @@
 size(_1)</tt>.
 
<a name="spirit.lex.tutorials.lexer_quickstart3.pulling_everything_together"></a><h5>
-<a name="id585133"></a>
+<a name="id585307"></a>
 <a href="lexer_quickstart3.html#spirit.lex.tutorials.lexer_quickstart3.pulling_everything_together">Pulling
 Everything Together</a>
 </h5>

Modified: trunk/libs/spirit/doc/html/spirit/qi/quick_reference/compound_attribute_rules.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/qi/quick_reference/compound_attribute_rules.html (original)
+++ trunk/libs/spirit/doc/html/spirit/qi/quick_reference/compound_attribute_rules.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -46,7 +46,7 @@
b</tt> will be <tt class="computeroutput">tuple<A, B></tt>.

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

Modified: trunk/libs/spirit/doc/html/spirit/qi/quick_reference/qi_parsers.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/qi/quick_reference/qi_parsers.html (original)
+++ trunk/libs/spirit/doc/html/spirit/qi/quick_reference/qi_parsers.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -30,9 +30,24 @@
</h4></div></div>
<div></div>
</div>
-<div class="table">
-<a name="id439751"></a>Table 4. char
-<table class="table" summary="char">
+<div class="toc"><dl>
+<dt>char</dt>
+<dt>numeric</dt>
+<dt>string</dt>
+<dt>auxiliary</dt>
+<dt>binary</dt>
+<dt>directive</dt>
+<dt>operator</dt>
+<dt>action</dt>
+</dl></div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.qi.quick_reference.qi_parsers.char"></a>char
+</h5></div></div>
+<div></div>
+</div>
+<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
@@ -40,222 +55,228 @@
</colgroup>
<thead><tr>
<th>
- Expression
- </th>
+ Expression
+ </th>
<th>
- Attribute
- </th>
+ Attribute
+ </th>
<th>
- Description
- </th>
+ Description
+ </th>
</tr></thead>
<tbody>
<tr>
<td>
- <tt class="computeroutput">char_</tt>
- </td>
+ <tt class="computeroutput">char_</tt>
+ </td>
<td>
- <tt class="computeroutput">Ch</tt>
- </td>
+ <tt class="computeroutput">Ch</tt>
+ </td>
<td>
- Matches any character
- </td>
+ Matches any character
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">char_(ch)</tt>
- </td>
+ <tt class="computeroutput">char_(ch)</tt>
+ </td>
<td>
- <tt class="computeroutput">Ch</tt>
- </td>
+ <tt class="computeroutput">Ch</tt>
+ </td>
<td>
- Matches <tt class="computeroutput">ch</tt>
- </td>
+ Matches <tt class="computeroutput">ch</tt>
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">char_("c")</tt>
- </td>
+ <tt class="computeroutput">char_("c")</tt>
+ </td>
<td>
- <tt class="computeroutput">Ch</tt>
- </td>
+ <tt class="computeroutput">Ch</tt>
+ </td>
<td>
- Matches a single char string literal, <tt class="computeroutput">c</tt>
- </td>
+ Matches a single char string literal, <tt class="computeroutput">c</tt>
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">char_(ch, ch2)</tt>
- </td>
+ <tt class="computeroutput">char_(ch,
+ ch2)</tt>
+ </td>
<td>
- <tt class="computeroutput">Ch</tt>
- </td>
+ <tt class="computeroutput">Ch</tt>
+ </td>
<td>
- Matches a range of chars from <tt class="computeroutput">ch</tt>
- to <tt class="computeroutput">ch2</tt> (inclusive)
- </td>
+ Matches a range of chars from <tt class="computeroutput">ch</tt>
+ to <tt class="computeroutput">ch2</tt> (inclusive)
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">char_(charset)</tt>
- </td>
+ <tt class="computeroutput">char_(charset)</tt>
+ </td>
<td>
- <tt class="computeroutput">Ch</tt>
- </td>
+ <tt class="computeroutput">Ch</tt>
+ </td>
<td>
- Matches a character set <tt class="computeroutput">charset</tt>
- </td>
+ Matches a character set <tt class="computeroutput">charset</tt>
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">alnum</tt>
- </td>
+ <tt class="computeroutput">alnum</tt>
+ </td>
<td>
- <tt class="computeroutput">Ch</tt>
- </td>
+ <tt class="computeroutput">Ch</tt>
+ </td>
<td>
- Matches a character based on the equivalent of <tt class="computeroutput">std::isalnum</tt>
- in the current character set
- </td>
+ Matches a character based on the equivalent of <tt class="computeroutput">std::isalnum</tt> in the current character
+ set
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">alpha</tt>
- </td>
+ <tt class="computeroutput">alpha</tt>
+ </td>
<td>
- <tt class="computeroutput">Ch</tt>
- </td>
+ <tt class="computeroutput">Ch</tt>
+ </td>
<td>
- Matches a character based on the equivalent of <tt class="computeroutput">std::isalpha</tt>
- in the current character set
- </td>
+ Matches a character based on the equivalent of <tt class="computeroutput">std::isalpha</tt> in the current character
+ set
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">blank</tt>
- </td>
+ <tt class="computeroutput">blank</tt>
+ </td>
<td>
- <tt class="computeroutput">Ch</tt>
- </td>
+ <tt class="computeroutput">Ch</tt>
+ </td>
<td>
- Matches a character based on the equivalent of <tt class="computeroutput">std::isblank</tt>
- in the current character set
- </td>
+ Matches a character based on the equivalent of <tt class="computeroutput">std::isblank</tt> in the current character
+ set
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">cntrl</tt>
- </td>
+ <tt class="computeroutput">cntrl</tt>
+ </td>
<td>
- <tt class="computeroutput">Ch</tt>
- </td>
+ <tt class="computeroutput">Ch</tt>
+ </td>
<td>
- Matches a character based on the equivalent of <tt class="computeroutput">std::iscntrl</tt>
- in the current character set
- </td>
+ Matches a character based on the equivalent of <tt class="computeroutput">std::iscntrl</tt> in the current character
+ set
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">digit</tt>
- </td>
+ <tt class="computeroutput">digit</tt>
+ </td>
<td>
- <tt class="computeroutput">Ch</tt>
- </td>
+ <tt class="computeroutput">Ch</tt>
+ </td>
<td>
- Matches a character based on the equivalent of <tt class="computeroutput">std::isdigit</tt>
- in the current character set
- </td>
+ Matches a character based on the equivalent of <tt class="computeroutput">std::isdigit</tt> in the current character
+ set
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">graph</tt>
- </td>
+ <tt class="computeroutput">graph</tt>
+ </td>
<td>
- <tt class="computeroutput">Ch</tt>
- </td>
+ <tt class="computeroutput">Ch</tt>
+ </td>
<td>
- Matches a character based on the equivalent of <tt class="computeroutput">std::isgraph</tt>
- in the current character set
- </td>
+ Matches a character based on the equivalent of <tt class="computeroutput">std::isgraph</tt> in the current character
+ set
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">print</tt>
- </td>
+ <tt class="computeroutput">print</tt>
+ </td>
<td>
- <tt class="computeroutput">Ch</tt>
- </td>
+ <tt class="computeroutput">Ch</tt>
+ </td>
<td>
- Matches a character based on the equivalent of <tt class="computeroutput">std::isprint</tt>
- in the current character set
- </td>
+ Matches a character based on the equivalent of <tt class="computeroutput">std::isprint</tt> in the current character
+ set
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">punct</tt>
- </td>
+ <tt class="computeroutput">punct</tt>
+ </td>
<td>
- <tt class="computeroutput">Ch</tt>
- </td>
+ <tt class="computeroutput">Ch</tt>
+ </td>
<td>
- Matches a character based on the equivalent of <tt class="computeroutput">std::ispunct</tt>
- in the current character set
- </td>
+ Matches a character based on the equivalent of <tt class="computeroutput">std::ispunct</tt> in the current character
+ set
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">space</tt>
- </td>
+ <tt class="computeroutput">space</tt>
+ </td>
<td>
- <tt class="computeroutput">Ch</tt>
- </td>
+ <tt class="computeroutput">Ch</tt>
+ </td>
<td>
- Matches a character based on the equivalent of <tt class="computeroutput">std::isspace</tt>
- in the current character set
- </td>
+ Matches a character based on the equivalent of <tt class="computeroutput">std::isspace</tt> in the current character
+ set
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">xdigit</tt>
- </td>
+ <tt class="computeroutput">xdigit</tt>
+ </td>
<td>
- <tt class="computeroutput">Ch</tt>
- </td>
+ <tt class="computeroutput">Ch</tt>
+ </td>
<td>
- Matches a character based on the equivalent of <tt class="computeroutput">std::isxdigit</tt>
- in the current character set
- </td>
+ Matches a character based on the equivalent of <tt class="computeroutput">std::isxdigit</tt> in the current character
+ set
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">lower</tt>
- </td>
+ <tt class="computeroutput">lower</tt>
+ </td>
<td>
- <tt class="computeroutput">Ch</tt>
- </td>
+ <tt class="computeroutput">Ch</tt>
+ </td>
<td>
- Matches a character based on the equivalent of <tt class="computeroutput">std::islower</tt>
- in the current character set
- </td>
+ Matches a character based on the equivalent of <tt class="computeroutput">std::islower</tt> in the current character
+ set
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">upper</tt>
- </td>
+ <tt class="computeroutput">upper</tt>
+ </td>
<td>
- <tt class="computeroutput">Ch</tt>
- </td>
+ <tt class="computeroutput">Ch</tt>
+ </td>
<td>
- Matches a character based on the equivalent of <tt class="computeroutput">std::isupper</tt>
- in the current character set
- </td>
+ Matches a character based on the equivalent of <tt class="computeroutput">std::isupper</tt> in the current character
+ set
+ </td>
</tr>
</tbody>
-</table>
+</table></div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.qi.quick_reference.qi_parsers.numeric"></a>numeric
+</h5></div></div>
+<div></div>
</div>
-<div class="table">
-<a name="id440989"></a>Table 5. numeric
-<table class="table" summary="numeric">
+<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
@@ -263,178 +284,183 @@
</colgroup>
<thead><tr>
<th>
- Expression
- </th>
+ Expression
+ </th>
<th>
- Attribute
- </th>
+ Attribute
+ </th>
<th>
- Description
- </th>
+ Description
+ </th>
</tr></thead>
<tbody>
<tr>
<td>
- <tt class="computeroutput">float_</tt>
- </td>
+ <tt class="computeroutput">float_</tt>
+ </td>
<td>
- <tt class="computeroutput">float</tt>
- </td>
+ <tt class="computeroutput">float</tt>
+ </td>
<td>
- Parse a floating point number into a <tt class="computeroutput">float</tt>
- </td>
+ Parse a floating point number into a <tt class="computeroutput">float</tt>
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">double_</tt>
- </td>
+ <tt class="computeroutput">double_</tt>
+ </td>
<td>
- <tt class="computeroutput">double</tt>
- </td>
+ <tt class="computeroutput">double</tt>
+ </td>
<td>
- Parse a floating point number into a <tt class="computeroutput">double</tt>
- </td>
+ Parse a floating point number into a <tt class="computeroutput">double</tt>
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">long_double</tt>
- </td>
+ <tt class="computeroutput">long_double</tt>
+ </td>
<td>
- <tt class="computeroutput">long double</tt>
- </td>
+ <tt class="computeroutput">long double</tt>
+ </td>
<td>
- Parse a floating point number into a <tt class="computeroutput">long
- double</tt>
- </td>
+ Parse a floating point number into a <tt class="computeroutput">long
+ double</tt>
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">bin</tt>
- </td>
+ <tt class="computeroutput">bin</tt>
+ </td>
<td>
- <tt class="computeroutput">unsigned</tt>
- </td>
+ <tt class="computeroutput">unsigned</tt>
+ </td>
<td>
- Parse a binary integer into an <tt class="computeroutput">unsigned</tt>
- </td>
+ Parse a binary integer into an <tt class="computeroutput">unsigned</tt>
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">oct</tt>
- </td>
+ <tt class="computeroutput">oct</tt>
+ </td>
<td>
- <tt class="computeroutput">unsigned</tt>
- </td>
+ <tt class="computeroutput">unsigned</tt>
+ </td>
<td>
- Parse an octal integer into an <tt class="computeroutput">unsigned</tt>
- </td>
+ Parse an octal integer into an <tt class="computeroutput">unsigned</tt>
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">hex</tt>
- </td>
+ <tt class="computeroutput">hex</tt>
+ </td>
<td>
- <tt class="computeroutput">unsigned</tt>
- </td>
+ <tt class="computeroutput">unsigned</tt>
+ </td>
<td>
- Parse a hexadecimal integer into an <tt class="computeroutput">unsigned</tt>
- </td>
+ Parse a hexadecimal integer into an <tt class="computeroutput">unsigned</tt>
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">ushort_</tt>
- </td>
+ <tt class="computeroutput">ushort_</tt>
+ </td>
<td>
- <tt class="computeroutput">unsigned short</tt>
- </td>
+ <tt class="computeroutput">unsigned short</tt>
+ </td>
<td>
- Parse an unsigned short integer
- </td>
+ Parse an unsigned short integer
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">ulong_</tt>
- </td>
+ <tt class="computeroutput">ulong_</tt>
+ </td>
<td>
- <tt class="computeroutput">unsigned long</tt>
- </td>
+ <tt class="computeroutput">unsigned long</tt>
+ </td>
<td>
- Parse an unsigned long integer
- </td>
+ Parse an unsigned long integer
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">uint_</tt>
- </td>
+ <tt class="computeroutput">uint_</tt>
+ </td>
<td>
- <tt class="computeroutput">unsigned int</tt>
- </td>
+ <tt class="computeroutput">unsigned int</tt>
+ </td>
<td>
- Parse an unsigned int
- </td>
+ Parse an unsigned int
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">ulong_long</tt>
- </td>
+ <tt class="computeroutput">ulong_long</tt>
+ </td>
<td>
- <tt class="computeroutput">unsigned long
- long</tt>
- </td>
+ <tt class="computeroutput">unsigned long
+ long</tt>
+ </td>
<td>
- Parse an unsigned long long
- </td>
+ Parse an unsigned long long
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">short_</tt>
- </td>
+ <tt class="computeroutput">short_</tt>
+ </td>
<td>
- <tt class="computeroutput">short</tt>
- </td>
+ <tt class="computeroutput">short</tt>
+ </td>
<td>
- Parse a short integer
- </td>
+ Parse a short integer
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">long_</tt>
- </td>
+ <tt class="computeroutput">long_</tt>
+ </td>
<td>
- <tt class="computeroutput">long</tt>
- </td>
+ <tt class="computeroutput">long</tt>
+ </td>
<td>
- Parse a long integer
- </td>
+ Parse a long integer
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">int_</tt>
- </td>
+ <tt class="computeroutput">int_</tt>
+ </td>
<td>
- <tt class="computeroutput">int</tt>
- </td>
+ <tt class="computeroutput">int</tt>
+ </td>
<td>
- Parse an int
- </td>
+ Parse an int
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">long_long</tt>
- </td>
+ <tt class="computeroutput">long_long</tt>
+ </td>
<td>
- <tt class="computeroutput">long long</tt>
- </td>
+ <tt class="computeroutput">long long</tt>
+ </td>
<td>
- Parse a long long
- </td>
+ Parse a long long
+ </td>
</tr>
</tbody>
-</table>
+</table></div>
</div>
-<div class="table">
-<a name="id441811"></a>Table 6. string
-<table class="table" summary="string">
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.qi.quick_reference.qi_parsers.string"></a>string
+</h5></div></div>
+<div></div>
+</div>
+<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
@@ -442,126 +468,132 @@
</colgroup>
<thead><tr>
<th>
- Expression
- </th>
+ Expression
+ </th>
<th>
- Attribute
- </th>
+ Attribute
+ </th>
<th>
- Description
- </th>
+ Description
+ </th>
</tr></thead>
<tbody>
<tr>
<td>
- ch
- </td>
+ ch
+ </td>
<td>
- <tt class="computeroutput">Unused</tt>
- </td>
+ <tt class="computeroutput">Unused</tt>
+ </td>
<td>
- Matches <tt class="computeroutput">ch</tt>
- </td>
+ Matches <tt class="computeroutput">ch</tt>
+ </td>
</tr>
<tr>
<td>
- str
- </td>
+ str
+ </td>
<td>
- <tt class="computeroutput">Unused</tt>
- </td>
+ <tt class="computeroutput">Unused</tt>
+ </td>
<td>
- Matches <tt class="computeroutput">str</tt>
- </td>
+ Matches <tt class="computeroutput">str</tt>
+ </td>
</tr>
<tr>
<td>
- lit(ch)
- </td>
+ lit(ch)
+ </td>
<td>
- <tt class="computeroutput">Unused</tt>
- </td>
+ <tt class="computeroutput">Unused</tt>
+ </td>
<td>
- Matches <tt class="computeroutput">ch</tt>
- </td>
+ Matches <tt class="computeroutput">ch</tt>
+ </td>
</tr>
<tr>
<td>
- lit(str)
- </td>
+ lit(str)
+ </td>
<td>
- <tt class="computeroutput">Unused</tt>
- </td>
+ <tt class="computeroutput">Unused</tt>
+ </td>
<td>
- Matches <tt class="computeroutput">str</tt>
- </td>
+ Matches <tt class="computeroutput">str</tt>
+ </td>
</tr>
<tr>
<td>
- string(str)
- </td>
+ string(str)
+ </td>
<td>
- <tt class="computeroutput">Str</tt>
- </td>
+ <tt class="computeroutput">Str</tt>
+ </td>
<td>
- Matches <tt class="computeroutput">str</tt>
- </td>
+ Matches <tt class="computeroutput">str</tt>
+ </td>
</tr>
<tr>
<td>
- symbols<Ch, T>
- </td>
+ <a href="../reference/string.html#spirit.qi.reference.string.symbols" title="symbols"><tt class="computeroutput">symbols<Ch,
+ T></tt></a>
+ </td>
<td>
- N/A
- </td>
+ N/A
+ </td>
<td>
- Declare a symbol table, <tt class="computeroutput">sym</tt>.
- <tt class="computeroutput">Ch</tt> is the underlying
- char type of the symbol table keys. <tt class="computeroutput">T</tt>
- is the data type associated with each key.
- </td>
+ Declare a symbol table, <tt class="computeroutput">sym</tt>.
+ <tt class="computeroutput">Ch</tt> is the underlying
+ char type of the symbol table keys. <tt class="computeroutput">T</tt>
+ is the data type associated with each key.
+ </td>
</tr>
<tr>
<td>

-
+

-<pre class="programlisting">sym.add
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">sym.add
 (str1, val1)
 (str2, val2)
 /*...more...*/
;
</pre>

- 
+ 
</td>
<td>
- N/A
- </td>
+ N/A
+ </td>
<td>
- Add symbols into a symbol table, <tt class="computeroutput">sym</tt>.
- val1 and val2 are optional data of type <tt class="computeroutput">T</tt>,
- the data type associated with each key.
- </td>
+ Add symbols into a symbol table, <tt class="computeroutput">sym</tt>.
+ val1 and val2 are optional data of type <tt class="computeroutput">T</tt>,
+ the data type associated with each key.
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">sym</tt>
- </td>
+ <tt class="computeroutput">sym</tt>
+ </td>
<td>
- <tt class="computeroutput">T</tt>
- </td>
+ <tt class="computeroutput">T</tt>
+ </td>
<td>
- Matches entries in the symbol table, <tt class="computeroutput">sym</tt>.
- If successful, returns the data associated with the key
- </td>
+ Matches entries in the symbol table, <tt class="computeroutput">sym</tt>.
+ If successful, returns the data associated with the key
+ </td>
</tr>
</tbody>
-</table>
+</table></div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.qi.quick_reference.qi_parsers.auxiliary"></a>auxiliary
+</h5></div></div>
+<div></div>
</div>
-<div class="table">
-<a name="id442524"></a>Table 7. auxiliary
-<table class="table" summary="auxiliary">
+<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
@@ -569,105 +601,110 @@
</colgroup>
<thead><tr>
<th>
- Expression
- </th>
+ Expression
+ </th>
<th>
- Attribute
- </th>
+ Attribute
+ </th>
<th>
- Description
- </th>
+ Description
+ </th>
</tr></thead>
<tbody>
<tr>
<td>
- <tt class="computeroutput">eol</tt>
- </td>
+ <tt class="computeroutput">eol</tt>
+ </td>
<td>
- <tt class="computeroutput">Unused</tt>
- </td>
+ <tt class="computeroutput">Unused</tt>
+ </td>
<td>
- Matches the end of line (<tt class="computeroutput">\r</tt> or <tt class="computeroutput">\n</tt> or <tt class="computeroutput">\r\n</tt>)
- </td>
+ Matches the end of line (<tt class="computeroutput">\r</tt> or <tt class="computeroutput">\n</tt> or <tt class="computeroutput">\r\n</tt>)
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">eoi</tt>
- </td>
+ <tt class="computeroutput">eoi</tt>
+ </td>
<td>
- <tt class="computeroutput">Unused</tt>
- </td>
+ <tt class="computeroutput">Unused</tt>
+ </td>
<td>
- Matches the end of input (first == last)
- </td>
+ Matches the end of input (first == last)
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">eps</tt>
- </td>
+ <tt class="computeroutput">eps</tt>
+ </td>
<td>
- <tt class="computeroutput">Unused</tt>
- </td>
+ <tt class="computeroutput">Unused</tt>
+ </td>
<td>
- Match an empty string
- </td>
+ Match an empty string
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">eps(b)</tt>
- </td>
+ <tt class="computeroutput">eps(b)</tt>
+ </td>
<td>
- <tt class="computeroutput">Unused</tt>
- </td>
+ <tt class="computeroutput">Unused</tt>
+ </td>
<td>
- If <tt class="computeroutput">b</tt> is true, match
- an empty string
- </td>
+ If <tt class="computeroutput">b</tt> is true,
+ match an empty string
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">lazy(fp)</tt>
- </td>
+ <tt class="computeroutput">lazy(fp)</tt>
+ </td>
<td>
- Attribute of <tt class="computeroutput">P</tt> where
- <tt class="computeroutput">P</tt> is the return type
- of <tt class="computeroutput">fp</tt>
- </td>
+ Attribute of <tt class="computeroutput">P</tt>
+ where <tt class="computeroutput">P</tt> is the
+ return type of <tt class="computeroutput">fp</tt>
+ </td>
<td>
- Invoke <tt class="computeroutput">fp</tt> at parse
- time, returning a parser <tt class="computeroutput">p</tt>
- which is then called to parse.
- </td>
+ Invoke <tt class="computeroutput">fp</tt> at
+ parse time, returning a parser <tt class="computeroutput">p</tt>
+ which is then called to parse.
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">fp</tt>
- </td>
+ <tt class="computeroutput">fp</tt>
+ </td>
<td>
- see <tt class="computeroutput">lazy(fp)</tt>
- above
- </td>
+ see <tt class="computeroutput">lazy(fp)</tt>
+ above
+ </td>
<td>
- Equivalent to <tt class="computeroutput">lazy[fp]</tt>
- </td>
+ Equivalent to <tt class="computeroutput">lazy[fp]</tt>
+ </td>
</tr>
<tr>
<td>
- attr(attrib)
- </td>
+ attr(attrib)
+ </td>
<td>
- <tt class="computeroutput">Attrib</tt>
- </td>
+ <tt class="computeroutput">Attrib</tt>
+ </td>
<td>
- Doesn't consume/parse any input, but exposes the argument <tt class="computeroutput">attrib</tt> as its attribute.
- </td>
+ Doesn't consume/parse any input, but exposes the argument <tt class="computeroutput">attrib</tt> as its attribute.
+ </td>
</tr>
</tbody>
-</table>
+</table></div>
</div>
-<div class="table">
-<a name="id443123"></a>Table 8. binary
-<table class="table" summary="binary">
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.qi.quick_reference.qi_parsers.binary"></a>binary
+</h5></div></div>
+<div></div>
+</div>
+<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
@@ -675,132 +712,137 @@
</colgroup>
<thead><tr>
<th>
- Expression
- </th>
+ Expression
+ </th>
<th>
- Attribute
- </th>
+ Attribute
+ </th>
<th>
- Description
- </th>
+ Description
+ </th>
</tr></thead>
<tbody>
<tr>
<td>
- <tt class="computeroutput">byte_</tt>
- </td>
+ <tt class="computeroutput">byte_</tt>
+ </td>
<td>
- 8 bits native endian
- </td>
+ 8 bits native endian
+ </td>
<td>
- Matches an 8 bit binary
- </td>
+ Matches an 8 bit binary
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">word</tt>
- </td>
+ <tt class="computeroutput">word</tt>
+ </td>
<td>
- 16 bits native endian
- </td>
+ 16 bits native endian
+ </td>
<td>
- Matches a 16 bit binary
- </td>
+ Matches a 16 bit binary
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">big_word</tt>
- </td>
+ <tt class="computeroutput">big_word</tt>
+ </td>
<td>
- 16 bits big endian
- </td>
+ 16 bits big endian
+ </td>
<td>
- Matches a 16 bit binary
- </td>
+ Matches a 16 bit binary
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">little_word</tt>
- </td>
+ <tt class="computeroutput">little_word</tt>
+ </td>
<td>
- 16 bits little endian
- </td>
+ 16 bits little endian
+ </td>
<td>
- Matches a 16 bit binary
- </td>
+ Matches a 16 bit binary
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">dword</tt>
- </td>
+ <tt class="computeroutput">dword</tt>
+ </td>
<td>
- 32 bits native endian
- </td>
+ 32 bits native endian
+ </td>
<td>
- Matches a 32 bit binary
- </td>
+ Matches a 32 bit binary
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">big_dword</tt>
- </td>
+ <tt class="computeroutput">big_dword</tt>
+ </td>
<td>
- 32 bits big endian
- </td>
+ 32 bits big endian
+ </td>
<td>
- Matches a 32 bit binary
- </td>
+ Matches a 32 bit binary
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">little_dword</tt>
- </td>
+ <tt class="computeroutput">little_dword</tt>
+ </td>
<td>
- 32 bits little endian
- </td>
+ 32 bits little endian
+ </td>
<td>
- Matches a 32 bit binary
- </td>
+ Matches a 32 bit binary
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">qword</tt>
- </td>
+ <tt class="computeroutput">qword</tt>
+ </td>
<td>
- 64 bits native endian
- </td>
+ 64 bits native endian
+ </td>
<td>
- Matches a 64 bit binary
- </td>
+ Matches a 64 bit binary
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">big_qword</tt>
- </td>
+ <tt class="computeroutput">big_qword</tt>
+ </td>
<td>
- 64 bits big endian
- </td>
+ 64 bits big endian
+ </td>
<td>
- Matches a 64 bit binary
- </td>
+ Matches a 64 bit binary
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">little_qword</tt>
- </td>
+ <tt class="computeroutput">little_qword</tt>
+ </td>
<td>
- 64 bits little endian
- </td>
+ 64 bits little endian
+ </td>
<td>
- Matches a 64 bit binary
- </td>
+ Matches a 64 bit binary
+ </td>
</tr>
</tbody>
-</table>
+</table></div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.qi.quick_reference.qi_parsers.directive"></a>directive
+</h5></div></div>
+<div></div>
</div>
-<div class="table">
-<a name="id443536"></a>Table 9. directive
-<table class="table" summary="directive">
+<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
@@ -808,136 +850,143 @@
</colgroup>
<thead><tr>
<th>
- Expression
- </th>
+ Expression
+ </th>
<th>
- Attribute
- </th>
+ Attribute
+ </th>
<th>
- Description
- </th>
+ Description
+ </th>
</tr></thead>
<tbody>
<tr>
<td>
- <tt class="computeroutput">lexeme[a]</tt>
- </td>
+ <tt class="computeroutput">lexeme[a]</tt>
+ </td>
<td>
- <tt class="computeroutput">A</tt>
- </td>
+ <tt class="computeroutput">A</tt>
+ </td>
<td>
- Disable skip parsing for <tt class="computeroutput">a</tt>
- </td>
+ Disable skip parsing for <tt class="computeroutput">a</tt>
+ </td>
</tr>
<tr>
<td>
- no_case[a]
- </td>
+ no_case[a]
+ </td>
<td>
- <tt class="computeroutput">A</tt>
- </td>
+ <tt class="computeroutput">A</tt>
+ </td>
<td>
- Inhibits case-sensitivity for <tt class="computeroutput">a</tt>
- </td>
+ Inhibits case-sensitivity for <tt class="computeroutput">a</tt>
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">omit[a]</tt>
- </td>
+ <tt class="computeroutput">omit[a]</tt>
+ </td>
<td>
- <tt class="computeroutput">Unused</tt>
- </td>
+ <tt class="computeroutput">Unused</tt>
+ </td>
<td>
- Ignores the attribute type of <tt class="computeroutput">a</tt>
- </td>
+ Ignores the attribute type of <tt class="computeroutput">a</tt>
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">raw[a]</tt>
- </td>
+ <tt class="computeroutput">raw[a]</tt>
+ </td>
<td>
- <tt class="computeroutput">boost::iterator_range<I></tt>
- </td>
+ <tt class="computeroutput">boost::iterator_range<I></tt>
+ </td>
<td>
- Presents the transduction of <tt class="computeroutput">a</tt>
- as an iterator range
- </td>
+ Presents the transduction of <tt class="computeroutput">a</tt>
+ as an iterator range
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">repeat[a]</tt>
- </td>
+ <tt class="computeroutput">repeat[a]</tt>
+ </td>
<td>
- <tt class="computeroutput">vector<A></tt>
- </td>
+ <tt class="computeroutput">vector<A></tt>
+ </td>
<td>
- Repeat <tt class="computeroutput">a</tt> zero or
- more times
- </td>
+ Repeat <tt class="computeroutput">a</tt> zero
+ or more times
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">repeat(N)[a]</tt>
- </td>
+ <tt class="computeroutput">repeat(N)[a]</tt>
+ </td>
<td>
- <tt class="computeroutput">vector<A></tt>
- </td>
+ <tt class="computeroutput">vector<A></tt>
+ </td>
<td>
- Repeat <tt class="computeroutput">a</tt> <tt class="computeroutput">N</tt> times
- </td>
+ Repeat <tt class="computeroutput">a</tt> <tt class="computeroutput">N</tt> times
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">repeat(N, M)[a]</tt>
- </td>
+ <tt class="computeroutput">repeat(N,
+ M)[a]</tt>
+ </td>
<td>
- <tt class="computeroutput">vector<A></tt>
- </td>
+ <tt class="computeroutput">vector<A></tt>
+ </td>
<td>
- Repeat <tt class="computeroutput">a</tt> <tt class="computeroutput">N</tt> to <tt class="computeroutput">M</tt>
- times
- </td>
+ Repeat <tt class="computeroutput">a</tt> <tt class="computeroutput">N</tt> to <tt class="computeroutput">M</tt>
+ times
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">repeat(N, inf)[a]</tt>
- </td>
+ <tt class="computeroutput">repeat(N,
+ inf)[a]</tt>
+ </td>
<td>
- <tt class="computeroutput">vector<A></tt>
- </td>
+ <tt class="computeroutput">vector<A></tt>
+ </td>
<td>
- Repeat <tt class="computeroutput">a</tt> <tt class="computeroutput">N</tt> or more times
- </td>
+ Repeat <tt class="computeroutput">a</tt> <tt class="computeroutput">N</tt> or more times
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">skip[a]</tt>
- </td>
+ <tt class="computeroutput">skip[a]</tt>
+ </td>
<td>
- <tt class="computeroutput">A</tt>
- </td>
+ <tt class="computeroutput">A</tt>
+ </td>
<td>
- Reestablish the skipper that got inhibited by lexeme
- </td>
+ Reestablish the skipper that got inhibited by lexeme
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">skip(p)[a]</tt>
- </td>
+ <tt class="computeroutput">skip(p)[a]</tt>
+ </td>
<td>
- <tt class="computeroutput">A</tt>
- </td>
+ <tt class="computeroutput">A</tt>
+ </td>
<td>
- Use <tt class="computeroutput">p</tt> as a skipper
- for parsing <tt class="computeroutput">a</tt>
- </td>
+ Use <tt class="computeroutput">p</tt> as a skipper
+ for parsing <tt class="computeroutput">a</tt>
+ </td>
</tr>
</tbody>
-</table>
+</table></div>
</div>
-<div class="table">
-<a name="id444512"></a>Table 10. operator
-<table class="table" summary="operator">
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.qi.quick_reference.qi_parsers.operator"></a>operator
+</h5></div></div>
+<div></div>
+</div>
+<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
@@ -945,176 +994,191 @@
</colgroup>
<thead><tr>
<th>
- Expression
- </th>
+ Expression
+ </th>
<th>
- Attribute
- </th>
+ Attribute
+ </th>
<th>
- Description
- </th>
+ Description
+ </th>
</tr></thead>
<tbody>
<tr>
<td>
- <tt class="computeroutput">!a</tt>
- </td>
+ <tt class="computeroutput">!a</tt>
+ </td>
<td>
- <tt class="computeroutput">Unused</tt>
- </td>
+ <tt class="computeroutput">Unused</tt>
+ </td>
<td>
- Not predicate. Ensure that <tt class="computeroutput">a</tt>
- does not match but don't move the iterator position
- </td>
+ Not predicate. Ensure that <tt class="computeroutput">a</tt>
+ does not match but don't move the iterator position
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">&a</tt>
- </td>
+ <tt class="computeroutput">&a</tt>
+ </td>
<td>
- <tt class="computeroutput">Unused</tt>
- </td>
+ <tt class="computeroutput">Unused</tt>
+ </td>
<td>
- And predicate. Ensure that <tt class="computeroutput">a</tt>
- matches but don't move the iterator position
- </td>
+ And predicate. Ensure that <tt class="computeroutput">a</tt>
+ matches but don't move the iterator position
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">-a</tt>
- </td>
+ <tt class="computeroutput">-a</tt>
+ </td>
<td>
- <tt class="computeroutput">optional<A></tt>
- </td>
+ <tt class="computeroutput">optional<A></tt>
+ </td>
<td>
- Optional. Parse <tt class="computeroutput">a</tt>
- zero or one time
- </td>
+ Optional. Parse <tt class="computeroutput">a</tt>
+ zero or one time
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">*a</tt>
- </td>
+ <tt class="computeroutput">*a</tt>
+ </td>
<td>
- <tt class="computeroutput">vector<A></tt>
- </td>
+ <tt class="computeroutput">vector<A></tt>
+ </td>
<td>
- Kleene. Parse <tt class="computeroutput">a</tt> zero
- or more times
- </td>
+ Kleene. Parse <tt class="computeroutput">a</tt>
+ zero or more times
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">+a</tt>
- </td>
+ <tt class="computeroutput">+a</tt>
+ </td>
<td>
- <tt class="computeroutput">vector<A></tt>
- </td>
+ <tt class="computeroutput">vector<A></tt>
+ </td>
<td>
- Plus. Parse <tt class="computeroutput">a</tt> one
- or more times
- </td>
+ Plus. Parse <tt class="computeroutput">a</tt>
+ one or more times
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">a |
- b</tt>
- </td>
+ <tt class="computeroutput">a |
+ b</tt>
+ </td>
<td>
- <tt class="computeroutput">variant<A, B></tt>
- </td>
+ <tt class="computeroutput">variant<A,
+ B></tt>
+ </td>
<td>
- Alternative. Parse <tt class="computeroutput">a</tt>
- or <tt class="computeroutput">b</tt>
- </td>
+ Alternative. Parse <tt class="computeroutput">a</tt>
+ or <tt class="computeroutput">b</tt>
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">a >>
- b</tt>
- </td>
+ <tt class="computeroutput">a >>
+ b</tt>
+ </td>
<td>
- <tt class="computeroutput">tuple<A, B></tt>
- </td>
+ <tt class="computeroutput">tuple<A,
+ B></tt>
+ </td>
<td>
- Sequence. Parse <tt class="computeroutput">a</tt>
- followed by <tt class="computeroutput">b</tt>
- </td>
+ Sequence. Parse <tt class="computeroutput">a</tt>
+ followed by <tt class="computeroutput">b</tt>
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">a >
- b</tt>
- </td>
+ <tt class="computeroutput">a >
+ b</tt>
+ </td>
<td>
- <tt class="computeroutput">tuple<A, B></tt>
- </td>
+ <tt class="computeroutput">tuple<A,
+ B></tt>
+ </td>
<td>
- Expect. Parse <tt class="computeroutput">a</tt> followed
- by <tt class="computeroutput">b</tt>. <tt class="computeroutput">b</tt> is expected to match when <tt class="computeroutput">a</tt> matches, otherwise, an <tt class="computeroutput">expectation_failure</tt> is thrown.
- </td>
+ Expect. Parse <tt class="computeroutput">a</tt>
+ followed by <tt class="computeroutput">b</tt>.
+ <tt class="computeroutput">b</tt> is expected
+ to match when <tt class="computeroutput">a</tt>
+ matches, otherwise, an <tt class="computeroutput">expectation_failure</tt>
+ is thrown.
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">a -
- b</tt>
- </td>
+ <tt class="computeroutput">a -
+ b</tt>
+ </td>
<td>
- <tt class="computeroutput">A</tt>
- </td>
+ <tt class="computeroutput">A</tt>
+ </td>
<td>
- Difference. Parse <tt class="computeroutput">a</tt>
- but not <tt class="computeroutput">b</tt>
- </td>
+ Difference. Parse <tt class="computeroutput">a</tt>
+ but not <tt class="computeroutput">b</tt>
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">a ||
- b</tt>
- </td>
+ <tt class="computeroutput">a ||
+ b</tt>
+ </td>
<td>
- <tt class="computeroutput">tuple<A, B></tt>
- </td>
+ <tt class="computeroutput">tuple<A,
+ B></tt>
+ </td>
<td>
- Sequential Or. Parse <tt class="computeroutput">a</tt>
- or <tt class="computeroutput">b</tt> or <tt class="computeroutput">a</tt> followed by <tt class="computeroutput">b</tt>
- </td>
+ Sequential Or. Parse <tt class="computeroutput">a</tt>
+ or <tt class="computeroutput">b</tt> or <tt class="computeroutput">a</tt> followed by <tt class="computeroutput">b</tt>
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">a %
- b</tt>
- </td>
+ <tt class="computeroutput">a %
+ b</tt>
+ </td>
<td>
- <tt class="computeroutput">vector<A></tt>
- </td>
+ <tt class="computeroutput">vector<A></tt>
+ </td>
<td>
- List. Parse <tt class="computeroutput">a</tt> delimited
- <tt class="computeroutput">b</tt> one or more times
- </td>
+ List. Parse <tt class="computeroutput">a</tt>
+ delimited <tt class="computeroutput">b</tt> one
+ or more times
+ </td>
</tr>
<tr>
<td>
- <tt class="computeroutput">a ^
- b</tt>
- </td>
+ <tt class="computeroutput">a ^
+ b</tt>
+ </td>
<td>
- <tt class="computeroutput">tuple<</tt>
- <tt class="computeroutput">optional<A>,</tt>
- <tt class="computeroutput">optional<B>
- ></tt>
- </td>
+ <tt class="computeroutput">tuple<</tt>
+ <tt class="computeroutput">optional<A>,</tt>
+ <tt class="computeroutput">optional<B>
+ ></tt>
+ </td>
<td>
- Permutation. Parse <tt class="computeroutput">a</tt>
- and <tt class="computeroutput">b</tt> in any order
- </td>
+ Permutation. Parse <tt class="computeroutput">a</tt>
+ and <tt class="computeroutput">b</tt> in any
+ order
+ </td>
</tr>
</tbody>
-</table>
+</table></div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.qi.quick_reference.qi_parsers.action"></a>action
+</h5></div></div>
+<div></div>
</div>
-<div class="table">
-<a name="id445738"></a>Table 11. action
-<table class="table" summary="action">
+<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
@@ -1122,28 +1186,28 @@
</colgroup>
<thead><tr>
<th>
- Expression
- </th>
+ Expression
+ </th>
<th>
- Attribute
- </th>
+ Attribute
+ </th>
<th>
- Description
- </th>
+ Description
+ </th>
</tr></thead>
<tbody><tr>
<td>
- <tt class="computeroutput">p[fa]</tt>
- </td>
+ <tt class="computeroutput">p[fa]</tt>
+ </td>
<td>
- Attribute of <tt class="computeroutput">p</tt>
- </td>
+ Attribute of <tt class="computeroutput">p</tt>
+ </td>
<td>
- Call semantic action, <tt class="computeroutput">fa</tt>
- if p succeeds.
- </td>
+ Call semantic action, <tt class="computeroutput">fa</tt>
+ if p succeeds.
+ </td>
</tr></tbody>
-</table>
+</table></div>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>

Modified: trunk/libs/spirit/doc/html/spirit/qi/reference/auxiliary.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/qi/reference/auxiliary.html (original)
+++ trunk/libs/spirit/doc/html/spirit/qi/reference/auxiliary.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -7,7 +7,7 @@
<link rel="home" href="../../../index.html" title="Spirit 2.1">
<link rel="up" href="../reference.html" title="Reference">
<link rel="previous" href="basics.html" title="Basics">
-<link rel="next" href="auxiliary/attr.html" title="attr">
+<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>
@@ -20,7 +20,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="basics.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/attr.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="basics.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">
@@ -29,7 +29,7 @@
</h4></div></div>
<div></div>
</div>
-<div class="toc"><dl><dt>attr</dt></dl></div>
+<div class="toc"><dl><dt>attr</dt></dl></div>

 This module includes different auxiliary parsers not fitting into any of
 the other categories. This module includes the <tt class="computeroutput">attr</tt>,
@@ -37,12 +37,269 @@
 <tt class="computeroutput">eps</tt>, and <tt class="computeroutput">lazy</tt> parsers.
 
<a name="spirit.qi.reference.auxiliary.module_header"></a><h5>
-<a name="id457653"></a>
+<a name="id457799"></a>
 <a href="auxiliary.html#spirit.qi.reference.auxiliary.module_header">Module Header</a>
 </h5>
<pre class="programlisting">// forwards to <boost/spirit/home/qi/auxiliary.hpp>
#include <boost/spirit/include/qi_auxiliary.hpp>
</pre>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.qi.reference.auxiliary.attr"></a>attr
+</h5></div></div>
+<div></div>
+</div>
+<div class="itemizedlist"><ul type="disc"><li>
+<tt class="computeroutput">boost::spirit::attr</tt>: generates a pseudo parser not
+ consuming any input
+ </li></ul></div>
+<a name="spirit.qi.reference.auxiliary.attr.description"></a><h6>
+<a name="id457956"></a>
+ Description
+ </h6>
+
+ The <tt class="computeroutput">attr</tt> parser does
+ not consume any input, for this reason it always matches an empty string.
+ The parser generated by <tt class="computeroutput">attr</tt>
+ always succeeds. It's purpose is to expose its specified parameter as
+ an attribute to the parsing process.
+ 
+<a name="spirit.qi.reference.auxiliary.attr.header"></a><h6>
+<a name="id458011"></a>
+ Header
+ </h6>
+<pre class="programlisting">// forwards to <boost/spirit/home/qi/auxiliary/attr.hpp>
+#include <boost/spirit/include/qi_attr.hpp>
+</pre>
+
+ Also, see Include Structure.
+ 
+<a name="spirit.qi.reference.auxiliary.attr.model_of"></a><h6>
+<a name="id458124"></a>
+ Model of
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ Parser
+ 
+
+ 
+</blockquote></div>
+<div class="variablelist">
+Notation
+<dl>
+<dt><tt class="computeroutput">attrib</tt></dt>
+<dd>
+ A arbitrary typed constant value, e.g. 0.0, "Hello", or
+ a variable of arbitrary type.
+ </dd>
+<dt><tt class="computeroutput">fattrib</tt></dt>
+<dd>
+ A Lazy Argument
+ that evaluates to an arbitrary type.
+ </dd>
+</dl>
+</div>
+<a name="spirit.qi.reference.auxiliary.attr.expression_semantics"></a><h6>
+<a name="id458242"></a>
+ <a href="auxiliary.html#spirit.qi.reference.auxiliary.attr.expression_semantics">Expression
+ Semantics</a>
+ </h6>
+
+ Semantics of an <tt class="computeroutput">attr()</tt> expression are fully defined by the
+ Parser concept.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Semantics
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <tt class="computeroutput">attr(attrib)</tt>
+ </td>
+<td>
+ Generate a pseudo parser exposing the current value of <tt class="computeroutput">attrib</tt> as its attribute value
+ while not consuming any input at parse time.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">attr(fattrib)</tt>
+ </td>
+<td>
+ Generate a pseudo parser exposing as its attribute the value
+ returned by invoking <tt class="computeroutput">fattrib</tt>
+ at parse time, while not consuming any input. See <a href="basics.html#spirit.qi.reference.basics.lazy_argument">Lazy
+ Argument</a>
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="spirit.qi.reference.auxiliary.attr.attributes"></a><h6>
+<a name="id458469"></a>
+ Attributes
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Attribute
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <tt class="computeroutput">attr(attrib)</tt>
+ </td>
+<td>
+ <tt class="computeroutput">Attrib</tt>, which
+ is the type of <tt class="computeroutput">attrib</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">attr(fattrib)</tt>
+ </td>
+<td>
+ <tt class="computeroutput">Attrib</tt>, which
+ is the return type of <tt class="computeroutput">fattrib</tt>
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="spirit.qi.reference.auxiliary.attr.complexity"></a><h6>
+<a name="id458665"></a>
+ Complexity
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ O(1)
+ 
+
+ 
+</blockquote></div>
+
+ The complexity is constant as no input is consumed and no matching is
+ done.
+ 
+<a name="spirit.qi.reference.auxiliary.attr.example"></a><h6>
+<a name="id458705"></a>
+ Example
+ </h6>
+
+ Some 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>
+
+ 
+
+ 
+
+ All code snippets below use this common test function:
+ 
+
+ 
+
+
+
+<pre class="programlisting">template <typename P>
+void test_parser(char const* input, P const& p)
+{
+ std::string s(input);
+ std::string::iterator f(s.begin());
+ if (boost::spirit::qi::parse(f, s.end(), p))
+ std::cout << "ok" << std::endl;
+ else
+ std::cout << "fail" << std::endl;
+}
+</pre>
+
+ 
+
+ 
+
+ Some using declaration:
+ 
+
+ 
+
+
+
+<pre class="programlisting">namespace phx = boost::phoenix;
+using boost::spirit::qi::attr;
+</pre>
+
+ 
+
+ 
+
+ Using <tt class="computeroutput">attr</tt> with literals:
+ 
+
+ 
+
+
+
+<pre class="programlisting">std::string str;
+test_parser_attr("", attr("boost"), str);
+std::cout << str << std::endl; // will print 'boost'
+
+double d;
+test_parser_attr("", attr(1.0), d);
+std::cout << d << std::endl; // will print '1.0'
+</pre>
+
+ 
+
+ 
+
+ Using <tt class="computeroutput">attr</tt> with Phoenix function objects:
+ 
+
+ 
+
+
+
+<pre class="programlisting">double d = 0.0, d1 = 1.2;
+test_parser_attr("", attr(phx::ref(d1)), d);
+std::cout << d << std::endl; // will print '1.2'
+</pre>
+
+ 
+
+ 
+</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
@@ -55,7 +312,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="basics.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/attr.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="basics.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>

Modified: trunk/libs/spirit/doc/html/spirit/qi/reference/auxiliary/attr.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/qi/reference/auxiliary/attr.html (original)
+++ trunk/libs/spirit/doc/html/spirit/qi/reference/auxiliary/attr.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -34,7 +34,7 @@
 consuming any input
 </li></ul></div>
<a name="spirit.qi.reference.auxiliary.attr.description"></a><h6>
-<a name="id457810"></a>
+<a name="id457956"></a>
 <a href="attr.html#spirit.qi.reference.auxiliary.attr.description">Description</a>
 </h6>

@@ -45,7 +45,7 @@
 an attribute to the parsing process.
 
<a name="spirit.qi.reference.auxiliary.attr.header"></a><h6>
-<a name="id457865"></a>
+<a name="id458011"></a>
 <a href="attr.html#spirit.qi.reference.auxiliary.attr.header">Header</a>
 </h6>
<pre class="programlisting">// forwards to <boost/spirit/home/qi/auxiliary/attr.hpp>
@@ -55,7 +55,7 @@
 Also, see Include Structure.
 
<a name="spirit.qi.reference.auxiliary.attr.model_of"></a><h6>
-<a name="id457978"></a>
+<a name="id458124"></a>
 <a href="attr.html#spirit.qi.reference.auxiliary.attr.model_of">Model of</a>
 </h6>
<div class="blockquote"><blockquote class="blockquote">
@@ -83,7 +83,7 @@
</dl>
</div>
<a name="spirit.qi.reference.auxiliary.attr.expression_semantics"></a><h6>
-<a name="id458096"></a>
+<a name="id458242"></a>
 <a href="attr.html#spirit.qi.reference.auxiliary.attr.expression_semantics">Expression
 Semantics</a>
 </h6>
@@ -128,7 +128,7 @@
</tbody>
</table></div>
<a name="spirit.qi.reference.auxiliary.attr.attributes"></a><h6>
-<a name="id458323"></a>
+<a name="id458469"></a>
 <a href="attr.html#spirit.qi.reference.auxiliary.attr.attributes">Attributes</a>
 </h6>
<div class="informaltable"><table class="table">
@@ -166,7 +166,7 @@
</tbody>
</table></div>
<a name="spirit.qi.reference.auxiliary.attr.complexity"></a><h6>
-<a name="id458519"></a>
+<a name="id458665"></a>
 <a href="attr.html#spirit.qi.reference.auxiliary.attr.complexity">Complexity</a>
 </h6>
<div class="blockquote"><blockquote class="blockquote">
@@ -183,7 +183,7 @@
 done.
 
<a name="spirit.qi.reference.auxiliary.attr.example"></a><h6>
-<a name="id458559"></a>
+<a name="id458705"></a>
 <a href="attr.html#spirit.qi.reference.auxiliary.attr.example">Example</a>
 </h6>

Modified: trunk/libs/spirit/doc/html/spirit/qi/reference/basics.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/qi/reference/basics.html (original)
+++ trunk/libs/spirit/doc/html/spirit/qi/reference/basics.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -6,7 +6,7 @@
<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
<link rel="home" href="../../../index.html" title="Spirit 2.1">
<link rel="up" href="../reference.html" title="Reference">
-<link rel="previous" href="parser_concepts/naryparser.html" title="NaryParser">
+<link rel="previous" href="parser_concepts.html" title="Parser Concepts">
<link rel="next" href="auxiliary.html" title="Auxiliary">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@@ -20,7 +20,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="parser_concepts/naryparser.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>
+<a accesskey="p" href="parser_concepts.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">
@@ -30,7 +30,7 @@
<div></div>
</div>
<a name="spirit.qi.reference.basics.lazy_argument"></a><h5>
-<a name="id457085"></a>
+<a name="id457231"></a>
 <a href="basics.html#spirit.qi.reference.basics.lazy_argument">Lazy Argument</a>
 </h5>

@@ -54,7 +54,7 @@
 second argument. This is done for uniformity with Semantic Actions).
 
<a name="spirit.qi.reference.basics.character_encoding_namespace"></a><h5>
-<a name="id457293"></a>
+<a name="id457439"></a>
 <a href="basics.html#spirit.qi.reference.basics.character_encoding_namespace">Character
 Encoding Namespace</a>
 </h5>
@@ -126,7 +126,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="parser_concepts/naryparser.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>
+<a accesskey="p" href="parser_concepts.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>

Modified: trunk/libs/spirit/doc/html/spirit/qi/reference/directive.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/qi/reference/directive.html (original)
+++ trunk/libs/spirit/doc/html/spirit/qi/reference/directive.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -6,8 +6,8 @@
<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
<link rel="home" href="../../../index.html" title="Spirit 2.1">
<link rel="up" href="../reference.html" title="Reference">
-<link rel="previous" href="auxiliary/attr.html" title="attr">
-<link rel="next" href="directive/no_case.html" title=" no_case">
+<link rel="previous" href="auxiliary.html" title="Auxiliary">
+<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>
@@ -20,7 +20,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="auxiliary/attr.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/no_case.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+<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="string.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage">
@@ -29,7 +29,7 @@
</h4></div></div>
<div></div>
</div>
-<div class="toc"><dl><dt> no_case</dt></dl></div>
+<div class="toc"><dl><dt> no_case</dt></dl></div>

 This module includes different directives usable to augment and parametrize
 other parsers. It includes the <tt class="computeroutput">no_case</tt>,
@@ -37,12 +37,267 @@
 <tt class="computeroutput">raw</tt>, and <tt class="computeroutput">skip</tt> directives.
 
<a name="spirit.qi.reference.directive.module_header"></a><h5>
-<a name="id459994"></a>
+<a name="id460140"></a>
 <a href="directive.html#spirit.qi.reference.directive.module_header">Module Header</a>
 </h5>
<pre class="programlisting">// forwards to <boost/spirit/home/qi/directive.hpp>
#include <boost/spirit/include/qi_directive.hpp>
</pre>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.qi.reference.directive.no_case"></a> no_case
+</h5></div></div>
+<div></div>
+</div>
+<div class="itemizedlist"><ul type="disc"><li>
+<tt class="computeroutput">boost::spirit::no_case</tt>: generates a parser directive
+ forcing all embedded parsers to do case in-sensitive matching.
+ </li></ul></div>
+<a name="spirit.qi.reference.directive.no_case.description"></a><h6>
+<a name="id460299"></a>
+ Description
+ </h6>
+
+ The <tt class="computeroutput">no_case[]</tt>
+ directive does not consume any input on it's own. The actual matching
+ is done by the embedded parsers. It's purpose is to force all matching
+ of all embedded parsers to be case in-sensitive.
+ 
+<a name="spirit.qi.reference.directive.no_case.header"></a><h6>
+<a name="id460348"></a>
+ Header
+ </h6>
+<pre class="programlisting">// forwards to <boost/spirit/home/qi/directive/no_case.hpp>
+#include <boost/spirit/include/qi_no_case.hpp>
+</pre>
+
+ Also, see Include Structure.
+ 
+<a name="spirit.qi.reference.directive.no_case.model_of"></a><h6>
+<a name="id460461"></a>
+ <a href="directive.html#spirit.qi.reference.directive.no_case.model_of">Model
+ of</a>
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ This directive is special as it does not conform to any parser concept.
+ It is a pure modifier directive.
+ 
+
+ 
+</blockquote></div>
+<div class="variablelist">
+Notation
+<dl>
+<dt><tt class="computeroutput">p</tt></dt>
+<dd>
+ A arbitrary complex parser expression embedded inside the <tt class="computeroutput">no_case[]</tt>
+ directive.
+ </dd>
+</dl>
+</div>
+<a name="spirit.qi.reference.directive.no_case.expression_semantics"></a><h6>
+<a name="id460545"></a>
+ <a href="directive.html#spirit.qi.reference.directive.no_case.expression_semantics">Expression
+ Semantics</a>
+ </h6>
+
+ The <tt class="computeroutput">no_case[]</tt>
+ directive has no special parser semantics. It is a pure modifier directive.
+ It indirectly influences the way all embedded parsers do their matching.
+ It adds information (the <tt class="computeroutput">tag::no_case</tt>)
+ to the <tt class="computeroutput">Modifier</tt> template
+ parameter used while tranforming the <tt class="computeroutput">proto::expr</tt>
+ into the corresponding parser expression. This is achieved by the following
+ specialization:
+ 
+<pre class="programlisting">namespace boost { namespace spirit
+{
+ template <typename CharEncoding>
+ struct is_modifier_directive<
+ qi::domain
+ , tag::char_code<tag::no_case, CharEncoding> >
+ : mpl::true_
+ {};
+}}
+</pre>
+
+ (for more details see the section describing the compilation process
+ of the Boost.Proto
+ expression into the corresponding parser expressions).
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Semantics
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ <tt class="computeroutput">no_case[p]</tt>
+ </td>
+<td>
+ Force <tt class="computeroutput">p</tt> to match
+ its input case in-sensitive.
+ </td>
+</tr></tbody>
+</table></div>
+<a name="spirit.qi.reference.directive.no_case.attributes"></a><h6>
+<a name="id460968"></a>
+ Attributes
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Attribute
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ <tt class="computeroutput">no_case[a]</tt>
+ </td>
+<td>
+ <tt class="computeroutput">A</tt>, the no_case
+ directive exposes the attribute of its embedded parser.
+ </td>
+</tr></tbody>
+</table></div>
+<a name="spirit.qi.reference.directive.no_case.complexity"></a><h6>
+<a name="id461085"></a>
+ Complexity
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ The complexity is defined by the complexity of the embedded parser
+ 
+
+ 
+</blockquote></div>
+<a name="spirit.qi.reference.directive.no_case.example"></a><h6>
+<a name="id461122"></a>
+ Example
+ </h6>
+
+ Some 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>
+
+ 
+
+ 
+
+ All code snippets below use this common test function:
+ 
+
+ 
+
+
+
+<pre class="programlisting">template <typename P>
+void test_parser(char const* input, P const& p)
+{
+ std::string s(input);
+ std::string::iterator f(s.begin());
+ if (boost::spirit::qi::parse(f, s.end(), p))
+ std::cout << "ok" << std::endl;
+ else
+ std::cout << "fail" << std::endl;
+}
+</pre>
+
+ 
+
+ 
+
+ Some using declaration:
+ 
+
+ 
+
+
+
+<pre class="programlisting">using boost::spirit::qi::parse;
+using boost::spirit::qi::symbols;
+using boost::spirit::ascii::no_case;
+</pre>
+
+ 
+
+ 
+
+ Simple usage of <tt class="computeroutput">no_case[]</tt>:
+ 
+
+ 
+
+
+
+<pre class="programlisting">test_parser("X", no_case[char_('x')]);
+test_parser("6", no_case[alnum]);
+</pre>
+
+ 
+
+ 
+
+ A more sophisticated use case of <tt class="computeroutput">no_case[]</tt> in conjunction with a symbol table
+ (see symbols<Ch, T>
+ for more details):
+ 
+
+ 
+
+
+
+<pre class="programlisting">symbols<char, int> sym;
+
+sym.add
+ ("apple", 1) // symbol strings are added in lowercase...
+ ("banana", 2)
+ ("orange", 3)
+;
+
+int i;
+// ...because sym is used for case-insensitive parsing
+test_parser_attr("Apple", no_case[ sym ], i);
+std::cout << i << std::endl;
+test_parser_attr("ORANGE", no_case[ sym ], i);
+std::cout << i << std::endl;
+</pre>
+
+ 
+
+ 
+</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
@@ -55,7 +310,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="auxiliary/attr.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/no_case.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+<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="string.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>

Modified: trunk/libs/spirit/doc/html/spirit/qi/reference/directive/no_case.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/qi/reference/directive/no_case.html (original)
+++ trunk/libs/spirit/doc/html/spirit/qi/reference/directive/no_case.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -34,7 +34,7 @@
 forcing all embedded parsers to do case in-sensitive matching.
 </li></ul></div>
<a name="spirit.qi.reference.directive.no_case.description"></a><h6>
-<a name="id460152"></a>
+<a name="id460299"></a>
 <a href="no_case.html#spirit.qi.reference.directive.no_case.description">Description</a>
 </h6>

@@ -44,7 +44,7 @@
 of all embedded parsers to be case in-sensitive.
 
<a name="spirit.qi.reference.directive.no_case.header"></a><h6>
-<a name="id460202"></a>
+<a name="id460348"></a>
 <a href="no_case.html#spirit.qi.reference.directive.no_case.header">Header</a>
 </h6>
<pre class="programlisting">// forwards to <boost/spirit/home/qi/directive/no_case.hpp>
@@ -54,7 +54,7 @@
 Also, see Include Structure.
 
<a name="spirit.qi.reference.directive.no_case.model_of"></a><h6>
-<a name="id460314"></a>
+<a name="id460461"></a>
 <a href="no_case.html#spirit.qi.reference.directive.no_case.model_of">Model
 of</a>
 </h6>
@@ -79,7 +79,7 @@
</dl>
</div>
<a name="spirit.qi.reference.directive.no_case.expression_semantics"></a><h6>
-<a name="id460399"></a>
+<a name="id460545"></a>
 <a href="no_case.html#spirit.qi.reference.directive.no_case.expression_semantics">Expression
 Semantics</a>
 </h6>
@@ -132,7 +132,7 @@
</tr></tbody>
</table></div>
<a name="spirit.qi.reference.directive.no_case.attributes"></a><h6>
-<a name="id460822"></a>
+<a name="id460968"></a>
 <a href="no_case.html#spirit.qi.reference.directive.no_case.attributes">Attributes</a>
 </h6>
<div class="informaltable"><table class="table">
@@ -159,7 +159,7 @@
</tr></tbody>
</table></div>
<a name="spirit.qi.reference.directive.no_case.complexity"></a><h6>
-<a name="id460940"></a>
+<a name="id461085"></a>
 <a href="no_case.html#spirit.qi.reference.directive.no_case.complexity">Complexity</a>
 </h6>
<div class="blockquote"><blockquote class="blockquote">
@@ -172,7 +172,7 @@
 
</blockquote></div>
<a name="spirit.qi.reference.directive.no_case.example"></a><h6>
-<a name="id460977"></a>
+<a name="id461122"></a>
 <a href="no_case.html#spirit.qi.reference.directive.no_case.example">Example</a>
 </h6>

Modified: trunk/libs/spirit/doc/html/spirit/qi/reference/parser_concepts.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/qi/reference/parser_concepts.html (original)
+++ trunk/libs/spirit/doc/html/spirit/qi/reference/parser_concepts.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -7,7 +7,7 @@
<link rel="home" href="../../../index.html" title="Spirit 2.1">
<link rel="up" href="../reference.html" title="Reference">
<link rel="previous" href="../reference.html" title="Reference">
-<link rel="next" href="parser_concepts/parser.html" title="Parser">
+<link rel="next" href="basics.html" title="Basics">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
@@ -20,7 +20,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../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="parser_concepts/parser.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+<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="basics.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage">
@@ -30,11 +30,11 @@
<div></div>
</div>
<div class="toc"><dl>
-<dt>Parser</dt>
-<dt>PrimitiveParser</dt>
-<dt>UnaryParser</dt>
-<dt>BinaryParser</dt>
-<dt>NaryParser</dt>
+<dt>Parser</dt>
+<dt>PrimitiveParser</dt>
+<dt>UnaryParser</dt>
+<dt>BinaryParser</dt>
+<dt>NaryParser</dt>
</dl></div>

 Spirit.Qi parsers fall into a couple of generalized concepts. The Parser
@@ -47,6 +47,755 @@

 The following sections provide details on these concepts.
 
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.qi.reference.parser_concepts.parser"></a>Parser
+</h5></div></div>
+<div></div>
+</div>
+<a name="spirit.qi.reference.parser_concepts.parser.description"></a><h6>
+<a name="id453137"></a>
+ Description
+ </h6>
+
+ The Parser is the most fundamental concept. A Parser
+ has a member function, <tt class="computeroutput">parse</tt>,
+ that accepts a first-last <tt class="computeroutput">ForwardIterator</tt>
+ pair and returns bool as its result. The iterators delimit the data being
+ parsed. The Parser's <tt class="computeroutput">parse</tt>
+ member function returns <tt class="computeroutput">true</tt>
+ if the parse succeeds, in which case the first iterator is advanced accordingly.
+ Each Parser can represent a specific pattern or algorithm, or it can
+ be a more complex parser formed as a composition of other Parsers.
+ 
+<div class="variablelist">
+Notation
+<dl>
+<dt><tt class="computeroutput">p</tt></dt>
+<dd>
+ A <tt class="computeroutput">Parser</tt>.
+ </dd>
+<dt><tt class="computeroutput">P</tt></dt>
+<dd>
+ A <tt class="computeroutput">Parser</tt> type.
+ </dd>
+<dt><tt class="computeroutput">Iter</tt></dt>
+<dd>
+ a <tt class="computeroutput">ForwardIterator</tt>
+ type.
+ </dd>
+<dt><tt class="computeroutput">f</tt>,
+ <tt class="computeroutput">l</tt></dt>
+<dd>
+ <tt class="computeroutput">ForwardIterator</tt>.
+ first/last iterator pair.
+ </dd>
+<dt><tt class="computeroutput">Context</tt></dt>
+<dd>
+ The parser's Context type.
+ </dd>
+<dt><tt class="computeroutput">context</tt></dt>
+<dd>
+ The parser's Context, or <tt class="computeroutput">unused</tt>.
+ </dd>
+<dt><tt class="computeroutput">skip</tt></dt>
+<dd>
+ A skip Parser, or <tt class="computeroutput">unused</tt>.
+ </dd>
+<dt><tt class="computeroutput">attrib</tt></dt>
+<dd>
+ A Compatible Attribute, or <tt class="computeroutput">unused</tt>.
+ </dd>
+</dl>
+</div>
+<a name="spirit.qi.reference.parser_concepts.parser.valid_expressions"></a><h6>
+<a name="id453511"></a>
+ <a href="parser_concepts.html#spirit.qi.reference.parser_concepts.parser.valid_expressions">Valid
+ Expressions</a>
+ </h6>
+
+ In the expressions below, the behavior of the parser, <tt class="computeroutput">p</tt>,
+ how <tt class="computeroutput">skip</tt> and <tt class="computeroutput">attrib</tt> are handled by <tt class="computeroutput">p</tt>, are left unspecified in the base
+ <tt class="computeroutput">Parser</tt> concept. These
+ are specified in subsequent, more refined concepts and by the actual
+ models therof.
+ 
+
+ For any Parser the following expressions must be valid:
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Semantics
+ </th>
+<th>
+ Return type
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">p.parse(f, l, context, skip, attr)</pre>
+
+ 
+</td>
+<td>
+ Match the input sequence starting from <tt class="computeroutput">f</tt>.
+ Return <tt class="computeroutput">true</tt> if successful,
+ otherwise return <tt class="computeroutput">false</tt>.
+ </td>
+<td>
+ <tt class="computeroutput">bool</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">p.what(context)</tt>
+ </td>
+<td>
+ Get information about a Parser.
+ </td>
+<td>
+ <tt class="computeroutput">info</tt>
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="spirit.qi.reference.parser_concepts.parser.type_expressions"></a><h6>
+<a name="id453874"></a>
+ <a href="parser_concepts.html#spirit.qi.reference.parser_concepts.parser.type_expressions">Type
+ Expressions</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Description
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <tt class="computeroutput">P::template attribute<Context, Iter>::type</tt>
+ </td>
+<td>
+ The Parser's expected attribute.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">traits::is_parser<P>::type</tt>
+ </td>
+<td>
+ Metafunction that evaluates to <tt class="computeroutput">mpl::true_</tt>
+ if a certain type, <tt class="computeroutput">P</tt>
+ is a Parser, <tt class="computeroutput">mpl::false_</tt>
+ otherwise (See <a href="../../../../../../../libs/mpl/doc/refmanual/integral-constant.html" target="_top">MPL
+ Boolean Constant</a>).
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="spirit.qi.reference.parser_concepts.parser.postcondition"></a><h6>
+<a name="id454139"></a>
+ Postcondition
+ </h6>
+
+ Upon return from <tt class="computeroutput">p.parse</tt> the following post conditions
+ should hold:
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ On a successful match, <tt class="computeroutput">f</tt>
+ is positioned one past the first non-matching character/token.
+ </li>
+<li>
+ On a failed match, if a <tt class="computeroutput">skip</tt>
+ parser is <tt class="computeroutput">unused</tt>,
+ <tt class="computeroutput">f</tt> is restored to its
+ original position prior to entry.
+ </li>
+<li>
+ On a failed match, if a <tt class="computeroutput">skip</tt>
+ parser is not <tt class="computeroutput">unused</tt>,
+ <tt class="computeroutput">f</tt> is positioned one
+ past the first character/token not matching <tt class="computeroutput">skip</tt>.
+ </li>
+<li>
+ On a failed match, <tt class="computeroutput">attrib</tt>
+ is left untouched.
+ </li>
+<li>
+ No post-skips: trailing <tt class="computeroutput">skip</tt>
+ characters/tokens will not be skipped.
+ </li>
+</ul></div>
+<a name="spirit.qi.reference.parser_concepts.parser.models"></a><h6>
+<a name="id454341"></a>
+ Models
+ </h6>
+
+ All parsers in Spirit.Qi are models of the Parser
+ concept.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.qi.reference.parser_concepts.primitiveparser"></a>PrimitiveParser
+</h5></div></div>
+<div></div>
+</div>
+<a name="spirit.qi.reference.parser_concepts.primitiveparser.description"></a><h6>
+<a name="id454395"></a>
+ Description
+ </h6>
+
+ PrimitiveParser is the most basic building block
+ that the client uses to build more complex parsers.
+ 
+<a name="spirit.qi.reference.parser_concepts.primitiveparser.refinement_of"></a><h6>
+<a name="id454431"></a>
+ <a href="parser_concepts.html#spirit.qi.reference.parser_concepts.primitiveparser.refinement_of">Refinement
+ of</a>
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ Parser
+ 
+
+ 
+</blockquote></div>
+<a name="spirit.qi.reference.parser_concepts.primitiveparser.pre_skip"></a><h6>
+<a name="id454486"></a>
+ Pre-skip
+ </h6>
+
+ Upon entry to the <tt class="computeroutput">parse</tt>
+ member function, a PrimitiveParser is required to do a pre-skip. Leading
+ <tt class="computeroutput">skip</tt> characters/tokens
+ will be skipped prior to parsing. Only PrimitiveParsers are required
+ to perform this pre-skip. This is typically carried out through a call
+ to <tt class="computeroutput">qi::skip_over</tt>:
+ 
+<pre class="programlisting">qi::skip_over(f, l, skip);
+</pre>
+<a name="spirit.qi.reference.parser_concepts.primitiveparser.type_expressions"></a><h6>
+<a name="id454625"></a>
+ <a href="parser_concepts.html#spirit.qi.reference.parser_concepts.primitiveparser.type_expressions">Type
+ Expressions</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Description
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ <tt class="computeroutput">traits::is_primitive_parser<P>::type</tt>
+ </td>
+<td>
+ Metafunction that evaluates to <tt class="computeroutput">mpl::true_</tt>
+ if a certain type, <tt class="computeroutput">P</tt>,
+ is a PrimitiveParser, <tt class="computeroutput">mpl::false_</tt>
+ otherwise (See <a href="../../../../../../../libs/mpl/doc/refmanual/integral-constant.html" target="_top">MPL
+ Boolean Constant</a>).
+ </td>
+</tr></tbody>
+</table></div>
+<a name="spirit.qi.reference.parser_concepts.primitiveparser.models"></a><h6>
+<a name="id454812"></a>
+ Models
+ </h6>
+
+ FIXME Add links to PrimitiveParser
+ models here.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.qi.reference.parser_concepts.unaryparser"></a>UnaryParser
+</h5></div></div>
+<div></div>
+</div>
+<a name="spirit.qi.reference.parser_concepts.unaryparser.description"></a><h6>
+<a name="id454871"></a>
+ Description
+ </h6>
+
+ UnaryParser is a composite parser that has a single
+ subject. The UnaryParser may change the behavior of its subject following
+ the Delegate Design Pattern.
+ 
+<a name="spirit.qi.reference.parser_concepts.unaryparser.refinement_of"></a><h6>
+<a name="id454906"></a>
+ <a href="parser_concepts.html#spirit.qi.reference.parser_concepts.unaryparser.refinement_of">Refinement
+ of</a>
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ Parser
+ 
+
+ 
+</blockquote></div>
+<div class="variablelist">
+Notation
+<dl>
+<dt><tt class="computeroutput">p</tt></dt>
+<dd>
+ A UnaryParser.
+ </dd>
+<dt><tt class="computeroutput">P</tt></dt>
+<dd>
+ A UnaryParser type.
+ </dd>
+</dl>
+</div>
+<a name="spirit.qi.reference.parser_concepts.unaryparser.valid_expressions"></a><h6>
+<a name="id455014"></a>
+ <a href="parser_concepts.html#spirit.qi.reference.parser_concepts.unaryparser.valid_expressions">Valid
+ Expressions</a>
+ </h6>
+
+ In addition to the requirements defined in Parser, for any UnaryParser
+ the following must be met:
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Semantics
+ </th>
+<th>
+ Return type
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ <tt class="computeroutput">p.subject</tt>
+ </td>
+<td>
+ Subject parser.
+ </td>
+<td>
+ Parser
+ </td>
+</tr></tbody>
+</table></div>
+<a name="spirit.qi.reference.parser_concepts.unaryparser.type_expressions"></a><h6>
+<a name="id455170"></a>
+ <a href="parser_concepts.html#spirit.qi.reference.parser_concepts.unaryparser.type_expressions">Type
+ Expressions</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Description
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <tt class="computeroutput">P::subject_type</tt>
+ </td>
+<td>
+ The subject parser type.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">traits::is_unary_parser<P>::type</tt>
+ </td>
+<td>
+ Metafunction that evaluates to <tt class="computeroutput">mpl::true_</tt>
+ if a certain type, <tt class="computeroutput">P</tt>
+ is a UnaryParser, <tt class="computeroutput">mpl::false_</tt>
+ otherwise (See <a href="../../../../../../../libs/mpl/doc/refmanual/integral-constant.html" target="_top">MPL
+ Boolean Constant</a>).
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="spirit.qi.reference.parser_concepts.unaryparser.invariants"></a><h6>
+<a name="id455394"></a>
+ Invariants
+ </h6>
+
+ For any UnaryParser, <tt class="computeroutput">P</tt>,
+ the following invariant always holds:
+ 
+<div class="itemizedlist"><ul type="disc"><li>
+<tt class="computeroutput">traits::is_parser<P::subject_type>::type</tt> evaluates to <tt class="computeroutput">mpl::true_</tt>
+</li></ul></div>
+<a name="spirit.qi.reference.parser_concepts.unaryparser.models"></a><h6>
+<a name="id455517"></a>
+ Models
+ </h6>
+
+ FIXME Add links to models of UnaryParser
+ concept
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.qi.reference.parser_concepts.binaryparser"></a>BinaryParser
+</h5></div></div>
+<div></div>
+</div>
+<a name="spirit.qi.reference.parser_concepts.binaryparser.description"></a><h6>
+<a name="id455573"></a>
+ Description
+ </h6>
+
+ BinaryParser is a composite parser that has a two
+ subjects, <tt class="computeroutput">left</tt> and <tt class="computeroutput">right</tt>. The BinaryParser allows its
+ subjects to be treated in the same way as a single instance of a Parser
+ following the Composite Design Pattern.
+ 
+<a name="spirit.qi.reference.parser_concepts.binaryparser.refinement_of"></a><h6>
+<a name="id455652"></a>
+ <a href="parser_concepts.html#spirit.qi.reference.parser_concepts.binaryparser.refinement_of">Refinement
+ of</a>
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ Parser
+ 
+
+ 
+</blockquote></div>
+<div class="variablelist">
+Notation
+<dl>
+<dt><tt class="computeroutput">p</tt></dt>
+<dd>
+ A BinaryParser.
+ </dd>
+<dt><tt class="computeroutput">P</tt></dt>
+<dd>
+ A BinaryParser type.
+ </dd>
+</dl>
+</div>
+<a name="spirit.qi.reference.parser_concepts.binaryparser.valid_expressions"></a><h6>
+<a name="id455760"></a>
+ <a href="parser_concepts.html#spirit.qi.reference.parser_concepts.binaryparser.valid_expressions">Valid
+ Expressions</a>
+ </h6>
+
+ In addition to the requirements defined in Parser, for any BinaryParser
+ the following must be met:
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Semantics
+ </th>
+<th>
+ Return type
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <tt class="computeroutput">p.left</tt>
+ </td>
+<td>
+ Left parser.
+ </td>
+<td>
+ Parser
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">p.right</tt>
+ </td>
+<td>
+ Right parser.
+ </td>
+<td>
+ Parser
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="spirit.qi.reference.parser_concepts.binaryparser.type_expressions"></a><h6>
+<a name="id455979"></a>
+ <a href="parser_concepts.html#spirit.qi.reference.parser_concepts.binaryparser.type_expressions">Type
+ Expressions</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Description
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <tt class="computeroutput">P::left_type</tt>
+ </td>
+<td>
+ The left parser type.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">P::right_type</tt>
+ </td>
+<td>
+ The right parser type.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">traits::is_binary_parser<P>::type</tt>
+ </td>
+<td>
+ Metafunction that evaluates to <tt class="computeroutput">mpl::true_</tt>
+ if a certain type, <tt class="computeroutput">P</tt>
+ is a BinaryParser, <tt class="computeroutput">mpl::false_</tt>
+ otherwise (See <a href="../../../../../../../libs/mpl/doc/refmanual/integral-constant.html" target="_top">MPL
+ Boolean Constant</a>).
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="spirit.qi.reference.parser_concepts.binaryparser.invariants"></a><h6>
+<a name="id456245"></a>
+ Invariants
+ </h6>
+
+ For any BinaryParser, <tt class="computeroutput">P</tt>,
+ the following invariants always hold:
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+<tt class="computeroutput">traits::is_parser<P::left_type>::type</tt> evaluates to <tt class="computeroutput">mpl::true_</tt>
+</li>
+<li>
+<tt class="computeroutput">traits::is_parser<P::right_type>::type</tt> evaluates to <tt class="computeroutput">mpl::true_</tt>
+</li>
+</ul></div>
+<a name="spirit.qi.reference.parser_concepts.binaryparser.models"></a><h6>
+<a name="id456445"></a>
+ Models
+ </h6>
+
+ FIXME Add links to models of BinaryParser
+ concept
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.qi.reference.parser_concepts.naryparser"></a>NaryParser
+</h5></div></div>
+<div></div>
+</div>
+<a name="spirit.qi.reference.parser_concepts.naryparser.description"></a><h6>
+<a name="id456499"></a>
+ Description
+ </h6>
+
+ NaryParser is a composite parser that has one or
+ more subjects. The NaryParser allows its subjects to be treated in the
+ same way as a single instance of a Parser following the Composite
+ Design Pattern.
+ 
+<a name="spirit.qi.reference.parser_concepts.naryparser.refinement_of"></a><h6>
+<a name="id456554"></a>
+ <a href="parser_concepts.html#spirit.qi.reference.parser_concepts.naryparser.refinement_of">Refinement
+ of</a>
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ Parser
+ 
+
+ 
+</blockquote></div>
+<div class="variablelist">
+Notation
+<dl>
+<dt><tt class="computeroutput">p</tt></dt>
+<dd>
+ A NaryParser.
+ </dd>
+<dt><tt class="computeroutput">P</tt></dt>
+<dd>
+ A NaryParser type.
+ </dd>
+</dl>
+</div>
+<a name="spirit.qi.reference.parser_concepts.naryparser.valid_expressions"></a><h6>
+<a name="id456661"></a>
+ <a href="parser_concepts.html#spirit.qi.reference.parser_concepts.naryparser.valid_expressions">Valid
+ Expressions</a>
+ </h6>
+
+ In addition to the requirements defined in Parser, for any NaryParser the
+ following must be met:
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Semantics
+ </th>
+<th>
+ Return type
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ <tt class="computeroutput">p.elements</tt>
+ </td>
+<td>
+ The tuple of elements.
+ </td>
+<td>
+ A Fusion
+ Sequence of Parser types.
+ </td>
+</tr></tbody>
+</table></div>
+<a name="spirit.qi.reference.parser_concepts.naryparser.type_expressions"></a><h6>
+<a name="id456825"></a>
+ <a href="parser_concepts.html#spirit.qi.reference.parser_concepts.naryparser.type_expressions">Type
+ Expressions</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Description
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <tt class="computeroutput">p.elements_type</tt>
+ </td>
+<td>
+ Elements tuple type.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">traits::is_nary_parser<P>::type</tt>
+ </td>
+<td>
+ Metafunction that evaluates to <tt class="computeroutput">mpl::true_</tt>
+ if a certain type, <tt class="computeroutput">P</tt>
+ is a NaryParser, <tt class="computeroutput">mpl::false_</tt>
+ otherwise (See <a href="../../../../../../../libs/mpl/doc/refmanual/integral-constant.html" target="_top">MPL
+ Boolean Constant</a>).
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="spirit.qi.reference.parser_concepts.naryparser.invariants"></a><h6>
+<a name="id457051"></a>
+ Invariants
+ </h6>
+
+ For each element, <tt class="computeroutput">E</tt>,
+ in any NaryParser, <tt class="computeroutput">P</tt>,
+ the following invariant always holds:
+ 
+<div class="itemizedlist"><ul type="disc"><li>
+<tt class="computeroutput">traits::is_parser<E>::type</tt> evaluates to <tt class="computeroutput">mpl::true_</tt>
+</li></ul></div>
+<a name="spirit.qi.reference.parser_concepts.naryparser.models"></a><h6>
+<a name="id457176"></a>
+ Models
+ </h6>
+
+ FIXME Add links to models of NaryParser
+ concept
+ 
+</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
@@ -59,7 +808,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../reference.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="parser_concepts/parser.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+<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="basics.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>

Modified: trunk/libs/spirit/doc/html/spirit/qi/reference/parser_concepts/binaryparser.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/qi/reference/parser_concepts/binaryparser.html (original)
+++ trunk/libs/spirit/doc/html/spirit/qi/reference/parser_concepts/binaryparser.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -30,7 +30,7 @@
<div></div>
</div>
<a name="spirit.qi.reference.parser_concepts.binaryparser.description"></a><h6>
-<a name="id455426"></a>
+<a name="id455573"></a>
 <a href="binaryparser.html#spirit.qi.reference.parser_concepts.binaryparser.description">Description</a>
 </h6>

@@ -40,7 +40,7 @@
 following the Composite Design Pattern.
 
<a name="spirit.qi.reference.parser_concepts.binaryparser.refinement_of"></a><h6>
-<a name="id455505"></a>
+<a name="id455652"></a>
 <a href="binaryparser.html#spirit.qi.reference.parser_concepts.binaryparser.refinement_of">Refinement
 of</a>
 </h6>
@@ -67,7 +67,7 @@
</dl>
</div>
<a name="spirit.qi.reference.parser_concepts.binaryparser.valid_expressions"></a><h6>
-<a name="id455613"></a>
+<a name="id455760"></a>
 <a href="binaryparser.html#spirit.qi.reference.parser_concepts.binaryparser.valid_expressions">Valid
 Expressions</a>
 </h6>
@@ -118,7 +118,7 @@
</tbody>
</table></div>
<a name="spirit.qi.reference.parser_concepts.binaryparser.type_expressions"></a><h6>
-<a name="id455833"></a>
+<a name="id455979"></a>
 <a href="binaryparser.html#spirit.qi.reference.parser_concepts.binaryparser.type_expressions">Type
 Expressions</a>
 </h6>
@@ -167,7 +167,7 @@
</tbody>
</table></div>
<a name="spirit.qi.reference.parser_concepts.binaryparser.invariants"></a><h6>
-<a name="id456099"></a>
+<a name="id456245"></a>
 <a href="binaryparser.html#spirit.qi.reference.parser_concepts.binaryparser.invariants">Invariants</a>
 </h6>

@@ -183,7 +183,7 @@
</li>
</ul></div>
<a name="spirit.qi.reference.parser_concepts.binaryparser.models"></a><h6>
-<a name="id456299"></a>
+<a name="id456445"></a>
 <a href="binaryparser.html#spirit.qi.reference.parser_concepts.binaryparser.models">Models</a>
 </h6>

Modified: trunk/libs/spirit/doc/html/spirit/qi/reference/parser_concepts/naryparser.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/qi/reference/parser_concepts/naryparser.html (original)
+++ trunk/libs/spirit/doc/html/spirit/qi/reference/parser_concepts/naryparser.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -30,7 +30,7 @@
<div></div>
</div>
<a name="spirit.qi.reference.parser_concepts.naryparser.description"></a><h6>
-<a name="id456353"></a>
+<a name="id456499"></a>
 <a href="naryparser.html#spirit.qi.reference.parser_concepts.naryparser.description">Description</a>
 </h6>

@@ -40,7 +40,7 @@
 Design Pattern.
 
<a name="spirit.qi.reference.parser_concepts.naryparser.refinement_of"></a><h6>
-<a name="id456407"></a>
+<a name="id456554"></a>
 <a href="naryparser.html#spirit.qi.reference.parser_concepts.naryparser.refinement_of">Refinement
 of</a>
 </h6>
@@ -67,7 +67,7 @@
</dl>
</div>
<a name="spirit.qi.reference.parser_concepts.naryparser.valid_expressions"></a><h6>
-<a name="id456514"></a>
+<a name="id456661"></a>
 <a href="naryparser.html#spirit.qi.reference.parser_concepts.naryparser.valid_expressions">Valid
 Expressions</a>
 </h6>
@@ -106,7 +106,7 @@
</tr></tbody>
</table></div>
<a name="spirit.qi.reference.parser_concepts.naryparser.type_expressions"></a><h6>
-<a name="id456679"></a>
+<a name="id456825"></a>
 <a href="naryparser.html#spirit.qi.reference.parser_concepts.naryparser.type_expressions">Type
 Expressions</a>
 </h6>
@@ -147,7 +147,7 @@
</tbody>
</table></div>
<a name="spirit.qi.reference.parser_concepts.naryparser.invariants"></a><h6>
-<a name="id456905"></a>
+<a name="id457051"></a>
 <a href="naryparser.html#spirit.qi.reference.parser_concepts.naryparser.invariants">Invariants</a>
 </h6>

@@ -159,7 +159,7 @@
<tt class="computeroutput">traits::is_parser<E>::type</tt> evaluates to <tt class="computeroutput">mpl::true_</tt>
</li></ul></div>
<a name="spirit.qi.reference.parser_concepts.naryparser.models"></a><h6>
-<a name="id457030"></a>
+<a name="id457176"></a>
 <a href="naryparser.html#spirit.qi.reference.parser_concepts.naryparser.models">Models</a>
 </h6>

Modified: trunk/libs/spirit/doc/html/spirit/qi/reference/parser_concepts/parser.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/qi/reference/parser_concepts/parser.html (original)
+++ trunk/libs/spirit/doc/html/spirit/qi/reference/parser_concepts/parser.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -30,7 +30,7 @@
<div></div>
</div>
<a name="spirit.qi.reference.parser_concepts.parser.description"></a><h6>
-<a name="id452990"></a>
+<a name="id453137"></a>
 <a href="parser.html#spirit.qi.reference.parser_concepts.parser.description">Description</a>
 </h6>

@@ -85,7 +85,7 @@
</dl>
</div>
<a name="spirit.qi.reference.parser_concepts.parser.valid_expressions"></a><h6>
-<a name="id453364"></a>
+<a name="id453511"></a>
 <a href="parser.html#spirit.qi.reference.parser_concepts.parser.valid_expressions">Valid
 Expressions</a>
 </h6>
@@ -149,7 +149,7 @@
</tbody>
</table></div>
<a name="spirit.qi.reference.parser_concepts.parser.type_expressions"></a><h6>
-<a name="id453728"></a>
+<a name="id453874"></a>
 <a href="parser.html#spirit.qi.reference.parser_concepts.parser.type_expressions">Type
 Expressions</a>
 </h6>
@@ -190,7 +190,7 @@
</tbody>
</table></div>
<a name="spirit.qi.reference.parser_concepts.parser.postcondition"></a><h6>
-<a name="id453993"></a>
+<a name="id454139"></a>
 <a href="parser.html#spirit.qi.reference.parser_concepts.parser.postcondition">Postcondition</a>
 </h6>

@@ -224,7 +224,7 @@
 </li>
</ul></div>
<a name="spirit.qi.reference.parser_concepts.parser.models"></a><h6>
-<a name="id454195"></a>
+<a name="id454341"></a>
 <a href="parser.html#spirit.qi.reference.parser_concepts.parser.models">Models</a>
 </h6>

Modified: trunk/libs/spirit/doc/html/spirit/qi/reference/parser_concepts/primitiveparser.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/qi/reference/parser_concepts/primitiveparser.html (original)
+++ trunk/libs/spirit/doc/html/spirit/qi/reference/parser_concepts/primitiveparser.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -30,7 +30,7 @@
<div></div>
</div>
<a name="spirit.qi.reference.parser_concepts.primitiveparser.description"></a><h6>
-<a name="id454249"></a>
+<a name="id454395"></a>
 <a href="primitiveparser.html#spirit.qi.reference.parser_concepts.primitiveparser.description">Description</a>
 </h6>

@@ -38,7 +38,7 @@
 that the client uses to build more complex parsers.
 
<a name="spirit.qi.reference.parser_concepts.primitiveparser.refinement_of"></a><h6>
-<a name="id454285"></a>
+<a name="id454431"></a>
 <a href="primitiveparser.html#spirit.qi.reference.parser_concepts.primitiveparser.refinement_of">Refinement
 of</a>
 </h6>
@@ -52,7 +52,7 @@
 
</blockquote></div>
<a name="spirit.qi.reference.parser_concepts.primitiveparser.pre_skip"></a><h6>
-<a name="id454340"></a>
+<a name="id454486"></a>
 <a href="primitiveparser.html#spirit.qi.reference.parser_concepts.primitiveparser.pre_skip">Pre-skip</a>
 </h6>

@@ -66,7 +66,7 @@
<pre class="programlisting">qi::skip_over(f, l, skip);
</pre>
<a name="spirit.qi.reference.parser_concepts.primitiveparser.type_expressions"></a><h6>
-<a name="id454478"></a>
+<a name="id454625"></a>
 <a href="primitiveparser.html#spirit.qi.reference.parser_concepts.primitiveparser.type_expressions">Type
 Expressions</a>
 </h6>
@@ -97,7 +97,7 @@
</tr></tbody>
</table></div>
<a name="spirit.qi.reference.parser_concepts.primitiveparser.models"></a><h6>
-<a name="id454665"></a>
+<a name="id454812"></a>
 <a href="primitiveparser.html#spirit.qi.reference.parser_concepts.primitiveparser.models">Models</a>
 </h6>

Modified: trunk/libs/spirit/doc/html/spirit/qi/reference/parser_concepts/unaryparser.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/qi/reference/parser_concepts/unaryparser.html (original)
+++ trunk/libs/spirit/doc/html/spirit/qi/reference/parser_concepts/unaryparser.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -30,7 +30,7 @@
<div></div>
</div>
<a name="spirit.qi.reference.parser_concepts.unaryparser.description"></a><h6>
-<a name="id454724"></a>
+<a name="id454871"></a>
 <a href="unaryparser.html#spirit.qi.reference.parser_concepts.unaryparser.description">Description</a>
 </h6>

@@ -39,7 +39,7 @@
 the Delegate Design Pattern.
 
<a name="spirit.qi.reference.parser_concepts.unaryparser.refinement_of"></a><h6>
-<a name="id454760"></a>
+<a name="id454906"></a>
 <a href="unaryparser.html#spirit.qi.reference.parser_concepts.unaryparser.refinement_of">Refinement
 of</a>
 </h6>
@@ -66,7 +66,7 @@
</dl>
</div>
<a name="spirit.qi.reference.parser_concepts.unaryparser.valid_expressions"></a><h6>
-<a name="id454868"></a>
+<a name="id455014"></a>
 <a href="unaryparser.html#spirit.qi.reference.parser_concepts.unaryparser.valid_expressions">Valid
 Expressions</a>
 </h6>
@@ -104,7 +104,7 @@
</tr></tbody>
</table></div>
<a name="spirit.qi.reference.parser_concepts.unaryparser.type_expressions"></a><h6>
-<a name="id455023"></a>
+<a name="id455170"></a>
 <a href="unaryparser.html#spirit.qi.reference.parser_concepts.unaryparser.type_expressions">Type
 Expressions</a>
 </h6>
@@ -145,7 +145,7 @@
</tbody>
</table></div>
<a name="spirit.qi.reference.parser_concepts.unaryparser.invariants"></a><h6>
-<a name="id455247"></a>
+<a name="id455394"></a>
 <a href="unaryparser.html#spirit.qi.reference.parser_concepts.unaryparser.invariants">Invariants</a>
 </h6>

@@ -156,7 +156,7 @@
<tt class="computeroutput">traits::is_parser<P::subject_type>::type</tt> evaluates to <tt class="computeroutput">mpl::true_</tt>
</li></ul></div>
<a name="spirit.qi.reference.parser_concepts.unaryparser.models"></a><h6>
-<a name="id455370"></a>
+<a name="id455517"></a>
 <a href="unaryparser.html#spirit.qi.reference.parser_concepts.unaryparser.models">Models</a>
 </h6>

Modified: trunk/libs/spirit/doc/html/spirit/qi/reference/string.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/qi/reference/string.html (original)
+++ trunk/libs/spirit/doc/html/spirit/qi/reference/string.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -6,8 +6,8 @@
<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
<link rel="home" href="../../../index.html" title="Spirit 2.1">
<link rel="up" href="../reference.html" title="Reference">
-<link rel="previous" href="directive/no_case.html" title=" no_case">
-<link rel="next" href="string/lit_string.html" title="lit/string">
+<link rel="previous" href="directive.html" title=" Directive">
+<link rel="next" href="../../karma.html" title=" Karma - Writing Generators">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
@@ -20,7 +20,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="directive/no_case.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/lit_string.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+<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="../../karma.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage">
@@ -30,20 +30,827 @@
<div></div>
</div>
<div class="toc"><dl>
-<dt>lit/string</dt>
-<dt>symbols</dt>
+<dt>lit/string</dt>
+<dt>symbols</dt>
</dl></div>

 This module includes parsers for strings. Currently, this module includes
 the literal and string parsers and the symbol table.
 
<a name="spirit.qi.reference.string.module_header"></a><h5>
-<a name="id462485"></a>
+<a name="id462631"></a>
 <a href="string.html#spirit.qi.reference.string.module_header">Module Header</a>
 </h5>
<pre class="programlisting">// forwards to <boost/spirit/home/qi/string.hpp>
#include <boost/spirit/include/qi_string.hpp>
</pre>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.qi.reference.string.lit_string"></a>lit/string
+</h5></div></div>
+<div></div>
+</div>
+<div class="itemizedlist"><ul type="disc">
+<li>
+<tt class="computeroutput">boost::spirit::lit</tt>: generates a string parser (Same
+ as <tt class="computeroutput">boost::spirit::qi::lit</tt>)
+ </li>
+<li>
+<tt class="computeroutput">NS::string</tt>: generates a string parser
+ for the character encoding. <tt class="computeroutput">NS</tt>
+ is a <a href="basics.html#spirit.qi.reference.basics.character_encoding_namespace">Character
+ Encoding Namespace</a>.
+ </li>
+</ul></div>
+<a name="spirit.qi.reference.string.lit_string.description"></a><h6>
+<a name="id462876"></a>
+ Description
+ </h6>
+
+ The lit/string parser matches a string of characters. The lit/string
+ parser is an implicit lexeme: the <tt class="computeroutput">skip</tt>
+ parser is not applied in between characters of the string.
+ 
+<a name="spirit.qi.reference.string.lit_string.header"></a><h6>
+<a name="id462920"></a>
+ Header
+ </h6>
+<pre class="programlisting">// forwards to <boost/spirit/home/qi/string/lit.hpp>
+#include <boost/spirit/include/qi_lit.hpp>
+</pre>
+
+ Also, see Include Structure.
+ 
+<a name="spirit.qi.reference.string.lit_string.model_of"></a><h6>
+<a name="id463033"></a>
+ <a href="string.html#spirit.qi.reference.string.lit_string.model_of">Model
+ of</a>
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ PrimitiveParser
+ 
+
+ 
+</blockquote></div>
+<div class="variablelist">
+Notation
+<dl>
+<dt><tt class="computeroutput">s</tt></dt>
+<dd>
+ A literal string, e.g. "Hello", or a pointer/reference
+ to a null-terminated array of characters or a <tt class="computeroutput">std::basic_string</tt>.
+ </dd>
+<dt><tt class="computeroutput">fs</tt></dt>
+<dd>
+ A Lazy Argument
+ that evaluates to a <tt class="computeroutput">std::basic_string</tt>
+ or a pointer/reference to a null-terminated array of characters.
+ </dd>
+<dt><tt class="computeroutput">ns</tt></dt>
+<dd>
+ A <a href="basics.html#spirit.qi.reference.basics.character_encoding_namespace">Character
+ Encoding Namespace</a>.
+ </dd>
+</dl>
+</div>
+<a name="spirit.qi.reference.string.lit_string.expression_semantics"></a><h6>
+<a name="id463226"></a>
+ <a href="string.html#spirit.qi.reference.string.lit_string.expression_semantics">Expression
+ Semantics</a>
+ </h6>
+
+ Semantics of an expression is defined only where it differs from, or
+ is not defined in PrimitiveParser.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Semantics
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <tt class="computeroutput">s</tt>
+ </td>
+<td>
+ Generate a string parser from a string, <tt class="computeroutput">s</tt>.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">lit(s)</tt>
+ </td>
+<td>
+ Generate a string parser from a string, <tt class="computeroutput">s</tt>.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ns::string(s)</tt>
+ </td>
+<td>
+ Generate a string parser from a string, <tt class="computeroutput">s</tt>.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">fs</tt>
+ </td>
+<td>
+ Generate a string parser from a string, <tt class="computeroutput">s</tt>,
+ returned by invoking <tt class="computeroutput">fs</tt>
+ at parse time. See <a href="basics.html#spirit.qi.reference.basics.lazy_argument">Lazy
+ Argument</a>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">lit(fs)</tt>
+ </td>
+<td>
+ Generate a string parser from a string, <tt class="computeroutput">s</tt>,
+ returned by invoking <tt class="computeroutput">fs</tt>
+ at parse time. See <a href="basics.html#spirit.qi.reference.basics.lazy_argument">Lazy
+ Argument</a>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ns::string(fs)</tt>
+ </td>
+<td>
+ Generate a string parser from a string, <tt class="computeroutput">s</tt>,
+ returned by invoking <tt class="computeroutput">fs</tt>
+ at parse time. See <a href="basics.html#spirit.qi.reference.basics.lazy_argument">Lazy
+ Argument</a>
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="spirit.qi.reference.string.lit_string.attributes"></a><h6>
+<a name="id463702"></a>
+ Attributes
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Attribute
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <tt class="computeroutput">s</tt>
+ </td>
+<td>
+ <tt class="computeroutput">unused</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">lit(s)</tt>
+ </td>
+<td>
+ <tt class="computeroutput">unused</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ns::string(s)</tt>
+ </td>
+<td>
+ <tt class="computeroutput">std::basic_string<T></tt>
+ where <tt class="computeroutput">T</tt> is the
+ underlying character type of <tt class="computeroutput">s</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">fs</tt>
+ </td>
+<td>
+ <tt class="computeroutput">std::basic_string<T></tt>
+ where <tt class="computeroutput">T</tt> is the
+ underlying character type of <tt class="computeroutput">s</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">lit(fs)</tt>
+ </td>
+<td>
+ <tt class="computeroutput">std::basic_string<T></tt>
+ where <tt class="computeroutput">T</tt> is the
+ underlying character type of <tt class="computeroutput">s</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">ns::string(fs)</tt>
+ </td>
+<td>
+ <tt class="computeroutput">std::basic_string<T></tt>
+ where <tt class="computeroutput">T</tt> is the
+ underlying character type of <tt class="computeroutput">s</tt>
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="spirit.qi.reference.string.lit_string.complexity"></a><h6>
+<a name="id464277"></a>
+ Complexity
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ O(N)
+ 
+
+ 
+</blockquote></div>
+
+ where <tt class="computeroutput">N</tt> is the number
+ of characters in the string to be parsed.
+ 
+<a name="spirit.qi.reference.string.lit_string.example"></a><h6>
+<a name="id464330"></a>
+ Example
+ </h6>
+
+ Some 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>
+
+ 
+
+ 
+
+ All code snippets below use this common test function:
+ 
+
+ 
+
+
+
+<pre class="programlisting">template <typename P>
+void test_parser(char const* input, P const& p)
+{
+ std::string s(input);
+ std::string::iterator f(s.begin());
+ if (boost::spirit::qi::parse(f, s.end(), p))
+ std::cout << "ok" << std::endl;
+ else
+ std::cout << "fail" << std::endl;
+}
+</pre>
+
+ 
+
+ 
+
+ Some using declarations:
+ 
+
+ 
+
+
+
+<pre class="programlisting">using boost::spirit::qi::parse;
+using boost::spirit::qi::lit;
+using boost::spirit::ascii::string;
+</pre>
+
+ 
+
+ 
+
+ Basic literals:
+ 
+
+ 
+
+
+
+<pre class="programlisting">test_parser("boost", "boost"); // plain literal
+test_parser("boost", lit("boost")); // explicit literal
+test_parser("boost", string("boost")); // ascii::string
+</pre>
+
+ 
+
+ 
+
+ From a <tt class="computeroutput">std::string</tt>
+ 
+
+ 
+
+
+
+<pre class="programlisting">std::string s("boost");
+test_parser("boost", s); // direct
+test_parser("boost", lit(s)); // explicit
+test_parser("boost", string(s)); // ascii::string
+</pre>
+
+ 
+
+ 
+
+ Lazy strings using Phoenix
+ 
+
+ 
+
+
+
+<pre class="programlisting">namespace phx = boost::phoenix;
+test_parser("boost", phx::val("boost")); // direct
+test_parser("boost", lit(phx::val("boost"))); // explicit
+test_parser("boost", string(phx::val("boost"))); // ascii::string
+</pre>
+
+ 
+
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage">
+<div><div><h5 class="title">
+<a name="spirit.qi.reference.string.symbols"></a>symbols
+</h5></div></div>
+<div></div>
+</div>
+<a name="spirit.qi.reference.string.symbols.description"></a><h6>
+<a name="id465836"></a>
+ Description
+ </h6>
+
+ This class <tt class="computeroutput">symbols</tt> implements
+ a symbol table: an associative container (or map) of key-value pairs
+ where the keys are strings. The <tt class="computeroutput">symbols</tt>
+ class can work efficiently with 8, 16, 32 and even 64 bit characters.
+ 
+
+ Traditionally, symbol table management is maintained seperately outside
+ the grammar through semantic actions. Contrary to standard practice,
+ the Spirit symbol table class symbols is-a parser. An instance of which
+ may be used anywhere in the 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, thus, dynamically altering
+ its behavior.
+ 
+<a name="spirit.qi.reference.string.symbols.header"></a><h6>
+<a name="id466179"></a>
+ Header
+ </h6>
+<pre class="programlisting">// forwards to <boost/spirit/home/qi/string/symbols.hpp>
+#include <boost/spirit/include/qi_symbols.hpp>
+</pre>
+
+ Also, see Include Structure.
+ 
+<a name="spirit.qi.reference.string.symbols.synopsis"></a><h6>
+<a name="id353129"></a>
+ Synopsis
+ </h6>
+<pre class="programlisting">template <typename Char, typename T>
+struct symbols;
+</pre>
+<a name="spirit.qi.reference.string.symbols.template_parameters"></a><h6>
+<a name="id353223"></a>
+ <a href="string.html#spirit.qi.reference.string.symbols.template_parameters">Template
+ parameters</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Parameter
+ </th>
+<th>
+ Description
+ </th>
+<th>
+ Default
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <tt class="computeroutput">Char</tt>
+ </td>
+<td>
+ The character type of the symbol strings.
+ </td>
+<td>
+ <tt class="computeroutput">char</tt>
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">T</tt>
+ </td>
+<td>
+ The data type associated with each symbol.
+ </td>
+<td>
+ <tt class="computeroutput">unused_type</tt>
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="spirit.qi.reference.string.symbols.model_of"></a><h6>
+<a name="id466414"></a>
+ Model of
+ </h6>
+<div class="blockquote"><blockquote class="blockquote">
+
+ 
+
+ PrimitiveParser
+ 
+
+ 
+</blockquote></div>
+<div class="variablelist">
+Notation
+<dl>
+<dt><tt class="computeroutput">Sym</tt></dt>
+<dd>
+ A <tt class="computeroutput">symbols</tt> type.
+ </dd>
+<dt><tt class="computeroutput">Char</tt></dt>
+<dd>
+ A character type.
+ </dd>
+<dt><tt class="computeroutput">T</tt></dt>
+<dd>
+ A data type.
+ </dd>
+<dt><tt class="computeroutput">sym</tt></dt>
+<dd>
+ A <tt class="computeroutput">symbols</tt> object.
+ </dd>
+<dt><tt class="computeroutput">sym2</tt></dt>
+<dd>
+ Another <tt class="computeroutput">symbols</tt> object.
+ </dd>
+<dt><tt class="computeroutput">sseq</tt></dt>
+<dd>
+ An STL container
+ of strings.
+ </dd>
+<dt><tt class="computeroutput">dseq</tt></dt>
+<dd>
+ An STL container
+ of data with <tt class="computeroutput">value_type</tt>
+ <tt class="computeroutput">T</tt>.
+ </dd>
+<dt><tt class="computeroutput">s1</tt>...<tt class="computeroutput">sN</tt></dt>
+<dd>
+ A literal string, e.g. "Hello", or a pointer/reference
+ to a null-terminated array of characters or a <tt class="computeroutput">std::basic_string</tt>.
+ </dd>
+<dt><tt class="computeroutput">d1</tt>...<tt class="computeroutput">dN</tt></dt>
+<dd>
+ Objects of type <tt class="computeroutput">T</tt>.
+ </dd>
+<dt><tt class="computeroutput">f</tt></dt>
+<dd>
+ A callable function or function object.
+ </dd>
+</dl>
+</div>
+<a name="spirit.qi.reference.string.symbols.expression_semantics"></a><h6>
+<a name="id466836"></a>
+ <a href="string.html#spirit.qi.reference.string.symbols.expression_semantics">Expression
+ Semantics</a>
+ </h6>
+
+ Semantics of an expression is defined only where it differs from, or
+ is not defined in PrimitiveParser.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ Expression
+ </th>
+<th>
+ Semantics
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <tt class="computeroutput">Sym()</tt>
+ </td>
+<td>
+ Construct an empty symbols.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">Sym(sym)</tt>
+ </td>
+<td>
+ Copy construct a symbols from <tt class="computeroutput">sym2</tt>.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">Sym(sseq)</tt>
+ </td>
+<td>
+ Construct symbols from <tt class="computeroutput">sseq</tt>.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">Sym(sseq)</tt>
+ </td>
+<td>
+ Construct symbols from <tt class="computeroutput">sseq</tt>
+ and <tt class="computeroutput">dseq</tt>.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">sym =
+ sym</tt>
+ </td>
+<td>
+ Assign <tt class="computeroutput">sym2</tt> to
+ <tt class="computeroutput">sym</tt>.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">sym =
+ s1,
+ s2,...
+ sN</tt>
+ </td>
+<td>
+ Assigns one or more symbols (<tt class="computeroutput">s1</tt>...<tt class="computeroutput">sN</tt>) to <tt class="computeroutput">sym</tt>.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">sym +=
+ s1,
+ s2,...
+ sN</tt>
+ </td>
+<td>
+ Adds one or more symbols (<tt class="computeroutput">s1</tt>...<tt class="computeroutput">sN</tt>) to <tt class="computeroutput">sym</tt>.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">sym.add(s1)(s2)...(sN)</tt>
+ </td>
+<td>
+ Adds one or more symbols (<tt class="computeroutput">s1</tt>...<tt class="computeroutput">sN</tt>) to <tt class="computeroutput">sym</tt>.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">sym.add(s1,
+ d1)(s2,
+ d2)...(sN,
+ dN)</tt>
+ </td>
+<td>
+ Adds one or more symbols (<tt class="computeroutput">s1</tt>...<tt class="computeroutput">sN</tt>) with associated data (<tt class="computeroutput">d1</tt>...<tt class="computeroutput">dN</tt>)
+ to <tt class="computeroutput">sym</tt>.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">sym -=
+ s1,
+ s2,...
+ sN</tt>
+ </td>
+<td>
+ Remove one or more symbols (<tt class="computeroutput">s1</tt>...<tt class="computeroutput">sN</tt>) from <tt class="computeroutput">sym</tt>.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">sym.remove(s1)(s2)...(sN)</tt>
+ </td>
+<td>
+ Remove one or more symbols (<tt class="computeroutput">s1</tt>...<tt class="computeroutput">sN</tt>) from <tt class="computeroutput">sym</tt>.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">sym.clear()</tt>
+ </td>
+<td>
+ Erase all of the symbols in <tt class="computeroutput">sym</tt>.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">sym.at(s)</tt>
+ </td>
+<td>
+ Returns a reference to the object associated with symbol, <tt class="computeroutput">s</tt>. If <tt class="computeroutput">sym</tt>
+ does not already contain such an object, <tt class="computeroutput">at</tt>
+ inserts the default object <tt class="computeroutput">T()</tt>.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">sym.find(s)</tt>
+ </td>
+<td>
+ Returns a pointer to the object associated with symbol, <tt class="computeroutput">s</tt>. If <tt class="computeroutput">sym</tt>
+ does not already contain such an object, <tt class="computeroutput">find</tt>
+ returns a null pointer.
+ </td>
+</tr>
+<tr>
+<td>
+ <tt class="computeroutput">sym.for_each(f)</tt>
+ </td>
+<td>
+ For each symbol in <tt class="computeroutput">sym</tt>,
+ <tt class="computeroutput">s</tt>, a <tt class="computeroutput">std::basic_string<Char></tt>
+ with associated data, <tt class="computeroutput">d</tt>,
+ an object of type <tt class="computeroutput">T</tt>,
+ invoke <tt class="computeroutput">f(s,
+ d)</tt>.
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="spirit.qi.reference.string.symbols.attributes"></a><h6>
+<a name="id468302"></a>
+ Attributes
+ </h6>
+
+ The attribute of <tt class="computeroutput">symbol<Char, T></tt> is <tt class="computeroutput">T</tt>.
+ 
+<a name="spirit.qi.reference.string.symbols.example"></a><h6>
+<a name="id468380"></a>
+ Example
+ </h6>
+
+ Some 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>
+
+ 
+
+ 
+
+ Our test function:
+ 
+
+ 
+
+
+
+<pre class="programlisting">template <typename P, typename T>
+void test_parser_attr(char const* input, P const& p, T& attr)
+{
+ std::string s(input);
+ std::string::iterator f(s.begin());
+ if (boost::spirit::qi::parse(f, s.end(), p, attr))
+ std::cout << "ok" << std::endl;
+ else
+ std::cout << "fail" << std::endl;
+}
+</pre>
+
+ 
+
+ 
+
+ Some using declarations:
+ 
+
+ 
+
+
+
+<pre class="programlisting">using boost::spirit::qi::parse;
+using boost::spirit::qi::symbols;
+using boost::spirit::ascii::no_case;
+</pre>
+
+ 
+
+ 
+
+ Symbols with data:
+ 
+
+ 
+
+
+
+<pre class="programlisting">symbols<char, int> sym;
+
+sym.add
+ ("Apple", 1)
+ ("Banana", 2)
+ ("Orange", 3)
+;
+
+int i;
+test_parser_attr("Banana", sym, i);
+std::cout << i << std::endl;
+</pre>
+
+ 
+
+ 
+
+ When symbols is used for case-insensitive parsing (in a no_case[a]
+ directive), added symbol strings should be in lowercase. Symbol strings
+ containing one or more uppercase characters will not match any input
+ when symbols is used in a <tt class="computeroutput">no_case</tt>
+ directive.
+ 
+
+ 
+
+
+
+<pre class="programlisting">symbols<char, int> sym;
+
+sym.add
+ ("apple", 1) // symbol strings are added in lowercase...
+ ("banana", 2)
+ ("orange", 3)
+;
+
+int i;
+// ...because sym is used for case-insensitive parsing
+test_parser_attr("Apple", no_case[ sym ], i);
+std::cout << i << std::endl;
+test_parser_attr("ORANGE", no_case[ sym ], i);
+std::cout << i << std::endl;
+</pre>
+
+ 
+
+ 
+</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
@@ -56,7 +863,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="directive/no_case.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/lit_string.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
+<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="../../karma.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>

Modified: trunk/libs/spirit/doc/html/spirit/qi/reference/string/lit_string.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/qi/reference/string/lit_string.html (original)
+++ trunk/libs/spirit/doc/html/spirit/qi/reference/string/lit_string.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -42,7 +42,7 @@
 </li>
</ul></div>
<a name="spirit.qi.reference.string.lit_string.description"></a><h6>
-<a name="id462729"></a>
+<a name="id462876"></a>
 <a href="lit_string.html#spirit.qi.reference.string.lit_string.description">Description</a>
 </h6>

@@ -51,7 +51,7 @@
 parser is not applied in between characters of the string.
 
<a name="spirit.qi.reference.string.lit_string.header"></a><h6>
-<a name="id462774"></a>
+<a name="id462920"></a>
 <a href="lit_string.html#spirit.qi.reference.string.lit_string.header">Header</a>
 </h6>
<pre class="programlisting">// forwards to <boost/spirit/home/qi/string/lit.hpp>
@@ -61,7 +61,7 @@
 Also, see Include Structure.
 
<a name="spirit.qi.reference.string.lit_string.model_of"></a><h6>
-<a name="id462887"></a>
+<a name="id463033"></a>
 <a href="lit_string.html#spirit.qi.reference.string.lit_string.model_of">Model
 of</a>
 </h6>
@@ -96,7 +96,7 @@
</dl>
</div>
<a name="spirit.qi.reference.string.lit_string.expression_semantics"></a><h6>
-<a name="id463080"></a>
+<a name="id463226"></a>
 <a href="lit_string.html#spirit.qi.reference.string.lit_string.expression_semantics">Expression
 Semantics</a>
 </h6>
@@ -178,7 +178,7 @@
</tbody>
</table></div>
<a name="spirit.qi.reference.string.lit_string.attributes"></a><h6>
-<a name="id463556"></a>
+<a name="id463702"></a>
 <a href="lit_string.html#spirit.qi.reference.string.lit_string.attributes">Attributes</a>
 </h6>
<div class="informaltable"><table class="table">
@@ -254,7 +254,7 @@
</tbody>
</table></div>
<a name="spirit.qi.reference.string.lit_string.complexity"></a><h6>
-<a name="id464130"></a>
+<a name="id464277"></a>
 <a href="lit_string.html#spirit.qi.reference.string.lit_string.complexity">Complexity</a>
 </h6>
<div class="blockquote"><blockquote class="blockquote">
@@ -271,7 +271,7 @@
 of characters in the string to be parsed.
 
<a name="spirit.qi.reference.string.lit_string.example"></a><h6>
-<a name="id464183"></a>
+<a name="id464330"></a>
 <a href="lit_string.html#spirit.qi.reference.string.lit_string.example">Example</a>
 </h6>

Modified: trunk/libs/spirit/doc/html/spirit/qi/reference/string/symbols.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/qi/reference/string/symbols.html (original)
+++ trunk/libs/spirit/doc/html/spirit/qi/reference/string/symbols.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -30,7 +30,7 @@
<div></div>
</div>
<a name="spirit.qi.reference.string.symbols.description"></a><h6>
-<a name="id465689"></a>
+<a name="id465836"></a>
 <a href="symbols.html#spirit.qi.reference.string.symbols.description">Description</a>
 </h6>

@@ -50,7 +50,7 @@
 its behavior.
 
<a name="spirit.qi.reference.string.symbols.header"></a><h6>
-<a name="id465759"></a>
+<a name="id466179"></a>
 <a href="symbols.html#spirit.qi.reference.string.symbols.header">Header</a>
 </h6>
<pre class="programlisting">// forwards to <boost/spirit/home/qi/string/symbols.hpp>
@@ -60,14 +60,14 @@
 Also, see Include Structure.
 
<a name="spirit.qi.reference.string.symbols.synopsis"></a><h6>
-<a name="id465872"></a>
+<a name="id353129"></a>
 <a href="symbols.html#spirit.qi.reference.string.symbols.synopsis">Synopsis</a>
 </h6>
<pre class="programlisting">template <typename Char, typename T>
struct symbols;
</pre>
<a name="spirit.qi.reference.string.symbols.template_parameters"></a><h6>
-<a name="id465966"></a>
+<a name="id353223"></a>
 <a href="symbols.html#spirit.qi.reference.string.symbols.template_parameters">Template
 parameters</a>
 </h6>
@@ -114,7 +114,7 @@
</tbody>
</table></div>
<a name="spirit.qi.reference.string.symbols.model_of"></a><h6>
-<a name="id466130"></a>
+<a name="id466414"></a>
 <a href="symbols.html#spirit.qi.reference.string.symbols.model_of">Model of</a>
 </h6>
<div class="blockquote"><blockquote class="blockquote">
@@ -176,7 +176,7 @@
</dl>
</div>
<a name="spirit.qi.reference.string.symbols.expression_semantics"></a><h6>
-<a name="id466553"></a>
+<a name="id466836"></a>
 <a href="symbols.html#spirit.qi.reference.string.symbols.expression_semantics">Expression
 Semantics</a>
 </h6>
@@ -346,14 +346,14 @@
</tbody>
</table></div>
<a name="spirit.qi.reference.string.symbols.attributes"></a><h6>
-<a name="id468018"></a>
+<a name="id468302"></a>
 <a href="symbols.html#spirit.qi.reference.string.symbols.attributes">Attributes</a>
 </h6>

 The attribute of <tt class="computeroutput">symbol<Char, T></tt> is <tt class="computeroutput">T</tt>.
 
<a name="spirit.qi.reference.string.symbols.example"></a><h6>
-<a name="id468096"></a>
+<a name="id468380"></a>
 <a href="symbols.html#spirit.qi.reference.string.symbols.example">Example</a>
 </h6>

Modified: trunk/libs/spirit/doc/html/spirit/support/multi_pass.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/support/multi_pass.html (original)
+++ trunk/libs/spirit/doc/html/spirit/support/multi_pass.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -64,7 +64,7 @@
 iterator was created.
 
<a name="spirit.support.multi_pass.using_the_multi_pass"></a><h4>
-<a name="id604749"></a>
+<a name="id604928"></a>
 <a href="multi_pass.html#spirit.support.multi_pass.using_the_multi_pass">Using the
 multi_pass</a>
 </h4>
@@ -212,7 +212,7 @@

 
<a name="spirit.support.multi_pass.using_the_flush_multi_pass_parser"></a><h4>
-<a name="id606536"></a>
+<a name="id606715"></a>
 <a href="multi_pass.html#spirit.support.multi_pass.using_the_flush_multi_pass_parser">Using
 the flush_multi_pass parser</a>
 </h4>
@@ -234,7 +234,7 @@
 thrown.
 
<a name="spirit.support.multi_pass.the_multi_pass_policies"></a><h4>
-<a name="id606691"></a>
+<a name="id606870"></a>
 <a href="multi_pass.html#spirit.support.multi_pass.the_multi_pass_policies">The multi_pass
 Policies</a>
 </h4>
@@ -275,7 +275,7 @@
 the functionality groups:
 
<div class="table">
-<a name="id606855"></a>Table 30. Policies needed for default_policy template
+<a name="id607033"></a>Table 22. Policies needed for default_policy template
<table class="table" summary="Policies needed for default_policy template">
<colgroup>
<col>
@@ -338,7 +338,7 @@
 implementations.
 
<a name="spirit.support.multi_pass.predefined_policies"></a><h4>
-<a name="id607119"></a>
+<a name="id607298"></a>
 <a href="multi_pass.html#spirit.support.multi_pass.predefined_policies">Predefined
 policies</a>
 </h4>
@@ -347,7 +347,7 @@
 policies are defined in the namespace <tt class="computeroutput">boost::spirit::iterator_policies</tt>.
 
<div class="table">
-<a name="id607184"></a>Table 31. Predefined policy classes
+<a name="id607362"></a>Table 23. Predefined policy classes
<table class="table" summary="Predefined policy classes">
<colgroup>
<col>
@@ -528,7 +528,7 @@
</table>
</div>
<a name="spirit.support.multi_pass.combinations__how_to_specify_your_own_custom_multi_pass"></a><h4>
-<a name="id608131"></a>
+<a name="id608310"></a>
 <a href="multi_pass.html#spirit.support.multi_pass.combinations__how_to_specify_your_own_custom_multi_pass">Combinations:
 How to specify your own custom multi_pass</a>
 </h4>
@@ -574,7 +574,7 @@
 behaviors while wrapping an <tt class="computeroutput">std::istream_iterator<char></tt>.
 
<a name="spirit.support.multi_pass.dealing_with_constant_look_ahead"></a><h4>
-<a name="id608749"></a>
+<a name="id608928"></a>
 <a href="multi_pass.html#spirit.support.multi_pass.dealing_with_constant_look_ahead">Dealing
 with constant look ahead</a>
 </h4>
@@ -593,7 +593,7 @@
 StoragePolicy.
 
<a name="spirit.support.multi_pass.how_to_write_a_functor_for_use_with_the__code__phrase_role__identifier__functor_input__phrase___code__inputpolicy"></a><h4>
-<a name="id608963"></a>
+<a name="id609143"></a>
 <a href="multi_pass.html#spirit.support.multi_pass.how_to_write_a_functor_for_use_with_the__code__phrase_role__identifier__functor_input__phrase___code__inputpolicy">How
 to write a functor for use with the <tt class="computeroutput">functor_input</tt>
 InputPolicy</a>
@@ -652,7 +652,7 @@
}
</pre>
<a name="spirit.support.multi_pass.how_to_write_policies_for_use_with_multi_pass"></a><h4>
-<a name="id609782"></a>
+<a name="id609961"></a>
 <a href="multi_pass.html#spirit.support.multi_pass.how_to_write_policies_for_use_with_multi_pass">How
 to write policies for use with multi_pass</a>
 </h4>
@@ -669,7 +669,7 @@
 copies of a particular <tt class="computeroutput">multi_pass</tt>.
 
<a name="spirit.support.multi_pass.inputpolicy"></a><h4>
-<a name="id609908"></a>
+<a name="id610087"></a>
 <a href="multi_pass.html#spirit.support.multi_pass.inputpolicy">InputPolicy</a>
 </h4>

@@ -765,7 +765,7 @@
 constructor of <tt class="computeroutput">shared</tt>.
 
<a name="spirit.support.multi_pass.ownershippolicy"></a><h4>
-<a name="id611116"></a>
+<a name="id611295"></a>
 <a href="multi_pass.html#spirit.support.multi_pass.ownershippolicy">OwnershipPolicy</a>
 </h4>

@@ -832,7 +832,7 @@
 constructor of <tt class="computeroutput">shared</tt>.
 
<a name="spirit.support.multi_pass.checkingpolicy"></a><h4>
-<a name="id611860"></a>
+<a name="id612039"></a>
 <a href="multi_pass.html#spirit.support.multi_pass.checkingpolicy">CheckingPolicy</a>
 </h4>

@@ -891,7 +891,7 @@
 constructor of <tt class="computeroutput">shared</tt>.
 
<a name="spirit.support.multi_pass.storagepolicy"></a><h4>
-<a name="id612495"></a>
+<a name="id612674"></a>
 <a href="multi_pass.html#spirit.support.multi_pass.storagepolicy">StoragePolicy</a>
 </h4>

Modified: trunk/libs/spirit/doc/html/spirit/what_s_new.html
==============================================================================
--- trunk/libs/spirit/doc/html/spirit/what_s_new.html (original)
+++ trunk/libs/spirit/doc/html/spirit/what_s_new.html 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -155,12 +155,12 @@
 </li>
<li>
 Added <tt class="computeroutput">karma::omit[]</tt>
- directive (see <a href="karma/reference/directive/omit.html" title=" Consume Attribute
+ directive (see <a href="karma/reference/directive.html#spirit.karma.reference.directive.omit" title=" Consume Attribute
 (omit[])"><tt class="computeroutput">omit[a]</tt></a>)
 </li>
<li>
 Added <tt class="computeroutput">karma::buffer[]</tt>
- directive (see <a href="karma/reference/directive/buffer.html" title=" Temporary
+ directive (see <a href="karma/reference/directive.html#spirit.karma.reference.directive.buffer" title=" Temporary
 Output Buffering (buffer[])"><tt class="computeroutput">buffer[a]</tt></a>)
 </li>
<li>
@@ -177,7 +177,7 @@
 first test if the attribute value is equal to the immediate literal. They
 fail not while generating anything if those are not equal. Otherwise they
 generate their immediate literal. For more information see for instance
- <a href="karma/reference/numeric/signed_int.html" title=" Signed
+ <a href="karma/reference/numeric.html#spirit.karma.reference.numeric.signed_int" title=" Signed
 Integer Number Generators"><tt class="computeroutput">int_</tt></a>.
 </li>
<li>

Modified: trunk/libs/spirit/doc/qi/quick_reference.qbk
==============================================================================
--- trunk/libs/spirit/doc/qi/quick_reference.qbk (original)
+++ trunk/libs/spirit/doc/qi/quick_reference.qbk 2009-08-22 01:26:45 EDT (Sat, 22 Aug 2009)
@@ -46,7 +46,9 @@
[endsect]
[section Qi Parsers]

-[table char
+[section char]
+
+[table
     [[Expression] [Attribute] [Description]]
     [[`char_`] [`Ch`] [Matches any character]]
     [[`char_(ch)`] [`Ch`] [Matches `ch`]]
@@ -80,7 +82,10 @@
                                                          `std::isupper` in the current character set]]
]

-[table numeric
+[endsect]
+[section numeric]
+
+[table
     [[Expression] [Attribute] [Description]]
     [[`float_`] [`float`] [Parse a floating point number into a `float`]]
     [[`double_`] [`double`] [Parse a floating point number into a `double`]]
@@ -99,7 +104,10 @@
     [[`long_long`] [`long long`] [Parse a long long]]
]

-[table string
+[endsect]
+[section string]
+
+[table
     [[Expression] [Attribute] [Description]]
     [[[qi_lit_string `ch`]] [`Unused`] [Matches `ch`]]
     [[[qi_lit_string `str`]] [`Unused`] [Matches `str`]]
@@ -127,7 +135,10 @@
                                                         the key]]
]

-[table auxiliary
+[endsect]
+[section auxiliary]
+
+[table
     [[Expression] [Attribute] [Description]]
     [[`eol`] [`Unused`] [Matches the end of line (`\r` or `\n` or `\r\n`)]]
     [[`eoi`] [`Unused`] [Matches the end of input (first == last)]]
@@ -141,7 +152,10 @@
                                                          argument `attrib` as its attribute.]]
]

-[table binary
+[endsect]
+[section binary]
+
+[table
     [[Expression] [Attribute] [Description]]
     [[`byte_`] [8 bits native endian] [Matches an 8 bit binary]]
     [[`word`] [16 bits native endian] [Matches a 16 bit binary]]
@@ -155,7 +169,10 @@
     [[`little_qword`] [64 bits little endian] [Matches a 64 bit binary]]
]

-[table directive
+[endsect]
+[section directive]
+
+[table
     [[Expression] [Attribute] [Description]]
     [[`lexeme[a]`] [`A`] [Disable skip parsing for `a`]]
     [[__qi_no_case__] [`A`] [Inhibits case-sensitivity for `a`]]
@@ -171,7 +188,10 @@
     [[`skip(p)[a]`] [`A`] [Use `p` as a skipper for parsing `a`]]
]

-[table operator
+[endsect]
+[section operator]
+
+[table
     [[Expression] [Attribute] [Description]]
     [[`!a`] [`Unused`] [Not predicate. Ensure that `a` does not match
                                                         but don't move the iterator position]]
@@ -194,12 +214,16 @@
                             ] [Permutation. Parse `a` and `b` in any order]]
]

-[table action
+[endsect]
+[section action]
+
+[table
     [[Expression] [Attribute] [Description]]
     [[`p[fa]`] [Attribute of `p`] [Call semantic action, `fa` if p succeeds.]]
]

[endsect]
+[endsect]
[section Compound Attribute Rules]

The notation will be for instance:

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