blob: 8f85153d0d2c1f4bf9340ced9371797eb3c92de9 [file] [log] [blame]
Jeff King7c92fe02006-09-08 04:03:18 -04001#include "cache.h"
Junio C Hamano85023572006-12-19 14:34:12 -08002#include "color.h"
Jeff King7c92fe02006-09-08 04:03:18 -04003
Matthieu Moy4c7f1812013-06-10 16:26:09 +02004static int git_use_color_default = GIT_COLOR_AUTO;
Jeff Kinge269eb72011-08-17 22:03:48 -07005int color_stdout_is_tty = -1;
Matthias Kestenholz6b2f2d92008-02-18 08:26:03 +01006
Dan McGee7cd52b52011-04-05 00:40:23 -05007/*
8 * The list of available column colors.
9 */
10const char *column_colors_ansi[] = {
11 GIT_COLOR_RED,
12 GIT_COLOR_GREEN,
13 GIT_COLOR_YELLOW,
14 GIT_COLOR_BLUE,
15 GIT_COLOR_MAGENTA,
16 GIT_COLOR_CYAN,
17 GIT_COLOR_BOLD_RED,
18 GIT_COLOR_BOLD_GREEN,
19 GIT_COLOR_BOLD_YELLOW,
20 GIT_COLOR_BOLD_BLUE,
21 GIT_COLOR_BOLD_MAGENTA,
22 GIT_COLOR_BOLD_CYAN,
23 GIT_COLOR_RESET,
24};
25
26/* Ignore the RESET at the end when giving the size */
27const int column_colors_ansi_max = ARRAY_SIZE(column_colors_ansi) - 1;
28
Jeff King695d95d2014-11-20 10:17:05 -050029/* An individual foreground or background color. */
30struct color {
31 enum {
32 COLOR_UNSPECIFIED = 0,
33 COLOR_NORMAL,
34 COLOR_ANSI, /* basic 0-7 ANSI colors */
Jeff King17a4be22014-11-20 10:25:39 -050035 COLOR_256,
36 COLOR_RGB
Jeff King695d95d2014-11-20 10:17:05 -050037 } type;
38 /* The numeric value for ANSI and 256-color modes */
39 unsigned char value;
Jeff King17a4be22014-11-20 10:25:39 -050040 /* 24-bit RGB color values */
41 unsigned char red, green, blue;
Jeff King695d95d2014-11-20 10:17:05 -050042};
43
44/*
45 * "word" is a buffer of length "len"; does it match the NUL-terminated
46 * "match" exactly?
47 */
48static int match_word(const char *word, int len, const char *match)
Jeff King7c92fe02006-09-08 04:03:18 -040049{
Jeff King695d95d2014-11-20 10:17:05 -050050 return !strncasecmp(word, match, len) && !match[len];
51}
52
Jeff King17a4be22014-11-20 10:25:39 -050053static int get_hex_color(const char *in, unsigned char *out)
54{
55 unsigned int val;
56 val = (hexval(in[0]) << 4) | hexval(in[1]);
57 if (val & ~0xff)
58 return -1;
59 *out = val;
60 return 0;
61}
62
Jeff King695d95d2014-11-20 10:17:05 -050063static int parse_color(struct color *out, const char *name, int len)
64{
65 /* Positions in array must match ANSI color codes */
Jeff King7c92fe02006-09-08 04:03:18 -040066 static const char * const color_names[] = {
Jeff King695d95d2014-11-20 10:17:05 -050067 "black", "red", "green", "yellow",
Jeff King7c92fe02006-09-08 04:03:18 -040068 "blue", "magenta", "cyan", "white"
69 };
70 char *end;
71 int i;
Jeff King695d95d2014-11-20 10:17:05 -050072 long val;
73
74 /* First try the special word "normal"... */
75 if (match_word(name, len, "normal")) {
76 out->type = COLOR_NORMAL;
77 return 0;
Jeff King7c92fe02006-09-08 04:03:18 -040078 }
Jeff King695d95d2014-11-20 10:17:05 -050079
Jeff King17a4be22014-11-20 10:25:39 -050080 /* Try a 24-bit RGB value */
81 if (len == 7 && name[0] == '#') {
82 if (!get_hex_color(name + 1, &out->red) &&
83 !get_hex_color(name + 3, &out->green) &&
84 !get_hex_color(name + 5, &out->blue)) {
85 out->type = COLOR_RGB;
86 return 0;
87 }
88 }
89
Jeff King695d95d2014-11-20 10:17:05 -050090 /* Then pick from our human-readable color names... */
91 for (i = 0; i < ARRAY_SIZE(color_names); i++) {
92 if (match_word(name, len, color_names[i])) {
93 out->type = COLOR_ANSI;
94 out->value = i;
95 return 0;
96 }
97 }
98
99 /* And finally try a literal 256-color-mode number */
100 val = strtol(name, &end, 10);
101 if (end - name == len) {
102 /*
103 * Allow "-1" as an alias for "normal", but other negative
104 * numbers are bogus.
105 */
106 if (val < -1)
107 ; /* fall through to error */
108 else if (val < 0) {
109 out->type = COLOR_NORMAL;
110 return 0;
111 /* Rewrite low numbers as more-portable standard colors. */
112 } else if (val < 8) {
113 out->type = COLOR_ANSI;
114 out->value = val;
Jeff King3759d272015-01-20 17:14:48 -0500115 return 0;
Jeff King695d95d2014-11-20 10:17:05 -0500116 } else if (val < 256) {
117 out->type = COLOR_256;
118 out->value = val;
119 return 0;
120 }
121 }
122
123 return -1;
Jeff King7c92fe02006-09-08 04:03:18 -0400124}
125
126static int parse_attr(const char *name, int len)
127{
Jeff Kingff40d182014-11-20 10:25:52 -0500128 static const int attr_values[] = { 1, 2, 4, 5, 7,
129 22, 22, 24, 25, 27 };
Jeff King7c92fe02006-09-08 04:03:18 -0400130 static const char * const attr_names[] = {
Jeff Kingff40d182014-11-20 10:25:52 -0500131 "bold", "dim", "ul", "blink", "reverse",
132 "nobold", "nodim", "noul", "noblink", "noreverse"
Jeff King7c92fe02006-09-08 04:03:18 -0400133 };
134 int i;
135 for (i = 0; i < ARRAY_SIZE(attr_names); i++) {
136 const char *str = attr_names[i];
137 if (!strncasecmp(name, str, len) && !str[len])
138 return attr_values[i];
139 }
140 return -1;
141}
142
Jeff Kingf6c5a292014-10-07 15:33:09 -0400143int color_parse(const char *value, char *dst)
Jeff King7c92fe02006-09-08 04:03:18 -0400144{
Jeff Kingf6c5a292014-10-07 15:33:09 -0400145 return color_parse_mem(value, strlen(value), dst);
René Scharfe2c2dc7c2009-01-19 23:30:30 -0500146}
147
Jeff King7ce4fb92015-09-24 17:08:21 -0400148void color_set(char *dst, const char *color_bytes)
149{
150 xsnprintf(dst, COLOR_MAXLEN, "%s", color_bytes);
151}
152
Jeff King695d95d2014-11-20 10:17:05 -0500153/*
154 * Write the ANSI color codes for "c" to "out"; the string should
155 * already have the ANSI escape code in it. "out" should have enough
156 * space in it to fit any color.
157 */
Jeff Kingcbc8fee2015-09-24 17:08:07 -0400158static char *color_output(char *out, int len, const struct color *c, char type)
Jeff King695d95d2014-11-20 10:17:05 -0500159{
160 switch (c->type) {
161 case COLOR_UNSPECIFIED:
162 case COLOR_NORMAL:
163 break;
164 case COLOR_ANSI:
Jeff Kingcbc8fee2015-09-24 17:08:07 -0400165 if (len < 2)
166 die("BUG: color parsing ran out of space");
Jeff King695d95d2014-11-20 10:17:05 -0500167 *out++ = type;
168 *out++ = '0' + c->value;
169 break;
170 case COLOR_256:
Jeff Kingcbc8fee2015-09-24 17:08:07 -0400171 out += xsnprintf(out, len, "%c8;5;%d", type, c->value);
Jeff King695d95d2014-11-20 10:17:05 -0500172 break;
Jeff King17a4be22014-11-20 10:25:39 -0500173 case COLOR_RGB:
Jeff Kingcbc8fee2015-09-24 17:08:07 -0400174 out += xsnprintf(out, len, "%c8;2;%d;%d;%d", type,
175 c->red, c->green, c->blue);
Jeff King17a4be22014-11-20 10:25:39 -0500176 break;
Jeff King695d95d2014-11-20 10:17:05 -0500177 }
178 return out;
179}
180
181static int color_empty(const struct color *c)
182{
183 return c->type <= COLOR_NORMAL;
184}
185
Jeff Kingf6c5a292014-10-07 15:33:09 -0400186int color_parse_mem(const char *value, int value_len, char *dst)
René Scharfe2c2dc7c2009-01-19 23:30:30 -0500187{
Jeff King7c92fe02006-09-08 04:03:18 -0400188 const char *ptr = value;
René Scharfe2c2dc7c2009-01-19 23:30:30 -0500189 int len = value_len;
Jeff Kingcbc8fee2015-09-24 17:08:07 -0400190 char *end = dst + COLOR_MAXLEN;
Junio C Hamano8b124132010-02-27 18:56:38 -0800191 unsigned int attr = 0;
Jeff King695d95d2014-11-20 10:17:05 -0500192 struct color fg = { COLOR_UNSPECIFIED };
193 struct color bg = { COLOR_UNSPECIFIED };
Jeff King7c92fe02006-09-08 04:03:18 -0400194
René Scharfe2c2dc7c2009-01-19 23:30:30 -0500195 if (!strncasecmp(value, "reset", len)) {
Jeff Kingcbc8fee2015-09-24 17:08:07 -0400196 xsnprintf(dst, end - dst, GIT_COLOR_RESET);
Jeff Kingf6c5a292014-10-07 15:33:09 -0400197 return 0;
Jeff King7c92fe02006-09-08 04:03:18 -0400198 }
199
Junio C Hamano8b124132010-02-27 18:56:38 -0800200 /* [fg [bg]] [attr]... */
René Scharfe2c2dc7c2009-01-19 23:30:30 -0500201 while (len > 0) {
Jeff King7c92fe02006-09-08 04:03:18 -0400202 const char *word = ptr;
Jeff King695d95d2014-11-20 10:17:05 -0500203 struct color c;
René Scharfe2c2dc7c2009-01-19 23:30:30 -0500204 int val, wordlen = 0;
Jeff King7c92fe02006-09-08 04:03:18 -0400205
René Scharfe2c2dc7c2009-01-19 23:30:30 -0500206 while (len > 0 && !isspace(word[wordlen])) {
207 wordlen++;
208 len--;
209 }
Jeff King7c92fe02006-09-08 04:03:18 -0400210
René Scharfe2c2dc7c2009-01-19 23:30:30 -0500211 ptr = word + wordlen;
212 while (len > 0 && isspace(*ptr)) {
Jeff King7c92fe02006-09-08 04:03:18 -0400213 ptr++;
René Scharfe2c2dc7c2009-01-19 23:30:30 -0500214 len--;
215 }
Jeff King7c92fe02006-09-08 04:03:18 -0400216
Jeff King695d95d2014-11-20 10:17:05 -0500217 if (!parse_color(&c, word, wordlen)) {
218 if (fg.type == COLOR_UNSPECIFIED) {
219 fg = c;
Jeff King7c92fe02006-09-08 04:03:18 -0400220 continue;
221 }
Jeff King695d95d2014-11-20 10:17:05 -0500222 if (bg.type == COLOR_UNSPECIFIED) {
223 bg = c;
Jeff King7c92fe02006-09-08 04:03:18 -0400224 continue;
225 }
226 goto bad;
227 }
René Scharfe2c2dc7c2009-01-19 23:30:30 -0500228 val = parse_attr(word, wordlen);
Junio C Hamano8b124132010-02-27 18:56:38 -0800229 if (0 <= val)
230 attr |= (1 << val);
231 else
Jeff King7c92fe02006-09-08 04:03:18 -0400232 goto bad;
Jeff King7c92fe02006-09-08 04:03:18 -0400233 }
234
Jeff Kingcbc8fee2015-09-24 17:08:07 -0400235#undef OUT
236#define OUT(x) do { \
237 if (dst == end) \
238 die("BUG: color parsing ran out of space"); \
239 *dst++ = (x); \
240} while(0)
241
Jeff King695d95d2014-11-20 10:17:05 -0500242 if (attr || !color_empty(&fg) || !color_empty(&bg)) {
Jeff King7c92fe02006-09-08 04:03:18 -0400243 int sep = 0;
Junio C Hamano8b124132010-02-27 18:56:38 -0800244 int i;
Jeff King7c92fe02006-09-08 04:03:18 -0400245
Jeff Kingcbc8fee2015-09-24 17:08:07 -0400246 OUT('\033');
247 OUT('[');
Junio C Hamano8b124132010-02-27 18:56:38 -0800248
249 for (i = 0; attr; i++) {
250 unsigned bit = (1 << i);
251 if (!(attr & bit))
252 continue;
253 attr &= ~bit;
254 if (sep++)
Jeff Kingcbc8fee2015-09-24 17:08:07 -0400255 OUT(';');
256 dst += xsnprintf(dst, end - dst, "%d", i);
Jeff King7c92fe02006-09-08 04:03:18 -0400257 }
Jeff King695d95d2014-11-20 10:17:05 -0500258 if (!color_empty(&fg)) {
Jeff King7c92fe02006-09-08 04:03:18 -0400259 if (sep++)
Jeff Kingcbc8fee2015-09-24 17:08:07 -0400260 OUT(';');
Jeff King71b59842014-12-09 16:01:26 -0500261 /* foreground colors are all in the 3x range */
Jeff Kingcbc8fee2015-09-24 17:08:07 -0400262 dst = color_output(dst, end - dst, &fg, '3');
Jeff King7c92fe02006-09-08 04:03:18 -0400263 }
Jeff King695d95d2014-11-20 10:17:05 -0500264 if (!color_empty(&bg)) {
Jeff King7c92fe02006-09-08 04:03:18 -0400265 if (sep++)
Jeff Kingcbc8fee2015-09-24 17:08:07 -0400266 OUT(';');
Jeff King71b59842014-12-09 16:01:26 -0500267 /* background colors are all in the 4x range */
Jeff Kingcbc8fee2015-09-24 17:08:07 -0400268 dst = color_output(dst, end - dst, &bg, '4');
Jeff King7c92fe02006-09-08 04:03:18 -0400269 }
Jeff Kingcbc8fee2015-09-24 17:08:07 -0400270 OUT('m');
Jeff King7c92fe02006-09-08 04:03:18 -0400271 }
Jeff Kingcbc8fee2015-09-24 17:08:07 -0400272 OUT(0);
Jeff Kingf6c5a292014-10-07 15:33:09 -0400273 return 0;
Jeff King7c92fe02006-09-08 04:03:18 -0400274bad:
Jeff Kingf6c5a292014-10-07 15:33:09 -0400275 return error(_("invalid color value: %.*s"), value_len, value);
Jeff Kingcbc8fee2015-09-24 17:08:07 -0400276#undef OUT
Jeff King7c92fe02006-09-08 04:03:18 -0400277}
278
Jeff Kinge269eb72011-08-17 22:03:48 -0700279int git_config_colorbool(const char *var, const char *value)
Jeff King7c92fe02006-09-08 04:03:18 -0400280{
Junio C Hamano57f2b842007-11-26 14:30:28 -0800281 if (value) {
282 if (!strcasecmp(value, "never"))
283 return 0;
284 if (!strcasecmp(value, "always"))
285 return 1;
286 if (!strcasecmp(value, "auto"))
Jeff Kingdaa0c3d2011-08-17 22:04:23 -0700287 return GIT_COLOR_AUTO;
Jeff King7c92fe02006-09-08 04:03:18 -0400288 }
Junio C Hamano57f2b842007-11-26 14:30:28 -0800289
Mark Lodato73e9da02010-02-16 23:55:58 -0500290 if (!var)
291 return -1;
292
Junio C Hamano57f2b842007-11-26 14:30:28 -0800293 /* Missing or explicit false to turn off colorization */
294 if (!git_config_bool(var, value))
Jeff King7c92fe02006-09-08 04:03:18 -0400295 return 0;
Junio C Hamano57f2b842007-11-26 14:30:28 -0800296
297 /* any normal truth value defaults to 'auto' */
Jeff Kingdaa0c3d2011-08-17 22:04:23 -0700298 return GIT_COLOR_AUTO;
299}
300
301static int check_auto_color(void)
302{
Jeff Kinge269eb72011-08-17 22:03:48 -0700303 if (color_stdout_is_tty < 0)
304 color_stdout_is_tty = isatty(1);
305 if (color_stdout_is_tty || (pager_in_use() && pager_use_color)) {
Junio C Hamano57f2b842007-11-26 14:30:28 -0800306 char *term = getenv("TERM");
307 if (term && strcmp(term, "dumb"))
308 return 1;
309 }
310 return 0;
Jeff King7c92fe02006-09-08 04:03:18 -0400311}
312
Jeff Kingdaa0c3d2011-08-17 22:04:23 -0700313int want_color(int var)
314{
315 static int want_auto = -1;
316
Jeff Kingc9bfb952011-08-17 22:05:35 -0700317 if (var < 0)
318 var = git_use_color_default;
319
Jeff Kingdaa0c3d2011-08-17 22:04:23 -0700320 if (var == GIT_COLOR_AUTO) {
321 if (want_auto < 0)
322 want_auto = check_auto_color();
323 return want_auto;
324 }
Jeff Kingc9bfb952011-08-17 22:05:35 -0700325 return var;
Jeff Kingdaa0c3d2011-08-17 22:04:23 -0700326}
327
Jeff King3e1dd172011-08-17 22:05:08 -0700328int git_color_config(const char *var, const char *value, void *cb)
Matthias Kestenholz6b2f2d92008-02-18 08:26:03 +0100329{
330 if (!strcmp(var, "color.ui")) {
Jeff Kinge269eb72011-08-17 22:03:48 -0700331 git_use_color_default = git_config_colorbool(var, value);
Matthias Kestenholz6b2f2d92008-02-18 08:26:03 +0100332 return 0;
333 }
334
Jeff King3e1dd172011-08-17 22:05:08 -0700335 return 0;
336}
337
338int git_color_default_config(const char *var, const char *value, void *cb)
339{
340 if (git_color_config(var, value, cb) < 0)
341 return -1;
342
Johannes Schindelinef90d6d2008-05-14 18:46:53 +0100343 return git_default_config(var, value, cb);
Matthias Kestenholz6b2f2d92008-02-18 08:26:03 +0100344}
345
Jonathan Niederbecbdae2011-02-25 23:09:41 -0600346void color_print_strbuf(FILE *fp, const char *color, const struct strbuf *sb)
347{
348 if (*color)
349 fprintf(fp, "%s", color);
350 fprintf(fp, "%s", sb->buf);
351 if (*color)
352 fprintf(fp, "%s", GIT_COLOR_RESET);
353}
354
Kristian Høgsbergf26a0012007-09-17 20:06:42 -0400355static int color_vfprintf(FILE *fp, const char *color, const char *fmt,
Jeff King7c92fe02006-09-08 04:03:18 -0400356 va_list args, const char *trail)
357{
358 int r = 0;
359
360 if (*color)
Kristian Høgsbergf26a0012007-09-17 20:06:42 -0400361 r += fprintf(fp, "%s", color);
362 r += vfprintf(fp, fmt, args);
Jeff King7c92fe02006-09-08 04:03:18 -0400363 if (*color)
Arjen Laarhovendc6ebd42009-02-13 22:53:40 +0100364 r += fprintf(fp, "%s", GIT_COLOR_RESET);
Jeff King7c92fe02006-09-08 04:03:18 -0400365 if (trail)
Kristian Høgsbergf26a0012007-09-17 20:06:42 -0400366 r += fprintf(fp, "%s", trail);
Jeff King7c92fe02006-09-08 04:03:18 -0400367 return r;
368}
369
370
371
Kristian Høgsbergf26a0012007-09-17 20:06:42 -0400372int color_fprintf(FILE *fp, const char *color, const char *fmt, ...)
Jeff King7c92fe02006-09-08 04:03:18 -0400373{
374 va_list args;
375 int r;
376 va_start(args, fmt);
Kristian Høgsbergf26a0012007-09-17 20:06:42 -0400377 r = color_vfprintf(fp, color, fmt, args, NULL);
Jeff King7c92fe02006-09-08 04:03:18 -0400378 va_end(args);
379 return r;
380}
381
Kristian Høgsbergf26a0012007-09-17 20:06:42 -0400382int color_fprintf_ln(FILE *fp, const char *color, const char *fmt, ...)
Jeff King7c92fe02006-09-08 04:03:18 -0400383{
384 va_list args;
385 int r;
386 va_start(args, fmt);
Kristian Høgsbergf26a0012007-09-17 20:06:42 -0400387 r = color_vfprintf(fp, color, fmt, args, "\n");
Jeff King7c92fe02006-09-08 04:03:18 -0400388 va_end(args);
389 return r;
390}
Jeff King148135f2010-12-09 12:27:08 -0500391
392int color_is_nil(const char *c)
393{
394 return !strcmp(c, "NIL");
395}