nojhan/clutchlog
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
clutchlog/docs/group__Config.html

215 lines
16 KiB
HTML
Raw Blame History

<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>clutchlog: Configuration accessors</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.1.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- 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="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Configuration accessors</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga656c277e074b64728cca871f2b484d1c"><td class="memItemLeft" align="right" valign="top"><a id="ga656c277e074b64728cca871f2b484d1c"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Config.html#ga656c277e074b64728cca871f2b484d1c">clutchlog::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"><a id="gafc53dbca51d0e2322a21899d0c571a80"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Config.html#gafc53dbca51d0e2322a21899d0c571a80">clutchlog::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"><a id="ga2144abe4ec6f630126b6490908b5f924"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Config.html#ga2144abe4ec6f630126b6490908b5f924">clutchlog::format_comment</a> (const std::string &amp;<a class="el" href="group__Config.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"><a id="gaa8d0a569ed3623ce36c5e567ec2d1ad5"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Config.html#gaa8d0a569ed3623ce36c5e567ec2d1ad5">clutchlog::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"><a id="ga7fd7c7bd3668c537061c314a619a336d"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Config.html#ga7fd7c7bd3668c537061c314a619a336d">clutchlog::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"><a id="ga6c6ab42a1df147e6c2d115bc36ec8266"></a>
std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Config.html#ga6c6ab42a1df147e6c2d115bc36ec8266">clutchlog::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"><a id="ga3cb0e4f43a4cadf1966001ad7c9861f4"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Config.html#ga3cb0e4f43a4cadf1966001ad7c9861f4">clutchlog::threshold</a> (<a class="el" href="group__UserAPI.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. <br /></td></tr>
<tr class="separator:ga3cb0e4f43a4cadf1966001ad7c9861f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab45287cc9c14217904a13aff49573732"><td class="memItemLeft" align="right" valign="top"><a id="gab45287cc9c14217904a13aff49573732"></a>
<a class="el" href="group__UserAPI.html#ga10fd25a1b51c8c95bd6d876ce1b4b928">level</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Config.html#gab45287cc9c14217904a13aff49573732">clutchlog::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:ga10064493c22f5c03b502a42d814c5c5c"><td class="memItemLeft" align="right" valign="top"><a id="ga10064493c22f5c03b502a42d814c5c5c"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Config.html#ga10064493c22f5c03b502a42d814c5c5c">clutchlog::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"><a id="gad32b5a0274dc03ee0004f67ba58b2447"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Config.html#gad32b5a0274dc03ee0004f67ba58b2447">clutchlog::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"><a id="gaa26c6b81ebaeb9e9daa3457e3a3d17c9"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Config.html#gaa26c6b81ebaeb9e9daa3457e3a3d17c9">clutchlog::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"><a id="ga6666106b9e5c239b6ae5e0d1091648e3"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Config.html#ga6666106b9e5c239b6ae5e0d1091648e3">clutchlog::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__Config.html#gac3ec55057b9c734b66f169bf43dbd591">clutchlog::style</a> (<a class="el" href="group__UserAPI.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="#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"><a id="gad1cfa9945c3f7f98fe8ce724c627d0d6"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Config.html#gad1cfa9945c3f7f98fe8ce724c627d0d6">clutchlog::style</a> (<a class="el" href="group__UserAPI.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 id="ga4831f44fd5ade102e57320632095934d"></a>
<a class="el" href="classclutchlog_1_1fmt.html">fmt</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Config.html#ga4831f44fd5ade102e57320632095934d">clutchlog::style</a> (<a class="el" href="group__UserAPI.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 class="memitem:gacebed8c9df9204f22bf8488e62e1cedd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__UserAPI.html#ga10fd25a1b51c8c95bd6d876ce1b4b928">level</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Config.html#gacebed8c9df9204f22bf8488e62e1cedd">clutchlog::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="#gacebed8c9df9204f22bf8488e62e1cedd">More...</a><br /></td></tr>
<tr class="separator:gacebed8c9df9204f22bf8488e62e1cedd"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a id="gacebed8c9df9204f22bf8488e62e1cedd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gacebed8c9df9204f22bf8488e62e1cedd">&#9670;&nbsp;</a></span>level_of()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__UserAPI.html#ga10fd25a1b51c8c95bd6d876ce1b4b928">level</a> clutchlog::level_of </td>
<td>(</td>
<td class="paramtype">const std::string&#160;</td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the log level tag corresponding to the given pre-configured name. </p>
<dl class="section note"><dt>Note</dt><dd>: This is case sensitive, see the pre-configured <code>_level_word</code>. </dd></dl>
</div>
</div>
<a id="gac3ec55057b9c734b66f169bf43dbd591"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac3ec55057b9c734b66f169bf43dbd591">&#9670;&nbsp;</a></span>style()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ... FMT&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void clutchlog::style </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__UserAPI.html#ga10fd25a1b51c8c95bd6d876ce1b4b928">level</a>&#160;</td>
<td class="paramname"><em>stage</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">FMT...&#160;</td>
<td class="paramname"><em>styles</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the style (color and typo) of the given log level. </p>
<p>This version accept style arguments as if they were passed to <code><a class="el" href="classclutchlog_1_1fmt.html" title="Color and style formatter for ANSI terminal escape sequences. ">clutchlog::fmt</a></code>. </p>
</div>
</div>
</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.13
</small></address>
</body>
</html>
Reference in a new issue View git blame Copy permalink