add command_output_handler_t
[openocd.git] / src / helper / command.c
index 5d69ffb3fb80aec3254793962a2b8479671dc12f..603da82f65c67cc80f82f5c615b36e05cd12ea61 100644 (file)
 int fast_and_dangerous = 0;
 Jim_Interp *interp = NULL;
 
-int run_command(command_context_t *context, command_t *c, char *words[], int num_words);
+static int run_command(command_context_t *context,
+               command_t *c, char *words[], unsigned num_words);
 
-static void tcl_output(void *privData, const char *file, int line, const char *function, const char *string)
+static void tcl_output(void *privData, const char *file, unsigned line,
+               const char *function, const char *string)
 {
        Jim_Obj *tclOutput = (Jim_Obj *)privData;
-
        Jim_AppendString(interp, tclOutput, string, strlen(string));
 }
 
 extern command_context_t *global_cmd_ctx;
 
-void script_debug(Jim_Interp *interp, const char *name, int argc, Jim_Obj *const *argv)
+void script_debug(Jim_Interp *interp, const char *name,
+               unsigned argc, Jim_Obj *const *argv)
 {
-       int i;
-
        LOG_DEBUG("command - %s", name);
-       for (i = 0; i < argc; i++) {
+       for (unsigned i = 0; i < argc; i++)
+       {
                int len;
                const char *w = Jim_GetString(argv[i], &len);
 
@@ -161,16 +162,82 @@ 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)
+{
+       Jim_Obj *cmd_list = c->parent ?
+                       command_name_list(c->parent) :
+                       Jim_NewListObj(interp, NULL, 0);
+       Jim_ListAppendElement(interp, cmd_list,
+                       Jim_NewStringObj(interp, c->name, -1));
+
+       return cmd_list;
+}
+
+static void command_helptext_add(Jim_Obj *cmd_list, const char *help)
+{
+       Jim_Obj *cmd_entry = Jim_NewListObj(interp, NULL, 0);
+       Jim_ListAppendElement(interp, cmd_entry, cmd_list);
+       Jim_ListAppendElement(interp, cmd_entry,
+                       Jim_NewStringObj(interp, help ? : "", -1));
+
+       /* accumulate help text in Tcl helptext list.  */
+       Jim_Obj *helptext = Jim_GetGlobalVariableStr(interp,
+                       "ocd_helptext", JIM_ERRMSG);
+       if (Jim_IsShared(helptext))
+               helptext = Jim_DuplicateObj(interp, helptext);
+       Jim_ListAppendElement(interp, helptext, cmd_entry);
+}
+
 /* 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)
+{
+       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)
 {
-       command_t *c, *p;
+       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,
+               int (*handler)(struct command_context_s *context,
+                               char* name, char** args, int argc),
+               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);
@@ -178,88 +245,32 @@ command_t* register_command(command_context_t *context, command_t *parent, char
        c->children = NULL;
        c->handler = handler;
        c->mode = mode;
-       if (!help)
-               help="";
        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)
                return c;
 
-       /* If this is a two level command, e.g. "flash banks", then the
-        * "unknown" proc in startup.tcl must redirect to  this command.
-        *
-        * "flash banks" is translated by "unknown" to "flash_banks"
-        * if such a proc exists
-        */
-       /* Print help for command */
-       const char *t1="";
-       const char *t2="";
-       const char *t3="";
-       /* maximum of two levels :-) */
-       if (c->parent != NULL)
-       {
-               t1 = c->parent->name;
-               t2="_";
-       }
-       t3 = c->name;
-       const char *full_name = alloc_printf("ocd_%s%s%s", t1, t2, t3);
-       Jim_CreateCommand(interp, full_name, script_command, c, NULL);
-       free((void *)full_name);
+       const char *full_name = command_name(c, '_');
+
+       const char *ocd_name = alloc_printf("ocd_%s", full_name);
+       Jim_CreateCommand(interp, ocd_name, script_command, c, NULL);
+       free((void *)ocd_name);
 
        /* we now need to add an overrideable proc */
-       const char *override_name = alloc_printf("proc %s%s%s {args} {if {[catch {eval ocd_%s%s%s $args}]==0} {return \"\"} else { return -code error }", t1, t2, t3, t1, t2, t3);
+       const char *override_name = alloc_printf("proc %s {args} {"
+                       "if {[catch {eval ocd_%s $args}] == 0} "
+                       "{return \"\"} else {return -code error}}",
+                       full_name, full_name);
        Jim_Eval_Named(interp, override_name, __THIS__FILE__, __LINE__);
        free((void *)override_name);
 
-       /* accumulate help text in Tcl helptext list.  */
-       Jim_Obj *helptext = Jim_GetGlobalVariableStr(interp, "ocd_helptext", JIM_ERRMSG);
-       if (Jim_IsShared(helptext))
-               helptext = Jim_DuplicateObj(interp, helptext);
-       Jim_Obj *cmd_entry = Jim_NewListObj(interp, NULL, 0);
-
-       Jim_Obj *cmd_list = Jim_NewListObj(interp, NULL, 0);
-
-       /* maximum of two levels :-) */
-       if (c->parent != NULL)
-       {
-               Jim_ListAppendElement(interp, cmd_list, Jim_NewStringObj(interp, c->parent->name, -1));
-       }
-       Jim_ListAppendElement(interp, cmd_list, Jim_NewStringObj(interp, c->name, -1));
+       free((void *)full_name);
 
-       Jim_ListAppendElement(interp, cmd_entry, cmd_list);
-       Jim_ListAppendElement(interp, cmd_entry, Jim_NewStringObj(interp, help, -1));
-       Jim_ListAppendElement(interp, helptext, cmd_entry);
        return c;
 }
 
@@ -403,7 +414,30 @@ void command_print(command_context_t *context, const char *format, ...)
        va_end(ap);
 }
 
