ceph/src/boost/libs/preprocessor/doc/ref/frame_iteration.html

   1 <html>
   2 <head>
   3         <title>BOOST_PP_FRAME_ITERATION</title>
   4         <link rel="stylesheet" type="text/css" href="../styles.css">
   5 </head>
   6 <body>
   7         <div style="margin-left:  0px;">
   8                 The <b>BOOST_PP_FRAME_ITERATION</b> macro expands to the iteration value of an absolute <i>file-iteration</i> depth.
   9         </div>
  10         <h4>Usage</h4>
  11                 <div class="code">
  12                         <b>BOOST_PP_FRAME_ITERATION</b>(<i>i</i>)
  13                 </div>
  14         <h4>Arguments</h4>
  15                 <dl>
  16                         <dt>i</dt>
  17                         <dd>
  18                                 The absolute depth of the frame whose iteration value is to be retreived.&nbsp;
  19                                 Valid values range from <i>1</i> to <b>BOOST_PP_ITERATION_DEPTH</b>().
  20                         </dd>
  21                 </dl>
  22         <h4>Remarks</h4>
  23                 <div>
  24                         This macro is only valid when a <i>file-iteration</i> is in progress.
  25                 </div>
  26         <h4>Requirements</h4>
  27                 <div>
  28                         <b>Header:</b> &nbsp;<a href="../headers/iteration/iterate.html">&lt;boost/preprocessor/iteration/iterate.hpp&gt;</a>
  29                 </div>
  30         <h4>Sample Code</h4>
  31 <div><pre>
  32 // file.h
  33 #if !<a href="is_iterating.html">BOOST_PP_IS_ITERATING</a>
  34
  35    #ifndef FILE_H_
  36    #define FILE_H_
  37
  38    #include &lt;<a href="../headers/iteration/iterate.html">boost/preprocessor/iteration/iterate.hpp</a>&gt;
  39
  40    #define <a href="iteration_params_x.html">BOOST_PP_ITERATION_PARAMS_1</a> (3, (1, 10, "file.h"))
  41    #include <a href="iterate.html">BOOST_PP_ITERATE</a>()
  42
  43    #endif
  44
  45 #elif <a href="iteration_depth.html">BOOST_PP_ITERATION_DEPTH</a>() == 1
  46
  47    --
  48    #define <a href="iteration_params_x.html">BOOST_PP_ITERATION_PARAMS_2</a> \
  49       (3, (1, <a href="iteration.html">BOOST_PP_ITERATION</a>(), "file.h"))   \
  50       /**/
  51
  52    #include <a href="iterate.html">BOOST_PP_ITERATE</a>()
  53
  54 #else
  55
  56    outer: <a href="frame_iteration.html">BOOST_PP_FRAME_ITERATION</a>(1)
  57    inner: <a href="frame_iteration.html">BOOST_PP_FRAME_ITERATION</a>(2)
  58
  59 #endif
  60 </pre></div>
  61         <hr size="1">
  62         <div style="margin-left: 0px;">
  63                 <i>© Copyright <a href="http://www.housemarque.com" target="_top">Housemarque Oy</a> 2002</i>
  64                 </br><i>© Copyright Paul Mensonides 2002</i>
  65         </div>
  66         <div style="margin-left: 0px;">
  67                 <p><small>Distributed under the Boost Software License, Version 1.0. (See
  68                 accompanying file <a href="../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or
  69                 copy at <a href=
  70                 "http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</small></p>
  71         </div>
  72 </body>
  73 </html>