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="qi_parsers.html" title="Qi Parsers"> 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="qi_parsers.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.qi.quick_reference.common_notation"></a><a class="link" href="common_notation.html" title="Common Notation">Common Notation</a> 28</h4></div></div></div> 29<div class="variablelist"> 30<p class="title"><b>Notation</b></p> 31<dl class="variablelist"> 32<dt><span class="term"><code class="computeroutput"><span class="identifier">P</span></code></span></dt> 33<dd><p> 34 Parser type 35 </p></dd> 36<dt><span class="term"><code class="computeroutput"><span class="identifier">p</span><span class="special">,</span> 37 <span class="identifier">a</span><span class="special">,</span> 38 <span class="identifier">b</span><span class="special">,</span> 39 <span class="identifier">c</span></code></span></dt> 40<dd><p> 41 Parser objects 42 </p></dd> 43<dt><span class="term"><code class="computeroutput"><span class="identifier">A</span><span class="special">,</span> 44 <span class="identifier">B</span><span class="special">,</span> 45 <span class="identifier">C</span></code></span></dt> 46<dd><p> 47 Attribute types of parsers <code class="computeroutput"><span class="identifier">a</span></code>, 48 <code class="computeroutput"><span class="identifier">b</span></code> and <code class="computeroutput"><span class="identifier">c</span></code> 49 </p></dd> 50<dt><span class="term"><code class="computeroutput"><span class="identifier">I</span></code></span></dt> 51<dd><p> 52 The iterator type used for parsing 53 </p></dd> 54<dt><span class="term"><code class="computeroutput"><span class="identifier">Unused</span></code></span></dt> 55<dd><p> 56 An <code class="computeroutput"><span class="identifier">unused_type</span></code> 57 </p></dd> 58<dt><span class="term"><code class="computeroutput"><span class="identifier">Context</span></code></span></dt> 59<dd><p> 60 The enclosing rule's <code class="computeroutput"><span class="identifier">Context</span></code> 61 type 62 </p></dd> 63<dt><span class="term"><code class="computeroutput"><span class="identifier">attrib</span></code></span></dt> 64<dd><p> 65 An attribute value 66 </p></dd> 67<dt><span class="term"><code class="computeroutput"><span class="identifier">Attrib</span></code></span></dt> 68<dd><p> 69 An attribute type 70 </p></dd> 71<dt><span class="term"><code class="computeroutput"><span class="identifier">b</span></code></span></dt> 72<dd><p> 73 A boolean expression 74 </p></dd> 75<dt><span class="term"><code class="computeroutput"><span class="identifier">fp</span></code></span></dt> 76<dd><p> 77 A (lazy parser) function with signature <code class="computeroutput"><span class="identifier">P</span><span class="special">(</span><span class="identifier">Unused</span><span class="special">,</span> <span class="identifier">Context</span><span class="special">)</span></code> 78 </p></dd> 79<dt><span class="term"><code class="computeroutput"><span class="identifier">fa</span></code></span></dt> 80<dd><p> 81 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 82 flag that can be set to false to force the parse to fail. Both <code class="computeroutput"><span class="identifier">Context</span></code> and the boolean flag are 83 optional. 84 </p></dd> 85<dt><span class="term"><code class="computeroutput"><span class="identifier">first</span></code></span></dt> 86<dd><p> 87 An iterator pointing to the start of input 88 </p></dd> 89<dt><span class="term"><code class="computeroutput"><span class="identifier">last</span></code></span></dt> 90<dd><p> 91 An iterator pointing to the end of input 92 </p></dd> 93<dt><span class="term"><code class="computeroutput"><span class="identifier">Ch</span></code></span></dt> 94<dd><p> 95 Character-class specific character type (See Character Class Types) 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 (See Character Class Types) 100 </p></dd> 101<dt><span class="term"><code class="computeroutput"><span class="identifier">ch2</span></code></span></dt> 102<dd><p> 103 Character-class specific character (See Character Class Types) 104 </p></dd> 105<dt><span class="term"><code class="computeroutput"><span class="identifier">charset</span></code></span></dt> 106<dd><p> 107 Character-set specifier string (example: "a-z0-9") 108 </p></dd> 109<dt><span class="term"><code class="computeroutput"><span class="identifier">str</span></code></span></dt> 110<dd><p> 111 Character-class specific string (See Character Class Types) 112 </p></dd> 113<dt><span class="term"><code class="computeroutput"><span class="identifier">Str</span></code></span></dt> 114<dd><p> 115 Attribute of <code class="computeroutput"><span class="identifier">str</span></code>: 116 <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> 117 where <code class="computeroutput"><span class="identifier">T</span></code> is the underlying 118 character type of <code class="computeroutput"><span class="identifier">str</span></code> 119 </p></dd> 120<dt><span class="term"><code class="computeroutput"><span class="identifier">tuple</span><span class="special"><></span></code></span></dt> 121<dd><p> 122 Used as a placeholder for a fusion sequence 123 </p></dd> 124<dt><span class="term"><code class="computeroutput"><span class="identifier">vector</span><span class="special"><></span></code></span></dt> 125<dd><p> 126 Used as a placeholder for an STL container 127 </p></dd> 128<dt><span class="term"><code class="computeroutput"><span class="identifier">variant</span><span class="special"><></span></code></span></dt> 129<dd><p> 130 Used as a placeholder for a boost::variant 131 </p></dd> 132<dt><span class="term"><code class="computeroutput"><span class="identifier">optional</span><span class="special"><></span></code></span></dt> 133<dd><p> 134 Used as a placeholder for a boost::optional 135 </p></dd> 136</dl> 137</div> 138</div> 139<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 140<td align="left"></td> 141<td align="right"><div class="copyright-footer">Copyright © 2001-2011 Joel de Guzman, Hartmut Kaiser<p> 142 Distributed under the Boost Software License, Version 1.0. (See accompanying 143 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>) 144 </p> 145</div></td> 146</tr></table> 147<hr> 148<div class="spirit-nav"> 149<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="qi_parsers.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> 150</div> 151</body> 152</html> 153
