X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=src%2Fhelper%2Fcommand.c;h=3cd11d218f4edba908b91ba9b4914e8a9ea7e039;hp=5f3c88dc0372dd4d4917a47c25e6be9025a81c2b;hb=f973320cbb98d661bc0e4ba4fa9939ce8bce2b83;hpb=6a2e83c01719cada03eb3bd13dc51d21d8bc964f diff --git a/src/helper/command.c b/src/helper/command.c index 5f3c88dc03..3cd11d218f 100644 --- a/src/helper/command.c +++ b/src/helper/command.c @@ -47,7 +47,8 @@ int fast_and_dangerous = 0; Jim_Interp *interp = NULL; -int run_command(command_context_t *context, command_t *c, char *words[], int num_words); +static int run_command(command_context_t *context, + command_t *c, const char *words[], unsigned num_words); static void tcl_output(void *privData, const char *file, unsigned line, const char *function, const char *string) @@ -58,12 +59,12 @@ static void tcl_output(void *privData, const char *file, unsigned line, extern command_context_t *global_cmd_ctx; -void script_debug(Jim_Interp *interp, const char *name, int argc, Jim_Obj *const *argv) +void script_debug(Jim_Interp *interp, const char *name, + unsigned argc, Jim_Obj *const *argv) { - int i; - LOG_DEBUG("command - %s", name); - for (i = 0; i < argc; i++) { + for (unsigned i = 0; i < argc; i++) + { int len; const char *w = Jim_GetString(argv[i], &len); @@ -101,7 +102,8 @@ static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv) script_debug(interp, c->name, argc, argv); - words = malloc(sizeof(char *) * argc); + words = malloc(sizeof(char *) * (argc + 1)); + words[0] = c->name; for (i = 0; i < argc; i++) { int len; @@ -111,12 +113,12 @@ static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv) /* hit an end of line comment */ break; } - words[i] = strdup(w); - if (words[i] == NULL) + words[i + 1] = strdup(w); + if (words[i + 1] == NULL) { int j; for (j = 0; j < i; j++) - free(words[j]); + free(words[j + 1]); free(words); return JIM_ERR; } @@ -140,7 +142,8 @@ static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv) log_add_callback(tcl_output, tclOutput); - retval = run_command(context, c, words, nwords); + // turn words[0] into args[-1] with this cast + retval = run_command(context, c, (const char **)words + 1, nwords); log_remove_callback(tcl_output, tclOutput); @@ -149,7 +152,7 @@ static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv) Jim_DecrRefCount(interp, tclOutput); for (i = 0; i < nwords; i++) - free(words[i]); + free(words[i + 1]); free(words); int *return_retval = Jim_GetAssocData(interp, "retval"); @@ -161,16 +164,80 @@ static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv) return (retval == ERROR_OK)?JIM_OK:JIM_ERR; } +static Jim_Obj *command_name_list(struct command_s *c) +{ + Jim_Obj *cmd_list = c->parent ? + command_name_list(c->parent) : + Jim_NewListObj(interp, NULL, 0); + Jim_ListAppendElement(interp, cmd_list, + Jim_NewStringObj(interp, c->name, -1)); + + return cmd_list; +} + +static void command_helptext_add(Jim_Obj *cmd_list, const char *help) +{ + Jim_Obj *cmd_entry = Jim_NewListObj(interp, NULL, 0); + Jim_ListAppendElement(interp, cmd_entry, cmd_list); + Jim_ListAppendElement(interp, cmd_entry, + Jim_NewStringObj(interp, help ? : "", -1)); + + /* 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_ListAppendElement(interp, helptext, cmd_entry); +} + /* nice short description of source file */ #define __THIS__FILE__ "command.c" -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) +/** + * Find a command by name from a list of commands. + * @returns The named command if found, or NULL. + */ +static struct command_s *command_find(struct command_s **head, const char *name) +{ + assert(head); + for (struct command_s *cc = *head; cc; cc = cc->next) + { + if (strcmp(cc->name, name) == 0) + return cc; + } + return NULL; +} + +/** + * Add the command to the end of linked list. + * @returns Returns false if the named command already exists in the list. + * Returns true otherwise. + */ +static void command_add_child(struct command_s **head, struct command_s *c) { - command_t *c, *p; + assert(head); + if (NULL == *head) + { + *head = c; + return; + } + struct command_s *cc = *head; + while (cc->next) cc = cc->next; + cc->next = c; +} +command_t* register_command(command_context_t *context, + command_t *parent, char *name, command_handler_t handler, + enum command_mode mode, char *help) +{ if (!context || !name) return NULL; + struct command_s **head = parent ? &parent->children : &context->commands; + struct command_s *c = command_find(head, name); + if (NULL != c) + return c; + c = malloc(sizeof(command_t)); c->name = strdup(name); @@ -178,88 +245,32 @@ command_t* register_command(command_context_t *context, command_t *parent, char c->children = NULL; c->handler = handler; c->mode = mode; - if (!help) - help=""; c->next = NULL; - /* place command in tree */ - if (parent) - { - if (parent->children) - { - /* find last child */ - for (p = parent->children; p && p->next; p = p->next); - if (p) - p->next = c; - } - else - { - parent->children = c; - } - } - else - { - if (context->commands) - { - /* find last command */ - for (p = context->commands; p && p->next; p = p->next); - if (p) - p->next = c; - } - else - { - context->commands = c; - } - } + command_add_child(head, c); + + command_helptext_add(command_name_list(c), help); /* 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("ocd_%s%s%s", t1, t2, t3); - Jim_CreateCommand(interp, full_name, script_command, c, NULL); - free((void *)full_name); + const char *full_name = command_name(c, '_'); + + const char *ocd_name = alloc_printf("ocd_%s", full_name); + Jim_CreateCommand(interp, ocd_name, script_command, c, NULL); + free((void *)ocd_name); /* we now need to add an overrideable proc */ - const char *override_name = alloc_printf("proc %s%s%s {args} {if {[catch {eval ocd_%s%s%s $args}]==0} {return \"\"} else { return -code error }", t1, t2, t3, t1, t2, t3); + const char *override_name = alloc_printf("proc %s {args} {" + "if {[catch {eval ocd_%s $args}] == 0} " + "{return \"\"} else {return -code error}}", + full_name, full_name); Jim_Eval_Named(interp, override_name, __THIS__FILE__, __LINE__); free((void *)override_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)); + free((void *)full_name); - 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; } @@ -403,7 +414,30 @@ void command_print(command_context_t *context, const char *format, ...) va_end(ap); } -int run_command(command_context_t *context, command_t *c, char *words[], int num_words) +static char *__command_name(struct command_s *c, char delim, unsigned extra) +{ + char *name; + unsigned len = strlen(c->name); + if (NULL == c->parent) { + // allocate enough for the name, child names, and '\0' + name = malloc(len + extra + 1); + strcpy(name, c->name); + } else { + // parent's extra must include both the space and name + name = __command_name(c->parent, delim, 1 + len + extra); + char dstr[2] = { delim, 0 }; + strcat(name, dstr); + strcat(name, c->name); + } + return name; +} +char *command_name(struct command_s *c, char delim) +{ + return __command_name(c, delim, 0); +} + +static int run_command(command_context_t *context, + command_t *c, const char *words[], unsigned num_words) { int start_word = 0; if (!((context->mode == COMMAND_CONFIG) || (c->mode == COMMAND_ANY) || (c->mode == context->mode))) @@ -413,21 +447,18 @@ int run_command(command_context_t *context, command_t *c, char *words[], int num return ERROR_FAIL; } - int retval = c->handler(context, c->name, words + start_word + 1, num_words - start_word - 1); + unsigned argc = num_words - start_word - 1; + const char **args = words + start_word + 1; + int retval = c->handler(context, args, argc); if (retval == ERROR_COMMAND_SYNTAX_ERROR) { /* 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); + char *full_name = command_name(c, ' '); + if (NULL != full_name) { + command_run_linef(context, "help %s", full_name); + free(full_name); + } else + retval = -ENOMEM; } else if (retval == ERROR_COMMAND_CLOSE_CONNECTION) { @@ -529,7 +560,8 @@ int command_run_linef(command_context_t *context, const char *format, ...) return retval; } -void command_set_output_handler(command_context_t* context, int (*output_handler)(struct command_context_s *context, const char* line), void *priv) +void command_set_output_handler(command_context_t* context, + command_output_handler_t output_handler, void *priv) { context->output_handler = output_handler; context->output_handler_priv = priv; @@ -688,8 +720,7 @@ static int jim_capture(Jim_Interp *interp, int argc, Jim_Obj *const *argv) /* sleep command sleeps for miliseconds * this is useful in target startup scripts */ -static int handle_sleep_command(struct command_context_s *cmd_ctx, - char *cmd, char **args, int argc) +COMMAND_HANDLER(handle_sleep_command) { bool busy = false; if (argc == 2) @@ -722,7 +753,7 @@ static int handle_sleep_command(struct command_context_s *cmd_ctx, return ERROR_OK; } -static int handle_fast_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc) +COMMAND_HANDLER(handle_fast_command) { if (argc != 1) return ERROR_COMMAND_SYNTAX_ERROR; @@ -842,20 +873,11 @@ void register_jim(struct command_context_s *cmd_ctx, const char *name, int (*cmd { Jim_CreateCommand(interp, name, cmd, NULL, NULL); - /* FIX!!! it would be prettier to invoke add_help_text... - * 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); - Jim_ListAppendElement(interp, cmd_list, Jim_NewStringObj(interp, name, -1)); + Jim_ListAppendElement(interp, cmd_list, + Jim_NewStringObj(interp, 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); + command_helptext_add(cmd_list, help); } /* return global variable long value or 0 upon failure */