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

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

#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;
			}
			/* 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);
		}
	}
}

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);

	/* 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;
	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);
}

#define USAGE_OPTS_WIDTH 24
#define USAGE_GAP         2

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) {
			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", opts->long_name);
		if (opts->type == OPTION_NUMBER)
			pos += fprintf(stderr, "-NUM");

		switch (opts->type) {
		case OPTION_ARGUMENT:
			break;
		case OPTION_INTEGER:
			if (opts->flags & PARSE_OPT_OPTARG)
				if (opts->long_name)
					pos += fprintf(stderr, "[=<n>]");
				else
					pos += fprintf(stderr, "[<n>]");
			else
				pos += fprintf(stderr, " <n>");
			break;
		case OPTION_CALLBACK:
			if (opts->flags & PARSE_OPT_NOARG)
				break;
			/* FALLTHROUGH */
		case OPTION_FILENAME:
			/* FALLTHROUGH */
		case OPTION_STRING:
			if (opts->argh)
				pos += usage_argh(opts);
			else {
				if (opts->flags & PARSE_OPT_OPTARG)
					if (opts->long_name)
						pos += fprintf(stderr, "[=...]");
					else
						pos += fprintf(stderr, "[...]");
				else
					pos += fprintf(stderr, " ...");
			}
			break;
		default: /* OPTION_{BIT,BOOLEAN,NUMBER,SET_INT,SET_PTR} */
			break;
		}

		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);
}

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;
}
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 PH	5
	6	#define OPT_SHORT 1
	7	#define OPT_UNSET 2
	8
4a59fd13 PH	9	static int opterror(const struct option opt, const char reason, int flags)
	10	{
	11	if (flags & OPT_SHORT)
	12	return error("switch `%c' %s", opt->short_name, reason);
	13	if (flags & OPT_UNSET)
	14	return error("option `no-%s' %s", opt->long_name, reason);
	15	return error("option `%s' %s", opt->long_name, reason);
	16	}
	17
1cc6985c PH	18	static int get_arg(struct parse_opt_ctx_t p, const struct option opt,
	19	int flags, const char **arg)
	20	{
	21	if (p->opt) {
	22	*arg = p->opt;
	23	p->opt = NULL;
	24	} else if (p->argc == 1 && (opt->flags & PARSE_OPT_LASTARG_DEFAULT)) {
	25	arg = (const char )opt->defval;
d5d745f9	26	} else if (p->argc > 1) {
1cc6985c PH	27	p->argc--;
	28	arg = ++p->argv;
	29	} else
	30	return opterror(opt, "requires a value", flags);
	31	return 0;
	32	}
	33
df217ed6 SB	34	static void fix_filename(const char prefix, const char *file)
	35	{
	36	if (!file \|\| !file \|\| !prefix \|\| is_absolute_path(file)
	37	\|\| !strcmp("-", *file))
	38	return;
	39	file = xstrdup(prefix_filename(prefix, strlen(prefix), file));
	40	}
	41
