doc/openocd.texi: fix bad aarch64 merge
[fw/openocd] / src / helper / command.c
index aadc072fa0ffde66b182b5ec100f3a5f9ac16c6a..3346a6c3798cdff0e242dc060b35dc33abcef544 100644 (file)
@@ -190,7 +190,7 @@ struct command_context *current_command_context(Jim_Interp *interp)
 }
 
 static int script_command_run(Jim_Interp *interp,
-       int argc, Jim_Obj * const *argv, struct command *c, bool capture)
+       int argc, Jim_Obj * const *argv, struct command *c)
 {
        target_call_timer_callbacks_now();
        LOG_USER_N("%s", "");   /* Keep GDB connection alive*/
@@ -200,15 +200,9 @@ static int script_command_run(Jim_Interp *interp,
        if (NULL == words)
                return JIM_ERR;
 
-       struct log_capture_state *state = NULL;
-       if (capture)
-               state = command_log_capture_start(interp);
-
        struct command_context *cmd_ctx = current_command_context(interp);
        int retval = run_command(cmd_ctx, c, (const char **)words, nwords);
 
-       command_log_capture_finish(state);
-
        script_command_args_free(words, nwords);
        return command_retval_set(interp, retval);
 }
@@ -220,7 +214,7 @@ static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
        struct command *c = interp->cmdPrivData;
        assert(c);
        script_debug(interp, c->name, argc, argv);
-       return script_command_run(interp, argc, argv, c, true);
+       return script_command_run(interp, argc, argv, c);
 }
 
 static struct command *command_root(struct command *c)
@@ -357,27 +351,11 @@ static int register_command_handler(struct command_context *cmd_ctx,
        struct command *c)
 {
        Jim_Interp *interp = cmd_ctx->interp;
-       char *ocd_name = alloc_printf("ocd_%s", c->name);
-       if (NULL == ocd_name)
-               return JIM_ERR;
 
-       LOG_DEBUG("registering '%s'...", ocd_name);
+       LOG_DEBUG("registering '%s'...", c->name);
 
        Jim_CmdProc *func = c->handler ? &script_command : &command_unknown;
-       int retval = Jim_CreateCommand(interp, ocd_name, func, c, NULL);
-       free(ocd_name);
-       if (JIM_OK != retval)
-               return retval;
-
-       /* we now need to add an overrideable proc */
-       char *override_name = alloc_printf(
-                       "proc %s {args} {eval ocd_bouncer %s $args}",
-                       c->name, c->name);
-       if (NULL == override_name)
-               return JIM_ERR;
-
-       retval = Jim_Eval_Named(interp, override_name, 0, 0);
-       free(override_name);
+       int retval = Jim_CreateCommand(interp, c->name, func, c, NULL);
 
        return retval;
 }
@@ -502,7 +480,7 @@ void command_output_text(struct command_context *context, const char *data)
                context->output_handler(context, data);
 }
 
