3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4 <title>Macro BOOST_CONTRACT_STATIC_PUBLIC_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 1. Boost.Contract 1.0.0">
8 <link rel="up" href="reference.html#header.boost.contract_macro_hpp" title="Header <boost/contract_macro.hpp>">
9 <link rel="prev" href="BOOST_CONTRACT_FUNCTION.html" title="Macro BOOST_CONTRACT_FUNCTION">
10 <link rel="next" href="BOOST_CO_idm45394998517984.html" title="Macro BOOST_CONTRACT_PUBLIC_FUNCTION">
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>
22 <div class="spirit-nav">
23 <a accesskey="p" href="BOOST_CONTRACT_FUNCTION.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_idm45394998517984.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
25 <div class="refentry">
26 <a name="BOOST_CO_idm45394998534992"></a><div class="titlepage"></div>
27 <div class="refnamediv">
28 <h2><span class="refentrytitle">Macro BOOST_CONTRACT_STATIC_PUBLIC_FUNCTION</span></h2>
29 <p>BOOST_CONTRACT_STATIC_PUBLIC_FUNCTION — Program contracts that can be completely disabled at compile-time for static public functions. </p>
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: <<a class="link" href="reference.html#header.boost.contract_macro_hpp" title="Header <boost/contract_macro.hpp>">boost/contract_macro.hpp</a>>
34 </span>BOOST_CONTRACT_STATIC_PUBLIC_FUNCTION(...)</pre></div>
35 <div class="refsect1">
36 <a name="idm45707992230320"></a><h2>Description</h2>
37 <p>This is used together with <code class="computeroutput"><a class="link" href="BOOST_CO_idm45394998748208.html" title="Macro BOOST_CONTRACT_PRECONDITION">BOOST_CONTRACT_PRECONDITION</a></code>, <code class="computeroutput"><a class="link" href="BOOST_CO_idm45394998736528.html" title="Macro BOOST_CONTRACT_POSTCONDITION">BOOST_CONTRACT_POSTCONDITION</a></code>, <code class="computeroutput"><a class="link" href="BOOST_CONTRACT_EXCEPT.html" title="Macro BOOST_CONTRACT_EXCEPT">BOOST_CONTRACT_EXCEPT</a></code>, and <code class="computeroutput"><a class="link" href="BOOST_CONTRACT_OLD.html" title="Macro BOOST_CONTRACT_OLD">BOOST_CONTRACT_OLD</a></code> to specify preconditions, postconditions, exception guarantees, and old value copies at body that can be completely disabled at compile-time for static public functions:</p>
38 <pre class="programlisting"><span class="keyword">class</span> <span class="identifier">u</span> <span class="special">{</span>
39 <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>
41 <span class="identifier">BOOST_CONTRACT_STATIC_INVARIANT</span><span class="special">(</span><span class="special">{</span> <span class="comment">// Optional (as for non-static).</span>
42 <span class="identifier">BOOST_CONTRACT_ASSERT</span><span class="special">(</span><span class="special">...</span><span class="special">)</span><span class="special">;</span>
43 <span class="special">...</span>
44 <span class="special">}</span><span class="special">)</span>
46 <span class="keyword">public</span><span class="special">:</span>
47 <span class="keyword">static</span> <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>
48 <span class="identifier">BOOST_CONTRACT_OLD_PTR</span><span class="special">(</span><span class="identifier">old_type</span><span class="special">)</span><span class="special">(</span><span class="identifier">old_var</span><span class="special">)</span><span class="special">;</span>
49 <span class="identifier">BOOST_CONTRACT_PUBLIC_FUNCTION</span><span class="special">(</span><span class="identifier">u</span><span class="special">)</span>
50 <span class="identifier">BOOST_CONTRACT_PRECONDITION</span><span class="special">(</span><span class="special">[</span><span class="special">&</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="identifier">BOOST_CONTRACT_OLD</span><span class="special">(</span><span class="special">[</span><span class="special">&</span><span class="special">]</span> <span class="special">{</span> <span class="comment">// Optional.</span>
55 <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>
56 <span class="special">...</span>
57 <span class="special">}</span><span class="special">)</span>
58 <span class="identifier">BOOST_CONTRACT_POSTCONDITION</span><span class="special">(</span><span class="special">[</span><span class="special">&</span><span class="special">]</span> <span class="special">{</span> <span class="comment">// Optional.</span>
59 <span class="identifier">BOOST_CONTRACT_ASSERT</span><span class="special">(</span><span class="special">...</span><span class="special">)</span><span class="special">;</span>
60 <span class="special">...</span>
61 <span class="special">}</span><span class="special">)</span>
62 <span class="identifier">BOOST_CONTRACT_EXCEPT</span><span class="special">(</span><span class="special">[</span><span class="special">&</span><span class="special">]</span> <span class="special">{</span> <span class="comment">// Optional.</span>
63 <span class="identifier">BOOST_CONTRACT_ASSERT</span><span class="special">(</span><span class="special">...</span><span class="special">)</span><span class="special">;</span>
64 <span class="special">...</span>
65 <span class="special">}</span><span class="special">)</span>
66 <span class="special">;</span> <span class="comment">// Trailing `;` is required.</span>
68 <span class="special">...</span> <span class="comment">// Function body.</span>
69 <span class="special">}</span>
71 <span class="special">...</span>
72 <span class="special">}</span><span class="special">;</span>
74 <p>For optimization, this can be omitted for static public functions that do not have preconditions, postconditions and exception guarantees, within classes that have no static invariants.</p>
75 <p><code class="computeroutput">BOOST_CONTRACT_STATIC_PUBLIC_FUNCTION(class_type)</code> expands to code equivalent to the following (note that no code is generated when <code class="computeroutput"><a class="link" href="BOOST_CO_idm45394999586272.html" title="Macro BOOST_CONTRACT_NO_PUBLIC_FUNCTIONS">BOOST_CONTRACT_NO_PUBLIC_FUNCTIONS</a></code> is defined):</p>
76 <pre class="programlisting"><span class="preprocessor">#ifndef</span> <span class="identifier">BOOST_CONTRACT_NO_PUBLIC_FUNCTIONS</span>
77 <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">internal_var</span> <span class="special">=</span>
78 <span class="identifier">boost</span><span class="special">::</span><span class="identifier">contract</span><span class="special">::</span><span class="identifier">public_function</span><span class="special"><</span><span class="identifier">class_type</span><span class="special">></span><span class="special">(</span><span class="special">)</span>
79 <span class="preprocessor">#endif</span>
82 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
83 <li class="listitem"><p><code class="computeroutput"><span class="bold"><strong>class_type</strong></span></code> is the type of the class containing the static public function declaring the contract. (This is a variadic macro parameter so it can contain commas not protected by round parenthesis.) </p></li>
84 <li class="listitem"><p><code class="computeroutput"><span class="bold"><strong>internal_var</strong></span></code> is a variable name internally generated by this library (this name is unique but only on different line numbers so this macro cannot be expanded multiple times on the same line).</p></li>
88 <p><span class="bold"><strong>See Also:</strong></span></p>
89 <p> <a class="link" href="boost_contract/extras.html#boost_contract.extras.disable_contract_compilation__macro_interface_" title="Disable Contract Compilation (Macro Interface)">
90 Disable Contract Compilation</a>, <a class="link" href="boost_contract/tutorial.html#boost_contract.tutorial.static_public_functions" title="Static Public Functions"> Static Public Functions</a> </p>
97 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
98 <td align="left"></td>
99 <td align="right"><div class="copyright-footer">Copyright © 2008-2019 Lorenzo Caminiti<p>
100 Distributed under the Boost Software License, Version 1.0 (see accompanying
101 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>)
106 <div class="spirit-nav">
107 <a accesskey="p" href="BOOST_CONTRACT_FUNCTION.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_idm45394998517984.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>