summaryrefslogtreecommitdiff
path: root/libs/preprocessor/doc/ref/seq_for_each.html
blob: 1f22ff201f4b9b2b2e00468c6749ed34565b55ec (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
<html>
	<head>
		<title>BOOST_PP_SEQ_FOR_EACH</title>
		<link rel="stylesheet" type="text/css" href="../styles.css">
	</head>
	<body>
		<div style="margin-left:  0px;">
			The <b>BOOST_PP_SEQ_FOR_EACH</b> macro repeats a macro for each element in a <i>seq</i>.
		</div>
		<h4>
			Usage
		</h4>
		<div class="code">
			<b>BOOST_PP_SEQ_FOR_EACH</b>(<i>macro</i>, <i>data</i>, <i>seq</i>)
		</div>
		<h4>
			Arguments
		</h4>
		<dl>
			<dt>macro</dt>
			<dd>
				A ternary macro of the form <i>macro</i>(<i>r</i>, <i>data</i>, <i>elem</i>).&nbsp; 
				This macro is expanded by <b>BOOST_PP_SEQ_FOR_EACH</b> with each element in <i>seq</i>.&nbsp; 
				It is expanded with the next available <b>BOOST_PP_FOR</b> repetition, the 
				auxiliary <i>data</i>, and the current element.
			</dd>
			<dt>data</dt>
			<dd>
				Auxiliary data passed to <i>macro</i>.
			</dd>
			<dt>seq</dt>
			<dd>
				The <i>seq</i> for which <i>macro</i> will be invoked on each element.
			</dd>
		</dl>
		<h4>
			Remarks
		</h4>
		<div>
			This macro is a repetition construct.&nbsp; If <i>seq</i> is (<i>a</i>)(<i>b</i>)(<i>c</i>), 
			it expands to the sequence:
			<div>
				<i>macro</i>(<i>r</i>, <i>data</i>, <i>a</i>) <i>macro</i>(<i>r</i>, <i>data</i>,
				<i>b</i>) <i>macro</i>(<i>r</i>, <i>data</i>, <i>c</i>)
			</div>
		</div>
		<div>
			For maximum efficiency, use <b>BOOST_PP_SEQ_FOR_EACH_R</b>.
		</div>
		<h4>
			See Also
		</h4>
		<ul>
			<li>
				<a href="seq_for_each_r.html">BOOST_PP_SEQ_FOR_EACH_R</a></li>
		</ul>
		<h4>
			Requirements
		</h4>
		<div>
			<b>Header:</b> &nbsp;<a href="../headers/seq/for_each.html">&lt;boost/preprocessor/seq/for_each.hpp&gt;</a>
		</div>
		<h4>
			Sample Code
		</h4>
		<div>
			<pre>
#include &lt;<a href="../headers/cat.html">boost/preprocessor/cat.hpp</a>&gt;
#include &lt;<a href="../headers/seq/for_each.html">boost/preprocessor/seq/for_each.hpp</a>&gt;

#define SEQ (w)(x)(y)(z)

#define MACRO(r, data, elem) <a href="cat.html">BOOST_PP_CAT</a>(elem, data)

<a href="seq_for_each.html">BOOST_PP_SEQ_FOR_EACH</a>(MACRO, _, SEQ) // expands to w_ x_ y_ z_
</pre>
		</div>
	<hr size="1">
	<div style="margin-left: 0px;">
		<i>© Copyright <a href="http://www.housemarque.com" target="_top">Housemarque Oy</a> 2002</i>
		</br><i>© Copyright Paul Mensonides 2002</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>