#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);
int handle_fast_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
+static void tcl_output(void *privData, const char *file, int line, const char *function, const char *string)
+{
+ Jim_Obj *tclOutput=(Jim_Obj *)privData;
+
+ Jim_AppendString(interp, tclOutput, string, strlen(string));
+}
-int build_unique_lengths(command_context_t *context, command_t *commands)
+static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
{
- command_t *c, *p;
+ /* the private data is stashed in the interp structure */
+ command_t *c;
+ command_context_t *context;
+ int *retval;
+ int i;
+ int nwords;
+ char **words;
+
+ target_call_timer_callbacks_now();
+ LOG_USER_N("%s", ""); /* Keep GDB connection alive*/
+
+ c = interp->cmdPrivData;
+ LOG_DEBUG("script_command - %s", c->name);
- /* iterate through all commands */
- for (c = commands; c; c = c->next)
+ nwords = argc;
+ words = malloc(sizeof(char *) * nwords);
+ for (i = 0; i < nwords; i++)
{
- /* 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 len;
+
+ words[i] = strdup(Jim_GetString(argv[i], &len));
+ if (words[i] == NULL)
{
- 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;
+ return JIM_ERR;
}
+ LOG_DEBUG("script_command - %s, argv[%u]=%s", c->name, i, words[i]);
+ }
+
+ /* grab the command context from the associated data */
+ context = Jim_GetAssocData(interp, "context");
+ retval = Jim_GetAssocData(interp, "retval");
+ if (context != NULL && retval != NULL)
+ {
+ /* capture log output and return it */
+ Jim_Obj *tclOutput = Jim_NewStringObj(interp, "", 0);
+ log_add_callback(tcl_output, tclOutput);
- /* if the current command has children, build the unique lengths for them */
- if (c->children)
- build_unique_lengths(context, c->children);
+ *retval = run_command(context, c, words, nwords);
+
+ log_remove_callback(tcl_output, tclOutput);
+
+ /* We dump output into this local variable */
+ Jim_SetVariableStr(interp, "openocd_output", tclOutput);
}
-
- 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;
+ for (i = 0; i < nwords; i++)
+ free(words[i]);
+ free(words);
+
+ return (*retval==ERROR_OK)?JIM_OK:JIM_ERR;
+}
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;
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 */
}
}
+ /* just a placeholder, no handler */
+ if (c->handler==NULL)
+ return c;
+
+ /* If this is a two level command, e.g. "flash banks", then the
+ * "unknown" proc in startup.tcl must redirect to this command.
+ *
+ * "flash banks" is translated by "unknown" to "flash_banks"
+ * if such a proc exists
+ */
+ /* Print help for command */
+ const char *t1="";
+ const char *t2="";
+ const char *t3="";
+ /* maximum of two levels :-) */
+ if (c->parent!=NULL)
+ {
+ t1=c->parent->name;
+ t2="_";
+ }
+ t3=c->name;
+ const char *full_name=alloc_printf("%s%s%s", t1, t2, t3);
+ Jim_CreateCommand(interp, full_name, script_command, c, NULL);
+ free((void *)full_name);
+
+
+ /* accumulate help text in Tcl helptext list. */
+ Jim_Obj *helptext=Jim_GetGlobalVariableStr(interp, "ocd_helptext", JIM_ERRMSG);
+ if (Jim_IsShared(helptext))
+ helptext = Jim_DuplicateObj(interp, helptext);
+ 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;
}
{
command_t *c, *c2;
- unique_length_dirty = 1;
-
if (context == NULL)
return ERROR_OK;
c->children = c->children->next;
free(c2->name);
c2->name = NULL;
- free(c2->help);
- c2->help = NULL;
free(c2);
c2 = NULL;
}
free(c->name);
c->name = NULL;
- free(c->help);
- c->help = NULL;
free(c);
c = NULL;
}
{
command_t *c, *p = NULL, *c2;
- unique_length_dirty = 1;
-
if ((!context) || (!name))
return ERROR_INVALID_ARGUMENTS;
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);
}
return ERROR_OK;
}
-int parse_line(char *line, char *words[], int max_words)
-{
- int nwords = 0;
- char *p = line;
- char *word_start = line;
- int inquote = 0;
- while (nwords < max_words - 1)
- {
- /* check if we reached
- * a terminating NUL
- * a matching closing quote character " or '
- * we're inside a word but not a quote, and the current character is whitespace
- */
- if (!*p || *p == inquote || (word_start && !inquote && isspace(*p)))
- {
- /* we're inside a word or quote, and reached its end*/
- if (word_start)
- {
- 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;
-
- /* skip over trailing quote or whitespace*/
- if (inquote || isspace(*p))
- p++;
- while (isspace(*p))
- p++;
-
- inquote = 0;
- word_start = 0;
- }
- else if (*p == '"' || *p == '\'')
- {
- /* we've reached the beginning of a quote */
- inquote = *p++;
- word_start = p;
- }
- else
- {
- /* we've reached the beginning of a new word */
- if (!word_start)
- word_start = p;
-
- /* normal character, skip */
- p++;
- }
+void command_output_text(command_context_t *context, const char *data)
+{
+ if( context && context->output_handler && data ){
+ context->output_handler( context, data );
}
-
- return nwords;
}
void command_print_n(command_context_t *context, char *format, ...)
string = alloc_vprintf(format, ap);
if (string != NULL)
{
- context->output_handler(context, string);
+ /* we want this collected in the log + we also want to pick it up as a tcl return
+ * value.
+ *
+ * The latter bit isn't precisely neat, but will do for now.
+ */
+ LOG_USER_N("%s", string);
+ // We already printed it above
+ //command_output_text(context, string);
free(string);
}
if (string != NULL)
{
strcat(string, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
- context->output_handler(context, string);
+ /* we want this collected in the log + we also want to pick it up as a tcl return
+ * value.
+ *
+ * The latter bit isn't precisely neat, but will do for now.
+ */
+ LOG_USER_N("%s", string);
+ // We already printed it above
+ //command_output_text(context, string);
free(string);
}
va_end(ap);
}
-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;
-
- 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))
- 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)
- {
- if (!c->handler)
- {
- return NULL;
- }
- else
- {
- *new_start_word=start_word;
- return c;
- }
- }
- else
- {
- if (start_word == num_words - 1)
- {
- return NULL;
- }
- 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 run_command(command_context_t *context, command_t *c, 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)
+ if (!((context->mode == COMMAND_CONFIG) || (c->mode == COMMAND_ANY) || (c->mode == context->mode) ))
{
- command_print(context, "Command %s not found", words[start_word]);
- return ERROR_COMMAND_SYNTAX_ERROR;
+ /* Config commands can not run after the config stage */
+ return ERROR_FAIL;
}
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);
+ /* Print help for command */
+ const char *t1="";
+ const char *t2="";
+ const char *t3="";
+ /* maximum of two levels :-) */
+ if (c->parent!=NULL)
+ {
+ t1=c->parent->name;
+ t2=" ";
+ }
+ t3=c->name;
+ command_run_linef(context, "help {%s%s%s}", t1, t2, t3);
}
else if (retval == ERROR_COMMAND_CLOSE_CONNECTION)
{
*/
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(command_context_t *context, char *line)
{
- LOG_USER_N("%s", ""); /* Keep GDB connection alive*/
-
- int nwords;
- char *words[128] = {0};
+ /* all the parent commands have been registered with the interpreter
+ * so, can just evaluate the line as a script and check for
+ * results
+ */
+ /* run the line thru a script engine */
int retval;
- int i;
-
- /* skip preceding whitespace */
- while (isspace(*line))
- line++;
-
- /* empty line, ignore */
- if (!*line)
- return ERROR_OK;
-
- /* 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)
- if (run)
+ int retcode;
+ Jim_DeleteAssocData(interp, "context"); /* remove existing */
+ retcode = Jim_SetAssocData(interp, "context", NULL, context);
+ if (retcode != JIM_OK)
+ return ERROR_FAIL;
+
+ /* associated the return value */
+ retval = ERROR_OK;
+ Jim_DeleteAssocData(interp, "retval"); /* remove existing */
+ retcode = Jim_SetAssocData(interp, "retval", NULL, &retval);
+ if (retcode != JIM_OK)
+ return ERROR_FAIL;
+
+ retcode = Jim_Eval(interp, line);
+ if (retcode == JIM_ERR) {
+ if (retval!=ERROR_COMMAND_CLOSE_CONNECTION)
{
- retval = find_and_run_command(context, context->commands, words, nwords);
- } else
+ /* We do not print the connection closed error message */
+ Jim_PrintErrorMessage(interp);
+ }
+ if (retval==ERROR_OK)
{
- int t;
- return (find_command(context, context->commands, words, nwords, 0, &t)!=NULL)?ERROR_OK:ERROR_FAIL;
+ /* It wasn't a low level OpenOCD command that failed */
+ return ERROR_FAIL;
+ }
+ return retval;
+ } else if (retcode == JIM_EXIT) {
+ /* ignore. */
+ /* exit(Jim_GetExitCode(interp)); */
+ } else {
+ const char *result;
+ int reslen;
+
+ result = Jim_GetString(Jim_GetResult(interp), &reslen);
+ if (reslen) {
+ int i;
+ char buff[256+1];
+ for (i = 0; i < reslen; i += 256)
+ {
+ int chunk;
+ chunk = reslen - i;
+ if (chunk > 256)
+ chunk = 256;
+ strncpy(buff, result+i, chunk);
+ buff[chunk] = 0;
+ LOG_USER_N("%s", buff);
+ }
+ LOG_USER_N("%s", "\n");
}
- else
- return ERROR_INVALID_ARGUMENTS;
-
- for (i = 0; i < nwords; i++)
- free(words[i]);
-
- 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)
-{
- int retval;
- 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);
-}
-
-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, ...)
{
int retval=ERROR_FAIL;
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;
command_context_t* copy_context = malloc(sizeof(command_context_t));
*copy_context = *context;
-
+
return copy_context;
}
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");
- 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;
}
+int command_context_mode(command_context_t *cmd_ctx, enum command_mode mode)
+{
+ if (!cmd_ctx)
+ return ERROR_INVALID_ARGUMENTS;
+
+ cmd_ctx->mode = mode;
+ return ERROR_OK;
+}
+
/* sleep command sleeps for <n> miliseconds
* this is useful in target startup scripts
*/
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);
-
- 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;
-}
Code Review / openocd.git / blobdiff