1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470
|
/*
getopt.c - Enhanced implementation of BSD getopt(1)
Copyright (c) 1997-2005 Frodo Looijaard <frodo@frodo.looijaard.name>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
/*
* Version 1.0-b4: Tue Sep 23 1997. First public release.
* Version 1.0: Wed Nov 19 1997.
* Bumped up the version number to 1.0
* Fixed minor typo (CSH instead of TCSH)
* Version 1.0.1: Tue Jun 3 1998
* Fixed sizeof instead of strlen bug
* Bumped up the version number to 1.0.1
* Version 1.0.2: Thu Jun 11 1998 (not present)
* Fixed gcc-2.8.1 warnings
* Fixed --version/-V option (not present)
* Version 1.0.5: Tue Jun 22 1999
* Make -u option work (not present)
* Version 1.0.6: Tue Jun 27 2000
* No important changes
* Version 1.1.0: Tue Jun 30 2000
* Added NLS support (partly written by Arkadiusz Mi<B6>kiewicz
* <misiek@pld.org.pl>)
* Version 1.1.4: Mon Nov 7 2005
* Fixed a few type's in the manpage
*/
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <ctype.h>
#if LIBCGETOPT
#include <getopt.h>
#else
#include "getopt.h"
#endif
#include "nls.h"
/* NON_OPT is the code that is returned when a non-option is found in '+'
mode */
#define NON_OPT 1
/* LONG_OPT is the code that is returned when a long option is found. */
#define LONG_OPT 2
/* The shells recognized. */
typedef enum {BASH,TCSH} shell_t;
/* Some global variables that tells us how to parse. */
shell_t shell=BASH; /* The shell we generate output for. */
int quiet_errors=0; /* 0 is not quiet. */
int quiet_output=0; /* 0 is not quiet. */
int quote=1; /* 1 is do quote. */
int alternative=0; /* 0 is getopt_long, 1 is getopt_long_only */
/* Function prototypes */
void *our_malloc(size_t size);
void *our_realloc(void *ptr, size_t size);
const char *normalize(const char *arg);
int generate_output(char * argv[],int argc,const char *optstr,
const struct option *longopts);
int main(int argc, char *argv[]);
void parse_error(const char *message);
void add_long_options(char *options);
void add_longopt(const char *name,int has_arg);
void print_help(void);
void set_shell(const char *new_shell);
void set_initial_shell(void);
void *our_malloc(size_t size)
{
void *ret=malloc(size);
if (! ret) {
fprintf(stderr,_("%s: Out of memory!\n"),"getopt");
exit(3);
}
return(ret);
}
void *our_realloc(void *ptr, size_t size)
{
void *ret=realloc(ptr,size);
if (! ret && size) {
fprintf(stderr,_("%s: Out of memory!\n"),"getopt");
exit(3);
}
return(ret);
}
/*
* This function 'normalizes' a single argument: it puts single quotes around
* it and escapes other special characters. If quote is false, it just
* returns its argument.
* Bash only needs special treatment for single quotes; tcsh also recognizes
* exclamation marks within single quotes, and nukes whitespace.
* This function returns a pointer to a buffer that is overwritten by
* each call.
*/
const char *normalize(const char *arg)
{
static char *BUFFER=NULL;
const char *argptr=arg;
char *bufptr;
if (BUFFER != NULL)
free(BUFFER);
if (!quote) { /* Just copy arg */
BUFFER=our_malloc(strlen(arg)+1);
strcpy(BUFFER,arg);
return BUFFER;
}
/* Each character in arg may take upto four characters in the result:
For a quote we need a closing quote, a backslash, a quote and an
opening quote! We need also the global opening and closing quote,
and one extra character for '\0'. */
BUFFER=our_malloc(strlen(arg)*4+3);
bufptr=BUFFER;
*bufptr++='\'';
while (*argptr) {
if (*argptr == '\'') {
/* Quote: replace it with: '\'' */
*bufptr++='\'';
*bufptr++='\\';
*bufptr++='\'';
*bufptr++='\'';
} else if (shell==TCSH && *argptr=='!') {
/* Exclamation mark: replace it with: \! */
*bufptr++='\'';
*bufptr++='\\';
*bufptr++='!';
*bufptr++='\'';
} else if (shell==TCSH && *argptr=='\n') {
/* Newline: replace it with: \n */
*bufptr++='\\';
*bufptr++='n';
} else if (shell==TCSH && isspace(*argptr)) {
/* Non-newline whitespace: replace it with \<ws> */
*bufptr++='\'';
*bufptr++='\\';
*bufptr++=*argptr;
*bufptr++='\'';
} else
/* Just copy */
*bufptr++=*argptr;
argptr++;
}
*bufptr++='\'';
*bufptr++='\0';
return BUFFER;
}
/*
* Generate the output. argv[0] is the program name (used for reporting errors).
* argv[1..] contains the options to be parsed. argc must be the number of
* elements in argv (ie. 1 if there are no options, only the program name),
* optstr must contain the short options, and longopts the long options.
* Other settings are found in global variables.
*/
int generate_output(char * argv[],int argc,const char *optstr,
const struct option *longopts)
{
int exit_code = 0; /* We assume everything will be OK */
int opt;
int longindex;
const char *charptr;
if (quiet_errors) /* No error reporting from getopt(3) */
opterr=0;
optind=0; /* Reset getopt(3) */
while ((opt = (alternative?
getopt_long_only(argc,argv,optstr,longopts,&longindex):
getopt_long(argc,argv,optstr,longopts,&longindex)))
!= EOF)
if (opt == '?' || opt == ':' )
exit_code = 1;
else if (!quiet_output)
{
if (opt == LONG_OPT) {
printf(" --%s",longopts[longindex].name);
if (longopts[longindex].has_arg)
printf(" %s",
normalize(optarg?optarg:""));
} else if (opt == NON_OPT)
printf(" %s",normalize(optarg));
else {
printf(" -%c",opt);
charptr = strchr(optstr,opt);
if (charptr != NULL && *++charptr == ':')
printf(" %s",
normalize(optarg?optarg:""));
}
}
if (! quiet_output) {
printf(" --");
while (optind < argc)
printf(" %s",normalize(argv[optind++]));
printf("\n");
}
return exit_code;
}
/*
* Report an error when parsing getopt's own arguments.
* If message is NULL, we already sent a message, we just exit with a helpful
* hint.
*/
void parse_error(const char *message)
{
if (message)
fprintf(stderr,"getopt: %s\n",message);
fputs(_("Try `getopt --help' for more information.\n"),stderr);
exit(2);
}
static struct option *long_options=NULL;
static int long_options_length=0; /* Length of array */
static int long_options_nr=0; /* Nr of used elements in array */
#define LONG_OPTIONS_INCR 10
#define init_longopt() add_longopt(NULL,0)
/* Register a long option. The contents of name is copied. */
void add_longopt(const char *name,int has_arg)
{
char *tmp;
if (!name) { /* init */
free(long_options);
long_options=NULL;
long_options_length=0;
long_options_nr=0;
}
if (long_options_nr == long_options_length) {
long_options_length += LONG_OPTIONS_INCR;
long_options=our_realloc(long_options,
sizeof(struct option) *
long_options_length);
}
long_options[long_options_nr].name=NULL;
long_options[long_options_nr].has_arg=0;
long_options[long_options_nr].flag=NULL;
long_options[long_options_nr].val=0;
if (long_options_nr) { /* Not for init! */
long_options[long_options_nr-1].has_arg=has_arg;
long_options[long_options_nr-1].flag=NULL;
long_options[long_options_nr-1].val=LONG_OPT;
tmp = our_malloc(strlen(name)+1);
strcpy(tmp,name);
long_options[long_options_nr-1].name=tmp;
}
long_options_nr++;
}
/*
* Register several long options. options is a string of long options,
* separated by commas or whitespace.
* This nukes options!
*/
void add_long_options(char *options)
{
int arg_opt;
char *tokptr=strtok(options,", \t\n");
while (tokptr) {
arg_opt=no_argument;
if (strlen(tokptr) > 0) {
if (tokptr[strlen(tokptr)-1] == ':') {
if (tokptr[strlen(tokptr)-2] == ':') {
tokptr[strlen(tokptr)-2]='\0';
arg_opt=optional_argument;
} else {
tokptr[strlen(tokptr)-1]='\0';
arg_opt=required_argument;
}
if (strlen(tokptr) == 0)
parse_error(_("empty long option after "
"-l or --long argument"));
}
add_longopt(tokptr,arg_opt);
}
tokptr=strtok(NULL,", \t\n");
}
}
void set_shell(const char *new_shell)
{
if (!strcmp(new_shell,"bash"))
shell=BASH;
else if (!strcmp(new_shell,"tcsh"))
shell=TCSH;
else if (!strcmp(new_shell,"sh"))
shell=BASH;
else if (!strcmp(new_shell,"csh"))
shell=TCSH;
else
parse_error(_("unknown shell after -s or --shell argument"));
}
void print_help(void)
{
fputs(_("Usage: getopt optstring parameters\n"),stderr);
fputs(_(" getopt [options] [--] optstring parameters\n"),stderr);
fputs(_(" getopt [options] -o|--options optstring [options] [--]\n"),stderr);
fputs(_(" parameters\n"),stderr);
fputs(_(" -a, --alternative Allow long options starting with single -\n"),stderr);
fputs(_(" -h, --help This small usage guide\n"),stderr);
fputs(_(" -l, --longoptions=longopts Long options to be recognized\n"),stderr);
fputs(_(" -n, --name=progname The name under which errors are reported\n"),stderr);
fputs(_(" -o, --options=optstring Short options to be recognized\n"),stderr);
fputs(_(" -q, --quiet Disable error reporting by getopt(3)\n"),stderr);
fputs(_(" -Q, --quiet-output No normal output\n"),stderr);
fputs(_(" -s, --shell=shell Set shell quoting conventions\n"),stderr);
fputs(_(" -T, --test Test for getopt(1) version\n"),stderr);
fputs(_(" -u, --unqote Do not quote the output\n"),stderr);
fputs(_(" -V, --version Output version information\n"),stderr);
exit(2);
}
/* Exit codes:
* 0) No errors, succesful operation.
* 1) getopt(3) returned an error.
* 2) A problem with parameter parsing for getopt(1).
* 3) Internal error, out of memory
* 4) Returned for -T
*/
static struct option longopts[]={ {"options",required_argument,NULL,'o'},
{"longoptions",required_argument,NULL,'l'},
{"quiet",no_argument,NULL,'q'},
{"quiet-output",no_argument,NULL,'Q'},
{"shell",required_argument,NULL,'s'},
{"test",no_argument,NULL,'T'},
{"unquoted",no_argument,NULL,'u'},
{"help",no_argument,NULL,'h'},
{"alternative",no_argument,NULL,'a'},
{"name",required_argument,NULL,'n'},
{"version",no_argument,NULL,'V'},
{NULL,0,NULL,0}
};
/* Stop scanning as soon as a non-option argument is found! */
static const char *shortopts="+ao:l:n:qQs:TuhV";
int main(int argc, char *argv[])
{
char *optstr=NULL;
char *name=NULL;
int opt;
int compatible=0;
#if WITHOUT_GETTEXT
#else
setlocale(LC_ALL,"");
bindtextdomain(PACKAGE, LOCALEDIR);
textdomain(PACKAGE);
#endif
init_longopt();
if (getenv("GETOPT_COMPATIBLE"))
compatible=1;
if (argc == 1)
{
if (compatible) {
/* For some reason, the original getopt gave no error
when there were no arguments. */
printf(" --\n");
exit(0);
}
else
parse_error(_("missing optstring argument"));
}
if (argv[1][0] != '-' || compatible) {
quote=0;
optstr=our_malloc(strlen(argv[1])+1);
strcpy(optstr,argv[1]+strspn(argv[1],"-+"));
argv[1]=argv[0];
exit(generate_output(argv+1,argc-1,optstr,long_options));
}
while ((opt=getopt_long(argc,argv,shortopts,longopts,NULL)) != EOF)
switch (opt) {
case 'a':
alternative=1;
break;
case 'h':
print_help();
exit(0);
case 'o':
if (optstr)
free(optstr);
optstr=our_malloc(strlen(optarg)+1);
strcpy(optstr,optarg);
break;
case 'l':
add_long_options(optarg);
break;
case 'n':
if (name)
free(name);
name=our_malloc(strlen(optarg)+1);
strcpy(name,optarg);
break;
case 'q':
quiet_errors=1;
break;
case 'Q':
quiet_output=1;
break;
case 's':
set_shell(optarg);
break;
case 'T':
exit(4);
case 'u':
quote=0;
break;
case 'V':
printf(_("getopt (enhanced) 1.1.4\n"));
exit(0);
case '?':
case ':':
parse_error(NULL);
default:
parse_error(_("internal error, contact the author."));
}
if (!optstr)
{
if (optind >= argc)
parse_error(_("missing optstring argument"));
else {
optstr=our_malloc(strlen(argv[optind])+1);
strcpy(optstr,argv[optind]);
optind++;
}
}
if (name)
argv[optind-1]=name;
else
argv[optind-1]=argv[0];
exit(generate_output(argv+optind-1,argc-optind+1,optstr,long_options));
}
|