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 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?"]":"");
183 extern char *AFSVersion;
186 VersionProc(struct cmd_syndesc *as, void *arock)
188 printf("%s\n", AFSVersion);
193 PrintSyntax(struct cmd_syndesc *as)
196 struct cmd_parmdesc *tp;
202 /* now print usage, from syntax table */
204 asprintf(&str, "Usage: %s", as->a0name);
206 if (!strcmp(as->name, initcmd_opcode))
207 asprintf(&str, "Usage: %s[%s]", NName(as->a0name, " "), as->name);
209 asprintf(&str, "Usage: %s%s", NName(as->a0name, " "), as->name);
216 for (i = 0; i < CMD_MAXPARMS; i++) {
219 continue; /* seeked over slot */
220 if (tp->flags & CMD_HIDE)
221 continue; /* skip hidden options */
223 /* The parameter name is the real name, plus any aliases */
225 name = strdup(tp->name);
228 struct cmd_item *alias;
229 namelen = strlen(tp->name) + 1;
230 for (alias = tp->aliases; alias != NULL; alias = alias->next)
231 namelen+=strlen(alias->data) + 3;
233 name = malloc(namelen);
234 strlcpy(name, tp->name, namelen);
236 for (alias = tp->aliases; alias != NULL; alias = alias->next) {
237 strlcat(name, " | ", namelen);
238 strlcat(name, alias->data, namelen);
242 /* Work out if we can fit what we want to on this line, or if we need to
244 str = ParmHelpString(tp);
245 xtralen = 1 + strlen(name) + strlen(str) +
246 ((tp->flags & CMD_OPTIONAL)? 2: 0);
248 if (len + xtralen > 78) {
254 tp->flags & CMD_OPTIONAL?"[":"",
257 tp->flags & CMD_OPTIONAL?"]":"");
265 /* must print newline in any case, to terminate preceding line */
267 PrintAliases(struct cmd_syndesc *as)
269 struct cmd_syndesc *ts;
271 if (as->flags & CMD_ALIAS) {
273 printf("(alias for %s)\n", ts->name);
277 return; /* none, print nothing */
279 for (as = as->nextAlias; as; as = as->nextAlias) {
280 printf("%s ", as->name);
287 PrintFlagHelp(struct cmd_syndesc *as)
290 struct cmd_parmdesc *tp;
294 /* find flag name length */
296 for (i = 0; i < CMD_MAXPARMS; i++) {
297 if (i == CMD_HELPPARM)
300 if (tp->type != CMD_FLAG)
302 if (tp->flags & CMD_HIDE)
303 continue; /* skip hidden options */
307 if (strlen(tp->name) > flag_width)
308 flag_width = strlen(tp->name);
311 /* print flag help */
312 flag_prefix = "Where:";
313 for (i = 0; i < CMD_MAXPARMS; i++) {
314 if (i == CMD_HELPPARM)
317 if (tp->type != CMD_FLAG)
319 if (tp->flags & CMD_HIDE)
320 continue; /* skip hidden options */
324 printf("%-7s%-*s %s\n", flag_prefix, flag_width, tp->name, tp->help);
330 AproposProc(struct cmd_syndesc *as, void *arock)
332 struct cmd_syndesc *ts;
337 tsub = as->parms[0].items->data;
338 for (ts = allSyntax; ts; ts = ts->next) {
339 if ((ts->flags & CMD_ALIAS) || (ts->flags & CMD_HIDDEN))
341 if (SubString(ts->help, tsub)) {
342 printf("%s: %s\n", ts->name, ts->help);
344 } else if (SubString(ts->name, tsub)) {
345 printf("%s: %s\n", ts->name, ts->help);
350 printf("Sorry, no commands found\n");
355 HelpProc(struct cmd_syndesc *as, void *arock)
357 struct cmd_syndesc *ts;
362 if (as->parms[0].items == 0) {
363 printf("%sCommands are:\n", NName(as->a0name, ": "));
364 for (ts = allSyntax; ts; ts = ts->next) {
365 if ((ts->flags & CMD_ALIAS) || (ts->flags & CMD_HIDDEN))
367 printf("%-15s %s\n", ts->name, (ts->help ? ts->help : ""));
370 /* print out individual help topics */
371 for (ti = as->parms[0].items; ti; ti = ti->next) {
373 ts = FindSyntax(ti->data, &ambig);
374 if (ts && (ts->flags & CMD_HIDDEN))
375 ts = 0; /* no hidden commands */
377 /* print out command name and help */
378 printf("%s%s: %s ", NName(as->a0name, " "), ts->name,
379 (ts->help ? ts->help : ""));
380 ts->a0name = as->a0name;
386 fprintf(stderr, "%sUnknown topic '%s'\n",
387 NName(as->a0name, ": "), ti->data);
389 /* ambiguous, list 'em all */
391 "%sAmbiguous topic '%s'; use 'apropos' to list\n",
392 NName(as->a0name, ": "), ti->data);
394 code = CMD_UNKNOWNCMD;
402 cmd_SetBeforeProc(int (*aproc) (struct cmd_syndesc * ts, void *beforeRock),
411 cmd_SetAfterProc(int (*aproc) (struct cmd_syndesc * ts, void *afterRock),
419 /* thread on list in alphabetical order */
421 SortSyntax(struct cmd_syndesc *as)
423 struct cmd_syndesc **ld, *ud;
425 for (ld = &allSyntax, ud = *ld; ud; ld = &ud->next, ud = *ld) {
426 if (strcmp(ud->name, as->name) > 0) { /* next guy is bigger than us */
430 /* thread us on the list now */
437 * Create a command syntax.
439 * \note Use cmd_AddParm() or cmd_AddParmAtOffset() to set the
440 * parameters for the new command.
442 * \param[in] aname name used to invoke the command
443 * \param[in] aproc procedure to be called when command is invoked
444 * \param[in] arock opaque data pointer to be passed to aproc
445 * \param[in] aflags command option flags (CMD_HIDDEN)
446 * \param[in] ahelp help string to display for this command
448 * \return a pointer to the cmd_syndesc or NULL if error.
451 cmd_CreateSyntax(char *aname,
452 int (*aproc) (struct cmd_syndesc * ts, void *arock),
453 void *arock, afs_uint32 aflags, char *ahelp)
455 struct cmd_syndesc *td;
457 /* can't have two cmds in no opcode mode */
461 /* Allow only valid cmd flags. */
462 if (aflags & ~CMD_HIDDEN) {
466 td = calloc(1, sizeof(struct cmd_syndesc));
468 td->aliasOf = td; /* treat aliasOf as pointer to real command, no matter what */
471 /* copy in name, etc */
473 td->name = strdup(aname);
480 td->help = strdup(ahelp);
489 cmd_Seek(td, CMD_HELPPARM);
490 cmd_AddParm(td, "-help", CMD_FLAG, CMD_OPTIONAL, "get detailed help");
497 cmd_CreateAlias(struct cmd_syndesc *as, char *aname)
499 struct cmd_syndesc *td;
501 td = malloc(sizeof(struct cmd_syndesc));
503 memcpy(td, as, sizeof(struct cmd_syndesc));
504 td->name = strdup(aname);
506 td->flags |= CMD_ALIAS;
507 /* if ever free things, make copy of help string, too */
512 /* thread on alias lists */
513 td->nextAlias = as->nextAlias;
517 return 0; /* all done */
521 cmd_DisablePositionalCommands(void)
523 enablePositional = 0;
527 cmd_DisableAbbreviations(void)
529 enableAbbreviation = 0;
533 cmd_Seek(struct cmd_syndesc *as, int apos)
535 if (apos >= CMD_MAXPARMS)
536 return CMD_EXCESSPARMS;
542 cmd_AddParmAtOffset(struct cmd_syndesc *as, int ref, char *aname, int atype,
543 afs_int32 aflags, char *ahelp)
545 struct cmd_parmdesc *tp;
547 if (ref >= CMD_MAXPARMS)
548 return CMD_EXCESSPARMS;
549 tp = &as->parms[ref];
551 tp->name = strdup(aname);
557 tp->help = strdup(ahelp);
564 if (as->nParms <= ref)
571 cmd_AddParm(struct cmd_syndesc *as, char *aname, int atype,
572 afs_int32 aflags, char *ahelp)
574 if (as->nParms >= CMD_MAXPARMS)
575 return CMD_EXCESSPARMS;
577 return cmd_AddParmAtOffset(as, as->nParms++, aname, atype, aflags, ahelp);
581 cmd_AddParmAlias(struct cmd_syndesc *as, int pos, char *alias)
583 struct cmd_item *item;
585 if (pos > as->nParms)
586 return CMD_EXCESSPARMS;
588 item = calloc(1, sizeof(struct cmd_item));
589 item->data = strdup(alias);
590 item->next = as->parms[pos].aliases;
591 as->parms[pos].aliases = item;
596 /* add a text item to the end of the parameter list */
598 AddItem(struct cmd_parmdesc *aparm, char *aval, char *pname)
600 struct cmd_item *ti, *ni;
602 if (aparm->type == CMD_SINGLE ||
603 aparm->type == CMD_SINGLE_OR_FLAG) {
605 fprintf(stderr, "%sToo many values after switch %s\n",
606 NName(pname, ": "), aparm->name);
611 ti = calloc(1, sizeof(struct cmd_item));
613 ti->data = strdup(aval);
615 /* now put ti at the *end* of the list */
616 if ((ni = aparm->items)) {
617 for (; ni; ni = ni->next)
619 break; /* skip to last one */
622 aparm->items = ti; /* we're first */
626 /* skip to next non-flag item, if any */
628 AdvanceType(struct cmd_syndesc *as, afs_int32 aval)
631 struct cmd_parmdesc *tp;
633 /* first see if we should try to grab rest of line for this dude */
634 if (as->parms[aval].flags & CMD_EXPANDS)
637 /* if not, find next non-flag used slot */
638 for (next = aval + 1; next < CMD_MAXPARMS; next++) {
639 tp = &as->parms[next];
640 if (tp->type != 0 && tp->type != CMD_FLAG)
646 /* discard parameters filled in by dispatch */
648 ResetSyntax(struct cmd_syndesc *as)
651 struct cmd_parmdesc *tp;
652 struct cmd_item *ti, *ni;
655 for (i = 0; i < CMD_MAXPARMS; i++, tp++) {
657 case CMD_SINGLE_OR_FLAG:
658 if (tp->items == &dummy)
660 /* Deliberately fall through here */
663 /* free whole list in both cases, just for fun */
664 for (ti = tp->items; ti; ti = ni) {
678 /* move the expands flag to the last one in the list */
680 SetupExpandsFlag(struct cmd_syndesc *as)
682 struct cmd_parmdesc *tp;
686 /* find last CMD_LIST type parameter, optional or not, and make it expandable
687 * if no other dude is expandable */
688 for (i = 0; i < CMD_MAXPARMS; i++) {
690 if (tp->type == CMD_LIST) {
691 if (tp->flags & CMD_EXPANDS)
692 return 0; /* done if already specified */
697 as->parms[last].flags |= CMD_EXPANDS;
701 /* Take the current argv & argc and alter them so that the initialization
702 * opcode is made to appear. This is used in cases where the initialization
703 * opcode is implicitly invoked.*/
705 InsertInitOpcode(int *aargc, char **aargv)
707 char **newargv; /*Ptr to new, expanded argv space */
708 char *pinitopcode; /*Ptr to space for name of init opcode */
709 int i; /*Loop counter */
711 /* Allocate the new argv array, plus one for the new opcode, plus one
712 * more for the trailing null pointer */
713 newargv = malloc(((*aargc) + 2) * sizeof(char *));
715 fprintf(stderr, "%s: Can't create new argv array with %d+2 slots\n",
720 /* Create space for the initial opcode & fill it in */
721 pinitopcode = strdup(initcmd_opcode);
723 fprintf(stderr, "%s: Can't malloc initial opcode space\n", aargv[0]);
728 /* Move all the items in the old argv into the new argv, in their
730 for (i = *aargc; i > 1; i--)
731 newargv[i] = aargv[i - 1];
733 /* Slip in the opcode and the trailing null pointer, and bump the
734 * argument count up by one for the new opcode */
735 newargv[0] = aargv[0];
736 newargv[1] = pinitopcode;
738 newargv[*aargc] = NULL;
740 /* Return the happy news */
743 } /*InsertInitOpcode */
746 NoParmsOK(struct cmd_syndesc *as)
749 struct cmd_parmdesc *td;
751 for (i = 0; i < CMD_MAXPARMS; i++) {
753 if (td->type != 0 && !(td->flags & CMD_OPTIONAL)) {
754 /* found a non-optional (e.g. required) parm, so NoParmsOK
755 * is false (some parms are required) */
762 /* Add help, apropos commands once */
766 struct cmd_syndesc *ts;
769 ts = cmd_CreateSyntax("help", HelpProc, NULL, 0,
770 "get help on commands");
771 cmd_AddParm(ts, "-topic", CMD_LIST, CMD_OPTIONAL, "help string");
773 ts = cmd_CreateSyntax("apropos", AproposProc, NULL, 0,
774 "search by help text");
775 cmd_AddParm(ts, "-topic", CMD_SINGLE, CMD_REQUIRED, "help string");
777 cmd_CreateSyntax("version", VersionProc, NULL, 0,
779 cmd_CreateSyntax("-version", VersionProc, NULL, CMD_HIDDEN, NULL);
780 cmd_CreateSyntax("-help", HelpProc, NULL, CMD_HIDDEN, NULL);
781 cmd_CreateSyntax("--version", VersionProc, NULL, CMD_HIDDEN, NULL);
782 cmd_CreateSyntax("--help", HelpProc, NULL, CMD_HIDDEN, NULL);
786 /* Call the appropriate function, or return syntax error code. Note: if
787 * no opcode is specified, an initialization routine exists, and it has
788 * NOT been called before, we invoke the special initialization opcode
791 cmd_Parse(int argc, char **argv, struct cmd_syndesc **outsyntax)
794 struct cmd_syndesc *ts = NULL;
795 struct cmd_parmdesc *tparm;
802 char *embeddedvalue = NULL;
803 static int initd = 0; /*Is this the first time this routine has been called? */
804 static int initcmdpossible = 1; /*Should be consider parsing the initial command? */
813 /*Remember the program name */
818 if (!NoParmsOK(allSyntax)) {
819 printf("%s: Type '%s -help' for help\n", pname, pname);
826 /* if there is an initcmd, don't print an error message, just
827 * setup to use the initcmd below. */
828 if (!(initcmdpossible && FindSyntax(initcmd_opcode, NULL))) {
829 printf("%s: Type '%s help' or '%s help <topic>' for help\n",
830 pname, pname, pname);
837 /* Find the syntax descriptor for this command, doing prefix matching properly */
841 ts = (argc < 2 ? 0 : FindSyntax(argv[1], &ambig));
843 /*First token doesn't match a syntax descriptor */
844 if (initcmdpossible) {
845 /*If initial command line handling hasn't been done yet,
846 * see if there is a descriptor for the initialization opcode.
847 * Only try this once. */
849 ts = FindSyntax(initcmd_opcode, NULL);
851 /*There is no initialization opcode available, so we declare
854 fprintf(stderr, "%s", NName(pname, ": "));
856 "Ambiguous operation '%s'; type '%shelp' for list\n",
857 argv[1], NName(pname, " "));
859 fprintf(stderr, "%s", NName(pname, ": "));
861 "Unrecognized operation '%s'; type '%shelp' for list\n",
862 argv[1], NName(pname, " "));
864 code = CMD_UNKNOWNCMD;
867 /*Found syntax structure for an initialization opcode. Fix
868 * up argv and argc to relect what the user
869 * ``should have'' typed */
870 if (!(argv = InsertInitOpcode(&argc, argv))) {
872 "%sCan't insert implicit init opcode into command line\n",
874 code = CMD_INTERNALERROR;
878 } /*Initial opcode not yet attempted */
880 /* init cmd already run and no syntax entry found */
882 fprintf(stderr, "%s", NName(pname, ": "));
884 "Ambiguous operation '%s'; type '%shelp' for list\n",
885 argv[1], NName(pname, " "));
887 fprintf(stderr, "%s", NName(pname, ": "));
889 "Unrecognized operation '%s'; type '%shelp' for list\n",
890 argv[1], NName(pname, " "));
892 code = CMD_UNKNOWNCMD;
895 } /*Argv[1] is not a valid opcode */
896 } /*Opcodes are defined */
898 /* Found the descriptor; start parsing. curType is the type we're
902 /* We start off parsing in "positional" mode, where tokens are put in
903 * slots positionally. If we find a name that takes args, we go
904 * out of positional mode, and from that point on, expect a switch
905 * before any particular token. */
907 positional = enablePositional; /* Accepting positional cmds ? */
908 i = noOpcodes ? 1 : 2;
909 SetupExpandsFlag(ts);
910 for (; i < argc; i++) {
914 embeddedvalue = NULL;
917 /* Only tokens that start with a hyphen and are not followed by a digit
918 * are considered switches. This allow negative numbers. */
920 if ((argv[i][0] == '-') && !isdigit(argv[i][1])) {
924 if (strrchr(argv[i], '=') != NULL) {
925 param = strdup(argv[i]);
926 embeddedvalue = strrchr(param, '=');
927 *embeddedvalue = '\0';
929 j = FindType(ts, param);
931 j = FindType(ts, argv[i]);
936 "%sUnrecognized or ambiguous switch '%s'; type ",
937 NName(pname, ": "), argv[i]);
939 fprintf(stderr, "'%s -help' for detailed help\n",
942 fprintf(stderr, "'%shelp %s' for detailed help\n",
943 NName(argv[0], " "), ts->name);
944 code = CMD_UNKNOWNSWITCH;
947 if (j >= CMD_MAXPARMS) {
948 fprintf(stderr, "%sInternal parsing error\n",
950 code = CMD_INTERNALERROR;
953 if (ts->parms[j].type == CMD_FLAG) {
954 ts->parms[j].items = &dummy;
957 fprintf(stderr, "%sSwitch '%s' doesn't take an argument\n",
958 NName(pname, ": "), ts->parms[j].name);
965 ts->parms[j].flags |= CMD_PROCESSED;
968 AddItem(&ts->parms[curType], embeddedvalue, pname);
972 /* Try to fit in this descr */
973 if (curType >= CMD_MAXPARMS) {
974 fprintf(stderr, "%sToo many arguments\n", NName(pname, ": "));
978 tparm = &ts->parms[curType];
980 if ((tparm->type == 0) || /* No option in this slot */
981 (tparm->type == CMD_FLAG)) { /* A flag (not an argument */
982 /* skipped parm slot */
983 curType++; /* Skip this slot and reprocess this parm */
988 if (!(tparm->flags & CMD_PROCESSED) && (tparm->flags & CMD_HIDE)) {
989 curType++; /* Skip this slot and reprocess this parm */
994 if (tparm->type == CMD_SINGLE ||
995 tparm->type == CMD_SINGLE_OR_FLAG) {
997 fprintf(stderr, "%sToo many values after switch %s\n",
998 NName(pname, ": "), tparm->name);
1002 AddItem(tparm, argv[i], pname); /* Add to end of list */
1003 } else if (tparm->type == CMD_LIST) {
1004 AddItem(tparm, argv[i], pname); /* Add to end of list */
1007 /* Now, if we're in positional mode, advance to the next item */
1009 curType = AdvanceType(ts, curType);
1013 /* keep track of this for messages */
1014 ts->a0name = argv[0];
1016 /* If we make it here, all the parameters are filled in. Check to see if
1017 * this is a -help version. Must do this before checking for all
1018 * required parms, otherwise it is a real nuisance */
1019 if (ts->parms[CMD_HELPPARM].items) {
1021 /* Display full help syntax if we don't have subcommands */
1028 /* Parsing done, see if we have all of our required parameters */
1029 for (i = 0; i < CMD_MAXPARMS; i++) {
1030 tparm = &ts->parms[i];
1031 if (tparm->type == 0)
1032 continue; /* Skipped parm slot */
1033 if ((tparm->flags & CMD_PROCESSED) && tparm->items == 0) {
1034 if (tparm->type == CMD_SINGLE_OR_FLAG) {
1035 tparm->items = &dummy;
1037 fprintf(stderr, "%s The field '%s' isn't completed properly\n",
1038 NName(pname, ": "), tparm->name);
1043 if (!(tparm->flags & CMD_OPTIONAL) && tparm->items == 0) {
1044 fprintf(stderr, "%sMissing required parameter '%s'\n",
1045 NName(pname, ": "), tparm->name);
1049 tparm->flags &= ~CMD_PROCESSED;
1054 if (code && ts != NULL)
1061 cmd_Dispatch(int argc, char **argv)
1063 struct cmd_syndesc *ts = NULL;
1066 code = cmd_Parse(argc, argv, &ts);
1068 if (code == CMD_HELP) {
1069 code = 0; /* displaying help is not an error */
1075 * Before calling the beforeProc and afterProc and all the implications
1076 * from those calls, check if the help procedure was called and call it
1079 if ((ts->proc == HelpProc) || (ts->proc == AproposProc)) {
1080 code = (*ts->proc) (ts, ts->rock);
1084 /* Now, we just call the procedure and return */
1086 code = (*beforeProc) (ts, beforeRock);
1091 code = (*ts->proc) (ts, ts->rock);
1094 (*afterProc) (ts, afterRock);
1096 cmd_FreeOptions(&ts);
1101 cmd_FreeOptions(struct cmd_syndesc **ts)
1109 /* free token list returned by parseLine */
1111 FreeTokens(struct cmd_token *alist)
1113 struct cmd_token *nlist;
1114 for (; alist; alist = nlist) {
1115 nlist = alist->next;
1122 /* free an argv list returned by parseline */
1124 cmd_FreeArgv(char **argv)
1127 for (tp = *argv; tp; argv++, tp = *argv)
1132 /* copy back the arg list to the argv array, freeing the cmd_tokens as you go;
1133 * the actual data is still malloc'd, and will be freed when the caller calls
1134 * cmd_FreeArgv later on
1138 CopyBackArgs(struct cmd_token *alist, char **argv,
1139 afs_int32 * an, afs_int32 amaxn)
1141 struct cmd_token *next;
1147 *argv = strdup(INITSTR);
1154 return CMD_TOOMANY; /* argv is too small for his many parms. */
1163 *argv = NULL; /* use last slot for terminating null */
1164 /* don't count terminating null */
1172 if (x == '"' || x == 39 /* single quote */ )
1181 if (x == 0 || x == ' ' || x == '\t' || x == '\n')
1188 cmd_ParseLine(char *aline, char **argv, afs_int32 * an, afs_int32 amaxn)
1192 int inToken, inQuote;
1193 struct cmd_token *first, *last;
1194 struct cmd_token *ttok;
1197 inToken = 0; /* not copying token chars at start */
1200 inQuote = 0; /* not in a quoted string */
1203 if (tc == 0 || (!inQuote && space(tc))) { /* terminating null gets us in here, too */
1205 inToken = 0; /* end of this token */
1207 return -1; /* should never get here */
1210 ttok = malloc(sizeof(struct cmd_token));
1213 ttok->key = strdup(tbuffer);
1224 /* an alpha character */
1229 if (tptr - tbuffer >= sizeof(tbuffer)) {
1231 return CMD_TOOBIG; /* token too long */
1234 /* hit a quote, toggle inQuote flag but don't insert character */
1237 /* insert character */
1242 /* last token flushed 'cause space(0) --> true */
1245 return CopyBackArgs(first, argv, an, amaxn);
1250 /* Read a string in from our configuration file. This checks in
1251 * multiple places within this file - firstly in the section
1252 * [command_subcommand], then in [command], then in [subcommand]
1254 * Returns CMD_MISSING if there is no configuration file configured,
1255 * or if the file doesn't contain information for the specified option
1256 * in any of these sections.
1260 _get_file_string(struct cmd_syndesc *syn, int pos, const char **str)
1265 /* Nothing on the command line, try the config file if we have one */
1266 if (globalConfig == NULL)
1269 /* March past any leading -'s */
1270 for (optionName = syn->parms[pos].name;
1271 *optionName == '-'; optionName++);
1273 /* First, try the command_subcommand form */
1274 if (syn->name != NULL && commandName != NULL) {
1275 asprintf(§ion, "%s_%s", commandName, syn->name);
1276 *str = cmd_RawConfigGetString(globalConfig, NULL, section,
1283 /* Then, try the command form */
1284 if (commandName != NULL) {
1285 *str = cmd_RawConfigGetString(globalConfig, NULL, commandName,
1291 /* Then, the defaults section */
1292 *str = cmd_RawConfigGetString(globalConfig, NULL, "defaults",
1297 /* Nothing there, return MISSING */
1302 _get_config_string(struct cmd_syndesc *syn, int pos, const char **str)
1306 if (pos > syn->nParms)
1307 return CMD_EXCESSPARMS;
1309 /* It's a flag, they probably shouldn't be using this interface to access
1310 * it, but don't blow up for now */
1311 if (syn->parms[pos].items == &dummy)
1314 /* We have a value on the command line - this overrides anything in the
1315 * configuration file */
1316 if (syn->parms[pos].items != NULL &&
1317 syn->parms[pos].items->data != NULL) {
1318 *str = syn->parms[pos].items->data;
1322 return _get_file_string(syn, pos, str);
1326 cmd_OptionAsInt(struct cmd_syndesc *syn, int pos, int *value)
1331 code =_get_config_string(syn, pos, &str);
1338 *value = strtol(str, NULL, 10);
1344 cmd_OptionAsUint(struct cmd_syndesc *syn, int pos,
1345 unsigned int *value)
1350 code = _get_config_string(syn, pos, &str);
1357 *value = strtoul(str, NULL, 10);
1363 cmd_OptionAsString(struct cmd_syndesc *syn, int pos, char **value)
1368 code = _get_config_string(syn, pos, &str);
1377 *value = strdup(str);
1383 cmd_OptionAsList(struct cmd_syndesc *syn, int pos, struct cmd_item **value)
1386 struct cmd_item *item, **last;
1387 const char *start, *end;
1391 if (pos > syn->nParms)
1392 return CMD_EXCESSPARMS;
1394 /* If we have a list already, just return the existing list */
1395 if (syn->parms[pos].items != NULL) {
1396 *value = syn->parms[pos].items;
1400 code = _get_file_string(syn, pos, &str);
1404 /* Use strchr to split str into elements, and build a recursive list
1405 * from them. Hang this list off the configuration structure, so that
1406 * it is returned by any future calls to this function, and is freed
1407 * along with everything else when the syntax description is freed
1409 last = &syn->parms[pos].items;
1411 while ((end = strchr(start, ' '))) {
1412 item = calloc(1, sizeof(struct cmd_item));
1413 len = end - start + 1;
1414 item->data = malloc(len);
1415 strlcpy(item->data, start, len);
1418 for (start = end; *start == ' '; start++); /* skip any whitespace */
1421 /* Catch the final element */
1422 if (*start != '\0') {
1423 item = calloc(1, sizeof(struct cmd_item));
1424 len = strlen(start) + 1;
1425 item->data = malloc(len);
1426 strlcpy(item->data, start, len);
1430 *value = syn->parms[pos].items;
1436 cmd_OptionAsFlag(struct cmd_syndesc *syn, int pos, int *value)
1438 const char *str = NULL;
1441 code = _get_config_string(syn, pos, &str);
1446 strcasecmp(str, "yes") == 0 ||
1447 strcasecmp(str, "true") == 0 ||
1457 cmd_OptionPresent(struct cmd_syndesc *syn, int pos)
1462 code = _get_config_string(syn, pos, &str);
1470 cmd_OpenConfigFile(const char *file)
1473 cmd_RawConfigFileFree(globalConfig);
1474 globalConfig = NULL;
1477 return cmd_RawConfigParseFile(file, &globalConfig);
1481 cmd_SetCommandName(const char *command)
1483 commandName = command;
1486 const cmd_config_section *
1489 return globalConfig;
1492 const cmd_config_section *
1493 cmd_RawSection(void)
1495 if (globalConfig == NULL || commandName == NULL)
1498 return cmd_RawConfigGetList(globalConfig, commandName, NULL);