libs/contract/doc/html/boost/contract/function.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Function 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="../../index.html" title="Chapter&#160;1.&#160;Boost.Contract 1.0.0">
   8 <link rel="up" href="../../reference.html#header.boost.contract.function_hpp" title="Header &lt;boost/contract/function.hpp&gt;">
   9 <link rel="prev" href="destructor.html" title="Function template destructor">
  10 <link rel="next" href="is_old_value_copyable.html" title="Struct template is_old_value_copyable">
  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="destructor.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html#header.boost.contract.function_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="is_old_value_copyable.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.contract.function"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Function function</span></h2>
  29 <p>boost::contract::function &#8212; Program contracts for non-member, private and protected functions. </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.function_hpp" title="Header &lt;boost/contract/function.hpp&gt;">boost/contract/function.hpp</a>&gt;
  33
  34 </span>
  35 <a class="link" href="specify__idm45394999179040.html" title="Class template specify_precondition_old_postcondition_except">specify_precondition_old_postcondition_except</a> <span class="identifier">function</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></div>
  36 <div class="refsect1">
  37 <a name="idm45707994921728"></a><h2>Description</h2>
  38 <p>This is used to specify preconditions, postconditions, exception guarantees, and old value copies at body for non-member, private and protected functions (these functions never check class invariants, see  <a class="link" href="../../boost_contract/contract_programming_overview.html#boost_contract.contract_programming_overview.function_calls" title="Function Calls"> Function Calls</a>):</p>
  39 <pre class="programlisting"><span class="keyword">void</span> <span class="identifier">f</span><span class="special">(</span><span class="special">...</span><span class="special">)</span> <span class="special">{</span>
  40     <span class="identifier">boost</span><span class="special">::</span><span class="identifier">contract</span><span class="special">::</span><span class="identifier">old_ptr</span><span class="special">&lt;</span><span class="identifier">old_type</span><span class="special">&gt;</span> <span class="identifier">old_var</span><span class="special">;</span>
  41     <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">c</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">contract</span><span class="special">::</span><span class="identifier">function</span><span class="special">(</span><span class="special">)</span>
  42         <span class="special">.</span><span class="identifier">precondition</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>
  43             <span class="identifier">BOOST_CONTRACT_ASSERT</span><span class="special">(</span><span class="special">...</span><span class="special">)</span><span class="special">;</span>
  44             <span class="special">...</span>
  45         <span class="special">}</span><span class="special">)</span>
  46         <span class="special">.</span><span class="identifier">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>
  47             <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_expr</span><span class="special">)</span><span class="special">;</span>
  48             <span class="special">...</span>
  49         <span class="special">}</span><span class="special">)</span>
  50         <span class="special">.</span><span class="identifier">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>
  51             <span class="identifier">BOOST_CONTRACT_ASSERT</span><span class="special">(</span><span class="special">...</span><span class="special">)</span><span class="special">;</span>
  52             <span class="special">...</span>
  53         <span class="special">}</span><span class="special">)</span>
  54         <span class="special">.</span><span class="identifier">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>
  55             <span class="identifier">BOOST_CONTRACT_ASSERT</span><span class="special">(</span><span class="special">...</span><span class="special">)</span><span class="special">;</span>
  56             <span class="special">...</span>
  57         <span class="special">}</span><span class="special">)</span>
  58     <span class="special">;</span>
  59
  60     <span class="special">...</span> <span class="comment">// Function body.</span>
  61 <span class="special">}</span>
  62 </pre>
  63 <p>This can be used also to program contracts in implementation code for lambda functions, loops, and arbitrary blocks of code. For optimization, this can be omitted for code that does not have preconditions, postconditions, and exception guarantees.</p>
  64 <p><span class="bold"><strong>See Also:</strong></span></p>
  65 <p> <a class="link" href="../../boost_contract/tutorial.html#boost_contract.tutorial.non_member_functions" title="Non-Member Functions"> Non-Member Functions</a>,  <a class="link" href="../../boost_contract/advanced.html#boost_contract.advanced.private_and_protected_functions" title="Private and Protected Functions">
  66         Private and Protected Functions</a>,  <a class="link" href="../../boost_contract/advanced.html#boost_contract.advanced.lambdas__loops__code_blocks__and__constexpr__" title="Lambdas, Loops, Code Blocks (and constexpr)">
  67         Lambdas, Loops, Code Blocks</a></p>
  68 <p>
  69 </p>
  70 <p>
  71
  72 </p>
  73 <div class="variablelist"><table border="0" class="variablelist compact">
  74 <colgroup>
  75 <col align="left" valign="top">
  76 <col>
  77 </colgroup>
  78 <tbody><tr>
  79 <td><p><span class="term">Returns:</span></p></td>
  80 <td><p>The result of this function must be assigned to a variable of type  <code class="computeroutput"><a class="link" href="check.html" title="Class check">boost::contract::check</a></code> declared explicitly (i.e., without using C++11 <code class="computeroutput">auto</code> declarations) and locally just before the code of the function body (otherwise this library will generate a run-time error, see <code class="computeroutput"><a class="link" href="../../BOOST_CO_idm45394999694064.html" title="Macro BOOST_CONTRACT_ON_MISSING_CHECK_DECL">BOOST_CONTRACT_ON_MISSING_CHECK_DECL</a></code>). </p></td>
  81 </tr></tbody>
  82 </table></div>
  83 </div>
  84 </div>
  85 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  86 <td align="left"></td>
  87 <td align="right"><div class="copyright-footer">Copyright &#169; 2008-2019 Lorenzo Caminiti<p>
  88         Distributed under the Boost Software License, Version 1.0 (see accompanying
  89         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>)
  90       </p>
  91 </div></td>
  92 </tr></table>
  93 <hr>
  94 <div class="spirit-nav">
  95 <a accesskey="p" href="destructor.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html#header.boost.contract.function_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="is_old_value_copyable.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  96 </div>
  97 </body>
  98 </html>