1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>Common Notation</title> 5<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css"> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="../../../index.html" title="Spirit 2.5.8"> 8<link rel="up" href="../quick_reference.html" title="Quick Reference"> 9<link rel="prev" href="../quick_reference.html" title="Quick Reference"> 10<link rel="next" href="primitive_generators.html" title="Karma Generators"> 11</head> 12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 13<table cellpadding="2" width="100%"><tr> 14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td> 15<td align="center"><a href="../../../../../../../index.html">Home</a></td> 16<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td> 17<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 18<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 19<td align="center"><a href="../../../../../../../more/index.htm">More</a></td> 20</tr></table> 21<hr> 22<div class="spirit-nav"> 23<a accesskey="p" href="../quick_reference.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../quick_reference.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="primitive_generators.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h4 class="title"> 27<a name="spirit.karma.quick_reference.common_notation"></a><a class="link" href="common_notation.html" title="Common Notation">Common 28 Notation</a> 29</h4></div></div></div> 30<div class="variablelist"> 31<p class="title"><b>Notation</b></p> 32<dl class="variablelist"> 33<dt><span class="term"><code class="computeroutput"><span class="identifier">G</span></code></span></dt> 34<dd><p> 35 Generator type 36 </p></dd> 37<dt><span class="term"><code class="computeroutput"><span class="identifier">g</span><span class="special">,</span> 38 <span class="identifier">a</span><span class="special">,</span> 39 <span class="identifier">b</span><span class="special">,</span> 40 <span class="identifier">c</span><span class="special">,</span> 41 <span class="identifier">d</span></code></span></dt> 42<dd><p> 43 Generator objects 44 </p></dd> 45<dt><span class="term"><code class="computeroutput"><span class="identifier">A</span><span class="special">,</span> 46 <span class="identifier">B</span><span class="special">,</span> 47 <span class="identifier">C</span><span class="special">,</span> 48 <span class="identifier">D</span></code></span></dt> 49<dd><p> 50 Attribute types of generators <code class="computeroutput"><span class="identifier">a</span></code>, 51 <code class="computeroutput"><span class="identifier">b</span></code>, <code class="computeroutput"><span class="identifier">c</span></code>, and <code class="computeroutput"><span class="identifier">d</span></code> 52 </p></dd> 53<dt><span class="term"><code class="computeroutput"><span class="identifier">I</span></code></span></dt> 54<dd><p> 55 The iterator type used for generation 56 </p></dd> 57<dt><span class="term"><code class="computeroutput"><span class="identifier">Unused</span></code></span></dt> 58<dd><p> 59 An <code class="computeroutput"><span class="identifier">unused_type</span></code> 60 </p></dd> 61<dt><span class="term"><code class="computeroutput"><span class="identifier">Context</span></code></span></dt> 62<dd><p> 63 The enclosing rule's <code class="computeroutput"><span class="identifier">Context</span></code> 64 type 65 </p></dd> 66<dt><span class="term"><code class="computeroutput"><span class="identifier">attrib</span></code></span></dt> 67<dd><p> 68 An attribute value 69 </p></dd> 70<dt><span class="term"><code class="computeroutput"><span class="identifier">Attrib</span></code></span></dt> 71<dd><p> 72 An attribute type 73 </p></dd> 74<dt><span class="term"><code class="computeroutput"><span class="identifier">b</span></code></span></dt> 75<dd><p> 76 A boolean expression 77 </p></dd> 78<dt><span class="term"><code class="computeroutput"><span class="identifier">B</span></code></span></dt> 79<dd><p> 80 A type to be interpreted in boolean expressions 81 </p></dd> 82<dt><span class="term"><code class="computeroutput"><span class="identifier">fg</span></code></span></dt> 83<dd><p> 84 A (lazy generator) function with signature <code class="computeroutput"><span class="identifier">G</span><span class="special">(</span><span class="identifier">Unused</span><span class="special">,</span> <span class="identifier">Context</span><span class="special">)</span></code> 85 </p></dd> 86<dt><span class="term"><code class="computeroutput"><span class="identifier">fa</span></code></span></dt> 87<dd><p> 88 A (semantic action) function with signature <code class="computeroutput"><span class="keyword">void</span><span class="special">(</span><span class="identifier">Attrib</span><span class="special">&,</span> <span class="identifier">Context</span><span class="special">,</span> <span class="keyword">bool</span><span class="special">&)</span></code>. The third parameter is a boolean 89 flag that can be set to false to force the generator to fail. Both 90 <code class="computeroutput"><span class="identifier">Context</span></code> and the boolean 91 flag are optional. 92 </p></dd> 93<dt><span class="term"><code class="computeroutput"><span class="identifier">outiter</span></code></span></dt> 94<dd><p> 95 An output iterator to receive the generated output 96 </p></dd> 97<dt><span class="term"><code class="computeroutput"><span class="identifier">Ch</span></code></span></dt> 98<dd><p> 99 Character-class specific character type (See Character Class Types) 100 </p></dd> 101<dt><span class="term"><code class="computeroutput"><span class="identifier">ch</span><span class="special">,</span> 102 <span class="identifier">ch2</span></code></span></dt> 103<dd><p> 104 Character-class specific character (See Character Class Types) 105 </p></dd> 106<dt><span class="term"><code class="computeroutput"><span class="identifier">charset</span></code></span></dt> 107<dd><p> 108 Character-set specifier string (example: <code class="computeroutput"><span class="string">"a-z0-9"</span></code>) 109 </p></dd> 110<dt><span class="term"><code class="computeroutput"><span class="identifier">str</span></code></span></dt> 111<dd><p> 112 Character-class specific string (See Character Class Types) 113 </p></dd> 114<dt><span class="term"><code class="computeroutput"><span class="identifier">Str</span></code></span></dt> 115<dd><p> 116 Attribute of <code class="computeroutput"><span class="identifier">str</span></code>: 117 <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span><span class="identifier">T</span><span class="special">></span></code> 118 where <code class="computeroutput"><span class="identifier">T</span></code> is the underlying 119 character type of <code class="computeroutput"><span class="identifier">str</span></code> 120 </p></dd> 121<dt><span class="term"><code class="computeroutput"><span class="identifier">num</span></code></span></dt> 122<dd><p> 123 Numeric literal, any integer or real number type 124 </p></dd> 125<dt><span class="term"><code class="computeroutput"><span class="identifier">Num</span></code></span></dt> 126<dd><p> 127 Attribute of <code class="computeroutput"><span class="identifier">num</span></code>: 128 any integer or real number type 129 </p></dd> 130<dt><span class="term"><code class="computeroutput"><span class="identifier">tuple</span><span class="special"><></span></code></span></dt> 131<dd><p> 132 Used as a placeholder for a fusion sequence 133 </p></dd> 134<dt><span class="term"><code class="computeroutput"><span class="identifier">vector</span><span class="special"><></span></code></span></dt> 135<dd><p> 136 Used as a placeholder for an STL container 137 </p></dd> 138<dt><span class="term"><code class="computeroutput"><span class="identifier">variant</span><span class="special"><></span></code></span></dt> 139<dd><p> 140 Used as a placeholder for a boost::variant 141 </p></dd> 142<dt><span class="term"><code class="computeroutput"><span class="identifier">optional</span><span class="special"><></span></code></span></dt> 143<dd><p> 144 Used as a placeholder for a boost::optional 145 </p></dd> 146</dl> 147</div> 148</div> 149<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 150<td align="left"></td> 151<td align="right"><div class="copyright-footer">Copyright © 2001-2011 Joel de Guzman, Hartmut Kaiser<p> 152 Distributed under the Boost Software License, Version 1.0. (See accompanying 153 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>) 154 </p> 155</div></td> 156</tr></table> 157<hr> 158<div class="spirit-nav"> 159<a accesskey="p" href="../quick_reference.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../quick_reference.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="primitive_generators.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> 160</div> 161</body> 162</html> 163
