71 lines
6.5 KiB
HTML
71 lines
6.5 KiB
HTML
<html>
|
||
<head>
|
||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||
<title>Macro BOOST_CONTRACT_INVARIANT</title>
|
||
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
|
||
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
|
||
<link rel="home" href="index.html" title="Chapter 1. Boost.Contract 1.0.0">
|
||
<link rel="up" href="reference.html#header.boost.contract_macro_hpp" title="Header <boost/contract_macro.hpp>">
|
||
<link rel="prev" href="BOOST_CO_idm45028038671712.html" title="Macro BOOST_CONTRACT_OLD_PTR_IF_COPYABLE">
|
||
<link rel="next" href="BOOST_CO_idm45028038632960.html" title="Macro BOOST_CONTRACT_INVARIANT_VOLATILE">
|
||
</head>
|
||
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
||
<table cellpadding="2" width="100%"><tr>
|
||
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
|
||
<td align="center"><a href="../../../../index.html">Home</a></td>
|
||
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
|
||
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
|
||
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
|
||
<td align="center"><a href="../../../../more/index.htm">More</a></td>
|
||
</tr></table>
|
||
<hr>
|
||
<div class="spirit-nav">
|
||
<a accesskey="p" href="BOOST_CO_idm45028038671712.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_idm45028038632960.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
|
||
</div>
|
||
<div class="refentry">
|
||
<a name="BOOST_CONTRACT_INVARIANT"></a><div class="titlepage"></div>
|
||
<div class="refnamediv">
|
||
<h2><span class="refentrytitle">Macro BOOST_CONTRACT_INVARIANT</span></h2>
|
||
<p>BOOST_CONTRACT_INVARIANT — Program (constant) class invariants that can be completely disabled at compile-time. </p>
|
||
</div>
|
||
<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
|
||
<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="reference.html#header.boost.contract_macro_hpp" title="Header <boost/contract_macro.hpp>">boost/contract_macro.hpp</a>>
|
||
|
||
</span>BOOST_CONTRACT_INVARIANT(...)</pre></div>
|
||
<div class="refsect1">
|
||
<a name="idm45909316410080"></a><h2>Description</h2>
|
||
<p><code class="computeroutput">BOOST_CONTRACT_INVARIANT</code>({ ... }) expands to code equivalent to the following (note that no code is generated when <code class="computeroutput"><a class="link" href="BOOST_CO_idm45028039619664.html" title="Macro BOOST_CONTRACT_NO_INVARIANTS">BOOST_CONTRACT_NO_INVARIANTS</a></code> is defined):</p>
|
||
<pre class="programlisting"><span class="preprocessor">#ifndef</span> <span class="identifier">BOOST_CONTRACT_NO_INVARIANTS</span>
|
||
<span class="keyword">void</span> <span class="identifier">BOOST_CONTRACT_INVARIANT_FUNC</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">{</span>
|
||
<span class="special">...</span>
|
||
<span class="special">}</span>
|
||
<span class="preprocessor">#endif</span>
|
||
</pre>
|
||
<p>Where:</p>
|
||
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><span class="bold"><strong>{ ... }</strong></span> is the definition of the function that checks class invariants for public functions that are not static and not volatile (see <code class="computeroutput"><a class="link" href="BOOST_CO_idm45028038619104.html" title="Macro BOOST_CONTRACT_STATIC_INVARIANT">BOOST_CONTRACT_STATIC_INVARIANT</a></code> and <code class="computeroutput"><a class="link" href="BOOST_CO_idm45028038632960.html" title="Macro BOOST_CONTRACT_INVARIANT_VOLATILE">BOOST_CONTRACT_INVARIANT_VOLATILE</a></code>). The curly parenthesis are mandatory (rationale: this is so the syntax of this macro resembles mote the syntax of the lambda functions usually used to specify preconditions, etc.). Assertions within this function are usually programmed using <code class="computeroutput"><a class="link" href="BOOST_CONTRACT_ASSERT.html" title="Macro BOOST_CONTRACT_ASSERT">BOOST_CONTRACT_ASSERT</a></code>, but any exception thrown by a call to this function indicates a contract assertion failure (and will result in this library calling either <code class="computeroutput"><a class="link" href="boost/contract/entry_invariant_failure.html" title="Function entry_invariant_failure">boost::contract::entry_invariant_failure</a></code> or <code class="computeroutput"><a class="link" href="boost/contract/exit_invariant_failure.html" title="Function exit_invariant_failure">boost::contract::exit_invariant_failure</a></code>). (This is a variadic macro parameter so it can contain commas not protected by round parenthesis.)</p></li></ul></div>
|
||
<p>
|
||
</p>
|
||
<p><span class="bold"><strong>See Also:</strong></span></p>
|
||
<p> <a class="link" href="boost_contract/extras.html#boost_contract.extras.disable_contract_compilation__macro_interface_" title="Disable Contract Compilation (Macro Interface)">
|
||
Disable Contract Compilation</a>, <a class="link" href="boost_contract/tutorial.html#boost_contract.tutorial.class_invariants" title="Class Invariants"> Class Invariants</a> </p>
|
||
<p>
|
||
</p>
|
||
<p>
|
||
</p>
|
||
</div>
|
||
</div>
|
||
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
|
||
<td align="left"></td>
|
||
<td align="right"><div class="copyright-footer">Copyright © 2008-2019 Lorenzo Caminiti<p>
|
||
Distributed under the Boost Software License, Version 1.0 (see accompanying
|
||
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>)
|
||
</p>
|
||
</div></td>
|
||
</tr></table>
|
||
<hr>
|
||
<div class="spirit-nav">
|
||
<a accesskey="p" href="BOOST_CO_idm45028038671712.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_idm45028038632960.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
|
||
</div>
|
||
</body>
|
||
</html>
|