diff-highlight: allow configurable colors
[git/git.git] / color.c
CommitLineData
7c92fe0e 1#include "cache.h"
85023577 2#include "color.h"
7c92fe0e 3
4c7f1819 4static int git_use_color_default = GIT_COLOR_AUTO;
e269eb79 5int color_stdout_is_tty = -1;
6b2f2d98 6
7cd52b5b
DM
7/*
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
695d95df
JK
29/* 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 */
17a4be26
JK
35 COLOR_256,
36 COLOR_RGB
695d95df
JK
37 } type;
38 /* The numeric value for ANSI and 256-color modes */
39 unsigned char value;
17a4be26
JK
40 /* 24-bit RGB color values */
41 unsigned char red, green, blue;
695d95df
JK
42};
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)
7c92fe0e 49{
695d95df
JK
50 return !strncasecmp(word, match, len) && !match[len];
51}
52
17a4be26
JK
53static 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
695d95df
JK
63static int parse_color(struct color *out, const char *name, int len)
64{
65 /* Positions in array must match ANSI color codes */
7c92fe0e 66 static const char * const color_names[] = {
695d95df 67 "black", "red", "green", "yellow",
7c92fe0e
JK
68 "blue", "magenta", "cyan", "white"
69 };
70 char *end;
71 int i;
695d95df
JK
72 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;
78 }
79
17a4be26
JK
80 /* 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
695d95df 90 /* Then pick from our human-readable color names... */
7c92fe0e 91 for (i = 0; i < ARRAY_SIZE(color_names); i++) {
695d95df
JK
92 if (match_word(name, len, color_names[i])) {
93 out->type = COLOR_ANSI;
94 out->value = i;
95 return 0;
96 }
7c92fe0e 97 }
695d95df
JK
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;
115 } else if (val < 256) {
116 out->type = COLOR_256;
117 out->value = val;
118 return 0;
119 }
120 }
121
122 return -1;
7c92fe0e
JK
123}
124
125static int parse_attr(const char *name, int len)
126{
ff40d185
JK
127 static const int attr_values[] = { 1, 2, 4, 5, 7,
128 22, 22, 24, 25, 27 };
7c92fe0e 129 static const char * const attr_names[] = {
ff40d185
JK
130 "bold", "dim", "ul", "blink", "reverse",
131 "nobold", "nodim", "noul", "noblink", "noreverse"
7c92fe0e
JK
132 };
133 int i;
134 for (i = 0; i < ARRAY_SIZE(attr_names); i++) {
135 const char *str = attr_names[i];
136 if (!strncasecmp(name, str, len) && !str[len])
137 return attr_values[i];
138 }
139 return -1;
140}
141
f6c5a296 142int color_parse(const char *value, char *dst)
2c2dc7c8 143{
f6c5a296 144 return color_parse_mem(value, strlen(value), dst);
2c2dc7c8
RS
145}
146
695d95df
JK
147#define COLOR_FOREGROUND '3'
148#define COLOR_BACKGROUND '4'
149
150/*
151 * Write the ANSI color codes for "c" to "out"; the string should
152 * already have the ANSI escape code in it. "out" should have enough
153 * space in it to fit any color.
154 */
155static char *color_output(char *out, const struct color *c, char type)
156{
157 switch (c->type) {
158 case COLOR_UNSPECIFIED:
159 case COLOR_NORMAL:
160 break;
161 case COLOR_ANSI:
162 *out++ = type;
163 *out++ = '0' + c->value;
164 break;
165 case COLOR_256:
166 out += sprintf(out, "%c8;5;%d", type, c->value);
167 break;
17a4be26
JK
168 case COLOR_RGB:
169 out += sprintf(out, "%c8;2;%d;%d;%d", type,
170 c->red, c->green, c->blue);
171 break;
695d95df
JK
172 }
173 return out;
174}
175
176static int color_empty(const struct color *c)
177{
178 return c->type <= COLOR_NORMAL;
179}
180
f6c5a296 181int color_parse_mem(const char *value, int value_len, char *dst)
7c92fe0e
JK
182{
183 const char *ptr = value;
2c2dc7c8 184 int len = value_len;
8b124135 185 unsigned int attr = 0;
695d95df
JK
186 struct color fg = { COLOR_UNSPECIFIED };
187 struct color bg = { COLOR_UNSPECIFIED };
7c92fe0e 188
2c2dc7c8 189 if (!strncasecmp(value, "reset", len)) {
dc6ebd4c 190 strcpy(dst, GIT_COLOR_RESET);
f6c5a296 191 return 0;
7c92fe0e
JK
192 }
193
8b124135 194 /* [fg [bg]] [attr]... */
2c2dc7c8 195 while (len > 0) {
7c92fe0e 196 const char *word = ptr;
695d95df 197 struct color c;
2c2dc7c8 198 int val, wordlen = 0;
7c92fe0e 199
2c2dc7c8
RS
200 while (len > 0 && !isspace(word[wordlen])) {
201 wordlen++;
202 len--;
203 }
7c92fe0e 204
2c2dc7c8
RS
205 ptr = word + wordlen;
206 while (len > 0 && isspace(*ptr)) {
7c92fe0e 207 ptr++;
2c2dc7c8
RS
208 len--;
209 }
7c92fe0e 210
695d95df
JK
211 if (!parse_color(&c, word, wordlen)) {
212 if (fg.type == COLOR_UNSPECIFIED) {
213 fg = c;
7c92fe0e
JK
214 continue;
215 }
695d95df
JK
216 if (bg.type == COLOR_UNSPECIFIED) {
217 bg = c;
7c92fe0e
JK
218 continue;
219 }
220 goto bad;
221 }
2c2dc7c8 222 val = parse_attr(word, wordlen);
8b124135
JH
223 if (0 <= val)
224 attr |= (1 << val);
225 else
7c92fe0e 226 goto bad;
7c92fe0e
JK
227 }
228
695d95df 229 if (attr || !color_empty(&fg) || !color_empty(&bg)) {
7c92fe0e 230 int sep = 0;
8b124135 231 int i;
7c92fe0e
JK
232
233 *dst++ = '\033';
234 *dst++ = '[';
8b124135
JH
235
236 for (i = 0; attr; i++) {
237 unsigned bit = (1 << i);
238 if (!(attr & bit))
239 continue;
240 attr &= ~bit;
241 if (sep++)
242 *dst++ = ';';
ff40d185 243 dst += sprintf(dst, "%d", i);
7c92fe0e 244 }
695d95df 245 if (!color_empty(&fg)) {
7c92fe0e
JK
246 if (sep++)
247 *dst++ = ';';
695d95df 248 dst = color_output(dst, &fg, COLOR_FOREGROUND);
7c92fe0e 249 }
695d95df 250 if (!color_empty(&bg)) {
7c92fe0e
JK
251 if (sep++)
252 *dst++ = ';';
695d95df 253 dst = color_output(dst, &bg, COLOR_BACKGROUND);
7c92fe0e
JK
254 }
255 *dst++ = 'm';
256 }
257 *dst = 0;
f6c5a296 258 return 0;
7c92fe0e 259bad:
f6c5a296 260 return error(_("invalid color value: %.*s"), value_len, value);
7c92fe0e
JK
261}
262
e269eb79 263int git_config_colorbool(const char *var, const char *value)
7c92fe0e 264{
57f2b842
JH
265 if (value) {
266 if (!strcasecmp(value, "never"))
267 return 0;
268 if (!strcasecmp(value, "always"))
269 return 1;
270 if (!strcasecmp(value, "auto"))
daa0c3d9 271 return GIT_COLOR_AUTO;
7c92fe0e 272 }
57f2b842 273
73e9da01
ML
274 if (!var)
275 return -1;
276
57f2b842
JH
277 /* Missing or explicit false to turn off colorization */
278 if (!git_config_bool(var, value))
7c92fe0e 279 return 0;
57f2b842
JH
280
281 /* any normal truth value defaults to 'auto' */
daa0c3d9
JK
282 return GIT_COLOR_AUTO;
283}
284
285static int check_auto_color(void)
286{
e269eb79
JK
287 if (color_stdout_is_tty < 0)
288 color_stdout_is_tty = isatty(1);
289 if (color_stdout_is_tty || (pager_in_use() && pager_use_color)) {
57f2b842
JH
290 char *term = getenv("TERM");
291 if (term && strcmp(term, "dumb"))
292 return 1;
293 }
294 return 0;
7c92fe0e
JK
295}
296
daa0c3d9
JK
297int want_color(int var)
298{
299 static int want_auto = -1;
300
c9bfb953
JK
301 if (var < 0)
302 var = git_use_color_default;
303
daa0c3d9
JK
304 if (var == GIT_COLOR_AUTO) {
305 if (want_auto < 0)
306 want_auto = check_auto_color();
307 return want_auto;
308 }
c9bfb953 309 return var;
daa0c3d9
JK
310}
311
3e1dd17a 312int git_color_config(const char *var, const char *value, void *cb)
6b2f2d98
MK
313{
314 if (!strcmp(var, "color.ui")) {
e269eb79 315 git_use_color_default = git_config_colorbool(var, value);
6b2f2d98
MK
316 return 0;
317 }
318
3e1dd17a
JK
319 return 0;
320}
321
322int git_color_default_config(const char *var, const char *value, void *cb)
323{
324 if (git_color_config(var, value, cb) < 0)
325 return -1;
326
ef90d6d4 327 return git_default_config(var, value, cb);
6b2f2d98
MK
328}
329
becbdae8
JN
330void color_print_strbuf(FILE *fp, const char *color, const struct strbuf *sb)
331{
332 if (*color)
333 fprintf(fp, "%s", color);
334 fprintf(fp, "%s", sb->buf);
335 if (*color)
336 fprintf(fp, "%s", GIT_COLOR_RESET);
337}
338
f26a0012 339static int color_vfprintf(FILE *fp, const char *color, const char *fmt,
7c92fe0e
JK
340 va_list args, const char *trail)
341{
342 int r = 0;
343
344 if (*color)
f26a0012
KH
345 r += fprintf(fp, "%s", color);
346 r += vfprintf(fp, fmt, args);
7c92fe0e 347 if (*color)
dc6ebd4c 348 r += fprintf(fp, "%s", GIT_COLOR_RESET);
7c92fe0e 349 if (trail)
f26a0012 350 r += fprintf(fp, "%s", trail);
7c92fe0e
JK
351 return r;
352}
353
354
355
f26a0012 356int color_fprintf(FILE *fp, const char *color, const char *fmt, ...)
7c92fe0e
JK
357{
358 va_list args;
359 int r;
360 va_start(args, fmt);
f26a0012 361 r = color_vfprintf(fp, color, fmt, args, NULL);
7c92fe0e
JK
362 va_end(args);
363 return r;
364}
365
f26a0012 366int color_fprintf_ln(FILE *fp, const char *color, const char *fmt, ...)
7c92fe0e
JK
367{
368 va_list args;
369 int r;
370 va_start(args, fmt);
f26a0012 371 r = color_vfprintf(fp, color, fmt, args, "\n");
7c92fe0e
JK
372 va_end(args);
373 return r;
374}
148135fc
JK
375
376int color_is_nil(const char *c)
377{
378 return !strcmp(c, "NIL");
379}