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