color.c 8.1 KB
Newer Older
1
#include "cache.h"
2
#include "color.h"
3

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

7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
/*
 * 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 已提交
29 30 31 32 33 34
/* An individual foreground or background color. */
struct color {
	enum {
		COLOR_UNSPECIFIED = 0,
		COLOR_NORMAL,
		COLOR_ANSI, /* basic 0-7 ANSI colors */
J
Jeff King 已提交
35 36
		COLOR_256,
		COLOR_RGB
J
Jeff King 已提交
37 38 39
	} type;
	/* The numeric value for ANSI and 256-color modes */
	unsigned char value;
J
Jeff King 已提交
40 41
	/* 24-bit RGB color values */
	unsigned char red, green, blue;
J
Jeff King 已提交
42 43 44 45 46 47 48
};

/*
 * "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)
49
{
J
Jeff King 已提交
50 51 52
	return !strncasecmp(word, match, len) && !match[len];
}

J
Jeff King 已提交
53 54 55 56 57 58 59 60 61 62
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 已提交
63 64 65
static int parse_color(struct color *out, const char *name, int len)
{
	/* Positions in array must match ANSI color codes */
66
	static const char * const color_names[] = {
J
Jeff King 已提交
67
		"black", "red", "green", "yellow",
68 69 70 71
		"blue", "magenta", "cyan", "white"
	};
	char *end;
	int i;
J
Jeff King 已提交
72 73 74 75 76 77 78 79
	long val;

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

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

	/* 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;
115
			return 0;
J
Jeff King 已提交
116 117 118 119 120 121 122 123
		} else if (val < 256) {
			out->type = COLOR_256;
			out->value = val;
			return 0;
		}
	}

	return -1;
124 125 126 127
}

static int parse_attr(const char *name, int len)
{
128 129
	static const int attr_values[] = { 1, 2, 4, 5, 7,
					   22, 22, 24, 25, 27 };
130
	static const char * const attr_names[] = {
131 132
		"bold", "dim", "ul", "blink", "reverse",
		"nobold", "nodim", "noul", "noblink", "noreverse"
133 134 135 136 137 138 139 140 141 142
	};
	int i;
	for (i = 0; i < ARRAY_SIZE(attr_names); i++) {
		const char *str = attr_names[i];
		if (!strncasecmp(name, str, len) && !str[len])
			return attr_values[i];
	}
	return -1;
}

143
int color_parse(const char *value, char *dst)
R
René Scharfe 已提交
144
{
145
	return color_parse_mem(value, strlen(value), dst);
R
René Scharfe 已提交
146 147
}

148 149 150 151 152
void color_set(char *dst, const char *color_bytes)
{
	xsnprintf(dst, COLOR_MAXLEN, "%s", color_bytes);
}

J
Jeff King 已提交
153 154 155 156 157
/*
 * 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.
 */
158
static char *color_output(char *out, int len, const struct color *c, char type)
J
Jeff King 已提交
159 160 161 162 163 164
{
	switch (c->type) {
	case COLOR_UNSPECIFIED:
	case COLOR_NORMAL:
		break;
	case COLOR_ANSI:
165 166
		if (len < 2)
			die("BUG: color parsing ran out of space");
J
Jeff King 已提交
167 168 169 170
		*out++ = type;
		*out++ = '0' + c->value;
		break;
	case COLOR_256:
171
		out += xsnprintf(out, len, "%c8;5;%d", type, c->value);
J
Jeff King 已提交
172
		break;
J
Jeff King 已提交
173
	case COLOR_RGB:
174 175
		out += xsnprintf(out, len, "%c8;2;%d;%d;%d", type,
				 c->red, c->green, c->blue);
J
Jeff King 已提交
176
		break;
J
Jeff King 已提交
177 178 179 180 181 182 183 184 185
	}
	return out;
}

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

186
int color_parse_mem(const char *value, int value_len, char *dst)
187 188
{
	const char *ptr = value;
R
René Scharfe 已提交
189
	int len = value_len;
190
	char *end = dst + COLOR_MAXLEN;
191
	unsigned int attr = 0;
J
Jeff King 已提交
192 193
	struct color fg = { COLOR_UNSPECIFIED };
	struct color bg = { COLOR_UNSPECIFIED };
194

R
René Scharfe 已提交
195
	if (!strncasecmp(value, "reset", len)) {
196
		xsnprintf(dst, end - dst, GIT_COLOR_RESET);
197
		return 0;
198 199
	}

200
	/* [fg [bg]] [attr]... */
R
René Scharfe 已提交
201
	while (len > 0) {
202
		const char *word = ptr;
J
Jeff King 已提交
203
		struct color c;
R
René Scharfe 已提交
204
		int val, wordlen = 0;
205

R
René Scharfe 已提交
206 207 208 209
		while (len > 0 && !isspace(word[wordlen])) {
			wordlen++;
			len--;
		}
210

R
René Scharfe 已提交
211 212
		ptr = word + wordlen;
		while (len > 0 && isspace(*ptr)) {
213
			ptr++;
R
René Scharfe 已提交
214 215
			len--;
		}
216

J
Jeff King 已提交
217 218 219
		if (!parse_color(&c, word, wordlen)) {
			if (fg.type == COLOR_UNSPECIFIED) {
				fg = c;
220 221
				continue;
			}
J
Jeff King 已提交
222 223
			if (bg.type == COLOR_UNSPECIFIED) {
				bg = c;
224 225 226 227
				continue;
			}
			goto bad;
		}
R
René Scharfe 已提交
228
		val = parse_attr(word, wordlen);
229 230 231
		if (0 <= val)
			attr |= (1 << val);
		else
232 233 234
			goto bad;
	}

235 236 237 238 239 240 241
#undef OUT
#define OUT(x) do { \
	if (dst == end) \
		die("BUG: color parsing ran out of space"); \
	*dst++ = (x); \
} while(0)

