devn00b
/
EQ2EMu


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164
							<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>BOOST_&lt;level&gt;_EXCEPTION</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../../index.html" title="Boost.Test">
<link rel="up" href="../testing_tool_ref.html" title="Reference API for writing tests">
<link rel="prev" href="assertion_boost_level_throw.html" title="BOOST_&lt;level&gt;_THROW">
<link rel="next" href="assertion_boost_level_small.html" title="BOOST_&lt;level&gt;_SMALL">
</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="assertion_boost_level_throw.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../testing_tool_ref.html"><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="assertion_boost_level_small.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="boost_test.utf_reference.testing_tool_ref.assertion_boost_level_exception"></a><a class="link" href="assertion_boost_level_exception.html" title="BOOST_&lt;level&gt;_EXCEPTION"><code class="computeroutput"><span class="identifier">BOOST_</span><span class="special">&lt;</span><span class="identifier">level</span><span class="special">&gt;</span><span class="identifier">_EXCEPTION</span></code></a>
</h4></div></div></div>
<pre class="programlisting"><span class="identifier">BOOST_WARN_EXCEPTION</span><span class="special">(</span><span class="identifier">expression</span><span class="special">,</span> <span class="identifier">exception_type</span><span class="special">,</span> <span class="identifier">predicate</span><span class="special">);</span>
<span class="identifier">BOOST_CHECK_EXCEPTION</span><span class="special">(</span><span class="identifier">expression</span><span class="special">,</span> <span class="identifier">exception_type</span><span class="special">,</span> <span class="identifier">predicate</span><span class="special">);</span>
<span class="identifier">BOOST_REQUIRE_EXCEPTION</span><span class="special">(</span><span class="identifier">expression</span><span class="special">,</span> <span class="identifier">exception_type</span><span class="special">,</span> <span class="identifier">predicate</span><span class="special">);</span>
</pre>
<p>
          As for <a class="link" href="assertion_boost_level_throw.html" title="BOOST_&lt;level&gt;_THROW"><code class="computeroutput"><span class="identifier">BOOST_</span><span class="special">&lt;</span><span class="identifier">level</span><span class="special">&gt;</span><span class="identifier">_THROW</span></code></a>, these assertions validate
          that <code class="computeroutput"><span class="identifier">expression</span></code> raises
          an exception of the type specified by <code class="computeroutput"><span class="identifier">exception_type</span></code>
          or any of its child type, with additional checks on the exception instance.
        </p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
              If an expected exception is raised by <code class="computeroutput"><span class="identifier">expression</span></code>,
              the instance of the exception is passed to <code class="computeroutput"><span class="identifier">predicate</span></code>
              for further validation.
            </li>
<li class="listitem">
              It behaves like <a class="link" href="assertion_boost_level_throw.html" title="BOOST_&lt;level&gt;_THROW"><code class="computeroutput"><span class="identifier">BOOST_</span><span class="special">&lt;</span><span class="identifier">level</span><span class="special">&gt;</span><span class="identifier">_THROW</span></code></a> if <code class="computeroutput"><span class="identifier">expression</span></code>
              does not raise any exception, or an unrelated exception is raised.
            </li>
</ul></div>
<p>
          <code class="computeroutput"><span class="identifier">predicate</span></code> should be a unary
          function accepting an instance of <code class="computeroutput"><span class="identifier">exception_type</span></code>
          or any of its child, and that should return a boolean indicating a success
          (<code class="computeroutput"><span class="keyword">true</span></code>) or a failure (<code class="computeroutput"><span class="keyword">false</span></code>).
        </p>
<div class="warning"><table border="0" summary="Warning">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="../../../../../../../doc/src/images/warning.png"></td>
<th align="left">Warning</th>
</tr>
<tr><td align="left" valign="top"><p>
            the assertion catches only the expected exceptions.
          </p></td></tr>
