summaryrefslogtreecommitdiff
path: root/doc/html/BOOST_PROTO_BASIC_EXTENDS.html
blob: cecc5d3b52f21e9758bd0796d98b43f27295f819 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Macro BOOST_PROTO_BASIC_EXTENDS</title>
<link rel="stylesheet" href="../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.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.extends_hpp" title="Header &lt;boost/proto/extends.hpp&gt;">
<link rel="prev" href="BOOST_PROTO_EXTENDS.html" title="Macro BOOST_PROTO_EXTENDS">
<link rel="next" href="BOOST_PROTO_EXTENDS_ASSIGN.html" title="Macro BOOST_PROTO_EXTENDS_ASSIGN">
</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="BOOST_PROTO_EXTENDS.html"><img src="../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="proto/reference.html#header.boost.proto.extends_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="BOOST_PROTO_EXTENDS_ASSIGN.html"><img src="../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="BOOST_PROTO_BASIC_EXTENDS"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Macro BOOST_PROTO_BASIC_EXTENDS</span></h2>
<p>BOOST_PROTO_BASIC_EXTENDS &#8212; For creating expression wrappers that add members to a Proto expression template, like
      <code class="computeroutput"><a class="link" href="boost/proto/extends.html" title="Struct template extends">proto::extends&lt;&gt;</a></code>,
      but while retaining POD-ness of the expression wrapper.</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: &lt;<a class="link" href="proto/reference.html#header.boost.proto.extends_hpp" title="Header &lt;boost/proto/extends.hpp&gt;">boost/proto/extends.hpp</a>&gt;

</span>BOOST_PROTO_BASIC_EXTENDS(Expr, Derived, Domain)</pre></div>
<div class="refsect1">
<a name="idp463554560"></a><h2>Description</h2>
<p>
        <code class="computeroutput">BOOST_PROTO_BASIC_EXTENDS()</code> adds the basic typedefs, member functions, and
        data members necessary to make a struct a valid Proto expression extension. It does <span class="emphasis"><em>not</em></span>
        add any constructors, virtual functions or access control blocks that would render the containing
        struct non-POD.
      </p>
<p>
        <code class="computeroutput">Expr</code> is the Proto expression that the enclosing struct extends.
        <code class="computeroutput">Derived</code> is the type of the enclosing struct.
        <code class="computeroutput">Domain</code> is the Proto domain to which this expression extension belongs.
        (See <code class="computeroutput"><a class="link" href="boost/proto/domain.html" title="Struct template domain">proto::domain&lt;&gt;</a></code>.)
        Can be preceeded with "<code class="computeroutput">typename</code>" if the specified domain is a dependent type.
      </p>
<p><code class="computeroutput">BOOST_PROTO_BASIC_EXTENDS()</code> adds to its enclosing struct
        exactly one data member of type <code class="computeroutput">Expr</code>. 
      </p>
<p>If the <code class="computeroutput">Domain</code> parameter is dependent, you can specify it as
        <code class="computeroutput">typename Domain</code>, as in
        <code class="computeroutput">BOOST_PROTO_BASIC_EXTENDS(Expr, Derived, typename Domain)</code>
      </p>
<p>
        <span class="bold"><strong>Example:</strong></span></p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span> <span class="keyword">class</span> <span class="identifier">Expr</span> <span class="special">&gt;</span>
<span class="keyword">struct</span> <span class="identifier">my_expr</span><span class="special">;</span>

<span class="keyword">struct</span> <span class="identifier">my_domain</span>
  <span class="special">:</span> <a class="link" href="boost/proto/domain.html" title="Struct template domain">proto::domain</a><span class="special">&lt;</span> <a class="link" href="boost/proto/pod_generator.html" title="Struct template pod_generator">proto::pod_generator</a><span class="special">&lt;</span> <span class="identifier">my_expr</span> <span class="special">&gt;</span> <span class="special">&gt;</span>
<span class="special">{</span><span class="special">}</span><span class="special">;</span>

<span class="keyword">template</span><span class="special">&lt;</span> <span class="keyword">class</span> <span class="identifier">Expr</span> <span class="special">&gt;</span>
<span class="keyword">struct</span> <span class="identifier">my_expr</span>
<span class="special">{</span>
    <span class="comment">// OK, this makes my_expr&lt;&gt; a valid Proto expression extension.</span>
    <span class="comment">// my_expr&lt;&gt; does /not/ have overloaded assignment, subscript,</span>
    <span class="comment">// and function call operators that build expression templates, however.</span>
    <a class="link" href="BOOST_PROTO_BASIC_EXTENDS.html" title="Macro BOOST_PROTO_BASIC_EXTENDS">BOOST_PROTO_BASIC_EXTENDS</a><span class="special">(</span><span class="identifier">Expr</span><span class="special">,</span> <span class="identifier">my_expr</span><span class="special">,</span> <span class="identifier">my_domain</span><span class="special">)</span>
<span class="special">}</span><span class="special">;</span>

<span class="comment">// OK, my_expr&lt;&gt; is POD, so this is statically initialized:</span>
<span class="identifier">my_expr</span><span class="special">&lt;</span> <a class="link" href="boost/proto/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="special">&gt;</span> <span class="keyword">const</span> <span class="identifier">_1</span> <span class="special">=</span> <span class="special">{</span><span class="special">{</span><span class="number">1</span><span class="special">}</span><span class="special">}</span><span class="special">;</span></pre>
<p>
      </p>
<p>
        See also:
        </p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><code class="computeroutput"><a class="link" href="BOOST_PROTO_EXTENDS_ASSIGN.html" title="Macro BOOST_PROTO_EXTENDS_ASSIGN">BOOST_PROTO_EXTENDS_ASSIGN</a>()</code></li>
<li class="listitem"><code class="computeroutput"><a class="link" href="BOOST_PROTO_EXTENDS_SUBSCRIPT.html" title="Macro BOOST_PROTO_EXTENDS_SUBSCRIPT">BOOST_PROTO_EXTENDS_SUBSCRIPT</a>()</code></li>
<li class="listitem"><code class="computeroutput"><a class="link" href="BOOST_PROTO_EXTENDS_FUNCTION.html" title="Macro BOOST_PROTO_EXTENDS_FUNCTION">BOOST_PROTO_EXTENDS_FUNCTION</a>()</code></li>
<li class="listitem"><code class="computeroutput"><a class="link" href="BOOST_PROTO_EXTENDS.html" title="Macro BOOST_PROTO_EXTENDS">BOOST_PROTO_EXTENDS</a>()</code></li>
</ul></div>
<p>
      </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 &#169; 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="BOOST_PROTO_EXTENDS.html"><img src="../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="proto/reference.html#header.boost.proto.extends_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="BOOST_PROTO_EXTENDS_ASSIGN.html"><img src="../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>