Home Explore Help
Register Sign In
devn00b
/
EQ2EMu
9
3
Fork 0
Files Issues 75 Pull Requests 0 Wiki
Tree: 8b3631d6ad
Branches Tags
EQ2EMu
/
EQ2
/
source
/
depends
/
boost_1_72_0
/
libs
/
contract
/
doc
/
html
/
BOOST_CONTRACT_CONSTRUCTOR.html

BOOST_CONTRACT_CONSTRUCTOR.html 11 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107 
  1. <html>
    2. 

  2. <head>
    3. 

  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
    4. 

  4. <title>Macro BOOST_CONTRACT_CONSTRUCTOR</title>
    5. 

  5. <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
    6. 

  6. <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
    7. 

  7. <link rel="home" href="index.html" title="Chapter&#160;1.&#160;Boost.Contract 1.0.0">
    8. 

  8. <link rel="up" href="reference.html#header.boost.contract_macro_hpp" title="Header &lt;boost/contract_macro.hpp&gt;">
    9. 

  9. <link rel="prev" href="BOOST_CO_idm45394998621472.html" title="Macro BOOST_CONTRACT_STATIC_INVARIANT">
    10. 

  10. <link rel="next" href="BOOST_CO_idm45394998587680.html" title="Macro BOOST_CONTRACT_CONSTRUCTOR_PRECONDITION">
    11. 

  11. </head>
    12. 

  12. <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
    13. 

  13. <table cellpadding="2" width="100%"><tr>
    14. 

  14. <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
    15. 

  15. <td align="center"><a href="../../../../index.html">Home</a></td>
    16. 

  16. <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
    17. 

  17. <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
    18. 

  18. <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
    19. 

  19. <td align="center"><a href="../../../../more/index.htm">More</a></td>
    20. 

  20. </tr></table>
    21. 

  21. <hr>
    22. 

  22. <div class="spirit-nav">
    23. 

  23. <a accesskey="p" href="BOOST_CO_idm45394998621472.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="reference.html#header.boost.contract_macro_hpp"><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_CO_idm45394998587680.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
    24. 

  24. </div>
    25. 

  25. <div class="refentry">
    26. 

  26. <a name="BOOST_CONTRACT_CONSTRUCTOR"></a><div class="titlepage"></div>
    27. 

  27. <div class="refnamediv">
    28. 

  28. <h2><span class="refentrytitle">Macro BOOST_CONTRACT_CONSTRUCTOR</span></h2>
    29. 

  29. <p>BOOST_CONTRACT_CONSTRUCTOR &#8212; Program contracts that can be completely disabled at compile-time for constructors. </p>
    30. 

  30. </div>
    31. 

  31. <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
    32. 

  32. <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="reference.html#header.boost.contract_macro_hpp" title="Header &lt;boost/contract_macro.hpp&gt;">boost/contract_macro.hpp</a>&gt;
    33. 

  33. 

  34. </span>BOOST_CONTRACT_CONSTRUCTOR(...)</pre></div>
    35. 

  35. <div class="refsect1">
    36. 

  36. <a name="idm45707992585824"></a><h2>Description</h2>
    37. 

  37. <p>This is used together with <code class="computeroutput"><a class="link" href="BOOST_CO_idm45394998736528.html" title="Macro BOOST_CONTRACT_POSTCONDITION">BOOST_CONTRACT_POSTCONDITION</a></code>,  <code class="computeroutput"><a class="link" href="BOOST_CONTRACT_EXCEPT.html" title="Macro BOOST_CONTRACT_EXCEPT">BOOST_CONTRACT_EXCEPT</a></code>, and <code class="computeroutput"><a class="link" href="BOOST_CONTRACT_OLD.html" title="Macro BOOST_CONTRACT_OLD">BOOST_CONTRACT_OLD</a></code> to specify postconditions, exception guarantees, and old value copies at body that can be completely disabled at compile-time for constructors (see  <code class="computeroutput"><a class="link" href="BOOST_CO_idm45394998587680.html" title="Macro BOOST_CONTRACT_CONSTRUCTOR_PRECONDITION">BOOST_CONTRACT_CONSTRUCTOR_PRECONDITION</a></code> to specify preconditions for constructors):</p>
    38. 

  38. <pre class="programlisting"><span class="keyword">class</span> <span class="identifier">u</span> <span class="special">{</span>
    39. 

  39.     <span class="keyword">friend</span> <span class="keyword">class</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">contract</span><span class="special">::</span><span class="identifier">access</span><span class="special">;</span>
    40. 

  40. 

  41.     <span class="identifier">BOOST_CONTRACT_INVARIANT</span><span class="special">(</span><span class="special">{</span> <span class="comment">// Optional (as for static and volatile).</span>
    42. 

  42.         <span class="identifier">BOOST_CONTRACT_ASSERT</span><span class="special">(</span><span class="special">...</span><span class="special">)</span><span class="special">;</span>
    43. 

  43.         <span class="special">...</span>
    44. 

  44.     <span class="special">}</span><span class="special">)</span>
    45. 

  45. 

  46. <span class="keyword">public</span><span class="special">:</span>
    47. 

  47.     <span class="identifier">u</span><span class="special">(</span><span class="special">...</span><span class="special">)</span> <span class="special">{</span>
    48. 

  48.         <span class="identifier">BOOST_CONTRACT_OLD_PTR</span><span class="special">(</span><span class="identifier">old_type</span><span class="special">)</span><span class="special">(</span><span class="identifier">old_var</span><span class="special">)</span><span class="special">;</span>
    49. 

  49.         <span class="identifier">BOOST_CONTRACT_CONSTRUCTOR</span><span class="special">(</span><span class="keyword">this</span><span class="special">)</span>
    50. 

  50.             <span class="comment">// No `PRECONDITION` (use `CONSTRUCTOR_PRECONDITION` if needed).</span>
    51. 

  51.             <span class="identifier">BOOST_CONTRACT_OLD</span><span class="special">(</span><span class="special">[</span><span class="special">&amp;</span><span class="special">]</span> <span class="special">{</span> <span class="comment">// Optional.</span>
    52. 

  52.                 <span class="identifier">old_var</span> <span class="special">=</span> <span class="identifier">BOOST_CONTRACT_OLDOF</span><span class="special">(</span><span class="identifier">old_epxr</span><span class="special">)</span><span class="special">;</span>
    53. 

  53.                 <span class="special">...</span>
    54. 

  54.             <span class="special">}</span><span class="special">)</span>
    55. 

  55.             <span class="identifier">BOOST_CONTRACT_POSTCONDITION</span><span class="special">(</span><span class="special">[</span><span class="special">&amp;</span><span class="special">]</span> <span class="special">{</span> <span class="comment">// Optional.</span>
    56. 

  56.                 <span class="identifier">BOOST_CONTRACT_ASSERT</span><span class="special">(</span><span class="special">...</span><span class="special">)</span><span class="special">;</span>
    57. 

  57.                 <span class="special">...</span>
    58. 

  58.             <span class="special">}</span><span class="special">)</span>
    59. 

  59.             <span class="identifier">BOOST_CONTRACT_EXCEPT</span><span class="special">(</span><span class="special">[</span><span class="special">&amp;</span><span class="special">]</span> <span class="special">{</span> <span class="comment">// Optional.</span>
    60. 

  60.                 <span class="identifier">BOOST_CONTRACT_ASSERT</span><span class="special">(</span><span class="special">...</span><span class="special">)</span><span class="special">;</span>
    61. 

  61.                 <span class="special">...</span>
    62. 

  62.             <span class="special">}</span><span class="special">)</span>
    63. 

  63.         <span class="special">;</span> <span class="comment">// Trailing `;` is required.</span>
    64. 

  64. 

  65.         <span class="special">...</span> <span class="comment">// Constructor body.</span>
    66. 

  66.     <span class="special">}</span>
    67. 

  67. 

  68.     <span class="special">...</span>
    69. 

  69. <span class="special">}</span><span class="special">;</span>
    70. 

  70. </pre>
    71. 

  71. <p>For optimization, this can be omitted for constructors that do not have postconditions and exception guarantees, within classes that have no invariants.</p>
    72. 

  72. <p><code class="computeroutput">BOOST_CONTRACT_CONSTRUCTOR(obj)</code> expands to code equivalent to the following (note that no code is generated when  <code class="computeroutput"><a class="link" href="BOOST_CO_idm45394999605408.html" title="Macro BOOST_CONTRACT_NO_CONSTRUCTORS">BOOST_CONTRACT_NO_CONSTRUCTORS</a></code> is defined):</p>
    73. 

  73. <pre class="programlisting"><span class="preprocessor">#ifndef</span> <span class="identifier">BOOST_CONTRACT_NO_CONSTRUCTORS</span>
    74. 

  74.     <span class="identifier">boost</span><span class="special">::</span><span class="identifier">contract</span><span class="special">::</span><span class="identifier">check</span> <span class="identifier">internal_var</span> <span class="special">=</span>
    75. 

  75.             <span class="identifier">boost</span><span class="special">::</span><span class="identifier">contract</span><span class="special">::</span><span class="identifier">constructor</span><span class="special">(</span><span class="identifier">obj</span><span class="special">)</span>
    76. 

  76. <span class="preprocessor">#endif</span>
    77. 

  77. </pre>
    78. 

  78. <p>Where:</p>
    79. 

  79. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
    80. 

  80. <li class="listitem"><p><code class="computeroutput"><span class="bold"><strong>obj</strong></span></code> is the object <code class="computeroutput">this</code> from the scope of the enclosing constructor declaring the contract. Constructors check all class invariants, including static and volatile invariants (see <code class="computeroutput"><a class="link" href="BOOST_CONTRACT_INVARIANT.html" title="Macro BOOST_CONTRACT_INVARIANT">BOOST_CONTRACT_INVARIANT</a></code>,  <code class="computeroutput"><a class="link" href="BOOST_CO_idm45394998621472.html" title="Macro BOOST_CONTRACT_STATIC_INVARIANT">BOOST_CONTRACT_STATIC_INVARIANT</a></code>, and  <code class="computeroutput"><a class="link" href="BOOST_CO_idm45394998635328.html" title="Macro BOOST_CONTRACT_INVARIANT_VOLATILE">BOOST_CONTRACT_INVARIANT_VOLATILE</a></code>). (This is a variadic macro parameter so it can contain commas not protected by round parenthesis.) </p></li>
    81. 

  81. <li class="listitem"><p><code class="computeroutput"><span class="bold"><strong>internal_var</strong></span></code> is a variable name internally generated by this library (this name is unique but only on different line numbers so this macro cannot be expanded multiple times on the same line).</p></li>
    82. 

  82. </ul></div>
    83. 

  83. <p>
    84. 

  84. </p>
    85. 

  85. <p><span class="bold"><strong>See Also:</strong></span></p>
    86. 

  86. <p> <a class="link" href="boost_contract/extras.html#boost_contract.extras.disable_contract_compilation__macro_interface_" title="Disable Contract Compilation (Macro Interface)">
    87. 

  87.         Disable Contract Compilation</a>,  <a class="link" href="boost_contract/tutorial.html#boost_contract.tutorial.constructors" title="Constructors"> Constructors</a> </p>
    88. 

  88. <p>
    89. 

  89. </p>
    90. 

  90. <p>
    91. 

  91. </p>
    92. 

  92. </div>
    93. 

  93. </div>
    94. 

  94. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
    95. 

  95. <td align="left"></td>
    96. 

  96. <td align="right"><div class="copyright-footer">Copyright &#169; 2008-2019 Lorenzo Caminiti<p>
    97. 

  97.         Distributed under the Boost Software License, Version 1.0 (see accompanying
    98. 

  98.         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>)
    99. 

  99.       </p>
    100. 

  100. </div></td>
    101. 

  101. </tr></table>
    102. 

  102. <hr>
    103. 

  103. <div class="spirit-nav">
    104. 

  104. <a accesskey="p" href="BOOST_CO_idm45394998621472.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="reference.html#header.boost.contract_macro_hpp"><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_CO_idm45394998587680.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
    105. 

  105. </div>
    106. 

  106. </body>
    107. 

  107. </html>
    108.