refactor command registration
[openocd.git] / src / helper / command.c
index f960127d8b9e20cdabecb999048fb95323d16dc4..87a898f293eb9b868a3ea1287e7ce82c788f60c5 100644 (file)
 #include "jim-eventloop.h"
 
 
-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);
+static int run_command(struct command_context *context,
+               struct command *c, const char *words[], unsigned num_words);
 
 static void tcl_output(void *privData, const char *file, unsigned line,
                const char *function, const char *string)
@@ -57,7 +56,7 @@ static void tcl_output(void *privData, const char *file, unsigned line,
        Jim_AppendString(interp, tclOutput, string, strlen(string));
 }
 
-extern command_context_t *global_cmd_ctx;
+extern struct command_context *global_cmd_ctx;
 
 void script_debug(Jim_Interp *interp, const char *name,
                unsigned argc, Jim_Obj *const *argv)
@@ -76,15 +75,45 @@ void script_debug(Jim_Interp *interp, const char *name,
        }
 }
 
+static void script_command_args_free(const char **words, unsigned nwords)
+{
+       for (unsigned i = 0; i < nwords; i++)
+               free((void *)words[i]);
+       free(words);
+}
+static const char **script_command_args_alloc(
+               unsigned argc, Jim_Obj *const *argv, unsigned *nwords)
+{
+       const char **words = malloc(argc * sizeof(char *));
+       if (NULL == words)
+               return NULL;
+
+       unsigned i;
+       for (i = 0; i < argc; i++)
+       {
+               int len;
+               const char *w = Jim_GetString(argv[i], &len);
+               /* a comment may end the line early */
+               if (*w == '#')
+                       break;
+
+               words[i] = strdup(w);
+               if (words[i] == NULL)
+               {
+                       script_command_args_free(words, i);
+                       return NULL;
+               }
+       }
+       *nwords = i;
+       return words;
+}
+
 static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 {
        /* the private data is stashed in the interp structure */
-       command_t *c;
-       command_context_t *context;
+       struct command *c;
+       struct command_context *context;
        int retval;
-       int i;
-       int nwords;
-       char **words;
 
        /* DANGER!!!! be careful what we invoke here, since interp->cmdPrivData might
         * get overwritten by running other Jim commands! Treat it as an
@@ -102,27 +131,10 @@ 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);
-       for (i = 0; i < argc; i++)
-       {
-               int len;
-               const char *w = Jim_GetString(argv[i], &len);
-               if (*w=='#')
-               {
-                       /* hit an end of line comment */
-                       break;
-               }
-               words[i] = strdup(w);
-               if (words[i] == NULL)
-               {
-                       int j;
-                       for (j = 0; j < i; j++)
-                               free(words[j]);
-                       free(words);
-                       return JIM_ERR;
-               }
-       }
-       nwords = i;
+       unsigned nwords;
+       const char **words = script_command_args_alloc(argc, argv, &nwords);
+       if (NULL == words)
+               return JIM_ERR;
 
        /* grab the command context from the associated data */
        context = Jim_GetAssocData(interp, "context");
@@ -141,7 +153,7 @@ 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);
+       retval = run_command(context, c, (const char **)words, nwords);
 
        log_remove_callback(tcl_output, tclOutput);
 
@@ -149,9 +161,7 @@ static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
        Jim_SetResult(interp, tclOutput);
        Jim_DecrRefCount(interp, tclOutput);
 
-       for (i = 0; i < nwords; i++)
-               free(words[i]);
-       free(words);
+       script_command_args_free(words, nwords);
 
        int *return_retval = Jim_GetAssocData(interp, "retval");
        if (return_retval != NULL)
