Imported Upstream version 1.72.0
[platform/upstream/boost.git] / libs / contract / doc / html / BOOST_CONTRACT_PERMISSIVE.html
1 <html>
2 <head>
3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4 <title>Macro BOOST_CONTRACT_PERMISSIVE</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_CO_idm45394999714768.html" title="Macro BOOST_CONTRACT_STATIC_INVARIANT_FUNC">
10 <link rel="next" href="BOOST_CO_idm45394999694064.html" title="Macro BOOST_CONTRACT_ON_MISSING_CHECK_DECL">
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_CO_idm45394999714768.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_idm45394999694064.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
24 </div>
25 <div class="refentry">
26 <a name="BOOST_CONTRACT_PERMISSIVE"></a><div class="titlepage"></div>
27 <div class="refnamediv">
28 <h2><span class="refentrytitle">Macro BOOST_CONTRACT_PERMISSIVE</span></h2>
29 <p>BOOST_CONTRACT_PERMISSIVE &#8212; Disable some compile-time errors generated by this library (undefined by default). </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_PERMISSIVE</pre></div>
35 <div class="refsect1">
36 <a name="idm45707996850224"></a><h2>Description</h2>
37 <p>Defining this macro disables a number of static checks and related compile-time errors generated by this library, for example:</p>
38 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
39 <li class="listitem"><p>The static invariant member function named as <code class="computeroutput">BOOST_CONTRACT_STATIC_INVARIANT_FUNC</code> must be declared <code class="computeroutput">static</code>. </p></li>
40 <li class="listitem"><p>Non-static invariant member functions named as <code class="computeroutput">BOOST_CONTRACT_INVARIANT_FUNC</code> must be declared either <code class="computeroutput">const</code>, <code class="computeroutput">const volatile</code>, or <code class="computeroutput">volatile const</code>. </p></li>
41 <li class="listitem"><p>Derived classes that program contracts for one or more public function overrides via <code class="computeroutput"><a class="link" href="boost/contract/public_f_idm45394998885120.html" title="Function template public_function">boost::contract::public_function</a></code> must also define the <code class="computeroutput"><a class="link" href="BOOST_CONTRACT_BASE_TYPES.html" title="Macro BOOST_CONTRACT_BASE_TYPES">BOOST_CONTRACT_BASE_TYPES</a></code> <code class="computeroutput">typedef</code>.</p></li>
42 </ul></div>
43 <p>
44 In general, it is not recommended to define this macro because these compile-time checks can guard against misuses of this library.</p>
45 <p><span class="bold"><strong>See Also:</strong></span></p>
46 <p> <a class="link" href="boost_contract/tutorial.html#boost_contract.tutorial.class_invariants" title="Class Invariants"> Class Invariants</a>,  <a class="link" href="boost_contract/tutorial.html#boost_contract.tutorial.base_classes__subcontracting_" title="Base Classes (Subcontracting)"> Base Classes</a> </p>
47 <p>
48 </p>
49 <p>
50 </p>
51 </div>
52 </div>
53 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
54 <td align="left"></td>
55 <td align="right"><div class="copyright-footer">Copyright &#169; 2008-2019 Lorenzo Caminiti<p>
56         Distributed under the Boost Software License, Version 1.0 (see accompanying
57         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>)
58       </p>
59 </div></td>
60 </tr></table>
61 <hr>
62 <div class="spirit-nav">
63 <a accesskey="p" href="BOOST_CO_idm45394999714768.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_idm45394999694064.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
64 </div>
65 </body>
66 </html>