libwreport-doc 3.6-1 / usr / share / doc / libwreport-doc / apidocs / notes_8h_source.html

This file is indexed.

/usr/share/doc/libwreport-doc/apidocs/notes_8h_source.html is in libwreport-doc 3.6-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>libwreport: notes.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">libwreport
   &#160;<span id="projectnumber">3.6</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_a77a435eba5a6a11d9ac0a833d87986c.html">wreport</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">notes.h</div>  </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="preprocessor">#ifndef WREPORT_NOTES_H</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="preprocessor">#define WREPORT_NOTES_H</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;</div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="preprocessor">#include &lt;iosfwd&gt;</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;</div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="preprocessor">#ifndef WREPORT_PRINTF_ATTRS</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="preprocessor">#define WREPORT_PRINTF_ATTRS(a, b) __attribute__ ((format(printf, a, b)))</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;</div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacewreport.html">wreport</a> {</div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;</div><div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="namespacewreport_1_1notes.html">   18</a></span>&#160;<span class="keyword">namespace </span>notes {</div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;</div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="keywordtype">void</span> <a class="code" href="namespacewreport_1_1notes.html#a4216a6a17fca1f386dcda712cd6f17c5">set_target</a>(std::ostream&amp; out);</div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;</div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;std::ostream* <a class="code" href="namespacewreport_1_1notes.html#a3d43d954b468179f3150d06178726637">get_target</a>();</div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;</div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="keywordtype">bool</span> <a class="code" href="namespacewreport_1_1notes.html#af63771b44858b3f9a0fc14e969e60813">logs</a>() <span class="keywordflow">throw</span> ();</div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;</div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;std::ostream&amp; <a class="code" href="namespacewreport_1_1notes.html#a302ee0e8068098d9fcf7035cdc2cfd08">log</a>() <span class="keywordflow">throw</span> ();</div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;</div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="keywordtype">void</span> <a class="code" href="namespacewreport_1_1notes.html#a6ccc3317851afa9338fda1956c7449c8">logf</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* fmt, ...) WREPORT_PRINTF_ATTRS(1, 2);</div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;</div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="structwreport_1_1notes_1_1Collect.html">   41</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structwreport_1_1notes_1_1Collect.html">Collect</a></div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;{</div><div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="structwreport_1_1notes_1_1Collect.html#a7b4bbcf60ab0882cc4fb822cca1ad7ad">   46</a></span>&#160;    std::ostream* <a class="code" href="structwreport_1_1notes_1_1Collect.html#a7b4bbcf60ab0882cc4fb822cca1ad7ad">old</a>;</div><div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;</div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="structwreport_1_1notes_1_1Collect.html#af77e22f1c9d8b91085caa60f7fed0d61">   49</a></span>&#160;    <a class="code" href="structwreport_1_1notes_1_1Collect.html#af77e22f1c9d8b91085caa60f7fed0d61">Collect</a>(std::ostream&amp; out)</div><div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;    {</div><div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;        old = <a class="code" href="namespacewreport_1_1notes.html#a3d43d954b468179f3150d06178726637">get_target</a>();</div><div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;        <a class="code" href="namespacewreport_1_1notes.html#a4216a6a17fca1f386dcda712cd6f17c5">set_target</a>(out);</div><div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;    }</div><div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;    ~<a class="code" href="structwreport_1_1notes_1_1Collect.html">Collect</a>()</div><div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;    {</div><div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;        <a class="code" href="namespacewreport_1_1notes.html#a4216a6a17fca1f386dcda712cd6f17c5">set_target</a>(*old);</div><div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;    }</div><div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;};</div><div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;</div><div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;}</div><div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;}</div><div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;</div><div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="namespacewreport_1_1notes_html_a6ccc3317851afa9338fda1956c7449c8"><div class="ttname"><a href="namespacewreport_1_1notes.html#a6ccc3317851afa9338fda1956c7449c8">wreport::notes::logf</a></div><div class="ttdeci">void logf(const char *fmt,...) WREPORT_PRINTF_ATTRS(1</div><div class="ttdoc">printf-style logging </div></div>
<div class="ttc" id="structwreport_1_1notes_1_1Collect_html_af77e22f1c9d8b91085caa60f7fed0d61"><div class="ttname"><a href="structwreport_1_1notes_1_1Collect.html#af77e22f1c9d8b91085caa60f7fed0d61">wreport::notes::Collect::Collect</a></div><div class="ttdeci">Collect(std::ostream &amp;out)</div><div class="ttdoc">Direct notes to out for the lifetime of the object. </div><div class="ttdef"><b>Definition:</b> notes.h:49</div></div>
<div class="ttc" id="namespacewreport_1_1notes_html_a302ee0e8068098d9fcf7035cdc2cfd08"><div class="ttname"><a href="namespacewreport_1_1notes.html#a302ee0e8068098d9fcf7035cdc2cfd08">wreport::notes::log</a></div><div class="ttdeci">std::ostream &amp; log()</div><div class="ttdoc">Output stream to send notes to. </div></div>
<div class="ttc" id="structwreport_1_1notes_1_1Collect_html_a7b4bbcf60ab0882cc4fb822cca1ad7ad"><div class="ttname"><a href="structwreport_1_1notes_1_1Collect.html#a7b4bbcf60ab0882cc4fb822cca1ad7ad">wreport::notes::Collect::old</a></div><div class="ttdeci">std::ostream * old</div><div class="ttdoc">Old target stream to be restored whemn the object goes out of scope. </div><div class="ttdef"><b>Definition:</b> notes.h:46</div></div>
<div class="ttc" id="namespacewreport_html"><div class="ttname"><a href="namespacewreport.html">wreport</a></div><div class="ttdoc">String functions. </div><div class="ttdef"><b>Definition:</b> benchmark.h:13</div></div>
<div class="ttc" id="namespacewreport_1_1notes_html_a4216a6a17fca1f386dcda712cd6f17c5"><div class="ttname"><a href="namespacewreport_1_1notes.html#a4216a6a17fca1f386dcda712cd6f17c5">wreport::notes::set_target</a></div><div class="ttdeci">void set_target(std::ostream &amp;out)</div><div class="ttdoc">Set the target stream where the notes are sent. </div></div>
<div class="ttc" id="namespacewreport_1_1notes_html_af63771b44858b3f9a0fc14e969e60813"><div class="ttname"><a href="namespacewreport_1_1notes.html#af63771b44858b3f9a0fc14e969e60813">wreport::notes::logs</a></div><div class="ttdeci">bool logs()</div><div class="ttdoc">Return true if there is any target to which notes are sent. </div></div>
<div class="ttc" id="namespacewreport_1_1notes_html_a3d43d954b468179f3150d06178726637"><div class="ttname"><a href="namespacewreport_1_1notes.html#a3d43d954b468179f3150d06178726637">wreport::notes::get_target</a></div><div class="ttdeci">std::ostream * get_target()</div><div class="ttdoc">Get the current target stream for notes. </div></div>
<div class="ttc" id="structwreport_1_1notes_1_1Collect_html"><div class="ttname"><a href="structwreport_1_1notes_1_1Collect.html">wreport::notes::Collect</a></div><div class="ttdoc">RAII way to temporarily set a notes target. </div><div class="ttdef"><b>Definition:</b> notes.h:41</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Aug 18 2016 13:32:18 for libwreport by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>

APT Browse - Built by Thomas Orozco.