Files
git/parse-options-cb.c
Jeff King e9330ae4b8 color: use git_colorbool enum type to store colorbools
We traditionally used "int" to store and pass around the values defined
by "enum git_colorbool" (which were originally just #define macros).
Using an int doesn't produce incorrect results, but using the actual
enum makes the intent of the code more clear.

It would be nice if the compiler could catch cases where we used the
enum and an int interchangeably, since it's very easy to accidentally
check the boolean true/false of a colorbool like:

  if (branch_use_color)

This is wrong because GIT_COLOR_UNKNOWN and GIT_COLOR_AUTO evaluate to
true in C, even though we may ultimately decide not to use color. But C
is pretty happy to convert between ints and enums (even with various
-Wenum-* warnings). So this sadly doesn't protect us from such mistakes,
but it hopefully does make the code easier to read.

Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2025-09-16 17:59:53 -07:00

319 lines
6.9 KiB
C

#define USE_THE_REPOSITORY_VARIABLE
#include "git-compat-util.h"
#include "parse-options.h"
#include "branch.h"
#include "commit.h"
#include "color.h"
#include "date.h"
#include "environment.h"
#include "gettext.h"
#include "object-name.h"
#include "setup.h"
#include "string-list.h"
#include "strvec.h"
#include "oid-array.h"
/*----- 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 {
if (!*arg)
return error(_("option `%s' expects a numerical value"),
opt->long_name);
v = strtol(arg, (char **)&arg, 10);
if (*arg)
return error(_("option `%s' expects a numerical value"),
opt->long_name);
if (v && v < MINIMUM_ABBREV)
v = MINIMUM_ABBREV;
}
*(int *)(opt->value) = v;
return 0;
}
int parse_opt_expiry_date_cb(const struct option *opt, const char *arg,
int unset)
{
if (unset)
arg = "never";
if (parse_expiry_date(arg, (timestamp_t *)opt->value))
die(_("malformed expiration date '%s'"), arg);
return 0;
}
int parse_opt_color_flag_cb(const struct option *opt, const char *arg,
int unset)
{
enum git_colorbool value;
if (!arg)
arg = unset ? "never" : (const char *)opt->defval;
value = git_config_colorbool(NULL, arg);
if (value == GIT_COLOR_UNKNOWN)
return error(_("option `%s' expects \"always\", \"auto\", or \"never\""),
opt->long_name);
*(int *)opt->value = value;
return 0;
}
int parse_opt_verbosity_cb(const struct option *opt, const char *arg,
int unset)
{
int *target = opt->value;
BUG_ON_OPT_ARG(arg);
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_commits(const struct option *opt, const char *arg, int unset)
{
struct object_id oid;
struct commit *commit;
BUG_ON_OPT_NEG(unset);
if (!arg)
return -1;
if (repo_get_oid(the_repository, 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);
commit_list_insert(commit, opt->value);
return 0;
}
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;
BUG_ON_OPT_NEG(unset);
if (!arg)
return -1;
if (repo_get_oid(the_repository, 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;
}
int parse_opt_object_name(const struct option *opt, const char *arg, int unset)
{
struct object_id oid;
if (unset) {
oid_array_clear(opt->value);
return 0;
}
if (!arg)
return -1;
if (repo_get_oid(the_repository, arg, &oid))
return error(_("malformed object name '%s'"), arg);
oid_array_append(opt->value, &oid);
return 0;
}
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) {
oidcpy(target, null_oid(the_hash_algo));
return 0;
}
if (!arg)
return -1;
if (repo_get_oid(the_repository, arg, &oid))
return error(_("malformed object name '%s'"), arg);
*target = oid;
return 0;
}
int parse_opt_tertiary(const struct option *opt, const char *arg, int unset)
{
int *target = opt->value;
BUG_ON_OPT_ARG(arg);
*target = unset ? 2 : 1;
return 0;
}
static size_t parse_options_count(const struct option *opt)
{
size_t n = 0;
for (; opt && opt->type != OPTION_END; opt++)
n++;
return n;
}
struct option *parse_options_dup(const struct option *o)
{
struct option no_options[] = { OPT_END() };
return parse_options_concat(o, no_options);
}
struct option *parse_options_concat(const struct option *a,
const struct option *b)
{
struct option *ret;
size_t a_len = parse_options_count(a);
size_t b_len = parse_options_count(b);
ALLOC_ARRAY(ret, st_add3(a_len, b_len, 1));
COPY_ARRAY(ret, a, a_len);
COPY_ARRAY(ret + a_len, b, b_len + 1); /* + 1 for final OPTION_END */
return ret;
}
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;
string_list_append(v, arg);
return 0;
}
int parse_opt_strvec(const struct option *opt, const char *arg, int unset)
{
struct strvec *v = opt->value;
if (unset) {
strvec_clear(v);
return 0;
}
if (!arg)
return -1;
strvec_push(v, arg);
return 0;
}
int parse_opt_noop_cb(const struct option *opt UNUSED,
const char *arg UNUSED,
int unset UNUSED)
{
return 0;
}
/**
* 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;
free(*opt_value);
*opt_value = strbuf_detach(&sb, NULL);
return 0;
}
/**
* For an option opt, recreate the command-line option, appending it to
* opt->value which must be a strvec. 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 strvec *opt_value = opt->value;
if (recreate_opt(&sb, opt, arg, unset) < 0)
return -1;
strvec_push(opt_value, sb.buf);
return 0;
}
int parse_opt_tracking_mode(const struct option *opt, const char *arg, int unset)
{
if (unset)
*(enum branch_track *)opt->value = BRANCH_TRACK_NEVER;
else if (!arg || !strcmp(arg, "direct"))
*(enum branch_track *)opt->value = BRANCH_TRACK_EXPLICIT;
else if (!strcmp(arg, "inherit"))
*(enum branch_track *)opt->value = BRANCH_TRACK_INHERIT;
else
return error(_("option `%s' expects \"%s\" or \"%s\""),
"--track", "direct", "inherit");
return 0;
}