303 lines
18 KiB
HTML
303 lines
18 KiB
HTML
<!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.17"/>
|
|
<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"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="doxygen-style.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="projectlogo"><img alt="Logo" src="clutchlog_logo.svg"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">clutchlog
|
|
 <span id="projectnumber">0.16</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.17 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&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&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('group___use_macros.html',''); initResizable(); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<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><!--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>
|
|
Macros</h2></td></tr>
|
|
<tr class="memitem:gae8911119d726a43b77f5781cb5a72813"><td class="memItemLeft" align="right" valign="top"><a id="gae8911119d726a43b77f5781cb5a72813"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___use_macros.html#gae8911119d726a43b77f5781cb5a72813">CLUTCHLOC</a>   __FILE__, __FUNCTION__, __LINE__</td></tr>
|
|
<tr class="memdesc:gae8911119d726a43b77f5781cb5a72813"><td class="mdescLeft"> </td><td class="mdescRight">Handy shortcuts to location. <br /></td></tr>
|
|
<tr class="separator:gae8911119d726a43b77f5781cb5a72813"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga369d365b7c25ec270596c3ca6839cf2c"><td class="memItemLeft" align="right" valign="top">#define </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"> </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"> </td></tr>
|
|
<tr class="memitem:ga6f86187e2b35e7e1907d688f504a197d"><td class="memItemLeft" align="right" valign="top"><a id="ga6f86187e2b35e7e1907d688f504a197d"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___use_macros.html#ga6f86187e2b35e7e1907d688f504a197d">CLUTCHLOG</a>(LEVEL, WHAT)   <a class="el" href="group___use_macros.html#ga369d365b7c25ec270596c3ca6839cf2c">CLUTCHLOGD</a>(LEVEL, WHAT, 0)</td></tr>
|
|
<tr class="memdesc:ga6f86187e2b35e7e1907d688f504a197d"><td class="mdescLeft"> </td><td class="mdescRight">Log a message at the given level. <br /></td></tr>
|
|
<tr class="separator:ga6f86187e2b35e7e1907d688f504a197d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga572e3aa19d8b39e3ed0b9e91961104c2"><td class="memItemLeft" align="right" valign="top">#define </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"> </td><td class="mdescRight">Dump the given container. <a href="group___use_macros.html#ga572e3aa19d8b39e3ed0b9e91961104c2">More...</a><br /></td></tr>
|
|
<tr class="separator:ga572e3aa19d8b39e3ed0b9e91961104c2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga9f77cee4f853e582262930c9c17f90ae"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___use_macros.html#ga9f77cee4f853e582262930c9c17f90ae">CLUTCHFUNC</a>(LEVEL, FUNC, ...)</td></tr>
|
|
<tr class="memdesc:ga9f77cee4f853e582262930c9c17f90ae"><td class="mdescLeft"> </td><td class="mdescRight">Call any function if the scope matches. <a href="group___use_macros.html#ga9f77cee4f853e582262930c9c17f90ae">More...</a><br /></td></tr>
|
|
<tr class="separator:ga9f77cee4f853e582262930c9c17f90ae"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaaf2e85e1153e6c88b458dd49e3c37c73"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___use_macros.html#gaaf2e85e1153e6c88b458dd49e3c37c73">CLUTCHCODE</a>(LEVEL, ...)</td></tr>
|
|
<tr class="memdesc:gaaf2e85e1153e6c88b458dd49e3c37c73"><td class="mdescLeft"> </td><td class="mdescRight">Run any code if the scope matches. <a href="group___use_macros.html#gaaf2e85e1153e6c88b458dd49e3c37c73">More...</a><br /></td></tr>
|
|
<tr class="separator:gaaf2e85e1153e6c88b458dd49e3c37c73"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a id="ga369d365b7c25ec270596c3ca6839cf2c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga369d365b7c25ec270596c3ca6839cf2c">◆ </a></span>CLUTCHLOGD</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define CLUTCHLOGD</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">LEVEL, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">WHAT, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">DEPTH_DELTA </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></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& clutchlog__logger = <a class="code" href="classclutchlog.html#acfaceb77da01503b432644a3efaee4fa">clutchlog::logger</a>(); \</div>
|
|
<div class="line"> std::ostringstream clutchlog__msg ; clutchlog__msg << 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"> } <span class="keywordflow">while</span>(0)</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>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga572e3aa19d8b39e3ed0b9e91961104c2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga572e3aa19d8b39e3ed0b9e91961104c2">◆ </a></span>CLUTCHDUMP</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define CLUTCHDUMP</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">LEVEL, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">CONTAINER, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">FILENAME </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></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& clutchlog__logger = <a class="code" href="classclutchlog.html#acfaceb77da01503b432644a3efaee4fa">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"> } <span class="keywordflow">while</span>(0)</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>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga9f77cee4f853e582262930c9c17f90ae"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga9f77cee4f853e582262930c9c17f90ae">◆ </a></span>CLUTCHFUNC</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define CLUTCHFUNC</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">LEVEL, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">FUNC, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>...</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></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& 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"> if(clutchlog__scope.matches) { \</div>
|
|
<div class="line"> FUNC(__VA_ARGS__); \</div>
|
|
<div class="line"> } \</div>
|
|
<div class="line"> } <span class="keywordflow">while</span>(0)</div>
|
|
</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>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaaf2e85e1153e6c88b458dd49e3c37c73"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaaf2e85e1153e6c88b458dd49e3c37c73">◆ </a></span>CLUTCHCODE</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define CLUTCHCODE</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">LEVEL, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>...</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></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& 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"> if(clutchlog__scope.matches) { \</div>
|
|
<div class="line"> __VA_ARGS__ \</div>
|
|
<div class="line"> } \</div>
|
|
<div class="line"> } <span class="keywordflow">while</span>(0)</div>
|
|
</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>
|
|
|
|
</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 & 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>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|