-int run_command(command_context_t *context, command_t *c, char *words[], int num_words)
+static char *__command_name(struct command_s *c, char delim, unsigned extra)
+{
+       char *name;
+       unsigned len = strlen(c->name);
+       if (NULL == c->parent) {
+               // allocate enough for the name, child names, and '\0'
+               name = malloc(len + extra + 1);
+               strcpy(name, c->name);
+       } else {
+               // parent's extra must include both the space and name
+               name = __command_name(c->parent, delim, 1 + len + extra);
+               char dstr[2] = { delim, 0 };
+               strcat(name, dstr);
+               strcat(name, c->name);
+       }
+       return name;
+}
+char *command_name(struct command_s *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)
 {
        int start_word = 0;
        if (!((context->mode == COMMAND_CONFIG) || (c->mode == COMMAND_ANY) || (c->mode == context->mode)))
@@ -417,17 +451,12 @@ int run_command(command_context_t *context, command_t *c, char *words[], int num
        if (retval == ERROR_COMMAND_SYNTAX_ERROR)
        {
                /* Print help for command */
-               const char *t1="";
-               const char *t2="";
-               const char *t3="";
-               /* maximum of two levels :-) */
-               if (c->parent != NULL)
-               {
-                       t1 = c->parent->name;
-                       t2=" ";
-               }
-               t3 = c->name;
-               command_run_linef(context, "help {%s%s%s}", t1, t2, t3);
+               char *full_name = command_name(c, ' ');
+               if (NULL != full_name) {
+                       command_run_linef(context, "help %s", full_name);
+                       free(full_name);
+               } else
+                       retval = -ENOMEM;
        }
        else if (retval == ERROR_COMMAND_CLOSE_CONNECTION)
        {
@@ -529,7 +558,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;
@@ -842,20 +872,11 @@ void register_jim(struct command_context_s *cmd_ctx, const char *name, int (*cmd
 {
        Jim_CreateCommand(interp, name, cmd, NULL, NULL);
 
-       /* FIX!!! it would be prettier to invoke add_help_text...
-        * accumulate help text in Tcl helptext list.  */
-       Jim_Obj *helptext = Jim_GetGlobalVariableStr(interp, "ocd_helptext", JIM_ERRMSG);
-       if (Jim_IsShared(helptext))
-               helptext = Jim_DuplicateObj(interp, helptext);
-
-       Jim_Obj *cmd_entry = Jim_NewListObj(interp, NULL, 0);
-
        Jim_Obj *cmd_list = Jim_NewListObj(interp, NULL, 0);
-       Jim_ListAppendElement(interp, cmd_list, Jim_NewStringObj(interp, name, -1));
+       Jim_ListAppendElement(interp, cmd_list,
+                       Jim_NewStringObj(interp, name, -1));
 
-       Jim_ListAppendElement(interp, cmd_entry, cmd_list);
-       Jim_ListAppendElement(interp, cmd_entry, Jim_NewStringObj(interp, help, -1));
-       Jim_ListAppendElement(interp, helptext, cmd_entry);
+       command_helptext_add(cmd_list, help);
 }
 
 /* return global variable long value or 0 upon failure */

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)