3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4 <title>Class compiler_log_formatter</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/output/compiler_log_formatter_hpp.html" title="Header <boost/test/output/compiler_log_formatter.hpp>">
9 <link rel="prev" href="../../../header/boost/test/output/compiler_log_formatter_hpp.html" title="Header <boost/test/output/compiler_log_formatter.hpp>">
10 <link rel="next" href="../../../header/boost/test/output/plain_report_formatter_hpp.html" title="Header <boost/test/output/plain_report_formatter.hpp>">
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>
22 <div class="spirit-nav">
23 <a accesskey="p" href="../../../header/boost/test/output/compiler_log_formatter_hpp.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../header/boost/test/output/compiler_log_formatter_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="../../../header/boost/test/output/plain_report_formatter_hpp.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
25 <div class="refentry">
26 <a name="boost.unit_test.output.compiler_log_formatter"></a><div class="titlepage"></div>
27 <div class="refnamediv">
28 <h2><span class="refentrytitle">Class compiler_log_formatter</span></h2>
29 <p>boost::unit_test::output::compiler_log_formatter — Log formatter for the Human Readable Format (HRF) log format. </p>
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: <<a class="link" href="../../../header/boost/test/output/compiler_log_formatter_hpp.html" title="Header <boost/test/output/compiler_log_formatter.hpp>">boost/test/output/compiler_log_formatter.hpp</a>>
35 <span class="keyword">class</span> <a class="link" href="compiler_log_formatter.html" title="Class compiler_log_formatter">compiler_log_formatter</a> <span class="special">:</span>
36 <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">unit_test</span><span class="special">::</span><span class="identifier">unit_test_log_formatter</span>
37 <span class="special">{</span>
38 <span class="keyword">public</span><span class="special">:</span>
39 <span class="comment">// <a class="link" href="compiler_log_formatter.html#boost.unit_test.output.compiler_log_formatterconstruct-copy-destruct">construct/copy/destruct</a></span>
40 <a class="link" href="compiler_log_formatter.html#idm46279113559472-bb"><span class="identifier">compiler_log_formatter</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
42 <span class="comment">// <a class="link" href="compiler_log_formatter.html#idm46279113670912-bb">public member functions</a></span>
43 <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="compiler_log_formatter.html#idm46279113670352-bb"><span class="identifier">log_start</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">counter_t</span><span class="special">)</span><span class="special">;</span>
44 <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="compiler_log_formatter.html#idm46279113664960-bb"><span class="identifier">log_finish</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
45 <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="compiler_log_formatter.html#idm46279113660688-bb"><span class="identifier">log_build_info</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">bool</span><span class="special">)</span><span class="special">;</span>
46 <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="compiler_log_formatter.html#idm46279113656560-bb"><span class="identifier">test_unit_start</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</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">&</span><span class="special">)</span><span class="special">;</span>
47 <span class="keyword">virtual</span> <span class="keyword">void</span>
48 <a class="link" href="compiler_log_formatter.html#idm46279113650864-bb"><span class="identifier">test_unit_finish</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</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">&</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">long</span><span class="special">)</span><span class="special">;</span>
49 <span class="keyword">virtual</span> <span class="keyword">void</span>
50 <a class="link" href="compiler_log_formatter.html#idm46279113644064-bb"><span class="identifier">test_unit_skipped</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</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">&</span><span class="special">,</span> <span class="identifier">const_string</span><span class="special">)</span><span class="special">;</span>
51 <span class="keyword">virtual</span> <span class="keyword">void</span>
52 <a class="link" href="compiler_log_formatter.html#idm46279113639008-bb"><span class="identifier">log_exception_start</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span><span class="special">,</span> <a class="link" href="../log_checkpoint_data.html" title="Struct log_checkpoint_data">log_checkpoint_data</a> <span class="keyword">const</span> <span class="special">&</span><span class="special">,</span>
53 <a class="link" href="../../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>
54 <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="compiler_log_formatter.html#idm46279113627152-bb"><span class="identifier">log_exception_finish</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
55 <span class="keyword">virtual</span> <span class="keyword">void</span>
56 <a class="link" href="compiler_log_formatter.html#idm46279113622816-bb"><span class="identifier">log_entry_start</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span><span class="special">,</span> <a class="link" href="../log_entry_data.html" title="Struct log_entry_data">log_entry_data</a> <span class="keyword">const</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">log_entry_types</span><span class="special">)</span><span class="special">;</span>
57 <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="compiler_log_formatter.html#idm46279113614800-bb"><span class="identifier">log_entry_value</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">const_string</span><span class="special">)</span><span class="special">;</span>
58 <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="compiler_log_formatter.html#idm46279113609280-bb"><span class="identifier">log_entry_value</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span><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="special">;</span>
59 <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="compiler_log_formatter.html#idm46279113603584-bb"><span class="identifier">log_entry_finish</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
60 <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="compiler_log_formatter.html#idm46279113599280-bb"><span class="identifier">entry_context_start</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">log_level</span><span class="special">)</span><span class="special">;</span>
61 <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="compiler_log_formatter.html#idm46279113593568-bb"><span class="identifier">log_entry_context</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">log_level</span><span class="special">,</span> <span class="identifier">const_string</span><span class="special">)</span><span class="special">;</span>
62 <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="compiler_log_formatter.html#idm46279113586928-bb"><span class="identifier">entry_context_finish</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">log_level</span><span class="special">)</span><span class="special">;</span>
63 <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="compiler_log_formatter.html#idm46279113581488-bb"><span class="identifier">test_unit_skipped</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</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">&</span><span class="special">)</span><span class="special">;</span>
64 <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="compiler_log_formatter.html#idm46279113577312-bb"><span class="identifier">test_unit_aborted</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</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">&</span><span class="special">)</span><span class="special">;</span>
65 <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="compiler_log_formatter.html#idm46279113574224-bb"><span class="identifier">test_unit_timed_out</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</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">&</span><span class="special">)</span><span class="special">;</span>
66 <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="compiler_log_formatter.html#idm46279113571136-bb"><span class="identifier">set_log_level</span></a><span class="special">(</span><span class="identifier">log_level</span><span class="special">)</span><span class="special">;</span>
67 <span class="keyword">virtual</span> <span class="identifier">log_level</span> <a class="link" href="compiler_log_formatter.html#idm46279113567632-bb"><span class="identifier">get_log_level</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
68 <span class="keyword">virtual</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="compiler_log_formatter.html#idm46279113564800-bb"><span class="identifier">get_default_stream_description</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
70 <span class="comment">// <a class="link" href="compiler_log_formatter.html#idm46279113559184-bb">protected member functions</a></span>
71 <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="compiler_log_formatter.html#idm46279113558608-bb"><span class="identifier">print_prefix</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">const_string</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">)</span><span class="special">;</span>
72 <span class="special">}</span><span class="special">;</span></pre></div>
73 <div class="refsect1">
74 <a name="idm45313889294672"></a><h2>Description</h2>
75 <div class="refsect2">
76 <a name="idm45313889294256"></a><h3>
77 <a name="boost.unit_test.output.compiler_log_formatterconstruct-copy-destruct"></a><code class="computeroutput">compiler_log_formatter</code>
79 construct/copy/destruct</h3>
80 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idm46279113559472-bb"></a><span class="identifier">compiler_log_formatter</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div>
82 <div class="refsect2">
83 <a name="idm45313889288272"></a><h3>
84 <a name="idm46279113670912-bb"></a><code class="computeroutput">compiler_log_formatter</code> public member functions</h3>
85 <div class="orderedlist"><ol class="orderedlist" type="1">
87 <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm46279113670352-bb"></a><span class="identifier">log_start</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span> os<span class="special">,</span> <span class="identifier">counter_t</span> test_cases_amount<span class="special">)</span><span class="special">;</span></pre>Invoked at the beginning of test module execution. <p>
89 <p><span class="bold"><strong>See Also:</strong></span></p>
95 <div class="variablelist"><table border="0" class="variablelist compact">
97 <col align="left" valign="top">
101 <td><p><span class="term">Parameters:</span></p></td>
102 <td><div class="variablelist"><table border="0" class="variablelist compact">
104 <col align="left" valign="top">
109 <td><p><span class="term"><code class="computeroutput">os</code></span></p></td>
110 <td><p>output stream to write a messages to </p></td>
113 <td><p><span class="term"><code class="computeroutput">test_cases_amount</code></span></p></td>
114 <td><p>total test case amount to be run </p></td>
121 <li class="listitem">
122 <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm46279113664960-bb"></a><span class="identifier">log_finish</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span> os<span class="special">)</span><span class="special">;</span></pre>Invoked at the end of test module execution. <p>
124 <p><span class="bold"><strong>See Also:</strong></span></p>
130 <div class="variablelist"><table border="0" class="variablelist compact">
132 <col align="left" valign="top">
136 <td><p><span class="term">Parameters:</span></p></td>
137 <td><div class="variablelist"><table border="0" class="variablelist compact">
139 <col align="left" valign="top">
143 <td><p><span class="term"><code class="computeroutput">os</code></span></p></td>
144 <td><p>output stream to write a messages into </p></td>
150 <li class="listitem">
151 <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm46279113660688-bb"></a><span class="identifier">log_build_info</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span> os<span class="special">,</span> <span class="keyword">bool</span> log_build_info<span class="special">)</span><span class="special">;</span></pre>Invoked when Unit Test Framework build information is requested. <p>
153 <div class="variablelist"><table border="0" class="variablelist compact">
155 <col align="left" valign="top">
159 <td><p><span class="term">Parameters:</span></p></td>
160 <td><div class="variablelist"><table border="0" class="variablelist compact">
162 <col align="left" valign="top">
167 <td><p><span class="term"><code class="computeroutput">log_build_info</code></span></p></td>
168 <td><p>indicates if build info should be logged or not </p></td>
171 <td><p><span class="term"><code class="computeroutput">os</code></span></p></td>
172 <td><p>output stream to write a messages into </p></td>
179 <li class="listitem">
180 <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm46279113656560-bb"></a><span class="identifier">test_unit_start</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span> os<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">&</span> tu<span class="special">)</span><span class="special">;</span></pre>Invoked when test unit starts (either test suite or test case) <p>
182 <p><span class="bold"><strong>See Also:</strong></span></p>
183 <p>test_unit_finish </p>
188 <div class="variablelist"><table border="0" class="variablelist compact">
190 <col align="left" valign="top">
194 <td><p><span class="term">Parameters:</span></p></td>
195 <td><div class="variablelist"><table border="0" class="variablelist compact">
197 <col align="left" valign="top">
202 <td><p><span class="term"><code class="computeroutput">os</code></span></p></td>
203 <td><p>output stream to write a messages into </p></td>
206 <td><p><span class="term"><code class="computeroutput">tu</code></span></p></td>
207 <td><p>test unit being started </p></td>
214 <li class="listitem">
215 <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span>
216 <a name="idm46279113650864-bb"></a><span class="identifier">test_unit_finish</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span> os<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">&</span> tu<span class="special">,</span>
217 <span class="keyword">unsigned</span> <span class="keyword">long</span> elapsed<span class="special">)</span><span class="special">;</span></pre>Invoked when test unit finishes. <p>
219 <p><span class="bold"><strong>See Also:</strong></span></p>
220 <p>test_unit_start </p>
225 <div class="variablelist"><table border="0" class="variablelist compact">
227 <col align="left" valign="top">
231 <td><p><span class="term">Parameters:</span></p></td>
232 <td><div class="variablelist"><table border="0" class="variablelist compact">
234 <col align="left" valign="top">
239 <td><p><span class="term"><code class="computeroutput">elapsed</code></span></p></td>
240 <td><p>time in microseconds spend executing this test unit </p></td>
243 <td><p><span class="term"><code class="computeroutput">os</code></span></p></td>
244 <td><p>output stream to write a messages into </p></td>
247 <td><p><span class="term"><code class="computeroutput">tu</code></span></p></td>
248 <td><p>test unit being finished </p></td>
255 <li class="listitem">
256 <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span>
257 <a name="idm46279113644064-bb"></a><span class="identifier">test_unit_skipped</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span> os<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">&</span> tu<span class="special">,</span> <span class="identifier">const_string</span><span class="special">)</span><span class="special">;</span></pre>Invoked if test unit skipped for any reason. <p>
259 <div class="variablelist"><table border="0" class="variablelist compact">
261 <col align="left" valign="top">
265 <td><p><span class="term">Parameters:</span></p></td>
266 <td><div class="variablelist"><table border="0" class="variablelist compact">
268 <col align="left" valign="top">
273 <td><p><span class="term"><code class="computeroutput">os</code></span></p></td>
274 <td><p>output stream to write a messages into </p></td>
277 <td><p><span class="term"><code class="computeroutput">tu</code></span></p></td>
278 <td><p>skipped test unit </p></td>
285 <li class="listitem">
286 <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span>
287 <a name="idm46279113639008-bb"></a><span class="identifier">log_exception_start</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span> os<span class="special">,</span> <a class="link" href="../log_checkpoint_data.html" title="Struct log_checkpoint_data">log_checkpoint_data</a> <span class="keyword">const</span> <span class="special">&</span> lcd<span class="special">,</span>
288 <a class="link" href="../../execution_exception.html" title="Class execution_exception">execution_exception</a> <span class="keyword">const</span> <span class="special">&</span> ex<span class="special">)</span><span class="special">;</span></pre>Invoked when Unit Test Framework detects uncaught exception. <p>The framwork calls this function when an uncaught exception it detected. This call is followed by context information:</p>
289 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
290 <li class="listitem"><p>one call to <code class="computeroutput">entry_context_start</code>,</p></li>
291 <li class="listitem"><p>as many calls to <code class="computeroutput">log_entry_context</code> as there are context entries</p></li>
292 <li class="listitem"><p>one call to <code class="computeroutput">entry_context_finish</code> </p></li>
296 <p>The logging of the exception information is finilized by a call to <code class="computeroutput">log_exception_finish</code>.</p>
299 <p><span class="bold"><strong>See Also:</strong></span></p>
300 <p>log_exception_finish </p>
305 <div class="variablelist"><table border="0" class="variablelist compact">
307 <col align="left" valign="top">
311 <td><p><span class="term">Parameters:</span></p></td>
312 <td><div class="variablelist"><table border="0" class="variablelist compact">
314 <col align="left" valign="top">
319 <td><p><span class="term"><code class="computeroutput">ex</code></span></p></td>
320 <td><p>information about the caught exception </p></td>
323 <td><p><span class="term"><code class="computeroutput">lcd</code></span></p></td>
324 <td><p>information about the last checkpoint before the exception was triggered </p></td>
327 <td><p><span class="term"><code class="computeroutput">os</code></span></p></td>
328 <td><p>output stream to write a messages into </p></td>
335 <li class="listitem">
336 <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm46279113627152-bb"></a><span class="identifier">log_exception_finish</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span> os<span class="special">)</span><span class="special">;</span></pre>Invoked when Unit Test Framework detects uncaught exception. <p>Call to this function finishes uncaught exception report.
338 <p><span class="bold"><strong>See Also:</strong></span></p>
339 <p>log_exception_start </p>
344 <div class="variablelist"><table border="0" class="variablelist compact">
346 <col align="left" valign="top">
350 <td><p><span class="term">Parameters:</span></p></td>
351 <td><div class="variablelist"><table border="0" class="variablelist compact">
353 <col align="left" valign="top">
357 <td><p><span class="term"><code class="computeroutput">os</code></span></p></td>
358 <td><p>output stream to write a messages into </p></td>
364 <li class="listitem">
365 <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span>
366 <a name="idm46279113622816-bb"></a><span class="identifier">log_entry_start</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span> os<span class="special">,</span> <a class="link" href="../log_entry_data.html" title="Struct log_entry_data">log_entry_data</a> <span class="keyword">const</span> <span class="special">&</span> led<span class="special">,</span>
367 <span class="identifier">log_entry_types</span> let<span class="special">)</span><span class="special">;</span></pre>Invoked by Unit Test Framework to start new log entry. <p>Call to this function starts new log entry. It is followed by series of log_entry_value calls and finally call to log_entry_finish. A log entry may consist of one or more values being reported. Some of these values will be plain strings, while others can be complicated expressions in a form of "lazy" expression template lazy_ostream.
369 <p><span class="bold"><strong>See Also:</strong></span></p>
370 <p>log_entry_value, log_entry_finish</p>
375 <div class="note"><table border="0" summary="Note">
377 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../../doc/src/images/note.png"></td>
378 <th align="left">Note</th>
380 <tr><td align="left" valign="top"><p>call to this function may happen before any call to test_unit_start or all calls to test_unit_finish as the framework might log errors raised during global initialization/shutdown. </p></td></tr>
384 <div class="variablelist"><table border="0" class="variablelist compact">
386 <col align="left" valign="top">
390 <td><p><span class="term">Parameters:</span></p></td>
391 <td><div class="variablelist"><table border="0" class="variablelist compact">
393 <col align="left" valign="top">
398 <td><p><span class="term"><code class="computeroutput">led</code></span></p></td>
399 <td><p>log entry attributes </p></td>
402 <td><p><span class="term"><code class="computeroutput">let</code></span></p></td>
403 <td><p>log entry type log_entry_finish </p></td>
406 <td><p><span class="term"><code class="computeroutput">os</code></span></p></td>
407 <td><p>output stream to write a messages into </p></td>
414 <li class="listitem">
415 <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm46279113614800-bb"></a><span class="identifier">log_entry_value</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span> os<span class="special">,</span> <span class="identifier">const_string</span> value<span class="special">)</span><span class="special">;</span></pre>Invoked by Unit Test Framework to report a log entry content. <p>This is one of two overloaded methods to report log entry content. This one is used to report plain string value.
417 <p><span class="bold"><strong>See Also:</strong></span></p>
418 <p>log_entry_start, log_entry_finish </p>
423 <div class="variablelist"><table border="0" class="variablelist compact">
425 <col align="left" valign="top">
429 <td><p><span class="term">Parameters:</span></p></td>
430 <td><div class="variablelist"><table border="0" class="variablelist compact">
432 <col align="left" valign="top">
437 <td><p><span class="term"><code class="computeroutput">os</code></span></p></td>
438 <td><p>output stream to write a messages into. </p></td>
441 <td><p><span class="term"><code class="computeroutput">value</code></span></p></td>
442 <td><p>log entry string value </p></td>
449 <li class="listitem">
450 <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm46279113609280-bb"></a><span class="identifier">log_entry_value</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span> os<span class="special">,</span> <span class="identifier">lazy_ostream</span> <span class="keyword">const</span> <span class="special">&</span> value<span class="special">)</span><span class="special">;</span></pre>Invoked by Unit Test Framework to report a log entry content. <p>This is one of two overloaded methods to report log entry content. This one is used to report some complicated expression passed as an expression template lazy_ostream. In most cases default implementation provided by the framework should work as is (it just converts the lazy expression into a string.
452 <p><span class="bold"><strong>See Also:</strong></span></p>
453 <p>log_entry_start, log_entry_finish </p>
458 <div class="variablelist"><table border="0" class="variablelist compact">
460 <col align="left" valign="top">
464 <td><p><span class="term">Parameters:</span></p></td>
465 <td><div class="variablelist"><table border="0" class="variablelist compact">
467 <col align="left" valign="top">
472 <td><p><span class="term"><code class="computeroutput">os</code></span></p></td>
473 <td><p>output stream to write a messages into </p></td>
476 <td><p><span class="term"><code class="computeroutput">value</code></span></p></td>
477 <td><p>log entry "lazy" value </p></td>
484 <li class="listitem">
485 <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm46279113603584-bb"></a><span class="identifier">log_entry_finish</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span> os<span class="special">)</span><span class="special">;</span></pre>Invoked by Unit Test Framework to finish a log entry report. <p>
487 <p><span class="bold"><strong>See Also:</strong></span></p>
488 <p>log_entry_start, log_entry_start </p>
493 <div class="variablelist"><table border="0" class="variablelist compact">
495 <col align="left" valign="top">
499 <td><p><span class="term">Parameters:</span></p></td>
500 <td><div class="variablelist"><table border="0" class="variablelist compact">
502 <col align="left" valign="top">
506 <td><p><span class="term"><code class="computeroutput">os</code></span></p></td>
507 <td><p>output stream to write a messages into </p></td>
513 <li class="listitem">
514 <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm46279113599280-bb"></a><span class="identifier">entry_context_start</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span> os<span class="special">,</span> <span class="identifier">log_level</span> l<span class="special">)</span><span class="special">;</span></pre>Invoked by Unit Test Framework to start log entry context report. <p>Unit Test Framework logs for failed assertions and uncaught exceptions context if one was defined by a test module. Context consists of multiple "scopes" identified by description messages assigned by the test module using BOOST_TEST_INFO/BOOST_TEST_CONTEXT statements.
516 <p><span class="bold"><strong>See Also:</strong></span></p>
517 <p>log_entry_context, entry_context_finish </p>
522 <div class="variablelist"><table border="0" class="variablelist compact">
524 <col align="left" valign="top">
528 <td><p><span class="term">Parameters:</span></p></td>
529 <td><div class="variablelist"><table border="0" class="variablelist compact">
531 <col align="left" valign="top">
536 <td><p><span class="term"><code class="computeroutput">l</code></span></p></td>
537 <td><p>entry log_level, to be used to fine tune the message </p></td>
540 <td><p><span class="term"><code class="computeroutput">os</code></span></p></td>
541 <td><p>output stream to write a messages into </p></td>
548 <li class="listitem">
549 <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span>
550 <a name="idm46279113593568-bb"></a><span class="identifier">log_entry_context</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span> os<span class="special">,</span> <span class="identifier">log_level</span> l<span class="special">,</span> <span class="identifier">const_string</span> value<span class="special">)</span><span class="special">;</span></pre>Invoked by Unit Test Framework to report log entry context "scope" description. <p>Each "scope" description is reported by separate call to log_entry_context.
552 <p><span class="bold"><strong>See Also:</strong></span></p>
553 <p>log_entry_start, entry_context_finish </p>
558 <div class="variablelist"><table border="0" class="variablelist compact">
560 <col align="left" valign="top">
564 <td><p><span class="term">Parameters:</span></p></td>
565 <td><div class="variablelist"><table border="0" class="variablelist compact">
567 <col align="left" valign="top">
572 <td><p><span class="term"><code class="computeroutput">l</code></span></p></td>
573 <td><p>entry log_level, to be used to fine tune the message </p></td>
576 <td><p><span class="term"><code class="computeroutput">os</code></span></p></td>
577 <td><p>output stream to write a messages into </p></td>
580 <td><p><span class="term"><code class="computeroutput">value</code></span></p></td>
581 <td><p>context "scope" description </p></td>
588 <li class="listitem">
589 <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm46279113586928-bb"></a><span class="identifier">entry_context_finish</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span> os<span class="special">,</span> <span class="identifier">log_level</span> l<span class="special">)</span><span class="special">;</span></pre>Invoked by Unit Test Framework to finish log entry context report. <p>
591 <p><span class="bold"><strong>See Also:</strong></span></p>
592 <p>log_entry_start, entry_context_context </p>
597 <div class="variablelist"><table border="0" class="variablelist compact">
599 <col align="left" valign="top">
603 <td><p><span class="term">Parameters:</span></p></td>
604 <td><div class="variablelist"><table border="0" class="variablelist compact">
606 <col align="left" valign="top">
611 <td><p><span class="term"><code class="computeroutput">l</code></span></p></td>
612 <td><p>entry log_level, to be used to fine tune the message </p></td>
615 <td><p><span class="term"><code class="computeroutput">os</code></span></p></td>
616 <td><p>output stream to write a messages into </p></td>
623 <li class="listitem">
624 <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm46279113581488-bb"></a><span class="identifier">test_unit_skipped</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</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">&</span><span class="special">)</span><span class="special">;</span></pre>Deprecated version of this interface. <p><span style="color: red"><xrefsect><span style="color: red"><xreftitle>Deprecated</xreftitle></span><span style="color: red"><xrefdescription></xrefdescription></span></xrefsect></span></p>
626 <li class="listitem">
627 <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm46279113577312-bb"></a><span class="identifier">test_unit_aborted</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</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">&</span><span class="special">)</span><span class="special">;</span></pre>Invoked when a test unit is aborted. </li>
628 <li class="listitem">
629 <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm46279113574224-bb"></a><span class="identifier">test_unit_timed_out</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</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">&</span><span class="special">)</span><span class="special">;</span></pre>Invoked when a test unit times-out. </li>
630 <li class="listitem">
631 <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm46279113571136-bb"></a><span class="identifier">set_log_level</span><span class="special">(</span><span class="identifier">log_level</span> new_log_level<span class="special">)</span><span class="special">;</span></pre>Sets the log level of the logger/formatter. <p>Some loggers need to manage the log level by their own. This member function let the implementation decide of that. </p>
632 <p><b>Since Boost 1.62 . </b></p>
636 <li class="listitem">
637 <pre class="literallayout"><span class="keyword">virtual</span> <span class="identifier">log_level</span> <a name="idm46279113567632-bb"></a><span class="identifier">get_log_level</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the log level of the logger/formatter. <p><b>Since Boost 1.62 . </b></p>
641 <li class="listitem">
642 <pre class="literallayout"><span class="keyword">virtual</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idm46279113564800-bb"></a><span class="identifier">get_default_stream_description</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns a default stream for this logger. <p>The returned string describes the stream as if it was passed from the command line <code class="computeroutput">"--log_sink"</code> parameter. With that regards, <span class="bold"><strong>stdout</strong></span> and <span class="bold"><strong>stderr</strong></span> have special meaning indicating the standard output or error stream respectively.</p>
643 <p><b>Since Boost 1.62 . </b></p>
649 <div class="refsect2">
650 <a name="idm45313888990384"></a><h3>
651 <a name="idm46279113559184-bb"></a><code class="computeroutput">compiler_log_formatter</code> protected member functions</h3>
652 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm46279113558608-bb"></a><span class="identifier">print_prefix</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">const_string</span> file<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> line<span class="special">)</span><span class="special">;</span></pre></li></ol></div>
656 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
657 <td align="left"></td>
658 <td align="right"><div class="copyright-footer">Copyright © 2001-2019 Boost.Test
660 Distributed under the Boost Software License, Version 1.0. (See accompanying
661 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>)
666 <div class="spirit-nav">
667 <a accesskey="p" href="../../../header/boost/test/output/compiler_log_formatter_hpp.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../header/boost/test/output/compiler_log_formatter_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="../../../header/boost/test/output/plain_report_formatter_hpp.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>