@@ -162,7 +172,7 @@ 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)
+static Jim_Obj *command_name_list(struct command *c)
 {
        Jim_Obj *cmd_list = c->parent ?
                        command_name_list(c->parent) :
@@ -195,10 +205,9 @@ static void command_helptext_add(Jim_Obj *cmd_list, const 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)
+static struct command *command_find(struct command *head, const char *name)
 {
-       assert(head);
-       for (struct command_s *cc = *head; cc; cc = cc->next)
+       for (struct command *cc = head; cc; cc = cc->next)
        {
                if (strcmp(cc->name, name) == 0)
                        return cc;
@@ -211,7 +220,7 @@ static struct command_s *command_find(struct command_s **head, const char *name)
  * @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)
+static void command_add_child(struct command **head, struct command *c)
 {
        assert(head);
        if (NULL == *head)
@@ -219,40 +228,74 @@ static void command_add_child(struct command_s **head, struct command_s *c)
                *head = c;
                return;
        }
-       struct command_s *cc = *head;
+       struct command *cc = *head;
        while (cc->next) cc = cc->next;
        cc->next = 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)
+static struct command **command_list_for_parent(
+               struct command_context *cmd_ctx, struct command *parent)
 {
-       if (!context || !name)
-               return NULL;
+       return parent ? &parent->children : &cmd_ctx->commands;
+}
 
-       struct command_s **head = parent ? &parent->children : &context->commands;
-       struct command_s *c = command_find(head, name);
-       if (NULL != c)
-               return c;
+static struct command *command_new(struct command_context *cmd_ctx,
+               struct command *parent, const char *name,
+               command_handler_t handler, enum command_mode mode,
+               const char *help)
+{
+       assert(name);
 
-       c = malloc(sizeof(command_t));
+       struct command *c = malloc(sizeof(struct command));
+       memset(c, 0, sizeof(struct command));
 
        c->name = strdup(name);
        c->parent = parent;
-       c->children = NULL;
        c->handler = handler;
        c->mode = mode;
-       c->next = NULL;
 
-       command_add_child(head, c);
+       command_add_child(command_list_for_parent(cmd_ctx, parent), c);
 
        command_helptext_add(command_name_list(c), help);
 
-       /* just a placeholder, no handler */
-       if (c->handler == NULL)
+       return c;
+}
+static void command_free(struct command *c)
+{
+       /// @todo if command has a handler, unregister its jim command!
+
+       while (NULL != c->children)
+       {
+               struct command *tmp = c->children;
+               c->children = tmp->next;
+               command_free(tmp);
+       }
+
+       if (c->name)
+               free(c->name);
+       free(c);
+}
+
+struct command* register_command(struct command_context *context,
+               struct command *parent, const char *name,
+               command_handler_t handler, enum command_mode mode,
+               const char *help)
+{
+       if (!context || !name)
+               return NULL;
+
+       struct command **head = command_list_for_parent(context, parent);
+       struct command *c = command_find(*head, name);
+       if (NULL != c)
+       {
+               LOG_ERROR("command '%s' is already registered in '%s' context",
+                               name, parent ? parent->name : "<global>");
+               return c;
+       }
+
+       c = command_new(context, parent, name, handler, mode, help);
+       /* if allocation failed or it is a placeholder (no handler), we're done */
+       if (NULL == c || NULL == c->handler)
                return c;
 
        const char *full_name = command_name(c, '_');
@@ -274,98 +317,56 @@ command_t* register_command(command_context_t *context,
        return c;
 }
 
-int unregister_all_commands(command_context_t *context)
+int unregister_all_commands(struct command_context *context,
+               struct command *parent)
 {
-       command_t *c, *c2;
-
        if (context == NULL)
                return ERROR_OK;
 
-       while (NULL != context->commands)
+       struct command **head = command_list_for_parent(context, parent);
+       while (NULL != *head)
        {
-               c = context->commands;
-
-               while (NULL != c->children)
-               {
-                       c2 = c->children;
-                       c->children = c->children->next;
-                       free(c2->name);
-                       c2->name = NULL;
-                       free(c2);
-                       c2 = NULL;
-               }
-
-               context->commands = context->commands->next;
-
-               free(c->name);
-               c->name = NULL;
-               free(c);
-               c = NULL;
+               struct command *tmp = *head;
+               *head = tmp->next;
+               command_free(tmp);
        }
 
        return ERROR_OK;
 }
 
-int unregister_command(command_context_t *context, char *name)
+int unregister_command(struct command_context *context,
+               struct command *parent, const char *name)
 {
-       command_t *c, *p = NULL, *c2;
-
        if ((!context) || (!name))
                return ERROR_INVALID_ARGUMENTS;
 
-       /* find command */
-       c = context->commands;
-
-       while (NULL != c)
+       struct command *p = NULL;
+       struct command **head = command_list_for_parent(context, parent);
+       for (struct command *c = *head; NULL != c; p = c, c = c->next)
        {
-               if (strcmp(name, c->name) == 0)
-               {
-                       /* unlink command */
-                       if (p)
-                       {
-                               p->next = c->next;
-                       }
-                       else
-                       {
-                               /* first element in command list */
-                               context->commands = c->next;
-                       }
+               if (strcmp(name, c->name) != 0)
+                       continue;
 
-                       /* unregister children */
-                       while (NULL != c->children)
-                       {
-                               c2 = c->children;
-                               c->children = c->children->next;
-                               free(c2->name);
-                               c2->name = NULL;
-                               free(c2);
-                               c2 = NULL;
-                       }
-
-                       /* delete command */
-                       free(c->name);
-                       c->name = NULL;
-                       free(c);
-                       c = NULL;
-                       return ERROR_OK;
-               }
+               if (p)
+                       p->next = c->next;
+               else
+                       *head = c->next;
 
-               /* remember the last command for unlinking */
-               p = c;
-               c = c->next;
+               command_free(c);
+               return ERROR_OK;
        }
 
        return ERROR_OK;
 }
 
-void command_output_text(command_context_t *context, const char *data)
+void command_output_text(struct command_context *context, const char *data)
 {
        if (context && context->output_handler && data) {
                context->output_handler(context, data);
        }
 }
 
-void command_print_sameline(command_context_t *context, const char *format, ...)
+void command_print_sameline(struct command_context *context, const char *format, ...)
 {
        char *string;
 
@@ -389,7 +390,7 @@ void command_print_sameline(command_context_t *context, const char *format, ...)
        va_end(ap);
 }
 
-void command_print(command_context_t *context, const char *format, ...)
+void command_print(struct command_context *context, const char *format, ...)
 {
        char *string;
 
@@ -414,7 +415,7 @@ void command_print(command_context_t *context, const char *format, ...)
        va_end(ap);
 }
 
-static char *__command_name(struct command_s *c, char delim, unsigned extra)
+static char *__command_name(struct command *c, char delim, unsigned extra)
 {
        char *name;
        unsigned len = strlen(c->name);
@@ -431,15 +432,14 @@ static char *__command_name(struct command_s *c, char delim, unsigned extra)
        }
        return name;
 }
-char *command_name(struct command_s *c, char delim)
+char *command_name(struct command *c, char delim)
 {
        return __command_name(c, delim, 0);
 }
 
-static int run_command(command_context_t *context,
-               command_t *c, char *words[], unsigned num_words)
+static int run_command(struct command_context *context,
+               struct command *c, const char *words[], unsigned num_words)
 {
-       int start_word = 0;
        if (!((context->mode == COMMAND_CONFIG) || (c->mode == COMMAND_ANY) || (c->mode == context->mode)))
        {
                /* Config commands can not run after the config stage */
@@ -447,7 +447,13 @@ 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);
+       struct command_invocation cmd = {
+                       .ctx = context,
+                       .name = c->name,
+                       .argc = num_words - 1,
+                       .argv = words + 1,
+               };
+       int retval = c->handler(&cmd);
        if (retval == ERROR_COMMAND_SYNTAX_ERROR)
        {
                /* Print help for command */
@@ -473,7 +479,7 @@ static int run_command(command_context_t *context,
        return retval;
 }
 
-int command_run_line(command_context_t *context, char *line)
+int command_run_line(struct command_context *context, char *line)
 {
        /* all the parent commands have been registered with the interpreter
         * so, can just evaluate the line as a script and check for
@@ -543,7 +549,7 @@ int command_run_line(command_context_t *context, char *line)
        return retval;
 }
 
-int command_run_linef(command_context_t *context, const char *format, ...)
+int command_run_linef(struct command_context *context, const char *format, ...)
 {
        int retval = ERROR_FAIL;
        char *string;
@@ -558,22 +564,23 @@ 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(struct command_context* context,
+               command_output_handler_t output_handler, void *priv)
 {
        context->output_handler = output_handler;
        context->output_handler_priv = priv;
 }
 
-command_context_t* copy_command_context(command_context_t* context)
+struct command_context* copy_command_context(struct command_context* context)
 {
-       command_context_t* copy_context = malloc(sizeof(command_context_t));
+       struct command_context* copy_context = malloc(sizeof(struct command_context));
 
        *copy_context = *context;
 
        return copy_context;
 }
 
-int command_done(command_context_t *context)
+int command_done(struct command_context *context)
 {
        free(context);
        context = NULL;
@@ -717,22 +724,21 @@ 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)
+       if (CMD_ARGC == 2)
        {
-               if (strcmp(args[1], "busy") == 0)
+               if (strcmp(CMD_ARGV[1], "busy") == 0)
                        busy = true;
                else
                        return ERROR_COMMAND_SYNTAX_ERROR;
        }
-       else if (argc < 1 || argc > 2)
+       else if (CMD_ARGC < 1 || CMD_ARGC > 2)
                return ERROR_COMMAND_SYNTAX_ERROR;
 
        unsigned long duration = 0;
-       int retval = parse_ulong(args[0], &duration);
+       int retval = parse_ulong(CMD_ARGV[0], &duration);
        if (ERROR_OK != retval)
                return retval;
 
@@ -751,21 +757,9 @@ 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)
+struct command_context* command_init(const char *startup_tcl)
 {
-       if (argc != 1)
-               return ERROR_COMMAND_SYNTAX_ERROR;
-
-       fast_and_dangerous = strcmp("enable", args[0]) == 0;
-
-       return ERROR_OK;
-}
-
-
-command_context_t* command_init()
-{
-       command_context_t* context = malloc(sizeof(command_context_t));
-       extern const char startup_tcl[];
+       struct command_context* context = malloc(sizeof(struct command_context));
        const char *HostOs;
 
        context->mode = COMMAND_EXEC;
@@ -836,15 +830,11 @@ command_context_t* command_init()
                        handle_sleep_command, COMMAND_ANY,
                        "<n> [busy] - sleep for n milliseconds. "
                        "\"busy\" means busy wait");
-       register_command(context, NULL, "fast",
-                       handle_fast_command, COMMAND_ANY,
-                       "fast <enable/disable> - place at beginning of "
-                       "config files. Sets defaults to fast and dangerous.");
 
        return context;
 }
 
-int command_context_mode(command_context_t *cmd_ctx, enum command_mode mode)
+int command_context_mode(struct command_context *cmd_ctx, enum command_mode mode)
 {
        if (!cmd_ctx)
                return ERROR_INVALID_ARGUMENTS;
@@ -867,7 +857,8 @@ void process_jim_events(void)
 #endif
 }
 
-void register_jim(struct command_context_s *cmd_ctx, const char *name, int (*cmd)(Jim_Interp *interp, int argc, Jim_Obj *const *argv), const char *help)
+void register_jim(struct command_context *cmd_ctx, const char *name,
+               Jim_CmdProc cmd, const char *help)
 {
        Jim_CreateCommand(interp, name, cmd, NULL, NULL);
 
@@ -878,18 +869,6 @@ void register_jim(struct command_context_s *cmd_ctx, const char *name, int (*cmd
        command_helptext_add(cmd_list, help);
 }
 
-/* return global variable long value or 0 upon failure */
-long jim_global_long(const char *variable)
-{
-       Jim_Obj *objPtr = Jim_GetGlobalVariableStr(interp, variable, JIM_ERRMSG);
-       long t;
-       if (Jim_GetLong(interp, objPtr, &t) == JIM_OK)
-       {
-               return t;
-       }
-       return 0;
-}
-
 #define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
        int parse##name(const char *str, type *ul) \
        { \
@@ -950,3 +929,53 @@ DEFINE_PARSE_LONG(_int, int, n < INT_MIN, INT_MAX)
 DEFINE_PARSE_LONG(_s32, int32_t, n < INT32_MIN, INT32_MAX)
 DEFINE_PARSE_LONG(_s16, int16_t, n < INT16_MIN, INT16_MAX)
 DEFINE_PARSE_LONG(_s8, int8_t, n < INT8_MIN, INT8_MAX)
+
+static int command_parse_bool(const char *in, bool *out,
+               const char *on, const char *off)
+{
+       if (strcasecmp(in, on) == 0)
+               *out = true;
+       else if (strcasecmp(in, off) == 0)
+               *out = false;
+       else
+               return ERROR_COMMAND_SYNTAX_ERROR;
+       return  ERROR_OK;
+}
+
+int command_parse_bool_arg(const char *in, bool *out)
+{
+       if (command_parse_bool(in, out, "on", "off") == ERROR_OK)
+               return ERROR_OK;
+       if (command_parse_bool(in, out, "enable", "disable") == ERROR_OK)
+               return ERROR_OK;
+       if (command_parse_bool(in, out, "true", "false") == ERROR_OK)
+               return ERROR_OK;
+       if (command_parse_bool(in, out, "yes", "no") == ERROR_OK)
+               return ERROR_OK;
+       if (command_parse_bool(in, out, "1", "0") == ERROR_OK)
+               return ERROR_OK;
+       return ERROR_INVALID_ARGUMENTS;
+}
+
+COMMAND_HELPER(handle_command_parse_bool, bool *out, const char *label)
+{
+       switch (CMD_ARGC) {
+       case 1: {
+               const char *in = CMD_ARGV[0];
+               if (command_parse_bool_arg(in, out) != ERROR_OK)
+               {
+                       LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME, in);
+                       return ERROR_INVALID_ARGUMENTS;
+               }
+               // fall through
+       }
+       case 0:
+               LOG_INFO("%s is %s", label, *out ? "enabled" : "disabled");
+               break;
+       default:
+               return ERROR_INVALID_ARGUMENTS;
+       }
+       return ERROR_OK;
+}
+
+

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read https://review.openocd.org/login/?link to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)