Merge branch 'jk/fetch-pack' into maint
[git.git] / color.c
blob9027352ad7786746537adea9007bd46f46edbb4e
1 #include "cache.h"
2 #include "color.h"
4 static int git_use_color_default = GIT_COLOR_AUTO;
5 int color_stdout_is_tty = -1;
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,
26 /* Ignore the RESET at the end when giving the size */
27 const int column_colors_ansi_max = ARRAY_SIZE(column_colors_ansi) - 1;
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;
45 * "word" is a buffer of length "len"; does it match the NUL-terminated
46 * "match" exactly?
48 static int match_word(const char *word, int len, const char *match)
50 return !strncasecmp(word, match, len) && !match[len];
53 static int get_hex_color(const char *in, unsigned char *out)
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;
63 static int parse_color(struct color *out, const char *name, int len)
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"
70 char *end;
71 int i;
72 long val;
74 /* First try the special word "normal"... */
75 if (match_word(name, len, "normal")) {
76 out->type = COLOR_NORMAL;
77 return 0;
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;
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;
99 /* And finally try a literal 256-color-mode number */
100 val = strtol(name, &end, 10);
101 if (end - name == len) {
103 * Allow "-1" as an alias for "normal", but other negative
104 * numbers are bogus.
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 return 0;
116 } else if (val < 256) {
117 out->type = COLOR_256;
118 out->value = val;
119 return 0;
123 return -1;
126 static int parse_attr(const char *name, int len)
128 static const int attr_values[] = { 1, 2, 4, 5, 7,
129 22, 22, 24, 25, 27 };
130 static const char * const attr_names[] = {
131 "bold", "dim", "ul", "blink", "reverse",
132 "nobold", "nodim", "noul", "noblink", "noreverse"
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];
140 return -1;
143 int color_parse(const char *value, char *dst)
145 return color_parse_mem(value, strlen(value), dst);
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.
153 static char *color_output(char *out, const struct color *c, char type)
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;
166 case COLOR_RGB:
167 out += sprintf(out, "%c8;2;%d;%d;%d", type,
168 c->red, c->green, c->blue);
169 break;
171 return out;
174 static int color_empty(const struct color *c)
176 return c->type <= COLOR_NORMAL;
179 int color_parse_mem(const char *value, int value_len, char *dst)
181 const char *ptr = value;
182 int len = value_len;
183 unsigned int attr = 0;
184 struct color fg = { COLOR_UNSPECIFIED };
185 struct color bg = { COLOR_UNSPECIFIED };
187 if (!strncasecmp(value, "reset", len)) {
188 strcpy(dst, GIT_COLOR_RESET);
189 return 0;
192 /* [fg [bg]] [attr]... */
193 while (len > 0) {
194 const char *word = ptr;
195 struct color c;
196 int val, wordlen = 0;
198 while (len > 0 && !isspace(word[wordlen])) {
199 wordlen++;
200 len--;
203 ptr = word + wordlen;
204 while (len > 0 && isspace(*ptr)) {
205 ptr++;
206 len--;
209 if (!parse_color(&c, word, wordlen)) {
210 if (fg.type == COLOR_UNSPECIFIED) {
211 fg = c;
212 continue;
214 if (bg.type == COLOR_UNSPECIFIED) {
215 bg = c;
216 continue;
218 goto bad;
220 val = parse_attr(word, wordlen);
221 if (0 <= val)
222 attr |= (1 << val);
223 else
224 goto bad;
227 if (attr || !color_empty(&fg) || !color_empty(&bg)) {
228 int sep = 0;
229 int i;
231 *dst++ = '\033';
232 *dst++ = '[';
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 += sprintf(dst, "%d", i);
243 if (!color_empty(&fg)) {
244 if (sep++)
245 *dst++ = ';';
246 /* foreground colors are all in the 3x range */
247 dst = color_output(dst, &fg, '3');
249 if (!color_empty(&bg)) {
250 if (sep++)
251 *dst++ = ';';
252 /* background colors are all in the 4x range */
253 dst = color_output(dst, &bg, '4');
255 *dst++ = 'm';
257 *dst = 0;
258 return 0;
259 bad:
260 return error(_("invalid color value: %.*s"), value_len, value);
263 int git_config_colorbool(const char *var, const char *value)
265 if (value) {
266 if (!strcasecmp(value, "never"))
267 return 0;
268 if (!strcasecmp(value, "always"))
269 return 1;
270 if (!strcasecmp(value, "auto"))
271 return GIT_COLOR_AUTO;
274 if (!var)
275 return -1;
277 /* Missing or explicit false to turn off colorization */
278 if (!git_config_bool(var, value))
279 return 0;
281 /* any normal truth value defaults to 'auto' */
282 return GIT_COLOR_AUTO;
285 static int check_auto_color(void)
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)) {
290 char *term = getenv("TERM");
291 if (term && strcmp(term, "dumb"))
292 return 1;
294 return 0;
297 int want_color(int var)
299 static int want_auto = -1;
301 if (var < 0)
302 var = git_use_color_default;
304 if (var == GIT_COLOR_AUTO) {
305 if (want_auto < 0)
306 want_auto = check_auto_color();
307 return want_auto;
309 return var;
312 int git_color_config(const char *var, const char *value, void *cb)
314 if (!strcmp(var, "color.ui")) {
315 git_use_color_default = git_config_colorbool(var, value);
316 return 0;
319 return 0;
322 int git_color_default_config(const char *var, const char *value, void *cb)
324 if (git_color_config(var, value, cb) < 0)
325 return -1;
327 return git_default_config(var, value, cb);
330 void color_print_strbuf(FILE *fp, const char *color, const struct strbuf *sb)
332 if (*color)
333 fprintf(fp, "%s", color);
334 fprintf(fp, "%s", sb->buf);
335 if (*color)
336 fprintf(fp, "%s", GIT_COLOR_RESET);
339 static int color_vfprintf(FILE *fp, const char *color, const char *fmt,
340 va_list args, const char *trail)
342 int r = 0;
344 if (*color)
345 r += fprintf(fp, "%s", color);
346 r += vfprintf(fp, fmt, args);
347 if (*color)
348 r += fprintf(fp, "%s", GIT_COLOR_RESET);
349 if (trail)
350 r += fprintf(fp, "%s", trail);
351 return r;
356 int color_fprintf(FILE *fp, const char *color, const char *fmt, ...)
358 va_list args;
359 int r;
360 va_start(args, fmt);
361 r = color_vfprintf(fp, color, fmt, args, NULL);
362 va_end(args);
363 return r;
366 int color_fprintf_ln(FILE *fp, const char *color, const char *fmt, ...)
368 va_list args;
369 int r;
370 va_start(args, fmt);
371 r = color_vfprintf(fp, color, fmt, args, "\n");
372 va_end(args);
373 return r;
376 int color_is_nil(const char *c)
378 return !strcmp(c, "NIL");