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