libs/test/doc/html/boost/unit_test/framework/current_auto_test_suite.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Function current_auto_test_suite</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="../../../header/boost/test/framework_hpp.html" title="Header &lt;boost/test/framework.hpp&gt;">
   9 <link rel="prev" href="shutdown.html" title="Function shutdown">
  10 <link rel="next" href="register_idm46279113747536.html" title="Function register_test_unit">
  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="shutdown.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../header/boost/test/framework_hpp.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="register_idm46279113747536.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.unit_test.framework.current_auto_test_suite"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Function current_auto_test_suite</span></h2>
  29 <p>boost::unit_test::framework::current_auto_test_suite &#8212; Provides both read and write access to current "leaf" auto test suite during the test unit registration phase. </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="../../../header/boost/test/framework_hpp.html" title="Header &lt;boost/test/framework.hpp&gt;">boost/test/framework.hpp</a>&gt;
  33
  34 </span>
  35 <a class="link" href="../test_suite.html" title="Class test_suite">test_suite</a> <span class="special">&amp;</span>
  36 <span class="identifier">current_auto_test_suite</span><span class="special">(</span><a class="link" href="../test_suite.html" title="Class test_suite">test_suite</a> <span class="special">*</span> ts <span class="special">=</span> <span class="number">0</span><span class="special">,</span> <span class="keyword">bool</span> push_or_pop <span class="special">=</span> <span class="keyword">true</span><span class="special">)</span><span class="special">;</span></pre></div>
  37 <div class="refsect1">
  38 <a name="idm45313889741504"></a><h2>Description</h2>
  39 <p>During auto-registration phase the framework maintain a FIFO queue of test units being registered. New test units become children of the current "leaf" test suite and if this is test suite it is pushed back into queue and becomes a new leaf. When test suite registration is completed, a test suite is popped from the back of the queue. Only automatically registered test suites should be added to this queue. Master test suite is always a zero element in this queue, so if no other test suites are registered all test cases are added to master test suite. This function facilitates all three possible actions:</p>
  40 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  41 <li class="listitem"><p>if no argument are provided it returns the current queue leaf test suite</p></li>
  42 <li class="listitem"><p>if test suite is provided and no second argument are set, test suite is added to the queue</p></li>
  43 <li class="listitem"><p>if no test suite are provided and last argument is false, the semantic of this function is similar to queue pop: last element is popped from the queue
  44
  45 </p></li>
  46 </ul></div>
  47 <p>
  48 </p>
  49 <div class="variablelist"><table border="0" class="variablelist compact">
  50 <colgroup>
  51 <col align="left" valign="top">
  52 <col>
  53 </colgroup>
  54 <tbody><tr>
  55 <td><p><span class="term">Parameters:</span></p></td>
  56 <td><div class="variablelist"><table border="0" class="variablelist compact">
  57 <colgroup>
  58 <col align="left" valign="top">
  59 <col>
  60 </colgroup>
  61 <tbody>
  62 <tr>
  63 <td><p><span class="term"><code class="computeroutput">push_or_pop</code></span></p></td>
  64 <td><p>should we push ts to the queue or pop leaf test suite instead </p></td>
  65 </tr>
  66 <tr>
  67 <td><p><span class="term"><code class="computeroutput">ts</code></span></p></td>
  68 <td><p>test suite to push back to the queue </p></td>
  69 </tr>
  70 </tbody>
  71 </table></div></td>
  72 </tr></tbody>
  73 </table></div>
  74 </div>
  75 </div>
  76 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  77 <td align="left"></td>
  78 <td align="right"><div class="copyright-footer">Copyright &#169; 2001-2019 Boost.Test
  79       contributors<p>
  80         Distributed under the Boost Software License, Version 1.0. (See accompanying
  81         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>)
  82       </p>
  83 </div></td>
  84 </tr></table>
  85 <hr>
  86 <div class="spirit-nav">
  87 <a accesskey="p" href="shutdown.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../header/boost/test/framework_hpp.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="register_idm46279113747536.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  88 </div>
  89 </body>
  90 </html>