David Smart / CommandProcessor

The CommandProcessor is the interface to install a run-time menu into an embedded system.

Dependents:   A_CANAdapter USB2I2C

CommandProcessor.c@12:a8c56bf811b9, 2011-05-29 (annotated)

Committer:
WiredHome
Date:
Sun May 29 20:40:04 2011 +0000
Revision:
12:a8c56bf811b9
Parent:
11:4a3cd3f2183b
Child:
13:e1880be590c4
v1.03 Internal documentation updates, no external interfaces affected.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
WiredHome 7:0f058d664b21 1 /// @file CommandProcessor.c is a simple interface to an interactive
WiredHome 7:0f058d664b21 2 /// command set of user defined commands.
WiredHome 0:198f53da1bc8 3 ///
WiredHome 7:0f058d664b21 4 /// With this, you can create functions that are exposed to a console
WiredHome 7:0f058d664b21 5 /// interface. Each command may have 0 or more parameters.
WiredHome 7:0f058d664b21 6 /// Typing the command, or at least the set of characters that make
WiredHome 7:0f058d664b21 7 /// it unique from all other commands is enough to activate the command.
WiredHome 7:0f058d664b21 8 ///
WiredHome 7:0f058d664b21 9 /// Even though it is a c interface, it is somewhat object oriented.
WiredHome 0:198f53da1bc8 10 ///
WiredHome 12:a8c56bf811b9 11 /// @version 1.03
WiredHome 0:198f53da1bc8 12 ///
WiredHome 12:a8c56bf811b9 13 /// @note Copyright &copr; 2011 by Smartware Computing, all rights reserved.
WiredHome 12:a8c56bf811b9 14 /// Individuals may use this application for evaluation or non-commercial
WiredHome 12:a8c56bf811b9 15 /// purposes. Within this restriction, changes may be made to this application
WiredHome 12:a8c56bf811b9 16 /// as long as this copyright notice is retained. The user shall make
WiredHome 12:a8c56bf811b9 17 /// clear that their work is a derived work, and not the original.
WiredHome 12:a8c56bf811b9 18 /// Users of this application and sources accept this application "as is" and
WiredHome 12:a8c56bf811b9 19 /// shall hold harmless Smartware Computing, for any undesired results while
WiredHome 12:a8c56bf811b9 20 /// using this application - whether real or imagined.
WiredHome 0:198f53da1bc8 21 ///
WiredHome 12:a8c56bf811b9 22 /// @author David Smart, Smartware Computing
WiredHome 12:a8c56bf811b9 23 ///
WiredHome 12:a8c56bf811b9 24
WiredHome 0:198f53da1bc8 25 #include "stdio.h"
WiredHome 0:198f53da1bc8 26 #include "string.h"
WiredHome 0:198f53da1bc8 27 #include "stdlib.h"
WiredHome 0:198f53da1bc8 28 #ifdef WIN32
WiredHome 0:198f53da1bc8 29 #include "windows.h"
WiredHome 0:198f53da1bc8 30 #pragma warning (disable: 4996)
WiredHome 0:198f53da1bc8 31 #endif
WiredHome 0:198f53da1bc8 32
WiredHome 0:198f53da1bc8 33 #include "CommandProcessor.h"
WiredHome 0:198f53da1bc8 34
WiredHome 0:198f53da1bc8 35 /// This holds the single linked list of commands
WiredHome 11:4a3cd3f2183b 36 /// @verbatim
WiredHome 7:0f058d664b21 37 /// +-- Head->next
WiredHome 7:0f058d664b21 38 /// v
WiredHome 7:0f058d664b21 39 /// +-- p +-- n
WiredHome 7:0f058d664b21 40 /// v v
WiredHome 7:0f058d664b21 41 /// |menu|-------------------------------->|"Command" |
WiredHome 7:0f058d664b21 42 /// |next|->0 |menu|---->|"Help" |"Help" |
WiredHome 7:0f058d664b21 43 /// |next|->0 |"..." |*(callback)|
WiredHome 7:0f058d664b21 44 /// |*(callback) |visible |
WiredHome 7:0f058d664b21 45 /// |visible
WiredHome 11:4a3cd3f2183b 46 /// @endverbatim
WiredHome 0:198f53da1bc8 47 ///
WiredHome 7:0f058d664b21 48 typedef struct CMDLINK_T {
WiredHome 0:198f53da1bc8 49 CMD_T * menu; // handle to the menu item
WiredHome 0:198f53da1bc8 50 struct CMDLINK_T * next; // handle to the next link
WiredHome 0:198f53da1bc8 51 } CMDLINK_T;
WiredHome 0:198f53da1bc8 52
WiredHome 0:198f53da1bc8 53 static CMDLINK_T * head = NULL;
WiredHome 0:198f53da1bc8 54
WiredHome 0:198f53da1bc8 55 static char *buffer; // buffer space must be allocated based on the longest command
WiredHome 0:198f53da1bc8 56
WiredHome 12:a8c56bf811b9 57 static int longestCommand = 0;
WiredHome 12:a8c56bf811b9 58
WiredHome 7:0f058d664b21 59 static struct {
WiredHome 12:a8c56bf811b9 60 CMD_T *SignOnBanner;
WiredHome 12:a8c56bf811b9 61 int showSignOnBanner; // Shows the sign-on banner at startup
WiredHome 0:198f53da1bc8 62 int caseinsensitive; // FALSE=casesensitive, TRUE=insensitive
WiredHome 6:1a0512faa75d 63 int echo; // TRUE=echo on, FALSE=echo off
WiredHome 6:1a0512faa75d 64 int bufferSize; // size of the buffer
WiredHome 0:198f53da1bc8 65 int (*kbhit)(void);
WiredHome 0:198f53da1bc8 66 int (*getch)(void);
WiredHome 0:198f53da1bc8 67 int (*putch)(int ch);
WiredHome 0:198f53da1bc8 68 int (*puts)(const char * s);
WiredHome 0:198f53da1bc8 69 } cfg;
WiredHome 0:198f53da1bc8 70
WiredHome 0:198f53da1bc8 71 static INITRESULT_T CommandProcessor_Init(
WiredHome 10:9e52bd1a4a71 72 CMD_T *SignOnBanner,
WiredHome 12:a8c56bf811b9 73 CONFIG_T config,
WiredHome 7:0f058d664b21 74 int maxCmdLen,
WiredHome 0:198f53da1bc8 75 int (*kbhit)(void),
WiredHome 0:198f53da1bc8 76 int (*getch)(void),
WiredHome 0:198f53da1bc8 77 int (*putch)(int ch),
WiredHome 0:198f53da1bc8 78 int (*puts)(const char * s)
WiredHome 7:0f058d664b21 79 );
WiredHome 0:198f53da1bc8 80 static ADDRESULT_T CommandProcessor_Add(CMD_T *m);
WiredHome 0:198f53da1bc8 81 static RUNRESULT_T CommandProcessor_Run(void);
WiredHome 0:198f53da1bc8 82 static RUNRESULT_T CommandProcessor_End(void);
WiredHome 6:1a0512faa75d 83 static RUNRESULT_T CommandProcessor_Echo(int echo);
WiredHome 0:198f53da1bc8 84
WiredHome 7:0f058d664b21 85 // helper functions
WiredHome 7:0f058d664b21 86 static int myisprint(int c);
WiredHome 7:0f058d664b21 87 static void mystrcat(char *dst, char *src);
WiredHome 7:0f058d664b21 88 static char mytolower(char a);
WiredHome 7:0f058d664b21 89 int mystrnicmp(const char *l, const char *r, size_t n);
WiredHome 7:0f058d664b21 90
WiredHome 7:0f058d664b21 91 static CMDP_T CommandProcessor = {
WiredHome 0:198f53da1bc8 92 CommandProcessor_Init,
WiredHome 0:198f53da1bc8 93 CommandProcessor_Add,
WiredHome 0:198f53da1bc8 94 CommandProcessor_Run,
WiredHome 6:1a0512faa75d 95 CommandProcessor_Echo,
WiredHome 0:198f53da1bc8 96 CommandProcessor_End
WiredHome 0:198f53da1bc8 97 };
WiredHome 0:198f53da1bc8 98
WiredHome 0:198f53da1bc8 99 static RUNRESULT_T Help(char *p);
WiredHome 6:1a0512faa75d 100 static RUNRESULT_T Echo(char *p);
WiredHome 0:198f53da1bc8 101 static RUNRESULT_T Exit(char *p);
WiredHome 10:9e52bd1a4a71 102 //static RUNRESULT_T About(char *p);
WiredHome 0:198f53da1bc8 103
WiredHome 9:41046d2fd8e7 104 static CMD_T HelpMenu = {"Help", "Help or '?' shows this help, 'Help ?' shows more details.", Help, visible};
WiredHome 9:41046d2fd8e7 105 static CMD_T QuestionMenu = {"?", "Shows this help, '? ?' shows more details.", Help, invisible};
WiredHome 6:1a0512faa75d 106 static CMD_T EchoMenu = {"Echo", "Echo [1|on|0|off] turns echo on or off.", Echo, visible};
WiredHome 10:9e52bd1a4a71 107 //static CMD_T AboutMenu = {"About", "About this CommandProcessor", About, visible};
WiredHome 0:198f53da1bc8 108 static CMD_T ExitMenu = {"Exit", "Exits the program", Exit, visible};
WiredHome 0:198f53da1bc8 109
WiredHome 0:198f53da1bc8 110 /// Gets a handle to the CommandProcessor
WiredHome 0:198f53da1bc8 111 ///
WiredHome 7:0f058d664b21 112 /// This returns a handle to the CommandProcessor, which then permits
WiredHome 7:0f058d664b21 113 /// access to the CommandProcessor functions.
WiredHome 0:198f53da1bc8 114 ///
WiredHome 7:0f058d664b21 115 /// @returns handle to the CommandProcessor
WiredHome 0:198f53da1bc8 116 ///
WiredHome 7:0f058d664b21 117 CMDP_T * GetCommandProcessor(void) {
WiredHome 0:198f53da1bc8 118 return &CommandProcessor;
WiredHome 0:198f53da1bc8 119 }
WiredHome 0:198f53da1bc8 120
WiredHome 0:198f53da1bc8 121
WiredHome 7:0f058d664b21 122 /// Information about this command processor
WiredHome 7:0f058d664b21 123 ///
WiredHome 7:0f058d664b21 124 /// @param p is a pointer to command line arguments, of which there is
WiredHome 7:0f058d664b21 125 /// none for this function.
WiredHome 7:0f058d664b21 126 /// @returns runok
WiredHome 7:0f058d664b21 127 ///
WiredHome 10:9e52bd1a4a71 128 #if 0
WiredHome 7:0f058d664b21 129 static RUNRESULT_T About(char *p) {
WiredHome 0:198f53da1bc8 130 cfg.puts("\r\n About this CommandProcessor:\r\n"
WiredHome 7:0f058d664b21 131 " This CommandProcessor provides an easy facility for creating a\r\n"
WiredHome 7:0f058d664b21 132 " runtime interactive interpreter in an embedded system.\r\n"
WiredHome 7:0f058d664b21 133 " Copyright (c) 2011 by Smartware Computing, all rights reserved.\r\n"
WiredHome 7:0f058d664b21 134 " Author: David Smart, Smartware Computing\r\n"
WiredHome 7:0f058d664b21 135 );
WiredHome 0:198f53da1bc8 136 return runok;
WiredHome 0:198f53da1bc8 137 }
WiredHome 10:9e52bd1a4a71 138 #endif
WiredHome 0:198f53da1bc8 139
WiredHome 7:0f058d664b21 140 /// Turns command prompt echo on and off
WiredHome 7:0f058d664b21 141 ///
WiredHome 7:0f058d664b21 142 /// This command is used to turn the command prompt on and off. When
WiredHome 7:0f058d664b21 143 /// running in an interactive mode, it is best to have this one.
WiredHome 7:0f058d664b21 144 /// When driven by another program, off may be the best choice.
WiredHome 7:0f058d664b21 145 ///
WiredHome 7:0f058d664b21 146 /// This command also displays the current state of the echo mode.
WiredHome 7:0f058d664b21 147 ///
WiredHome 7:0f058d664b21 148 /// @param p is a pointer to a string "on" | "1" | "off" | "0"
WiredHome 7:0f058d664b21 149 /// @returns runok
WiredHome 7:0f058d664b21 150 ///
WiredHome 6:1a0512faa75d 151 static RUNRESULT_T Echo(char *p) {
WiredHome 6:1a0512faa75d 152 if (*p) {
WiredHome 6:1a0512faa75d 153 if (*p == '1' || mystrnicmp(p, "on", 2) == 0)
WiredHome 6:1a0512faa75d 154 CommandProcessor_Echo(1);
WiredHome 6:1a0512faa75d 155 if (*p == '0' || mystrnicmp(p, "off", 3) == 0)
WiredHome 6:1a0512faa75d 156 CommandProcessor_Echo(0);
WiredHome 6:1a0512faa75d 157 }
WiredHome 6:1a0512faa75d 158 if (cfg.echo)
WiredHome 6:1a0512faa75d 159 cfg.puts("\r\nEcho is on");
WiredHome 6:1a0512faa75d 160 else
WiredHome 6:1a0512faa75d 161 cfg.puts("\r\nEcho is off");
WiredHome 6:1a0512faa75d 162 return runok;
WiredHome 6:1a0512faa75d 163 }
WiredHome 6:1a0512faa75d 164
WiredHome 7:0f058d664b21 165 static RUNRESULT_T Exit(char *p) {
WiredHome 0:198f53da1bc8 166 (void)p;
WiredHome 0:198f53da1bc8 167 cfg.puts("\r\nbye.");
WiredHome 0:198f53da1bc8 168 return runexit;
WiredHome 0:198f53da1bc8 169 }
WiredHome 0:198f53da1bc8 170
WiredHome 7:0f058d664b21 171 static RUNRESULT_T Help(char *p) {
WiredHome 0:198f53da1bc8 172 CMDLINK_T *link = head;
WiredHome 0:198f53da1bc8 173 char buffer[100];
WiredHome 0:198f53da1bc8 174 cfg.puts("\r\n");
WiredHome 10:9e52bd1a4a71 175 //sprintf(buffer, " %-10s: %s", "Command", "Description");
WiredHome 10:9e52bd1a4a71 176 //cfg.puts(buffer);
WiredHome 7:0f058d664b21 177 while (link && link->menu) {
WiredHome 7:0f058d664b21 178 if (link->menu->visible) {
WiredHome 7:0f058d664b21 179 if (strlen(link->menu->command) + strlen(link->menu->helptext) + 5 < sizeof(buffer)) {
WiredHome 12:a8c56bf811b9 180 sprintf(buffer, " %-*s: %s", longestCommand, link->menu->command, link->menu->helptext);
WiredHome 0:198f53da1bc8 181 cfg.puts(buffer);
WiredHome 0:198f53da1bc8 182 }
WiredHome 0:198f53da1bc8 183 }
WiredHome 0:198f53da1bc8 184 link = link->next;
WiredHome 0:198f53da1bc8 185 }
WiredHome 0:198f53da1bc8 186 cfg.puts("");
WiredHome 7:0f058d664b21 187 if (*p == '?') {
WiredHome 10:9e52bd1a4a71 188 cfg.puts("\r\n Extended Help:\r\n"
WiredHome 7:0f058d664b21 189 " The general form for entering commands is:\r\n"
WiredHome 7:0f058d664b21 190 " >command option1 option2 ...\r\n"
WiredHome 10:9e52bd1a4a71 191 " [note that not all commands support optional parameters]\r\n"
WiredHome 7:0f058d664b21 192 " * Abbreviations of commands may be entered so long as there\r\n"
WiredHome 7:0f058d664b21 193 " is exactly one match in the list of commands. For example,\r\n"
WiredHome 7:0f058d664b21 194 " 'he' is the same as 'help', if there is no other command \r\n"
WiredHome 7:0f058d664b21 195 " that starts with 'he'.\r\n"
WiredHome 7:0f058d664b21 196 " * <bs> can be used to erase previously entered information.\r\n"
WiredHome 7:0f058d664b21 197 " * <esc> can be used to cancel a command.\r\n"
WiredHome 7:0f058d664b21 198 " * <tab> can be used to complete the entry of a partial command.\r\n"
WiredHome 7:0f058d664b21 199 "");
WiredHome 12:a8c56bf811b9 200 cfg.puts("\r\n About this CommandProcessor:\r\n"
WiredHome 12:a8c56bf811b9 201 " This CommandProcessor provides an easy facility for creating an\r\n"
WiredHome 12:a8c56bf811b9 202 " interactive runtime interpreter in an embedded system.\r\n"
WiredHome 12:a8c56bf811b9 203 " Copyright (c) 2011 by Smartware Computing, all rights reserved.\r\n"
WiredHome 12:a8c56bf811b9 204 " Author: David Smart, Smartware Computing\r\n");
WiredHome 0:198f53da1bc8 205 }
WiredHome 0:198f53da1bc8 206 return runok;
WiredHome 0:198f53da1bc8 207 }
WiredHome 0:198f53da1bc8 208
WiredHome 7:0f058d664b21 209 /// CommandMatches is the function that determines if the user is entering a valid
WiredHome 7:0f058d664b21 210 /// command
WiredHome 7:0f058d664b21 211 ///
WiredHome 7:0f058d664b21 212 /// This function gets called whenever the user types a printable character or when
WiredHome 7:0f058d664b21 213 /// they press \<enter\>.
WiredHome 7:0f058d664b21 214 /// The buffer of user input is evaluated to determine if the command is legitimate.
WiredHome 7:0f058d664b21 215 /// It also determines if they want to execute the command, or simply evaluate it.
WiredHome 7:0f058d664b21 216 /// Finally, it identifies writes to user provided pointers, the menu item that
WiredHome 7:0f058d664b21 217 /// matches and a pointer to any parameters that the user entered.
WiredHome 7:0f058d664b21 218 ///
WiredHome 7:0f058d664b21 219 /// @param buffer is the buffer that the user has entered commands into
WiredHome 7:0f058d664b21 220 /// @param exec indicates the intention to execute the command, if found
WiredHome 7:0f058d664b21 221 /// @param menu is a pointer to a pointer to a menu structure, which is updated based on the command
WiredHome 7:0f058d664b21 222 /// @param params is a pointer to a pointer to the user entered parameters
WiredHome 7:0f058d664b21 223 /// @returns the number of menu picks that match the user entered command
WiredHome 7:0f058d664b21 224 ///
WiredHome 7:0f058d664b21 225 static int CommandMatches(char * buffer, int exec, CMD_T **menu, char **params) {
WiredHome 7:0f058d664b21 226 char *space;
WiredHome 7:0f058d664b21 227 int compareLength;
WiredHome 7:0f058d664b21 228 int foundCount = 0;
WiredHome 7:0f058d664b21 229 CMDLINK_T *link = head;
WiredHome 7:0f058d664b21 230
WiredHome 7:0f058d664b21 231 if (strlen(buffer)) { // simple sanity check
WiredHome 7:0f058d664b21 232 // Try to process the buffer. A command could be "Help", or it could be "Test1 123 abc"
WiredHome 7:0f058d664b21 233 space = strchr(buffer, ' '); // if the command has parameters, find the delimiter
WiredHome 7:0f058d664b21 234 if (space) {
WiredHome 7:0f058d664b21 235 compareLength = space - buffer;
WiredHome 7:0f058d664b21 236 space++; // char after the space
WiredHome 7:0f058d664b21 237 } else {
WiredHome 7:0f058d664b21 238 compareLength = strlen(buffer);
WiredHome 7:0f058d664b21 239 space = buffer + compareLength;
WiredHome 7:0f058d664b21 240 }
WiredHome 7:0f058d664b21 241 while (link && link->menu) {
WiredHome 7:0f058d664b21 242 int cmpResult;
WiredHome 7:0f058d664b21 243
WiredHome 7:0f058d664b21 244 if (cfg.caseinsensitive) {
WiredHome 7:0f058d664b21 245 cmpResult = mystrnicmp(buffer, link->menu->command, compareLength);
WiredHome 7:0f058d664b21 246 } else
WiredHome 7:0f058d664b21 247 cmpResult = strncmp(buffer, link->menu->command, compareLength);
WiredHome 7:0f058d664b21 248 if (0 == cmpResult) { // A match to what they typed
WiredHome 7:0f058d664b21 249 if (menu) { // yes, we have a callback
WiredHome 7:0f058d664b21 250 *menu = link->menu; // accessor to the command they want to execute
WiredHome 7:0f058d664b21 251 *params = space;
WiredHome 7:0f058d664b21 252 }
WiredHome 7:0f058d664b21 253 foundCount++; // how many command match what they typed so far
WiredHome 7:0f058d664b21 254 }
WiredHome 7:0f058d664b21 255 link = link->next; // follow the link to the next command
WiredHome 7:0f058d664b21 256 }
WiredHome 7:0f058d664b21 257 if (foundCount == 1) {
WiredHome 7:0f058d664b21 258 // If we found exactly one and they expressed an intent to execute that command
WiredHome 7:0f058d664b21 259 // then we'll rewrite the command to be fully qualified
WiredHome 7:0f058d664b21 260 if (exec) { // command wants to execute it, not just validate the command syntax
WiredHome 7:0f058d664b21 261 // If they type "He 1234 5678", we backup and rewrite as "Help 1234 5678"
WiredHome 7:0f058d664b21 262 int diff = strlen((*menu)->command) - compareLength; // e.g. 5 - 3
WiredHome 7:0f058d664b21 263
WiredHome 7:0f058d664b21 264 if (diff > 0) {
WiredHome 7:0f058d664b21 265 int back = 0;
WiredHome 7:0f058d664b21 266 char *p;
WiredHome 7:0f058d664b21 267 if (strlen(space))
WiredHome 7:0f058d664b21 268 back = strlen(space) + 1;
WiredHome 7:0f058d664b21 269
WiredHome 7:0f058d664b21 270 while (back--)
WiredHome 7:0f058d664b21 271 cfg.putch(0x08);
WiredHome 7:0f058d664b21 272 p = (*menu)->command + compareLength;
WiredHome 7:0f058d664b21 273 while (*p)
WiredHome 7:0f058d664b21 274 cfg.putch(*p++);
WiredHome 7:0f058d664b21 275 cfg.putch(' ');
WiredHome 7:0f058d664b21 276 p = space;
WiredHome 7:0f058d664b21 277 while (*p)
WiredHome 7:0f058d664b21 278 cfg.putch(*p++);
WiredHome 7:0f058d664b21 279 //cfg.printf("%s %s", link->menu->command + compareLength, space);
WiredHome 7:0f058d664b21 280 }
WiredHome 7:0f058d664b21 281 }
WiredHome 7:0f058d664b21 282 }
WiredHome 7:0f058d664b21 283 }
WiredHome 7:0f058d664b21 284 return foundCount;
WiredHome 7:0f058d664b21 285 }
WiredHome 7:0f058d664b21 286
WiredHome 10:9e52bd1a4a71 287 /// Init is the first function to call to configure the CommandProcessor.
WiredHome 7:0f058d664b21 288 ///
WiredHome 10:9e52bd1a4a71 289 /// This function has a number of parameters, which make the CommandProcessor
WiredHome 10:9e52bd1a4a71 290 /// quite flexible.
WiredHome 7:0f058d664b21 291 ///
WiredHome 10:9e52bd1a4a71 292 /// @param SignOnBanner function, which is used as a signon banner
WiredHome 10:9e52bd1a4a71 293 /// @param config enables various default menu items, based on the bit values, combine the following:
WiredHome 10:9e52bd1a4a71 294 /// \li CFG_ENABLE_TERMINATE - enables the Exit command
WiredHome 10:9e52bd1a4a71 295 /// \li CFG_ENABLE_SYSTEM - enables system commands Echo, Help, etc.
WiredHome 10:9e52bd1a4a71 296 /// \li CFG_ECHO_ON - initialize with echo on
WiredHome 10:9e52bd1a4a71 297 /// \li CFG_CASE_INSENSITIVE - Command Parser is case insensitive
WiredHome 10:9e52bd1a4a71 298 /// @param maxCmdLen sizes the buffer, and is the maximum number of characters in a single
WiredHome 10:9e52bd1a4a71 299 /// command, including all command arguments
WiredHome 10:9e52bd1a4a71 300 /// @param kbhit is a user provided function to detect if a character is available for the CommandProcessor,
WiredHome 10:9e52bd1a4a71 301 /// and when using standard io, you can typically use kbhit, or _kbhit as your system provides.
WiredHome 10:9e52bd1a4a71 302 /// @param getch is a user provided function that provides a single character to the CommandProcessor
WiredHome 10:9e52bd1a4a71 303 /// @param putch is a user provided function that permits the CommandProcessor to output a character
WiredHome 10:9e52bd1a4a71 304 /// @param puts is a user provided function that permits the CommandProcessor to output a string
WiredHome 10:9e52bd1a4a71 305 /// to which is automatically appended a \\n
WiredHome 10:9e52bd1a4a71 306 /// @returns INITRESULT_T to indicate if the init was successful or failed
WiredHome 7:0f058d664b21 307 ///
WiredHome 7:0f058d664b21 308 INITRESULT_T CommandProcessor_Init(
WiredHome 10:9e52bd1a4a71 309 CMD_T (*SignOnBanner),
WiredHome 10:9e52bd1a4a71 310 CONFIG_T config,
WiredHome 7:0f058d664b21 311 int maxCmdLen,
WiredHome 7:0f058d664b21 312 int (*kbhit)(void),
WiredHome 7:0f058d664b21 313 int (*getch)(void),
WiredHome 7:0f058d664b21 314 int (*putch)(int ch),
WiredHome 7:0f058d664b21 315 int (*puts)(const char * s)
WiredHome 7:0f058d664b21 316 ) {
WiredHome 12:a8c56bf811b9 317 if (SignOnBanner) {
WiredHome 12:a8c56bf811b9 318 CommandProcessor.Add(SignOnBanner);
WiredHome 12:a8c56bf811b9 319 cfg.SignOnBanner = SignOnBanner;
WiredHome 12:a8c56bf811b9 320 cfg.showSignOnBanner = 1;
WiredHome 12:a8c56bf811b9 321 }
WiredHome 7:0f058d664b21 322 if (maxCmdLen < 6)
WiredHome 7:0f058d664b21 323 maxCmdLen = 6;
WiredHome 7:0f058d664b21 324 buffer = (char *)malloc(maxCmdLen+1);
WiredHome 7:0f058d664b21 325 cfg.bufferSize = maxCmdLen;
WiredHome 7:0f058d664b21 326 if (buffer) {
WiredHome 10:9e52bd1a4a71 327 if (config & CFG_ENABLE_SYSTEM)
WiredHome 12:a8c56bf811b9 328 {
WiredHome 7:0f058d664b21 329 CommandProcessor.Add(&QuestionMenu);
WiredHome 7:0f058d664b21 330 CommandProcessor.Add(&HelpMenu);
WiredHome 7:0f058d664b21 331 CommandProcessor.Add(&EchoMenu);
WiredHome 12:a8c56bf811b9 332 }
WiredHome 10:9e52bd1a4a71 333 if (config & CFG_ENABLE_TERMINATE)
WiredHome 7:0f058d664b21 334 CommandProcessor.Add(&ExitMenu);
WiredHome 10:9e52bd1a4a71 335 //if (addDefaultMenu & 0x0002)
WiredHome 10:9e52bd1a4a71 336 // CommandProcessor.Add(&AboutMenu);
WiredHome 10:9e52bd1a4a71 337 cfg.caseinsensitive = (config & CFG_CASE_INSENSITIVE) ? 1 : 0;
WiredHome 10:9e52bd1a4a71 338 cfg.echo = (config & CFG_ECHO_ON) ? 1 : 0;
WiredHome 7:0f058d664b21 339 cfg.kbhit = kbhit;
WiredHome 7:0f058d664b21 340 cfg.getch = getch;
WiredHome 7:0f058d664b21 341 cfg.putch = putch;
WiredHome 7:0f058d664b21 342 cfg.puts = puts;
WiredHome 7:0f058d664b21 343 return initok;
WiredHome 7:0f058d664b21 344 } else
WiredHome 7:0f058d664b21 345 return initfailed;
WiredHome 7:0f058d664b21 346 }
WiredHome 7:0f058d664b21 347
WiredHome 7:0f058d664b21 348 /// Add a command to the CommandProcessor
WiredHome 7:0f058d664b21 349 ///
WiredHome 7:0f058d664b21 350 /// This adds a command to the CommandProcessor. A command has several components
WiredHome 7:0f058d664b21 351 /// to it, including the command name, a brief description, the function to
WiredHome 7:0f058d664b21 352 /// activate when the command is entered, and a flag indicating if the command
WiredHome 7:0f058d664b21 353 /// should show up in the built-in help.
WiredHome 7:0f058d664b21 354 ///
WiredHome 7:0f058d664b21 355 /// @param menu is the menu to add to the CommandProcessor
WiredHome 7:0f058d664b21 356 /// @returns addok if the command was added
WiredHome 7:0f058d664b21 357 /// @returns addfail if the command could not be added (failure to allocate memory for the linked list)
WiredHome 7:0f058d664b21 358 ///
WiredHome 7:0f058d664b21 359 ADDRESULT_T CommandProcessor_Add(CMD_T * menu) {
WiredHome 7:0f058d664b21 360 CMDLINK_T *ptr;
WiredHome 7:0f058d664b21 361 CMDLINK_T *prev;
WiredHome 7:0f058d664b21 362 CMDLINK_T *temp;
WiredHome 7:0f058d664b21 363
WiredHome 12:a8c56bf811b9 364 if (strlen(menu->command) > longestCommand)
WiredHome 12:a8c56bf811b9 365 longestCommand = strlen(menu->command);
WiredHome 12:a8c56bf811b9 366
WiredHome 7:0f058d664b21 367 // Allocate the storage for this menu item
WiredHome 7:0f058d664b21 368 temp = (CMDLINK_T *)malloc(sizeof(CMDLINK_T));
WiredHome 7:0f058d664b21 369 if (!temp)
WiredHome 8:25581f24f7f9 370 return addfailed; // something went really bad
WiredHome 7:0f058d664b21 371 temp->menu = menu;
WiredHome 7:0f058d664b21 372 temp->next = NULL;
WiredHome 7:0f058d664b21 373
WiredHome 7:0f058d664b21 374 prev = ptr = head;
WiredHome 7:0f058d664b21 375 if (!ptr) {
WiredHome 8:25581f24f7f9 376 head = temp; // This installs the very first item
WiredHome 7:0f058d664b21 377 return addok;
WiredHome 7:0f058d664b21 378 }
WiredHome 7:0f058d664b21 379 // Search alphabetically for the insertion point
WiredHome 7:0f058d664b21 380 while (ptr && mystrnicmp(ptr->menu->command, menu->command, strlen(menu->command)) < 0) {
WiredHome 7:0f058d664b21 381 prev = ptr;
WiredHome 7:0f058d664b21 382 ptr = ptr->next;
WiredHome 7:0f058d664b21 383 }
WiredHome 12:a8c56bf811b9 384 if (prev == head) {
WiredHome 12:a8c56bf811b9 385 head = temp;
WiredHome 12:a8c56bf811b9 386 head->next = prev;
WiredHome 12:a8c56bf811b9 387 } else {
WiredHome 12:a8c56bf811b9 388 prev->next = temp;
WiredHome 12:a8c56bf811b9 389 prev = temp;
WiredHome 12:a8c56bf811b9 390 prev->next = ptr;
WiredHome 12:a8c56bf811b9 391 }
WiredHome 7:0f058d664b21 392 return addok;
WiredHome 7:0f058d664b21 393 }
WiredHome 7:0f058d664b21 394
WiredHome 7:0f058d664b21 395 /// Run the CommandProcessor
WiredHome 7:0f058d664b21 396 ///
WiredHome 7:0f058d664b21 397 /// This will peek to see if there is a keystroke ready. It will pull that into a
WiredHome 7:0f058d664b21 398 /// buffer if it is part of a valid command in the command set. You may then enter
WiredHome 7:0f058d664b21 399 /// arguments to the command to be run.
WiredHome 7:0f058d664b21 400 ///
WiredHome 7:0f058d664b21 401 /// Primitive editing is permitted with <bs>.
WiredHome 7:0f058d664b21 402 ///
WiredHome 7:0f058d664b21 403 /// When you press <enter> it will evaluate the command and execute the command
WiredHome 7:0f058d664b21 404 /// passing it the parameter string.
WiredHome 7:0f058d664b21 405 ///
WiredHome 7:0f058d664b21 406 /// @returns runok if the command that was run allows continuation of the CommandProcessor
WiredHome 7:0f058d664b21 407 /// @returns runfail if the command that was run is asking the CommandProcessor to exit
WiredHome 7:0f058d664b21 408 ///
WiredHome 7:0f058d664b21 409 RUNRESULT_T CommandProcessor_Run(void) {
WiredHome 7:0f058d664b21 410 static int showPrompt = TRUE;
WiredHome 7:0f058d664b21 411 static int keycount = 0; // how full?
WiredHome 7:0f058d664b21 412 RUNRESULT_T val = runok; // return true when happy, false to exit the prog
WiredHome 7:0f058d664b21 413 CMD_T *cbk = NULL;
WiredHome 7:0f058d664b21 414 char * params = NULL;
WiredHome 7:0f058d664b21 415
WiredHome 12:a8c56bf811b9 416 if (cfg.showSignOnBanner) {
WiredHome 12:a8c56bf811b9 417 cfg.SignOnBanner->callback("");
WiredHome 12:a8c56bf811b9 418 cfg.showSignOnBanner = 0;
WiredHome 12:a8c56bf811b9 419 }
WiredHome 7:0f058d664b21 420 if (showPrompt && cfg.echo) {
WiredHome 7:0f058d664b21 421 cfg.putch('>');
WiredHome 7:0f058d664b21 422 showPrompt = FALSE;
WiredHome 7:0f058d664b21 423 }
WiredHome 7:0f058d664b21 424 if (cfg.kbhit()) {
WiredHome 7:0f058d664b21 425 int c = cfg.getch();
WiredHome 7:0f058d664b21 426
WiredHome 7:0f058d664b21 427 switch (c) {
WiredHome 7:0f058d664b21 428 case 0x09: // <TAB> to request command completion
WiredHome 7:0f058d664b21 429 if (1 == CommandMatches(buffer, FALSE, &cbk, &params)) {
WiredHome 7:0f058d664b21 430 size_t n;
WiredHome 7:0f058d664b21 431 char *p = strchr(buffer, ' ');
WiredHome 7:0f058d664b21 432 if (p)
WiredHome 7:0f058d664b21 433 n = p - buffer;
WiredHome 7:0f058d664b21 434 else
WiredHome 7:0f058d664b21 435 n = strlen(buffer);
WiredHome 7:0f058d664b21 436 if (n < strlen(cbk->command)) {
WiredHome 7:0f058d664b21 437 p = cbk->command + strlen(buffer);
WiredHome 7:0f058d664b21 438 mystrcat(buffer, p);
WiredHome 7:0f058d664b21 439 keycount = strlen(buffer);
WiredHome 7:0f058d664b21 440 while (*p)
WiredHome 7:0f058d664b21 441 cfg.putch(*p++);
WiredHome 7:0f058d664b21 442 //cfg.printf("%s", p);
WiredHome 7:0f058d664b21 443 }
WiredHome 7:0f058d664b21 444 }
WiredHome 7:0f058d664b21 445 break;
WiredHome 7:0f058d664b21 446 case 0x1b: // <ESC> to empty the command buffer
WiredHome 7:0f058d664b21 447 while (keycount--) {
WiredHome 7:0f058d664b21 448 cfg.putch(0x08); // <bs>
WiredHome 7:0f058d664b21 449 cfg.putch(' ');
WiredHome 7:0f058d664b21 450 cfg.putch(0x08);
WiredHome 7:0f058d664b21 451 }
WiredHome 7:0f058d664b21 452 keycount = 0;
WiredHome 7:0f058d664b21 453 buffer[keycount] = '\0';
WiredHome 7:0f058d664b21 454 break;
WiredHome 7:0f058d664b21 455 case '\x08': // <bs>
WiredHome 7:0f058d664b21 456 if (keycount) {
WiredHome 7:0f058d664b21 457 buffer[--keycount] = '\0';
WiredHome 7:0f058d664b21 458 cfg.putch(0x08);
WiredHome 7:0f058d664b21 459 cfg.putch(' ');
WiredHome 7:0f058d664b21 460 cfg.putch(0x08);
WiredHome 7:0f058d664b21 461 } else
WiredHome 7:0f058d664b21 462 cfg.putch(0x07); // bell
WiredHome 7:0f058d664b21 463 break;
WiredHome 7:0f058d664b21 464 case '\r':
WiredHome 7:0f058d664b21 465 case '\n': {
WiredHome 7:0f058d664b21 466 int foundCount = 0;
WiredHome 7:0f058d664b21 467
WiredHome 7:0f058d664b21 468 if (strlen(buffer)) {
WiredHome 7:0f058d664b21 469 foundCount = CommandMatches(buffer, TRUE, &cbk, &params);
WiredHome 7:0f058d664b21 470 if (foundCount == 1) {
WiredHome 7:0f058d664b21 471 val = (*cbk->callback)(params); // Execute the command
WiredHome 7:0f058d664b21 472 } else if (foundCount > 1)
WiredHome 7:0f058d664b21 473 cfg.puts(" *** non-unique command ignored try 'Help' ***");
WiredHome 7:0f058d664b21 474 else if (foundCount == 0)
WiredHome 7:0f058d664b21 475 cfg.puts(" *** huh? try 'Help' ***");
WiredHome 7:0f058d664b21 476 } else
WiredHome 7:0f058d664b21 477 cfg.puts("");
WiredHome 7:0f058d664b21 478 keycount = 0;
WiredHome 7:0f058d664b21 479 buffer[keycount] = '\0';
WiredHome 7:0f058d664b21 480 showPrompt = TRUE; // forces the prompt
WiredHome 7:0f058d664b21 481 }
WiredHome 7:0f058d664b21 482 break;
WiredHome 7:0f058d664b21 483 default:
WiredHome 7:0f058d664b21 484 if (myisprint(c) && keycount < cfg.bufferSize) {
WiredHome 7:0f058d664b21 485 buffer[keycount++] = c;
WiredHome 7:0f058d664b21 486 buffer[keycount] = '\0';
WiredHome 7:0f058d664b21 487 if (CommandMatches(buffer, FALSE, &cbk, &params))
WiredHome 7:0f058d664b21 488 cfg.putch(c);
WiredHome 7:0f058d664b21 489 else {
WiredHome 7:0f058d664b21 490 buffer[--keycount] = '\0';
WiredHome 7:0f058d664b21 491 cfg.putch(0x07); // bell
WiredHome 7:0f058d664b21 492 }
WiredHome 7:0f058d664b21 493 } else
WiredHome 7:0f058d664b21 494 cfg.putch(0x07); // bell
WiredHome 7:0f058d664b21 495 break;
WiredHome 7:0f058d664b21 496 }
WiredHome 7:0f058d664b21 497 }
WiredHome 7:0f058d664b21 498 return val;
WiredHome 7:0f058d664b21 499 }
WiredHome 7:0f058d664b21 500
WiredHome 7:0f058d664b21 501 static RUNRESULT_T CommandProcessor_Echo(int echo) {
WiredHome 7:0f058d664b21 502 cfg.echo = echo;
WiredHome 7:0f058d664b21 503 return runok;
WiredHome 7:0f058d664b21 504 }
WiredHome 7:0f058d664b21 505
WiredHome 7:0f058d664b21 506 /// End the CommandProcessor by freeing all the memory that was allocated
WiredHome 7:0f058d664b21 507 ///
WiredHome 7:0f058d664b21 508 /// @returns runok
WiredHome 7:0f058d664b21 509 ///
WiredHome 7:0f058d664b21 510 RUNRESULT_T CommandProcessor_End(void) {
WiredHome 7:0f058d664b21 511 CMDLINK_T *p = head;
WiredHome 7:0f058d664b21 512 CMDLINK_T *n;
WiredHome 7:0f058d664b21 513
WiredHome 7:0f058d664b21 514 do {
WiredHome 7:0f058d664b21 515 n = p->next;
WiredHome 7:0f058d664b21 516 free(p); // free each of the allocated links to menu items.
WiredHome 7:0f058d664b21 517 p = n;
WiredHome 7:0f058d664b21 518 } while (n);
WiredHome 7:0f058d664b21 519 free(buffer); // finally, free the command buffer
WiredHome 7:0f058d664b21 520 buffer = NULL; // flag it as deallocated
WiredHome 7:0f058d664b21 521 return runok;
WiredHome 7:0f058d664b21 522 }
WiredHome 7:0f058d664b21 523
WiredHome 7:0f058d664b21 524
WiredHome 7:0f058d664b21 525 // Helper functions follow. These functions may exist in some environments and
WiredHome 7:0f058d664b21 526 // not in other combinations of libraries and compilers, so private versions
WiredHome 7:0f058d664b21 527 // are here to ensure consistent behavior.
WiredHome 7:0f058d664b21 528
WiredHome 0:198f53da1bc8 529 /// mytolower exists because not all compiler libraries have this function
WiredHome 0:198f53da1bc8 530 ///
WiredHome 0:198f53da1bc8 531 /// This takes a character and if it is upper-case, it converts it to
WiredHome 0:198f53da1bc8 532 /// lower-case and returns it.
WiredHome 0:198f53da1bc8 533 ///
WiredHome 7:0f058d664b21 534 /// @param a is the character to convert
WiredHome 0:198f53da1bc8 535 /// @returns the lower case equivalent to a
WiredHome 0:198f53da1bc8 536 ///
WiredHome 7:0f058d664b21 537 static char mytolower(char a) {
WiredHome 0:198f53da1bc8 538 if (a >= 'A' && a <= 'Z')
WiredHome 0:198f53da1bc8 539 return (a - 'A' + 'a');
WiredHome 0:198f53da1bc8 540 else
WiredHome 0:198f53da1bc8 541 return a;
WiredHome 0:198f53da1bc8 542 }
WiredHome 0:198f53da1bc8 543
WiredHome 0:198f53da1bc8 544 /// mystrnicmp exists because not all compiler libraries have this function.
WiredHome 0:198f53da1bc8 545 ///
WiredHome 0:198f53da1bc8 546 /// Some have strnicmp, others _strnicmp, and others have C++ methods, which
WiredHome 0:198f53da1bc8 547 /// is outside the scope of this C-portable set of functions.
WiredHome 0:198f53da1bc8 548 ///
WiredHome 7:0f058d664b21 549 /// @param l is a pointer to the string on the left
WiredHome 0:198f53da1bc8 550 /// @param r is a pointer to the string on the right
WiredHome 0:198f53da1bc8 551 /// @param n is the number of characters to compare
WiredHome 0:198f53da1bc8 552 /// @returns -1 if l < r
WiredHome 0:198f53da1bc8 553 /// @returns 0 if l == r
WiredHome 0:198f53da1bc8 554 /// @returns +1 if l > r
WiredHome 0:198f53da1bc8 555 ///
WiredHome 8:25581f24f7f9 556 static int mystrnicmp(const char *l, const char *r, size_t n) {
WiredHome 0:198f53da1bc8 557 int result = 0;
WiredHome 0:198f53da1bc8 558
WiredHome 7:0f058d664b21 559 if (n != 0) {
WiredHome 0:198f53da1bc8 560 do {
WiredHome 0:198f53da1bc8 561 result = mytolower(*l++) - mytolower(*r++);
WiredHome 0:198f53da1bc8 562 } while ((result == 0) && (*l != '\0') && (--n > 0));
WiredHome 0:198f53da1bc8 563 }
WiredHome 0:198f53da1bc8 564 if (result < -1)
WiredHome 0:198f53da1bc8 565 result = -1;
WiredHome 0:198f53da1bc8 566 else if (result > 1)
WiredHome 0:198f53da1bc8 567 result = 1;
WiredHome 0:198f53da1bc8 568 return result;
WiredHome 0:198f53da1bc8 569 }
WiredHome 0:198f53da1bc8 570
WiredHome 0:198f53da1bc8 571 /// mystrcat exists because not all compiler libraries have this function
WiredHome 0:198f53da1bc8 572 ///
WiredHome 7:0f058d664b21 573 /// This function concatinates one string onto another. It is generally
WiredHome 0:198f53da1bc8 574 /// considered unsafe, because of the potential for buffer overflow.
WiredHome 0:198f53da1bc8 575 /// Some libraries offer a strcat_s as the safe version, and others may have
WiredHome 0:198f53da1bc8 576 /// _strcat. Because this is needed only internal to the CommandProcessor,
WiredHome 0:198f53da1bc8 577 /// this version was created.
WiredHome 0:198f53da1bc8 578 ///
WiredHome 7:0f058d664b21 579 /// @param dst is a pointer to the destination string
WiredHome 0:198f53da1bc8 580 /// @param src is a pointer to the source string
WiredHome 0:198f53da1bc8 581 /// @returns nothing
WiredHome 0:198f53da1bc8 582 ///
WiredHome 7:0f058d664b21 583 static void mystrcat(char *dst, char *src) {
WiredHome 0:198f53da1bc8 584 while (*dst)
WiredHome 0:198f53da1bc8 585 dst++;
WiredHome 7:0f058d664b21 586 do
WiredHome 0:198f53da1bc8 587 *dst++ = *src;
WiredHome 0:198f53da1bc8 588 while (*src++);
WiredHome 0:198f53da1bc8 589 }
WiredHome 0:198f53da1bc8 590
WiredHome 0:198f53da1bc8 591 /// myisprint exists because not all compiler libraries have this function
WiredHome 0:198f53da1bc8 592 ///
WiredHome 0:198f53da1bc8 593 /// This function tests a character to see if it is printable (a member
WiredHome 0:198f53da1bc8 594 /// of the standard ASCII set).
WiredHome 0:198f53da1bc8 595 ///
WiredHome 0:198f53da1bc8 596 /// @param c is the character to test
WiredHome 0:198f53da1bc8 597 /// @returns TRUE if the character is printable
WiredHome 0:198f53da1bc8 598 /// @returns FALSE if the character is not printable
WiredHome 0:198f53da1bc8 599 ///
WiredHome 7:0f058d664b21 600 static int myisprint(int c) {
WiredHome 0:198f53da1bc8 601 if (c >= ' ' && c <= '~')
WiredHome 0:198f53da1bc8 602 return TRUE;
WiredHome 0:198f53da1bc8 603 else
WiredHome 0:198f53da1bc8 604 return FALSE;
WiredHome 0:198f53da1bc8 605 }
WiredHome 0:198f53da1bc8 606