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