2011-08-11 09:15:38 +00:00
|
|
|
#include "git-compat-util.h"
|
|
|
|
#include "parse-options.h"
|
|
|
|
#include "cache.h"
|
|
|
|
#include "commit.h"
|
|
|
|
#include "color.h"
|
|
|
|
#include "string-list.h"
|
2015-06-14 08:41:49 +00:00
|
|
|
#include "argv-array.h"
|
2015-07-07 16:06:08 +00:00
|
|
|
#include "sha1-array.h"
|
2011-08-11 09:15:38 +00:00
|
|
|
|
|
|
|
/*----- some often used options -----*/
|
|
|
|
|
|
|
|
int parse_opt_abbrev_cb(const struct option *opt, const char *arg, int unset)
|
|
|
|
{
|
|
|
|
int v;
|
|
|
|
|
|
|
|
if (!arg) {
|
|
|
|
v = unset ? 0 : DEFAULT_ABBREV;
|
|
|
|
} else {
|
2019-05-29 09:11:16 +00:00
|
|
|
if (!*arg)
|
|
|
|
return error(_("option `%s' expects a numerical value"),
|
|
|
|
opt->long_name);
|
2011-08-11 09:15:38 +00:00
|
|
|
v = strtol(arg, (char **)&arg, 10);
|
|
|
|
if (*arg)
|
2018-11-10 05:16:11 +00:00
|
|
|
return error(_("option `%s' expects a numerical value"),
|
|
|
|
opt->long_name);
|
2011-08-11 09:15:38 +00:00
|
|
|
if (v && v < MINIMUM_ABBREV)
|
|
|
|
v = MINIMUM_ABBREV;
|
2019-03-24 08:20:04 +00:00
|
|
|
else if (v > the_hash_algo->hexsz)
|
|
|
|
v = the_hash_algo->hexsz;
|
2011-08-11 09:15:38 +00:00
|
|
|
}
|
|
|
|
*(int *)(opt->value) = v;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
2013-04-25 18:13:49 +00:00
|
|
|
int parse_opt_expiry_date_cb(const struct option *opt, const char *arg,
|
|
|
|
int unset)
|
|
|
|
{
|
2018-04-21 03:13:13 +00:00
|
|
|
if (unset)
|
|
|
|
arg = "never";
|
|
|
|
if (parse_expiry_date(arg, (timestamp_t *)opt->value))
|
|
|
|
die(_("malformed expiration date '%s'"), arg);
|
|
|
|
return 0;
|
2013-04-25 18:13:49 +00:00
|
|
|
}
|
|
|
|
|
2011-08-11 09:15:38 +00:00
|
|
|
int parse_opt_color_flag_cb(const struct option *opt, const char *arg,
|
|
|
|
int unset)
|
|
|
|
{
|
|
|
|
int value;
|
|
|
|
|
|
|
|
if (!arg)
|
|
|
|
arg = unset ? "never" : (const char *)opt->defval;
|
2011-08-29 04:19:16 +00:00
|
|
|
value = git_config_colorbool(NULL, arg);
|
2011-08-11 09:15:38 +00:00
|
|
|
if (value < 0)
|
2018-11-10 05:16:11 +00:00
|
|
|
return error(_("option `%s' expects \"always\", \"auto\", or \"never\""),
|
|
|
|
opt->long_name);
|
2011-08-11 09:15:38 +00:00
|
|
|
*(int *)opt->value = value;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
int parse_opt_verbosity_cb(const struct option *opt, const char *arg,
|
|
|
|
int unset)
|
|
|
|
{
|
|
|
|
int *target = opt->value;
|
|
|
|
|
assert NOARG/NONEG behavior of parse-options callbacks
When we define a parse-options callback, the flags we put in the option
struct must match what the callback expects. For example, a callback
which does not handle the "unset" parameter should only be used with
PARSE_OPT_NONEG. But since the callback and the option struct are not
defined next to each other, it's easy to get this wrong (as earlier
patches in this series show).
Fortunately, the compiler can help us here: compiling with
-Wunused-parameters can show us which callbacks ignore their "unset"
parameters (and likewise, ones that ignore "arg" expect to be triggered
with PARSE_OPT_NOARG).
But after we've inspected a callback and determined that all of its
callers use the right flags, what do we do next? We'd like to silence
the compiler warning, but do so in a way that will catch any wrong calls
in the future.
We can do that by actually checking those variables and asserting that
they match our expectations. Because this is such a common pattern,
we'll introduce some helper macros. The resulting messages aren't
as descriptive as we could make them, but the file/line information from
BUG() is enough to identify the problem (and anyway, the point is that
these should never be seen).
Each of the annotated callbacks in this patch triggers
-Wunused-parameters, and was manually inspected to make sure all callers
use the correct options (so none of these BUGs should be triggerable).
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2018-11-05 06:45:42 +00:00
|
|
|
BUG_ON_OPT_ARG(arg);
|
|
|
|
|
2011-08-11 09:15:38 +00:00
|
|
|
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;
|
|
|
|
}
|
|
|
|
|
2015-07-07 16:06:14 +00:00
|
|
|
int parse_opt_commits(const struct option *opt, const char *arg, int unset)
|
2011-08-11 09:15:38 +00:00
|
|
|
{
|
2017-05-06 22:09:59 +00:00
|
|
|
struct object_id oid;
|
2011-08-11 09:15:38 +00:00
|
|
|
struct commit *commit;
|
|
|
|
|
assert NOARG/NONEG behavior of parse-options callbacks
When we define a parse-options callback, the flags we put in the option
struct must match what the callback expects. For example, a callback
which does not handle the "unset" parameter should only be used with
PARSE_OPT_NONEG. But since the callback and the option struct are not
defined next to each other, it's easy to get this wrong (as earlier
patches in this series show).
Fortunately, the compiler can help us here: compiling with
-Wunused-parameters can show us which callbacks ignore their "unset"
parameters (and likewise, ones that ignore "arg" expect to be triggered
with PARSE_OPT_NOARG).
But after we've inspected a callback and determined that all of its
callers use the right flags, what do we do next? We'd like to silence
the compiler warning, but do so in a way that will catch any wrong calls
in the future.
We can do that by actually checking those variables and asserting that
they match our expectations. Because this is such a common pattern,
we'll introduce some helper macros. The resulting messages aren't
as descriptive as we could make them, but the file/line information from
BUG() is enough to identify the problem (and anyway, the point is that
these should never be seen).
Each of the annotated callbacks in this patch triggers
-Wunused-parameters, and was manually inspected to make sure all callers
use the correct options (so none of these BUGs should be triggerable).
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2018-11-05 06:45:42 +00:00
|
|
|
BUG_ON_OPT_NEG(unset);
|
|
|
|
|
2011-08-11 09:15:38 +00:00
|
|
|
if (!arg)
|
|
|
|
return -1;
|
2017-05-06 22:09:59 +00:00
|
|
|
if (get_oid(arg, &oid))
|
2011-08-11 09:15:38 +00:00
|
|
|
return error("malformed object name %s", arg);
|
2018-06-29 01:21:58 +00:00
|
|
|
commit = lookup_commit_reference(the_repository, &oid);
|
2011-08-11 09:15:38 +00:00
|
|
|
if (!commit)
|
|
|
|
return error("no such commit %s", arg);
|
|
|
|
commit_list_insert(commit, opt->value);
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
2019-04-17 14:30:39 +00:00
|
|
|
int parse_opt_commit(const struct option *opt, const char *arg, int unset)
|
|
|
|
{
|
|
|
|
struct object_id oid;
|
|
|
|
struct commit *commit;
|
|
|
|
struct commit **target = opt->value;
|
|
|
|
|
|
|
|
if (!arg)
|
|
|
|
return -1;
|
|
|
|
if (get_oid(arg, &oid))
|
|
|
|
return error("malformed object name %s", arg);
|
|
|
|
commit = lookup_commit_reference(the_repository, &oid);
|
|
|
|
if (!commit)
|
|
|
|
return error("no such commit %s", arg);
|
|
|
|
*target = commit;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
2015-07-07 16:06:08 +00:00
|
|
|
int parse_opt_object_name(const struct option *opt, const char *arg, int unset)
|
|
|
|
{
|
2017-03-26 16:01:31 +00:00
|
|
|
struct object_id oid;
|
2015-07-07 16:06:08 +00:00
|
|
|
|
|
|
|
if (unset) {
|
2017-03-31 01:40:00 +00:00
|
|
|
oid_array_clear(opt->value);
|
2015-07-07 16:06:08 +00:00
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
if (!arg)
|
|
|
|
return -1;
|
2017-03-26 16:01:31 +00:00
|
|
|
if (get_oid(arg, &oid))
|
2015-07-07 16:06:08 +00:00
|
|
|
return error(_("malformed object name '%s'"), arg);
|
2017-03-31 01:40:00 +00:00
|
|
|
oid_array_append(opt->value, &oid);
|
2015-07-07 16:06:08 +00:00
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
2019-04-17 14:30:40 +00:00
|
|
|
int parse_opt_object_id(const struct option *opt, const char *arg, int unset)
|
|
|
|
{
|
|
|
|
struct object_id oid;
|
|
|
|
struct object_id *target = opt->value;
|
|
|
|
|
|
|
|
if (unset) {
|
|
|
|
*target = null_oid;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
if (!arg)
|
|
|
|
return -1;
|
|
|
|
if (get_oid(arg, &oid))
|
|
|
|
return error(_("malformed object name '%s'"), arg);
|
|
|
|
*target = oid;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
2011-08-11 09:15:38 +00:00
|
|
|
int parse_opt_tertiary(const struct option *opt, const char *arg, int unset)
|
|
|
|
{
|
|
|
|
int *target = opt->value;
|
assert NOARG/NONEG behavior of parse-options callbacks
When we define a parse-options callback, the flags we put in the option
struct must match what the callback expects. For example, a callback
which does not handle the "unset" parameter should only be used with
PARSE_OPT_NONEG. But since the callback and the option struct are not
defined next to each other, it's easy to get this wrong (as earlier
patches in this series show).
Fortunately, the compiler can help us here: compiling with
-Wunused-parameters can show us which callbacks ignore their "unset"
parameters (and likewise, ones that ignore "arg" expect to be triggered
with PARSE_OPT_NOARG).
But after we've inspected a callback and determined that all of its
callers use the right flags, what do we do next? We'd like to silence
the compiler warning, but do so in a way that will catch any wrong calls
in the future.
We can do that by actually checking those variables and asserting that
they match our expectations. Because this is such a common pattern,
we'll introduce some helper macros. The resulting messages aren't
as descriptive as we could make them, but the file/line information from
BUG() is enough to identify the problem (and anyway, the point is that
these should never be seen).
Each of the annotated callbacks in this patch triggers
-Wunused-parameters, and was manually inspected to make sure all callers
use the correct options (so none of these BUGs should be triggerable).
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2018-11-05 06:45:42 +00:00
|
|
|
|
|
|
|
BUG_ON_OPT_ARG(arg);
|
|
|
|
|
2011-08-11 09:15:38 +00:00
|
|
|
*target = unset ? 2 : 1;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
2016-07-05 20:44:47 +00:00
|
|
|
struct option *parse_options_concat(struct option *a, struct option *b)
|
2011-08-11 09:15:38 +00:00
|
|
|
{
|
2016-07-05 20:44:47 +00:00
|
|
|
struct option *ret;
|
|
|
|
size_t i, a_len = 0, b_len = 0;
|
|
|
|
|
|
|
|
for (i = 0; a[i].type != OPTION_END; i++)
|
|
|
|
a_len++;
|
|
|
|
for (i = 0; b[i].type != OPTION_END; i++)
|
|
|
|
b_len++;
|
|
|
|
|
|
|
|
ALLOC_ARRAY(ret, st_add3(a_len, b_len, 1));
|
|
|
|
for (i = 0; i < a_len; i++)
|
|
|
|
ret[i] = a[i];
|
|
|
|
for (i = 0; i < b_len; i++)
|
|
|
|
ret[a_len + i] = b[i];
|
|
|
|
ret[a_len + b_len] = b[b_len]; /* final OPTION_END */
|
|
|
|
|
|
|
|
return ret;
|
2011-08-11 09:15:38 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
int parse_opt_string_list(const struct option *opt, const char *arg, int unset)
|
|
|
|
{
|
|
|
|
struct string_list *v = opt->value;
|
|
|
|
|
|
|
|
if (unset) {
|
|
|
|
string_list_clear(v, 0);
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (!arg)
|
|
|
|
return -1;
|
|
|
|
|
parse_opt_string_list: stop allocating new strings
The parse_opt_string_list callback is basically a thin
wrapper to string_list_append() any string options we get.
However, it calls:
string_list_append(v, xstrdup(arg));
which duplicates the option value. This is wrong for two
reasons:
1. If the string list has strdup_strings set, then we are
making an extra copy, which is simply leaked.
2. If the string list does not have strdup_strings set,
then we pass memory ownership to the string list, but
it does not realize this. If we later call
string_list_clear(), which can happen if "--no-foo" is
passed, then we will leak all of the existing entries.
Instead, we should just pass the argument straight to
string_list_append, and it can decide whether to copy or not
based on its strdup_strings flag.
It's possible that some (buggy) caller could be relying on
this extra copy (e.g., because it parses some options from
an allocated argv array and then frees the array), but it's
not likely. For one, we generally only use parse_options on
the argv given to us in main(). And two, such a caller is
broken anyway, because other option types like OPT_STRING()
do not make such a copy. This patch brings us in line with
them.
Noticed-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com>
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2016-06-13 05:39:12 +00:00
|
|
|
string_list_append(v, arg);
|
2011-08-11 09:15:38 +00:00
|
|
|
return 0;
|
|
|
|
}
|
2011-09-28 17:44:30 +00:00
|
|
|
|
|
|
|
int parse_opt_noop_cb(const struct option *opt, const char *arg, int unset)
|
|
|
|
{
|
|
|
|
return 0;
|
|
|
|
}
|
2015-06-14 08:41:48 +00:00
|
|
|
|
2016-09-05 09:44:52 +00:00
|
|
|
/**
|
|
|
|
* Report that the option is unknown, so that other code can handle
|
|
|
|
* it. This can be used as a callback together with
|
|
|
|
* OPTION_LOWLEVEL_CALLBACK to allow an option to be documented in the
|
|
|
|
* "-h" output even if it's not being handled directly by
|
|
|
|
* parse_options().
|
|
|
|
*/
|
2019-01-27 00:35:27 +00:00
|
|
|
enum parse_opt_result parse_opt_unknown_cb(struct parse_opt_ctx_t *ctx,
|
2019-01-27 00:35:28 +00:00
|
|
|
const struct option *opt,
|
|
|
|
const char *arg, int unset)
|
2016-09-05 09:44:52 +00:00
|
|
|
{
|
2019-01-27 00:35:28 +00:00
|
|
|
BUG_ON_OPT_ARG(arg);
|
2019-01-27 00:35:27 +00:00
|
|
|
return PARSE_OPT_UNKNOWN;
|
2016-09-05 09:44:52 +00:00
|
|
|
}
|
|
|
|
|
2015-06-14 08:41:48 +00:00
|
|
|
/**
|
|
|
|
* Recreates the command-line option in the strbuf.
|
|
|
|
*/
|
|
|
|
static int recreate_opt(struct strbuf *sb, const struct option *opt,
|
|
|
|
const char *arg, int unset)
|
|
|
|
{
|
|
|
|
strbuf_reset(sb);
|
|
|
|
|
|
|
|
if (opt->long_name) {
|
|
|
|
strbuf_addstr(sb, unset ? "--no-" : "--");
|
|
|
|
strbuf_addstr(sb, opt->long_name);
|
|
|
|
if (arg) {
|
|
|
|
strbuf_addch(sb, '=');
|
|
|
|
strbuf_addstr(sb, arg);
|
|
|
|
}
|
|
|
|
} else if (opt->short_name && !unset) {
|
|
|
|
strbuf_addch(sb, '-');
|
|
|
|
strbuf_addch(sb, opt->short_name);
|
|
|
|
if (arg)
|
|
|
|
strbuf_addstr(sb, arg);
|
|
|
|
} else
|
|
|
|
return -1;
|
|
|
|
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* For an option opt, recreates the command-line option in opt->value which
|
|
|
|
* must be an char* initialized to NULL. This is useful when we need to pass
|
|
|
|
* the command-line option to another command. Since any previous value will be
|
|
|
|
* overwritten, this callback should only be used for options where the last
|
|
|
|
* one wins.
|
|
|
|
*/
|
|
|
|
int parse_opt_passthru(const struct option *opt, const char *arg, int unset)
|
|
|
|
{
|
|
|
|
static struct strbuf sb = STRBUF_INIT;
|
|
|
|
char **opt_value = opt->value;
|
|
|
|
|
|
|
|
if (recreate_opt(&sb, opt, arg, unset) < 0)
|
|
|
|
return -1;
|
|
|
|
|
2016-10-08 14:14:57 +00:00
|
|
|
free(*opt_value);
|
2015-06-14 08:41:48 +00:00
|
|
|
|
|
|
|
*opt_value = strbuf_detach(&sb, NULL);
|
|
|
|
|
|
|
|
return 0;
|
|
|
|
}
|
2015-06-14 08:41:49 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* For an option opt, recreate the command-line option, appending it to
|
|
|
|
* opt->value which must be a argv_array. This is useful when we need to pass
|
|
|
|
* the command-line option, which can be specified multiple times, to another
|
|
|
|
* command.
|
|
|
|
*/
|
|
|
|
int parse_opt_passthru_argv(const struct option *opt, const char *arg, int unset)
|
|
|
|
{
|
|
|
|
static struct strbuf sb = STRBUF_INIT;
|
|
|
|
struct argv_array *opt_value = opt->value;
|
|
|
|
|
|
|
|
if (recreate_opt(&sb, opt, arg, unset) < 0)
|
|
|
|
return -1;
|
|
|
|
|
|
|
|
argv_array_push(opt_value, sb.buf);
|
|
|
|
|
|
|
|
return 0;
|
|
|
|
}
|