boostorg/preprocessor
1
0
Fork 1
mirror of https://github.com/boostorg/preprocessor.git synced 2025-07-30 20:27:13 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'develop'

Browse Source
This commit is contained in:
Edward Diener
2014-04-01 00:43:06 -04:00
parent 7cb46e03ea 91fb925e1c
commit 81302d1e69
6 changed files with 395 additions and 244 deletions
Download Patch File Download Diff File Expand all files Collapse all files

160
doc/ref/for_r.html
View File

@ -1,75 +1,68 @@
<html> <html>
<head> <head>
<title>BOOST_PP_FOR_r</title> <meta content="text/html; charset=windows-1252" http-equiv="content-type">
<link rel="stylesheet" type="text/css" href="../styles.css"> <title>BOOST_PP_FOR_r</title>
</head> <link rel="stylesheet" type="text/css" href="../styles.css">
<body> </head>
<div style="margin-left: 0px;"> <body>
The <b>BOOST_PP_FOR_<i>r</i></b> macro represents a reentry into the <b>BOOST_PP_FOR</b> repetition construct. <div style="margin-left: 0px;"> The <b>BOOST_PP_FOR_<i>r</i></b> macro
</div> represents a reentry into the <b>BOOST_PP_FOR</b> repetition construct. </div>
<h4>Usage</h4> <h4>Usage</h4>
<div class="code"> <div class="code"> <b>BOOST_PP_FOR_</b> ## <i>r</i>(<i>state</i>, <i>pred</i>,
<b>BOOST_PP_FOR_</b> ## <i>r</i>(<i>state</i>, <i>pred</i>, <i>op</i>, <i>macro</i>) <i>op</i>, <i>macro</i>) </div>
</div> <h4>Arguments</h4>
<h4>Arguments</h4> <dl>
<dl> <dt>r</dt>
<dt>r</dt> <dd> The next available <b>BOOST_PP_FOR</b> repetition. </dd>
<dd> <dt>state</dt>
The next available <b>BOOST_PP_FOR</b> repetition. <dd> The initial state. </dd>
</dd> <dt>pred</dt>
<dt>state</dt> <dd> A binary predicate of the form <i>pred</i>(<i>r</i>, <i>state</i>).&nbsp;
<dd> This macro must expand to an integer in the range of <i>0</i> to <b>BOOST_PP_LIMIT_MAG</b>.&nbsp;
The initial state. <b>BOOST_PP_FOR</b> repeatedly expands <i>macro</i> while this
</dd> predicate returns non-zero.&nbsp; This macro is called with the next
<dt>pred</dt> available <b>BOOST_PP_FOR</b> repetition and the current <i>state</i>.
<dd> </dd>
A binary predicate of the form <i>pred</i>(<i>r</i>, <i>state</i>).&nbsp; <dt>op</dt>
This macro must expand to an integer in the range of <i>0</i> to <b>BOOST_PP_LIMIT_MAG</b>.&nbsp; <dd> A binary operation of the form <i>op</i>(<i>r</i>, <i>state</i>).&nbsp;
<b>BOOST_PP_FOR</b> repeatedly expands <i>macro</i> while this predicate returns non-zero.&nbsp; This operation is expanded by <b>BOOST_PP_FOR</b> with the next
This macro is called with the next available <b>BOOST_PP_FOR</b> repetition and the current <i>state</i>. available <b>BOOST_PP_FOR</b> repetition and the current <i>state</i>.&nbsp;
</dd> This macro is repeatedly applied to the <i>state</i>, each time
<dt>op</dt> producing a new <i>state</i>, until <i>pred</i> returns <i>0</i>. </dd>
<dd> <dt>macro</dt>
A binary operation of the form <i>op</i>(<i>r</i>, <i>state</i>).&nbsp; <dd> A binary macro of the form <i>macro</i>(<i>r</i>, <i>state</i>).&nbsp;
This operation is expanded by <b>BOOST_PP_FOR</b> with the next available <b>BOOST_PP_FOR</b> repetition and the current <i>state</i>.&nbsp; This macro is expanded by <b>BOOST_PP_FOR</b> with the next available <b>BOOST_PP_FOR</b>
This macro is repeatedly applied to the <i>state</i>, each time producing a new <i>state</i>, until <i>pred</i> returns <i>0</i>. repetition and the current <i>state</i>.&nbsp; This macro is is
</dd> repeated by <b>BOOST_PP_FOR</b> until <i>pred</i> returns <i>0</i>. </dd>
<dt>macro</dt> </dl>
<dd> <h4>Remarks</h4>
A binary macro of the form <i>macro</i>(<i>r</i>, <i>state</i>).&nbsp; <div> This macro expands to the sequence:
This macro is expanded by <b>BOOST_PP_FOR</b> with the next available <b>BOOST_PP_FOR</b> repetition and the current <i>state</i>.&nbsp; <div> <i>macro</i>(<i>r</i>, <i>state</i>) <i>macro</i>(<i>r</i>, <i>op</i>(<i>r</i>,
This macro is is repeated by <b>BOOST_PP_FOR</b> until <i>pred</i> returns <i>0</i>. <i>state</i>)) ... <i>macro</i>(<i>r</i>, <i>op</i>(<i>r</i>, ... <i>op</i>(<i>r</i>,
</dd> <i>state</i>) ... )) </div>
</dl> </div>
<h4>Remarks</h4> <div> At certain times, it may be necessary to perform the concatenation
<div> with <b>BOOST_PP_CAT</b> rather than the preprocessor token-pasting
This macro expands to the sequence: operator.&nbsp; This happens when the <i>r</i> value is a macro
<div> invocation itself.&nbsp; It needs a delay to allow it to expand.&nbsp; The
<i>macro</i>(<i>r</i>, <i>state</i>) <i>macro</i>(<i>r</i>, <i>op</i>(<i>r</i>, <i>state</i>)) ... <i>macro</i>(<i>r</i>, <i>op</i>(<i>r</i>, ... <i>op</i>(<i>r</i>, <i>state</i>) ... )) syntax in such a scenario becomes:
</div> <div> <b>BOOST_PP_CAT</b>(<b>BOOST_PP_FOR_</b>, <i>r</i>)(<i>state</i>,
</div> <i>pred</i>, <i>op</i>, <i>macro</i>) </div>
<div> </div>
At certain times, it may be necessary to perform the concatenation with <b>BOOST_PP_CAT</b> rather than the preprocessor token-pasting operator.&nbsp; <h4>See Also</h4>
This happens when the <i>r</i> value is a macro invocation itself.&nbsp; <ul>
It needs a delay to allow it to expand.&nbsp; <li><a href="cat.html">BOOST_PP_CAT</a></li>
The syntax in such a scenario becomes: <li><a href="for.html">BOOST_PP_FOR</a></li>
<div> <li><a href="limit_mag.html">BOOST_PP_LIMIT_MAG</a></li>
<b>BOOST_PP_CAT</b>(<b>BOOST_PP_FOR_</b>, <i>r</i>)(<i>state</i>, <i>pred</i>, <i>op</i>, <i>macro</i>) <li><a href="for_r_macros.html"><span style="color: gray;">Macros with R
</div> re-entrancy forms</span></a></li>
</div> </ul>
<h4>See Also</h4> <h4>Requirements</h4>
<ul> <div> <b>Header:</b> &nbsp;<a href="../headers/repetition/for.html">&lt;boost/preprocessor/repetition/for.hpp&gt;</a>
<li><a href="cat.html">BOOST_PP_CAT</a></li> </div>
<li><a href="for.html">BOOST_PP_FOR</a></li> <h4>Sample Code</h4>
<li><a href="limit_mag.html">BOOST_PP_LIMIT_MAG</a></li> <div>
</ul> <pre>#include &lt;<a href="../headers/arithmetic/dec.html">boost/preprocessor/arithmetic/dec.hpp</a>&gt;
<h4>Requirements</h4>
<div>
<b>Header:</b> &nbsp;<a href="../headers/repetition/for.html">&lt;boost/preprocessor/repetition/for.hpp&gt;</a>
</div>
<h4>Sample Code</h4>
<div><pre>
#include &lt;<a href="../headers/arithmetic/dec.html">boost/preprocessor/arithmetic/dec.hpp</a>&gt;
#include &lt;<a href="../headers/arithmetic/inc.html">boost/preprocessor/arithmetic/inc.hpp</a>&gt; #include &lt;<a href="../headers/arithmetic/inc.html">boost/preprocessor/arithmetic/inc.hpp</a>&gt;
#include &lt;<a href="../headers/comparison/not_equal.html">boost/preprocessor/comparison/not_equal.hpp</a>&gt; #include &lt;<a href="../headers/comparison/not_equal.html">boost/preprocessor/comparison/not_equal.hpp</a>&gt;
#include &lt;<a href="../headers/punctuation/comma_if.html">boost/preprocessor/punctuation/comma_if.hpp</a>&gt; #include &lt;<a href="../headers/punctuation/comma_if.html">boost/preprocessor/punctuation/comma_if.hpp</a>&gt;
@ -140,16 +133,17 @@ TEMPLATE_TEMPLATE(2, 4, T)
template&lt;class, class, class, class&gt; class T4 template&lt;class, class, class, class&gt; class T4
*/ */
</pre></div> </pre></div>
<hr size="1"> <hr size="1">
<div style="margin-left: 0px;"> <div style="margin-left: 0px;"> <i><EFBFBD> Copyright <a href="http://www.housemarque.com"
<i><EFBFBD> Copyright <a href="http://www.housemarque.com" target="_top">Housemarque Oy</a> 2002</i>
</br><i><EFBFBD> Copyright Paul Mensonides 2002</i> target="_top">Housemarque Oy</a> 2002</i> <br>
</div> <i><EFBFBD> Copyright Paul Mensonides 2002<br>
<div style="margin-left: 0px;"> </i><i><EFBFBD> Copyright Edward Diener 2014</i><br>
<p><small>Distributed under the Boost Software License, Version 1.0. (See </div>
accompanying file <a href="../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or <div style="margin-left: 0px;">
copy at <a href= <p><small>Distributed under the Boost Software License, Version 1.0. (See
"http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</small></p> accompanying file <a href="../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a>
</div> or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</small></p>
</body> </div>
</body>
</html> </html>

44
doc/ref/for_r_macros.html Normal file
View File

@ -0,0 +1,44 @@
<html>
<head>
<meta content="text/html; charset=windows-1252" http-equiv="content-type">
<title>BOOST_PP_FOR_r_macros</title>
<link rel="stylesheet" type="text/css" href="../styles.css">
</head>
<body>This is a list, based on functionality, of the macros which have an
alternate <b>_<i>r</i></b> name, representing a reentry into the <b>BOOST_PP_FOR</b>
looping construct:
<p>repetition</p>
<ul>
<li><a href="deduce_r.html">BOOST_PP_DEDUCE_R</a></li>
</ul>
list<br>
<ul>
<li><a href="list_enum_r.html">BOOST_PP_LIST_ENUM_R</a></li>
<li><a href="list_for_each_i_r.html">BOOST_PP_LIST_FOR_EACH_I_R</a></li>
<li><a href="list_for_each_product_r.html">BOOST_PP_LIST_FOR_EACH_PRODUCT_R</a></li>
<li><a href="list_for_each_r.html">BOOST_PP_LIST_FOR_EACH_R</a></li>
<li><a href="list_to_seq_r.html">BOOST_PP_LIST_TO_SEQ_R</a></li>
<li><a href="list_to_tuple_r.html">BOOST_PP_LIST_TO_TUPLE_R</a></li>
</ul>
seq<br>
<ul>
<li><a href="seq_for_each_product_r.html">BOOST_PP_SEQ_FOR_EACH_PRODUCT_R</a></li>
<li><a href="seq_for_each_r.html">BOOST_PP_SEQ_FOR_EACH_R</a></li>
</ul>
base<br>
<ul>
<li><a href="for_r.html">BOOST_PP_FOR_R</a><br>
</li>
</ul>
<br>
<ul>
</ul>
<hr size="1">
<div style="margin-left: 0px;"> <i><EFBFBD> Copyright Edward Diener 2014</i> </div>
<div style="margin-left: 0px;">
<p><small>Distributed under the Boost Software License, Version 1.0. (See
accompanying file <a href="../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a>
or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</small></p>
</div>
</body>
</html>

143
doc/ref/repeat_z.html
View File

@ -1,67 +1,59 @@
<html> <html>
<head> <head>
<title>BOOST_PP_REPEAT_z</title> <meta content="text/html; charset=windows-1252" http-equiv="content-type">
<link rel="stylesheet" type="text/css" href="../styles.css"> <title>BOOST_PP_REPEAT_z</title>
</head> <link rel="stylesheet" type="text/css" href="../styles.css">
<body> </head>
<div style="margin-left: 0px;"> <body>
The <b>BOOST_PP_REPEAT_<i>z</i></b> macro represents a reentry into the <b>BOOST_PP_REPEAT</b> repetition construct. <div style="margin-left: 0px;"> The <b>BOOST_PP_REPEAT_<i>z</i></b> macro
</div> represents a reentry into the <b>BOOST_PP_REPEAT</b> repetition
<h4>Usage</h4> construct. </div>
<div class="code"> <h4>Usage</h4>
<b>BOOST_PP_REPEAT_</b> ## <i>z</i>(<i>count</i>, <i>macro</i>, <i>data</i>) <div class="code"> <b>BOOST_PP_REPEAT_</b> ## <i>z</i>(<i>count</i>, <i>macro</i>,
</div> <i>data</i>) </div>
<h4>Arguments</h4> <h4>Arguments</h4>
<dl> <dl>
<dt>z</dt> <dt>z</dt>
<dd> <dd> The next available <b>BOOST_PP_REPEAT</b> dimension. </dd>
The next available <b>BOOST_PP_REPEAT</b> dimension. <dt>count</dt>
</dd> <dd> The number of repetitious calls to <i>macro</i>.&nbsp; Valid values
<dt>count</dt> range from <i>0</i> to <b>BOOST_PP_LIMIT_REPEAT</b>. </dd>
<dd> <dt>macro</dt>
The number of repetitious calls to <i>macro</i>.&nbsp; <dd> A ternary operation of the form <i>macro</i>(<i>z</i>, <i>n</i>, <i>data</i>).&nbsp;
Valid values range from <i>0</i> to <b>BOOST_PP_LIMIT_REPEAT</b>. This macro is expanded by <b>BOOST_PP_REPEAT</b> with the next
</dd> available repetition depth, the current repetition number, and the
<dt>macro</dt> auxiliary <i>data</i> argument.&nbsp; </dd>
<dd> <dt>data</dt>
A ternary operation of the form <i>macro</i>(<i>z</i>, <i>n</i>, <i>data</i>).&nbsp; <dd> Auxiliary data passed to <i>macro</i>. </dd>
This macro is expanded by <b>BOOST_PP_REPEAT</b> with the next available repetition depth, </dl>
the current repetition number, and the auxiliary <i>data</i> argument.&nbsp; <h4>Remarks</h4>
</dd> <div> This macro expands to the sequence:
<dt>data</dt> <div> <i>macro</i>(<i>z</i>, <i>0</i>, <i>data</i>) <i>macro</i>(<i>z</i>,
<dd> <i>1</i>, <i>data</i>) ... <i>macro</i>(<i>z</i>, <i>count</i> - <i>1</i>,
Auxiliary data passed to <i>macro</i>. <i>data</i>) </div>
</dd> </div>
</dl> <div> At certain times, it may be necessary to perform the concatenation
<h4>Remarks</h4> with <b>BOOST_PP_CAT</b> rather than the preprocessor token-pasting
<div> operator.&nbsp; This happens when the <i>z</i> value is a macro
This macro expands to the sequence: invocation itself.&nbsp; It needs a delay to allow it to expand.&nbsp; The
<div> syntax in such a scenario becomes:
<i>macro</i>(<i>z</i>, <i>0</i>, <i>data</i>) <i>macro</i>(<i>z</i>, <i>1</i>, <i>data</i>) ... <i>macro</i>(<i>z</i>, <i>count</i> - <i>1</i>, <i>data</i>) <div> <b>BOOST_PP_CAT</b>(<b>BOOST_PP_REPEAT_</b>, <i>z</i>)(<i>count</i>,
</div> <i>macro</i>, <i>data</i>) </div>
</div> </div>
<div> <h4>See Also</h4>
At certain times, it may be necessary to perform the concatenation with <b>BOOST_PP_CAT</b> rather than the preprocessor token-pasting operator.&nbsp; <ul>
This happens when the <i>z</i> value is a macro invocation itself.&nbsp; <li><a href="cat.html">BOOST_PP_CAT</a></li>
It needs a delay to allow it to expand.&nbsp; <li><a href="limit_repeat.html">BOOST_PP_LIMIT_REPEAT</a></li>
The syntax in such a scenario becomes: <li><a href="repeat.html">BOOST_PP_REPEAT</a></li>
<div> <li><a href="repeat_z_macros.html"><span style="color: gray;">Macros with
<b>BOOST_PP_CAT</b>(<b>BOOST_PP_REPEAT_</b>, <i>z</i>)(<i>count</i>, <i>macro</i>, <i>data</i>) Z re-entrancy forms</span></a></li>
</div> </ul>
</div> <h4>Requirements</h4>
<h4>See Also</h4> <div> <b>Header:</b> &nbsp;<a href="../headers/repetition/repeat.html">&lt;boost/preprocessor/repetition/repeat.hpp&gt;</a>
<ul> </div>
<li><a href="cat.html">BOOST_PP_CAT</a></li> <h4>Sample Code</h4>
<li><a href="limit_repeat.html">BOOST_PP_LIMIT_REPEAT</a></li> <div>
<li><a href="repeat.html">BOOST_PP_REPEAT</a></li> <pre>#include &lt;<a href="../headers/arithmetic/inc.html">boost/preprocessor/arithmetic/inc.hpp</a>&gt;
</ul>
<h4>Requirements</h4>
<div>
<b>Header:</b> &nbsp;<a href="../headers/repetition/repeat.html">&lt;boost/preprocessor/repetition/repeat.hpp&gt;</a>
</div>
<h4>Sample Code</h4>
<div><pre>
#include &lt;<a href="../headers/arithmetic/inc.html">boost/preprocessor/arithmetic/inc.hpp</a>&gt;
#include &lt;<a href="../headers/punctuation/comma_if.html">boost/preprocessor/punctuation/comma_if.hpp</a>&gt; #include &lt;<a href="../headers/punctuation/comma_if.html">boost/preprocessor/punctuation/comma_if.hpp</a>&gt;
#include &lt;<a href="../headers/repetition/repeat.html">boost/preprocessor/repetition/repeat.hpp</a>&gt; #include &lt;<a href="../headers/repetition/repeat.html">boost/preprocessor/repetition/repeat.hpp</a>&gt;
@ -85,16 +77,17 @@
template&lt;class, class, class&gt; class T2 template&lt;class, class, class&gt; class T2
*/ */
</pre></div> </pre></div>
<hr size="1"> <hr size="1">
<div style="margin-left: 0px;"> <div style="margin-left: 0px;"> <i><EFBFBD> Copyright <a href="http://www.housemarque.com"
<i><EFBFBD> Copyright <a href="http://www.housemarque.com" target="_top">Housemarque Oy</a> 2002</i>
</br><i><EFBFBD> Copyright Paul Mensonides 2002</i> target="_top">Housemarque Oy</a> 2002</i> <br>
</div> <i><EFBFBD> Copyright Paul Mensonides 2002<br>
<div style="margin-left: 0px;"> </i><i><EFBFBD> Copyright Edward Diener 2014</i><br>
<p><small>Distributed under the Boost Software License, Version 1.0. (See </div>
accompanying file <a href="../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or <div style="margin-left: 0px;">
copy at <a href= <p><small>Distributed under the Boost Software License, Version 1.0. (See
"http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</small></p> accompanying file <a href="../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a>
</div> or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</small></p>
</body> </div>
</body>
</html> </html>

45
doc/ref/repeat_z_macros.html Normal file
View File

@ -0,0 +1,45 @@
<html>
<head>
<meta content="text/html; charset=windows-1252" http-equiv="content-type">
<title>BOOST_PP_REPEAT_z_macros</title>
<link rel="stylesheet" type="text/css" href="../styles.css">
</head>
<body>This is a list, based on functionality, of the macros which have an
alternate <b>_z<i></i></b> name, representing a reentry into the <b>BOOST_PP_REPEAT</b>
looping construct:<br>
<br>
array<br>
<ul>
<li><a href="array_pop_back_z.html">BOOST_PP_ARRAY_POP_BACK_Z</a></li>
<li><a href="array_pop_front_z.html">BOOST_PP_ARRAY_POP_FRONT_Z</a></li>
</ul>
repetition<br>
<ul>
<li><a href="deduce_z.html">BOOST_PP_DEDUCE_Z</a></li>
<li><a href="enum_binary_params_z.html">BOOST_PP_ENUM_BINARY_PARAMS_Z</a></li>
<li><a href="enum_params_z.html">BOOST_PP_ENUM_PARAMS_Z</a></li>
<li><a href="esbpz.html">BOOST_PP_ENUM_SHIFTED_BINARY_PARAMS_Z</a></li>
<li><a href="enum_shifted_params_z.html">BOOST_PP_ENUM_SHIFTED_PARAMS_Z</a></li>
<li><a href="enum_shifted_z.html">BOOST_PP_ENUM_SHIFTED_<i>z</i></a></li>
<li><a href="etbpz.html">BOOST_PP_ENUM_TRAILING_BINARY_PARAMS_Z</a></li>
<li><a href="enum_trailing_params_z.html">BOOST_PP_ENUM_TRAILING_PARAMS_Z</a></li>
<li><a href="enum_trailing_z.html">BOOST_PP_ENUM_TRAILING_<i>z</i></a></li>
<li><a href="enum_z.html">BOOST_PP_ENUM_<i>z</i></a></li>
<li><a href="repeat_from_to_d_z.html">BOOST_PP_REPEAT_FROM_TO_D_<i>z</i></a></li>
<li><a href="repeat_from_to_z.html">BOOST_PP_REPEAT_FROM_TO_<i>z</i></a></li>
</ul>
base<br>
<ul>
<li><a href="repeat_z.html">BOOST_PP_REPEAT_<i>z</i></a></li>
</ul>
<br>
<pre></pre>
<hr size="1">
<div style="margin-left: 0px;"> <i><EFBFBD> Copyright Edward Diener 2014</i> </div>
<div style="margin-left: 0px;">
<p><small>Distributed under the Boost Software License, Version 1.0. (See
accompanying file <a href="../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a>
or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</small></p>
</div>
</body>
</html>

161
doc/ref/while_d.html
View File

@ -1,78 +1,66 @@
<html> <html>
<head> <head>
<title>BOOST_PP_WHILE_d</title> <meta content="text/html; charset=windows-1252" http-equiv="content-type">
<link rel="stylesheet" type="text/css" href="../styles.css"> <title>BOOST_PP_WHILE_d</title>
</head> <link rel="stylesheet" type="text/css" href="../styles.css">
<body> </head>
<div style="margin-left: 0px;"> <body>
The <b>BOOST_PP_WHILE_<i>d</i></b> macro represents a reentry into the <b>BOOST_PP_WHILE</b> looping construct. <div style="margin-left: 0px;"> The <b>BOOST_PP_WHILE_<i>d</i></b> macro
</div> represents a reentry into the <b>BOOST_PP_WHILE</b> looping construct. </div>
<h4>Usage</h4> <h4>Usage</h4>
<div class="code"> <div class="code"> <b>BOOST_PP_WHILE_</b> ## <i>d</i>(<i>pred</i>, <i>op</i>,
<b>BOOST_PP_WHILE_</b> ## <i>d</i>(<i>pred</i>, <i>op</i>, <i>state</i>) <i>state</i>) </div>
</div> <h4>Arguments</h4>
<h4>Arguments</h4> <dl>
<dl> <dt>d</dt>
<dt>d</dt> <dd> The next available <b>BOOST_PP_WHILE</b> iteration. </dd>
<dd> <dt>pred</dt>
The next available <b>BOOST_PP_WHILE</b> iteration. <dd> A binary predicate of the form <i>pred</i>(<i>d</i>, <i>state</i>).&nbsp;
</dd> This predicate is expanded by <b>BOOST_PP_WHILE</b> with the next
<dt>pred</dt> available iteration <i>d</i> and the current <i>state</i>.&nbsp; This
<dd> predicate must expand to value in the range of <i>0</i> to <b>BOOST_PP_LIMIT_MAG</b>.
A binary predicate of the form <i>pred</i>(<i>d</i>, <i>state</i>).&nbsp; The construct continues to loop until this predicate returns <i>0</i>.&nbsp;
This predicate is expanded by <b>BOOST_PP_WHILE</b> with the next available When this predicate returns <i>0</i>, <b>BOOST_PP_WHILE</b> returns
iteration <i>d</i> and the current <i>state</i>.&nbsp; the current <i>state</i>. </dd>
This predicate must expand to value in the range of <i>0</i> to <b>BOOST_PP_LIMIT_MAG</b>. <dt>op</dt>
The construct continues to loop until this predicate returns <i>0</i>.&nbsp; <dd> A binary operation of the form <i>op</i>(<i>d</i>, <i>state</i>).&nbsp;
When this predicate returns <i>0</i>, <b>BOOST_PP_WHILE</b> returns the current <i>state</i>. This operation is expanded by <b>BOOST_PP_WHILE</b> with the next
</dd> available iteration <i>d</i> and the current <i>state</i>.&nbsp; This
<dt>op</dt> macro is repeatedly applied to the <i>state</i>, each time producing a
<dd> new <i>state</i>, until <i>pred</i> returns <i>0</i>. </dd>
A binary operation of the form <i>op</i>(<i>d</i>, <i>state</i>).&nbsp; <dt>state</dt>
This operation is expanded by <b>BOOST_PP_WHILE</b> with the next available <dd> The initial state.&nbsp; Often this argument is a <i>tuple</i>. </dd>
iteration <i>d</i> and the current <i>state</i>.&nbsp; </dl>
This macro is repeatedly applied to the <i>state</i>, each time producing a new <i>state</i>, until <i>pred</i> returns <i>0</i>. <h4>Remarks</h4>
</dd> <div> This macro iterates <i>op</i>(<i>d</i>, <i>state</i>) while <i>pred</i>(<i>d</i>,
<dt>state</dt> <i>state</i>) is non-zero.&nbsp; In other words expands to:
<dd> <div> <i>op</i>(<i>d</i>, ... <i>op</i>(<i>d</i>, <i>op</i>(<i>d</i>, <i>state</i>))
The initial state.&nbsp; ... ). </div>
Often this argument is a <i>tuple</i>. </div>
</dd> <div> At certain times, it may be necessary to perform the concatenation
</dl> with <b>BOOST_PP_CAT</b> rather than the preprocessor token-pasting
<h4>Remarks</h4> operator.&nbsp; This happens when the <i>d</i> value is a macro
<div> invocation itself.&nbsp; It needs a delay to allow it to expand.&nbsp; The
This macro iterates <i>op</i>(<i>d</i>, <i>state</i>) while <i>pred</i>(<i>d</i>, <i>state</i>) is non-zero.&nbsp; syntax in such a scenario becomes:
In other words expands to: <div> <b>BOOST_PP_CAT</b>(<b>BOOST_PP_WHILE_</b>, <i>d</i>)(<i>pred</i>,
<div> <i>op</i>, <i>state</i>). </div>
<i>op</i>(<i>d</i>, ... <i>op</i>(<i>d</i>, <i>op</i>(<i>d</i>, <i>state</i>)) ... ). </div>
</div> <div> Previously, it was possible to concatenate <i>d</i> directly to <b>BOOST_PP_WHILE</b>
</div> (without the trailing underscore).&nbsp; This is no longer supported. </div>
<div> <h4>See Also</h4>
At certain times, it may be necessary to perform the concatenation with <b>BOOST_PP_CAT</b> rather than the preprocessor token-pasting operator.&nbsp; <ul>
This happens when the <i>d</i> value is a macro invocation itself.&nbsp; <li><a href="cat.html">BOOST_PP_CAT</a></li>
It needs a delay to allow it to expand.&nbsp; <li><a href="limit_mag.html">BOOST_PP_LIMIT_MAG</a></li>
The syntax in such a scenario becomes: <li><a href="while.html">BOOST_PP_WHILE</a></li>
<div> <li><a href="while_d_macros.html"><span style="color: gray;">Macros with D
<b>BOOST_PP_CAT</b>(<b>BOOST_PP_WHILE_</b>, <i>d</i>)(<i>pred</i>, <i>op</i>, <i>state</i>). re-entrancy forms</span></a></li>
</div> </ul>
</div> <h4>Requirements</h4>
<div> <div> <b>Header:</b> &nbsp;<a href="../headers/control/while.html">&lt;boost/preprocessor/control/while.hpp&gt;</a>
Previously, it was possible to concatenate <i>d</i> directly to <b>BOOST_PP_WHILE</b> (without the trailing underscore).&nbsp; </div>
This is no longer supported. <h4>Sample Code</h4>
</div> <div>
<h4>See Also</h4> <pre>#include &lt;<a href="../headers/arithmetic/add.html">boost/preprocessor/arithmetic/add.hpp</a>&gt;
<ul>
<li><a href="cat.html">BOOST_PP_CAT</a></li>
<li><a href="limit_mag.html">BOOST_PP_LIMIT_MAG</a></li>
<li><a href="while.html">BOOST_PP_WHILE</a></li>
</ul>
<h4>Requirements</h4>
<div>
<b>Header:</b> &nbsp;<a href="../headers/control/while.html">&lt;boost/preprocessor/control/while.hpp&gt;</a>
</div>
<h4>Sample Code</h4>
<div><pre>
#include &lt;<a href="../headers/arithmetic/add.html">boost/preprocessor/arithmetic/add.hpp</a>&gt;
#include &lt;<a href="../headers/arithmetic/dec.html">boost/preprocessor/arithmetic/dec.hpp</a>&gt; #include &lt;<a href="../headers/arithmetic/dec.html">boost/preprocessor/arithmetic/dec.hpp</a>&gt;
#include &lt;<a href="../headers/array/elem.html">boost/preprocessor/array/elem.hpp</a>&gt; #include &lt;<a href="../headers/array/elem.html">boost/preprocessor/array/elem.hpp</a>&gt;
#include &lt;<a href="../headers/array/size.html">boost/preprocessor/array/size.hpp</a>&gt; #include &lt;<a href="../headers/array/size.html">boost/preprocessor/array/size.hpp</a>&gt;
@ -114,16 +102,17 @@
ACCUMULATE_D(1, ARRAY)// expands to 10 ACCUMULATE_D(1, ARRAY)// expands to 10
</pre></div> </pre></div>
<hr size="1"> <hr size="1">
<div style="margin-left: 0px;"> <div style="margin-left: 0px;"> <i><EFBFBD> Copyright <a href="http://www.housemarque.com"
<i><EFBFBD> Copyright <a href="http://www.housemarque.com" target="_top">Housemarque Oy</a> 2002</i>
</br><i><EFBFBD> Copyright Paul Mensonides 2002</i> target="_top">Housemarque Oy</a> 2002</i> <br>
</div> <i><EFBFBD> Copyright Paul Mensonides 2002<br>
<div style="margin-left: 0px;"> </i><i><EFBFBD> Copyright Edward Diener 2014</i><br>
<p><small>Distributed under the Boost Software License, Version 1.0. (See </div>
accompanying file <a href="../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or <div style="margin-left: 0px;">
copy at <a href= <p><small>Distributed under the Boost Software License, Version 1.0. (See
"http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</small></p> accompanying file <a href="../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a>
</div> or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</small></p>
</body> </div>
</body>
</html> </html>

86
doc/ref/while_d_macros.html Normal file
View File

@ -0,0 +1,86 @@
<html>
<head>
<meta content="text/html; charset=windows-1252" http-equiv="content-type">
<title>BOOST_PP_WHILE_d_macros</title>
<link rel="stylesheet" type="text/css" href="../styles.css">
</head>
<body>This is a list, based on functionality, of the macros which have an
alternate <b>_<i>d</i></b> name, representing a reentry into the <b>BOOST_PP_WHILE</b>
looping construct:<br>
<br>
arithmetic<br>
<ul>
<li><a href="add_d.html"><span style="color: gray;">BOOST_PP_ADD_D</span></a></li>
<li><a href="div_d.html"><span style=" color: gray;">BOOST_PP_DIV_D</span></a></li>
<li><a href="file:///C:/Programming/VersionControl/modular-boost/libs/preprocessor/doc/ref/div_d.html"><span
style=" color: gray;"></span></a><a href="mod_d.html"><span style=" color: gray;">BOOST_PP_MOD_D</span></a></li>
<li><a href="file:///C:/Programming/VersionControl/modular-boost/libs/preprocessor/doc/ref/mod_d.html"><span
style=" color: gray;"></span></a><a href="mul_d.html"><span
style=" color: gray;">BOOST_PP_MUL_D</span></a></li>
<li><a href="file:///C:/Programming/VersionControl/modular-boost/libs/preprocessor/doc/ref/mul_d.html"><span
style=" color: gray;"></span></a><a href="sub_d.html"><span
style=" color: gray;">BOOST_PP_SUB_D</span></a></li>
</ul>
array<br>
<ul>
<li><a href="array_insert_d.html"><span style="color: gray;">BOOST_PP_ARRAY_INSERT_D</span></a></li>
<li><span style=" color: gray;"><a href="array_remove_d.html">BOOST_PP_ARRAY_REMOVE_D</a></span></li>
<li><a href="array_replace_d.html"><span style=" color: gray;">BOOST_PP_ARRAY_REPLACE_D</span></a></li>
</ul>
comparison<br>
<ul>
<li><a href="greater_d.html"><span style=" color: gray;">BOOST_PP_GREATER_D</span></a></li>
<li><a href="greater_equal_d.html"><span style=" color: gray;">BOOST_PP_GREATER_EQUAL_D</span></a></li>
<li><a href="less_d.html"><span style=" color: gray;">BOOST_PP_LESS_D</span></a></li>
<li><a href="less_equal_d.html"><span style=" color: gray;">BOOST_PP_LESS_EQUAL_D</span></a></li>
</ul>
control<br>
<ul>
<li><a href="deduce_d.html"><span style=" color: gray;">BOOST_PP_DEDUCE_D</span></a></li>
</ul>
list<br>
<ul>
</ul>
<ul>
<li><a href="list_append_d.html"><span style=" color: gray;">BOOST_PP_LIST_APPEND_D</span></a></li>
<li><a href="list_at_d.html"><span style=" color: gray;">BOOST_PP_LIST_AT_D</span></a></li>
<li><a href="list_cat_d.html"><span style=" color: gray;">BOOST_PP_LIST_CAT_D</span></a></li>
<li><a href="list_filter_d.html"><span style=" color: gray;">BOOST_PP_LIST_FILTER_D</span></a></li>
<li><a href="list_first_n_d.html"><span style=" color: gray;">BOOST_PP_LIST_FIRST_N_D</span></a></li>
<li><a href="list_fold_left_d.html"><span style=" color: gray;">BOOST_PP_LIST_FOLD_LEFT_d</span></a></li>
<li><a href="list_fold_right_d.html"><span style=" color: gray;">BOOST_PP_LIST_FOLD_RIGHT_d</span></a></li>
<li><a href="list_rest_n_d.html"><span style=" color: gray;">BOOST_PP_LIST_REST_N_D</span></a></li>
<li><a href="list_reverse_d.html"><span style=" color: gray;">BOOST_PP_LIST_REVERSE_D</span></a></li>
<li><a href="list_to_array_d.html"><span style=" color: gray;">BOOST_PP_LIST_TO_ARRAY_D</span></a></li>
<li><a href="list_transform_d.html"><span style=" color: gray;">BOOST_PP_LIST_TRANSFORM_D</span></a></li>
</ul>
selection<br>
<ul>
<li><a href="max_d.html"><span style=" color: gray;">BOOST_PP_MAX_D</span></a></li>
<li><a href="min_d.html"><span style=" color: gray;">BOOST_PP_MIN_D</span></a></li>
</ul>
repetition<br>
<ul>
<li><a href="repeat_from_to_d.html"><span style=" color: gray;">BOOST_PP_REPEAT_FROM_TO_D</span></a></li>
<li><a href="repeat_from_to_d_z.html"><span style=" color: gray;">BOOST_PP_REPEAT_FROM_TO_D_z</span></a></li>
</ul>
tuple<br>
<ul>
<li><a href="tuple_insert_d.html"><span style=" color: gray;">BOOST_PP_TUPLE_INSERT_D</span></a></li>
<li><a href="tuple_remove_d.html"><span style=" color: gray;">BOOST_PP_TUPLE_REMOVE_D</span></a></li>
<li><a href="tuple_replace_d.html"><span style=" color: gray;">BOOST_PP_TUPLE_REPLACE_D</span></a></li>
</ul>
base<br>
<ul>
<li><a href="while_d.html"><span style=" color: gray;">BOOST_PP_WHILE_D</span></a></li>
</ul>
<br>
<hr size="1">
<div style="margin-left: 0px;"> <i><EFBFBD> Copyright Edward Diener 2014</i> </div>
<div style="margin-left: 0px;">
<p><small>Distributed under the Boost Software License, Version 1.0. (See
accompanying file <a href="../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a>
or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</small></p>
</div>
</body>
</html>