reference.html 55 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
  4. <title>Reference</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="index.html" title="Chapter&#160;1.&#160;Boost.Contract 1.0.0">
  8. <link rel="up" href="index.html" title="Chapter&#160;1.&#160;Boost.Contract 1.0.0">
  9. <link rel="prev" href="boost_contract/examples.html" title="Examples">
  10. <link rel="next" href="BOOST_CONTRACT_ASSERT.html" title="Macro BOOST_CONTRACT_ASSERT">
  11. </head>
  12. <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13. <table cellpadding="2" width="100%"><tr>
  14. <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
  15. <td align="center"><a href="../../../../index.html">Home</a></td>
  16. <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
  17. <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18. <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19. <td align="center"><a href="../../../../more/index.htm">More</a></td>
  20. </tr></table>
  21. <hr>
  22. <div class="spirit-nav">
  23. <a accesskey="p" href="boost_contract/examples.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="index.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="BOOST_CONTRACT_ASSERT.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  24. </div>
  25. <div class="section">
  26. <div class="titlepage"><div><div><h2 class="title" style="clear: both">
  27. <a name="reference"></a>Reference</h2></div></div></div>
  28. <div class="toc"><dl class="toc">
  29. <dt><span class="section"><a href="reference.html#header.boost.contract_hpp">Header &lt;boost/contract.hpp&gt;</a></span></dt>
  30. <dt><span class="section"><a href="reference.html#header.boost.contract.assert_hpp">Header &lt;boost/contract/assert.hpp&gt;</a></span></dt>
  31. <dt><span class="section"><a href="reference.html#header.boost.contract.base_types_hpp">Header &lt;boost/contract/base_types.hpp&gt;</a></span></dt>
  32. <dt><span class="section"><a href="reference.html#header.boost.contract.call_if_hpp">Header &lt;boost/contract/call_if.hpp&gt;</a></span></dt>
  33. <dt><span class="section"><a href="reference.html#header.boost.contract.check_hpp">Header &lt;boost/contract/check.hpp&gt;</a></span></dt>
  34. <dt><span class="section"><a href="reference.html#header.boost.contract.constructor_hpp">Header &lt;boost/contract/constructor.hpp&gt;</a></span></dt>
  35. <dt><span class="section"><a href="reference.html#header.boost.contract.core.access_hpp">Header &lt;boost/contract/core/access.hpp&gt;</a></span></dt>
  36. <dt><span class="section"><a href="reference.html#header.boost.contract.core.check_macro_hpp">Header &lt;boost/contract/core/check_macro.hpp&gt;</a></span></dt>
  37. <dt><span class="section"><a href="reference.html#header.boost.contract.core.config_hpp">Header &lt;boost/contract/core/config.hpp&gt;</a></span></dt>
  38. <dt><span class="section"><a href="reference.html#header.boost.contract.core.constructor_precondition_hpp">Header &lt;boost/contract/core/constructor_precondition.hpp&gt;</a></span></dt>
  39. <dt><span class="section"><a href="reference.html#header.boost.contract.core.exception_hpp">Header &lt;boost/contract/core/exception.hpp&gt;</a></span></dt>
  40. <dt><span class="section"><a href="reference.html#header.boost.contract.core.specify_hpp">Header &lt;boost/contract/core/specify.hpp&gt;</a></span></dt>
  41. <dt><span class="section"><a href="reference.html#header.boost.contract.core.virtual_hpp">Header &lt;boost/contract/core/virtual.hpp&gt;</a></span></dt>
  42. <dt><span class="section"><a href="reference.html#header.boost.contract.destructor_hpp">Header &lt;boost/contract/destructor.hpp&gt;</a></span></dt>
  43. <dt><span class="section"><a href="reference.html#header.boost.contract.function_hpp">Header &lt;boost/contract/function.hpp&gt;</a></span></dt>
  44. <dt><span class="section"><a href="reference.html#header.boost.contract.old_hpp">Header &lt;boost/contract/old.hpp&gt;</a></span></dt>
  45. <dt><span class="section"><a href="reference.html#header.boost.contract.override_hpp">Header &lt;boost/contract/override.hpp&gt;</a></span></dt>
  46. <dt><span class="section"><a href="reference.html#header.boost.contract.public_function_hpp">Header &lt;boost/contract/public_function.hpp&gt;</a></span></dt>
  47. <dt><span class="section"><a href="reference.html#header.boost.contract_macro_hpp">Header &lt;boost/contract_macro.hpp&gt;</a></span></dt>
  48. </dl></div>
  49. <div class="section">
  50. <div class="titlepage"><div><div><h3 class="title">
  51. <a name="header.boost.contract_hpp"></a>Header &lt;<a href="../../../../boost/contract.hpp" target="_top">boost/contract.hpp</a>&gt;</h3></div></div></div>
  52. <p>Include all header files required by this library at once (for convenience). </p>
  53. <p>All header files <code class="computeroutput">boost/contract/*.hpp</code> are independent from one another and can be included one-by-one to reduce the amount of code to compile from this library in user code (but this was measured to not make an appreciable difference in compile-time so <code class="computeroutput">boost/contract.hpp</code> can be included directly in most cases). Instead the headers <code class="computeroutput">boost/contract/core/*.hpp</code> are not independent from other library headers and they are automatically included by the <code class="computeroutput">boost/contract/*.hpp</code> headers (so the <code class="computeroutput">boost/contract/core/*.hpp</code> headers are usually not directly included by programmers).</p>
  54. <p>All files under the <code class="computeroutput">boost/contract/detail/</code> directory, names within the <code class="computeroutput">boost::contract::detail</code> namespace, names prefixed by <code class="computeroutput">boost_contract_detail</code>... and <code class="computeroutput">BOOST_CONTRACT_DETAIL</code>... (in any namesapce, including user's code) are reserved for internal use of this library and should never be used directly by programmers.</p>
  55. <p><span class="bold"><strong>See Also:</strong></span></p>
  56. <p> <a class="link" href="boost_contract/getting_started.html" title="Getting Started"> Getting Started</a> </p>
  57. <p>
  58. </p>
  59. <p>
  60. </p>
  61. </div>
  62. <div class="section">
  63. <div class="titlepage"><div><div><h3 class="title">
  64. <a name="header.boost.contract.assert_hpp"></a>Header &lt;<a href="../../../../boost/contract/assert.hpp" target="_top">boost/contract/assert.hpp</a>&gt;</h3></div></div></div>
  65. <p>Assert contract conditions. </p>
  66. <pre class="synopsis">
  67. <a class="link" href="BOOST_CONTRACT_ASSERT.html" title="Macro BOOST_CONTRACT_ASSERT">BOOST_CONTRACT_ASSERT</a>(cond)
  68. <a class="link" href="BOOST_CO_idm45395000817520.html" title="Macro BOOST_CONTRACT_ASSERT_AUDIT">BOOST_CONTRACT_ASSERT_AUDIT</a>(cond)
  69. <a class="link" href="BOOST_CO_idm45395027441616.html" title="Macro BOOST_CONTRACT_ASSERT_AXIOM">BOOST_CONTRACT_ASSERT_AXIOM</a>(cond)</pre>
  70. </div>
  71. <div class="section">
  72. <div class="titlepage"><div><div><h3 class="title">
  73. <a name="header.boost.contract.base_types_hpp"></a>Header &lt;<a href="../../../../boost/contract/base_types.hpp" target="_top">boost/contract/base_types.hpp</a>&gt;</h3></div></div></div>
  74. <p>Specify inheritance form base classes (for subcontracting). </p>
  75. <pre class="synopsis">
  76. <a class="link" href="BOOST_CONTRACT_BASE_TYPES.html" title="Macro BOOST_CONTRACT_BASE_TYPES">BOOST_CONTRACT_BASE_TYPES</a>(...)</pre>
  77. </div>
  78. <div class="section">
  79. <div class="titlepage"><div><div><h3 class="title">
  80. <a name="header.boost.contract.call_if_hpp"></a>Header &lt;<a href="../../../../boost/contract/call_if.hpp" target="_top">boost/contract/call_if.hpp</a>&gt;</h3></div></div></div>
  81. <p>Statically disable compilation and execution of functor calls. </p>
  82. <div class="note"><table border="0" summary="Note">
  83. <tr>
  84. <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
  85. <th align="left">Note</th>
  86. </tr>
  87. <tr><td align="left" valign="top"><p>These facilities allow to emulate C++17 <code class="computeroutput">if constexpr</code> statements when used together with functor templates (and C++14 generic lambdas). Therefore, they are not useful on C++17 compilers where <code class="computeroutput"> if constexpr</code> can be directly used instead. </p></td></tr>
  88. </table></div>
  89. <p>
  90. </p>
  91. <pre class="synopsis"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span>
  92. <span class="keyword">namespace</span> <span class="identifier">contract</span> <span class="special">{</span>
  93. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">bool</span> Pred<span class="special">,</span> <span class="keyword">typename</span> Then<span class="special">,</span> <span class="keyword">typename</span> ThenResult <span class="special">=</span> <span class="identifier">internal_type</span><span class="special">&gt;</span>
  94. <span class="keyword">struct</span> <a class="link" href="boost/contract/call_if_statement.html" title="Struct template call_if_statement">call_if_statement</a><span class="special">;</span>
  95. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Then<span class="special">&gt;</span>
  96. <span class="keyword">struct</span> <a class="link" href="boost/contract/call_if__idm45395000098448.html" title="Struct template call_if_statement&lt;false, Then, internal_type&gt;">call_if_statement</a><span class="special">&lt;</span><span class="keyword">false</span><span class="special">,</span> <span class="identifier">Then</span><span class="special">,</span> <span class="identifier">internal_type</span><span class="special">&gt;</span><span class="special">;</span>
  97. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Then<span class="special">&gt;</span> <span class="keyword">struct</span> <a class="link" href="boost/contract/call_if__idm45395000058976.html" title="Struct template call_if_statement&lt;true, Then, internal_type&gt;">call_if_statement</a><span class="special">&lt;</span><span class="keyword">true</span><span class="special">,</span> <span class="identifier">Then</span><span class="special">,</span> <span class="identifier">internal_type</span><span class="special">&gt;</span><span class="special">;</span>
  98. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Then<span class="special">,</span> <span class="keyword">typename</span> ThenResult<span class="special">&gt;</span>
  99. <span class="keyword">struct</span> <a class="link" href="boost/contract/call_if__idm45395000042848.html" title="Struct template call_if_statement&lt;true, Then, ThenResult&gt;">call_if_statement</a><span class="special">&lt;</span><span class="keyword">true</span><span class="special">,</span> <span class="identifier">Then</span><span class="special">,</span> <span class="identifier">ThenResult</span><span class="special">&gt;</span><span class="special">;</span>
  100. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Then<span class="special">&gt;</span> <span class="keyword">struct</span> <a class="link" href="boost/contract/call_if__idm45395000002720.html" title="Struct template call_if_statement&lt;true, Then, void&gt;">call_if_statement</a><span class="special">&lt;</span><span class="keyword">true</span><span class="special">,</span> <span class="identifier">Then</span><span class="special">,</span> <span class="keyword">void</span><span class="special">&gt;</span><span class="special">;</span>
  101. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">bool</span> Pred<span class="special">,</span> <span class="keyword">typename</span> Then<span class="special">&gt;</span>
  102. <a class="link" href="boost/contract/call_if_statement.html" title="Struct template call_if_statement">call_if_statement</a><span class="special">&lt;</span> <span class="identifier">Pred</span><span class="special">,</span> <span class="identifier">Then</span> <span class="special">&gt;</span> <a class="link" href="boost/contract/call_if_c.html" title="Function template call_if_c"><span class="identifier">call_if_c</span></a><span class="special">(</span><span class="identifier">Then</span><span class="special">)</span><span class="special">;</span>
  103. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Pred<span class="special">,</span> <span class="keyword">typename</span> Then<span class="special">&gt;</span>
  104. <a class="link" href="boost/contract/call_if_statement.html" title="Struct template call_if_statement">call_if_statement</a><span class="special">&lt;</span> <span class="identifier">Pred</span><span class="special">::</span><span class="identifier">value</span><span class="special">,</span> <span class="identifier">Then</span> <span class="special">&gt;</span> <a class="link" href="boost/contract/call_if.html" title="Function template call_if"><span class="identifier">call_if</span></a><span class="special">(</span><span class="identifier">Then</span><span class="special">)</span><span class="special">;</span>
  105. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">bool</span> Pred<span class="special">,</span> <span class="keyword">typename</span> Then<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="boost/contract/condition_if_c.html" title="Function template condition_if_c"><span class="identifier">condition_if_c</span></a><span class="special">(</span><span class="identifier">Then</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">=</span> <span class="keyword">true</span><span class="special">)</span><span class="special">;</span>
  106. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Pred<span class="special">,</span> <span class="keyword">typename</span> Then<span class="special">&gt;</span>
  107. <span class="keyword">bool</span> <a class="link" href="boost/contract/condition_if.html" title="Function template condition_if"><span class="identifier">condition_if</span></a><span class="special">(</span><span class="identifier">Then</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">=</span> <span class="keyword">true</span><span class="special">)</span><span class="special">;</span>
  108. <span class="special">}</span>
  109. <span class="special">}</span></pre>
  110. </div>
  111. <div class="section">
  112. <div class="titlepage"><div><div><h3 class="title">
  113. <a name="header.boost.contract.check_hpp"></a>Header &lt;<a href="../../../../boost/contract/check.hpp" target="_top">boost/contract/check.hpp</a>&gt;</h3></div></div></div>
  114. <p>RAII object that checks contracts. </p>
  115. <pre class="synopsis"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span>
  116. <span class="keyword">namespace</span> <span class="identifier">contract</span> <span class="special">{</span>
  117. <span class="keyword">class</span> <a class="link" href="boost/contract/check.html" title="Class check">check</a><span class="special">;</span>
  118. <span class="special">}</span>
  119. <span class="special">}</span></pre>
  120. </div>
  121. <div class="section">
  122. <div class="titlepage"><div><div><h3 class="title">
  123. <a name="header.boost.contract.constructor_hpp"></a>Header &lt;<a href="../../../../boost/contract/constructor.hpp" target="_top">boost/contract/constructor.hpp</a>&gt;</h3></div></div></div>
  124. <p>Program contracts for constructors. </p>
  125. <pre class="synopsis"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span>
  126. <span class="keyword">namespace</span> <span class="identifier">contract</span> <span class="special">{</span>
  127. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Class<span class="special">&gt;</span>
  128. <a class="link" href="boost/contract/specify__idm45394999245856.html" title="Class template specify_old_postcondition_except">specify_old_postcondition_except</a> <a class="link" href="boost/contract/constructor.html" title="Function template constructor"><span class="identifier">constructor</span></a><span class="special">(</span><span class="identifier">Class</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span>
  129. <span class="special">}</span>
  130. <span class="special">}</span></pre>
  131. </div>
  132. <div class="section">
  133. <div class="titlepage"><div><div><h3 class="title">
  134. <a name="header.boost.contract.core.access_hpp"></a>Header &lt;<a href="../../../../boost/contract/core/access.hpp" target="_top">boost/contract/core/access.hpp</a>&gt;</h3></div></div></div>
  135. <p>Allow to declare invariants, base types, etc all as private members. </p>
  136. <pre class="synopsis"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span>
  137. <span class="keyword">namespace</span> <span class="identifier">contract</span> <span class="special">{</span>
  138. <span class="keyword">class</span> <a class="link" href="boost/contract/access.html" title="Class access">access</a><span class="special">;</span>
  139. <span class="special">}</span>
  140. <span class="special">}</span></pre>
  141. </div>
  142. <div class="section">
  143. <div class="titlepage"><div><div><h3 class="title">
  144. <a name="header.boost.contract.core.check_macro_hpp"></a>Header &lt;<a href="../../../../boost/contract/core/check_macro.hpp" target="_top">boost/contract/core/check_macro.hpp</a>&gt;</h3></div></div></div>
  145. <p>Macros for implementation checks. </p>
  146. <pre class="synopsis">
  147. <a class="link" href="BOOST_CONTRACT_CHECK.html" title="Macro BOOST_CONTRACT_CHECK">BOOST_CONTRACT_CHECK</a>(cond)
  148. <a class="link" href="BOOST_CONTRACT_CHECK_AUDIT.html" title="Macro BOOST_CONTRACT_CHECK_AUDIT">BOOST_CONTRACT_CHECK_AUDIT</a>(cond)
  149. <a class="link" href="BOOST_CONTRACT_CHECK_AXIOM.html" title="Macro BOOST_CONTRACT_CHECK_AXIOM">BOOST_CONTRACT_CHECK_AXIOM</a>(cond)</pre>
  150. </div>
  151. <div class="section">
  152. <div class="titlepage"><div><div><h3 class="title">
  153. <a name="header.boost.contract.core.config_hpp"></a>Header &lt;<a href="../../../../boost/contract/core/config.hpp" target="_top">boost/contract/core/config.hpp</a>&gt;</h3></div></div></div>
  154. <p>Configure this library compile-time and run-time behaviours. </p>
  155. <pre class="synopsis">
  156. <a class="link" href="BOOST_CONTRACT_DYN_LINK.html" title="Macro BOOST_CONTRACT_DYN_LINK">BOOST_CONTRACT_DYN_LINK</a>
  157. <a class="link" href="BOOST_CONTRACT_STATIC_LINK.html" title="Macro BOOST_CONTRACT_STATIC_LINK">BOOST_CONTRACT_STATIC_LINK</a>
  158. <a class="link" href="BOOST_CONTRACT_HEADER_ONLY.html" title="Macro BOOST_CONTRACT_HEADER_ONLY">BOOST_CONTRACT_HEADER_ONLY</a>
  159. <a class="link" href="BOOST_CO_idm45394999743888.html" title="Macro BOOST_CONTRACT_DISABLE_THREADS">BOOST_CONTRACT_DISABLE_THREADS</a>
  160. <a class="link" href="BOOST_CONTRACT_MAX_ARGS.html" title="Macro BOOST_CONTRACT_MAX_ARGS">BOOST_CONTRACT_MAX_ARGS</a>
  161. <a class="link" href="BOOST_CO_idm45394999732400.html" title="Macro BOOST_CONTRACT_BASES_TYPEDEF">BOOST_CONTRACT_BASES_TYPEDEF</a>
  162. <a class="link" href="BOOST_CO_idm45394999724496.html" title="Macro BOOST_CONTRACT_INVARIANT_FUNC">BOOST_CONTRACT_INVARIANT_FUNC</a>
  163. <a class="link" href="BOOST_CO_idm45394999714768.html" title="Macro BOOST_CONTRACT_STATIC_INVARIANT_FUNC">BOOST_CONTRACT_STATIC_INVARIANT_FUNC</a>
  164. <a class="link" href="BOOST_CONTRACT_PERMISSIVE.html" title="Macro BOOST_CONTRACT_PERMISSIVE">BOOST_CONTRACT_PERMISSIVE</a>
  165. <a class="link" href="BOOST_CO_idm45394999694064.html" title="Macro BOOST_CONTRACT_ON_MISSING_CHECK_DECL">BOOST_CONTRACT_ON_MISSING_CHECK_DECL</a>
  166. <a class="link" href="BOOST_CO_idm45394999685184.html" title="Macro BOOST_CONTRACT_PRECONDITIONS_DISABLE_NO_ASSERTION">BOOST_CONTRACT_PRECONDITIONS_DISABLE_NO_ASSERTION</a>
  167. <a class="link" href="BOOST_CO_idm45394999679376.html" title="Macro BOOST_CONTRACT_ALL_DISABLE_NO_ASSERTION">BOOST_CONTRACT_ALL_DISABLE_NO_ASSERTION</a>
  168. <a class="link" href="BOOST_CONTRACT_AUDITS.html" title="Macro BOOST_CONTRACT_AUDITS">BOOST_CONTRACT_AUDITS</a>
  169. <a class="link" href="BOOST_CONTRACT_NO_CHECKS.html" title="Macro BOOST_CONTRACT_NO_CHECKS">BOOST_CONTRACT_NO_CHECKS</a>
  170. <a class="link" href="BOOST_CO_idm45394999662416.html" title="Macro BOOST_CONTRACT_NO_PRECONDITIONS">BOOST_CONTRACT_NO_PRECONDITIONS</a>
  171. <a class="link" href="BOOST_CO_idm45394999656032.html" title="Macro BOOST_CONTRACT_NO_POSTCONDITIONS">BOOST_CONTRACT_NO_POSTCONDITIONS</a>
  172. <a class="link" href="BOOST_CONTRACT_NO_EXCEPTS.html" title="Macro BOOST_CONTRACT_NO_EXCEPTS">BOOST_CONTRACT_NO_EXCEPTS</a>
  173. <a class="link" href="BOOST_CO_idm45394999637264.html" title="Macro BOOST_CONTRACT_NO_ENTRY_INVARIANTS">BOOST_CONTRACT_NO_ENTRY_INVARIANTS</a>
  174. <a class="link" href="BOOST_CO_idm45394999629648.html" title="Macro BOOST_CONTRACT_NO_EXIT_INVARIANTS">BOOST_CONTRACT_NO_EXIT_INVARIANTS</a>
  175. <a class="link" href="BOOST_CO_idm45394999622032.html" title="Macro BOOST_CONTRACT_NO_INVARIANTS">BOOST_CONTRACT_NO_INVARIANTS</a>
  176. <a class="link" href="BOOST_CONTRACT_NO_OLDS.html" title="Macro BOOST_CONTRACT_NO_OLDS">BOOST_CONTRACT_NO_OLDS</a>
  177. <a class="link" href="BOOST_CO_idm45394999605408.html" title="Macro BOOST_CONTRACT_NO_CONSTRUCTORS">BOOST_CONTRACT_NO_CONSTRUCTORS</a>
  178. <a class="link" href="BOOST_CO_idm45394999594544.html" title="Macro BOOST_CONTRACT_NO_DESTRUCTORS">BOOST_CONTRACT_NO_DESTRUCTORS</a>
  179. <a class="link" href="BOOST_CO_idm45394999586272.html" title="Macro BOOST_CONTRACT_NO_PUBLIC_FUNCTIONS">BOOST_CONTRACT_NO_PUBLIC_FUNCTIONS</a>
  180. <a class="link" href="BOOST_CO_idm45394999577072.html" title="Macro BOOST_CONTRACT_NO_FUNCTIONS">BOOST_CONTRACT_NO_FUNCTIONS</a>
  181. <a class="link" href="BOOST_CO_idm45394999566736.html" title="Macro BOOST_CONTRACT_NO_CONDITIONS">BOOST_CONTRACT_NO_CONDITIONS</a>
  182. <a class="link" href="BOOST_CONTRACT_NO_ALL.html" title="Macro BOOST_CONTRACT_NO_ALL">BOOST_CONTRACT_NO_ALL</a></pre>
  183. </div>
  184. <div class="section">
  185. <div class="titlepage"><div><div><h3 class="title">
  186. <a name="header.boost.contract.core.constructor_precondition_hpp"></a>Header &lt;<a href="../../../../boost/contract/core/constructor_precondition.hpp" target="_top">boost/contract/core/constructor_precondition.hpp</a>&gt;</h3></div></div></div>
  187. <p>Program preconditions for constructors. </p>
  188. <pre class="synopsis"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span>
  189. <span class="keyword">namespace</span> <span class="identifier">contract</span> <span class="special">{</span>
  190. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Class<span class="special">&gt;</span> <span class="keyword">class</span> <a class="link" href="boost/contract/constructor_precondition.html" title="Class template constructor_precondition">constructor_precondition</a><span class="special">;</span>
  191. <span class="special">}</span>
  192. <span class="special">}</span></pre>
  193. </div>
  194. <div class="section">
  195. <div class="titlepage"><div><div><h3 class="title">
  196. <a name="header.boost.contract.core.exception_hpp"></a>Header &lt;<a href="../../../../boost/contract/core/exception.hpp" target="_top">boost/contract/core/exception.hpp</a>&gt;</h3></div></div></div>
  197. <p>Handle contract assertion failures. </p>
  198. <pre class="synopsis"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span>
  199. <span class="keyword">namespace</span> <span class="identifier">contract</span> <span class="special">{</span>
  200. <span class="keyword">class</span> <a class="link" href="boost/contract/assertion_failure.html" title="Class assertion_failure">assertion_failure</a><span class="special">;</span>
  201. <span class="keyword">class</span> <a class="link" href="boost/contract/bad_virtual_result_cast.html" title="Class bad_virtual_result_cast">bad_virtual_result_cast</a><span class="special">;</span>
  202. <span class="keyword">class</span> <a class="link" href="boost/contract/exception.html" title="Class exception">exception</a><span class="special">;</span>
  203. <span class="keyword">enum</span> <a class="link" href="boost/contract/from.html" title="Type from">from</a><span class="special">;</span>
  204. <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">function</span><span class="special">&lt;</span> <span class="keyword">void</span><span class="special">(</span><span class="identifier">from</span><span class="special">)</span><span class="special">&gt;</span> <a class="link" href="boost/contract/from_failure_handler.html" title="Type definition from_failure_handler"><span class="identifier">from_failure_handler</span></a><span class="special">;</span>
  205. <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">function</span><span class="special">&lt;</span> <span class="keyword">void</span><span class="special">(</span><span class="special">)</span><span class="special">&gt;</span> <a class="link" href="boost/contract/failure_handler.html" title="Type definition failure_handler"><span class="identifier">failure_handler</span></a><span class="special">;</span>
  206. <span class="identifier">failure_handler</span> <span class="keyword">const</span> <span class="special">&amp;</span> <a class="link" href="boost/contract/set_check_failure.html" title="Function set_check_failure"><span class="identifier">set_check_failure</span></a><span class="special">(</span><span class="identifier">failure_handler</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  207. <span class="identifier">failure_handler</span> <a class="link" href="boost/contract/get_check_failure.html" title="Function get_check_failure"><span class="identifier">get_check_failure</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  208. <span class="keyword">void</span> <a class="link" href="boost/contract/check_failure.html" title="Function check_failure"><span class="identifier">check_failure</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  209. <span class="identifier">from_failure_handler</span> <span class="keyword">const</span> <span class="special">&amp;</span>
  210. <a class="link" href="boost/contract/set_precondition_failure.html" title="Function set_precondition_failure"><span class="identifier">set_precondition_failure</span></a><span class="special">(</span><span class="identifier">from_failure_handler</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  211. <span class="identifier">from_failure_handler</span> <a class="link" href="boost/contract/get_precondition_failure.html" title="Function get_precondition_failure"><span class="identifier">get_precondition_failure</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  212. <span class="keyword">void</span> <a class="link" href="boost/contract/precondition_failure.html" title="Function precondition_failure"><span class="identifier">precondition_failure</span></a><span class="special">(</span><span class="identifier">from</span><span class="special">)</span><span class="special">;</span>
  213. <span class="identifier">from_failure_handler</span> <span class="keyword">const</span> <span class="special">&amp;</span>
  214. <a class="link" href="boost/contract/set_postcondition_failure.html" title="Function set_postcondition_failure"><span class="identifier">set_postcondition_failure</span></a><span class="special">(</span><span class="identifier">from_failure_handler</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  215. <span class="identifier">from_failure_handler</span> <a class="link" href="boost/contract/get_postcondition_failure.html" title="Function get_postcondition_failure"><span class="identifier">get_postcondition_failure</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  216. <span class="keyword">void</span> <a class="link" href="boost/contract/postcondition_failure.html" title="Function postcondition_failure"><span class="identifier">postcondition_failure</span></a><span class="special">(</span><span class="identifier">from</span><span class="special">)</span><span class="special">;</span>
  217. <span class="identifier">from_failure_handler</span> <span class="keyword">const</span> <span class="special">&amp;</span>
  218. <a class="link" href="boost/contract/set_except_failure.html" title="Function set_except_failure"><span class="identifier">set_except_failure</span></a><span class="special">(</span><span class="identifier">from_failure_handler</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  219. <span class="identifier">from_failure_handler</span> <a class="link" href="boost/contract/get_except_failure.html" title="Function get_except_failure"><span class="identifier">get_except_failure</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  220. <span class="keyword">void</span> <a class="link" href="boost/contract/except_failure.html" title="Function except_failure"><span class="identifier">except_failure</span></a><span class="special">(</span><span class="identifier">from</span><span class="special">)</span><span class="special">;</span>
  221. <span class="identifier">from_failure_handler</span> <span class="keyword">const</span> <span class="special">&amp;</span>
  222. <a class="link" href="boost/contract/set_old_failure.html" title="Function set_old_failure"><span class="identifier">set_old_failure</span></a><span class="special">(</span><span class="identifier">from_failure_handler</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  223. <span class="identifier">from_failure_handler</span> <a class="link" href="boost/contract/get_old_failure.html" title="Function get_old_failure"><span class="identifier">get_old_failure</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  224. <span class="keyword">void</span> <a class="link" href="boost/contract/old_failure.html" title="Function old_failure"><span class="identifier">old_failure</span></a><span class="special">(</span><span class="identifier">from</span><span class="special">)</span><span class="special">;</span>
  225. <span class="identifier">from_failure_handler</span> <span class="keyword">const</span> <span class="special">&amp;</span>
  226. <a class="link" href="boost/contract/set_entr_idm45394999333872.html" title="Function set_entry_invariant_failure"><span class="identifier">set_entry_invariant_failure</span></a><span class="special">(</span><span class="identifier">from_failure_handler</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  227. <span class="identifier">from_failure_handler</span> <a class="link" href="boost/contract/get_entr_idm45394999324384.html" title="Function get_entry_invariant_failure"><span class="identifier">get_entry_invariant_failure</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  228. <span class="keyword">void</span> <a class="link" href="boost/contract/entry_invariant_failure.html" title="Function entry_invariant_failure"><span class="identifier">entry_invariant_failure</span></a><span class="special">(</span><span class="identifier">from</span><span class="special">)</span><span class="special">;</span>
  229. <span class="identifier">from_failure_handler</span> <span class="keyword">const</span> <span class="special">&amp;</span>
  230. <a class="link" href="boost/contract/set_exit_invariant_failure.html" title="Function set_exit_invariant_failure"><span class="identifier">set_exit_invariant_failure</span></a><span class="special">(</span><span class="identifier">from_failure_handler</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  231. <span class="identifier">from_failure_handler</span> <a class="link" href="boost/contract/get_exit_invariant_failure.html" title="Function get_exit_invariant_failure"><span class="identifier">get_exit_invariant_failure</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  232. <span class="keyword">void</span> <a class="link" href="boost/contract/exit_invariant_failure.html" title="Function exit_invariant_failure"><span class="identifier">exit_invariant_failure</span></a><span class="special">(</span><span class="identifier">from</span><span class="special">)</span><span class="special">;</span>
  233. <span class="identifier">from_failure_handler</span> <span class="keyword">const</span> <span class="special">&amp;</span>
  234. <a class="link" href="boost/contract/set_invariant_failure.html" title="Function set_invariant_failure"><span class="identifier">set_invariant_failure</span></a><span class="special">(</span><span class="identifier">from_failure_handler</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  235. <span class="special">}</span>
  236. <span class="special">}</span></pre>
  237. </div>
  238. <div class="section">
  239. <div class="titlepage"><div><div><h3 class="title">
  240. <a name="header.boost.contract.core.specify_hpp"></a>Header &lt;<a href="../../../../boost/contract/core/specify.hpp" target="_top">boost/contract/core/specify.hpp</a>&gt;</h3></div></div></div>
  241. <p>Specify preconditions, old values copied at body, postconditions, and exception guarantees. </p>
  242. <p>Preconditions, old values copied at body, postconditions, and exception guarantees are all optionals but, when they are specified, they need to be specified in that order. </p>
  243. <pre class="synopsis"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span>
  244. <span class="keyword">namespace</span> <span class="identifier">contract</span> <span class="special">{</span>
  245. <span class="keyword">class</span> <a class="link" href="boost/contract/specify_except.html" title="Class specify_except">specify_except</a><span class="special">;</span>
  246. <span class="keyword">class</span> <a class="link" href="boost/contract/specify_nothing.html" title="Class specify_nothing">specify_nothing</a><span class="special">;</span>
  247. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> VirtualResult <span class="special">=</span> <span class="keyword">void</span><span class="special">&gt;</span>
  248. <span class="keyword">class</span> <a class="link" href="boost/contract/specify__idm45394999245856.html" title="Class template specify_old_postcondition_except">specify_old_postcondition_except</a><span class="special">;</span>
  249. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> VirtualResult <span class="special">=</span> <span class="keyword">void</span><span class="special">&gt;</span> <span class="keyword">class</span> <a class="link" href="boost/contract/specify__idm45394999207792.html" title="Class template specify_postcondition_except">specify_postcondition_except</a><span class="special">;</span>
  250. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> VirtualResult <span class="special">=</span> <span class="keyword">void</span><span class="special">&gt;</span>
  251. <span class="keyword">class</span> <a class="link" href="boost/contract/specify__idm45394999179040.html" title="Class template specify_precondition_old_postcondition_except">specify_precondition_old_postcondition_except</a><span class="special">;</span>
  252. <span class="special">}</span>
  253. <span class="special">}</span></pre>
  254. </div>
  255. <div class="section">
  256. <div class="titlepage"><div><div><h3 class="title">
  257. <a name="header.boost.contract.core.virtual_hpp"></a>Header &lt;<a href="../../../../boost/contract/core/virtual.hpp" target="_top">boost/contract/core/virtual.hpp</a>&gt;</h3></div></div></div>
  258. <p>Handle virtual public functions with contracts (for subcontracting). </p>
  259. <pre class="synopsis"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span>
  260. <span class="keyword">namespace</span> <span class="identifier">contract</span> <span class="special">{</span>
  261. <span class="keyword">class</span> <a class="link" href="boost/contract/virtual_.html" title="Class virtual_">virtual_</a><span class="special">;</span>
  262. <span class="special">}</span>
  263. <span class="special">}</span></pre>
  264. </div>
  265. <div class="section">
  266. <div class="titlepage"><div><div><h3 class="title">
  267. <a name="header.boost.contract.destructor_hpp"></a>Header &lt;<a href="../../../../boost/contract/destructor.hpp" target="_top">boost/contract/destructor.hpp</a>&gt;</h3></div></div></div>
  268. <p>Program contracts for destructors. </p>
  269. <pre class="synopsis"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span>
  270. <span class="keyword">namespace</span> <span class="identifier">contract</span> <span class="special">{</span>
  271. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Class<span class="special">&gt;</span>
  272. <a class="link" href="boost/contract/specify__idm45394999245856.html" title="Class template specify_old_postcondition_except">specify_old_postcondition_except</a> <a class="link" href="boost/contract/destructor.html" title="Function template destructor"><span class="identifier">destructor</span></a><span class="special">(</span><span class="identifier">Class</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span>
  273. <span class="special">}</span>
  274. <span class="special">}</span></pre>
  275. </div>
  276. <div class="section">
  277. <div class="titlepage"><div><div><h3 class="title">
  278. <a name="header.boost.contract.function_hpp"></a>Header &lt;<a href="../../../../boost/contract/function.hpp" target="_top">boost/contract/function.hpp</a>&gt;</h3></div></div></div>
  279. <p>Program contracts for (non-public) functions. </p>
  280. <pre class="synopsis"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span>
  281. <span class="keyword">namespace</span> <span class="identifier">contract</span> <span class="special">{</span>
  282. <a class="link" href="boost/contract/specify__idm45394999179040.html" title="Class template specify_precondition_old_postcondition_except">specify_precondition_old_postcondition_except</a> <a class="link" href="boost/contract/function.html" title="Function function"><span class="identifier">function</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  283. <span class="special">}</span>
  284. <span class="special">}</span></pre>
  285. </div>
  286. <div class="section">
  287. <div class="titlepage"><div><div><h3 class="title">
  288. <a name="header.boost.contract.old_hpp"></a>Header &lt;<a href="../../../../boost/contract/old.hpp" target="_top">boost/contract/old.hpp</a>&gt;</h3></div></div></div>
  289. <p>Handle old values. </p>
  290. <pre class="synopsis">
  291. <a class="link" href="BOOST_CONTRACT_OLDOF.html" title="Macro BOOST_CONTRACT_OLDOF">BOOST_CONTRACT_OLDOF</a>(...)</pre>
  292. <pre class="synopsis"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span>
  293. <span class="keyword">namespace</span> <span class="identifier">contract</span> <span class="special">{</span>
  294. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> <span class="keyword">struct</span> <a class="link" href="boost/contract/is_old_value_copyable.html" title="Struct template is_old_value_copyable">is_old_value_copyable</a><span class="special">;</span>
  295. <span class="keyword">class</span> <a class="link" href="boost/contract/old_pointer.html" title="Class old_pointer">old_pointer</a><span class="special">;</span>
  296. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> <span class="keyword">class</span> <a class="link" href="boost/contract/old_ptr.html" title="Class template old_ptr">old_ptr</a><span class="special">;</span>
  297. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> <span class="keyword">class</span> <a class="link" href="boost/contract/old_ptr_if_copyable.html" title="Class template old_ptr_if_copyable">old_ptr_if_copyable</a><span class="special">;</span>
  298. <span class="keyword">class</span> <a class="link" href="boost/contract/old_value.html" title="Class old_value">old_value</a><span class="special">;</span>
  299. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> <span class="keyword">struct</span> <a class="link" href="boost/contract/old_value_copy.html" title="Struct template old_value_copy">old_value_copy</a><span class="special">;</span>
  300. <a class="link" href="boost/contract/old_value.html" title="Class old_value">old_value</a> <a class="link" href="boost/contract/null_old.html" title="Function null_old"><span class="identifier">null_old</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  301. <a class="link" href="boost/contract/old_pointer.html" title="Class old_pointer">old_pointer</a> <a class="link" href="boost/contract/make_old_idm45394998968720.html" title="Function make_old"><span class="identifier">make_old</span></a><span class="special">(</span><a class="link" href="boost/contract/old_value.html" title="Class old_value">old_value</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  302. <a class="link" href="boost/contract/old_pointer.html" title="Class old_pointer">old_pointer</a> <a class="link" href="boost/contract/make_old_idm45394998958240.html" title="Function make_old"><span class="identifier">make_old</span></a><span class="special">(</span><a class="link" href="boost/contract/virtual_.html" title="Class virtual_">virtual_</a> <span class="special">*</span><span class="special">,</span> <a class="link" href="boost/contract/old_value.html" title="Class old_value">old_value</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  303. <span class="keyword">bool</span> <a class="link" href="boost/contract/copy_old_idm45394998944672.html" title="Function copy_old"><span class="identifier">copy_old</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  304. <span class="keyword">bool</span> <a class="link" href="boost/contract/copy_old_idm45394998938528.html" title="Function copy_old"><span class="identifier">copy_old</span></a><span class="special">(</span><a class="link" href="boost/contract/virtual_.html" title="Class virtual_">virtual_</a> <span class="special">*</span><span class="special">)</span><span class="special">;</span>
  305. <span class="special">}</span>
  306. <span class="special">}</span></pre>
  307. </div>
  308. <div class="section">
  309. <div class="titlepage"><div><div><h3 class="title">
  310. <a name="header.boost.contract.override_hpp"></a>Header &lt;<a href="../../../../boost/contract/override.hpp" target="_top">boost/contract/override.hpp</a>&gt;</h3></div></div></div>
  311. <p>Handle public function overrides (for subcontracting). </p>
  312. <pre class="synopsis">
  313. <a class="link" href="BOOST_CO_idm45394998912688.html" title="Macro BOOST_CONTRACT_NAMED_OVERRIDE">BOOST_CONTRACT_NAMED_OVERRIDE</a>(type_name, func_name)
  314. <a class="link" href="BOOST_CONTRACT_OVERRIDE.html" title="Macro BOOST_CONTRACT_OVERRIDE">BOOST_CONTRACT_OVERRIDE</a>(func_name)
  315. <a class="link" href="BOOST_CONTRACT_OVERRIDES.html" title="Macro BOOST_CONTRACT_OVERRIDES">BOOST_CONTRACT_OVERRIDES</a>(...)</pre>
  316. </div>
  317. <div class="section">
  318. <div class="titlepage"><div><div><h3 class="title">
  319. <a name="header.boost.contract.public_function_hpp"></a>Header &lt;<a href="../../../../boost/contract/public_function.hpp" target="_top">boost/contract/public_function.hpp</a>&gt;</h3></div></div></div>
  320. <p>Program contracts for public functions (including subcontracting). </p>
  321. <p>The different overloads handle public functions that are static, virtual void, virtual non-void, overriding void, and overriding non-void. </p>
  322. <pre class="synopsis"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span>
  323. <span class="keyword">namespace</span> <span class="identifier">contract</span> <span class="special">{</span>
  324. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Class<span class="special">&gt;</span>
  325. <a class="link" href="boost/contract/specify__idm45394999179040.html" title="Class template specify_precondition_old_postcondition_except">specify_precondition_old_postcondition_except</a> <a class="link" href="boost/contract/public_f_idm45394998885120.html" title="Function template public_function"><span class="identifier">public_function</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  326. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Class<span class="special">&gt;</span>
  327. <a class="link" href="boost/contract/specify__idm45394999179040.html" title="Class template specify_precondition_old_postcondition_except">specify_precondition_old_postcondition_except</a> <a class="link" href="boost/contract/public_f_idm45394998874224.html" title="Function template public_function"><span class="identifier">public_function</span></a><span class="special">(</span><span class="identifier">Class</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span>
  328. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Class<span class="special">&gt;</span>
  329. <a class="link" href="boost/contract/specify__idm45394999179040.html" title="Class template specify_precondition_old_postcondition_except">specify_precondition_old_postcondition_except</a>
  330. <a class="link" href="boost/contract/public_f_idm45394998859936.html" title="Function template public_function"><span class="identifier">public_function</span></a><span class="special">(</span><a class="link" href="boost/contract/virtual_.html" title="Class virtual_">virtual_</a> <span class="special">*</span><span class="special">,</span> <span class="identifier">Class</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span>
  331. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> VirtualResult<span class="special">,</span> <span class="keyword">typename</span> Class<span class="special">&gt;</span>
  332. <a class="link" href="boost/contract/specify__idm45394999179040.html" title="Class template specify_precondition_old_postcondition_except">specify_precondition_old_postcondition_except</a><span class="special">&lt;</span> <span class="identifier">VirtualResult</span> <span class="special">&gt;</span>
  333. <a class="link" href="boost/contract/public_f_idm45394998841296.html" title="Function template public_function"><span class="identifier">public_function</span></a><span class="special">(</span><a class="link" href="boost/contract/virtual_.html" title="Class virtual_">virtual_</a> <span class="special">*</span><span class="special">,</span> <span class="identifier">VirtualResult</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">Class</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span>
  334. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Override<span class="special">,</span> <span class="keyword">typename</span> F<span class="special">,</span> <span class="keyword">typename</span> Class<span class="special">,</span> <span class="keyword">typename</span><span class="special">...</span> Args<span class="special">&gt;</span>
  335. <a class="link" href="boost/contract/specify__idm45394999179040.html" title="Class template specify_precondition_old_postcondition_except">specify_precondition_old_postcondition_except</a>
  336. <a class="link" href="boost/contract/public_f_idm45394998817488.html" title="Function template public_function"><span class="identifier">public_function</span></a><span class="special">(</span><a class="link" href="boost/contract/virtual_.html" title="Class virtual_">virtual_</a> <span class="special">*</span><span class="special">,</span> <span class="identifier">F</span><span class="special">,</span> <span class="identifier">Class</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">Args</span> <span class="special">&amp;</span><span class="special">...</span><span class="special">)</span><span class="special">;</span>
  337. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Override<span class="special">,</span> <span class="keyword">typename</span> VirtualResult<span class="special">,</span> <span class="keyword">typename</span> F<span class="special">,</span>
  338. <span class="keyword">typename</span> Class<span class="special">,</span> <span class="keyword">typename</span><span class="special">...</span> Args<span class="special">&gt;</span>
  339. <a class="link" href="boost/contract/specify__idm45394999179040.html" title="Class template specify_precondition_old_postcondition_except">specify_precondition_old_postcondition_except</a><span class="special">&lt;</span> <span class="identifier">VirtualResult</span> <span class="special">&gt;</span>
  340. <a class="link" href="boost/contract/public_f_idm45394998787360.html" title="Function template public_function"><span class="identifier">public_function</span></a><span class="special">(</span><a class="link" href="boost/contract/virtual_.html" title="Class virtual_">virtual_</a> <span class="special">*</span><span class="special">,</span> <span class="identifier">VirtualResult</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">F</span><span class="special">,</span> <span class="identifier">Class</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">Args</span> <span class="special">&amp;</span><span class="special">...</span><span class="special">)</span><span class="special">;</span>
  341. <span class="special">}</span>
  342. <span class="special">}</span></pre>
  343. </div>
  344. <div class="section">
  345. <div class="titlepage"><div><div><h3 class="title">
  346. <a name="header.boost.contract_macro_hpp"></a>Header &lt;<a href="../../../../boost/contract_macro.hpp" target="_top">boost/contract_macro.hpp</a>&gt;</h3></div></div></div>
  347. <p>Allow to disable contracts to completely remove their compile-time and run-time overhead. </p>
  348. <p>This header automatically includes all header files <code class="computeroutput">boost/contract/*.hpp</code> necessary to use its macros.</p>
  349. <p>Almost all the macros defined in this header file are variadic macros. On compilers that do not support variadic macros, programmers can manually code <code class="computeroutput">#ifndef BOOST_CONTRACT_NO_...</code> statements instead (see <a class="link" href="boost_contract/extras.html#boost_contract.extras.disable_contract_compilation__macro_interface_" title="Disable Contract Compilation (Macro Interface)">
  350. Disable Contract Compilation</a>). </p>
  351. <pre class="synopsis">
  352. <a class="link" href="BOOST_CO_idm45394998748208.html" title="Macro BOOST_CONTRACT_PRECONDITION">BOOST_CONTRACT_PRECONDITION</a>(...)
  353. <a class="link" href="BOOST_CO_idm45394998736528.html" title="Macro BOOST_CONTRACT_POSTCONDITION">BOOST_CONTRACT_POSTCONDITION</a>(...)
  354. <a class="link" href="BOOST_CONTRACT_EXCEPT.html" title="Macro BOOST_CONTRACT_EXCEPT">BOOST_CONTRACT_EXCEPT</a>(...)
  355. <a class="link" href="BOOST_CONTRACT_OLD.html" title="Macro BOOST_CONTRACT_OLD">BOOST_CONTRACT_OLD</a>(...)
  356. <a class="link" href="BOOST_CONTRACT_OLD_PTR.html" title="Macro BOOST_CONTRACT_OLD_PTR">BOOST_CONTRACT_OLD_PTR</a>(...)
  357. <a class="link" href="BOOST_CO_idm45394998674080.html" title="Macro BOOST_CONTRACT_OLD_PTR_IF_COPYABLE">BOOST_CONTRACT_OLD_PTR_IF_COPYABLE</a>(...)
  358. <a class="link" href="BOOST_CONTRACT_INVARIANT.html" title="Macro BOOST_CONTRACT_INVARIANT">BOOST_CONTRACT_INVARIANT</a>(...)
  359. <a class="link" href="BOOST_CO_idm45394998635328.html" title="Macro BOOST_CONTRACT_INVARIANT_VOLATILE">BOOST_CONTRACT_INVARIANT_VOLATILE</a>(...)
  360. <a class="link" href="BOOST_CO_idm45394998621472.html" title="Macro BOOST_CONTRACT_STATIC_INVARIANT">BOOST_CONTRACT_STATIC_INVARIANT</a>(...)
  361. <a class="link" href="BOOST_CONTRACT_CONSTRUCTOR.html" title="Macro BOOST_CONTRACT_CONSTRUCTOR">BOOST_CONTRACT_CONSTRUCTOR</a>(...)
  362. <a class="link" href="BOOST_CO_idm45394998587680.html" title="Macro BOOST_CONTRACT_CONSTRUCTOR_PRECONDITION">BOOST_CONTRACT_CONSTRUCTOR_PRECONDITION</a>(...)
  363. <a class="link" href="BOOST_CONTRACT_DESTRUCTOR.html" title="Macro BOOST_CONTRACT_DESTRUCTOR">BOOST_CONTRACT_DESTRUCTOR</a>(...)
  364. <a class="link" href="BOOST_CONTRACT_FUNCTION.html" title="Macro BOOST_CONTRACT_FUNCTION">BOOST_CONTRACT_FUNCTION</a>()
  365. <a class="link" href="BOOST_CO_idm45394998534992.html" title="Macro BOOST_CONTRACT_STATIC_PUBLIC_FUNCTION">BOOST_CONTRACT_STATIC_PUBLIC_FUNCTION</a>(...)
  366. <a class="link" href="BOOST_CO_idm45394998517984.html" title="Macro BOOST_CONTRACT_PUBLIC_FUNCTION">BOOST_CONTRACT_PUBLIC_FUNCTION</a>(...)
  367. <a class="link" href="BOOST_CO_idm45394998486064.html" title="Macro BOOST_CONTRACT_PUBLIC_FUNCTION_OVERRIDE">BOOST_CONTRACT_PUBLIC_FUNCTION_OVERRIDE</a>(...)</pre>
  368. </div>
  369. </div>
  370. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  371. <td align="left"></td>
  372. <td align="right"><div class="copyright-footer">Copyright &#169; 2008-2019 Lorenzo Caminiti<p>
  373. Distributed under the Boost Software License, Version 1.0 (see accompanying
  374. file LICENSE_1_0.txt or a copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
  375. </p>
  376. </div></td>
  377. </tr></table>
  378. <hr>
  379. <div class="spirit-nav">
  380. <a accesskey="p" href="boost_contract/examples.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="index.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="BOOST_CONTRACT_ASSERT.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  381. </div>
  382. </body>
  383. </html>