1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>BOOST_FUSION_ADAPT_TPL_ADT</title> 5<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="../../index.html" title="Chapter 1. Fusion 2.2"> 8<link rel="up" href="../adapted.html" title="Adapted"> 9<link rel="prev" href="adapt_adt.html" title="BOOST_FUSION_ADAPT_ADT"> 10<link rel="next" href="adapt_assoc_adt.html" title="BOOST_FUSION_ADAPT_ASSOC_ADT"> 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="adapt_adt.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../adapted.html"><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="adapt_assoc_adt.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h3 class="title"> 27<a name="fusion.adapted.adapt_tpl_adt"></a><a class="link" href="adapt_tpl_adt.html" title="BOOST_FUSION_ADAPT_TPL_ADT">BOOST_FUSION_ADAPT_TPL_ADT</a> 28</h3></div></div></div> 29<p> 30 BOOST_FUSION_ADAPT_TPL_ADT is a macro than can be used to generate all the 31 necessary boilerplate to adapt an arbitrary template class type as a model 32 of <a class="link" href="../sequence/concepts/random_access_sequence.html" title="Random Access Sequence">Random 33 Access Sequence</a>. 34 </p> 35<h5> 36<a name="fusion.adapted.adapt_tpl_adt.h0"></a> 37 <span class="phrase"><a name="fusion.adapted.adapt_tpl_adt.synopsis"></a></span><a class="link" href="adapt_tpl_adt.html#fusion.adapted.adapt_tpl_adt.synopsis">Synopsis</a> 38 </h5> 39<pre class="programlisting"><span class="identifier">BOOST_FUSION_ADAPT_TPL_ADT</span><span class="special">(</span> 40 <span class="special">(</span><span class="identifier">template_param0</span><span class="special">)(</span><span class="identifier">template_param1</span><span class="special">)...,</span> 41 <span class="special">(</span><span class="identifier">type_name</span><span class="special">)</span> <span class="special">(</span><span class="identifier">specialization_param0</span><span class="special">)(</span><span class="identifier">specialization_param1</span><span class="special">)...,</span> 42 <span class="special">([</span><span class="identifier">attribute_type0</span><span class="special">,</span> <span class="identifier">attribute_const_type0</span><span class="special">,]</span> <span class="identifier">get_expr0</span><span class="special">,</span> <span class="identifier">set_expr0</span><span class="special">)</span> 43 <span class="special">([</span><span class="identifier">attribute_type1</span><span class="special">,</span> <span class="identifier">attribute_const_type1</span><span class="special">,]</span> <span class="identifier">get_expr1</span><span class="special">,</span> <span class="identifier">set_expr1</span><span class="special">)</span> 44 <span class="special">...</span> 45 <span class="special">)</span> 46</pre> 47<h5> 48<a name="fusion.adapted.adapt_tpl_adt.h1"></a> 49 <span class="phrase"><a name="fusion.adapted.adapt_tpl_adt.expression_semantics"></a></span><a class="link" href="adapt_tpl_adt.html#fusion.adapted.adapt_tpl_adt.expression_semantics">Expression 50 Semantics</a> 51 </h5> 52<p> 53 The above macro generates the necessary code to adapt <code class="computeroutput"><span class="identifier">type_name</span></code> 54 or an arbitrary specialization of <code class="computeroutput"><span class="identifier">type_name</span></code> 55 as a model of <a class="link" href="../sequence/concepts/random_access_sequence.html" title="Random Access Sequence">Random 56 Access Sequence</a>. The sequence <code class="computeroutput"><span class="special">(</span><span class="identifier">template_param0</span><span class="special">)(</span><span class="identifier">template_param1</span><span class="special">)...</span></code> 57 declares the names of the template type parameters used. The sequence <code class="computeroutput"><span class="special">(</span><span class="identifier">specialization_param0</span><span class="special">)(</span><span class="identifier">specialization_param1</span><span class="special">)...</span></code> declares the template parameters of the 58 actual specialization of <code class="computeroutput"><span class="identifier">type_name</span></code> 59 that is adapted as a fusion sequence. The sequence of <code class="literal">(attribute_type<span class="emphasis"><em>N</em></span>, 60 attribute_const_type<span class="emphasis"><em>N</em></span>, get_expr<span class="emphasis"><em>N</em></span>, 61 set_expr<span class="emphasis"><em>N</em></span>)</code> quadruples declares the types, 62 const types, get-expressions and set-expressions of the elements that are 63 part of the adapted fusion sequence. <code class="literal">get_expr<span class="emphasis"><em>N</em></span></code> 64 is the expression that is invoked to get the <span class="emphasis"><em>N</em></span>th element 65 of an instance of <code class="computeroutput"><span class="identifier">type_name</span></code>. 66 This expression may access a variable named <code class="computeroutput"><span class="identifier">obj</span></code> 67 of type <code class="computeroutput"><span class="identifier">type_name</span><span class="special">&</span></code> 68 or <code class="computeroutput"><span class="identifier">type_name</span> <span class="keyword">const</span><span class="special">&</span></code> which represents the underlying instance 69 of <code class="computeroutput"><span class="identifier">type_name</span></code>. <code class="literal">attribute_type<span class="emphasis"><em>N</em></span></code> 70 and <code class="literal">attribute_const_type<span class="emphasis"><em>N</em></span></code> may specify 71 the types that <code class="literal">get_expr<span class="emphasis"><em>N</em></span></code> denotes 72 to, when omitted the type is deduced from [get_expr<span class="emphasis"><em>N</em></span>] 73 return type via BOOST_TYPEOF. On compiler missing support for variadic macros 74 auto can be used to avoid repeating the type. <code class="literal">set_expr<span class="emphasis"><em>N</em></span></code> 75 is the expression that is invoked to set the <span class="emphasis"><em>N</em></span>th element 76 of an instance of <code class="computeroutput"><span class="identifier">type_name</span></code>. 77 This expression may access variables named <code class="computeroutput"><span class="identifier">obj</span></code> 78 of type <code class="computeroutput"><span class="identifier">type_name</span><span class="special">&</span></code>, 79 which represent the corresponding instance of <code class="computeroutput"><span class="identifier">type_name</span></code>, 80 and <code class="computeroutput"><span class="identifier">val</span></code> of an arbitrary const-qualified 81 reference template type parameter <code class="computeroutput"><span class="identifier">Val</span></code>, 82 which represents the right operand of the assignment expression. 83 </p> 84<p> 85 The actual return type of fusion's intrinsic sequence access (meta-)functions 86 when in invoked with (an instance of) <code class="computeroutput"><span class="identifier">type_name</span></code> 87 is a proxy type. This type is implicitly convertible to the attribute type 88 via <code class="literal">get_expr<span class="emphasis"><em>N</em></span></code> and forwards assignment 89 to the underlying element via <code class="literal">set_expr<span class="emphasis"><em>N</em></span></code>. 90 The value type (that is the type returned by <a class="link" href="../iterator/metafunctions/value_of.html" title="value_of"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">value_of</span></code></a>, <a class="link" href="../sequence/intrinsic/metafunctions/value_at.html" title="value_at"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">value_at</span></code></a> and <a class="link" href="../sequence/intrinsic/metafunctions/value_at_c.html" title="value_at_c"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">value_at_c</span></code></a>) of the <span class="emphasis"><em>N</em></span>th 91 element is <code class="literal">attribute_type<span class="emphasis"><em>N</em></span></code> with const-qualifier 92 and reference removed. 93 </p> 94<p> 95 The macro should be used at global scope, and <code class="computeroutput"><span class="identifier">type_name</span></code> 96 should be the fully namespace qualified name of the template class type to 97 be adapted. 98 </p> 99<h5> 100<a name="fusion.adapted.adapt_tpl_adt.h2"></a> 101 <span class="phrase"><a name="fusion.adapted.adapt_tpl_adt.header"></a></span><a class="link" href="adapt_tpl_adt.html#fusion.adapted.adapt_tpl_adt.header">Header</a> 102 </h5> 103<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">fusion</span><span class="special">/</span><span class="identifier">adapted</span><span class="special">/</span><span class="identifier">adt</span><span class="special">/</span><span class="identifier">adapt_adt</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> 104<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">fusion</span><span class="special">/</span><span class="identifier">include</span><span class="special">/</span><span class="identifier">adapt_adt</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> 105</pre> 106<h5> 107<a name="fusion.adapted.adapt_tpl_adt.h3"></a> 108 <span class="phrase"><a name="fusion.adapted.adapt_tpl_adt.example"></a></span><a class="link" href="adapt_tpl_adt.html#fusion.adapted.adapt_tpl_adt.example">Example</a> 109 </h5> 110<pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">demo</span> 111<span class="special">{</span> 112 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> <span class="identifier">Name</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Age</span><span class="special">></span> 113 <span class="keyword">struct</span> <span class="identifier">employee</span> 114 <span class="special">{</span> 115 <span class="keyword">private</span><span class="special">:</span> 116 <span class="identifier">Name</span> <span class="identifier">name</span><span class="special">;</span> 117 <span class="identifier">Age</span> <span class="identifier">age</span><span class="special">;</span> 118 119 <span class="keyword">public</span><span class="special">:</span> 120 <span class="keyword">void</span> <span class="identifier">set_name</span><span class="special">(</span><span class="identifier">Name</span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">n</span><span class="special">)</span> 121 <span class="special">{</span> 122 <span class="identifier">name</span><span class="special">=</span><span class="identifier">n</span><span class="special">;</span> 123 <span class="special">}</span> 124 125 <span class="keyword">void</span> <span class="identifier">set_age</span><span class="special">(</span><span class="identifier">Age</span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">a</span><span class="special">)</span> 126 <span class="special">{</span> 127 <span class="identifier">age</span><span class="special">=</span><span class="identifier">a</span><span class="special">;</span> 128 <span class="special">}</span> 129 130 <span class="identifier">Name</span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">get_name</span><span class="special">()</span><span class="keyword">const</span> 131 <span class="special">{</span> 132 <span class="keyword">return</span> <span class="identifier">name</span><span class="special">;</span> 133 <span class="special">}</span> 134 135 <span class="identifier">Age</span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">get_age</span><span class="special">()</span><span class="keyword">const</span> 136 <span class="special">{</span> 137 <span class="keyword">return</span> <span class="identifier">age</span><span class="special">;</span> 138 <span class="special">}</span> 139 <span class="special">};</span> 140<span class="special">}</span> 141 142<span class="identifier">BOOST_FUSION_ADAPT_TPL_ADT</span><span class="special">(</span> 143 <span class="special">(</span><span class="identifier">Name</span><span class="special">)(</span><span class="identifier">Age</span><span class="special">),</span> 144 <span class="special">(</span><span class="identifier">demo</span><span class="special">::</span><span class="identifier">employee</span><span class="special">)</span> <span class="special">(</span><span class="identifier">Name</span><span class="special">)(</span><span class="identifier">Age</span><span class="special">),</span> 145 <span class="special">(</span><span class="identifier">Name</span> <span class="keyword">const</span><span class="special">&,</span> <span class="identifier">Name</span> <span class="keyword">const</span><span class="special">&,</span> <span class="identifier">obj</span><span class="special">.</span><span class="identifier">get_name</span><span class="special">(),</span> <span class="identifier">obj</span><span class="special">.</span><span class="identifier">set_name</span><span class="special">(</span><span class="identifier">val</span><span class="special">))</span> 146 <span class="special">(</span><span class="identifier">Age</span> <span class="keyword">const</span><span class="special">&,</span> <span class="identifier">Age</span> <span class="keyword">const</span><span class="special">&,</span> <span class="identifier">obj</span><span class="special">.</span><span class="identifier">get_age</span><span class="special">(),</span> <span class="identifier">obj</span><span class="special">.</span><span class="identifier">set_age</span><span class="special">(</span><span class="identifier">val</span><span class="special">)))</span> 147 148<span class="identifier">demo</span><span class="special">::</span><span class="identifier">employee</span><span class="special"><</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span><span class="special">,</span> <span class="keyword">int</span><span class="special">></span> <span class="identifier">e</span><span class="special">;</span> 149<span class="identifier">boost</span><span class="special">::</span><span class="identifier">fusion</span><span class="special">::</span><span class="identifier">front</span><span class="special">(</span><span class="identifier">e</span><span class="special">)=</span><span class="string">"Edward Norton"</span><span class="special">;</span> 150<span class="identifier">boost</span><span class="special">::</span><span class="identifier">fusion</span><span class="special">::</span><span class="identifier">back</span><span class="special">(</span><span class="identifier">e</span><span class="special">)=</span><span class="number">41</span><span class="special">;</span> 151<span class="comment">//Prints 'Edward Norton is 41 years old'</span> 152<span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special"><<</span> <span class="identifier">e</span><span class="special">.</span><span class="identifier">get_name</span><span class="special">()</span> <span class="special"><<</span> <span class="string">" is "</span> <span class="special"><<</span> <span class="identifier">e</span><span class="special">.</span><span class="identifier">get_age</span><span class="special">()</span> <span class="special"><<</span> <span class="string">" years old"</span> <span class="special"><<</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span> 153</pre> 154<h5> 155<a name="fusion.adapted.adapt_tpl_adt.h4"></a> 156 <span class="phrase"><a name="fusion.adapted.adapt_tpl_adt.see_also"></a></span><a class="link" href="adapt_tpl_adt.html#fusion.adapted.adapt_tpl_adt.see_also">See 157 also</a> 158 </h5> 159<p> 160 <a class="link" href="../notes.html#fusion.notes.adt_attribute_proxy"><code class="computeroutput"><span class="identifier">adt_attribute_proxy</span></code></a> 161 </p> 162</div> 163<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 164<td align="left"></td> 165<td align="right"><div class="copyright-footer">Copyright © 2001-2006, 2011, 2012 Joel de Guzman, 166 Dan Marsden, Tobias Schwinger<p> 167 Distributed under the Boost Software License, Version 1.0. (See accompanying 168 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>) 169 </p> 170</div></td> 171</tr></table> 172<hr> 173<div class="spirit-nav"> 174<a accesskey="p" href="adapt_adt.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../adapted.html"><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="adapt_assoc_adt.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 175</div> 176</body> 177</html> 178
