]> rtime.felk.cvut.cz Git - git.git/blob - color.c
Merge branch 'jc/checkout-local-track-report'
[git.git] / color.c
1 #include "cache.h"
2 #include "color.h"
3
4 static int git_use_color_default = GIT_COLOR_AUTO;
5 int color_stdout_is_tty = -1;
6
7 /*
8  * The list of available column colors.
9  */
10 const 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 */
27 const int column_colors_ansi_max = ARRAY_SIZE(column_colors_ansi) - 1;
28
29 /* An individual foreground or background color. */
30 struct color {
31         enum {
32                 COLOR_UNSPECIFIED = 0,
33                 COLOR_NORMAL,
34                 COLOR_ANSI, /* basic 0-7 ANSI colors */
35                 COLOR_256,
36                 COLOR_RGB
37         } type;
38         /* The numeric value for ANSI and 256-color modes */
39         unsigned char value;
40         /* 24-bit RGB color values */
41         unsigned char red, green, blue;
42 };
43
44 /*
45  * "word" is a buffer of length "len"; does it match the NUL-terminated
46  * "match" exactly?
47  */
48 static int match_word(const char *word, int len, const char *match)
49 {
50         return !strncasecmp(word, match, len) && !match[len];
51 }
52
53 static 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
63 static int parse_color(struct color *out, const char *name, int len)
64 {
65         /* Positions in array must match ANSI color codes */
66         static const char * const color_names[] = {
67                 "black", "red", "green", "yellow",
68                 "blue", "magenta", "cyan", "white"
69         };
70         char *end;
71         int i;
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
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
90         /* 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;
115                 } else if (val < 256) {
116                         out->type = COLOR_256;
117                         out->value = val;
118                         return 0;
119                 }
120         }
121
122         return -1;
123 }
124
125 static int parse_attr(const char *name, int len)
126 {
127         static const int attr_values[] = { 1, 2, 4, 5, 7,
128                                            22, 22, 24, 25, 27 };
129         static const char * const attr_names[] = {
130                 "bold", "dim", "ul", "blink", "reverse",
131                 "nobold", "nodim", "noul", "noblink", "noreverse"
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
142 int color_parse(const char *value, char *dst)
143 {
144         return color_parse_mem(value, strlen(value), dst);
145 }
146
147 /*
148  * Write the ANSI color codes for "c" to "out"; the string should
149  * already have the ANSI escape code in it. "out" should have enough
150  * space in it to fit any color.
151  */
152 static char *color_output(char *out, const struct color *c, char type)
153 {
154         switch (c->type) {
155         case COLOR_UNSPECIFIED:
156         case COLOR_NORMAL:
157                 break;
158         case COLOR_ANSI:
159                 *out++ = type;
160                 *out++ = '0' + c->value;
161                 break;
162         case COLOR_256:
163                 out += sprintf(out, "%c8;5;%d", type, c->value);
164                 break;
165         case COLOR_RGB:
166                 out += sprintf(out, "%c8;2;%d;%d;%d", type,
167                                c->red, c->green, c->blue);
168                 break;
169         }
170         return out;
171 }
172
173 static int color_empty(const struct color *c)
174 {
175         return c->type <= COLOR_NORMAL;
176 }
177
178 int color_parse_mem(const char *value, int value_len, char *dst)
179 {
180         const char *ptr = value;
181         int len = value_len;
182         unsigned int attr = 0;
183         struct color fg = { COLOR_UNSPECIFIED };
184         struct color bg = { COLOR_UNSPECIFIED };
185
186         if (!strncasecmp(value, "reset", len)) {
187                 strcpy(dst, GIT_COLOR_RESET);
188                 return 0;
189         }
190
191         /* [fg [bg]] [attr]... */
192         while (len > 0) {
193                 const char *word = ptr;
194                 struct color c;
195                 int val, wordlen = 0;
196
197                 while (len > 0 && !isspace(word[wordlen])) {
198                         wordlen++;
199                         len--;
200                 }
201
202                 ptr = word + wordlen;
203                 while (len > 0 && isspace(*ptr)) {
204                         ptr++;
205                         len--;
206                 }
207
208                 if (!parse_color(&c, word, wordlen)) {
209                         if (fg.type == COLOR_UNSPECIFIED) {
210                                 fg = c;
211                                 continue;
212                         }
213                         if (bg.type == COLOR_UNSPECIFIED) {
214                                 bg = c;
215                                 continue;
216                         }
217                         goto bad;
218                 }
219                 val = parse_attr(word, wordlen);
220                 if (0 <= val)
221                         attr |= (1 << val);
222                 else
223                         goto bad;
224         }
225
226         if (attr || !color_empty(&fg) || !color_empty(&bg)) {
227                 int sep = 0;
228                 int i;
229
230                 *dst++ = '\033';
231                 *dst++ = '[';
232
233                 for (i = 0; attr; i++) {
234                         unsigned bit = (1 << i);
235                         if (!(attr & bit))
236                                 continue;
237                         attr &= ~bit;
238                         if (sep++)
239                                 *dst++ = ';';
240                         dst += sprintf(dst, "%d", i);
241                 }
242                 if (!color_empty(&fg)) {
243                         if (sep++)
244                                 *dst++ = ';';
245                         /* foreground colors are all in the 3x range */
246                         dst = color_output(dst, &fg, '3');
247                 }
248                 if (!color_empty(&bg)) {
249                         if (sep++)
250                                 *dst++ = ';';
251                         /* background colors are all in the 4x range */
252                         dst = color_output(dst, &bg, '4');
253                 }
254                 *dst++ = 'm';
255         }
256         *dst = 0;
257         return 0;
258 bad:
259         return error(_("invalid color value: %.*s"), value_len, value);
260 }
261
262 int git_config_colorbool(const char *var, const char *value)
263 {
264         if (value) {
265                 if (!strcasecmp(value, "never"))
266                         return 0;
267                 if (!strcasecmp(value, "always"))
268                         return 1;
269                 if (!strcasecmp(value, "auto"))
270                         return GIT_COLOR_AUTO;
271         }
272
273         if (!var)
274                 return -1;
275
276         /* Missing or explicit false to turn off colorization */
277         if (!git_config_bool(var, value))
278                 return 0;
279
280         /* any normal truth value defaults to 'auto' */
281         return GIT_COLOR_AUTO;
282 }
283
284 static int check_auto_color(void)
285 {
286         if (color_stdout_is_tty < 0)
287                 color_stdout_is_tty = isatty(1);
288         if (color_stdout_is_tty || (pager_in_use() && pager_use_color)) {
289                 char *term = getenv("TERM");
290                 if (term && strcmp(term, "dumb"))
291                         return 1;
292         }
293         return 0;
294 }
295
296 int want_color(int var)
297 {
298         static int want_auto = -1;
299
300         if (var < 0)
301                 var = git_use_color_default;
302
303         if (var == GIT_COLOR_AUTO) {
304                 if (want_auto < 0)
305                         want_auto = check_auto_color();
306                 return want_auto;
307         }
308         return var;
309 }
310
311 int git_color_config(const char *var, const char *value, void *cb)
312 {
313         if (!strcmp(var, "color.ui")) {
314                 git_use_color_default = git_config_colorbool(var, value);
315                 return 0;
316         }
317
318         return 0;
319 }
320
321 int git_color_default_config(const char *var, const char *value, void *cb)
322 {
323         if (git_color_config(var, value, cb) < 0)
324                 return -1;
325
326         return git_default_config(var, value, cb);
327 }
328
329 void color_print_strbuf(FILE *fp, const char *color, const struct strbuf *sb)
330 {
331         if (*color)
332                 fprintf(fp, "%s", color);
333         fprintf(fp, "%s", sb->buf);
334         if (*color)
335                 fprintf(fp, "%s", GIT_COLOR_RESET);
336 }
337
338 static int color_vfprintf(FILE *fp, const char *color, const char *fmt,
339                 va_list args, const char *trail)
340 {
341         int r = 0;
342
343         if (*color)
344                 r += fprintf(fp, "%s", color);
345         r += vfprintf(fp, fmt, args);
346         if (*color)
347                 r += fprintf(fp, "%s", GIT_COLOR_RESET);
348         if (trail)
349                 r += fprintf(fp, "%s", trail);
350         return r;
351 }
352
353
354
355 int color_fprintf(FILE *fp, const char *color, const char *fmt, ...)
356 {
357         va_list args;
358         int r;
359         va_start(args, fmt);
360         r = color_vfprintf(fp, color, fmt, args, NULL);
361         va_end(args);
362         return r;
363 }
364
365 int color_fprintf_ln(FILE *fp, const char *color, const char *fmt, ...)
366 {
367         va_list args;
368         int r;
369         va_start(args, fmt);
370         r = color_vfprintf(fp, color, fmt, args, "\n");
371         va_end(args);
372         return r;
373 }
374
375 int color_is_nil(const char *c)
376 {
377         return !strcmp(c, "NIL");
378 }