1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>BinaryParser</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="../parser_concepts.html" title="Parser Concepts"> 9<link rel="prev" href="unaryparser.html" title="UnaryParser"> 10<link rel="next" href="naryparser.html" title="NaryParser"> 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="unaryparser.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../parser_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="naryparser.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h5 class="title"> 27<a name="spirit.qi.reference.parser_concepts.binaryparser"></a><a class="link" href="binaryparser.html" title="BinaryParser">BinaryParser</a> 28</h5></div></div></div> 29<h6> 30<a name="spirit.qi.reference.parser_concepts.binaryparser.h0"></a> 31 <span class="phrase"><a name="spirit.qi.reference.parser_concepts.binaryparser.description"></a></span><a class="link" href="binaryparser.html#spirit.qi.reference.parser_concepts.binaryparser.description">Description</a> 32 </h6> 33<p> 34 <span class="emphasis"><em>BinaryParser</em></span> is a composite parser that has a two 35 subjects, <code class="computeroutput"><span class="identifier">left</span></code> and <code class="computeroutput"><span class="identifier">right</span></code>. The BinaryParser allows its 36 subjects to be treated in the same way as a single instance of a <a class="link" href="parser.html" title="Parser"><code class="computeroutput"><span class="identifier">Parser</span></code></a> 37 following the Composite Design Pattern. 38 </p> 39<h6> 40<a name="spirit.qi.reference.parser_concepts.binaryparser.h1"></a> 41 <span class="phrase"><a name="spirit.qi.reference.parser_concepts.binaryparser.refinement_of"></a></span><a class="link" href="binaryparser.html#spirit.qi.reference.parser_concepts.binaryparser.refinement_of">Refinement 42 of</a> 43 </h6> 44<div class="blockquote"><blockquote class="blockquote"><p> 45 <a class="link" href="parser.html" title="Parser"><code class="computeroutput"><span class="identifier">Parser</span></code></a> 46 </p></blockquote></div> 47<div class="variablelist"> 48<p class="title"><b>Notation</b></p> 49<dl class="variablelist"> 50<dt><span class="term"><code class="computeroutput"><span class="identifier">p</span></code></span></dt> 51<dd><p> 52 A BinaryParser. 53 </p></dd> 54<dt><span class="term"><code class="computeroutput"><span class="identifier">P</span></code></span></dt> 55<dd><p> 56 A BinaryParser type. 57 </p></dd> 58</dl> 59</div> 60<h6> 61<a name="spirit.qi.reference.parser_concepts.binaryparser.h2"></a> 62 <span class="phrase"><a name="spirit.qi.reference.parser_concepts.binaryparser.valid_expressions"></a></span><a class="link" href="binaryparser.html#spirit.qi.reference.parser_concepts.binaryparser.valid_expressions">Valid 63 Expressions</a> 64 </h6> 65<p> 66 In addition to the requirements defined in <a class="link" href="parser.html" title="Parser"><code class="computeroutput"><span class="identifier">Parser</span></code></a>, for any BinaryParser 67 the following must be met: 68 </p> 69<div class="informaltable"><table class="table"> 70<colgroup> 71<col> 72<col> 73<col> 74</colgroup> 75<thead><tr> 76<th> 77 <p> 78 Expression 79 </p> 80 </th> 81<th> 82 <p> 83 Semantics 84 </p> 85 </th> 86<th> 87 <p> 88 Return type 89 </p> 90 </th> 91</tr></thead> 92<tbody> 93<tr> 94<td> 95 <p> 96 <code class="computeroutput"><span class="identifier">p</span><span class="special">.</span><span class="identifier">left</span></code> 97 </p> 98 </td> 99<td> 100 <p> 101 Left parser. 102 </p> 103 </td> 104<td> 105 <p> 106 <a class="link" href="parser.html" title="Parser"><code class="computeroutput"><span class="identifier">Parser</span></code></a> 107 </p> 108 </td> 109</tr> 110<tr> 111<td> 112 <p> 113 <code class="computeroutput"><span class="identifier">p</span><span class="special">.</span><span class="identifier">right</span></code> 114 </p> 115 </td> 116<td> 117 <p> 118 Right parser. 119 </p> 120 </td> 121<td> 122 <p> 123 <a class="link" href="parser.html" title="Parser"><code class="computeroutput"><span class="identifier">Parser</span></code></a> 124 </p> 125 </td> 126</tr> 127</tbody> 128</table></div> 129<h6> 130<a name="spirit.qi.reference.parser_concepts.binaryparser.h3"></a> 131 <span class="phrase"><a name="spirit.qi.reference.parser_concepts.binaryparser.type_expressions"></a></span><a class="link" href="binaryparser.html#spirit.qi.reference.parser_concepts.binaryparser.type_expressions">Type 132 Expressions</a> 133 </h6> 134<div class="informaltable"><table class="table"> 135<colgroup> 136<col> 137<col> 138</colgroup> 139<thead><tr> 140<th> 141 <p> 142 Expression 143 </p> 144 </th> 145<th> 146 <p> 147 Description 148 </p> 149 </th> 150</tr></thead> 151<tbody> 152<tr> 153<td> 154 <p> 155 <code class="computeroutput"><span class="identifier">P</span><span class="special">::</span><span class="identifier">left_type</span></code> 156 </p> 157 </td> 158<td> 159 <p> 160 The left parser type. 161 </p> 162 </td> 163</tr> 164<tr> 165<td> 166 <p> 167 <code class="computeroutput"><span class="identifier">P</span><span class="special">::</span><span class="identifier">right_type</span></code> 168 </p> 169 </td> 170<td> 171 <p> 172 The right parser type. 173 </p> 174 </td> 175</tr> 176<tr> 177<td> 178 <p> 179 <code class="computeroutput"><span class="identifier">traits</span><span class="special">::</span><span class="identifier">is_binary_parser</span><span class="special"><</span><span class="identifier">P</span><span class="special">>::</span><span class="identifier">type</span></code> 180 </p> 181 </td> 182<td> 183 <p> 184 Metafunction that evaluates to <code class="computeroutput"><span class="identifier">mpl</span><span class="special">::</span><span class="identifier">true_</span></code> 185 if a certain type, <code class="computeroutput"><span class="identifier">P</span></code> 186 is a BinaryParser, <code class="computeroutput"><span class="identifier">mpl</span><span class="special">::</span><span class="identifier">false_</span></code> 187 otherwise (See <a href="../../../../../../../../libs/mpl/doc/refmanual/integral-constant.html" target="_top">MPL 188 Boolean Constant</a>). 189 </p> 190 </td> 191</tr> 192</tbody> 193</table></div> 194<h6> 195<a name="spirit.qi.reference.parser_concepts.binaryparser.h4"></a> 196 <span class="phrase"><a name="spirit.qi.reference.parser_concepts.binaryparser.invariants"></a></span><a class="link" href="binaryparser.html#spirit.qi.reference.parser_concepts.binaryparser.invariants">Invariants</a> 197 </h6> 198<p> 199 For any BinaryParser, <code class="computeroutput"><span class="identifier">P</span></code>, 200 the following invariants always hold: 201 </p> 202<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 203<li class="listitem"> 204 <code class="computeroutput"><span class="identifier">traits</span><span class="special">::</span><span class="identifier">is_parser</span><span class="special"><</span><span class="identifier">P</span><span class="special">::</span><span class="identifier">left_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> 205 </li> 206<li class="listitem"> 207 <code class="computeroutput"><span class="identifier">traits</span><span class="special">::</span><span class="identifier">is_parser</span><span class="special"><</span><span class="identifier">P</span><span class="special">::</span><span class="identifier">right_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> 208 </li> 209</ul></div> 210<h6> 211<a name="spirit.qi.reference.parser_concepts.binaryparser.h5"></a> 212 <span class="phrase"><a name="spirit.qi.reference.parser_concepts.binaryparser.models"></a></span><a class="link" href="binaryparser.html#spirit.qi.reference.parser_concepts.binaryparser.models">Models</a> 213 </h6> 214<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 215<li class="listitem"> 216 <a class="link" href="../operator/difference.html" title="Difference Parser (a - b)">Difference</a> 217 </li> 218<li class="listitem"> 219 <a class="link" href="../operator/list.html" title="List Parser (a % b)">List</a> 220 </li> 221</ul></div> 222</div> 223<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 224<td align="left"></td> 225<td align="right"><div class="copyright-footer">Copyright © 2001-2011 Joel de Guzman, Hartmut Kaiser<p> 226 Distributed under the Boost Software License, Version 1.0. (See accompanying 227 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>) 228 </p> 229</div></td> 230</tr></table> 231<hr> 232<div class="spirit-nav"> 233<a accesskey="p" href="unaryparser.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../parser_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="naryparser.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 234</div> 235</body> 236</html> 237
