- retired variable stuff.
[openocd.git] / src / helper / command.c
index ca08535a4039c6ed62913bfe3f14ec101f6e2afc..d2abb0c2ab43de4900667606f523f6d14785a6d6 100644 (file)
@@ -29,6 +29,7 @@
 #include "command.h"
 
 #include "log.h"
+#include "time_support.h"
 
 #include <stdlib.h>
 #include <string.h>
 #include <stdio.h>
 #include <unistd.h>
 
+int fast_and_dangerous = 0;
+
+void command_print_help_line(command_context_t* context, struct command_s *command, int indent);
+
 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);
+int handle_fast_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
+
+/* 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;
-}
 
 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)
 {
@@ -94,7 +69,6 @@ command_t* register_command(command_context_t *context, command_t *parent, char
                c->help = strdup(help);
        else
                c->help = NULL;
-       c->unique_len = 0;
        c->next = NULL;
        
        /* place command in tree */
@@ -127,12 +101,46 @@ command_t* register_command(command_context_t *context, command_t *parent, char
                }
        }
        
-       /* update unique lengths */
-       build_unique_lengths(context, (parent) ? parent : context->commands);
-       
        return c;
 }
 
+int unregister_all_commands(command_context_t *context)
+{
+       command_t *c, *c2;
+       
+       if (context == NULL)
+               return ERROR_OK;
+       
+       
+       while(NULL != context->commands)
+       {
+               c = context->commands;
+               
+               while(NULL != c->children)
+               {
+                       c2 = c->children;
+                       c->children = c->children->next;
+                       free(c2->name);
+                       c2->name = NULL;
+                       free(c2->help);
+                       c2->help = NULL;
+                       free(c2);
+                       c2 = NULL;
+               }
+               
+               context->commands = context->commands->next;
+               
+               free(c->name);
+               c->name = NULL;
+               free(c->help);
+               c->help = NULL;
+               free(c);
+               c = NULL;               
+       }
+       
+       return ERROR_OK;
+}
+
 int unregister_command(command_context_t *context, char *name)
 {
        command_t *c, *p = NULL, *c2;
@@ -200,14 +208,24 @@ int parse_line(char *line, char *words[], int max_words)
                        /* we're inside a word or quote, and reached its end*/
                        if (word_start)
                        {
-                               int len = p - word_start;
-
-                               /* copy the word */
-                               memcpy(words[nwords] = malloc(len + 1), word_start, len);
-                               /* add terminating NUL */
-                               words[nwords++][len] = 0;
+                               int len;
+                               char *word_end=p;
+                               
+                               /* This will handle extra whitespace within quotes */
+                               while (isspace(*word_start)&&(word_start<word_end))
+                                       word_start++;
+                               while (isspace(*(word_end-1))&&(word_start<word_end))
+                                       word_end--;
+                               len = word_end - word_start;
+                               
+                               if (len>0)
+                               {
+                                       /* copy the word */
+                                       memcpy(words[nwords] = malloc(len + 1), word_start, len);
+                                       /* add terminating NUL */
+                                       words[nwords++][len] = 0;
+                               }
                        }
-
                        /* we're done parsing the line */
                        if (!*p)
                                break;
@@ -215,7 +233,9 @@ int parse_line(char *line, char *words[], int max_words)
                        /* skip over trailing quote or whitespace*/
                        if (inquote || isspace(*p))
                                p++;
-
+                       while (isspace(*p))
+                               p++;
+                       
                        inquote = 0;
                        word_start = 0;
                }
@@ -239,103 +259,125 @@ int parse_line(char *line, char *words[], int max_words)
        return nwords;
 }
 
-void command_print(command_context_t *context, char *format, ...)
+void command_output_text(command_context_t *context, const char *data)
 {
-       va_list ap;
-       char *buffer = NULL;
-       int n, size = 0;
-       char *p;
+       if( context && context->output_handler && data  ){
+               context->output_handler( context, data );
+       }
+}
 
