[thirdparty/git.git] / parse-options.c

#include "git-compat-util.h"
#include "parse-options.h"
#include "cache.h"
#include "commit.h"
#include "color.h"

static int parse_options_usage(struct parse_opt_ctx_t *ctx,
			       const char * const *usagestr,
			       const struct option *opts, int err);

#define OPT_SHORT 1
#define OPT_UNSET 2

int optbug(const struct option *opt, const char *reason)
{
	if (opt->long_name)
		return error("BUG: option '%s' %s", opt->long_name, reason);
	return error("BUG: switch '%c' %s", opt->short_name, reason);
}

int opterror(const struct option *opt, const char *reason, int flags)
{
	if (flags & OPT_SHORT)
		return error("switch `%c' %s", opt->short_name, reason);
	if (flags & OPT_UNSET)
		return error("option `no-%s' %s", opt->long_name, reason);
	return error("option `%s' %s", opt->long_name, reason);
}

static int get_arg(struct parse_opt_ctx_t *p, const struct option *opt,
		   int flags, const char **arg)
{
	if (p->opt) {
		*arg = p->opt;
		p->opt = NULL;
	} else if (p->argc == 1 && (opt->flags & PARSE_OPT_LASTARG_DEFAULT)) {
		*arg = (const char *)opt->defval;
	} else if (p->argc > 1) {
		p->argc--;
		*arg = *++p->argv;
	} else
		return opterror(opt, "requires a value", flags);
	return 0;
}

static void fix_filename(const char *prefix, const char **file)
{
	if (!file || !*file || !prefix || is_absolute_path(*file)
	    || !strcmp("-", *file))
		return;
	*file = xstrdup(prefix_filename(prefix, strlen(prefix), *file));
}

static int get_value(struct parse_opt_ctx_t *p,
		     const struct option *opt, int flags)
{
	const char *s, *arg;
	const int unset = flags & OPT_UNSET;
	int err;

	if (unset && p->opt)
		return opterror(opt, "takes no value", flags);
	if (unset && (opt->flags & PARSE_OPT_NONEG))
		return opterror(opt, "isn't available", flags);
	if (!(flags & OPT_SHORT) && p->opt && (opt->flags & PARSE_OPT_NOARG))
		return opterror(opt, "takes no value", flags);

	switch (opt->type) {
	case OPTION_LOWLEVEL_CALLBACK:
		return (*(parse_opt_ll_cb *)opt->callback)(p, opt, unset);

	case OPTION_BIT:
		if (unset)
			*(int *)opt->value &= ~opt->defval;
		else
			*(int *)opt->value |= opt->defval;
		return 0;

	case OPTION_NEGBIT:
		if (unset)
			*(int *)opt->value |= opt->defval;
		else
			*(int *)opt->value &= ~opt->defval;
		return 0;

	case OPTION_COUNTUP:
		*(int *)opt->value = unset ? 0 : *(int *)opt->value + 1;
		return 0;

	case OPTION_SET_INT:
		*(int *)opt->value = unset ? 0 : opt->defval;
		return 0;

	case OPTION_SET_PTR:
		*(void **)opt->value = unset ? NULL : (void *)opt->defval;
		return 0;

	case OPTION_STRING:
		if (unset)
			*(const char **)opt->value = NULL;
		else if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
			*(const char **)opt->value = (const char *)opt->defval;
		else
			return get_arg(p, opt, flags, (const char **)opt->value);
		return 0;

	case OPTION_FILENAME:
		err = 0;
		if (unset)
			*(const char **)opt->value = NULL;
		else if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
			*(const char **)opt->value = (const char *)opt->defval;
		else
			err = get_arg(p, opt, flags, (const char **)opt->value);

		if (!err)
			fix_filename(p->prefix, (const char **)opt->value);
		return err;

	case OPTION_CALLBACK:
		if (unset)
			return (*opt->callback)(opt, NULL, 1) ? (-1) : 0;
		if (opt->flags & PARSE_OPT_NOARG)
			return (*opt->callback)(opt, NULL, 0) ? (-1) : 0;
		if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
			return (*opt->callback)(opt, NULL, 0) ? (-1) : 0;
		if (get_arg(p, opt, flags, &arg))
			return -1;
		return (*opt->callback)(opt, arg, 0) ? (-1) : 0;

	case OPTION_INTEGER:
		if (unset) {
			*(int *)opt->value = 0;
			return 0;
		}
		if (opt->flags & PARSE_OPT_OPTARG && !p->opt) {
			*(int *)opt->value = opt->defval;
			return 0;
		}
		if (get_arg(p, opt, flags, &arg))
			return -1;
		*(int *)opt->value = strtol(arg, (char **)&s, 10);
		if (*s)
			return opterror(opt, "expects a numerical value", flags);
		return 0;

	default:
		die("should not happen, someone must be hit on the forehead");
	}
}

static int parse_short_opt(struct parse_opt_ctx_t *p, const struct option *options)
{
	const struct option *numopt = NULL;

	for (; options->type != OPTION_END; options++) {
		if (options->short_name == *p->opt) {
			p->opt = p->opt[1] ? p->opt + 1 : NULL;
			return get_value(p, options, OPT_SHORT);
		}

		/*
		 * Handle the numerical option later, explicit one-digit
		 * options take precedence over it.
		 */
		if (options->type == OPTION_NUMBER)
			numopt = options;
	}
	if (numopt && isdigit(*p->opt)) {
		size_t len = 1;
		char *arg;
		int rc;

		while (isdigit(p->opt[len]))
			len++;
		arg = xmemdupz(p->opt, len);
		p->opt = p->opt[len] ? p->opt + len : NULL;
		rc = (*numopt->callback)(numopt, arg, 0) ? (-1) : 0;
		free(arg);
		return rc;
	}
	return -2;
}

