summaryrefslogtreecommitdiff
path: root/libs/preprocessor/doc/ref/list_cons.html
blob: 53d29bacb539f9246cc875a3e627980cca418ac4 (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
<html>
<head>
	<title>BOOST_PP_LIST_CONS</title>
	<link rel="stylesheet" type="text/css" href="../styles.css">
</head>
<body>
	<div style="margin-left:  0px;">
		The <b>BOOST_PP_LIST_CONS</b> macro is a <i>list</i> constructor.
	</div>
	<h4>Usage</h4>
		<div class="code">
			<b>BOOST_PP_LIST_CONS</b>(<i>head</i>, <i>tail</i>)
		</div>
	<h4>Arguments</h4>
		<dl>
			<dt>head</dt>
			<dd>
				An element in a <i>list</i>.
			</dd>
			<dt>tail</dt>
			<dd>
				Either a <i>list</i>, <b>BOOST_PP_LIST_NIL</b>, or <b>BOOST_PP_NIL</b>.
			</dd>
		</dl>
	<h4>Remarks</h4>
		<div>
			This macro appends a new head to an existing <i>list</i> or creates a <i>list</i> from <b>BOOST_PP_LIST_NIL</b>.
		</div>
		<div>
			This macro is no longer necessary.&nbsp;
			For example...
			<div>
				<b>BOOST_PP_LIST_CONS</b>(a, <b>BOOST_PP_LIST_CONS</b>(b, <b>BOOST_PP_LIST_NIL</b>)))
			</div>
			...is just an explicit way of writing the following:
			<div>
				(a, (b, <b>BOOST_PP_NIL</b>))
			</div>
			Because of this, this macro is deprecated.
		</div>
	<h4>See Also</h4>
		<ul>
			<li><a href="list_nil.html">BOOST_PP_LIST_NIL</a></li>
			<li><a href="nil.html">BOOST_PP_NIL</a></li>
		</ul>
	<h4>Requirements</h4>
		<div>
			<b>Header:</b> &nbsp;<a href="../headers/list/adt.html">&lt;boost/preprocessor/list/adt.hpp&gt;</a>
		</div>
	<h4>Sample Code</h4>
<div><pre>
#include &lt;<a href="../headers/list/adt.html">boost/preprocessor/list/adt.hpp</a>&gt;

#define OLD \
   <a href="list_cons.html">BOOST_PP_LIST_CONS</a>( \
      a, \
      <a href="list_cons.html">BOOST_PP_LIST_CONS</a>( \
         b, \
         <a href="list_cons.html">BOOST_PP_LIST_CONS</a>( \
            c, \
            <a href="list_nil.html">BOOST_PP_LIST_NIL</a> \
         ) \
      ) \
   ) \
   /**/

#define NEW (a, (b, (c, <a href="nil.html">BOOST_PP_NIL</a>)))

<a href="list_first.html">BOOST_PP_LIST_FIRST</a>(OLD) == <a href="list_first.html">BOOST_PP_LIST_FIRST</a>(NEW)
   // expands to a == a

<a href="list_rest.html">BOOST_PP_LIST_REST</a>(OLD) == <a href="list_rest.html">BOOST_PP_LIST_REST</a>(NEW)
   // expands to (b, (c, <a href="nil.html">BOOST_PP_NIL</a>)) == (b, (c, <a href="nil.html">BOOST_PP_NIL</a>))
</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>