command mode: return "any" for tcl proc
[fw/openocd] / src / helper / command.c
index b44e4667f9dadee286abb6e2b8e9bf3ab6676821..288ba99aa874ba53518e40eb64ab8dfb98757d6f 100644 (file)
@@ -44,9 +44,6 @@
 /* nice short description of source file */
 #define __THIS__FILE__ "command.c"
 
-static int run_command(struct command_context *context,
-               struct command *c, const char *words[], unsigned num_words);
-
 struct log_capture_state {
        Jim_Interp *interp;
        Jim_Obj *output;
@@ -56,6 +53,12 @@ static int unregister_command(struct command_context *context,
        struct command *parent, const char *name);
 static char *command_name(struct command *c, char delim);
 
+/* wrap jimtcl internal data */
+static inline bool jimcmd_is_proc(Jim_Cmd *cmd)
+{
+       return cmd->isproc;
+}
+
 static void tcl_output(void *privData, const char *file, unsigned line,
        const char *function, const char *string)
 {
@@ -226,34 +229,6 @@ struct command_context *current_command_context(Jim_Interp *interp)
        return cmd_ctx;
 }
 
-static int script_command_run(Jim_Interp *interp,
-       int argc, Jim_Obj * const *argv, struct command *c)
-{
-       target_call_timer_callbacks_now();
-       LOG_USER_N("%s", "");   /* Keep GDB connection alive*/
-
-       unsigned nwords;
-       char **words = script_command_args_alloc(argc, argv, &nwords);
-       if (NULL == words)
-               return JIM_ERR;
-
-       struct command_context *cmd_ctx = current_command_context(interp);
-       int retval = run_command(cmd_ctx, c, (const char **)words, nwords);
-
-       script_command_args_free(words, nwords);
-       return command_retval_set(interp, retval);
-}
-
-static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
-{
-       /* the private data is stashed in the interp structure */
-
-       struct command *c = jim_to_command(interp);
-       assert(c);
-       script_debug(interp, argc, argv);
-       return script_command_run(interp, argc, argv, c);
-}
-
 static struct command *command_root(struct command *c)
 {
        while (NULL != c->parent)
@@ -275,12 +250,6 @@ static struct command *command_find(struct command *head, const char *name)
        return NULL;
 }
 
-struct command *command_find_in_context(struct command_context *cmd_ctx,
-       const char *name)
-{
-       return command_find(cmd_ctx->commands, name);
-}
-
 /**
  * Add the command into the linked list, sorted by name.
  * @param head Address to head of command list pointer, which may be
@@ -387,10 +356,7 @@ static int register_command_handler(struct command_context *cmd_ctx,
        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);
-
-       return retval;
+       return Jim_CreateCommand(interp, c->name, command_unknown, c, NULL);
 }
 
 static struct command *register_command(struct command_context *context,
@@ -415,22 +381,19 @@ static struct command *register_command(struct command_context *context,
        if (NULL == c)
                return NULL;
 
-       int retval = JIM_OK;
-       if (NULL != cr->jim_handler && NULL == parent) {
-               retval = Jim_CreateCommand(context->interp, cr->name,
-                               cr->jim_handler, c, NULL);
-       } else if (NULL != cr->handler || NULL != parent)
-               retval = register_command_handler(context, command_root(c));
-
-       if (retval != JIM_OK) {
-               unregister_command(context, parent, name);
-               c = NULL;
+       if (cr->jim_handler || cr->handler) {
+               int retval = register_command_handler(context, command_root(c));
+               if (retval != JIM_OK) {
+                       unregister_command(context, parent, name);
+                       return NULL;
+               }
        }
        return c;
 }
 
-int register_commands(struct command_context *cmd_ctx, struct command *parent,
-       const struct command_registration *cmds)
+static int ___register_commands(struct command_context *cmd_ctx, struct command *parent,
+       const struct command_registration *cmds, void *data,
+       struct target *override_target)
 {
        int retval = ERROR_OK;
        unsigned i;
@@ -444,10 +407,12 @@ int register_commands(struct command_context *cmd_ctx, struct command *parent,
                                retval = ERROR_FAIL;
                                break;
                        }
+                       c->jim_handler_data = data;
+                       c->jim_override_target = override_target;
                }
                if (NULL != cr->chain) {
                        struct command *p = c ? : parent;
-                       retval = register_commands(cmd_ctx, p, cr->chain);
+                       retval = ___register_commands(cmd_ctx, p, cr->chain, data, override_target);
                        if (ERROR_OK != retval)
                                break;
                }
@@ -459,6 +424,18 @@ int register_commands(struct command_context *cmd_ctx, struct command *parent,
        return retval;
 }
 
+int __register_commands(struct command_context *cmd_ctx, const char *cmd_prefix,
+       const struct command_registration *cmds, void *data,
+       struct target *override_target)
+{
+       struct command *parent = NULL;
+
+       if (cmd_prefix)
+               parent = command_find(cmd_ctx->commands, cmd_prefix);
+
+       return ___register_commands(cmd_ctx, parent, cmds, data, override_target);
+}
+
 int unregister_all_commands(struct command_context *context,
        struct command *parent)
 {
@@ -499,13 +476,6 @@ static int unregister_command(struct command_context *context,
        return ERROR_OK;
 }
 
-void command_set_handler_data(struct command *c, void *p)
-{
-       c->jim_handler_data = p;
-       for (struct command *cc = c->children; NULL != cc; cc = cc->next)
-               command_set_handler_data(cc, p);
-}
-
 void command_output_text(struct command_context *context, const char *data)
 {
        if (context && context->output_handler && data)
@@ -614,11 +584,8 @@ static bool command_can_run(struct command_context *cmd_ctx, struct command *c)
 }
 
 static int run_command(struct command_context *context,
-       struct command *c, const char *words[], unsigned num_words)
+       struct command *c, const char **words, unsigned num_words)
 {
-       if (!command_can_run(context, c))
-               return ERROR_FAIL;
-
        struct command_invocation cmd = {
                .ctx = context,
                .current = c,
@@ -626,26 +593,11 @@ static int run_command(struct command_context *context,
                .argc = num_words - 1,
                .argv = words + 1,
        };
-       /* Black magic of overridden current target:
-        * If the command we are going to handle has a target prefix,
-        * override the current target temporarily for the time
-        * of processing the command.
-        * current_target_override is used also for event handlers
-        * therefore we prevent touching it if command has no prefix.
-        * Previous override is saved and restored back to ensure
-        * correct work when run_command() is re-entered. */
-       struct target *saved_target_override = context->current_target_override;
-       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)
-               context->current_target_override = saved_target_override;
-
        if (retval == ERROR_COMMAND_SYNTAX_ERROR) {
                /* Print help for command */
                char *full_name = command_name(c, ' ');
@@ -1053,6 +1005,23 @@ static int run_usage(Jim_Interp *interp, int argc_valid, int argc, Jim_Obj * con
        return retval;
 }
 
+static int exec_command(Jim_Interp *interp, struct command_context *cmd_ctx,
+               struct command *c, int argc, Jim_Obj *const *argv)
+{
+       if (c->jim_handler)
+               return c->jim_handler(interp, argc, argv);
+
+       /* use c->handler */
+       unsigned int nwords;
+       char **words = script_command_args_alloc(argc, argv, &nwords);
+       if (!words)
+               return JIM_ERR;
+
+       int retval = run_command(cmd_ctx, c, (const char **)words, nwords);
+       script_command_args_free(words, nwords);
+       return command_retval_set(interp, retval);
+}
+
 static int command_unknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 {
        script_debug(interp, argc, argv);
@@ -1079,15 +1048,32 @@ static int command_unknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
                run_usage(interp, count, argc, start);
                return JIM_ERR;
        }
-       /* pass the command through to the intended handler */
-       if (c->jim_handler) {
-               if (!command_can_run(cmd_ctx, c))
-                       return JIM_ERR;
 
-               return (*c->jim_handler)(interp, count, start);
-       }
+       if (!command_can_run(cmd_ctx, c))
+               return JIM_ERR;
+
+       target_call_timer_callbacks_now();
+
+       /*
+        * Black magic of overridden current target:
+        * If the command we are going to handle has a target prefix,
+        * override the current target temporarily for the time
+        * of processing the command.
+        * current_target_override is used also for event handlers
+        * therefore we prevent touching it if command has no prefix.
+        * Previous override is saved and restored back to ensure
+        * correct work when command_unknown() is re-entered.
+        */
+       struct target *saved_target_override = cmd_ctx->current_target_override;
+       if (c->jim_override_target)
+               cmd_ctx->current_target_override = c->jim_override_target;
+
+       int retval = exec_command(interp, cmd_ctx, c, count, start);
 
-       return script_command_run(interp, count, start, c);
+       if (c->jim_override_target)
+               cmd_ctx->current_target_override = saved_target_override;
+
+       return retval;
 }
 
 static int jim_command_mode(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
@@ -1096,6 +1082,18 @@ static int jim_command_mode(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
        enum command_mode mode;
 
        if (argc > 1) {
+               char *full_name = alloc_concatenate_strings(argc - 1, argv + 1);
+               if (!full_name)
+                       return JIM_ERR;
+               Jim_Obj *s = Jim_NewStringObj(interp, full_name, -1);
+               Jim_IncrRefCount(s);
+               Jim_Cmd *cmd = Jim_GetCommand(interp, s, JIM_NONE);
+               Jim_DecrRefCount(interp, s);
+               free(full_name);
+               if (cmd && jimcmd_is_proc(cmd)) {
+                       Jim_SetResultString(interp, "any", -1);
+                       return JIM_OK;
+               }
                struct command *c = cmd_ctx->commands;
                int remaining = command_unknown_find(argc - 1, argv + 1, c, &c);
                /* if nothing could be consumed, then it's an unknown command */