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