doc/html/boost/proto/functional/display_expr.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 display_expr</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.debug_hpp" title="Header &lt;boost/proto/debug.hpp&gt;">
  10 <link rel="prev" href="../listN.html" title="Struct template listN">
  11 <link rel="next" href="../display_expr_idp700251904.html" title="Function display_expr">
  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="../listN.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../proto/reference.html#header.boost.proto.debug_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="../display_expr_idp700251904.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
  25 </div>
  26 <div class="refentry">
  27 <a name="boost.proto.functional.display_expr"></a><div class="titlepage"></div>
  28 <div class="refnamediv">
  29 <h2><span class="refentrytitle">Struct display_expr</span></h2>
  30 <p>boost::proto::functional::display_expr &#8212; Pretty-print a Proto expression tree. </p>
  31 </div>
  32 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  33 <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.debug_hpp" title="Header &lt;boost/proto/debug.hpp&gt;">boost/proto/debug.hpp</a>&gt;
  34
  35 </span>
  36 <span class="keyword">struct</span> <a class="link" href="display_expr.html" title="Struct display_expr">display_expr</a> <span class="special">{</span>
  37   <span class="comment">// types</span>
  38   <span class="keyword">typedef</span> <span class="keyword">void</span> <a name="boost.proto.functional.display_expr.result_type"></a><span class="identifier">result_type</span><span class="special">;</span>
  39
  40   <span class="comment">// <a class="link" href="display_expr.html#boost.proto.functional.display_exprconstruct-copy-destruct">construct/copy/destruct</a></span>
  41   <a class="link" href="display_expr.html#idp700245056-bb"><span class="identifier">display_expr</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&amp;</span> <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span><span class="special">,</span> <span class="keyword">int</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span>
  42
  43   <span class="comment">// <a class="link" href="display_expr.html#idp700240720-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="keyword">void</span> <a class="link" href="display_expr.html#idp700241280-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="idp461445152"></a><h2>Description</h2>
  48 <p>
  49               A <a class="link" href="../../../PolymorphicFunctionObject.html" title="Concept PolymorphicFunctionObject">PolymorphicFunctionObject</a> which accepts a Proto expression tree and pretty-prints it to an <code class="computeroutput">ostream</code> for debugging purposes.
  50             </p>
  51 <div class="refsect2">
  52 <a name="idp461447696"></a><h3>
  53 <a name="boost.proto.functional.display_exprconstruct-copy-destruct"></a><code class="computeroutput">display_expr</code>
  54         public
  55        construct/copy/destruct</h3>
  56 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
  57 <pre class="literallayout"><a name="idp700245056-bb"></a><span class="identifier">display_expr</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&amp;</span> sout <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span><span class="special">,</span> <span class="keyword">int</span> depth <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre>
  58 <div class="variablelist"><table border="0" class="variablelist compact">
  59 <colgroup>
  60 <col align="left" valign="top">
  61 <col>
  62 </colgroup>
  63 <tbody><tr>
  64 <td><p><span class="term">Parameters:</span></p></td>
  65 <td><div class="variablelist"><table border="0" class="variablelist compact">
  66 <colgroup>
  67 <col align="left" valign="top">
  68 <col>
  69 </colgroup>
  70 <tbody>
  71 <tr>
  72 <td><p><span class="term"><code class="computeroutput">depth</code></span></p></td>
  73 <td><p>
  74                   The starting indentation depth for this node. Children nodes will be displayed at a starting depth of <code class="computeroutput">depth+4</code>.
  75                 </p></td>
  76 </tr>
  77 <tr>
  78 <td><p><span class="term"><code class="computeroutput">sout</code></span></p></td>
  79 <td><p>
  80                   The <code class="computeroutput">ostream</code> to which the expression tree will be written.
  81                 </p></td>
  82 </tr>
  83 </tbody>
  84 </table></div></td>
  85 </tr></tbody>
  86 </table></div>
  87 </li></ol></div>
  88 </div>
  89 <div class="refsect2">
  90 <a name="idp461466704"></a><h3>
  91 <a name="idp700240720-bb"></a><code class="computeroutput">display_expr</code> public member functions</h3>
  92 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><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="keyword">void</span> <a name="idp700241280-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></li></ol></div>
  93 </div>
  94 </div>
  95 </div>
  96 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  97 <td align="left"></td>
  98 <td align="right"><div class="copyright-footer">Copyright &#169; 2008 Eric Niebler<p>
  99         Distributed under the Boost Software License, Version 1.0. (See accompanying
 100         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>)
 101       </p>
 102 </div></td>
 103 </tr></table>
 104 <hr>
 105 <div class="spirit-nav">
 106 <a accesskey="p" href="../listN.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../proto/reference.html#header.boost.proto.debug_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="../display_expr_idp700251904.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
 107 </div>
 108 </body>
 109 </html>