cmd: Tidy up -help output

[openafs.git] / src / cmd / cmd.c

diff --git a/src/cmd/cmd.c b/src/cmd/cmd.c
index edd4ec0..204508d 100644 (file)
--- a/src/cmd/cmd.c
+++ b/src/cmd/cmd.c
@@ -75,6 +75,7 @@ FindType(struct cmd_syndesc *as, char *aname)
     size_t cmdlen;
     int ambig;
     int best;
+    struct cmd_item *alias;
 
     /* Allow --long-style options. */
     if (aname[0] == '-' && aname[1] == '-' && aname[2] && aname[3]) {
@@ -91,6 +92,15 @@ FindType(struct cmd_syndesc *as, char *aname)
            return i;
        if (strlen(as->parms[i].name) < cmdlen)
            continue;
+
+       /* Check for aliases, which must be full matches */
+       alias = as->parms[i].aliases;
+       while (alias != NULL) {
+           if (strcmp(alias->data, aname) == 0)
+               return i;
+           alias = alias->next;
+       }
+
        /* A hidden option must be a full match (no best matches) */
        if (as->parms[i].flags & CMD_HIDE || !enableAbbreviation)
            continue;
@@ -150,23 +160,20 @@ FindSyntax(char *aname, int *aambig)
 }
 
 /* print the help for a single parameter */
-static void
-PrintParmHelp(struct cmd_parmdesc *aparm)
+static char *
+ParmHelpString(struct cmd_parmdesc *aparm)
 {
+    char *str;
     if (aparm->type == CMD_FLAG) {
-#ifdef notdef
-       /* doc people don't like seeing this information */
-       if (aparm->help)
-           printf(" (%s)", aparm->help);
-#endif
-    } else if (aparm->help) {
-       printf(" <%s>", aparm->help);
-       if (aparm->type == CMD_LIST)
-           printf("+");
-    } else if (aparm->type == CMD_SINGLE)
-       printf(" <arg>");
-    else if (aparm->type == CMD_LIST)
-       printf(" <arg>+");
+       return strdup("");
+    } else {
+       asprintf(&str, " %s<%s>%s%s",
+                aparm->type == CMD_SINGLE_OR_FLAG?"[":"",
+                aparm->help?aparm->help:"arg",
+                aparm->type == CMD_LIST?"+":"",
+                aparm->type == CMD_SINGLE_OR_FLAG?"]":"");
+       return str;
+    }
 }
 
 extern char *AFSVersion;
@@ -183,30 +190,48 @@ PrintSyntax(struct cmd_syndesc *as)
 {
     int i;
     struct cmd_parmdesc *tp;
+    char *str;
+    size_t len;
+    size_t xtralen;
 
     /* now print usage, from syntax table */
     if (noOpcodes)
-       printf("Usage: %s", as->a0name);
+       asprintf(&str, "Usage: %s", as->a0name);
     else {
        if (!strcmp(as->name, initcmd_opcode))
-           printf("Usage: %s[%s]", NName(as->a0name, " "), as->name);
+           asprintf(&str, "Usage: %s[%s]", NName(as->a0name, " "), as->name);
        else
-           printf("Usage: %s%s", NName(as->a0name, " "), as->name);
+           asprintf(&str, "Usage: %s%s", NName(as->a0name, " "), as->name);
     }
 
+    len = strlen(str);
+    printf("%s", str);
+    free(str);
+
     for (i = 0; i < CMD_MAXPARMS; i++) {
        tp = &as->parms[i];
        if (tp->type == 0)
            continue;           /* seeked over slot */
        if (tp->flags & CMD_HIDE)
            continue;           /* skip hidden options */
-       printf(" ");
-       if (tp->flags & CMD_OPTIONAL)
-           printf("[");
-       printf("%s", tp->name);
-       PrintParmHelp(tp);
-       if (tp->flags & CMD_OPTIONAL)
-           printf("]");
+       /* Work out if we can fit what we want to on this line, or if we need to
+        * start a new one */
+       str = ParmHelpString(tp);
+       xtralen = 1 + strlen(tp->name) + strlen(str) +
+                 ((tp->flags & CMD_OPTIONAL)? 2: 0);
+
+       if (len + xtralen > 78) {
+           printf("\n        ");
+           len = 8;
+       }
+
+       printf(" %s%s%s%s",
+              tp->flags & CMD_OPTIONAL?"[":"",
+              tp->name,
+              str,
+              tp->flags & CMD_OPTIONAL?"]":"");
+       free(str);
+       len+=xtralen;
     }
     printf("\n");
 }