static int parse_long_opt(struct parse_opt_ctx_t *p, const char *arg,
                          const struct option *options)
{
	const char *arg_end = strchr(arg, '=');
	const struct option *abbrev_option = NULL, *ambiguous_option = NULL;
	int abbrev_flags = 0, ambiguous_flags = 0;

	if (!arg_end)
		arg_end = arg + strlen(arg);

	for (; options->type != OPTION_END; options++) {
		const char *rest, *long_name = options->long_name;
		int flags = 0, opt_flags = 0;

		if (!long_name)
			continue;

again:
		rest = skip_prefix(arg, long_name);
		if (options->type == OPTION_ARGUMENT) {
			if (!rest)
				continue;
			if (*rest == '=')
				return opterror(options, "takes no value", flags);
			if (*rest)
				continue;
			p->out[p->cpidx++] = arg - 2;
			return 0;
		}
		if (!rest) {
			/* abbreviated? */
			if (!strncmp(long_name, arg, arg_end - arg)) {
is_abbreviated:
				if (abbrev_option) {
					/*
					 * If this is abbreviated, it is
					 * ambiguous. So when there is no
					 * exact match later, we need to
					 * error out.
					 */
					ambiguous_option = abbrev_option;
					ambiguous_flags = abbrev_flags;
				}
				if (!(flags & OPT_UNSET) && *arg_end)
					p->opt = arg_end + 1;
				abbrev_option = options;
				abbrev_flags = flags ^ opt_flags;
				continue;
			}
			/* negation allowed? */
			if (options->flags & PARSE_OPT_NONEG)
				continue;
			/* negated and abbreviated very much? */
			if (!prefixcmp("no-", arg)) {
				flags |= OPT_UNSET;
				goto is_abbreviated;
			}
			/* negated? */
			if (prefixcmp(arg, "no-")) {
				if (!prefixcmp(long_name, "no-")) {
					long_name += 3;
					opt_flags |= OPT_UNSET;
					goto again;
				}
				continue;
			}
			flags |= OPT_UNSET;
			rest = skip_prefix(arg + 3, long_name);
			/* abbreviated and negated? */
			if (!rest && !prefixcmp(long_name, arg + 3))
				goto is_abbreviated;
			if (!rest)
				continue;
		}
		if (*rest) {
			if (*rest != '=')
				continue;
			p->opt = rest + 1;
		}
		return get_value(p, options, flags ^ opt_flags);
	}

	if (ambiguous_option)
		return error("Ambiguous option: %s "
			"(could be --%s%s or --%s%s)",
			arg,
			(ambiguous_flags & OPT_UNSET) ?  "no-" : "",
			ambiguous_option->long_name,
			(abbrev_flags & OPT_UNSET) ?  "no-" : "",
			abbrev_option->long_name);
	if (abbrev_option)
		return get_value(p, abbrev_option, abbrev_flags);
	return -2;
}

static int parse_nodash_opt(struct parse_opt_ctx_t *p, const char *arg,
			    const struct option *options)
{
	for (; options->type != OPTION_END; options++) {
		if (!(options->flags & PARSE_OPT_NODASH))
			continue;
		if (options->short_name == arg[0] && arg[1] == '\0')
			return get_value(p, options, OPT_SHORT);
	}
	return -2;
}

static void check_typos(const char *arg, const struct option *options)
{
	if (strlen(arg) < 3)
		return;

	if (!prefixcmp(arg, "no-")) {
		error ("did you mean `--%s` (with two dashes ?)", arg);
		exit(129);
	}

	for (; options->type != OPTION_END; options++) {
		if (!options->long_name)
			continue;
		if (!prefixcmp(options->long_name, arg)) {
			error ("did you mean `--%s` (with two dashes ?)", arg);
			exit(129);
		}
	}
}

static void parse_options_check(const struct option *opts)
{
	int err = 0;

	for (; opts->type != OPTION_END; opts++) {
		if ((opts->flags & PARSE_OPT_LASTARG_DEFAULT) &&
		    (opts->flags & PARSE_OPT_OPTARG))
			err |= optbug(opts, "uses incompatible flags "
					"LASTARG_DEFAULT and OPTARG");
		if (opts->flags & PARSE_OPT_NODASH &&
		    ((opts->flags & PARSE_OPT_OPTARG) ||
		     !(opts->flags & PARSE_OPT_NOARG) ||
		     !(opts->flags & PARSE_OPT_NONEG) ||
		     opts->long_name))
			err |= optbug(opts, "uses feature "
					"not supported for dashless options");
		switch (opts->type) {
		case OPTION_COUNTUP:
		case OPTION_BIT:
		case OPTION_NEGBIT:
		case OPTION_SET_INT:
		case OPTION_SET_PTR:
		case OPTION_NUMBER:
			if ((opts->flags & PARSE_OPT_OPTARG) ||
			    !(opts->flags & PARSE_OPT_NOARG))
				err |= optbug(opts, "should not accept an argument");
		default:
			; /* ok. (usually accepts an argument) */
		}
	}
	if (err)
		exit(128);
}

void parse_options_start(struct parse_opt_ctx_t *ctx,
			 int argc, const char **argv, const char *prefix,
			 const struct option *options, int flags)
{
	memset(ctx, 0, sizeof(*ctx));
	ctx->argc = argc - 1;
	ctx->argv = argv + 1;
	ctx->out  = argv;
	ctx->prefix = prefix;
	ctx->cpidx = ((flags & PARSE_OPT_KEEP_ARGV0) != 0);
	ctx->flags = flags;
	if ((flags & PARSE_OPT_KEEP_UNKNOWN) &&
	    (flags & PARSE_OPT_STOP_AT_NON_OPTION))
		die("STOP_AT_NON_OPTION and KEEP_UNKNOWN don't go together");
	parse_options_check(options);
}

static int usage_with_options_internal(struct parse_opt_ctx_t *,
				       const char * const *,
				       const struct option *, int, int);

