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

update(docs)

Browse source
This commit is contained in:
Johann Dreo 2024-09-10 16:21:54 +02:00
commit c9cb73990d
213 changed files with 10044 additions and 6276 deletions
Download patch file Download diff file Expand all files Collapse all files

131
docs/group___use_macros.html
View file

@ -2,8 +2,8 @@
<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.17"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>clutchlog: High-level API macros</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@ -24,11 +24,10 @@
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="clutchlog_logo.svg"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">clutchlog
&#160;<span id="projectnumber">0.16</span>
<td id="projectalign">
<div id="projectname">clutchlog<span id="projectnumber">&#160;0.17</span>
</div>
</td>
</tr>
@ -36,21 +35,22 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<!-- Generated by Doxygen 1.9.4 -->
<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 magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @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 */
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
@ -64,7 +64,7 @@ $(function() {
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('group___use_macros.html',''); initResizable(); });
/* @license-end */
</script>
@ -86,24 +86,21 @@ $(document).ready(function(){initNavTree('group___use_macros.html',''); initResi
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">High-level API macros</div> </div>
<div class="headertitle"><div class="title">High-level API macros</div></div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gae8911119d726a43b77f5781cb5a72813"><td class="memItemLeft" align="right" valign="top"><a id="gae8911119d726a43b77f5781cb5a72813"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___use_macros.html#gae8911119d726a43b77f5781cb5a72813">CLUTCHLOC</a>&#160;&#160;&#160;__FILE__, __FUNCTION__, __LINE__</td></tr>
<tr class="memdesc:gae8911119d726a43b77f5781cb5a72813"><td class="mdescLeft">&#160;</td><td class="mdescRight">Handy shortcuts to location. <br /></td></tr>
<tr class="memitem:gae8911119d726a43b77f5781cb5a72813"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___use_macros.html#gae8911119d726a43b77f5781cb5a72813">CLUTCHLOC</a>&#160;&#160;&#160;__FILE__, __FUNCTION__, __LINE__</td></tr>
<tr class="memdesc:gae8911119d726a43b77f5781cb5a72813"><td class="mdescLeft">&#160;</td><td class="mdescRight">Handy shortcuts to location. <a href="group___use_macros.html#gae8911119d726a43b77f5781cb5a72813">More...</a><br /></td></tr>
<tr class="separator:gae8911119d726a43b77f5781cb5a72813"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga369d365b7c25ec270596c3ca6839cf2c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___use_macros.html#ga369d365b7c25ec270596c3ca6839cf2c">CLUTCHLOGD</a>(LEVEL, WHAT, DEPTH_DELTA)</td></tr>
<tr class="memdesc:ga369d365b7c25ec270596c3ca6839cf2c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Log a message at the given level and with a given depth delta. <a href="group___use_macros.html#ga369d365b7c25ec270596c3ca6839cf2c">More...</a><br /></td></tr>
<tr class="separator:ga369d365b7c25ec270596c3ca6839cf2c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6f86187e2b35e7e1907d688f504a197d"><td class="memItemLeft" align="right" valign="top"><a id="ga6f86187e2b35e7e1907d688f504a197d"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___use_macros.html#ga6f86187e2b35e7e1907d688f504a197d">CLUTCHLOG</a>(LEVEL, WHAT)&#160;&#160;&#160;<a class="el" href="group___use_macros.html#ga369d365b7c25ec270596c3ca6839cf2c">CLUTCHLOGD</a>(LEVEL, WHAT, 0)</td></tr>
<tr class="memdesc:ga6f86187e2b35e7e1907d688f504a197d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Log a message at the given level. <br /></td></tr>
<tr class="memitem:ga6f86187e2b35e7e1907d688f504a197d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___use_macros.html#ga6f86187e2b35e7e1907d688f504a197d">CLUTCHLOG</a>(LEVEL, WHAT)&#160;&#160;&#160; <a class="el" href="group___use_macros.html#ga369d365b7c25ec270596c3ca6839cf2c">CLUTCHLOGD</a>(LEVEL, WHAT, 0)</td></tr>
<tr class="memdesc:ga6f86187e2b35e7e1907d688f504a197d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Log a message at the given level. <a href="group___use_macros.html#ga6f86187e2b35e7e1907d688f504a197d">More...</a><br /></td></tr>
<tr class="separator:ga6f86187e2b35e7e1907d688f504a197d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga572e3aa19d8b39e3ed0b9e91961104c2"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___use_macros.html#ga572e3aa19d8b39e3ed0b9e91961104c2">CLUTCHDUMP</a>(LEVEL, CONTAINER, FILENAME)</td></tr>
<tr class="memdesc:ga572e3aa19d8b39e3ed0b9e91961104c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dump the given container. <a href="group___use_macros.html#ga572e3aa19d8b39e3ed0b9e91961104c2">More...</a><br /></td></tr>
@ -116,7 +113,25 @@ Macros</h2></td></tr>
<tr class="separator:gaaf2e85e1153e6c88b458dd49e3c37c73"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ga369d365b7c25ec270596c3ca6839cf2c"></a>
<a id="gae8911119d726a43b77f5781cb5a72813" name="gae8911119d726a43b77f5781cb5a72813"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae8911119d726a43b77f5781cb5a72813">&#9670;&nbsp;</a></span>CLUTCHLOC</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define CLUTCHLOC&#160;&#160;&#160;__FILE__, __FUNCTION__, __LINE__</td>
</tr>
</table>
</div><div class="memdoc">
<p>Handy shortcuts to location. </p>
<p class="definition">Definition at line <a class="el" href="clutchlog_8h_source.html#l00078">78</a> of file <a class="el" href="clutchlog_8h_source.html">clutchlog.h</a>.</p>
</div>
</div>
<a id="ga369d365b7c25ec270596c3ca6839cf2c" name="ga369d365b7c25ec270596c3ca6839cf2c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga369d365b7c25ec270596c3ca6839cf2c">&#9670;&nbsp;</a></span>CLUTCHLOGD</h2>
<div class="memitem">
@ -148,18 +163,52 @@ Macros</h2></td></tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> <span class="keywordflow">do</span> { \</div>
<div class="line"> auto&amp; clutchlog__logger = <a class="code" href="classclutchlog.html#acfaceb77da01503b432644a3efaee4fa">clutchlog::logger</a>(); \</div>
<div class="line"> auto&amp; clutchlog__logger = <a class="code hl_function" href="classclutchlog.html#a6e2a5e98fa9f722d90ba6515895543ac">clutchlog::logger</a>(); \</div>
<div class="line"> std::ostringstream clutchlog__msg ; clutchlog__msg &lt;&lt; WHAT; \</div>
<div class="line"> clutchlog__logger.log(clutchlog::level::LEVEL, clutchlog__msg.str(), <a class="code" href="group___use_macros.html#gae8911119d726a43b77f5781cb5a72813">CLUTCHLOC</a>, DEPTH_DELTA); \</div>
<div class="line"> clutchlog__logger.log(clutchlog::level::LEVEL, clutchlog__msg.str(), <a class="code hl_define" href="group___use_macros.html#gae8911119d726a43b77f5781cb5a72813">CLUTCHLOC</a>, DEPTH_DELTA); \</div>
<div class="line"> } <span class="keywordflow">while</span>(0)</div>
<div class="ttc" id="aclassclutchlog_html_a6e2a5e98fa9f722d90ba6515895543ac"><div class="ttname"><a href="classclutchlog.html#a6e2a5e98fa9f722d90ba6515895543ac">clutchlog::logger</a></div><div class="ttdeci">static clutchlog &amp; logger()</div><div class="ttdoc">Get the logger instance.</div><div class="ttdef"><b>Definition:</b> <a href="clutchlog_8h_source.html#l00307">clutchlog.h:307</a></div></div>
<div class="ttc" id="agroup___use_macros_html_gae8911119d726a43b77f5781cb5a72813"><div class="ttname"><a href="group___use_macros.html#gae8911119d726a43b77f5781cb5a72813">CLUTCHLOC</a></div><div class="ttdeci">#define CLUTCHLOC</div><div class="ttdoc">Handy shortcuts to location.</div><div class="ttdef"><b>Definition:</b> <a href="clutchlog_8h_source.html#l00078">clutchlog.h:78</a></div></div>
</div><!-- fragment -->
<p>Log a message at the given level and with a given depth delta. </p>
<p class="definition">Definition at line <a class="el" href="clutchlog_8h_source.html#l00081">81</a> of file <a class="el" href="clutchlog_8h_source.html">clutchlog.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="clutchlog_8h_source.html#l00082">82</a> of file <a class="el" href="clutchlog_8h_source.html">clutchlog.h</a>.</p>
</div>
</div>
<a id="ga572e3aa19d8b39e3ed0b9e91961104c2"></a>
<a id="ga6f86187e2b35e7e1907d688f504a197d" name="ga6f86187e2b35e7e1907d688f504a197d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6f86187e2b35e7e1907d688f504a197d">&#9670;&nbsp;</a></span>CLUTCHLOG</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define CLUTCHLOG</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">LEVEL, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">WHAT&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>&#160;&#160;&#160; <a class="el" href="group___use_macros.html#ga369d365b7c25ec270596c3ca6839cf2c">CLUTCHLOGD</a>(LEVEL, WHAT, 0)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Log a message at the given level. </p>
<p class="definition">Definition at line <a class="el" href="clutchlog_8h_source.html#l00099">99</a> of file <a class="el" href="clutchlog_8h_source.html">clutchlog.h</a>.</p>
</div>
</div>
<a id="ga572e3aa19d8b39e3ed0b9e91961104c2" name="ga572e3aa19d8b39e3ed0b9e91961104c2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga572e3aa19d8b39e3ed0b9e91961104c2">&#9670;&nbsp;</a></span>CLUTCHDUMP</h2>
<div class="memitem">
@ -191,18 +240,19 @@ Macros</h2></td></tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> <span class="keywordflow">do</span> { \</div>
<div class="line"> auto&amp; clutchlog__logger = <a class="code" href="classclutchlog.html#acfaceb77da01503b432644a3efaee4fa">clutchlog::logger</a>(); \</div>
<div class="line"> auto&amp; clutchlog__logger = <a class="code hl_function" href="classclutchlog.html#a6e2a5e98fa9f722d90ba6515895543ac">clutchlog::logger</a>(); \</div>
<div class="line"> clutchlog__logger.dump(clutchlog::level::LEVEL, std::begin(CONTAINER), std::end(CONTAINER), \</div>
<div class="line"> <a class="code" href="group___use_macros.html#gae8911119d726a43b77f5781cb5a72813">CLUTCHLOC</a>, FILENAME, <a class="code" href="group___default_config.html#ga54d29e956575e1c731eab5406135c5df">CLUTCHDUMP_DEFAULT_SEP</a>); \</div>
<div class="line"> <a class="code hl_define" href="group___use_macros.html#gae8911119d726a43b77f5781cb5a72813">CLUTCHLOC</a>, FILENAME, <a class="code hl_define" href="group___default_config.html#ga54d29e956575e1c731eab5406135c5df">CLUTCHDUMP_DEFAULT_SEP</a>); \</div>
<div class="line"> } <span class="keywordflow">while</span>(0)</div>
<div class="ttc" id="agroup___default_config_html_ga54d29e956575e1c731eab5406135c5df"><div class="ttname"><a href="group___default_config.html#ga54d29e956575e1c731eab5406135c5df">CLUTCHDUMP_DEFAULT_SEP</a></div><div class="ttdeci">#define CLUTCHDUMP_DEFAULT_SEP</div><div class="ttdoc">Compile-time default item separator for dump.</div><div class="ttdef"><b>Definition:</b> <a href="clutchlog_8h_source.html#l00250">clutchlog.h:250</a></div></div>
</div><!-- fragment -->
<p>Dump the given container. </p>
<p class="definition">Definition at line <a class="el" href="clutchlog_8h_source.html#l00107">107</a> of file <a class="el" href="clutchlog_8h_source.html">clutchlog.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="clutchlog_8h_source.html#l00108">108</a> of file <a class="el" href="clutchlog_8h_source.html">clutchlog.h</a>.</p>
</div>
</div>
<a id="ga9f77cee4f853e582262930c9c17f90ae"></a>
<a id="ga9f77cee4f853e582262930c9c17f90ae" name="ga9f77cee4f853e582262930c9c17f90ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9f77cee4f853e582262930c9c17f90ae">&#9670;&nbsp;</a></span>CLUTCHFUNC</h2>
<div class="memitem">
@ -234,8 +284,8 @@ Macros</h2></td></tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> <span class="keywordflow">do</span> { \</div>
<div class="line"> auto&amp; clutchlog__logger = <a class="code" href="classclutchlog.html#acfaceb77da01503b432644a3efaee4fa">clutchlog::logger</a>(); \</div>
<div class="line"> clutchlog::scope_t clutchlog__scope = clutchlog__logger.locate(clutchlog::level::LEVEL, <a class="code" href="group___use_macros.html#gae8911119d726a43b77f5781cb5a72813">CLUTCHLOC</a>); \</div>
<div class="line"> auto&amp; clutchlog__logger = <a class="code hl_function" href="classclutchlog.html#a6e2a5e98fa9f722d90ba6515895543ac">clutchlog::logger</a>(); \</div>
<div class="line"> clutchlog::scope_t clutchlog__scope = clutchlog__logger.locate(clutchlog::level::LEVEL, <a class="code hl_define" href="group___use_macros.html#gae8911119d726a43b77f5781cb5a72813">CLUTCHLOC</a>); \</div>
<div class="line"> if(clutchlog__scope.matches) { \</div>
<div class="line"> FUNC(__VA_ARGS__); \</div>
<div class="line"> } \</div>
@ -243,11 +293,11 @@ Macros</h2></td></tr>
</div><!-- fragment -->
<p>Call any function if the scope matches. </p>
<p class="definition">Definition at line <a class="el" href="clutchlog_8h_source.html#l00124">124</a> of file <a class="el" href="clutchlog_8h_source.html">clutchlog.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="clutchlog_8h_source.html#l00125">125</a> of file <a class="el" href="clutchlog_8h_source.html">clutchlog.h</a>.</p>
</div>
</div>
<a id="gaaf2e85e1153e6c88b458dd49e3c37c73"></a>
<a id="gaaf2e85e1153e6c88b458dd49e3c37c73" name="gaaf2e85e1153e6c88b458dd49e3c37c73"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaaf2e85e1153e6c88b458dd49e3c37c73">&#9670;&nbsp;</a></span>CLUTCHCODE</h2>
<div class="memitem">
@ -273,8 +323,8 @@ Macros</h2></td></tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> <span class="keywordflow">do</span> { \</div>
<div class="line"> auto&amp; clutchlog__logger = <a class="code" href="classclutchlog.html#acfaceb77da01503b432644a3efaee4fa">clutchlog::logger</a>(); \</div>
<div class="line"> clutchlog::scope_t clutchlog__scope = clutchlog__logger.locate(clutchlog::level::LEVEL, <a class="code" href="group___use_macros.html#gae8911119d726a43b77f5781cb5a72813">CLUTCHLOC</a>); \</div>
<div class="line"> auto&amp; clutchlog__logger = <a class="code hl_function" href="classclutchlog.html#a6e2a5e98fa9f722d90ba6515895543ac">clutchlog::logger</a>(); \</div>
<div class="line"> clutchlog::scope_t clutchlog__scope = clutchlog__logger.locate(clutchlog::level::LEVEL, <a class="code hl_define" href="group___use_macros.html#gae8911119d726a43b77f5781cb5a72813">CLUTCHLOC</a>); \</div>
<div class="line"> if(clutchlog__scope.matches) { \</div>
<div class="line"> __VA_ARGS__ \</div>
<div class="line"> } \</div>
@ -282,21 +332,16 @@ Macros</h2></td></tr>
</div><!-- fragment -->
<p>Run any code if the scope matches. </p>
<p class="definition">Definition at line <a class="el" href="clutchlog_8h_source.html#l00145">145</a> of file <a class="el" href="clutchlog_8h_source.html">clutchlog.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="clutchlog_8h_source.html#l00146">146</a> of file <a class="el" href="clutchlog_8h_source.html">clutchlog.h</a>.</p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="aclassclutchlog_html_acfaceb77da01503b432644a3efaee4fa"><div class="ttname"><a href="classclutchlog.html#acfaceb77da01503b432644a3efaee4fa">clutchlog::logger</a></div><div class="ttdeci">static clutchlog &amp; logger()</div><div class="ttdoc">Get the logger instance.</div><div class="ttdef"><b>Definition:</b> <a href="clutchlog_8h_source.html#l00306">clutchlog.h:306</a></div></div>
<div class="ttc" id="agroup___use_macros_html_gae8911119d726a43b77f5781cb5a72813"><div class="ttname"><a href="group___use_macros.html#gae8911119d726a43b77f5781cb5a72813">CLUTCHLOC</a></div><div class="ttdeci">#define CLUTCHLOC</div><div class="ttdoc">Handy shortcuts to location.</div><div class="ttdef"><b>Definition:</b> <a href="clutchlog_8h_source.html#l00077">clutchlog.h:77</a></div></div>
<div class="ttc" id="agroup___default_config_html_ga54d29e956575e1c731eab5406135c5df"><div class="ttname"><a href="group___default_config.html#ga54d29e956575e1c731eab5406135c5df">CLUTCHDUMP_DEFAULT_SEP</a></div><div class="ttdeci">#define CLUTCHDUMP_DEFAULT_SEP</div><div class="ttdoc">Compile-time default item separator for dump.</div><div class="ttdef"><b>Definition:</b> <a href="clutchlog_8h_source.html#l00249">clutchlog.h:249</a></div></div>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4 </li>
</ul>
</div>
</body>