Commit 021c0221 authored by Josh Coalson's avatar Josh Coalson
Browse files

specialize getopt for FLAC

parent 8ba563d4
/*
NOTE:
I cannot get the vanilla getopt code to work (i.e. compile only what
is needed and not duplicate symbols found in the standard library)
on all the platforms that FLAC supports. In particular the gating
of code with the ELIDE_CODE #define is not accurate enough on systems
that are POSIX but not glibc. If someone has a patch that works on
GNU/Linux, Darwin, AND Solaris please submit it on the project page:
http://sourceforge.net/projects/flac
In the meantime I have munged the global symbols and remove gates
around code, while at the same time trying to touch the original as
little as possible.
*/
/* Declarations for getopt.
Copyright (C) 1989,90,91,92,93,94,96,97,98 Free Software Foundation, Inc.
This file is part of the GNU C Library.
......@@ -17,70 +31,71 @@
write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA. */
#ifndef _GETOPT_H
#ifndef FLAC__SHARE__GETOPT_H
#define FLAC__SHARE__GETOPT_H
#ifndef __need_getopt
# define _GETOPT_H 1
#endif
/*[JEC] was:#ifndef __need_getopt*/
/*[JEC] was:# define _GETOPT_H 1*/
/*[JEC] was:#endif*/
#ifdef __cplusplus
extern "C" {
#endif
/* For communication from `getopt' to the caller.
When `getopt' finds an option that takes an argument,
/* For communication from `FLAC__share__getopt' to the caller.
When `FLAC__share__getopt' finds an option that takes an argument,
the argument value is returned here.
Also, when `ordering' is RETURN_IN_ORDER,
each non-option ARGV-element is returned here. */
extern char *optarg;
extern char *FLAC__share__optarg;
/* Index in ARGV of the next element to be scanned.
This is used for communication to and from the caller
and for communication between successive calls to `getopt'.
and for communication between successive calls to `FLAC__share__getopt'.
On entry to `getopt', zero means this is the first call; initialize.
On entry to `FLAC__share__getopt', zero means this is the first call; initialize.
When `getopt' returns -1, this is the index of the first of the
When `FLAC__share__getopt' returns -1, this is the index of the first of the
non-option elements that the caller should itself scan.
Otherwise, `optind' communicates from one call to the next
Otherwise, `FLAC__share__optind' communicates from one call to the next
how much of ARGV has been scanned so far. */
extern int optind;
extern int FLAC__share__optind;
/* Callers store zero here to inhibit the error message `getopt' prints
/* Callers store zero here to inhibit the error message `FLAC__share__getopt' prints
for unrecognized options. */
extern int opterr;
extern int FLAC__share__opterr;
/* Set to an option character which was unrecognized. */
extern int optopt;
extern int FLAC__share__optopt;
#ifndef __need_getopt
/*[JEC] was:#ifndef __need_getopt */
/* Describe the long-named options requested by the application.
The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
of `struct option' terminated by an element containing a name which is
The LONG_OPTIONS argument to FLAC__share__getopt_long or FLAC__share__getopt_long_only is a vector
of `struct FLAC__share__option' terminated by an element containing a name which is
zero.
The field `has_arg' is:
no_argument (or 0) if the option does not take an argument,
required_argument (or 1) if the option requires an argument,
optional_argument (or 2) if the option takes an optional argument.
FLAC__share__no_argument (or 0) if the option does not take an argument,
FLAC__share__required_argument (or 1) if the option requires an argument,
FLAC__share__optional_argument (or 2) if the option takes an optional argument.
If the field `flag' is not NULL, it points to a variable that is set
to the value given in the field `val' when the option is found, but
left unchanged if the option is not found.
To have a long-named option do something other than set an `int' to
a compiled-in constant, such as set a value from `optarg', set the
a compiled-in constant, such as set a value from `FLAC__share__optarg', set the
option's `flag' field to zero and its `val' field to a nonzero
value (the equivalent single-letter option character, if there is
one). For long options that have a zero `flag' field, `getopt'
one). For long options that have a zero `flag' field, `FLAC__share__getopt'
returns the contents of the `val' field. */
struct option
struct FLAC__share__option
{
# if defined __STDC__ && __STDC__
const char *name;
......@@ -94,12 +109,12 @@ struct option
int val;
};
/* Names for the values of the `has_arg' field of `struct option'. */
/* Names for the values of the `has_arg' field of `struct FLAC__share__option'. */
# define no_argument 0
# define required_argument 1
# define optional_argument 2
#endif /* need getopt */
# define FLAC__share__no_argument 0
# define FLAC__share__required_argument 1
# define FLAC__share__optional_argument 2
/*[JEC] was:#endif*/ /* need getopt */
/* Get definitions and prototypes for functions to process the
......@@ -108,62 +123,62 @@ struct option
Return the option character from OPTS just read. Return -1 when
there are no more options. For unrecognized options, or options
missing arguments, `optopt' is set to the option letter, and '?' is
missing arguments, `FLAC__share__optopt' is set to the option letter, and '?' is
returned.
The OPTS string is a list of characters which are recognized option
letters, optionally followed by colons, specifying that that letter
takes an argument, to be placed in `optarg'.
takes an argument, to be placed in `FLAC__share__optarg'.
If a letter in OPTS is followed by two colons, its argument is
optional. This behavior is specific to the GNU `getopt'.
optional. This behavior is specific to the GNU `FLAC__share__getopt'.
The argument `--' causes premature termination of argument
scanning, explicitly telling `getopt' that there are no more
scanning, explicitly telling `FLAC__share__getopt' that there are no more
options.
If OPTS begins with `--', then non-option arguments are treated as
arguments to the option '\0'. This behavior is specific to the GNU
`getopt'. */
`FLAC__share__getopt'. */
#if defined __STDC__ && __STDC__
# ifdef __GNU_LIBRARY__
/*[JEC] was:#if defined __STDC__ && __STDC__*/
/*[JEC] was:# ifdef __GNU_LIBRARY__*/
/* Many other libraries have conflicting prototypes for getopt, with
differences in the consts, in stdlib.h. To avoid compilation
errors, only prototype getopt for the GNU C library. */
extern int getopt (int __argc, char *const *__argv, const char *__shortopts);
# else /* not __GNU_LIBRARY__ */
extern int getopt ();
# endif /* __GNU_LIBRARY__ */
# ifndef __need_getopt
extern int getopt_long (int __argc, char *const *__argv, const char *__shortopts,
const struct option *__longopts, int *__longind);
extern int getopt_long_only (int __argc, char *const *__argv,
extern int FLAC__share__getopt (int __argc, char *const *__argv, const char *__shortopts);
/*[JEC] was:# else*/ /* not __GNU_LIBRARY__ */
/*[JEC] was:extern int getopt ();*/
/*[JEC] was:# endif*/ /* __GNU_LIBRARY__ */
/*[JEC] was:# ifndef __need_getopt*/
extern int FLAC__share__getopt_long (int __argc, char *const *__argv, const char *__shortopts,
const struct FLAC__share__option *__longopts, int *__longind);
extern int FLAC__share__getopt_long_only (int __argc, char *const *__argv,
const char *__shortopts,
const struct option *__longopts, int *__longind);
const struct FLAC__share__option *__longopts, int *__longind);
/* Internal only. Users should not call this directly. */
extern int _getopt_internal (int __argc, char *const *__argv,
extern int FLAC__share___getopt_internal (int __argc, char *const *__argv,
const char *__shortopts,
const struct option *__longopts, int *__longind,
const struct FLAC__share__option *__longopts, int *__longind,
int __long_only);
# endif
#else /* not __STDC__ */
extern int getopt ();
# ifndef __need_getopt
extern int getopt_long ();
extern int getopt_long_only ();
/*[JEC] was:# endif*/
/*[JEC] was:#else*/ /* not __STDC__ */
/*[JEC] was:extern int getopt ();*/
/*[JEC] was:# ifndef __need_getopt*/
/*[JEC] was:extern int getopt_long ();*/
/*[JEC] was:extern int getopt_long_only ();*/
extern int _getopt_internal ();
# endif
#endif /* __STDC__ */
/*[JEC] was:extern int _getopt_internal ();*/
/*[JEC] was:# endif*/
/*[JEC] was:#endif*/ /* __STDC__ */
#ifdef __cplusplus
}
#endif
/* Make sure we later can get all the definitions and declarations. */
#undef __need_getopt
/*[JEC] was:#undef __need_getopt*/
#endif /* getopt.h */
......@@ -33,17 +33,19 @@ more powerful operations yet to add:
#include <stdlib.h>
#include <string.h>
#if HAVE_GETOPT_LONG
#if 0
/*[JEC] was:#if HAVE_GETOPT_LONG*/
/*[JEC] see flac/include/share/getopt.h as to why the change */
# include <getopt.h>
#else
# include "share/getopt.h"
#endif
/*
getopt format struct; note we don't use short options so we just
FLAC__share__getopt format struct; note we don't use short options so we just
set the 'val' field to 0 everywhere to indicate a valid option.
*/
static struct option long_options_[] = {
static struct FLAC__share__option long_options_[] = {
/* global options */
{ "preserve-modtime", 0, 0, 0 },
{ "with-filename", 0, 0, 0 },
......@@ -304,10 +306,10 @@ FLAC__bool parse_options(int argc, char *argv[], CommandLineOptions *options)
int option_index = 1;
FLAC__bool had_error = false;
while ((ret = getopt_long(argc, argv, "", long_options_, &option_index)) != -1) {
while ((ret = FLAC__share__getopt_long(argc, argv, "", long_options_, &option_index)) != -1) {
switch (ret) {
case 0:
had_error |= !parse_option(option_index, optarg, options);
had_error |= !parse_option(option_index, FLAC__share__optarg, options);
break;
case '?':
case ':':
......@@ -320,22 +322,22 @@ FLAC__bool parse_options(int argc, char *argv[], CommandLineOptions *options)
}
if(options->prefix_with_filename == 2)
options->prefix_with_filename = (argc - optind > 1);
options->prefix_with_filename = (argc - FLAC__share__optind > 1);
if(optind >= argc && !options->show_long_help) {
if(FLAC__share__optind >= argc && !options->show_long_help) {
fprintf(stderr,"ERROR: you must specify at least one FLAC file;\n");
fprintf(stderr," metaflac cannot be used as a pipe\n");
had_error = true;
}
options->num_files = argc - optind;
options->num_files = argc - FLAC__share__optind;
if(options->num_files > 0) {
unsigned i = 0;
if(0 == (options->filenames = malloc(sizeof(char *) * options->num_files)))
die("out of memory allocating space for file names list");
while(optind < argc)
options->filenames[i++] = local_strdup(argv[optind++]);
while(FLAC__share__optind < argc)
options->filenames[i++] = local_strdup(argv[FLAC__share__optind++]);
}
if(options->args.checks.num_major_ops > 0) {
......
/*
NOTE:
I cannot get the vanilla getopt code to work (i.e. compile only what
is needed and not duplicate symbols found in the standard library)
on all the platforms that FLAC supports. In particular the gating
of code with the ELIDE_CODE #define is not accurate enough on systems
that are POSIX but not glibc. If someone has a patch that works on
GNU/Linux, Darwin, AND Solaris please submit it on the project page:
http://sourceforge.net/projects/flac
In the meantime I have munged the global symbols and remove gates
around code, while at the same time trying to touch the original as
little as possible.
*/
/* Getopt for GNU.
NOTE: getopt is now part of the C library, so if you don't know what
"Keep this file name-space clean" means, talk to drepper@gnu.org
......@@ -57,7 +71,8 @@
# endif
#endif
#ifndef ELIDE_CODE
#if 1
/*[JEC] was:#ifndef ELIDE_CODE*/
/* This needs to come after some library #include
......@@ -87,11 +102,11 @@
# endif
#endif
/* This version of `getopt' appears to the caller like standard Unix `getopt'
/* This version of `FLAC__share__getopt' appears to the caller like standard Unix `getopt'
but it behaves differently for the user, since it allows the user
to intersperse the options with the other arguments.
As `getopt' works, it permutes the elements of ARGV so that,
As `FLAC__share__getopt' works, it permutes the elements of ARGV so that,
when it is done, all the options precede everything else. Thus
all application programs are extended to handle flexible argument order.
......@@ -101,36 +116,36 @@
GNU application programs can use a third alternative mode in which
they can distinguish the relative order of options and other arguments. */
#include "getopt.h"
/*[JEC] was:#include "getopt.h"*/
/* For communication from `getopt' to the caller.
When `getopt' finds an option that takes an argument,
/* For communication from `FLAC__share__getopt' to the caller.
When `FLAC__share__getopt' finds an option that takes an argument,
the argument value is returned here.
Also, when `ordering' is RETURN_IN_ORDER,
each non-option ARGV-element is returned here. */
char *optarg;
char *FLAC__share__optarg;
/* Index in ARGV of the next element to be scanned.
This is used for communication to and from the caller
and for communication between successive calls to `getopt'.
and for communication between successive calls to `FLAC__share__getopt'.
On entry to `getopt', zero means this is the first call; initialize.
On entry to `FLAC__share__getopt', zero means this is the first call; initialize.
When `getopt' returns -1, this is the index of the first of the
When `FLAC__share__getopt' returns -1, this is the index of the first of the
non-option elements that the caller should itself scan.
Otherwise, `optind' communicates from one call to the next
Otherwise, `FLAC__share__optind' communicates from one call to the next
how much of ARGV has been scanned so far. */
/* 1003.2 says this must be 1 before any call. */
int optind = 1;
int FLAC__share__optind = 1;
/* Formerly, initialization of getopt depended on optind==0, which
/* Formerly, initialization of getopt depended on FLAC__share__optind==0, which
causes problems with re-calling getopt as programs generally don't
know that. */
int __getopt_initialized;
int FLAC__share____getopt_initialized;
/* The next char to be scanned in the option-element
in which the last option character we returned was found.
......@@ -144,13 +159,13 @@ static char *nextchar;
/* Callers store zero here to inhibit the error message
for unrecognized options. */
int opterr = 1;
int FLAC__share__opterr = 1;
/* Set to an option character which was unrecognized.
This must be initialized on some systems to avoid linking in the
system's own getopt implementation. */
int optopt = '?';
int FLAC__share__optopt = '?';
/* Describe how to deal with options that follow non-option ARGV-elements.
......@@ -179,7 +194,7 @@ int optopt = '?';
The special argument `--' forces an end of option-scanning regardless
of the value of `ordering'. In the case of RETURN_IN_ORDER, only
`--' can cause `getopt' to return -1 with `optind' != ARGC. */
`--' can cause `FLAC__share__getopt' to return -1 with `FLAC__share__optind' != ARGC. */
static enum
{
......@@ -287,7 +302,7 @@ text_set_element (__libc_subinit, store_args_and_env);
/* Exchange two adjacent subsequences of ARGV.
One subsequence is elements [first_nonopt,last_nonopt)
which contains all the non-options that have been skipped so far.
The other is elements [last_nonopt,optind), which contains all
The other is elements [last_nonopt,FLAC__share__optind), which contains all
the options processed since those non-options were skipped.
`first_nonopt' and `last_nonopt' are relocated so that they describe
......@@ -303,7 +318,7 @@ exchange (argv)
{
int bottom = first_nonopt;
int middle = last_nonopt;
int top = optind;
int top = FLAC__share__optind;
char *tem;
/* Exchange the shorter segment with the far end of the longer segment.
......@@ -373,17 +388,17 @@ exchange (argv)
/* Update records for the slots the non-options now occupy. */
first_nonopt += (optind - last_nonopt);
last_nonopt = optind;
first_nonopt += (FLAC__share__optind - last_nonopt);
last_nonopt = FLAC__share__optind;
}
/* Initialize the internal data when the first call is made. */
#if defined __STDC__ && __STDC__
static const char *_getopt_initialize (int, char *const *, const char *);
static const char *FLAC__share___getopt_initialize (int, char *const *, const char *);
#endif
static const char *
_getopt_initialize (argc, argv, optstring)
FLAC__share___getopt_initialize (argc, argv, optstring)
int argc;
char *const *argv;
const char *optstring;
......@@ -392,7 +407,7 @@ _getopt_initialize (argc, argv, optstring)
is the program name); the sequence of previously skipped
non-option ARGV-elements is empty. */
first_nonopt = last_nonopt = optind;
first_nonopt = last_nonopt = FLAC__share__optind;
nextchar = NULL;
......@@ -453,29 +468,29 @@ _getopt_initialize (argc, argv, optstring)
If an element of ARGV starts with '-', and is not exactly "-" or "--",
then it is an option element. The characters of this element
(aside from the initial '-') are option characters. If `getopt'
(aside from the initial '-') are option characters. If `FLAC__share__getopt'
is called repeatedly, it returns successively each of the option characters
from each of the option elements.
If `getopt' finds another option character, it returns that character,
updating `optind' and `nextchar' so that the next call to `getopt' can
If `FLAC__share__getopt' finds another option character, it returns that character,
updating `FLAC__share__optind' and `nextchar' so that the next call to `FLAC__share__getopt' can
resume the scan with the following option character or ARGV-element.
If there are no more option characters, `getopt' returns -1.
Then `optind' is the index in ARGV of the first ARGV-element
If there are no more option characters, `FLAC__share__getopt' returns -1.
Then `FLAC__share__optind' is the index in ARGV of the first ARGV-element
that is not an option. (The ARGV-elements have been permuted
so that those that are not options now come last.)
OPTSTRING is a string containing the legitimate option characters.
If an option character is seen that is not listed in OPTSTRING,
return '?' after printing an error message. If you set `opterr' to
return '?' after printing an error message. If you set `FLAC__share__opterr' to
zero, the error message is suppressed but we still return '?'.
If a char in OPTSTRING is followed by a colon, that means it wants an arg,
so the following text in the same ARGV-element, or the text of the following
ARGV-element, is returned in `optarg'. Two colons mean an option that
ARGV-element, is returned in `FLAC__share__optarg'. Two colons mean an option that
wants an optional arg; if there is text in the current ARGV-element,
it is returned in `optarg', otherwise `optarg' is set to zero.
it is returned in `FLAC__share__optarg', otherwise `FLAC__share__optarg' is set to zero.
If OPTSTRING starts with `-' or `+', it requests different methods of
handling the non-option ARGV-elements.
......@@ -486,7 +501,7 @@ _getopt_initialize (argc, argv, optstring)
or is an exact match for some defined option. If they have an
argument, it follows the option name in the same ARGV-element, separated
from the option name by a `=', or else the in next ARGV-element.
When `getopt' finds a long-named option, it returns 0 if that option's
When `FLAC__share__getopt' finds a long-named option, it returns 0 if that option's
`flag' field is nonzero, the value of the option's `val' field
if the `flag' field is zero.
......@@ -494,7 +509,7 @@ _getopt_initialize (argc, argv, optstring)
But we pretend they're const in the prototype to be compatible
with other systems.
LONGOPTS is a vector of `struct option' terminated by an
LONGOPTS is a vector of `struct FLAC__share__option' terminated by an
element containing a name which is zero.
LONGIND returns the index in LONGOPT of the long-named option found.
......@@ -505,34 +520,34 @@ _getopt_initialize (argc, argv, optstring)
long-named options. */
int
_getopt_internal (argc, argv, optstring, longopts, longind, long_only)
FLAC__share___getopt_internal (argc, argv, optstring, longopts, longind, long_only)
int argc;
char *const *argv;
const char *optstring;
const struct option *longopts;
const struct FLAC__share__option *longopts;
int *longind;
int long_only;
{
optarg = NULL;
FLAC__share__optarg = NULL;
if (optind == 0 || !__getopt_initialized)
if (FLAC__share__optind == 0 || !FLAC__share____getopt_initialized)
{
if (optind == 0)
optind = 1; /* Don't scan ARGV[0], the program name. */
optstring = _getopt_initialize (argc, argv, optstring);
__getopt_initialized = 1;
if (FLAC__share__optind == 0)
FLAC__share__optind = 1; /* Don't scan ARGV[0], the program name. */
optstring = FLAC__share___getopt_initialize (argc, argv, optstring);
FLAC__share____getopt_initialized = 1;
}
/* Test whether ARGV[optind] points to a non-option argument.
/* Test whether ARGV[FLAC__share__optind] points to a non-option argument.
Either it does not have option syntax, or there is an environment flag
from the shell indicating it is not an option. The later information
is only used when the used in the GNU libc. */
#ifdef _LIBC
# define NONOPTION_P (argv[optind][0] != '-' || argv[optind][1] == '\0' \
|| (optind < nonoption_flags_len \
&& __getopt_nonoption_flags[optind] == '1'))
# define NONOPTION_P (argv[FLAC__share__optind][0] != '-' || argv[FLAC__share__optind][1] == '\0' \
|| (FLAC__share__optind < nonoption_flags_len \
&& __getopt_nonoption_flags[FLAC__share__optind] == '1'))
#else
# define NONOPTION_P (argv[optind][0] != '-' || argv[optind][1] == '\0')
# define NONOPTION_P (argv[FLAC__share__optind][0] != '-' || argv[FLAC__share__optind][1] == '\0')
#endif
if (nextchar == NULL || *nextchar == '\0')
......@@ -541,27 +556,27 @@ _getopt_internal (argc, argv, optstring, longopts, longind, long_only)
/* Give FIRST_NONOPT & LAST_NONOPT rational values if OPTIND has been
moved back by the user (who may also have changed the arguments). */
if (last_nonopt > optind)
last_nonopt = optind;
if (first_nonopt > optind)
first_nonopt = optind;
if (last_nonopt > FLAC__share__optind)
last_nonopt = FLAC__share__optind;
if (first_nonopt > FLAC__share__optind)
first_nonopt = FLAC__share__optind;
if (ordering == PERMUTE)
{
/* If we have just processed some options following some non-options,
exchange them so that the options come first. */
if (first_nonopt != last_nonopt && last_nonopt != optind)
if (first_nonopt != last_nonopt && last_nonopt != FLAC__share__optind)
exchange ((char **) argv);
else if (last_nonopt != optind)
first_nonopt = optind;
else if (last_nonopt != FLAC__share__optind)
first_nonopt = FLAC__share__optind;
/* Skip any additional non-options
and extend the range of non-options previously skipped. */
while (optind < argc && NONOPTION_P)
optind++;
last_nonopt = optind;
while (FLAC__share__optind < argc && NONOPTION_P)
FLAC__share__optind++;
last_nonopt = FLAC__share__optind;
}
/* The special ARGV-element `--' means premature end of options.
......@@ -569,28 +584,28 @@ _getopt_internal (argc, argv, optstring, longopts, longind, long_only)
then exchange with previous non-options as if it were an option,
then skip everything else like a non-option. */
if (optind != argc && !strcmp (argv[optind], "--"))
if (FLAC__share__optind != argc && !strcmp (argv[FLAC__share__optind], "--"))
{
optind++;
FLAC__share__optind++;
if (first_nonopt != last_nonopt && last_nonopt != optind)
if (first_nonopt != last_nonopt && last_nonopt != FLAC__share__optind)
exchange ((char **) argv);
else if (first_nonopt == last_nonopt)
first_nonopt = optind;
first_nonopt = FLAC__share__optind;
last_nonopt = argc;
optind = argc;
FLAC__share__optind = argc;
}
/* If we have done all the ARGV-elements, stop the scan
and back over any non-options that we skipped and permuted. */
if (optind == argc)
if (FLAC__share__optind == argc)
{
/* Set the next-arg-index to point at the non-options
that we previously skipped, so the caller will digest them. */
if (first_nonopt != last_nonopt)
optind = first_nonopt;
FLAC__share__optind = first_nonopt;
return -1;
}
......@@ -601,15 +616,15 @@ _getopt_internal (argc, argv, optstring, longopts, longind, long_only)
{
if (ordering == REQUIRE_ORDER)
return -1;
optarg = argv[optind++];
FLAC__share__optarg = argv[FLAC__share__optind++];
return 1;
}
/* We have found another option-ARGV-element.
Skip the initial punctuation. */
nextchar = (argv[optind] + 1
+ (longopts != NULL && argv[optind][1] == '-'));
nextchar = (argv[FLAC__share__optind] + 1
+ (longopts != NULL && argv[FLAC__share__optind][1] == '-'));
}
/* Decode the current option-ARGV-element. */
......@@ -628,12 +643,12 @@ _getopt_internal (argc, argv, optstring, longopts, longind, long_only)
<