int parse_options_step(struct parse_opt_ctx_t *ctx,
		       const struct option *options,
		       const char * const usagestr[])
{
	int internal_help = !(ctx->flags & PARSE_OPT_NO_INTERNAL_HELP);

	/* we must reset ->opt, unknown short option leave it dangling */
	ctx->opt = NULL;

	for (; ctx->argc; ctx->argc--, ctx->argv++) {
		const char *arg = ctx->argv[0];

		if (*arg != '-' || !arg[1]) {
			if (parse_nodash_opt(ctx, arg, options) == 0)
				continue;
			if (ctx->flags & PARSE_OPT_STOP_AT_NON_OPTION)
				return PARSE_OPT_NON_OPTION;
			ctx->out[ctx->cpidx++] = ctx->argv[0];
			continue;
		}

		if (arg[1] != '-') {
			ctx->opt = arg + 1;
			if (internal_help && *ctx->opt == 'h')
				return parse_options_usage(ctx, usagestr, options, 0);
			switch (parse_short_opt(ctx, options)) {
			case -1:
				return parse_options_usage(ctx, usagestr, options, 1);
			case -2:
				if (ctx->opt)
					check_typos(arg + 1, options);
				goto unknown;
			}
			if (ctx->opt)
				check_typos(arg + 1, options);
			while (ctx->opt) {
				if (internal_help && *ctx->opt == 'h')
					return parse_options_usage(ctx, usagestr, options, 0);
				switch (parse_short_opt(ctx, options)) {
				case -1:
					return parse_options_usage(ctx, usagestr, options, 1);
				case -2:
					/* fake a short option thing to hide the fact that we may have
					 * started to parse aggregated stuff
					 *
					 * This is leaky, too bad.
					 */
					ctx->argv[0] = xstrdup(ctx->opt - 1);
					*(char *)ctx->argv[0] = '-';
					goto unknown;
				}
			}
			continue;
		}

		if (!arg[2]) { /* "--" */
			if (!(ctx->flags & PARSE_OPT_KEEP_DASHDASH)) {
				ctx->argc--;
				ctx->argv++;
			}
			break;
		}

		if (internal_help && !strcmp(arg + 2, "help-all"))
			return usage_with_options_internal(ctx, usagestr, options, 1, 0);
		if (internal_help && !strcmp(arg + 2, "help"))
			return parse_options_usage(ctx, usagestr, options, 0);
		switch (parse_long_opt(ctx, arg + 2, options)) {
		case -1:
			return parse_options_usage(ctx, usagestr, options, 1);
		case -2:
			goto unknown;
		}
		continue;
unknown:
		if (!(ctx->flags & PARSE_OPT_KEEP_UNKNOWN))
			return PARSE_OPT_UNKNOWN;
		ctx->out[ctx->cpidx++] = ctx->argv[0];
		ctx->opt = NULL;
	}
	return PARSE_OPT_DONE;
}

int parse_options_end(struct parse_opt_ctx_t *ctx)
{
	memmove(ctx->out + ctx->cpidx, ctx->argv, ctx->argc * sizeof(*ctx->out));
	ctx->out[ctx->cpidx + ctx->argc] = NULL;
	return ctx->cpidx + ctx->argc;
}

int parse_options(int argc, const char **argv, const char *prefix,
		  const struct option *options, const char * const usagestr[],
		  int flags)
{
	struct parse_opt_ctx_t ctx;

	parse_options_start(&ctx, argc, argv, prefix, options, flags);
	switch (parse_options_step(&ctx, options, usagestr)) {
	case PARSE_OPT_HELP:
		exit(129);
	case PARSE_OPT_NON_OPTION:
	case PARSE_OPT_DONE:
		break;
	default: /* PARSE_OPT_UNKNOWN */
		if (ctx.argv[0][1] == '-') {
			error("unknown option `%s'", ctx.argv[0] + 2);
		} else {
			error("unknown switch `%c'", *ctx.opt);
		}
		usage_with_options(usagestr, options);
	}

	precompose_argv(argc, argv);
	return parse_options_end(&ctx);
}

static int usage_argh(const struct option *opts, FILE *outfile)
{
	const char *s;
	int literal = (opts->flags & PARSE_OPT_LITERAL_ARGHELP) || !opts->argh;
	if (opts->flags & PARSE_OPT_OPTARG)
		if (opts->long_name)
			s = literal ? "[=%s]" : "[=<%s>]";
		else
			s = literal ? "[%s]" : "[<%s>]";
	else
		s = literal ? " %s" : " <%s>";
	return fprintf(outfile, s, opts->argh ? _(opts->argh) : _("..."));
}

#define USAGE_OPTS_WIDTH 24
#define USAGE_GAP         2

static int usage_with_options_internal(struct parse_opt_ctx_t *ctx,
				       const char * const *usagestr,
				       const struct option *opts, int full, int err)
{
	FILE *outfile = err ? stderr : stdout;

	if (!usagestr)
		return PARSE_OPT_HELP;

	if (!err && ctx && ctx->flags & PARSE_OPT_SHELL_EVAL)
		fprintf(outfile, "cat <<\\EOF\n");

	fprintf_ln(outfile, _("usage: %s"), _(*usagestr++));
	while (*usagestr && **usagestr)
		/* TRANSLATORS: the colon here should align with the
		   one in "usage: %s" translation */
		fprintf_ln(outfile, _("   or: %s"), _(*usagestr++));
	while (*usagestr) {
		if (**usagestr)
			fprintf_ln(outfile, _("    %s"), _(*usagestr));
		else
			putchar('\n');
		usagestr++;
	}

	if (opts->type != OPTION_GROUP)
		fputc('\n', outfile);

	for (; opts->type != OPTION_END; opts++) {
		size_t pos;
		int pad;

		if (opts->type == OPTION_GROUP) {
			fputc('\n', outfile);
			if (*opts->help)
				fprintf(outfile, "%s\n", _(opts->help));
			continue;
		}
		if (!full && (opts->flags & PARSE_OPT_HIDDEN))
			continue;

		pos = fprintf(outfile, "    ");
		if (opts->short_name) {
			if (opts->flags & PARSE_OPT_NODASH)
				pos += fprintf(outfile, "%c", opts->short_name);
			else
				pos += fprintf(outfile, "-%c", opts->short_name);
		}
		if (opts->long_name && opts->short_name)
			pos += fprintf(outfile, ", ");
		if (opts->long_name)
			pos += fprintf(outfile, "--%s", opts->long_name);
		if (opts->type == OPTION_NUMBER)
			pos += fprintf(outfile, "-NUM");

		if ((opts->flags & PARSE_OPT_LITERAL_ARGHELP) ||
		    !(opts->flags & PARSE_OPT_NOARG))
			pos += usage_argh(opts, outfile);

		if (pos <= USAGE_OPTS_WIDTH)
			pad = USAGE_OPTS_WIDTH - pos;
		else {
			fputc('\n', outfile);
			pad = USAGE_OPTS_WIDTH;
		}
		fprintf(outfile, "%*s%s\n", pad + USAGE_GAP, "", _(opts->help));
	}
	fputc('\n', outfile);

	if (!err && ctx && ctx->flags & PARSE_OPT_SHELL_EVAL)
		fputs("EOF\n", outfile);

	return PARSE_OPT_HELP;
}

