1 This file is getopts.def, from which is created getopts.c.
2 It implements the builtin "getopts" in Bash.
4 Copyright (C) 1987, 1989, 1991 Free Software Foundation, Inc.
6 This file is part of GNU Bash, the Bourne Again SHell.
8 Bash is free software; you can redistribute it and/or modify it under
9 the terms of the GNU General Public License as published by the Free
10 Software Foundation; either version 2, or (at your option) any later
13 Bash is distributed in the hope that it will be useful, but WITHOUT ANY
14 WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
18 You should have received a copy of the GNU General Public License along
19 with Bash; see the file COPYING. If not, write to the Free Software
20 Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA.
25 $FUNCTION getopts_builtin
26 $SHORT_DOC getopts optstring name [arg]
27 Getopts is used by shell procedures to parse positional parameters.
29 OPTSTRING contains the option letters to be recognized; if a letter
30 is followed by a colon, the option is expected to have an argument,
31 which should be separated from it by white space.
33 Each time it is invoked, getopts will place the next option in the
34 shell variable $name, initializing name if it does not exist, and
35 the index of the next argument to be processed into the shell
36 variable OPTIND. OPTIND is initialized to 1 each time the shell or
37 a shell script is invoked. When an option requires an argument,
38 getopts places that argument into the shell variable OPTARG.
40 getopts reports errors in one of two ways. If the first character
41 of OPTSTRING is a colon, getopts uses silent error reporting. In
42 this mode, no error messages are printed. If an illegal option is
43 seen, getopts places the option character found into OPTARG. If a
44 required argument is not found, getopts places a ':' into NAME and
45 sets OPTARG to the option character found. If getopts is not in
46 silent mode, and an illegal option is seen, getopts places '?' into
47 NAME and unsets OPTARG. If a required option is not found, a '?'
48 is placed in NAME, OPTARG is unset, and a diagnostic message is
51 If the shell variable OPTERR has the value 0, getopts disables the
52 printing of error messages, even if the first character of
53 OPTSTRING is not a colon. OPTERR has the value 1 by default.
55 Getopts normally parses the positional parameters ($0 - $9), but if
56 more arguments are given, they are parsed instead.
63 #if defined (HAVE_UNISTD_H)
65 # include <sys/types.h>
70 #include "../bashansi.h"
74 #include "bashgetopt.h"
78 #define G_ILLEGAL_OPT -2
79 #define G_ARG_MISSING -3
81 extern char *this_command_name;
82 extern WORD_LIST *rest_of_args;
84 /* getopts_reset is magic code for when OPTIND is reset. N is the
85 value that has just been assigned to OPTIND. */
87 getopts_reset (newind)
95 getopts_bind_variable (name, value)
100 if (legal_identifier (name))
102 v = bind_variable (name, value);
103 return (v && (readonly_p (v) == 0)) ? EXECUTION_SUCCESS : EXECUTION_FAILURE;
107 builtin_error ("`%s': not a valid identifier", name);
108 return (EXECUTION_FAILURE);
112 /* Error handling is now performed as specified by Posix.2, draft 11
113 (identical to that of ksh-88). The special handling is enabled if
114 the first character of the option string is a colon; this handling
115 disables diagnostic messages concerning missing option arguments
116 and illegal option characters. The handling is as follows.
120 if (special_error) then
121 OPTARG = option character found
128 MISSING OPTION ARGUMENT;
129 if (special_error) then
131 OPTARG = option character found
140 dogetopts (argc, argv)
144 int ret, special_error, old_opterr, i, n;
145 char strval[2], numval[16];
146 char *optstr; /* list of options */
147 char *name; /* variable to get flag val */
156 /* argv[0] is "getopts". */
163 special_error = optstr[0] == ':';
167 old_opterr = sh_opterr;
169 sh_opterr = 0; /* suppress diagnostic messages */
174 sh_getopt_restore_state (argv);
176 argv[0] = dollar_vars[0];
177 ret = sh_getopt (argc, argv, optstr);
180 else if (rest_of_args == (WORD_LIST *)NULL)
182 for (i = 0; i < 10 && dollar_vars[i]; i++)
185 sh_getopt_restore_state (dollar_vars);
186 ret = sh_getopt (i, dollar_vars, optstr);
190 register WORD_LIST *words;
193 for (i = 0; i < 10 && dollar_vars[i]; i++)
195 for (words = rest_of_args; words; words = words->next, i++)
197 v = alloc_array (i + 1);
198 for (i = 0; i < 10 && dollar_vars[i]; i++)
199 v[i] = dollar_vars[i];
200 for (words = rest_of_args; words; words = words->next, i++)
201 v[i] = words->word->word;
203 sh_getopt_restore_state (v);
204 ret = sh_getopt (i, v, optstr);
209 sh_opterr = old_opterr;
211 /* Set the OPTIND variable in any case, to handle "--" skipping. */
214 numval[14] = sh_optind + '0';
220 numval[i = 15] = '\0';
224 numval[--i] = (n % 10) + '0';
228 bind_variable ("OPTIND", numval + i);
230 /* If an error occurred, decide which one it is and set the return
231 code appropriately. In all cases, the option character in error
232 is in OPTOPT. If an illegal option was encountered, OPTARG is
233 NULL. If a required option argument was missing, OPTARG points
234 to a NULL string (that is, sh_optarg[0] == 0). */
237 if (sh_optarg == NULL)
239 else if (sh_optarg[0] == '\0')
245 getopts_bind_variable (name, "?");
246 return (EXECUTION_FAILURE);
249 if (ret == G_ILLEGAL_OPT)
251 /* Illegal option encountered. */
252 ret = getopts_bind_variable (name, "?");
256 strval[0] = (char)sh_optopt;
258 bind_variable ("OPTARG", strval);
261 makunbound ("OPTARG", shell_variables);
266 if (ret == G_ARG_MISSING)
268 /* Required argument missing. */
271 ret = getopts_bind_variable (name, ":");
273 strval[0] = (char)sh_optopt;
275 bind_variable ("OPTARG", strval);
279 ret = getopts_bind_variable (name, "?");
280 makunbound ("OPTARG", shell_variables);
285 bind_variable ("OPTARG", sh_optarg);
287 strval[0] = (char) ret;
289 return (getopts_bind_variable (name, strval));
292 /* The getopts builtin. Build an argv, and call dogetopts with it. */
294 getopts_builtin (list)
306 reset_internal_getopt ();
307 while ((ret = internal_getopt (list, "")) != -1)
318 av = make_builtin_argv (list, &ac);
319 ret = dogetopts (ac, av);