Files
hasherezade-bearparser/class_formatter.html
2026-06-03 14:23:09 +00:00

346 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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.17.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>BearParser: Formatter Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="codefolding.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<script type="text/javascript" src="cookie.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>
<script type="module">
import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid@11/dist/mermaid.esm.min.mjs';
const theme = window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'default';
mermaid.initialize({ startOnLoad: true, theme: theme });
</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 id="projectrow">
<td id="projectalign">
<div id="projectname">BearParser
</div>
<div id="projectbrief">Portable Executable parsing library (from PE-bear)</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.17.0 -->
<script type="text/javascript">
let searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
document.addEventListener('DOMContentLoaded', codefold.init);
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
document.addEventListener('DOMContentLoaded', () => {
initMenu('',false);
init_search();
});
</script>
<div id="main-nav-mobile">
<div class="sm sm-dox"><input id="main-menu-state" type="checkbox"/>
<label class="main-menu-btn" for="main-menu-state">
<span class="main-menu-btn-icon"></span> Toggle main menu visibility</label>
<span id="searchBoxPos1" style="position:absolute;right:8px;top:8px;height:36px;"></span>
</div>
</div><!-- main-nav-mobile -->
<div id="main-nav">
<ul class="sm sm-dox" id="main-menu">
<li id="searchBoxPos2" style="float:right">
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" class="search-icon" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"><span class="search-icon-dropdown"></span></span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><div id="MSearchCloseImg" class="close-icon"></div></a>
</span>
</div>
</li>
</ul>
</div><!-- main-nav -->
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="class_formatter-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">Formatter Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="_formatter_8h_source.html">Formatter.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for Formatter:</div>
<div class="dyncontent">
<div class="center"><img src="class_formatter__coll__graph.png" border="0" usemap="#a_formatter_coll__map" loading="lazy" alt="Collaboration graph"/></div>
<map name="a_formatter_coll__map" id="a_formatter_coll__map">
<area shape="rect" title=" " alt="" coords="32,177,109,203"/>
<area shape="rect" href="class_abstract_formatter.html" title=" " alt="" coords="7,102,134,128"/>
<area shape="poly" title=" " alt="" coords="73,143,73,177,68,177,68,143"/>
<area shape="rect" href="class_abstract_byte_buffer.html" title=" " alt="" coords="5,5,136,31"/>
<area shape="poly" title=" " alt="" coords="73,46,73,101,68,101,68,46"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pub-methods" class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:af7d987b7f085aefe6ba35f20c992c14d" id="r_af7d987b7f085aefe6ba35f20c992c14d"><td class="memItemLeft">&#160;</td><td class="memItemRight"><a class="el" href="#af7d987b7f085aefe6ba35f20c992c14d">Formatter</a> (<a class="el" href="class_abstract_byte_buffer.html">AbstractByteBuffer</a> *buf, bool _isHex=false, bool _isSkipNonprintable=false)</td></tr>
<tr class="memitem:af14f0559fb635c3a5afaa71fbc0e87ae" id="r_af14f0559fb635c3a5afaa71fbc0e87ae"><td class="memItemLeft">void&#160;</td><td class="memItemRight"><a class="el" href="#af14f0559fb635c3a5afaa71fbc0e87ae">setHex</a> (bool isEnabled)</td></tr>
<tr class="memitem:a184c36e62fb95e0df57aefdbc200a65b" id="r_a184c36e62fb95e0df57aefdbc200a65b"><td class="memItemLeft">void&#160;</td><td class="memItemRight"><a class="el" href="#a184c36e62fb95e0df57aefdbc200a65b">setSkipNonPrintable</a> (bool isEnabled)</td></tr>
<tr class="memitem:a5e1a806e1a1bebdab3a08736d8a10990" id="r_a5e1a806e1a1bebdab3a08736d8a10990"><td class="memItemLeft">const QString&#160;</td><td class="memItemRight"><a class="el" href="#a5e1a806e1a1bebdab3a08736d8a10990">operator[]</a> (std::size_t idx) const</td></tr>
<tr class="inherit_header pub_methods_class_abstract_formatter"><td colspan="2">Public Member Functions inherited from <a class="el" href="class_abstract_formatter.html">AbstractFormatter</a></td></tr>
<tr class="memitem:a57a59b2942bb9c829fcc1b45aba1bbb1 pub_methods_class_abstract_formatter" id="r_a57a59b2942bb9c829fcc1b45aba1bbb1"><td class="memItemLeft">&#160;</td><td class="memItemRight"><a class="el" href="class_abstract_formatter.html#a57a59b2942bb9c829fcc1b45aba1bbb1">AbstractFormatter</a> (<a class="el" href="class_abstract_byte_buffer.html">AbstractByteBuffer</a> *v_buf)</td></tr>
<tr class="memitem:a357e977f2d4d293345a1d38ee8ee3420 pub_methods_class_abstract_formatter" id="r_a357e977f2d4d293345a1d38ee8ee3420"><td class="memItemLeft">virtual&#160;</td><td class="memItemRight"><a class="el" href="class_abstract_formatter.html#a357e977f2d4d293345a1d38ee8ee3420">~AbstractFormatter</a> ()</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pro-attribs" class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:ab9c774af452b980b4e4775a33b950fbe" id="r_ab9c774af452b980b4e4775a33b950fbe"><td class="memItemLeft">bool&#160;</td><td class="memItemRight"><a class="el" href="#ab9c774af452b980b4e4775a33b950fbe">isHex</a></td></tr>
<tr class="memitem:afbb60c22ecb6537ff3440c66c56002f9" id="r_afbb60c22ecb6537ff3440c66c56002f9"><td class="memItemLeft">bool&#160;</td><td class="memItemRight"><a class="el" href="#afbb60c22ecb6537ff3440c66c56002f9">isSkipNonprintable</a></td></tr>
<tr class="inherit_header pro_attribs_class_abstract_formatter"><td colspan="2">Protected Attributes inherited from <a class="el" href="class_abstract_formatter.html">AbstractFormatter</a></td></tr>
<tr class="memitem:abe6b55fd6f0d1cfecca5d35e53b84223 pro_attribs_class_abstract_formatter" id="r_abe6b55fd6f0d1cfecca5d35e53b84223"><td class="memItemLeft"><a class="el" href="class_abstract_byte_buffer.html">AbstractByteBuffer</a> *&#160;</td><td class="memItemRight"><a class="el" href="class_abstract_formatter.html#abe6b55fd6f0d1cfecca5d35e53b84223">buf</a></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="_formatter_8h_source.html#l00018">18</a> of file <a class="el" href="_formatter_8h_source.html">Formatter.h</a>.</p>
</div><a name="doc-constructors" id="doc-constructors"></a><h2 id="header-doc-constructors" class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="af7d987b7f085aefe6ba35f20c992c14d" name="af7d987b7f085aefe6ba35f20c992c14d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af7d987b7f085aefe6ba35f20c992c14d">&#9670;&#160;</a></span>Formatter()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Formatter::Formatter </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_abstract_byte_buffer.html">AbstractByteBuffer</a> *</td> <td class="paramname"><span class="paramname"><em>buf</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>_isHex</em></span><span class="paramdefsep"> = </span><span class="paramdefval">false</span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>_isSkipNonprintable</em></span><span class="paramdefsep"> = </span><span class="paramdefval">false</span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="_formatter_8h_source.html#l00020">20</a> of file <a class="el" href="_formatter_8h_source.html">Formatter.h</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="class_formatter_af7d987b7f085aefe6ba35f20c992c14d_cgraph.png" border="0" usemap="#aclass_formatter_af7d987b7f085aefe6ba35f20c992c14d_cgraph" loading="lazy" alt=""/></div>
<map name="aclass_formatter_af7d987b7f085aefe6ba35f20c992c14d_cgraph" id="aclass_formatter_af7d987b7f085aefe6ba35f20c992c14d_cgraph">
<area shape="rect" title=" " alt="" coords="5,13,145,38"/>
<area shape="rect" href="class_abstract_formatter.html#a57a59b2942bb9c829fcc1b45aba1bbb1" title=" " alt="" coords="193,5,325,46"/>
<area shape="poly" title=" " alt="" coords="145,23,177,23,177,28,145,28"/>
</map>
</div>
</div>
</div>
<a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Member Function Documentation</h2>
<a id="a5e1a806e1a1bebdab3a08736d8a10990" name="a5e1a806e1a1bebdab3a08736d8a10990"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5e1a806e1a1bebdab3a08736d8a10990">&#9670;&#160;</a></span>operator[]()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const QString Formatter::operator[] </td>
<td>(</td>
<td class="paramtype">std::size_t</td> <td class="paramname"><span class="paramname"><em>idx</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="class_abstract_formatter.html#a53099d0eb6374a39ff83bcf90b1aa41e">AbstractFormatter</a>.</p>
<p class="definition">Definition at line <a class="el" href="_formatter_8cpp_source.html#l00012">12</a> of file <a class="el" href="_formatter_8cpp_source.html">Formatter.cpp</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="class_formatter_a5e1a806e1a1bebdab3a08736d8a10990_cgraph.png" border="0" usemap="#aclass_formatter_a5e1a806e1a1bebdab3a08736d8a10990_cgraph" loading="lazy" alt=""/></div>
<map name="aclass_formatter_a5e1a806e1a1bebdab3a08736d8a10990_cgraph" id="aclass_formatter_a5e1a806e1a1bebdab3a08736d8a10990_cgraph">
<area shape="rect" title=" " alt="" coords="5,5,144,31"/>
<area shape="rect" href="namespacepe__util.html#aad5182df7cffa8c7cbcadcf71ff60a19" title=" " alt="" coords="192,5,318,31"/>
<area shape="poly" title=" " alt="" coords="144,16,176,16,176,21,144,21"/>
</map>
</div>
</div>
</div>
<a id="af14f0559fb635c3a5afaa71fbc0e87ae" name="af14f0559fb635c3a5afaa71fbc0e87ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af14f0559fb635c3a5afaa71fbc0e87ae">&#9670;&#160;</a></span>setHex()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Formatter::setHex </td>
<td>(</td>
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>isEnabled</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="_formatter_8h_source.html#l00026">26</a> of file <a class="el" href="_formatter_8h_source.html">Formatter.h</a>.</p>
</div>
</div>
<a id="a184c36e62fb95e0df57aefdbc200a65b" name="a184c36e62fb95e0df57aefdbc200a65b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a184c36e62fb95e0df57aefdbc200a65b">&#9670;&#160;</a></span>setSkipNonPrintable()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Formatter::setSkipNonPrintable </td>
<td>(</td>
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>isEnabled</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="_formatter_8h_source.html#l00027">27</a> of file <a class="el" href="_formatter_8h_source.html">Formatter.h</a>.</p>
</div>
</div>
<a name="doc-variable-members" id="doc-variable-members"></a><h2 id="header-doc-variable-members" class="groupheader">Member Data Documentation</h2>
<a id="ab9c774af452b980b4e4775a33b950fbe" name="ab9c774af452b980b4e4775a33b950fbe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab9c774af452b980b4e4775a33b950fbe">&#9670;&#160;</a></span>isHex</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Formatter::isHex</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel protected">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="_formatter_8h_source.html#l00032">32</a> of file <a class="el" href="_formatter_8h_source.html">Formatter.h</a>.</p>
</div>
</div>
<a id="afbb60c22ecb6537ff3440c66c56002f9" name="afbb60c22ecb6537ff3440c66c56002f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afbb60c22ecb6537ff3440c66c56002f9">&#9670;&#160;</a></span>isSkipNonprintable</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Formatter::isSkipNonprintable</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel protected">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="_formatter_8h_source.html#l00033">33</a> of file <a class="el" href="_formatter_8h_source.html">Formatter.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>parser/include/bearparser/<a class="el" href="_formatter_8h_source.html">Formatter.h</a></li>
<li>parser/<a class="el" href="_formatter_8cpp_source.html">Formatter.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.17.0
</small></address>
</div><!-- doc-content -->
</body>
</html>