|
|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r65529 - sandbox/variadic_macro_data/libs/variadic_macro_data/doc/html
From: eldiener_at_[hidden]
Date: 2010-09-22 00:37:59
Author: eldiener
Date: 2010-09-22 00:37:58 EDT (Wed, 22 Sep 2010)
New Revision: 65529
URL: http://svn.boost.org/trac/boost/changeset/65529
Log:
Documentation for TUPLE_REM and TUPLE_EAT macros.
Text files modified:
sandbox/variadic_macro_data/libs/variadic_macro_data/doc/html/_variadic_macro_data_8hpp.html | 77 +++++++++++++++++++++++++++++++++++++++
sandbox/variadic_macro_data/libs/variadic_macro_data/doc/html/globals.html | 9 ++++
sandbox/variadic_macro_data/libs/variadic_macro_data/doc/html/globals_defs.html | 9 ++++
3 files changed, 95 insertions(+), 0 deletions(-)
Modified: sandbox/variadic_macro_data/libs/variadic_macro_data/doc/html/_variadic_macro_data_8hpp.html
==============================================================================
--- sandbox/variadic_macro_data/libs/variadic_macro_data/doc/html/_variadic_macro_data_8hpp.html (original)
+++ sandbox/variadic_macro_data/libs/variadic_macro_data/doc/html/_variadic_macro_data_8hpp.html 2010-09-22 00:37:58 EDT (Wed, 22 Sep 2010)
@@ -53,6 +53,12 @@
<tr><td class="mdescLeft"> </td><td class="mdescRight">Expands to the number of elements in a tuple. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_variadic_macro_data_8hpp.html#a5c645fee7591a40aa173b7dd989c758f">VMD_PP_TUPLE_ELEM</a>(n, tuple)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Expands to a particular tuple element. <br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_variadic_macro_data_8hpp.html#a112de8b9571ff160beab7e9d1e66a011">VMD_PP_TUPLE_EAT</a>(size)</td></tr>
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Expands to a macro that eats a tuple of the specified size. <br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_variadic_macro_data_8hpp.html#a1facbd95654768f329db54b76f009b40">VMD_PP_TUPLE_REM</a>(size)</td></tr>
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Expands to a macro that removes the parentheses from a tuple of the specified size. <br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_variadic_macro_data_8hpp.html#a0e31d2b35fa81c051b83bc6b9556b36e">VMD_PP_TUPLE_REM_CTOR</a>(tuple)</td></tr>
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Expands to a series of tokens which are equivalent to removing the parentheses from a tuple. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_variadic_macro_data_8hpp.html#a8c81c6e964c9fb60b850c6cb1f71382d">VMD_PP_TUPLE_REVERSE</a>(tuple)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Expands to a tuple whose elements are in reversed order. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_variadic_macro_data_8hpp.html#ab4f99fd1f6008a036db7fc9b92583e38">VMD_PP_TUPLE_TO_LIST</a>(tuple)</td></tr>
@@ -322,6 +328,77 @@
</div>
</div>
+<a class="anchor" id="a112de8b9571ff160beab7e9d1e66a011"></a><!-- doxytag: member="VariadicMacroData.hpp::VMD_PP_TUPLE_EAT" ref="a112de8b9571ff160beab7e9d1e66a011" args="(size)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">#define VMD_PP_TUPLE_EAT</td>
+ <td>(</td>
+ <td class="paramtype"> </td>
+ <td class="paramname">size</td>
+ <td> ) </td>
+ <td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>Expands to a macro that eats a tuple of the specified size. </p>
+<p>size = the number of elements in the subsequent tuple.</p>
+<p>returns = a macro which eats a subsequent tuple. This means that when applied to the subsequent tuple the returned macro expands to nothing.</p>
+<p>This macro is a replacement for BOOST_PP_TUPLE_EAT when the count parameter is calculated with either VMD_DATA_SIZE(...) or <a class="el" href="_variadic_macro_data_8hpp.html#a142becd2891042b870cdc32adda0d0b5" title="Expands to the number of elements in a tuple.">VMD_PP_TUPLE_SIZE(tuple)</a>. In that case BOOST_PP_TUPLE_EAT will not expand properly but using this macro, which delays the call to BOOST_PP_TUPLE_REM until the VMD_DATA_SIZE(...) or <a class="el" href="_variadic_macro_data_8hpp.html#a142becd2891042b870cdc32adda0d0b5" title="Expands to the number of elements in a tuple.">VMD_PP_TUPLE_SIZE(tuple)</a> are fully expanded, does work properly. </p>
+
+</div>
+</div>
+<a class="anchor" id="a1facbd95654768f329db54b76f009b40"></a><!-- doxytag: member="VariadicMacroData.hpp::VMD_PP_TUPLE_REM" ref="a1facbd95654768f329db54b76f009b40" args="(size)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">#define VMD_PP_TUPLE_REM</td>
+ <td>(</td>
+ <td class="paramtype"> </td>
+ <td class="paramname">size</td>
+ <td> ) </td>
+ <td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>Expands to a macro that removes the parentheses from a tuple of the specified size. </p>
+<p>size = the number of elements in the subsequent tuple.</p>
+<p>returns = a macro which can remove the parentheses from a subsequent tuple.</p>
+<p>This macro is a replacement for BOOST_PP_TUPLE_REM when the count parameter is calculated with either VMD_DATA_SIZE(...) or <a class="el" href="_variadic_macro_data_8hpp.html#a142becd2891042b870cdc32adda0d0b5" title="Expands to the number of elements in a tuple.">VMD_PP_TUPLE_SIZE(tuple)</a>. In that case BOOST_PP_TUPLE_REM will not expand properly but using this macro, which delays the call to BOOST_PP_TUPLE_REM until the VMD_DATA_SIZE(...) or <a class="el" href="_variadic_macro_data_8hpp.html#a142becd2891042b870cdc32adda0d0b5" title="Expands to the number of elements in a tuple.">VMD_PP_TUPLE_SIZE(tuple)</a> are fully expanded, does work properly. </p>
+
+</div>
+</div>
+<a class="anchor" id="a0e31d2b35fa81c051b83bc6b9556b36e"></a><!-- doxytag: member="VariadicMacroData.hpp::VMD_PP_TUPLE_REM_CTOR" ref="a0e31d2b35fa81c051b83bc6b9556b36e" args="(tuple)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">#define VMD_PP_TUPLE_REM_CTOR</td>
+ <td>(</td>
+ <td class="paramtype"> </td>
+ <td class="paramname">tuple</td>
+ <td> ) </td>
+ <td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>Expands to a series of tokens which are equivalent to removing the parentheses from a tuple. </p>
+<p>tuple = a Boost PP library tuple data type.</p>
+<p>returns = a series of comma-separated tokens equivalent to removing the parentheses from a tuple.</p>
+<p>This result is actually equivalent to the form of variadic macro data and can be used as an alternative to VMD_PP_TUPLE_TO_DATA to convert the tuple to variadic macro data.</p>
+<p>In the Boost PP library there is no way to calculate the size of a tuple, so that the size must be known in order to be used by Boost PP library tuple macros. With variadic macros the size of a tuple can be calculated from the tuple itself.</p>
+<p>Therefore this macro is a replacement for the BOOST_PP_TUPLE_REM_CTOR macro without the necessity of having to pass a size. </p>
+
+</div>
+</div>
<a class="anchor" id="a8c81c6e964c9fb60b850c6cb1f71382d"></a><!-- doxytag: member="VariadicMacroData.hpp::VMD_PP_TUPLE_REVERSE" ref="a8c81c6e964c9fb60b850c6cb1f71382d" args="(tuple)" -->
<div class="memitem">
<div class="memproto">
Modified: sandbox/variadic_macro_data/libs/variadic_macro_data/doc/html/globals.html
==============================================================================
--- sandbox/variadic_macro_data/libs/variadic_macro_data/doc/html/globals.html (original)
+++ sandbox/variadic_macro_data/libs/variadic_macro_data/doc/html/globals.html 2010-09-22 00:37:58 EDT (Wed, 22 Sep 2010)
@@ -63,9 +63,18 @@
<li>VMD_PP_SEQ_TO_DATA
: <a class="el" href="_variadic_macro_data_8hpp.html#a0701b18f9f3852515cd9710b77b41879">VariadicMacroData.hpp</a>
</li>
+<li>VMD_PP_TUPLE_EAT
+: <a class="el" href="_variadic_macro_data_8hpp.html#a112de8b9571ff160beab7e9d1e66a011">VariadicMacroData.hpp</a>
+</li>
<li>VMD_PP_TUPLE_ELEM
: <a class="el" href="_variadic_macro_data_8hpp.html#a5c645fee7591a40aa173b7dd989c758f">VariadicMacroData.hpp</a>
</li>
+<li>VMD_PP_TUPLE_REM
+: <a class="el" href="_variadic_macro_data_8hpp.html#a1facbd95654768f329db54b76f009b40">VariadicMacroData.hpp</a>
+</li>
+<li>VMD_PP_TUPLE_REM_CTOR
+: <a class="el" href="_variadic_macro_data_8hpp.html#a0e31d2b35fa81c051b83bc6b9556b36e">VariadicMacroData.hpp</a>
+</li>
<li>VMD_PP_TUPLE_REVERSE
: <a class="el" href="_variadic_macro_data_8hpp.html#a8c81c6e964c9fb60b850c6cb1f71382d">VariadicMacroData.hpp</a>
</li>
Modified: sandbox/variadic_macro_data/libs/variadic_macro_data/doc/html/globals_defs.html
==============================================================================
--- sandbox/variadic_macro_data/libs/variadic_macro_data/doc/html/globals_defs.html (original)
+++ sandbox/variadic_macro_data/libs/variadic_macro_data/doc/html/globals_defs.html 2010-09-22 00:37:58 EDT (Wed, 22 Sep 2010)
@@ -63,9 +63,18 @@
<li>VMD_PP_SEQ_TO_DATA
: <a class="el" href="_variadic_macro_data_8hpp.html#a0701b18f9f3852515cd9710b77b41879">VariadicMacroData.hpp</a>
</li>
+<li>VMD_PP_TUPLE_EAT
+: <a class="el" href="_variadic_macro_data_8hpp.html#a112de8b9571ff160beab7e9d1e66a011">VariadicMacroData.hpp</a>
+</li>
<li>VMD_PP_TUPLE_ELEM
: <a class="el" href="_variadic_macro_data_8hpp.html#a5c645fee7591a40aa173b7dd989c758f">VariadicMacroData.hpp</a>
</li>
+<li>VMD_PP_TUPLE_REM
+: <a class="el" href="_variadic_macro_data_8hpp.html#a1facbd95654768f329db54b76f009b40">VariadicMacroData.hpp</a>
+</li>
+<li>VMD_PP_TUPLE_REM_CTOR
+: <a class="el" href="_variadic_macro_data_8hpp.html#a0e31d2b35fa81c051b83bc6b9556b36e">VariadicMacroData.hpp</a>
+</li>
<li>VMD_PP_TUPLE_REVERSE
: <a class="el" href="_variadic_macro_data_8hpp.html#a8c81c6e964c9fb60b850c6cb1f71382d">VariadicMacroData.hpp</a>
</li>
Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk