📄 cmdline_8h-source.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"><title>Procyon AVRlib: cmdline.h Source File</title><link href="dox.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.3.6 --><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="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a></div><h1>cmdline.h</h1><a href="cmdline_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <span class="comment">/*! \file cmdline.h \brief Command-Line Interface Library. */</span>00002 <span class="comment">//*****************************************************************************</span>00003 <span class="comment">//</span>00004 <span class="comment">// File Name : 'cmdline.h'</span>00005 <span class="comment">// Title : Command-Line Interface Library</span>00006 <span class="comment">// Author : Pascal Stang - Copyright (C) 2003</span>00007 <span class="comment">// Created : 2003.07.16</span>00008 <span class="comment">// Revised : 2003.07.16</span>00009 <span class="comment">// Version : 0.1</span>00010 <span class="comment">// Target MCU : Atmel AVR Series</span>00011 <span class="comment">// Editor Tabs : 4</span>00012 <span class="comment">//</span>00013 <span class="comment">// Description :</span>00014 <span class="comment">// This Command-Line interface library is meant to provide a reusable</span>00015 <span class="comment">// terminal-like user interface much like a DOS command line or UNIX terminal.</span>00016 <span class="comment">//</span>00017 <span class="comment">// The cmdline library does the following things for you:</span>00018 <span class="comment">// -Prints command prompts</span>00019 <span class="comment">// -Gathers a command string from the user (with editing features)</span>00020 <span class="comment">// -Parses the command string when the user presses [ENTER]</span>00021 <span class="comment">// -Compares the entered command to the command database</span>00022 <span class="comment">// \-Executes the corresponding function if a match is found</span>00023 <span class="comment">// \-Reports an error if no match is found</span>00024 <span class="comment">// -Provides functions to retrieve the command arguments:</span>00025 <span class="comment">// \-as strings</span>00026 <span class="comment">// \-as decimal integers</span>00027 <span class="comment">// \-as hex integers</span>00028 <span class="comment">//</span>00029 <span class="comment">// Supported editing features include:</span>00030 <span class="comment">// -Backspace support</span>00031 <span class="comment">// -Mid-line editing, inserting and deleting (left/right-arrows)</span>00032 <span class="comment">// -Command History (up-arrow) (currently only one command deep)</span>00033 <span class="comment">//</span>00034 <span class="comment">// To use the cmdline system, you will need to associate command strings</span>00035 <span class="comment">// (commands the user will be typing) with your function that you wish to have</span>00036 <span class="comment">// called when the user enters that command. This is done by using the</span>00037 <span class="comment">// cmdlineAddCommand() function.</span>00038 <span class="comment">//</span>00039 <span class="comment">// To setup the cmdline system, you must do these things:</span>00040 <span class="comment">// -Initialize it: cmdlineInit()</span>00041 <span class="comment">// -Add one or more commands to the database: cmdlineAddCommand()</span>00042 <span class="comment">// -Set an output function for your terminal: cmdlineSetOutputFunc()</span>00043 <span class="comment">//</span>00044 <span class="comment">// To operate the cmdline system, you must do these things repeatedly:</span>00045 <span class="comment">// -Pass user input from the terminal to: cmdlineSetOutputFunc()</span>00046 <span class="comment">// -Call cmdlineMainLoop() from your program's main loop</span>00047 <span class="comment">//</span>00048 <span class="comment">// The cmdline library does not assume an input or output device, but can be</span>00049 <span class="comment">// configured to use any user function for output using cmdlineSetOutputFunc()</span>00050 <span class="comment">// and accepts input by calling cmdlineInputFunc(). This means the cmdline</span>00051 <span class="comment">// library can operate over any interface including UART (serial port),</span>00052 <span class="comment">// I2c, ethernet, etc.</span>00053 <span class="comment">//</span>00054 <span class="comment">// ***** FOR MORE INFORMATION ABOUT USING cmdline SEE THE AVRLIB EXAMPLE *****</span>00055 <span class="comment">// ***** CODE IN THE avrlib/examples DIRECTORY *****</span>00056 <span class="comment">//</span>00057 <span class="comment">// NOTE: This code is currently below version 1.0, and therefore is considered</span>00058 <span class="comment">// to be lacking in some functionality or documentation, or may not be fully</span>00059 <span class="comment">// tested. Nonetheless, you can expect most functions to work.</span>00060 <span class="comment">//</span>00061 <span class="comment">// This code is distributed under the GNU Public License</span>00062 <span class="comment">// which can be found at http://www.gnu.org/licenses/gpl.txt</span>00063 <span class="comment">//</span>00064 <span class="comment">//*****************************************************************************</span>00065 00066 <span class="preprocessor">#ifndef CMDLINE_H</span>00067 <span class="preprocessor"></span><span class="preprocessor">#define CMDLINE_H</span>00068 <span class="preprocessor"></span>00069 <span class="preprocessor">#include "<a class="code" href="global_8h.html">global.h</a>"</span>00070 00071 <span class="comment">// constants/macros/typdefs</span>00072 <span class="keyword">typedef</span> void (*CmdlineFuncPtrType)(<span class="keywordtype">void</span>);00073 00074 <span class="comment">// functions</span>00075 <span class="comment"></span>00076 <span class="comment">//! initalize the command line system</span>00077 <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="cmdline_8c.html#a26">cmdlineInit</a>(<span class="keywordtype">void</span>);00078 <span class="comment"></span>00079 <span class="comment">//! add a new command to the database of known commands</span>00080 <span class="comment"></span><span class="comment">// newCmdString should be a null-terminated command string with no whitespace</span>00081 <span class="comment">// newCmdFuncPtr should be a pointer to the function to execute when</span>00082 <span class="comment">// the user enters the corresponding command tring</span>00083 <span class="keywordtype">void</span> <a class="code" href="cmdline_8h.html#a2">cmdlineAddCommand</a>(u08* newCmdString, CmdlineFuncPtrType newCmdFuncPtr);00084 <span class="comment"></span>00085 <span class="comment">//! sets the function used for sending characters to the user terminal</span>00086 <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="cmdline_8h.html#a3">cmdlineSetOutputFunc</a>(<span class="keywordtype">void</span> (*output_func)(<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> c));00087 <span class="comment"></span>00088 <span class="comment">//! call this function to pass input charaters from the user terminal</span>00089 <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="cmdline_8h.html#a4">cmdlineInputFunc</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> c);00090 <span class="comment"></span>00091 <span class="comment">//! call this function in your program's main loop</span>00092 <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="cmdline_8c.html#a33">cmdlineMainLoop</a>(<span class="keywordtype">void</span>);00093 00094 <span class="comment">// internal commands</span>00095 <span class="keywordtype">void</span> cmdlineRepaint(<span class="keywordtype">void</span>);00096 <span class="keywordtype">void</span> cmdlineDoHistory(u08 action);00097 <span class="keywordtype">void</span> cmdlineProcessInputString(<span class="keywordtype">void</span>);00098 <span class="keywordtype">void</span> cmdlinePrintPrompt(<span class="keywordtype">void</span>);00099 <span class="keywordtype">void</span> cmdlinePrintError(<span class="keywordtype">void</span>);00100 00101 <span class="comment">// argument retrieval commands</span><span class="comment"></span>00102 <span class="comment">//! returns a string pointer to argument number [argnum] on the command line</span>00103 <span class="comment"></span>u08* <a class="code" href="cmdline_8h.html#a11">cmdlineGetArgStr</a>(u08 argnum);<span class="comment"></span>00104 <span class="comment">//! returns the decimal integer interpretation of argument number [argnum]</span>00105 <span class="comment"></span><span class="keywordtype">long</span> <a class="code" href="cmdline_8h.html#a12">cmdlineGetArgInt</a>(u08 argnum);<span class="comment"></span>00106 <span class="comment">//! returns the hex integer interpretation of argument number [argnum]</span>00107 <span class="comment"></span><span class="keywordtype">long</span> <a class="code" href="cmdline_8h.html#a13">cmdlineGetArgHex</a>(u08 argnum);00108 00109 <span class="preprocessor">#endif</span></pre></div><hr size="1"><address style="align: right;"><small>Generated on Fri Oct 15 03:50:21 2004 for Procyon AVRlib by<a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border=0 > </a>1.3.6 </small></address></body></html>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -