clutchlog/docs/classclutchlog.html
2022-09-07 23:08:14 +02:00

298 lines
36 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: clutchlog Class Reference</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="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" />
</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">clutchlog
&#160;<span id="projectnumber">0.10</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&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(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- 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><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pro-static-attribs">Static Protected Attributes</a> &#124;
<a href="classclutchlog-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">clutchlog Class Reference<div class="ingroups"><a class="el" href="group__Main.html">Main class</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classclutchlog_1_1fmt.html">fmt</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Color and style formatter for ANSI terminal escape sequences. <a href="classclutchlog_1_1fmt.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structclutchlog_1_1scope__t.html">scope_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Structure holding a location matching. <a href="structclutchlog_1_1scope__t.html#details">More...</a><br /></td></tr>
<tr class="separator:"><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><td colspan="2"><div class="groupHeader">Configuration accessors</div></td></tr>
<tr class="memitem:ga656c277e074b64728cca871f2b484d1c"><td class="memItemLeft" align="right" valign="top">
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#ga656c277e074b64728cca871f2b484d1c">format</a> (const std::string &amp;format)</td></tr>
<tr class="memdesc:ga656c277e074b64728cca871f2b484d1c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the template string. <br /></td></tr>
<tr class="separator:ga656c277e074b64728cca871f2b484d1c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafc53dbca51d0e2322a21899d0c571a80"><td class="memItemLeft" align="right" valign="top">
std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#gafc53dbca51d0e2322a21899d0c571a80">format</a> () const</td></tr>
<tr class="memdesc:gafc53dbca51d0e2322a21899d0c571a80"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the template string. <br /></td></tr>
<tr class="separator:gafc53dbca51d0e2322a21899d0c571a80"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2144abe4ec6f630126b6490908b5f924"><td class="memItemLeft" align="right" valign="top">
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#ga2144abe4ec6f630126b6490908b5f924">format_comment</a> (const std::string &amp;<a class="el" href="group__UseMacros.html#ga656c277e074b64728cca871f2b484d1c">format</a>)</td></tr>
<tr class="memdesc:ga2144abe4ec6f630126b6490908b5f924"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the template string for dumps. <br /></td></tr>
<tr class="separator:ga2144abe4ec6f630126b6490908b5f924"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa8d0a569ed3623ce36c5e567ec2d1ad5"><td class="memItemLeft" align="right" valign="top">
std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#gaa8d0a569ed3623ce36c5e567ec2d1ad5">format_comment</a> () const</td></tr>
<tr class="memdesc:gaa8d0a569ed3623ce36c5e567ec2d1ad5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the template string for dumps. <br /></td></tr>
<tr class="separator:gaa8d0a569ed3623ce36c5e567ec2d1ad5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7fd7c7bd3668c537061c314a619a336d"><td class="memItemLeft" align="right" valign="top">
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#ga7fd7c7bd3668c537061c314a619a336d">out</a> (std::ostream &amp;out)</td></tr>
<tr class="memdesc:ga7fd7c7bd3668c537061c314a619a336d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the output stream on which to print. <br /></td></tr>
<tr class="separator:ga7fd7c7bd3668c537061c314a619a336d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6c6ab42a1df147e6c2d115bc36ec8266"><td class="memItemLeft" align="right" valign="top">
std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#ga6c6ab42a1df147e6c2d115bc36ec8266">out</a> ()</td></tr>
<tr class="memdesc:ga6c6ab42a1df147e6c2d115bc36ec8266"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the output stream on which to print. <br /></td></tr>
<tr class="separator:ga6c6ab42a1df147e6c2d115bc36ec8266"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3cb0e4f43a4cadf1966001ad7c9861f4"><td class="memItemLeft" align="right" valign="top">
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#ga3cb0e4f43a4cadf1966001ad7c9861f4">threshold</a> (<a class="el" href="group__UseMacros.html#ga10fd25a1b51c8c95bd6d876ce1b4b928">level</a> l)</td></tr>
<tr class="memdesc:ga3cb0e4f43a4cadf1966001ad7c9861f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the log level (below which logs are not printed) with an identifier. <br /></td></tr>
<tr class="separator:ga3cb0e4f43a4cadf1966001ad7c9861f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7a7738eaad114bfa870121412fe23ad9"><td class="memItemLeft" align="right" valign="top">
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#ga7a7738eaad114bfa870121412fe23ad9">threshold</a> (const std::string &amp;l)</td></tr>
<tr class="memdesc:ga7a7738eaad114bfa870121412fe23ad9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the log level (below which logs are not printed) with a string. <br /></td></tr>
<tr class="separator:ga7a7738eaad114bfa870121412fe23ad9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab45287cc9c14217904a13aff49573732"><td class="memItemLeft" align="right" valign="top">
<a class="el" href="group__UseMacros.html#ga10fd25a1b51c8c95bd6d876ce1b4b928">level</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#gab45287cc9c14217904a13aff49573732">threshold</a> () const</td></tr>
<tr class="memdesc:gab45287cc9c14217904a13aff49573732"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the log level below which logs are not printed. <br /></td></tr>
<tr class="separator:gab45287cc9c14217904a13aff49573732"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaff3aa09fb60f7d6dc688c028d3834d8a"><td class="memItemLeft" align="right" valign="top">
const std::map&lt; std::string, <a class="el" href="group__UseMacros.html#ga10fd25a1b51c8c95bd6d876ce1b4b928">level</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#gaff3aa09fb60f7d6dc688c028d3834d8a">levels</a> () const</td></tr>
<tr class="memdesc:gaff3aa09fb60f7d6dc688c028d3834d8a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the map of available log levels string representations toward their identifier. *&zwj;/. <br /></td></tr>
<tr class="separator:gaff3aa09fb60f7d6dc688c028d3834d8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacebed8c9df9204f22bf8488e62e1cedd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__UseMacros.html#ga10fd25a1b51c8c95bd6d876ce1b4b928">level</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#gacebed8c9df9204f22bf8488e62e1cedd">level_of</a> (const std::string name)</td></tr>
<tr class="memdesc:gacebed8c9df9204f22bf8488e62e1cedd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the log level tag corresponding to the given pre-configured name. <a href="group__UseMacros.html#gacebed8c9df9204f22bf8488e62e1cedd">More...</a><br /></td></tr>
<tr class="separator:gacebed8c9df9204f22bf8488e62e1cedd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga10064493c22f5c03b502a42d814c5c5c"><td class="memItemLeft" align="right" valign="top">
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#ga10064493c22f5c03b502a42d814c5c5c">file</a> (std::string file)</td></tr>
<tr class="memdesc:ga10064493c22f5c03b502a42d814c5c5c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the regular expression filtering the file location. <br /></td></tr>
<tr class="separator:ga10064493c22f5c03b502a42d814c5c5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad32b5a0274dc03ee0004f67ba58b2447"><td class="memItemLeft" align="right" valign="top">
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#gad32b5a0274dc03ee0004f67ba58b2447">func</a> (std::string func)</td></tr>
<tr class="memdesc:gad32b5a0274dc03ee0004f67ba58b2447"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the regular expression filtering the function location. <br /></td></tr>
<tr class="separator:gad32b5a0274dc03ee0004f67ba58b2447"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa26c6b81ebaeb9e9daa3457e3a3d17c9"><td class="memItemLeft" align="right" valign="top">
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#gaa26c6b81ebaeb9e9daa3457e3a3d17c9">line</a> (std::string line)</td></tr>
<tr class="memdesc:gaa26c6b81ebaeb9e9daa3457e3a3d17c9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the regular expression filtering the line location. <br /></td></tr>
<tr class="separator:gaa26c6b81ebaeb9e9daa3457e3a3d17c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6666106b9e5c239b6ae5e0d1091648e3"><td class="memItemLeft" align="right" valign="top">
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#ga6666106b9e5c239b6ae5e0d1091648e3">location</a> (const std::string &amp;in_file, const std::string &amp;in_function=&quot;.*&quot;, const std::string &amp;in_line=&quot;.*&quot;)</td></tr>
<tr class="memdesc:ga6666106b9e5c239b6ae5e0d1091648e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the regular expressions filtering the location. <br /></td></tr>
<tr class="separator:ga6666106b9e5c239b6ae5e0d1091648e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac3ec55057b9c734b66f169bf43dbd591"><td class="memTemplParams" colspan="2">template&lt;class ... FMT&gt; </td></tr>
<tr class="memitem:gac3ec55057b9c734b66f169bf43dbd591"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#gac3ec55057b9c734b66f169bf43dbd591">style</a> (<a class="el" href="group__UseMacros.html#ga10fd25a1b51c8c95bd6d876ce1b4b928">level</a> stage, FMT... styles)</td></tr>
<tr class="memdesc:gac3ec55057b9c734b66f169bf43dbd591"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the style (color and typo) of the given log level. <a href="group__UseMacros.html#gac3ec55057b9c734b66f169bf43dbd591">More...</a><br /></td></tr>
<tr class="separator:gac3ec55057b9c734b66f169bf43dbd591"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad1cfa9945c3f7f98fe8ce724c627d0d6"><td class="memItemLeft" align="right" valign="top">
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#gad1cfa9945c3f7f98fe8ce724c627d0d6">style</a> (<a class="el" href="group__UseMacros.html#ga10fd25a1b51c8c95bd6d876ce1b4b928">level</a> stage, <a class="el" href="classclutchlog_1_1fmt.html">fmt</a> style)</td></tr>
<tr class="memdesc:gad1cfa9945c3f7f98fe8ce724c627d0d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the style (color and typo) of the given log level, passing a <code>fmt</code> instance. <br /></td></tr>
<tr class="separator:gad1cfa9945c3f7f98fe8ce724c627d0d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4831f44fd5ade102e57320632095934d"><td class="memItemLeft" align="right" valign="top">
<a class="el" href="classclutchlog_1_1fmt.html">fmt</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#ga4831f44fd5ade102e57320632095934d">style</a> (<a class="el" href="group__UseMacros.html#ga10fd25a1b51c8c95bd6d876ce1b4b928">level</a> stage) const</td></tr>
<tr class="memdesc:ga4831f44fd5ade102e57320632095934d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the configured fmt instance of the given log level. <br /></td></tr>
<tr class="separator:ga4831f44fd5ade102e57320632095934d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Low-level API</div></td></tr>
<tr class="memitem:ga4ebdfcded6c56262676bf6926d63fc96"><td class="memItemLeft" align="right" valign="top">
<a class="el" href="structclutchlog_1_1scope__t.html">scope_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#ga4ebdfcded6c56262676bf6926d63fc96">locate</a> (const <a class="el" href="group__UseMacros.html#ga10fd25a1b51c8c95bd6d876ce1b4b928">level</a> &amp;stage, const std::string &amp;<a class="el" href="group__UseMacros.html#ga10064493c22f5c03b502a42d814c5c5c">file</a>, const std::string &amp;<a class="el" href="group__UseMacros.html#gad32b5a0274dc03ee0004f67ba58b2447">func</a>, const size_t <a class="el" href="group__UseMacros.html#gaa26c6b81ebaeb9e9daa3457e3a3d17c9">line</a>) const</td></tr>
<tr class="memdesc:ga4ebdfcded6c56262676bf6926d63fc96"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gather information on the current location of the call. <br /></td></tr>
<tr class="separator:ga4ebdfcded6c56262676bf6926d63fc96"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga972f895c70edc335f3018a2c8971d59e"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#ga972f895c70edc335f3018a2c8971d59e">replace</a> (const std::string &amp;form, const std::string &amp;mark, const std::string &amp;tag) const</td></tr>
<tr class="memdesc:ga972f895c70edc335f3018a2c8971d59e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Replace <code>mark</code> by <code>tag</code> in <code>form</code>. <a href="group__UseMacros.html#ga972f895c70edc335f3018a2c8971d59e">More...</a><br /></td></tr>
<tr class="separator:ga972f895c70edc335f3018a2c8971d59e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae90d5a1a428587ad67b38b2ea4ca9fa2"><td class="memItemLeft" align="right" valign="top">
std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#gae90d5a1a428587ad67b38b2ea4ca9fa2">replace</a> (const std::string &amp;form, const std::string &amp;mark, const size_t tag) const</td></tr>
<tr class="memdesc:gae90d5a1a428587ad67b38b2ea4ca9fa2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Replace <code>mark</code> by <code>tag</code> in <code>form</code>, converting tag to its string representation first. <br /></td></tr>
<tr class="separator:gae90d5a1a428587ad67b38b2ea4ca9fa2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf1219599b1361562c802779572aa669f"><td class="memItemLeft" align="right" valign="top">
std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#gaf1219599b1361562c802779572aa669f">format</a> (std::string format, const std::string &amp;what, const <a class="el" href="group__UseMacros.html#ga10fd25a1b51c8c95bd6d876ce1b4b928">level</a> &amp;stage, const std::string &amp;<a class="el" href="group__UseMacros.html#ga10064493c22f5c03b502a42d814c5c5c">file</a>, const std::string &amp;<a class="el" href="group__UseMacros.html#gad32b5a0274dc03ee0004f67ba58b2447">func</a>, const size_t <a class="el" href="group__UseMacros.html#gaa26c6b81ebaeb9e9daa3457e3a3d17c9">line</a>) const</td></tr>
<tr class="memdesc:gaf1219599b1361562c802779572aa669f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Substitute all tags in the format string with the corresponding information and apply the style corresponding to the log level. <br /></td></tr>
<tr class="separator:gaf1219599b1361562c802779572aa669f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga23dbb98f0d3c5cc21c232cde16cf317a"><td class="memItemLeft" align="right" valign="top">
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#ga23dbb98f0d3c5cc21c232cde16cf317a">log</a> (const <a class="el" href="group__UseMacros.html#ga10fd25a1b51c8c95bd6d876ce1b4b928">level</a> &amp;stage, const std::string &amp;what, const std::string &amp;<a class="el" href="group__UseMacros.html#ga10064493c22f5c03b502a42d814c5c5c">file</a>, const std::string &amp;<a class="el" href="group__UseMacros.html#gad32b5a0274dc03ee0004f67ba58b2447">func</a>, size_t <a class="el" href="group__UseMacros.html#gaa26c6b81ebaeb9e9daa3457e3a3d17c9">line</a>) const</td></tr>
<tr class="memdesc:ga23dbb98f0d3c5cc21c232cde16cf317a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Print a log message IF the location matches the given one. <br /></td></tr>
<tr class="separator:ga23dbb98f0d3c5cc21c232cde16cf317a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga63308e8deae3cfec6801318203494143"><td class="memTemplParams" colspan="2">
template&lt;class In &gt; </td></tr>
<tr class="memitem:ga63308e8deae3cfec6801318203494143"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#ga63308e8deae3cfec6801318203494143">dump</a> (const <a class="el" href="group__UseMacros.html#ga10fd25a1b51c8c95bd6d876ce1b4b928">level</a> &amp;stage, const In container_begin, const In container_end, const std::string &amp;<a class="el" href="group__UseMacros.html#ga10064493c22f5c03b502a42d814c5c5c">file</a>, const std::string &amp;<a class="el" href="group__UseMacros.html#gad32b5a0274dc03ee0004f67ba58b2447">func</a>, size_t <a class="el" href="group__UseMacros.html#gaa26c6b81ebaeb9e9daa3457e3a3d17c9">line</a>, const std::string &amp;filename_template=&quot;dump_{n}.dat&quot;, const std::string sep=<a class="el" href="group__UseMacros.html#gaf898bffe23b125245e338d7495c76d45">dump_default_sep</a>) const</td></tr>
<tr class="memdesc:ga63308e8deae3cfec6801318203494143"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dump a serializable container after a comment line with log information. <br /></td></tr>
<tr class="separator:ga63308e8deae3cfec6801318203494143"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-static-attribs"></a>
Static Protected Attributes</h2></td></tr>
<tr class="memitem:ga0c4ac57601e6f8d146fd5cc060968ecc"><td class="memItemLeft" align="right" valign="top">
static std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#ga0c4ac57601e6f8d146fd5cc060968ecc">default_format</a> = <a class="el" href="group__UseMacros.html#ga524c16f280d92ee8ab683162c9ce01fa">CLUTCHLOG_DEFAULT_FORMAT</a></td></tr>
<tr class="memdesc:ga0c4ac57601e6f8d146fd5cc060968ecc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default format of the messages. <br /></td></tr>
<tr class="separator:ga0c4ac57601e6f8d146fd5cc060968ecc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gace879554298e6e6e36dafef330c27be8"><td class="memItemLeft" align="right" valign="top">
static std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#gace879554298e6e6e36dafef330c27be8">dump_default_format</a> = <a class="el" href="group__UseMacros.html#ga27b613c6727857a7cbcd0165d862034e">CLUTCHDUMP_DEFAULT_FORMAT</a></td></tr>
<tr class="memdesc:gace879554298e6e6e36dafef330c27be8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default format of the comment line in file dump. <br /></td></tr>
<tr class="separator:gace879554298e6e6e36dafef330c27be8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf898bffe23b125245e338d7495c76d45"><td class="memItemLeft" align="right" valign="top">
static std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#gaf898bffe23b125245e338d7495c76d45">dump_default_sep</a> = <a class="el" href="group__UseMacros.html#ga54d29e956575e1c731eab5406135c5df">CLUTCHDUMP_DEFAULT_SEP</a></td></tr>
<tr class="memdesc:gaf898bffe23b125245e338d7495c76d45"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default item separator for dump. <br /></td></tr>
<tr class="separator:gaf898bffe23b125245e338d7495c76d45"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga229fd61519f1245282440120f2d45fb5"><td class="memItemLeft" align="right" valign="top">
static std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#ga229fd61519f1245282440120f2d45fb5">default_depth_mark</a> = <a class="el" href="group__UseMacros.html#ga45c4c964fad4ad1641d5c9c28c4645b9">CLUTCHLOG_DEFAULT_DEPTH_MARK</a></td></tr>
<tr class="memdesc:ga229fd61519f1245282440120f2d45fb5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default mark for stack depth. <br /></td></tr>
<tr class="separator:ga229fd61519f1245282440120f2d45fb5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1a8cb6411726133208f5a2f2cb42d468"><td class="memItemLeft" align="right" valign="top">
static unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#ga1a8cb6411726133208f5a2f2cb42d468">default_strip_calls</a> = <a class="el" href="group__UseMacros.html#ga98f30d814d4913a8a7c93a8793f49adf">CLUTCHLOG_STRIP_CALLS</a></td></tr>
<tr class="memdesc:ga1a8cb6411726133208f5a2f2cb42d468"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of call stack levels to remove from depth display by default. <br /></td></tr>
<tr class="separator:ga1a8cb6411726133208f5a2f2cb42d468"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga76eb34537b634aadb75e255f7887eeb6"><td class="memItemLeft" align="right" valign="top">
static char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#ga76eb34537b634aadb75e255f7887eeb6">default_hfill_char</a> = <a class="el" href="group__UseMacros.html#gad5fbbacf74b8e4669b8f9efdfe81bd25">CLUTCHLOG_HFILL_MARK</a></td></tr>
<tr class="memdesc:ga76eb34537b634aadb75e255f7887eeb6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default character used as a filling for right-align the right part of messages with "{hfill}". <br /></td></tr>
<tr class="separator:ga76eb34537b634aadb75e255f7887eeb6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa3c8e8ef6a1729b95b48f9001fc8b4c6"><td class="memItemLeft" align="right" valign="top">
static unsigned short&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#gaa3c8e8ef6a1729b95b48f9001fc8b4c6">default_hfill_max</a> = CLUTCHLOG_HFILL_MAX</td></tr>
<tr class="memdesc:gaa3c8e8ef6a1729b95b48f9001fc8b4c6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default maximum number of character used as a filling for right-align the right part of messages with "{hfill}". <br /></td></tr>
<tr class="separator:gaa3c8e8ef6a1729b95b48f9001fc8b4c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
High-level API</h2></td></tr>
<tr class="memitem:ga10fd25a1b51c8c95bd6d876ce1b4b928"><td class="memItemLeft" align="right" valign="top"><a id="ga10fd25a1b51c8c95bd6d876ce1b4b928"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#ga10fd25a1b51c8c95bd6d876ce1b4b928">level</a> { <br />
&#160;&#160;<b>critical</b> =0,
<b>error</b> =1,
<b>warning</b> =2,
<b>progress</b> =3,
<br />
&#160;&#160;<b>note</b> =4,
<b>info</b> =5,
<b>debug</b> =6,
<b>xdebug</b> =7
<br />
}</td></tr>
<tr class="memdesc:ga10fd25a1b51c8c95bd6d876ce1b4b928"><td class="mdescLeft">&#160;</td><td class="mdescRight">Available log levels. <br /></td></tr>
<tr class="separator:ga10fd25a1b51c8c95bd6d876ce1b4b928"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacfaceb77da01503b432644a3efaee4fa"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classclutchlog.html">clutchlog</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#gacfaceb77da01503b432644a3efaee4fa">logger</a> ()</td></tr>
<tr class="memdesc:gacfaceb77da01503b432644a3efaee4fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the logger instance. <a href="group__UseMacros.html#gacfaceb77da01503b432644a3efaee4fa">More...</a><br /></td></tr>
<tr class="separator:gacfaceb77da01503b432644a3efaee4fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
Internal details</h2></td></tr>
<tr class="memitem:ga356df86455409193792b6ed550dfd09e"><td class="memItemLeft" align="right" valign="top">
size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#ga356df86455409193792b6ed550dfd09e">_strip_calls</a></td></tr>
<tr class="memdesc:ga356df86455409193792b6ed550dfd09e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current number of call stack levels to remove from depth display. <br /></td></tr>
<tr class="separator:ga356df86455409193792b6ed550dfd09e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab1c377a376e6772fe1746ff7147c125f"><td class="memItemLeft" align="right" valign="top">
const std::map&lt; <a class="el" href="group__UseMacros.html#ga10fd25a1b51c8c95bd6d876ce1b4b928">level</a>, std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#gab1c377a376e6772fe1746ff7147c125f">_level_word</a></td></tr>
<tr class="memdesc:gab1c377a376e6772fe1746ff7147c125f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dictionary of level identifier to their string representation. <br /></td></tr>
<tr class="separator:gab1c377a376e6772fe1746ff7147c125f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabd4625bf211bfbaa30d9c126fa3d7888"><td class="memItemLeft" align="right" valign="top">
std::map&lt; std::string, <a class="el" href="group__UseMacros.html#ga10fd25a1b51c8c95bd6d876ce1b4b928">level</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#gabd4625bf211bfbaa30d9c126fa3d7888">_word_level</a></td></tr>
<tr class="memdesc:gabd4625bf211bfbaa30d9c126fa3d7888"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dictionary of level string to their identifier. <br /></td></tr>
<tr class="separator:gabd4625bf211bfbaa30d9c126fa3d7888"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab805ac5c33885459f9f752518a4aa735"><td class="memItemLeft" align="right" valign="top">
std::map&lt; <a class="el" href="group__UseMacros.html#ga10fd25a1b51c8c95bd6d876ce1b4b928">level</a>, <a class="el" href="classclutchlog_1_1fmt.html">fmt</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#gab805ac5c33885459f9f752518a4aa735">_level_fmt</a></td></tr>
<tr class="memdesc:gab805ac5c33885459f9f752518a4aa735"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dictionary of level identifier to their format. <br /></td></tr>
<tr class="separator:gab805ac5c33885459f9f752518a4aa735"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7c6e3fc082bc6f55d50131ed2b32e81e"><td class="memItemLeft" align="right" valign="top">
std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#ga7c6e3fc082bc6f55d50131ed2b32e81e">_format_log</a></td></tr>
<tr class="memdesc:ga7c6e3fc082bc6f55d50131ed2b32e81e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current format of the standard output. <br /></td></tr>
<tr class="separator:ga7c6e3fc082bc6f55d50131ed2b32e81e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5f4ddb57ce42e8be86a7c7d269f7bae5"><td class="memItemLeft" align="right" valign="top">
std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#ga5f4ddb57ce42e8be86a7c7d269f7bae5">_format_dump</a></td></tr>
<tr class="memdesc:ga5f4ddb57ce42e8be86a7c7d269f7bae5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current format of the file output. <br /></td></tr>
<tr class="separator:ga5f4ddb57ce42e8be86a7c7d269f7bae5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1896f6c4b8597e3e76ff93970bd85167"><td class="memItemLeft" align="right" valign="top">
std::ostream *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#ga1896f6c4b8597e3e76ff93970bd85167">_out</a></td></tr>
<tr class="memdesc:ga1896f6c4b8597e3e76ff93970bd85167"><td class="mdescLeft">&#160;</td><td class="mdescRight">Standard output. <br /></td></tr>
<tr class="separator:ga1896f6c4b8597e3e76ff93970bd85167"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaeb60684c89bcef5aa9273075c21cc993"><td class="memItemLeft" align="right" valign="top">
<a class="el" href="group__UseMacros.html#ga10fd25a1b51c8c95bd6d876ce1b4b928">level</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#gaeb60684c89bcef5aa9273075c21cc993">_stage</a></td></tr>
<tr class="memdesc:gaeb60684c89bcef5aa9273075c21cc993"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current log level. <br /></td></tr>
<tr class="separator:gaeb60684c89bcef5aa9273075c21cc993"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaded03528f34d9000f618419c482c5042"><td class="memItemLeft" align="right" valign="top">
std::regex&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#gaded03528f34d9000f618419c482c5042">_in_file</a></td></tr>
<tr class="memdesc:gaded03528f34d9000f618419c482c5042"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current file location filter. <br /></td></tr>
<tr class="separator:gaded03528f34d9000f618419c482c5042"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga130c4f12eacbd2028102838fe16b734e"><td class="memItemLeft" align="right" valign="top">
std::regex&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#ga130c4f12eacbd2028102838fe16b734e">_in_func</a></td></tr>
<tr class="memdesc:ga130c4f12eacbd2028102838fe16b734e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current function location filter. <br /></td></tr>
<tr class="separator:ga130c4f12eacbd2028102838fe16b734e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga41757198b29862832a14472a9e5e24c6"><td class="memItemLeft" align="right" valign="top">
std::regex&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#ga41757198b29862832a14472a9e5e24c6">_in_line</a></td></tr>
<tr class="memdesc:ga41757198b29862832a14472a9e5e24c6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current line location filter. <br /></td></tr>
<tr class="separator:ga41757198b29862832a14472a9e5e24c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0906d74275cedcd403da94879764815e"><td class="memItemLeft" align="right" valign="top">
&#160;</td><td class="memItemRight" valign="bottom"><b>clutchlog</b> (<a class="el" href="classclutchlog.html">clutchlog</a> const &amp;)=delete</td></tr>
<tr class="separator:ga0906d74275cedcd403da94879764815e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaef653a9744a72a889ca8163269bb781e"><td class="memItemLeft" align="right" valign="top">
void&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classclutchlog.html">clutchlog</a> const &amp;)=delete</td></tr>
<tr class="separator:gaef653a9744a72a889ca8163269bb781e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>clutchlog/<a class="el" href="clutchlog_8h_source.html">clutchlog.h</a></li>
</ul>
</div><!-- contents -->
<!-- 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.17
</small></address>
</body>
</html>