server: revert commit 7e6556b3cad8
[fw/openocd] / src / helper / command.c
index 98c62cf8cdb83e35278ec44c5c589642aa10a357..0a711e51437b78a64dc9ac8ba88b41357d86f526 100644 (file)
@@ -52,6 +52,10 @@ struct log_capture_state {
        Jim_Obj *output;
 };
 
+static int unregister_command(struct command_context *context,
+       struct command *parent, const char *name);
+static char *command_name(struct command *c, char delim);
+
 static void tcl_output(void *privData, const char *file, unsigned line,
        const char *function, const char *string)
 {
@@ -126,13 +130,12 @@ extern struct command_context *global_cmd_ctx;
 
 /* dump a single line to the log for the command.
  * Do nothing in case we are not at debug level 3 */
-void script_debug(Jim_Interp *interp, const char *name,
-       unsigned argc, Jim_Obj * const *argv)
+void script_debug(Jim_Interp *interp, unsigned int argc, Jim_Obj * const *argv)
 {
        if (debug_level < LOG_LVL_DEBUG)
                return;
 
-       char *dbg = alloc_printf("command - %s", name);
+       char *dbg = alloc_printf("command -");
        for (unsigned i = 0; i < argc; i++) {
                int len;
                const char *w = Jim_GetString(argv[i], &len);
@@ -213,7 +216,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);
+       script_debug(interp, argc, argv);
        return script_command_run(interp, argc, argv, c);
 }
 
@@ -243,11 +246,6 @@ struct command *command_find_in_context(struct command_context *cmd_ctx,
 {
        return command_find(cmd_ctx->commands, name);
 }
-struct command *command_find_in_parent(struct command *parent,
-       const char *name)
-{
-       return command_find(parent->children, name);
-}
 
 /**
  * Add the command into the linked list, sorted by name.
@@ -333,7 +331,6 @@ static struct command *command_new(struct command_context *cmd_ctx,
        c->parent = parent;
        c->handler = cr->handler;
        c->jim_handler = cr->jim_handler;
-       c->jim_handler_data = cr->jim_handler_data;
        c->mode = cr->mode;
 
        command_add_child(command_list_for_parent(cmd_ctx, parent), c);
@@ -352,7 +349,9 @@ static int register_command_handler(struct command_context *cmd_ctx,
 {
        Jim_Interp *interp = cmd_ctx->interp;
 
+#if 0
        LOG_DEBUG("registering '%s'...", c->name);
+#endif
 
        Jim_CmdProc *func = c->handler ? &script_command : &command_unknown;
        int retval = Jim_CreateCommand(interp, c->name, func, c, NULL);
@@ -360,7 +359,7 @@ static int register_command_handler(struct command_context *cmd_ctx,
        return retval;
 }
 
-struct command *register_command(struct command_context *context,
+static struct command *register_command(struct command_context *context,
        struct command *parent, const struct command_registration *cr)
 {
        if (!context || !cr->name)
@@ -382,14 +381,14 @@ struct command *register_command(struct command_context *context,
        if (NULL == c)
                return NULL;
 
-       int retval = ERROR_OK;
+       int retval = JIM_OK;
        if (NULL != cr->jim_handler && NULL == parent) {
                retval = Jim_CreateCommand(context->interp, cr->name,
-                               cr->jim_handler, cr->jim_handler_data, NULL);
+                               cr->jim_handler, NULL, NULL);
        } else if (NULL != cr->handler || NULL != parent)
                retval = register_command_handler(context, command_root(c));
 
-       if (ERROR_OK != retval) {
+       if (retval != JIM_OK) {
                unregister_command(context, parent, name);
                c = NULL;
        }
@@ -442,7 +441,7 @@ int unregister_all_commands(struct command_context *context,
        return ERROR_OK;
 }
 
-int unregister_command(struct command_context *context,
+static int unregister_command(struct command_context *context,
        struct command *parent, const char *name)
 {
        if ((!context) || (!name))
@@ -550,7 +549,7 @@ static char *__command_name(struct command *c, char delim, unsigned extra)
        return name;
 }
 
-char *command_name(struct command *c, char delim)
+static char *command_name(struct command *c, char delim)
 {
        return __command_name(c, delim, 0);
 }
@@ -623,15 +622,13 @@ 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);
        }
@@ -654,9 +651,11 @@ int command_run_line(struct command_context *context, char *line)
         * happen when the Jim Tcl interpreter is provided by eCos for
         * instance.
         */
+       struct target *saved_target_override = context->current_target_override;
        context->current_target_override = NULL;
 
        Jim_Interp *interp = context->interp;
+       struct command_context *old_context = Jim_GetAssocData(interp, "context");
        Jim_DeleteAssocData(interp, "context");
        retcode = Jim_SetAssocData(interp, "context", NULL, context);
        if (retcode == JIM_OK) {
@@ -669,25 +668,19 @@ int command_run_line(struct command_context *context, char *line)
                        Jim_DeleteAssocData(interp, "retval");
                }
                Jim_DeleteAssocData(interp, "context");
+               int inner_retcode = Jim_SetAssocData(interp, "context", NULL, old_context);
+               if (retcode == JIM_OK)
+                       retcode = inner_retcode;
        }
+       context->current_target_override = saved_target_override;
        if (retcode == JIM_OK) {
                const char *result;
                int reslen;
 
                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) {
@@ -697,6 +690,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) {
@@ -812,8 +806,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)
@@ -930,71 +922,111 @@ COMMAND_HANDLER(handle_help_command)
        bool full = strcmp(CMD_NAME, "help") == 0;
        int retval;
        struct command *c = CMD_CTX->commands;
-       char *cmd_match = NULL;
-
-       if (CMD_ARGC == 0)
-               cmd_match = "";
-       else if (CMD_ARGC >= 1) {
-               unsigned i;
-
-               for (i = 0; i < CMD_ARGC; ++i) {
-                       if (NULL != cmd_match) {
-                               char *prev = cmd_match;
-
-                               cmd_match = alloc_printf("%s %s", cmd_match, CMD_ARGV[i]);
-                               free(prev);
-                               if (NULL == cmd_match) {
-                                       LOG_ERROR("unable to build search string");
-                                       return -ENOMEM;
-                               }
-                       } else {
-                               cmd_match = alloc_printf("%s", CMD_ARGV[i]);
-                               if (NULL == cmd_match) {
-                                       LOG_ERROR("unable to build search string");
-                                       return -ENOMEM;
-                               }
-                       }
+       char *cmd_match;
+
+       if (CMD_ARGC <= 0)
+               cmd_match = strdup("");
+
+       else {
+               cmd_match = strdup(CMD_ARGV[0]);
+
+               for (unsigned int i = 1; i < CMD_ARGC && cmd_match; ++i) {
+                       char *prev = cmd_match;
+                       cmd_match = alloc_printf("%s %s", prev, CMD_ARGV[i]);
+                       free(prev);
                }
-       } else
-               return ERROR_COMMAND_SYNTAX_ERROR;
+       }
 
+       if (cmd_match == NULL) {
+               LOG_ERROR("unable to build search string");
+               return -ENOMEM;
+       }
        retval = CALL_COMMAND_HANDLER(command_help_show_list,
                        c, 0, full, cmd_match);
 
-       if (CMD_ARGC >= 1)
-               free(cmd_match);
+       free(cmd_match);
        return retval;
 }
 
 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 int command_unknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+static char *alloc_concatenate_strings(int argc, Jim_Obj * const *argv)
 {
-       const char *cmd_name = Jim_GetString(argv[0], NULL);
-       if (strcmp(cmd_name, "unknown") == 0) {
-               if (argc == 1)
-                       return JIM_OK;
-               argc--;
-               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;
+               }
        }
-       script_debug(interp, cmd_name, argc, argv);
+
+       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)
+{
+       script_debug(interp, argc, 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);
@@ -1009,13 +1041,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;
+               run_usage(interp, count, argc, start);
+               return JIM_ERR;
        }
        /* pass the command through to the intended handler */
        if (c->jim_handler) {
@@ -1036,7 +1065,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);
@@ -1179,9 +1208,9 @@ static const struct command_registration command_subcommand_handlers[] = {
                .mode = COMMAND_ANY,
                .jim_handler = jim_command_mode,
                .usage = "[command_name ...]",
-               .help = "Returns the command modes allowed by a  command:"
-                       "'any', 'config', or 'exec'.  If no command is"
-                       "specified, returns the current command mode.  "
+               .help = "Returns the command modes allowed by a command: "
+                       "'any', 'config', or 'exec'. If no command is "
+                       "specified, returns the current command mode. "
                        "Returns 'unknown' if an unknown command is given. "
                        "Command can be multiple tokens.",
        },
