2 * Copyright 2000, International Business Machines Corporation and others.
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
10 #include <afsconfig.h>
11 #include <afs/param.h>
20 /* declaration of private token type */
22 struct cmd_token *next;
26 static struct cmd_item dummy; /* non-null ptr used for flag existence */
27 static struct cmd_syndesc *allSyntax = 0;
28 static int noOpcodes = 0;
29 static int (*beforeProc) (struct cmd_syndesc * ts, void *beforeRock) = NULL;
30 static int (*afterProc) (struct cmd_syndesc * ts, void *afterRock) = NULL;
31 static int enablePositional = 1;
32 static int enableAbbreviation = 1;
33 static void *beforeRock, *afterRock;
34 static char initcmd_opcode[] = "initcmd"; /*Name of initcmd opcode */
35 static cmd_config_section *globalConfig = NULL;
36 static const char *commandName = NULL;
38 /* take name and string, and return null string if name is empty, otherwise return
39 the concatenation of the two strings */
41 NName(char *a1, char *a2)
43 static char tbuffer[300];
44 if (strlen(a1) == 0) {
47 strlcpy(tbuffer, a1, sizeof(tbuffer));
48 strlcat(tbuffer, a2, sizeof(tbuffer));
53 /* return true if asub is a substring of amain */
55 SubString(char *amain, char *asub)
59 mlen = (int) strlen(amain);
60 slen = (int) strlen(asub);
63 return 0; /* not a substring */
64 for (i = 0; i <= j; i++) {
65 if (strncmp(amain, asub, slen) == 0)
69 return 0; /* didn't find it */
73 FindType(struct cmd_syndesc *as, char *aname)
79 struct cmd_item *alias;
81 /* Allow --long-style options. */
82 if (aname[0] == '-' && aname[1] == '-' && aname[2] && aname[3]) {
86 cmdlen = strlen(aname);
89 for (i = 0; i < CMD_MAXPARMS; i++) {
90 if (as->parms[i].type == 0)
91 continue; /* this slot not set (seeked over) */
92 if (strcmp(as->parms[i].name, aname) == 0)
94 if (strlen(as->parms[i].name) < cmdlen)
97 /* Check for aliases, which must be full matches */
98 alias = as->parms[i].aliases;
99 while (alias != NULL) {
100 if (strcmp(alias->data, aname) == 0)
105 /* A hidden option, or one which cannot be abbreviated,
106 * must be a full match (no best matches) */
107 if (as->parms[i].flags & CMD_HIDE ||
108 as->parms[i].flags & CMD_NOABBRV ||
112 if (strncmp(as->parms[i].name, aname, cmdlen) == 0) {
119 return (ambig ? -1 : best);
122 static struct cmd_syndesc *
123 FindSyntax(char *aname, int *aambig)
125 struct cmd_syndesc *ts;
126 struct cmd_syndesc *best;
130 cmdLen = strlen(aname);
131 best = (struct cmd_syndesc *)0;
134 *aambig = 0; /* initialize to unambiguous */
135 for (ts = allSyntax; ts; ts = ts->next) {
136 if (strcmp(aname, ts->name) == 0)
138 if (strlen(ts->name) < cmdLen)
139 continue; /* we typed more than item has */
140 /* A hidden command must be a full match (no best matches) */
141 if (ts->flags & CMD_HIDDEN)
144 /* This is just an alias for *best, or *best is just an alias for us.
145 * If we don't make this check explicitly, then an alias which is just a
146 * short prefix of the real command's name might make things ambiguous
147 * for no apparent reason.
149 if (best && ts->aliasOf == best->aliasOf)
151 if (strncmp(ts->name, aname, cmdLen) == 0) {
153 ambig = 1; /* ambiguous name */
160 *aambig = ambig; /* if ambiguous and they care, tell them */
161 return (struct cmd_syndesc *)0; /* fails */
163 return best; /* otherwise its not ambiguous, and they know */
166 /* print the help for a single parameter */
168 ParmHelpString(struct cmd_parmdesc *aparm)
171 if (aparm->type == CMD_FLAG) {
174 if (asprintf(&str, " %s<%s>%s%s",
175 aparm->type == CMD_SINGLE_OR_FLAG?"[":"",
176 aparm->help?aparm->help:"arg",
177 aparm->type == CMD_LIST?"+":"",
178 aparm->type == CMD_SINGLE_OR_FLAG?"]":"") < 0)
184 extern char *AFSVersion;
187 VersionProc(struct cmd_syndesc *as, void *arock)
189 printf("%s\n", AFSVersion);
194 PrintSyntax(struct cmd_syndesc *as)
197 struct cmd_parmdesc *tp;
203 /* now print usage, from syntax table */
205 len = printf("Usage: %s", as->a0name);
207 if (!strcmp(as->name, initcmd_opcode))
208 len = printf("Usage: %s[%s]", NName(as->a0name, " "), as->name);
210 len = printf("Usage: %s%s", NName(as->a0name, " "), as->name);
213 for (i = 0; i < CMD_MAXPARMS; i++) {
216 continue; /* seeked over slot */
217 if (tp->flags & CMD_HIDE)
218 continue; /* skip hidden options */
220 /* The parameter name is the real name, plus any aliases */
222 name = strdup(tp->name);
224 fprintf(stderr, "Out of memory.\n");
229 struct cmd_item *alias;
230 namelen = strlen(tp->name) + 1;
231 for (alias = tp->aliases; alias != NULL; alias = alias->next)
232 namelen+=strlen(alias->data) + 3;
234 name = malloc(namelen);
236 fprintf(stderr, "Out of memory.\n");
239 strlcpy(name, tp->name, namelen);
241 for (alias = tp->aliases; alias != NULL; alias = alias->next) {
242 strlcat(name, " | ", namelen);
243 strlcat(name, alias->data, namelen);
247 /* Work out if we can fit what we want to on this line, or if we need to
249 str = ParmHelpString(tp);
251 fprintf(stderr, "Out of memory.\n");
255 xtralen = 1 + strlen(name) + strlen(str) +
256 ((tp->flags & CMD_OPTIONAL)? 2: 0);
258 if (len + xtralen > 78) {
264 tp->flags & CMD_OPTIONAL?"[":"",
267 tp->flags & CMD_OPTIONAL?"]":"");
275 /* must print newline in any case, to terminate preceding line */
277 PrintAliases(struct cmd_syndesc *as)
279 struct cmd_syndesc *ts;
281 if (as->flags & CMD_ALIAS) {
283 printf("(alias for %s)\n", ts->name);
287 return; /* none, print nothing */
289 for (as = as->nextAlias; as; as = as->nextAlias) {
290 printf("%s ", as->name);
297 PrintFlagHelp(struct cmd_syndesc *as)
300 struct cmd_parmdesc *tp;
304 /* find flag name length */
306 for (i = 0; i < CMD_MAXPARMS; i++) {
307 if (i == CMD_HELPPARM)
310 if (tp->type != CMD_FLAG)
312 if (tp->flags & CMD_HIDE)
313 continue; /* skip hidden options */
317 if (strlen(tp->name) > flag_width)
318 flag_width = strlen(tp->name);
321 /* print flag help */
322 flag_prefix = "Where:";
323 for (i = 0; i < CMD_MAXPARMS; i++) {
324 if (i == CMD_HELPPARM)
327 if (tp->type != CMD_FLAG)
329 if (tp->flags & CMD_HIDE)
330 continue; /* skip hidden options */
334 printf("%-7s%-*s %s\n", flag_prefix, flag_width, tp->name, tp->help);
340 AproposProc(struct cmd_syndesc *as, void *arock)
342 struct cmd_syndesc *ts;
347 tsub = as->parms[0].items->data;
348 for (ts = allSyntax; ts; ts = ts->next) {
349 if ((ts->flags & CMD_ALIAS) || (ts->flags & CMD_HIDDEN))
351 if (SubString(ts->help, tsub)) {
352 printf("%s: %s\n", ts->name, ts->help);
354 } else if (SubString(ts->name, tsub)) {
355 printf("%s: %s\n", ts->name, ts->help);
360 printf("Sorry, no commands found\n");
365 HelpProc(struct cmd_syndesc *as, void *arock)
367 struct cmd_syndesc *ts;
372 if (as->parms[0].items == 0) {
373 struct cmd_syndesc *initcmd = NULL;
377 * Print the usage of the initcmd command when it is the only
378 * non-hidden, explicit command, otherwise, list the all the commands.
380 for (ts = allSyntax; ts; ts = ts->next) {
381 if (ts->flags & (CMD_ALIAS | CMD_HIDDEN | CMD_IMPLICIT)) {
382 continue; /* skip aliases, hidden, and implied commands */
384 if (strcmp(ts->name, initcmd_opcode) == 0) {
385 initcmd = ts; /* save the initcmd */
390 if (initcmd && count == 0) {
391 initcmd->a0name = as->a0name;
392 PrintAliases(initcmd);
393 PrintSyntax(initcmd);
394 PrintFlagHelp(initcmd);
396 printf("%sCommands are:\n", NName(as->a0name, ": "));
397 for (ts = allSyntax; ts; ts = ts->next) {
398 if ((ts->flags & CMD_ALIAS) || (ts->flags & CMD_HIDDEN))
400 printf("%-15s %s\n", ts->name, (ts->help ? ts->help : ""));
404 /* print out individual help topics */
405 for (ti = as->parms[0].items; ti; ti = ti->next) {
407 ts = FindSyntax(ti->data, &ambig);
408 if (ts && (ts->flags & CMD_HIDDEN))
409 ts = 0; /* no hidden commands */
411 /* print out command name and help */
412 printf("%s%s: %s ", NName(as->a0name, " "), ts->name,
413 (ts->help ? ts->help : ""));
414 ts->a0name = as->a0name;
420 fprintf(stderr, "%sUnknown topic '%s'\n",
421 NName(as->a0name, ": "), ti->data);
423 /* ambiguous, list 'em all */
425 "%sAmbiguous topic '%s'; use 'apropos' to list\n",
426 NName(as->a0name, ": "), ti->data);
428 code = CMD_UNKNOWNCMD;
436 cmd_SetBeforeProc(int (*aproc) (struct cmd_syndesc * ts, void *beforeRock),
445 cmd_SetAfterProc(int (*aproc) (struct cmd_syndesc * ts, void *afterRock),
453 /* thread on list in alphabetical order */
455 SortSyntax(struct cmd_syndesc *as)
457 struct cmd_syndesc **ld, *ud;
459 for (ld = &allSyntax, ud = *ld; ud; ld = &ud->next, ud = *ld) {
460 if (strcmp(ud->name, as->name) > 0) { /* next guy is bigger than us */
464 /* thread us on the list now */
471 * Create a command syntax.
473 * \note Use cmd_AddParm() or cmd_AddParmAtOffset() to set the
474 * parameters for the new command.
476 * \param[in] aname name used to invoke the command
477 * \param[in] aproc procedure to be called when command is invoked
478 * \param[in] arock opaque data pointer to be passed to aproc
479 * \param[in] aflags command option flags
480 * \param[in] ahelp help string to display for this command
482 * \return a pointer to the cmd_syndesc or NULL if error.
485 cmd_CreateSyntax(char *aname,
486 int (*aproc) (struct cmd_syndesc * ts, void *arock),
487 void *arock, afs_uint32 aflags, char *ahelp)
489 struct cmd_syndesc *td;
491 /* can't have two cmds in no opcode mode */
495 /* Allow only valid cmd flags. */
496 if (aflags & ~(CMD_HIDDEN | CMD_IMPLICIT)) {
500 td = calloc(1, sizeof(struct cmd_syndesc));
502 td->aliasOf = td; /* treat aliasOf as pointer to real command, no matter what */
505 /* copy in name, etc */
507 td->name = strdup(aname);
514 td->help = strdup(ahelp);
523 cmd_Seek(td, CMD_HELPPARM);
524 cmd_AddParm(td, "-help", CMD_FLAG, CMD_OPTIONAL, "get detailed help");
531 cmd_CreateAlias(struct cmd_syndesc *as, char *aname)
533 struct cmd_syndesc *td;
535 td = malloc(sizeof(struct cmd_syndesc));
537 memcpy(td, as, sizeof(struct cmd_syndesc));
538 td->name = strdup(aname);
540 td->flags |= CMD_ALIAS;
541 /* if ever free things, make copy of help string, too */
546 /* thread on alias lists */
547 td->nextAlias = as->nextAlias;
551 return 0; /* all done */
555 cmd_DisablePositionalCommands(void)
557 enablePositional = 0;
561 cmd_DisableAbbreviations(void)
563 enableAbbreviation = 0;
567 cmd_Seek(struct cmd_syndesc *as, int apos)
569 if (apos >= CMD_MAXPARMS)
570 return CMD_EXCESSPARMS;
576 cmd_AddParmAtOffset(struct cmd_syndesc *as, int ref, char *aname, int atype,
577 afs_int32 aflags, char *ahelp)
579 struct cmd_parmdesc *tp;
581 if (ref >= CMD_MAXPARMS)
582 return CMD_EXCESSPARMS;
583 tp = &as->parms[ref];
585 tp->name = strdup(aname);
591 tp->help = strdup(ahelp);
598 if (as->nParms <= ref)
605 cmd_AddParm(struct cmd_syndesc *as, char *aname, int atype,
606 afs_int32 aflags, char *ahelp)
608 if (as->nParms >= CMD_MAXPARMS)
609 return CMD_EXCESSPARMS;
611 return cmd_AddParmAtOffset(as, as->nParms++, aname, atype, aflags, ahelp);
615 cmd_AddParmAlias(struct cmd_syndesc *as, int pos, char *alias)
617 struct cmd_item *item;
619 if (pos > as->nParms)
620 return CMD_EXCESSPARMS;
622 item = calloc(1, sizeof(struct cmd_item));
623 item->data = strdup(alias);
624 item->next = as->parms[pos].aliases;
625 as->parms[pos].aliases = item;
630 /* add a text item to the end of the parameter list */
632 AddItem(struct cmd_parmdesc *aparm, char *aval, char *pname)
634 struct cmd_item *ti, *ni;
636 if (aparm->type == CMD_SINGLE ||
637 aparm->type == CMD_SINGLE_OR_FLAG) {
639 fprintf(stderr, "%sToo many values after switch %s\n",
640 NName(pname, ": "), aparm->name);
645 ti = calloc(1, sizeof(struct cmd_item));
647 ti->data = strdup(aval);
649 /* now put ti at the *end* of the list */
650 if ((ni = aparm->items)) {
651 for (; ni; ni = ni->next)
653 break; /* skip to last one */
656 aparm->items = ti; /* we're first */
660 /* skip to next non-flag item, if any */
662 AdvanceType(struct cmd_syndesc *as, afs_int32 aval)
665 struct cmd_parmdesc *tp;
667 /* first see if we should try to grab rest of line for this dude */
668 if (as->parms[aval].flags & CMD_EXPANDS)
671 /* if not, find next non-flag used slot */
672 for (next = aval + 1; next < CMD_MAXPARMS; next++) {
673 tp = &as->parms[next];
674 if (tp->type != 0 && tp->type != CMD_FLAG)
680 /* discard parameters filled in by dispatch */
682 ResetSyntax(struct cmd_syndesc *as)
685 struct cmd_parmdesc *tp;
686 struct cmd_item *ti, *ni;
689 for (i = 0; i < CMD_MAXPARMS; i++, tp++) {
691 case CMD_SINGLE_OR_FLAG:
692 if (tp->items == &dummy)
697 /* free whole list in both cases, just for fun */
698 for (ti = tp->items; ti; ti = ni) {
712 /* move the expands flag to the last one in the list */
714 SetupExpandsFlag(struct cmd_syndesc *as)
716 struct cmd_parmdesc *tp;
720 /* find last CMD_LIST type parameter, optional or not, and make it expandable
721 * if no other dude is expandable */
722 for (i = 0; i < CMD_MAXPARMS; i++) {
724 if (tp->type == CMD_LIST) {
725 if (tp->flags & CMD_EXPANDS)
726 return 0; /* done if already specified */
731 as->parms[last].flags |= CMD_EXPANDS;
735 /* Take the current argv & argc and alter them so that the initialization
736 * opcode is made to appear. This is used in cases where the initialization
737 * opcode is implicitly invoked.*/
739 InsertInitOpcode(int *aargc, char **aargv)
741 char **newargv; /*Ptr to new, expanded argv space */
742 char *pinitopcode; /*Ptr to space for name of init opcode */
743 int i; /*Loop counter */
745 /* Allocate the new argv array, plus one for the new opcode, plus one
746 * more for the trailing null pointer */
747 newargv = malloc(((*aargc) + 2) * sizeof(char *));
749 fprintf(stderr, "%s: Can't create new argv array with %d+2 slots\n",
754 /* Create space for the initial opcode & fill it in */
755 pinitopcode = strdup(initcmd_opcode);
757 fprintf(stderr, "%s: Can't malloc initial opcode space\n", aargv[0]);
762 /* Move all the items in the old argv into the new argv, in their
764 for (i = *aargc; i > 1; i--)
765 newargv[i] = aargv[i - 1];
767 /* Slip in the opcode and the trailing null pointer, and bump the
768 * argument count up by one for the new opcode */
769 newargv[0] = aargv[0];
770 newargv[1] = pinitopcode;
772 newargv[*aargc] = NULL;
774 /* Return the happy news */
777 } /*InsertInitOpcode */
780 NoParmsOK(struct cmd_syndesc *as)
783 struct cmd_parmdesc *td;
785 for (i = 0; i < CMD_MAXPARMS; i++) {
787 if (td->type != 0 && !(td->flags & CMD_OPTIONAL)) {
788 /* found a non-optional (e.g. required) parm, so NoParmsOK
789 * is false (some parms are required) */
796 /* Add help, apropos commands once */
800 struct cmd_syndesc *ts;
803 ts = cmd_CreateSyntax("help", HelpProc, NULL, CMD_IMPLICIT,
804 "get help on commands");
805 cmd_AddParm(ts, "-topic", CMD_LIST, CMD_OPTIONAL, "help string");
807 ts = cmd_CreateSyntax("apropos", AproposProc, NULL, CMD_IMPLICIT,
808 "search by help text");
809 cmd_AddParm(ts, "-topic", CMD_SINGLE, CMD_REQUIRED, "help string");
811 cmd_CreateSyntax("version", VersionProc, NULL, CMD_IMPLICIT,
813 cmd_CreateSyntax("-version", VersionProc, NULL, (CMD_HIDDEN | CMD_IMPLICIT), NULL);
814 cmd_CreateSyntax("-help", HelpProc, NULL, (CMD_HIDDEN | CMD_IMPLICIT), NULL);
815 cmd_CreateSyntax("--version", VersionProc, NULL, (CMD_HIDDEN | CMD_IMPLICIT), NULL);
816 cmd_CreateSyntax("--help", HelpProc, NULL, (CMD_HIDDEN | CMD_IMPLICIT), NULL);
820 /* Call the appropriate function, or return syntax error code. Note: if
821 * no opcode is specified, an initialization routine exists, and it has
822 * NOT been called before, we invoke the special initialization opcode
825 cmd_Parse(int argc, char **argv, struct cmd_syndesc **outsyntax)
828 struct cmd_syndesc *ts = NULL;
829 struct cmd_parmdesc *tparm;
836 char *embeddedvalue = NULL;
837 static int initd = 0; /*Is this the first time this routine has been called? */
838 static int initcmdpossible = 1; /*Should be consider parsing the initial command? */
847 /*Remember the program name */
852 if (!NoParmsOK(allSyntax)) {
853 printf("%s: Type '%s -help' for help\n", pname, pname);
860 /* if there is an initcmd, don't print an error message, just
861 * setup to use the initcmd below. */
862 if (!(initcmdpossible && FindSyntax(initcmd_opcode, NULL))) {
863 printf("%s: Type '%s help' or '%s help <topic>' for help\n",
864 pname, pname, pname);
871 /* Find the syntax descriptor for this command, doing prefix matching properly */
875 ts = (argc < 2 ? 0 : FindSyntax(argv[1], &ambig));
877 /*First token doesn't match a syntax descriptor */
878 if (initcmdpossible) {
879 /*If initial command line handling hasn't been done yet,
880 * see if there is a descriptor for the initialization opcode.
881 * Only try this once. */
883 ts = FindSyntax(initcmd_opcode, NULL);
885 /*There is no initialization opcode available, so we declare
888 fprintf(stderr, "%s", NName(pname, ": "));
890 "Ambiguous operation '%s'; type '%shelp' for list\n",
891 argv[1], NName(pname, " "));
893 fprintf(stderr, "%s", NName(pname, ": "));
895 "Unrecognized operation '%s'; type '%shelp' for list\n",
896 argv[1], NName(pname, " "));
898 code = CMD_UNKNOWNCMD;
901 /*Found syntax structure for an initialization opcode. Fix
902 * up argv and argc to relect what the user
903 * ``should have'' typed */
904 if (!(argv = InsertInitOpcode(&argc, argv))) {
906 "%sCan't insert implicit init opcode into command line\n",
908 code = CMD_INTERNALERROR;
912 } /*Initial opcode not yet attempted */
914 /* init cmd already run and no syntax entry found */
916 fprintf(stderr, "%s", NName(pname, ": "));
918 "Ambiguous operation '%s'; type '%shelp' for list\n",
919 argv[1], NName(pname, " "));
921 fprintf(stderr, "%s", NName(pname, ": "));
923 "Unrecognized operation '%s'; type '%shelp' for list\n",
924 argv[1], NName(pname, " "));
926 code = CMD_UNKNOWNCMD;
929 } /*Argv[1] is not a valid opcode */
930 } /*Opcodes are defined */
932 /* Found the descriptor; start parsing. curType is the type we're
936 /* We start off parsing in "positional" mode, where tokens are put in
937 * slots positionally. If we find a name that takes args, we go
938 * out of positional mode, and from that point on, expect a switch
939 * before any particular token. */
941 positional = enablePositional; /* Accepting positional cmds ? */
942 i = noOpcodes ? 1 : 2;
943 SetupExpandsFlag(ts);
944 for (; i < argc; i++) {
948 embeddedvalue = NULL;
951 /* Only tokens that start with a hyphen and are not followed by a digit
952 * are considered switches. This allow negative numbers. */
954 if ((argv[i][0] == '-') && !isdigit(argv[i][1])) {
958 if (strrchr(argv[i], '=') != NULL) {
959 param = strdup(argv[i]);
960 embeddedvalue = strrchr(param, '=');
961 *embeddedvalue = '\0';
963 j = FindType(ts, param);
965 j = FindType(ts, argv[i]);
970 "%sUnrecognized or ambiguous switch '%s'; type ",
971 NName(pname, ": "), argv[i]);
973 fprintf(stderr, "'%s -help' for detailed help\n",
976 fprintf(stderr, "'%shelp %s' for detailed help\n",
977 NName(argv[0], " "), ts->name);
978 code = CMD_UNKNOWNSWITCH;
981 if (j >= CMD_MAXPARMS) {
982 fprintf(stderr, "%sInternal parsing error\n",
984 code = CMD_INTERNALERROR;
987 if (ts->parms[j].type == CMD_FLAG) {
988 ts->parms[j].items = &dummy;
991 fprintf(stderr, "%sSwitch '%s' doesn't take an argument\n",
992 NName(pname, ": "), ts->parms[j].name);
999 ts->parms[j].flags |= CMD_PROCESSED;
1001 if (embeddedvalue) {
1002 AddItem(&ts->parms[curType], embeddedvalue, pname);
1006 /* Try to fit in this descr */
1007 if (curType >= CMD_MAXPARMS) {
1008 fprintf(stderr, "%sToo many arguments\n", NName(pname, ": "));
1012 tparm = &ts->parms[curType];
1014 if ((tparm->type == 0) || /* No option in this slot */
1015 (tparm->type == CMD_FLAG)) { /* A flag (not an argument */
1016 /* skipped parm slot */
1017 curType++; /* Skip this slot and reprocess this parm */
1022 if (!(tparm->flags & CMD_PROCESSED) && (tparm->flags & CMD_HIDE)) {
1023 curType++; /* Skip this slot and reprocess this parm */
1028 if (tparm->type == CMD_SINGLE ||
1029 tparm->type == CMD_SINGLE_OR_FLAG) {
1031 fprintf(stderr, "%sToo many values after switch %s\n",
1032 NName(pname, ": "), tparm->name);
1036 AddItem(tparm, argv[i], pname); /* Add to end of list */
1037 } else if (tparm->type == CMD_LIST) {
1038 AddItem(tparm, argv[i], pname); /* Add to end of list */
1041 /* Now, if we're in positional mode, advance to the next item */
1043 curType = AdvanceType(ts, curType);
1047 /* keep track of this for messages */
1048 ts->a0name = argv[0];
1050 /* If we make it here, all the parameters are filled in. Check to see if
1051 * this is a -help version. Must do this before checking for all
1052 * required parms, otherwise it is a real nuisance */
1053 if (ts->parms[CMD_HELPPARM].items) {
1055 /* Display full help syntax if we don't have subcommands */
1062 /* Parsing done, see if we have all of our required parameters */
1063 for (i = 0; i < CMD_MAXPARMS; i++) {
1064 tparm = &ts->parms[i];
1065 if (tparm->type == 0)
1066 continue; /* Skipped parm slot */
1067 if ((tparm->flags & CMD_PROCESSED) && tparm->items == 0) {
1068 if (tparm->type == CMD_SINGLE_OR_FLAG) {
1069 tparm->items = &dummy;
1071 fprintf(stderr, "%s The field '%s' isn't completed properly\n",
1072 NName(pname, ": "), tparm->name);
1077 if (!(tparm->flags & CMD_OPTIONAL) && tparm->items == 0) {
1078 fprintf(stderr, "%sMissing required parameter '%s'\n",
1079 NName(pname, ": "), tparm->name);
1083 tparm->flags &= ~CMD_PROCESSED;
1088 if (code && ts != NULL)
1095 cmd_Dispatch(int argc, char **argv)
1097 struct cmd_syndesc *ts = NULL;
1100 code = cmd_Parse(argc, argv, &ts);
1102 if (code == CMD_HELP) {
1103 code = 0; /* displaying help is not an error */
1109 * Before calling the beforeProc and afterProc and all the implications
1110 * from those calls, check if the help procedure was called and call it
1113 if ((ts->proc == HelpProc) || (ts->proc == AproposProc)) {
1114 code = (*ts->proc) (ts, ts->rock);
1118 /* Now, we just call the procedure and return */
1120 code = (*beforeProc) (ts, beforeRock);
1125 code = (*ts->proc) (ts, ts->rock);
1128 (*afterProc) (ts, afterRock);
1130 cmd_FreeOptions(&ts);
1135 cmd_FreeOptions(struct cmd_syndesc **ts)
1143 /* free token list returned by parseLine */
1145 FreeTokens(struct cmd_token *alist)
1147 struct cmd_token *nlist;
1148 for (; alist; alist = nlist) {
1149 nlist = alist->next;
1156 /* free an argv list returned by parseline */
1158 cmd_FreeArgv(char **argv)
1161 for (tp = *argv; tp; argv++, tp = *argv)
1166 /* copy back the arg list to the argv array, freeing the cmd_tokens as you go;
1167 * the actual data is still malloc'd, and will be freed when the caller calls
1168 * cmd_FreeArgv later on
1172 CopyBackArgs(struct cmd_token *alist, char **argv,
1173 afs_int32 * an, afs_int32 amaxn)
1175 struct cmd_token *next;
1181 *argv = strdup(INITSTR);
1188 return CMD_TOOMANY; /* argv is too small for his many parms. */
1197 *argv = NULL; /* use last slot for terminating null */
1198 /* don't count terminating null */
1206 if (x == '"' || x == 39 /* single quote */ )
1215 if (x == 0 || x == ' ' || x == '\t' || x == '\n')
1222 cmd_ParseLine(char *aline, char **argv, afs_int32 * an, afs_int32 amaxn)
1226 int inToken, inQuote;
1227 struct cmd_token *first, *last;
1228 struct cmd_token *ttok;
1231 inToken = 0; /* not copying token chars at start */
1234 inQuote = 0; /* not in a quoted string */
1237 if (tc == 0 || (!inQuote && space(tc))) { /* terminating null gets us in here, too */
1239 inToken = 0; /* end of this token */
1241 return -1; /* should never get here */
1244 ttok = malloc(sizeof(struct cmd_token));
1247 ttok->key = strdup(tbuffer);
1258 /* an alpha character */
1263 if (tptr - tbuffer >= sizeof(tbuffer)) {
1265 return CMD_TOOBIG; /* token too long */
1268 /* hit a quote, toggle inQuote flag but don't insert character */
1271 /* insert character */
1276 /* last token flushed 'cause space(0) --> true */
1279 return CopyBackArgs(first, argv, an, amaxn);
1284 /* Read a string in from our configuration file. This checks in
1285 * multiple places within this file - firstly in the section
1286 * [command_subcommand], then in [command], then in [subcommand]
1288 * Returns CMD_MISSING if there is no configuration file configured,
1289 * or if the file doesn't contain information for the specified option
1290 * in any of these sections.
1294 _get_file_string(struct cmd_syndesc *syn, int pos, const char **str)
1299 /* Nothing on the command line, try the config file if we have one */
1300 if (globalConfig == NULL)
1303 /* March past any leading -'s */
1304 for (optionName = syn->parms[pos].name;
1305 *optionName == '-'; optionName++);
1307 /* First, try the command_subcommand form */
1308 if (syn->name != NULL && commandName != NULL) {
1309 if (asprintf(§ion, "%s_%s", commandName, syn->name) < 0)
1311 *str = cmd_RawConfigGetString(globalConfig, NULL, section,
1318 /* Then, try the command form */
1319 if (commandName != NULL) {
1320 *str = cmd_RawConfigGetString(globalConfig, NULL, commandName,
1326 /* Then, the defaults section */
1327 *str = cmd_RawConfigGetString(globalConfig, NULL, "defaults",
1332 /* Nothing there, return MISSING */
1337 _get_config_string(struct cmd_syndesc *syn, int pos, const char **str)
1341 if (pos > syn->nParms)
1342 return CMD_EXCESSPARMS;
1344 /* It's a flag, they probably shouldn't be using this interface to access
1345 * it, but don't blow up for now */
1346 if (syn->parms[pos].items == &dummy)
1349 /* We have a value on the command line - this overrides anything in the
1350 * configuration file */
1351 if (syn->parms[pos].items != NULL &&
1352 syn->parms[pos].items->data != NULL) {
1353 *str = syn->parms[pos].items->data;
1357 return _get_file_string(syn, pos, str);
1361 cmd_OptionAsInt(struct cmd_syndesc *syn, int pos, int *value)
1366 code =_get_config_string(syn, pos, &str);
1373 *value = strtol(str, NULL, 10);
1379 cmd_OptionAsUint(struct cmd_syndesc *syn, int pos,
1380 unsigned int *value)
1385 code = _get_config_string(syn, pos, &str);
1392 *value = strtoul(str, NULL, 10);
1398 cmd_OptionAsString(struct cmd_syndesc *syn, int pos, char **value)
1403 code = _get_config_string(syn, pos, &str);
1412 *value = strdup(str);
1418 cmd_OptionAsList(struct cmd_syndesc *syn, int pos, struct cmd_item **value)
1421 struct cmd_item *item, **last;
1422 const char *start, *end;
1426 if (pos > syn->nParms)
1427 return CMD_EXCESSPARMS;
1429 /* If we have a list already, just return the existing list */
1430 if (syn->parms[pos].items != NULL) {
1431 *value = syn->parms[pos].items;
1435 code = _get_file_string(syn, pos, &str);
1439 /* Use strchr to split str into elements, and build a recursive list
1440 * from them. Hang this list off the configuration structure, so that
1441 * it is returned by any future calls to this function, and is freed
1442 * along with everything else when the syntax description is freed
1444 last = &syn->parms[pos].items;
1446 while ((end = strchr(start, ' '))) {
1447 item = calloc(1, sizeof(struct cmd_item));
1448 len = end - start + 1;
1449 item->data = malloc(len);
1450 strlcpy(item->data, start, len);
1453 for (start = end; *start == ' '; start++); /* skip any whitespace */
1456 /* Catch the final element */
1457 if (*start != '\0') {
1458 item = calloc(1, sizeof(struct cmd_item));
1459 len = strlen(start) + 1;
1460 item->data = malloc(len);
1461 strlcpy(item->data, start, len);
1465 *value = syn->parms[pos].items;
1471 cmd_OptionAsFlag(struct cmd_syndesc *syn, int pos, int *value)
1473 const char *str = NULL;
1476 code = _get_config_string(syn, pos, &str);
1481 strcasecmp(str, "yes") == 0 ||
1482 strcasecmp(str, "true") == 0 ||
1492 cmd_OptionPresent(struct cmd_syndesc *syn, int pos)
1497 code = _get_config_string(syn, pos, &str);
1505 cmd_OpenConfigFile(const char *file)
1508 cmd_RawConfigFileFree(globalConfig);
1509 globalConfig = NULL;
1512 return cmd_RawConfigParseFile(file, &globalConfig);
1516 cmd_SetCommandName(const char *command)
1518 commandName = command;
1521 const cmd_config_section *
1524 return globalConfig;
1527 const cmd_config_section *
1528 cmd_RawSection(void)
1530 if (globalConfig == NULL || commandName == NULL)
1533 return cmd_RawConfigGetList(globalConfig, commandName, NULL);