forked from boostorg/preprocessor
Updated docs for the the fact that in C++20 mode when __VA_OPT__ is supported variadic data passed some of the variadic macros can be empty.
This commit is contained in:
@ -1,37 +1,52 @@
|
|||||||
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<title>BOOST_PP_ARRAY_ENUM</title>
|
|
||||||
<link rel="stylesheet" type="text/css" href="../styles.css">
|
<meta http-equiv="content-type" content="text/html; charset=windows-1252">
|
||||||
</head>
|
<title>BOOST_PP_ARRAY_ENUM</title>
|
||||||
<body>
|
<link rel="stylesheet" type="text/css" href="../styles.css">
|
||||||
<div style="margin-left: 0px;"> The <b>BOOST_PP_ARRAY_ENUM</b> macro converts an <i>array</i> to its comma-separated elements. The comma-separated elements are in the form of <i>variadic data</i>.<br>
|
</head>
|
||||||
</div>
|
<body>
|
||||||
<h4> Usage </h4>
|
<div style="margin-left: 0px;"> The <b>BOOST_PP_ARRAY_ENUM</b>
|
||||||
<div class="code"> <b>BOOST_PP_ARRAY_ENUM</b>(<i>array</i>) </div>
|
macro converts an <i>array</i> to its comma-separated elements.
|
||||||
<h4> Arguments </h4>
|
The comma-separated elements are in the form of <i>variadic data</i>.<br>
|
||||||
<dl>
|
</div>
|
||||||
<dt>array</dt>
|
<h4> Usage </h4>
|
||||||
<dd> The <i>array</i> whose elements are to be converted. </dd>
|
<div class="code"> <b>BOOST_PP_ARRAY_ENUM</b>(<i>array</i>) </div>
|
||||||
</dl>
|
<h4> Arguments </h4>
|
||||||
<h4> Remarks </h4>
|
<dl>
|
||||||
<div> This macro expands to a comma-separated list of the elements in <i>array</i>.
|
<dt>array</dt>
|
||||||
For example, <b>BOOST_PP_ARRAY_ENUM</b>((3,(<i>x,</i><i>y,</i><i>z</i>)))
|
<dd> The <i>array</i> whose elements are to be converted. </dd>
|
||||||
expands to...
|
</dl>
|
||||||
<div> <i>x</i>, <i>y</i>, <i>z</i> </div>
|
<h4> Remarks </h4>
|
||||||
</div>
|
<div> This macro expands to a comma-separated list of the elements
|
||||||
<h4> Requirements </h4>
|
in <i>array</i>.
|
||||||
<div> <b>Header:</b> <a href="../headers/array/enum.html"><boost/preprocessor/array/enum.hpp></a>
|
For example, <b>BOOST_PP_ARRAY_ENUM</b>((3,(<i>x,</i><i>y,</i><i>z</i>)))
|
||||||
</div>
|
expands
|
||||||
<h4> Sample Code </h4>
|
to...
|
||||||
<div>
|
<div> <i>x</i>, <i>y</i>, <i>z<br>
|
||||||
<pre>#include <<a href="../headers/array/enum.html">boost/preprocessor/array/enum.hpp</a>><br><br>#define ARRAY (5,(B,O,O,S,T))<br><br><a href="array_enum.html">BOOST_PP_ARRAY_ENUM</a>(ARRAY) // expands to B, O, O, S, T<br></pre>
|
</i> </div>
|
||||||
</div>
|
</div>
|
||||||
<hr size="1">
|
<p> In <a
|
||||||
<div style="margin-left: 0px;"> <i></i><i><EFBFBD> Copyright Edward Diener 2011</i> </div>
|
href="file:///E:/Programming/VersionControl/modular-boost/libs/preprocessor/doc/topics/variadic_macros.html#C20_Support_For_Variadic_Macros">C++
|
||||||
<div style="margin-left: 0px;">
|
20</a> mode if the array is empty the resulting <i>variadic</i>
|
||||||
<p><small>Distributed under the Boost Software License, Version 1.0.
|
<i>data</i> will be empty.</p>
|
||||||
(See accompanying file <a href="../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a>
|
<h4> </h4>
|
||||||
or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</small></p>
|
<h4>Requirements </h4>
|
||||||
</div>
|
<div> <b>Header:</b> <a href="../headers/array/enum.html"><boost/preprocessor/array/enum.hpp></a>
|
||||||
</body>
|
</div>
|
||||||
|
<h4> Sample Code </h4>
|
||||||
|
<div>
|
||||||
|
<pre>#include <<a href="../headers/array/enum.html">boost/preprocessor/array/enum.hpp</a>><br><br>#define ARRAY (5,(B,O,O,S,T))<br><br><a href="array_enum.html">BOOST_PP_ARRAY_ENUM</a>(ARRAY) // expands to B, O, O, S, T<br></pre>
|
||||||
|
</div>
|
||||||
|
<hr size="1">
|
||||||
|
<div style="margin-left: 0px;"> <i></i><i><EFBFBD> Copyright Edward Diener
|
||||||
|
2011</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>
|
</html>
|
||||||
|
@ -1,62 +1,62 @@
|
|||||||
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<title>BOOST_PP_LIST_ENUM</title>
|
|
||||||
<link rel="stylesheet" type="text/css" href="../styles.css">
|
<meta http-equiv="content-type" content="text/html; charset=windows-1252">
|
||||||
</head>
|
<title>BOOST_PP_LIST_ENUM</title>
|
||||||
<body>
|
<link rel="stylesheet" type="text/css" href="../styles.css">
|
||||||
<div style="margin-left: 0px;">
|
</head>
|
||||||
The <b>BOOST_PP_LIST_ENUM</b> macro converts a <i>list</i> to a comma-separated list.
|
<body>
|
||||||
</div>
|
<div style="margin-left: 0px;"> The <b>BOOST_PP_LIST_ENUM</b> macro
|
||||||
<h4>Usage</h4>
|
converts a <i>list</i> to a comma-separated list. </div>
|
||||||
<div class="code">
|
<h4>Usage</h4>
|
||||||
<b>BOOST_PP_LIST_ENUM</b>(<i>list</i>)
|
<div class="code"> <b>BOOST_PP_LIST_ENUM</b>(<i>list</i>) </div>
|
||||||
</div>
|
<h4>Arguments</h4>
|
||||||
<h4>Arguments</h4>
|
<dl>
|
||||||
<dl>
|
<dt>list</dt>
|
||||||
<dt>list</dt>
|
<dd> The <i>list</i> to be converted. </dd>
|
||||||
<dd>
|
</dl>
|
||||||
The <i>list</i> to be converted.
|
<h4>Remarks</h4>
|
||||||
</dd>
|
<div> If <i>list</i> is, for example, (<i>a</i>, (<i>b</i>, (<i>c</i>,
|
||||||
</dl>
|
<b>BOOST_PP_NIL</b>))), this macro will produce:
|
||||||
<h4>Remarks</h4>
|
<div> <i>a</i>, <i>b</i>, <i>c</i> </div>
|
||||||
<div>
|
</div>
|
||||||
If <i>list</i> is, for example, (<i>a</i>, (<i>b</i>, (<i>c</i>, <b>BOOST_PP_NIL</b>))),
|
<div> Previously, this macro could not be used inside <b>BOOST_PP_FOR</b>.
|
||||||
this macro will produce:
|
|
||||||
<div>
|
There is no longer any such restriction. It is more
|
||||||
<i>a</i>, <i>b</i>, <i>c</i>
|
efficient, however, to use <b>BOOST_PP_LIST_ENUM_R</b> in such a
|
||||||
</div>
|
situation.<br>
|
||||||
</div>
|
<br>
|
||||||
<div>
|
In <a
|
||||||
Previously, this macro could not be used inside <b>BOOST_PP_FOR</b>.
|
href="file:///E:/Programming/VersionControl/modular-boost/libs/preprocessor/doc/topics/variadic_macros.html#C20_Support_For_Variadic_Macros">C++
|
||||||
There is no longer any such restriction.
|
20</a> mode if the list is empty the resulting <i>variadic</i>
|
||||||
It is more efficient, however, to use <b>BOOST_PP_LIST_ENUM_R</b> in such a situation.
|
<i>data</i> will be empty.</div>
|
||||||
</div>
|
<h4>See Also</h4>
|
||||||
<h4>See Also</h4>
|
<ul>
|
||||||
<ul>
|
<li><a href="list_enum_r.html">BOOST_PP_LIST_ENUM_R</a></li>
|
||||||
<li><a href="list_enum_r.html">BOOST_PP_LIST_ENUM_R</a></li>
|
</ul>
|
||||||
</ul>
|
<h4>Requirements</h4>
|
||||||
<h4>Requirements</h4>
|
<div> <b>Header:</b> <a href="../headers/list/enum.html"><boost/preprocessor/list/enum.hpp></a>
|
||||||
<div>
|
</div>
|
||||||
<b>Header:</b> <a href="../headers/list/enum.html"><boost/preprocessor/list/enum.hpp></a>
|
<h4>Sample Code</h4>
|
||||||
</div>
|
<div>
|
||||||
<h4>Sample Code</h4>
|
<pre>#include <<a href="../headers/list/enum.html">boost/preprocessor/list/enum.hpp</a>>
|
||||||
<div><pre>
|
|
||||||
#include <<a href="../headers/list/enum.html">boost/preprocessor/list/enum.hpp</a>>
|
|
||||||
|
|
||||||
#define LIST (w, (x, (y, (z, <a href="nil.html">BOOST_PP_NIL</a>))))
|
#define LIST (w, (x, (y, (z, <a href="nil.html">BOOST_PP_NIL</a>))))
|
||||||
|
|
||||||
<a href="list_enum.html">BOOST_PP_LIST_ENUM</a>(LIST) // expands to w, x, y, z
|
<a href="list_enum.html">BOOST_PP_LIST_ENUM</a>(LIST) // expands to w, x, y, z
|
||||||
</pre></div>
|
</pre>
|
||||||
<hr size="1">
|
</div>
|
||||||
<div style="margin-left: 0px;">
|
<hr size="1">
|
||||||
<i><EFBFBD> Copyright <a href="http://www.housemarque.com" target="_top">Housemarque Oy</a> 2002</i>
|
<div style="margin-left: 0px;"> <i><EFBFBD> Copyright <a
|
||||||
</br><i><EFBFBD> Copyright Paul Mensonides 2002</i>
|
href="http://www.housemarque.com" target="_top">Housemarque Oy</a>
|
||||||
</div>
|
2002</i> <br>
|
||||||
<div style="margin-left: 0px;">
|
<i><EFBFBD> Copyright Paul Mensonides 2002</i> </div>
|
||||||
<p><small>Distributed under the Boost Software License, Version 1.0. (See
|
<div style="margin-left: 0px;">
|
||||||
accompanying file <a href="../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or
|
<p><small>Distributed under the Boost Software License, Version
|
||||||
copy at <a href=
|
1.0. (See accompanying file <a
|
||||||
"http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</small></p>
|
href="../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or
|
||||||
</div>
|
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>
|
||||||
|
@ -31,6 +31,12 @@
|
|||||||
<i>a</i>, <i>b</i>, <i>c</i>
|
<i>a</i>, <i>b</i>, <i>c</i>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
<div>
|
||||||
|
In <a
|
||||||
|
href="file:///E:/Programming/VersionControl/modular-boost/libs/preprocessor/doc/topics/variadic_macros.html#C20_Support_For_Variadic_Macros">C++
|
||||||
|
20</a> mode if the list is empty the resulting <i>variadic</i>
|
||||||
|
<i>data</i> will be empty.
|
||||||
|
</div>
|
||||||
<h4>See Also</h4>
|
<h4>See Also</h4>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="list_enum.html">BOOST_PP_LIST_ENUM</a></li>
|
<li><a href="list_enum.html">BOOST_PP_LIST_ENUM</a></li>
|
||||||
|
@ -1,33 +1,46 @@
|
|||||||
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<title>BOOST_PP_VARIADIC_SIZE</title>
|
|
||||||
<link rel="stylesheet" type="text/css" href="../styles.css">
|
<meta http-equiv="content-type" content="text/html; charset=windows-1252">
|
||||||
</head>
|
<title>BOOST_PP_VARIADIC_SIZE</title>
|
||||||
<body>
|
<link rel="stylesheet" type="text/css" href="../styles.css">
|
||||||
<div style="margin-left: 0px;"> The <b>BOOST_PP_VARIADIC_SIZE</b> variadic macro
|
</head>
|
||||||
expands to the size of the <i>variadic data </i>passed to it. </div>
|
<body>
|
||||||
<h4>Usage</h4>
|
<div style="margin-left: 0px;"> The <b>BOOST_PP_VARIADIC_SIZE</b>
|
||||||
<div class="code"> <b>BOOST_PP_VARIADIC_SIZE</b>(<i>...</i>) <a href="../topics/variadic_macros.html#VNotation" target="_self"><sup>(v)</sup></a><br>
|
variadic macro
|
||||||
</div>
|
expands to the size of the <i>variadic data </i>passed to it. </div>
|
||||||
<h4>Arguments</h4>
|
<h4>Usage</h4>
|
||||||
<dl>
|
<div class="code"> <b>BOOST_PP_VARIADIC_SIZE</b>(<i>...</i>) <a
|
||||||
<dt>...<br>
|
href="../topics/variadic_macros.html#VNotation" target="_self"><sup>(v)</sup></a><br>
|
||||||
</dt>
|
</div>
|
||||||
<dd> <i>Variadic data </i>whose size is to be extracted. </dd>
|
<h4>Arguments</h4>
|
||||||
</dl>
|
<dl>
|
||||||
<h4>Requirements</h4>
|
<dt>...<br>
|
||||||
<div> <b>Header:</b> <a href="../headers/variadic/size.html"><boost/preprocessor/variadic/size.hpp></a>
|
</dt>
|
||||||
</div>
|
<dd> <i>Variadic data </i>whose size is to be extracted.</dd>
|
||||||
<h4>Sample Code</h4>
|
</dl>
|
||||||
<div>
|
<h4>Remarks</h4>
|
||||||
<pre>#include <<a href="../headers/variadic/size.html">boost/preprocessor/variadic/size.hpp</a>><br><br>#define VAR_DATA x, y, z<br><br><a href="variadic_size.html">BOOST_PP_VARIADIC_SIZE</a>(VAR_DATA) // expands to 3<br></pre>
|
<p> In <a
|
||||||
</div>
|
href="../topics/variadic_macros.html#C20_Support_For_Variadic_Macros">C++
|
||||||
<hr size="1">
|
20</a> mode the <i>variadic</i> <i>data</i> can be empty and
|
||||||
<div style="margin-left: 0px;"> <i></i><i><EFBFBD> Copyright Edward Diener 2011,2013</i> </div>
|
the result will be 0.<br>
|
||||||
<div style="margin-left: 0px;">
|
</p>
|
||||||
<p><small>Distributed under the Boost Software License, Version 1.0.
|
<h4>Requirements</h4>
|
||||||
(See accompanying file <a href="../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a>
|
<div> <b>Header:</b> <a href="../headers/variadic/size.html"><boost/preprocessor/variadic/size.hpp></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>
|
||||||
</div>
|
<h4>Sample Code</h4>
|
||||||
</body>
|
<div>
|
||||||
|
<pre>#include <<a href="../headers/variadic/size.html">boost/preprocessor/variadic/size.hpp</a>><br><br>#define VAR_DATA x, y, z<br><br><a href="variadic_size.html">BOOST_PP_VARIADIC_SIZE</a>(VAR_DATA) // expands to 3<br></pre>
|
||||||
|
</div>
|
||||||
|
<hr size="1">
|
||||||
|
<div style="margin-left: 0px;"> <i></i><i><EFBFBD> Copyright Edward Diener
|
||||||
|
2011,2013</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>
|
</html>
|
||||||
|
@ -1,32 +1,45 @@
|
|||||||
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<title>BOOST_PP_VARIADIC_TO_ARRAY</title>
|
|
||||||
<link rel="stylesheet" type="text/css" href="../styles.css">
|
<meta http-equiv="content-type" content="text/html; charset=windows-1252">
|
||||||
</head>
|
<title>BOOST_PP_VARIADIC_TO_ARRAY</title>
|
||||||
<body>
|
<link rel="stylesheet" type="text/css" href="../styles.css">
|
||||||
<div style="margin-left: 0px;"> The <b>BOOST_PP_VARIADIC_TO_ARRAY</b> variadic macro
|
</head>
|
||||||
converts <i>variadic data</i> to an <i>array</i>. </div>
|
<body>
|
||||||
<h4> Usage </h4>
|
<div style="margin-left: 0px;"> The <b>BOOST_PP_VARIADIC_TO_ARRAY</b>
|
||||||
<div class="code"> <b>BOOST_PP_VARIADIC_TO_ARRAY</b>(<i>...</i>) <a href="../topics/variadic_macros.html#VNotation" target="_self"><sup>(v)</sup></a><br>
|
variadic macro
|
||||||
</div>
|
converts <i>variadic data</i> to an <i>array</i>. </div>
|
||||||
<h4> Arguments </h4>
|
<h4> Usage </h4>
|
||||||
<dl>
|
<div class="code"> <b>BOOST_PP_VARIADIC_TO_ARRAY</b>(<i>...</i>) <a
|
||||||
<dt>...</dt>
|
href="../topics/variadic_macros.html#VNotation" target="_self"><sup>(v)</sup></a><br>
|
||||||
<dd> The <i>variadic data</i> to be converted. </dd>
|
</div>
|
||||||
</dl>
|
<h4> Arguments </h4>
|
||||||
<h4> Requirements </h4>
|
<dl>
|
||||||
<div> <b>Header:</b> <a href="../headers/variadic/to_array.html"><boost/preprocessor/variadic/to_array.hpp></a>
|
<dt>...</dt>
|
||||||
</div>
|
<dd> The <i>variadic data</i> to be converted.</dd>
|
||||||
<h4> Sample Code </h4>
|
</dl>
|
||||||
<div>
|
<h4>Remarks</h4>
|
||||||
<pre>#include <<a href="../headers/variadic/to_array.html">boost/preprocessor/variadic/to_array.hpp</a>><br><br>#define VAR_DATA a, b, c<br><br><a href="variadic_to_array.html">BOOST_PP_VARIADIC_TO_ARRAY</a>(VAR_DATA) // expands to (3, (a, b, c))<br></pre>
|
<p> In <a
|
||||||
</div>
|
href="file:///E:/Programming/VersionControl/modular-boost/libs/preprocessor/doc/topics/variadic_macros.html#C20_Support_For_Variadic_Macros">C++
|
||||||
<hr size="1">
|
20</a> mode the <i>variadic</i> <i>data</i> can be empty and
|
||||||
<div style="margin-left: 0px;"> <i></i><i><EFBFBD> Copyright Edward Diener 2011,2013</i> </div>
|
the result will be an empty array of the form '(0,())'.</p>
|
||||||
<div style="margin-left: 0px;">
|
<h4> Requirements </h4>
|
||||||
<p><small>Distributed under the Boost Software License, Version 1.0.
|
<div> <b>Header:</b> <a
|
||||||
(See accompanying file <a href="../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a>
|
href="../headers/variadic/to_array.html"><boost/preprocessor/variadic/to_array.hpp></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>
|
||||||
</div>
|
<h4> Sample Code </h4>
|
||||||
</body>
|
<div>
|
||||||
|
<pre>#include <<a href="../headers/variadic/to_array.html">boost/preprocessor/variadic/to_array.hpp</a>><br><br>#define VAR_DATA a, b, c<br><br><a href="variadic_to_array.html">BOOST_PP_VARIADIC_TO_ARRAY</a>(VAR_DATA) // expands to (3, (a, b, c))<br></pre>
|
||||||
|
</div>
|
||||||
|
<hr size="1">
|
||||||
|
<div style="margin-left: 0px;"> <i></i><i><EFBFBD> Copyright Edward Diener
|
||||||
|
2011,2013</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>
|
</html>
|
||||||
|
@ -1,31 +1,45 @@
|
|||||||
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<title>BOOST_PP_VARIADIC_TO_LIST</title>
|
|
||||||
<link rel="stylesheet" type="text/css" href="../styles.css">
|
<meta http-equiv="content-type" content="text/html; charset=windows-1252">
|
||||||
</head>
|
<title>BOOST_PP_VARIADIC_TO_LIST</title>
|
||||||
<body>
|
<link rel="stylesheet" type="text/css" href="../styles.css">
|
||||||
<div style="margin-left: 0px;"> The <b>BOOST_PP_VARIADIC_TO_LIST</b>
|
</head>
|
||||||
variadic macro converts <i>variadic data</i> to a <i>list</i>. </div>
|
<body>
|
||||||
<h4>Usage</h4>
|
<div style="margin-left: 0px;"> The <b>BOOST_PP_VARIADIC_TO_LIST</b>
|
||||||
<div class="code"> <b>BOOST_PP_VARIADIC_TO_LIST</b>(<i>...</i>) <a href="../topics/variadic_macros.html#VNotation" target="_self"><sup>(v)</sup></a><br>
|
variadic macro converts <i>variadic data</i> to a <i>list</i>. </div>
|
||||||
</div>
|
<h4>Usage</h4>
|
||||||
<h4>Arguments</h4>
|
<div class="code"> <b>BOOST_PP_VARIADIC_TO_LIST</b>(<i>...</i>) <a
|
||||||
<dl><dt>...</dt>
|
href="../topics/variadic_macros.html#VNotation" target="_self"><sup>(v)</sup></a><br>
|
||||||
<dd> The <i>variadic data</i> to be converted.<br>
|
</div>
|
||||||
</dd>
|
<h4>Arguments</h4>
|
||||||
</dl><h4>Requirements</h4>
|
<dl>
|
||||||
<div> <b>Header:</b> <a href="../headers/variadic/to_list.html"><boost/preprocessor/variadic/to_list.hpp></a>
|
<dt>...</dt>
|
||||||
</div>
|
<dd> The <i>variadic data</i> to be converted.<br>
|
||||||
<h4>Sample Code</h4>
|
</dd>
|
||||||
<div>
|
</dl>
|
||||||
<pre>#include <<a href="../headers/variadic/to_list.html">boost/preprocessor/variadic/to_list.hpp</a>><br><br><a href="variadic_to_list.html">BOOST_PP_VARIADIC_TO_LIST</a>(x, y, z)<br> // expands to (x, (y, (z, <a href="nil.html">BOOST_PP_NIL</a>)))<br></pre>
|
<h4>Remarks</h4>
|
||||||
</div>
|
<p> In <a
|
||||||
<hr size="1">
|
href="file:///E:/Programming/VersionControl/modular-boost/libs/preprocessor/doc/topics/variadic_macros.html#C20_Support_For_Variadic_Macros">C++
|
||||||
<div style="margin-left: 0px;"> <i></i><i><EFBFBD> Copyright Edward Diener 2011,2013</i> </div>
|
20</a> mode the <i>variadic</i> <i>data</i> can be empty and
|
||||||
<div style="margin-left: 0px;">
|
the result will be an empty list of the form 'BOOST_PP_NIL'.</p>
|
||||||
<p><small>Distributed under the Boost Software License, Version 1.0.
|
<h4>Requirements</h4>
|
||||||
(See accompanying file <a href="../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a>
|
<div> <b>Header:</b> <a
|
||||||
or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</small></p>
|
href="../headers/variadic/to_list.html"><boost/preprocessor/variadic/to_list.hpp></a>
|
||||||
</div>
|
</div>
|
||||||
</body>
|
<h4>Sample Code</h4>
|
||||||
|
<div>
|
||||||
|
<pre>#include <<a href="../headers/variadic/to_list.html">boost/preprocessor/variadic/to_list.hpp</a>><br><br><a href="variadic_to_list.html">BOOST_PP_VARIADIC_TO_LIST</a>(x, y, z)<br> // expands to (x, (y, (z, <a href="nil.html">BOOST_PP_NIL</a>)))<br></pre>
|
||||||
|
</div>
|
||||||
|
<hr size="1">
|
||||||
|
<div style="margin-left: 0px;"> <i></i><i><EFBFBD> Copyright Edward Diener
|
||||||
|
2011,2013</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>
|
</html>
|
||||||
|
@ -1,282 +1,285 @@
|
|||||||
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta content="text/html; charset=windows-1252" http-equiv="content-type">
|
<meta content="text/html; charset=windows-1252"
|
||||||
|
http-equiv="content-type">
|
||||||
<title>variadic_macros.html</title>
|
<title>variadic_macros.html</title>
|
||||||
<link rel="stylesheet" type="text/css" href="../styles.css">
|
<link rel="stylesheet" type="text/css" href="../styles.css">
|
||||||
<style>
|
<style>
|
||||||
u { font-weight: normal; text-decoration: none; }
|
u { font-weight: normal; text-decoration: none; }
|
||||||
</style>
|
</style>
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<h4>Variadic Macros</h4>
|
<h4>Variadic Macros</h4>
|
||||||
<div> Variadic macros are supported by a number of compilers. They are
|
<div> Variadic macros are supported by a number of compilers. They
|
||||||
macros of the form: </div>
|
are macros of the form: </div>
|
||||||
<div class="code">
|
<div class="code">
|
||||||
<pre>#define SOME_MACRO(ZeroOrMoreParameters,...) macro expansion possible specifying __VA_ARGS__</pre>
|
<pre>#define SOME_MACRO(ZeroOrMoreParameters,...) macro expansion possible specifying __VA_ARGS__</pre>
|
||||||
</div>
|
</div>
|
||||||
<div> The '...' in the parameter list represents the variadic data when the
|
<div> The '...' in the parameter list represents the variadic data
|
||||||
macro is invoked and the __VA_ARGS__ in the expansion represents the
|
when the macro is invoked and the __VA_ARGS__ in the expansion
|
||||||
variadic data in the expansion of the macro. Variadic data is of the form
|
represents the variadic data in the expansion of the macro.
|
||||||
of 1 or more preprocessor tokens separated by commas.<br>
|
Variadic data is of the form of 1 or more preprocessor tokens
|
||||||
|
separated by commas.<br>
|
||||||
<br>
|
<br>
|
||||||
The '...' must be the last parameter in the macro definition and there may
|
The '...' must be the last parameter in the macro definition and
|
||||||
be 0 or more non-variadic parameters preceding it.<br>
|
there may be 0 or more non-variadic parameters preceding it.<br>
|
||||||
<br>
|
<br>
|
||||||
In the expansion of the macro __VA_ARGS__ may be specified 0 or more times
|
In the expansion of the macro __VA_ARGS__ may be specified 0 or
|
||||||
to represent the variadic data. The variadic data in the expansion is a
|
more times to represent the variadic data. The variadic data in
|
||||||
comma separated list of preprocessor tokens representing the variadic data
|
the expansion is a comma separated list of preprocessor tokens
|
||||||
which the invoker of the macro enters as the last arguments to the macro.<br>
|
representing the variadic data which the invoker of the macro
|
||||||
|
enters as the last arguments to the macro.<br>
|
||||||
</div>
|
</div>
|
||||||
<h4>Example<u> - Creating and invoking a variadic macro.</u></h4>
|
<h4>Example<u> - Creating and invoking a variadic macro.</u></h4>
|
||||||
<div class="code">
|
<div class="code">
|
||||||
<pre>#define INITIALIZE_INT_ARRAY(array_name,...) \ <br> static int array_name[] = { __VA_ARGS__ }; \ <br> /**/<br><br> INITIALIZE_INT_ARRAY(myname,45,789,33510,9346,2)</pre>
|
<pre>#define INITIALIZE_INT_ARRAY(array_name,...) \ <br> static int array_name[] = { __VA_ARGS__ }; \ <br> /**/<br><br> INITIALIZE_INT_ARRAY(myname,45,789,33510,9346,2)</pre>
|
||||||
</div>
|
</div>
|
||||||
<u> <span style="font-weight: bold;">Preprocessor
|
<u> <span style="font-weight: bold;">Preprocessor Library Support<br>
|
||||||
Library Support<br>
|
|
||||||
</span></u>
|
</span></u>
|
||||||
<div>The library offers support for variadic macros for those
|
<div>The library offers support for variadic macros for those
|
||||||
compilers
|
compilers which support the feature. The library can automatically
|
||||||
which support the feature. The library can automatically detect whether
|
detect whether a compiler supports variadic macros and sets the
|
||||||
a compiler supports variadic macros and sets the macro
|
macro BOOST_PP_VARIADICS accordingly to 1 if the compiler supports
|
||||||
BOOST_PP_VARIADICS accordingly to 1 if the compiler supports variadic
|
variadic macros or 0 if the compiler does not support variadic
|
||||||
macros or 0 if the compiler does not support variadic macros.<br>
|
macros.<br>
|
||||||
<br>
|
<br>
|
||||||
The end-user can #define BOOST_PP_VARIADICS to 1 or 0 himself in a
|
The end-user can #define BOOST_PP_VARIADICS to 1 or 0 himself in a
|
||||||
translation unit, before including any preprocessor header files, to
|
translation unit, before including any preprocessor header files,
|
||||||
prevent the library from attempting to detect whether the compiler
|
to prevent the library from attempting to detect whether the
|
||||||
supports variadic macros. This has the effect of manually turning on or
|
compiler supports variadic macros. This has the effect of manually
|
||||||
off variadic macro support in the library. Of course if one manually
|
turning on or off variadic macro support in the library. Of course
|
||||||
turns on variadic macro support in the library, and one's compiler does
|
if one manually turns on variadic macro support in the library,
|
||||||
not support variadic macros, functionality in the library which uses
|
and one's compiler does not support variadic macros, functionality
|
||||||
variadic macros will fail with error messages from the compiler.<br>
|
in the library which uses variadic macros will fail with error
|
||||||
|
messages from the compiler.<br>
|
||||||
<br>
|
<br>
|
||||||
When BOOST_PP_VARIADICS is 1, the library offers some extended
|
When BOOST_PP_VARIADICS is 1, the library offers some extended
|
||||||
functionality
|
functionality by using variadic macros, and also offers extended
|
||||||
by using variadic macros, and also offers extended support for working
|
support for working with variadic data.<br>
|
||||||
with variadic data.<br><br>
|
|
||||||
<a name="vmvcquirk"></a>Visual C++ has a
|
|
||||||
few quirks related to variadic macros which require the end-user to code
|
|
||||||
slightly differently. When BOOST_PP_VARIADICS is 1 and Visual C++ is the
|
|
||||||
compiler BOOST_PP_VARIADICS_MSVC is 1, else when BOOST_PP_VARIADICS is 1
|
|
||||||
and Visual C++ is not the compiler BOOST_PP_VARIADICS_MSVC is 0. When
|
|
||||||
BOOST_PP_VARIADICS is 0 then BOOST_PP_VARIADICS_MSVC is not defined.
|
|
||||||
In this way the end-user, when using variadic macros, can test for the
|
|
||||||
presence of Visual C++ as the compiler and code accordingly.<br>
|
|
||||||
<br>
|
<br>
|
||||||
Support for working with variadic
|
<a name="vmvcquirk"></a>Visual C++ has a few quirks related to
|
||||||
data is largely centered on being able to convert variadic data to
|
variadic macros which require the end-user to code slightly
|
||||||
other library data types, since the
|
differently. When BOOST_PP_VARIADICS is 1 and Visual C++ is the
|
||||||
functionality for working with those Boost preprocessor library data
|
compiler BOOST_PP_VARIADICS_MSVC is 1, else when
|
||||||
types is much greater than that for working with variadic data directly.<br>
|
BOOST_PP_VARIADICS is 1 and Visual C++ is not the compiler
|
||||||
|
BOOST_PP_VARIADICS_MSVC is 0. When BOOST_PP_VARIADICS is 0 then
|
||||||
|
BOOST_PP_VARIADICS_MSVC is not defined. In this way the end-user,
|
||||||
|
when using variadic macros, can test for the presence of Visual
|
||||||
|
C++ as the compiler and code accordingly.<br>
|
||||||
|
<br>
|
||||||
|
Support for working with variadic data is largely centered on
|
||||||
|
being able to convert variadic data to other library data types,
|
||||||
|
since the functionality for working with those Boost preprocessor
|
||||||
|
library data types is much greater than that for working with
|
||||||
|
variadic data directly.<br>
|
||||||
</div>
|
</div>
|
||||||
<a name="VNotation"></a>
|
<a name="VNotation"></a>
|
||||||
<h4>Notation For Variadic Macros<br>
|
<h4>Notation For Variadic Macros<br>
|
||||||
</h4>
|
</h4>
|
||||||
<div>In the documentation, headers which have variadic macros,
|
<div>In the documentation, headers which have variadic macros, and
|
||||||
and
|
variadic macros themselves, have a notation of '(v)' appended to
|
||||||
variadic macros themselves, have a notation of '(v)' appended to them.
|
them. For the variadic macros themselves this signifies that
|
||||||
For the variadic macros themselves this signifies that
|
BOOST_PP_VARIADICS must be 1 for those variadic macros to be
|
||||||
BOOST_PP_VARIADICS must be 1 for those variadic macros to be usable.
|
usable. For variadic macros which have a non-variadic equivalent,
|
||||||
For variadic macros which have a non-variadic equivalent, the
|
the non-variadic equivalent will be used if BOOST_PP_VARIADICS is
|
||||||
non-variadic equivalent will be used if BOOST_PP_VARIADICS is set to 0.
|
set to 0. </div>
|
||||||
</div>
|
|
||||||
<h4>Extended Functionality Using Variadic Macros<br>
|
<h4>Extended Functionality Using Variadic Macros<br>
|
||||||
</h4>
|
</h4>
|
||||||
<div>Some macros in the library offer extended
|
<div>Some macros in the library offer extended functionality through
|
||||||
functionality through the use of variadic macros.<br>
|
the use of variadic macros.<br>
|
||||||
<br>
|
<br>
|
||||||
The variadic macro version offers the same functionality
|
The variadic macro version offers the same functionality as the
|
||||||
as the non-variadic version, but because of the ability of the variadic
|
non-variadic version, but because of the ability of the variadic
|
||||||
parameters to encompass a variable number of arguments, it also offers
|
parameters to encompass a variable number of arguments, it also
|
||||||
an enhanced syntax using the same macro name.<br>
|
offers an enhanced syntax using the same macro name.<br>
|
||||||
<br>
|
<br>
|
||||||
The macros in the library which offer this enhanced functionality are
|
The macros in the library which offer this enhanced functionality
|
||||||
all
|
are all centered on <i>tuple</i> manipulation. With variadic
|
||||||
centered on <i>tuple</i> manipulation. With variadic
|
macros it is possible to manipulate tuples without having to know
|
||||||
macros it is
|
the size of the tuple. So while the invoker can still specify the
|
||||||
possible to
|
size when using tuple macro functionality, there are variadic
|
||||||
manipulate tuples without having to know the size of the tuple. So
|
versions of each of the tuple macros, with the exact same name as
|
||||||
while the invoker can still specify the size when using tuple macro
|
the non-variadic macro, where the size need not be specified.<br>
|
||||||
functionality, there are variadic versions of each of the tuple macros,
|
|
||||||
with the exact same name as the non-variadic macro, where the size need
|
|
||||||
not be specified.<br>
|
|
||||||
</div>
|
</div>
|
||||||
<h4>Extended Support For Variadic Data</h4>
|
<h4>Extended Support For Variadic Data</h4>
|
||||||
<div>The library offers extended support for working with
|
<div>The library offers extended support for working with variadic
|
||||||
variadic data
|
data which goes beyond the functionality offered by the C++
|
||||||
which goes beyond the functionality offered by the C++ specification
|
specification for variadic macros. It does this through
|
||||||
for variadic macros. It does this through preprocessor programming and
|
preprocessor programming and by using some of the other
|
||||||
by using some of the other functionality in the library itself. Header
|
functionality in the library itself. Header and macro names in the
|
||||||
and macro names
|
library which offer extended support for working with variadic
|
||||||
in the library which offer extended support for working with variadic
|
data, and need the compiler to support variadic macros, are marked
|
||||||
data, and need the compiler to support variadic macros, are marked with
|
with a (v)<sup> </sup>to indicate a variadic macro.<br>
|
||||||
a (v)<sup> </sup>to indicate a variadic macro.<br>
|
|
||||||
<br>
|
<br>
|
||||||
The form of the functionality which the library offers is centered on
|
The form of the functionality which the library offers is centered
|
||||||
two macros which work with variadic data itself, and a set of macros
|
on two macros which work with variadic data itself, and a set of
|
||||||
which convert between variadic data and other library data
|
macros which convert between variadic data and other library data
|
||||||
types.<br>
|
types.<br>
|
||||||
<br>
|
<br>
|
||||||
The two macros are BOOST_PP_VARIADIC_ELEM and BOOST_PP_VARIADIC_SIZE,
|
The two macros are BOOST_PP_VARIADIC_ELEM and
|
||||||
which respectively return a particular token of variadic data and the
|
BOOST_PP_VARIADIC_SIZE, which respectively return a particular
|
||||||
number of tokens of variadic data.<br>
|
token of variadic data and the number of tokens of variadic data.<br>
|
||||||
<br>
|
<br>
|
||||||
The macros for converting variadic data to the library's data types are
|
The macros for converting variadic data to the library's data
|
||||||
BOOST_PP_VARIADIC_TO_ARRAY, BOOST_PP_VARIADIC_TO_LIST,
|
types are BOOST_PP_VARIADIC_TO_ARRAY, BOOST_PP_VARIADIC_TO_LIST,
|
||||||
BOOST_PP_VARIADIC_TO_SEQ, and BOOST_PP_VARIADIC_TO_TUPLE.<br>
|
BOOST_PP_VARIADIC_TO_SEQ, and BOOST_PP_VARIADIC_TO_TUPLE.<br>
|
||||||
<br>
|
<br>
|
||||||
All of these macros need compiler support for variadic data and only
|
All of these macros need compiler support for variadic data and
|
||||||
exist if BOOST_PP_VARIADICS is 1. <br>
|
only exist if BOOST_PP_VARIADICS is 1. <br>
|
||||||
<br>
|
<br>
|
||||||
The remaining four macros, which convert from a library data type
|
The remaining four macros, which convert from a library data type
|
||||||
to comma-separated preprocessor tokens, which is the form of
|
to comma-separated preprocessor tokens, which is the form of
|
||||||
variadic data, do not need compiler support for variadic
|
variadic data, do not need compiler support for variadic macros.
|
||||||
macros. These functions are BOOST_PP_ARRAY_ENUM, BOOST_PP_LIST_ENUM,
|
These functions are BOOST_PP_ARRAY_ENUM, BOOST_PP_LIST_ENUM,
|
||||||
BOOST_PP_SEQ_ENUM, and BOOST_PP_TUPLE_ENUM. However if one wishes to
|
BOOST_PP_SEQ_ENUM, and BOOST_PP_TUPLE_ENUM. However if one wishes
|
||||||
use this variadic data reliably as arguments to other macros, one needs
|
to use this variadic data reliably as arguments to other macros,
|
||||||
variadic macro support.<br>
|
one needs variadic macro support.<br>
|
||||||
</div>
|
</div>
|
||||||
<h4>C++20 Support For Variadic Macros</h4>
|
<h4><a name="C20_Support_For_Variadic_Macros"></a>C++20 Support For
|
||||||
<div>
|
Variadic Macros</h4>
|
||||||
In the C++20 specification there is a new construct which can be
|
<div> In the C++20 specification there is a new construct which can
|
||||||
used in the expansion of a variadic macro, called __VA_OPT__. This
|
be used in the expansion of a variadic macro, called __VA_OPT__.
|
||||||
construct when used in the expansion of a variadic macro is followed
|
This construct when used in the expansion of a variadic macro is
|
||||||
by an opening paranthesis ('('), preprocessor data, and a closing
|
followed by an opening paranthesis ('('), preprocessor data, and a
|
||||||
parenthesis ('}'). When the variadic data passed by the invocation
|
closing parenthesis ('}'). When the variadic data passed by the
|
||||||
of a variadic macro is empty, this new construct expands to nothing.
|
invocation of a variadic macro is empty, this new construct
|
||||||
When the variadic data passed by the invocation of a variadic macro
|
expands to nothing. When the variadic data passed by the
|
||||||
is not empty, this new construct expands to the preprocessor data
|
invocation of a variadic macro is not empty, this new construct
|
||||||
between its opening and closing parentheses.
|
expands to the preprocessor data between its opening and closing
|
||||||
<br><br>
|
parentheses. <br>
|
||||||
This library offers support for this new C++20 construct by automatically
|
|
||||||
detecting whether this new construct is supported by the compiler's
|
|
||||||
preprocessor when using the library. The library macro which detects
|
|
||||||
support for the __VA_OPT__ construct is called BOOST_PP_VARIADIC_HAS_OPT.
|
|
||||||
This is a function-like macro which takes no parameters and returns
|
|
||||||
1 if the compiler is working in C++20 mode and supports the __VA_OPT__
|
|
||||||
construct, while otherwise it returns 0.
|
|
||||||
<br>
|
<br>
|
||||||
|
This library offers support for this new C++20 construct by
|
||||||
|
automatically detecting whether this new construct is supported by
|
||||||
|
the compiler's preprocessor when using the library. The library
|
||||||
|
macro which detects support for the __VA_OPT__ construct is called
|
||||||
|
BOOST_PP_VARIADIC_HAS_OPT. This is a function-like macro which
|
||||||
|
takes no parameters and returns 1 if the compiler is working in
|
||||||
|
C++20 mode and supports the __VA_OPT__ construct, while otherwise
|
||||||
|
it returns 0. <br>
|
||||||
|
<br>
|
||||||
|
When the __VA_OPT__ construct is supported in C++20 mode the
|
||||||
|
variadic data passed to the variadic macros can be empty,
|
||||||
|
otherwise when not in this mode variadic data passed to the
|
||||||
|
variadic macros should never be empty. In this C+++20 mode
|
||||||
|
invoking BOOST_PP_VARIADIC_SIZE with empty data expands to 0,
|
||||||
|
invoking BOOST_PP_VARIADIC_TO_ARRAY with empty data expands to the
|
||||||
|
empty array '(0,())', and invoking BOOST_PP_VARIADIC_TO_LIST with
|
||||||
|
empty data expands to the empty list 'BOOST_PP_NIL'. Similarly in
|
||||||
|
this C++20 mode passing an empty array '(0,())' to
|
||||||
|
BOOST_PP_ARRAY_ENUM expands to empty variadic data and passing an
|
||||||
|
empty list 'BOOST_PP_NIL' to BOOST_PP_LIST_ENUM also expands to
|
||||||
|
empty variadic data. Neither a seq or a tuple can be empty so
|
||||||
|
passing empty variadic data to either BOOST_PP_VARIADIC_TO_SEQ or
|
||||||
|
BOOST_PP_VARIADIC_TO_TUPLE is erroneous. Likewise passing empty
|
||||||
|
data to BOOST_PP_VARIADIC_ELEM is always erroneous since there are
|
||||||
|
no tokens of variadic data to access. <br>
|
||||||
</div>
|
</div>
|
||||||
<u style="font-weight: bold;"> Using a Tuple Instead of an Array<br>
|
<u style="font-weight: bold;"> Using a Tuple Instead of an Array<br>
|
||||||
</u>
|
</u>
|
||||||
<div>An array as a preprocessor data type is a two-element tuple where the
|
<div>An array as a preprocessor data type is a two-element tuple
|
||||||
first element is the array size and the second element is a tuple which
|
where the first element is the array size and the second element
|
||||||
constitutes the array data. Because a tuple knows its own size when the
|
is a tuple which constitutes the array data. Because a tuple knows
|
||||||
compiler supports variadic macros, there is no reason to use the array preprocessor
|
its own size when the compiler supports variadic macros, there is
|
||||||
data type as opposed to the tuple preprocessor data type; the tuple data
|
no reason to use the array preprocessor data type as opposed to
|
||||||
type now has all of the functionality which the array data type has and is
|
the tuple preprocessor data type; the tuple data type now has all
|
||||||
syntactically easier to use. With variadic macro support, which is now
|
of the functionality which the array data type has and is
|
||||||
officially part of the latest C++ standard, the preprocessor array data
|
syntactically easier to use. With variadic macro support, which is
|
||||||
type is essentially obsolete for conforming C++ compilers. Only if your
|
now officially part of the latest C++ standard, the preprocessor
|
||||||
compiler does not support variadic macros is the preprocessor array data
|
array data type is essentially obsolete for conforming C++
|
||||||
type still useful.</div>
|
compilers. Only if your compiler does not support variadic macros
|
||||||
<u style="font-weight: bold;">Using Variadic Data</u>
|
is the preprocessor array data type still useful.</div>
|
||||||
<div>Variadic data exists in the
|
<u style="font-weight: bold;">Using Variadic Data</u>
|
||||||
form of comma-separated preprocessor tokens. This is the case whether
|
<div>Variadic data exists in the form of comma-separated
|
||||||
the variadic data comes from the __VA_ARGS__ of a variadic macro, from
|
preprocessor tokens. This is the case whether the variadic data
|
||||||
the conversion of a library's data type to variadic data, or the
|
comes from the __VA_ARGS__ of a variadic macro, from the
|
||||||
|
conversion of a library's data type to variadic data, or the
|
||||||
manual construction of comma-separated preprocessing tokens by the
|
manual construction of comma-separated preprocessing tokens by the
|
||||||
programmer writing a macro.<br>
|
programmer writing a macro.<br>
|
||||||
<br>
|
<br>
|
||||||
The easiest way to work with
|
The easiest way to work with variadic data internally is to
|
||||||
variadic data internally is to convert it to a library data type.
|
convert it to a library data type. Library data types, whether an
|
||||||
Library data types, whether an <i>array</i>, <i>list</i>,
|
<i>array</i>, <i>list</i>, <i>sequence</i>, or <i>tuple</i>,
|
||||||
<i>sequence</i>,
|
have a rich set of functionality for manipulating data whereas
|
||||||
or <i>tuple</i>, have a rich set of functionality for
|
variadic data functionality in the library only allows one to
|
||||||
manipulating
|
access the variadic data as a whole or to access a single token of
|
||||||
data whereas
|
the variadic data at a time.<br>
|
||||||
variadic data functionality in the library only allows one to access
|
|
||||||
the variadic data as a whole or to access a single token of the
|
|
||||||
variadic data at a time.<br>
|
|
||||||
<br>
|
<br>
|
||||||
The user of the library still may
|
The user of the library still may choose to pass variadic data
|
||||||
choose to pass variadic data back into internal macros rather than
|
back into internal macros rather than convert it to other library
|
||||||
convert it to other library data types. There is no problem passing
|
data types. There is no problem passing variadic data as a whole
|
||||||
variadic data as a whole to variadic macros as the last parameter of
|
to variadic macros as the last parameter of the macro. However: <br>
|
||||||
the macro. However: <br>
|
|
||||||
<br>
|
<br>
|
||||||
<span style="font-weight: bold;">Attempting to pass
|
<span style="font-weight: bold;">Attempting to pass variadic data
|
||||||
variadic data as a
|
as a whole directly into a non-variadic macro is not guaranteed
|
||||||
whole directly into a non-variadic macro is not guaranteed to work and
|
to work and may fail.<br>
|
||||||
may fail.<br>
|
|
||||||
</span><br>
|
</span><br>
|
||||||
This occurs because of a preprocessor weakness in a number
|
This occurs because of a preprocessor weakness in a number of
|
||||||
of compilers, currently most notably Visual C++. Even passing variadic
|
compilers, currently most notably Visual C++. Even passing
|
||||||
data as arguments to a non-variadic macro, when it is not represented
|
variadic data as arguments to a non-variadic macro, when it is not
|
||||||
in
|
represented in the form of __VA_ARGS__, may fail with
|
||||||
the form of<6F> __VA_ARGS__, may fail with certain compilers.<br>
|
certain compilers.<br>
|
||||||
<br>
|
<br>
|
||||||
What follows are very simple examples, showing how variadic data can be
|
What follows are very simple examples, showing how variadic data
|
||||||
passed to a non-variadic macro.<br>
|
can be passed to a non-variadic macro.<br>
|
||||||
<br>
|
<br>
|
||||||
First an example of what NOT to do.<br>
|
First an example of what NOT to do.<br>
|
||||||
</div>
|
</div>
|
||||||
<h4>Example<u> - Passing variadic data as a whole to a
|
<h4>Example<u> - Passing variadic data as a whole to a non-variadic
|
||||||
non-variadic
|
|
||||||
macro. DO NOT DO.</u></h4>
|
macro. DO NOT DO.</u></h4>
|
||||||
<div class="code">
|
<div class="code">
|
||||||
<pre>#define MACRO_ARG_2(x,y) BOOST_PP_ADD(x,y)<br>#define VAR_MACRO(...) __VA_ARGS__<br><br>/* The following should not be done and is not guaranteed to work with compilers. */<br><br><span
|
<pre>#define MACRO_ARG_2(x,y) BOOST_PP_ADD(x,y)<br>#define VAR_MACRO(...) __VA_ARGS__<br><br>/* The following should not be done and is not guaranteed to work with compilers. */<br><br><span style="font-weight: bold;"><span style="font-family: monospace;"></span></span>int xx = MACRO_ARG_2(VAR_MACRO(2,3));</pre>
|
||||||
style="font-weight: bold;"><span style="font-family: monospace;"></span></span>int xx = MACRO_ARG_2(VAR_MACRO(2,3));</pre>
|
|
||||||
</div>
|
</div>
|
||||||
<div> There are two ways to pass variadic data to a non-variadic
|
<div> There are two ways to pass variadic data to a non-variadic
|
||||||
macro.
|
macro. The first of these is to pass the individual tokens of the
|
||||||
The
|
variadic data separately to the non-variadic macro using the
|
||||||
first of these is to pass the individual tokens of the variadic data
|
BOOST_PP_VARIADIC_ELEM macro in the library.<br>
|
||||||
separately to the non-variadic macro using the BOOST_PP_VARIADIC_ELEM
|
|
||||||
macro in the library.<br>
|
|
||||||
</div>
|
</div>
|
||||||
<h4>Example<u> - Passing individual variadic data tokens to
|
<h4>Example<u> - Passing individual variadic data tokens to a
|
||||||
a
|
|
||||||
non-variadic macro.<br>
|
non-variadic macro.<br>
|
||||||
</u></h4>
|
</u></h4>
|
||||||
<div class="code">
|
<div class="code">
|
||||||
<pre>#define MACRO_ARG_2(x,y) BOOST_PP_ADD(x,y)<br>#define VAR_MACRO(...) __VA_ARGS__<br><br>/* The following will work correctly */<br><br>int xx = MACRO_ARG_2<br> (<br> BOOST_PP_VARIADIC_ELEM(0,VAR_MACRO(2,3)),<br> BOOST_PP_VARIADIC_ELEM(1,VAR_MACRO(2,3))<br> );</pre>
|
<pre>#define MACRO_ARG_2(x,y) BOOST_PP_ADD(x,y)<br>#define VAR_MACRO(...) __VA_ARGS__<br><br>/* The following will work correctly */<br><br>int xx = MACRO_ARG_2<br> (<br> BOOST_PP_VARIADIC_ELEM(0,VAR_MACRO(2,3)),<br> BOOST_PP_VARIADIC_ELEM(1,VAR_MACRO(2,3))<br> );</pre>
|
||||||
</div>
|
</div>
|
||||||
<div>The second way is to use a macro in the library called
|
<div>The second way is to use a macro in the library called
|
||||||
BOOST_PP_OVERLOAD.
|
BOOST_PP_OVERLOAD. This macro allows one to "overload" a variadic
|
||||||
This macro allows one to "overload" a variadic macro to non-variadic
|
macro to non-variadic macros of different numbers of parameters,
|
||||||
macros of different numbers of parameters, using a common prefix.
|
using a common prefix. </div>
|
||||||
</div>
|
|
||||||
<h4>Example<u> - Passing variadic data as a whole to
|
<h4>Example<u> - Passing variadic data as a whole to
|
||||||
BOOST_PP_OVERLOAD
|
BOOST_PP_OVERLOAD and on to a non-variadic macro.<br>
|
||||||
and on to a non-variadic macro.<br>
|
|
||||||
</u></h4>
|
</u></h4>
|
||||||
<div class="code">
|
<div class="code">
|
||||||
<pre>#define MACRO_ARG_2(x,y) BOOST_PP_ADD(x,y)<br>#define VAR_MACRO(...) __VA_ARGS__<br><br>/* The following will work correctly */<br><br>int xx = BOOST_PP_OVERLOAD(MACRO_ARG_,VAR_MACRO(2,3))(VAR_MACRO(2,3));<br><br>/* For Visual C++ it is necessary to do this */<br><br>int xx = <br>BOOST_PP_CAT(BOOST_PP_OVERLOAD(MACRO_ARG_,VAR_MACRO(2,3))(VAR_MACRO(2,3)),BOOST_PP_EMPTY());</pre>
|
<pre>#define MACRO_ARG_2(x,y) BOOST_PP_ADD(x,y)<br>#define VAR_MACRO(...) __VA_ARGS__<br><br>/* The following will work correctly */<br><br>int xx = BOOST_PP_OVERLOAD(MACRO_ARG_,VAR_MACRO(2,3))(VAR_MACRO(2,3));<br><br>/* For Visual C++ it is necessary to do this */<br><br>int xx = <br>BOOST_PP_CAT(BOOST_PP_OVERLOAD(MACRO_ARG_,VAR_MACRO(2,3))(VAR_MACRO(2,3)),BOOST_PP_EMPTY());</pre>
|
||||||
</div>
|
</div>
|
||||||
<br>
|
<br>
|
||||||
<div>Although these techniques will work when passing variadic
|
<div>Although these techniques will work when passing variadic data
|
||||||
data to
|
to non-variadic macros, it is much better and less problematical
|
||||||
non-variadic macros, it is much better and less problematical to
|
to work internally with the existing library data types and to
|
||||||
work internally with the existing library data types and to only use
|
only use variadic macros as an interface for end-users when there
|
||||||
variadic
|
is a need to have a macro which takes a variable number of
|
||||||
macros as an interface for end-users when there is a need to have a
|
parameters.<br>
|
||||||
macro which takes a
|
|
||||||
variable number of parameters.<br>
|
|
||||||
</div>
|
</div>
|
||||||
<b>See</b> <b>Also</b><br>
|
<b>See</b> <b>Also</b><br>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="../ref/variadics.html">BOOST_PP_VARIADICS</a></li>
|
<li><a href="../ref/variadics.html">BOOST_PP_VARIADICS</a></li>
|
||||||
<li><a href="../headers/tuple.html">Tuple Macros</a><br>
|
<li><a href="../headers/tuple.html">Tuple Macros</a><br>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="../headers/variadic.html">Variadic
|
<li><a href="../headers/variadic.html">Variadic Macros<br>
|
||||||
Macros<br>
|
|
||||||
</a></li>
|
</a></li>
|
||||||
<li><a href="../ref/array_enum.html">BOOST_PP_ARRAY_ENUM</a></li>
|
<li><a href="../ref/array_enum.html">BOOST_PP_ARRAY_ENUM</a></li>
|
||||||
<li><a href="../ref/list_enum_r.html">BOOST_PP_LIST_ENUM</a></li>
|
<li><a href="../ref/list_enum_r.html">BOOST_PP_LIST_ENUM</a></li>
|
||||||
<li><a href="../ref/seq_enum.html">BOOST_PP_SEQ_ENUM</a></li>
|
<li><a href="../ref/seq_enum.html">BOOST_PP_SEQ_ENUM</a></li>
|
||||||
<li><a href="../ref/tuple_enum.html">BOOST_PP_TUPLE_ENUM</a></li>
|
<li><a href="../ref/tuple_enum.html">BOOST_PP_TUPLE_ENUM</a></li>
|
||||||
<li><a href="../ref/overload.html">BOOST_PP_OVERLOAD</a></li>
|
<li><a href="../ref/overload.html">BOOST_PP_OVERLOAD</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<hr size="1">
|
<hr size="1">
|
||||||
<div style="margin-left: 0px;"> <i><EFBFBD> Copyright
|
<div style="margin-left: 0px;"> <i><EFBFBD> Copyright Edward Diener
|
||||||
Edward Diener
|
|
||||||
2011,2013,2016</i> </div>
|
2011,2013,2016</i> </div>
|
||||||
<div style="margin-left: 0px;">
|
<div style="margin-left: 0px;">
|
||||||
<p><small>Distributed under the Boost Software License,
|
<p><small>Distributed under the Boost Software License, Version
|
||||||
Version 1.0.
|
1.0. (See accompanying file <a
|
||||||
(See accompanying file <a href="../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a>
|
href="../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or
|
||||||
or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</small></p>
|
copy at <a href="http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</small></p>
|
||||||
</div>
|
</div>
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
||||||
|
Reference in New Issue
Block a user