@@ -1189,6 +1218,21 @@ static const struct command_registration command_subcommand_handlers[] = {
 };
 
 static const struct command_registration command_builtin_handlers[] = {
+       {
+               .name = "ocd_find",
+               .mode = COMMAND_ANY,
+               .jim_handler = jim_find,
+               .help = "find full path to file",
+               .usage = "file",
+       },
+       {
+               .name = "capture",
+               .mode = COMMAND_ANY,
+               .jim_handler = jim_capture,
+               .help = "Capture progress output and return as tcl return value. If the "
+                               "progress output was empty, return tcl return value.",
+               .usage = "command",
+       },
        {
                .name = "echo",
                .handler = jim_echo,
@@ -1299,9 +1343,6 @@ struct command_context *command_init(const char *startup_tcl, Jim_Interp *interp
        Jim_SetGlobalVariableStr(interp, "ocd_HOSTOS",
                Jim_NewStringObj(interp, HostOs, strlen(HostOs)));
 
-       Jim_CreateCommand(interp, "ocd_find", jim_find, NULL, NULL);
-       Jim_CreateCommand(interp, "capture", jim_capture, NULL, NULL);
-
        register_commands(context, NULL, command_builtin_handlers);
 
        Jim_SetAssocData(interp, "context", NULL, context);
@@ -1353,6 +1394,7 @@ void process_jim_events(struct command_context *cmd_ctx)
                        return ERROR_COMMAND_ARGUMENT_INVALID; \
                } \
                char *end; \
+               errno = 0; \
                *ul = func(str, &end, 0); \
                if (*end) { \
                        LOG_ERROR("Invalid command argument"); \