command_handler_t: make cmd an indirect parameter

[openocd.git] / src / helper / command.c

diff --git a/src/helper/command.c b/src/helper/command.c
index a4ac4af00d0f57ce1791659151ceea80eac57286..3cd11d218f4edba908b91ba9b4914e8a9ea7e039 100644 (file)
--- a/src/helper/command.c
+++ b/src/helper/command.c
@@ -48,7 +48,7 @@ int fast_and_dangerous = 0;
 Jim_Interp *interp = NULL;
 
 static int run_command(command_context_t *context,
-               command_t *c, char *words[], unsigned num_words);
+               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)
@@ -102,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;
@@ -112,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;
                }
@@ -141,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);
 
@@ -150,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");
@@ -191,13 +193,51 @@ static void command_helptext_add(Jim_Obj *cmd_list, const char *help)
 /* 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)
 {
-       command_t *c, *p;
+       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)
+{
+       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);
@@ -207,35 +247,9 @@ command_t* register_command(command_context_t *context, command_t *parent, char
        c->mode = mode;
        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)
@@ -257,8 +271,6 @@ command_t* register_command(command_context_t *context, command_t *parent, char
 
        free((void *)full_name);
 
-       command_helptext_add(command_name_list(c), help);
-
        return c;
 }
 
@@ -425,7 +437,7 @@ char *command_name(struct command_s *c, char delim)
 }
 
 static int run_command(command_context_t *context,
-               command_t *c, char *words[], unsigned num_words)
+               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)))
@@ -435,7 +447,9 @@ static int run_command(command_context_t *context,
                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 */
@@ -546,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;
@@ -705,8 +720,7 @@ static int jim_capture(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 /* sleep command sleeps for <n> 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)
@@ -739,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;