libs/contract/doc/html/BOOST_CO_idm45123870548928.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Macro BOOST_CONTRACT_ON_MISSING_CHECK_DECL</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.config_hpp" title="Header &lt;boost/contract/core/config.hpp&gt;">
   9 <link rel="prev" href="BOOST_CONTRACT_PERMISSIVE.html" title="Macro BOOST_CONTRACT_PERMISSIVE">
  10 <link rel="next" href="BOOST_CO_idm45123870540560.html" title="Macro BOOST_CONTRACT_PRECONDITIONS_DISABLE_NO_ASSERTION">
  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_PERMISSIVE.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="reference.html#header.boost.contract.core.config_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_idm45123870540560.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="BOOST_CO_idm45123870548928"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Macro BOOST_CONTRACT_ON_MISSING_CHECK_DECL</span></h2>
  29 <p>BOOST_CONTRACT_ON_MISSING_CHECK_DECL &#8212; Code block to execute if contracts are not assigned to a  <code class="computeroutput"><a class="link" href="boost/contract/check.html" title="Class check">boost::contract::check</a></code> variable (undefined by default and executes <code class="computeroutput">BOOST_ASSERT(false)</code>). </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.config_hpp" title="Header &lt;boost/contract/core/config.hpp&gt;">boost/contract/core/config.hpp</a>&gt;
  33
  34 </span>BOOST_CONTRACT_ON_MISSING_CHECK_DECL</pre></div>
  35 <div class="refsect1">
  36 <a name="idm45751730279488"></a><h2>Description</h2>
  37 <p>In general, there is a logic error in the program when contracts are not assigned to a local variable of type <code class="computeroutput"><a class="link" href="boost/contract/check.html" title="Class check">boost::contract::check</a></code> (because that is a misuse of this library). Therefore, by default (i.e., when this macro is not defined) this library calls <code class="computeroutput">BOOST_ASSERT(false)</code> in those cases. If this macro is defined, this library will execute the code expanded by the macro instead of calling <code class="computeroutput">BOOST_ASSERT(false)</code> (if programmers prefer to throw an exception, etc.).</p>
  38 <p>This macro can be defined to be any block of code (use empty curly brackets <code class="computeroutput">{}</code> to generate no error), for example (on GCC): </p>
  39 <pre class="programlisting"><span class="special">-</span><span class="identifier">DBOOST_CONTRACT_ON_MISSING_CHECK_DECL</span><span class="special">=</span><span class="char">'{ throw std::logic_error("missing contract check declaration"); }'</span>
  40 </pre>
  41 <p><span class="bold"><strong>See Also:</strong></span></p>
  42 <p> <a class="link" href="boost_contract/tutorial.html" title="Tutorial"> Tutorial</a> </p>
  43 <p>
  44 </p>
  45 <p>
  46 </p>
  47 </div>
  48 </div>
  49 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  50 <td align="left"></td>
  51 <td align="right"><div class="copyright-footer">Copyright &#169; 2008-2018 Lorenzo Caminiti<p>
  52         Distributed under the Boost Software License, Version 1.0 (see accompanying
  53         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>)
  54       </p>
  55 </div></td>
  56 </tr></table>
  57 <hr>
  58 <div class="spirit-nav">
  59 <a accesskey="p" href="BOOST_CONTRACT_PERMISSIVE.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="reference.html#header.boost.contract.core.config_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_idm45123870540560.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  60 </div>
  61 </body>
  62 </html>