format.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
  4. <title>Class format</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/results_reporter_hpp.html" title="Header &lt;boost/test/results_reporter.hpp&gt;">
  9. <link rel="prev" href="../../../header/boost/test/results_reporter_hpp.html" title="Header &lt;boost/test/results_reporter.hpp&gt;">
  10. <link rel="next" href="set_level.html" title="Function set_level">
  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="../../../header/boost/test/results_reporter_hpp.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../header/boost/test/results_reporter_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="set_level.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24. </div>
  25. <div class="refentry">
  26. <a name="boost.unit_test.results_reporter.format"></a><div class="titlepage"></div>
  27. <div class="refnamediv">
  28. <h2><span class="refentrytitle">Class format</span></h2>
  29. <p>boost::unit_test::results_reporter::format &#8212; Results report formatter interface. </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/results_reporter_hpp.html" title="Header &lt;boost/test/results_reporter.hpp&gt;">boost/test/results_reporter.hpp</a>&gt;
  33. </span>
  34. <span class="keyword">class</span> <a class="link" href="format.html" title="Class format">format</a> <span class="special">{</span>
  35. <span class="keyword">public</span><span class="special">:</span>
  36. <span class="comment">// <a class="link" href="format.html#boost.unit_test.results_reporter.formatconstruct-copy-destruct">construct/copy/destruct</a></span>
  37. <a class="link" href="format.html#idm46279113240112-bb"><span class="special">~</span><span class="identifier">format</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  38. <span class="comment">// <a class="link" href="format.html#idm46279113254160-bb">public member functions</a></span>
  39. <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="format.html#idm46279113253600-bb"><span class="identifier">results_report_start</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span>
  40. <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="format.html#idm46279113251520-bb"><span class="identifier">results_report_finish</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span>
  41. <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="format.html#idm46279113249440-bb"><span class="identifier">test_unit_report_start</span></a><span class="special">(</span><a class="link" href="../test_unit.html" title="Class test_unit">test_unit</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span>
  42. <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="format.html#idm46279113246384-bb"><span class="identifier">test_unit_report_finish</span></a><span class="special">(</span><a class="link" href="../test_unit.html" title="Class test_unit">test_unit</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span>
  43. <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="format.html#idm46279113243328-bb"><span class="identifier">do_confirmation_report</span></a><span class="special">(</span><a class="link" href="../test_unit.html" title="Class test_unit">test_unit</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span>
  44. <span class="special">}</span><span class="special">;</span></pre></div>
  45. <div class="refsect1">
  46. <a name="idm45313887492048"></a><h2>Description</h2>
  47. <p>This is abstract interface for the report formatter used by results reporter routines. You can define a custom formatter by implementing this interface and setting the formatter using set_format function. This is usually done during test module initialization </p>
  48. <div class="refsect2">
  49. <a name="idm45313887491104"></a><h3>
  50. <a name="boost.unit_test.results_reporter.formatconstruct-copy-destruct"></a><code class="computeroutput">format</code>
  51. public
  52. construct/copy/destruct</h3>
  53. <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idm46279113240112-bb"></a><span class="special">~</span><span class="identifier">format</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div>
  54. </div>
  55. <div class="refsect2">
  56. <a name="idm45313887484672"></a><h3>
  57. <a name="idm46279113254160-bb"></a><code class="computeroutput">format</code> public member functions</h3>
  58. <div class="orderedlist"><ol class="orderedlist" type="1">
  59. <li class="listitem"><pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm46279113253600-bb"></a><span class="identifier">results_report_start</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&amp;</span> ostr<span class="special">)</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span></pre></li>
  60. <li class="listitem"><pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm46279113251520-bb"></a><span class="identifier">results_report_finish</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&amp;</span> ostr<span class="special">)</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span></pre></li>
  61. <li class="listitem"><pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span>
  62. <a name="idm46279113249440-bb"></a><span class="identifier">test_unit_report_start</span><span class="special">(</span><a class="link" href="../test_unit.html" title="Class test_unit">test_unit</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&amp;</span> ostr<span class="special">)</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span></pre></li>
  63. <li class="listitem"><pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span>
  64. <a name="idm46279113246384-bb"></a><span class="identifier">test_unit_report_finish</span><span class="special">(</span><a class="link" href="../test_unit.html" title="Class test_unit">test_unit</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&amp;</span> ostr<span class="special">)</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span></pre></li>
  65. <li class="listitem"><pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span>
  66. <a name="idm46279113243328-bb"></a><span class="identifier">do_confirmation_report</span><span class="special">(</span><a class="link" href="../test_unit.html" title="Class test_unit">test_unit</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&amp;</span> ostr<span class="special">)</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span></pre></li>
  67. </ol></div>
  68. </div>
  69. </div>
  70. </div>
  71. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  72. <td align="left"></td>
  73. <td align="right"><div class="copyright-footer">Copyright &#169; 2001-2019 Boost.Test
  74. contributors<p>
  75. Distributed under the Boost Software License, Version 1.0. (See accompanying
  76. 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>)
  77. </p>
  78. </div></td>
  79. </tr></table>
  80. <hr>
  81. <div class="spirit-nav">
  82. <a accesskey="p" href="../../../header/boost/test/results_reporter_hpp.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../header/boost/test/results_reporter_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="set_level.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  83. </div>
  84. </body>
  85. </html>