herbglitch/archeus
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
archeus/doc/doxygen/html/d6/d4f/shell_8c.html

416 lines
35 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/packages/console/ncurses/shell.c File 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="../../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('d6/d4f/shell_8c.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="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">shell.c File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="../../df/d03/shell_8h_source.html">arc/console/shell.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="../../d5/d08/buffer_8h_source.html">arc/console/buffer.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="../../da/d66/string_8h_source.html">arc/std/string.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="../../d6/d68/vector_8h_source.html">arc/std/vector.h</a>&quot;</code><br />
<code>#include &lt;stdlib.h&gt;</code><br />
</div>
<p><a href="../../d6/d4f/shell_8c_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:aad422f04801c70d2a27f6e30f74efd70" id="r_aad422f04801c70d2a27f6e30f74efd70"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aad422f04801c70d2a27f6e30f74efd70">ARC_ConsoleShell_Create</a> (<a class="el" href="../../d9/d4c/structARC__ConsoleShell.html">ARC_ConsoleShell</a> **shell, <a class="el" href="../../d1/d4a/structARC__ConsoleView.html">ARC_ConsoleView</a> *view, <a class="el" href="../../df/d03/shell_8h.html#a896c97abc1c3a02746738b4c0550f48b">ARC_ConsoleShell_UpdateFn</a> updateFn)</td></tr>
<tr class="memdesc:aad422f04801c70d2a27f6e30f74efd70"><td class="mdescLeft">&#160;</td><td class="mdescRight">creates <a class="el" href="../../d9/d4c/structARC__ConsoleShell.html">ARC_ConsoleShell</a> type <br /></td></tr>
<tr class="separator:aad422f04801c70d2a27f6e30f74efd70"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5e9357a85d39bf8d040cfb4fa19ede06" id="r_a5e9357a85d39bf8d040cfb4fa19ede06"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5e9357a85d39bf8d040cfb4fa19ede06">ARC_ConsoleShell_Destroy</a> (<a class="el" href="../../d9/d4c/structARC__ConsoleShell.html">ARC_ConsoleShell</a> *shell)</td></tr>
<tr class="memdesc:a5e9357a85d39bf8d040cfb4fa19ede06"><td class="mdescLeft">&#160;</td><td class="mdescRight">destroys <a class="el" href="../../d9/d4c/structARC__ConsoleShell.html">ARC_ConsoleShell</a> type <br /></td></tr>
<tr class="separator:a5e9357a85d39bf8d040cfb4fa19ede06"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac73769a7e97b7ba99f74c53347249f63" id="r_ac73769a7e97b7ba99f74c53347249f63"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac73769a7e97b7ba99f74c53347249f63">ARC_ConsoleShell_Update</a> (<a class="el" href="../../d9/d4c/structARC__ConsoleShell.html">ARC_ConsoleShell</a> *shell)</td></tr>
<tr class="memdesc:ac73769a7e97b7ba99f74c53347249f63"><td class="mdescLeft">&#160;</td><td class="mdescRight">updates the <a class="el" href="../../d9/d4c/structARC__ConsoleShell.html">ARC_ConsoleShell</a> type <br /></td></tr>
<tr class="separator:ac73769a7e97b7ba99f74c53347249f63"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a43241a784b1a6a914899b26d9d86c10c" id="r_a43241a784b1a6a914899b26d9d86c10c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a43241a784b1a6a914899b26d9d86c10c">ARC_ConsoleShell_Render</a> (<a class="el" href="../../d9/d4c/structARC__ConsoleShell.html">ARC_ConsoleShell</a> *shell)</td></tr>
<tr class="memdesc:a43241a784b1a6a914899b26d9d86c10c"><td class="mdescLeft">&#160;</td><td class="mdescRight">renders the <a class="el" href="../../d9/d4c/structARC__ConsoleShell.html">ARC_ConsoleShell</a> type <br /></td></tr>
<tr class="separator:a43241a784b1a6a914899b26d9d86c10c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac52159572774e27f8c2e489f73b28314" id="r_ac52159572774e27f8c2e489f73b28314"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac52159572774e27f8c2e489f73b28314">ARC_ConsoleShell_AddHistory</a> (<a class="el" href="../../d9/d4c/structARC__ConsoleShell.html">ARC_ConsoleShell</a> *shell, <a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> *string)</td></tr>
<tr class="memdesc:ac52159572774e27f8c2e489f73b28314"><td class="mdescLeft">&#160;</td><td class="mdescRight">adds history <a class="el" href="../../df/d06/structARC__String.html" title="substring position within a string">ARC_String</a> to <a class="el" href="../../d9/d4c/structARC__ConsoleShell.html">ARC_ConsoleShell</a> <br /></td></tr>
<tr class="separator:ac52159572774e27f8c2e489f73b28314"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a90d4df9f1eba33e1a15c3184621a4805" id="r_a90d4df9f1eba33e1a15c3184621a4805"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a90d4df9f1eba33e1a15c3184621a4805">ARC_ConsoleShell_GetHistoryAt</a> (<a class="el" href="../../d9/d4c/structARC__ConsoleShell.html">ARC_ConsoleShell</a> *shell, uint32_t index)</td></tr>
<tr class="memdesc:a90d4df9f1eba33e1a15c3184621a4805"><td class="mdescLeft">&#160;</td><td class="mdescRight">gets history from <a class="el" href="../../d9/d4c/structARC__ConsoleShell.html">ARC_ConsoleShell</a> <br /></td></tr>
<tr class="separator:a90d4df9f1eba33e1a15c3184621a4805"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="ac52159572774e27f8c2e489f73b28314" name="ac52159572774e27f8c2e489f73b28314"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac52159572774e27f8c2e489f73b28314">&#9670;&#160;</a></span>ARC_ConsoleShell_AddHistory()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_ConsoleShell_AddHistory </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../d9/d4c/structARC__ConsoleShell.html">ARC_ConsoleShell</a> *</td> <td class="paramname"><span class="paramname"><em>shell</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> *</td> <td class="paramname"><span class="paramname"><em>string</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>adds history <a class="el" href="../../df/d06/structARC__String.html" title="substring position within a string">ARC_String</a> to <a class="el" href="../../d9/d4c/structARC__ConsoleShell.html">ARC_ConsoleShell</a> </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">shell</td><td>the <a class="el" href="../../d9/d4c/structARC__ConsoleShell.html">ARC_ConsoleShell</a> to add history to </td></tr>
<tr><td class="paramname">string</td><td>the history string to add to <a class="el" href="../../d9/d4c/structARC__ConsoleShell.html">ARC_ConsoleShell</a> </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="../../d6/d4f/shell_8c_source.html#l00046">46</a> of file <a class="el" href="../../d6/d4f/shell_8c_source.html">shell.c</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 46</span> {</div>
<div class="line"><span class="lineno"> 47</span> <a class="code hl_function" href="../../d6/d68/vector_8h.html#a2a06c8c4c1fc1f99e08568ef92c186ae">ARC_Vector_Add</a>(shell-&gt;<a class="code hl_variable" href="../../d9/d4c/structARC__ConsoleShell.html#a88f6d6daf79f0464766ae1a912eac0fa">history</a>, (<span class="keywordtype">void</span> *)<span class="keywordtype">string</span>);</div>
<div class="line"><span class="lineno"> 48</span>}</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="../../df/d03/shell_8h_source.html#l00034">shell.h:34</a></div></div>
<div class="ttc" id="avector_8h_html_a2a06c8c4c1fc1f99e08568ef92c186ae"><div class="ttname"><a href="../../d6/d68/vector_8h.html#a2a06c8c4c1fc1f99e08568ef92c186ae">ARC_Vector_Add</a></div><div class="ttdeci">void ARC_Vector_Add(ARC_Vector *vector, void *data)</div><div class="ttdoc">adds an item to an ARC_Vector</div><div class="ttdef"><b>Definition</b> <a href="../../df/d6b/src_2std_2vector_8c_source.html#l00070">vector.c:70</a></div></div>
</div><!-- fragment -->
<p class="reference">References <a class="el" href="../../df/d6b/src_2std_2vector_8c_source.html#l00070">ARC_Vector_Add()</a>, and <a class="el" href="../../df/d03/shell_8h_source.html#l00034">ARC_ConsoleShell::history</a>.</p>
</div>
</div>
<a id="aad422f04801c70d2a27f6e30f74efd70" name="aad422f04801c70d2a27f6e30f74efd70"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aad422f04801c70d2a27f6e30f74efd70">&#9670;&#160;</a></span>ARC_ConsoleShell_Create()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_ConsoleShell_Create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../d9/d4c/structARC__ConsoleShell.html">ARC_ConsoleShell</a> **</td> <td class="paramname"><span class="paramname"><em>shell</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../d1/d4a/structARC__ConsoleView.html">ARC_ConsoleView</a> *</td> <td class="paramname"><span class="paramname"><em>view</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../df/d03/shell_8h.html#a896c97abc1c3a02746738b4c0550f48b">ARC_ConsoleShell_UpdateFn</a></td> <td class="paramname"><span class="paramname"><em>updateFn</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>creates <a class="el" href="../../d9/d4c/structARC__ConsoleShell.html">ARC_ConsoleShell</a> type </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">shell</td><td><a class="el" href="../../d9/d4c/structARC__ConsoleShell.html">ARC_ConsoleShell</a> to create </td></tr>
<tr><td class="paramname">view</td><td><a class="el" href="../../d1/d4a/structARC__ConsoleView.html">ARC_ConsoleView</a> to attach the shell to </td></tr>
<tr><td class="paramname">updateFn</td><td>ARC_ConsoleShell_UpdateFn provided that will run the console </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="../../d6/d4f/shell_8c_source.html#l00008">8</a> of file <a class="el" href="../../d6/d4f/shell_8c_source.html">shell.c</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 8</span> {</div>
<div class="line"><span class="lineno"> 9</span> *shell = (<a class="code hl_struct" href="../../d9/d4c/structARC__ConsoleShell.html">ARC_ConsoleShell</a> *)malloc(<span class="keyword">sizeof</span>(<a class="code hl_struct" href="../../d9/d4c/structARC__ConsoleShell.html">ARC_ConsoleShell</a>));</div>
<div class="line"><span class="lineno"> 10</span> </div>
<div class="line"><span class="lineno"> 11</span> (*shell)-&gt;<a class="code hl_variable" href="../../d9/d4c/structARC__ConsoleShell.html#a53d8365cb1119f21f0b23fa1abae8c05">view</a> = view;</div>
<div class="line"><span class="lineno"> 12</span> <a class="code hl_function" href="../../d5/d08/buffer_8h.html#a724aa56dd933bc31502a971204467132">ARC_ConsoleBuffer_Create</a>(&amp;((*shell)-&gt;buffer));</div>
<div class="line"><span class="lineno"> 13</span> (*shell)-&gt;bufferLineIndex = 0;</div>
<div class="line"><span class="lineno"> 14</span> </div>
<div class="line"><span class="lineno"> 15</span> <a class="code hl_function" href="../../d6/d68/vector_8h.html#ac8de583c096684695a7d862c581b78f6">ARC_Vector_Create</a>(&amp;((*shell)-&gt;history));</div>
<div class="line"><span class="lineno"> 16</span> (*shell)-&gt;historyIndex = 0;</div>
<div class="line"><span class="lineno"> 17</span> </div>
<div class="line"><span class="lineno"> 18</span> (*shell)-&gt;updateFn = updateFn;</div>
<div class="line"><span class="lineno"> 19</span> (*shell)-&gt;currentLine = NULL;</div>
<div class="line"><span class="lineno"> 20</span> (*shell)-&gt;userInput = NULL;</div>
<div class="line"><span class="lineno"> 21</span>}</div>
<div class="ttc" id="abuffer_8h_html_a724aa56dd933bc31502a971204467132"><div class="ttname"><a href="../../d5/d08/buffer_8h.html#a724aa56dd933bc31502a971204467132">ARC_ConsoleBuffer_Create</a></div><div class="ttdeci">void ARC_ConsoleBuffer_Create(ARC_ConsoleBuffer **buffer)</div><div class="ttdoc">creates ARC_ConsoleBuffer type</div><div class="ttdef"><b>Definition</b> <a href="../../d3/d8b/buffer_8c_source.html#l00013">buffer.c:13</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="../../df/d03/shell_8h_source.html#l00029">shell.h:29</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="../../df/d03/shell_8h_source.html#l00030">shell.h:30</a></div></div>
<div class="ttc" id="avector_8h_html_ac8de583c096684695a7d862c581b78f6"><div class="ttname"><a href="../../d6/d68/vector_8h.html#ac8de583c096684695a7d862c581b78f6">ARC_Vector_Create</a></div><div class="ttdeci">void ARC_Vector_Create(ARC_Vector **vector, ARC_Vector_CompareDataFn *compareDataFn, ARC_Vector_DestroyDataFn *destroyDataFn)</div><div class="ttdoc">creates an ARC_Vector which is an &quot;expandable&quot; array</div><div class="ttdef"><b>Definition</b> <a href="../../df/d6b/src_2std_2vector_8c_source.html#l00031">vector.c:31</a></div></div>
</div><!-- fragment -->
<p class="reference">References <a class="el" href="../../d3/d8b/buffer_8c_source.html#l00013">ARC_ConsoleBuffer_Create()</a>, <a class="el" href="../../df/d6b/src_2std_2vector_8c_source.html#l00031">ARC_Vector_Create()</a>, and <a class="el" href="../../df/d03/shell_8h_source.html#l00030">ARC_ConsoleShell::view</a>.</p>
</div>
</div>
<a id="a5e9357a85d39bf8d040cfb4fa19ede06" name="a5e9357a85d39bf8d040cfb4fa19ede06"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5e9357a85d39bf8d040cfb4fa19ede06">&#9670;&#160;</a></span>ARC_ConsoleShell_Destroy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_ConsoleShell_Destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../d9/d4c/structARC__ConsoleShell.html">ARC_ConsoleShell</a> *</td> <td class="paramname"><span class="paramname"><em>shell</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>destroys <a class="el" href="../../d9/d4c/structARC__ConsoleShell.html">ARC_ConsoleShell</a> type </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">shell</td><td><a class="el" href="../../d9/d4c/structARC__ConsoleShell.html">ARC_ConsoleShell</a> to destroy </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="../../d6/d4f/shell_8c_source.html#l00023">23</a> of file <a class="el" href="../../d6/d4f/shell_8c_source.html">shell.c</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 23</span> {</div>
<div class="line"><span class="lineno"> 24</span> <a class="code hl_function" href="../../d5/d08/buffer_8h.html#ab2a88c30d33e6d3120d98673fd6beec4">ARC_ConsoleBuffer_Destroy</a>(shell-&gt;<a class="code hl_variable" href="../../d9/d4c/structARC__ConsoleShell.html#a77c4a161dfbf8ad6c6afc18362c3ec66">buffer</a>);</div>
<div class="line"><span class="lineno"> 25</span> </div>
<div class="line"><span class="lineno"> 26</span> <span class="keywordflow">for</span>(uint32_t i = 0; i &lt; ARC_Vector_Size(shell-&gt;<a class="code hl_variable" href="../../d9/d4c/structARC__ConsoleShell.html#a88f6d6daf79f0464766ae1a912eac0fa">history</a>); i++){</div>
<div class="line"><span class="lineno"> 27</span> <a class="code hl_struct" href="../../df/d06/structARC__String.html">ARC_String</a> *temp = (<a class="code hl_struct" href="../../df/d06/structARC__String.html">ARC_String</a> *)<a class="code hl_function" href="../../d6/d68/vector_8h.html#a1b01ba012d6fe295e8ce1446f9a6a3a0">ARC_Vector_Get</a>(shell-&gt;<a class="code hl_variable" href="../../d9/d4c/structARC__ConsoleShell.html#a88f6d6daf79f0464766ae1a912eac0fa">history</a>, i);</div>
<div class="line"><span class="lineno"> 28</span> </div>
<div class="line"><span class="lineno"> 29</span> <span class="keywordflow">if</span>(temp != NULL){</div>
<div class="line"><span class="lineno"> 30</span> <a class="code hl_function" href="../../da/d66/string_8h.html#ac63d17182fd14297f5e7021488d74e35">ARC_String_Destroy</a>(temp);</div>
<div class="line"><span class="lineno"> 31</span> }</div>
<div class="line"><span class="lineno"> 32</span> }</div>
<div class="line"><span class="lineno"> 33</span> </div>
<div class="line"><span class="lineno"> 34</span> <a class="code hl_function" href="../../d6/d68/vector_8h.html#a605bb525f6df05ec88742237e1911e47">ARC_Vector_Destroy</a>(shell-&gt;<a class="code hl_variable" href="../../d9/d4c/structARC__ConsoleShell.html#a88f6d6daf79f0464766ae1a912eac0fa">history</a>);</div>
<div class="line"><span class="lineno"> 35</span> free(shell);</div>
<div class="line"><span class="lineno"> 36</span>}</div>
<div class="ttc" id="abuffer_8h_html_ab2a88c30d33e6d3120d98673fd6beec4"><div class="ttname"><a href="../../d5/d08/buffer_8h.html#ab2a88c30d33e6d3120d98673fd6beec4">ARC_ConsoleBuffer_Destroy</a></div><div class="ttdeci">void ARC_ConsoleBuffer_Destroy(ARC_ConsoleBuffer *buffer)</div><div class="ttdoc">destroys ARC_ConsoleBuffer type</div><div class="ttdef"><b>Definition</b> <a href="../../d3/d8b/buffer_8c_source.html#l00022">buffer.c:22</a></div></div>
<div class="ttc" id="astring_8h_html_ac63d17182fd14297f5e7021488d74e35"><div class="ttname"><a href="../../da/d66/string_8h.html#ac63d17182fd14297f5e7021488d74e35">ARC_String_Destroy</a></div><div class="ttdeci">void ARC_String_Destroy(ARC_String *string)</div><div class="ttdoc">destroys ARC_String type</div><div class="ttdef"><b>Definition</b> <a href="../../d1/db0/string_8c_source.html#l00052">string.c:52</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="../../df/d03/shell_8h_source.html#l00031">shell.h:31</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_a1b01ba012d6fe295e8ce1446f9a6a3a0"><div class="ttname"><a href="../../d6/d68/vector_8h.html#a1b01ba012d6fe295e8ce1446f9a6a3a0">ARC_Vector_Get</a></div><div class="ttdeci">void * ARC_Vector_Get(ARC_Vector *vector, uint32_t index)</div><div class="ttdoc">gets an item from an ARC_Vector at a position index</div><div class="ttdef"><b>Definition</b> <a href="../../df/d6b/src_2std_2vector_8c_source.html#l00153">vector.c:153</a></div></div>
<div class="ttc" id="avector_8h_html_a605bb525f6df05ec88742237e1911e47"><div class="ttname"><a href="../../d6/d68/vector_8h.html#a605bb525f6df05ec88742237e1911e47">ARC_Vector_Destroy</a></div><div class="ttdeci">void ARC_Vector_Destroy(ARC_Vector *vector)</div><div class="ttdoc">destroys an ARC_Vector</div><div class="ttdef"><b>Definition</b> <a href="../../df/d6b/src_2std_2vector_8c_source.html#l00054">vector.c:54</a></div></div>
</div><!-- fragment -->
<p class="reference">References <a class="el" href="../../d3/d8b/buffer_8c_source.html#l00022">ARC_ConsoleBuffer_Destroy()</a>, <a class="el" href="../../d1/db0/string_8c_source.html#l00052">ARC_String_Destroy()</a>, <a class="el" href="../../df/d6b/src_2std_2vector_8c_source.html#l00054">ARC_Vector_Destroy()</a>, <a class="el" href="../../df/d6b/src_2std_2vector_8c_source.html#l00153">ARC_Vector_Get()</a>, <a class="el" href="../../df/d03/shell_8h_source.html#l00031">ARC_ConsoleShell::buffer</a>, and <a class="el" href="../../df/d03/shell_8h_source.html#l00034">ARC_ConsoleShell::history</a>.</p>
</div>
</div>
<a id="a90d4df9f1eba33e1a15c3184621a4805" name="a90d4df9f1eba33e1a15c3184621a4805"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a90d4df9f1eba33e1a15c3184621a4805">&#9670;&#160;</a></span>ARC_ConsoleShell_GetHistoryAt()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> * ARC_ConsoleShell_GetHistoryAt </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../d9/d4c/structARC__ConsoleShell.html">ARC_ConsoleShell</a> *</td> <td class="paramname"><span class="paramname"><em>shell</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t</td> <td class="paramname"><span class="paramname"><em>index</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>gets history from <a class="el" href="../../d9/d4c/structARC__ConsoleShell.html">ARC_ConsoleShell</a> </p>
<dl class="section note"><dt>Note</dt><dd>the index 0 will start from the last added history</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">shell</td><td>the <a class="el" href="../../d9/d4c/structARC__ConsoleShell.html">ARC_ConsoleShell</a> to get history from </td></tr>
<tr><td class="paramname">index</td><td>the location to get history at</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the history as an <a class="el" href="../../df/d06/structARC__String.html" title="substring position within a string">ARC_String</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d6/d4f/shell_8c_source.html#l00050">50</a> of file <a class="el" href="../../d6/d4f/shell_8c_source.html">shell.c</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 50</span> {</div>
<div class="line"><span class="lineno"> 51</span> uint32_t maxHistory = ARC_Vector_Size(shell-&gt;<a class="code hl_variable" href="../../d9/d4c/structARC__ConsoleShell.html#a88f6d6daf79f0464766ae1a912eac0fa">history</a>);</div>
<div class="line"><span class="lineno"> 52</span> <span class="keywordflow">if</span>(index &gt;= maxHistory){</div>
<div class="line"><span class="lineno"> 53</span> <span class="keywordflow">return</span> NULL;</div>
<div class="line"><span class="lineno"> 54</span> }</div>
<div class="line"><span class="lineno"> 55</span> </div>
<div class="line"><span class="lineno"> 56</span> <span class="keywordflow">return</span> (<a class="code hl_struct" href="../../df/d06/structARC__String.html">ARC_String</a> *)<a class="code hl_function" href="../../d6/d68/vector_8h.html#a1b01ba012d6fe295e8ce1446f9a6a3a0">ARC_Vector_Get</a>(shell-&gt;<a class="code hl_variable" href="../../d9/d4c/structARC__ConsoleShell.html#a88f6d6daf79f0464766ae1a912eac0fa">history</a>, (maxHistory - 1) - index);</div>
<div class="line"><span class="lineno"> 57</span>}</div>
</div><!-- fragment -->
<p class="reference">References <a class="el" href="../../df/d6b/src_2std_2vector_8c_source.html#l00153">ARC_Vector_Get()</a>, and <a class="el" href="../../df/d03/shell_8h_source.html#l00034">ARC_ConsoleShell::history</a>.</p>
</div>
</div>
<a id="a43241a784b1a6a914899b26d9d86c10c" name="a43241a784b1a6a914899b26d9d86c10c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a43241a784b1a6a914899b26d9d86c10c">&#9670;&#160;</a></span>ARC_ConsoleShell_Render()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_ConsoleShell_Render </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../d9/d4c/structARC__ConsoleShell.html">ARC_ConsoleShell</a> *</td> <td class="paramname"><span class="paramname"><em>shell</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>renders the <a class="el" href="../../d9/d4c/structARC__ConsoleShell.html">ARC_ConsoleShell</a> type </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">shell</td><td>the <a class="el" href="../../d9/d4c/structARC__ConsoleShell.html">ARC_ConsoleShell</a> to render </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="../../d6/d4f/shell_8c_source.html#l00042">42</a> of file <a class="el" href="../../d6/d4f/shell_8c_source.html">shell.c</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 42</span> {</div>
<div class="line"><span class="lineno"> 43</span> <a class="code hl_function" href="../../d5/d08/buffer_8h.html#a46ebb41d45ba5aeafa12372f69539458">ARC_ConsoleBuffer_Render</a>(shell-&gt;<a class="code hl_variable" href="../../d9/d4c/structARC__ConsoleShell.html#a77c4a161dfbf8ad6c6afc18362c3ec66">buffer</a>, shell-&gt;<a class="code hl_variable" href="../../d9/d4c/structARC__ConsoleShell.html#a53d8365cb1119f21f0b23fa1abae8c05">view</a>);</div>
<div class="line"><span class="lineno"> 44</span>}</div>
<div class="ttc" id="abuffer_8h_html_a46ebb41d45ba5aeafa12372f69539458"><div class="ttname"><a href="../../d5/d08/buffer_8h.html#a46ebb41d45ba5aeafa12372f69539458">ARC_ConsoleBuffer_Render</a></div><div class="ttdeci">void ARC_ConsoleBuffer_Render(ARC_ConsoleBuffer *buffer, ARC_ConsoleView *view)</div><div class="ttdoc">renders a buffer to a ARC_ConsoleView</div><div class="ttdef"><b>Definition</b> <a href="../../d3/d8b/buffer_8c_source.html#l00051">buffer.c:51</a></div></div>
</div><!-- fragment -->
<p class="reference">References <a class="el" href="../../d3/d8b/buffer_8c_source.html#l00051">ARC_ConsoleBuffer_Render()</a>, <a class="el" href="../../df/d03/shell_8h_source.html#l00031">ARC_ConsoleShell::buffer</a>, and <a class="el" href="../../df/d03/shell_8h_source.html#l00030">ARC_ConsoleShell::view</a>.</p>
</div>
</div>
<a id="ac73769a7e97b7ba99f74c53347249f63" name="ac73769a7e97b7ba99f74c53347249f63"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac73769a7e97b7ba99f74c53347249f63">&#9670;&#160;</a></span>ARC_ConsoleShell_Update()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_ConsoleShell_Update </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../d9/d4c/structARC__ConsoleShell.html">ARC_ConsoleShell</a> *</td> <td class="paramname"><span class="paramname"><em>shell</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>updates the <a class="el" href="../../d9/d4c/structARC__ConsoleShell.html">ARC_ConsoleShell</a> type </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">shell</td><td>the <a class="el" href="../../d9/d4c/structARC__ConsoleShell.html">ARC_ConsoleShell</a> to update </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="../../d6/d4f/shell_8c_source.html#l00038">38</a> of file <a class="el" href="../../d6/d4f/shell_8c_source.html">shell.c</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 38</span> {</div>
<div class="line"><span class="lineno"> 39</span> shell-&gt;<a class="code hl_variable" href="../../d9/d4c/structARC__ConsoleShell.html#a950522b4dfb71a19621da6b1077ccbdb">updateFn</a>(shell);</div>
<div class="line"><span class="lineno"> 40</span>}</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="../../df/d03/shell_8h_source.html#l00037">shell.h:37</a></div></div>
</div><!-- fragment -->
<p class="reference">References <a class="el" href="../../df/d03/shell_8h_source.html#l00037">ARC_ConsoleShell::updateFn</a>.</p>
</div>
</div>
</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_93501a11e921083efbd154e0cdff5f10.html">packages</a></li><li class="navelem"><a class="el" href="../../dir_55e5558cfbdbc80ca812673b2b436991.html">console</a></li><li class="navelem"><a class="el" href="../../dir_4eff4d556f090b5df86a0d7e570b70c4.html">ncurses</a></li><li class="navelem"><a class="el" href="../../d6/d4f/shell_8c.html">shell.c</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