-void command_print_sameline(struct command_context *context, const char *format, ...)
+void command_print_sameline(struct command_invocation *cmd, const char *format, ...)
 {
        char *string;
 
@@ -510,13 +488,13 @@ void command_print_sameline(struct command_context *context, const char *format,
        va_start(ap, format);
 
        string = alloc_vprintf(format, ap);
-       if (string != NULL) {
+       if (string != NULL && cmd) {
                /* 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);
+               Jim_AppendString(cmd->ctx->interp, cmd->output, string, -1);
                /* We already printed it above
                 * command_output_text(context, string); */
                free(string);
@@ -525,7 +503,7 @@ void command_print_sameline(struct command_context *context, const char *format,
        va_end(ap);
 }
 
-void command_print(struct command_context *context, const char *format, ...)
+void command_print(struct command_invocation *cmd, const char *format, ...)
 {
        char *string;
 
@@ -533,7 +511,7 @@ void command_print(struct command_context *context, const char *format, ...)
        va_start(ap, format);
 
        string = alloc_vprintf(format, ap);
-       if (string != NULL) {
+       if (string != NULL && cmd) {
                strcat(string, "\n");   /* alloc_vprintf guaranteed the buffer to be at least one
                                         *char longer */
                /* we want this collected in the log + we also want to pick it up as a tcl return
@@ -541,7 +519,7 @@ void command_print(struct command_context *context, const char *format, ...)
                 *
                 * The latter bit isn't precisely neat, but will do for now.
                 */
-               LOG_USER_N("%s", string);
+               Jim_AppendString(cmd->ctx->interp, cmd->output, string, -1);
                /* We already printed it above
                 * command_output_text(context, string); */
                free(string);
@@ -628,6 +606,9 @@ static int run_command(struct command_context *context,
        if (c->jim_handler_data)
                context->current_target_override = c->jim_handler_data;
 
+       cmd.output = Jim_NewEmptyStringObj(context->interp);
+       Jim_IncrRefCount(cmd.output);
+
        int retval = c->handler(&cmd);
 
        if (c->jim_handler_data)
@@ -642,15 +623,17 @@ static int run_command(struct command_context *context,
                }
        } 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
-                */
-               char *full_name = command_name(c, ' ');
-               LOG_DEBUG("Command '%s' failed with error code %d",
-                                       full_name ? full_name : c->name, retval);
-               free(full_name);
+       } else {
+               if (retval != ERROR_OK) {
+                       char *full_name = command_name(c, ' ');
+                       LOG_DEBUG("Command '%s' failed with error code %d",
+                                               full_name ? full_name : c->name, retval);
+                       free(full_name);
+               }
+               /* Use the command output as the Tcl result */
+               Jim_SetResult(context->interp, cmd.output);
        }
+       Jim_DecrRefCount(context->interp, cmd.output);
 
        return retval;
 }
@@ -691,18 +674,8 @@ int command_run_line(struct command_context *context, char *line)
 
                result = Jim_GetString(Jim_GetResult(interp), &reslen);
                if (reslen > 0) {
-                       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("\n");
+                       command_output_text(context, result);
+                       command_output_text(context, "\n");
                }
                retval = ERROR_OK;
        } else if (retcode == JIM_EXIT) {
@@ -712,6 +685,7 @@ int command_run_line(struct command_context *context, char *line)
                return retcode;
        } else {
                Jim_MakeErrorMessage(interp);
+               /* error is broadcast */
                LOG_USER("%s", Jim_GetString(Jim_GetResult(interp), NULL));
 
                if (retval == ERROR_OK) {
@@ -827,8 +801,6 @@ static COMMAND_HELPER(command_help_find, struct command *head,
        if (0 == CMD_ARGC)
                return ERROR_COMMAND_SYNTAX_ERROR;
        *out = command_find(head, CMD_ARGV[0]);
-       if (NULL == *out && strncmp(CMD_ARGV[0], "ocd_", 4) == 0)
-               *out = command_find(head, CMD_ARGV[0] + 4);
        if (NULL == *out)
                return ERROR_COMMAND_SYNTAX_ERROR;
        if (--CMD_ARGC == 0)
@@ -982,18 +954,75 @@ COMMAND_HANDLER(handle_help_command)
 }
 
 static int command_unknown_find(unsigned argc, Jim_Obj *const *argv,
-       struct command *head, struct command **out, bool top_level)
+       struct command *head, struct command **out)
 {
        if (0 == argc)
                return argc;
        const char *cmd_name = Jim_GetString(argv[0], NULL);
        struct command *c = command_find(head, cmd_name);
-       if (NULL == c && top_level && strncmp(cmd_name, "ocd_", 4) == 0)
-               c = command_find(head, cmd_name + 4);
        if (NULL == c)
                return argc;
        *out = c;
-       return command_unknown_find(--argc, ++argv, (*out)->children, out, false);
+       return command_unknown_find(--argc, ++argv, (*out)->children, out);
+}
+
+static char *alloc_concatenate_strings(int argc, Jim_Obj * const *argv)
+{
+       char *prev, *all;
+       int i;
+
+       assert(argc >= 1);
+
+       all = strdup(Jim_GetString(argv[0], NULL));
+       if (!all) {
+               LOG_ERROR("Out of memory");
+               return NULL;
+       }
+
+       for (i = 1; i < argc; ++i) {
+               prev = all;
+               all = alloc_printf("%s %s", all, Jim_GetString(argv[i], NULL));
+               free(prev);
+               if (!all) {
+                       LOG_ERROR("Out of memory");
+                       return NULL;
+               }
+       }
+
+       return all;
+}
+
+static int run_usage(Jim_Interp *interp, int argc_valid, int argc, Jim_Obj * const *argv)
+{
+       struct command_context *cmd_ctx = current_command_context(interp);
+       char *command;
+       int retval;
+
+       assert(argc_valid >= 1);
+       assert(argc >= argc_valid);
+
+       command = alloc_concatenate_strings(argc_valid, argv);
+       if (!command)
+               return JIM_ERR;
+
+       retval = command_run_linef(cmd_ctx, "usage %s", command);
+       if (retval != ERROR_OK) {
+               LOG_ERROR("unable to execute command \"usage %s\"", command);
+               return JIM_ERR;
+       }
+
+       if (argc_valid == argc)
+               LOG_ERROR("%s: command requires more arguments", command);
+       else {
+               free(command);
+               command = alloc_concatenate_strings(argc - argc_valid, argv + argc_valid);
+               if (!command)
+                       return JIM_ERR;
+               LOG_ERROR("invalid subcommand \"%s\"", command);
+       }
+
+       free(command);
+       return retval;
 }
 
 static int command_unknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
@@ -1009,7 +1038,7 @@ static int command_unknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 
        struct command_context *cmd_ctx = current_command_context(interp);
        struct command *c = cmd_ctx->commands;
-       int remaining = command_unknown_find(argc, argv, c, &c, true);
+       int remaining = command_unknown_find(argc, argv, c, &c);
        /* if nothing could be consumed, then it's really an unknown command */
        if (remaining == argc) {
                const char *cmd = Jim_GetString(argv[0], NULL);
@@ -1017,7 +1046,6 @@ static int command_unknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
                return JIM_OK;
        }
 
-       bool found = true;
        Jim_Obj *const *start;
        unsigned count;
        if (c->handler || c->jim_handler) {
@@ -1025,14 +1053,10 @@ static int command_unknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
                count = remaining + 1;
                start = argv + (argc - remaining - 1);
        } else {
-               c = command_find(cmd_ctx->commands, "usage");
-               if (NULL == c) {
-                       LOG_ERROR("unknown command, but usage is missing too");
-                       return JIM_ERR;
-               }
                count = argc - remaining;
                start = argv;
-               found = false;
+               run_usage(interp, count, argc, start);
+               return JIM_ERR;
        }
        /* pass the command through to the intended handler */
        if (c->jim_handler) {
@@ -1043,7 +1067,7 @@ static int command_unknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
                return (*c->jim_handler)(interp, count, start);
        }
 
-       return script_command_run(interp, count, start, c, found);
+       return script_command_run(interp, count, start, c);
 }
 
 static int jim_command_mode(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
@@ -1053,7 +1077,7 @@ static int jim_command_mode(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 
        if (argc > 1) {
                struct command *c = cmd_ctx->commands;
-               int remaining = command_unknown_find(argc - 1, argv + 1, c, &c, true);
+               int remaining = command_unknown_find(argc - 1, argv + 1, c, &c);
                /* if nothing could be consumed, then it's an unknown command */
                if (remaining == argc - 1) {
                        Jim_SetResultString(interp, "unknown", -1);
@@ -1082,32 +1106,6 @@ static int jim_command_mode(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
        return JIM_OK;
 }
 
-static int jim_command_type(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
-{
-       if (1 == argc)
-               return JIM_ERR;
-
-       struct command_context *cmd_ctx = current_command_context(interp);
-       struct command *c = cmd_ctx->commands;
-       int remaining = command_unknown_find(argc - 1, argv + 1, c, &c, true);
-       /* if nothing could be consumed, then it's an unknown command */
-       if (remaining == argc - 1) {
-               Jim_SetResultString(interp, "unknown", -1);
-               return JIM_OK;
-       }
-
-       if (c->jim_handler)
-               Jim_SetResultString(interp, "native", -1);
-       else if (c->handler)
-               Jim_SetResultString(interp, "simple", -1);
-       else if (remaining == 0)
-               Jim_SetResultString(interp, "group", -1);
-       else
-               Jim_SetResultString(interp, "unknown", -1);
-
-       return JIM_OK;
-}
-
 int help_add_command(struct command_context *cmd_ctx, struct command *parent,
        const char *cmd_name, const char *help_text, const char *usage)
 {
@@ -1228,15 +1226,6 @@ static const struct command_registration command_subcommand_handlers[] = {
                        "Returns 'unknown' if an unknown command is given. "
                        "Command can be multiple tokens.",
        },
-       {
-               .name = "type",
-               .mode = COMMAND_ANY,
-               .jim_handler = jim_command_type,
-               .usage = "command_name [...]",
-               .help = "Returns the type of built-in command:"
-                       "'native', 'simple', 'group', or 'unknown'. "
-                       "Command can be multiple tokens.",
-       },
        COMMAND_REGISTRATION_DONE
 };