mirror of
https://github.com/taigrr/arduinolibs
synced 2025-01-18 04:33:12 -08:00
282 lines
42 KiB
HTML
282 lines
42 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.6"/>
|
|
<title>ArduinoLibs: 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="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { searchBox.OnSelectItem(0); });
|
|
</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 style="padding-left: 0.5em;">
|
|
<div id="projectname">ArduinoLibs
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.6 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></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_bc0718b08fb2015b8e59c47b2805f60c.html">libraries</a></li><li class="navelem"><a class="el" href="dir_1de32c476debcefedf4aa8bb43bea551.html">Shell</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">Shell.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<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"> * Copyright (C) 2016 Southern Storm Software, Pty Ltd.</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> <span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * copy of this software and associated documentation files (the "Software"),</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * to deal in the Software without restriction, including without limitation</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * the rights to use, copy, modify, merge, publish, distribute, sublicense,</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * and/or sell copies of the Software, and to permit persons to whom the</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * Software is furnished to do so, subject to the following conditions:</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * The above copyright notice and this permission notice shall be included</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * in all copies or substantial portions of the Software.</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER</span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * DEALINGS IN THE SOFTWARE.</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#ifndef SHELL_h</span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor"></span><span class="preprocessor">#define SHELL_h</span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "Terminal.h"</span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <Client.h></span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">class </span><a class="code" href="classShell.html">Shell</a>;</div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">class </span><a class="code" href="classShellArguments.html">ShellArguments</a>;</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">class </span><a class="code" href="classLoginShell.html">LoginShell</a>;</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#if defined(__arm__)</span></div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor"></span><span class="preprocessor">#define SHELL_MAX_CMD_LEN 256</span></div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor"></span><span class="preprocessor">#else</span></div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor"></span><span class="preprocessor">#define SHELL_MAX_CMD_LEN 64</span></div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor"></span><span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">typedef</span> void (*<a class="code" href="classShell.html#ad5bac6a4033cd81e24c1345650bca744">ShellCommandFunc</a>)(<a class="code" href="classShell.html">Shell</a> &shell, <span class="keywordtype">int</span> argc, <span class="keyword">const</span> <a class="code" href="classShellArguments.html">ShellArguments</a> &argv);</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">typedef</span> <span class="keyword">struct</span></div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> {</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *name;</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="classShell.html#a58b0e9104d1f6c7ec7d1663c69cd03dd">help</a>;</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <a class="code" href="classShell.html#ad5bac6a4033cd81e24c1345650bca744">ShellCommandFunc</a> func;</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> } ShellCommandInfo;</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="keyword">class </span>ShellCommandRegister</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> {</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">inline</span> ShellCommandRegister(<span class="keyword">const</span> ShellCommandInfo *_info);</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">const</span> ShellCommandInfo *info;</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  ShellCommandRegister *next;</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 class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="classShell.html"> 62</a></span> <span class="keyword">class </span><a class="code" href="classShell.html">Shell</a> : <span class="keyword">public</span> <a class="code" href="classTerminal.html">Terminal</a></div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> {</div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <a class="code" href="classShell.html#ad613444a902075e8fd26b1f51c4d3b63">Shell</a>();</div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keyword">virtual</span> <a class="code" href="classShell.html#a95f78f499b3dfd9c83f4099cf90ef3df">~Shell</a>();</div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordtype">bool</span> <a class="code" href="classShell.html#ad9acba905b6e0b661cce19d57c067990">begin</a>(Stream &<a class="code" href="classTerminal.html#a18f46590476d5231e9480b5f69a68f63">stream</a>, <span class="keywordtype">size_t</span> maxHistory = 0, <a class="code" href="classTerminal.html#a6fd7d021468962e9604bee0522b3a364">Terminal::Mode</a> <a class="code" href="classTerminal.html#acbf591c7371acba52bcd84ba4a0ce5c8">mode</a> = <a class="code" href="classTerminal.html#a6fd7d021468962e9604bee0522b3a364a7efe0e37dae166c00d913190cd8f55f6">Serial</a>);</div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keywordtype">bool</span> <a class="code" href="classShell.html#ad9acba905b6e0b661cce19d57c067990">begin</a>(Client &client, <span class="keywordtype">size_t</span> maxHistory = 0, <a class="code" href="classTerminal.html#a6fd7d021468962e9604bee0522b3a364">Terminal::Mode</a> <a class="code" href="classTerminal.html#acbf591c7371acba52bcd84ba4a0ce5c8">mode</a> = <a class="code" href="classTerminal.html#a6fd7d021468962e9604bee0522b3a364a71eb4637496b7a884384c4250f3289a7">Telnet</a>);</div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordtype">void</span> <a class="code" href="classShell.html#a8a654aadd0b6a379309bb1007749e41d">end</a>();</div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordtype">void</span> <a class="code" href="classShell.html#afc45cae4ccfc76321a254bb617dce08c">loop</a>();</div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classShell.html#a03dfba66a0125a8c02dd71b3f3b37870">registerCommand</a>(ShellCommandRegister *cmd);</div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"><a class="line" href="classShell.html#af4a335f97bc888a25f7e54f2a025c11c"> 76</a></span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="classShell.html#af4a335f97bc888a25f7e54f2a025c11c">prompt</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> prom; }</div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="classShell.html#a89d802eae5b716e80b2c4dfbce0a0a75"> 77</a></span>  <span class="keywordtype">void</span> <a class="code" href="classShell.html#a89d802eae5b716e80b2c4dfbce0a0a75">setPrompt</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="classShell.html#af4a335f97bc888a25f7e54f2a025c11c">prompt</a>) { prom = <a class="code" href="classShell.html#af4a335f97bc888a25f7e54f2a025c11c">prompt</a>; }</div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"><a class="line" href="classShell.html#a6ae6e1af0a7f6116e6a9a1e658fb9a84"> 79</a></span>  <span class="keywordtype">int</span> <a class="code" href="classShell.html#a6ae6e1af0a7f6116e6a9a1e658fb9a84">userid</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> uid; }</div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"><a class="line" href="classShell.html#a5db7316a4feb9829beea11dfe65462d2"> 80</a></span>  <span class="keywordtype">void</span> <a class="code" href="classShell.html#a5db7316a4feb9829beea11dfe65462d2">setUserid</a>(<span class="keywordtype">int</span> <a class="code" href="classShell.html#a6ae6e1af0a7f6116e6a9a1e658fb9a84">userid</a>) { uid = <a class="code" href="classShell.html#a6ae6e1af0a7f6116e6a9a1e658fb9a84">userid</a>; }</div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keywordtype">void</span> <a class="code" href="classShell.html#a58b0e9104d1f6c7ec7d1663c69cd03dd">help</a>();</div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordtype">void</span> <a class="code" href="classShell.html#ab9dab65bc0757ce3bb0ac926bbefcee3">exit</a>();</div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="keyword">protected</span>:</div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classShell.html#a3ad32b7cd3b48c78953ab9f7384d5a58">beginSession</a>();</div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classShell.html#a720144957bf6462659017cc25c429beb">printPrompt</a>();</div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classShell.html#ab4a3f80dc5ff779ac99116a1f7e35cda">execute</a>();</div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keywordtype">char</span> buffer[SHELL_MAX_CMD_LEN];</div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keywordtype">size_t</span> curStart;</div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keywordtype">size_t</span> curLen;</div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keywordtype">size_t</span> curMax;</div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keywordtype">char</span> *history;</div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordtype">size_t</span> historyWrite;</div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keywordtype">size_t</span> historyRead;</div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keywordtype">size_t</span> historySize;</div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *prom;</div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keywordtype">bool</span> isClient;</div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  uint8_t lineMode;</div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keywordtype">int</span> uid;</div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> timer;</div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="comment">// Disable copy constructor and operator=().</span></div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <a class="code" href="classShell.html#ad613444a902075e8fd26b1f51c4d3b63">Shell</a>(<span class="keyword">const</span> <a class="code" href="classShell.html">Shell</a> &other) {}</div>
|
|
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <a class="code" href="classShell.html">Shell</a> &operator=(<span class="keyword">const</span> <a class="code" href="classShell.html">Shell</a> &) { <span class="keywordflow">return</span> *<span class="keyword">this</span>; }</div>
|
|
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> </div>
|
|
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="keywordtype">bool</span> beginShell(Stream &stream, <span class="keywordtype">size_t</span> maxHistory, <a class="code" href="classTerminal.html#a6fd7d021468962e9604bee0522b3a364">Terminal::Mode</a> <a class="code" href="classTerminal.html#acbf591c7371acba52bcd84ba4a0ce5c8">mode</a>);</div>
|
|
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keywordtype">bool</span> <a class="code" href="classShell.html#ab4a3f80dc5ff779ac99116a1f7e35cda">execute</a>(<span class="keyword">const</span> <a class="code" href="classShellArguments.html">ShellArguments</a> &argv);</div>
|
|
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="keywordtype">void</span> executeBuiltin(<span class="keyword">const</span> <span class="keywordtype">char</span> *cmd);</div>
|
|
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="keywordtype">void</span> clearCharacters(<span class="keywordtype">size_t</span> len);</div>
|
|
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keywordtype">void</span> changeHistory(<span class="keywordtype">bool</span> up);</div>
|
|
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="keywordtype">void</span> clearHistory();</div>
|
|
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> </div>
|
|
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classLoginShell.html">LoginShell</a>;</div>
|
|
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> };</div>
|
|
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> </div>
|
|
<div class="line"><a name="l00119"></a><span class="lineno"><a class="line" href="classShellArguments.html"> 119</a></span> <span class="keyword">class </span><a class="code" href="classShellArguments.html">ShellArguments</a></div>
|
|
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> {</div>
|
|
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classShell.html">Shell</a>;</div>
|
|
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <a class="code" href="classShellArguments.html">ShellArguments</a>(<span class="keywordtype">char</span> *buffer, <span class="keywordtype">size_t</span> len);</div>
|
|
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  ~<a class="code" href="classShellArguments.html">ShellArguments</a>() {}</div>
|
|
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span> </div>
|
|
<div class="line"><a name="l00127"></a><span class="lineno"><a class="line" href="classShellArguments.html#ad1d8f103c645bc280e518f2522a62cc1"> 127</a></span>  <span class="keywordtype">int</span> <a class="code" href="classShellArguments.html#ad1d8f103c645bc280e518f2522a62cc1">count</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> argc; }</div>
|
|
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="classShellArguments.html#a1308c90889e9341f07986b4b256acc16">operator[]</a>(<span class="keywordtype">int</span> index) <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> </div>
|
|
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *line;</div>
|
|
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="keywordtype">size_t</span> size;</div>
|
|
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <span class="keywordtype">int</span> argc;</div>
|
|
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <span class="keyword">mutable</span> <span class="keywordtype">int</span> currentIndex;</div>
|
|
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <span class="keyword">mutable</span> <span class="keywordtype">size_t</span> currentPosn;</div>
|
|
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> </div>
|
|
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="comment">// Disable copy constructor and operator=().</span></div>
|
|
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  <a class="code" href="classShellArguments.html">ShellArguments</a>(<span class="keyword">const</span> <a class="code" href="classShellArguments.html">ShellArguments</a> &other) {}</div>
|
|
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  <a class="code" href="classShellArguments.html">ShellArguments</a> &operator=(<span class="keyword">const</span> <a class="code" href="classShellArguments.html">ShellArguments</a> &) { <span class="keywordflow">return</span> *<span class="keyword">this</span>; }</div>
|
|
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> };</div>
|
|
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> </div>
|
|
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="keyword">inline</span> ShellCommandRegister::ShellCommandRegister(<span class="keyword">const</span> ShellCommandInfo *_info)</div>
|
|
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  : info(_info)</div>
|
|
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  , next(0)</div>
|
|
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> {</div>
|
|
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <a class="code" href="classShell.html#a03dfba66a0125a8c02dd71b3f3b37870">Shell::registerCommand</a>(<span class="keyword">this</span>);</div>
|
|
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span> }</div>
|
|
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span> </div>
|
|
<div class="line"><a name="l00153"></a><span class="lineno"><a class="line" href="classShell.html#a809d96cf913bf11d02f3c0d51a120740"> 153</a></span> <span class="preprocessor">#define ShellCommand(name,help,function) \</span></div>
|
|
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="preprocessor"> static char const shell_id_##name[] PROGMEM = #name; \</span></div>
|
|
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="preprocessor"> static char const shell_help_##name[] PROGMEM = help; \</span></div>
|
|
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="preprocessor"> static ShellCommandInfo const shell_info_##name PROGMEM = { \</span></div>
|
|
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="preprocessor"> shell_id_##name, \</span></div>
|
|
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="preprocessor"> shell_help_##name, \</span></div>
|
|
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="preprocessor"> (function) \</span></div>
|
|
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="preprocessor"> }; \</span></div>
|
|
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="preprocessor"> static ShellCommandRegister shell_cmd_##name(&shell_info_##name)</span></div>
|
|
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="ttc" id="classShellArguments_html_a1308c90889e9341f07986b4b256acc16"><div class="ttname"><a href="classShellArguments.html#a1308c90889e9341f07986b4b256acc16">ShellArguments::operator[]</a></div><div class="ttdeci">const char * operator[](int index) const </div><div class="ttdoc">Gets a specific argument for the command. </div><div class="ttdef"><b>Definition:</b> <a href="Shell_8cpp_source.html#l00927">Shell.cpp:927</a></div></div>
|
|
<div class="ttc" id="classShell_html_a3ad32b7cd3b48c78953ab9f7384d5a58"><div class="ttname"><a href="classShell.html#a3ad32b7cd3b48c78953ab9f7384d5a58">Shell::beginSession</a></div><div class="ttdeci">virtual void beginSession()</div><div class="ttdoc">Begins a login session. </div><div class="ttdef"><b>Definition:</b> <a href="Shell_8cpp_source.html#l00594">Shell.cpp:594</a></div></div>
|
|
<div class="ttc" id="classShell_html_a58b0e9104d1f6c7ec7d1663c69cd03dd"><div class="ttname"><a href="classShell.html#a58b0e9104d1f6c7ec7d1663c69cd03dd">Shell::help</a></div><div class="ttdeci">void help()</div><div class="ttdoc">Displays help for all supported commands. </div><div class="ttdef"><b>Definition:</b> <a href="Shell_8cpp_source.html#l00542">Shell.cpp:542</a></div></div>
|
|
<div class="ttc" id="classShell_html_ad9acba905b6e0b661cce19d57c067990"><div class="ttname"><a href="classShell.html#ad9acba905b6e0b661cce19d57c067990">Shell::begin</a></div><div class="ttdeci">bool begin(Stream &stream, size_t maxHistory=0, Terminal::Mode mode=Serial)</div><div class="ttdoc">Begin shell handling on an underlying character stream. </div><div class="ttdef"><b>Definition:</b> <a href="Shell_8cpp_source.html#l00176">Shell.cpp:176</a></div></div>
|
|
<div class="ttc" id="classShell_html_a720144957bf6462659017cc25c429beb"><div class="ttname"><a href="classShell.html#a720144957bf6462659017cc25c429beb">Shell::printPrompt</a></div><div class="ttdeci">virtual void printPrompt()</div><div class="ttdoc">Prints the current prompt string. </div><div class="ttdef"><b>Definition:</b> <a href="Shell_8cpp_source.html#l00603">Shell.cpp:603</a></div></div>
|
|
<div class="ttc" id="classShell_html_a03dfba66a0125a8c02dd71b3f3b37870"><div class="ttname"><a href="classShell.html#a03dfba66a0125a8c02dd71b3f3b37870">Shell::registerCommand</a></div><div class="ttdeci">static void registerCommand(ShellCommandRegister *cmd)</div><div class="ttdoc">Registers a command with the shell. </div><div class="ttdef"><b>Definition:</b> <a href="Shell_8cpp_source.html#l00472">Shell.cpp:472</a></div></div>
|
|
<div class="ttc" id="classTerminal_html_a6fd7d021468962e9604bee0522b3a364a7efe0e37dae166c00d913190cd8f55f6"><div class="ttname"><a href="classTerminal.html#a6fd7d021468962e9604bee0522b3a364a7efe0e37dae166c00d913190cd8f55f6">Terminal::Serial</a></div><div class="ttdoc">Operates the terminal in serial mode. </div><div class="ttdef"><b>Definition:</b> <a href="Terminal_8h_source.html#l00044">Terminal.h:44</a></div></div>
|
|
<div class="ttc" id="classShell_html_ab9dab65bc0757ce3bb0ac926bbefcee3"><div class="ttname"><a href="classShell.html#ab9dab65bc0757ce3bb0ac926bbefcee3">Shell::exit</a></div><div class="ttdeci">void exit()</div><div class="ttdoc">Exit from the shell back to the login prompt. </div><div class="ttdef"><b>Definition:</b> <a href="Shell_8cpp_source.html#l00577">Shell.cpp:577</a></div></div>
|
|
<div class="ttc" id="classTerminal_html_a6fd7d021468962e9604bee0522b3a364a71eb4637496b7a884384c4250f3289a7"><div class="ttname"><a href="classTerminal.html#a6fd7d021468962e9604bee0522b3a364a71eb4637496b7a884384c4250f3289a7">Terminal::Telnet</a></div><div class="ttdoc">Operates the terminal in telnet mode. </div><div class="ttdef"><b>Definition:</b> <a href="Terminal_8h_source.html#l00045">Terminal.h:45</a></div></div>
|
|
<div class="ttc" id="classTerminal_html_acbf591c7371acba52bcd84ba4a0ce5c8"><div class="ttname"><a href="classTerminal.html#acbf591c7371acba52bcd84ba4a0ce5c8">Terminal::mode</a></div><div class="ttdeci">Terminal::Mode mode() const </div><div class="ttdoc">Returns the mode this terminal is operating in, Serial or Telnet. </div><div class="ttdef"><b>Definition:</b> <a href="Terminal_8h_source.html#l00052">Terminal.h:52</a></div></div>
|
|
<div class="ttc" id="classShell_html_afc45cae4ccfc76321a254bb617dce08c"><div class="ttname"><a href="classShell.html#afc45cae4ccfc76321a254bb617dce08c">Shell::loop</a></div><div class="ttdeci">void loop()</div><div class="ttdoc">Performs regular activities on the shell. </div><div class="ttdef"><b>Definition:</b> <a href="Shell_8cpp_source.html#l00294">Shell.cpp:294</a></div></div>
|
|
<div class="ttc" id="classShell_html_a89d802eae5b716e80b2c4dfbce0a0a75"><div class="ttname"><a href="classShell.html#a89d802eae5b716e80b2c4dfbce0a0a75">Shell::setPrompt</a></div><div class="ttdeci">void setPrompt(const char *prompt)</div><div class="ttdoc">Sets the prompt string to display in the shell. </div><div class="ttdef"><b>Definition:</b> <a href="Shell_8h_source.html#l00077">Shell.h:77</a></div></div>
|
|
<div class="ttc" id="classTerminal_html"><div class="ttname"><a href="classTerminal.html">Terminal</a></div><div class="ttdoc">Extended stream interface for terminal operations. </div><div class="ttdef"><b>Definition:</b> <a href="Terminal_8h_source.html#l00036">Terminal.h:36</a></div></div>
|
|
<div class="ttc" id="classShell_html_ad613444a902075e8fd26b1f51c4d3b63"><div class="ttname"><a href="classShell.html#ad613444a902075e8fd26b1f51c4d3b63">Shell::Shell</a></div><div class="ttdeci">Shell()</div><div class="ttdoc">Constructs a new Shell instance. </div><div class="ttdef"><b>Definition:</b> <a href="Shell_8cpp_source.html#l00122">Shell.cpp:122</a></div></div>
|
|
<div class="ttc" id="classTerminal_html_a6fd7d021468962e9604bee0522b3a364"><div class="ttname"><a href="classTerminal.html#a6fd7d021468962e9604bee0522b3a364">Terminal::Mode</a></div><div class="ttdeci">Mode</div><div class="ttdoc">Mode to operate in, Serial or Telnet. </div><div class="ttdef"><b>Definition:</b> <a href="Terminal_8h_source.html#l00042">Terminal.h:42</a></div></div>
|
|
<div class="ttc" id="classTerminal_html_a18f46590476d5231e9480b5f69a68f63"><div class="ttname"><a href="classTerminal.html#a18f46590476d5231e9480b5f69a68f63">Terminal::stream</a></div><div class="ttdeci">Stream * stream() const </div><div class="ttdoc">Returns a pointer to the underlying Stream, or NULL if the stream has not been set with begin() yet...</div><div class="ttdef"><b>Definition:</b> <a href="Terminal_8h_source.html#l00051">Terminal.h:51</a></div></div>
|
|
<div class="ttc" id="classShell_html_ad5bac6a4033cd81e24c1345650bca744"><div class="ttname"><a href="classShell.html#ad5bac6a4033cd81e24c1345650bca744">Shell::ShellCommandFunc</a></div><div class="ttdeci">ShellCommandFunc</div><div class="ttdoc">Type of functions that provide shell command handlers. </div></div>
|
|
<div class="ttc" id="classShellArguments_html_ad1d8f103c645bc280e518f2522a62cc1"><div class="ttname"><a href="classShellArguments.html#ad1d8f103c645bc280e518f2522a62cc1">ShellArguments::count</a></div><div class="ttdeci">int count() const </div><div class="ttdoc">Returns the number of arguments, including the name of the command. </div><div class="ttdef"><b>Definition:</b> <a href="Shell_8h_source.html#l00127">Shell.h:127</a></div></div>
|
|
<div class="ttc" id="classShell_html_af4a335f97bc888a25f7e54f2a025c11c"><div class="ttname"><a href="classShell.html#af4a335f97bc888a25f7e54f2a025c11c">Shell::prompt</a></div><div class="ttdeci">const char * prompt() const </div><div class="ttdoc">Gets the prompt string to display in the shell. </div><div class="ttdef"><b>Definition:</b> <a href="Shell_8h_source.html#l00076">Shell.h:76</a></div></div>
|
|
<div class="ttc" id="classShell_html_a5db7316a4feb9829beea11dfe65462d2"><div class="ttname"><a href="classShell.html#a5db7316a4feb9829beea11dfe65462d2">Shell::setUserid</a></div><div class="ttdeci">void setUserid(int userid)</div><div class="ttdoc">Sets the user identifier for the currently logged in user. </div><div class="ttdef"><b>Definition:</b> <a href="Shell_8h_source.html#l00080">Shell.h:80</a></div></div>
|
|
<div class="ttc" id="classShell_html_ab4a3f80dc5ff779ac99116a1f7e35cda"><div class="ttname"><a href="classShell.html#ab4a3f80dc5ff779ac99116a1f7e35cda">Shell::execute</a></div><div class="ttdeci">virtual void execute()</div><div class="ttdoc">Executes the command in the buffer. </div><div class="ttdef"><b>Definition:</b> <a href="Shell_8cpp_source.html#l00613">Shell.cpp:613</a></div></div>
|
|
<div class="ttc" id="classShellArguments_html"><div class="ttname"><a href="classShellArguments.html">ShellArguments</a></div><div class="ttdoc">Convenience class that encapsulates an array of shell command arguments. </div><div class="ttdef"><b>Definition:</b> <a href="Shell_8h_source.html#l00119">Shell.h:119</a></div></div>
|
|
<div class="ttc" id="classLoginShell_html"><div class="ttname"><a href="classLoginShell.html">LoginShell</a></div><div class="ttdoc">Command-line shell access via a login shell. </div><div class="ttdef"><b>Definition:</b> <a href="LoginShell_8h_source.html#l00030">LoginShell.h:30</a></div></div>
|
|
<div class="ttc" id="classShell_html_a8a654aadd0b6a379309bb1007749e41d"><div class="ttname"><a href="classShell.html#a8a654aadd0b6a379309bb1007749e41d">Shell::end</a></div><div class="ttdeci">void end()</div><div class="ttdoc">Ends shell processing on the underlying stream. </div><div class="ttdef"><b>Definition:</b> <a href="Shell_8cpp_source.html#l00262">Shell.cpp:262</a></div></div>
|
|
<div class="ttc" id="classShell_html_a95f78f499b3dfd9c83f4099cf90ef3df"><div class="ttname"><a href="classShell.html#a95f78f499b3dfd9c83f4099cf90ef3df">Shell::~Shell</a></div><div class="ttdeci">virtual ~Shell()</div><div class="ttdoc">Destroys this Shell object. </div><div class="ttdef"><b>Definition:</b> <a href="Shell_8cpp_source.html#l00141">Shell.cpp:141</a></div></div>
|
|
<div class="ttc" id="classShell_html"><div class="ttname"><a href="classShell.html">Shell</a></div><div class="ttdoc">Command-line shell access. </div><div class="ttdef"><b>Definition:</b> <a href="Shell_8h_source.html#l00062">Shell.h:62</a></div></div>
|
|
<div class="ttc" id="classShell_html_a6ae6e1af0a7f6116e6a9a1e658fb9a84"><div class="ttname"><a href="classShell.html#a6ae6e1af0a7f6116e6a9a1e658fb9a84">Shell::userid</a></div><div class="ttdeci">int userid() const </div><div class="ttdoc">Gets the user identifier for the currently logged in user, or -1 if there is no user logged in curren...</div><div class="ttdef"><b>Definition:</b> <a href="Shell_8h_source.html#l00079">Shell.h:79</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Sat Aug 27 2016 14:32:20 for ArduinoLibs by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.6
|
|
</small></address>
|
|
</body>
|
|
</html>
|