2006-09-08 08:03:18 +00:00
|
|
|
#ifndef COLOR_H
|
|
|
|
|
#define COLOR_H
|
|
|
|
|
|
2011-02-26 05:09:41 +00:00
|
|
|
struct strbuf;
|
|
|
|
|
|
2010-02-28 02:56:38 +00:00
|
|
|
/*
|
|
|
|
|
* The maximum length of ANSI color sequence we would generate:
|
|
|
|
|
* - leading ESC '[' 2
|
color: fix max-size comment
We use fixed-size buffers for colors, because we know our
parsing cannot grow beyond a particular bound. However, our
comment description has two issues:
1. It has the description in two forms: a short one, and
one with more explanation. Over time the latter has
been updated, but the former has not. Let's just drop
the short one (after making sure everything it says
is in the long one).
2. As of ff40d18 (parse_color: recognize "no$foo" to clear
the $foo attribute, 2014-11-20), the per-attribute size
bumped to "3" (because "nobold" is actually "21;"). But
that's not quite enough, as somebody may use both
"bold" and "nobold", requiring 5 characters.
This wasn't a problem for the final count, because we
over-estimated in other ways, but let's clarify how we
got to the final number.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2016-06-23 17:31:44 +00:00
|
|
|
* - attr + ';' 2 * num_attr (e.g. "1;")
|
|
|
|
|
* - no-attr + ';' 3 * num_attr (e.g. "22;")
|
2014-11-20 15:25:39 +00:00
|
|
|
* - fg color + ';' 17 (e.g. "38;2;255;255;255;")
|
|
|
|
|
* - bg color + ';' 17 (e.g. "48;2;255;255;255;")
|
2010-02-28 02:56:38 +00:00
|
|
|
* - terminating 'm' NUL 2
|
|
|
|
|
*
|
color: fix max-size comment
We use fixed-size buffers for colors, because we know our
parsing cannot grow beyond a particular bound. However, our
comment description has two issues:
1. It has the description in two forms: a short one, and
one with more explanation. Over time the latter has
been updated, but the former has not. Let's just drop
the short one (after making sure everything it says
is in the long one).
2. As of ff40d18 (parse_color: recognize "no$foo" to clear
the $foo attribute, 2014-11-20), the per-attribute size
bumped to "3" (because "nobold" is actually "21;"). But
that's not quite enough, as somebody may use both
"bold" and "nobold", requiring 5 characters.
This wasn't a problem for the final count, because we
over-estimated in other ways, but let's clarify how we
got to the final number.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2016-06-23 17:31:44 +00:00
|
|
|
* The above overcounts by one semicolon but it is close enough.
|
|
|
|
|
*
|
|
|
|
|
* The space for attributes is also slightly overallocated, as
|
|
|
|
|
* the negation for some attributes is the same (e.g., nobold and nodim).
|
2016-06-23 17:39:07 +00:00
|
|
|
*
|
2016-06-23 17:40:16 +00:00
|
|
|
* We allocate space for 7 attributes.
|
2010-02-28 02:56:38 +00:00
|
|
|
*/
|
2016-06-23 17:40:16 +00:00
|
|
|
#define COLOR_MAXLEN 75
|
2006-09-08 08:03:18 +00:00
|
|
|
|
2009-02-13 21:53:40 +00:00
|
|
|
#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"
|
2009-04-13 19:53:41 +00:00
|
|
|
#define GIT_COLOR_MAGENTA "\033[35m"
|
2009-02-13 21:53:40 +00:00
|
|
|
#define GIT_COLOR_CYAN "\033[36m"
|
2010-03-07 16:52:45 +00:00
|
|
|
#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"
|
2009-02-13 21:53:40 +00:00
|
|
|
#define GIT_COLOR_BG_RED "\033[41m"
|
2010-03-07 16:52:45 +00:00
|
|
|
#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"
|
2009-02-13 21:53:40 +00:00
|
|
|
|
2010-12-09 17:27:08 +00:00
|
|
|
/* A special value meaning "no color selected" */
|
|
|
|
|
#define GIT_COLOR_NIL "NIL"
|
|
|
|
|
|
color: delay auto-color decision until point of use
When we read a color value either from a config file or from
the command line, we use git_config_colorbool to convert it
from the tristate always/never/auto into a single yes/no
boolean value.
This has some timing implications with respect to starting
a pager.
If we start (or decide not to start) the pager before
checking the colorbool, everything is fine. Either isatty(1)
will give us the right information, or we will properly
check for pager_in_use().
However, if we decide to start a pager after we have checked
the colorbool, things are not so simple. If stdout is a tty,
then we will have already decided to use color. However, the
user may also have configured color.pager not to use color
with the pager. In this case, we need to actually turn off
color. Unfortunately, the pager code has no idea which color
variables were turned on (and there are many of them
throughout the code, and they may even have been manipulated
after the colorbool selection by something like "--color" on
the command line).
This bug can be seen any time a pager is started after
config and command line options are checked. This has
affected "git diff" since 89d07f7 (diff: don't run pager if
user asked for a diff style exit code, 2007-08-12). It has
also affect the log family since 1fda91b (Fix 'git log'
early pager startup error case, 2010-08-24).
This patch splits the notion of parsing a colorbool and
actually checking the configuration. The "use_color"
variables now have an additional possible value,
GIT_COLOR_AUTO. Users of the variable should use the new
"want_color()" wrapper, which will lazily determine and
cache the auto-color decision.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2011-08-18 05:04:23 +00:00
|
|
|
/*
|
|
|
|
|
* 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
|
|
|
|
|
|
2011-04-05 05:40:23 +00:00
|
|
|
/* 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;
|
2008-02-18 07:26:03 +00:00
|
|
|
|
2011-08-18 05:03:48 +00:00
|
|
|
/*
|
|
|
|
|
* 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;
|
|
|
|
|
|
2008-02-18 07:26:03 +00:00
|
|
|
/*
|
2011-08-18 05:05:08 +00:00
|
|
|
* 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.
|
2008-02-18 07:26:03 +00:00
|
|
|
*/
|
2011-08-18 05:05:08 +00:00
|
|
|
int git_color_config(const char *var, const char *value, void *cb);
|
2008-05-14 17:46:53 +00:00
|
|
|
int git_color_default_config(const char *var, const char *value, void *cb);
|
2008-02-18 07:26:03 +00:00
|
|
|
|
2015-09-24 21:08:21 +00:00
|
|
|
/*
|
|
|
|
|
* Set the color buffer (which must be COLOR_MAXLEN bytes)
|
|
|
|
|
* to the raw color bytes; this is useful for initializing
|
|
|
|
|
* default color variables.
|
|
|
|
|
*/
|
|
|
|
|
void color_set(char *dst, const char *color_bytes);
|
|
|
|
|
|
2011-08-18 05:03:48 +00:00
|
|
|
int git_config_colorbool(const char *var, const char *value);
|
color: delay auto-color decision until point of use
When we read a color value either from a config file or from
the command line, we use git_config_colorbool to convert it
from the tristate always/never/auto into a single yes/no
boolean value.
This has some timing implications with respect to starting
a pager.
If we start (or decide not to start) the pager before
checking the colorbool, everything is fine. Either isatty(1)
will give us the right information, or we will properly
check for pager_in_use().
However, if we decide to start a pager after we have checked
the colorbool, things are not so simple. If stdout is a tty,
then we will have already decided to use color. However, the
user may also have configured color.pager not to use color
with the pager. In this case, we need to actually turn off
color. Unfortunately, the pager code has no idea which color
variables were turned on (and there are many of them
throughout the code, and they may even have been manipulated
after the colorbool selection by something like "--color" on
the command line).
This bug can be seen any time a pager is started after
config and command line options are checked. This has
affected "git diff" since 89d07f7 (diff: don't run pager if
user asked for a diff style exit code, 2007-08-12). It has
also affect the log family since 1fda91b (Fix 'git log'
early pager startup error case, 2010-08-24).
This patch splits the notion of parsing a colorbool and
actually checking the configuration. The "use_color"
variables now have an additional possible value,
GIT_COLOR_AUTO. Users of the variable should use the new
"want_color()" wrapper, which will lazily determine and
cache the auto-color decision.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2011-08-18 05:04:23 +00:00
|
|
|
int want_color(int var);
|
2014-10-07 19:33:09 +00:00
|
|
|
int color_parse(const char *value, char *dst);
|
|
|
|
|
int color_parse_mem(const char *value, int len, char *dst);
|
2009-11-14 21:33:13 +00:00
|
|
|
__attribute__((format (printf, 3, 4)))
|
2007-09-18 00:06:42 +00:00
|
|
|
int color_fprintf(FILE *fp, const char *color, const char *fmt, ...);
|
2009-11-14 21:33:13 +00:00
|
|
|
__attribute__((format (printf, 3, 4)))
|
2007-09-18 00:06:42 +00:00
|
|
|
int color_fprintf_ln(FILE *fp, const char *color, const char *fmt, ...);
|
2011-02-26 05:09:41 +00:00
|
|
|
void color_print_strbuf(FILE *fp, const char *color, const struct strbuf *sb);
|
2006-09-08 08:03:18 +00:00
|
|
|
|
2010-12-09 17:27:08 +00:00
|
|
|
int color_is_nil(const char *color);
|
|
|
|
|
|
2006-09-08 08:03:18 +00:00
|
|
|
#endif /* COLOR_H */
|