add extended help feature

diff --git a/winsrc/command.cpp b/winsrc/command.cpp
index 349ede695886c17c79dad93cf893e9854efb3be0..86b0d4466e62abdfdb0c5dc23809694522422dc0 100644 (file)
--- a/winsrc/command.cpp
+++ b/winsrc/command.cpp
@@ -2647,6 +2647,14 @@ static struct {
        {"zerocrossings",       CmdZerocrossings,1,     "    Count time between zero-crossings"},\r
 };\r
 \r
        {"zerocrossings",       CmdZerocrossings,1,     "    Count time between zero-crossings"},\r
 };\r
 \r

+static struct {\r
+       char *name;\r
+       char *args;\r
+       char *argshelp;\r
+       char *description;\r
+       }       CommandExtendedHelp[]= {\r
+               {"detectreader","'l'|'h'","'l' specifies LF antenna scan only, 'h' specifies HF antenna scan only.","Monitor antenna for changes in voltage. Output is in three fields: CHANGED, CURRENT, PERIOD,\nwhere CHANGED is the value just changed from, CURRENT is the current value and PERIOD is the\nnumber of program loops since the last change.\n\nThe RED LED indicates LF field detected, and the GREEN LED indicates HF field detected.\n"},\r
+               };\r

 \r
 //-----------------------------------------------------------------------------\r
 // Entry point into our code: called whenever the user types a command and\r
 \r
 //-----------------------------------------------------------------------------\r
 // Entry point into our code: called whenever the user types a command and\r


@@ -2655,15 +2663,29 @@ static struct {
 void CommandReceived(char *cmd)\r
 {\r
        int i;\r
 void CommandReceived(char *cmd)\r
 {\r
        int i;\r

+       char line[256];\r

 \r
        PrintToScrollback("> %s", cmd);\r
 \r
 \r
        PrintToScrollback("> %s", cmd);\r
 \r

-       if(strcmp(cmd, "help")==0) {\r
+       if(strcmp(cmd, "help") == 0 || strncmp(cmd,"help ",strlen("help ")) == 0) {\r
+               // check if we're doing extended help\r
+               if(strlen(cmd) > strlen("help ")) {\r
+                       cmd += strlen("help ");\r
+                       for(i = 0; i < sizeof(CommandExtendedHelp) / sizeof(CommandExtendedHelp[0]); i++) {\r
+                               if(strcmp(CommandExtendedHelp[i].name,cmd) == 0) {\r
+                                       PrintToScrollback("\nExtended help for '%s':\n", cmd);\r
+                                       PrintToScrollback("Args: %s\t- %s\n",CommandExtendedHelp[i].args,CommandExtendedHelp[i].argshelp);\r
+                                       PrintToScrollback(CommandExtendedHelp[i].description);\r
+                                       return;\r
+                               }\r
+                       }\r
+               PrintToScrollback("No extended help available for '%s'", cmd);\r
+               return;\r
+               }\r

                if (offline) PrintToScrollback("Operating in OFFLINE mode (no device connected)");\r
                PrintToScrollback("\r\nAvailable commands:");\r
                for(i = 0; i < sizeof(CommandTable) / sizeof(CommandTable[0]); i++) {\r
                        if (offline && (CommandTable[i].offline==0)) continue;\r
                if (offline) PrintToScrollback("Operating in OFFLINE mode (no device connected)");\r
                PrintToScrollback("\r\nAvailable commands:");\r
                for(i = 0; i < sizeof(CommandTable) / sizeof(CommandTable[0]); i++) {\r
                        if (offline && (CommandTable[i].offline==0)) continue;\r

-                       char line[256];\r

                        memset(line, ' ', sizeof(line));\r
                        strcpy(line+2, CommandTable[i].name);\r
                        line[strlen(line)] = ' ';\r
                        memset(line, ' ', sizeof(line));\r
                        strcpy(line+2, CommandTable[i].name);\r
                        line[strlen(line)] = ' ';\r


@@ -2671,7 +2693,7 @@ void CommandReceived(char *cmd)
                        PrintToScrollback("%s", line);\r
                }\r
                PrintToScrollback("");\r
                        PrintToScrollback("%s", line);\r
                }\r
                PrintToScrollback("");\r

-               PrintToScrollback("and also: help, cls");\r
+               PrintToScrollback("'help <command>' for extended help on that command");\r

                return;\r
        }\r
 \r
                return;\r
        }\r
 \r