void NORETURN usage_with_options(const char * const *usagestr,
			const struct option *opts)
{
	usage_with_options_internal(NULL, usagestr, opts, 0, 1);
	exit(129);
}

void NORETURN usage_msg_opt(const char *msg,
		   const char * const *usagestr,
		   const struct option *options)
{
	fprintf(stderr, "%s\n\n", msg);
	usage_with_options(usagestr, options);
}

static int parse_options_usage(struct parse_opt_ctx_t *ctx,
			       const char * const *usagestr,
			       const struct option *opts, int err)
{
	return usage_with_options_internal(ctx, usagestr, opts, 0, err);
}
Commit	Line	Data
4a59fd13 PH	1	#include "git-compat-util.h"
4a59fd13 PH	2	#include "parse-options.h"
26141b5b	3	#include "cache.h"
269defdf	4	#include "commit.h"
73e9da01	5	#include "color.h"
4a59fd13	6
47e9cd28 TR	7	static int parse_options_usage(struct parse_opt_ctx_t *ctx,
47e9cd28 TR	8	const char * const *usagestr,
9c7304e3	9	const struct option *opts, int err);
41064ebc	10
4a59fd13 PH	11	#define OPT_SHORT 1
	12	#define OPT_UNSET 2
	13
1f275b7c	14	int optbug(const struct option opt, const char reason)
1e5ce570 JN	15	{
	16	if (opt->long_name)
	17	return error("BUG: option '%s' %s", opt->long_name, reason);
	18	return error("BUG: switch '%c' %s", opt->short_name, reason);
	19	}
	20
1f275b7c	21	int opterror(const struct option opt, const char reason, int flags)
4a59fd13 PH	22	{
	23	if (flags & OPT_SHORT)
	24	return error("switch `%c' %s", opt->short_name, reason);
	25	if (flags & OPT_UNSET)
	26	return error("option `no-%s' %s", opt->long_name, reason);
	27	return error("option `%s' %s", opt->long_name, reason);
	28	}
	29
1cc6985c PH	30	static int get_arg(struct parse_opt_ctx_t p, const struct option opt,
	31	int flags, const char **arg)
	32	{
	33	if (p->opt) {
	34	*arg = p->opt;
	35	p->opt = NULL;
	36	} else if (p->argc == 1 && (opt->flags & PARSE_OPT_LASTARG_DEFAULT)) {
	37	arg = (const char )opt->defval;
d5d745f9	38	} else if (p->argc > 1) {
1cc6985c PH	39	p->argc--;
	40	arg = ++p->argv;
	41	} else
	42	return opterror(opt, "requires a value", flags);
	43	return 0;
	44	}
	45
df217ed6 SB	46	static void fix_filename(const char prefix, const char *file)
	47	{
	48	if (!file \|\| !file \|\| !prefix \|\| is_absolute_path(file)
	49	\|\| !strcmp("-", *file))
	50	return;
	51	file = xstrdup(prefix_filename(prefix, strlen(prefix), file));
	52	}
	53
