1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>Header <boost/test/framework.hpp></title> 5<link rel="stylesheet" href="../../../boostbook.css" type="text/css"> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="../../../index.html" title="Boost.Test"> 8<link rel="up" href="../../../boost_test/reference.html" title="Reference"> 9<link rel="prev" href="../../../BOOST_TEST_SYS_ASSERT.html" title="Macro BOOST_TEST_SYS_ASSERT"> 10<link rel="next" href="../../../boost/unit_test/framework/impl/master_t_idm45267287661184.html" title="Struct master_test_suite_name_setter"> 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_TEST_SYS_ASSERT.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_test/reference.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="../../../boost/unit_test/framework/impl/master_t_idm45267287661184.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h4 class="title"> 27<a name="header.boost.test.framework_hpp"></a>Header <<a href="../../../../../../../boost/test/framework.hpp" target="_top">boost/test/framework.hpp</a>></h4></div></div></div> 28<p>Defines Unit Test Framework mono-state interfaces. The framework interfaces are based on Monostate design pattern. </p> 29<pre class="synopsis"> 30 31<a class="link" href="../../../BOOST_TEST_SETUP_ASSERT.html" title="Macro BOOST_TEST_SETUP_ASSERT">BOOST_TEST_SETUP_ASSERT</a>(cond, msg)</pre> 32<pre class="synopsis"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span> 33 <span class="keyword">namespace</span> <span class="identifier">unit_test</span> <span class="special">{</span> 34 <span class="keyword">typedef</span> <a class="link" href="../../../boost/unit_test/test_suite.html" title="Class test_suite">test_suite</a> <span class="special">*</span><span class="special">(</span><span class="special">*</span> <a class="link" href="../../../boost/unit_test/init_unit_test_func.html" title="Type definition init_unit_test_func"><span class="identifier">init_unit_test_func</span></a><span class="special">;</span> 35 <span class="keyword">namespace</span> <span class="identifier">framework</span> <span class="special">{</span> 36 <span class="keyword">struct</span> <a class="link" href="../../../boost/unit_test/framework/context_generator.html" title="Struct context_generator">context_generator</a><span class="special">;</span> 37 <span class="keyword">struct</span> <a class="link" href="../../../boost/unit_test/framework/internal_error.html" title="Struct internal_error">internal_error</a><span class="special">;</span> 38 <span class="keyword">struct</span> <a class="link" href="../../../boost/unit_test/framework/nothing_to_test.html" title="Struct nothing_to_test">nothing_to_test</a><span class="special">;</span> 39 <span class="keyword">struct</span> <a class="link" href="../../../boost/unit_test/framework/setup_error.html" title="Struct setup_error">setup_error</a><span class="special">;</span> 40 <span class="keyword">void</span> <a class="link" href="../../../boost/unit_test/framework/init.html" title="Function init"><span class="identifier">init</span></a><span class="special">(</span><span class="identifier">init_unit_test_func</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> 41 <span class="keyword">void</span> <a class="link" href="../../../boost/unit_test/framework/finalize_setup_phase.html" title="Function finalize_setup_phase"><span class="identifier">finalize_setup_phase</span></a><span class="special">(</span><span class="identifier">test_unit_id</span> <span class="special">=</span> <span class="identifier">INV_TEST_UNIT_ID</span><span class="special">)</span><span class="special">;</span> 42 43 <span class="comment">// This function returns true when testing is in progress (setup is finished). </span> 44 <span class="keyword">bool</span> <a name="boost.unit_test.framework.test_in_progress"></a><span class="identifier">test_in_progress</span><span class="special">(</span><span class="special">)</span><span class="special">;</span> 45 <span class="keyword">void</span> <a class="link" href="../../../boost/unit_test/framework/shutdown.html" title="Function shutdown"><span class="identifier">shutdown</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 46 <a class="link" href="../../../boost/unit_test/test_suite.html" title="Class test_suite">test_suite</a> <span class="special">&</span> <a class="link" href="../../../boost/unit_test/framework/current_auto_test_suite.html" title="Function current_auto_test_suite"><span class="identifier">current_auto_test_suite</span></a><span class="special">(</span><a class="link" href="../../../boost/unit_test/test_suite.html" title="Class test_suite">test_suite</a> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">=</span> <span class="keyword">true</span><span class="special">)</span><span class="special">;</span> 47 <span class="keyword">void</span> <a class="link" href="../../../boost/unit_test/framework/register_idm45267287637040.html" title="Function register_test_unit"><span class="identifier">register_test_unit</span></a><span class="special">(</span><a class="link" href="../../../boost/unit_test/test_case.html" title="Class test_case">test_case</a> <span class="special">*</span><span class="special">)</span><span class="special">;</span> 48 <span class="keyword">void</span> <a class="link" href="../../../boost/unit_test/framework/register_idm45267287633808.html" title="Function register_test_unit"><span class="identifier">register_test_unit</span></a><span class="special">(</span><a class="link" href="../../../boost/unit_test/test_suite.html" title="Class test_suite">test_suite</a> <span class="special">*</span><span class="special">)</span><span class="special">;</span> 49 <span class="keyword">void</span> <a class="link" href="../../../boost/unit_test/framework/deregister_test_unit.html" title="Function deregister_test_unit"><span class="identifier">deregister_test_unit</span></a><span class="special">(</span><a class="link" href="../../../boost/unit_test/test_unit.html" title="Class test_unit">test_unit</a> <span class="special">*</span><span class="special">)</span><span class="special">;</span> 50 51 <span class="comment">// After this call the framework can be reinitialized to perform a second test run during the same program lifetime. </span> 52 <span class="keyword">void</span> <a name="boost.unit_test.framework.clear"></a><span class="identifier">clear</span><span class="special">(</span><span class="special">)</span><span class="special">;</span> 53 <span class="keyword">void</span> <a class="link" href="../../../boost/unit_test/framework/register_observer.html" title="Function register_observer"><span class="identifier">register_observer</span></a><span class="special">(</span><a class="link" href="../../../boost/unit_test/test_observer.html" title="Class test_observer">test_observer</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 54 <span class="keyword">void</span> <a class="link" href="../../../boost/unit_test/framework/deregister_observer.html" title="Function deregister_observer"><span class="identifier">deregister_observer</span></a><span class="special">(</span><a class="link" href="../../../boost/unit_test/test_observer.html" title="Class test_observer">test_observer</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 55 <span class="keyword">void</span> <a class="link" href="../../../boost/unit_test/framework/register_global_fixture.html" title="Function register_global_fixture"><span class="identifier">register_global_fixture</span></a><span class="special">(</span><span class="identifier">global_fixture</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 56 <span class="keyword">void</span> <a class="link" href="../../../boost/unit_test/framework/deregister_global_fixture.html" title="Function deregister_global_fixture"><span class="identifier">deregister_global_fixture</span></a><span class="special">(</span><span class="identifier">global_fixture</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 57 <span class="keyword">int</span> <a class="link" href="../../../boost/unit_test/framework/add_context.html" title="Function add_context"><span class="identifier">add_context</span></a><span class="special">(</span><span class="identifier">lazy_ostream</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">bool</span><span class="special">)</span><span class="special">;</span> 58 <span class="keyword">void</span> <a class="link" href="../../../boost/unit_test/framework/clear_context.html" title="Function clear_context"><span class="identifier">clear_context</span></a><span class="special">(</span><span class="keyword">int</span> <span class="special">=</span> <span class="special">-</span><span class="number">1</span><span class="special">)</span><span class="special">;</span> 59 60 <span class="comment">// Produces an instance of small "delegate" object, which facilitates access to collected context. </span> 61 <a class="link" href="../../../boost/unit_test/framework/context_generator.html" title="Struct context_generator">context_generator</a> <a name="boost.unit_test.framework.get_context"></a><span class="identifier">get_context</span><span class="special">(</span><span class="special">)</span><span class="special">;</span> 62 <a class="link" href="../../../boost/unit_test/master_test_suite_t.html" title="Class master_test_suite_t">master_test_suite_t</a> <span class="special">&</span> <a class="link" href="../../../boost/unit_test/framework/master_test_suite.html" title="Function master_test_suite"><span class="identifier">master_test_suite</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 63 <a class="link" href="../../../boost/unit_test/test_unit.html" title="Class test_unit">test_unit</a> <span class="keyword">const</span> <span class="special">&</span> <a class="link" href="../../../boost/unit_test/framework/current_test_unit.html" title="Function current_test_unit"><span class="identifier">current_test_unit</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 64 <a class="link" href="../../../boost/unit_test/test_case.html" title="Class test_case">test_case</a> <span class="keyword">const</span> <span class="special">&</span> <a class="link" href="../../../boost/unit_test/framework/current_test_case.html" title="Function current_test_case"><span class="identifier">current_test_case</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 65 <span class="identifier">test_unit_id</span> <a class="link" href="../../../boost/unit_test/framework/current_test_case_id.html" title="Function current_test_case_id"><span class="identifier">current_test_case_id</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 66 <a class="link" href="../../../boost/unit_test/test_unit.html" title="Class test_unit">test_unit</a> <span class="special">&</span> <a class="link" href="../../../boost/unit_test/framework/get_idm45267287593744.html" title="Function get"><span class="identifier">get</span></a><span class="special">(</span><span class="identifier">test_unit_id</span><span class="special">,</span> <span class="identifier">test_unit_type</span><span class="special">)</span><span class="special">;</span> 67 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> UnitType<span class="special">></span> <span class="identifier">UnitType</span> <span class="special">&</span> <a class="link" href="../../../boost/unit_test/framework/get_idm45267287588992.html" title="Function template get"><span class="identifier">get</span></a><span class="special">(</span><span class="identifier">test_unit_id</span><span class="special">)</span><span class="special">;</span> 68 <span class="keyword">void</span> <a class="link" href="../../../boost/unit_test/framework/run_idm45267287583488.html" title="Function run"><span class="identifier">run</span></a><span class="special">(</span><span class="identifier">test_unit_id</span> <span class="special">=</span> <span class="identifier">INV_TEST_UNIT_ID</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">=</span> <span class="keyword">true</span><span class="special">)</span><span class="special">;</span> 69 70 <span class="comment">// Initiates test execution. Same as other overload. </span> 71 <span class="keyword">void</span> <a name="boost.unit_test.framework.run_idm45267287578688"></a><span class="identifier">run</span><span class="special">(</span><a class="link" href="../../../boost/unit_test/test_unit.html" title="Class test_unit">test_unit</a> <span class="keyword">const</span> <span class="special">*</span> tu<span class="special">,</span> <span class="keyword">bool</span> continue_test <span class="special">=</span> <span class="keyword">true</span><span class="special">)</span><span class="special">;</span> 72 <span class="keyword">void</span> <a name="boost.unit_test.framework.assertion_result"></a><span class="identifier">assertion_result</span><span class="special">(</span><span class="identifier">unit_test</span><span class="special">::</span><span class="identifier">assertion_result</span> ar<span class="special">)</span><span class="special">;</span> 73 74 <span class="comment">// Reports uncaught exception to all test observers. </span> 75 <span class="keyword">void</span> <a name="boost.unit_test.framework.exception_caught"></a><span class="identifier">exception_caught</span><span class="special">(</span><a class="link" href="../../../boost/execution_exception.html" title="Class execution_exception">execution_exception</a> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 76 77 <span class="comment">// Reports aborted test unit to all test observers. </span> 78 <span class="keyword">void</span> <a name="boost.unit_test.framework.test_unit_aborted"></a><span class="identifier">test_unit_aborted</span><span class="special">(</span><a class="link" href="../../../boost/unit_test/test_unit.html" title="Class test_unit">test_unit</a> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 79 80 <span class="comment">// Reports aborted test module to all test observers. </span> 81 <span class="keyword">void</span> <a name="boost.unit_test.framework.test_aborted"></a><span class="identifier">test_aborted</span><span class="special">(</span><span class="special">)</span><span class="special">;</span> 82 <span class="keyword">namespace</span> <span class="identifier">impl</span> <span class="special">{</span> 83 <span class="keyword">struct</span> <a class="link" href="../../../boost/unit_test/framework/impl/master_t_idm45267287661184.html" title="Struct master_test_suite_name_setter">master_test_suite_name_setter</a><span class="special">;</span> 84 <span class="keyword">void</span> <a name="boost.unit_test.framework.impl.setup_for_execution"></a><span class="identifier">setup_for_execution</span><span class="special">(</span><a class="link" href="../../../boost/unit_test/test_unit.html" title="Class test_unit">test_unit</a> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 85 <span class="keyword">void</span> <a name="boost.unit_test.framework.impl.setup_loggers"></a><span class="identifier">setup_loggers</span><span class="special">(</span><span class="special">)</span><span class="special">;</span> 86 <span class="special">}</span> 87 <span class="special">}</span> 88 <span class="special">}</span> 89<span class="special">}</span></pre> 90</div> 91<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 92<td align="left"></td> 93<td align="right"><div class="copyright-footer">Copyright © 2001-2020 Boost.Test contributors<p> 94 Distributed under the Boost Software License, Version 1.0. (See accompanying 95 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>) 96 </p> 97</div></td> 98</tr></table> 99<hr> 100<div class="spirit-nav"> 101<a accesskey="p" href="../../../BOOST_TEST_SYS_ASSERT.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_test/reference.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="../../../boost/unit_test/framework/impl/master_t_idm45267287661184.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> 102</div> 103</body> 104</html> 105
