mirror of
https://github.com/git/git.git
synced 2024-11-14 13:13:01 +01:00
f6c5a2968c
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>
90 lines
3.1 KiB
C
90 lines
3.1 KiB
C
#ifndef COLOR_H
|
|
#define COLOR_H
|
|
|
|
struct strbuf;
|
|
|
|
/* 2 + (2 * num_attrs) + 8 + 1 + 8 + 'm' + NUL */
|
|
/* "\033[1;2;4;5;7;38;5;2xx;48;5;2xxm\0" */
|
|
/*
|
|
* The maximum length of ANSI color sequence we would generate:
|
|
* - leading ESC '[' 2
|
|
* - attr + ';' 2 * 8 (e.g. "1;")
|
|
* - fg color + ';' 9 (e.g. "38;5;2xx;")
|
|
* - fg color + ';' 9 (e.g. "48;5;2xx;")
|
|
* - terminating 'm' NUL 2
|
|
*
|
|
* The above overcounts attr (we only use 5 not 8) and one semicolon
|
|
* but it is close enough.
|
|
*/
|
|
#define COLOR_MAXLEN 40
|
|
|
|
/*
|
|
* IMPORTANT: Due to the way these color codes are emulated on Windows,
|
|
* write them only using printf(), fprintf(), and fputs(). In particular,
|
|
* do not use puts() or write().
|
|
*/
|
|
#define GIT_COLOR_NORMAL ""
|
|
#define GIT_COLOR_RESET "\033[m"
|
|
#define GIT_COLOR_BOLD "\033[1m"
|
|
#define GIT_COLOR_RED "\033[31m"
|
|
#define GIT_COLOR_GREEN "\033[32m"
|
|
#define GIT_COLOR_YELLOW "\033[33m"
|
|
#define GIT_COLOR_BLUE "\033[34m"
|
|
#define GIT_COLOR_MAGENTA "\033[35m"
|
|
#define GIT_COLOR_CYAN "\033[36m"
|
|
#define GIT_COLOR_BOLD_RED "\033[1;31m"
|
|
#define GIT_COLOR_BOLD_GREEN "\033[1;32m"
|
|
#define GIT_COLOR_BOLD_YELLOW "\033[1;33m"
|
|
#define GIT_COLOR_BOLD_BLUE "\033[1;34m"
|
|
#define GIT_COLOR_BOLD_MAGENTA "\033[1;35m"
|
|
#define GIT_COLOR_BOLD_CYAN "\033[1;36m"
|
|
#define GIT_COLOR_BG_RED "\033[41m"
|
|
#define GIT_COLOR_BG_GREEN "\033[42m"
|
|
#define GIT_COLOR_BG_YELLOW "\033[43m"
|
|
#define GIT_COLOR_BG_BLUE "\033[44m"
|
|
#define GIT_COLOR_BG_MAGENTA "\033[45m"
|
|
#define GIT_COLOR_BG_CYAN "\033[46m"
|
|
|
|
/* A special value meaning "no color selected" */
|
|
#define GIT_COLOR_NIL "NIL"
|
|
|
|
/*
|
|
* The first three are chosen to match common usage in the code, and what is
|
|
* returned from git_config_colorbool. The "auto" value can be returned from
|
|
* config_colorbool, and will be converted by want_color() into either 0 or 1.
|
|
*/
|
|
#define GIT_COLOR_UNKNOWN -1
|
|
#define GIT_COLOR_NEVER 0
|
|
#define GIT_COLOR_ALWAYS 1
|
|
#define GIT_COLOR_AUTO 2
|
|
|
|
/* A default list of colors to use for commit graphs and show-branch output */
|
|
extern const char *column_colors_ansi[];
|
|
extern const int column_colors_ansi_max;
|
|
|
|
/*
|
|
* Generally the color code will lazily figure this out itself, but
|
|
* this provides a mechanism for callers to override autodetection.
|
|
*/
|
|
extern int color_stdout_is_tty;
|
|
|
|
/*
|
|
* Use the first one if you need only color config; the second is a convenience
|
|
* if you are just going to change to git_default_config, too.
|
|
*/
|
|
int git_color_config(const char *var, const char *value, void *cb);
|
|
int git_color_default_config(const char *var, const char *value, void *cb);
|
|
|
|
int git_config_colorbool(const char *var, const char *value);
|
|
int want_color(int var);
|
|
int color_parse(const char *value, char *dst);
|
|
int color_parse_mem(const char *value, int len, char *dst);
|
|
__attribute__((format (printf, 3, 4)))
|
|
int color_fprintf(FILE *fp, const char *color, const char *fmt, ...);
|
|
__attribute__((format (printf, 3, 4)))
|
|
int color_fprintf_ln(FILE *fp, const char *color, const char *fmt, ...);
|
|
void color_print_strbuf(FILE *fp, const char *color, const struct strbuf *sb);
|
|
|
|
int color_is_nil(const char *color);
|
|
|
|
#endif /* COLOR_H */
|