placeholders.html 7.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165
  1. <?xml version="1.0" encoding="utf-8" ?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  4. <!-- Copyright Aleksey Gurtovoy 2006. Distributed under the Boost -->
  5. <!-- Software License, Version 1.0. (See accompanying -->
  6. <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
  7. <head>
  8. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  9. <meta name="generator" content="Docutils 0.3.6: http://docutils.sourceforge.net/" />
  10. <title>THE BOOST MPL LIBRARY: Placeholders</title>
  11. <link rel="stylesheet" href="../style.css" type="text/css" />
  12. </head>
  13. <body class="docframe">
  14. <table class="header"><tr class="header"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./lambda-details.html" class="navigation-link">Prev</a>&nbsp;<a href="./placeholder-expression.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group">Back&nbsp;<a href="./placeholder-expression.html" class="navigation-link">Along</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./lambda-details.html" class="navigation-link">Up</a>&nbsp;<a href="../index.html" class="navigation-link">Home</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./tutorial_toc.html" class="navigation-link">Full TOC</a></span></td>
  15. <td class="header-group page-location"><a href="../index.html" class="navigation-link">Front Page</a> / <a href="./tutorial-metafunctions.html" class="navigation-link">Tutorial: Metafunctions and Higher-Order Metaprogramming</a> / <a href="./lambda-details.html" class="navigation-link">Lambda Details</a> / <a href="./placeholders.html" class="navigation-link">Placeholders</a></td>
  16. </tr></table><div class="header-separator"></div>
  17. <div class="section" id="placeholders">
  18. <h1><a class="toc-backref" href="./lambda-details.html#id55" name="placeholders">Placeholders</a></h1>
  19. <p>The definition of &quot;placeholder&quot; may surprise you:</p>
  20. <div class="admonition-definition admonition">
  21. <p class="admonition-title first">Definition</p>
  22. <p>A <strong>placeholder</strong> is a metafunction class of the form <tt class="literal"><span class="pre">mpl::arg&lt;X&gt;</span></tt>.</p>
  23. </div>
  24. <div class="section" id="implementation">
  25. <h2><a name="implementation">Implementation</a></h2>
  26. <p>The convenient names <tt class="literal"><span class="pre">_1</span></tt>, <tt class="literal"><span class="pre">_2</span></tt>,... <tt class="literal"><span class="pre">_5</span></tt> are actually
  27. <tt class="literal"><span class="pre">typedef</span></tt>s for specializations of <tt class="literal"><span class="pre">mpl::arg</span></tt> that simply
  28. select the <em>N</em>th argument for any <em>N</em>. <a class="footnote-reference" href="#config" id="id12" name="id12">[6]</a> The
  29. implementation of placeholders looks something like this:</p>
  30. <table class="footnote" frame="void" id="config" rules="none">
  31. <colgroup><col class="label" /><col /></colgroup>
  32. <tbody valign="top">
  33. <tr><td class="label"><a class="fn-backref" href="#id12" name="config">[6]</a></td><td>MPL provides five placeholders by default. See
  34. the Configuration Macros section of <a class="reference" href="./reference-manual.html">the MPL reference manual</a> for a
  35. description of how to change the number of placeholders
  36. provided.</td></tr>
  37. </tbody>
  38. </table>
  39. <pre class="literal-block">
  40. namespace boost { namespace mpl { namespace placeholders {
  41. template &lt;int N&gt; struct arg; // forward declarations
  42. struct void_;
  43. template &lt;&gt;
  44. struct arg&lt;<strong>1</strong>&gt;
  45. {
  46. template &lt;
  47. class <strong>A1</strong>, class A2 = void_, ... class A<em>m</em> = void_&gt;
  48. struct apply
  49. {
  50. typedef <strong>A1</strong> type; // return the first argument
  51. };
  52. };
  53. typedef <strong>arg&lt;1&gt; _1</strong>;
  54. template &lt;&gt;
  55. struct arg&lt;<strong>2</strong>&gt;
  56. {
  57. template &lt;
  58. class A1, class <strong>A2</strong>, class A3 = void_, ...class A<em>m</em> = void_
  59. &gt;
  60. struct apply
  61. {
  62. typedef <strong>A2</strong> type; // return the second argument
  63. };
  64. };
  65. typedef <strong>arg&lt;2&gt; _2</strong>;
  66. <em>more specializations and typedefs...</em>
  67. }}}
  68. </pre>
  69. <!-- @example.replace('...','') -->
  70. <p>Remember that invoking a metafunction class is the same as invoking
  71. its nested <tt class="literal"><span class="pre">apply</span></tt> metafunction. When a placeholder in a lambda
  72. expression is evaluated, it is invoked on the expression's actual
  73. arguments, returning just one of them. The results are then
  74. substituted back into the lambda expression and the evaluation
  75. process continues.</p>
  76. </div>
  77. <div class="section" id="the-unnamed-placeholder">
  78. <h2><a name="the-unnamed-placeholder">The Unnamed Placeholder</a></h2>
  79. <p>There's one special placeholder, known as the <strong>unnamed
  80. placeholder</strong>, that we haven't yet defined:</p>
  81. <pre class="literal-block">
  82. namespace boost { namespace mpl { namespace placeholders {
  83. <strong>typedef arg&lt;-1&gt; _;</strong> // the unnamed placeholder
  84. }}}
  85. </pre>
  86. <!-- @ stack[-2].prepend('namespace shield {')
  87. example.append('}') # so we don't conflict with the prefix
  88. compile('all') -->
  89. <p>The details of its implementation aren't important; all you really
  90. need to know about the unnamed placeholder is that it gets special
  91. treatment. When a lambda expression is being transformed into a
  92. metafunction class by <tt class="literal"><span class="pre">mpl::lambda</span></tt>,</p>
  93. <blockquote>
  94. the <em>n</em>th appearance of the unnamed placeholder <em>in a given
  95. template specialization</em> is replaced with <tt class="literal"><span class="pre">_</span></tt><em>n</em>.</blockquote>
  96. <p>So, for example, every row of Table 1.1
  97. below contains two equivalent lambda expressions.</p>
  98. <table border="1" class="table">
  99. <caption>Unnamed Placeholder Semantics</caption>
  100. <colgroup>
  101. <col width="48%" />
  102. <col width="52%" />
  103. </colgroup>
  104. <tbody valign="top">
  105. <tr><td><pre class="first last literal-block">
  106. mpl::plus&lt;_,_&gt;
  107. </pre>
  108. </td>
  109. <td><pre class="first last literal-block">
  110. mpl::plus&lt;_1,_2&gt;
  111. </pre>
  112. </td>
  113. </tr>
  114. <tr><td><pre class="first last literal-block">
  115. boost::is_same&lt;
  116. _
  117. , boost::add_pointer&lt;_&gt;
  118. &gt;
  119. </pre>
  120. </td>
  121. <td><pre class="first last literal-block">
  122. boost::is_same&lt;
  123. _1
  124. , boost::add_pointer&lt;_1&gt;
  125. &gt;
  126. </pre>
  127. </td>
  128. </tr>
  129. <tr><td><pre class="first last literal-block">
  130. mpl::multiplies&lt;
  131. mpl::plus&lt;_,_&gt;
  132. , mpl::minus&lt;_,_&gt;
  133. &gt;
  134. </pre>
  135. </td>
  136. <td><pre class="first last literal-block">
  137. mpl::multiplies&lt;
  138. mpl::plus&lt;_1,_2&gt;
  139. , mpl::minus&lt;_1,_2&gt;
  140. &gt;
  141. </pre>
  142. </td>
  143. </tr>
  144. </tbody>
  145. </table>
  146. <!-- @ for n in range(len(stack)):
  147. stack[n].wrap('typedef ', 'type%d;' % n)
  148. compile('all') -->
  149. <p>Especially when used in simple lambda expressions, the unnamed
  150. placeholder often eliminates just enough syntactic &quot;noise&quot; to
  151. significantly improve readability.</p>
  152. </div>
  153. </div>
  154. <div class="footer-separator"></div>
  155. <table class="footer"><tr class="footer"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./lambda-details.html" class="navigation-link">Prev</a>&nbsp;<a href="./placeholder-expression.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group">Back&nbsp;<a href="./placeholder-expression.html" class="navigation-link">Along</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./lambda-details.html" class="navigation-link">Up</a>&nbsp;<a href="../index.html" class="navigation-link">Home</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./tutorial_toc.html" class="navigation-link">Full TOC</a></span></td>
  156. </tr></table></body>
  157. </html>