libs/contract/doc/html/boost/contract/constructor_precondition.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template constructor_precondition</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="../../reference.html#header.boost.contract.core.constructor_precondition_hpp" title="Header &lt;boost/contract/core/constructor_precondition.hpp&gt;">
   9 <link rel="prev" href="../../BOOST_CONTRACT_NO_ALL.html" title="Macro BOOST_CONTRACT_NO_ALL">
  10 <link rel="next" href="assertion_failure.html" title="Class assertion_failure">
  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_NO_ALL.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html#header.boost.contract.core.constructor_precondition_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="assertion_failure.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.contract.constructor_precondition"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class template constructor_precondition</span></h2>
  29 <p>boost::contract::constructor_precondition &#8212; Program preconditions for constructors. </p>
  30 </div>
  31 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  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.core.constructor_precondition_hpp" title="Header &lt;boost/contract/core/constructor_precondition.hpp&gt;">boost/contract/core/constructor_precondition.hpp</a>&gt;
  33
  34 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Class<span class="special">&gt;</span>
  35 <span class="keyword">class</span> <a class="link" href="constructor_precondition.html" title="Class template constructor_precondition">constructor_precondition</a> <span class="special">{</span>
  36 <span class="keyword">public</span><span class="special">:</span>
  37   <span class="comment">// <a class="link" href="constructor_precondition.html#boost.contract.constructor_preconditionconstruct-copy-destruct">construct/copy/destruct</a></span>
  38   <a class="link" href="constructor_precondition.html#idm45394999534384-bb"><span class="identifier">constructor_precondition</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  39   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> F<span class="special">&gt;</span> <span class="keyword">explicit</span> <a class="link" href="constructor_precondition.html#idm45394999532192-bb"><span class="identifier">constructor_precondition</span></a><span class="special">(</span><span class="identifier">F</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  40 <span class="special">}</span><span class="special">;</span></pre></div>
  41 <div class="refsect1">
  42 <a name="idm45707996536960"></a><h2>Description</h2>
  43 <p>This class must be the very first base of the class declaring the constructor for which preconditions are programmed (that way constructor arguments can be checked by preconditions even before they are used to initialize other base classes):</p>
  44 <pre class="programlisting"><span class="keyword">class</span> <span class="identifier">u</span>
  45     <span class="preprocessor">#define</span> <span class="identifier">BASES</span> <span class="keyword">private</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">contract</span><span class="special">::</span><span class="identifier">constructor_precondition</span><span class="special">&lt;</span><span class="identifier">u</span><span class="special">&gt;</span><span class="special">,</span> \
  46             <span class="keyword">public</span> <span class="identifier">b</span>
  47     <span class="special">:</span> <span class="identifier">BASES</span>
  48 <span class="special">{</span>
  49     <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>
  50
  51     <span class="keyword">typedef</span> <span class="identifier">BOOST_CONTRACT_BASE_TYPES</span><span class="special">(</span><span class="identifier">BASES</span><span class="special">)</span> <span class="identifier">base_types</span><span class="special">;</span>
  52     <span class="preprocessor">#undef</span> <span class="identifier">BASES</span>
  53
  54 <span class="keyword">public</span><span class="special">:</span>
  55     <span class="keyword">explicit</span> <span class="identifier">u</span><span class="special">(</span><span class="keyword">unsigned</span> <span class="identifier">x</span><span class="special">)</span> <span class="special">:</span>
  56         <span class="identifier">boost</span><span class="special">::</span><span class="identifier">contract</span><span class="special">::</span><span class="identifier">constructor_precondition</span><span class="special">&lt;</span><span class="identifier">u</span><span class="special">&gt;</span><span class="special">(</span><span class="special">[</span><span class="special">&amp;</span><span class="special">]</span> <span class="special">{</span>
  57             <span class="identifier">BOOST_CONTRACT_ASSERT</span><span class="special">(</span><span class="identifier">x</span> <span class="special">!=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span>
  58             <span class="special">...</span>
  59         <span class="special">}</span><span class="special">)</span><span class="special">,</span>
  60         <span class="identifier">b</span><span class="special">(</span><span class="number">1</span><span class="special">.</span><span class="number">0</span> <span class="special">/</span> <span class="keyword">float</span><span class="special">(</span><span class="identifier">x</span><span class="special">)</span><span class="special">)</span>
  61     <span class="special">{</span>
  62         <span class="special">...</span>
  63     <span class="special">}</span>
  64
  65     <span class="special">...</span>
  66 <span class="special">}</span><span class="special">;</span>
  67 </pre>
  68 <p>User-defined classes should inherit privately from this class (to not alter the public interface of user-defined classes). In addition, this class should never be declared as a virtual base (because virtual bases are initialized only once across the entire inheritance hierarchy preventing preconditions of other base classes from being checked).</p>
  69 <p>This class cannot be used this way in a <code class="computeroutput">union</code> because unions cannot have base classes in C++. Instead, this class is used in a <code class="computeroutput">union</code> to declare a local object within the constructor definition just before <code class="computeroutput"><a class="link" href="constructor.html" title="Function template constructor">boost::contract::constructor</a></code> is used (see <a class="link" href="../../boost_contract/extras.html#boost_contract.extras.unions" title="Unions"> Unions</a>).</p>
  70 <p><span class="bold"><strong>See Also:</strong></span></p>
  71 <p> <a class="link" href="../../boost_contract/tutorial.html#boost_contract.tutorial.constructors" title="Constructors"> Constructors</a></p>
  72 <p>
  73 </p>
  74 <p>
  75
  76 </p>
  77 <div class="refsect2">
  78 <a name="idm45707996477424"></a><h3>Template Parameters</h3>
  79 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
  80 <pre class="literallayout"><span class="keyword">typename</span> Class</pre>
  81 <p>The class type of the constructor for which preconditions are being programmed. </p>
  82 </li></ol></div>
  83 </div>
  84 <div class="refsect2">
  85 <a name="idm45707996474208"></a><h3>
  86 <a name="boost.contract.constructor_preconditionconstruct-copy-destruct"></a><code class="computeroutput">constructor_precondition</code>
  87         public
  88        construct/copy/destruct</h3>
  89 <div class="orderedlist"><ol class="orderedlist" type="1">
  90 <li class="listitem">
  91 <pre class="literallayout"><a name="idm45394999534384-bb"></a><span class="identifier">constructor_precondition</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Construct this object without specifying constructor preconditions. <p>This is implicitly called for those constructors of the contracted class that do not specify preconditions.</p>
  92 <div class="note"><table border="0" summary="Note">
  93 <tr>
  94 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../doc/src/images/note.png"></td>
  95 <th align="left">Note</th>
  96 </tr>
  97 <tr><td align="left" valign="top"><p>The implementation of this library is optimized so that calling this default constructor should amount to negligible compile-time and run-time overheads (likely to be optimized away completely by most compilers). </p></td></tr>
  98 </table></div>
  99 <p>
 100 </p>
 101 </li>
 102 <li class="listitem">
 103 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> F<span class="special">&gt;</span> <span class="keyword">explicit</span> <a name="idm45394999532192-bb"></a><span class="identifier">constructor_precondition</span><span class="special">(</span><span class="identifier">F</span> <span class="keyword">const</span> <span class="special">&amp;</span> f<span class="special">)</span><span class="special">;</span></pre>Construct this object specifying constructor preconditions. <p>
 104 </p>
 105 <div class="variablelist"><table border="0" class="variablelist compact">
 106 <colgroup>
 107 <col align="left" valign="top">
 108 <col>
 109 </colgroup>
 110 <tbody><tr>
 111 <td><p><span class="term">Parameters:</span></p></td>
 112 <td><div class="variablelist"><table border="0" class="variablelist compact">
 113 <colgroup>
 114 <col align="left" valign="top">
 115 <col>
 116 </colgroup>
 117 <tbody><tr>
 118 <td><p><span class="term"><code class="computeroutput">f</code></span></p></td>
 119 <td><p>Nullary functor called by this library to check constructor preconditions <code class="computeroutput">f()</code>. Assertions within this functor call are usually programmed using <code class="computeroutput"><code class="computeroutput"><a class="link" href="../../BOOST_CONTRACT_ASSERT.html" title="Macro BOOST_CONTRACT_ASSERT">BOOST_CONTRACT_ASSERT</a></code></code>, but any exception thrown by a call to this functor indicates a contract failure (and will result in this library calling  <code class="computeroutput"><code class="computeroutput"><a class="link" href="precondition_failure.html" title="Function precondition_failure">boost::contract::precondition_failure</a></code></code>). This functor should capture variables by (constant) value, or better by (constant) reference to avoid extra copies. </p></td>
 120 </tr></tbody>
 121 </table></div></td>
 122 </tr></tbody>
 123 </table></div>
 124 </li>
 125 </ol></div>
 126 </div>
 127 </div>
 128 </div>
 129 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 130 <td align="left"></td>
 131 <td align="right"><div class="copyright-footer">Copyright &#169; 2008-2019 Lorenzo Caminiti<p>
 132         Distributed under the Boost Software License, Version 1.0 (see accompanying
 133         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>)
 134       </p>
 135 </div></td>
 136 </tr></table>
 137 <hr>
 138 <div class="spirit-nav">
 139 <a accesskey="p" href="../../BOOST_CONTRACT_NO_ALL.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html#header.boost.contract.core.constructor_precondition_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="assertion_failure.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 140 </div>
 141 </body>
 142 </html>