mem_fn.html 59 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
  4. <title>Chapter&#160;1.&#160;Boost.Member Function</title>
  5. <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
  6. <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
  7. <link rel="home" href="mem_fn.html" title="Chapter&#160;1.&#160;Boost.Member Function">
  8. </head>
  9. <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  10. <table cellpadding="2" width="100%"><tr>
  11. <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
  12. <td align="center"><a href="../../../../index.html">Home</a></td>
  13. <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
  14. <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  15. <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  16. <td align="center"><a href="../../../../more/index.htm">More</a></td>
  17. </tr></table>
  18. <hr>
  19. <div class="spirit-nav"></div>
  20. <div class="chapter">
  21. <div class="titlepage"><div>
  22. <div><h2 class="title">
  23. <a name="mem_fn"></a>Chapter&#160;1.&#160;Boost.Member Function</h2></div>
  24. <div><p class="copyright">Copyright &#169; 2001, 2002 Peter Dimov and Multi Media Ltd.</p></div>
  25. <div><p class="copyright">Copyright &#169; 2003-2005 Peter Dimov</p></div>
  26. <div><div class="legalnotice">
  27. <a name="mem_fn.legal"></a><p>
  28. Distributed under the <a href="http://boost.org/LICENSE_1_0.txt" target="_top">Boost
  29. Software License, Version 1.0</a>.
  30. </p>
  31. </div></div>
  32. </div></div>
  33. <div class="toc">
  34. <p><b>Table of Contents</b></p>
  35. <dl class="toc">
  36. <dt><span class="section"><a href="mem_fn.html#mem_fn.purpose">Purpose</a></span></dt>
  37. <dt><span class="section"><a href="mem_fn.html#mem_fn.faq">Frequently Asked Questions</a></span></dt>
  38. <dd><dl>
  39. <dt><span class="section"><a href="mem_fn.html#mem_fn.faq.can_mem_fn_be_used_instead_of_th">Can <code class="computeroutput"><span class="identifier">mem_fn</span></code> be used instead of the standard <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">mem_fun</span><span class="special">[</span><span class="identifier">_ref</span><span class="special">]</span></code>
  40. adaptors?</a></span></dt>
  41. <dt><span class="section"><a href="mem_fn.html#mem_fn.faq.should_i_replace_every_occurence">Should I
  42. replace every occurence of <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">mem_fun</span><span class="special">[</span><span class="identifier">_ref</span><span class="special">]</span></code>
  43. with <code class="computeroutput"><span class="identifier">mem_fn</span></code> in my existing
  44. code?</a></span></dt>
  45. <dt><span class="section"><a href="mem_fn.html#mem_fn.faq.does_mem_fn_work_with_com_method">Does <code class="computeroutput"><span class="identifier">mem_fn</span></code> work with COM methods?</a></span></dt>
  46. <dt><span class="section"><a href="mem_fn.html#mem_fn.faq.why_isn_t_boost_mem_fn_enable_st">Why isn't
  47. <code class="computeroutput"><span class="identifier">BOOST_MEM_FN_ENABLE_STDCALL</span></code>
  48. defined automatically?</a></span></dt>
  49. </dl></dd>
  50. <dt><span class="section"><a href="mem_fn.html#mem_fn.interface">Interface</a></span></dt>
  51. <dd><dl>
  52. <dt><span class="section"><a href="mem_fn.html#mem_fn.interface.synopsys">Synopsis</a></span></dt>
  53. <dt><span class="section"><a href="mem_fn.html#mem_fn.interface.common_requirements">Common requirements</a></span></dt>
  54. <dt><span class="section"><a href="mem_fn.html#mem_fn.interface.get_pointer"><code class="computeroutput"><span class="identifier">get_pointer</span></code></a></span></dt>
  55. <dt><span class="section"><a href="mem_fn.html#mem_fn.interface.mem_fn"><code class="computeroutput"><span class="identifier">mem_fn</span></code></a></span></dt>
  56. </dl></dd>
  57. <dt><span class="section"><a href="mem_fn.html#mem_fn.implementation">Implementation</a></span></dt>
  58. <dd><dl>
  59. <dt><span class="section"><a href="mem_fn.html#mem_fn.implementation.files">Files</a></span></dt>
  60. <dt><span class="section"><a href="mem_fn.html#mem_fn.implementation.dependencies">Dependencies</a></span></dt>
  61. <dt><span class="section"><a href="mem_fn.html#mem_fn.implementation.number_of_arguments">Number of
  62. Arguments</a></span></dt>
  63. <dt><span class="section"><a href="mem_fn.html#mem_fn.implementation.stdcall"><code class="computeroutput"><span class="identifier">__stdcall</span></code>,
  64. <code class="computeroutput"><span class="identifier">__cdecl</span></code>, and <code class="computeroutput"><span class="identifier">__fastcall</span></code> Support</a></span></dt>
  65. </dl></dd>
  66. <dt><span class="section"><a href="mem_fn.html#mem_fn.acknowledgements">Acknowledgements</a></span></dt>
  67. </dl>
  68. </div>
  69. <div class="section">
  70. <div class="titlepage"><div><div><h2 class="title" style="clear: both">
  71. <a name="mem_fn.purpose"></a><a class="link" href="mem_fn.html#mem_fn.purpose" title="Purpose">Purpose</a>
  72. </h2></div></div></div>
  73. <p>
  74. <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">mem_fn</span></code> is a generalization of the standard
  75. functions <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">mem_fun</span></code> and <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">mem_fun_ref</span></code>.
  76. It supports member function pointers with more than one argument, and the returned
  77. function object can take a pointer, a reference, or a smart pointer to an object
  78. instance as its first argument. <code class="computeroutput"><span class="identifier">mem_fn</span></code>
  79. also supports pointers to data members by treating them as functions taking
  80. no arguments and returning a (const) reference to the member.
  81. </p>
  82. <p>
  83. The purpose of <code class="computeroutput"><span class="identifier">mem_fn</span></code> is twofold.
  84. First, it allows users to invoke a member function on a container with the
  85. familiar
  86. </p>
  87. <pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">for_each</span><span class="special">(</span><span class="identifier">v</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">v</span><span class="special">.</span><span class="identifier">end</span><span class="special">(),</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">mem_fn</span><span class="special">(&amp;</span><span class="identifier">Shape</span><span class="special">::</span><span class="identifier">draw</span><span class="special">));</span>
  88. </pre>
  89. <p>
  90. syntax, even when the container stores smart pointers.
  91. </p>
  92. <p>
  93. Second, it can be used as a building block by library developers that want
  94. to treat a pointer to member function as a function object. A library might
  95. define an enhanced <code class="computeroutput"><span class="identifier">for_each</span></code>
  96. algorithm with an overload of the form:
  97. </p>
  98. <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">It</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">R</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">T</span><span class="special">&gt;</span> <span class="keyword">void</span> <span class="identifier">for_each</span><span class="special">(</span><span class="identifier">It</span> <span class="identifier">first</span><span class="special">,</span> <span class="identifier">It</span> <span class="identifier">last</span><span class="special">,</span> <span class="identifier">R</span> <span class="special">(</span><span class="identifier">T</span><span class="special">::*</span><span class="identifier">pmf</span><span class="special">)</span> <span class="special">())</span>
  99. <span class="special">{</span>
  100. <span class="identifier">std</span><span class="special">::</span><span class="identifier">for_each</span><span class="special">(</span><span class="identifier">first</span><span class="special">,</span> <span class="identifier">last</span><span class="special">,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">mem_fn</span><span class="special">(</span><span class="identifier">pmf</span><span class="special">));</span>
  101. <span class="special">}</span>
  102. </pre>
  103. <p>
  104. that will allow the convenient syntax:
  105. </p>
  106. <pre class="programlisting"><span class="identifier">for_each</span><span class="special">(</span><span class="identifier">v</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">v</span><span class="special">.</span><span class="identifier">end</span><span class="special">(),</span> <span class="special">&amp;</span><span class="identifier">Shape</span><span class="special">::</span><span class="identifier">draw</span><span class="special">);</span>
  107. </pre>
  108. <p>
  109. When documenting the feature, the library author will simply state:
  110. </p>
  111. <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">It</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">R</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">T</span><span class="special">&gt;</span> <span class="keyword">void</span> <span class="identifier">for_each</span><span class="special">(</span><span class="identifier">It</span> <span class="identifier">first</span><span class="special">,</span> <span class="identifier">It</span> <span class="identifier">last</span><span class="special">,</span> <span class="identifier">R</span> <span class="special">(</span><span class="identifier">T</span><span class="special">::*</span><span class="identifier">pmf</span><span class="special">)</span> <span class="special">());</span>
  112. </pre>
  113. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
  114. <span class="emphasis"><em>Effects:</em></span> Equivalent to <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">for_each</span><span class="special">(</span><span class="identifier">first</span><span class="special">,</span> <span class="identifier">last</span><span class="special">,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">mem_fn</span><span class="special">(</span><span class="identifier">pmf</span><span class="special">))</span></code>.
  115. </li></ul></div>
  116. <p>
  117. where <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">mem_fn</span></code> can be a link to this page. See the
  118. <a href="../../../../libs/bind/bind.html" target="_top">documentation of <code class="computeroutput"><span class="identifier">bind</span></code></a>
  119. for an example.
  120. </p>
  121. <p>
  122. <code class="computeroutput"><span class="identifier">mem_fn</span></code> takes one argument,
  123. a pointer to a member, and returns a function object suitable for use with
  124. standard or user-defined algorithms:
  125. </p>
  126. <pre class="programlisting"><span class="keyword">struct</span> <span class="identifier">X</span>
  127. <span class="special">{</span>
  128. <span class="keyword">void</span> <span class="identifier">f</span><span class="special">();</span>
  129. <span class="special">};</span>
  130. <span class="keyword">void</span> <span class="identifier">g</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span><span class="identifier">X</span><span class="special">&gt;</span> <span class="special">&amp;</span> <span class="identifier">v</span><span class="special">)</span>
  131. <span class="special">{</span>
  132. <span class="identifier">std</span><span class="special">::</span><span class="identifier">for_each</span><span class="special">(</span><span class="identifier">v</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">v</span><span class="special">.</span><span class="identifier">end</span><span class="special">(),</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">mem_fn</span><span class="special">(&amp;</span><span class="identifier">X</span><span class="special">::</span><span class="identifier">f</span><span class="special">));</span>
  133. <span class="special">};</span>
  134. <span class="keyword">void</span> <span class="identifier">h</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span><span class="identifier">X</span> <span class="special">*&gt;</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">v</span><span class="special">)</span>
  135. <span class="special">{</span>
  136. <span class="identifier">std</span><span class="special">::</span><span class="identifier">for_each</span><span class="special">(</span><span class="identifier">v</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">v</span><span class="special">.</span><span class="identifier">end</span><span class="special">(),</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">mem_fn</span><span class="special">(&amp;</span><span class="identifier">X</span><span class="special">::</span><span class="identifier">f</span><span class="special">));</span>
  137. <span class="special">};</span>
  138. <span class="keyword">void</span> <span class="identifier">k</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">shared_ptr</span><span class="special">&lt;</span><span class="identifier">X</span><span class="special">&gt;</span> <span class="special">&gt;</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">v</span><span class="special">)</span>
  139. <span class="special">{</span>
  140. <span class="identifier">std</span><span class="special">::</span><span class="identifier">for_each</span><span class="special">(</span><span class="identifier">v</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">v</span><span class="special">.</span><span class="identifier">end</span><span class="special">(),</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">mem_fn</span><span class="special">(&amp;</span><span class="identifier">X</span><span class="special">::</span><span class="identifier">f</span><span class="special">));</span>
  141. <span class="special">};</span>
  142. </pre>
  143. <p>
  144. The returned function object takes the same arguments as the input member function
  145. plus a "flexible" first argument that represents the object instance.
  146. </p>
  147. <p>
  148. When the function object is invoked with a first argument <code class="computeroutput"><span class="identifier">x</span></code>
  149. that is neither a pointer nor a reference to the appropriate class (<code class="computeroutput"><span class="identifier">X</span></code> in the example above), it uses <code class="computeroutput"><span class="identifier">get_pointer</span><span class="special">(</span><span class="identifier">x</span><span class="special">)</span></code> to obtain
  150. a pointer from <code class="computeroutput"><span class="identifier">x</span></code>. Library authors
  151. can "register" their smart pointer classes by supplying an appropriate
  152. <code class="computeroutput"><span class="identifier">get_pointer</span></code> overload, allowing
  153. <code class="computeroutput"><span class="identifier">mem_fn</span></code> to recognize and support
  154. them.
  155. </p>
  156. <p>
  157. <span class="emphasis"><em>[Note:</em></span> <code class="computeroutput"><span class="identifier">get_pointer</span></code>
  158. is not restricted to return a pointer. Any object that can be used in a member
  159. function call expression <code class="computeroutput"><span class="special">(</span><span class="identifier">x</span><span class="special">-&gt;*</span><span class="identifier">pmf</span><span class="special">)(...)</span></code> will work.<span class="emphasis"><em>]</em></span>
  160. </p>
  161. <p>
  162. <span class="emphasis"><em>[Note:</em></span> the library uses an unqualified call to <code class="computeroutput"><span class="identifier">get_pointer</span></code>. Therefore, it will find, through
  163. argument-dependent lookup, <code class="computeroutput"><span class="identifier">get_pointer</span></code>
  164. overloads that are defined in the same namespace as the corresponding smart
  165. pointer class, in addition to any <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">get_pointer</span></code>
  166. overloads.<span class="emphasis"><em>]</em></span>
  167. </p>
  168. <p>
  169. All function objects returned by <code class="computeroutput"><span class="identifier">mem_fn</span></code>
  170. expose a <code class="computeroutput"><span class="identifier">result_type</span></code> typedef
  171. that represents the return type of the member function. For data members,
  172. <code class="computeroutput"><span class="identifier">result_type</span></code> is defined as the
  173. type of the member.
  174. </p>
  175. </div>
  176. <div class="section">
  177. <div class="titlepage"><div><div><h2 class="title" style="clear: both">
  178. <a name="mem_fn.faq"></a><a class="link" href="mem_fn.html#mem_fn.faq" title="Frequently Asked Questions">Frequently Asked Questions</a>
  179. </h2></div></div></div>
  180. <div class="section">
  181. <div class="titlepage"><div><div><h3 class="title">
  182. <a name="mem_fn.faq.can_mem_fn_be_used_instead_of_th"></a><a class="link" href="mem_fn.html#mem_fn.faq.can_mem_fn_be_used_instead_of_th" title="Can mem_fn be used instead of the standard std::mem_fun[_ref] adaptors?">Can <code class="computeroutput"><span class="identifier">mem_fn</span></code> be used instead of the standard <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">mem_fun</span><span class="special">[</span><span class="identifier">_ref</span><span class="special">]</span></code>
  183. adaptors?</a>
  184. </h3></div></div></div>
  185. <p>
  186. Yes. For simple uses, <code class="computeroutput"><span class="identifier">mem_fn</span></code>
  187. provides additional functionality that the standard adaptors do not. Complicated
  188. expressions that use <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">bind1st</span></code>,
  189. <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">bind2nd</span></code> or <a href="http://www.boost.org/doc/libs/1_31_0/libs/compose/index.htm" target="_top">Boost.Compose</a>
  190. along with the standard adaptors can be rewritten using <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">bind</span></code>
  191. that automatically takes advantage of <code class="computeroutput"><span class="identifier">mem_fn</span></code>.
  192. </p>
  193. </div>
  194. <div class="section">
  195. <div class="titlepage"><div><div><h3 class="title">
  196. <a name="mem_fn.faq.should_i_replace_every_occurence"></a><a class="link" href="mem_fn.html#mem_fn.faq.should_i_replace_every_occurence" title="Should I replace every occurence of std::mem_fun[_ref] with mem_fn in my existing code?">Should I
  197. replace every occurence of <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">mem_fun</span><span class="special">[</span><span class="identifier">_ref</span><span class="special">]</span></code>
  198. with <code class="computeroutput"><span class="identifier">mem_fn</span></code> in my existing
  199. code?</a>
  200. </h3></div></div></div>
  201. <p>
  202. No, unless you have good reasons to do so. <code class="computeroutput"><span class="identifier">mem_fn</span></code>
  203. is not 100% compatible with the standard adaptors, although it comes pretty
  204. close. In particular, <code class="computeroutput"><span class="identifier">mem_fn</span></code>
  205. does not return objects of type <code class="computeroutput"><span class="identifier">std</span><span class="special">::[</span><span class="identifier">const_</span><span class="special">]</span><span class="identifier">mem_fun</span><span class="special">[</span><span class="number">1</span><span class="special">][</span><span class="identifier">_ref</span><span class="special">]</span><span class="identifier">_t</span></code>,
  206. as the standard adaptors do, and it is not possible to fully describe the
  207. type of the first argument using the standard <code class="computeroutput"><span class="identifier">argument_type</span></code>
  208. and <code class="computeroutput"><span class="identifier">first_argument_type</span></code> nested
  209. typedefs. Libraries that need adaptable function objects in order to function
  210. might not like <code class="computeroutput"><span class="identifier">mem_fn</span></code>.
  211. </p>
  212. </div>
  213. <div class="section">
  214. <div class="titlepage"><div><div><h3 class="title">
  215. <a name="mem_fn.faq.does_mem_fn_work_with_com_method"></a><a class="link" href="mem_fn.html#mem_fn.faq.does_mem_fn_work_with_com_method" title="Does mem_fn work with COM methods?">Does <code class="computeroutput"><span class="identifier">mem_fn</span></code> work with COM methods?</a>
  216. </h3></div></div></div>
  217. <p>
  218. Yes, if you <a class="link" href="mem_fn.html#mem_fn.implementation.stdcall" title="__stdcall, __cdecl, and __fastcall Support">`#define BOOST_MEM_FN_ENABLE_STDCALL</a>.
  219. </p>
  220. </div>
  221. <div class="section">
  222. <div class="titlepage"><div><div><h3 class="title">
  223. <a name="mem_fn.faq.why_isn_t_boost_mem_fn_enable_st"></a><a class="link" href="mem_fn.html#mem_fn.faq.why_isn_t_boost_mem_fn_enable_st" title="Why isn't BOOST_MEM_FN_ENABLE_STDCALL defined automatically?">Why isn't
  224. <code class="computeroutput"><span class="identifier">BOOST_MEM_FN_ENABLE_STDCALL</span></code>
  225. defined automatically?</a>
  226. </h3></div></div></div>
  227. <p>
  228. Non-portable extensions, in general, should default to off to prevent vendor
  229. lock-in. Had <code class="computeroutput"><span class="identifier">BOOST_MEM_FN_ENABLE_STDCALL</span></code>
  230. been defined automatically, you could have accidentally taken advantage of
  231. it without realizing that your code is, perhaps, no longer portable. In addition,
  232. it is possible for the default calling convention to be <code class="computeroutput"><span class="identifier">__stdcall</span></code>,
  233. in which case enabling <code class="computeroutput"><span class="identifier">__stdcall</span></code>
  234. support will result in duplicate definitions.
  235. </p>
  236. </div>
  237. </div>
  238. <div class="section">
  239. <div class="titlepage"><div><div><h2 class="title" style="clear: both">
  240. <a name="mem_fn.interface"></a><a class="link" href="mem_fn.html#mem_fn.interface" title="Interface">Interface</a>
  241. </h2></div></div></div>
  242. <div class="section">
  243. <div class="titlepage"><div><div><h3 class="title">
  244. <a name="mem_fn.interface.synopsys"></a><a class="link" href="mem_fn.html#mem_fn.interface.synopsys" title="Synopsis">Synopsis</a>
  245. </h3></div></div></div>
  246. <pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">boost</span>
  247. <span class="special">{</span>
  248. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">&gt;</span> <span class="identifier">T</span> <span class="special">*</span> <a class="link" href="mem_fn.html#get_pointer_1"><code class="computeroutput"><span class="identifier">get_pointer</span></code></a><span class="special">(</span><span class="identifier">T</span> <span class="special">*</span> <span class="identifier">p</span><span class="special">);</span>
  249. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">T</span><span class="special">&gt;</span> <span class="emphasis"><em>unspecified-1</em></span> <a class="link" href="mem_fn.html#mem_fn_1"><code class="computeroutput"><span class="identifier">mem_fn</span></code></a><span class="special">(</span><span class="identifier">R</span> <span class="special">(</span><span class="identifier">T</span><span class="special">::*</span><span class="identifier">pmf</span><span class="special">)</span> <span class="special">());</span>
  250. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">T</span><span class="special">&gt;</span> <span class="emphasis"><em>unspecified-2</em></span> <a class="link" href="mem_fn.html#mem_fn_2"><code class="computeroutput"><span class="identifier">mem_fn</span></code></a><span class="special">(</span><span class="identifier">R</span> <span class="special">(</span><span class="identifier">T</span><span class="special">::*</span><span class="identifier">pmf</span><span class="special">)</span> <span class="special">()</span> <span class="keyword">const</span><span class="special">);</span>
  251. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">T</span><span class="special">&gt;</span> <span class="emphasis"><em>unspecified-2-1</em></span> <a class="link" href="mem_fn.html#mem_fn_2_1"><code class="computeroutput"><span class="identifier">mem_fn</span></code></a><span class="special">(</span><span class="identifier">R</span> <span class="identifier">T</span><span class="special">::*</span><span class="identifier">pm</span><span class="special">);</span>
  252. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">T</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">A1</span><span class="special">&gt;</span> <span class="emphasis"><em>unspecified-3</em></span> <a class="link" href="mem_fn.html#mem_fn_3"><code class="computeroutput"><span class="identifier">mem_fn</span></code></a><span class="special">(</span><span class="identifier">R</span> <span class="special">(</span><span class="identifier">T</span><span class="special">::*</span><span class="identifier">pmf</span><span class="special">)</span> <span class="special">(</span><span class="identifier">A1</span><span class="special">));</span>
  253. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">T</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">A1</span><span class="special">&gt;</span> <span class="emphasis"><em>unspecified-4</em></span> <a class="link" href="mem_fn.html#mem_fn_4"><code class="computeroutput"><span class="identifier">mem_fn</span></code></a><span class="special">(</span><span class="identifier">R</span> <span class="special">(</span><span class="identifier">T</span><span class="special">::*</span><span class="identifier">pmf</span><span class="special">)</span> <span class="special">(</span><span class="identifier">A1</span><span class="special">)</span> <span class="keyword">const</span><span class="special">);</span>
  254. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">T</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">A1</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">A2</span><span class="special">&gt;</span> <span class="emphasis"><em>unspecified-5</em></span> <a class="link" href="mem_fn.html#mem_fn_5"><code class="computeroutput"><span class="identifier">mem_fn</span></code></a><span class="special">(</span><span class="identifier">R</span> <span class="special">(</span><span class="identifier">T</span><span class="special">::*</span><span class="identifier">pmf</span><span class="special">)</span> <span class="special">(</span><span class="identifier">A1</span><span class="special">,</span> <span class="identifier">A2</span><span class="special">));</span>
  255. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">T</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">A1</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">A2</span><span class="special">&gt;</span> <span class="emphasis"><em>unspecified-6</em></span> <a class="link" href="mem_fn.html#mem_fn_6"><code class="computeroutput"><span class="identifier">mem_fn</span></code></a><span class="special">(</span><span class="identifier">R</span> <span class="special">(</span><span class="identifier">T</span><span class="special">::*</span><span class="identifier">pmf</span><span class="special">)</span> <span class="special">(</span><span class="identifier">A1</span><span class="special">,</span> <span class="identifier">A2</span><span class="special">)</span> <span class="keyword">const</span><span class="special">);</span>
  256. <span class="comment">// implementation defined number of additional overloads for more arguments</span>
  257. <span class="special">}</span>
  258. </pre>
  259. </div>
  260. <div class="section">
  261. <div class="titlepage"><div><div><h3 class="title">
  262. <a name="mem_fn.interface.common_requirements"></a><a class="link" href="mem_fn.html#mem_fn.interface.common_requirements" title="Common requirements">Common requirements</a>
  263. </h3></div></div></div>
  264. <p>
  265. All <span class="emphasis"><em>unspecified-N</em></span> types mentioned in the Synopsis are
  266. <span class="emphasis"><em>CopyConstructible</em></span> and <span class="emphasis"><em>Assignable</em></span>.
  267. Their copy constructors and assignment operators do not throw exceptions.
  268. <span class="emphasis"><em>unspecified-N</em></span><code class="computeroutput"><span class="special">::</span><span class="identifier">result_type</span></code> is defined as the return type
  269. of the member function pointer passed as an argument to <code class="computeroutput"><span class="identifier">mem_fn</span></code>
  270. (<code class="computeroutput"><span class="identifier">R</span></code> in the Synopsis.) <span class="emphasis"><em>unspecified-2-1</em></span><code class="computeroutput"><span class="special">::</span><span class="identifier">result_type</span></code>
  271. is defined as <code class="computeroutput"><span class="identifier">R</span></code>.
  272. </p>
  273. </div>
  274. <div class="section">
  275. <div class="titlepage"><div><div><h3 class="title">
  276. <a name="mem_fn.interface.get_pointer"></a><a class="link" href="mem_fn.html#mem_fn.interface.get_pointer" title="get_pointer"><code class="computeroutput"><span class="identifier">get_pointer</span></code></a>
  277. </h3></div></div></div>
  278. <a name="get_pointer_1"></a><pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">&gt;</span> <span class="identifier">T</span> <span class="special">*</span> <span class="identifier">get_pointer</span><span class="special">(</span><span class="identifier">T</span> <span class="special">*</span> <span class="identifier">p</span><span class="special">)</span>
  279. </pre>
  280. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  281. <li class="listitem">
  282. <span class="emphasis"><em>Returns:</em></span> <code class="computeroutput"><span class="identifier">p</span></code>.
  283. </li>
  284. <li class="listitem">
  285. <span class="emphasis"><em>Throws:</em></span> Nothing.
  286. </li>
  287. </ul></div>
  288. </div>
  289. <div class="section">
  290. <div class="titlepage"><div><div><h3 class="title">
  291. <a name="mem_fn.interface.mem_fn"></a><a class="link" href="mem_fn.html#mem_fn.interface.mem_fn" title="mem_fn"><code class="computeroutput"><span class="identifier">mem_fn</span></code></a>
  292. </h3></div></div></div>
  293. <a name="mem_fn_1"></a><pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">T</span><span class="special">&gt;</span> <span class="emphasis"><em>unspecified-1</em></span> <span class="identifier">mem_fn</span><span class="special">(</span><span class="identifier">R</span> <span class="special">(</span><span class="identifier">T</span><span class="special">::*</span><span class="identifier">pmf</span><span class="special">)</span> <span class="special">())</span>
  294. </pre>
  295. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  296. <li class="listitem">
  297. <span class="emphasis"><em>Returns:</em></span> a function object &#989; such that the
  298. expression &#989;<code class="computeroutput"><span class="special">(</span><span class="identifier">t</span><span class="special">)</span></code> is equivalent to <code class="computeroutput"><span class="special">(</span><span class="identifier">t</span><span class="special">.*</span><span class="identifier">pmf</span><span class="special">)()</span></code>
  299. when <code class="computeroutput"><span class="identifier">t</span></code> is an l-value
  300. of type <code class="computeroutput"><span class="identifier">T</span></code> or derived,
  301. <code class="computeroutput"><span class="special">(</span><span class="identifier">get_pointer</span><span class="special">(</span><span class="identifier">t</span><span class="special">)-&gt;*</span><span class="identifier">pmf</span><span class="special">)()</span></code> otherwise.
  302. </li>
  303. <li class="listitem">
  304. <span class="emphasis"><em>Throws:</em></span> Nothing.
  305. </li>
  306. </ul></div>
  307. <a name="mem_fn_2"></a><pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">T</span><span class="special">&gt;</span> <span class="emphasis"><em>unspecified-2</em></span> <span class="identifier">mem_fn</span><span class="special">(</span><span class="identifier">R</span> <span class="special">(</span><span class="identifier">T</span><span class="special">::*</span><span class="identifier">pmf</span><span class="special">)</span> <span class="special">()</span> <span class="keyword">const</span><span class="special">)</span>
  308. </pre>
  309. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  310. <li class="listitem">
  311. <span class="emphasis"><em>Returns:</em></span> a function object &#989; such that the
  312. expression &#989;<code class="computeroutput"><span class="special">(</span><span class="identifier">t</span><span class="special">)</span></code> is equivalent to <code class="computeroutput"><span class="special">(</span><span class="identifier">t</span><span class="special">.*</span><span class="identifier">pmf</span><span class="special">)()</span></code>
  313. when <code class="computeroutput"><span class="identifier">t</span></code> is of type <code class="computeroutput"><span class="identifier">T</span></code> <span class="emphasis"><em>[</em></span><code class="computeroutput"><span class="keyword">const</span></code><span class="emphasis"><em>]</em></span> or derived,
  314. <code class="computeroutput"><span class="special">(</span><span class="identifier">get_pointer</span><span class="special">(</span><span class="identifier">t</span><span class="special">)-&gt;*</span><span class="identifier">pmf</span><span class="special">)()</span></code> otherwise.
  315. </li>
  316. <li class="listitem">
  317. <span class="emphasis"><em>Throws:</em></span> Nothing.
  318. </li>
  319. </ul></div>
  320. <a name="mem_fn_2_1"></a><pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">T</span><span class="special">&gt;</span> <span class="emphasis"><em>unspecified-2-1</em></span> <span class="identifier">mem_fn</span><span class="special">(</span><span class="identifier">R</span> <span class="identifier">T</span><span class="special">::*</span><span class="identifier">pm</span><span class="special">)</span>
  321. </pre>
  322. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  323. <li class="listitem">
  324. <span class="emphasis"><em>Returns:</em></span> a function object &#989; such that the
  325. expression &#989;<code class="computeroutput"><span class="special">(</span><span class="identifier">t</span><span class="special">)</span></code> is equivalent to <code class="computeroutput"><span class="identifier">t</span><span class="special">.*</span><span class="identifier">pm</span></code>
  326. when <code class="computeroutput"><span class="identifier">t</span></code> is of type <code class="computeroutput"><span class="identifier">T</span></code> <span class="emphasis"><em>[</em></span><code class="computeroutput"><span class="keyword">const</span></code><span class="emphasis"><em>]</em></span> or derived,
  327. <code class="computeroutput"><span class="identifier">get_pointer</span><span class="special">(</span><span class="identifier">t</span><span class="special">)-&gt;*</span><span class="identifier">pm</span></code> otherwise.
  328. </li>
  329. <li class="listitem">
  330. <span class="emphasis"><em>Throws:</em></span> Nothing.
  331. </li>
  332. </ul></div>
  333. <a name="mem_fn_3"></a><pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">T</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">A1</span><span class="special">&gt;</span> <span class="emphasis"><em>unspecified-3</em></span> <span class="identifier">mem_fn</span><span class="special">(</span><span class="identifier">R</span> <span class="special">(</span><span class="identifier">T</span><span class="special">::*</span><span class="identifier">pmf</span><span class="special">)</span> <span class="special">(</span><span class="identifier">A1</span><span class="special">))</span>
  334. </pre>
  335. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  336. <li class="listitem">
  337. <span class="emphasis"><em>Returns:</em></span> a function object &#989; such that the
  338. expression &#989;<code class="computeroutput"><span class="special">(</span><span class="identifier">t</span><span class="special">,</span> <span class="identifier">a1</span><span class="special">)</span></code> is equivalent to <code class="computeroutput"><span class="special">(</span><span class="identifier">t</span><span class="special">.*</span><span class="identifier">pmf</span><span class="special">)(</span><span class="identifier">a1</span><span class="special">)</span></code>
  339. when <code class="computeroutput"><span class="identifier">t</span></code> is an l-value
  340. of type <code class="computeroutput"><span class="identifier">T</span></code> or derived,
  341. <code class="computeroutput"><span class="special">(</span><span class="identifier">get_pointer</span><span class="special">(</span><span class="identifier">t</span><span class="special">)-&gt;*</span><span class="identifier">pmf</span><span class="special">)(</span><span class="identifier">a1</span><span class="special">)</span></code> otherwise.
  342. </li>
  343. <li class="listitem">
  344. <span class="emphasis"><em>Throws:</em></span> Nothing.
  345. </li>
  346. </ul></div>
  347. <a name="mem_fn_4"></a><pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">T</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">A1</span><span class="special">&gt;</span> <span class="emphasis"><em>unspecified-4</em></span> <span class="identifier">mem_fn</span><span class="special">(</span><span class="identifier">R</span> <span class="special">(</span><span class="identifier">T</span><span class="special">::*</span><span class="identifier">pmf</span><span class="special">)</span> <span class="special">(</span><span class="identifier">A1</span><span class="special">)</span> <span class="keyword">const</span><span class="special">)</span>
  348. </pre>
  349. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  350. <li class="listitem">
  351. <span class="emphasis"><em>Returns:</em></span> a function object &#989; such that the
  352. expression &#989;<code class="computeroutput"><span class="special">(</span><span class="identifier">t</span><span class="special">,</span> <span class="identifier">a1</span><span class="special">)</span></code> is equivalent to <code class="computeroutput"><span class="special">(</span><span class="identifier">t</span><span class="special">.*</span><span class="identifier">pmf</span><span class="special">)(</span><span class="identifier">a1</span><span class="special">)</span></code>
  353. when <code class="computeroutput"><span class="identifier">t</span></code> is of type <code class="computeroutput"><span class="identifier">T</span></code> <span class="emphasis"><em>[</em></span><code class="computeroutput"><span class="keyword">const</span></code><span class="emphasis"><em>]</em></span> or derived,
  354. <code class="computeroutput"><span class="special">(</span><span class="identifier">get_pointer</span><span class="special">(</span><span class="identifier">t</span><span class="special">)-&gt;*</span><span class="identifier">pmf</span><span class="special">)(</span><span class="identifier">a1</span><span class="special">)</span></code> otherwise.
  355. </li>
  356. <li class="listitem">
  357. <span class="emphasis"><em>Throws:</em></span> Nothing.
  358. </li>
  359. </ul></div>
  360. <a name="mem_fn_5"></a><pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">T</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">A1</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">A2</span><span class="special">&gt;</span> <span class="emphasis"><em>unspecified-5</em></span> <span class="identifier">mem_fn</span><span class="special">(</span><span class="identifier">R</span> <span class="special">(</span><span class="identifier">T</span><span class="special">::*</span><span class="identifier">pmf</span><span class="special">)</span> <span class="special">(</span><span class="identifier">A1</span><span class="special">,</span> <span class="identifier">A2</span><span class="special">))</span>
  361. </pre>
  362. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  363. <li class="listitem">
  364. <span class="emphasis"><em>Returns:</em></span> a function object &#989; such that the
  365. expression &#989;<code class="computeroutput"><span class="special">(</span><span class="identifier">t</span><span class="special">,</span> <span class="identifier">a1</span><span class="special">,</span> <span class="identifier">a2</span><span class="special">)</span></code> is equivalent to <code class="computeroutput"><span class="special">(</span><span class="identifier">t</span><span class="special">.*</span><span class="identifier">pmf</span><span class="special">)(</span><span class="identifier">a1</span><span class="special">,</span> <span class="identifier">a2</span><span class="special">)</span></code>
  366. when <code class="computeroutput"><span class="identifier">t</span></code> is an l-value
  367. of type <code class="computeroutput"><span class="identifier">T</span></code> or derived,
  368. <code class="computeroutput"><span class="special">(</span><span class="identifier">get_pointer</span><span class="special">(</span><span class="identifier">t</span><span class="special">)-&gt;*</span><span class="identifier">pmf</span><span class="special">)(</span><span class="identifier">a1</span><span class="special">,</span> <span class="identifier">a2</span><span class="special">)</span></code> otherwise.
  369. </li>
  370. <li class="listitem">
  371. <span class="emphasis"><em>Throws:</em></span> Nothing.
  372. </li>
  373. </ul></div>
  374. <a name="mem_fn_6"></a><pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">T</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">A1</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">A2</span><span class="special">&gt;</span> <span class="emphasis"><em>unspecified-6</em></span> <span class="identifier">mem_fn</span><span class="special">(</span><span class="identifier">R</span> <span class="special">(</span><span class="identifier">T</span><span class="special">::*</span><span class="identifier">pmf</span><span class="special">)</span> <span class="special">(</span><span class="identifier">A1</span><span class="special">,</span> <span class="identifier">A2</span><span class="special">)</span> <span class="keyword">const</span><span class="special">)</span>
  375. </pre>
  376. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  377. <li class="listitem">
  378. <span class="emphasis"><em>Returns:</em></span> a function object &#989; such that the
  379. expression &#989;<code class="computeroutput"><span class="special">(</span><span class="identifier">t</span><span class="special">,</span> <span class="identifier">a1</span><span class="special">,</span> <span class="identifier">a2</span><span class="special">)</span></code> is equivalent to <code class="computeroutput"><span class="special">(</span><span class="identifier">t</span><span class="special">.*</span><span class="identifier">pmf</span><span class="special">)(</span><span class="identifier">a1</span><span class="special">,</span> <span class="identifier">a2</span><span class="special">)</span></code>
  380. when <code class="computeroutput"><span class="identifier">t</span></code> is of type <code class="computeroutput"><span class="identifier">T</span></code> <span class="emphasis"><em>[</em></span><code class="computeroutput"><span class="keyword">const</span></code><span class="emphasis"><em>]</em></span> or derived,
  381. <code class="computeroutput"><span class="special">(</span><span class="identifier">get_pointer</span><span class="special">(</span><span class="identifier">t</span><span class="special">)-&gt;*</span><span class="identifier">pmf</span><span class="special">)(</span><span class="identifier">a1</span><span class="special">,</span> <span class="identifier">a2</span><span class="special">)</span></code> otherwise.
  382. </li>
  383. <li class="listitem">
  384. <span class="emphasis"><em>Throws:</em></span> Nothing.
  385. </li>
  386. </ul></div>
  387. </div>
  388. </div>
  389. <div class="section">
  390. <div class="titlepage"><div><div><h2 class="title" style="clear: both">
  391. <a name="mem_fn.implementation"></a><a class="link" href="mem_fn.html#mem_fn.implementation" title="Implementation">Implementation</a>
  392. </h2></div></div></div>
  393. <div class="section">
  394. <div class="titlepage"><div><div><h3 class="title">
  395. <a name="mem_fn.implementation.files"></a><a class="link" href="mem_fn.html#mem_fn.implementation.files" title="Files">Files</a>
  396. </h3></div></div></div>
  397. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  398. <li class="listitem">
  399. <a href="../../../../boost/mem_fn.hpp" target="_top">boost/mem_fn.hpp</a> (main
  400. header)
  401. </li>
  402. <li class="listitem">
  403. <a href="../../../../boost/bind/mem_fn_cc.hpp" target="_top">boost/bind/mem_fn_cc.hpp</a>
  404. (used by <code class="computeroutput"><span class="identifier">mem_fn</span><span class="special">.</span><span class="identifier">hpp</span></code>, do not include directly)
  405. </li>
  406. <li class="listitem">
  407. <a href="../../../../boost/bind/mem_fn_vw.hpp" target="_top">boost/bind/mem_fn_vw.hpp</a>
  408. (used by <code class="computeroutput"><span class="identifier">mem_fn</span><span class="special">.</span><span class="identifier">hpp</span></code>, do not include directly)
  409. </li>
  410. <li class="listitem">
  411. <a href="../../../../boost/bind/mem_fn_template.hpp" target="_top">boost/bind/mem_fn_template.hpp</a>
  412. (used by <code class="computeroutput"><span class="identifier">mem_fn</span><span class="special">.</span><span class="identifier">hpp</span></code>, do not include directly)
  413. </li>
  414. <li class="listitem">
  415. <a href="../../test/mem_fn_test.cpp" target="_top">libs/bind/test/mem_fn_test.cpp</a>
  416. (test)
  417. </li>
  418. <li class="listitem">
  419. <a href="../../test/mem_fn_derived_test.cpp" target="_top">libs/bind/test/mem_fn_derived_test.cpp</a>
  420. (test with derived objects)
  421. </li>
  422. <li class="listitem">
  423. <a href="../../test/mem_fn_fastcall_test.cpp" target="_top">libs/bind/test/mem_fn_fastcall_test.cpp</a>
  424. (test for <code class="computeroutput"><span class="identifier">__fastcall</span></code>)
  425. </li>
  426. <li class="listitem">
  427. <a href="../../test/mem_fn_stdcall_test.cpp" target="_top">libs/bind/test/mem_fn_stdcall_test.cpp</a>
  428. (test for <code class="computeroutput"><span class="identifier">__stdcall</span></code>)
  429. </li>
  430. <li class="listitem">
  431. <a href="../../test/mem_fn_void_test.cpp" target="_top">libs/bind/test/mem_fn_void_test.cpp</a>
  432. (test for <code class="computeroutput"><span class="keyword">void</span></code> returns)
  433. </li>
  434. </ul></div>
  435. </div>
  436. <div class="section">
  437. <div class="titlepage"><div><div><h3 class="title">
  438. <a name="mem_fn.implementation.dependencies"></a><a class="link" href="mem_fn.html#mem_fn.implementation.dependencies" title="Dependencies">Dependencies</a>
  439. </h3></div></div></div>
  440. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
  441. <a href="../../../../libs/config/config.htm" target="_top">Boost.Config</a>
  442. </li></ul></div>
  443. </div>
  444. <div class="section">
  445. <div class="titlepage"><div><div><h3 class="title">
  446. <a name="mem_fn.implementation.number_of_arguments"></a><a class="link" href="mem_fn.html#mem_fn.implementation.number_of_arguments" title="Number of Arguments">Number of
  447. Arguments</a>
  448. </h3></div></div></div>
  449. <p>
  450. This implementation supports member functions with up to eight arguments.
  451. This is not an inherent limitation of the design, but an implementation detail.
  452. </p>
  453. </div>
  454. <div class="section">
  455. <div class="titlepage"><div><div><h3 class="title">
  456. <a name="mem_fn.implementation.stdcall"></a><a class="link" href="mem_fn.html#mem_fn.implementation.stdcall" title="__stdcall, __cdecl, and __fastcall Support"><code class="computeroutput"><span class="identifier">__stdcall</span></code>,
  457. <code class="computeroutput"><span class="identifier">__cdecl</span></code>, and <code class="computeroutput"><span class="identifier">__fastcall</span></code> Support</a>
  458. </h3></div></div></div>
  459. <p>
  460. Some platforms allow several types of member functions that differ by their
  461. calling convention (the rules by which the function is invoked: how are arguments
  462. passed, how is the return value handled, and who cleans up the stack - if
  463. any.)
  464. </p>
  465. <p>
  466. For example, Windows API functions and COM interface member functions use
  467. a calling convention known as <code class="computeroutput"><span class="identifier">__stdcall</span></code>.
  468. Borland VCL components use <code class="computeroutput"><span class="identifier">__fastcall</span></code>.
  469. UDK, the component model of OpenOffice.org, uses <code class="computeroutput"><span class="identifier">__cdecl</span></code>.
  470. </p>
  471. <p>
  472. To use <code class="computeroutput"><span class="identifier">mem_fn</span></code> with <code class="computeroutput"><span class="identifier">__stdcall</span></code> member functions, <code class="computeroutput"><span class="preprocessor">#define</span></code> the macro <code class="computeroutput"><span class="identifier">BOOST_MEM_FN_ENABLE_STDCALL</span></code>
  473. before including <code class="computeroutput"><span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">mem_fn</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>.
  474. </p>
  475. <p>
  476. To use <code class="computeroutput"><span class="identifier">mem_fn</span></code> with <code class="computeroutput"><span class="identifier">__fastcall</span></code> member functions, <code class="computeroutput"><span class="preprocessor">#define</span></code> the macro <code class="computeroutput"><span class="identifier">BOOST_MEM_FN_ENABLE_FASTCALL</span></code>
  477. before including <code class="computeroutput"><span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">mem_fn</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>.
  478. </p>
  479. <p>
  480. To use <code class="computeroutput"><span class="identifier">mem_fn</span></code> with <code class="computeroutput"><span class="identifier">__cdecl</span></code> member functions, <code class="computeroutput"><span class="preprocessor">#define</span></code> the macro <code class="computeroutput"><span class="identifier">BOOST_MEM_FN_ENABLE_CDECL</span></code>
  481. before including <code class="computeroutput"><span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">mem_fn</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>.
  482. </p>
  483. <p>
  484. <span class="bold"><strong>It is best to define these macros in the project options,
  485. via <code class="computeroutput"><span class="special">-</span><span class="identifier">D</span></code>
  486. on the command line, or as the first line in the translation unit (.cpp file)
  487. where <code class="computeroutput"><span class="identifier">mem_fn</span></code> is used.</strong></span>
  488. Not following this rule can lead to obscure errors when a header includes
  489. <code class="computeroutput"><span class="identifier">mem_fn</span><span class="special">.</span><span class="identifier">hpp</span></code> before the macro has been defined.
  490. </p>
  491. <p>
  492. <span class="emphasis"><em>[Note:</em></span> this is a non-portable extension. It is not part
  493. of the interface.<span class="emphasis"><em>]</em></span>
  494. </p>
  495. <p>
  496. <span class="emphasis"><em>[Note:</em></span> Some compilers provide only minimal support for
  497. the <code class="computeroutput"><span class="identifier">__stdcall</span></code> keyword.<span class="emphasis"><em>]</em></span>
  498. </p>
  499. </div>
  500. </div>
  501. <div class="section">
  502. <div class="titlepage"><div><div><h2 class="title" style="clear: both">
  503. <a name="mem_fn.acknowledgements"></a><a class="link" href="mem_fn.html#mem_fn.acknowledgements" title="Acknowledgements">Acknowledgements</a>
  504. </h2></div></div></div>
  505. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  506. <li class="listitem">
  507. Rene Jager's initial suggestion of using traits classes to make <code class="computeroutput"><span class="identifier">mem_fn</span></code> adapt to user-defined smart pointers
  508. inspired the <code class="computeroutput"><span class="identifier">get_pointer</span></code>-based
  509. design.
  510. </li>
  511. <li class="listitem">
  512. Numerous improvements were suggested during the formal review period by
  513. Richard Crossley, Jens Maurer, Ed Brey, and others. Review manager was
  514. Darin Adler.
  515. </li>
  516. <li class="listitem">
  517. Steve Anichini pointed out that COM interfaces use <code class="computeroutput"><span class="identifier">__stdcall</span></code>.
  518. </li>
  519. <li class="listitem">
  520. Dave Abrahams modified <code class="computeroutput"><span class="identifier">bind</span></code>
  521. and <code class="computeroutput"><span class="identifier">mem_fn</span></code> to support
  522. <code class="computeroutput"><span class="keyword">void</span></code> returns on deficient
  523. compilers.
  524. </li>
  525. <li class="listitem">
  526. Daniel Boelzle pointed out that UDK uses <code class="computeroutput"><span class="identifier">__cdecl</span></code>.
  527. </li>
  528. </ul></div>
  529. <p>
  530. This documentation was ported to Quickbook by Agust&#237;n Berg&#233;.
  531. </p>
  532. </div>
  533. </div>
  534. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  535. <td align="left"><p><small>Last revised: December 10, 2019 at 00:24:17 GMT</small></p></td>
  536. <td align="right"><div class="copyright-footer"></div></td>
  537. </tr></table>
  538. <hr>
  539. <div class="spirit-nav"></div>
  540. </body>
  541. </html>