-       va_start(ap, format);
+void command_print_n(command_context_t *context, char *format, ...)
+{
+       char *string;
        
-       /* process format string */
-       /* TODO: possible bug. va_list is undefined after the first call to vsnprintf */
-       while (!buffer || (n = vsnprintf(buffer, size, format, ap)) >= size)
-       {
-               /* increase buffer until it fits the whole string */
-               if (!(p = realloc(buffer, size += 4096)))
-                       return;
+       va_list ap;
+       va_start(ap, format);
 
-               buffer = p;
+       string = alloc_vprintf(format, ap);
+       if (string != NULL)
+       {
+               context->output_handler(context, string);
+               free(string);
        }
-       
-       /* vsnprintf failed */
-       if (n < 0)
-               return;
 
-       p = buffer;
-       
-       /* process lines in buffer */
-       do {
-               char *next = strchr(p, '\n');
-               
-               if (next)
-                       *next++ = 0;
+       va_end(ap);
+}
 
-               if (context->output_handler)
-                       context->output_handler(context, p);
+void command_print(command_context_t *context, char *format, ...)
+{
+       char *string;
+
+       va_list ap;
+       va_start(ap, format);
+
+       string = alloc_vprintf(format, ap);
+       if (string != NULL)
+       {
+               strcat(string, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
+               context->output_handler(context, string);
+               free(string);
+       }
 
-               p = next;
-       } while (p);
-       
-       if (buffer)
-               free(buffer);
-       
        va_end(ap);
 }
 
-int find_and_run_command(command_context_t *context, command_t *commands, char *words[], int num_words, int start_word)
+command_t *find_command(command_context_t *context, command_t *commands, char *words[], int num_words, int start_word, int *new_start_word)
 {
        command_t *c;
        
        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 ((c->mode == context->mode) || (c->mode == COMMAND_ANY))
+               if ((context->mode == COMMAND_CONFIG) || (c->mode == COMMAND_ANY) || (c->mode == context->mode) )
                {
                        if (!c->children)
                        {
                                if (!c->handler)
                                {
-                                       command_print(context, "No handler for command");
-                                       break;
+                                       return NULL;
                                }
                                else
                                {
-                                       return c->handler(context, c->name, words + start_word + 1, num_words - start_word - 1);
+                                       *new_start_word=start_word;
+                                       return c;
                                }
                        }
                        else
                        {
                                if (start_word == num_words - 1)
                                {
-                                       command_print(context, "Incomplete command");
-                                       break;
+                                       return NULL;
                                }
-                               return find_and_run_command(context, c->children, words, num_words, start_word + 1);
+                               return find_command(context, c->children, words, num_words, start_word + 1, new_start_word);
                        }
                }
        }
+       return NULL;
+}
+
+int find_and_run_command(command_context_t *context, command_t *commands, char *words[], int num_words)
+{
+       int start_word=0;
+       command_t *c;
+       c = find_command(context, commands, words, num_words, start_word, &start_word);
+       if (c == NULL)
+       {
+               /* just return command not found */
+               return ERROR_COMMAND_NOTFOUND;
+       }
        
-       command_print(context, "Command %s not found", words[start_word]);
-       return ERROR_OK;
+       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)
+       {
+               /* just fall through for a shutdown request */
+       }
+       else if (retval != ERROR_OK)
+       {
+               /* we do not print out an error message because the command *should*
+                * have printed out an error
+                */
+               LOG_DEBUG("Command failed with error code %d", retval); 
+       }
+       
+       return retval; 
 }
 
-int command_run_line(command_context_t *context, char *line)
+int command_run_line_internal(command_context_t *context, char *line)
 {
+       LOG_USER_N("%s", ""); /* Keep GDB connection alive*/ 
+       
        int nwords;
        char *words[128] = {0};
        int retval;
        int i;
-       
-       if ((!context) || (!line))
-               return ERROR_INVALID_ARGUMENTS;
-       
+
        /* skip preceding whitespace */
        while (isspace(*line))
                line++;
@@ -344,15 +386,18 @@ int command_run_line(command_context_t *context, char *line)
        if (!*line)
                return ERROR_OK;
        
-       if (context->echo)
-       {
-               command_print(context, "%s", line);
-       }
+       /* ignore comments */
+       if (*line && (line[0] == '#'))
+               return ERROR_OK;
+       
+       LOG_DEBUG("%s", line);
 
        nwords = parse_line(line, words, sizeof(words) / sizeof(words[0]));
        
        if (nwords > 0)
-               retval = find_and_run_command(context, context->commands, words, nwords, 0);
+       {
+               retval = find_and_run_command(context, context->commands, words, nwords);
+       }
        else
                return ERROR_INVALID_ARGUMENTS;
        
@@ -362,77 +407,57 @@ int command_run_line(command_context_t *context, char *line)
        return retval;
 }
 
