Skip to content

Commit

Permalink
drop odd return value semantics from userdiff_config
Browse files Browse the repository at this point in the history
When the userdiff_config function was introduced in be58e70
(diff: unify external diff and funcname parsing code,
2008-10-05), it used a return value convention unlike any
other config callback. Like other callbacks, it used "-1" to
signal error. But it returned "1" to indicate that it found
something, and "0" otherwise; other callbacks simply
returned "0" to indicate that no error occurred.

This distinction was necessary at the time, because the
userdiff namespace overlapped slightly with the color
configuration namespace. So "diff.color.foo" could mean "the
'foo' slot of diff coloring" or "the 'foo' component of the
"color" userdiff driver". Because the color-parsing code
would die on an unknown color slot, we needed the userdiff
code to indicate that it had matched the variable, letting
us bypass the color-parsing code entirely.

Later, in 8b8e862 (ignore unknown color configuration,
2009-12-12), the color-parsing code learned to silently
ignore unknown slots. This means we no longer need to
protect userdiff-matched variables from reaching the
color-parsing code.

We can therefore change the userdiff_config calling
convention to a more normal one. This drops some code from
each caller, which is nice. But more importantly, it reduces
the cognitive load for readers who may wonder why
userdiff_config is unlike every other config callback.

There's no need to add a new test confirming that this
works; t4020 already contains a test that sets
diff.color.external.

Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
  • Loading branch information
peff authored and gitster committed Feb 7, 2012
1 parent 65da088 commit 6680a08
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 37 deletions.
8 changes: 1 addition & 7 deletions builtin/blame.c
Expand Up @@ -2050,14 +2050,8 @@ static int git_blame_config(const char *var, const char *value, void *cb)
return 0;
}

switch (userdiff_config(var, value)) {
case 0:
break;
case -1:
if (userdiff_config(var, value) < 0)
return -1;
default:
return 0;
}

return git_default_config(var, value, cb);
}
Expand Down
8 changes: 1 addition & 7 deletions builtin/cat-file.c
Expand Up @@ -226,14 +226,8 @@ static const char * const cat_file_usage[] = {

static int git_cat_file_config(const char *var, const char *value, void *cb)
{
switch (userdiff_config(var, value)) {
case 0:
break;
case -1:
if (userdiff_config(var, value) < 0)
return -1;
default:
return 0;
}

return git_default_config(var, value, cb);
}
Expand Down
7 changes: 2 additions & 5 deletions builtin/grep.c
Expand Up @@ -325,11 +325,8 @@ static int grep_config(const char *var, const char *value, void *cb)
struct grep_opt *opt = cb;
char *color = NULL;

switch (userdiff_config(var, value)) {
case 0: break;
case -1: return -1;
default: return 0;
}
if (userdiff_config(var, value) < 0)
return -1;

if (!strcmp(var, "grep.extendedregexp")) {
if (git_config_bool(var, value))
Expand Down
7 changes: 2 additions & 5 deletions diff.c
Expand Up @@ -177,11 +177,8 @@ int git_diff_basic_config(const char *var, const char *value, void *cb)
return 0;
}

switch (userdiff_config(var, value)) {
case 0: break;
case -1: return -1;
default: return 0;
}
if (userdiff_config(var, value) < 0)
return -1;

if (!prefixcmp(var, "diff.color.") || !prefixcmp(var, "color.diff.")) {
int slot = parse_diff_color_slot(var, 11);
Expand Down
19 changes: 6 additions & 13 deletions userdiff.c
Expand Up @@ -210,14 +210,7 @@ static int parse_funcname(struct userdiff_funcname *f, const char *k,
if (git_config_string(&f->pattern, k, v) < 0)
return -1;
f->cflags = cflags;
return 1;
}

static int parse_string(const char **d, const char *k, const char *v)
{
if (git_config_string(d, k, v) < 0)
return -1;
return 1;
return 0;
}

static int parse_tristate(int *b, const char *k, const char *v)
Expand All @@ -226,13 +219,13 @@ static int parse_tristate(int *b, const char *k, const char *v)
*b = -1;
else
*b = git_config_bool(k, v);
return 1;
return 0;
}

static int parse_bool(int *b, const char *k, const char *v)
{
*b = git_config_bool(k, v);
return 1;
return 0;
}

int userdiff_config(const char *k, const char *v)
Expand All @@ -246,13 +239,13 @@ int userdiff_config(const char *k, const char *v)
if ((drv = parse_driver(k, v, "binary")))
return parse_tristate(&drv->binary, k, v);
if ((drv = parse_driver(k, v, "command")))
return parse_string(&drv->external, k, v);
return git_config_string(&drv->external, k, v);
if ((drv = parse_driver(k, v, "textconv")))
return parse_string(&drv->textconv, k, v);
return git_config_string(&drv->textconv, k, v);
if ((drv = parse_driver(k, v, "cachetextconv")))
return parse_bool(&drv->textconv_want_cache, k, v);
if ((drv = parse_driver(k, v, "wordregex")))
return parse_string(&drv->word_regex, k, v);
return git_config_string(&drv->word_regex, k, v);

return 0;
}
Expand Down

0 comments on commit 6680a08

Please sign in to comment.