7e7bbcb4	42	static int get_value(struct parse_opt_ctx_t *p,
1cc6985c	43	const struct option *opt, int flags)
4a59fd13	44	{
ffe659f9	45	const char s, arg;
db7244bd	46	const int unset = flags & OPT_UNSET;
df217ed6	47	int err;
4a59fd13	48
db7244bd	49	if (unset && p->opt)
4a59fd13	50	return opterror(opt, "takes no value", flags);
db7244bd PH	51	if (unset && (opt->flags & PARSE_OPT_NONEG))
db7244bd PH	52	return opterror(opt, "isn't available", flags);
4a59fd13	53
db7244bd PH	54	if (!(flags & OPT_SHORT) && p->opt) {
	55	switch (opt->type) {
	56	case OPTION_CALLBACK:
	57	if (!(opt->flags & PARSE_OPT_NOARG))
	58	break;
	59	/* FALLTHROUGH */
	60	case OPTION_BOOLEAN:
	61	case OPTION_BIT:
2f4b97f9	62	case OPTION_NEGBIT:
db7244bd PH	63	case OPTION_SET_INT:
db7244bd PH	64	case OPTION_SET_PTR:
4a59fd13	65	return opterror(opt, "takes no value", flags);
db7244bd PH	66	default:
	67	break;
	68	}
	69	}
	70
db7244bd PH	71	switch (opt->type) {
	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
db7244bd PH	86	case OPTION_BOOLEAN:
	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 PH	195	for (; options->type != OPTION_END; options++) {
	196	const char *rest;
	197	int flags = 0;
	198
	199	if (!options->long_name)
	200	continue;
	201
	202	rest = skip_prefix(arg, options->long_name);
580d5bff PH	203	if (options->type == OPTION_ARGUMENT) {
	204	if (!rest)
	205	continue;
	206	if (*rest == '=')
	207	return opterror(options, "takes no value", flags);
	208	if (*rest)
	209	continue;
	210	p->out[p->cpidx++] = arg - 2;
	211	return 0;
	212	}
4a59fd13	213	if (!rest) {
7f275b91 JS	214	/* abbreviated? */
	215	if (!strncmp(options->long_name, arg, arg_end - arg)) {
	216	is_abbreviated:
243e0614 JS	217	if (abbrev_option) {
	218	/*
	219	* If this is abbreviated, it is
	220	* ambiguous. So when there is no
	221	* exact match later, we need to
	222	* error out.
	223	*/
	224	ambiguous_option = abbrev_option;
	225	ambiguous_flags = abbrev_flags;
	226	}
7f275b91 JS	227	if (!(flags & OPT_UNSET) && *arg_end)
	228	p->opt = arg_end + 1;
	229	abbrev_option = options;
	230	abbrev_flags = flags;
	231	continue;
	232	}
	233	/* negated and abbreviated very much? */
	234	if (!prefixcmp("no-", arg)) {
	235	flags \|= OPT_UNSET;
	236	goto is_abbreviated;
	237	}
	238	/* negated? */
4a59fd13 PH	239	if (strncmp(arg, "no-", 3))
	240	continue;
	241	flags \|= OPT_UNSET;
	242	rest = skip_prefix(arg + 3, options->long_name);
7f275b91 JS	243	/* abbreviated and negated? */
	244	if (!rest && !prefixcmp(options->long_name, arg + 3))
	245	goto is_abbreviated;
4a59fd13 PH	246	if (!rest)
	247	continue;
	248	}
	249	if (*rest) {
	250	if (*rest != '=')
	251	continue;
	252	p->opt = rest + 1;
	253	}
	254	return get_value(p, options, flags);
	255	}
243e0614 JS	256
	257	if (ambiguous_option)
	258	return error("Ambiguous option: %s "
	259	"(could be --%s%s or --%s%s)",
	260	arg,
	261	(ambiguous_flags & OPT_UNSET) ? "no-" : "",
	262	ambiguous_option->long_name,
	263	(abbrev_flags & OPT_UNSET) ? "no-" : "",
	264	abbrev_option->long_name);
7f275b91 JS	265	if (abbrev_option)
7f275b91 JS	266	return get_value(p, abbrev_option, abbrev_flags);
07fe54db	267	return -2;
4a59fd13 PH	268	}
4a59fd13 PH	269
51a9949e RS	270	static int parse_nodash_opt(struct parse_opt_ctx_t p, const char arg,
	271	const struct option *options)
	272	{
	273	for (; options->type != OPTION_END; options++) {
	274	if (!(options->flags & PARSE_OPT_NODASH))
	275	continue;
	276	if ((options->flags & PARSE_OPT_OPTARG) \|\|
	277	!(options->flags & PARSE_OPT_NOARG))
	278	die("BUG: dashless options don't support arguments");
	279	if (!(options->flags & PARSE_OPT_NONEG))
	280	die("BUG: dashless options don't support negation");
	281	if (options->long_name)
	282	die("BUG: dashless options can't be long");
	283	if (options->short_name == arg[0] && arg[1] == '\0')
	284	return get_value(p, options, OPT_SHORT);
	285	}
	286	return -2;
	287	}
	288
1121a878	289	static void check_typos(const char arg, const struct option options)
3a9f0f41 PH	290	{
	291	if (strlen(arg) < 3)
	292	return;
	293
	294	if (!prefixcmp(arg, "no-")) {
	295	error ("did you mean `--%s` (with two dashes ?)", arg);
	296	exit(129);
	297	}
	298
	299	for (; options->type != OPTION_END; options++) {
	300	if (!options->long_name)
	301	continue;
	302	if (!prefixcmp(options->long_name, arg)) {
	303	error ("did you mean `--%s` (with two dashes ?)", arg);
	304	exit(129);
	305	}
	306	}
	307	}
	308
7e7bbcb4	309	void parse_options_start(struct parse_opt_ctx_t *ctx,
37782920 SB	310	int argc, const char *argv, const char prefix,
37782920 SB	311	int flags)
7e7bbcb4 PH	312	{
	313	memset(ctx, 0, sizeof(*ctx));
	314	ctx->argc = argc - 1;
	315	ctx->argv = argv + 1;
	316	ctx->out = argv;
37782920	317	ctx->prefix = prefix;
a32a4eaa	318	ctx->cpidx = ((flags & PARSE_OPT_KEEP_ARGV0) != 0);
7e7bbcb4	319	ctx->flags = flags;
0d260f9a RS	320	if ((flags & PARSE_OPT_KEEP_UNKNOWN) &&
	321	(flags & PARSE_OPT_STOP_AT_NON_OPTION))
	322	die("STOP_AT_NON_OPTION and KEEP_UNKNOWN don't go together");
7e7bbcb4 PH	323	}
7e7bbcb4 PH	324
ee68b87a	325	static int usage_with_options_internal(const char * const *,
ff43ec3e	326	const struct option *, int);
dd3bf0f4	327
ff43ec3e PH	328	int parse_options_step(struct parse_opt_ctx_t *ctx,
	329	const struct option *options,
	330	const char * const usagestr[])
4a59fd13	331	{
b92891f9 RS	332	int internal_help = !(ctx->flags & PARSE_OPT_NO_INTERNAL_HELP);
b92891f9 RS	333
26141b5b PH	334	/* we must reset ->opt, unknown short option leave it dangling */
	335	ctx->opt = NULL;
	336
ff43ec3e PH	337	for (; ctx->argc; ctx->argc--, ctx->argv++) {
ff43ec3e PH	338	const char *arg = ctx->argv[0];
4a59fd13 PH	339
4a59fd13 PH	340	if (*arg != '-' \|\| !arg[1]) {
51a9949e RS	341	if (parse_nodash_opt(ctx, arg, options) == 0)
51a9949e RS	342	continue;
ff43ec3e	343	if (ctx->flags & PARSE_OPT_STOP_AT_NON_OPTION)
a0ec9d25	344	break;
ff43ec3e	345	ctx->out[ctx->cpidx++] = ctx->argv[0];
4a59fd13 PH	346	continue;
	347	}
	348
	349	if (arg[1] != '-') {
ff43ec3e	350	ctx->opt = arg + 1;
b92891f9	351	if (internal_help && *ctx->opt == 'h')
ff43ec3e	352	return parse_options_usage(usagestr, options);
07fe54db PH	353	switch (parse_short_opt(ctx, options)) {
	354	case -1:
	355	return parse_options_usage(usagestr, options);
	356	case -2:
b5ce3a54	357	goto unknown;
07fe54db	358	}
ff43ec3e	359	if (ctx->opt)
3a9f0f41	360	check_typos(arg + 1, options);
ff43ec3e	361	while (ctx->opt) {
b92891f9	362	if (internal_help && *ctx->opt == 'h')
ff43ec3e	363	return parse_options_usage(usagestr, options);
07fe54db PH	364	switch (parse_short_opt(ctx, options)) {
	365	case -1:
	366	return parse_options_usage(usagestr, options);
	367	case -2:
26141b5b PH	368	/* fake a short option thing to hide the fact that we may have
	369	* started to parse aggregated stuff
	370	*
	371	* This is leaky, too bad.
	372	*/
	373	ctx->argv[0] = xstrdup(ctx->opt - 1);
	374	(char )ctx->argv[0] = '-';
b5ce3a54	375	goto unknown;
07fe54db	376	}
3a9f0f41	377	}
4a59fd13 PH	378	continue;
	379	}
	380
	381	if (!arg[2]) { /* "--" */
ff43ec3e PH	382	if (!(ctx->flags & PARSE_OPT_KEEP_DASHDASH)) {
	383	ctx->argc--;
	384	ctx->argv++;
4a59fd13 PH	385	}
	386	break;
	387	}
	388
b92891f9	389	if (internal_help && !strcmp(arg + 2, "help-all"))
ff43ec3e	390	return usage_with_options_internal(usagestr, options, 1);
b92891f9	391	if (internal_help && !strcmp(arg + 2, "help"))
ff43ec3e	392	return parse_options_usage(usagestr, options);
07fe54db PH	393	switch (parse_long_opt(ctx, arg + 2, options)) {
	394	case -1:
	395	return parse_options_usage(usagestr, options);
	396	case -2:
b5ce3a54	397	goto unknown;
07fe54db	398	}
b5ce3a54 RS	399	continue;
	400	unknown:
	401	if (!(ctx->flags & PARSE_OPT_KEEP_UNKNOWN))
	402	return PARSE_OPT_UNKNOWN;
	403	ctx->out[ctx->cpidx++] = ctx->argv[0];
	404	ctx->opt = NULL;
ff43ec3e PH	405	}
	406	return PARSE_OPT_DONE;
	407	}
	408
	409	int parse_options_end(struct parse_opt_ctx_t *ctx)
	410	{
	411	memmove(ctx->out + ctx->cpidx, ctx->argv, ctx->argc * sizeof(*ctx->out));
	412	ctx->out[ctx->cpidx + ctx->argc] = NULL;
	413	return ctx->cpidx + ctx->argc;
	414	}
	415
37782920 SB	416	int parse_options(int argc, const char *argv, const char prefix,
	417	const struct option options, const char const usagestr[],
	418	int flags)
ff43ec3e PH	419	{
	420	struct parse_opt_ctx_t ctx;
	421
37782920	422	parse_options_start(&ctx, argc, argv, prefix, flags);
ff43ec3e PH	423	switch (parse_options_step(&ctx, options, usagestr)) {
	424	case PARSE_OPT_HELP:
	425	exit(129);
	426	case PARSE_OPT_DONE:
	427	break;
	428	default: /* PARSE_OPT_UNKNOWN */
07fe54db PH	429	if (ctx.argv[0][1] == '-') {
	430	error("unknown option `%s'", ctx.argv[0] + 2);
	431	} else {
	432	error("unknown switch `%c'", *ctx.opt);
	433	}
	434	usage_with_options(usagestr, options);
4a59fd13 PH	435	}
4a59fd13 PH	436
7e7bbcb4	437	return parse_options_end(&ctx);
4a59fd13	438	}
d7a38c54	439
29f25d49 SB	440	static int usage_argh(const struct option *opts)
	441	{
	442	const char *s;
	443	int literal = opts->flags & PARSE_OPT_LITERAL_ARGHELP;
	444	if (opts->flags & PARSE_OPT_OPTARG)
	445	if (opts->long_name)
	446	s = literal ? "[=%s]" : "[=<%s>]";
	447	else
	448	s = literal ? "[%s]" : "[<%s>]";
	449	else
	450	s = literal ? " %s" : " <%s>";
	451	return fprintf(stderr, s, opts->argh);
	452	}
	453
d7a38c54 PH	454	#define USAGE_OPTS_WIDTH 24
	455	#define USAGE_GAP 2
	456
ee68b87a	457	int usage_with_options_internal(const char * const *usagestr,
ff43ec3e	458	const struct option *opts, int full)
d7a38c54	459	{
49b61802 RS	460	if (!usagestr)
	461	return PARSE_OPT_HELP;
	462
f389c808 AR	463	fprintf(stderr, "usage: %s\n", *usagestr++);
	464	while (usagestr && *usagestr)
	465	fprintf(stderr, " or: %s\n", *usagestr++);
44d86e91 JK	466	while (*usagestr) {
	467	fprintf(stderr, "%s%s\n",
	468	**usagestr ? " " : "",
	469	*usagestr);
	470	usagestr++;
	471	}
d7a38c54 PH	472
d7a38c54 PH	473	if (opts->type != OPTION_GROUP)
f389c808	474	fputc('\n', stderr);
d7a38c54 PH	475
	476	for (; opts->type != OPTION_END; opts++) {
	477	size_t pos;
	478	int pad;
	479
	480	if (opts->type == OPTION_GROUP) {
f389c808	481	fputc('\n', stderr);
d7a38c54	482	if (*opts->help)
f389c808	483	fprintf(stderr, "%s\n", opts->help);
d7a38c54 PH	484	continue;
d7a38c54 PH	485	}
dd3bf0f4 PH	486	if (!full && (opts->flags & PARSE_OPT_HIDDEN))
dd3bf0f4 PH	487	continue;
d7a38c54	488
f389c808	489	pos = fprintf(stderr, " ");
51a9949e RS	490	if (opts->short_name) {
	491	if (opts->flags & PARSE_OPT_NODASH)
	492	pos += fprintf(stderr, "%c", opts->short_name);
	493	else
	494	pos += fprintf(stderr, "-%c", opts->short_name);
	495	}
d7a38c54	496	if (opts->long_name && opts->short_name)
f389c808	497	pos += fprintf(stderr, ", ");
d7a38c54	498	if (opts->long_name)
f389c808	499	pos += fprintf(stderr, "--%s", opts->long_name);
e0319ff5 RS	500	if (opts->type == OPTION_NUMBER)
e0319ff5 RS	501	pos += fprintf(stderr, "-NUM");
d7a38c54 PH	502
d7a38c54 PH	503	switch (opts->type) {
580d5bff PH	504	case OPTION_ARGUMENT:
580d5bff PH	505	break;
d7a38c54	506	case OPTION_INTEGER:
ffe659f9	507	if (opts->flags & PARSE_OPT_OPTARG)
6422f633 MB	508	if (opts->long_name)
	509	pos += fprintf(stderr, "[=<n>]");
	510	else
	511	pos += fprintf(stderr, "[<n>]");
ffe659f9 PH	512	else
ffe659f9 PH	513	pos += fprintf(stderr, " <n>");
d7a38c54	514	break;
ffe659f9	515	case OPTION_CALLBACK:
f481e22a PH	516	if (opts->flags & PARSE_OPT_NOARG)
	517	break;
	518	/* FALLTHROUGH */
df217ed6 SB	519	case OPTION_FILENAME:
df217ed6 SB	520	/* FALLTHROUGH */
f481e22a	521	case OPTION_STRING:
29f25d49 SB	522	if (opts->argh)
	523	pos += usage_argh(opts);
	524	else {
ffe659f9	525	if (opts->flags & PARSE_OPT_OPTARG)
6422f633 MB	526	if (opts->long_name)
	527	pos += fprintf(stderr, "[=...]");
	528	else
	529	pos += fprintf(stderr, "[...]");
ffe659f9 PH	530	else
	531	pos += fprintf(stderr, " ...");
	532	}
d7a38c54	533	break;
e0319ff5	534	default: /* OPTION_{BIT,BOOLEAN,NUMBER,SET_INT,SET_PTR} */
d7a38c54 PH	535	break;
	536	}
	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
ee68b87a PH	558	int parse_options_usage(const char * const *usagestr,
	559	const struct option *opts)
	560	{
ff43ec3e	561	return usage_with_options_internal(usagestr, opts, 0);
ee68b87a PH	562	}
	563
	564
0ce865b1 PH	565	/----- some often used options -----/
0ce865b1 PH	566	#include "cache.h"
db7244bd	567
0ce865b1 PH	568	int parse_opt_abbrev_cb(const struct option opt, const char arg, int unset)
	569	{
	570	int v;
	571
	572	if (!arg) {
	573	v = unset ? 0 : DEFAULT_ABBREV;
	574	} else {
	575	v = strtol(arg, (char **)&arg, 10);
	576	if (*arg)
	577	return opterror(opt, "expects a numerical value", 0);
	578	if (v && v < MINIMUM_ABBREV)
	579	v = MINIMUM_ABBREV;
	580	else if (v > 40)
	581	v = 40;
	582	}
	583	(int )(opt->value) = v;
	584	return 0;
	585	}
1f4a711a MB	586
	587	int parse_opt_approxidate_cb(const struct option opt, const char arg,
	588	int unset)
	589	{
	590	(unsigned long )(opt->value) = approxidate(arg);
	591	return 0;
	592	}
dbd0f5c7	593
7f87aff2 TA	594	int parse_opt_verbosity_cb(const struct option opt, const char arg,
	595	int unset)
	596	{
	597	int *target = opt->value;
	598
	599	if (unset)
	600	/* --no-quiet, --no-verbose */
	601	*target = 0;
	602	else if (opt->short_name == 'v') {
	603	if (*target >= 0)
	604	(*target)++;
	605	else
	606	*target = 1;
	607	} else {
	608	if (*target <= 0)
	609	(*target)--;
	610	else
	611	*target = -1;
	612	}
	613	return 0;
	614	}
	615
269defdf JG	616	int parse_opt_with_commit(const struct option opt, const char arg, int unset)
	617	{
	618	unsigned char sha1[20];
	619	struct commit *commit;
	620
	621	if (!arg)
	622	return -1;
	623	if (get_sha1(arg, sha1))
	624	return error("malformed object name %s", arg);
	625	commit = lookup_commit_reference(sha1);
	626	if (!commit)
	627	return error("no such commit %s", arg);
	628	commit_list_insert(commit, opt->value);
	629	return 0;
	630	}