diff options
Diffstat (limited to 'doc/html/boost/proto/or_.html')
| -rwxr-xr-x | doc/html/boost/proto/or_.html | 91 |
1 files changed, 91 insertions, 0 deletions
diff --git a/doc/html/boost/proto/or_.html b/doc/html/boost/proto/or_.html new file mode 100755 index 0000000000..91527235ac --- /dev/null +++ b/doc/html/boost/proto/or_.html @@ -0,0 +1,91 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Struct template or_</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../proto/reference.html#header.boost.proto.matches_hpp" title="Header <boost/proto/matches.hpp>"> +<link rel="prev" href="if_/impl.html" title="Struct template impl"> +<link rel="next" href="or_/impl.html" title="Struct template impl"> +</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="if_/impl.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../proto/reference.html#header.boost.proto.matches_hpp"><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="or_/impl.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.proto.or_"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Struct template or_</span></h2> +<p>boost::proto::or_ — For matching one of a set of alternate grammars. Alternates are tried in order to avoid ambiguity. + When used as a transform, <code class="computeroutput">proto::or_<></code> applies the transform + associated with the first grammar that matches the expression.</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../proto/reference.html#header.boost.proto.matches_hpp" title="Header <boost/proto/matches.hpp>">boost/proto/matches.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span><span class="special">...</span> G<span class="special">></span> +<span class="keyword">struct</span> <a class="link" href="or_.html" title="Struct template or_">or_</a> <span class="special">:</span> <span class="keyword"></span> <a class="link" href="transform.html" title="Struct template transform">proto::transform</a><or_<G...> > <span class="special">{</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <span class="identifier">or_</span> <a name="boost.proto.or_.proto_grammar"></a><span class="identifier">proto_grammar</span><span class="special">;</span> + + <span class="comment">// member classes/structs/unions</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> <a class="link" href="../../Expr.html" title="Concept Expr">Expr</a><span class="special">,</span> <span class="keyword">typename</span> State<span class="special">,</span> <span class="keyword">typename</span> Data<span class="special">></span> + <span class="keyword">struct</span> <a class="link" href="or_/impl.html" title="Struct template impl">impl</a> <span class="special">:</span> <span class="keyword"></span> <a class="link" href="transform_impl.html" title="Struct template transform_impl">proto::transform_impl</a>< Expr, State, Data > <span class="special">{</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <em class="replaceable"><code><span class="identifier">unspecified</span></code></em> <a class="link" href="or_/impl.html#boost.proto.or_.impl.result_type"><span class="identifier">result_type</span></a><span class="special">;</span> + + <span class="comment">// <a class="link" href="or_/impl.html#id1505563-bb">public member functions</a></span> + <span class="identifier">result_type</span> <a class="link" href="or_/impl.html#id1505568-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">impl</span><span class="special">::</span><span class="identifier">expr_param</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">impl</span><span class="special">::</span><span class="identifier">state_param</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">impl</span><span class="special">::</span><span class="identifier">data_param</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="special">}</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id2762687"></a><h2>Description</h2> +<p> + An expression type <code class="computeroutput">E</code> matches + <code class="computeroutput">proto::or_<G<sub>0</sub>,G<sub>1</sub>,...G<sub>n</sub>></code> + if <code class="computeroutput">E</code> matches any <code class="computeroutput">G<sub>x</sub></code> for + <code class="computeroutput">x</code> in <code class="computeroutput">[0,n]</code>. + </p> +<p> + When applying + <code class="computeroutput">proto::or_<G<sub>0</sub>,G<sub>1</sub>,...G<sub>n</sub>></code> + as a transform with an expression <code class="computeroutput">e</code> of type <code class="computeroutput">E</code>, + state <code class="computeroutput">s</code> and data <code class="computeroutput">d</code>, it is equivalent to + <code class="computeroutput">G<sub>x</sub>()(e, s, d)</code>, where + <code class="computeroutput">x</code> is the lowest number such that + <code class="computeroutput"><a class="link" href="matches.html" title="Struct template matches">proto::matches</a><E, G<sub>x</sub>>::value</code> + is <code class="computeroutput">true</code>. + </p> +<p> + The maximun number of template arguments <code class="computeroutput">proto::or_<></code> accepts + is controlled by the <code class="computeroutput"><a class="link" href="../../BOOST_PROTO_MAX_LOGICAL_ARITY.html" title="Macro BOOST_PROTO_MAX_LOGICAL_ARITY">BOOST_PROTO_MAX_LOGICAL_ARITY</a></code> + macro. + </p> +</div> +</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 © 2008 Eric Niebler<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="if_/impl.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../proto/reference.html#header.boost.proto.matches_hpp"><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="or_/impl.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> |