| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> |
| <title>UnaryGenerator</title> |
| <link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> |
| <meta name="generator" content="DocBook XSL Stylesheets V1.75.0"> |
| <link rel="home" href="../../../../index.html" title="Spirit 2.4.1"> |
| <link rel="up" href="../generator_concepts.html" title="Generator Concepts"> |
| <link rel="prev" href="primitivegenerator.html" title="PrimitiveGenerator"> |
| <link rel="next" href="binarygenerator.html" title="BinaryGenerator"> |
| </head> |
| <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
| <table cellpadding="2" width="100%"><tr> |
| <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> |
| <td align="center"><a href="../../../../../../../../index.html">Home</a></td> |
| <td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> |
| <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> |
| <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> |
| <td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> |
| </tr></table> |
| <hr> |
| <div class="spirit-nav"> |
| <a accesskey="p" href="primitivegenerator.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../generator_concepts.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="binarygenerator.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> |
| </div> |
| <div class="section"> |
| <div class="titlepage"><div><div><h5 class="title"> |
| <a name="spirit.karma.reference.generator_concepts.unarygenerator"></a><a class="link" href="unarygenerator.html" title="UnaryGenerator">UnaryGenerator</a> |
| </h5></div></div></div> |
| <a name="spirit.karma.reference.generator_concepts.unarygenerator.description"></a><h6> |
| <a name="id987546"></a> |
| <a class="link" href="unarygenerator.html#spirit.karma.reference.generator_concepts.unarygenerator.description">Description</a> |
| </h6> |
| <p> |
| <span class="emphasis"><em>UnaryGenerator</em></span> is a composite generator that has |
| a single subject. The UnaryGenerator may change the behavior of its subject |
| following the Delegate Design Pattern. |
| </p> |
| <a name="spirit.karma.reference.generator_concepts.unarygenerator.refinement_of"></a><h6> |
| <a name="id987566"></a> |
| <a class="link" href="unarygenerator.html#spirit.karma.reference.generator_concepts.unarygenerator.refinement_of">Refinement |
| of</a> |
| </h6> |
| <div class="blockquote"><blockquote class="blockquote"><p> |
| <a class="link" href="generator.html" title="Generator"><code class="computeroutput"><span class="identifier">Generator</span></code></a> |
| </p></blockquote></div> |
| <div class="variablelist"> |
| <p class="title"><b>Notation</b></p> |
| <dl> |
| <dt><span class="term"><code class="computeroutput"><span class="identifier">g</span></code></span></dt> |
| <dd><p> |
| A UnaryGenerator. |
| </p></dd> |
| <dt><span class="term"><code class="computeroutput"><span class="identifier">G</span></code></span></dt> |
| <dd><p> |
| A UnaryGenerator type. |
| </p></dd> |
| </dl> |
| </div> |
| <a name="spirit.karma.reference.generator_concepts.unarygenerator.valid_expressions"></a><h6> |
| <a name="id987643"></a> |
| <a class="link" href="unarygenerator.html#spirit.karma.reference.generator_concepts.unarygenerator.valid_expressions">Valid |
| Expressions</a> |
| </h6> |
| <p> |
| In addition to the requirements defined in <a class="link" href="generator.html" title="Generator"><code class="computeroutput"><span class="identifier">Generator</span></code></a>, for any UnaryGenerator |
| the following must be met: |
| </p> |
| <div class="informaltable"><table class="table"> |
| <colgroup> |
| <col> |
| <col> |
| <col> |
| </colgroup> |
| <thead><tr> |
| <th> |
| <p> |
| Expression |
| </p> |
| </th> |
| <th> |
| <p> |
| Semantics |
| </p> |
| </th> |
| <th> |
| <p> |
| Return type |
| </p> |
| </th> |
| </tr></thead> |
| <tbody><tr> |
| <td> |
| <p> |
| <code class="computeroutput"><span class="identifier">g</span><span class="special">.</span><span class="identifier">subject</span></code> |
| </p> |
| </td> |
| <td> |
| <p> |
| Subject generator. |
| </p> |
| </td> |
| <td> |
| <p> |
| <a class="link" href="generator.html" title="Generator"><code class="computeroutput"><span class="identifier">Generator</span></code></a> |
| </p> |
| </td> |
| </tr></tbody> |
| </table></div> |
| <a name="spirit.karma.reference.generator_concepts.unarygenerator.type_expressions"></a><h6> |
| <a name="id987763"></a> |
| <a class="link" href="unarygenerator.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> |
| <p> |
| Expression |
| </p> |
| </th> |
| <th> |
| <p> |
| Description |
| </p> |
| </th> |
| </tr></thead> |
| <tbody> |
| <tr> |
| <td> |
| <p> |
| <code class="computeroutput"><span class="identifier">G</span><span class="special">::</span><span class="identifier">subject_type</span></code> |
| </p> |
| </td> |
| <td> |
| <p> |
| The subject generator type. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <code class="computeroutput"><span class="identifier">traits</span><span class="special">::</span><span class="identifier">is_unary_generator</span><span class="special"><</span><span class="identifier">G</span><span class="special">>::</span><span class="identifier">type</span></code> |
| </p> |
| </td> |
| <td> |
| <p> |
| Metafunction that evaluates to <code class="computeroutput"><span class="identifier">mpl</span><span class="special">::</span><span class="identifier">true_</span></code> |
| if a certain type, <code class="computeroutput"><span class="identifier">G</span></code> |
| is a UnaryGenerator, <code class="computeroutput"><span class="identifier">mpl</span><span class="special">::</span><span class="identifier">false_</span></code> |
| otherwise (See <a href="../../../../../../../../libs/mpl/doc/refmanual/integral-constant.html" target="_top">MPL |
| Boolean Constant</a>). |
| </p> |
| </td> |
| </tr> |
| </tbody> |
| </table></div> |
| <a name="spirit.karma.reference.generator_concepts.unarygenerator.invariants"></a><h6> |
| <a name="id987932"></a> |
| <a class="link" href="unarygenerator.html#spirit.karma.reference.generator_concepts.unarygenerator.invariants">Invariants</a> |
| </h6> |
| <p> |
| For any UnaryGenerator, <code class="computeroutput"><span class="identifier">G</span></code>, |
| the following invariant always holds: |
| </p> |
| <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"> |
| <code class="computeroutput"><span class="identifier">traits</span><span class="special">::</span><span class="identifier">is_generator</span><span class="special"><</span><span class="identifier">G</span><span class="special">::</span><span class="identifier">subject_type</span><span class="special">>::</span><span class="identifier">type</span></code> evaluates to <code class="computeroutput"><span class="identifier">mpl</span><span class="special">::</span><span class="identifier">true_</span></code> |
| </li></ul></div> |
| <a name="spirit.karma.reference.generator_concepts.unarygenerator.models"></a><h6> |
| <a name="id988021"></a> |
| <a class="link" href="unarygenerator.html#spirit.karma.reference.generator_concepts.unarygenerator.models">Models</a> |
| </h6> |
| <p> |
| The following generators conform to this model: |
| </p> |
| <div class="itemizedlist"><ul class="itemizedlist" type="disc"> |
| <li class="listitem"> |
| <a class="link" href="../operator/kleene.html" title="Kleene Star (*a)">Kleene Star |
| (unary <code class="computeroutput"><span class="special">*</span></code>)</a> operator, |
| </li> |
| <li class="listitem"> |
| <a class="link" href="../operator/plus.html" title="Plus (+a)">Plus (unary |
| <code class="computeroutput"><span class="special">+</span></code>)</a> operator, |
| </li> |
| <li class="listitem"> |
| <a class="link" href="../operator/optional.html" title="Optional (-a)">Optional |
| (unary <code class="computeroutput"><span class="special">-</span></code>)</a> operator, |
| </li> |
| <li class="listitem"> |
| <a class="link" href="../operator/and_predicate.html" title="And-Predicate (&a)">And |
| predicate (unary <code class="computeroutput"><span class="special">&</span></code>)</a> |
| and <a class="link" href="../operator/not_predicate.html" title="Not-Predicate (!a)">Not |
| predicate (unary <code class="computeroutput"><span class="special">!</span></code>)</a> |
| operators, |
| </li> |
| <li class="listitem"> |
| <a class="link" href="../directive/alignment.html" title="Alignment Directives (left_align[], center[], right_align[])"><code class="computeroutput"><span class="identifier">left_align</span></code></a>, <a class="link" href="../directive/alignment.html" title="Alignment Directives (left_align[], center[], right_align[])"><code class="computeroutput"><span class="identifier">center</span></code></a>, and <a class="link" href="../directive/alignment.html" title="Alignment Directives (left_align[], center[], right_align[])"><code class="computeroutput"><span class="identifier">right_align</span></code></a> directives, |
| </li> |
| <li class="listitem"> |
| <a class="link" href="../directive/repeat.html" title="Repetition Directive (repeat[])"><code class="computeroutput"><span class="identifier">repeat</span></code></a> directive, |
| </li> |
| <li class="listitem"> |
| <a class="link" href="../directive/delimit.html" title="Directives Controlling Automatic Delimiting (verbatim[], no_delimit[], delimit[])"><code class="computeroutput"><span class="identifier">verbatim</span></code></a> directive, |
| </li> |
| <li class="listitem"> |
| <a class="link" href="../directive/delimit.html" title="Directives Controlling Automatic Delimiting (verbatim[], no_delimit[], delimit[])"><code class="computeroutput"><span class="identifier">delimit</span></code></a> directive, |
| </li> |
| <li class="listitem"> |
| <a class="link" href="../directive/upperlower.html" title="Directives Controlling Case Sensitivity (upper[], lower[])"><code class="computeroutput"><span class="identifier">lower</span></code></a> and <a class="link" href="../directive/upperlower.html" title="Directives Controlling Case Sensitivity (upper[], lower[])"><code class="computeroutput"><span class="identifier">upper</span></code></a> directives, |
| </li> |
| <li class="listitem"> |
| <a class="link" href="../directive/maxwidth.html" title="Controlling the Maximum Field Width (maxwidth[])"><code class="computeroutput"><span class="identifier">maxwidth</span></code></a> directive, |
| </li> |
| <li class="listitem"> |
| <a class="link" href="../directive/buffer.html" title="Temporary Output Buffering (buffer[])"><code class="computeroutput"><span class="identifier">buffer</span></code></a> directive, |
| </li> |
| <li class="listitem"> |
| <a class="link" href="../directive/omit.html" title="Consume Attribute (omit[] and skip[])"><code class="computeroutput"><span class="identifier">omit</span></code></a> directive. |
| </li> |
| </ul></div> |
| <p> |
| <span class="bold"><strong>FIXME</strong></span> Add more links to models of UnaryGenerator |
| concept |
| </p> |
| </div> |
| <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> |
| <td align="left"></td> |
| <td align="right"><div class="copyright-footer">Copyright © 2001-2010 Joel de Guzman, Hartmut Kaiser<p> |
| Distributed under the Boost Software License, Version 1.0. (See accompanying |
| file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) |
| </p> |
| </div></td> |
| </tr></table> |
| <hr> |
| <div class="spirit-nav"> |
| <a accesskey="p" href="primitivegenerator.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../generator_concepts.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="binarygenerator.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> |
| </div> |
| </body> |
| </html> |
