1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>BOOST_FUSION_ADAPT_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="boost__tuple.html" title="boost::tuple"> 10<link rel="next" href="adapt_tpl_struct.html" title="BOOST_FUSION_ADAPT_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="boost__tuple.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_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.adapt_struct"></a><a class="link" href="adapt_struct.html" title="BOOST_FUSION_ADAPT_STRUCT">BOOST_FUSION_ADAPT_STRUCT</a> 28</h3></div></div></div> 29<h5> 30<a name="fusion.adapted.adapt_struct.h0"></a> 31 <span class="phrase"><a name="fusion.adapted.adapt_struct.description"></a></span><a class="link" href="adapt_struct.html#fusion.adapted.adapt_struct.description">Description</a> 32 </h5> 33<p> 34 BOOST_FUSION_ADAPT_STRUCT is a macro that can be used to generate all the 35 necessary boilerplate to make an arbitrary struct a model of <a class="link" href="../sequence/concepts/random_access_sequence.html" title="Random Access Sequence">Random 36 Access Sequence</a>. 37 </p> 38<h5> 39<a name="fusion.adapted.adapt_struct.h1"></a> 40 <span class="phrase"><a name="fusion.adapted.adapt_struct.synopsis"></a></span><a class="link" href="adapt_struct.html#fusion.adapted.adapt_struct.synopsis">Synopsis</a> 41 </h5> 42<pre class="programlisting"><span class="identifier">BOOST_FUSION_ADAPT_STRUCT</span><span class="special">(</span> 43 <span class="identifier">struct_name</span><span class="special">,</span> 44 <span class="identifier">member_name0</span><span class="special">,</span> 45 <span class="identifier">member_name1</span><span class="special">,</span> 46 <span class="identifier">member_name2</span><span class="special">,</span> 47 <span class="special">...</span> 48 <span class="special">)</span> 49 50<span class="comment">// Without BOOST_PP_VARIADICS support :</span> 51<span class="identifier">BOOST_FUSION_ADAPT_STRUCT</span><span class="special">(</span> 52 <span class="identifier">struct_name</span><span class="special">,</span> 53 <span class="special">(</span><span class="identifier">member_type0</span><span class="special">,</span> <span class="identifier">member_name0</span><span class="special">)</span> 54 <span class="special">(</span><span class="identifier">member_type1</span><span class="special">,</span> <span class="identifier">member_name1</span><span class="special">)</span> 55 <span class="special">(</span><span class="keyword">auto</span><span class="special">,</span> <span class="identifier">member_name2</span><span class="special">)</span> 56 <span class="special">...</span> 57 <span class="special">)</span> 58</pre> 59<h5> 60<a name="fusion.adapted.adapt_struct.h2"></a> 61 <span class="phrase"><a name="fusion.adapted.adapt_struct.semantics"></a></span><a class="link" href="adapt_struct.html#fusion.adapted.adapt_struct.semantics">Semantics</a> 62 </h5> 63<p> 64 The above macro generates the necessary code to adapt <code class="computeroutput"><span class="identifier">struct_name</span></code> 65 as a model of <a class="link" href="../sequence/concepts/random_access_sequence.html" title="Random Access Sequence">Random 66 Access Sequence</a>. 67 </p> 68<p> 69 The sequence of <code class="computeroutput"><span class="identifier">member_nameN</span><span class="special">,</span></code> arguments or <code class="computeroutput"><span class="special">(</span><span class="identifier">member_typeN</span><span class="special">,</span> 70 <span class="identifier">member_nameN</span><span class="special">)</span></code> 71 pairs declares the type and names of each of the struct members that are 72 part of the sequence. 73 </p> 74<p> 75 When member_typeN is omitted or set to auto, the type is infered with Boost.TypeOf. 76 </p> 77<p> 78 The macro should be used at global scope, and <code class="computeroutput"><span class="identifier">struct_name</span></code> 79 should be the fully namespace qualified name of the struct to be adapted. 80 </p> 81<h5> 82<a name="fusion.adapted.adapt_struct.h3"></a> 83 <span class="phrase"><a name="fusion.adapted.adapt_struct.header"></a></span><a class="link" href="adapt_struct.html#fusion.adapted.adapt_struct.header">Header</a> 84 </h5> 85<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">adapt_struct</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> 86<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_struct</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> 87</pre> 88<h5> 89<a name="fusion.adapted.adapt_struct.h4"></a> 90 <span class="phrase"><a name="fusion.adapted.adapt_struct.example__boost_fusion_adapt_struct_"></a></span><a class="link" href="adapt_struct.html#fusion.adapted.adapt_struct.example__boost_fusion_adapt_struct_">Example: 91 BOOST_FUSION_ADAPT_STRUCT </a> 92 </h5> 93<pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">demo</span> 94<span class="special">{</span> 95 <span class="keyword">struct</span> <span class="identifier">employee</span> 96 <span class="special">{</span> 97 <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="identifier">name</span><span class="special">;</span> 98 <span class="keyword">int</span> <span class="identifier">age</span><span class="special">;</span> 99 <span class="special">};</span> 100<span class="special">}</span> 101 102<span class="comment">// demo::employee is now a Fusion sequence</span> 103<span class="identifier">BOOST_FUSION_ADAPT_STRUCT</span><span class="special">(</span> 104 <span class="identifier">demo</span><span class="special">::</span><span class="identifier">employee</span><span class="special">,</span> 105 <span class="identifier">name</span><span class="special">,</span> 106 <span class="identifier">age</span><span class="special">)</span> 107 108<span class="comment">// Without BOOST_PP_VARIADICS support :</span> 109<span class="identifier">BOOST_FUSION_ADAPT_STRUCT</span><span class="special">(</span> 110 <span class="identifier">demo</span><span class="special">::</span><span class="identifier">employee</span><span class="special">,</span> 111 <span class="special">(</span><span class="keyword">auto</span><span class="special">,</span> <span class="identifier">name</span><span class="special">)</span> 112 <span class="special">(</span><span class="keyword">auto</span><span class="special">,</span> <span class="identifier">age</span><span class="special">)</span> 113<span class="special">)</span> 114</pre> 115</div> 116<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 117<td align="left"></td> 118<td align="right"><div class="copyright-footer">Copyright © 2001-2006, 2011, 2012 Joel de Guzman, 119 Dan Marsden, Tobias Schwinger<p> 120 Distributed under the Boost Software License, Version 1.0. (See accompanying 121 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>) 122 </p> 123</div></td> 124</tr></table> 125<hr> 126<div class="spirit-nav"> 127<a accesskey="p" href="boost__tuple.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_tpl_struct.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 128</div> 129</body> 130</html> 131
