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

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

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

#define OPT_SHORT 1
#define OPT_UNSET 2

static 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) {
		switch (opt->type) {
		case OPTION_CALLBACK:
			if (!(opt->flags & PARSE_OPT_NOARG))
				break;
			/* FALLTHROUGH */
		case OPTION_BOOLEAN:
		case OPTION_BIT:
		case OPTION_NEGBIT:
		case OPTION_SET_INT:
		case OPTION_SET_PTR:
			return opterror(opt, "takes no value", flags);
		default:
			break;
		}
	}

	switch (opt->type) {
	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_BOOLEAN:
		*(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;
		int flags = 0;

		if (!options->long_name)
			continue;

		rest = skip_prefix(arg, options->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(options->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;
				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 (strncmp(arg, "no-", 3))
				continue;
			flags |= OPT_UNSET;
			rest = skip_prefix(arg + 3, options->long_name);
			/* abbreviated and negated? */
			if (!rest && !prefixcmp(options->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);
	}

	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->flags & PARSE_OPT_OPTARG) ||
		    !(options->flags & PARSE_OPT_NOARG))
			die("BUG: dashless options don't support arguments");
		if (!(options->flags & PARSE_OPT_NONEG))
			die("BUG: dashless options don't support negation");
		if (options->long_name)
			die("BUG: dashless options can't be long");
		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)) {
			if (opts->long_name) {
				error("`--%s` uses incompatible flags "
				      "LASTARG_DEFAULT and OPTARG", opts->long_name);
			} else {
				error("`-%c` uses incompatible flags "
				      "LASTARG_DEFAULT and OPTARG", opts->short_name);
			}
			err |= 1;
		}
	}

	if (err)
		exit(129);
}

void parse_options_start(struct parse_opt_ctx_t *ctx,
			 int argc, const char **argv, const char *prefix,
			 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");
}

static int usage_with_options_internal(const char * const *,
				       const struct option *, 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);

	parse_options_check(options);

	/* 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)
				break;
			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(usagestr, options);
			switch (parse_short_opt(ctx, options)) {
			case -1:
				return parse_options_usage(usagestr, options);
			case -2:
				goto unknown;
			}
			if (ctx->opt)
				check_typos(arg + 1, options);
			while (ctx->opt) {
				if (internal_help && *ctx->opt == 'h')
					return parse_options_usage(usagestr, options);
				switch (parse_short_opt(ctx, options)) {
				case -1:
					return parse_options_usage(usagestr, options);
				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(usagestr, options, 1);
		if (internal_help && !strcmp(arg + 2, "help"))
			return parse_options_usage(usagestr, options);
		switch (parse_long_opt(ctx, arg + 2, options)) {
		case -1:
			return parse_options_usage(usagestr, options);
		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, flags);
	switch (parse_options_step(&ctx, options, usagestr)) {
	case PARSE_OPT_HELP:
		exit(129);
	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);
	}

	return parse_options_end(&ctx);
}

static int usage_argh(const struct option *opts)
{
	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(stderr, s, opts->argh ? opts->argh : "...");
}

#define USAGE_OPTS_WIDTH 24
#define USAGE_GAP         2

static int usage_with_options_internal(const char * const *usagestr,
				const struct option *opts, int full)
{
	if (!usagestr)
		return PARSE_OPT_HELP;

	fprintf(stderr, "usage: %s\n", *usagestr++);
	while (*usagestr && **usagestr)
		fprintf(stderr, "   or: %s\n", *usagestr++);
	while (*usagestr) {
		fprintf(stderr, "%s%s\n",
				**usagestr ? "    " : "",
				*usagestr);
		usagestr++;
	}

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

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

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

		pos = fprintf(stderr, "    ");
		if (opts->short_name && !(opts->flags & PARSE_OPT_NEGHELP)) {
			if (opts->flags & PARSE_OPT_NODASH)
				pos += fprintf(stderr, "%c", opts->short_name);
			else
				pos += fprintf(stderr, "-%c", opts->short_name);
		}
		if (opts->long_name && opts->short_name)
			pos += fprintf(stderr, ", ");
		if (opts->long_name)
			pos += fprintf(stderr, "--%s%s",
				(opts->flags & PARSE_OPT_NEGHELP) ?  "no-" : "",
				opts->long_name);
		if (opts->type == OPTION_NUMBER)
			pos += fprintf(stderr, "-NUM");

		if (!(opts->flags & PARSE_OPT_NOARG))
			pos += usage_argh(opts);

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

	return PARSE_OPT_HELP;
}

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

void 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(const char * const *usagestr,
			       const struct option *opts)
{
	return usage_with_options_internal(usagestr, opts, 0);
}


/*----- some often used options -----*/
#include "cache.h"

int parse_opt_abbrev_cb(const struct option *opt, const char *arg, int unset)
{
	int v;

	if (!arg) {
		v = unset ? 0 : DEFAULT_ABBREV;
	} else {
		v = strtol(arg, (char **)&arg, 10);
		if (*arg)
			return opterror(opt, "expects a numerical value", 0);
		if (v && v < MINIMUM_ABBREV)
			v = MINIMUM_ABBREV;
		else if (v > 40)
			v = 40;
	}
	*(int *)(opt->value) = v;
	return 0;
}

int parse_opt_approxidate_cb(const struct option *opt, const char *arg,
			     int unset)
{
	*(unsigned long *)(opt->value) = approxidate(arg);
	return 0;
}

int parse_opt_verbosity_cb(const struct option *opt, const char *arg,
			   int unset)
{
	int *target = opt->value;

	if (unset)
		/* --no-quiet, --no-verbose */
		*target = 0;
	else if (opt->short_name == 'v') {
		if (*target >= 0)
			(*target)++;
		else
			*target = 1;
	} else {
		if (*target <= 0)
			(*target)--;
		else
			*target = -1;
	}
	return 0;
}

int parse_opt_with_commit(const struct option *opt, const char *arg, int unset)
{
	unsigned char sha1[20];
	struct commit *commit;

	if (!arg)
		return -1;
	if (get_sha1(arg, sha1))
		return error("malformed object name %s", arg);
	commit = lookup_commit_reference(sha1);
	if (!commit)
		return error("no such commit %s", arg);
	commit_list_insert(commit, opt->value);
	return 0;
}

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