boostorg/preprocessor
1
0
Fork 1
mirror of https://github.com/boostorg/preprocessor.git synced 2025-07-29 11:47:14 +02:00
Code Issues Packages Projects Releases Wiki Activity

lib cleanup

Browse Source 
[SVN r15693]
This commit is contained in:
Paul Mensonides
2002-10-03 22:13:37 +00:00
parent ae584c68b2
commit 4bb690a819
263 changed files with 14965 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

90
doc/ref/relative_iteration.html Normal file
View File

@ -0,0 +1,90 @@
<html>
<head>
<title>BOOST_PP_RELATIVE_ITERATION</title>
<link rel="stylesheet" type="text/css" href="../styles.css">
</head>
<body>
<div style="margin-left: 0px;">
The <b>BOOST_PP_RELATIVE_ITERATION</b> macro expands to the iteration value of a <i>file-iteration</i> depth relative to the current depth.
</div>
<h4>Usage</h4>
<div class="code">
<b>BOOST_PP_RELATIVE_ITERATION</b>(<i>i</i>)
</div>
<h4>Arguments</h4>
<dl>
<dt>i</dt>
<dd>
The relative depth of the frame whose iteration value is to be retreived.&nbsp;
Valid values range from <i>0</i> to <b>BOOST_PP_ITERATION_DEPTH</b>() - <i>1</i>.
</dd>
</dl>
<h4>Remarks</h4>
<div>
This macro is only valid when a <i>file-iteration</i> is in progress.
</div>
<div>
The argument <i>i</i> is interpreted as the number of frames <i>outward</i> from the current frame.&nbsp;
Therefore, <b>BOOST_PP_RELATIVE_ITERATION</b>(<i>0</i>) is equivalent to <b>BOOST_PP_ITERATION</b>().
</div>
<h4>Requirements</h4>
<div>
<b>Header:</b> &nbsp;<a href="../headers/iteration/iterate.hpp.html">&lt;boost/preprocessor/iteration/iterate.hpp&gt;</a>
</div>
<h4>Sample Code</h4>
<div><pre>
// file.h
#if !<a href="is_iterating.html">BOOST_PP_IS_ITERATING</a>
#ifndef FILE_H_
#define FILE_H_
#include &lt;<a href="../headers/iteration/iterate.hpp.html">boost/preprocessor/iteration/iterate.hpp</a>&gt;
1st iteration:
#define <a href="iteration_params_x.html">BOOST_PP_ITERATION_PARAMS_1</a> (4, (0, 3, "file.h", 0x0001))
#include <a href="iterate.html">BOOST_PP_ITERATE</a>()
2nd iteration:
#define <a href="iteration_params_x.html">BOOST_PP_ITERATION_PARAMS_1</a> (4, (1, 10, "file.h", 0x0002))
#include <a href="iterate.html">BOOST_PP_ITERATE</a>()
#endif
#elif <a href="iteration_depth.html">BOOST_PP_ITERATION_DEPTH</a>() == 1 \
&amp;&amp; <a href="iteration_flags.html">BOOST_PP_ITERATION_FLAGS</a>() == 0x0001 \
/**/
--
#define <a href="iteration_params_x.html">BOOST_PP_ITERATION_PARAMS_2</a> (3, (1, 10, "file.h"))
#include <a href="iterate.html">BOOST_PP_ITERATE</a>()
#elif <a href="iteration_depth.html">BOOST_PP_ITERATION_DEPTH</a>() == 1 \
&amp;&amp; <a href="iteration_flags.html">BOOST_PP_ITERATION_FLAGS</a>() == 0x0002 \
/**/
--
#define <a href="iteration_params_x.html">BOOST_PP_ITERATION_PARAMS_2</a> \
(3, (1, <a href="iteration.html">BOOST_PP_ITERATION</a>(), "file.h")) \
/**/
#include <a href="iterate.html">BOOST_PP_ITERATE</a>()
#elif <a href="iteration_depth.html">BOOST_PP_ITERATION_DEPTH</a>() == 2 \
&amp;&amp; <a href="frame_flags.html">BOOST_PP_FRAME_FLAGS</a>(1) == 0x0001 \
/**/
--
#define <a href="iteration_params_x.html">BOOST_PP_ITERATION_PARAMS_3</a> \
(3, (1, <a href="iteration.html">BOOST_PP_ITERATION</a>(), "file.h")) \
/**/
#include <a href="iterate.html">BOOST_PP_ITERATE</a>()
#else // used by both
previous: <a href="relative_iteration.html">BOOST_PP_RELATIVE_ITERATION</a>(1)
current: <a href="iteration.html">BOOST_PP_ITERATION</a>()
#endif
</pre></div>
</body>
</html>