libs/contract/doc/html/BOOST_CONTRACT_BASE_TYPES.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Macro BOOST_CONTRACT_BASE_TYPES</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.base_types_hpp" title="Header &lt;boost/contract/base_types.hpp&gt;">
   9 <link rel="prev" href="BOOST_CO_idm45395027441616.html" title="Macro BOOST_CONTRACT_ASSERT_AXIOM">
  10 <link rel="next" href="boost/contract/call_if_statement.html" title="Struct template call_if_statement">
  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_idm45395027441616.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="reference.html#header.boost.contract.base_types_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/contract/call_if_statement.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="BOOST_CONTRACT_BASE_TYPES"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Macro BOOST_CONTRACT_BASE_TYPES</span></h2>
  29 <p>BOOST_CONTRACT_BASE_TYPES &#8212; Used to program the <code class="computeroutput">typedef</code> that lists the bases of a derived class. </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.base_types_hpp" title="Header &lt;boost/contract/base_types.hpp&gt;">boost/contract/base_types.hpp</a>&gt;
  33
  34 </span>BOOST_CONTRACT_BASE_TYPES(...)</pre></div>
  35 <div class="refsect1">
  36 <a name="idm45707998411456"></a><h2>Description</h2>
  37 <p>In order to support subcontracting, a derived class that specifies contracts for one or more overriding public functions must declare a <code class="computeroutput">typedef</code> named <code class="computeroutput">base_types</code> (or <code class="computeroutput"><a class="link" href="BOOST_CO_idm45394999732400.html" title="Macro BOOST_CONTRACT_BASES_TYPEDEF">BOOST_CONTRACT_BASES_TYPEDEF</a></code>) using this macro:</p>
  38 <pre class="programlisting"><span class="keyword">class</span> <span class="identifier">u</span>
  39     <span class="preprocessor">#define</span> <span class="identifier">BASES</span> <span class="keyword">public</span> <span class="identifier">b</span><span class="special">,</span> <span class="keyword">protected</span> <span class="keyword">virtual</span> <span class="identifier">w1</span><span class="special">,</span> <span class="keyword">private</span> <span class="identifier">w2</span>
  40     <span class="special">:</span> <span class="identifier">BASES</span>
  41 <span class="special">{</span>
  42     <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>
  43
  44     <span class="keyword">typedef</span> <span class="identifier">BOOST_CONTRACT_BASE_TYPES</span><span class="special">(</span><span class="identifier">BASES</span><span class="special">)</span> <span class="identifier">base_types</span><span class="special">;</span>
  45     <span class="preprocessor">#undef</span> <span class="identifier">BASES</span>
  46
  47     <span class="special">...</span>
  48 <span class="special">}</span><span class="special">;</span>
  49 </pre>
  50 <p>This <code class="computeroutput">typedef</code> must be <code class="computeroutput">public</code> unless <code class="computeroutput"><a class="link" href="boost/contract/access.html" title="Class access">boost::contract::access</a></code> is used.</p>
  51 <p><span class="bold"><strong>See Also:</strong></span></p>
  52 <p> <a class="link" href="boost_contract/tutorial.html#boost_contract.tutorial.base_classes__subcontracting_" title="Base Classes (Subcontracting)"> Base Classes</a></p>
  53 <p>
  54 </p>
  55 <p>
  56
  57 </p>
  58 <div class="variablelist"><table border="0" class="variablelist compact">
  59 <colgroup>
  60 <col align="left" valign="top">
  61 <col>
  62 </colgroup>
  63 <tbody><tr>
  64 <td><p><span class="term">Parameters:</span></p></td>
  65 <td><div class="variablelist"><table border="0" class="variablelist compact">
  66 <colgroup>
  67 <col align="left" valign="top">
  68 <col>
  69 </colgroup>
  70 <tbody><tr>
  71 <td><p><span class="term"><code class="computeroutput">...</code></span></p></td>
  72 <td><p>Comma separated list of base classes. Each base must explicitly specify its access specifier <code class="computeroutput">public</code>, <code class="computeroutput">protected</code>, or <code class="computeroutput">private</code>, and also <code class="computeroutput">virtual</code> when present (this not always required in C++ instead). There is a limit of about 20 maximum bases that can be listed (because of similar limits in Boost.MPL internally used by this library). This is a variadic macro parameter, on compilers that do not support variadic macros, the <code class="computeroutput">typedef</code> for base classes can be programmed manually without using this macro (see  <a class="link" href="boost_contract/extras.html#boost_contract.extras.no_macros__and_no_variadic_macros_" title="No Macros (and No Variadic Macros)"> No Macros</a>). </p></td>
  73 </tr></tbody>
  74 </table></div></td>
  75 </tr></tbody>
  76 </table></div>
  77 </div>
  78 </div>
  79 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  80 <td align="left"></td>
  81 <td align="right"><div class="copyright-footer">Copyright &#169; 2008-2019 Lorenzo Caminiti<p>
  82         Distributed under the Boost Software License, Version 1.0 (see accompanying
  83         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>)
  84       </p>
  85 </div></td>
  86 </tr></table>
  87 <hr>
  88 <div class="spirit-nav">
  89 <a accesskey="p" href="BOOST_CO_idm45395027441616.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="reference.html#header.boost.contract.base_types_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/contract/call_if_statement.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  90 </div>
  91 </body>
  92 </html>