?lang_form? ?lang_select? ?lang_submit? ?lang_endform?
{HEADER END}
{BLAME START}

library

?curdirlinks? -

Blame information for rev 6

Line No. Rev Author Line
1 6 kaklik <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3 <title>Procyon AVRlib: cmdline.c File Reference</title>
4 <link href="dox.css" rel="stylesheet" type="text/css">
5 </head><body>
6 <!-- Generated by Doxygen 1.4.2 -->
7 <div class="qindex"><a class="qindex" href="main.html">Main&nbsp;Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Data&nbsp;Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Data&nbsp;Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
8 <h1>cmdline.c File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
9  
10 <p>
11 Definition in file <a class="el" href="cmdline_8c-source.html">cmdline.c</a>.
12 <p>
13 <code>#include &lt;avr/io.h&gt;</code><br>
14 <code>#include &lt;avr/interrupt.h&gt;</code><br>
15 <code>#include &lt;avr/pgmspace.h&gt;</code><br>
16 <code>#include &lt;string.h&gt;</code><br>
17 <code>#include &lt;stdlib.h&gt;</code><br>
18 <code>#include "<a class="el" href="global_8h-source.html">global.h</a>"</code><br>
19 <code>#include "<a class="el" href="cmdline_8h-source.html">cmdline.h</a>"</code><br>
20 <code>#include "<a class="el" href="cmdlineconf_8h-source.html">cmdlineconf.h</a>"</code><br>
21  
22 <p>
23 <a href="cmdline_8c-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
24 <tr><td></td></tr>
25 <tr><td colspan="2"><br><h2>Defines</h2></td></tr>
26 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a0" doxytag="cmdline.c::ASCII_BEL"></a>
27 #define&nbsp;</td><td class="memItemRight" valign="bottom"><b>ASCII_BEL</b>&nbsp;&nbsp;&nbsp;0x07</td></tr>
28  
29 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1" doxytag="cmdline.c::ASCII_BS"></a>
30 #define&nbsp;</td><td class="memItemRight" valign="bottom"><b>ASCII_BS</b>&nbsp;&nbsp;&nbsp;0x08</td></tr>
31  
32 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2" doxytag="cmdline.c::ASCII_CR"></a>
33 #define&nbsp;</td><td class="memItemRight" valign="bottom"><b>ASCII_CR</b>&nbsp;&nbsp;&nbsp;0x0D</td></tr>
34  
35 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3" doxytag="cmdline.c::ASCII_LF"></a>
36 #define&nbsp;</td><td class="memItemRight" valign="bottom"><b>ASCII_LF</b>&nbsp;&nbsp;&nbsp;0x0A</td></tr>
37  
38 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4" doxytag="cmdline.c::ASCII_ESC"></a>
39 #define&nbsp;</td><td class="memItemRight" valign="bottom"><b>ASCII_ESC</b>&nbsp;&nbsp;&nbsp;0x1B</td></tr>
40  
41 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a5" doxytag="cmdline.c::ASCII_DEL"></a>
42 #define&nbsp;</td><td class="memItemRight" valign="bottom"><b>ASCII_DEL</b>&nbsp;&nbsp;&nbsp;0x7F</td></tr>
43  
44 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6" doxytag="cmdline.c::VT100_ARROWUP"></a>
45 #define&nbsp;</td><td class="memItemRight" valign="bottom"><b>VT100_ARROWUP</b>&nbsp;&nbsp;&nbsp;'A'</td></tr>
46  
47 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a7" doxytag="cmdline.c::VT100_ARROWDOWN"></a>
48 #define&nbsp;</td><td class="memItemRight" valign="bottom"><b>VT100_ARROWDOWN</b>&nbsp;&nbsp;&nbsp;'B'</td></tr>
49  
50 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a8" doxytag="cmdline.c::VT100_ARROWRIGHT"></a>
51 #define&nbsp;</td><td class="memItemRight" valign="bottom"><b>VT100_ARROWRIGHT</b>&nbsp;&nbsp;&nbsp;'C'</td></tr>
52  
53 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a9" doxytag="cmdline.c::VT100_ARROWLEFT"></a>
54 #define&nbsp;</td><td class="memItemRight" valign="bottom"><b>VT100_ARROWLEFT</b>&nbsp;&nbsp;&nbsp;'D'</td></tr>
55  
56 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a10" doxytag="cmdline.c::CMDLINE_HISTORY_SAVE"></a>
57 #define&nbsp;</td><td class="memItemRight" valign="bottom"><b>CMDLINE_HISTORY_SAVE</b>&nbsp;&nbsp;&nbsp;0</td></tr>
58  
59 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a11" doxytag="cmdline.c::CMDLINE_HISTORY_PREV"></a>
60 #define&nbsp;</td><td class="memItemRight" valign="bottom"><b>CMDLINE_HISTORY_PREV</b>&nbsp;&nbsp;&nbsp;1</td></tr>
61  
62 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a12" doxytag="cmdline.c::CMDLINE_HISTORY_NEXT"></a>
63 #define&nbsp;</td><td class="memItemRight" valign="bottom"><b>CMDLINE_HISTORY_NEXT</b>&nbsp;&nbsp;&nbsp;2</td></tr>
64  
65 <tr><td colspan="2"><br><h2>Functions</h2></td></tr>
66 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga1" doxytag="cmdline.c::cmdlineInit"></a>
67 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__cmdline.html#ga1">cmdlineInit</a> (void)</td></tr>
68  
69 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">initalize the command line system <br></td></tr>
70 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga2" doxytag="cmdline.c::cmdlineAddCommand"></a>
71 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__cmdline.html#ga2">cmdlineAddCommand</a> (u08 *newCmdString, CmdlineFuncPtrType newCmdFuncPtr)</td></tr>
72  
73 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">add a new command to the database of known commands <br></td></tr>
74 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga3" doxytag="cmdline.c::cmdlineSetOutputFunc"></a>
75 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__cmdline.html#ga3">cmdlineSetOutputFunc</a> (void(*output_func)(unsigned char c))</td></tr>
76  
77 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">sets the function used for sending characters to the user terminal <br></td></tr>
78 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga4" doxytag="cmdline.c::cmdlineInputFunc"></a>
79 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__cmdline.html#ga4">cmdlineInputFunc</a> (unsigned char c)</td></tr>
80  
81 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">call this function to pass input charaters from the user terminal <br></td></tr>
82 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga6" doxytag="cmdline.c::cmdlineRepaint"></a>
83 void&nbsp;</td><td class="memItemRight" valign="bottom"><b>cmdlineRepaint</b> (void)</td></tr>
84  
85 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga7" doxytag="cmdline.c::cmdlineDoHistory"></a>
86 void&nbsp;</td><td class="memItemRight" valign="bottom"><b>cmdlineDoHistory</b> (u08 action)</td></tr>
87  
88 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga8" doxytag="cmdline.c::cmdlineProcessInputString"></a>
89 void&nbsp;</td><td class="memItemRight" valign="bottom"><b>cmdlineProcessInputString</b> (void)</td></tr>
90  
91 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga5" doxytag="cmdline.c::cmdlineMainLoop"></a>
92 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__cmdline.html#ga5">cmdlineMainLoop</a> (void)</td></tr>
93  
94 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">call this function in your program's main loop <br></td></tr>
95 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga9" doxytag="cmdline.c::cmdlinePrintPrompt"></a>
96 void&nbsp;</td><td class="memItemRight" valign="bottom"><b>cmdlinePrintPrompt</b> (void)</td></tr>
97  
98 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga10" doxytag="cmdline.c::cmdlinePrintError"></a>
99 void&nbsp;</td><td class="memItemRight" valign="bottom"><b>cmdlinePrintError</b> (void)</td></tr>
100  
101 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga11" doxytag="cmdline.c::cmdlineGetArgStr"></a>
102 u08 *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__cmdline.html#ga11">cmdlineGetArgStr</a> (u08 argnum)</td></tr>
103  
104 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns a string pointer to argument number [argnum] on the command line <br></td></tr>
105 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga12" doxytag="cmdline.c::cmdlineGetArgInt"></a>
106 long&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__cmdline.html#ga12">cmdlineGetArgInt</a> (u08 argnum)</td></tr>
107  
108 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns the decimal integer interpretation of argument number [argnum] <br></td></tr>
109 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga13" doxytag="cmdline.c::cmdlineGetArgHex"></a>
110 long&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__cmdline.html#ga13">cmdlineGetArgHex</a> (u08 argnum)</td></tr>
111  
112 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns the hex integer interpretation of argument number [argnum] <br></td></tr>
113 <tr><td colspan="2"><br><h2>Variables</h2></td></tr>
114 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a13" doxytag="cmdline.c::CmdlinePrompt"></a>
115 u08 PROGMEM&nbsp;</td><td class="memItemRight" valign="bottom"><b>CmdlinePrompt</b> [] = "cmd&gt;"</td></tr>
116  
117 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a14" doxytag="cmdline.c::CmdlineNotice"></a>
118 u08 PROGMEM&nbsp;</td><td class="memItemRight" valign="bottom"><b>CmdlineNotice</b> [] = "cmdline: "</td></tr>
119  
120 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a15" doxytag="cmdline.c::CmdlineCmdNotFound"></a>
121 u08 PROGMEM&nbsp;</td><td class="memItemRight" valign="bottom"><b>CmdlineCmdNotFound</b> [] = "command not found"</td></tr>
122  
123 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a18" doxytag="cmdline.c::CmdlineNumCommands"></a>
124 u08&nbsp;</td><td class="memItemRight" valign="bottom"><b>CmdlineNumCommands</b></td></tr>
125  
126 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a19" doxytag="cmdline.c::CmdlineBuffer"></a>
127 u08&nbsp;</td><td class="memItemRight" valign="bottom"><b>CmdlineBuffer</b> [CMDLINE_BUFFERSIZE]</td></tr>
128  
129 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a20" doxytag="cmdline.c::CmdlineBufferLength"></a>
130 u08&nbsp;</td><td class="memItemRight" valign="bottom"><b>CmdlineBufferLength</b></td></tr>
131  
132 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a21" doxytag="cmdline.c::CmdlineBufferEditPos"></a>
133 u08&nbsp;</td><td class="memItemRight" valign="bottom"><b>CmdlineBufferEditPos</b></td></tr>
134  
135 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a22" doxytag="cmdline.c::CmdlineInputVT100State"></a>
136 u08&nbsp;</td><td class="memItemRight" valign="bottom"><b>CmdlineInputVT100State</b></td></tr>
137  
138 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a23" doxytag="cmdline.c::CmdlineHistory"></a>
139 u08&nbsp;</td><td class="memItemRight" valign="bottom"><b>CmdlineHistory</b> [CMDLINE_HISTORYSIZE][CMDLINE_BUFFERSIZE]</td></tr>
140  
141 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a24" doxytag="cmdline.c::CmdlineExecFunction"></a>
142 CmdlineFuncPtrType&nbsp;</td><td class="memItemRight" valign="bottom"><b>CmdlineExecFunction</b></td></tr>
143  
144 </table>
145 <hr size="1"><address style="align: right;"><small>Generated on Sun Oct 29 03:41:08 2006 for Procyon AVRlib by&nbsp;
146 <a href="http://www.doxygen.org/index.html">
147 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.2 </small></address>
148 </body>
149 </html>
{BLAME END}
{FOOTER START}

Powered by WebSVN v2.8.3