boost_fusion/doc/html/fusion/adapted/adapt_struct.html

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title> BOOST_FUSION_ADAPT_STRUCT</title>
<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
<<<<<<< .working
<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
=======
<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
>>>>>>> .merge-right.r57125
<link rel="home" href="../../index.html" title="Chapter 1. Fusion 2.0">
<link rel="up" href="../adapted.html" title="Adapted">
<link rel="previous" href="boost__tuple.html" title="boost::tuple">
<link rel="next" href="adapt_assoc.html" title=" BOOST_FUSION_ADAPT_ASSOC_STRUCT">
</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="../../../../../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__tuple.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../adapted.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="adapt_assoc.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<<<<<<< .working
<div class="section" lang="en">
<div class="titlepage">
<div><div><h3 class="title">
<a name="fusion.adapted.adapt_struct"></a><a href="adapt_struct.html" title=" BOOST_FUSION_ADAPT_STRUCT"> BOOST_FUSION_ADAPT_STRUCT</a>
</h3></div></div>
<div></div>
</div>
<a name="fusion.adapted.adapt_struct.description"></a><h4>
<a name="id533623"></a>
        <a href="adapt_struct.html#fusion.adapted.adapt_struct.description">Description</a>
      </h4>
=======
<div class="section" title="BOOST_FUSION_ADAPT_STRUCT">
<div class="titlepage"><div><div><h3 class="title">
<a name="fusion.adapted.adapt_struct"></a><a class="link" href="adapt_struct.html" title="BOOST_FUSION_ADAPT_STRUCT"> BOOST_FUSION_ADAPT_STRUCT</a>
</h3></div></div></div>
<a name="fusion.adapted.adapt_struct.description"></a><h5>
<a name="id741004"></a>
        <a class="link" href="adapt_struct.html#fusion.adapted.adapt_struct.description">Description</a>
      </h5>
>>>>>>> .merge-right.r57125
<p>
        BOOST_FUSION_ADAPT_STRUCT is a macro that can be used to generate all the
        necessary boilerplate to make an arbitrary struct into a <a href="../sequence/concepts/random_access_sequence.html" title="Random
        Access Sequence">Random
        Access Sequence</a>.
      </p>
<<<<<<< .working
<a name="fusion.adapted.adapt_struct.synopsis"></a><h4>
<a name="id533662"></a>
        <a href="adapt_struct.html#fusion.adapted.adapt_struct.synopsis">Synopsis</a>
      </h4>
=======
<a name="fusion.adapted.adapt_struct.synopsis"></a><h5>
<a name="id741026"></a>
        <a class="link" href="adapt_struct.html#fusion.adapted.adapt_struct.synopsis">Synopsis</a>
      </h5>
>>>>>>> .merge-right.r57125
<pre class="programlisting"><span class="identifier">BOOST_FUSION_ADAPT_STRUCT</span><span class="special">(</span>
    <span class="identifier">struct_name</span><span class="special">,</span>
    <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="special">(</span><span class="identifier">member_type1</span><span class="special">,</span> <span class="identifier">member_name1</span><span class="special">)</span>
    <span class="special">...</span>
    <span class="special">)</span>
</pre>
<<<<<<< .working
<a name="fusion.adapted.adapt_struct.semantics"></a><h4>
<a name="id533781"></a>
        <a href="adapt_struct.html#fusion.adapted.adapt_struct.semantics">Semantics</a>
      </h4>
=======
<a name="fusion.adapted.adapt_struct.semantics"></a><h5>
<a name="id741110"></a>
        <a class="link" href="adapt_struct.html#fusion.adapted.adapt_struct.semantics">Semantics</a>
      </h5>
>>>>>>> .merge-right.r57125
<p>
        The above macro generates the necessary code to adapt <tt class="computeroutput"><span class="identifier">struct_name</span></tt>
        as a model of <a href="../sequence/concepts/random_access_sequence.html" title="Random
        Access Sequence">Random
        Access Sequence</a>. The sequence of <tt class="computeroutput"><span class="special">(</span><span class="identifier">member_typeN</span><span class="special">,</span>
        <span class="identifier">member_nameN</span><span class="special">)</span></tt>
        pairs declare the type and names of each of the struct members that will
        be part of the sequence.
      </p>
<p>
        The macro should be used at global scope, and <tt class="computeroutput"><span class="identifier">struct_name</span></tt>
        should be the fully namespace qualified name of the struct to be converted.
      </p>
<<<<<<< .working
<a name="fusion.adapted.adapt_struct.header"></a><h4>
<a name="id533884"></a>
        <a href="adapt_struct.html#fusion.adapted.adapt_struct.header">Header</a>
      </h4>
=======
<a name="fusion.adapted.adapt_struct.header"></a><h5>
<a name="id741173"></a>
        <a class="link" href="adapt_struct.html#fusion.adapted.adapt_struct.header">Header</a>
      </h5>
>>>>>>> .merge-right.r57125
<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special">&lt;</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">&gt;</span>
<span class="preprocessor">#include</span> <span class="special">&lt;</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">&gt;</span>
</pre>
<<<<<<< .working
<a name="fusion.adapted.adapt_struct.example"></a><h4>
<a name="id534049"></a>
        <a href="adapt_struct.html#fusion.adapted.adapt_struct.example">Example</a>
      </h4>
=======
<a name="fusion.adapted.adapt_struct.example"></a><h5>
<a name="id741288"></a>
        <a class="link" href="adapt_struct.html#fusion.adapted.adapt_struct.example">Example</a>
      </h5>
>>>>>>> .merge-right.r57125
<pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">demo</span>
<span class="special">{</span>
    <span class="keyword">struct</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="identifier">name</span><span class="special">;</span>
        <span class="keyword">int</span> <span class="identifier">age</span><span class="special">;</span>
    <span class="special">};</span>
<span class="special">}</span>

<span class="comment">// demo::employee is now a Fusion sequence
</span><span class="identifier">BOOST_FUSION_ADAPT_STRUCT</span><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">std</span><span class="special">::</span><span class="identifier">string</span><span class="special">,</span> <span class="identifier">name</span><span class="special">)</span>
    <span class="special">(</span><span class="keyword">int</span><span class="special">,</span> <span class="identifier">age</span><span class="special">))</span>
</pre>
</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 © 2001-2007 Joel de Guzman, Dan Marsden, Tobias
      Schwinger<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__tuple.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../adapted.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="adapt_assoc.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>