Miscellaneous warning cleanup
[openafs.git] / src / cmd / cmd.c
1 /*
2  * Copyright 2000, International Business Machines Corporation and others.
3  * All Rights Reserved.
4  * 
5  * This software has been released under the terms of the IBM Public
6  * License.  For details, see the LICENSE file in the top-level source
7  * directory or online at http://www.openafs.org/dl/license10.html
8  */
9
10 #include <afsconfig.h>
11 #include <afs/param.h>
12
13
14 #include <sys/types.h>
15 #include <ctype.h>
16 #include "cmd.h"
17 #include <stdio.h>
18 #include <string.h>
19 #include <stdlib.h>
20 #include <assert.h>
21
22 /* declaration of private token type */
23 struct cmd_token {
24     struct cmd_token *next;
25     char *key;
26 };
27
28 static int dummy;               /* non-null ptr used for flag existence */
29 static struct cmd_syndesc *allSyntax = 0;
30 static int noOpcodes = 0;
31 static int (*beforeProc) (struct cmd_syndesc * ts, void *beforeRock) = NULL;
32 static int (*afterProc) (struct cmd_syndesc * ts, void *afterRock) = NULL;
33 static void *beforeRock, *afterRock;
34 static char initcmd_opcode[] = "initcmd";       /*Name of initcmd opcode */
35
36 /* take name and string, and return null string if name is empty, otherwise return
37    the concatenation of the two strings */
38 static char *
39 NName(char *a1, char *a2)
40 {
41     static char tbuffer[300];
42     if (strlen(a1) == 0) {
43         return "";
44     } else {
45         strncpy(tbuffer, a1, sizeof(tbuffer));
46         strncat(tbuffer, a2, sizeof(tbuffer));
47         tbuffer[sizeof(tbuffer)-1]='\0';
48         return tbuffer;
49     }
50 }
51
52 /* return true if asub is a substring of amain */
53 static int
54 SubString(register char *amain, register char *asub)
55 {
56     int mlen, slen;
57     register int i, j;
58     mlen = (int) strlen(amain);
59     slen = (int) strlen(asub);
60     j = mlen - slen;
61     if (j < 0)
62         return 0;               /* not a substring */
63     for (i = 0; i <= j; i++) {
64         if (strncmp(amain, asub, slen) == 0)
65             return 1;
66         amain++;
67     }
68     return 0;                   /* didn't find it */
69 }
70
71 static int
72 FindType(register struct cmd_syndesc *as, register char *aname)
73 {
74     register int i;
75     size_t cmdlen;
76     int ambig;
77     int best;
78
79     cmdlen = strlen(aname);
80     ambig = 0;
81     best = -1;
82     for (i = 0; i < CMD_MAXPARMS; i++) {
83         if (as->parms[i].type == 0)
84             continue;           /* this slot not set (seeked over) */
85         if (strcmp(as->parms[i].name, aname) == 0)
86             return i;
87         if (strlen(as->parms[i].name) < cmdlen)
88             continue;
89         /* A hidden option must be a full match (no best matches) */
90         if (as->parms[i].flags & CMD_HIDE)
91             continue;
92
93         if (strncmp(as->parms[i].name, aname, cmdlen) == 0) {
94             if (best != -1)
95                 ambig = 1;
96             else
97                 best = i;
98         }
99     }
100     return (ambig ? -1 : best);
101 }
102
103 static struct cmd_syndesc *
104 FindSyntax(char *aname, int *aambig)
105 {
106     register struct cmd_syndesc *ts;
107     struct cmd_syndesc *best;
108     size_t cmdLen;
109     int ambig;
110
111     cmdLen = strlen(aname);
112     best = (struct cmd_syndesc *)0;
113     ambig = 0;
114     if (aambig)
115         *aambig = 0;            /* initialize to unambiguous */
116     for (ts = allSyntax; ts; ts = ts->next) {
117         if (strcmp(aname, ts->name) == 0)
118             return (ts);
119         if (strlen(ts->name) < cmdLen)
120             continue;           /* we typed more than item has */
121         /* A hidden command must be a full match (no best matches) */
122         if (ts->flags & CMD_HIDDEN)
123             continue;
124
125         /* This is just an alias for *best, or *best is just an alias for us.
126          * If we don't make this check explicitly, then an alias which is just a
127          * short prefix of the real command's name might make things ambiguous
128          * for no apparent reason.
129          */
130         if (best && ts->aliasOf == best->aliasOf)
131             continue;
132         if (strncmp(ts->name, aname, cmdLen) == 0) {
133             if (best)
134                 ambig = 1;      /* ambiguous name */
135             else
136                 best = ts;
137         }
138     }
139     if (ambig) {
140         if (aambig)
141             *aambig = ambig;    /* if ambiguous and they care, tell them */
142         return (struct cmd_syndesc *)0; /* fails */
143     } else
144         return best;            /* otherwise its not ambiguous, and they know */
145 }
146
147 /* print the help for a single parameter */
148 static void
149 PrintParmHelp(register struct cmd_parmdesc *aparm)
150 {
151     if (aparm->type == CMD_FLAG) {
152 #ifdef notdef
153         /* doc people don't like seeing this information */
154         if (aparm->help)
155             printf(" (%s)", aparm->help);
156 #endif
157     } else if (aparm->help) {
158         printf(" <%s>", aparm->help);
159         if (aparm->type == CMD_LIST)
160             printf("+");
161     } else if (aparm->type == CMD_SINGLE)
162         printf(" <arg>");
163     else if (aparm->type == CMD_LIST)
164         printf(" <arg>+");
165 }
166
167 extern char *AFSVersion;
168
169 static int
170 VersionProc(register struct cmd_syndesc *as, void *arock)
171 {
172     printf("%s\n", AFSVersion);
173     return 0;
174 }
175
176 void
177 PrintSyntax(register struct cmd_syndesc *as)
178 {
179     register int i;
180     register struct cmd_parmdesc *tp;
181
182     /* now print usage, from syntax table */
183     if (noOpcodes)
184         printf("Usage: %s", as->a0name);
185     else {
186         if (!strcmp(as->name, initcmd_opcode))
187             printf("Usage: %s[%s]", NName(as->a0name, " "), as->name);
188         else
189             printf("Usage: %s%s", NName(as->a0name, " "), as->name);
190     }
191
192     for (i = 0; i < CMD_MAXPARMS; i++) {
193         tp = &as->parms[i];
194         if (tp->type == 0)
195             continue;           /* seeked over slot */
196         if (tp->flags & CMD_HIDE)
197             continue;           /* skip hidden options */
198         printf(" ");
199         if (tp->flags & CMD_OPTIONAL)
200             printf("[");
201         printf("%s", tp->name);
202         PrintParmHelp(tp);
203         if (tp->flags & CMD_OPTIONAL)
204             printf("]");
205     }
206     printf("\n");
207 }
208
209 /* must print newline in any case, to terminate preceding line */
210 static void
211 PrintAliases(register struct cmd_syndesc *as)
212 {
213     register struct cmd_syndesc *ts;
214
215     if (as->flags & CMD_ALIAS) {
216         ts = as->aliasOf;
217         printf("(alias for %s)\n", ts->name);
218     } else {
219         printf("\n");
220         if (!as->nextAlias)
221             return;             /* none, print nothing */
222         printf("aliases: ");
223         for (as = as->nextAlias; as; as = as->nextAlias) {
224             printf("%s ", as->name);
225         }
226         printf("\n");
227     }
228 }
229
230 void
231 PrintFlagHelp(register struct cmd_syndesc *as)
232 {
233     register int i;
234     register struct cmd_parmdesc *tp;
235     int flag_width;
236     char *flag_prefix;
237
238     /* find flag name length */
239     flag_width = 0;
240     for (i = 0; i < CMD_MAXPARMS; i++) {
241         if (i == CMD_HELPPARM)
242             continue;
243         tp = &as->parms[i];
244         if (tp->type != CMD_FLAG)
245             continue;
246         if (tp->flags & CMD_HIDE)
247             continue;           /* skip hidden options */
248         if (!tp->help)
249             continue;
250
251         if (strlen(tp->name) > flag_width)
252             flag_width = strlen(tp->name);
253     }
254
255     /* print flag help */
256     flag_prefix = "Where:";
257     for (i = 0; i < CMD_MAXPARMS; i++) {
258         if (i == CMD_HELPPARM)
259             continue;
260         tp = &as->parms[i];
261         if (tp->type != CMD_FLAG)
262             continue;
263         if (tp->flags & CMD_HIDE)
264             continue;           /* skip hidden options */
265         if (!tp->help)
266             continue;
267
268         printf("%-7s%-*s  %s\n", flag_prefix, flag_width, tp->name, tp->help);
269         flag_prefix = "";
270     }
271 }
272
273 static int
274 AproposProc(register struct cmd_syndesc *as, void *arock)
275 {
276     register struct cmd_syndesc *ts;
277     char *tsub;
278     int didAny;
279
280     didAny = 0;
281     tsub = as->parms[0].items->data;
282     for (ts = allSyntax; ts; ts = ts->next) {
283         if ((ts->flags & CMD_ALIAS) || (ts->flags & CMD_HIDDEN))
284             continue;
285         if (SubString(ts->help, tsub)) {
286             printf("%s: %s\n", ts->name, ts->help);
287             didAny = 1;
288         } else if (SubString(ts->name, tsub)) {
289             printf("%s: %s\n", ts->name, ts->help);
290             didAny = 1;
291         }
292     }
293     if (!didAny)
294         printf("Sorry, no commands found\n");
295     return 0;
296 }
297
298 static int
299 HelpProc(register struct cmd_syndesc *as, void *arock)
300 {
301     register struct cmd_syndesc *ts;
302     register struct cmd_item *ti;
303     int ambig;
304     int code = 0;
305
306     if (as->parms[0].items == 0) {
307         printf("%sCommands are:\n", NName(as->a0name, ": "));
308         for (ts = allSyntax; ts; ts = ts->next) {
309             if ((ts->flags & CMD_ALIAS) || (ts->flags & CMD_HIDDEN))
310                 continue;
311             printf("%-15s %s\n", ts->name, (ts->help ? ts->help : ""));
312         }
313     } else {
314         /* print out individual help topics */
315         for (ti = as->parms[0].items; ti; ti = ti->next) {
316             code = 0;
317             ts = FindSyntax(ti->data, &ambig);
318             if (ts && (ts->flags & CMD_HIDDEN))
319                 ts = 0;         /* no hidden commands */
320             if (ts) {
321                 /* print out command name and help */
322                 printf("%s%s: %s ", NName(as->a0name, " "), ts->name,
323                        (ts->help ? ts->help : ""));
324                 ts->a0name = as->a0name;
325                 PrintAliases(ts);
326                 PrintSyntax(ts);
327                 PrintFlagHelp(ts);
328             } else {
329                 if (!ambig)
330                     fprintf(stderr, "%sUnknown topic '%s'\n",
331                             NName(as->a0name, ": "), ti->data);
332                 else {
333                     /* ambiguous, list 'em all */
334                     fprintf(stderr,
335                             "%sAmbiguous topic '%s'; use 'apropos' to list\n",
336                             NName(as->a0name, ": "), ti->data);
337                 }
338                 code = CMD_UNKNOWNCMD;
339             }
340         }
341     }
342     return (code);
343 }
344
345 int
346 cmd_SetBeforeProc(int (*aproc) (struct cmd_syndesc * ts, void *beforeRock),
347                   void *arock)
348 {
349     beforeProc = aproc;
350     beforeRock = arock;
351     return 0;
352 }
353
354 int
355 cmd_SetAfterProc(int (*aproc) (struct cmd_syndesc * ts, void *afterRock),
356                  void *arock)
357 {
358     afterProc = aproc;
359     afterRock = arock;
360     return 0;
361 }
362
363 /* thread on list in alphabetical order */
364 static int
365 SortSyntax(struct cmd_syndesc *as)
366 {
367     register struct cmd_syndesc **ld, *ud;
368
369     for (ld = &allSyntax, ud = *ld; ud; ld = &ud->next, ud = *ld) {
370         if (strcmp(ud->name, as->name) > 0) {   /* next guy is bigger than us */
371             break;
372         }
373     }
374     /* thread us on the list now */
375     *ld = as;
376     as->next = ud;
377     return 0;
378 }
379
380 struct cmd_syndesc *
381 cmd_CreateSyntax(char *aname,
382                  int (*aproc) (struct cmd_syndesc * ts, void *arock),
383                  void *arock, char *ahelp)
384 {
385     register struct cmd_syndesc *td;
386
387     /* can't have two cmds in no opcode mode */
388     if (noOpcodes)
389         return (struct cmd_syndesc *)0;
390
391     td = (struct cmd_syndesc *)calloc(1, sizeof(struct cmd_syndesc));
392     assert(td);
393     td->aliasOf = td;           /* treat aliasOf as pointer to real command, no matter what */
394
395     /* copy in name, etc */
396     if (aname) {
397         td->name = (char *)malloc(strlen(aname) + 1);
398         assert(td->name);
399         strcpy(td->name, aname);
400     } else {
401         td->name = NULL;
402         noOpcodes = 1;
403     }
404     if (ahelp) {
405         /* Piggy-back the hidden option onto the help string */
406         if (ahelp == (char *)CMD_HIDDEN) {
407             td->flags |= CMD_HIDDEN;
408         } else {
409             td->help = (char *)malloc(strlen(ahelp) + 1);
410             assert(td->help);
411             strcpy(td->help, ahelp);
412         }
413     } else
414         td->help = NULL;
415     td->proc = aproc;
416     td->rock = arock;
417
418     SortSyntax(td);
419
420     cmd_Seek(td, CMD_HELPPARM);
421     cmd_AddParm(td, "-help", CMD_FLAG, CMD_OPTIONAL, "get detailed help");
422     cmd_Seek(td, 0);
423
424     return td;
425 }
426
427 int
428 cmd_CreateAlias(register struct cmd_syndesc *as, char *aname)
429 {
430     register struct cmd_syndesc *td;
431
432     td = (struct cmd_syndesc *)malloc(sizeof(struct cmd_syndesc));
433     assert(td);
434     memcpy(td, as, sizeof(struct cmd_syndesc));
435     td->name = (char *)malloc(strlen(aname) + 1);
436     assert(td->name);
437     strcpy(td->name, aname);
438     td->flags |= CMD_ALIAS;
439     /* if ever free things, make copy of help string, too */
440
441     /* thread on list */
442     SortSyntax(td);
443
444     /* thread on alias lists */
445     td->nextAlias = as->nextAlias;
446     as->nextAlias = td;
447     td->aliasOf = as;
448
449     return 0;                   /* all done */
450 }
451
452 int
453 cmd_IsAdministratorCommand(register struct cmd_syndesc *as)
454 {
455     as->flags |= CMD_ADMIN;
456     return 0;
457 }
458
459 int
460 cmd_Seek(register struct cmd_syndesc *as, int apos)
461 {
462     if (apos >= CMD_MAXPARMS)
463         return CMD_EXCESSPARMS;
464     as->nParms = apos;
465     return 0;
466 }
467
468 int
469 cmd_AddParm(register struct cmd_syndesc *as, char *aname, int atype,
470             afs_int32 aflags, char *ahelp)
471 {
472     register struct cmd_parmdesc *tp;
473
474     if (as->nParms >= CMD_MAXPARMS)
475         return CMD_EXCESSPARMS;
476     tp = &as->parms[as->nParms++];
477
478     tp->name = (char *)malloc(strlen(aname) + 1);
479     assert(tp->name);
480     strcpy(tp->name, aname);
481     tp->type = atype;
482     tp->flags = aflags;
483     tp->items = NULL;
484     if (ahelp) {
485         tp->help = (char *)malloc(strlen(ahelp) + 1);
486         assert(tp->help);
487         strcpy(tp->help, ahelp);
488     } else
489         tp->help = NULL;
490     return 0;
491 }
492
493 /* add a text item to the end of the parameter list */
494 static int
495 AddItem(register struct cmd_parmdesc *aparm, register char *aval)
496 {
497     register struct cmd_item *ti, *ni;
498     ti = (struct cmd_item *)calloc(1, sizeof(struct cmd_item));
499     assert(ti);
500     ti->data = (char *)malloc(strlen(aval) + 1);
501     assert(ti->data);
502     strcpy(ti->data, aval);
503     /* now put ti at the *end* of the list */
504     if ((ni = aparm->items)) {
505         for (; ni; ni = ni->next)
506             if (ni->next == 0)
507                 break;          /* skip to last one */
508         ni->next = ti;
509     } else
510         aparm->items = ti;      /* we're first */
511     return 0;
512 }
513
514 /* skip to next non-flag item, if any */
515 static int
516 AdvanceType(register struct cmd_syndesc *as, register afs_int32 aval)
517 {
518     register afs_int32 next;
519     register struct cmd_parmdesc *tp;
520
521     /* first see if we should try to grab rest of line for this dude */
522     if (as->parms[aval].flags & CMD_EXPANDS)
523         return aval;
524
525     /* if not, find next non-flag used slot */
526     for (next = aval + 1; next < CMD_MAXPARMS; next++) {
527         tp = &as->parms[next];
528         if (tp->type != 0 && tp->type != CMD_FLAG)
529             return next;
530     }
531     return aval;
532 }
533
534 /* discard parameters filled in by dispatch */
535 static void
536 ResetSyntax(register struct cmd_syndesc *as)
537 {
538     int i;
539     register struct cmd_parmdesc *tp;
540     register struct cmd_item *ti, *ni;
541
542     tp = as->parms;
543     for (i = 0; i < CMD_MAXPARMS; i++, tp++) {
544         switch (tp->type) {
545         case CMD_SINGLE:
546         case CMD_LIST:
547             /* free whole list in both cases, just for fun */
548             for (ti = tp->items; ti; ti = ni) {
549                 ni = ti->next;
550                 free(ti->data);
551                 free(ti);
552             }
553             break;
554
555         default:
556             break;
557         }
558         tp->items = NULL;
559     }
560 }
561
562 /* move the expands flag to the last one in the list */
563 static int
564 SetupExpandsFlag(register struct cmd_syndesc *as)
565 {
566     register struct cmd_parmdesc *tp;
567     register int last, i;
568
569     last = -1;
570     /* find last CMD_LIST type parameter, optional or not, and make it expandable
571      * if no other dude is expandable */
572     for (i = 0; i < CMD_MAXPARMS; i++) {
573         tp = &as->parms[i];
574         if (tp->type == CMD_LIST) {
575             if (tp->flags & CMD_EXPANDS)
576                 return 0;       /* done if already specified */
577             last = i;
578         }
579     }
580     if (last >= 0)
581         as->parms[last].flags |= CMD_EXPANDS;
582     return 0;
583 }
584
585 /*Take the current argv & argc and alter them so that the initialization opcode is made to appear.  This is used in cases where the initialization opcode is implicitly invoked.*/
586 static char **
587 InsertInitOpcode(int *aargc, char **aargv)
588 {
589     char **newargv;             /*Ptr to new, expanded argv space */
590     char *pinitopcode;          /*Ptr to space for name of init opcode */
591     int i;                      /*Loop counter */
592
593     /*Allocate the new argv array, plus one for the new opcode, plus one more for the trailing null pointer */
594     newargv = (char **)malloc(((*aargc) + 2) * sizeof(char *));
595     if (!newargv) {
596         fprintf(stderr, "%s: Can't create new argv array with %d+2 slots\n",
597                 aargv[0], *aargc);
598         return (NULL);
599     }
600
601     /*Create space for the initial opcode & fill it in */
602     pinitopcode = (char *)malloc(sizeof(initcmd_opcode));
603     if (!pinitopcode) {
604         fprintf(stderr, "%s: Can't malloc initial opcode space\n", aargv[0]);
605         free(newargv);
606         return (NULL);
607     }
608     strcpy(pinitopcode, initcmd_opcode);
609
610     /*Move all the items in the old argv into the new argv, in their proper places */
611     for (i = *aargc; i > 1; i--)
612         newargv[i] = aargv[i - 1];
613
614     /*Slip in the opcode and the trailing null pointer, and bump the argument count up by one for the new opcode */
615     newargv[0] = aargv[0];
616     newargv[1] = pinitopcode;
617     (*aargc)++;
618     newargv[*aargc] = NULL;
619
620     /*Return the happy news */
621     return (newargv);
622
623 }                               /*InsertInitOpcode */
624
625 static int
626 NoParmsOK(register struct cmd_syndesc *as)
627 {
628     register int i;
629     register struct cmd_parmdesc *td;
630
631     for (i = 0; i < CMD_MAXPARMS; i++) {
632         td = &as->parms[i];
633         if (td->type != 0 && !(td->flags & CMD_OPTIONAL)) {
634             /* found a non-optional (e.g. required) parm, so NoParmsOK
635              * is false (some parms are required) */
636             return 0;
637         }
638     }
639     return 1;
640 }
641
642 /* Call the appropriate function, or return syntax error code.  Note: if no opcode is specified, an initialization routine exists, and it has NOT been called before, we invoke the special initialization opcode*/
643 int
644 cmd_Dispatch(int argc, char **argv)
645 {
646     char *pname;
647     struct cmd_syndesc *ts;
648     struct cmd_parmdesc *tparm;
649     afs_int32 i, j;
650     int curType;
651     int positional;
652     int ambig;
653     static int initd = 0;       /*Is this the first time this routine has been called? */
654     static int initcmdpossible = 1;     /*Should be consider parsing the initial command? */
655
656     if (!initd) {
657         initd = 1;
658         /* Add help, apropos commands once */
659         if (!noOpcodes) {
660             ts = cmd_CreateSyntax("help", HelpProc, (char *)0,
661                                   "get help on commands");
662             cmd_AddParm(ts, "-topic", CMD_LIST, CMD_OPTIONAL, "help string");
663             cmd_AddParm(ts, "-admin", CMD_FLAG, CMD_OPTIONAL, NULL);
664
665             ts = cmd_CreateSyntax("apropos", AproposProc, (char *)0,
666                                   "search by help text");
667             cmd_AddParm(ts, "-topic", CMD_SINGLE, CMD_REQUIRED,
668                         "help string");
669             ts = cmd_CreateSyntax("version", VersionProc, (char *)0,
670                                   (char *)CMD_HIDDEN);
671             ts = cmd_CreateSyntax("-version", VersionProc, (char *)0,
672                                   (char *)CMD_HIDDEN);
673             ts = cmd_CreateSyntax("-help", HelpProc, (char *)0,
674                                   (char *)CMD_HIDDEN);
675             ts = cmd_CreateSyntax("--version", VersionProc, (char *)0,
676                                   (char *)CMD_HIDDEN);
677             ts = cmd_CreateSyntax("--help", HelpProc, (char *)0,
678                                   (char *)CMD_HIDDEN);
679         }
680     }
681
682     /*Remember the program name */
683     pname = argv[0];
684
685     if (noOpcodes) {
686         if (argc == 1) {
687             if (!NoParmsOK(allSyntax)) {
688                 printf("%s: Type '%s -help' for help\n", pname, pname);
689                 return (CMD_USAGE);
690             }
691         }
692     } else {
693         if (argc < 2) {
694             /* if there is an initcmd, don't print an error message, just
695              * setup to use the initcmd below. */
696             if (!(initcmdpossible && FindSyntax(initcmd_opcode, (int *)0))) {
697                 printf("%s: Type '%s help' or '%s help <topic>' for help\n",
698                        pname, pname, pname);
699                 return (CMD_USAGE);
700             }
701         }
702     }
703
704     /* Find the syntax descriptor for this command, doing prefix matching properly */
705     if (noOpcodes) {
706         ts = allSyntax;
707     } else {
708         ts = (argc < 2 ? 0 : FindSyntax(argv[1], &ambig));
709         if (!ts) {
710             /*First token doesn't match a syntax descriptor */
711             if (initcmdpossible) {
712                 /*If initial command line handling hasn't been done yet,
713                  * see if there is a descriptor for the initialization opcode.
714                  * Only try this once. */
715                 initcmdpossible = 0;
716                 ts = FindSyntax(initcmd_opcode, (int *)0);
717                 if (!ts) {
718                     /*There is no initialization opcode available, so we declare
719                      * an error */
720                     if (ambig) {
721                         fprintf(stderr, "%s", NName(pname, ": "));
722                         fprintf(stderr,
723                                 "Ambiguous operation '%s'; type '%shelp' for list\n",
724                                 argv[1], NName(pname, " "));
725                     } else {
726                         fprintf(stderr, "%s", NName(pname, ": "));
727                         fprintf(stderr,
728                                 "Unrecognized operation '%s'; type '%shelp' for list\n",
729                                 argv[1], NName(pname, " "));
730                     }
731                     return (CMD_UNKNOWNCMD);
732                 } else {
733                     /*Found syntax structure for an initialization opcode.  Fix
734                      * up argv and argc to relect what the user
735                      * ``should have'' typed */
736                     if (!(argv = InsertInitOpcode(&argc, argv))) {
737                         fprintf(stderr,
738                                 "%sCan't insert implicit init opcode into command line\n",
739                                 NName(pname, ": "));
740                         return (CMD_INTERNALERROR);
741                     }
742                 }
743             } /*Initial opcode not yet attempted */
744             else {
745                 /* init cmd already run and no syntax entry found */
746                 if (ambig) {
747                     fprintf(stderr, "%s", NName(pname, ": "));
748                     fprintf(stderr,
749                             "Ambiguous operation '%s'; type '%shelp' for list\n",
750                             argv[1], NName(pname, " "));
751                 } else {
752                     fprintf(stderr, "%s", NName(pname, ": "));
753                     fprintf(stderr,
754                             "Unrecognized operation '%s'; type '%shelp' for list\n",
755                             argv[1], NName(pname, " "));
756                 }
757                 return CMD_UNKNOWNCMD;
758             }
759         }                       /*Argv[1] is not a valid opcode */
760     }                           /*Opcodes are defined */
761
762     /* Found the descriptor; start parsing.  curType is the type we're trying to parse */
763     curType = 0;
764
765     /* We start off parsing in "positional" mode, where tokens are put in
766      * slots positionally.  If we find a name that takes args, we go
767      * out of positional mode, and from that point on, expect a switch
768      * before any particular token. */
769     positional = 1;             /* Are we still in the positional region of the cmd line? */
770     i = noOpcodes ? 1 : 2;
771     SetupExpandsFlag(ts);
772     for (; i < argc; i++) {
773         /* Only tokens that start with a hyphen and are not followed by a digit
774          * are considered switches.  This allow negative numbers. */
775         if ((argv[i][0] == '-') && !isdigit(argv[i][1])) {
776             /* Find switch */
777             j = FindType(ts, argv[i]);
778             if (j < 0) {
779                 fprintf(stderr,
780                         "%sUnrecognized or ambiguous switch '%s'; type ",
781                         NName(pname, ": "), argv[i]);
782                 if (noOpcodes)
783                     fprintf(stderr, "'%s -help' for detailed help\n",
784                             argv[0]);
785                 else
786                     fprintf(stderr, "'%shelp %s' for detailed help\n",
787                             NName(argv[0], " "), ts->name);
788                 ResetSyntax(ts);
789                 return (CMD_UNKNOWNSWITCH);
790             }
791             if (j >= CMD_MAXPARMS) {
792                 fprintf(stderr, "%sInternal parsing error\n",
793                         NName(pname, ": "));
794                 ResetSyntax(ts);
795                 return (CMD_INTERNALERROR);
796             }
797             if (ts->parms[j].type == CMD_FLAG) {
798                 ts->parms[j].items = (struct cmd_item *)&dummy;
799             } else {
800                 positional = 0;
801                 curType = j;
802                 ts->parms[j].flags |= CMD_PROCESSED;
803             }
804         } else {
805             /* Try to fit in this descr */
806             if (curType >= CMD_MAXPARMS) {
807                 fprintf(stderr, "%sToo many arguments\n", NName(pname, ": "));
808                 ResetSyntax(ts);
809                 return (CMD_TOOMANY);
810             }
811             tparm = &ts->parms[curType];
812
813             if ((tparm->type == 0) ||   /* No option in this slot */
814                 (tparm->type == CMD_FLAG)) {    /* A flag (not an argument */
815                 /* skipped parm slot */
816                 curType++;      /* Skip this slot and reprocess this parm */
817                 i--;
818                 continue;
819             }
820
821             if (!(tparm->flags & CMD_PROCESSED) && (tparm->flags & CMD_HIDE)) {
822                 curType++;      /* Skip this slot and reprocess this parm */
823                 i--;
824                 continue;
825             }
826
827             if (tparm->type == CMD_SINGLE) {
828                 if (tparm->items) {
829                     fprintf(stderr, "%sToo many values after switch %s\n",
830                             NName(pname, ": "), tparm->name);
831                     ResetSyntax(ts);
832                     return (CMD_NOTLIST);
833                 }
834                 AddItem(tparm, argv[i]);        /* Add to end of list */
835             } else if (tparm->type == CMD_LIST) {
836                 AddItem(tparm, argv[i]);        /* Add to end of list */
837             }
838             /* Now, if we're in positional mode, advance to the next item */
839             if (positional)
840                 curType = AdvanceType(ts, curType);
841         }
842     }
843
844     /* keep track of this for messages */
845     ts->a0name = argv[0];
846
847     /* If we make it here, all the parameters are filled in.  Check to see if this
848      * is a -help version.  Must do this before checking for all required parms,
849      * otherwise it is a real nuisance */
850     if (ts->parms[CMD_HELPPARM].items) {
851         PrintSyntax(ts);
852         /* Display full help syntax if we don't have subcommands */
853         if (noOpcodes)
854             PrintFlagHelp(ts);
855         ResetSyntax(ts);
856         return 0;
857     }
858
859     /* Parsing done, see if we have all of our required parameters */
860     for (i = 0; i < CMD_MAXPARMS; i++) {
861         tparm = &ts->parms[i];
862         if (tparm->type == 0)
863             continue;           /* Skipped parm slot */
864         if ((tparm->flags & CMD_PROCESSED) && tparm->items == 0) {
865             fprintf(stderr, "%s The field '%s' isn't completed properly\n",
866                     NName(pname, ": "), tparm->name);
867             ResetSyntax(ts);
868             tparm->flags &= ~CMD_PROCESSED;
869             return (CMD_TOOFEW);
870         }
871         if (!(tparm->flags & CMD_OPTIONAL) && tparm->items == 0) {
872             fprintf(stderr, "%sMissing required parameter '%s'\n",
873                     NName(pname, ": "), tparm->name);
874             ResetSyntax(ts);
875             tparm->flags &= ~CMD_PROCESSED;
876             return (CMD_TOOFEW);
877         }
878         tparm->flags &= ~CMD_PROCESSED;
879     }
880
881     /*
882      * Before calling the beforeProc and afterProc and all the implications 
883      * from those calls, check if the help procedure was called and call it now.
884      */
885     if ((ts->proc == HelpProc) || (ts->proc == AproposProc)) {
886         i = (*ts->proc) (ts, ts->rock);
887         ResetSyntax(ts);
888         return (i);
889     }
890
891     /* Now, we just call the procedure and return */
892     if (beforeProc)
893         i = (*beforeProc) (ts, beforeRock);
894     else
895         i = 0;
896     if (i) {
897         ResetSyntax(ts);
898         return (i);
899     }
900     i = (*ts->proc) (ts, ts->rock);
901     if (afterProc)
902         (*afterProc) (ts, afterRock);
903     ResetSyntax(ts);            /* Reset and free things */
904     return (i);
905 }
906
907 /* free token list returned by parseLine */
908 static int
909 FreeTokens(register struct cmd_token *alist)
910 {
911     register struct cmd_token *nlist;
912     for (; alist; alist = nlist) {
913         nlist = alist->next;
914         free(alist->key);
915         free(alist);
916     }
917     return 0;
918 }
919
920 /* free an argv list returned by parseline */
921 int
922 cmd_FreeArgv(register char **argv)
923 {
924     register char *tp;
925     for (tp = *argv; tp; argv++, tp = *argv)
926         free(tp);
927     return 0;
928 }
929
930 /* copy back the arg list to the argv array, freeing the cmd_tokens as you go; the actual
931     data is still malloc'd, and will be freed when the caller calls cmd_FreeArgv
932     later on */
933 #define INITSTR ""
934 static int
935 CopyBackArgs(register struct cmd_token *alist, register char **argv,
936              afs_int32 * an, afs_int32 amaxn)
937 {
938     register struct cmd_token *next;
939     afs_int32 count;
940
941     count = 0;
942     if (amaxn <= 1)
943         return CMD_TOOMANY;
944     *argv = (char *)malloc(strlen(INITSTR) + 1);
945     assert(*argv);
946     strcpy(*argv, INITSTR);
947     amaxn--;
948     argv++;
949     count++;
950     while (alist) {
951         if (amaxn <= 1)
952             return CMD_TOOMANY; /* argv is too small for his many parms. */
953         *argv = alist->key;
954         next = alist->next;
955         free(alist);
956         alist = next;
957         amaxn--;
958         argv++;
959         count++;
960     }
961     *(argv++) = 0;              /* use last slot for terminating null */
962     /* don't count terminating null */
963     *an = count;
964     return 0;
965 }
966
967 static int
968 quote(register int x)
969 {
970     if (x == '"' || x == 39 /* single quote */ )
971         return 1;
972     else
973         return 0;
974 }
975
976 static int
977 space(register int x)
978 {
979     if (x == 0 || x == ' ' || x == '\t' || x == '\n')
980         return 1;
981     else
982         return 0;
983 }
984
985 int
986 cmd_ParseLine(char *aline, char **argv, afs_int32 * an, afs_int32 amaxn)
987 {
988     char tbuffer[256];
989     register char *tptr = 0;
990     int inToken, inQuote;
991     struct cmd_token *first, *last;
992     register struct cmd_token *ttok;
993     register int tc;
994
995     inToken = 0;                /* not copying token chars at start */
996     first = (struct cmd_token *)0;
997     last = (struct cmd_token *)0;
998     inQuote = 0;                /* not in a quoted string */
999     while (1) {
1000         tc = *aline++;
1001         if (tc == 0 || (!inQuote && space(tc))) {       /* terminating null gets us in here, too */
1002             if (inToken) {
1003                 inToken = 0;    /* end of this token */
1004                 if (!tptr)
1005                     return -1;  /* should never get here */
1006                 else
1007                     *tptr++ = 0;
1008                 ttok = (struct cmd_token *)malloc(sizeof(struct cmd_token));
1009                 assert(ttok);
1010                 ttok->next = (struct cmd_token *)0;
1011                 ttok->key = (char *)malloc(strlen(tbuffer) + 1);
1012                 assert(ttok->key);
1013                 strcpy(ttok->key, tbuffer);
1014                 if (last) {
1015                     last->next = ttok;
1016                     last = ttok;
1017                 } else
1018                     last = ttok;
1019                 if (!first)
1020                     first = ttok;
1021             }
1022         } else {
1023             /* an alpha character */
1024             if (!inToken) {
1025                 tptr = tbuffer;
1026                 inToken = 1;
1027             }
1028             if (tptr - tbuffer >= sizeof(tbuffer)) {
1029                 FreeTokens(first);
1030                 return CMD_TOOBIG;      /* token too long */
1031             }
1032             if (quote(tc)) {
1033                 /* hit a quote, toggle inQuote flag but don't insert character */
1034                 inQuote = !inQuote;
1035             } else {
1036                 /* insert character */
1037                 *tptr++ = tc;
1038             }
1039         }
1040         if (tc == 0) {
1041             /* last token flushed 'cause space(0) --> true */
1042             if (last)
1043                 last->next = (struct cmd_token *)0;
1044             return CopyBackArgs(first, argv, an, amaxn);
1045         }
1046     }
1047 }