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)
179 return "<< OUT OF MEMORY >>";
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);
225 struct cmd_item *alias;
226 namelen = strlen(tp->name) + 1;
227 for (alias = tp->aliases; alias != NULL; alias = alias->next)
228 namelen+=strlen(alias->data) + 3;
230 name = malloc(namelen);
231 strlcpy(name, tp->name, namelen);
233 for (alias = tp->aliases; alias != NULL; alias = alias->next) {
234 strlcat(name, " | ", namelen);
235 strlcat(name, alias->data, namelen);
239 /* Work out if we can fit what we want to on this line, or if we need to
241 str = ParmHelpString(tp);
242 xtralen = 1 + strlen(name) + strlen(str) +
243 ((tp->flags & CMD_OPTIONAL)? 2: 0);
245 if (len + xtralen > 78) {
251 tp->flags & CMD_OPTIONAL?"[":"",
254 tp->flags & CMD_OPTIONAL?"]":"");
262 /* must print newline in any case, to terminate preceding line */
264 PrintAliases(struct cmd_syndesc *as)
266 struct cmd_syndesc *ts;
268 if (as->flags & CMD_ALIAS) {
270 printf("(alias for %s)\n", ts->name);
274 return; /* none, print nothing */
276 for (as = as->nextAlias; as; as = as->nextAlias) {
277 printf("%s ", as->name);
284 PrintFlagHelp(struct cmd_syndesc *as)
287 struct cmd_parmdesc *tp;
291 /* find flag name length */
293 for (i = 0; i < CMD_MAXPARMS; i++) {
294 if (i == CMD_HELPPARM)
297 if (tp->type != CMD_FLAG)
299 if (tp->flags & CMD_HIDE)
300 continue; /* skip hidden options */
304 if (strlen(tp->name) > flag_width)
305 flag_width = strlen(tp->name);
308 /* print flag help */
309 flag_prefix = "Where:";
310 for (i = 0; i < CMD_MAXPARMS; i++) {
311 if (i == CMD_HELPPARM)
314 if (tp->type != CMD_FLAG)
316 if (tp->flags & CMD_HIDE)
317 continue; /* skip hidden options */
321 printf("%-7s%-*s %s\n", flag_prefix, flag_width, tp->name, tp->help);
327 AproposProc(struct cmd_syndesc *as, void *arock)
329 struct cmd_syndesc *ts;
334 tsub = as->parms[0].items->data;
335 for (ts = allSyntax; ts; ts = ts->next) {
336 if ((ts->flags & CMD_ALIAS) || (ts->flags & CMD_HIDDEN))
338 if (SubString(ts->help, tsub)) {
339 printf("%s: %s\n", ts->name, ts->help);
341 } else if (SubString(ts->name, tsub)) {
342 printf("%s: %s\n", ts->name, ts->help);
347 printf("Sorry, no commands found\n");
352 HelpProc(struct cmd_syndesc *as, void *arock)
354 struct cmd_syndesc *ts;
359 if (as->parms[0].items == 0) {
360 struct cmd_syndesc *initcmd = NULL;
364 * Print the usage of the initcmd command when it is the only
365 * non-hidden, explicit command, otherwise, list the all the commands.
367 for (ts = allSyntax; ts; ts = ts->next) {
368 if (ts->flags & (CMD_ALIAS | CMD_HIDDEN | CMD_IMPLICIT)) {
369 continue; /* skip aliases, hidden, and implied commands */
371 if (strcmp(ts->name, initcmd_opcode) == 0) {
372 initcmd = ts; /* save the initcmd */
377 if (initcmd && count == 0) {
378 initcmd->a0name = as->a0name;
379 PrintAliases(initcmd);
380 PrintSyntax(initcmd);
381 PrintFlagHelp(initcmd);
383 printf("%sCommands are:\n", NName(as->a0name, ": "));
384 for (ts = allSyntax; ts; ts = ts->next) {
385 if ((ts->flags & CMD_ALIAS) || (ts->flags & CMD_HIDDEN))
387 printf("%-15s %s\n", ts->name, (ts->help ? ts->help : ""));
391 /* print out individual help topics */
392 for (ti = as->parms[0].items; ti; ti = ti->next) {
394 ts = FindSyntax(ti->data, &ambig);
395 if (ts && (ts->flags & CMD_HIDDEN))
396 ts = 0; /* no hidden commands */
398 /* print out command name and help */
399 printf("%s%s: %s ", NName(as->a0name, " "), ts->name,
400 (ts->help ? ts->help : ""));
401 ts->a0name = as->a0name;
407 fprintf(stderr, "%sUnknown topic '%s'\n",
408 NName(as->a0name, ": "), ti->data);
410 /* ambiguous, list 'em all */
412 "%sAmbiguous topic '%s'; use 'apropos' to list\n",
413 NName(as->a0name, ": "), ti->data);
415 code = CMD_UNKNOWNCMD;
423 cmd_SetBeforeProc(int (*aproc) (struct cmd_syndesc * ts, void *beforeRock),
432 cmd_SetAfterProc(int (*aproc) (struct cmd_syndesc * ts, void *afterRock),
440 /* thread on list in alphabetical order */
442 SortSyntax(struct cmd_syndesc *as)
444 struct cmd_syndesc **ld, *ud;
446 for (ld = &allSyntax, ud = *ld; ud; ld = &ud->next, ud = *ld) {
447 if (strcmp(ud->name, as->name) > 0) { /* next guy is bigger than us */
451 /* thread us on the list now */
458 * Create a command syntax.
460 * \note Use cmd_AddParm() or cmd_AddParmAtOffset() to set the
461 * parameters for the new command.
463 * \param[in] aname name used to invoke the command
464 * \param[in] aproc procedure to be called when command is invoked
465 * \param[in] arock opaque data pointer to be passed to aproc
466 * \param[in] aflags command option flags
467 * \param[in] ahelp help string to display for this command
469 * \return a pointer to the cmd_syndesc or NULL if error.
472 cmd_CreateSyntax(char *aname,
473 int (*aproc) (struct cmd_syndesc * ts, void *arock),
474 void *arock, afs_uint32 aflags, char *ahelp)
476 struct cmd_syndesc *td;
478 /* can't have two cmds in no opcode mode */
482 /* Allow only valid cmd flags. */
483 if (aflags & ~(CMD_HIDDEN | CMD_IMPLICIT)) {
487 td = calloc(1, sizeof(struct cmd_syndesc));
489 td->aliasOf = td; /* treat aliasOf as pointer to real command, no matter what */
492 /* copy in name, etc */
494 td->name = strdup(aname);
501 td->help = strdup(ahelp);
510 cmd_Seek(td, CMD_HELPPARM);
511 cmd_AddParm(td, "-help", CMD_FLAG, CMD_OPTIONAL, "get detailed help");
518 cmd_CreateAlias(struct cmd_syndesc *as, char *aname)
520 struct cmd_syndesc *td;
522 td = malloc(sizeof(struct cmd_syndesc));
524 memcpy(td, as, sizeof(struct cmd_syndesc));
525 td->name = strdup(aname);
527 td->flags |= CMD_ALIAS;
528 /* if ever free things, make copy of help string, too */
533 /* thread on alias lists */
534 td->nextAlias = as->nextAlias;
538 return 0; /* all done */
542 cmd_DisablePositionalCommands(void)
544 enablePositional = 0;
548 cmd_DisableAbbreviations(void)
550 enableAbbreviation = 0;
554 cmd_Seek(struct cmd_syndesc *as, int apos)
556 if (apos >= CMD_MAXPARMS)
557 return CMD_EXCESSPARMS;
563 cmd_AddParmAtOffset(struct cmd_syndesc *as, int ref, char *aname, int atype,
564 afs_int32 aflags, char *ahelp)
566 struct cmd_parmdesc *tp;
568 if (ref >= CMD_MAXPARMS)
569 return CMD_EXCESSPARMS;
570 tp = &as->parms[ref];
572 tp->name = strdup(aname);
578 tp->help = strdup(ahelp);
585 if (as->nParms <= ref)
592 cmd_AddParm(struct cmd_syndesc *as, char *aname, int atype,
593 afs_int32 aflags, char *ahelp)
595 if (as->nParms >= CMD_MAXPARMS)
596 return CMD_EXCESSPARMS;
598 return cmd_AddParmAtOffset(as, as->nParms++, aname, atype, aflags, ahelp);
602 cmd_AddParmAlias(struct cmd_syndesc *as, int pos, char *alias)
604 struct cmd_item *item;
606 if (pos > as->nParms)
607 return CMD_EXCESSPARMS;
609 item = calloc(1, sizeof(struct cmd_item));
610 item->data = strdup(alias);
611 item->next = as->parms[pos].aliases;
612 as->parms[pos].aliases = item;
617 /* add a text item to the end of the parameter list */
619 AddItem(struct cmd_parmdesc *aparm, char *aval, char *pname)
621 struct cmd_item *ti, *ni;
623 if (aparm->type == CMD_SINGLE ||
624 aparm->type == CMD_SINGLE_OR_FLAG) {
626 fprintf(stderr, "%sToo many values after switch %s\n",
627 NName(pname, ": "), aparm->name);
632 ti = calloc(1, sizeof(struct cmd_item));
634 ti->data = strdup(aval);
636 /* now put ti at the *end* of the list */
637 if ((ni = aparm->items)) {
638 for (; ni; ni = ni->next)
640 break; /* skip to last one */
643 aparm->items = ti; /* we're first */
647 /* skip to next non-flag item, if any */
649 AdvanceType(struct cmd_syndesc *as, afs_int32 aval)
652 struct cmd_parmdesc *tp;
654 /* first see if we should try to grab rest of line for this dude */
655 if (as->parms[aval].flags & CMD_EXPANDS)
658 /* if not, find next non-flag used slot */
659 for (next = aval + 1; next < CMD_MAXPARMS; next++) {
660 tp = &as->parms[next];
661 if (tp->type != 0 && tp->type != CMD_FLAG)
667 /* discard parameters filled in by dispatch */
669 ResetSyntax(struct cmd_syndesc *as)
672 struct cmd_parmdesc *tp;
673 struct cmd_item *ti, *ni;
676 for (i = 0; i < CMD_MAXPARMS; i++, tp++) {
678 case CMD_SINGLE_OR_FLAG:
679 if (tp->items == &dummy)
681 /* Deliberately fall through here */
684 /* free whole list in both cases, just for fun */
685 for (ti = tp->items; ti; ti = ni) {
699 /* move the expands flag to the last one in the list */
701 SetupExpandsFlag(struct cmd_syndesc *as)
703 struct cmd_parmdesc *tp;
707 /* find last CMD_LIST type parameter, optional or not, and make it expandable
708 * if no other dude is expandable */
709 for (i = 0; i < CMD_MAXPARMS; i++) {
711 if (tp->type == CMD_LIST) {
712 if (tp->flags & CMD_EXPANDS)
713 return 0; /* done if already specified */
718 as->parms[last].flags |= CMD_EXPANDS;
722 /* Take the current argv & argc and alter them so that the initialization
723 * opcode is made to appear. This is used in cases where the initialization
724 * opcode is implicitly invoked.*/
726 InsertInitOpcode(int *aargc, char **aargv)
728 char **newargv; /*Ptr to new, expanded argv space */
729 char *pinitopcode; /*Ptr to space for name of init opcode */
730 int i; /*Loop counter */
732 /* Allocate the new argv array, plus one for the new opcode, plus one
733 * more for the trailing null pointer */
734 newargv = malloc(((*aargc) + 2) * sizeof(char *));
736 fprintf(stderr, "%s: Can't create new argv array with %d+2 slots\n",
741 /* Create space for the initial opcode & fill it in */
742 pinitopcode = strdup(initcmd_opcode);
744 fprintf(stderr, "%s: Can't malloc initial opcode space\n", aargv[0]);
749 /* Move all the items in the old argv into the new argv, in their
751 for (i = *aargc; i > 1; i--)
752 newargv[i] = aargv[i - 1];
754 /* Slip in the opcode and the trailing null pointer, and bump the
755 * argument count up by one for the new opcode */
756 newargv[0] = aargv[0];
757 newargv[1] = pinitopcode;
759 newargv[*aargc] = NULL;
761 /* Return the happy news */
764 } /*InsertInitOpcode */
767 NoParmsOK(struct cmd_syndesc *as)
770 struct cmd_parmdesc *td;
772 for (i = 0; i < CMD_MAXPARMS; i++) {
774 if (td->type != 0 && !(td->flags & CMD_OPTIONAL)) {
775 /* found a non-optional (e.g. required) parm, so NoParmsOK
776 * is false (some parms are required) */
783 /* Add help, apropos commands once */
787 struct cmd_syndesc *ts;
790 ts = cmd_CreateSyntax("help", HelpProc, NULL, CMD_IMPLICIT,
791 "get help on commands");
792 cmd_AddParm(ts, "-topic", CMD_LIST, CMD_OPTIONAL, "help string");
794 ts = cmd_CreateSyntax("apropos", AproposProc, NULL, CMD_IMPLICIT,
795 "search by help text");
796 cmd_AddParm(ts, "-topic", CMD_SINGLE, CMD_REQUIRED, "help string");
798 cmd_CreateSyntax("version", VersionProc, NULL, CMD_IMPLICIT,
800 cmd_CreateSyntax("-version", VersionProc, NULL, (CMD_HIDDEN | CMD_IMPLICIT), NULL);
801 cmd_CreateSyntax("-help", HelpProc, NULL, (CMD_HIDDEN | CMD_IMPLICIT), NULL);
802 cmd_CreateSyntax("--version", VersionProc, NULL, (CMD_HIDDEN | CMD_IMPLICIT), NULL);
803 cmd_CreateSyntax("--help", HelpProc, NULL, (CMD_HIDDEN | CMD_IMPLICIT), NULL);
807 /* Call the appropriate function, or return syntax error code. Note: if
808 * no opcode is specified, an initialization routine exists, and it has
809 * NOT been called before, we invoke the special initialization opcode
812 cmd_Parse(int argc, char **argv, struct cmd_syndesc **outsyntax)
815 struct cmd_syndesc *ts = NULL;
816 struct cmd_parmdesc *tparm;
823 char *embeddedvalue = NULL;
824 static int initd = 0; /*Is this the first time this routine has been called? */
825 static int initcmdpossible = 1; /*Should be consider parsing the initial command? */
834 /*Remember the program name */
839 if (!NoParmsOK(allSyntax)) {
840 printf("%s: Type '%s -help' for help\n", pname, pname);
847 /* if there is an initcmd, don't print an error message, just
848 * setup to use the initcmd below. */
849 if (!(initcmdpossible && FindSyntax(initcmd_opcode, NULL))) {
850 printf("%s: Type '%s help' or '%s help <topic>' for help\n",
851 pname, pname, pname);
858 /* Find the syntax descriptor for this command, doing prefix matching properly */
862 ts = (argc < 2 ? 0 : FindSyntax(argv[1], &ambig));
864 /*First token doesn't match a syntax descriptor */
865 if (initcmdpossible) {
866 /*If initial command line handling hasn't been done yet,
867 * see if there is a descriptor for the initialization opcode.
868 * Only try this once. */
870 ts = FindSyntax(initcmd_opcode, NULL);
872 /*There is no initialization opcode available, so we declare
875 fprintf(stderr, "%s", NName(pname, ": "));
877 "Ambiguous operation '%s'; type '%shelp' for list\n",
878 argv[1], NName(pname, " "));
880 fprintf(stderr, "%s", NName(pname, ": "));
882 "Unrecognized operation '%s'; type '%shelp' for list\n",
883 argv[1], NName(pname, " "));
885 code = CMD_UNKNOWNCMD;
888 /*Found syntax structure for an initialization opcode. Fix
889 * up argv and argc to relect what the user
890 * ``should have'' typed */
891 if (!(argv = InsertInitOpcode(&argc, argv))) {
893 "%sCan't insert implicit init opcode into command line\n",
895 code = CMD_INTERNALERROR;
899 } /*Initial opcode not yet attempted */
901 /* init cmd already run and no syntax entry found */
903 fprintf(stderr, "%s", NName(pname, ": "));
905 "Ambiguous operation '%s'; type '%shelp' for list\n",
906 argv[1], NName(pname, " "));
908 fprintf(stderr, "%s", NName(pname, ": "));
910 "Unrecognized operation '%s'; type '%shelp' for list\n",
911 argv[1], NName(pname, " "));
913 code = CMD_UNKNOWNCMD;
916 } /*Argv[1] is not a valid opcode */
917 } /*Opcodes are defined */
919 /* Found the descriptor; start parsing. curType is the type we're
923 /* We start off parsing in "positional" mode, where tokens are put in
924 * slots positionally. If we find a name that takes args, we go
925 * out of positional mode, and from that point on, expect a switch
926 * before any particular token. */
928 positional = enablePositional; /* Accepting positional cmds ? */
929 i = noOpcodes ? 1 : 2;
930 SetupExpandsFlag(ts);
931 for (; i < argc; i++) {
935 embeddedvalue = NULL;
938 /* Only tokens that start with a hyphen and are not followed by a digit
939 * are considered switches. This allow negative numbers. */
941 if ((argv[i][0] == '-') && !isdigit(argv[i][1])) {
945 if (strrchr(argv[i], '=') != NULL) {
946 param = strdup(argv[i]);
947 embeddedvalue = strrchr(param, '=');
948 *embeddedvalue = '\0';
950 j = FindType(ts, param);
952 j = FindType(ts, argv[i]);
957 "%sUnrecognized or ambiguous switch '%s'; type ",
958 NName(pname, ": "), argv[i]);
960 fprintf(stderr, "'%s -help' for detailed help\n",
963 fprintf(stderr, "'%shelp %s' for detailed help\n",
964 NName(argv[0], " "), ts->name);
965 code = CMD_UNKNOWNSWITCH;
968 if (j >= CMD_MAXPARMS) {
969 fprintf(stderr, "%sInternal parsing error\n",
971 code = CMD_INTERNALERROR;
974 if (ts->parms[j].type == CMD_FLAG) {
975 ts->parms[j].items = &dummy;
978 fprintf(stderr, "%sSwitch '%s' doesn't take an argument\n",
979 NName(pname, ": "), ts->parms[j].name);
986 ts->parms[j].flags |= CMD_PROCESSED;
989 AddItem(&ts->parms[curType], embeddedvalue, pname);
993 /* Try to fit in this descr */
994 if (curType >= CMD_MAXPARMS) {
995 fprintf(stderr, "%sToo many arguments\n", NName(pname, ": "));
999 tparm = &ts->parms[curType];
1001 if ((tparm->type == 0) || /* No option in this slot */
1002 (tparm->type == CMD_FLAG)) { /* A flag (not an argument */
1003 /* skipped parm slot */
1004 curType++; /* Skip this slot and reprocess this parm */
1009 if (!(tparm->flags & CMD_PROCESSED) && (tparm->flags & CMD_HIDE)) {
1010 curType++; /* Skip this slot and reprocess this parm */
1015 if (tparm->type == CMD_SINGLE ||
1016 tparm->type == CMD_SINGLE_OR_FLAG) {
1018 fprintf(stderr, "%sToo many values after switch %s\n",
1019 NName(pname, ": "), tparm->name);
1023 AddItem(tparm, argv[i], pname); /* Add to end of list */
1024 } else if (tparm->type == CMD_LIST) {
1025 AddItem(tparm, argv[i], pname); /* Add to end of list */
1028 /* Now, if we're in positional mode, advance to the next item */
1030 curType = AdvanceType(ts, curType);
1034 /* keep track of this for messages */
1035 ts->a0name = argv[0];
1037 /* If we make it here, all the parameters are filled in. Check to see if
1038 * this is a -help version. Must do this before checking for all
1039 * required parms, otherwise it is a real nuisance */
1040 if (ts->parms[CMD_HELPPARM].items) {
1042 /* Display full help syntax if we don't have subcommands */
1049 /* Parsing done, see if we have all of our required parameters */
1050 for (i = 0; i < CMD_MAXPARMS; i++) {
1051 tparm = &ts->parms[i];
1052 if (tparm->type == 0)
1053 continue; /* Skipped parm slot */
1054 if ((tparm->flags & CMD_PROCESSED) && tparm->items == 0) {
1055 if (tparm->type == CMD_SINGLE_OR_FLAG) {
1056 tparm->items = &dummy;
1058 fprintf(stderr, "%s The field '%s' isn't completed properly\n",
1059 NName(pname, ": "), tparm->name);
1064 if (!(tparm->flags & CMD_OPTIONAL) && tparm->items == 0) {
1065 fprintf(stderr, "%sMissing required parameter '%s'\n",
1066 NName(pname, ": "), tparm->name);
1070 tparm->flags &= ~CMD_PROCESSED;
1075 if (code && ts != NULL)
1082 cmd_Dispatch(int argc, char **argv)
1084 struct cmd_syndesc *ts = NULL;
1087 code = cmd_Parse(argc, argv, &ts);
1089 if (code == CMD_HELP) {
1090 code = 0; /* displaying help is not an error */
1096 * Before calling the beforeProc and afterProc and all the implications
1097 * from those calls, check if the help procedure was called and call it
1100 if ((ts->proc == HelpProc) || (ts->proc == AproposProc)) {
1101 code = (*ts->proc) (ts, ts->rock);
1105 /* Now, we just call the procedure and return */
1107 code = (*beforeProc) (ts, beforeRock);
1112 code = (*ts->proc) (ts, ts->rock);
1115 (*afterProc) (ts, afterRock);
1117 cmd_FreeOptions(&ts);
1122 cmd_FreeOptions(struct cmd_syndesc **ts)
1130 /* free token list returned by parseLine */
1132 FreeTokens(struct cmd_token *alist)
1134 struct cmd_token *nlist;
1135 for (; alist; alist = nlist) {
1136 nlist = alist->next;
1143 /* free an argv list returned by parseline */
1145 cmd_FreeArgv(char **argv)
1148 for (tp = *argv; tp; argv++, tp = *argv)
1153 /* copy back the arg list to the argv array, freeing the cmd_tokens as you go;
1154 * the actual data is still malloc'd, and will be freed when the caller calls
1155 * cmd_FreeArgv later on
1159 CopyBackArgs(struct cmd_token *alist, char **argv,
1160 afs_int32 * an, afs_int32 amaxn)
1162 struct cmd_token *next;
1168 *argv = strdup(INITSTR);
1175 return CMD_TOOMANY; /* argv is too small for his many parms. */
1184 *argv = NULL; /* use last slot for terminating null */
1185 /* don't count terminating null */
1193 if (x == '"' || x == 39 /* single quote */ )
1202 if (x == 0 || x == ' ' || x == '\t' || x == '\n')
1209 cmd_ParseLine(char *aline, char **argv, afs_int32 * an, afs_int32 amaxn)
1213 int inToken, inQuote;
1214 struct cmd_token *first, *last;
1215 struct cmd_token *ttok;
1218 inToken = 0; /* not copying token chars at start */
1221 inQuote = 0; /* not in a quoted string */
1224 if (tc == 0 || (!inQuote && space(tc))) { /* terminating null gets us in here, too */
1226 inToken = 0; /* end of this token */
1228 return -1; /* should never get here */
1231 ttok = malloc(sizeof(struct cmd_token));
1234 ttok->key = strdup(tbuffer);
1245 /* an alpha character */
1250 if (tptr - tbuffer >= sizeof(tbuffer)) {
1252 return CMD_TOOBIG; /* token too long */
1255 /* hit a quote, toggle inQuote flag but don't insert character */
1258 /* insert character */
1263 /* last token flushed 'cause space(0) --> true */
1266 return CopyBackArgs(first, argv, an, amaxn);
1271 /* Read a string in from our configuration file. This checks in
1272 * multiple places within this file - firstly in the section
1273 * [command_subcommand], then in [command], then in [subcommand]
1275 * Returns CMD_MISSING if there is no configuration file configured,
1276 * or if the file doesn't contain information for the specified option
1277 * in any of these sections.
1281 _get_file_string(struct cmd_syndesc *syn, int pos, const char **str)
1286 /* Nothing on the command line, try the config file if we have one */
1287 if (globalConfig == NULL)
1290 /* March past any leading -'s */
1291 for (optionName = syn->parms[pos].name;
1292 *optionName == '-'; optionName++);
1294 /* First, try the command_subcommand form */
1295 if (syn->name != NULL && commandName != NULL) {
1296 if (asprintf(§ion, "%s_%s", commandName, syn->name) < 0)
1298 *str = cmd_RawConfigGetString(globalConfig, NULL, section,
1305 /* Then, try the command form */
1306 if (commandName != NULL) {
1307 *str = cmd_RawConfigGetString(globalConfig, NULL, commandName,
1313 /* Then, the defaults section */
1314 *str = cmd_RawConfigGetString(globalConfig, NULL, "defaults",
1319 /* Nothing there, return MISSING */
1324 _get_config_string(struct cmd_syndesc *syn, int pos, const char **str)
1328 if (pos > syn->nParms)
1329 return CMD_EXCESSPARMS;
1331 /* It's a flag, they probably shouldn't be using this interface to access
1332 * it, but don't blow up for now */
1333 if (syn->parms[pos].items == &dummy)
1336 /* We have a value on the command line - this overrides anything in the
1337 * configuration file */
1338 if (syn->parms[pos].items != NULL &&
1339 syn->parms[pos].items->data != NULL) {
1340 *str = syn->parms[pos].items->data;
1344 return _get_file_string(syn, pos, str);
1348 cmd_OptionAsInt(struct cmd_syndesc *syn, int pos, int *value)
1353 code =_get_config_string(syn, pos, &str);
1360 *value = strtol(str, NULL, 10);
1366 cmd_OptionAsUint(struct cmd_syndesc *syn, int pos,
1367 unsigned int *value)
1372 code = _get_config_string(syn, pos, &str);
1379 *value = strtoul(str, NULL, 10);
1385 cmd_OptionAsString(struct cmd_syndesc *syn, int pos, char **value)
1390 code = _get_config_string(syn, pos, &str);
1399 *value = strdup(str);
1405 cmd_OptionAsList(struct cmd_syndesc *syn, int pos, struct cmd_item **value)
1408 struct cmd_item *item, **last;
1409 const char *start, *end;
1413 if (pos > syn->nParms)
1414 return CMD_EXCESSPARMS;
1416 /* If we have a list already, just return the existing list */
1417 if (syn->parms[pos].items != NULL) {
1418 *value = syn->parms[pos].items;
1422 code = _get_file_string(syn, pos, &str);
1426 /* Use strchr to split str into elements, and build a recursive list
1427 * from them. Hang this list off the configuration structure, so that
1428 * it is returned by any future calls to this function, and is freed
1429 * along with everything else when the syntax description is freed
1431 last = &syn->parms[pos].items;
1433 while ((end = strchr(start, ' '))) {
1434 item = calloc(1, sizeof(struct cmd_item));
1435 len = end - start + 1;
1436 item->data = malloc(len);
1437 strlcpy(item->data, start, len);
1440 for (start = end; *start == ' '; start++); /* skip any whitespace */
1443 /* Catch the final element */
1444 if (*start != '\0') {
1445 item = calloc(1, sizeof(struct cmd_item));
1446 len = strlen(start) + 1;
1447 item->data = malloc(len);
1448 strlcpy(item->data, start, len);
1452 *value = syn->parms[pos].items;
1458 cmd_OptionAsFlag(struct cmd_syndesc *syn, int pos, int *value)
1460 const char *str = NULL;
1463 code = _get_config_string(syn, pos, &str);
1468 strcasecmp(str, "yes") == 0 ||
1469 strcasecmp(str, "true") == 0 ||
1479 cmd_OptionPresent(struct cmd_syndesc *syn, int pos)
1484 code = _get_config_string(syn, pos, &str);
1492 cmd_OpenConfigFile(const char *file)
1495 cmd_RawConfigFileFree(globalConfig);
1496 globalConfig = NULL;
1499 return cmd_RawConfigParseFile(file, &globalConfig);
1503 cmd_SetCommandName(const char *command)
1505 commandName = command;
1508 const cmd_config_section *
1511 return globalConfig;
1514 const cmd_config_section *
1515 cmd_RawSection(void)
1517 if (globalConfig == NULL || commandName == NULL)
1520 return cmd_RawConfigGetList(globalConfig, commandName, NULL);