color.c 8.3 KB
Newer Older
1
#include "cache.h"
2
#include "config.h"
3
#include "color.h"
4

M
Matthieu Moy 已提交
5
static int git_use_color_default = GIT_COLOR_AUTO;
6
int color_stdout_is_tty = -1;
7

8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
/*
 * The list of available column colors.
 */
const char *column_colors_ansi[] = {
	GIT_COLOR_RED,
	GIT_COLOR_GREEN,
	GIT_COLOR_YELLOW,
	GIT_COLOR_BLUE,
	GIT_COLOR_MAGENTA,
	GIT_COLOR_CYAN,
	GIT_COLOR_BOLD_RED,
	GIT_COLOR_BOLD_GREEN,
	GIT_COLOR_BOLD_YELLOW,
	GIT_COLOR_BOLD_BLUE,
	GIT_COLOR_BOLD_MAGENTA,
	GIT_COLOR_BOLD_CYAN,
	GIT_COLOR_RESET,
};

/* Ignore the RESET at the end when giving the size */
const int column_colors_ansi_max = ARRAY_SIZE(column_colors_ansi) - 1;

J
Jeff King 已提交
30 31 32 33 34 35
/* An individual foreground or background color. */
struct color {
	enum {
		COLOR_UNSPECIFIED = 0,
		COLOR_NORMAL,
		COLOR_ANSI, /* basic 0-7 ANSI colors */
J
Jeff King 已提交
36 37
		COLOR_256,
		COLOR_RGB
J
Jeff King 已提交
38 39 40
	} type;
	/* The numeric value for ANSI and 256-color modes */
	unsigned char value;
J
Jeff King 已提交
41 42
	/* 24-bit RGB color values */
	unsigned char red, green, blue;
J
Jeff King 已提交
43 44 45 46 47 48 49
};

/*
 * "word" is a buffer of length "len"; does it match the NUL-terminated
 * "match" exactly?
 */
static int match_word(const char *word, int len, const char *match)
50
{
J
Jeff King 已提交
51 52 53
	return !strncasecmp(word, match, len) && !match[len];
}

J
Jeff King 已提交
54 55 56 57 58 59 60 61 62 63
static int get_hex_color(const char *in, unsigned char *out)
{
	unsigned int val;
	val = (hexval(in[0]) << 4) | hexval(in[1]);
	if (val & ~0xff)
		return -1;
	*out = val;
	return 0;
}

J
Jeff King 已提交
64 65 66
static int parse_color(struct color *out, const char *name, int len)
{
	/* Positions in array must match ANSI color codes */
67
	static const char * const color_names[] = {
J
Jeff King 已提交
68
		"black", "red", "green", "yellow",
69 70 71 72
		"blue", "magenta", "cyan", "white"
	};
	char *end;
	int i;
J
Jeff King 已提交
73 74 75 76 77 78 79 80
	long val;

	/* First try the special word "normal"... */
	if (match_word(name, len, "normal")) {
		out->type = COLOR_NORMAL;
		return 0;
	}

J
Jeff King 已提交
81 82 83 84 85 86 87 88 89 90
	/* Try a 24-bit RGB value */
	if (len == 7 && name[0] == '#') {
		if (!get_hex_color(name + 1, &out->red) &&
		    !get_hex_color(name + 3, &out->green) &&
		    !get_hex_color(name + 5, &out->blue)) {
			out->type = COLOR_RGB;
			return 0;
		}
	}

J
Jeff King 已提交
91
	/* Then pick from our human-readable color names... */
92
	for (i = 0; i < ARRAY_SIZE(color_names); i++) {
J
Jeff King 已提交
93 94 95 96 97
		if (match_word(name, len, color_names[i])) {
			out->type = COLOR_ANSI;
			out->value = i;
			return 0;
		}
98
	}
J
Jeff King 已提交
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115

	/* And finally try a literal 256-color-mode number */
	val = strtol(name, &end, 10);
	if (end - name == len) {
		/*
		 * Allow "-1" as an alias for "normal", but other negative
		 * numbers are bogus.
		 */
		if (val < -1)
			; /* fall through to error */
		else if (val < 0) {
			out->type = COLOR_NORMAL;
			return 0;
		/* Rewrite low numbers as more-portable standard colors. */
		} else if (val < 8) {
			out->type = COLOR_ANSI;
			out->value = val;
116
			return 0;
J
Jeff King 已提交
117 118 119 120 121 122 123 124
		} else if (val < 256) {
			out->type = COLOR_256;
			out->value = val;
			return 0;
		}
	}

	return -1;
125 126
}