-int command_run_file(command_context_t *context, FILE *file, enum command_mode mode)
+int command_run_line(command_context_t *context, char *line)
 {
-       int retval;
-       int old_command_mode;
-       char buffer[4096];
-       
-       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;
+       /* 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);
+}
 
-               /* 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;
+int command_run_linef(command_context_t *context, char *format, ...)
+{
+       int retval=ERROR_FAIL;
+       char *string;
+       va_list ap;
+       va_start(ap, format);
+       string = alloc_vprintf(format, ap);
+       if (string!=NULL)
+       {
+               retval=command_run_line(context, string);
        }
-       
-       context->mode = old_command_mode;
-       
+       va_end(ap);
        return retval;
 }
 
 void command_print_help_line(command_context_t* context, struct command_s *command, int indent)
 {
        command_t *c;
-       char indents[32] = {0};
+       char *indent_text=malloc(indent + 2);
+       
        char *help = "no help available";
        char name_buf[64];
-       int i;
        
-       for (i = 0; i < indent; i+=2)
+       if (indent)
        {
-               indents[i*2] = ' ';
-               indents[i*2+1] = '-';
+           indent_text[0] = ' ';
+           memset(indent_text + 1, '-', indent);
+           indent_text[indent + 1] = 0;
        }
-       indents[i*2] = 0;
        
-       if ((command->mode == COMMAND_EXEC) || (command->mode == COMMAND_ANY))
-       {
-               if (command->help)
-                       help = command->help;
+       if (command->help)
+               help = command->help;
                
-               snprintf(name_buf, 64, command->name);
-               strncat(name_buf, indents, 64);
-               command_print(context, "%20s\t%s", name_buf, 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)
        {
@@ -441,22 +466,26 @@ void command_print_help_line(command_context_t* context, struct command_s *comma
                        command_print_help_line(context, c, indent + 1);
                }
        }
+       free(indent_text);
 }
 
-int command_print_help(command_context_t* context, char* name, char** args, int argc)
+int command_print_help_match(command_context_t* context, command_t* c_first, char* name, char** args, int argc)
 {
-       command_t *c;
+       command_t * c;
 
-       for (c = context->commands; c; c = c->next)
+       for (c = c_first; c; c = c->next)
        {
-               if (argc == 1)
+               if (argc > 0)
                {
-                        if (strncasecmp(c->name, args[0], c->unique_len))
-                                continue;
+                       if (strcasecmp(c->name, args[0]))
+                               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);
        }
@@ -464,7 +493,12 @@ int command_print_help(command_context_t* context, char* name, char** args, int
        return ERROR_OK;
 }
 
-void command_set_output_handler(command_context_t* context, int (*output_handler)(struct command_context_s *context, char* line), void *priv)
+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, const char* line), void *priv)
 {
        context->output_handler = output_handler;
        context->output_handler_priv = priv;
@@ -482,6 +516,7 @@ command_context_t* copy_command_context(command_context_t* context)
 int command_done(command_context_t *context)
 {
        free(context);
+       context = NULL;
        
        return ERROR_OK;
 }
@@ -493,7 +528,6 @@ command_context_t* command_init()
        context->mode = COMMAND_EXEC;
        context->commands = NULL;
        context->current_target = 0;
-       context->echo = 0;
        context->output_handler = NULL;
        context->output_handler_priv = NULL;
        
@@ -503,6 +537,12 @@ command_context_t* command_init()
        register_command(context, NULL, "sleep", handle_sleep_command,
                                         COMMAND_ANY, "sleep for <n> milliseconds");
        
+       register_command(context, NULL, "time", handle_time_command,
+                                        COMMAND_ANY, "time <cmd + args> - execute <cmd + args> and print time it took");
+       
+       register_command(context, NULL, "fast", handle_fast_command,
+                                        COMMAND_ANY, "fast <enable/disable> - place at beginning of config files. Sets defaults to fast and dangerous.");
+       
        return context;
 }
 
@@ -521,3 +561,43 @@ int handle_sleep_command(struct command_context_s *cmd_ctx, char *cmd, char **ar
 
        return ERROR_OK;
 }
+
+int handle_fast_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+{
+       if (argc!=1)
+               return ERROR_COMMAND_SYNTAX_ERROR;
+       
+       fast_and_dangerous = strcmp("enable", args[0])==0;
+       
+       return ERROR_OK;
+}
+
+
+int handle_time_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+{
+       duration_t duration;
+       char *duration_text;
+       int retval;
+       float t;
+       
+       if (argc<1)
+               return ERROR_COMMAND_SYNTAX_ERROR;
+       
+       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);
+       
+       t=duration.duration.tv_sec;
+       t+=((float)duration.duration.tv_usec / 1000000.0);
+       command_print(cmd_ctx, "%s took %fs", args[0], t);
+       
+       free(duration_text);
+
+       return retval;
+}

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)