Files
ComSquare/classComSquare_1_1Debugger_1_1CPU_1_1WlaDx.html
AnonymusRaccoon d33b0ab52d Deploying the doc
2021-07-13 21:32:24 +00:00

280 lines
14 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>ComSquare: ComSquare::Debugger::CPU::WlaDx 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">ComSquare
</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="namespaceComSquare.html">ComSquare</a></li><li class="navelem"><a class="el" href="namespaceComSquare_1_1Debugger.html">Debugger</a></li><li class="navelem"><a class="el" href="namespaceComSquare_1_1Debugger_1_1CPU.html">CPU</a></li><li class="navelem"><a class="el" href="classComSquare_1_1Debugger_1_1CPU_1_1WlaDx.html">WlaDx</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="classComSquare_1_1Debugger_1_1CPU_1_1WlaDx-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ComSquare::Debugger::CPU::WlaDx Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Class to parse WLA-DX symbol files.
<a href="classComSquare_1_1Debugger_1_1CPU_1_1WlaDx.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="WlaDx_8hpp_source.html">WlaDx.hpp</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ComSquare::Debugger::CPU::WlaDx:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classComSquare_1_1Debugger_1_1CPU_1_1WlaDx__coll__graph.svg" width="179" height="147"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a2022d318bbb47768ce5f8f7f3e056975"><td class="memItemLeft" align="right" valign="top">static std::vector&lt; <a class="el" href="structComSquare_1_1Debugger_1_1CPU_1_1Label.html">Label</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Debugger_1_1CPU_1_1WlaDx.html#a2022d318bbb47768ce5f8f7f3e056975">parse</a> (std::ifstream &amp;symbolFile)</td></tr>
<tr class="memdesc:a2022d318bbb47768ce5f8f7f3e056975"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parse the whole file. <a href="classComSquare_1_1Debugger_1_1CPU_1_1WlaDx.html#a2022d318bbb47768ce5f8f7f3e056975">More...</a><br /></td></tr>
<tr class="separator:a2022d318bbb47768ce5f8f7f3e056975"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1501ed862cc0c5fb47fe654d56c7a741"><td class="memItemLeft" align="right" valign="top">static std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Debugger_1_1CPU_1_1WlaDx.html#a1501ed862cc0c5fb47fe654d56c7a741">_parseLabels</a> (std::map&lt; std::string, <a class="el" href="structComSquare_1_1Debugger_1_1CPU_1_1Label.html">Label</a> &gt; &amp;labels, std::ifstream &amp;symbolFile)</td></tr>
<tr class="memdesc:a1501ed862cc0c5fb47fe654d56c7a741"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parse labels name &amp; addresses (the [labels] section) <a href="classComSquare_1_1Debugger_1_1CPU_1_1WlaDx.html#a1501ed862cc0c5fb47fe654d56c7a741">More...</a><br /></td></tr>
<tr class="separator:a1501ed862cc0c5fb47fe654d56c7a741"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a25ffa95555de366bf565a0a567105459"><td class="memItemLeft" align="right" valign="top">static std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Debugger_1_1CPU_1_1WlaDx.html#a25ffa95555de366bf565a0a567105459">_parseDefinitions</a> (std::map&lt; std::string, <a class="el" href="structComSquare_1_1Debugger_1_1CPU_1_1Label.html">Label</a> &gt; &amp;labels, std::ifstream &amp;symbolFile)</td></tr>
<tr class="memdesc:a25ffa95555de366bf565a0a567105459"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parse definitions (and size of labels) (the [definitions] section) <a href="classComSquare_1_1Debugger_1_1CPU_1_1WlaDx.html#a25ffa95555de366bf565a0a567105459">More...</a><br /></td></tr>
<tr class="separator:a25ffa95555de366bf565a0a567105459"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a42e49db03ae19bf2fc8be14f1f6e6173"><td class="memItemLeft" align="right" valign="top">static std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Debugger_1_1CPU_1_1WlaDx.html#a42e49db03ae19bf2fc8be14f1f6e6173">_cleanLine</a> (std::string line)</td></tr>
<tr class="memdesc:a42e49db03ae19bf2fc8be14f1f6e6173"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove comments, indentation &amp; trailing spaces from a line. <a href="classComSquare_1_1Debugger_1_1CPU_1_1WlaDx.html#a42e49db03ae19bf2fc8be14f1f6e6173">More...</a><br /></td></tr>
<tr class="separator:a42e49db03ae19bf2fc8be14f1f6e6173"><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>Class to parse WLA-DX symbol files. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a42e49db03ae19bf2fc8be14f1f6e6173"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a42e49db03ae19bf2fc8be14f1f6e6173">&#9670;&nbsp;</a></span>_cleanLine()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string ComSquare::Debugger::CPU::WlaDx::_cleanLine </td>
<td>(</td>
<td class="paramtype">std::string&#160;</td>
<td class="paramname"><em>line</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Remove comments, indentation &amp; trailing spaces from a line. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">line</td><td>The line to clean </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The line cleaned up. </dd></dl>
</div>
</div>
<a id="a25ffa95555de366bf565a0a567105459"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a25ffa95555de366bf565a0a567105459">&#9670;&nbsp;</a></span>_parseDefinitions()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string ComSquare::Debugger::CPU::WlaDx::_parseDefinitions </td>
<td>(</td>
<td class="paramtype">std::map&lt; std::string, <a class="el" href="structComSquare_1_1Debugger_1_1CPU_1_1Label.html">Label</a> &gt; &amp;&#160;</td>
<td class="paramname"><em>labels</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::ifstream &amp;&#160;</td>
<td class="paramname"><em>symbolFile</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">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Parse definitions (and size of labels) (the [definitions] section) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">labels</td><td>An list of labels. If one is already defined, the size will be set. </td></tr>
<tr><td class="paramname">symbolFile</td><td>The file to parse, opened and seeked to the line just after the [definitions] line. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The line after the definitions section (the first line that doesn't match the section's regex). </dd></dl>
</div>
</div>
<a id="a1501ed862cc0c5fb47fe654d56c7a741"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1501ed862cc0c5fb47fe654d56c7a741">&#9670;&nbsp;</a></span>_parseLabels()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string ComSquare::Debugger::CPU::WlaDx::_parseLabels </td>
<td>(</td>
<td class="paramtype">std::map&lt; std::string, <a class="el" href="structComSquare_1_1Debugger_1_1CPU_1_1Label.html">Label</a> &gt; &amp;&#160;</td>
<td class="paramname"><em>labels</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::ifstream &amp;&#160;</td>
<td class="paramname"><em>symbolFile</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">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Parse labels name &amp; addresses (the [labels] section) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">labels</td><td>An list of labels. If one is already defined, the address will be set. </td></tr>
<tr><td class="paramname">symbolFile</td><td>The file to parse, opened and seeked to the line just after the [labels] line. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The line after the label section (the first line that doesn't match the section's regex). </dd></dl>
</div>
</div>
<a id="a2022d318bbb47768ce5f8f7f3e056975"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2022d318bbb47768ce5f8f7f3e056975">&#9670;&nbsp;</a></span>parse()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::vector&lt; <a class="el" href="structComSquare_1_1Debugger_1_1CPU_1_1Label.html">Label</a> &gt; ComSquare::Debugger::CPU::WlaDx::parse </td>
<td>(</td>
<td class="paramtype">std::ifstream &amp;&#160;</td>
<td class="paramname"><em>symbolFile</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Parse the whole file. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">symbolFile</td><td>The file to parse (opened but not seeked) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The list of symbol found. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>sources/Debugger/CPU/SymbolLoaders/<a class="el" href="WlaDx_8hpp_source.html">WlaDx.hpp</a></li>
<li>sources/Debugger/CPU/SymbolLoaders/<a class="el" href="WlaDx_8cpp.html">WlaDx.cpp</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>