herbglitch/archeus
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
archeus/doc/doxygen/html/df/d03/shell_8h_source.html

251 lines
31 KiB
HTML
Raw Blame History

<!-- HTML header for doxygen 1.9.2-->
<!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" class="dark-mode">
<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.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Archeus: /home/herbglitch/programs/archeus/arc/include/arc/console/shell.h 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="../../navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../navtreedata.js"></script>
<script type="text/javascript" src="../../navtree.js"></script>
<script type="text/javascript" src="../../resize.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>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
<link href="../../doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="../../doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
<link href="../../doxygen-awesome-sidebar-only-darkmode-toggle.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../doxygen-awesome-darkmode-toggle.js"></script>
</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">Archeus<span id="projectnumber">&#160;0.0.0</span>
</div>
<div id="projectbrief">A C library and game engine that focuses on documentation</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "../../search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(1); });
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('../../',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('df/d03/shell_8h_source.html','../../'); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="headertitle"><div class="title">shell.h</div></div>
</div><!--header-->
<div class="contents">
<a href="../../df/d03/shell_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifndef ARC_CONSOLE_SHELL_H_</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define ARC_CONSOLE_SHELL_H_</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment">//TODO: fix up this file</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include &quot;<a class="code" href="../../d6/d7e/console_2view_8h.html">view.h</a>&quot;</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#include &quot;<a class="code" href="../../d5/d08/buffer_8h.html">buffer.h</a>&quot;</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#include &quot;<a class="code" href="../../da/d66/string_8h.html">arc/std/string.h</a>&quot;</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="preprocessor">#include &quot;<a class="code" href="../../d6/d68/vector_8h.html">arc/std/vector.h</a>&quot;</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#include &lt;stdint.h&gt;</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"></span> </div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment">/**</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> * @brief</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment">*/</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="../../df/d03/shell_8h.html#a6acfa8cd8d7743d75ac04caffdec44ae"> 19</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="../../d9/d4c/structARC__ConsoleShell.html">ARC_ConsoleShell</a> <a class="code hl_struct" href="../../d9/d4c/structARC__ConsoleShell.html">ARC_ConsoleShell</a>;</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment"></span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="comment">/**</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="comment"> * @brief</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="comment">*/</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"><a class="line" href="../../df/d03/shell_8h.html#a896c97abc1c3a02746738b4c0550f48b"> 24</a></span><span class="keyword">typedef</span> void (* <a class="code hl_typedef" href="../../df/d03/shell_8h.html#a896c97abc1c3a02746738b4c0550f48b">ARC_ConsoleShell_UpdateFn</a>)(<a class="code hl_struct" href="../../d9/d4c/structARC__ConsoleShell.html">ARC_ConsoleShell</a> *shell);</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="comment"></span> </div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="comment">/**</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="comment"> * @brief</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="comment">*/</span></div>
<div class="foldopen" id="foldopen00029" data-start="{" data-end="};">
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"><a class="line" href="../../d9/d4c/structARC__ConsoleShell.html"> 29</a></span><span class="keyword">struct </span><a class="code hl_struct" href="../../d9/d4c/structARC__ConsoleShell.html">ARC_ConsoleShell</a> {</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="../../d9/d4c/structARC__ConsoleShell.html#a53d8365cb1119f21f0b23fa1abae8c05"> 30</a></span> <a class="code hl_typedef" href="../../d6/d7e/console_2view_8h.html#a518bdb9b27a8304e65e60ec49320b18b">ARC_ConsoleView</a> *<a class="code hl_variable" href="../../d9/d4c/structARC__ConsoleShell.html#a53d8365cb1119f21f0b23fa1abae8c05">view</a>;</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"><a class="line" href="../../d9/d4c/structARC__ConsoleShell.html#a77c4a161dfbf8ad6c6afc18362c3ec66"> 31</a></span> <a class="code hl_typedef" href="../../d5/d08/buffer_8h.html#a04647685671d3c7dbb760fcd1413f7e6">ARC_ConsoleBuffer</a> *<a class="code hl_variable" href="../../d9/d4c/structARC__ConsoleShell.html#a77c4a161dfbf8ad6c6afc18362c3ec66">buffer</a>;</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="../../d9/d4c/structARC__ConsoleShell.html#a25d7454e64c1af58a66288d8a12b04ce"> 32</a></span> uint32_t <a class="code hl_variable" href="../../d9/d4c/structARC__ConsoleShell.html#a25d7454e64c1af58a66288d8a12b04ce">bufferLineIndex</a>;</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"><a class="line" href="../../d9/d4c/structARC__ConsoleShell.html#a88f6d6daf79f0464766ae1a912eac0fa"> 34</a></span> <a class="code hl_typedef" href="../../d2/d19/group__ARC__Vector.html#ga23dfcf0229206051666a31f91c8c6e1b">ARC_Vector</a> *<a class="code hl_variable" href="../../d9/d4c/structARC__ConsoleShell.html#a88f6d6daf79f0464766ae1a912eac0fa">history</a>;</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="../../d9/d4c/structARC__ConsoleShell.html#ad860e9556c262f6d02240589c5099b8f"> 35</a></span> uint32_t <a class="code hl_variable" href="../../d9/d4c/structARC__ConsoleShell.html#ad860e9556c262f6d02240589c5099b8f">historyIndex</a>;</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="../../d9/d4c/structARC__ConsoleShell.html#a950522b4dfb71a19621da6b1077ccbdb"> 37</a></span> <a class="code hl_typedef" href="../../df/d03/shell_8h.html#a896c97abc1c3a02746738b4c0550f48b">ARC_ConsoleShell_UpdateFn</a> <a class="code hl_variable" href="../../d9/d4c/structARC__ConsoleShell.html#a950522b4dfb71a19621da6b1077ccbdb">updateFn</a>;</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="../../d9/d4c/structARC__ConsoleShell.html#aa8671d3299f3352e0a7639464d9eb2d1"> 39</a></span> <a class="code hl_struct" href="../../df/d06/structARC__String.html">ARC_String</a> *<a class="code hl_variable" href="../../d9/d4c/structARC__ConsoleShell.html#aa8671d3299f3352e0a7639464d9eb2d1">currentLine</a>;</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="../../d9/d4c/structARC__ConsoleShell.html#ac9dde7ef4fedcb03abf056d9e189311a"> 40</a></span> <a class="code hl_struct" href="../../df/d06/structARC__String.html">ARC_String</a> *<a class="code hl_variable" href="../../d9/d4c/structARC__ConsoleShell.html#ac9dde7ef4fedcb03abf056d9e189311a">userInput</a>;</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span>};</div>
</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="comment"></span> </div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span><span class="comment">/**</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><span class="comment"> * @brief creates ARC_ConsoleShell type</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><span class="comment"> *</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span><span class="comment"> * @param shell ARC_ConsoleShell to create</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="comment"> * @param view ARC_ConsoleView to attach the shell to</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="comment"> * @param updateFn ARC_ConsoleShell_UpdateFn provided that will run the console</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="comment">*/</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="../../df/d03/shell_8h.html#aad422f04801c70d2a27f6e30f74efd70"> 50</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../df/d03/shell_8h.html#aad422f04801c70d2a27f6e30f74efd70">ARC_ConsoleShell_Create</a>(<a class="code hl_struct" href="../../d9/d4c/structARC__ConsoleShell.html">ARC_ConsoleShell</a> **shell, <a class="code hl_typedef" href="../../d6/d7e/console_2view_8h.html#a518bdb9b27a8304e65e60ec49320b18b">ARC_ConsoleView</a> *view, <a class="code hl_typedef" href="../../df/d03/shell_8h.html#a896c97abc1c3a02746738b4c0550f48b">ARC_ConsoleShell_UpdateFn</a> updateFn);</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span><span class="comment"></span> </div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="comment">/**</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span><span class="comment"> * @brief destroys ARC_ConsoleShell type</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span><span class="comment"> *</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span><span class="comment"> * @param shell ARC_ConsoleShell to destroy</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span><span class="comment">*/</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"><a class="line" href="../../df/d03/shell_8h.html#a5e9357a85d39bf8d040cfb4fa19ede06"> 57</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../df/d03/shell_8h.html#a5e9357a85d39bf8d040cfb4fa19ede06">ARC_ConsoleShell_Destroy</a>(<a class="code hl_struct" href="../../d9/d4c/structARC__ConsoleShell.html">ARC_ConsoleShell</a> *shell);</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span><span class="comment"></span> </div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span><span class="comment">/**</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span><span class="comment"> * @brief updates the ARC_ConsoleShell type</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span><span class="comment"> *</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span><span class="comment"> * @param shell the ARC_ConsoleShell to update</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span><span class="comment">*/</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"><a class="line" href="../../df/d03/shell_8h.html#ac73769a7e97b7ba99f74c53347249f63"> 64</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../df/d03/shell_8h.html#ac73769a7e97b7ba99f74c53347249f63">ARC_ConsoleShell_Update</a>(<a class="code hl_struct" href="../../d9/d4c/structARC__ConsoleShell.html">ARC_ConsoleShell</a> *shell);</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span><span class="comment"></span> </div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span><span class="comment">/**</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span><span class="comment"> * @brief renders the ARC_ConsoleShell type</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span><span class="comment"> *</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span><span class="comment"> * @param shell the ARC_ConsoleShell to render</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span><span class="comment">*/</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"><a class="line" href="../../df/d03/shell_8h.html#a43241a784b1a6a914899b26d9d86c10c"> 71</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../df/d03/shell_8h.html#a43241a784b1a6a914899b26d9d86c10c">ARC_ConsoleShell_Render</a>(<a class="code hl_struct" href="../../d9/d4c/structARC__ConsoleShell.html">ARC_ConsoleShell</a> *shell);</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span><span class="comment"></span> </div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span><span class="comment">/**</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span><span class="comment"> * @brief adds history ARC_String to ARC_ConsoleShell</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span><span class="comment"> *</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span><span class="comment"> * @param shell the ARC_ConsoleShell to add history to</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span><span class="comment"> * @param string the history string to add to ARC_ConsoleShell</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span><span class="comment">*/</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"><a class="line" href="../../df/d03/shell_8h.html#ac52159572774e27f8c2e489f73b28314"> 79</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../df/d03/shell_8h.html#ac52159572774e27f8c2e489f73b28314">ARC_ConsoleShell_AddHistory</a>(<a class="code hl_struct" href="../../d9/d4c/structARC__ConsoleShell.html">ARC_ConsoleShell</a> *shell, <a class="code hl_struct" href="../../df/d06/structARC__String.html">ARC_String</a> *<span class="keywordtype">string</span>);</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span><span class="comment"></span> </div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span><span class="comment">/**</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span><span class="comment"> * @brief gets history from ARC_ConsoleShell</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span><span class="comment"> *</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span><span class="comment"> * @note the index 0 will start from the last added history</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span><span class="comment"> *</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span><span class="comment"> * @param shell the ARC_ConsoleShell to get history from</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span><span class="comment"> * @param index the location to get history at</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span><span class="comment"> *</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span><span class="comment"> * @return the history as an ARC_String</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span><span class="comment">*/</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"><a class="line" href="../../df/d03/shell_8h.html#a90d4df9f1eba33e1a15c3184621a4805"> 91</a></span><a class="code hl_struct" href="../../df/d06/structARC__String.html">ARC_String</a> *<a class="code hl_function" href="../../df/d03/shell_8h.html#a90d4df9f1eba33e1a15c3184621a4805">ARC_ConsoleShell_GetHistoryAt</a>(<a class="code hl_struct" href="../../d9/d4c/structARC__ConsoleShell.html">ARC_ConsoleShell</a> *shell, uint32_t index);</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> </div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span><span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span>}</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> </div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span><span class="preprocessor">#endif </span><span class="comment">//!ARC_CONSOLE_SHELL_H_</span></div>
<div class="ttc" id="abuffer_8h_html"><div class="ttname"><a href="../../d5/d08/buffer_8h.html">buffer.h</a></div></div>
<div class="ttc" id="abuffer_8h_html_a04647685671d3c7dbb760fcd1413f7e6"><div class="ttname"><a href="../../d5/d08/buffer_8h.html#a04647685671d3c7dbb760fcd1413f7e6">ARC_ConsoleBuffer</a></div><div class="ttdeci">struct ARC_ConsoleBuffer ARC_ConsoleBuffer</div><div class="ttdef"><b>Definition</b> <a href="../../d5/d08/buffer_8h_source.html#l00015">buffer.h:15</a></div></div>
<div class="ttc" id="aconsole_2view_8h_html"><div class="ttname"><a href="../../d6/d7e/console_2view_8h.html">view.h</a></div></div>
<div class="ttc" id="aconsole_2view_8h_html_a518bdb9b27a8304e65e60ec49320b18b"><div class="ttname"><a href="../../d6/d7e/console_2view_8h.html#a518bdb9b27a8304e65e60ec49320b18b">ARC_ConsoleView</a></div><div class="ttdeci">struct ARC_ConsoleView ARC_ConsoleView</div><div class="ttdef"><b>Definition</b> <a href="../../d6/d7e/console_2view_8h_source.html#l00018">view.h:18</a></div></div>
<div class="ttc" id="agroup__ARC__Vector_html_ga23dfcf0229206051666a31f91c8c6e1b"><div class="ttname"><a href="../../d2/d19/group__ARC__Vector.html#ga23dfcf0229206051666a31f91c8c6e1b">ARC_Vector</a></div><div class="ttdeci">struct ARC_Vector ARC_Vector</div><div class="ttdoc">a dynamic array type</div><div class="ttdef"><b>Definition</b> <a href="../../d6/d68/vector_8h_source.html#l00026">vector.h:26</a></div></div>
<div class="ttc" id="ashell_8h_html_a43241a784b1a6a914899b26d9d86c10c"><div class="ttname"><a href="../../df/d03/shell_8h.html#a43241a784b1a6a914899b26d9d86c10c">ARC_ConsoleShell_Render</a></div><div class="ttdeci">void ARC_ConsoleShell_Render(ARC_ConsoleShell *shell)</div><div class="ttdoc">renders the ARC_ConsoleShell type</div></div>
<div class="ttc" id="ashell_8h_html_a5e9357a85d39bf8d040cfb4fa19ede06"><div class="ttname"><a href="../../df/d03/shell_8h.html#a5e9357a85d39bf8d040cfb4fa19ede06">ARC_ConsoleShell_Destroy</a></div><div class="ttdeci">void ARC_ConsoleShell_Destroy(ARC_ConsoleShell *shell)</div><div class="ttdoc">destroys ARC_ConsoleShell type</div></div>
<div class="ttc" id="ashell_8h_html_a896c97abc1c3a02746738b4c0550f48b"><div class="ttname"><a href="../../df/d03/shell_8h.html#a896c97abc1c3a02746738b4c0550f48b">ARC_ConsoleShell_UpdateFn</a></div><div class="ttdeci">void(* ARC_ConsoleShell_UpdateFn)(ARC_ConsoleShell *shell)</div><div class="ttdef"><b>Definition</b> <a href="#l00024">shell.h:24</a></div></div>
<div class="ttc" id="ashell_8h_html_a90d4df9f1eba33e1a15c3184621a4805"><div class="ttname"><a href="../../df/d03/shell_8h.html#a90d4df9f1eba33e1a15c3184621a4805">ARC_ConsoleShell_GetHistoryAt</a></div><div class="ttdeci">ARC_String * ARC_ConsoleShell_GetHistoryAt(ARC_ConsoleShell *shell, uint32_t index)</div><div class="ttdoc">gets history from ARC_ConsoleShell</div></div>
<div class="ttc" id="ashell_8h_html_aad422f04801c70d2a27f6e30f74efd70"><div class="ttname"><a href="../../df/d03/shell_8h.html#aad422f04801c70d2a27f6e30f74efd70">ARC_ConsoleShell_Create</a></div><div class="ttdeci">void ARC_ConsoleShell_Create(ARC_ConsoleShell **shell, ARC_ConsoleView *view, ARC_ConsoleShell_UpdateFn updateFn)</div><div class="ttdoc">creates ARC_ConsoleShell type</div></div>
<div class="ttc" id="ashell_8h_html_ac52159572774e27f8c2e489f73b28314"><div class="ttname"><a href="../../df/d03/shell_8h.html#ac52159572774e27f8c2e489f73b28314">ARC_ConsoleShell_AddHistory</a></div><div class="ttdeci">void ARC_ConsoleShell_AddHistory(ARC_ConsoleShell *shell, ARC_String *string)</div><div class="ttdoc">adds history ARC_String to ARC_ConsoleShell</div></div>
<div class="ttc" id="ashell_8h_html_ac73769a7e97b7ba99f74c53347249f63"><div class="ttname"><a href="../../df/d03/shell_8h.html#ac73769a7e97b7ba99f74c53347249f63">ARC_ConsoleShell_Update</a></div><div class="ttdeci">void ARC_ConsoleShell_Update(ARC_ConsoleShell *shell)</div><div class="ttdoc">updates the ARC_ConsoleShell type</div></div>
<div class="ttc" id="astring_8h_html"><div class="ttname"><a href="../../da/d66/string_8h.html">string.h</a></div></div>
<div class="ttc" id="astructARC__ConsoleShell_html"><div class="ttname"><a href="../../d9/d4c/structARC__ConsoleShell.html">ARC_ConsoleShell</a></div><div class="ttdef"><b>Definition</b> <a href="#l00029">shell.h:29</a></div></div>
<div class="ttc" id="astructARC__ConsoleShell_html_a25d7454e64c1af58a66288d8a12b04ce"><div class="ttname"><a href="../../d9/d4c/structARC__ConsoleShell.html#a25d7454e64c1af58a66288d8a12b04ce">ARC_ConsoleShell::bufferLineIndex</a></div><div class="ttdeci">uint32_t bufferLineIndex</div><div class="ttdef"><b>Definition</b> <a href="#l00032">shell.h:32</a></div></div>
<div class="ttc" id="astructARC__ConsoleShell_html_a53d8365cb1119f21f0b23fa1abae8c05"><div class="ttname"><a href="../../d9/d4c/structARC__ConsoleShell.html#a53d8365cb1119f21f0b23fa1abae8c05">ARC_ConsoleShell::view</a></div><div class="ttdeci">ARC_ConsoleView * view</div><div class="ttdef"><b>Definition</b> <a href="#l00030">shell.h:30</a></div></div>
<div class="ttc" id="astructARC__ConsoleShell_html_a77c4a161dfbf8ad6c6afc18362c3ec66"><div class="ttname"><a href="../../d9/d4c/structARC__ConsoleShell.html#a77c4a161dfbf8ad6c6afc18362c3ec66">ARC_ConsoleShell::buffer</a></div><div class="ttdeci">ARC_ConsoleBuffer * buffer</div><div class="ttdef"><b>Definition</b> <a href="#l00031">shell.h:31</a></div></div>
<div class="ttc" id="astructARC__ConsoleShell_html_a88f6d6daf79f0464766ae1a912eac0fa"><div class="ttname"><a href="../../d9/d4c/structARC__ConsoleShell.html#a88f6d6daf79f0464766ae1a912eac0fa">ARC_ConsoleShell::history</a></div><div class="ttdeci">ARC_Vector * history</div><div class="ttdef"><b>Definition</b> <a href="#l00034">shell.h:34</a></div></div>
<div class="ttc" id="astructARC__ConsoleShell_html_a950522b4dfb71a19621da6b1077ccbdb"><div class="ttname"><a href="../../d9/d4c/structARC__ConsoleShell.html#a950522b4dfb71a19621da6b1077ccbdb">ARC_ConsoleShell::updateFn</a></div><div class="ttdeci">ARC_ConsoleShell_UpdateFn updateFn</div><div class="ttdef"><b>Definition</b> <a href="#l00037">shell.h:37</a></div></div>
<div class="ttc" id="astructARC__ConsoleShell_html_aa8671d3299f3352e0a7639464d9eb2d1"><div class="ttname"><a href="../../d9/d4c/structARC__ConsoleShell.html#aa8671d3299f3352e0a7639464d9eb2d1">ARC_ConsoleShell::currentLine</a></div><div class="ttdeci">ARC_String * currentLine</div><div class="ttdef"><b>Definition</b> <a href="#l00039">shell.h:39</a></div></div>
<div class="ttc" id="astructARC__ConsoleShell_html_ac9dde7ef4fedcb03abf056d9e189311a"><div class="ttname"><a href="../../d9/d4c/structARC__ConsoleShell.html#ac9dde7ef4fedcb03abf056d9e189311a">ARC_ConsoleShell::userInput</a></div><div class="ttdeci">ARC_String * userInput</div><div class="ttdef"><b>Definition</b> <a href="#l00040">shell.h:40</a></div></div>
<div class="ttc" id="astructARC__ConsoleShell_html_ad860e9556c262f6d02240589c5099b8f"><div class="ttname"><a href="../../d9/d4c/structARC__ConsoleShell.html#ad860e9556c262f6d02240589c5099b8f">ARC_ConsoleShell::historyIndex</a></div><div class="ttdeci">uint32_t historyIndex</div><div class="ttdef"><b>Definition</b> <a href="#l00035">shell.h:35</a></div></div>
<div class="ttc" id="astructARC__String_html"><div class="ttname"><a href="../../df/d06/structARC__String.html">ARC_String</a></div><div class="ttdoc">substring position within a string</div><div class="ttdef"><b>Definition</b> <a href="../../da/d66/string_8h_source.html#l00014">string.h:14</a></div></div>
<div class="ttc" id="avector_8h_html"><div class="ttname"><a href="../../d6/d68/vector_8h.html">vector.h</a></div><div class="ttdoc">creates and outlines a dynamic array type and its functions</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.9.2-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul><li class="navelem"><a class="el" href="../../dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="../../dir_8698ff38f6ae643760cdad826b9d4736.html">arc</a></li><li class="navelem"><a class="el" href="../../dir_beba8fde51bfc57b68b9250b4fe33f5c.html">console</a></li><li class="navelem"><a class="el" href="../../df/d03/shell_8h.html">shell.h</a></li></ul>
</div>
<script type="text/javascript">
// script for doxygen 1.9.1
$(function() {
toggleButton = document.createElement('doxygen-awesome-dark-mode-toggle')
toggleButton.title = "Toggle Light/Dark Mode"
$(document).ready(function(){
document.getElementById("MSearchBox").parentNode.appendChild(toggleButton)
})
$(window).resize(function(){
document.getElementById("MSearchBox").parentNode.appendChild(toggleButton)
})
})
</script>
</body>
</html>
Reference in a new issue View git blame Copy permalink