diff options
Diffstat (limited to 'doc/html/boost/proto/data_type.html')
| -rw-r--r-- | doc/html/boost/proto/data_type.html | 89 |
1 files changed, 89 insertions, 0 deletions
diff --git a/doc/html/boost/proto/data_type.html b/doc/html/boost/proto/data_type.html new file mode 100644 index 0000000000..cc9c758d59 --- /dev/null +++ b/doc/html/boost/proto/data_type.html @@ -0,0 +1,89 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Struct data_type</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.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.transform.env_hpp" title="Header <boost/proto/transform/env.hpp>"> +<link rel="prev" href="is_env.html" title="Struct template is_env"> +<link rel="next" href="data.html" title="Global data"> +</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="is_env.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../proto/reference.html#header.boost.proto.transform.env_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="data.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.proto.data_type"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Struct data_type</span></h2> +<p>boost::proto::data_type — + The type of <code class="computeroutput"><a class="link" href="data.html" title="Global data">proto::data</a></code>, a key for use when creating + a transform environment that associates a piece of data with this type. + </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.transform.env_hpp" title="Header <boost/proto/transform/env.hpp>">boost/proto/transform/env.hpp</a>> + +</span> +<span class="keyword">struct</span> <a class="link" href="data_type.html" title="Struct data_type">data_type</a> <span class="special">{</span> + + <span class="comment">// <a class="link" href="data_type.html#idp206882624-bb">public member functions</a></span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Value<span class="special">></span> <a class="link" href="env.html" title="Struct template env">env</a><span class="special"><</span><span class="identifier">data_type</span><span class="special">,</span> <em class="replaceable"><code><span class="identifier">see</span><span class="special">-</span><span class="identifier">below</span></code></em><span class="special">></span> <a class="link" href="data_type.html#idp206883744-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="identifier">Value</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Value<span class="special">></span> + <a class="link" href="env.html" title="Struct template env">env</a><span class="special"><</span><span class="identifier">data_type</span><span class="special">,</span> <em class="replaceable"><code><span class="identifier">see</span><span class="special">-</span><span class="identifier">below</span></code></em><span class="special">></span> <a class="link" href="data_type.html#idp206887824-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="identifier">Value</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp388796400"></a><h2>Description</h2> +<p> + The <code class="computeroutput">proto::data_type</code> type, along with the <code class="computeroutput"><a class="link" href="data.html" title="Global data">proto::data</a></code> + global, are declared using the <code class="computeroutput"><a class="link" href="../../BOOST_PROTO_DEFINE_ENV_VAR.html" title="Macro BOOST_PROTO_DEFINE_ENV_VAR">BOOST_PROTO_DEFINE_ENV_VAR</a>()</code> macro. + </p> +<div class="refsect2"> +<a name="idp388800752"></a><h3> +<a name="idp206882624-bb"></a><code class="computeroutput">data_type</code> public member functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> +<pre class="literallayout"><a name="idp206883184-bb"></a><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Value<span class="special">></span> + <a class="link" href="env.html" title="Struct template env">env</a><span class="special"><</span><span class="identifier">data_type</span><span class="special">,</span> <em class="replaceable"><code><span class="identifier">see</span><span class="special">-</span><span class="identifier">below</span></code></em><span class="special">></span> <a name="idp206883744-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="identifier">Value</span> <span class="special">&</span> value<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Value<span class="special">></span> + <a class="link" href="env.html" title="Struct template env">env</a><span class="special"><</span><span class="identifier">data_type</span><span class="special">,</span> <em class="replaceable"><code><span class="identifier">see</span><span class="special">-</span><span class="identifier">below</span></code></em><span class="special">></span> <a name="idp206887824-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="identifier">Value</span> <span class="keyword">const</span> <span class="special">&</span> value<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p> + If <code class="computeroutput">Value</code> is a specialization <code class="computeroutput">boost::reference_wrapper<T></code>, + this function returns <code class="computeroutput"><a class="link" href="env.html" title="Struct template env">env</a><data_type, T &>(value.get())</code>. + </p> +<p> + Else, if the type <code class="computeroutput">Value</code> is non-copyable (i.e., a function, an array, abstract, or an ostream), + this function returns <code class="computeroutput"><a class="link" href="env.html" title="Struct template env">env</a><data_type, Value <em class="replaceable"><code>cv</code></em> &>(value)</code>, + where <code class="computeroutput"><em class="replaceable"><code>cv</code></em></code> is <code class="computeroutput">const</code> for the second overload, and empty + for the first. + </p> +<p> + Otherwise, this function returns <code class="computeroutput"><a class="link" href="env.html" title="Struct template env">env</a><data_type, Value>(value)</code>. + </p> +</li></ol></div> +</div> +</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="is_env.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../proto/reference.html#header.boost.proto.transform.env_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="data.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> |