J
Jeff King 已提交
242
	if (attr || !color_empty(&fg) || !color_empty(&bg)) {
243
		int sep = 0;
244
		int i;
245

246 247
		OUT('\033');
		OUT('[');
248 249 250 251 252 253 254

		for (i = 0; attr; i++) {
			unsigned bit = (1 << i);
			if (!(attr & bit))
				continue;
			attr &= ~bit;
			if (sep++)
255 256
				OUT(';');
			dst += xsnprintf(dst, end - dst, "%d", i);
257
		}
J
Jeff King 已提交
258
		if (!color_empty(&fg)) {
259
			if (sep++)
260
				OUT(';');
261
			/* foreground colors are all in the 3x range */
262
			dst = color_output(dst, end - dst, &fg, '3');
263
		}
J
Jeff King 已提交
264
		if (!color_empty(&bg)) {
265
			if (sep++)
266
				OUT(';');
267
			/* background colors are all in the 4x range */
268
			dst = color_output(dst, end - dst, &bg, '4');
269
		}
270
		OUT('m');
271
	}
272
	OUT(0);
273
	return 0;
274
bad:
275
	return error(_("invalid color value: %.*s"), value_len, value);
276
#undef OUT
277 278
}

279
int git_config_colorbool(const char *var, const char *value)
280
{
281 282 283 284 285 286
	if (value) {
		if (!strcasecmp(value, "never"))
			return 0;
		if (!strcasecmp(value, "always"))
			return 1;
		if (!strcasecmp(value, "auto"))
287
			return GIT_COLOR_AUTO;
288
	}
289

290 291 292
	if (!var)
		return -1;

293 294
	/* Missing or explicit false to turn off colorization */
	if (!git_config_bool(var, value))
295
		return 0;
296 297

	/* any normal truth value defaults to 'auto' */
298 299 300 301 302
	return GIT_COLOR_AUTO;
}

static int check_auto_color(void)
{
303 304 305
	if (color_stdout_is_tty < 0)
		color_stdout_is_tty = isatty(1);
	if (color_stdout_is_tty || (pager_in_use() && pager_use_color)) {
306 307 308 309 310
		char *term = getenv("TERM");
		if (term && strcmp(term, "dumb"))
			return 1;
	}
	return 0;
311 312
}

313 314 315 316
int want_color(int var)
{
	static int want_auto = -1;

317 318 319
	if (var < 0)
		var = git_use_color_default;

320 321 322 323 324
	if (var == GIT_COLOR_AUTO) {
		if (want_auto < 0)
			want_auto = check_auto_color();
		return want_auto;
	}
325
	return var;
326 327
}

328
int git_color_config(const char *var, const char *value, void *cb)
329 330
{
	if (!strcmp(var, "color.ui")) {
331
		git_use_color_default = git_config_colorbool(var, value);
332 333 334
		return 0;
	}

335 336 337 338 339 340 341 342
	return 0;
}

int git_color_default_config(const char *var, const char *value, void *cb)
{
	if (git_color_config(var, value, cb) < 0)
		return -1;

343
	return git_default_config(var, value, cb);
344 345
}

346 347 348 349 350 351 352 353 354
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);
}

355
static int color_vfprintf(FILE *fp, const char *color, const char *fmt,
356 357 358 359 360
		va_list args, const char *trail)
{
	int r = 0;

	if (*color)
361 362
		r += fprintf(fp, "%s", color);
	r += vfprintf(fp, fmt, args);
363
	if (*color)
364
		r += fprintf(fp, "%s", GIT_COLOR_RESET);
365
	if (trail)
366
		r += fprintf(fp, "%s", trail);
367 368 369 370 371
	return r;
}



372
int color_fprintf(FILE *fp, const char *color, const char *fmt, ...)
373 374 375 376
{
	va_list args;
	int r;
	va_start(args, fmt);
377
	r = color_vfprintf(fp, color, fmt, args, NULL);
378 379 380 381
	va_end(args);
	return r;
}

382
int color_fprintf_ln(FILE *fp, const char *color, const char *fmt, ...)
383 384 385 386
{
	va_list args;
	int r;
	va_start(args, fmt);
387
	r = color_vfprintf(fp, color, fmt, args, "\n");
388 389 390
	va_end(args);
	return r;
}
391 392 393 394 395

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