| 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.h 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 Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a></div> |
||
| 8 | <h1>cmdline.h File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2> |
||
| 9 | |||
| 10 | <p> |
||
| 11 | Definition in file <a class="el" href="cmdline_8h-source.html">cmdline.h</a>. |
||
| 12 | <p> |
||
| 13 | <code>#include "<a class="el" href="global_8h-source.html">global.h</a>"</code><br> |
||
| 14 | |||
| 15 | <p> |
||
| 16 | <a href="cmdline_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> |
||
| 17 | <tr><td></td></tr> |
||
| 18 | <tr><td colspan="2"><br><h2>Typedefs</h2></td></tr> |
||
| 19 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga0" doxytag="cmdline.h::CmdlineFuncPtrType"></a> |
||
| 20 | typedef void(* </td><td class="memItemRight" valign="bottom"><b>CmdlineFuncPtrType</b> )(void)</td></tr> |
||
| 21 | |||
| 22 | <tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
||
| 23 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga1" doxytag="cmdline.h::cmdlineInit"></a> |
||
| 24 | void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cmdline.html#ga1">cmdlineInit</a> (void)</td></tr> |
||
| 25 | |||
| 26 | <tr><td class="mdescLeft"> </td><td class="mdescRight">initalize the command line system <br></td></tr> |
||
| 27 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga2" doxytag="cmdline.h::cmdlineAddCommand"></a> |
||
| 28 | void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cmdline.html#ga2">cmdlineAddCommand</a> (u08 *newCmdString, CmdlineFuncPtrType newCmdFuncPtr)</td></tr> |
||
| 29 | |||
| 30 | <tr><td class="mdescLeft"> </td><td class="mdescRight">add a new command to the database of known commands <br></td></tr> |
||
| 31 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga3" doxytag="cmdline.h::cmdlineSetOutputFunc"></a> |
||
| 32 | void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cmdline.html#ga3">cmdlineSetOutputFunc</a> (void(*output_func)(unsigned char c))</td></tr> |
||
| 33 | |||
| 34 | <tr><td class="mdescLeft"> </td><td class="mdescRight">sets the function used for sending characters to the user terminal <br></td></tr> |
||
| 35 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga4" doxytag="cmdline.h::cmdlineInputFunc"></a> |
||
| 36 | void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cmdline.html#ga4">cmdlineInputFunc</a> (unsigned char c)</td></tr> |
||
| 37 | |||
| 38 | <tr><td class="mdescLeft"> </td><td class="mdescRight">call this function to pass input charaters from the user terminal <br></td></tr> |
||
| 39 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga5" doxytag="cmdline.h::cmdlineMainLoop"></a> |
||
| 40 | void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cmdline.html#ga5">cmdlineMainLoop</a> (void)</td></tr> |
||
| 41 | |||
| 42 | <tr><td class="mdescLeft"> </td><td class="mdescRight">call this function in your program's main loop <br></td></tr> |
||
| 43 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga6" doxytag="cmdline.h::cmdlineRepaint"></a> |
||
| 44 | void </td><td class="memItemRight" valign="bottom"><b>cmdlineRepaint</b> (void)</td></tr> |
||
| 45 | |||
| 46 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga7" doxytag="cmdline.h::cmdlineDoHistory"></a> |
||
| 47 | void </td><td class="memItemRight" valign="bottom"><b>cmdlineDoHistory</b> (u08 action)</td></tr> |
||
| 48 | |||
| 49 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga8" doxytag="cmdline.h::cmdlineProcessInputString"></a> |
||
| 50 | void </td><td class="memItemRight" valign="bottom"><b>cmdlineProcessInputString</b> (void)</td></tr> |
||
| 51 | |||
| 52 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga9" doxytag="cmdline.h::cmdlinePrintPrompt"></a> |
||
| 53 | void </td><td class="memItemRight" valign="bottom"><b>cmdlinePrintPrompt</b> (void)</td></tr> |
||
| 54 | |||
| 55 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga10" doxytag="cmdline.h::cmdlinePrintError"></a> |
||
| 56 | void </td><td class="memItemRight" valign="bottom"><b>cmdlinePrintError</b> (void)</td></tr> |
||
| 57 | |||
| 58 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga11" doxytag="cmdline.h::cmdlineGetArgStr"></a> |
||
| 59 | u08 * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cmdline.html#ga11">cmdlineGetArgStr</a> (u08 argnum)</td></tr> |
||
| 60 | |||
| 61 | <tr><td class="mdescLeft"> </td><td class="mdescRight">returns a string pointer to argument number [argnum] on the command line <br></td></tr> |
||
| 62 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga12" doxytag="cmdline.h::cmdlineGetArgInt"></a> |
||
| 63 | long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cmdline.html#ga12">cmdlineGetArgInt</a> (u08 argnum)</td></tr> |
||
| 64 | |||
| 65 | <tr><td class="mdescLeft"> </td><td class="mdescRight">returns the decimal integer interpretation of argument number [argnum] <br></td></tr> |
||
| 66 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga13" doxytag="cmdline.h::cmdlineGetArgHex"></a> |
||
| 67 | long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cmdline.html#ga13">cmdlineGetArgHex</a> (u08 argnum)</td></tr> |
||
| 68 | |||
| 69 | <tr><td class="mdescLeft"> </td><td class="mdescRight">returns the hex integer interpretation of argument number [argnum] <br></td></tr> |
||
| 70 | </table> |
||
| 71 | <hr size="1"><address style="align: right;"><small>Generated on Sun Oct 29 03:41:08 2006 for Procyon AVRlib by |
||
| 72 | <a href="http://www.doxygen.org/index.html"> |
||
| 73 | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.2 </small></address> |
||
| 74 | </body> |
||
| 75 | </html> |
Powered by WebSVN v2.8.3