color_parse: do not mention variable name in error message

Originally the color-parsing function was used only for
config variables. It made sense to pass the variable name so
that the die() message could be something like:

  $ git -c color.branch.plain=bogus branch
  fatal: bad color value 'bogus' for variable 'color.branch.plain'

These days we call it in other contexts, and the resulting
error messages are a little confusing:

  $ git log --pretty='%C(bogus)'
  fatal: bad color value 'bogus' for variable '--pretty format'

  $ git config --get-color foo.bar bogus
  fatal: bad color value 'bogus' for variable 'command line'

This patch teaches color_parse to complain only about the
value, and then return an error code. Config callers can
then propagate that up to the config parser, which mentions
the variable name. Other callers can provide a custom
message. After this patch these three cases now look like:

  $ git -c color.branch.plain=bogus branch
  error: invalid color value: bogus
  fatal: unable to parse 'color.branch.plain' from command-line config

  $ git log --pretty='%C(bogus)'
  error: invalid color value: bogus
  fatal: unable to parse --pretty format

  $ git config --get-color foo.bar bogus
  error: invalid color value: bogus
  fatal: unable to parse default color value

Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Jeff King 2014-10-07 15:33:09 -04:00 committed by Junio C Hamano
parent 8852117a60
commit f6c5a2968c
11 changed files with 26 additions and 28 deletions

@ -93,8 +93,7 @@ static int git_branch_config(const char *var, const char *value, void *cb)
return 0; return 0;
if (!value) if (!value)
return config_error_nonbool(var); return config_error_nonbool(var);
color_parse(value, var, branch_colors[slot]); return color_parse(value, branch_colors[slot]);
return 0;
} }
return git_color_default_config(var, value, cb); return git_color_default_config(var, value, cb);
} }

@ -116,8 +116,7 @@ static int git_clean_config(const char *var, const char *value, void *cb)
return 0; return 0;
if (!value) if (!value)
return config_error_nonbool(var); return config_error_nonbool(var);
color_parse(value, var, clean_colors[slot]); return color_parse(value, clean_colors[slot]);
return 0;
} }
if (!strcmp(var, "clean.requireforce")) { if (!strcmp(var, "clean.requireforce")) {

@ -1295,8 +1295,7 @@ static int git_status_config(const char *k, const char *v, void *cb)
return 0; return 0;
if (!v) if (!v)
return config_error_nonbool(k); return config_error_nonbool(k);
color_parse(v, k, s->color_palette[slot]); return color_parse(v, s->color_palette[slot]);
return 0;
} }
if (!strcmp(k, "status.relativepaths")) { if (!strcmp(k, "status.relativepaths")) {
s->relative_paths = git_config_bool(k, v); s->relative_paths = git_config_bool(k, v);

@ -296,7 +296,8 @@ static int git_get_color_config(const char *var, const char *value, void *cb)
if (!strcmp(var, get_color_slot)) { if (!strcmp(var, get_color_slot)) {
if (!value) if (!value)
config_error_nonbool(var); config_error_nonbool(var);
color_parse(value, var, parsed_color); if (color_parse(value, parsed_color) < 0)
return -1;
get_color_found = 1; get_color_found = 1;
} }
return 0; return 0;
@ -309,8 +310,10 @@ static void get_color(const char *def_color)
git_config_with_options(git_get_color_config, NULL, git_config_with_options(git_get_color_config, NULL,
&given_config_source, respect_includes); &given_config_source, respect_includes);
if (!get_color_found && def_color) if (!get_color_found && def_color) {
color_parse(def_color, "command line", parsed_color); if (color_parse(def_color, parsed_color) < 0)
die(_("unable to parse default color value"));
}
fputs(parsed_color, stdout); fputs(parsed_color, stdout);
} }

@ -673,7 +673,8 @@ static void populate_value(struct refinfo *ref)
} else if (starts_with(name, "color:")) { } else if (starts_with(name, "color:")) {
char color[COLOR_MAXLEN] = ""; char color[COLOR_MAXLEN] = "";
color_parse(name + 6, "--format", color); if (color_parse(name + 6, color) < 0)
die(_("unable to parse format"));
v->s = xstrdup(color); v->s = xstrdup(color);
continue; continue;
} else if (!strcmp(name, "flag")) { } else if (!strcmp(name, "flag")) {
@ -1007,7 +1008,8 @@ static void show_ref(struct refinfo *info, const char *format, int quote_style)
struct atom_value resetv; struct atom_value resetv;
char color[COLOR_MAXLEN] = ""; char color[COLOR_MAXLEN] = "";
color_parse("reset", "--format", color); if (color_parse("reset", color) < 0)
die("BUG: couldn't parse 'reset' as a color");
resetv.s = color; resetv.s = color;
print_value(&resetv, quote_style); print_value(&resetv, quote_style);
} }

