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