</table></div>
<div class="tip"><table border="0" summary="Tip">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="../../../../../../../doc/src/images/tip.png"></td>
<th align="left">Tip</th>
</tr>
<tr><td align="left" valign="top"><p>
            It is possible to test for complex expressions with the use of constructs
            such as <code class="computeroutput"><span class="keyword">do</span> <span class="special">{</span>
            <span class="comment">/* ... */</span><span class="special">}</span>
            <span class="keyword">while</span><span class="special">(</span><span class="number">0</span><span class="special">)</span></code> block.
          </p></td></tr>
</table></div>
<p>
          The example below checks that the exception carries the proper error code.
        </p>
<h6>
<a name="boost_test.utf_reference.testing_tool_ref.assertion_boost_level_exception.h0"></a>
          <span class="phrase"><a name="boost_test.utf_reference.testing_tool_ref.assertion_boost_level_exception.example_descr"></a></span><a class="link" href="assertion_boost_level_exception.html#boost_test.utf_reference.testing_tool_ref.assertion_boost_level_exception.example_descr">Example:
          BOOST_&lt;level&gt;_EXCEPTION usage</a>
        </h6>
<div class="informaltable"><table class="table">
<colgroup><col></colgroup>
<thead><tr><th>
                  <p>
                    Code
                  </p>
                </th></tr></thead>
<tbody><tr><td>
<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="preprocessor">#define</span> <span class="identifier">BOOST_TEST_MODULE</span> <span class="identifier">example</span>
<span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">test</span><span class="special">/</span><span class="identifier">included</span><span class="special">/</span><span class="identifier">unit_test</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>

<span class="keyword">struct</span> <span class="identifier">my_exception</span>
<span class="special">{</span>
  <span class="keyword">explicit</span> <span class="identifier">my_exception</span><span class="special">(</span> <span class="keyword">int</span> <span class="identifier">ec</span> <span class="special">=</span> <span class="number">0</span> <span class="special">)</span> <span class="special">:</span> <span class="identifier">m_error_code</span><span class="special">(</span> <span class="identifier">ec</span> <span class="special">)</span>
  <span class="special">{}</span>

  <span class="keyword">int</span> <span class="identifier">m_error_code</span><span class="special">;</span>
<span class="special">};</span>