7e7bbcb4	54	static int get_value(struct parse_opt_ctx_t *p,
1cc6985c	55	const struct option *opt, int flags)
4a59fd13	56	{
ffe659f9	57	const char s, arg;
db7244bd	58	const int unset = flags & OPT_UNSET;
df217ed6	59	int err;
4a59fd13	60
db7244bd	61	if (unset && p->opt)
4a59fd13	62	return opterror(opt, "takes no value", flags);
db7244bd PH	63	if (unset && (opt->flags & PARSE_OPT_NONEG))
db7244bd PH	64	return opterror(opt, "isn't available", flags);
c1f4ec9e SB	65	if (!(flags & OPT_SHORT) && p->opt && (opt->flags & PARSE_OPT_NOARG))
c1f4ec9e SB	66	return opterror(opt, "takes no value", flags);
db7244bd	67
db7244bd	68	switch (opt->type) {
b0b3a8b6 JN	69	case OPTION_LOWLEVEL_CALLBACK:
	70	return ((parse_opt_ll_cb )opt->callback)(p, opt, unset);
	71
db7244bd PH	72	case OPTION_BIT:
	73	if (unset)
	74	(int )opt->value &= ~opt->defval;
4a59fd13	75	else
db7244bd PH	76	(int )opt->value \|= opt->defval;
	77	return 0;
	78
2f4b97f9 RS	79	case OPTION_NEGBIT:
	80	if (unset)
	81	(int )opt->value \|= opt->defval;
	82	else
	83	(int )opt->value &= ~opt->defval;
	84	return 0;
	85
b04ba2bb	86	case OPTION_COUNTUP:
db7244bd PH	87	(int )opt->value = unset ? 0 : (int )opt->value + 1;
	88	return 0;
	89
	90	case OPTION_SET_INT:
	91	(int )opt->value = unset ? 0 : opt->defval;
	92	return 0;
	93
	94	case OPTION_SET_PTR:
	95	(void )opt->value = unset ? NULL : (void )opt->defval;
4a59fd13 PH	96	return 0;
	97
	98	case OPTION_STRING:
1cc6985c	99	if (unset)
db7244bd	100	(const char *)opt->value = NULL;
1cc6985c	101	else if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
ffe659f9	102	(const char )opt->value = (const char )opt->defval;
1cc6985c PH	103	else
1cc6985c PH	104	return get_arg(p, opt, flags, (const char **)opt->value);
4a59fd13 PH	105	return 0;
4a59fd13 PH	106
df217ed6 SB	107	case OPTION_FILENAME:
	108	err = 0;
	109	if (unset)
	110	(const char *)opt->value = NULL;
	111	else if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
	112	(const char )opt->value = (const char )opt->defval;
	113	else
	114	err = get_arg(p, opt, flags, (const char **)opt->value);
	115
	116	if (!err)
	117	fix_filename(p->prefix, (const char **)opt->value);
	118	return err;
	119
ffe659f9	120	case OPTION_CALLBACK:
db7244bd	121	if (unset)
07fe54db	122	return (*opt->callback)(opt, NULL, 1) ? (-1) : 0;
db7244bd	123	if (opt->flags & PARSE_OPT_NOARG)
07fe54db	124	return (*opt->callback)(opt, NULL, 0) ? (-1) : 0;
c43a2483	125	if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
07fe54db	126	return (*opt->callback)(opt, NULL, 0) ? (-1) : 0;
1cc6985c PH	127	if (get_arg(p, opt, flags, &arg))
	128	return -1;
	129	return (*opt->callback)(opt, arg, 0) ? (-1) : 0;
ffe659f9	130
4a59fd13	131	case OPTION_INTEGER:
db7244bd	132	if (unset) {
4a59fd13 PH	133	(int )opt->value = 0;
	134	return 0;
	135	}
c43a2483	136	if (opt->flags & PARSE_OPT_OPTARG && !p->opt) {
ffe659f9 PH	137	(int )opt->value = opt->defval;
	138	return 0;
	139	}
1cc6985c PH	140	if (get_arg(p, opt, flags, &arg))
	141	return -1;
	142	(int )opt->value = strtol(arg, (char **)&s, 10);
4a59fd13 PH	143	if (*s)
	144	return opterror(opt, "expects a numerical value", flags);
	145	return 0;
	146
	147	default:
	148	die("should not happen, someone must be hit on the forehead");
	149	}
	150	}
	151
7e7bbcb4	152	static int parse_short_opt(struct parse_opt_ctx_t p, const struct option options)
4a59fd13	153	{
e0319ff5 RS	154	const struct option *numopt = NULL;
e0319ff5 RS	155
4a59fd13 PH	156	for (; options->type != OPTION_END; options++) {
	157	if (options->short_name == *p->opt) {
	158	p->opt = p->opt[1] ? p->opt + 1 : NULL;
	159	return get_value(p, options, OPT_SHORT);
	160	}
e0319ff5 RS	161
	162	/*
	163	* Handle the numerical option later, explicit one-digit
	164	* options take precedence over it.
	165	*/
	166	if (options->type == OPTION_NUMBER)
	167	numopt = options;
	168	}
	169	if (numopt && isdigit(*p->opt)) {
	170	size_t len = 1;
	171	char *arg;
	172	int rc;
	173
	174	while (isdigit(p->opt[len]))
	175	len++;
	176	arg = xmemdupz(p->opt, len);
	177	p->opt = p->opt[len] ? p->opt + len : NULL;
	178	rc = (*numopt->callback)(numopt, arg, 0) ? (-1) : 0;
	179	free(arg);
	180	return rc;
4a59fd13	181	}
07fe54db	182	return -2;
4a59fd13 PH	183	}
4a59fd13 PH	184
7e7bbcb4	185	static int parse_long_opt(struct parse_opt_ctx_t p, const char arg,
4a59fd13 PH	186	const struct option *options)
4a59fd13 PH	187	{
7f275b91	188	const char *arg_end = strchr(arg, '=');
243e0614 JS	189	const struct option abbrev_option = NULL, ambiguous_option = NULL;
243e0614 JS	190	int abbrev_flags = 0, ambiguous_flags = 0;
7f275b91 JS	191
	192	if (!arg_end)
	193	arg_end = arg + strlen(arg);
	194
4a59fd13	195	for (; options->type != OPTION_END; options++) {
0f1930c5 RS	196	const char rest, long_name = options->long_name;
0f1930c5 RS	197	int flags = 0, opt_flags = 0;
4a59fd13	198
0f1930c5	199	if (!long_name)
4a59fd13 PH	200	continue;
4a59fd13 PH	201
0f1930c5 RS	202	again:
0f1930c5 RS	203	rest = skip_prefix(arg, long_name);
580d5bff PH	204	if (options->type == OPTION_ARGUMENT) {
	205	if (!rest)
	206	continue;
	207	if (*rest == '=')
	208	return opterror(options, "takes no value", flags);
	209	if (*rest)
	210	continue;
	211	p->out[p->cpidx++] = arg - 2;
	212	return 0;
	213	}
4a59fd13	214	if (!rest) {
7f275b91	215	/* abbreviated? */
0f1930c5	216	if (!strncmp(long_name, arg, arg_end - arg)) {
7f275b91	217	is_abbreviated:
243e0614 JS	218	if (abbrev_option) {
	219	/*
	220	* If this is abbreviated, it is
	221	* ambiguous. So when there is no
	222	* exact match later, we need to
	223	* error out.
	224	*/
	225	ambiguous_option = abbrev_option;
	226	ambiguous_flags = abbrev_flags;
	227	}
7f275b91 JS	228	if (!(flags & OPT_UNSET) && *arg_end)
	229	p->opt = arg_end + 1;
	230	abbrev_option = options;
0f1930c5	231	abbrev_flags = flags ^ opt_flags;
7f275b91 JS	232	continue;
7f275b91 JS	233	}
6bbfd1fa AS	234	/* negation allowed? */
	235	if (options->flags & PARSE_OPT_NONEG)
	236	continue;
7f275b91 JS	237	/* negated and abbreviated very much? */
	238	if (!prefixcmp("no-", arg)) {
	239	flags \|= OPT_UNSET;
	240	goto is_abbreviated;
	241	}
	242	/* negated? */
0f1930c5 RS	243	if (prefixcmp(arg, "no-")) {
	244	if (!prefixcmp(long_name, "no-")) {
	245	long_name += 3;
	246	opt_flags \|= OPT_UNSET;
	247	goto again;
	248	}
4a59fd13	249	continue;
0f1930c5	250	}
4a59fd13	251	flags \|= OPT_UNSET;
0f1930c5	252	rest = skip_prefix(arg + 3, long_name);
7f275b91	253	/* abbreviated and negated? */
0f1930c5	254	if (!rest && !prefixcmp(long_name, arg + 3))
7f275b91	255	goto is_abbreviated;
4a59fd13 PH	256	if (!rest)
	257	continue;
	258	}
	259	if (*rest) {
	260	if (*rest != '=')
	261	continue;
	262	p->opt = rest + 1;
	263	}
0f1930c5	264	return get_value(p, options, flags ^ opt_flags);
4a59fd13	265	}
243e0614 JS	266
	267	if (ambiguous_option)
	268	return error("Ambiguous option: %s "
	269	"(could be --%s%s or --%s%s)",
	270	arg,
	271	(ambiguous_flags & OPT_UNSET) ? "no-" : "",
	272	ambiguous_option->long_name,
	273	(abbrev_flags & OPT_UNSET) ? "no-" : "",
	274	abbrev_option->long_name);
7f275b91 JS	275	if (abbrev_option)
7f275b91 JS	276	return get_value(p, abbrev_option, abbrev_flags);
07fe54db	277	return -2;
4a59fd13 PH	278	}
4a59fd13 PH	279
51a9949e RS	280	static int parse_nodash_opt(struct parse_opt_ctx_t p, const char arg,
	281	const struct option *options)
	282	{
	283	for (; options->type != OPTION_END; options++) {
	284	if (!(options->flags & PARSE_OPT_NODASH))
	285	continue;
51a9949e RS	286	if (options->short_name == arg[0] && arg[1] == '\0')
	287	return get_value(p, options, OPT_SHORT);
	288	}
	289	return -2;
	290	}
	291
