color: add color_set helper for copying raw 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;
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
126static int parse_attr(const char *name, int len)
127{
ff40d185
JK
128 static const int attr_values[] = { 1, 2, 4, 5, 7,
129 22, 22, 24, 25, 27 };
7c92fe0e 130 static const char * const attr_names[] = {
ff40d185
JK
131 "bold", "dim", "ul", "blink", "reverse",
132 "nobold", "nodim", "noul", "noblink", "noreverse"
7c92fe0e
JK
133 };
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
f6c5a296 143int color_parse(const char *value, char *dst)
2c2dc7c8 144{
f6c5a296 145 return color_parse_mem(value, strlen(value), dst);
2c2dc7c8
RS
146}
147
7ce4fb94
JK
148void color_set(char *dst, const char *color_bytes)
149{
150 xsnprintf(dst, COLOR_MAXLEN, "%s", color_bytes);
151}
152
695d95df
JK
153/*
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 */
cbc8feea 158static char *color_output(char *out, int len, const struct color *c, char type)
695d95df
JK
159{
160 switch (c->type) {
161 case COLOR_UNSPECIFIED:
162 case COLOR_NORMAL:
163 break;
164 case COLOR_ANSI:
cbc8feea
JK
165 if (len < 2)
166 die("BUG: color parsing ran out of space");
695d95df
JK
167 *out++ = type;
168 *out++ = '0' + c->value;
169 break;
170 case COLOR_256:
cbc8feea 171 out += xsnprintf(out, len, "%c8;5;%d", type, c->value);
695d95df 172 break;
17a4be26 173 case COLOR_RGB:
cbc8feea
JK
174 out += xsnprintf(out, len, "%c8;2;%d;%d;%d", type,
175 c->red, c->green, c->blue);
17a4be26 176 break;
695d95df
JK
177 }
178 return out;
179}
180
181static int color_empty(const struct color *c)
182{
183 return c->type <= COLOR_NORMAL;
184}
185
f6c5a296 186int color_parse_mem(const char *value, int value_len, char *dst)
7c92fe0e
JK
187{
188 const char *ptr = value;
2c2dc7c8 189 int len = value_len;
cbc8feea 190 char *end = dst + COLOR_MAXLEN;
8b124135 191 unsigned int attr = 0;
695d95df
JK
192 struct color fg = { COLOR_UNSPECIFIED };
193 struct color bg = { COLOR_UNSPECIFIED };
7c92fe0e 194
2c2dc7c8 195 if (!strncasecmp(value, "reset", len)) {
cbc8feea 196 xsnprintf(dst, end - dst, GIT_COLOR_RESET);
f6c5a296 197 return 0;
7c92fe0e
JK
198 }
199
8b124135 200 /* [fg [bg]] [attr]... */
2c2dc7c8 201 while (len > 0) {
7c92fe0e 202 const char *word = ptr;
695d95df 203 struct color c;
2c2dc7c8 204 int val, wordlen = 0;
7c92fe0e 205
2c2dc7c8
RS
206 while (len > 0 && !isspace(word[wordlen])) {
207 wordlen++;
208 len--;
209 }
7c92fe0e 210
2c2dc7c8
RS
211 ptr = word + wordlen;
212 while (len > 0 && isspace(*ptr)) {
7c92fe0e 213 ptr++;
2c2dc7c8
RS
214 len--;
215 }
7c92fe0e 216
695d95df
JK
217 if (!parse_color(&c, word, wordlen)) {
218 if (fg.type == COLOR_UNSPECIFIED) {
219 fg = c;
7c92fe0e
JK
220 continue;
221 }
695d95df
JK
222 if (bg.type == COLOR_UNSPECIFIED) {
223 bg = c;
7c92fe0e
JK
224 continue;
225 }
226 goto bad;
227 }
2c2dc7c8 228 val = parse_attr(word, wordlen);
8b124135
JH
229 if (0 <= val)
230 attr |= (1 << val);
231 else
7c92fe0e 232 goto bad;
7c92fe0e
JK
233 }
234
cbc8feea
JK
235#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
695d95df 242 if (attr || !color_empty(&fg) || !color_empty(&bg)) {
7c92fe0e 243 int sep = 0;
8b124135 244 int i;
7c92fe0e 245
cbc8feea
JK
246 OUT('\033');
247 OUT('[');
8b124135
JH
248
249 for (i = 0; attr; i++) {
250 unsigned bit = (1 << i);
251 if (!(attr & bit))
252 continue;
253 attr &= ~bit;
254 if (sep++)
cbc8feea
JK
255 OUT(';');
256 dst += xsnprintf(dst, end - dst, "%d", i);
7c92fe0e 257 }
695d95df 258 if (!color_empty(&fg)) {
7c92fe0e 259 if (sep++)
cbc8feea 260 OUT(';');
71b59849 261 /* foreground colors are all in the 3x range */
cbc8feea 262 dst = color_output(dst, end - dst, &fg, '3');
7c92fe0e 263 }
695d95df 264 if (!color_empty(&bg)) {
7c92fe0e 265 if (sep++)
cbc8feea 266 OUT(';');
71b59849 267 /* background colors are all in the 4x range */
cbc8feea 268 dst = color_output(dst, end - dst, &bg, '4');
7c92fe0e 269 }
cbc8feea 270 OUT('m');
7c92fe0e 271 }
cbc8feea 272 OUT(0);
f6c5a296 273 return 0;
7c92fe0e 274bad:
f6c5a296 275 return error(_("invalid color value: %.*s"), value_len, value);
cbc8feea 276#undef OUT
7c92fe0e
JK
277}
278
e269eb79 279int git_config_colorbool(const char *var, const char *value)
7c92fe0e 280{
57f2b842
JH
281 if (value) {
282 if (!strcasecmp(value, "never"))
283 return 0;
284 if (!strcasecmp(value, "always"))
285 return 1;
286 if (!strcasecmp(value, "auto"))
daa0c3d9 287 return GIT_COLOR_AUTO;
7c92fe0e 288 }
57f2b842 289
73e9da01
ML
290 if (!var)
291 return -1;
292
57f2b842
JH
293 /* Missing or explicit false to turn off colorization */
294 if (!git_config_bool(var, value))
7c92fe0e 295 return 0;
57f2b842
JH
296
297 /* any normal truth value defaults to 'auto' */
daa0c3d9
JK
298 return GIT_COLOR_AUTO;
299}
300
301static int check_auto_color(void)
302{
e269eb79
JK
303 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)) {
57f2b842
JH
306 char *term = getenv("TERM");
307 if (term && strcmp(term, "dumb"))
308 return 1;
309 }
310 return 0;
7c92fe0e
JK
311}
312
daa0c3d9
JK
313int want_color(int var)
314{
315 static int want_auto = -1;
316
c9bfb953
JK
317 if (var < 0)
318 var = git_use_color_default;
319
daa0c3d9
JK
320 if (var == GIT_COLOR_AUTO) {
321 if (want_auto < 0)
322 want_auto = check_auto_color();
323 return want_auto;
324 }
c9bfb953 325 return var;
daa0c3d9
JK
326}
327
3e1dd17a 328int git_color_config(const char *var, const char *value, void *cb)
6b2f2d98
MK
329{
330 if (!strcmp(var, "color.ui")) {
e269eb79 331 git_use_color_default = git_config_colorbool(var, value);
6b2f2d98
MK
332 return 0;
333 }
334
3e1dd17a
JK
335 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
ef90d6d4 343 return git_default_config(var, value, cb);
6b2f2d98
MK
344}
345
becbdae8
JN
346void 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
f26a0012 355static int color_vfprintf(FILE *fp, const char *color, const char *fmt,
7c92fe0e
JK
356 va_list args, const char *trail)
357{
358 int r = 0;
359
360 if (*color)
f26a0012
KH
361 r += fprintf(fp, "%s", color);
362 r += vfprintf(fp, fmt, args);
7c92fe0e 363 if (*color)
dc6ebd4c 364 r += fprintf(fp, "%s", GIT_COLOR_RESET);
7c92fe0e 365 if (trail)
f26a0012 366 r += fprintf(fp, "%s", trail);
7c92fe0e
JK
367 return r;
368}
369
370
371
f26a0012 372int color_fprintf(FILE *fp, const char *color, const char *fmt, ...)
7c92fe0e
JK
373{
374 va_list args;
375 int r;
376 va_start(args, fmt);
f26a0012 377 r = color_vfprintf(fp, color, fmt, args, NULL);
7c92fe0e
JK
378 va_end(args);
379 return r;
380}
381
f26a0012 382int color_fprintf_ln(FILE *fp, const char *color, const char *fmt, ...)
7c92fe0e
JK
383{
384 va_list args;
385 int r;
386 va_start(args, fmt);
f26a0012 387 r = color_vfprintf(fp, color, fmt, args, "\n");
7c92fe0e
JK
388 va_end(args);
389 return r;
390}
148135fc
JK
391
392int color_is_nil(const char *c)
393{
394 return !strcmp(c, "NIL");
395}