13
color.c

@ -60,13 +60,12 @@ static int parse_attr(const char *name, int len)
return -1; return -1;
} }
void color_parse(const char *value, const char *var, char *dst) int color_parse(const char *value, char *dst)
{ {
color_parse_mem(value, strlen(value), var, dst); return color_parse_mem(value, strlen(value), dst);
} }
void color_parse_mem(const char *value, int value_len, const char *var, int color_parse_mem(const char *value, int value_len, char *dst)
char *dst)
{ {
const char *ptr = value; const char *ptr = value;
int len = value_len; int len = value_len;
@ -76,7 +75,7 @@ void color_parse_mem(const char *value, int value_len, const char *var,
if (!strncasecmp(value, "reset", len)) { if (!strncasecmp(value, "reset", len)) {
strcpy(dst, GIT_COLOR_RESET); strcpy(dst, GIT_COLOR_RESET);
return; return 0;
} }
/* [fg [bg]] [attr]... */ /* [fg [bg]] [attr]... */
@ -153,9 +152,9 @@ void color_parse_mem(const char *value, int value_len, const char *var,
*dst++ = 'm'; *dst++ = 'm';
} }
*dst = 0; *dst = 0;
return; return 0;
bad: bad:
die("bad color value '%.*s' for variable '%s'", value_len, value, var); return error(_("invalid color value: %.*s"), value_len, value);
} }
int git_config_colorbool(const char *var, const char *value) int git_config_colorbool(const char *var, const char *value)

@ -77,8 +77,8 @@ int git_color_default_config(const char *var, const char *value, void *cb);
int git_config_colorbool(const char *var, const char *value); int git_config_colorbool(const char *var, const char *value);
int want_color(int var); int want_color(int var);
void color_parse(const char *value, const char *var, char *dst); int color_parse(const char *value, char *dst);
void color_parse_mem(const char *value, int len, const char *var, char *dst); int color_parse_mem(const char *value, int len, char *dst);
__attribute__((format (printf, 3, 4))) __attribute__((format (printf, 3, 4)))
int color_fprintf(FILE *fp, const char *color, const char *fmt, ...); int color_fprintf(FILE *fp, const char *color, const char *fmt, ...);
__attribute__((format (printf, 3, 4))) __attribute__((format (printf, 3, 4)))

3
diff.c

@ -248,8 +248,7 @@ int git_diff_basic_config(const char *var, const char *value, void *cb)
return 0; return 0;
if (!value) if (!value)
return config_error_nonbool(var); return config_error_nonbool(var);
color_parse(value, var, diff_colors[slot]); return color_parse(value, diff_colors[slot]);
return 0;
} }
/* like GNU diff's --suppress-blank-empty option */ /* like GNU diff's --suppress-blank-empty option */

2
grep.c

@ -111,7 +111,7 @@ int grep_config(const char *var, const char *value, void *cb)
if (color) { if (color) {
if (!value) if (!value)
return config_error_nonbool(var); return config_error_nonbool(var);
color_parse(value, var, color); return color_parse(value, color);
} }
return 0; return 0;
} }

@ -73,8 +73,7 @@ int parse_decorate_color_config(const char *var, const char *slot_name, const ch
return 0; return 0;
if (!value) if (!value)
return config_error_nonbool(var); return config_error_nonbool(var);
color_parse(value, var, decoration_colors[slot]); return color_parse(value, decoration_colors[slot]);
return 0;
} }
/* /*

@ -979,9 +979,8 @@ static size_t parse_color(struct strbuf *sb, /* in UTF-8 */
return end - placeholder + 1; return end - placeholder + 1;
begin += 5; begin += 5;
} }
color_parse_mem(begin, if (color_parse_mem(begin, end - begin, color) < 0)
end - begin, die(_("unable to parse --pretty format"));
"--pretty format", color);
strbuf_addstr(sb, color); strbuf_addstr(sb, color);
return end - placeholder + 1; return end - placeholder + 1;
} }