• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3	<title>BOOST_PP_ENUM_TRAILING</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_ENUM_TRAILING</b> macro generates a comma-separated list with a leading comma.
9	</div>
10	<h4>Usage</h4>
11		<div class="code">
12			<b>BOOST_PP_ENUM_TRAILING</b>(<i>count</i>, <i>macro</i>, <i>data</i>)
13		</div>
14	<h4>Arguments</h4>
15		<dl>
16			<dt>count</dt>
17			<dd>
18				The number of repetitious calls to <i>macro</i>.&nbsp;
19				Valid values range from <i>0</i> to <b>BOOST_PP_LIMIT_REPEAT</b>.
20			</dd>
21			<dt>macro</dt>
22			<dd>
23				A ternary operation of the form <i>macro</i>(<i>z</i>, <i>n</i>, <i>data</i>).&nbsp;
24				This macro is expanded by <b>BOOST_PP_ENUM</b> with the next available repetition depth,
25				the current repetition number, and the auxiliary <i>data</i> argument.&nbsp;
26			</dd>
27			<dt>data</dt>
28			<dd>
29				Auxiliary data passed to <i>macro</i>.
30			</dd>
31		</dl>
32	<h4>Remarks</h4>
33		<div>
34			This macro expands to the comma-separated sequence:
35			<div>
36				, <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>)
37			</div>
38		</div>
39		<div>
40			The <i>z</i> value that is passed to <i>macro</i> represents the next available repetition dimension.&nbsp;
41			Other macros that have <b>_Z</b> suffix variants internally use <b>BOOST_PP_REPEAT</b>--for example, <b>BOOST_PP_ENUM_PARAMS</b> and <b>BOOST_PP_ENUM_PARAMS_Z</b>.&nbsp;
42			Using these <b>_Z</b> versions is not strictly necessary, but passing the <i>z</i> value (that is passed to <i>macro</i>) to these macros allows them to reenter <b>BOOST_PP_REPEAT</b> with maximum efficiency.
43		</div>
44		<div>
45			To directly use this <i>z</i> value, rather than simply passing it to another macro, see <b>BOOST_PP_ENUM_TRAILING_<i>z</i></b>.
46		</div>
47	<h4>See Also</h4>
48		<ul>
49			<li><a href="enum_trailing_z.html">BOOST_PP_ENUM_TRAILING_<i>z</i></a></li>
50			<li><a href="limit_repeat.html">BOOST_PP_LIMIT_REPEAT</a></li>
51		</ul>
52	<h4>Requirements</h4>
53		<div>
54			<b>Header:</b> &nbsp;<a href="../headers/repetition/enum_trailing.html">&lt;boost/preprocessor/repetition/enum_trailing.hpp&gt;</a>
55		</div>
56	<h4>Sample Code</h4>
57<div><pre>
58#include &lt;<a href="../headers/repetition/enum_trailing.html">boost/preprocessor/repetition/enum_trailing.hpp</a>&gt;
59
60#define TEXT(z, n, text) text
61
62template&lt;class <a href="enum_trailing.html">BOOST_PP_ENUM_TRAILING</a>(3, TEXT, class)&gt;
63class X { };
64/*
65   expands to...
66
67template&lt;class, class, class, class&gt;
68class X { };
69*/
70</pre></div>
71	<hr size="1">
72	<div style="margin-left: 0px;">
73		<i>� Copyright <a href="http://www.housemarque.com" target="_top">Housemarque Oy</a> 2002</i>
74		</br><i>� Copyright Paul Mensonides 2002</i>
75	</div>
76	<div style="margin-left: 0px;">
77		<p><small>Distributed under the Boost Software License, Version 1.0. (See
78		accompanying file <a href="../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or
79		copy at <a href=
80		"http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</small></p>
81	</div>
82</body>
83</html>
84