help is now implemented in startup.tcl/help
[openocd.git] / src / helper / command.c
index ed0a82e6218946c51a6b683a1604f4be20136a42..45b66d60006ac3f74584d8991a96e66fa0e75c1d 100644 (file)
@@ -38,9 +38,9 @@
 #include <stdio.h>
 #include <unistd.h>
 
-int fast_and_dangerous = 0;
+#include <openocd_tcl.h>
 
-void command_print_help_line(command_context_t* context, struct command_s *command, int indent);
+int fast_and_dangerous = 0;
 
 int handle_sleep_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
 int handle_time_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
@@ -49,52 +49,11 @@ int handle_fast_command(struct command_context_s *cmd_ctx, char *cmd, char **arg
 /* forward declaration of jim_command */
 extern int jim_command(command_context_t *context, char *line);
 
-int build_unique_lengths(command_context_t *context, command_t *commands)
-{
-       command_t *c, *p;
-
-       /* iterate through all commands */
-       for (c = commands; c; c = c->next)
-       {
-               /* find out how many characters are required to uniquely identify a command */
-               for (c->unique_len = 1; c->unique_len <= strlen(c->name); c->unique_len++)
-               {
-                       int foundmatch = 0;
-                       
-                       /* for every command, see if the current length is enough */
-                       for (p = commands; p; p = p->next)
-                       {
-                               /* ignore the command itself */
-                               if (c == p)
-                                       continue;
-                               
-                               /* compare commands up to the current length */
-                               if (strncmp(p->name, c->name, c->unique_len) == 0)
-                                       foundmatch++;
-                       }
-                       
-                       /* when none of the commands matched, we've found the minimum length required */
-                       if (!foundmatch)
-                               break;
-               }
-               
-               /* if the current command has children, build the unique lengths for them */
-               if (c->children)
-                       build_unique_lengths(context, c->children);
-       }
-       
-       return ERROR_OK;
-}
 
-/* Avoid evaluating this each time we add a command. Reduces overhead from O(n^2) to O(n). 
- * Makes a difference on ARM7 types machines and is not observable on GHz machines.
- */
-static int unique_length_dirty = 1; 
 
 command_t* register_command(command_context_t *context, command_t *parent, char *name, int (*handler)(struct command_context_s *context, char* name, char** args, int argc), enum command_mode mode, char *help)
 {
        command_t *c, *p;
-       unique_length_dirty = 1;
        
        if (!context || !name)
                return NULL;
@@ -106,11 +65,8 @@ command_t* register_command(command_context_t *context, command_t *parent, char
        c->children = NULL;
        c->handler = handler;
        c->mode = mode;
-       if (help)
-               c->help = strdup(help);
-       else
-               c->help = NULL;
-       c->unique_len = 0;
+       if (!help)
+               help="";
        c->next = NULL;
        
        /* place command in tree */
@@ -142,7 +98,22 @@ command_t* register_command(command_context_t *context, command_t *parent, char
                        context->commands = c;
                }
        }
+       /* accumulate help text in Tcl helptext list.  */
+    Jim_Obj *helptext=Jim_GetGlobalVariableStr(interp, "ocd_helptext", JIM_ERRMSG);
+       Jim_Obj *cmd_entry=Jim_NewListObj(interp, NULL, 0);
+       
+       Jim_Obj *cmd_list=Jim_NewListObj(interp, NULL, 0);
+
+       /* maximum of two levels :-) */
+       if (c->parent!=NULL)
+       {
+               Jim_ListAppendElement(interp, cmd_list, Jim_NewStringObj(interp, c->parent->name, -1));
+       } 
+       Jim_ListAppendElement(interp, cmd_list, Jim_NewStringObj(interp, c->name, -1));
        
+       Jim_ListAppendElement(interp, cmd_entry, cmd_list);
+       Jim_ListAppendElement(interp, cmd_entry, Jim_NewStringObj(interp, help, -1));
+       Jim_ListAppendElement(interp, helptext, cmd_entry);
        return c;
 }
 
@@ -150,8 +121,6 @@ int unregister_all_commands(command_context_t *context)
 {
        command_t *c, *c2;
        
-       unique_length_dirty = 1;
-       
        if (context == NULL)
                return ERROR_OK;
        
@@ -166,8 +135,6 @@ int unregister_all_commands(command_context_t *context)
                        c->children = c->children->next;
                        free(c2->name);
                        c2->name = NULL;
-                       free(c2->help);
-                       c2->help = NULL;
                        free(c2);
                        c2 = NULL;
                }
@@ -176,8 +143,6 @@ int unregister_all_commands(command_context_t *context)
                
                free(c->name);
                c->name = NULL;
-               free(c->help);
-               c->help = NULL;
                free(c);
                c = NULL;               
        }
