aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat
-rw-r--r--applets/busybox.c3
-rw-r--r--busybox.c3
-rw-r--r--busybox.def.h1
-rw-r--r--docs/busybox.pod46
-rw-r--r--docs/busybox.sgml55
-rw-r--r--getopt.c416
-rw-r--r--internal.h1
-rw-r--r--util-linux/getopt.c416
8 files changed, 939 insertions, 2 deletions
diff --git a/applets/busybox.c b/applets/busybox.c
index 5d13a7b98..d93fc5185 100644
--- a/applets/busybox.c
+++ b/applets/busybox.c
@@ -100,6 +100,9 @@ const struct BB_applet applets[] = {
100#ifdef BB_FSCK_MINIX 100#ifdef BB_FSCK_MINIX
101 {"fsck.minix", fsck_minix_main, _BB_DIR_SBIN, fsck_minix_usage}, 101 {"fsck.minix", fsck_minix_main, _BB_DIR_SBIN, fsck_minix_usage},
102#endif 102#endif
103#ifdef BB_GETOPT
104 {"getopt", getopt_main, _BB_DIR_BIN},
105#endif
103#ifdef BB_GREP 106#ifdef BB_GREP
104 {"grep", grep_main, _BB_DIR_BIN, grep_usage}, 107 {"grep", grep_main, _BB_DIR_BIN, grep_usage},
105#endif 108#endif
diff --git a/busybox.c b/busybox.c
index 5d13a7b98..d93fc5185 100644
--- a/busybox.c
+++ b/busybox.c
@@ -100,6 +100,9 @@ const struct BB_applet applets[] = {
100#ifdef BB_FSCK_MINIX 100#ifdef BB_FSCK_MINIX
101 {"fsck.minix", fsck_minix_main, _BB_DIR_SBIN, fsck_minix_usage}, 101 {"fsck.minix", fsck_minix_main, _BB_DIR_SBIN, fsck_minix_usage},
102#endif 102#endif
103#ifdef BB_GETOPT
104 {"getopt", getopt_main, _BB_DIR_BIN},
105#endif
103#ifdef BB_GREP 106#ifdef BB_GREP
104 {"grep", grep_main, _BB_DIR_BIN, grep_usage}, 107 {"grep", grep_main, _BB_DIR_BIN, grep_usage},
105#endif 108#endif
diff --git a/busybox.def.h b/busybox.def.h
index fd4302a84..692c7213f 100644
--- a/busybox.def.h
+++ b/busybox.def.h
@@ -33,6 +33,7 @@
33#define BB_FREE 33#define BB_FREE
34#define BB_FREERAMDISK 34#define BB_FREERAMDISK
35#define BB_FSCK_MINIX 35#define BB_FSCK_MINIX
36#define BB_GETOPT
36#define BB_GREP 37#define BB_GREP
37#define BB_GUNZIP 38#define BB_GUNZIP
38#define BB_GZIP 39#define BB_GZIP
diff --git a/docs/busybox.pod b/docs/busybox.pod
index 916ccb6f0..4fba7eafa 100644
--- a/docs/busybox.pod
+++ b/docs/busybox.pod
@@ -57,7 +57,7 @@ Currently defined functions include:
57 57
58ar, basename, cat, chgrp, chmod, chown, chroot, chvt, clear, cp, cut, date, 58ar, basename, cat, chgrp, chmod, chown, chroot, chvt, clear, cp, cut, date,
59dc, dd, deallocvt, df, dirname, dmesg, du, dumpkmap, dutmp, echo, false, fbset, 59dc, dd, deallocvt, df, dirname, dmesg, du, dumpkmap, dutmp, echo, false, fbset,
60fdflush, find, free, freeramdisk, fsck.minix, grep, gunzip, gzip, halt, 60fdflush, find, free, freeramdisk, fsck.minix, getopt, grep, gunzip, gzip, halt,
61head, hostid, hostname, id, init, insmod, kill, killall, length, ln, 61head, hostid, hostname, id, init, insmod, kill, killall, length, ln,
62loadacm, loadfont, loadkmap, logger, logname, ls, lsmod, makedevs, mkdir, 62loadacm, loadfont, loadkmap, logger, logname, ls, lsmod, makedevs, mkdir,
63mkfifo, mkfs.minix, mknod, mkswap, mktemp, more, mount, mt, mv, nc, 63mkfifo, mkfs.minix, mknod, mkswap, mktemp, more, mount, mt, mv, nc,
@@ -614,6 +614,48 @@ Options:
614 614
615------------------------------- 615-------------------------------
616 616
617=item getopt
618
619Usage: getopt [OPTIONS]...
620
621Parse command options
622
623Options:
624
625 -a, --alternative Allow long options starting with single -\n"
626 -l, --longoptions=longopts Long options to be recognized\n"
627 -n, --name=progname The name under which errors are reported\n"
628 -o, --options=optstring Short options to be recognized\n"
629 -q, --quiet Disable error reporting by getopt(3)\n"
630 -Q, --quiet-output No normal output\n"
631 -s, --shell=shell Set shell quoting conventions\n"
632 -T, --test Test for getopt(1) version\n"
633 -u, --unqote Do not quote the output\n"
634
635Example:
636 $ cat getopt.test
637 #!/bin/sh
638 GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \
639 -n 'example.busybox' -- "$@"`
640 if [ $? != 0 ] ; then exit 1 ; fi
641 eval set -- "$GETOPT"
642 while true ; do
643 case $1 in
644 -a|--a-long) echo "Option a" ; shift ;;
645 -b|--b-long) echo "Option b, argument \`$2'" ; shift 2 ;;
646 -c|--c-long)
647 case "$2" in
648 "") echo "Option c, no argument"; shift 2 ;;
649 *) echo "Option c, argument \`$2'" ; shift 2 ;;
650 esac ;;
651 --) shift ; break ;;
652 *) echo "Internal error!" ; exit 1 ;;
653 esac
654 done
655
656
657-------------------------------
658
617=item grep 659=item grep
618 660
619Usage: grep [OPTIONS]... PATTERN [FILE]... 661Usage: grep [OPTIONS]... PATTERN [FILE]...
@@ -2052,4 +2094,4 @@ Enrique Zanardi <ezanardi@ull.es>
2052 2094
2053=cut 2095=cut
2054 2096
2055# $Id: busybox.pod,v 1.61 2000/08/21 21:18:52 andersen Exp $ 2097# $Id: busybox.pod,v 1.62 2000/08/21 22:02:34 andersen Exp $
diff --git a/docs/busybox.sgml b/docs/busybox.sgml
index 864dbe0ac..f53be8d6f 100644
--- a/docs/busybox.sgml
+++ b/docs/busybox.sgml
@@ -1063,6 +1063,61 @@
1063 </screen> 1063 </screen>
1064 </para> 1064 </para>
1065 </sect1> 1065 </sect1>
1066
1067 <sect1 id="getopt">
1068 <title>getopt</title>
1069
1070 <para>
1071 Usage: getopt [OPTIONS]...
1072 </para>
1073
1074 <para>
1075 Parse command options
1076 </para>
1077
1078 <para>
1079 <screen>
1080 -a, --alternative Allow long options starting with single -\n"
1081 -l, --longoptions=longopts Long options to be recognized\n"
1082 -n, --name=progname The name under which errors are reported\n"
1083 -o, --options=optstring Short options to be recognized\n"
1084 -q, --quiet Disable error reporting by getopt(3)\n"
1085 -Q, --quiet-output No normal output\n"
1086 -s, --shell=shell Set shell quoting conventions\n"
1087 -T, --test Test for getopt(1) version\n"
1088 -u, --unqote Do not quote the output\n"
1089 </screen>
1090 </para>
1091
1092
1093 <para>
1094 Example:
1095 </para>
1096
1097 <para>
1098 <screen>
1099 $ cat getopt.test
1100 #!/bin/sh
1101 GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \
1102 -n 'example.busybox' -- "$@"`
1103 if [ $? != 0 ] ; then exit 1 ; fi
1104 eval set -- "$GETOPT"
1105 while true ; do
1106 case $1 in
1107 -a|--a-long) echo "Option a" ; shift ;;
1108 -b|--b-long) echo "Option b, argument \`$2'" ; shift 2 ;;
1109 -c|--c-long)
1110 case "$2" in
1111 "") echo "Option c, no argument"; shift 2 ;;
1112 *) echo "Option c, argument \`$2'" ; shift 2 ;;
1113 esac ;;
1114 --) shift ; break ;;
1115 *) echo "Internal error!" ; exit 1 ;;
1116 esac
1117 done
1118 </screen>
1119 </para>
1120 </sect1>
1066 1121
1067 <sect1 id="grep"> 1122 <sect1 id="grep">
1068 <title>grep</title> 1123 <title>grep</title>
diff --git a/getopt.c b/getopt.c
new file mode 100644
index 000000000..fb75790d9
--- /dev/null
+++ b/getopt.c
@@ -0,0 +1,416 @@
1/*
2 * getopt.c - Enhanced implementation of BSD getopt(1)
3 * Copyright (c) 1997, 1998, 1999, 2000 Frodo Looijaard <frodol@dds.nl>
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18 */
19
20/*
21 * Version 1.0-b4: Tue Sep 23 1997. First public release.
22 * Version 1.0: Wed Nov 19 1997.
23 * Bumped up the version number to 1.0
24 * Fixed minor typo (CSH instead of TCSH)
25 * Version 1.0.1: Tue Jun 3 1998
26 * Fixed sizeof instead of strlen bug
27 * Bumped up the version number to 1.0.1
28 * Version 1.0.2: Thu Jun 11 1998 (not present)
29 * Fixed gcc-2.8.1 warnings
30 * Fixed --version/-V option (not present)
31 * Version 1.0.5: Tue Jun 22 1999
32 * Make -u option work (not present)
33 * Version 1.0.6: Tue Jun 27 2000
34 * No important changes
35 * Version 1.1.0: Tue Jun 30 2000
36 * Added NLS support (partly written by Arkadiusz Mi<B6>kiewicz
37 * <misiek@misiek.eu.org>)
38 * Ported to Busybox - Alfred M. Szmidt <ams@trillian.itslinux.org>
39 * Removed --version/-V and --help/-h in
40 * Removed prase_error(), using errorMsg() from Busybox instead
41 * Replaced our_malloc with xmalloc and our_realloc with xrealloc
42 *
43 */
44
45#include <stdio.h>
46#include <stdlib.h>
47#include <string.h>
48#include <unistd.h>
49#include <ctype.h>
50#include <getopt.h>
51
52#include "internal.h"
53
54/* NON_OPT is the code that is returned when a non-option is found in '+'
55 mode */
56#define NON_OPT 1
57/* LONG_OPT is the code that is returned when a long option is found. */
58#define LONG_OPT 2
59
60/* The shells recognized. */
61typedef enum {BASH,TCSH} shell_t;
62
63
64/* Some global variables that tells us how to parse. */
65shell_t shell=BASH; /* The shell we generate output for. */
66int quiet_errors=0; /* 0 is not quiet. */
67int quiet_output=0; /* 0 is not quiet. */
68int quote=1; /* 1 is do quote. */
69int alternative=0; /* 0 is getopt_long, 1 is getopt_long_only */
70
71/* Function prototypes */
72const char *normalize(const char *arg);
73int generate_output(char * argv[],int argc,const char *optstr,
74 const struct option *longopts);
75void add_long_options(char *options);
76void add_longopt(const char *name,int has_arg);
77void set_shell(const char *new_shell);
78void set_initial_shell(void);
79
80
81/*
82 * This function 'normalizes' a single argument: it puts single quotes around
83 * it and escapes other special characters. If quote is false, it just
84 * returns its argument.
85 * Bash only needs special treatment for single quotes; tcsh also recognizes
86 * exclamation marks within single quotes, and nukes whitespace.
87 * This function returns a pointer to a buffer that is overwritten by
88 * each call.
89 */
90const char *normalize(const char *arg)
91{
92 static char *BUFFER=NULL;
93 const char *argptr=arg;
94 char *bufptr;
95
96 if (BUFFER != NULL)
97 free(BUFFER);
98
99 if (!quote) { /* Just copy arg */
100 BUFFER=xmalloc(strlen(arg)+1);
101
102 strcpy(BUFFER,arg);
103 return BUFFER;
104 }
105
106 /* Each character in arg may take upto four characters in the result:
107 For a quote we need a closing quote, a backslash, a quote and an
108 opening quote! We need also the global opening and closing quote,
109 and one extra character for '\0'. */
110 BUFFER=xmalloc(strlen(arg)*4+3);
111
112 bufptr=BUFFER;
113 *bufptr++='\'';
114
115 while (*argptr) {
116 if (*argptr == '\'') {
117 /* Quote: replace it with: '\'' */
118 *bufptr++='\'';
119 *bufptr++='\\';
120 *bufptr++='\'';
121 *bufptr++='\'';
122 } else if (shell==TCSH && *argptr=='!') {
123 /* Exclamation mark: replace it with: \! */
124 *bufptr++='\'';
125 *bufptr++='\\';
126 *bufptr++='!';
127 *bufptr++='\'';
128 } else if (shell==TCSH && *argptr=='\n') {
129 /* Newline: replace it with: \n */
130 *bufptr++='\\';
131 *bufptr++='n';
132 } else if (shell==TCSH && isspace(*argptr)) {
133 /* Non-newline whitespace: replace it with \<ws> */
134 *bufptr++='\'';
135 *bufptr++='\\';
136 *bufptr++=*argptr;
137 *bufptr++='\'';
138 } else
139 /* Just copy */
140 *bufptr++=*argptr;
141 argptr++;
142 }
143 *bufptr++='\'';
144 *bufptr++='\0';
145 return BUFFER;
146}
147
148/*
149 * Generate the output. argv[0] is the program name (used for reporting errors).
150 * argv[1..] contains the options to be parsed. argc must be the number of
151 * elements in argv (ie. 1 if there are no options, only the program name),
152 * optstr must contain the short options, and longopts the long options.
153 * Other settings are found in global variables.
154 */
155int generate_output(char * argv[],int argc,const char *optstr,
156 const struct option *longopts)
157{
158 int exit_code = 0; /* We assume everything will be OK */
159 int opt;
160 int longindex;
161 const char *charptr;
162
163 if (quiet_errors) /* No error reporting from getopt(3) */
164 opterr=0;
165 optind=0; /* Reset getopt(3) */
166
167 while ((opt = (alternative?
168 getopt_long_only(argc,argv,optstr,longopts,&longindex):
169 getopt_long(argc,argv,optstr,longopts,&longindex)))
170 != EOF)
171 if (opt == '?' || opt == ':' )
172 exit_code = 1;
173 else if (!quiet_output) {
174 if (opt == LONG_OPT) {
175 printf(" --%s",longopts[longindex].name);
176 if (longopts[longindex].has_arg)
177 printf(" %s",
178 normalize(optarg?optarg:""));
179 } else if (opt == NON_OPT)
180 printf(" %s",normalize(optarg));
181 else {
182 printf(" -%c",opt);
183 charptr = strchr(optstr,opt);
184 if (charptr != NULL && *++charptr == ':')
185 printf(" %s",
186 normalize(optarg?optarg:""));
187 }
188 }
189
190 if (! quiet_output) {
191 printf(" --");
192 while (optind < argc)
193 printf(" %s",normalize(argv[optind++]));
194 printf("\n");
195 }
196 return exit_code;
197}
198
199static struct option *long_options=NULL;
200static int long_options_length=0; /* Length of array */
201static int long_options_nr=0; /* Nr of used elements in array */
202#define LONG_OPTIONS_INCR 10
203#define init_longopt() add_longopt(NULL,0)
204
205/* Register a long option. The contents of name is copied. */
206void add_longopt(const char *name,int has_arg)
207{
208 char *tmp;
209 if (!name) { /* init */
210 free(long_options);
211 long_options=NULL;
212 long_options_length=0;
213 long_options_nr=0;
214 }
215
216 if (long_options_nr == long_options_length) {
217 long_options_length += LONG_OPTIONS_INCR;
218 long_options=xrealloc(long_options,
219 sizeof(struct option) *
220 long_options_length);
221 }
222
223 long_options[long_options_nr].name=NULL;
224 long_options[long_options_nr].has_arg=0;
225 long_options[long_options_nr].flag=NULL;
226 long_options[long_options_nr].val=0;
227
228 if (long_options_nr) { /* Not for init! */
229 long_options[long_options_nr-1].has_arg=has_arg;
230 long_options[long_options_nr-1].flag=NULL;
231 long_options[long_options_nr-1].val=LONG_OPT;
232 tmp = xmalloc(strlen(name)+1);
233 strcpy(tmp,name);
234 long_options[long_options_nr-1].name=tmp;
235 }
236 long_options_nr++;
237}
238
239
240/*
241 * Register several long options. options is a string of long options,
242 * separated by commas or whitespace.
243 * This nukes options!
244 */
245void add_long_options(char *options)
246{
247 int arg_opt;
248 char *tokptr=strtok(options,", \t\n");
249 while (tokptr) {
250 arg_opt=no_argument;
251 if (strlen(tokptr) > 0) {
252 if (tokptr[strlen(tokptr)-1] == ':') {
253 if (tokptr[strlen(tokptr)-2] == ':') {
254 tokptr[strlen(tokptr)-2]='\0';
255 arg_opt=optional_argument;
256 } else {
257 tokptr[strlen(tokptr)-1]='\0';
258 arg_opt=required_argument;
259 }
260 if (strlen(tokptr) == 0)
261 errorMsg("empty long option after -l or --long argument\n");
262 }
263 add_longopt(tokptr,arg_opt);
264 }
265 tokptr=strtok(NULL,", \t\n");
266 }
267}
268
269void set_shell(const char *new_shell)
270{
271 if (!strcmp(new_shell,"bash"))
272 shell=BASH;
273 else if (!strcmp(new_shell,"tcsh"))
274 shell=TCSH;
275 else if (!strcmp(new_shell,"sh"))
276 shell=BASH;
277 else if (!strcmp(new_shell,"csh"))
278 shell=TCSH;
279 else
280 errorMsg("unknown shell after -s or --shell argument\n");
281}
282
283
284/* Exit codes:
285 * 0) No errors, succesful operation.
286 * 1) getopt(3) returned an error.
287 * 2) A problem with parameter parsing for getopt(1).
288 * 3) Internal error, out of memory
289 * 4) Returned for -T
290 */
291
292static struct option longopts[]=
293{
294 {"options",required_argument,NULL,'o'},
295 {"longoptions",required_argument,NULL,'l'},
296 {"quiet",no_argument,NULL,'q'},
297 {"quiet-output",no_argument,NULL,'Q'},
298 {"shell",required_argument,NULL,'s'},
299 {"test",no_argument,NULL,'T'},
300 {"unquoted",no_argument,NULL,'u'},
301 {"alternative",no_argument,NULL,'a'},
302 {"name",required_argument,NULL,'n'},
303 {NULL,0,NULL,0}
304};
305
306/* Stop scanning as soon as a non-option argument is found! */
307static const char *shortopts="+ao:l:n:qQs:Tu";
308
309static const char getopt_usage[] =
310"getopt [OPTIONS]...\n"
311#ifndef BB_FEATURE_TRIVIAL_HELP
312"Parse command options\n"
313" -a, --alternative Allow long options starting with single -\n"
314" -l, --longoptions=longopts Long options to be recognized\n"
315" -n, --name=progname The name under which errors are reported\n"
316" -o, --options=optstring Short options to be recognized\n"
317" -q, --quiet Disable error reporting by getopt(3)\n"
318" -Q, --quiet-output No normal output\n"
319" -s, --shell=shell Set shell quoting conventions\n"
320" -T, --test Test for getopt(1) version\n"
321" -u, --unqote Do not quote the output\n"
322#endif
323;
324
325
326int getopt_main(int argc, char *argv[])
327{
328 char *optstr=NULL;
329 char *name=NULL;
330 int opt;
331 int compatible=0;
332
333 init_longopt();
334
335 if (getenv("GETOPT_COMPATIBLE"))
336 compatible=1;
337
338 if (argc == 1) {
339 if (compatible) {
340 /* For some reason, the original getopt gave no error
341 when there were no arguments. */
342 printf(" --\n");
343 exit(0);
344 } else
345 fatalError("missing optstring argument\n");
346 }
347
348 if (argv[1][0] != '-' || compatible) {
349 quote=0;
350 optstr=xmalloc(strlen(argv[1])+1);
351 strcpy(optstr,argv[1]+strspn(argv[1],"-+"));
352 argv[1]=argv[0];
353 exit(generate_output(argv+1,argc-1,optstr,long_options));
354 }
355
356 while ((opt=getopt_long(argc,argv,shortopts,longopts,NULL)) != EOF)
357 switch (opt) {
358 case 'a':
359 alternative=1;
360 break;
361 case 'o':
362 if (optstr)
363 free(optstr);
364 optstr=xmalloc(strlen(optarg)+1);
365 strcpy(optstr,optarg);
366 break;
367 case 'l':
368 add_long_options(optarg);
369 break;
370 case 'n':
371 if (name)
372 free(name);
373 name=xmalloc(strlen(optarg)+1);
374 strcpy(name,optarg);
375 break;
376 case 'q':
377 quiet_errors=1;
378 break;
379 case 'Q':
380 quiet_output=1;
381 break;
382 case 's':
383 set_shell(optarg);
384 break;
385 case 'T':
386 exit(4);
387 case 'u':
388 quote=0;
389 break;
390 default:
391 usage(getopt_usage);
392 }
393
394 if (!optstr) {
395 if (optind >= argc)
396 fatalError("missing optstring argument\n");
397 else {
398 optstr=xmalloc(strlen(argv[optind])+1);
399 strcpy(optstr,argv[optind]);
400 optind++;
401 }
402 }
403 if (name)
404 argv[optind-1]=name;
405 else
406 argv[optind-1]=argv[0];
407 exit(generate_output(argv+optind-1,argc-optind+1,optstr,long_options));
408}
409
410/*
411 Local Variables:
412 c-file-style: "linux"
413 c-basic-offset: 4
414 tab-width: 4
415 End:
416*/
diff --git a/internal.h b/internal.h
index a47274342..939384c42 100644
--- a/internal.h
+++ b/internal.h
@@ -137,6 +137,7 @@ extern int fsck_minix_main(int argc, char **argv);
137extern int find_main(int argc, char** argv); 137extern int find_main(int argc, char** argv);
138extern int free_main(int argc, char** argv); 138extern int free_main(int argc, char** argv);
139extern int freeramdisk_main(int argc, char** argv); 139extern int freeramdisk_main(int argc, char** argv);
140extern int getopt_main(int argc, char** argv);
140extern int grep_main(int argc, char** argv); 141extern int grep_main(int argc, char** argv);
141extern int gunzip_main (int argc, char** argv); 142extern int gunzip_main (int argc, char** argv);
142extern int gzip_main(int argc, char** argv); 143extern int gzip_main(int argc, char** argv);
diff --git a/util-linux/getopt.c b/util-linux/getopt.c
new file mode 100644
index 000000000..fb75790d9
--- /dev/null
+++ b/util-linux/getopt.c
@@ -0,0 +1,416 @@
1/*
2 * getopt.c - Enhanced implementation of BSD getopt(1)
3 * Copyright (c) 1997, 1998, 1999, 2000 Frodo Looijaard <frodol@dds.nl>
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18 */
19
20/*
21 * Version 1.0-b4: Tue Sep 23 1997. First public release.
22 * Version 1.0: Wed Nov 19 1997.
23 * Bumped up the version number to 1.0
24 * Fixed minor typo (CSH instead of TCSH)
25 * Version 1.0.1: Tue Jun 3 1998
26 * Fixed sizeof instead of strlen bug
27 * Bumped up the version number to 1.0.1
28 * Version 1.0.2: Thu Jun 11 1998 (not present)
29 * Fixed gcc-2.8.1 warnings
30 * Fixed --version/-V option (not present)
31 * Version 1.0.5: Tue Jun 22 1999
32 * Make -u option work (not present)
33 * Version 1.0.6: Tue Jun 27 2000
34 * No important changes
35 * Version 1.1.0: Tue Jun 30 2000
36 * Added NLS support (partly written by Arkadiusz Mi<B6>kiewicz
37 * <misiek@misiek.eu.org>)
38 * Ported to Busybox - Alfred M. Szmidt <ams@trillian.itslinux.org>
39 * Removed --version/-V and --help/-h in
40 * Removed prase_error(), using errorMsg() from Busybox instead
41 * Replaced our_malloc with xmalloc and our_realloc with xrealloc
42 *
43 */
44
45#include <stdio.h>
46#include <stdlib.h>
47#include <string.h>
48#include <unistd.h>
49#include <ctype.h>
50#include <getopt.h>
51
52#include "internal.h"
53
54/* NON_OPT is the code that is returned when a non-option is found in '+'
55 mode */
56#define NON_OPT 1
57/* LONG_OPT is the code that is returned when a long option is found. */
58#define LONG_OPT 2
59
60/* The shells recognized. */
61typedef enum {BASH,TCSH} shell_t;
62
63
64/* Some global variables that tells us how to parse. */
65shell_t shell=BASH; /* The shell we generate output for. */
66int quiet_errors=0; /* 0 is not quiet. */
67int quiet_output=0; /* 0 is not quiet. */
68int quote=1; /* 1 is do quote. */
69int alternative=0; /* 0 is getopt_long, 1 is getopt_long_only */
70
71/* Function prototypes */
72const char *normalize(const char *arg);
73int generate_output(char * argv[],int argc,const char *optstr,
74 const struct option *longopts);
75void add_long_options(char *options);
76void add_longopt(const char *name,int has_arg);
77void set_shell(const char *new_shell);
78void set_initial_shell(void);
79
80
81/*
82 * This function 'normalizes' a single argument: it puts single quotes around
83 * it and escapes other special characters. If quote is false, it just
84 * returns its argument.
85 * Bash only needs special treatment for single quotes; tcsh also recognizes
86 * exclamation marks within single quotes, and nukes whitespace.
87 * This function returns a pointer to a buffer that is overwritten by
88 * each call.
89 */
90const char *normalize(const char *arg)
91{
92 static char *BUFFER=NULL;
93 const char *argptr=arg;
94 char *bufptr;
95
96 if (BUFFER != NULL)
97 free(BUFFER);
98
99 if (!quote) { /* Just copy arg */
100 BUFFER=xmalloc(strlen(arg)+1);
101
102 strcpy(BUFFER,arg);
103 return BUFFER;
104 }
105
106 /* Each character in arg may take upto four characters in the result:
107 For a quote we need a closing quote, a backslash, a quote and an
108 opening quote! We need also the global opening and closing quote,
109 and one extra character for '\0'. */
110 BUFFER=xmalloc(strlen(arg)*4+3);
111
112 bufptr=BUFFER;
113 *bufptr++='\'';
114
115 while (*argptr) {
116 if (*argptr == '\'') {
117 /* Quote: replace it with: '\'' */
118 *bufptr++='\'';
119 *bufptr++='\\';
120 *bufptr++='\'';
121 *bufptr++='\'';
122 } else if (shell==TCSH && *argptr=='!') {
123 /* Exclamation mark: replace it with: \! */
124 *bufptr++='\'';
125 *bufptr++='\\';
126 *bufptr++='!';
127 *bufptr++='\'';
128 } else if (shell==TCSH && *argptr=='\n') {
129 /* Newline: replace it with: \n */
130 *bufptr++='\\';
131 *bufptr++='n';
132 } else if (shell==TCSH && isspace(*argptr)) {
133 /* Non-newline whitespace: replace it with \<ws> */
134 *bufptr++='\'';
135 *bufptr++='\\';
136 *bufptr++=*argptr;
137 *bufptr++='\'';
138 } else
139 /* Just copy */
140 *bufptr++=*argptr;
141 argptr++;
142 }
143 *bufptr++='\'';
144 *bufptr++='\0';
145 return BUFFER;
146}
147
148/*
149 * Generate the output. argv[0] is the program name (used for reporting errors).
150 * argv[1..] contains the options to be parsed. argc must be the number of
151 * elements in argv (ie. 1 if there are no options, only the program name),
152 * optstr must contain the short options, and longopts the long options.
153 * Other settings are found in global variables.
154 */
155int generate_output(char * argv[],int argc,const char *optstr,
156 const struct option *longopts)
157{
158 int exit_code = 0; /* We assume everything will be OK */
159 int opt;
160 int longindex;
161 const char *charptr;
162
163 if (quiet_errors) /* No error reporting from getopt(3) */
164 opterr=0;
165 optind=0; /* Reset getopt(3) */
166
167 while ((opt = (alternative?
168 getopt_long_only(argc,argv,optstr,longopts,&longindex):
169 getopt_long(argc,argv,optstr,longopts,&longindex)))
170 != EOF)
171 if (opt == '?' || opt == ':' )
172 exit_code = 1;
173 else if (!quiet_output) {
174 if (opt == LONG_OPT) {
175 printf(" --%s",longopts[longindex].name);
176 if (longopts[longindex].has_arg)
177 printf(" %s",
178 normalize(optarg?optarg:""));
179 } else if (opt == NON_OPT)
180 printf(" %s",normalize(optarg));
181 else {
182 printf(" -%c",opt);
183 charptr = strchr(optstr,opt);
184 if (charptr != NULL && *++charptr == ':')
185 printf(" %s",
186 normalize(optarg?optarg:""));
187 }
188 }
189
190 if (! quiet_output) {
191 printf(" --");
192 while (optind < argc)
193 printf(" %s",normalize(argv[optind++]));
194 printf("\n");
195 }
196 return exit_code;
197}
198
199static struct option *long_options=NULL;
200static int long_options_length=0; /* Length of array */
201static int long_options_nr=0; /* Nr of used elements in array */
202#define LONG_OPTIONS_INCR 10
203#define init_longopt() add_longopt(NULL,0)
204
205/* Register a long option. The contents of name is copied. */
206void add_longopt(const char *name,int has_arg)
207{
208 char *tmp;
209 if (!name) { /* init */
210 free(long_options);
211 long_options=NULL;
212 long_options_length=0;
213 long_options_nr=0;
214 }
215
216 if (long_options_nr == long_options_length) {
217 long_options_length += LONG_OPTIONS_INCR;
218 long_options=xrealloc(long_options,
219 sizeof(struct option) *
220 long_options_length);
221 }
222
223 long_options[long_options_nr].name=NULL;
224 long_options[long_options_nr].has_arg=0;
225 long_options[long_options_nr].flag=NULL;
226 long_options[long_options_nr].val=0;
227
228 if (long_options_nr) { /* Not for init! */
229 long_options[long_options_nr-1].has_arg=has_arg;
230 long_options[long_options_nr-1].flag=NULL;
231 long_options[long_options_nr-1].val=LONG_OPT;
232 tmp = xmalloc(strlen(name)+1);
233 strcpy(tmp,name);
234 long_options[long_options_nr-1].name=tmp;
235 }
236 long_options_nr++;
237}
238
239
240/*
241 * Register several long options. options is a string of long options,
242 * separated by commas or whitespace.
243 * This nukes options!
244 */
245void add_long_options(char *options)
246{
247 int arg_opt;
248 char *tokptr=strtok(options,", \t\n");
249 while (tokptr) {
250 arg_opt=no_argument;
251 if (strlen(tokptr) > 0) {
252 if (tokptr[strlen(tokptr)-1] == ':') {
253 if (tokptr[strlen(tokptr)-2] == ':') {
254 tokptr[strlen(tokptr)-2]='\0';
255 arg_opt=optional_argument;
256 } else {
257 tokptr[strlen(tokptr)-1]='\0';
258 arg_opt=required_argument;
259 }
260 if (strlen(tokptr) == 0)
261 errorMsg("empty long option after -l or --long argument\n");
262 }
263 add_longopt(tokptr,arg_opt);
264 }
265 tokptr=strtok(NULL,", \t\n");
266 }
267}
268
269void set_shell(const char *new_shell)
270{
271 if (!strcmp(new_shell,"bash"))
272 shell=BASH;
273 else if (!strcmp(new_shell,"tcsh"))
274 shell=TCSH;
275 else if (!strcmp(new_shell,"sh"))
276 shell=BASH;
277 else if (!strcmp(new_shell,"csh"))
278 shell=TCSH;
279 else
280 errorMsg("unknown shell after -s or --shell argument\n");
281}
282
283
284/* Exit codes:
285 * 0) No errors, succesful operation.
286 * 1) getopt(3) returned an error.
287 * 2) A problem with parameter parsing for getopt(1).
288 * 3) Internal error, out of memory
289 * 4) Returned for -T
290 */
291
292static struct option longopts[]=
293{
294 {"options",required_argument,NULL,'o'},
295 {"longoptions",required_argument,NULL,'l'},
296 {"quiet",no_argument,NULL,'q'},
297 {"quiet-output",no_argument,NULL,'Q'},
298 {"shell",required_argument,NULL,'s'},
299 {"test",no_argument,NULL,'T'},
300 {"unquoted",no_argument,NULL,'u'},
301 {"alternative",no_argument,NULL,'a'},
302 {"name",required_argument,NULL,'n'},
303 {NULL,0,NULL,0}
304};
305
306/* Stop scanning as soon as a non-option argument is found! */
307static const char *shortopts="+ao:l:n:qQs:Tu";
308
309static const char getopt_usage[] =
310"getopt [OPTIONS]...\n"
311#ifndef BB_FEATURE_TRIVIAL_HELP
312"Parse command options\n"
313" -a, --alternative Allow long options starting with single -\n"
314" -l, --longoptions=longopts Long options to be recognized\n"
315" -n, --name=progname The name under which errors are reported\n"
316" -o, --options=optstring Short options to be recognized\n"
317" -q, --quiet Disable error reporting by getopt(3)\n"
318" -Q, --quiet-output No normal output\n"
319" -s, --shell=shell Set shell quoting conventions\n"
320" -T, --test Test for getopt(1) version\n"
321" -u, --unqote Do not quote the output\n"
322#endif
323;
324
325
326int getopt_main(int argc, char *argv[])
327{
328 char *optstr=NULL;
329 char *name=NULL;
330 int opt;
331 int compatible=0;
332
333 init_longopt();
334
335 if (getenv("GETOPT_COMPATIBLE"))
336 compatible=1;
337
338 if (argc == 1) {
339 if (compatible) {
340 /* For some reason, the original getopt gave no error
341 when there were no arguments. */
342 printf(" --\n");
343 exit(0);
344 } else
345 fatalError("missing optstring argument\n");
346 }
347
348 if (argv[1][0] != '-' || compatible) {
349 quote=0;
350 optstr=xmalloc(strlen(argv[1])+1);
351 strcpy(optstr,argv[1]+strspn(argv[1],"-+"));
352 argv[1]=argv[0];
353 exit(generate_output(argv+1,argc-1,optstr,long_options));
354 }
355
356 while ((opt=getopt_long(argc,argv,shortopts,longopts,NULL)) != EOF)
357 switch (opt) {
358 case 'a':
359 alternative=1;
360 break;
361 case 'o':
362 if (optstr)
363 free(optstr);
364 optstr=xmalloc(strlen(optarg)+1);
365 strcpy(optstr,optarg);
366 break;
367 case 'l':
368 add_long_options(optarg);
369 break;
370 case 'n':
371 if (name)
372 free(name);
373 name=xmalloc(strlen(optarg)+1);
374 strcpy(name,optarg);
375 break;
376 case 'q':
377 quiet_errors=1;
378 break;
379 case 'Q':
380 quiet_output=1;
381 break;
382 case 's':
383 set_shell(optarg);
384 break;
385 case 'T':
386 exit(4);
387 case 'u':
388 quote=0;
389 break;
390 default:
391 usage(getopt_usage);
392 }
393
394 if (!optstr) {
395 if (optind >= argc)
396 fatalError("missing optstring argument\n");
397 else {
398 optstr=xmalloc(strlen(argv[optind])+1);
399 strcpy(optstr,argv[optind]);
400 optind++;
401 }
402 }
403 if (name)
404 argv[optind-1]=name;
405 else
406 argv[optind-1]=argv[0];
407 exit(generate_output(argv+optind-1,argc-optind+1,optstr,long_options));
408}
409
410/*
411 Local Variables:
412 c-file-style: "linux"
413 c-basic-offset: 4
414 tab-width: 4
415 End:
416*/
generated by cgit v1.2.3-55-g6feb (git 2.39.1) at 2025-03-29 03:58:20 +0000