]> cloudbase.mooo.com Git - z180-stamp.git/blobdiff - avr/command.c
Print prefix of subcommands
[z180-stamp.git] / avr / command.c
index e88e2f37083041823ce05857f4c20c10dc73ab8f..bb179b800d4b8d88e24533bca0aa7e8ec9abea8d 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * (C) Copyright 2014, 2016 Leo C. <erbl259-lmu@yahoo.de>
+ * (C) Copyright 2014, 2016, 2018 Leo C. <erbl259-lmu@yahoo.de>
  *
  * (C) Copyright 2000-2009
  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
@@ -13,8 +13,6 @@
 
 #include "command.h"
 #include "common.h"
-#include <stdlib.h>
-#include <string.h>
 #include <ctype.h>
 #include <setjmp.h>
 
 #include "env.h"
 #include "debug.h"
 
+#define DEBUG_CMD      1       /* set to 1 to debug */
+
+#define debug_cmd(fmt, args...)                                                              \
+       debug_cond(DEBUG_CMD, fmt, ##args)
+
 
 jmp_buf cmd_jbuf;
 
 
-static void print_usage_line(const FLASH char *name, int width,
-                               const FLASH char *usage)
+static int cmd_tbl_item_count(cmd_tbl_t *p)
+{
+       int count = 0;
+
+       while (p->name != NULL) {
+               if (p->subcmd) {
+                       cmd_tbl_t *sub = p->subcmd;
+                       while (sub->name != NULL) {
+                               if (sub->flags & CTBL_SUBCMDAUTO)
+                                       count++;
+                               sub++;
+                       }
+               }
+               if ((p->flags & CTBL_SUBCMDAUTO) == 0)
+                       count++;
+               p++;
+       }
+       return count;
+}
+
+static cmd_tbl_t *get_cmd_tbl_base(cmd_tbl_t  *cmdtp)
+{
+       cmd_tbl_t *p = cmdtp;
+
+       while (p->name != NULL)
+               ++p;
+
+       return p->subcmd;
+}
+
+static void print_name_prefix(cmd_tbl_t *p)
+{
+       cmd_tbl_t *tbl_start = get_cmd_tbl_base(p);
+       cmd_tbl_t *top;
+
+       if (tbl_start == cmd_tbl)
+               top = NULL;
+       else {
+               top = cmd_tbl;
+               while (top->subcmd != tbl_start)
+                       ++top;
+       }
+
+       if (top && (p->flags & CTBL_SUBCMDAUTO) == 0) {
+               printf_P(PSTR("%S "), top->name);
+       }
+}
+
+static void print_usage_line(cmd_tbl_t *p, int width)
 {
-       width -= strlen_P(name);
+       width -= strlen_P(p->name);
        if (width < 0)
                width = 0;
-       my_puts_P(name);
+       print_name_prefix(p);
+       my_puts_P(p->name);
        print_blanks(width);
        my_puts_P(PSTR(" - "));
-       my_puts_P(usage);
-       my_puts_P(PSTR("\n"));
+       puts_P(p->usage);
 }
 
-int strcmp_PP(const FLASH char *s1, const FLASH char *s2)
+static int strcmp_PP(const FLASH char *s1, const FLASH char *s2)
 {
        unsigned char c1, c2;
 
@@ -53,7 +103,7 @@ int strcmp_PP(const FLASH char *s1, const FLASH char *s2)
        return c1 - c2;
 }
 
-int cmpstring_PP(const void *p1, const void *p2)
+static int cmpstring_PP(const void *p1, const void *p2)
 {
        return strcmp_PP((*(const FLASH cmd_tbl_t **) p1)->name,
                         (*(const FLASH cmd_tbl_t **) p2)->name);
@@ -61,95 +111,49 @@ int cmpstring_PP(const void *p1, const void *p2)
 
 /****************************************************************************/
 
-int cmd_tbl_item_count(cmd_tbl_t *p)
-{
-       int count = 0;
-
-       while (p->name != NULL) {
-               p++; count++;
-       }
-       return count;
-}
-
-
-cmd_tbl_t *get_cmd_tbl_base(cmd_tbl_t  *cmdtp)
-{
-       cmd_tbl_t *p = cmdtp;
-
-       while (p->name != NULL)
-               ++p;
-
-       return p->subcmd;
-}
-
 /*
  * find command table entry for a command
  */
-typedef struct {
-               size_t len;
-               uint_fast8_t level;
-               bool opt_debug;
-       } find_cmd_para_t;
 
-cmd_tbl_t *_find_cmd (const char *cmd, cmd_tbl_t *table, find_cmd_para_t *para)
+static cmd_tbl_t *find_cmd (const char *cmd, cmd_tbl_t *table)
 {
-       cmd_tbl_t *cmdtp_ret = NULL;
-       uint_fast8_t n_found = 0, sub_found = 0;
-
-       for (cmd_tbl_t *cmdtp = table; cmdtp->name != NULL; cmdtp++) {
-               if (strncmp_P(cmd, cmdtp->name, para->len) == 0 &&
-                                       (para->opt_debug || !(cmdtp->flags & CTBL_DBG))) {
-                       if (para->len == strlen_P(cmdtp->name))
-                               return cmdtp;   /* full match */
-
-                       cmdtp_ret = cmdtp;      /* abbreviated command ? */
-                       n_found++;
-               } else if (cmdtp->subcmd && cmdtp->flags & CTBL_SUBCMDAUTO) {
-                       cmd_tbl_t *sub = _find_cmd(cmd, cmdtp->subcmd, para);
-                       if (sub) {
-                               cmdtp_ret = sub;
-                               ++n_found;
-                       }
-               }
-       }
-       if (n_found == 1) {                     /* exactly one match */
-               if (sub_found)
-                       para->level++;
-               return cmdtp_ret;
-       }
-
-       return NULL;    /* not found or ambiguous command */
-}
-
-
-cmd_tbl_t *find_cmd (const char *cmd, cmd_tbl_t *table, uint_fast8_t *cmdlevel)
-{
-       find_cmd_para_t para;
-
        if (!cmd)
                return NULL;
 
        char *optenv = getenv_str(PSTR("cmd"));
-       para.level = 0;
-       para.opt_debug = optenv && strstr_P(optenv, PSTR("debug")) != NULL;
-       para.len = strlen(cmd);
-
-       cmd_tbl_t *cmdtp = _find_cmd(cmd, table, &para);
+       uint8_t opt_debug = optenv && strstr_P(optenv, PSTR("debug")) != NULL;
 
-       if (cmdlevel)
-               *cmdlevel = para.level;
-       return cmdtp;
-}
+       cmd_tbl_t *cmdtp_ret = NULL;
+       uint_fast8_t n_found = 0;
+       uint_fast8_t len = strlen(cmd);
 
-cmd_tbl_t *find_cmd_sub(const char *cmd, cmd_tbl_t *table)
-{
-       cmd_tbl_t *entry = NULL;
+       for (cmd_tbl_t *cmdtp = table; cmdtp->name != NULL; cmdtp++) {
+               if (cmdtp->subcmd) {
+                       for (cmd_tbl_t *sub = cmdtp->subcmd; sub->name != NULL; sub++) {
+                               if (sub->flags & CTBL_SUBCMDAUTO &&
+                                                       strncmp_P(cmd, sub->name, len) == 0 &&
+                                                       (opt_debug || !(sub->flags & CTBL_DBG))) {
+                                       if (len == strlen_P(sub->name))
+                                               return sub;                             /* full match */
+                                       cmdtp_ret = sub;                        /* abbreviated command ? */
+                                       ++n_found;
+                               }
+                       }
+               }
+               if ((cmdtp->flags & CTBL_SUBCMDAUTO) == 0 &&
+                                       strncmp_P(cmd, cmdtp->name, len) == 0 &&
+                                       (opt_debug || !(cmdtp->flags & CTBL_DBG))) {
+                       if (len == strlen_P(cmdtp->name))
+                               return cmdtp;                                   /* full match */
+                       cmdtp_ret = cmdtp;                                      /* abbreviated command ? */
+                       ++n_found;
+               }
+       }
 
-       for (cmd_tbl_t *tp = get_cmd_tbl_base(table); tp->name && entry == NULL; tp++)
-               if (tp->subcmd && tp->flags & CTBL_SUBCMDAUTO)
-                       entry = find_cmd(cmd, tp->subcmd, NULL);
+       if (n_found == 1)
+               return cmdtp_ret;                       /* exactly one match */
 
-       return entry;
+       return NULL;    /* not found or ambiguous command */
 }
 
 /*
@@ -160,54 +164,67 @@ cmd_tbl_t *find_cmd_sub(const char *cmd, cmd_tbl_t *table)
 command_ret_t do_help(cmd_tbl_t *cmdtp, uint_fast8_t flag UNUSED, int argc, char * const argv[])
 {
        cmd_tbl_t *tbl_start = get_cmd_tbl_base(cmdtp);
+       command_ret_t rc = CMD_RET_SUCCESS;
 
        char *optenv = getenv_str(PSTR("cmd"));
        bool opt_debug = optenv && strstr_P(optenv, PSTR("debug")) != NULL;
 
        if (argc == 1) {        /*show list of commands */
                int cmd_items = cmd_tbl_item_count(tbl_start);
-               cmd_tbl_t *cmd_array[cmd_items];
-               cmd_tbl_t *tp = tbl_start;
-               uint_fast8_t max_len = 0;
+               cmd_tbl_t **cmd_list = (cmd_tbl_t **) malloc(cmd_items * sizeof(cmd_tbl_t *));
+               uint_fast8_t maxlen_cmd = 0;
 
-               /* Make array of commands from .uboot_cmd section */
-               for (int i = 0; i < cmd_items; i++) {
-                       cmd_array[i] = tp++;
-                       uint_fast8_t l = strlen_P(cmd_array[i]->name);
-                       if (l > max_len)
-                               max_len = l;
+               /* Make array of commands */
+               cmd_tbl_t *tp = tbl_start;
+               int i = 0;
+               while (tp->name != NULL) {
+                       if (tp->subcmd) {
+                               cmd_tbl_t *sub = tp->subcmd;
+                               while (sub->name != NULL) {
+                                       if (sub->flags & CTBL_SUBCMDAUTO) {
+                                               uint_fast8_t len = strlen_P(sub->name);
+                                               if (len > maxlen_cmd)
+                                                       maxlen_cmd = len;
+                                               cmd_list[i++] = sub;
+                                       }
+                                       sub++;
+                               }
+                       }
+                       if ((tp->flags & CTBL_SUBCMDAUTO) == 0) {
+                               uint_fast8_t len = strlen_P(tp->name);
+                               if (len > maxlen_cmd)
+                                       maxlen_cmd = len;
+                                       cmd_list[i++] = tp;
+                       }
+                       tp++;
                }
-
                /* Sort command list */
-               qsort(cmd_array, cmd_items, sizeof (cmd_tbl_t *), cmpstring_PP);
+               qsort(cmd_list, cmd_items, sizeof (cmd_tbl_t *), cmpstring_PP);
 
                /* print short help (usage) */
                for (int i = 0; i < cmd_items; i++) {
-                       if (opt_debug || !(cmd_array[i]->flags & CTBL_DBG)) {
-                               const FLASH char *usage = cmd_array[i]->usage;
-
-                               /* allow user abort */
-                               if (ctrlc ())
-                                       return CMD_RET_FAILURE;
-                               if (usage == NULL)
-                                       continue;
-#if defined(GCC_BUG_61443) || 1
-                               print_usage_line(cmd_array[i]->name, max_len, usage);
-#else
-                               printf_P(PSTR("%-" stringify(8) /*FIXME*/ "S - %S\n"),
-                                               cmd_array[i]->name, usage);
-#endif
+                       if ((cmd_list[i]->flags & CTBL_DBG) && !opt_debug)
+                               continue;
+                       if (cmd_list[i]->usage == NULL)
+                               continue;
+
+                       print_usage_line(cmd_list[i], maxlen_cmd);
+
+                       /* allow user abort */
+                       if (ctrlc ()) {
+                               rc = CMD_RET_FAILURE;
+                               break;
                        }
                }
-               return CMD_RET_SUCCESS;
+               free(cmd_list);
+               return rc;
        }
 
        /*
         * command help (long version)
         */
        for (uint8_t i = 1; i < argc; ++i) {
-               if ((cmdtp = find_cmd(argv[i], tbl_start, NULL)) != NULL &&
-                                       (opt_debug || cmdtp->name[0] != '!')) {
+               if ((cmdtp = find_cmd(argv[i], tbl_start)) != NULL) {
                        cmd_usage(cmdtp);
                } else {
                        printf_P(PSTR("Unknown command '%s' - try 'help'"
@@ -221,30 +238,19 @@ command_ret_t do_help(cmd_tbl_t *cmdtp, uint_fast8_t flag UNUSED, int argc, char
 }
 
 
-command_ret_t cmd_usage(const FLASH cmd_tbl_t *cmdtp)
+command_ret_t cmd_usage(cmd_tbl_t *cmdtp)
 {
-//     printf("%s - %s\n\n", cmdtp->name, cmdtp->usage);
-       print_usage_line(cmdtp->name, 0, cmdtp->usage);
-#if 0
-       my_puts_P(cmdtp->name);
-       print_blanks(/*FIXME*/ 8 - strlen_P(cmdtp->name));
-       my_puts_P(PSTR(" - "));
-       my_puts_P(cmdtp->usage);
-       my_puts_P(PSTR("\n\n"));
-#endif
+       print_usage_line(cmdtp, 0);
 #ifdef CONFIG_SYS_LONGHELP
-//     printf("Usage:\n%s ", cmdtp->name);
        my_puts_P(PSTR("Usage:\n"));
+       print_name_prefix(cmdtp);
        my_puts_P(cmdtp->name);
        my_puts_P(PSTR(" "));
 
-       if (!cmdtp->help) {
+       if (cmdtp->help && *cmdtp->help != '\0')
+               puts_P(cmdtp->help);
+       else
                my_puts_P(PSTR(" - No additional help available.\n"));
-               return CMD_RET_FAILURE;
-       }
-
-       my_puts_P(cmdtp->help);
-       my_puts_P(PSTR("\n"));
 #endif /* CONFIG_SYS_LONGHELP */
        return CMD_RET_FAILURE;
 }
@@ -538,16 +544,15 @@ command_ret_t cmd_process(uint_fast8_t flag, int argc, char * const argv[],
 {
        command_ret_t rc = CMD_RET_SUCCESS;
        cmd_tbl_t *cmdtp;
-       uint_fast8_t cmdlevel;
 
        /* Look up command in command table */
-       cmdtp = find_cmd(argv[0], cmd_tbl, &cmdlevel);
+       cmdtp = find_cmd(argv[0], cmd_tbl);
        if (cmdtp != NULL) {
                /* Check if this command has subcommands */
                if (cmdtp->subcmd && argc > 1) {
 
                        /* Look up subcommand in subcommand table */
-                       cmd_tbl_t *cmdtpsub = find_cmd(argv[1], cmdtp->subcmd, &cmdlevel);
+                       cmd_tbl_t *cmdtpsub = find_cmd(argv[1], cmdtp->subcmd);
                        if (cmdtpsub == NULL) {
                                printf_P(PSTR("Unknown '%s' subcommand '%s' - try '%s help'\n"), argv[0], argv[1], argv[0]);
                                return CMD_RET_FAILURE;
@@ -557,12 +562,6 @@ command_ret_t cmd_process(uint_fast8_t flag, int argc, char * const argv[],
                        ++argv;
                }
        }
-#if 0
-        else {
-               /* Search subcommands */
-               cmdtp = find_cmd_sub(argv[0], cmd_tbl, &cmdlevel);
-       }
-#endif
 
        if (cmdtp == NULL) {
                printf_P(PSTR("Unknown command '%s' - try 'help'\n"), argv[0]);