1121a878	292	static void check_typos(const char arg, const struct option options)
3a9f0f41 PH	293	{
	294	if (strlen(arg) < 3)
	295	return;
	296
	297	if (!prefixcmp(arg, "no-")) {
	298	error ("did you mean `--%s` (with two dashes ?)", arg);
	299	exit(129);
	300	}
	301
	302	for (; options->type != OPTION_END; options++) {
	303	if (!options->long_name)
	304	continue;
	305	if (!prefixcmp(options->long_name, arg)) {
	306	error ("did you mean `--%s` (with two dashes ?)", arg);
	307	exit(129);
	308	}
	309	}
	310	}
	311
cb9d398c PH	312	static void parse_options_check(const struct option *opts)
	313	{
	314	int err = 0;
	315
	316	for (; opts->type != OPTION_END; opts++) {
	317	if ((opts->flags & PARSE_OPT_LASTARG_DEFAULT) &&
1e5ce570 JN	318	(opts->flags & PARSE_OPT_OPTARG))
	319	err \|= optbug(opts, "uses incompatible flags "
	320	"LASTARG_DEFAULT and OPTARG");
a02dd4ff JN	321	if (opts->flags & PARSE_OPT_NODASH &&
	322	((opts->flags & PARSE_OPT_OPTARG) \|\|
	323	!(opts->flags & PARSE_OPT_NOARG) \|\|
	324	!(opts->flags & PARSE_OPT_NONEG) \|\|
	325	opts->long_name))
	326	err \|= optbug(opts, "uses feature "
	327	"not supported for dashless options");
5c400ed2	328	switch (opts->type) {
b04ba2bb	329	case OPTION_COUNTUP:
5c400ed2 JN	330	case OPTION_BIT:
	331	case OPTION_NEGBIT:
	332	case OPTION_SET_INT:
	333	case OPTION_SET_PTR:
	334	case OPTION_NUMBER:
	335	if ((opts->flags & PARSE_OPT_OPTARG) \|\|
	336	!(opts->flags & PARSE_OPT_NOARG))
	337	err \|= optbug(opts, "should not accept an argument");
	338	default:
	339	; /* ok. (usually accepts an argument) */
	340	}
cb9d398c	341	}
cb9d398c	342	if (err)
1e5ce570	343	exit(128);
cb9d398c PH	344	}
cb9d398c PH	345
7e7bbcb4	346	void parse_options_start(struct parse_opt_ctx_t *ctx,
37782920	347	int argc, const char *argv, const char prefix,
9ca1169f	348	const struct option *options, int flags)
7e7bbcb4 PH	349	{
	350	memset(ctx, 0, sizeof(*ctx));
	351	ctx->argc = argc - 1;
	352	ctx->argv = argv + 1;
	353	ctx->out = argv;
37782920	354	ctx->prefix = prefix;
a32a4eaa	355	ctx->cpidx = ((flags & PARSE_OPT_KEEP_ARGV0) != 0);
7e7bbcb4	356	ctx->flags = flags;
0d260f9a RS	357	if ((flags & PARSE_OPT_KEEP_UNKNOWN) &&
	358	(flags & PARSE_OPT_STOP_AT_NON_OPTION))
	359	die("STOP_AT_NON_OPTION and KEEP_UNKNOWN don't go together");
9ca1169f	360	parse_options_check(options);
7e7bbcb4 PH	361	}
7e7bbcb4 PH	362
47e9cd28 TR	363	static int usage_with_options_internal(struct parse_opt_ctx_t *,
47e9cd28 TR	364	const char * const *,
9c7304e3	365	const struct option *, int, int);
dd3bf0f4	366
ff43ec3e PH	367	int parse_options_step(struct parse_opt_ctx_t *ctx,
	368	const struct option *options,
	369	const char * const usagestr[])
