?lang_form? ?lang_select? ?lang_submit? ?lang_endform?

library

?curdirlinks? - Rev 6

?prevdifflink?

<!DOCTYPE <h <t <link </head><body> <!-- <div <h 00002 00003 00004 00005 00006 00007 00008 00009 00010 00011 00012 00013 00014 00015 00016 00017 00018 00019 00020 00021 00022 00023 00024 00025 00026 00027 00028 00029 00030 00031 00032 00033 00034 00035 00036 00037 00038 00039 00040 00041 00042 00043 00044 00045 00046 00047 00048 00049 00050 00051 00052 00053 00054 00055 00056 00057 00058 00059 00060 00061 00062 00063 00064 00065 00066 00067 00068 00069 00070 00071 00072 00073 00074 00075 00076 00077 00078 00079 <a 00081 { 00082 00083 00084 00085 00086 00087 00088 00089 00090 00091 } 00092 <a 00094 { 00095 00096 00097 00098 00099 00100 00101 } 00102 <a 00104 { 00105 00106 00107 00108 00109 00110 00111 } 00112 <a 00114 { 00115 u08 i; 00116 00117 00118 00119 00120 00121 { 00122 00123 00124 00125 { 00126 00127 00128 00129 00130 00131 00132 00133 00134 00135 { 00136 00137 00138 00139 00140 00141 00142 } 00143 00144 { 00145 00146 00147 } 00148 00149 00150 00151 00152 { 00153 00154 00155 00156 00157 } 00158 00159 { 00160 00161 00162 } 00163 00164 00165 00166 } 00167 00168 00169 00170 } 00171 00172 { 00173 00174 00175 { 00176 00177 00178 } 00179 00180 00181 } 00182 00183 { 00184 00185 00186 } 00187 00188 00189 00190 { 00191 00192 00193 00194 { 00195 00196 00197 00198 00199 00200 00201 } 00202 00203 { 00204 00205 00206 00207 00208 00209 00210 00211 00212 00213 00214 00215 00216 00217 } 00218 } 00219 00220 00221 { 00222 00223 00224 00225 00226 00227 00228 00229 00230 00231 00232 00233 00234 } 00235 00236 { 00237 00238 { 00239 00240 00241 { 00242 00243 00244 00245 00246 00247 00248 00249 00250 } 00251 00252 { 00253 00254 00255 00256 00257 00258 00259 00260 00261 00262 00263 00264 00265 00266 00267 } 00268 } 00269 00270 { 00271 00272 00273 } 00274 } 00275 00276 { 00277 00278 } 00279 00280 { 00281 00282 } 00283 } 00284 00285 00286 { 00287 u08* ptr; 00288 u08 i; 00289 00290 00291 00292 00293 00294 00295 00296 00297 00298 } 00299 00300 00301 { 00302 00303 { 00304 00305 00306 00307 00308 00309 00310 00311 00312 00313 00314 00315 00316 00317 00318 00319 00320 } 00321 } 00322 00323 00324 { 00325 u08 cmdIndex; 00326 u08 i=0; 00327 00328 00329 00330 00331 00332 00333 00334 00335 00336 { 00337 00338 00339 00340 00341 00342 } 00343 00344 00345 00346 { 00347 00348 { 00349 00350 00351 00352 00353 00354 00355 } 00356 } 00357 00358 00359 00360 00361 00362 00363 } 00364 <a 00366 { 00367 00368 00369 { 00370 00371 00372 00373 00374 00375 00376 } 00377 } 00378 00379 00380 { 00381 00382 00383 00384 } 00385 00386 00387 { 00388 u08 * ptr; 00389 00390 00391 00392 00393 00394 00395 00396 00397 00398 00399 00400 00401 00402 00403 00404 00405 00406 00407 00408 00409 } 00410 00411 00412 00413 <a 00415 { 00416 00417 u08 idx=0; 00418 u08 arg; 00419 00420 00421 00422 00423 00424 00425 { 00426 00427 00428 00429 00430 } 00431 00432 00433 } 00434 00435 <a 00437 { 00438 00439 00440 } 00441 00442 <a 00444 { 00445 00446 00447 } </ <a <img </body> </html>

HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> tml><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> itle>Procyon AVRlib: cmdline.c Source File</title> href="dox.css" rel="stylesheet" type="text/css"> Generated by Doxygen 1.4.2 --> 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> 1>cmdline.c</h1><a href="cmdline_8c.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment">00001 /*! \file cmdline.c \brief Command-Line Interface Library. */ //***************************************************************************** // // File Name : 'cmdline.c' // Title : Command-Line Interface Library // Author : Pascal Stang - Copyright (C) 2003 // Created : 2003.07.16 // Revised : 2003.07.23 // Version : 0.1 // Target MCU : Atmel AVR Series // Editor Tabs : 4 // // NOTE: This code is currently below version 1.0, and therefore is considered // to be lacking in some functionality or documentation, or may not be fully // tested. Nonetheless, you can expect most functions to work. // // This code is distributed under the GNU Public License // which can be found at http://www.gnu.org/licenses/gpl.txt // //***************************************************************************** //----- Include Files --------------------------------------------------------- #include <avr/io.h> // include I/O definitions (port names, pin names, etc) #include <avr/interrupt.h> // include interrupt support #include <avr/pgmspace.h> // include AVR program memory support #include <string.h> // include standard C string functions #include <stdlib.h> // include stdlib for string conversion functions #include "<a class="code" href="global_8h.html">global.h</a>" // include our global settings #include "<a class="code" href="cmdline_8h.html">cmdline.h</a>" // include project-specific configuration #include "<a class="code" href="cmdlineconf_8h.html">cmdlineconf.h</a>" // defines #define ASCII_BEL 0x07 #define ASCII_BS 0x08 #define ASCII_CR 0x0D #define ASCII_LF 0x0A #define ASCII_ESC 0x1B #define ASCII_DEL 0x7F #define VT100_ARROWUP 'A' #define VT100_ARROWDOWN 'B' #define VT100_ARROWRIGHT 'C' #define VT100_ARROWLEFT 'D' #define CMDLINE_HISTORY_SAVE 0 #define CMDLINE_HISTORY_PREV 1 #define CMDLINE_HISTORY_NEXT 2 // Global variables // strings u08 PROGMEM CmdlinePrompt[] = "cmd>"; u08 PROGMEM CmdlineNotice[] = "cmdline: "; u08 PROGMEM CmdlineCmdNotFound[] = "command not found"; // command list // -commands are null-terminated strings static char CmdlineCommandList[CMDLINE_MAX_COMMANDS][CMDLINE_MAX_CMD_LENGTH]; // command function pointer list static CmdlineFuncPtrType CmdlineFunctionList[CMDLINE_MAX_COMMANDS]; // number of commands currently registered u08 CmdlineNumCommands; u08 CmdlineBuffer[CMDLINE_BUFFERSIZE]; u08 CmdlineBufferLength; u08 CmdlineBufferEditPos; u08 CmdlineInputVT100State; u08 CmdlineHistory[CMDLINE_HISTORYSIZE][CMDLINE_BUFFERSIZE]; CmdlineFuncPtrType CmdlineExecFunction; // Functions // function pointer to single character output routine static void (*cmdlineOutputFunc)(unsigned char c); name="l00080"></a><a class="code" href="group__cmdline.html#ga1">00080</a> void <a class="code" href="group__cmdline.html#ga1">cmdlineInit</a>(void) // reset vt100 processing state CmdlineInputVT100State = 0; // initialize input buffer CmdlineBufferLength = 0; CmdlineBufferEditPos = 0; // initialize executing function CmdlineExecFunction = 0; // initialize command list CmdlineNumCommands = 0; name="l00093"></a><a class="code" href="group__cmdline.html#ga2">00093</a> void <a class="code" href="group__cmdline.html#ga2">cmdlineAddCommand</a>(u08* newCmdString, CmdlineFuncPtrType newCmdFuncPtr) // add command string to end of command list strcpy(CmdlineCommandList[CmdlineNumCommands], newCmdString); // add command function ptr to end of function list CmdlineFunctionList[CmdlineNumCommands] = newCmdFuncPtr; // increment number of registered commands CmdlineNumCommands++; name="l00103"></a><a class="code" href="group__cmdline.html#ga3">00103</a> void <a class="code" href="group__cmdline.html#ga3">cmdlineSetOutputFunc</a>(void (*output_func)(unsigned char c)) // set new output function cmdlineOutputFunc = output_func; // should we really do this? // print a prompt //cmdlinePrintPrompt(); name="l00113"></a><a class="code" href="group__cmdline.html#ga4">00113</a> void <a class="code" href="group__cmdline.html#ga4">cmdlineInputFunc</a>(unsigned char c) // process the received character // VT100 handling // are we processing a VT100 command? if(CmdlineInputVT100State == 2) // we have already received ESC and [ // now process the vt100 code switch(c) case VT100_ARROWUP: cmdlineDoHistory(CMDLINE_HISTORY_PREV); break; case VT100_ARROWDOWN: cmdlineDoHistory(CMDLINE_HISTORY_NEXT); break; case VT100_ARROWRIGHT: // if the edit position less than current string length if(CmdlineBufferEditPos < CmdlineBufferLength) // increment the edit position CmdlineBufferEditPos++; // move cursor forward one space (no erase) cmdlineOutputFunc(ASCII_ESC); cmdlineOutputFunc('['); cmdlineOutputFunc(VT100_ARROWRIGHT); else // else, ring the bell cmdlineOutputFunc(ASCII_BEL); break; case VT100_ARROWLEFT: // if the edit position is non-zero if(CmdlineBufferEditPos) // decrement the edit position CmdlineBufferEditPos--; // move cursor back one space (no erase) cmdlineOutputFunc(ASCII_BS); else // else, ring the bell cmdlineOutputFunc(ASCII_BEL); break; default: break; // done, reset state CmdlineInputVT100State = 0; return; else if(CmdlineInputVT100State == 1) // we last received [ESC] if(c == '[') CmdlineInputVT100State = 2; return; else CmdlineInputVT100State = 0; else // anything else, reset state CmdlineInputVT100State = 0; // Regular handling if( (c >= 0x20) && (c < 0x7F) ) // character is printable // is this a simple append if(CmdlineBufferEditPos == CmdlineBufferLength) // echo character to the output cmdlineOutputFunc(c); // add it to the command line buffer CmdlineBuffer[CmdlineBufferEditPos++] = c; // update buffer length CmdlineBufferLength++; else // edit/cursor position != end of buffer // we're inserting characters at a mid-line edit position // make room at the insert point CmdlineBufferLength++; for(i=CmdlineBufferLength; i>CmdlineBufferEditPos; i--) CmdlineBuffer[i] = CmdlineBuffer[i-1]; // insert character CmdlineBuffer[CmdlineBufferEditPos++] = c; // repaint cmdlineRepaint(); // reposition cursor for(i=CmdlineBufferEditPos; i<CmdlineBufferLength; i++) cmdlineOutputFunc(ASCII_BS); // handle special characters else if(c == ASCII_CR) // user pressed [ENTER] // echo CR and LF to terminal cmdlineOutputFunc(ASCII_CR); cmdlineOutputFunc(ASCII_LF); // add null termination to command CmdlineBuffer[CmdlineBufferLength++] = 0; CmdlineBufferEditPos++; // command is complete, process it cmdlineProcessInputString(); // reset buffer CmdlineBufferLength = 0; CmdlineBufferEditPos = 0; else if(c == ASCII_BS) if(CmdlineBufferEditPos) // is this a simple delete (off the end of the line) if(CmdlineBufferEditPos == CmdlineBufferLength) // destructive backspace // echo backspace-space-backspace cmdlineOutputFunc(ASCII_BS); cmdlineOutputFunc(' '); cmdlineOutputFunc(ASCII_BS); // decrement our buffer length and edit position CmdlineBufferLength--; CmdlineBufferEditPos--; else // edit/cursor position != end of buffer // we're deleting characters at a mid-line edit position // shift characters down, effectively deleting CmdlineBufferLength--; CmdlineBufferEditPos--; for(i=CmdlineBufferEditPos; i<CmdlineBufferLength; i++) CmdlineBuffer[i] = CmdlineBuffer[i+1]; // repaint cmdlineRepaint(); // add space to clear leftover characters cmdlineOutputFunc(' '); // reposition cursor for(i=CmdlineBufferEditPos; i<(CmdlineBufferLength+1); i++) cmdlineOutputFunc(ASCII_BS); else // else, ring the bell cmdlineOutputFunc(ASCII_BEL); else if(c == ASCII_DEL) // not yet handled else if(c == ASCII_ESC) CmdlineInputVT100State = 1; void cmdlineRepaint(void) // carriage return cmdlineOutputFunc(ASCII_CR); // print fresh prompt cmdlinePrintPrompt(); // print the new command line buffer i = CmdlineBufferLength; ptr = CmdlineBuffer; while(i--) cmdlineOutputFunc(*ptr++); void cmdlineDoHistory(u08 action) switch(action) case CMDLINE_HISTORY_SAVE: // copy CmdlineBuffer to history if not null string if( strlen(CmdlineBuffer) ) strcpy(CmdlineHistory[0], CmdlineBuffer); break; case CMDLINE_HISTORY_PREV: // copy history to current buffer strcpy(CmdlineBuffer, CmdlineHistory[0]); // set the buffer position to the end of the line CmdlineBufferLength = strlen(CmdlineBuffer); CmdlineBufferEditPos = CmdlineBufferLength; // "re-paint" line cmdlineRepaint(); break; case CMDLINE_HISTORY_NEXT: break; void cmdlineProcessInputString(void) // save command in history cmdlineDoHistory(CMDLINE_HISTORY_SAVE); // find the end of the command (excluding arguments) // find first whitespace character in CmdlineBuffer while( !((CmdlineBuffer[i] == ' ') || (CmdlineBuffer[i] == 0)) ) i++; if(!i) // command was null or empty // output a new prompt cmdlinePrintPrompt(); // we're done return; // search command list for match with entered command for(cmdIndex=0; cmdIndex<CmdlineNumCommands; cmdIndex++) if( !strncmp(CmdlineCommandList[cmdIndex], CmdlineBuffer, i) ) // user-entered command matched a command in the list (database) // run the corresponding function CmdlineExecFunction = CmdlineFunctionList[cmdIndex]; // new prompt will be output after user function runs // and we're done return; // if we did not get a match // output an error message cmdlinePrintError(); // output a new prompt cmdlinePrintPrompt(); name="l00365"></a><a class="code" href="group__cmdline.html#ga5">00365</a> void <a class="code" href="group__cmdline.html#ga5">cmdlineMainLoop</a>(void) // do we have a command/function to be executed if(CmdlineExecFunction) // run it CmdlineExecFunction(); // reset CmdlineExecFunction = 0; // output new prompt cmdlinePrintPrompt(); void cmdlinePrintPrompt(void) // print a new command prompt u08* ptr = CmdlinePrompt; while(pgm_read_byte(ptr)) cmdlineOutputFunc( pgm_read_byte(ptr++) ); void cmdlinePrintError(void) // print a notice header // (u08*) cast used to avoid compiler warning ptr = (u08*)CmdlineNotice; while(pgm_read_byte(ptr)) cmdlineOutputFunc( pgm_read_byte(ptr++) ); // print the offending command ptr = CmdlineBuffer; while((*ptr) && (*ptr != ' ')) cmdlineOutputFunc(*ptr++); cmdlineOutputFunc(':'); cmdlineOutputFunc(' '); // print the not-found message // (u08*) cast used to avoid compiler warning ptr = (u08*)CmdlineCmdNotFound; while(pgm_read_byte(ptr)) cmdlineOutputFunc( pgm_read_byte(ptr++) ); cmdlineOutputFunc('\r'); cmdlineOutputFunc('\n'); // argument retrieval commands // return string pointer to argument [argnum] name="l00414"></a><a class="code" href="group__cmdline.html#ga11">00414</a> u08* <a class="code" href="group__cmdline.html#ga11">cmdlineGetArgStr</a>(u08 argnum) // find the offset of argument number [argnum] // find the first non-whitespace character while( (CmdlineBuffer[idx] != 0) && (CmdlineBuffer[idx] == ' ')) idx++; // we are at the first argument for(arg=0; arg<argnum; arg++) // find the next whitespace character while( (CmdlineBuffer[idx] != 0) && (CmdlineBuffer[idx] != ' ')) idx++; // find the first non-whitespace character while( (CmdlineBuffer[idx] != 0) && (CmdlineBuffer[idx] == ' ')) idx++; // we are at the requested argument or the end of the buffer return &CmdlineBuffer[idx]; // return argument [argnum] interpreted as a decimal integer name="l00436"></a><a class="code" href="group__cmdline.html#ga12">00436</a> long <a class="code" href="group__cmdline.html#ga12">cmdlineGetArgInt</a>(u08 argnum) char* endptr; return strtol(<a class="code" href="group__cmdline.html#ga11">cmdlineGetArgStr</a>(argnum), &endptr, 10); // return argument [argnum] interpreted as a hex integer name="l00443"></a><a class="code" href="group__cmdline.html#ga13">00443</a> long <a class="code" href="group__cmdline.html#ga13">cmdlineGetArgHex</a>(u08 argnum) char* endptr; return strtol(<a class="code" href="group__cmdline.html#ga11">cmdlineGetArgStr</a>(argnum), &endptr, 16); pre></div><hr size="1"><address style="align: right;">Generated on Sun Oct 29 03:41:06 2006 for Procyon AVRlib by  href="http://www.doxygen.org/index.html"> src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.2 </address>

END}