<html> <head> <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> <title>Macro BOOST_PROTO_LOCAL_ITERATE</title> <link rel="stylesheet" href="boostbook.css" type="text/css"> <meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> <link rel="home" href="index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="proto/reference.html#header.boost.proto.repeat_hpp" title="Header <boost/proto/repeat.hpp>"> <link rel="prev" href="BOOST_PROTO_REPEAT_FROM_TO_EX.html" title="Macro BOOST_PROTO_REPEAT_FROM_TO_EX"> <link rel="next" href="BOOST_PROTO_typename_A.html" title="Macro BOOST_PROTO_typename_A"> </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="../../libs/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_PROTO_REPEAT_FROM_TO_EX.html"><img src="../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="proto/reference.html#header.boost.proto.repeat_hpp"><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="BOOST_PROTO_typename_A.html"><img src="../../doc/html/images/next.png" alt="Next"></a> </div> <div class="refentry" title="Macro BOOST_PROTO_LOCAL_ITERATE"> <a name="BOOST_PROTO_LOCAL_ITERATE"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Macro BOOST_PROTO_LOCAL_ITERATE</span></h2> <p>BOOST_PROTO_LOCAL_ITERATE — Vertical repetition of a user-supplied macro.</p> </div> <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="emphasis"><em>// In header: <<a class="link" href="proto/reference.html#header.boost.proto.repeat_hpp" title="Header <boost/proto/repeat.hpp>">boost/proto/repeat.hpp</a>> </em></span>BOOST_PROTO_LOCAL_ITERATE()</pre></div> <div class="refsect1" title="Description"> <a name="id1630976"></a><h2>Description</h2> <p> <code class="computeroutput">BOOST_PROTO_LOCAL_ITERATE()</code> is used generate the kind of repetitive code that is typical of DSELs built with Proto. This macro causes the user-defined macro <code class="computeroutput">BOOST_PROTO_LOCAL_MACRO()</code> to be expanded with values in the range specified by <code class="computeroutput">BOOST_PROTO_LOCAL_LIMITS</code>. </p> <p> <span class="bold"><strong>Usage:</strong></span> </p> <p> </p> <pre class="programlisting">#include BOOST_PROTO_LOCAL_ITERATE()</pre> <p> </p> <p> <span class="bold"><strong>Example:</strong></span> </p> <p> </p> <pre class="programlisting">// Generate BOOST_PROTO_MAX_ARITY-1 overloads of the // following construct() function template. #define BOOST_PROTO_LOCAL_MACRO(N, typename_A, A_const_ref, A_const_ref_a, ref_a)\ template<typename T, typename_A(N)> \ typename <a class="link" href="boost/proto/result_of/make_expr.html" title="Struct template make_expr">proto::result_of::make_expr</a>< \ <a class="link" href="boost/proto/tag/function.html" title="Struct function">proto::tag::function</a> \ , construct_helper<T> \ , A_const_ref(N) \ >::type const \ construct(A_const_ref_a(N)) \ { \ return <a class="link" href="boost/proto/make_expr_id1241909.html" title="Function make_expr">proto::make_expr</a>< \ <a class="link" href="boost/proto/tag/function.html" title="Struct function">proto::tag::function</a> \ >( \ construct_helper<T>() \ , ref_a(N) \ ); \ } #define BOOST_PROTO_LOCAL_LIMITS (1, BOOST_PP_DEC(BOOST_PROTO_MAX_ARITY)) #include BOOST_PROTO_LOCAL_ITERATE()</pre> <p> </p> <p> The above inclusion of <code class="computeroutput">BOOST_PROTO_LOCAL_ITERATE()</code> will generate the following code: </p> <p> </p> <pre class="programlisting">template<typename T, typename A0> typename <a class="link" href="boost/proto/result_of/make_expr.html" title="Struct template make_expr">proto::result_of::make_expr</a>< <a class="link" href="boost/proto/tag/function.html" title="Struct function">proto::tag::function</a> , construct_helper<T> , A0 const & >::type const construct(A0 const & a0) { return <a class="link" href="boost/proto/make_expr_id1241909.html" title="Function make_expr">proto::make_expr</a>< <a class="link" href="boost/proto/tag/function.html" title="Struct function">proto::tag::function</a> >( construct_helper<T>() , boost::ref(a0) ); } template<typename T, typename A0, typename A1> typename <a class="link" href="boost/proto/result_of/make_expr.html" title="Struct template make_expr">proto::result_of::make_expr</a>< <a class="link" href="boost/proto/tag/function.html" title="Struct function">proto::tag::function</a> , construct_helper<T> , A0 const & , A1 const & >::type const construct(A0 const & a0, A1 const & a1) { return <a class="link" href="boost/proto/make_expr_id1241909.html" title="Function make_expr">proto::make_expr</a>< <a class="link" href="boost/proto/tag/function.html" title="Struct function">proto::tag::function</a> >( construct_helper<T>() , boost::ref(a0) , boost::ref(a1) ); } // ... and so on, up to BOOST_PROTO_MAX_ARITY-1 arguments ...</pre> <p> </p> <p> If <code class="computeroutput">BOOST_PROTO_LOCAL_LIMITS</code> is not defined by the user, it defaults to <code class="computeroutput">(1, BOOST_PROTO_MAX_ARITY)</code>. </p> <p> At each iteration, <code class="computeroutput">BOOST_PROTO_LOCAL_MACRO()</code> is invoked with the current iteration number and the following 4 macro parameters: </p> <div class="itemizedlist"><ul class="itemizedlist" type="disc"> <li class="listitem"><code class="computeroutput">BOOST_PROTO_LOCAL_typename_A</code></li> <li class="listitem"><code class="computeroutput">BOOST_PROTO_LOCAL_A</code></li> <li class="listitem"><code class="computeroutput">BOOST_PROTO_LOCAL_A_a</code></li> <li class="listitem"><code class="computeroutput">BOOST_PROTO_LOCAL_a</code></li> </ul></div> <p> If these macros are not defined by the user, they default respectively to: </p> <div class="itemizedlist"><ul class="itemizedlist" type="disc"> <li class="listitem"><code class="computeroutput"><a class="link" href="BOOST_PROTO_typename_A.html" title="Macro BOOST_PROTO_typename_A">BOOST_PROTO_typename_A</a></code></li> <li class="listitem"><code class="computeroutput"><a class="link" href="BOOST_PROTO_A_const_ref.html" title="Macro BOOST_PROTO_A_const_ref">BOOST_PROTO_A_const_ref</a></code></li> <li class="listitem"><code class="computeroutput"><a class="link" href="BOOST_PROTO_A_const_ref_a.html" title="Macro BOOST_PROTO_A_const_ref_a">BOOST_PROTO_A_const_ref_a</a></code></li> <li class="listitem"><code class="computeroutput"><a class="link" href="BOOST_PROTO_ref_a.html" title="Macro BOOST_PROTO_ref_a">BOOST_PROTO_ref_a</a></code></li> </ul></div> <p> </p> <p> After including <code class="computeroutput">BOOST_PROTO_LOCAL_ITERATE()</code>, the following macros are automatically undefined: </p> <div class="itemizedlist"><ul class="itemizedlist" type="disc"> <li class="listitem"><code class="computeroutput">BOOST_PROTO_LOCAL_MACRO</code></li> <li class="listitem"><code class="computeroutput">BOOST_PROTO_LOCAL_LIMITS</code></li> <li class="listitem"><code class="computeroutput">BOOST_PROTO_LOCAL_typename_A</code></li> <li class="listitem"><code class="computeroutput">BOOST_PROTO_LOCAL_A</code></li> <li class="listitem"><code class="computeroutput">BOOST_PROTO_LOCAL_A_a</code></li> <li class="listitem"><code class="computeroutput">BOOST_PROTO_LOCAL_a</code></li> </ul></div> <p> </p> </div> </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 © 2008 Eric Niebler<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_PROTO_REPEAT_FROM_TO_EX.html"><img src="../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="proto/reference.html#header.boost.proto.repeat_hpp"><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="BOOST_PROTO_typename_A.html"><img src="../../doc/html/images/next.png" alt="Next"></a> </div> </body> </html>