nojhan/clutchlog
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
clutchlog/docs/classclutchlog_1_1fmt.html
nojhan 2d094b2637 bump to v0.10
2022-09-07 23:08:14 +02:00

203 lines
15 KiB
HTML
Raw Blame History

<!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::fmt 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="classclutchlog.html">clutchlog</a></li><li class="navelem"><a class="el" href="classclutchlog_1_1fmt.html">fmt</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classclutchlog_1_1fmt-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">clutchlog::fmt Class Reference<div class="ingroups"><a class="el" href="group__UseMacros.html">High-level API macros</a> &raquo; <a class="el" href="group__Formating.html">Formating tools</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Color and style formatter for ANSI terminal escape sequences.
<a href="classclutchlog_1_1fmt.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="clutchlog_8h_source.html">clutchlog.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ga4662a3ec3577c6a575a2c734636ed8a0"><td class="memItemLeft" align="right" valign="top"><a id="ga4662a3ec3577c6a575a2c734636ed8a0"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#ga4662a3ec3577c6a575a2c734636ed8a0">fg</a> { <br />
&#160;&#160;<b>black</b> = 30,
<b>red</b> = 31,
<b>green</b> = 32,
<b>yellow</b> = 33,
<br />
&#160;&#160;<b>blue</b> = 34,
<b>magenta</b> = 35,
<b>cyan</b> = 36,
<b>white</b> = 37,
<br />
&#160;&#160;<b>none</b>
<br />
}</td></tr>
<tr class="memdesc:ga4662a3ec3577c6a575a2c734636ed8a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Foreground color codes. <br /></td></tr>
<tr class="separator:ga4662a3ec3577c6a575a2c734636ed8a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1cf3e27e4041250ffea0a6d58010da1e"><td class="memItemLeft" align="right" valign="top"><a id="ga1cf3e27e4041250ffea0a6d58010da1e"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#ga1cf3e27e4041250ffea0a6d58010da1e">bg</a> { <br />
&#160;&#160;<b>black</b> = 40,
<b>red</b> = 41,
<b>green</b> = 42,
<b>yellow</b> = 43,
<br />
&#160;&#160;<b>blue</b> = 44,
<b>magenta</b> = 45,
<b>cyan</b> = 46,
<b>white</b> = 47,
<br />
&#160;&#160;<b>none</b>
<br />
}</td></tr>
<tr class="memdesc:ga1cf3e27e4041250ffea0a6d58010da1e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Background color codes. <br /></td></tr>
<tr class="separator:ga1cf3e27e4041250ffea0a6d58010da1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga932f47b78fb7b10590d5613a1c4eab89"><td class="memItemLeft" align="right" valign="top"><a id="ga932f47b78fb7b10590d5613a1c4eab89"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#ga932f47b78fb7b10590d5613a1c4eab89">typo</a> { <br />
&#160;&#160;<b>reset</b> = 0,
<b>bold</b> = 1,
<b>underline</b> = 4,
<b>inverse</b> = 7,
<br />
&#160;&#160;<b>none</b>
<br />
}</td></tr>
<tr class="memdesc:ga932f47b78fb7b10590d5613a1c4eab89"><td class="mdescLeft">&#160;</td><td class="mdescRight">Typographic style codes. <br /></td></tr>
<tr class="separator:ga932f47b78fb7b10590d5613a1c4eab89"><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:ga407506bc02ed3f91d88b3df630e54959"><td class="memItemLeft" align="right" valign="top">
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#ga407506bc02ed3f91d88b3df630e54959">fmt</a> ()</td></tr>
<tr class="memdesc:ga407506bc02ed3f91d88b3df630e54959"><td class="mdescLeft">&#160;</td><td class="mdescRight">&#160;Empty constructor, only useful for a no-op formatter. <br /></td></tr>
<tr class="separator:ga407506bc02ed3f91d88b3df630e54959"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafeaedd18298498d1dcfcc15f5f17ac3c"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#gafeaedd18298498d1dcfcc15f5f17ac3c">operator()</a> (const std::string &amp;msg) const</td></tr>
<tr class="memdesc:gafeaedd18298498d1dcfcc15f5f17ac3c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Format the given string with the currently encoded format. <a href="group__UseMacros.html#gafeaedd18298498d1dcfcc15f5f17ac3c">More...</a><br /></td></tr>
<tr class="separator:gafeaedd18298498d1dcfcc15f5f17ac3c"><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:ga6cc6126d113fc0647ed3acbf29cdc425"><td class="memItemLeft" align="right" valign="top">
&#160;</td><td class="memItemRight" valign="bottom"><b>fmt</b> (<a class="el" href="group__UseMacros.html#ga4662a3ec3577c6a575a2c734636ed8a0">fg</a> f, <a class="el" href="group__UseMacros.html#ga1cf3e27e4041250ffea0a6d58010da1e">bg</a> b=bg::none, <a class="el" href="group__UseMacros.html#ga932f47b78fb7b10590d5613a1c4eab89">typo</a> s=typo::none)</td></tr>
<tr class="separator:ga6cc6126d113fc0647ed3acbf29cdc425"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac69e6d3b7ddaec908c429ac61f354267"><td class="memItemLeft" align="right" valign="top">
&#160;</td><td class="memItemRight" valign="bottom"><b>fmt</b> (<a class="el" href="group__UseMacros.html#ga4662a3ec3577c6a575a2c734636ed8a0">fg</a> f, <a class="el" href="group__UseMacros.html#ga932f47b78fb7b10590d5613a1c4eab89">typo</a> s, <a class="el" href="group__UseMacros.html#ga1cf3e27e4041250ffea0a6d58010da1e">bg</a> b=bg::none)</td></tr>
<tr class="separator:gac69e6d3b7ddaec908c429ac61f354267"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga13453c0b5dbc19d9b510dcdc0352b443"><td class="memItemLeft" align="right" valign="top">
&#160;</td><td class="memItemRight" valign="bottom"><b>fmt</b> (<a class="el" href="group__UseMacros.html#ga1cf3e27e4041250ffea0a6d58010da1e">bg</a> b, <a class="el" href="group__UseMacros.html#ga4662a3ec3577c6a575a2c734636ed8a0">fg</a> f=fg::none, <a class="el" href="group__UseMacros.html#ga932f47b78fb7b10590d5613a1c4eab89">typo</a> s=typo::none)</td></tr>
<tr class="separator:ga13453c0b5dbc19d9b510dcdc0352b443"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga65856874070ec0865b3a5b9aeb0e4f3d"><td class="memItemLeft" align="right" valign="top">
&#160;</td><td class="memItemRight" valign="bottom"><b>fmt</b> (<a class="el" href="group__UseMacros.html#ga1cf3e27e4041250ffea0a6d58010da1e">bg</a> b, <a class="el" href="group__UseMacros.html#ga932f47b78fb7b10590d5613a1c4eab89">typo</a> s, <a class="el" href="group__UseMacros.html#ga4662a3ec3577c6a575a2c734636ed8a0">fg</a> f=fg::none)</td></tr>
<tr class="separator:ga65856874070ec0865b3a5b9aeb0e4f3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga99b3a05ddf6fa341cee6cb1e5dffc159"><td class="memItemLeft" align="right" valign="top">
&#160;</td><td class="memItemRight" valign="bottom"><b>fmt</b> (<a class="el" href="group__UseMacros.html#ga932f47b78fb7b10590d5613a1c4eab89">typo</a> s, <a class="el" href="group__UseMacros.html#ga4662a3ec3577c6a575a2c734636ed8a0">fg</a> f=fg::none, <a class="el" href="group__UseMacros.html#ga1cf3e27e4041250ffea0a6d58010da1e">bg</a> b=bg::none)</td></tr>
<tr class="separator:ga99b3a05ddf6fa341cee6cb1e5dffc159"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaeea73b0239bf73ebc8ee84c1e6d278e2"><td class="memItemLeft" align="right" valign="top">
&#160;</td><td class="memItemRight" valign="bottom"><b>fmt</b> (<a class="el" href="group__UseMacros.html#ga932f47b78fb7b10590d5613a1c4eab89">typo</a> s, <a class="el" href="group__UseMacros.html#ga1cf3e27e4041250ffea0a6d58010da1e">bg</a> b, <a class="el" href="group__UseMacros.html#ga4662a3ec3577c6a575a2c734636ed8a0">fg</a> f=fg::none)</td></tr>
<tr class="separator:gaeea73b0239bf73ebc8ee84c1e6d278e2"><td class="memSeparator" colspan="2">&#160;</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:ga8307a848fcf9ed929435b3e1f2b53401"><td class="memItemLeft" align="right" valign="top">
enum <a class="el" href="group__UseMacros.html#ga4662a3ec3577c6a575a2c734636ed8a0">clutchlog::fmt::fg</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#ga8307a848fcf9ed929435b3e1f2b53401">fore</a></td></tr>
<tr class="memdesc:ga8307a848fcf9ed929435b3e1f2b53401"><td class="mdescLeft">&#160;</td><td class="mdescRight">Foreground color. <br /></td></tr>
<tr class="separator:ga8307a848fcf9ed929435b3e1f2b53401"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga86696b20e5b31c96ba592926efb324f3"><td class="memItemLeft" align="right" valign="top">
enum <a class="el" href="group__UseMacros.html#ga1cf3e27e4041250ffea0a6d58010da1e">clutchlog::fmt::bg</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#ga86696b20e5b31c96ba592926efb324f3">back</a></td></tr>
<tr class="memdesc:ga86696b20e5b31c96ba592926efb324f3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Background color. <br /></td></tr>
<tr class="separator:ga86696b20e5b31c96ba592926efb324f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2bb0fde65fcd264393e102314dd1610b"><td class="memItemLeft" align="right" valign="top">
enum <a class="el" href="group__UseMacros.html#ga932f47b78fb7b10590d5613a1c4eab89">clutchlog::fmt::typo</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#ga2bb0fde65fcd264393e102314dd1610b">style</a></td></tr>
<tr class="memdesc:ga2bb0fde65fcd264393e102314dd1610b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Typographic style. <br /></td></tr>
<tr class="separator:ga2bb0fde65fcd264393e102314dd1610b"><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>
<tr class="memitem:ga0b607e343b6813b99eafca1fdfec9cd0"><td class="memItemLeft" align="right" valign="top">
std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#ga0b607e343b6813b99eafca1fdfec9cd0">print_on</a> (std::ostream &amp;os) const</td></tr>
<tr class="memdesc:ga0b607e343b6813b99eafca1fdfec9cd0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Print the currently encoded format escape code on the given output stream. <br /></td></tr>
<tr class="separator:ga0b607e343b6813b99eafca1fdfec9cd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:ga96849ba427feac3a2eeaa1165e3845da"><td class="memItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#ga96849ba427feac3a2eeaa1165e3845da">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:ga96849ba427feac3a2eeaa1165e3845da"><td class="mdescLeft">&#160;</td><td class="mdescRight">Output stream overload. <a href="group__UseMacros.html#ga96849ba427feac3a2eeaa1165e3845da">More...</a><br /></td></tr>
<tr class="separator:ga96849ba427feac3a2eeaa1165e3845da"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Color and style formatter for ANSI terminal escape sequences. </p>
<dl class="section note"><dt>Note</dt><dd>All styles may not be supported by a given terminal/operating system. </dd></dl>
</div><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>
Reference in a new issue View git blame Copy permalink