1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 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>"> 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/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> 24</div> 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> 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: <<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>> 33 34</span> 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#idm45267287448976-bb"><span class="identifier">compiler_log_formatter</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 41 42 <span class="comment">// <a class="link" href="compiler_log_formatter.html#idm45267287560416-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#idm45267287559856-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#idm45267287554464-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#idm45267287550192-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#idm45267287546064-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#idm45267287540368-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#idm45267287533568-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#idm45267287528512-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#idm45267287516656-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#idm45267287512320-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#idm45267287504304-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#idm45267287498784-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#idm45267287493088-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#idm45267287488784-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#idm45267287483072-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#idm45267287476432-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#idm45267287470992-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#idm45267287466816-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#idm45267287463728-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#idm45267287460640-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#idm45267287457136-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#idm45267287454304-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> 69 70 <span class="comment">// <a class="link" href="compiler_log_formatter.html#idm45267287448688-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#idm45267287448112-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="idm46175618691744"></a><h2>Description</h2> 75<div class="refsect2"> 76<a name="idm46175618691328"></a><h3> 77<a name="boost.unit_test.output.compiler_log_formatterconstruct-copy-destruct"></a><code class="computeroutput">compiler_log_formatter</code> 78 public 79 construct/copy/destruct</h3> 80<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idm45267287448976-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> 81</div> 82<div class="refsect2"> 83<a name="idm46175618685408"></a><h3> 84<a name="idm45267287560416-bb"></a><code class="computeroutput">compiler_log_formatter</code> public member functions</h3> 85<div class="orderedlist"><ol class="orderedlist" type="1"> 86<li class="listitem"> 87<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm45267287559856-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> 88</p> 89<p><span class="bold"><strong>See Also:</strong></span></p> 90<p>log_finish </p> 91<p> 92</p> 93<p> 94</p> 95<div class="variablelist"><table border="0" class="variablelist compact"> 96<colgroup> 97<col align="left" valign="top"> 98<col> 99</colgroup> 100<tbody><tr> 101<td><p><span class="term">Parameters:</span></p></td> 102<td><div class="variablelist"><table border="0" class="variablelist compact"> 103<colgroup> 104<col align="left" valign="top"> 105<col> 106</colgroup> 107<tbody> 108<tr> 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> 111</tr> 112<tr> 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> 115</tr> 116</tbody> 117</table></div></td> 118</tr></tbody> 119</table></div> 120</li> 121<li class="listitem"> 122<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm45267287554464-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> 123</p> 124<p><span class="bold"><strong>See Also:</strong></span></p> 125<p>log_start </p> 126<p> 127</p> 128<p> 129</p> 130<div class="variablelist"><table border="0" class="variablelist compact"> 131<colgroup> 132<col align="left" valign="top"> 133<col> 134</colgroup> 135<tbody><tr> 136<td><p><span class="term">Parameters:</span></p></td> 137<td><div class="variablelist"><table border="0" class="variablelist compact"> 138<colgroup> 139<col align="left" valign="top"> 140<col> 141</colgroup> 142<tbody><tr> 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> 145</tr></tbody> 146</table></div></td> 147</tr></tbody> 148</table></div> 149</li> 150<li class="listitem"> 151<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm45267287550192-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> 152</p> 153<div class="variablelist"><table border="0" class="variablelist compact"> 154<colgroup> 155<col align="left" valign="top"> 156<col> 157</colgroup> 158<tbody><tr> 159<td><p><span class="term">Parameters:</span></p></td> 160<td><div class="variablelist"><table border="0" class="variablelist compact"> 161<colgroup> 162<col align="left" valign="top"> 163<col> 164</colgroup> 165<tbody> 166<tr> 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> 169</tr> 170<tr> 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> 173</tr> 174</tbody> 175</table></div></td> 176</tr></tbody> 177</table></div> 178</li> 179<li class="listitem"> 180<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm45267287546064-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> 181</p> 182<p><span class="bold"><strong>See Also:</strong></span></p> 183<p>test_unit_finish </p> 184<p> 185</p> 186<p> 187</p> 188<div class="variablelist"><table border="0" class="variablelist compact"> 189<colgroup> 190<col align="left" valign="top"> 191<col> 192</colgroup> 193<tbody><tr> 194<td><p><span class="term">Parameters:</span></p></td> 195<td><div class="variablelist"><table border="0" class="variablelist compact"> 196<colgroup> 197<col align="left" valign="top"> 198<col> 199</colgroup> 200<tbody> 201<tr> 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> 204</tr> 205<tr> 206<td><p><span class="term"><code class="computeroutput">tu</code></span></p></td> 207<td><p>test unit being started </p></td> 208</tr> 209</tbody> 210</table></div></td> 211</tr></tbody> 212</table></div> 213</li> 214<li class="listitem"> 215<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> 216<a name="idm45267287540368-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> 218</p> 219<p><span class="bold"><strong>See Also:</strong></span></p> 220<p>test_unit_start </p> 221<p> 222</p> 223<p> 224</p> 225<div class="variablelist"><table border="0" class="variablelist compact"> 226<colgroup> 227<col align="left" valign="top"> 228<col> 229</colgroup> 230<tbody><tr> 231<td><p><span class="term">Parameters:</span></p></td> 232<td><div class="variablelist"><table border="0" class="variablelist compact"> 233<colgroup> 234<col align="left" valign="top"> 235<col> 236</colgroup> 237<tbody> 238<tr> 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> 241</tr> 242<tr> 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> 245</tr> 246<tr> 247<td><p><span class="term"><code class="computeroutput">tu</code></span></p></td> 248<td><p>test unit being finished </p></td> 249</tr> 250</tbody> 251</table></div></td> 252</tr></tbody> 253</table></div> 254</li> 255<li class="listitem"> 256<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> 257<a name="idm45267287533568-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> 258</p> 259<div class="variablelist"><table border="0" class="variablelist compact"> 260<colgroup> 261<col align="left" valign="top"> 262<col> 263</colgroup> 264<tbody><tr> 265<td><p><span class="term">Parameters:</span></p></td> 266<td><div class="variablelist"><table border="0" class="variablelist compact"> 267<colgroup> 268<col align="left" valign="top"> 269<col> 270</colgroup> 271<tbody> 272<tr> 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> 275</tr> 276<tr> 277<td><p><span class="term"><code class="computeroutput">tu</code></span></p></td> 278<td><p>skipped test unit </p></td> 279</tr> 280</tbody> 281</table></div></td> 282</tr></tbody> 283</table></div> 284</li> 285<li class="listitem"> 286<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> 287<a name="idm45267287528512-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> 293</ul></div> 294<p> 295</p> 296<p>The logging of the exception information is finilized by a call to <code class="computeroutput">log_exception_finish</code>.</p> 297<p> 298</p> 299<p><span class="bold"><strong>See Also:</strong></span></p> 300<p>log_exception_finish </p> 301<p> 302</p> 303<p> 304</p> 305<div class="variablelist"><table border="0" class="variablelist compact"> 306<colgroup> 307<col align="left" valign="top"> 308<col> 309</colgroup> 310<tbody><tr> 311<td><p><span class="term">Parameters:</span></p></td> 312<td><div class="variablelist"><table border="0" class="variablelist compact"> 313<colgroup> 314<col align="left" valign="top"> 315<col> 316</colgroup> 317<tbody> 318<tr> 319<td><p><span class="term"><code class="computeroutput">ex</code></span></p></td> 320<td><p>information about the caught exception </p></td> 321</tr> 322<tr> 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> 325</tr> 326<tr> 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> 329</tr> 330</tbody> 331</table></div></td> 332</tr></tbody> 333</table></div> 334</li> 335<li class="listitem"> 336<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm45267287516656-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. 337</p> 338<p><span class="bold"><strong>See Also:</strong></span></p> 339<p>log_exception_start </p> 340<p> 341</p> 342<p> 343</p> 344<div class="variablelist"><table border="0" class="variablelist compact"> 345<colgroup> 346<col align="left" valign="top"> 347<col> 348</colgroup> 349<tbody><tr> 350<td><p><span class="term">Parameters:</span></p></td> 351<td><div class="variablelist"><table border="0" class="variablelist compact"> 352<colgroup> 353<col align="left" valign="top"> 354<col> 355</colgroup> 356<tbody><tr> 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> 359</tr></tbody> 360</table></div></td> 361</tr></tbody> 362</table></div> 363</li> 364<li class="listitem"> 365<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> 366<a name="idm45267287512320-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. 368</p> 369<p><span class="bold"><strong>See Also:</strong></span></p> 370<p>log_entry_value, log_entry_finish</p> 371<p> 372</p> 373<p> 374</p> 375<div class="note"><table border="0" summary="Note"> 376<tr> 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> 379</tr> 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> 381</table></div> 382<p> 383</p> 384<div class="variablelist"><table border="0" class="variablelist compact"> 385<colgroup> 386<col align="left" valign="top"> 387<col> 388</colgroup> 389<tbody><tr> 390<td><p><span class="term">Parameters:</span></p></td> 391<td><div class="variablelist"><table border="0" class="variablelist compact"> 392<colgroup> 393<col align="left" valign="top"> 394<col> 395</colgroup> 396<tbody> 397<tr> 398<td><p><span class="term"><code class="computeroutput">led</code></span></p></td> 399<td><p>log entry attributes </p></td> 400</tr> 401<tr> 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> 404</tr> 405<tr> 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> 408</tr> 409</tbody> 410</table></div></td> 411</tr></tbody> 412</table></div> 413</li> 414<li class="listitem"> 415<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm45267287504304-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. 416</p> 417<p><span class="bold"><strong>See Also:</strong></span></p> 418<p>log_entry_start, log_entry_finish </p> 419<p> 420</p> 421<p> 422</p> 423<div class="variablelist"><table border="0" class="variablelist compact"> 424<colgroup> 425<col align="left" valign="top"> 426<col> 427</colgroup> 428<tbody><tr> 429<td><p><span class="term">Parameters:</span></p></td> 430<td><div class="variablelist"><table border="0" class="variablelist compact"> 431<colgroup> 432<col align="left" valign="top"> 433<col> 434</colgroup> 435<tbody> 436<tr> 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> 439</tr> 440<tr> 441<td><p><span class="term"><code class="computeroutput">value</code></span></p></td> 442<td><p>log entry string value </p></td> 443</tr> 444</tbody> 445</table></div></td> 446</tr></tbody> 447</table></div> 448</li> 449<li class="listitem"> 450<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm45267287498784-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. 451</p> 452<p><span class="bold"><strong>See Also:</strong></span></p> 453<p>log_entry_start, log_entry_finish </p> 454<p> 455</p> 456<p> 457</p> 458<div class="variablelist"><table border="0" class="variablelist compact"> 459<colgroup> 460<col align="left" valign="top"> 461<col> 462</colgroup> 463<tbody><tr> 464<td><p><span class="term">Parameters:</span></p></td> 465<td><div class="variablelist"><table border="0" class="variablelist compact"> 466<colgroup> 467<col align="left" valign="top"> 468<col> 469</colgroup> 470<tbody> 471<tr> 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> 474</tr> 475<tr> 476<td><p><span class="term"><code class="computeroutput">value</code></span></p></td> 477<td><p>log entry "lazy" value </p></td> 478</tr> 479</tbody> 480</table></div></td> 481</tr></tbody> 482</table></div> 483</li> 484<li class="listitem"> 485<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm45267287493088-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> 486</p> 487<p><span class="bold"><strong>See Also:</strong></span></p> 488<p>log_entry_start, log_entry_start </p> 489<p> 490</p> 491<p> 492</p> 493<div class="variablelist"><table border="0" class="variablelist compact"> 494<colgroup> 495<col align="left" valign="top"> 496<col> 497</colgroup> 498<tbody><tr> 499<td><p><span class="term">Parameters:</span></p></td> 500<td><div class="variablelist"><table border="0" class="variablelist compact"> 501<colgroup> 502<col align="left" valign="top"> 503<col> 504</colgroup> 505<tbody><tr> 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> 508</tr></tbody> 509</table></div></td> 510</tr></tbody> 511</table></div> 512</li> 513<li class="listitem"> 514<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm45267287488784-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. 515</p> 516<p><span class="bold"><strong>See Also:</strong></span></p> 517<p>log_entry_context, entry_context_finish </p> 518<p> 519</p> 520<p> 521</p> 522<div class="variablelist"><table border="0" class="variablelist compact"> 523<colgroup> 524<col align="left" valign="top"> 525<col> 526</colgroup> 527<tbody><tr> 528<td><p><span class="term">Parameters:</span></p></td> 529<td><div class="variablelist"><table border="0" class="variablelist compact"> 530<colgroup> 531<col align="left" valign="top"> 532<col> 533</colgroup> 534<tbody> 535<tr> 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> 538</tr> 539<tr> 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> 542</tr> 543</tbody> 544</table></div></td> 545</tr></tbody> 546</table></div> 547</li> 548<li class="listitem"> 549<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> 550<a name="idm45267287483072-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. 551</p> 552<p><span class="bold"><strong>See Also:</strong></span></p> 553<p>log_entry_start, entry_context_finish </p> 554<p> 555</p> 556<p> 557</p> 558<div class="variablelist"><table border="0" class="variablelist compact"> 559<colgroup> 560<col align="left" valign="top"> 561<col> 562</colgroup> 563<tbody><tr> 564<td><p><span class="term">Parameters:</span></p></td> 565<td><div class="variablelist"><table border="0" class="variablelist compact"> 566<colgroup> 567<col align="left" valign="top"> 568<col> 569</colgroup> 570<tbody> 571<tr> 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> 574</tr> 575<tr> 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> 578</tr> 579<tr> 580<td><p><span class="term"><code class="computeroutput">value</code></span></p></td> 581<td><p>context "scope" description </p></td> 582</tr> 583</tbody> 584</table></div></td> 585</tr></tbody> 586</table></div> 587</li> 588<li class="listitem"> 589<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm45267287476432-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> 590</p> 591<p><span class="bold"><strong>See Also:</strong></span></p> 592<p>log_entry_start, entry_context_context </p> 593<p> 594</p> 595<p> 596</p> 597<div class="variablelist"><table border="0" class="variablelist compact"> 598<colgroup> 599<col align="left" valign="top"> 600<col> 601</colgroup> 602<tbody><tr> 603<td><p><span class="term">Parameters:</span></p></td> 604<td><div class="variablelist"><table border="0" class="variablelist compact"> 605<colgroup> 606<col align="left" valign="top"> 607<col> 608</colgroup> 609<tbody> 610<tr> 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> 613</tr> 614<tr> 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> 617</tr> 618</tbody> 619</table></div></td> 620</tr></tbody> 621</table></div> 622</li> 623<li class="listitem"> 624<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm45267287470992-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> 625</li> 626<li class="listitem"> 627<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm45267287466816-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="idm45267287463728-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="idm45267287460640-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> 633<p> 634</p> 635</li> 636<li class="listitem"> 637<pre class="literallayout"><span class="keyword">virtual</span> <span class="identifier">log_level</span> <a name="idm45267287457136-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> 638<p> 639</p> 640</li> 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="idm45267287454304-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> 644<p> 645</p> 646</li> 647</ol></div> 648</div> 649<div class="refsect2"> 650<a name="idm46175618387312"></a><h3> 651<a name="idm45267287448688-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="idm45267287448112-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> 653</div> 654</div> 655</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-2020 Boost.Test contributors<p> 659 Distributed under the Boost Software License, Version 1.0. (See accompanying 660 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>) 661 </p> 662</div></td> 663</tr></table> 664<hr> 665<div class="spirit-nav"> 666<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> 667</div> 668</body> 669</html> 670