@@ -189,8 +154,6 @@ int unregister_command(command_context_t *context, char *name)
 {
        command_t *c, *p = NULL, *c2;
        
-       unique_length_dirty = 1;
-       
        if ((!context) || (!name))
                return ERROR_INVALID_ARGUMENTS;
        
@@ -215,16 +178,12 @@ int unregister_command(command_context_t *context, char *name)
                                for (c2 = c->children; c2; c2 = c2->next)
                                {
                                        free(c2->name);
-                                       if (c2->help)
-                                               free(c2->help);
                                        free(c2);
                                }
                        }
                        
                        /* delete command */
                        free(c->name);
-                       if (c->help)
-                               free(c->help);
                        free(c);
                }
                
@@ -305,6 +264,13 @@ int parse_line(char *line, char *words[], int max_words)
        return nwords;
 }
 
+void command_output_text(command_context_t *context, const char *data)
+{
+       if( context && context->output_handler && data  ){
+               context->output_handler( context, data );
+       }
+}
+
 void command_print_n(command_context_t *context, char *format, ...)
 {
        char *string;
@@ -344,21 +310,11 @@ command_t *find_command(command_context_t *context, command_t *commands, char *w
 {
        command_t *c;
        
-       if (unique_length_dirty)
-       {
-               unique_length_dirty = 0;
-               /* update unique lengths */
-               build_unique_lengths(context, context->commands);
-       }
-       
        for (c = commands; c; c = c->next)
        {
-               if (strncasecmp(c->name, words[start_word], c->unique_len))
+               if (strcasecmp(c->name, words[start_word]))
                        continue;
 
-               if (strncasecmp(c->name, words[start_word], strlen(words[start_word])))
-                       continue;
-               
                if ((context->mode == COMMAND_CONFIG) || (c->mode == COMMAND_ANY) || (c->mode == context->mode) )
                {
                        if (!c->children)
@@ -390,18 +346,17 @@ int find_and_run_command(command_context_t *context, command_t *commands, char *
 {
        int start_word=0;
        command_t *c;
-       c=find_command(context, commands, words, num_words, start_word, &start_word);
-       if (c==NULL)
+       c = find_command(context, commands, words, num_words, start_word, &start_word);
+       if (c == NULL)
        {
-               command_print(context, "Command %s not found", words[start_word]);
-               return ERROR_COMMAND_SYNTAX_ERROR;
+               /* just return command not found */
+               return ERROR_COMMAND_NOTFOUND;
        }
        
        int retval = c->handler(context, c->name, words + start_word + 1, num_words - start_word - 1);
        if (retval == ERROR_COMMAND_SYNTAX_ERROR)
        {
-               command_print(context, "Syntax error:");
-               command_print_help_line(context, c, 0);
+               
        }
        else if (retval == ERROR_COMMAND_CLOSE_CONNECTION)
        {
@@ -414,10 +369,11 @@ int find_and_run_command(command_context_t *context, command_t *commands, char *
                 */
                LOG_DEBUG("Command failed with error code %d", retval); 
        }
+       
        return retval; 
 }
 
-int command_run_line_internal_op(command_context_t *context, char *line, int run)
+int command_run_line_internal(command_context_t *context, char *line)
 {
        LOG_USER_N("%s", ""); /* Keep GDB connection alive*/ 
        
@@ -443,14 +399,9 @@ int command_run_line_internal_op(command_context_t *context, char *line, int run
        nwords = parse_line(line, words, sizeof(words) / sizeof(words[0]));
        
        if (nwords > 0)
-               if (run)
-               {
-                       retval = find_and_run_command(context, context->commands, words, nwords);
-               } else
-               {
-                       int t;
-                       return (find_command(context, context->commands, words, nwords, 0, &t)!=NULL)?ERROR_OK:ERROR_FAIL;
-               }
+       {
+               retval = find_and_run_command(context, context->commands, words, nwords);
+       }
        else
                return ERROR_INVALID_ARGUMENTS;
        
@@ -460,84 +411,17 @@ int command_run_line_internal_op(command_context_t *context, char *line, int run
        return retval;
 }
 
-int command_run_line_internal(command_context_t *context, char *line)
-{
-       return command_run_line_internal_op(context, line, 1);
-}
-
 int command_run_line(command_context_t *context, char *line)
 {
-       if ((!context) || (!line))
-               return ERROR_INVALID_ARGUMENTS;
-
-       if (command_run_line_internal_op(context, line, 0)!=ERROR_OK)
-       {
-               /* If we can't find a command, then try the interpreter. 
-                * If there is no interpreter implemented, then this will
-                * simply print a syntax error.
-                * 
-                * These hooks were left in to reduce patch size for 
-                * wip to add scripting language.
-                */
-               return jim_command(context, line);
-       }
-
-       return command_run_line_internal(context, line);
+       /* if a command is unknown to the "unknown" proc in tcl/commands.tcl will
+        * redirect it to OpenOCD.
+        * 
+        * This avoids having to type the "openocd" prefix and makes OpenOCD
+        * commands "native" to Tcl.
+        */
+       return jim_command(context, line);
 }
 
-int command_run_file(command_context_t *context, FILE *file, enum command_mode mode)
-{
-       int retval = ERROR_OK;
-       int old_command_mode;
-       char *buffer=malloc(4096);
-       if (buffer==NULL)
-       {
-               return ERROR_INVALID_ARGUMENTS;
-       }
-       
-       old_command_mode = context->mode;
-       context->mode = mode;
-       
-       while (fgets(buffer, 4096, file))
-       {
-               char *p;
-               char *cmd, *end;
-               
-               /* stop processing line after a comment (#, !) or a LF, CR were encountered */
-               if ((p = strpbrk(buffer, "#!\r\n")))
-                       *p = 0;
-
-               /* skip over leading whitespace */
-               cmd = buffer;
-               while (isspace(*cmd))
-                       cmd++;
-
-               /* empty (all whitespace) line? */
-               if (!*cmd)
-                       continue;
-               
-               /* search the end of the current line, ignore trailing whitespace */
-               for (p = end = cmd; *p; p++)
-                       if (!isspace(*p))
-                               end = p;
-               
-               /* terminate end */
-               *++end = 0;
-               if (strcasecmp(cmd, "quit") == 0)
-                       break;
-
-               /* run line */
-               if ((retval = command_run_line(context, cmd)) == ERROR_COMMAND_CLOSE_CONNECTION)
-                       break;
-       }
-       
-       context->mode = old_command_mode;
-
-       
-       free(buffer);
-       
-       return retval;
-}
 
 int command_run_linef(command_context_t *context, char *format, ...)
 {
@@ -554,74 +438,9 @@ int command_run_linef(command_context_t *context, char *format, ...)
        return retval;
 }
 
-void command_print_help_line(command_context_t* context, struct command_s *command, int indent)
-{
-       command_t *c;
-       char *indent_text=malloc(indent + 2);
-       
-       char *help = "no help available";
-       char name_buf[64];
-       
-       if (indent)
-       {
-           indent_text[0] = ' ';
-           memset(indent_text + 1, '-', indent);
-           indent_text[indent + 1] = 0;
-       }
-       
-       if (command->help)
-               help = command->help;
-               
-       snprintf(name_buf, 64, command->name);
 
-       if (indent)
-           strncat(name_buf, indent_text, 64);
 
-       command_print(context, "%20s\t%s", name_buf, help, indent);
-       
-       if (command->children)
-       {
-               for (c = command->children; c; c = c->next)
-               {
-                       command_print_help_line(context, c, indent + 1);
-               }
-       }
-       free(indent_text);
-}
-
-int command_print_help_match(command_context_t* context, command_t* c_first, char* name, char** args, int argc)
-{
-       command_t * c;
-
-       for (c = c_first; c; c = c->next)
-       {
-               if (argc > 0)
-               {
-                       if (strncasecmp(c->name, args[0], c->unique_len))
-                               continue;
-
-                       if (strncasecmp(c->name, args[0], strlen(args[0])))
-                               continue;
-
-                       if (argc > 1)
-                       {
-                               command_print_help_match(context, c->children, name, args + 1, argc - 1);
-                               continue;
-                       }
-               }
-
-               command_print_help_line(context, c, 0);
-       }
-       
-       return ERROR_OK;
-}
-
-int command_print_help(command_context_t* context, char* name, char** args, int argc)
-{
-    return command_print_help_match(context, context->commands, name, args, argc);
-}
-
-void command_set_output_handler(command_context_t* context, int (*output_handler)(struct command_context_s *context, char* line), void *priv)
+void command_set_output_handler(command_context_t* context, int (*output_handler)(struct command_context_s *context, const char* line), void *priv)
 {
        context->output_handler = output_handler;
        context->output_handler_priv = priv;
@@ -654,9 +473,6 @@ command_context_t* command_init()
        context->output_handler = NULL;
        context->output_handler_priv = NULL;
        
-       register_command(context, NULL, "help", command_print_help,
-                                        COMMAND_EXEC, "display this help");
-       
        register_command(context, NULL, "sleep", handle_sleep_command,
                                         COMMAND_ANY, "sleep for <n> milliseconds");
        
@@ -709,6 +525,10 @@ int handle_time_command(struct command_context_s *cmd_ctx, char *cmd, char **arg
        duration_start_measure(&duration);
        
        retval = find_and_run_command(cmd_ctx, cmd_ctx->commands, args, argc);
+       if (retval == ERROR_COMMAND_NOTFOUND)
+       {
+               command_print(cmd_ctx, "Command %s not found", args[0]);
+       }
        
        duration_stop_measure(&duration, &duration_text);
        

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read https://review.openocd.org/login/?link to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)