1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>BOOST_FUSION_DEFINE_ASSOC_TPL_STRUCT</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="define_assoc_struct.html" title="BOOST_FUSION_DEFINE_ASSOC_STRUCT"> 10<link rel="next" href="../algorithm.html" title="Algorithm"> 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="define_assoc_struct.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="../algorithm.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.define_assoc_tpl_struct"></a><a class="link" href="define_assoc_tpl_struct.html" title="BOOST_FUSION_DEFINE_ASSOC_TPL_STRUCT">BOOST_FUSION_DEFINE_ASSOC_TPL_STRUCT</a> 28</h3></div></div></div> 29<h5> 30<a name="fusion.adapted.define_assoc_tpl_struct.h0"></a> 31 <span class="phrase"><a name="fusion.adapted.define_assoc_tpl_struct.description"></a></span><a class="link" href="define_assoc_tpl_struct.html#fusion.adapted.define_assoc_tpl_struct.description">Description</a> 32 </h5> 33<p> 34 BOOST_FUSION_DEFINE_ASSOC_TPL_STRUCT is a macro that can be used to generate 35 all the necessary boilerplate to define and adapt an arbitrary template struct 36 as a model of <a class="link" href="../sequence/concepts/random_access_sequence.html" title="Random Access Sequence">Random 37 Access Sequence</a> and <a class="link" href="../sequence/concepts/associative_sequence.html" title="Associative Sequence">Associative 38 Sequence</a>. 39 </p> 40<h5> 41<a name="fusion.adapted.define_assoc_tpl_struct.h1"></a> 42 <span class="phrase"><a name="fusion.adapted.define_assoc_tpl_struct.synopsis"></a></span><a class="link" href="define_assoc_tpl_struct.html#fusion.adapted.define_assoc_tpl_struct.synopsis">Synopsis</a> 43 </h5> 44<pre class="programlisting"><span class="identifier">BOOST_FUSION_DEFINE_ASSOC_TPL_STRUCT</span><span class="special">(</span> 45 <span class="special">(</span><span class="identifier">template_param0</span><span class="special">)(</span><span class="identifier">template_param1</span><span class="special">)...,</span> 46 <span class="special">(</span><span class="identifier">namespace0</span><span class="special">)(</span><span class="identifier">namespace1</span><span class="special">)...,</span> 47 <span class="identifier">struct_name</span><span class="special">,</span> 48 <span class="special">(</span><span class="identifier">member_type0</span><span class="special">,</span> <span class="identifier">member_name0</span><span class="special">,</span> <span class="identifier">key_type0</span><span class="special">)</span> 49 <span class="special">(</span><span class="identifier">member_type1</span><span class="special">,</span> <span class="identifier">member_name1</span><span class="special">,</span> <span class="identifier">key_type1</span><span class="special">)</span> 50 <span class="special">...</span> 51 <span class="special">)</span> 52</pre> 53<div class="variablelist"> 54<p class="title"><b>Notation</b></p> 55<dl class="variablelist"> 56<dt><span class="term"><code class="computeroutput"><span class="identifier">Str</span></code></span></dt> 57<dd><p> 58 An instantiated <code class="computeroutput"><span class="identifier">struct_name</span></code> 59 </p></dd> 60<dt><span class="term"><code class="computeroutput"><span class="identifier">str</span></code></span></dt> 61<dd><p> 62 An instance of <code class="computeroutput"><span class="identifier">Str</span></code> 63 </p></dd> 64<dt><span class="term"><code class="computeroutput"><span class="identifier">e0</span></code>...<code class="computeroutput"><span class="identifier">en</span></code></span></dt> 65<dd><p> 66 Heterogeneous values 67 </p></dd> 68<dt><span class="term"><code class="computeroutput"><span class="identifier">fs</span></code></span></dt> 69<dd><p> 70 A <a class="link" href="../sequence/concepts/forward_sequence.html" title="Forward Sequence">Forward 71 Sequence</a> 72 </p></dd> 73</dl> 74</div> 75<h5> 76<a name="fusion.adapted.define_assoc_tpl_struct.h2"></a> 77 <span class="phrase"><a name="fusion.adapted.define_assoc_tpl_struct.expression_semantics"></a></span><a class="link" href="define_assoc_tpl_struct.html#fusion.adapted.define_assoc_tpl_struct.expression_semantics">Expression 78 Semantics</a> 79 </h5> 80<p> 81 The above macro generates the necessary code that defines and adapts <code class="computeroutput"><span class="identifier">struct_name</span></code> as a model of <a class="link" href="../sequence/concepts/random_access_sequence.html" title="Random Access Sequence">Random 82 Access Sequence</a> and <a class="link" href="../sequence/concepts/associative_sequence.html" title="Associative Sequence">Associative 83 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> 84 declares the names of the template type parameters used. The sequence <code class="computeroutput"><span class="special">(</span><span class="identifier">namespace0</span><span class="special">)(</span><span class="identifier">namespace1</span><span class="special">)...</span></code> declares the namespace for <code class="computeroutput"><span class="identifier">struct_name</span></code>. It yields to a fully qualified 85 name for <code class="computeroutput"><span class="identifier">struct_name</span></code> of 86 <code class="computeroutput"><span class="identifier">namespace0</span><span class="special">::</span><span class="identifier">namespace1</span><span class="special">::...</span> 87 <span class="identifier">struct_name</span></code>. If an empty namespace 88 sequence is given (that is a macro that expands to nothing), the struct is 89 placed in the global namespace. The sequence of <code class="computeroutput"><span class="special">(</span><span class="identifier">member_typeN</span><span class="special">,</span> 90 <span class="identifier">member_nameN</span><span class="special">,</span> 91 <span class="identifier">key_typeN</span><span class="special">)</span></code> 92 triples declares the type, name and key type of each of the struct members 93 that are part of the sequence. 94 </p> 95<p> 96 The macro should be used at global scope. Semantics of an expression is defined 97 only where it differs from, or is not defined in <a class="link" href="../sequence/concepts/random_access_sequence.html" title="Random Access Sequence">Random 98 Access Sequence</a> and <a class="link" href="../sequence/concepts/associative_sequence.html" title="Associative Sequence">Associative 99 Sequence</a>. 100 </p> 101<div class="informaltable"><table class="table"> 102<colgroup> 103<col> 104<col> 105</colgroup> 106<thead><tr> 107<th> 108 <p> 109 Expression 110 </p> 111 </th> 112<th> 113 <p> 114 Semantics 115 </p> 116 </th> 117</tr></thead> 118<tbody> 119<tr> 120<td> 121 <p> 122 <code class="computeroutput"><span class="identifier">Str</span><span class="special">()</span></code> 123 </p> 124 </td> 125<td> 126 <p> 127 Creates an instance of <code class="computeroutput"><span class="identifier">Str</span></code> 128 with default constructed elements. 129 </p> 130 </td> 131</tr> 132<tr> 133<td> 134 <p> 135 <code class="computeroutput"><span class="identifier">Str</span><span class="special">(</span><span class="identifier">e0</span><span class="special">,</span> 136 <span class="identifier">e1</span><span class="special">,...</span> 137 <span class="identifier">en</span><span class="special">)</span></code> 138 </p> 139 </td> 140<td> 141 <p> 142 Creates an instance of <code class="computeroutput"><span class="identifier">Str</span></code> 143 with elements <code class="computeroutput"><span class="identifier">e0</span></code>...<code class="computeroutput"><span class="identifier">en</span></code>. 144 </p> 145 </td> 146</tr> 147<tr> 148<td> 149 <p> 150 <code class="computeroutput"><span class="identifier">Str</span><span class="special">(</span><span class="identifier">fs</span><span class="special">)</span></code> 151 </p> 152 </td> 153<td> 154 <p> 155 Copy constructs an instance of <code class="computeroutput"><span class="identifier">Str</span></code> 156 from a <a class="link" href="../sequence/concepts/forward_sequence.html" title="Forward Sequence">Forward 157 Sequence</a> <code class="computeroutput"><span class="identifier">fs</span></code>. 158 </p> 159 </td> 160</tr> 161<tr> 162<td> 163 <p> 164 <code class="computeroutput"><span class="identifier">str</span> <span class="special">=</span> 165 <span class="identifier">fs</span></code> 166 </p> 167 </td> 168<td> 169 <p> 170 Assigns from a <a class="link" href="../sequence/concepts/forward_sequence.html" title="Forward Sequence">Forward 171 Sequence</a> <code class="computeroutput"><span class="identifier">fs</span></code>. 172 </p> 173 </td> 174</tr> 175<tr> 176<td> 177 <p> 178 <code class="computeroutput"><span class="identifier">str</span><span class="special">.</span><span class="identifier">member_nameN</span></code> 179 </p> 180 </td> 181<td> 182 <p> 183 Access of struct member <code class="computeroutput"><span class="identifier">member_nameN</span></code> 184 </p> 185 </td> 186</tr> 187</tbody> 188</table></div> 189<h5> 190<a name="fusion.adapted.define_assoc_tpl_struct.h3"></a> 191 <span class="phrase"><a name="fusion.adapted.define_assoc_tpl_struct.header"></a></span><a class="link" href="define_assoc_tpl_struct.html#fusion.adapted.define_assoc_tpl_struct.header">Header</a> 192 </h5> 193<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="keyword">struct</span><span class="special">/</span><span class="identifier">define_assoc_struct</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> 194<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">define_assoc_struct</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> 195</pre> 196<h5> 197<a name="fusion.adapted.define_assoc_tpl_struct.h4"></a> 198 <span class="phrase"><a name="fusion.adapted.define_assoc_tpl_struct.example"></a></span><a class="link" href="define_assoc_tpl_struct.html#fusion.adapted.define_assoc_tpl_struct.example">Example</a> 199 </h5> 200<pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">keys</span> 201<span class="special">{</span> 202 <span class="keyword">struct</span> <span class="identifier">name</span><span class="special">;</span> 203 <span class="keyword">struct</span> <span class="identifier">age</span><span class="special">;</span> 204<span class="special">}</span> 205 206<span class="comment">// Any instantiated demo::employee is a Fusion sequence</span> 207<span class="identifier">BOOST_FUSION_DEFINE_ASSOC_TPL_STRUCT</span><span class="special">(</span> 208 <span class="special">(</span><span class="identifier">Name</span><span class="special">)(</span><span class="identifier">Age</span><span class="special">),</span> <span class="special">(</span><span class="identifier">demo</span><span class="special">),</span> <span class="identifier">employee</span><span class="special">,</span> 209 <span class="special">(</span><span class="identifier">Name</span><span class="special">,</span> <span class="identifier">name</span><span class="special">,</span> <span class="identifier">keys</span><span class="special">::</span><span class="identifier">name</span><span class="special">)</span> 210 <span class="special">(</span><span class="identifier">Age</span><span class="special">,</span> <span class="identifier">age</span><span class="special">,</span> <span class="identifier">keys</span><span class="special">::</span><span class="identifier">age</span><span class="special">))</span> 211</pre> 212</div> 213<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 214<td align="left"></td> 215<td align="right"><div class="copyright-footer">Copyright © 2001-2006, 2011, 2012 Joel de Guzman, 216 Dan Marsden, Tobias Schwinger<p> 217 Distributed under the Boost Software License, Version 1.0. (See accompanying 218 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>) 219 </p> 220</div></td> 221</tr></table> 222<hr> 223<div class="spirit-nav"> 224<a accesskey="p" href="define_assoc_struct.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="../algorithm.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 225</div> 226</body> 227</html> 228
