color.c 8.0 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
}

J
Jeff King 已提交
126
static int parse_attr(const char *name, size_t len)
127
{
J
Jeff King 已提交
128 129 130 131 132 133 134 135
	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 已提交
136
		ATTR("italic",    3, 23),
J
Jeff King 已提交
137 138 139 140
		ATTR("ul",        4, 24),
		ATTR("blink",     5, 25),
		ATTR("reverse",   7, 27)
#undef ATTR
141
	};
J
Jeff King 已提交
142
	int negate = 0;
143
	int i;
J
Jeff King 已提交
144

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

	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;
153 154 155 156
	}
	return -1;
}

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

J
Jeff King 已提交
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
/*
 * 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.
 */
static char *color_output(char *out, const struct color *c, char type)
{
	switch (c->type) {
	case COLOR_UNSPECIFIED:
	case COLOR_NORMAL:
		break;
	case COLOR_ANSI:
		*out++ = type;
		*out++ = '0' + c->value;
		break;
	case COLOR_256:
		out += sprintf(out, "%c8;5;%d", type, c->value);
		break;
J
Jeff King 已提交
180 181 182 183
	case COLOR_RGB:
		out += sprintf(out, "%c8;2;%d;%d;%d", type,
			       c->red, c->green, c->blue);
		break;
J
Jeff King 已提交
184 185 186 187 188 189 190 191 192
	}
	return out;
}

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

193
int color_parse_mem(const char *value, int value_len, char *dst)
194 195
{
	const char *ptr = value;
R
René Scharfe 已提交
196
	int len = value_len;
197
	unsigned int attr = 0;
J
Jeff King 已提交
198 199
	struct color fg = { COLOR_UNSPECIFIED };
	struct color bg = { COLOR_UNSPECIFIED };
200

R
René Scharfe 已提交
201
	if (!strncasecmp(value, "reset", len)) {
202
		strcpy(dst, GIT_COLOR_RESET);
203
		return 0;
204 205
	}

206
	/* [fg [bg]] [attr]... */
R
René Scharfe 已提交
207
	while (len > 0) {
208
		const char *word = ptr;
J
Jeff King 已提交
209
		struct color c;
R
René Scharfe 已提交
210
		int val, wordlen = 0;
211

R
René Scharfe 已提交
212 213 214 215
		while (len > 0 && !isspace(word[wordlen])) {
			wordlen++;
			len--;
		}
216

R
René Scharfe 已提交
217 218
		ptr = word + wordlen;
		while (len > 0 && isspace(*ptr)) {
219
			ptr++;
R
René Scharfe 已提交
220 221
			len--;
		}
222

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

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

		*dst++ = '\033';
		*dst++ = '[';
247 248 249 250 251 252 253 254

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

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

288 289 290
	if (!var)
		return -1;

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

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

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

311 312 313 314
int want_color(int var)
{
	static int want_auto = -1;

315 316 317
	if (var < 0)
		var = git_use_color_default;

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

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

333 334 335 336 337 338 339 340
	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;

341
	return git_default_config(var, value, cb);
342 343
}

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

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

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



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

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

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