<span class="keyword">bool</span> <span class="identifier">is_critical</span><span class="special">(</span> <span class="identifier">my_exception</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">ex</span> <span class="special">)</span> <span class="special">{</span> <span class="keyword">return</span> <span class="identifier">ex</span><span class="special">.</span><span class="identifier">m_error_code</span> <span class="special">&lt;</span> <span class="number">0</span><span class="special">;</span> <span class="special">}</span>

<span class="keyword">void</span> <span class="identifier">some_func</span><span class="special">(</span> <span class="keyword">int</span> <span class="identifier">i</span> <span class="special">)</span> <span class="special">{</span> <span class="keyword">if</span><span class="special">(</span> <span class="identifier">i</span><span class="special">&gt;=</span><span class="number">0</span> <span class="special">)</span> <span class="keyword">throw</span> <span class="identifier">my_exception</span><span class="special">(</span> <span class="identifier">i</span> <span class="special">);</span> <span class="special">}</span>

<span class="identifier">BOOST_AUTO_TEST_CASE</span><span class="special">(</span> <span class="identifier">test_exception_predicate</span> <span class="special">)</span>
<span class="special">{</span>
  <span class="identifier">BOOST_CHECK_EXCEPTION</span><span class="special">(</span> <span class="identifier">some_func</span><span class="special">(</span><span class="number">0</span><span class="special">),</span> <span class="identifier">my_exception</span><span class="special">,</span> <span class="special">!</span><span class="identifier">is_critical</span> <span class="special">);</span>
  <span class="identifier">BOOST_CHECK_EXCEPTION</span><span class="special">(</span> <span class="identifier">some_func</span><span class="special">(</span><span class="number">1</span><span class="special">),</span> <span class="identifier">my_exception</span><span class="special">,</span> <span class="identifier">is_critical</span> <span class="special">);</span>
<span class="special">}</span>
</pre>
                </td></tr></tbody>
</table></div>
<div class="informaltable"><table class="table">
<colgroup><col></colgroup>
<thead><tr><th>
                  <p>
                    Output
                  </p>
                </th></tr></thead>
<tbody><tr><td>
<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="special">&gt;</span> <span class="identifier">example</span> <span class="special">--</span><span class="identifier">log_level</span><span class="special">=</span><span class="identifier">success</span>
<span class="identifier">Running</span> <span class="number">1</span> <span class="identifier">test</span> <span class="keyword">case</span><span class="special">...</span>
<span class="identifier">Entering</span> <span class="identifier">test</span> <span class="identifier">module</span> <span class="string">"example"</span>
<span class="identifier">test</span><span class="special">:</span><span class="number">24</span><span class="special">:</span> <span class="identifier">Entering</span> <span class="identifier">test</span> <span class="keyword">case</span> <span class="string">"test_exception_predicate"</span>
<span class="identifier">test</span><span class="special">:</span><span class="number">26</span><span class="special">:</span> <span class="identifier">info</span><span class="special">:</span> <span class="identifier">check</span> <span class="char">'exception "my_exception" raised as expected: validation on the raised exception through predicate "!is_critical"'</span> <span class="identifier">has</span> <span class="identifier">passed</span>
<span class="identifier">test</span><span class="special">:</span><span class="number">27</span><span class="special">:</span> <span class="identifier">error</span><span class="special">:</span> <span class="identifier">in</span> <span class="string">"test_exception_predicate"</span><span class="special">:</span> <span class="identifier">exception</span> <span class="string">"my_exception"</span> <span class="identifier">raised</span> <span class="identifier">as</span> <span class="identifier">expected</span><span class="special">:</span> <span class="identifier">validation</span> <span class="identifier">on</span> <span class="identifier">the</span> <span class="identifier">raised</span> <span class="identifier">exception</span> <span class="identifier">through</span> <span class="identifier">predicate</span> <span class="string">"is_critical"</span>
<span class="identifier">test</span><span class="special">:</span><span class="number">24</span><span class="special">:</span> <span class="identifier">Leaving</span> <span class="identifier">test</span> <span class="keyword">case</span> <span class="string">"test_exception_predicate"</span><span class="special">;</span> <span class="identifier">testing</span> <span class="identifier">time</span><span class="special">:</span> <span class="number">203u</span><span class="identifier">s</span>
<span class="identifier">Leaving</span> <span class="identifier">test</span> <span class="identifier">module</span> <span class="string">"example"</span><span class="special">;</span> <span class="identifier">testing</span> <span class="identifier">time</span><span class="special">:</span> <span class="number">271u</span><span class="identifier">s</span>

<span class="special">***</span> <span class="number">1</span> <span class="identifier">failure</span> <span class="identifier">is</span> <span class="identifier">detected</span> <span class="identifier">in</span> <span class="identifier">the</span> <span class="identifier">test</span> <span class="identifier">module</span> <span class="string">"example"</span>
</pre>
                </td></tr></tbody>
</table></div>
<p>
          See also:
        </p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
              <a class="link" href="assertion_boost_level_throw.html" title="BOOST_&lt;level&gt;_THROW"><code class="computeroutput"><span class="identifier">BOOST_</span><span class="special">&lt;</span><span class="identifier">level</span><span class="special">&gt;</span><span class="identifier">_THROW</span></code></a>
            </li>
<li class="listitem">
              <a class="link" href="../../testing_tools/exception_correctness.html" title="Exception correctness">Exception
              correctness</a> section
            </li>
</ul></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 &#169; 2001-2019 Boost.Test
      contributors<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or 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="assertion_boost_level_throw.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../testing_tool_ref.html"><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="assertion_boost_level_small.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>