nojhan/clutchlog
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

update doc

Browse source
This commit is contained in:
Johann Dreo 2021-12-19 08:32:51 +01:00
commit 26a5461cc4
161 changed files with 3506 additions and 760 deletions
Download patch file Download diff file Expand all files Collapse all files

57
docs/classclutchlog_1_1fmt.html
View file

@ -1,9 +1,9 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.13"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>clutchlog: clutchlog::fmt Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">clutchlog
&#160;<span id="projectnumber">0.5.0</span>
&#160;<span id="projectnumber">0.6.0</span>
</div>
</td>
</tr>
@ -30,18 +30,21 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
@ -95,8 +98,8 @@ Public Types</h2></td></tr>
<br />
&#160;&#160;<b>none</b>
<br />
}<tr class="memdesc:a4662a3ec3577c6a575a2c734636ed8a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Foreground color codes. <br /></td></tr>
</td></tr>
}</td></tr>
<tr class="memdesc:a4662a3ec3577c6a575a2c734636ed8a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Foreground color codes. <br /></td></tr>
<tr class="separator:a4662a3ec3577c6a575a2c734636ed8a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1cf3e27e4041250ffea0a6d58010da1e"><td class="memItemLeft" align="right" valign="top"><a id="a1cf3e27e4041250ffea0a6d58010da1e"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classclutchlog_1_1fmt.html#a1cf3e27e4041250ffea0a6d58010da1e">bg</a> { <br />
&#160;&#160;<b>black</b> = 40,
@ -111,8 +114,8 @@ Public Types</h2></td></tr>
<br />
&#160;&#160;<b>none</b>
<br />
}<tr class="memdesc:a1cf3e27e4041250ffea0a6d58010da1e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Background color codes. <br /></td></tr>
</td></tr>
}</td></tr>
<tr class="memdesc:a1cf3e27e4041250ffea0a6d58010da1e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Background color codes. <br /></td></tr>
<tr class="separator:a1cf3e27e4041250ffea0a6d58010da1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a932f47b78fb7b10590d5613a1c4eab89"><td class="memItemLeft" align="right" valign="top"><a id="a932f47b78fb7b10590d5613a1c4eab89"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classclutchlog_1_1fmt.html#a932f47b78fb7b10590d5613a1c4eab89">typo</a> { <br />
&#160;&#160;<b>reset</b> = 0,
@ -122,18 +125,18 @@ Public Types</h2></td></tr>
<br />
&#160;&#160;<b>none</b>
<br />
}<tr class="memdesc:a932f47b78fb7b10590d5613a1c4eab89"><td class="mdescLeft">&#160;</td><td class="mdescRight">Typographic style codes. <br /></td></tr>
</td></tr>
}</td></tr>
<tr class="memdesc:a932f47b78fb7b10590d5613a1c4eab89"><td class="mdescLeft">&#160;</td><td class="mdescRight">Typographic style codes. <br /></td></tr>
<tr class="separator:a932f47b78fb7b10590d5613a1c4eab89"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a407506bc02ed3f91d88b3df630e54959"><td class="memItemLeft" align="right" valign="top"><a id="a407506bc02ed3f91d88b3df630e54959"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classclutchlog_1_1fmt.html#a407506bc02ed3f91d88b3df630e54959">fmt</a> ()</td></tr>
<tr class="memdesc:a407506bc02ed3f91d88b3df630e54959"><td class="mdescLeft">&#160;</td><td class="mdescRight"> Empty constructor, only useful for a no-op formatter. <br /></td></tr>
<tr class="memdesc:a407506bc02ed3f91d88b3df630e54959"><td class="mdescLeft">&#160;</td><td class="mdescRight">&#160;Empty constructor, only useful for a no-op formatter. <br /></td></tr>
<tr class="separator:a407506bc02ed3f91d88b3df630e54959"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afeaedd18298498d1dcfcc15f5f17ac3c"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classclutchlog_1_1fmt.html#afeaedd18298498d1dcfcc15f5f17ac3c">operator()</a> (const std::string &amp;msg) const</td></tr>
<tr class="memdesc:afeaedd18298498d1dcfcc15f5f17ac3c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Format the given string with the currently encoded format. <a href="#afeaedd18298498d1dcfcc15f5f17ac3c">More...</a><br /></td></tr>
<tr class="memdesc:afeaedd18298498d1dcfcc15f5f17ac3c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Format the given string with the currently encoded format. <a href="classclutchlog_1_1fmt.html#afeaedd18298498d1dcfcc15f5f17ac3c">More...</a><br /></td></tr>
<tr class="separator:afeaedd18298498d1dcfcc15f5f17ac3c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">All combination of constructors with different parameters orders.</div></td></tr>
<tr class="memitem:a6cc6126d113fc0647ed3acbf29cdc425"><td class="memItemLeft" align="right" valign="top"><a id="a6cc6126d113fc0647ed3acbf29cdc425"></a>
@ -157,15 +160,15 @@ Public Member Functions</h2></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a0743e7095b5c9f4d856e84d21b5da2ee"><td class="memItemLeft" align="right" valign="top"><a id="a0743e7095b5c9f4d856e84d21b5da2ee"></a>
<tr class="memitem:a8307a848fcf9ed929435b3e1f2b53401"><td class="memItemLeft" align="right" valign="top"><a id="a8307a848fcf9ed929435b3e1f2b53401"></a>
enum <a class="el" href="classclutchlog_1_1fmt.html#a4662a3ec3577c6a575a2c734636ed8a0">clutchlog::fmt::fg</a>&#160;</td><td class="memItemRight" valign="bottom"><b>fore</b></td></tr>
<tr class="separator:a0743e7095b5c9f4d856e84d21b5da2ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3cb46f9202161b7375baf3a7bfd440be"><td class="memItemLeft" align="right" valign="top"><a id="a3cb46f9202161b7375baf3a7bfd440be"></a>
<tr class="separator:a8307a848fcf9ed929435b3e1f2b53401"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a86696b20e5b31c96ba592926efb324f3"><td class="memItemLeft" align="right" valign="top"><a id="a86696b20e5b31c96ba592926efb324f3"></a>
enum <a class="el" href="classclutchlog_1_1fmt.html#a1cf3e27e4041250ffea0a6d58010da1e">clutchlog::fmt::bg</a>&#160;</td><td class="memItemRight" valign="bottom"><b>back</b></td></tr>
<tr class="separator:a3cb46f9202161b7375baf3a7bfd440be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa9f6c806abb8c6ffb6cade5a14e9db02"><td class="memItemLeft" align="right" valign="top"><a id="aa9f6c806abb8c6ffb6cade5a14e9db02"></a>
<tr class="separator:a86696b20e5b31c96ba592926efb324f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2bb0fde65fcd264393e102314dd1610b"><td class="memItemLeft" align="right" valign="top"><a id="a2bb0fde65fcd264393e102314dd1610b"></a>
enum <a class="el" href="classclutchlog_1_1fmt.html#a932f47b78fb7b10590d5613a1c4eab89">clutchlog::fmt::typo</a>&#160;</td><td class="memItemRight" valign="bottom"><b>style</b></td></tr>
<tr class="separator:aa9f6c806abb8c6ffb6cade5a14e9db02"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="separator:a2bb0fde65fcd264393e102314dd1610b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
@ -177,7 +180,7 @@ std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a96849ba427feac3a2eeaa1165e3845da"><td class="memItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classclutchlog_1_1fmt.html#a96849ba427feac3a2eeaa1165e3845da">operator&lt;&lt;</a> (std::ostream &amp;os, const <a class="el" href="classclutchlog_1_1fmt.html">fmt</a> &amp;<a class="el" href="classclutchlog_1_1fmt.html">fmt</a>)</td></tr>
<tr class="memdesc:a96849ba427feac3a2eeaa1165e3845da"><td class="mdescLeft">&#160;</td><td class="mdescRight">Output stream overload. <a href="#a96849ba427feac3a2eeaa1165e3845da">More...</a><br /></td></tr>
<tr class="memdesc:a96849ba427feac3a2eeaa1165e3845da"><td class="mdescLeft">&#160;</td><td class="mdescRight">Output stream overload. <a href="classclutchlog_1_1fmt.html#a96849ba427feac3a2eeaa1165e3845da">More...</a><br /></td></tr>
<tr class="separator:a96849ba427feac3a2eeaa1165e3845da"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
@ -209,13 +212,15 @@ Friends</h2></td></tr>
</div><div class="memdoc">
<p>Format the given string with the currently encoded format. </p>
<p>Allow to use a formatter as a function: </p><div class="fragment"><div class="line"><a class="code" href="classclutchlog_1_1fmt.html">clutchlog::fmt</a> error(clutchlog::fmt::fg::red, clutchlog::fmt::typo::bold);</div><div class="line">std::cout &lt;&lt; error(<span class="stringliteral">&quot;ERROR&quot;</span>) &lt;&lt; std::endl;</div></div><!-- fragment --><dl class="section note"><dt>Note</dt><dd>A formatter called this way WILL output a reset escape code at the end. </dd></dl>
<p>Allow to use a formatter as a function: </p><div class="fragment"><div class="line"><a class="code" href="classclutchlog_1_1fmt.html">clutchlog::fmt</a> error(clutchlog::fmt::fg::red, clutchlog::fmt::typo::bold);</div>
<div class="line">std::cout &lt;&lt; error(<span class="stringliteral">&quot;ERROR&quot;</span>) &lt;&lt; std::endl;</div>
</div><!-- fragment --><dl class="section note"><dt>Note</dt><dd>A formatter called this way WILL output a reset escape code at the end. </dd></dl>
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a id="a96849ba427feac3a2eeaa1165e3845da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a96849ba427feac3a2eeaa1165e3845da">&#9670;&nbsp;</a></span>operator<<</h2>
<h2 class="memtitle"><span class="permalink"><a href="#a96849ba427feac3a2eeaa1165e3845da">&#9670;&nbsp;</a></span>operator&lt;&lt;</h2>
<div class="memitem">
<div class="memproto">
@ -249,7 +254,10 @@ Friends</h2></td></tr>
</div><div class="memdoc">
<p>Output stream overload. </p>
<p>Allow to use a formatter as a tag within a stream: </p><div class="fragment"><div class="line"><a class="code" href="classclutchlog_1_1fmt.html">clutchlog::fmt</a> end(clutchlog::fmt::typo::reset);</div><div class="line"><a class="code" href="classclutchlog_1_1fmt.html">clutchlog::fmt</a> error(clutchlog::fmt::fg::red, clutchlog::fmt::typo::bold);</div><div class="line">std::cout &lt;&lt; error &lt;&lt; <span class="stringliteral">&quot;ERROR&quot;</span> &lt;&lt; end &lt;&lt; std::endl;</div></div><!-- fragment --><dl class="section note"><dt>Note</dt><dd>An formatter called this way will NOT output a reset escape code. </dd></dl>
<p>Allow to use a formatter as a tag within a stream: </p><div class="fragment"><div class="line"><a class="code" href="classclutchlog_1_1fmt.html">clutchlog::fmt</a> end(clutchlog::fmt::typo::reset);</div>
<div class="line"><a class="code" href="classclutchlog_1_1fmt.html">clutchlog::fmt</a> error(clutchlog::fmt::fg::red, clutchlog::fmt::typo::bold);</div>
<div class="line">std::cout &lt;&lt; error &lt;&lt; <span class="stringliteral">&quot;ERROR&quot;</span> &lt;&lt; end &lt;&lt; std::endl;</div>
</div><!-- fragment --><dl class="section note"><dt>Note</dt><dd>An formatter called this way will NOT output a reset escape code. </dd></dl>
</div>
</div>
@ -257,11 +265,12 @@ Friends</h2></td></tr>
<li>clutchlog/<a class="el" href="clutchlog_8h_source.html">clutchlog.h</a></li>
</ul>
</div><!-- contents -->
<div class="ttc" id="aclassclutchlog_1_1fmt_html"><div class="ttname"><a href="classclutchlog_1_1fmt.html">clutchlog::fmt</a></div><div class="ttdoc">Color and style formatter for ANSI terminal escape sequences.</div><div class="ttdef"><b>Definition:</b> clutchlog.h:223</div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</a> 1.8.17
</small></address>
</body>
</html>