mirror of
https://github.com/zoriya/ComSquare.git
synced 2026-05-07 05:39:01 +00:00
134 lines
17 KiB
HTML
134 lines
17 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: sources/Memory/MemoryShadow.hpp Source File</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&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&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="dir_08d237fc27d4ecd563f71c5d52f2fecc.html">sources</a></li><li class="navelem"><a class="el" href="dir_b6b0f0b7471b46e8c4cfc0f00c8af2f6.html">Memory</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">MemoryShadow.hpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="MemoryShadow_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// Created by anonymus-raccoon on 1/28/20.</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">//</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>  </div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#pragma once</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>  </div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include <memory></span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include "<a class="code" href="AMemory_8hpp.html">AMemory.hpp</a>"</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>  </div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="keyword">namespace </span><a class="code" href="namespaceComSquare_1_1Memory.html">ComSquare::Memory</a></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> {</div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"><a class="line" href="classComSquare_1_1Memory_1_1MemoryShadow.html"> 12</a></span>  <span class="keyword">class </span><a class="code" href="classComSquare_1_1Memory_1_1MemoryShadow.html">MemoryShadow</a> : <span class="keyword">public</span> <a class="code" href="classComSquare_1_1Memory_1_1AMemory.html">AMemory</a></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>  {</div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>  <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="classComSquare_1_1Memory_1_1MemoryShadow.html#a70738186c3fb76103ad2ba4827e8ff6c"> 16</a></span>  <a class="code" href="classComSquare_1_1Memory_1_1IMemory.html">IMemory</a> &<a class="code" href="classComSquare_1_1Memory_1_1MemoryShadow.html#a70738186c3fb76103ad2ba4827e8ff6c">_initial</a>;</div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  <a class="code" href="classComSquare_1_1Memory_1_1MemoryShadow.html#a725e0ffcaee092d19283ff3379fd9224">MemoryShadow</a>(<a class="code" href="classComSquare_1_1Memory_1_1IMemory.html">IMemory</a> &initial, <a class="code" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> start, <a class="code" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> end);</div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <a class="code" href="classComSquare_1_1Memory_1_1MemoryShadow.html#a725e0ffcaee092d19283ff3379fd9224">MemoryShadow</a>(<span class="keyword">const</span> <a class="code" href="classComSquare_1_1Memory_1_1MemoryShadow.html">MemoryShadow</a> &) = <span class="keywordflow">default</span>;</div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <a class="code" href="classComSquare_1_1Memory_1_1MemoryShadow.html">MemoryShadow</a> &<a class="code" href="classComSquare_1_1Memory_1_1MemoryShadow.html#ab717b49dc1b840f6b6c008ed915cdef8">operator=</a>(<span class="keyword">const</span> <a class="code" href="classComSquare_1_1Memory_1_1MemoryShadow.html">MemoryShadow</a> &) = <span class="keyword">delete</span>;</div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <a class="code" href="classComSquare_1_1Memory_1_1MemoryShadow.html#a249f0159ee5926ac6b658e735b0fda78">~MemoryShadow</a>() <span class="keyword">override</span> = <span class="keywordflow">default</span>;</div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  </div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  uint8_t <a class="code" href="classComSquare_1_1Memory_1_1MemoryShadow.html#abc27d0d65cf3f5b4b258a5aa8e1250ff">read</a>(<a class="code" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> addr) <span class="keyword">override</span>;</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  </div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordtype">void</span> <a class="code" href="classComSquare_1_1Memory_1_1MemoryShadow.html#a885d4559319980e9e5b706f7fe4c3f49">write</a>(<a class="code" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> addr, uint8_t data) <span class="keyword">override</span>;</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  </div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  [[nodiscard]] <a class="code" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> <a class="code" href="classComSquare_1_1Memory_1_1MemoryShadow.html#ac18f444c8b40e9ef8a077a93c0e7024e">getSize</a>() <span class="keyword">const override</span>;</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  </div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  [[nodiscard]] std::string <a class="code" href="classComSquare_1_1Memory_1_1MemoryShadow.html#a6c5a02f97b97a258d60d8011b805cb6e">getName</a>() <span class="keyword">const override</span>;</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  [[nodiscard]] <a class="code" href="namespaceComSquare.html#a891b49feb5c3e0aaa4873ff19b49968c">Component</a> <a class="code" href="classComSquare_1_1Memory_1_1MemoryShadow.html#a44297bdec2e515e550b6fcd99f635aa1">getComponent</a>() <span class="keyword">const override</span>;</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  </div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  [[nodiscard]] std::string <a class="code" href="classComSquare_1_1Memory_1_1MemoryShadow.html#a3181d146bea3924d4c24974cf7338c97">getValueName</a>(<a class="code" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> addr) <span class="keyword">const override</span>;</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  </div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  [[nodiscard]] <a class="code" href="classComSquare_1_1Memory_1_1IMemory.html">IMemory</a> &<a class="code" href="classComSquare_1_1Memory_1_1MemoryShadow.html#a5734503f992ecf521dc715116670f0f5">getMirrored</a>() <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  };</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> }</div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="aclassComSquare_1_1Memory_1_1MemoryShadow_html_a70738186c3fb76103ad2ba4827e8ff6c"><div class="ttname"><a href="classComSquare_1_1Memory_1_1MemoryShadow.html#a70738186c3fb76103ad2ba4827e8ff6c">ComSquare::Memory::MemoryShadow::_initial</a></div><div class="ttdeci">IMemory & _initial</div><div class="ttdoc">Memory to shadow from.</div><div class="ttdef"><b>Definition:</b> MemoryShadow.hpp:16</div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Memory_1_1MemoryShadow_html_abc27d0d65cf3f5b4b258a5aa8e1250ff"><div class="ttname"><a href="classComSquare_1_1Memory_1_1MemoryShadow.html#abc27d0d65cf3f5b4b258a5aa8e1250ff">ComSquare::Memory::MemoryShadow::read</a></div><div class="ttdeci">uint8_t read(uint24_t addr) override</div><div class="ttdoc">Read from the initial AMemory given.</div><div class="ttdef"><b>Definition:</b> MemoryShadow.cpp:15</div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Memory_1_1MemoryShadow_html"><div class="ttname"><a href="classComSquare_1_1Memory_1_1MemoryShadow.html">ComSquare::Memory::MemoryShadow</a></div><div class="ttdef"><b>Definition:</b> MemoryShadow.hpp:12</div></div>
|
|
<div class="ttc" id="anamespaceComSquare_html_a891b49feb5c3e0aaa4873ff19b49968c"><div class="ttname"><a href="namespaceComSquare.html#a891b49feb5c3e0aaa4873ff19b49968c">ComSquare::Component</a></div><div class="ttdeci">Component</div><div class="ttdef"><b>Definition:</b> Components.hpp:9</div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Memory_1_1MemoryShadow_html_a885d4559319980e9e5b706f7fe4c3f49"><div class="ttname"><a href="classComSquare_1_1Memory_1_1MemoryShadow.html#a885d4559319980e9e5b706f7fe4c3f49">ComSquare::Memory::MemoryShadow::write</a></div><div class="ttdeci">void write(uint24_t addr, uint8_t data) override</div><div class="ttdoc">Write data to the ram.</div><div class="ttdef"><b>Definition:</b> MemoryShadow.cpp:20</div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Memory_1_1MemoryShadow_html_a5734503f992ecf521dc715116670f0f5"><div class="ttname"><a href="classComSquare_1_1Memory_1_1MemoryShadow.html#a5734503f992ecf521dc715116670f0f5">ComSquare::Memory::MemoryShadow::getMirrored</a></div><div class="ttdeci">IMemory & getMirrored() const</div><div class="ttdoc">Return the memory accessor this accessor mirror if any.</div><div class="ttdef"><b>Definition:</b> MemoryShadow.cpp:30</div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Memory_1_1MemoryShadow_html_a44297bdec2e515e550b6fcd99f635aa1"><div class="ttname"><a href="classComSquare_1_1Memory_1_1MemoryShadow.html#a44297bdec2e515e550b6fcd99f635aa1">ComSquare::Memory::MemoryShadow::getComponent</a></div><div class="ttdeci">Component getComponent() const override</div><div class="ttdoc">Get the component of this accessor (used for debug purpose)</div><div class="ttdef"><b>Definition:</b> MemoryShadow.cpp:40</div></div>
|
|
<div class="ttc" id="aAMemory_8hpp_html"><div class="ttname"><a href="AMemory_8hpp.html">AMemory.hpp</a></div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Memory_1_1MemoryShadow_html_a6c5a02f97b97a258d60d8011b805cb6e"><div class="ttname"><a href="classComSquare_1_1Memory_1_1MemoryShadow.html#a6c5a02f97b97a258d60d8011b805cb6e">ComSquare::Memory::MemoryShadow::getName</a></div><div class="ttdeci">std::string getName() const override</div><div class="ttdoc">Get the name of this accessor (used for debug purpose)</div><div class="ttdef"><b>Definition:</b> MemoryShadow.cpp:35</div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Memory_1_1MemoryShadow_html_ac18f444c8b40e9ef8a077a93c0e7024e"><div class="ttname"><a href="classComSquare_1_1Memory_1_1MemoryShadow.html#ac18f444c8b40e9ef8a077a93c0e7024e">ComSquare::Memory::MemoryShadow::getSize</a></div><div class="ttdeci">uint24_t getSize() const override</div><div class="ttdoc">Get the size of the data. This size can be lower than the mapped data.</div><div class="ttdef"><b>Definition:</b> MemoryShadow.cpp:25</div></div>
|
|
<div class="ttc" id="aInts_8hpp_html_a89f009aaf5d1964a000f44f09fa0bcf8"><div class="ttname"><a href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a></div><div class="ttdeci">unsigned uint24_t</div><div class="ttdef"><b>Definition:</b> Ints.hpp:10</div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Memory_1_1IMemory_html"><div class="ttname"><a href="classComSquare_1_1Memory_1_1IMemory.html">ComSquare::Memory::IMemory</a></div><div class="ttdoc">Common interface implemented by all components mapping memory.</div><div class="ttdef"><b>Definition:</b> IMemory.hpp:17</div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Memory_1_1MemoryShadow_html_a249f0159ee5926ac6b658e735b0fda78"><div class="ttname"><a href="classComSquare_1_1Memory_1_1MemoryShadow.html#a249f0159ee5926ac6b658e735b0fda78">ComSquare::Memory::MemoryShadow::~MemoryShadow</a></div><div class="ttdeci">~MemoryShadow() override=default</div><div class="ttdoc">A default destructor.</div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Memory_1_1MemoryShadow_html_a3181d146bea3924d4c24974cf7338c97"><div class="ttname"><a href="classComSquare_1_1Memory_1_1MemoryShadow.html#a3181d146bea3924d4c24974cf7338c97">ComSquare::Memory::MemoryShadow::getValueName</a></div><div class="ttdeci">std::string getValueName(uint24_t addr) const override</div><div class="ttdoc">Get the name of the data at the address.</div><div class="ttdef"><b>Definition:</b> MemoryShadow.cpp:45</div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Memory_1_1AMemory_html"><div class="ttname"><a href="classComSquare_1_1Memory_1_1AMemory.html">ComSquare::Memory::AMemory</a></div><div class="ttdoc">Abstract class representing a continuous block of memory.</div><div class="ttdef"><b>Definition:</b> AMemory.hpp:18</div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Memory_1_1MemoryShadow_html_a725e0ffcaee092d19283ff3379fd9224"><div class="ttname"><a href="classComSquare_1_1Memory_1_1MemoryShadow.html#a725e0ffcaee092d19283ff3379fd9224">ComSquare::Memory::MemoryShadow::MemoryShadow</a></div><div class="ttdeci">MemoryShadow(IMemory &initial, uint24_t start, uint24_t end)</div><div class="ttdoc">Create a shadow for the memory given as parameter.</div><div class="ttdef"><b>Definition:</b> MemoryShadow.cpp:9</div></div>
|
|
<div class="ttc" id="anamespaceComSquare_1_1Memory_html"><div class="ttname"><a href="namespaceComSquare_1_1Memory.html">ComSquare::Memory</a></div><div class="ttdef"><b>Definition:</b> AMemory.cpp:7</div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Memory_1_1MemoryShadow_html_ab717b49dc1b840f6b6c008ed915cdef8"><div class="ttname"><a href="classComSquare_1_1Memory_1_1MemoryShadow.html#ab717b49dc1b840f6b6c008ed915cdef8">ComSquare::Memory::MemoryShadow::operator=</a></div><div class="ttdeci">MemoryShadow & operator=(const MemoryShadow &)=delete</div><div class="ttdoc">A memory shadow is not assignable.</div></div>
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|