doc/html/boost/proto/_data.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   5 <title>Struct _data</title>
   6 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
   7 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   8 <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   9 <link rel="up" href="../../proto/reference.html#header.boost.proto.transform.arg_hpp" title="Header &lt;boost/proto/transform/arg.hpp&gt;">
  10 <link rel="prev" href="_state/impl.html" title="Struct template impl">
  11 <link rel="next" href="_data/impl.html" title="Struct template impl">
  12 </head>
  13 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  14 <table cellpadding="2" width="100%"><tr>
  15 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
  16 <td align="center"><a href="../../../../index.html">Home</a></td>
  17 <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  19 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  20 <td align="center"><a href="../../../../more/index.htm">More</a></td>
  21 </tr></table>
  22 <hr>
  23 <div class="spirit-nav">
  24 <a accesskey="p" href="_state/impl.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../proto/reference.html#header.boost.proto.transform.arg_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/impl.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  25 </div>
  26 <div class="refentry">
  27 <a name="boost.proto._data"></a><div class="titlepage"></div>
  28 <div class="refnamediv">
  29 <h2><span class="refentrytitle">Struct _data</span></h2>
  30 <p>boost::proto::_data &#8212;
  31           A <a class="link" href="../../PrimitiveTransform.html" title="Concept PrimitiveTransform">PrimitiveTransform</a> that returns the current data unmodified.
  32           If the data (third) parameter is a transform environment, it returns the value associated
  33           with the <code class="computeroutput"><a class="link" href="data_type.html" title="Struct data_type">proto::data_type</a></code> key. Otherwise, it returns
  34           the data parameter unmodified.
  35         </p>
  36 </div>
  37 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  38 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../proto/reference.html#header.boost.proto.transform.arg_hpp" title="Header &lt;boost/proto/transform/arg.hpp&gt;">boost/proto/transform/arg.hpp</a>&gt;
  39
  40 </span>
  41 <span class="keyword">struct</span> <a class="link" href="_data.html" title="Struct _data">_data</a> <span class="special">:</span> <span class="keyword"></span> <a class="link" href="transform.html" title="Struct template transform">proto::transform</a><span class="special">&lt;</span> <span class="identifier">_data</span> <span class="special">&gt;</span> <span class="special">{</span>
  42   <span class="comment">// member classes/structs/unions</span>
  43   <span class="keyword">template</span><span class="special">&lt;</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">&gt;</span>
  44   <span class="keyword">struct</span> <a class="link" href="_data/impl.html" title="Struct template impl">impl</a> <span class="special">:</span> <span class="keyword"></span>
  45     <span class="identifier">mpl</span><span class="special">::</span><span class="identifier">if_c</span><span class="special">&lt;</span>
  46       <a class="link" href="is_env.html" title="Struct template is_env">proto::is_env</a><span class="special">&lt;</span><span class="identifier">Data</span><span class="special">&gt;</span><span class="special">::</span><span class="identifier">value</span><span class="special">,</span>
  47       <a class="link" href="_env_var.html" title="Struct template _env_var">proto::_env_var</a><span class="special">&lt;</span><a class="link" href="data_type.html" title="Struct data_type">proto::data_type</a><span class="special">&gt;</span><span class="special">,</span>
  48       <a class="link" href="_env.html" title="Struct _env">proto::_env</a>
  49     <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span><span class="special">::</span><span class="keyword">template</span> <span class="identifier">impl</span><span class="special">&lt;</span><span class="identifier">Expr</span><span class="special">,</span> <span class="identifier">State</span><span class="special">,</span> <span class="identifier">Data</span><span class="special">&gt;</span>
  50   <span class="special">{</span>
  51   <span class="special">}</span><span class="special">;</span>
  52 <span class="special">}</span><span class="special">;</span></pre></div>
  53 <div class="refsect1">
  54 <a name="idp479105840"></a><h2>Description</h2>
  55 <p>
  56             If the data (third) parameter is a transform environment, it returns the value associated
  57             with the <code class="computeroutput"><a class="link" href="data_type.html" title="Struct data_type">proto::data_type</a></code> key. Otherwise, it returns
  58             the data parameter unmodified.
  59           </p>
  60 <p>
  61             <span class="bold"><strong>Example:</strong></span>
  62             </p>
  63 <pre class="programlisting"><a class="link" href="terminal.html" title="Struct template terminal">proto::terminal</a><span class="special">&lt;</span><span class="keyword">int</span><span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> <span class="identifier">i</span> <span class="special">=</span> <span class="special">{</span><span class="number">42</span><span class="special">}</span><span class="special">;</span>
  64 <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="identifier">str</span><span class="special">(</span><span class="string">"hello"</span><span class="special">)</span><span class="special">;</span>
  65 <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&amp;</span> <span class="identifier">d1</span> <span class="special">=</span> <span class="identifier">proto</span><span class="special">::</span><span class="identifier">_data</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">i</span><span class="special">,</span> <span class="char">'a'</span><span class="special">,</span> <span class="identifier">str</span><span class="special">)</span><span class="special">;</span>
  66 <span class="identifier">assert</span><span class="special">(</span> <span class="special">&amp;</span><span class="identifier">str</span> <span class="special">==</span> <span class="special">&amp;</span><span class="identifier">d1</span> <span class="special">)</span><span class="special">;</span>
  67
  68 <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&amp;</span> <span class="identifier">d2</span> <span class="special">=</span> <span class="identifier">proto</span><span class="special">::</span><span class="identifier">_data</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">i</span><span class="special">,</span> <span class="char">'a'</span><span class="special">,</span> <span class="special">(</span><a class="link" href="data.html" title="Global data">proto::data</a> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">ref</span><span class="special">(</span><span class="identifier">str</span><span class="special">)</span><span class="special">)</span><span class="special">)</span><span class="special">;</span>
  69 <span class="identifier">assert</span><span class="special">(</span> <span class="special">&amp;</span><span class="identifier">str</span> <span class="special">==</span> <span class="special">&amp;</span><span class="identifier">d2</span> <span class="special">)</span><span class="special">;</span></pre>
  70 <p>
  71           </p>
  72 </div>
  73 </div>
  74 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  75 <td align="left"></td>
  76 <td align="right"><div class="copyright-footer">Copyright &#169; 2008 Eric Niebler<p>
  77         Distributed under the Boost Software License, Version 1.0. (See accompanying
  78         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>)
  79       </p>
  80 </div></td>
  81 </tr></table>
  82 <hr>
  83 <div class="spirit-nav">
  84 <a accesskey="p" href="_state/impl.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../proto/reference.html#header.boost.proto.transform.arg_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/impl.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  85 </div>
  86 </body>
  87 </html>