4a59fd13	370	{
b92891f9 RS	371	int internal_help = !(ctx->flags & PARSE_OPT_NO_INTERNAL_HELP);
b92891f9 RS	372
26141b5b PH	373	/* we must reset ->opt, unknown short option leave it dangling */
	374	ctx->opt = NULL;
	375
ff43ec3e PH	376	for (; ctx->argc; ctx->argc--, ctx->argv++) {
ff43ec3e PH	377	const char *arg = ctx->argv[0];
4a59fd13 PH	378
4a59fd13 PH	379	if (*arg != '-' \|\| !arg[1]) {
51a9949e RS	380	if (parse_nodash_opt(ctx, arg, options) == 0)
51a9949e RS	381	continue;
ff43ec3e	382	if (ctx->flags & PARSE_OPT_STOP_AT_NON_OPTION)
979240fe	383	return PARSE_OPT_NON_OPTION;
ff43ec3e	384	ctx->out[ctx->cpidx++] = ctx->argv[0];
4a59fd13 PH	385	continue;
	386	}
	387
	388	if (arg[1] != '-') {
ff43ec3e	389	ctx->opt = arg + 1;
b92891f9	390	if (internal_help && *ctx->opt == 'h')
47e9cd28	391	return parse_options_usage(ctx, usagestr, options, 0);
07fe54db PH	392	switch (parse_short_opt(ctx, options)) {
07fe54db PH	393	case -1:
47e9cd28	394	return parse_options_usage(ctx, usagestr, options, 1);
07fe54db	395	case -2:
38916c5b RS	396	if (ctx->opt)
38916c5b RS	397	check_typos(arg + 1, options);
b5ce3a54	398	goto unknown;
07fe54db	399	}
ff43ec3e	400	if (ctx->opt)
3a9f0f41	401	check_typos(arg + 1, options);
ff43ec3e	402	while (ctx->opt) {
b92891f9	403	if (internal_help && *ctx->opt == 'h')
47e9cd28	404	return parse_options_usage(ctx, usagestr, options, 0);
07fe54db PH	405	switch (parse_short_opt(ctx, options)) {
07fe54db PH	406	case -1:
47e9cd28	407	return parse_options_usage(ctx, usagestr, options, 1);
07fe54db	408	case -2:
26141b5b PH	409	/* fake a short option thing to hide the fact that we may have
	410	* started to parse aggregated stuff
	411	*
	412	* This is leaky, too bad.
	413	*/
	414	ctx->argv[0] = xstrdup(ctx->opt - 1);
	415	(char )ctx->argv[0] = '-';
b5ce3a54	416	goto unknown;
07fe54db	417	}
3a9f0f41	418	}
4a59fd13 PH	419	continue;
	420	}
	421
	422	if (!arg[2]) { /* "--" */
ff43ec3e PH	423	if (!(ctx->flags & PARSE_OPT_KEEP_DASHDASH)) {
	424	ctx->argc--;
	425	ctx->argv++;
4a59fd13 PH	426	}
	427	break;
	428	}
	429
b92891f9	430	if (internal_help && !strcmp(arg + 2, "help-all"))
47e9cd28	431	return usage_with_options_internal(ctx, usagestr, options, 1, 0);
b92891f9	432	if (internal_help && !strcmp(arg + 2, "help"))
47e9cd28	433	return parse_options_usage(ctx, usagestr, options, 0);
07fe54db PH	434	switch (parse_long_opt(ctx, arg + 2, options)) {
07fe54db PH	435	case -1:
47e9cd28	436	return parse_options_usage(ctx, usagestr, options, 1);
07fe54db	437	case -2:
b5ce3a54	438	goto unknown;
07fe54db	439	}
b5ce3a54 RS	440	continue;
	441	unknown:
	442	if (!(ctx->flags & PARSE_OPT_KEEP_UNKNOWN))
	443	return PARSE_OPT_UNKNOWN;
	444	ctx->out[ctx->cpidx++] = ctx->argv[0];
	445	ctx->opt = NULL;
ff43ec3e PH	446	}
	447	return PARSE_OPT_DONE;
	448	}
	449
	450	int parse_options_end(struct parse_opt_ctx_t *ctx)
	451	{
	452	memmove(ctx->out + ctx->cpidx, ctx->argv, ctx->argc * sizeof(*ctx->out));
	453	ctx->out[ctx->cpidx + ctx->argc] = NULL;
	454	return ctx->cpidx + ctx->argc;
	455	}
	456
37782920 SB	457	int parse_options(int argc, const char *argv, const char prefix,
	458	const struct option options, const char const usagestr[],
	459	int flags)
ff43ec3e PH	460	{
	461	struct parse_opt_ctx_t ctx;
	462
9ca1169f	463	parse_options_start(&ctx, argc, argv, prefix, options, flags);
ff43ec3e PH	464	switch (parse_options_step(&ctx, options, usagestr)) {
	465	case PARSE_OPT_HELP:
	466	exit(129);
979240fe	467	case PARSE_OPT_NON_OPTION:
ff43ec3e PH	468	case PARSE_OPT_DONE:
	469	break;
	470	default: /* PARSE_OPT_UNKNOWN */
07fe54db PH	471	if (ctx.argv[0][1] == '-') {
	472	error("unknown option `%s'", ctx.argv[0] + 2);
	473	} else {
	474	error("unknown switch `%c'", *ctx.opt);
	475	}
	476	usage_with_options(usagestr, options);
4a59fd13 PH	477	}
4a59fd13 PH	478
76759c7d	479	precompose_argv(argc, argv);
7e7bbcb4	480	return parse_options_end(&ctx);
4a59fd13	481	}
d7a38c54	482
9c7304e3	483	static int usage_argh(const struct option opts, FILE outfile)
29f25d49 SB	484	{
29f25d49 SB	485	const char *s;
34aec9f5	486	int literal = (opts->flags & PARSE_OPT_LITERAL_ARGHELP) \|\| !opts->argh;
29f25d49 SB	487	if (opts->flags & PARSE_OPT_OPTARG)
	488	if (opts->long_name)
	489	s = literal ? "[=%s]" : "[=<%s>]";
	490	else
	491	s = literal ? "[%s]" : "[<%s>]";
	492	else
	493	s = literal ? " %s" : " <%s>";
54e6dc7d	494	return fprintf(outfile, s, opts->argh ? _(opts->argh) : _("..."));
29f25d49 SB	495	}
29f25d49 SB	496
d7a38c54 PH	497	#define USAGE_OPTS_WIDTH 24
	498	#define USAGE_GAP 2
	499