J
Jeff King 已提交
127
static int parse_attr(const char *name, size_t len)
128
{
J
Jeff King 已提交
129 130 131 132 133 134 135 136
	static const struct {
		const char *name;
		size_t len;
		int val, neg;
	} attrs[] = {
#define ATTR(x, val, neg) { (x), sizeof(x)-1, (val), (neg) }
		ATTR("bold",      1, 22),
		ATTR("dim",       2, 22),
J
Jeff King 已提交
137
		ATTR("italic",    3, 23),
J
Jeff King 已提交
138 139
		ATTR("ul",        4, 24),
		ATTR("blink",     5, 25),
140 141
		ATTR("reverse",   7, 27),
		ATTR("strike",    9, 29)
J
Jeff King 已提交
142
#undef ATTR
143
	};
J
Jeff King 已提交
144
	int negate = 0;
145
	int i;
J
Jeff King 已提交
146

147 148
	if (skip_prefix_mem(name, len, "no", &name, &len)) {
		skip_prefix_mem(name, len, "-", &name, &len);
J
Jeff King 已提交
149
		negate = 1;
150
	}
J
Jeff King 已提交
151 152 153 154

	for (i = 0; i < ARRAY_SIZE(attrs); i++) {
		if (attrs[i].len == len && !memcmp(attrs[i].name, name, len))
			return negate ? attrs[i].neg : attrs[i].val;
155 156 157 158
	}
	return -1;
}

159
int color_parse(const char *value, char *dst)
R
René Scharfe 已提交
160
{
161
	return color_parse_mem(value, strlen(value), dst);
R
René Scharfe 已提交
162 163
}

164 165 166 167 168
void color_set(char *dst, const char *color_bytes)
{
	xsnprintf(dst, COLOR_MAXLEN, "%s", color_bytes);
}

J
Jeff King 已提交
169 170 171 172 173
/*
 * Write the ANSI color codes for "c" to "out"; the string should
 * already have the ANSI escape code in it. "out" should have enough
 * space in it to fit any color.
 */
174
static char *color_output(char *out, int len, const struct color *c, char type)
J
Jeff King 已提交
175 176 177 178 179 180
{
	switch (c->type) {
	case COLOR_UNSPECIFIED:
	case COLOR_NORMAL:
		break;
	case COLOR_ANSI:
181 182
		if (len < 2)
			die("BUG: color parsing ran out of space");
J
Jeff King 已提交
183 184 185 186
		*out++ = type;
		*out++ = '0' + c->value;
		break;
	case COLOR_256:
187
		out += xsnprintf(out, len, "%c8;5;%d", type, c->value);
J
Jeff King 已提交
188
		break;
J
Jeff King 已提交
189
	case COLOR_RGB:
190 191
		out += xsnprintf(out, len, "%c8;2;%d;%d;%d", type,
				 c->red, c->green, c->blue);
J
Jeff King 已提交
192
		break;
J
Jeff King 已提交
193 194 195 196 197 198 199 200 201
	}
	return out;
}

static int color_empty(const struct color *c)
{
	return c->type <= COLOR_NORMAL;
}

202
int color_parse_mem(const char *value, int value_len, char *dst)
203 204
{
	const char *ptr = value;
R
René Scharfe 已提交
205
	int len = value_len;
206
	char *end = dst + COLOR_MAXLEN;
207
	unsigned int attr = 0;
J
Jeff King 已提交
208 209
	struct color fg = { COLOR_UNSPECIFIED };
	struct color bg = { COLOR_UNSPECIFIED };
210

211 212 213 214 215
	while (len > 0 && isspace(*ptr)) {
		ptr++;
		len--;
	}

216 217 218 219
	if (!len) {
		dst[0] = '\0';
		return 0;
	}
220

221
	if (!strncasecmp(ptr, "reset", len)) {
222
		xsnprintf(dst, end - dst, GIT_COLOR_RESET);
223
		return 0;
224 225
	}

226
	/* [fg [bg]] [attr]... */
R
René Scharfe 已提交
227
	while (len > 0) {
228
		const char *word = ptr;
229
		struct color c = { COLOR_UNSPECIFIED };
R
René Scharfe 已提交
230
		int val, wordlen = 0;
231

R
René Scharfe 已提交
232 233 234 235
		while (len > 0 && !isspace(word[wordlen])) {
			wordlen++;
			len--;
		}
236

R
René Scharfe 已提交
237 238
		ptr = word + wordlen;
		while (len > 0 && isspace(*ptr)) {
239
			ptr++;
R
René Scharfe 已提交
240 241
			len--;
		}
242

J
Jeff King 已提交
243 244 245
		if (!parse_color(&c, word, wordlen)) {
			if (fg.type == COLOR_UNSPECIFIED) {
				fg = c;
246 247
				continue;
			}
J
Jeff King 已提交
248 249
			if (bg.type == COLOR_UNSPECIFIED) {
				bg = c;
250 251 252 253
				continue;
			}
			goto bad;
		}
R
René Scharfe 已提交
254
		val = parse_attr(word, wordlen);
255 256 257
		if (0 <= val)
			attr |= (1 << val);
		else
258 259 260
			goto bad;
	}

261 262 263 264 265 266 267
#undef OUT
#define OUT(x) do { \
	if (dst == end) \
		die("BUG: color parsing ran out of space"); \
	*dst++ = (x); \
} while(0)