@@ -505,6 +530,8 @@ cmd_AddParmAtOffset(struct cmd_syndesc *as, char *aname, int atype,
     } else
        tp->help = NULL;
 
+    tp->aliases = NULL;
+
     if (as->nParms <= ref)
        as->nParms = ref+1;
 
@@ -521,6 +548,22 @@ cmd_AddParm(struct cmd_syndesc *as, char *aname, int atype,
     return cmd_AddParmAtOffset(as, aname, atype, aflags, ahelp, as->nParms++);
 }
 
+int
+cmd_AddParmAlias(struct cmd_syndesc *as, int pos, char *alias)
+{
+    struct cmd_item *item;
+
+    if (pos > as->nParms)
+       return CMD_EXCESSPARMS;
+
+    item = calloc(1, sizeof(struct cmd_item));
+    item->data = strdup(alias);
+    item->next = as->parms[pos].aliases;
+    as->parms[pos].aliases = item;
+
+    return 0;
+}
+
 /* add a text item to the end of the parameter list */
 static int
 AddItem(struct cmd_parmdesc *aparm, char *aval)
@@ -573,6 +616,10 @@ ResetSyntax(struct cmd_syndesc *as)
     tp = as->parms;
     for (i = 0; i < CMD_MAXPARMS; i++, tp++) {
        switch (tp->type) {
+       case CMD_SINGLE_OR_FLAG:
+           if (tp->items == &dummy)
+               break;
+           /* Deliberately fall through here */
        case CMD_SINGLE:
        case CMD_LIST:
            /* free whole list in both cases, just for fun */
@@ -880,7 +927,8 @@ cmd_Parse(int argc, char **argv, struct cmd_syndesc **outsyntax)
                continue;
            }
 
-           if (tparm->type == CMD_SINGLE) {
+           if (tparm->type == CMD_SINGLE ||
+               tparm->type == CMD_SINGLE_OR_FLAG) {
                if (tparm->items) {
                    fprintf(stderr, "%sToo many values after switch %s\n",
                            NName(pname, ": "), tparm->name);
@@ -918,10 +966,14 @@ cmd_Parse(int argc, char **argv, struct cmd_syndesc **outsyntax)
        if (tparm->type == 0)
            continue;           /* Skipped parm slot */
        if ((tparm->flags & CMD_PROCESSED) && tparm->items == 0) {
-           fprintf(stderr, "%s The field '%s' isn't completed properly\n",
+           if (tparm->type == CMD_SINGLE_OR_FLAG) {
+               tparm->items = &dummy;
+           } else {
+               fprintf(stderr, "%s The field '%s' isn't completed properly\n",
                    NName(pname, ": "), tparm->name);
-           code = CMD_TOOFEW;
-           goto out;
+               code = CMD_TOOFEW;
+               goto out;
+           }
        }
        if (!(tparm->flags & CMD_OPTIONAL) && tparm->items == 0) {
            fprintf(stderr, "%sMissing required parameter '%s'\n",
@@ -1136,6 +1188,9 @@ cmd_OptionAsInt(struct cmd_syndesc *syn, int pos, int *value)
     if (syn->parms[pos].items == NULL ||
        syn->parms[pos].items->data == NULL)
        return CMD_MISSING;
+    if (syn->parms[pos].items == &dummy)
+       return 0;
+
     *value = strtol(syn->parms[pos].items->data, NULL, 10);
 
     return 0;
@@ -1148,9 +1203,12 @@ cmd_OptionAsString(struct cmd_syndesc *syn, int pos, char **value)
        return CMD_EXCESSPARMS;
     if (syn->parms[pos].items == NULL || syn->parms[pos].items->data == NULL)
        return CMD_MISSING;
+    if (syn->parms[pos].items == &dummy)
+       return 0;
 
     if (*value)
        free(*value);
+
     *value = strdup(syn->parms[pos].items->data);
 
     return 0;