47e9cd28 TR	500	static int usage_with_options_internal(struct parse_opt_ctx_t *ctx,
	501	const char * const *usagestr,
	502	const struct option *opts, int full, int err)
d7a38c54	503	{
9c7304e3 GS	504	FILE *outfile = err ? stderr : stdout;
9c7304e3 GS	505
49b61802 RS	506	if (!usagestr)
	507	return PARSE_OPT_HELP;
	508
47e9cd28 TR	509	if (!err && ctx && ctx->flags & PARSE_OPT_SHELL_EVAL)
	510	fprintf(outfile, "cat <<\\EOF\n");
	511
54e6dc7d	512	fprintf_ln(outfile, _("usage: %s"), _(*usagestr++));
f389c808	513	while (usagestr && *usagestr)
54e6dc7d NTND	514	/* TRANSLATORS: the colon here should align with the
	515	one in "usage: %s" translation */
	516	fprintf_ln(outfile, _(" or: %s"), _(*usagestr++));
44d86e91	517	while (*usagestr) {
54e6dc7d NTND	518	if (**usagestr)
	519	fprintf_ln(outfile, _(" %s"), _(*usagestr));
	520	else
	521	putchar('\n');
44d86e91 JK	522	usagestr++;
44d86e91 JK	523	}
d7a38c54 PH	524
d7a38c54 PH	525	if (opts->type != OPTION_GROUP)
9c7304e3	526	fputc('\n', outfile);
d7a38c54 PH	527
	528	for (; opts->type != OPTION_END; opts++) {
	529	size_t pos;
	530	int pad;
	531
	532	if (opts->type == OPTION_GROUP) {
9c7304e3	533	fputc('\n', outfile);
d7a38c54	534	if (*opts->help)
54e6dc7d	535	fprintf(outfile, "%s\n", _(opts->help));
d7a38c54 PH	536	continue;
d7a38c54 PH	537	}
dd3bf0f4 PH	538	if (!full && (opts->flags & PARSE_OPT_HIDDEN))
dd3bf0f4 PH	539	continue;
d7a38c54	540
9c7304e3	541	pos = fprintf(outfile, " ");
cbb08c2e	542	if (opts->short_name) {
51a9949e	543	if (opts->flags & PARSE_OPT_NODASH)
9c7304e3	544	pos += fprintf(outfile, "%c", opts->short_name);
51a9949e	545	else
9c7304e3	546	pos += fprintf(outfile, "-%c", opts->short_name);
51a9949e	547	}
d7a38c54	548	if (opts->long_name && opts->short_name)
9c7304e3	549	pos += fprintf(outfile, ", ");
d7a38c54	550	if (opts->long_name)
cbb08c2e	551	pos += fprintf(outfile, "--%s", opts->long_name);
e0319ff5	552	if (opts->type == OPTION_NUMBER)
9c7304e3	553	pos += fprintf(outfile, "-NUM");
d7a38c54	554
b57c68a6 JN	555	if ((opts->flags & PARSE_OPT_LITERAL_ARGHELP) \|\|
b57c68a6 JN	556	!(opts->flags & PARSE_OPT_NOARG))
9c7304e3	557	pos += usage_argh(opts, outfile);
d7a38c54	558
f389c808 AR	559	if (pos <= USAGE_OPTS_WIDTH)
f389c808 AR	560	pad = USAGE_OPTS_WIDTH - pos;
d7a38c54	561	else {
9c7304e3	562	fputc('\n', outfile);
d7a38c54 PH	563	pad = USAGE_OPTS_WIDTH;
d7a38c54 PH	564	}
54e6dc7d	565	fprintf(outfile, "%*s%s\n", pad + USAGE_GAP, "", _(opts->help));
d7a38c54	566	}
9c7304e3	567	fputc('\n', outfile);
f389c808	568
47e9cd28 TR	569	if (!err && ctx && ctx->flags & PARSE_OPT_SHELL_EVAL)
	570	fputs("EOF\n", outfile);
	571
ee68b87a	572	return PARSE_OPT_HELP;
d7a38c54	573	}
0ce865b1	574
c2e86add	575	void NORETURN usage_with_options(const char * const *usagestr,
ff43ec3e	576	const struct option *opts)
dd3bf0f4	577	{
47e9cd28	578	usage_with_options_internal(NULL, usagestr, opts, 0, 1);
ff43ec3e	579	exit(129);
dd3bf0f4 PH	580	}
dd3bf0f4 PH	581
c2e86add	582	void NORETURN usage_msg_opt(const char *msg,
451bb210 CC	583	const char * const *usagestr,
	584	const struct option *options)
	585	{
	586	fprintf(stderr, "%s\n\n", msg);
	587	usage_with_options(usagestr, options);
	588	}
	589
47e9cd28 TR	590	static int parse_options_usage(struct parse_opt_ctx_t *ctx,
47e9cd28 TR	591	const char * const *usagestr,
9c7304e3	592	const struct option *opts, int err)
ee68b87a	593	{
47e9cd28	594	return usage_with_options_internal(ctx, usagestr, opts, 0, err);
ee68b87a PH	595	}
ee68b87a PH	596