J
Jeff King 已提交
268
	if (attr || !color_empty(&fg) || !color_empty(&bg)) {
269
		int sep = 0;
270
		int i;
271

272 273
		OUT('\033');
		OUT('[');
274 275 276 277 278 279 280

		for (i = 0; attr; i++) {
			unsigned bit = (1 << i);
			if (!(attr & bit))
				continue;
			attr &= ~bit;
			if (sep++)
281 282
				OUT(';');
			dst += xsnprintf(dst, end - dst, "%d", i);
283
		}
J
Jeff King 已提交
284
		if (!color_empty(&fg)) {
285
			if (sep++)
286
				OUT(';');
287
			/* foreground colors are all in the 3x range */
288
			dst = color_output(dst, end - dst, &fg, '3');
289
		}
J
Jeff King 已提交
290
		if (!color_empty(&bg)) {
291
			if (sep++)
292
				OUT(';');
293
			/* background colors are all in the 4x range */
294
			dst = color_output(dst, end - dst, &bg, '4');
295
		}
296
		OUT('m');
297
	}
298
	OUT(0);
299
	return 0;
300
bad:
301
	return error(_("invalid color value: %.*s"), value_len, value);
302
#undef OUT
303 304
}

305
int git_config_colorbool(const char *var, const char *value)
306
{
307 308 309 310 311 312
	if (value) {
		if (!strcasecmp(value, "never"))
			return 0;
		if (!strcasecmp(value, "always"))
			return 1;
		if (!strcasecmp(value, "auto"))
313
			return GIT_COLOR_AUTO;
314
	}
315

316 317 318
	if (!var)
		return -1;

319 320
	/* Missing or explicit false to turn off colorization */
	if (!git_config_bool(var, value))
321
		return 0;
322 323

	/* any normal truth value defaults to 'auto' */
324 325 326 327 328
	return GIT_COLOR_AUTO;
}

static int check_auto_color(void)
{
329 330 331
	if (color_stdout_is_tty < 0)
		color_stdout_is_tty = isatty(1);
	if (color_stdout_is_tty || (pager_in_use() && pager_use_color)) {
332 333 334 335 336
		char *term = getenv("TERM");
		if (term && strcmp(term, "dumb"))
			return 1;
	}
	return 0;
337 338
}

339 340 341 342
int want_color(int var)
{
	static int want_auto = -1;

343 344 345
	if (var < 0)
		var = git_use_color_default;

346 347 348 349 350
	if (var == GIT_COLOR_AUTO) {
		if (want_auto < 0)
			want_auto = check_auto_color();
		return want_auto;
	}
351
	return var;
352 353
}

354
int git_color_config(const char *var, const char *value, void *cb)
355 356
{
	if (!strcmp(var, "color.ui")) {
357
		git_use_color_default = git_config_colorbool(var, value);
358 359 360
		return 0;
	}

361 362 363
	return 0;
}

364 365 366 367 368 369 370 371 372
void color_print_strbuf(FILE *fp, const char *color, const struct strbuf *sb)
{
	if (*color)
		fprintf(fp, "%s", color);
	fprintf(fp, "%s", sb->buf);
	if (*color)
		fprintf(fp, "%s", GIT_COLOR_RESET);
}

373
static int color_vfprintf(FILE *fp, const char *color, const char *fmt,
374 375 376 377 378
		va_list args, const char *trail)
{
	int r = 0;

	if (*color)
379 380
		r += fprintf(fp, "%s", color);
	r += vfprintf(fp, fmt, args);
381
	if (*color)
382
		r += fprintf(fp, "%s", GIT_COLOR_RESET);
383
	if (trail)
384
		r += fprintf(fp, "%s", trail);
385 386 387 388 389
	return r;
}



390
int color_fprintf(FILE *fp, const char *color, const char *fmt, ...)
391 392 393 394
{
	va_list args;
	int r;
	va_start(args, fmt);
395
	r = color_vfprintf(fp, color, fmt, args, NULL);
396 397 398 399
	va_end(args);
	return r;
}

400
int color_fprintf_ln(FILE *fp, const char *color, const char *fmt, ...)
401 402 403 404
{
	va_list args;
	int r;
	va_start(args, fmt);
405
	r = color_vfprintf(fp, color, fmt, args, "\n");
406 407 408
	va_end(args);
	return r;
}
409 410 411 412 413

int color_is_nil(const char *c)
{
	return !strcmp(c, "NIL");
}