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 printf("%sCommands are:\n", NName(as
->a0name
, ": "));
361 for (ts
= allSyntax
; ts
; ts
= ts
->next
) {
362 if ((ts
->flags
& CMD_ALIAS
) || (ts
->flags
& CMD_HIDDEN
))
364 printf("%-15s %s\n", ts
->name
, (ts
->help
? ts
->help
: ""));
367 /* print out individual help topics */
368 for (ti
= as
->parms
[0].items
; ti
; ti
= ti
->next
) {
370 ts
= FindSyntax(ti
->data
, &ambig
);
371 if (ts
&& (ts
->flags
& CMD_HIDDEN
))
372 ts
= 0; /* no hidden commands */
374 /* print out command name and help */
375 printf("%s%s: %s ", NName(as
->a0name
, " "), ts
->name
,
376 (ts
->help
? ts
->help
: ""));
377 ts
->a0name
= as
->a0name
;
383 fprintf(stderr
, "%sUnknown topic '%s'\n",
384 NName(as
->a0name
, ": "), ti
->data
);
386 /* ambiguous, list 'em all */
388 "%sAmbiguous topic '%s'; use 'apropos' to list\n",
389 NName(as
->a0name
, ": "), ti
->data
);
391 code
= CMD_UNKNOWNCMD
;
399 cmd_SetBeforeProc(int (*aproc
) (struct cmd_syndesc
* ts
, void *beforeRock
),
408 cmd_SetAfterProc(int (*aproc
) (struct cmd_syndesc
* ts
, void *afterRock
),
416 /* thread on list in alphabetical order */
418 SortSyntax(struct cmd_syndesc
*as
)
420 struct cmd_syndesc
**ld
, *ud
;
422 for (ld
= &allSyntax
, ud
= *ld
; ud
; ld
= &ud
->next
, ud
= *ld
) {
423 if (strcmp(ud
->name
, as
->name
) > 0) { /* next guy is bigger than us */
427 /* thread us on the list now */
434 * Create a command syntax.
436 * \note Use cmd_AddParm() or cmd_AddParmAtOffset() to set the
437 * parameters for the new command.
439 * \param[in] aname name used to invoke the command
440 * \param[in] aproc procedure to be called when command is invoked
441 * \param[in] arock opaque data pointer to be passed to aproc
442 * \param[in] aflags command option flags (CMD_HIDDEN)
443 * \param[in] ahelp help string to display for this command
445 * \return a pointer to the cmd_syndesc or NULL if error.
448 cmd_CreateSyntax(char *aname
,
449 int (*aproc
) (struct cmd_syndesc
* ts
, void *arock
),
450 void *arock
, afs_uint32 aflags
, char *ahelp
)
452 struct cmd_syndesc
*td
;
454 /* can't have two cmds in no opcode mode */
458 /* Allow only valid cmd flags. */
459 if (aflags
& ~CMD_HIDDEN
) {
463 td
= calloc(1, sizeof(struct cmd_syndesc
));
465 td
->aliasOf
= td
; /* treat aliasOf as pointer to real command, no matter what */
468 /* copy in name, etc */
470 td
->name
= strdup(aname
);
477 td
->help
= strdup(ahelp
);
486 cmd_Seek(td
, CMD_HELPPARM
);
487 cmd_AddParm(td
, "-help", CMD_FLAG
, CMD_OPTIONAL
, "get detailed help");
494 cmd_CreateAlias(struct cmd_syndesc
*as
, char *aname
)
496 struct cmd_syndesc
*td
;
498 td
= malloc(sizeof(struct cmd_syndesc
));
500 memcpy(td
, as
, sizeof(struct cmd_syndesc
));
501 td
->name
= strdup(aname
);
503 td
->flags
|= CMD_ALIAS
;
504 /* if ever free things, make copy of help string, too */
509 /* thread on alias lists */
510 td
->nextAlias
= as
->nextAlias
;
514 return 0; /* all done */
518 cmd_DisablePositionalCommands(void)
520 enablePositional
= 0;
524 cmd_DisableAbbreviations(void)
526 enableAbbreviation
= 0;
530 cmd_Seek(struct cmd_syndesc
*as
, int apos
)
532 if (apos
>= CMD_MAXPARMS
)
533 return CMD_EXCESSPARMS
;
539 cmd_AddParmAtOffset(struct cmd_syndesc
*as
, int ref
, char *aname
, int atype
,
540 afs_int32 aflags
, char *ahelp
)
542 struct cmd_parmdesc
*tp
;
544 if (ref
>= CMD_MAXPARMS
)
545 return CMD_EXCESSPARMS
;
546 tp
= &as
->parms
[ref
];
548 tp
->name
= strdup(aname
);
554 tp
->help
= strdup(ahelp
);
561 if (as
->nParms
<= ref
)
568 cmd_AddParm(struct cmd_syndesc
*as
, char *aname
, int atype
,
569 afs_int32 aflags
, char *ahelp
)
571 if (as
->nParms
>= CMD_MAXPARMS
)
572 return CMD_EXCESSPARMS
;
574 return cmd_AddParmAtOffset(as
, as
->nParms
++, aname
, atype
, aflags
, ahelp
);
578 cmd_AddParmAlias(struct cmd_syndesc
*as
, int pos
, char *alias
)
580 struct cmd_item
*item
;
582 if (pos
> as
->nParms
)
583 return CMD_EXCESSPARMS
;
585 item
= calloc(1, sizeof(struct cmd_item
));
586 item
->data
= strdup(alias
);
587 item
->next
= as
->parms
[pos
].aliases
;
588 as
->parms
[pos
].aliases
= item
;
593 /* add a text item to the end of the parameter list */
595 AddItem(struct cmd_parmdesc
*aparm
, char *aval
, char *pname
)
597 struct cmd_item
*ti
, *ni
;
599 if (aparm
->type
== CMD_SINGLE
||
600 aparm
->type
== CMD_SINGLE_OR_FLAG
) {
602 fprintf(stderr
, "%sToo many values after switch %s\n",
603 NName(pname
, ": "), aparm
->name
);
608 ti
= calloc(1, sizeof(struct cmd_item
));
610 ti
->data
= strdup(aval
);
612 /* now put ti at the *end* of the list */
613 if ((ni
= aparm
->items
)) {
614 for (; ni
; ni
= ni
->next
)
616 break; /* skip to last one */
619 aparm
->items
= ti
; /* we're first */
623 /* skip to next non-flag item, if any */
625 AdvanceType(struct cmd_syndesc
*as
, afs_int32 aval
)
628 struct cmd_parmdesc
*tp
;
630 /* first see if we should try to grab rest of line for this dude */
631 if (as
->parms
[aval
].flags
& CMD_EXPANDS
)
634 /* if not, find next non-flag used slot */
635 for (next
= aval
+ 1; next
< CMD_MAXPARMS
; next
++) {
636 tp
= &as
->parms
[next
];
637 if (tp
->type
!= 0 && tp
->type
!= CMD_FLAG
)
643 /* discard parameters filled in by dispatch */
645 ResetSyntax(struct cmd_syndesc
*as
)
648 struct cmd_parmdesc
*tp
;
649 struct cmd_item
*ti
, *ni
;
652 for (i
= 0; i
< CMD_MAXPARMS
; i
++, tp
++) {
654 case CMD_SINGLE_OR_FLAG
:
655 if (tp
->items
== &dummy
)
657 /* Deliberately fall through here */
660 /* free whole list in both cases, just for fun */
661 for (ti
= tp
->items
; ti
; ti
= ni
) {
675 /* move the expands flag to the last one in the list */
677 SetupExpandsFlag(struct cmd_syndesc
*as
)
679 struct cmd_parmdesc
*tp
;
683 /* find last CMD_LIST type parameter, optional or not, and make it expandable
684 * if no other dude is expandable */
685 for (i
= 0; i
< CMD_MAXPARMS
; i
++) {
687 if (tp
->type
== CMD_LIST
) {
688 if (tp
->flags
& CMD_EXPANDS
)
689 return 0; /* done if already specified */
694 as
->parms
[last
].flags
|= CMD_EXPANDS
;
698 /* Take the current argv & argc and alter them so that the initialization
699 * opcode is made to appear. This is used in cases where the initialization
700 * opcode is implicitly invoked.*/
702 InsertInitOpcode(int *aargc
, char **aargv
)
704 char **newargv
; /*Ptr to new, expanded argv space */
705 char *pinitopcode
; /*Ptr to space for name of init opcode */
706 int i
; /*Loop counter */
708 /* Allocate the new argv array, plus one for the new opcode, plus one
709 * more for the trailing null pointer */
710 newargv
= malloc(((*aargc
) + 2) * sizeof(char *));
712 fprintf(stderr
, "%s: Can't create new argv array with %d+2 slots\n",
717 /* Create space for the initial opcode & fill it in */
718 pinitopcode
= strdup(initcmd_opcode
);
720 fprintf(stderr
, "%s: Can't malloc initial opcode space\n", aargv
[0]);
725 /* Move all the items in the old argv into the new argv, in their
727 for (i
= *aargc
; i
> 1; i
--)
728 newargv
[i
] = aargv
[i
- 1];
730 /* Slip in the opcode and the trailing null pointer, and bump the
731 * argument count up by one for the new opcode */
732 newargv
[0] = aargv
[0];
733 newargv
[1] = pinitopcode
;
735 newargv
[*aargc
] = NULL
;
737 /* Return the happy news */
740 } /*InsertInitOpcode */
743 NoParmsOK(struct cmd_syndesc
*as
)
746 struct cmd_parmdesc
*td
;
748 for (i
= 0; i
< CMD_MAXPARMS
; i
++) {
750 if (td
->type
!= 0 && !(td
->flags
& CMD_OPTIONAL
)) {
751 /* found a non-optional (e.g. required) parm, so NoParmsOK
752 * is false (some parms are required) */
759 /* Add help, apropos commands once */
763 struct cmd_syndesc
*ts
;
766 ts
= cmd_CreateSyntax("help", HelpProc
, NULL
, 0,
767 "get help on commands");
768 cmd_AddParm(ts
, "-topic", CMD_LIST
, CMD_OPTIONAL
, "help string");
770 ts
= cmd_CreateSyntax("apropos", AproposProc
, NULL
, 0,
771 "search by help text");
772 cmd_AddParm(ts
, "-topic", CMD_SINGLE
, CMD_REQUIRED
, "help string");
774 cmd_CreateSyntax("version", VersionProc
, NULL
, 0,
776 cmd_CreateSyntax("-version", VersionProc
, NULL
, CMD_HIDDEN
, NULL
);
777 cmd_CreateSyntax("-help", HelpProc
, NULL
, CMD_HIDDEN
, NULL
);
778 cmd_CreateSyntax("--version", VersionProc
, NULL
, CMD_HIDDEN
, NULL
);
779 cmd_CreateSyntax("--help", HelpProc
, NULL
, CMD_HIDDEN
, NULL
);
783 /* Call the appropriate function, or return syntax error code. Note: if
784 * no opcode is specified, an initialization routine exists, and it has
785 * NOT been called before, we invoke the special initialization opcode
788 cmd_Parse(int argc
, char **argv
, struct cmd_syndesc
**outsyntax
)
791 struct cmd_syndesc
*ts
= NULL
;
792 struct cmd_parmdesc
*tparm
;
799 char *embeddedvalue
= NULL
;
800 static int initd
= 0; /*Is this the first time this routine has been called? */
801 static int initcmdpossible
= 1; /*Should be consider parsing the initial command? */
810 /*Remember the program name */
815 if (!NoParmsOK(allSyntax
)) {
816 printf("%s: Type '%s -help' for help\n", pname
, pname
);
823 /* if there is an initcmd, don't print an error message, just
824 * setup to use the initcmd below. */
825 if (!(initcmdpossible
&& FindSyntax(initcmd_opcode
, NULL
))) {
826 printf("%s: Type '%s help' or '%s help <topic>' for help\n",
827 pname
, pname
, pname
);
834 /* Find the syntax descriptor for this command, doing prefix matching properly */
838 ts
= (argc
< 2 ? 0 : FindSyntax(argv
[1], &ambig
));
840 /*First token doesn't match a syntax descriptor */
841 if (initcmdpossible
) {
842 /*If initial command line handling hasn't been done yet,
843 * see if there is a descriptor for the initialization opcode.
844 * Only try this once. */
846 ts
= FindSyntax(initcmd_opcode
, NULL
);
848 /*There is no initialization opcode available, so we declare
851 fprintf(stderr
, "%s", NName(pname
, ": "));
853 "Ambiguous operation '%s'; type '%shelp' for list\n",
854 argv
[1], NName(pname
, " "));
856 fprintf(stderr
, "%s", NName(pname
, ": "));
858 "Unrecognized operation '%s'; type '%shelp' for list\n",
859 argv
[1], NName(pname
, " "));
861 code
= CMD_UNKNOWNCMD
;
864 /*Found syntax structure for an initialization opcode. Fix
865 * up argv and argc to relect what the user
866 * ``should have'' typed */
867 if (!(argv
= InsertInitOpcode(&argc
, argv
))) {
869 "%sCan't insert implicit init opcode into command line\n",
871 code
= CMD_INTERNALERROR
;
875 } /*Initial opcode not yet attempted */
877 /* init cmd already run and no syntax entry found */
879 fprintf(stderr
, "%s", NName(pname
, ": "));
881 "Ambiguous operation '%s'; type '%shelp' for list\n",
882 argv
[1], NName(pname
, " "));
884 fprintf(stderr
, "%s", NName(pname
, ": "));
886 "Unrecognized operation '%s'; type '%shelp' for list\n",
887 argv
[1], NName(pname
, " "));
889 code
= CMD_UNKNOWNCMD
;
892 } /*Argv[1] is not a valid opcode */
893 } /*Opcodes are defined */
895 /* Found the descriptor; start parsing. curType is the type we're
899 /* We start off parsing in "positional" mode, where tokens are put in
900 * slots positionally. If we find a name that takes args, we go
901 * out of positional mode, and from that point on, expect a switch
902 * before any particular token. */
904 positional
= enablePositional
; /* Accepting positional cmds ? */
905 i
= noOpcodes
? 1 : 2;
906 SetupExpandsFlag(ts
);
907 for (; i
< argc
; i
++) {
911 embeddedvalue
= NULL
;
914 /* Only tokens that start with a hyphen and are not followed by a digit
915 * are considered switches. This allow negative numbers. */
917 if ((argv
[i
][0] == '-') && !isdigit(argv
[i
][1])) {
921 if (strrchr(argv
[i
], '=') != NULL
) {
922 param
= strdup(argv
[i
]);
923 embeddedvalue
= strrchr(param
, '=');
924 *embeddedvalue
= '\0';
926 j
= FindType(ts
, param
);
928 j
= FindType(ts
, argv
[i
]);
933 "%sUnrecognized or ambiguous switch '%s'; type ",
934 NName(pname
, ": "), argv
[i
]);
936 fprintf(stderr
, "'%s -help' for detailed help\n",
939 fprintf(stderr
, "'%shelp %s' for detailed help\n",
940 NName(argv
[0], " "), ts
->name
);
941 code
= CMD_UNKNOWNSWITCH
;
944 if (j
>= CMD_MAXPARMS
) {
945 fprintf(stderr
, "%sInternal parsing error\n",
947 code
= CMD_INTERNALERROR
;
950 if (ts
->parms
[j
].type
== CMD_FLAG
) {
951 ts
->parms
[j
].items
= &dummy
;
954 fprintf(stderr
, "%sSwitch '%s' doesn't take an argument\n",
955 NName(pname
, ": "), ts
->parms
[j
].name
);
962 ts
->parms
[j
].flags
|= CMD_PROCESSED
;
965 AddItem(&ts
->parms
[curType
], embeddedvalue
, pname
);
969 /* Try to fit in this descr */
970 if (curType
>= CMD_MAXPARMS
) {
971 fprintf(stderr
, "%sToo many arguments\n", NName(pname
, ": "));
975 tparm
= &ts
->parms
[curType
];
977 if ((tparm
->type
== 0) || /* No option in this slot */
978 (tparm
->type
== CMD_FLAG
)) { /* A flag (not an argument */
979 /* skipped parm slot */
980 curType
++; /* Skip this slot and reprocess this parm */
985 if (!(tparm
->flags
& CMD_PROCESSED
) && (tparm
->flags
& CMD_HIDE
)) {
986 curType
++; /* Skip this slot and reprocess this parm */
991 if (tparm
->type
== CMD_SINGLE
||
992 tparm
->type
== CMD_SINGLE_OR_FLAG
) {
994 fprintf(stderr
, "%sToo many values after switch %s\n",
995 NName(pname
, ": "), tparm
->name
);
999 AddItem(tparm
, argv
[i
], pname
); /* Add to end of list */
1000 } else if (tparm
->type
== CMD_LIST
) {
1001 AddItem(tparm
, argv
[i
], pname
); /* Add to end of list */
1004 /* Now, if we're in positional mode, advance to the next item */
1006 curType
= AdvanceType(ts
, curType
);
1010 /* keep track of this for messages */
1011 ts
->a0name
= argv
[0];
1013 /* If we make it here, all the parameters are filled in. Check to see if
1014 * this is a -help version. Must do this before checking for all
1015 * required parms, otherwise it is a real nuisance */
1016 if (ts
->parms
[CMD_HELPPARM
].items
) {
1018 /* Display full help syntax if we don't have subcommands */
1025 /* Parsing done, see if we have all of our required parameters */
1026 for (i
= 0; i
< CMD_MAXPARMS
; i
++) {
1027 tparm
= &ts
->parms
[i
];
1028 if (tparm
->type
== 0)
1029 continue; /* Skipped parm slot */
1030 if ((tparm
->flags
& CMD_PROCESSED
) && tparm
->items
== 0) {
1031 if (tparm
->type
== CMD_SINGLE_OR_FLAG
) {
1032 tparm
->items
= &dummy
;
1034 fprintf(stderr
, "%s The field '%s' isn't completed properly\n",
1035 NName(pname
, ": "), tparm
->name
);
1040 if (!(tparm
->flags
& CMD_OPTIONAL
) && tparm
->items
== 0) {
1041 fprintf(stderr
, "%sMissing required parameter '%s'\n",
1042 NName(pname
, ": "), tparm
->name
);
1046 tparm
->flags
&= ~CMD_PROCESSED
;
1051 if (code
&& ts
!= NULL
)
1058 cmd_Dispatch(int argc
, char **argv
)
1060 struct cmd_syndesc
*ts
= NULL
;
1063 code
= cmd_Parse(argc
, argv
, &ts
);
1065 if (code
== CMD_HELP
) {
1066 code
= 0; /* displaying help is not an error */
1072 * Before calling the beforeProc and afterProc and all the implications
1073 * from those calls, check if the help procedure was called and call it
1076 if ((ts
->proc
== HelpProc
) || (ts
->proc
== AproposProc
)) {
1077 code
= (*ts
->proc
) (ts
, ts
->rock
);
1081 /* Now, we just call the procedure and return */
1083 code
= (*beforeProc
) (ts
, beforeRock
);
1088 code
= (*ts
->proc
) (ts
, ts
->rock
);
1091 (*afterProc
) (ts
, afterRock
);
1093 cmd_FreeOptions(&ts
);
1098 cmd_FreeOptions(struct cmd_syndesc
**ts
)
1106 /* free token list returned by parseLine */
1108 FreeTokens(struct cmd_token
*alist
)
1110 struct cmd_token
*nlist
;
1111 for (; alist
; alist
= nlist
) {
1112 nlist
= alist
->next
;
1119 /* free an argv list returned by parseline */
1121 cmd_FreeArgv(char **argv
)
1124 for (tp
= *argv
; tp
; argv
++, tp
= *argv
)
1129 /* copy back the arg list to the argv array, freeing the cmd_tokens as you go;
1130 * the actual data is still malloc'd, and will be freed when the caller calls
1131 * cmd_FreeArgv later on
1135 CopyBackArgs(struct cmd_token
*alist
, char **argv
,
1136 afs_int32
* an
, afs_int32 amaxn
)
1138 struct cmd_token
*next
;
1144 *argv
= strdup(INITSTR
);
1151 return CMD_TOOMANY
; /* argv is too small for his many parms. */
1160 *argv
= NULL
; /* use last slot for terminating null */
1161 /* don't count terminating null */
1169 if (x
== '"' || x
== 39 /* single quote */ )
1178 if (x
== 0 || x
== ' ' || x
== '\t' || x
== '\n')
1185 cmd_ParseLine(char *aline
, char **argv
, afs_int32
* an
, afs_int32 amaxn
)
1189 int inToken
, inQuote
;
1190 struct cmd_token
*first
, *last
;
1191 struct cmd_token
*ttok
;
1194 inToken
= 0; /* not copying token chars at start */
1197 inQuote
= 0; /* not in a quoted string */
1200 if (tc
== 0 || (!inQuote
&& space(tc
))) { /* terminating null gets us in here, too */
1202 inToken
= 0; /* end of this token */
1204 return -1; /* should never get here */
1207 ttok
= malloc(sizeof(struct cmd_token
));
1210 ttok
->key
= strdup(tbuffer
);
1221 /* an alpha character */
1226 if (tptr
- tbuffer
>= sizeof(tbuffer
)) {
1228 return CMD_TOOBIG
; /* token too long */
1231 /* hit a quote, toggle inQuote flag but don't insert character */
1234 /* insert character */
1239 /* last token flushed 'cause space(0) --> true */
1242 return CopyBackArgs(first
, argv
, an
, amaxn
);
1247 /* Read a string in from our configuration file. This checks in
1248 * multiple places within this file - firstly in the section
1249 * [command_subcommand], then in [command], then in [subcommand]
1251 * Returns CMD_MISSING if there is no configuration file configured,
1252 * or if the file doesn't contain information for the specified option
1253 * in any of these sections.
1257 _get_file_string(struct cmd_syndesc
*syn
, int pos
, const char **str
)
1262 /* Nothing on the command line, try the config file if we have one */
1263 if (globalConfig
== NULL
)
1266 /* March past any leading -'s */
1267 for (optionName
= syn
->parms
[pos
].name
;
1268 *optionName
== '-'; optionName
++);
1270 /* First, try the command_subcommand form */
1271 if (syn
->name
!= NULL
&& commandName
!= NULL
) {
1272 if (asprintf(§ion
, "%s_%s", commandName
, syn
->name
) < 0)
1274 *str
= cmd_RawConfigGetString(globalConfig
, NULL
, section
,
1281 /* Then, try the command form */
1282 if (commandName
!= NULL
) {
1283 *str
= cmd_RawConfigGetString(globalConfig
, NULL
, commandName
,
1289 /* Then, the defaults section */
1290 *str
= cmd_RawConfigGetString(globalConfig
, NULL
, "defaults",
1295 /* Nothing there, return MISSING */
1300 _get_config_string(struct cmd_syndesc
*syn
, int pos
, const char **str
)
1304 if (pos
> syn
->nParms
)
1305 return CMD_EXCESSPARMS
;
1307 /* It's a flag, they probably shouldn't be using this interface to access
1308 * it, but don't blow up for now */
1309 if (syn
->parms
[pos
].items
== &dummy
)
1312 /* We have a value on the command line - this overrides anything in the
1313 * configuration file */
1314 if (syn
->parms
[pos
].items
!= NULL
&&
1315 syn
->parms
[pos
].items
->data
!= NULL
) {
1316 *str
= syn
->parms
[pos
].items
->data
;
1320 return _get_file_string(syn
, pos
, str
);
1324 cmd_OptionAsInt(struct cmd_syndesc
*syn
, int pos
, int *value
)
1329 code
=_get_config_string(syn
, pos
, &str
);
1336 *value
= strtol(str
, NULL
, 10);
1342 cmd_OptionAsUint(struct cmd_syndesc
*syn
, int pos
,
1343 unsigned int *value
)
1348 code
= _get_config_string(syn
, pos
, &str
);
1355 *value
= strtoul(str
, NULL
, 10);
1361 cmd_OptionAsString(struct cmd_syndesc
*syn
, int pos
, char **value
)
1366 code
= _get_config_string(syn
, pos
, &str
);
1375 *value
= strdup(str
);
1381 cmd_OptionAsList(struct cmd_syndesc
*syn
, int pos
, struct cmd_item
**value
)
1384 struct cmd_item
*item
, **last
;
1385 const char *start
, *end
;
1389 if (pos
> syn
->nParms
)
1390 return CMD_EXCESSPARMS
;
1392 /* If we have a list already, just return the existing list */
1393 if (syn
->parms
[pos
].items
!= NULL
) {
1394 *value
= syn
->parms
[pos
].items
;
1398 code
= _get_file_string(syn
, pos
, &str
);
1402 /* Use strchr to split str into elements, and build a recursive list
1403 * from them. Hang this list off the configuration structure, so that
1404 * it is returned by any future calls to this function, and is freed
1405 * along with everything else when the syntax description is freed
1407 last
= &syn
->parms
[pos
].items
;
1409 while ((end
= strchr(start
, ' '))) {
1410 item
= calloc(1, sizeof(struct cmd_item
));
1411 len
= end
- start
+ 1;
1412 item
->data
= malloc(len
);
1413 strlcpy(item
->data
, start
, len
);
1416 for (start
= end
; *start
== ' '; start
++); /* skip any whitespace */
1419 /* Catch the final element */
1420 if (*start
!= '\0') {
1421 item
= calloc(1, sizeof(struct cmd_item
));
1422 len
= strlen(start
) + 1;
1423 item
->data
= malloc(len
);
1424 strlcpy(item
->data
, start
, len
);
1428 *value
= syn
->parms
[pos
].items
;
1434 cmd_OptionAsFlag(struct cmd_syndesc
*syn
, int pos
, int *value
)
1436 const char *str
= NULL
;
1439 code
= _get_config_string(syn
, pos
, &str
);
1444 strcasecmp(str
, "yes") == 0 ||
1445 strcasecmp(str
, "true") == 0 ||
1455 cmd_OptionPresent(struct cmd_syndesc
*syn
, int pos
)
1460 code
= _get_config_string(syn
, pos
, &str
);
1468 cmd_OpenConfigFile(const char *file
)
1471 cmd_RawConfigFileFree(globalConfig
);
1472 globalConfig
= NULL
;
1475 return cmd_RawConfigParseFile(file
, &globalConfig
);
1479 cmd_SetCommandName(const char *command
)
1481 commandName
= command
;
1484 const cmd_config_section
*
1487 return globalConfig
;
1490 const cmd_config_section
*
1491 cmd_RawSection(void)
1493 if (globalConfig
== NULL
|| commandName
== NULL
)
1496 return cmd_RawConfigGetList(globalConfig
, commandName
, NULL
);