add help regardless of callback
[fw/openocd] / src / helper / command.c
index c6327029217ab0506dcd22bba8cc97d2df5f1911..5ac5c3015d43c6b1b41a398b7c650baad9ddad47 100644 (file)
@@ -162,6 +162,32 @@ 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"
 
@@ -179,8 +205,6 @@ 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 */
@@ -213,54 +237,28 @@ command_t* register_command(command_context_t *context, command_t *parent, char
                }
        }
 
+       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;
 }
 
@@ -404,6 +402,28 @@ 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)
+{
+       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)
 {
@@ -419,17 +439,12 @@ static int run_command(command_context_t *context,
        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)
        {
@@ -844,20 +859,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 */