doc/html/boost/proto/generator.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Struct template generator</title>
   5 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
   7 <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   8 <link rel="up" href="../../proto/reference.html#header.boost.proto.generate_hpp" title="Header &lt;boost/proto/generate.hpp&gt;">
   9 <link rel="prev" href="basic_default_generator.html" title="Struct basic_default_generator">
  10 <link rel="next" href="generator/result_This_E_idp208747456.html" title="Struct template result&lt;This(Expr)&gt;">
  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="basic_default_generator.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../proto/reference.html#header.boost.proto.generate_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="generator/result_This_E_idp208747456.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.proto.generator"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Struct template generator</span></h2>
  29 <p>boost::proto::generator &#8212; A generator that wraps expressions passed to it in the specified extension wrapper.</p>
  30 </div>
  31 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  32 <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.generate_hpp" title="Header &lt;boost/proto/generate.hpp&gt;">boost/proto/generate.hpp</a>&gt;
  33
  34 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">template</span><span class="special">&lt;</span> <span class="keyword">typename</span> <span class="special">&gt;</span> <span class="keyword">class</span> Extends<span class="special">&gt;</span>
  35 <span class="keyword">struct</span> <a class="link" href="generator.html" title="Struct template generator">generator</a> <span class="special">{</span>
  36   <span class="comment">// member classes/structs/unions</span>
  37   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> This<span class="special">,</span> <span class="keyword">typename</span> <a class="link" href="../../Expr.html" title="Concept Expr">Expr</a><span class="special">&gt;</span>
  38   <span class="keyword">struct</span> <a class="link" href="generator/result_This_E_idp208747456.html" title="Struct template result&lt;This(Expr)&gt;">result</a><span class="special">&lt;</span><span class="identifier">This</span><span class="special">(</span><span class="identifier">Expr</span><span class="special">)</span><span class="special">&gt;</span> <span class="special">{</span>
  39     <span class="comment">// types</span>
  40     <span class="keyword">typedef</span> <span class="identifier">Extends</span><span class="special">&lt;</span> <span class="identifier">Expr</span> <span class="special">&gt;</span> <a class="link" href="generator/result_This_E_idp208747456.html#boost.proto.generator.result_This(E_idp208747456.type"><span class="identifier">type</span></a><span class="special">;</span>
  41   <span class="special">}</span><span class="special">;</span>
  42
  43   <span class="comment">// <a class="link" href="generator.html#idp208751808-bb">public member functions</a></span>
  44   <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">&gt;</span> <span class="identifier">Extends</span><span class="special">&lt;</span> <span class="identifier">Expr</span> <span class="special">&gt;</span> <a class="link" href="generator.html#idp208752368-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">Expr</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  45 <span class="special">}</span><span class="special">;</span></pre></div>
  46 <div class="refsect1">
  47 <a name="idp374263248"></a><h2>Description</h2>
  48 <p>
  49             Generators are intended for use as the first template parameter to the
  50             <code class="computeroutput"><a class="link" href="domain.html" title="Struct template domain">proto::domain&lt;&gt;</a></code>
  51             class template and control if and how expressions within that domain are to be customized.
  52             <code class="computeroutput">proto::generator&lt;&gt;</code> wraps each expression passed to it in
  53             the <code class="computeroutput">Extends&lt;&gt;</code> wrapper.
  54           </p>
  55 <div class="refsect2">
  56 <a name="idp374267120"></a><h3>
  57 <a name="idp208751808-bb"></a><code class="computeroutput">generator</code> public member functions</h3>
  58 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
  59 <pre class="literallayout"><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">&gt;</span> <span class="identifier">Extends</span><span class="special">&lt;</span> <span class="identifier">Expr</span> <span class="special">&gt;</span> <a name="idp208752368-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">Expr</span> <span class="keyword">const</span> <span class="special">&amp;</span> expr<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
  60 <div class="variablelist"><table border="0" class="variablelist compact">
  61 <colgroup>
  62 <col align="left" valign="top">
  63 <col>
  64 </colgroup>
  65 <tbody>
  66 <tr>
  67 <td><p><span class="term">Parameters:</span></p></td>
  68 <td><div class="variablelist"><table border="0" class="variablelist compact">
  69 <colgroup>
  70 <col align="left" valign="top">
  71 <col>
  72 </colgroup>
  73 <tbody><tr>
  74 <td><p><span class="term"><code class="computeroutput">expr</code></span></p></td>
  75 <td><p>A Proto expression</p></td>
  76 </tr></tbody>
  77 </table></div></td>
  78 </tr>
  79 <tr>
  80 <td><p><span class="term">Returns:</span></p></td>
  81 <td><p><code class="computeroutput">Extends&lt;Expr&gt;(expr)</code></p></td>
  82 </tr>
  83 </tbody>
  84 </table></div>
  85 </li></ol></div>
  86 </div>
  87 </div>
  88 </div>
  89 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  90 <td align="left"></td>
  91 <td align="right"><div class="copyright-footer">Copyright &#169; 2008 Eric Niebler<p>
  92         Distributed under the Boost Software License, Version 1.0. (See accompanying
  93         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>)
  94       </p>
  95 </div></td>
  96 </tr></table>
  97 <hr>
  98 <div class="spirit-nav">
  99 <a accesskey="p" href="basic_default_generator.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../proto/reference.html#header.boost.proto.generate_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="generator/result_This_E_idp208747456.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 100 </div>
 101 </body>
 102 </html>