[thirdparty/git.git] / color.c

#include "cache.h"
#include "color.h"

static int git_use_color_default = GIT_COLOR_AUTO;
int color_stdout_is_tty = -1;

/*
 * 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;

/* An individual foreground or background color. */
struct color {
	enum {
		COLOR_UNSPECIFIED = 0,
		COLOR_NORMAL,
		COLOR_ANSI, /* basic 0-7 ANSI colors */
		COLOR_256,
		COLOR_RGB
	} type;
	/* The numeric value for ANSI and 256-color modes */
	unsigned char value;
	/* 24-bit RGB color values */
	unsigned char red, green, blue;
};

/*
 * "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)
{
	return !strncasecmp(word, match, len) && !match[len];
}

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;
}

static int parse_color(struct color *out, const char *name, int len)
{
	/* Positions in array must match ANSI color codes */
	static const char * const color_names[] = {
		"black", "red", "green", "yellow",
		"blue", "magenta", "cyan", "white"
	};
	char *end;
	int i;
	long val;

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

	/* 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;
		}
	}

	/* Then pick from our human-readable color names... */
	for (i = 0; i < ARRAY_SIZE(color_names); i++) {
		if (match_word(name, len, color_names[i])) {
			out->type = COLOR_ANSI;
			out->value = i;
			return 0;
		}
	}

	/* 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;
		} else if (val < 256) {
			out->type = COLOR_256;
			out->value = val;
			return 0;
		}
	}

	return -1;
}

static int parse_attr(const char *name, int len)
{
	static const int attr_values[] = { 1, 2, 4, 5, 7,
					   22, 22, 24, 25, 27 };
	static const char * const attr_names[] = {
		"bold", "dim", "ul", "blink", "reverse",
		"nobold", "nodim", "noul", "noblink", "noreverse"
	};
	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;
}

int color_parse(const char *value, char *dst)
{
	return color_parse_mem(value, strlen(value), dst);
}

/*
 * 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;
	case COLOR_RGB:
		out += sprintf(out, "%c8;2;%d;%d;%d", type,
			       c->red, c->green, c->blue);
		break;
	}
	return out;
}

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

int color_parse_mem(const char *value, int value_len, char *dst)
{
	const char *ptr = value;
	int len = value_len;
	unsigned int attr = 0;
	struct color fg = { COLOR_UNSPECIFIED };
	struct color bg = { COLOR_UNSPECIFIED };

	if (!strncasecmp(value, "reset", len)) {
		strcpy(dst, GIT_COLOR_RESET);
		return 0;
	}

	/* [fg [bg]] [attr]... */
	while (len > 0) {
		const char *word = ptr;
		struct color c;
		int val, wordlen = 0;

		while (len > 0 && !isspace(word[wordlen])) {
			wordlen++;
			len--;
		}

		ptr = word + wordlen;
		while (len > 0 && isspace(*ptr)) {
			ptr++;
			len--;
		}

		if (!parse_color(&c, word, wordlen)) {
			if (fg.type == COLOR_UNSPECIFIED) {
				fg = c;
				continue;
			}
			if (bg.type == COLOR_UNSPECIFIED) {
				bg = c;
				continue;
			}
			goto bad;
		}
		val = parse_attr(word, wordlen);
		if (0 <= val)
			attr |= (1 << val);
		else
			goto bad;
	}

	if (attr || !color_empty(&fg) || !color_empty(&bg)) {
		int sep = 0;
		int i;

		*dst++ = '\033';
		*dst++ = '[';

		for (i = 0; attr; i++) {
			unsigned bit = (1 << i);
			if (!(attr & bit))
				continue;
			attr &= ~bit;
			if (sep++)
				*dst++ = ';';
			dst += sprintf(dst, "%d", i);
		}
		if (!color_empty(&fg)) {
			if (sep++)
				*dst++ = ';';
			/* foreground colors are all in the 3x range */
			dst = color_output(dst, &fg, '3');
		}
		if (!color_empty(&bg)) {
			if (sep++)
				*dst++ = ';';
			/* background colors are all in the 4x range */
			dst = color_output(dst, &bg, '4');
		}
		*dst++ = 'm';
	}
	*dst = 0;
	return 0;
bad:
	return error(_("invalid color value: %.*s"), value_len, value);
}

int git_config_colorbool(const char *var, const char *value)
{
	if (value) {
		if (!strcasecmp(value, "never"))
			return 0;
		if (!strcasecmp(value, "always"))
			return 1;
		if (!strcasecmp(value, "auto"))
			return GIT_COLOR_AUTO;
	}

	if (!var)
		return -1;

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

	/* any normal truth value defaults to 'auto' */
	return GIT_COLOR_AUTO;
}

static int check_auto_color(void)
{
	if (color_stdout_is_tty < 0)
		color_stdout_is_tty = isatty(1);
	if (color_stdout_is_tty || (pager_in_use() && pager_use_color)) {
		char *term = getenv("TERM");
		if (term && strcmp(term, "dumb"))
			return 1;
	}
	return 0;
}

int want_color(int var)
{
	static int want_auto = -1;

	if (var < 0)
		var = git_use_color_default;

	if (var == GIT_COLOR_AUTO) {
		if (want_auto < 0)
			want_auto = check_auto_color();
		return want_auto;
	}
	return var;
}

int git_color_config(const char *var, const char *value, void *cb)
{
	if (!strcmp(var, "color.ui")) {
		git_use_color_default = git_config_colorbool(var, value);
		return 0;
	}

	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;

	return git_default_config(var, value, cb);
}

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);
}

static int color_vfprintf(FILE *fp, const char *color, const char *fmt,
		va_list args, const char *trail)
{
	int r = 0;

	if (*color)
		r += fprintf(fp, "%s", color);
	r += vfprintf(fp, fmt, args);
	if (*color)
		r += fprintf(fp, "%s", GIT_COLOR_RESET);
	if (trail)
		r += fprintf(fp, "%s", trail);
	return r;
}


int color_fprintf(FILE *fp, const char *color, const char *fmt, ...)
{
	va_list args;
	int r;
	va_start(args, fmt);
	r = color_vfprintf(fp, color, fmt, args, NULL);
	va_end(args);
	return r;
}

int color_fprintf_ln(FILE *fp, const char *color, const char *fmt, ...)
{
	va_list args;
	int r;
	va_start(args, fmt);
	r = color_vfprintf(fp, color, fmt, args, "\n");
	va_end(args);
	return r;
}

int color_is_nil(const char *c)
{
	return !strcmp(c, "NIL");
}
Commit	Line	Data
7c92fe0e	1	#include "cache.h"
85023577	2	#include "color.h"
7c92fe0e	3
4c7f1819	4	static int git_use_color_default = GIT_COLOR_AUTO;
e269eb79	5	int color_stdout_is_tty = -1;
6b2f2d98	6
7cd52b5b DM	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
695d95df JK	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 */
17a4be26 JK	35	COLOR_256,
17a4be26 JK	36	COLOR_RGB
695d95df JK	37	} type;
	38	/* The numeric value for ANSI and 256-color modes */
	39	unsigned char value;
17a4be26 JK	40	/* 24-bit RGB color values */
17a4be26 JK	41	unsigned char red, green, blue;
695d95df JK	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)
7c92fe0e	49	{
695d95df JK	50	return !strncasecmp(word, match, len) && !match[len];
	51	}
	52
17a4be26 JK	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
695d95df JK	63	static int parse_color(struct color out, const char name, int len)
	64	{
	65	/* Positions in array must match ANSI color codes */
7c92fe0e	66	static const char * const color_names[] = {
695d95df	67	"black", "red", "green", "yellow",
7c92fe0e JK	68	"blue", "magenta", "cyan", "white"
	69	};
	70	char *end;
	71	int i;
695d95df JK	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
17a4be26 JK	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
695d95df	90	/* Then pick from our human-readable color names... */
7c92fe0e	91	for (i = 0; i < ARRAY_SIZE(color_names); i++) {
695d95df JK	92	if (match_word(name, len, color_names[i])) {
	93	out->type = COLOR_ANSI;
	94	out->value = i;
	95	return 0;
	96	}
7c92fe0e	97	}
695d95df JK	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;
7c92fe0e JK	123	}
	124
	125	static int parse_attr(const char *name, int len)
	126	{
ff40d185 JK	127	static const int attr_values[] = { 1, 2, 4, 5, 7,
ff40d185 JK	128	22, 22, 24, 25, 27 };
7c92fe0e	129	static const char * const attr_names[] = {
ff40d185 JK	130	"bold", "dim", "ul", "blink", "reverse",
ff40d185 JK	131	"nobold", "nodim", "noul", "noblink", "noreverse"
7c92fe0e JK	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
f6c5a296	142	int color_parse(const char value, char dst)
2c2dc7c8	143	{
f6c5a296	144	return color_parse_mem(value, strlen(value), dst);
2c2dc7c8 RS	145	}
2c2dc7c8 RS	146
695d95df JK	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;
17a4be26 JK	165	case COLOR_RGB:
	166	out += sprintf(out, "%c8;2;%d;%d;%d", type,
	167	c->red, c->green, c->blue);
	168	break;
695d95df JK	169	}
	170	return out;
	171	}
	172
	173	static int color_empty(const struct color *c)
	174	{
	175	return c->type <= COLOR_NORMAL;
	176	}
	177
f6c5a296	178	int color_parse_mem(const char value, int value_len, char dst)
7c92fe0e JK	179	{
7c92fe0e JK	180	const char *ptr = value;
2c2dc7c8	181	int len = value_len;
8b124135	182	unsigned int attr = 0;
695d95df JK	183	struct color fg = { COLOR_UNSPECIFIED };
695d95df JK	184	struct color bg = { COLOR_UNSPECIFIED };
7c92fe0e	185
2c2dc7c8	186	if (!strncasecmp(value, "reset", len)) {
dc6ebd4c	187	strcpy(dst, GIT_COLOR_RESET);
f6c5a296	188	return 0;
7c92fe0e JK	189	}
7c92fe0e JK	190
8b124135	191	/* [fg [bg]] [attr]... */
2c2dc7c8	192	while (len > 0) {
7c92fe0e	193	const char *word = ptr;
695d95df	194	struct color c;
2c2dc7c8	195	int val, wordlen = 0;
7c92fe0e	196
2c2dc7c8 RS	197	while (len > 0 && !isspace(word[wordlen])) {
	198	wordlen++;
	199	len--;
	200	}
7c92fe0e	201
2c2dc7c8 RS	202	ptr = word + wordlen;
2c2dc7c8 RS	203	while (len > 0 && isspace(*ptr)) {
7c92fe0e	204	ptr++;
2c2dc7c8 RS	205	len--;
2c2dc7c8 RS	206	}
7c92fe0e	207
695d95df JK	208	if (!parse_color(&c, word, wordlen)) {
	209	if (fg.type == COLOR_UNSPECIFIED) {
	210	fg = c;
7c92fe0e JK	211	continue;
7c92fe0e JK	212	}
695d95df JK	213	if (bg.type == COLOR_UNSPECIFIED) {
695d95df JK	214	bg = c;
7c92fe0e JK	215	continue;
	216	}
	217	goto bad;
	218	}
2c2dc7c8	219	val = parse_attr(word, wordlen);
8b124135 JH	220	if (0 <= val)
	221	attr \|= (1 << val);
	222	else
7c92fe0e	223	goto bad;
7c92fe0e JK	224	}
7c92fe0e JK	225
695d95df	226	if (attr \|\| !color_empty(&fg) \|\| !color_empty(&bg)) {
7c92fe0e	227	int sep = 0;
8b124135	228	int i;
7c92fe0e JK	229
	230	*dst++ = '\033';
	231	*dst++ = '[';
8b124135 JH	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++ = ';';
ff40d185	240	dst += sprintf(dst, "%d", i);
7c92fe0e	241	}
695d95df	242	if (!color_empty(&fg)) {
7c92fe0e JK	243	if (sep++)
7c92fe0e JK	244	*dst++ = ';';
71b59849 JK	245	/* foreground colors are all in the 3x range */
71b59849 JK	246	dst = color_output(dst, &fg, '3');
7c92fe0e	247	}
695d95df	248	if (!color_empty(&bg)) {
7c92fe0e JK	249	if (sep++)
7c92fe0e JK	250	*dst++ = ';';
71b59849 JK	251	/* background colors are all in the 4x range */
71b59849 JK	252	dst = color_output(dst, &bg, '4');
7c92fe0e JK	253	}
	254	*dst++ = 'm';
	255	}
	256	*dst = 0;
f6c5a296	257	return 0;
7c92fe0e	258	bad:
f6c5a296	259	return error(_("invalid color value: %.*s"), value_len, value);
7c92fe0e JK	260	}
7c92fe0e JK	261
e269eb79	262	int git_config_colorbool(const char var, const char value)
7c92fe0e	263	{
57f2b842 JH	264	if (value) {
	265	if (!strcasecmp(value, "never"))
	266	return 0;
	267	if (!strcasecmp(value, "always"))
	268	return 1;
	269	if (!strcasecmp(value, "auto"))
daa0c3d9	270	return GIT_COLOR_AUTO;
7c92fe0e	271	}
57f2b842	272
73e9da01 ML	273	if (!var)
	274	return -1;
	275
57f2b842 JH	276	/* Missing or explicit false to turn off colorization */
57f2b842 JH	277	if (!git_config_bool(var, value))
7c92fe0e	278	return 0;
57f2b842 JH	279
57f2b842 JH	280	/* any normal truth value defaults to 'auto' */
daa0c3d9 JK	281	return GIT_COLOR_AUTO;
	282	}
	283
	284	static int check_auto_color(void)
	285	{
e269eb79 JK	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)) {
57f2b842 JH	289	char *term = getenv("TERM");
	290	if (term && strcmp(term, "dumb"))
	291	return 1;
	292	}
	293	return 0;
7c92fe0e JK	294	}
7c92fe0e JK	295
daa0c3d9 JK	296	int want_color(int var)
	297	{
	298	static int want_auto = -1;
	299
c9bfb953 JK	300	if (var < 0)
	301	var = git_use_color_default;
	302
daa0c3d9 JK	303	if (var == GIT_COLOR_AUTO) {
	304	if (want_auto < 0)
	305	want_auto = check_auto_color();
	306	return want_auto;
	307	}
c9bfb953	308	return var;
daa0c3d9 JK	309	}
daa0c3d9 JK	310
3e1dd17a	311	int git_color_config(const char var, const char value, void *cb)
6b2f2d98 MK	312	{
6b2f2d98 MK	313	if (!strcmp(var, "color.ui")) {
e269eb79	314	git_use_color_default = git_config_colorbool(var, value);
6b2f2d98 MK	315	return 0;
	316	}
	317
3e1dd17a JK	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
ef90d6d4	326	return git_default_config(var, value, cb);
6b2f2d98 MK	327	}
6b2f2d98 MK	328
becbdae8 JN	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
f26a0012	338	static int color_vfprintf(FILE fp, const char color, const char *fmt,
7c92fe0e JK	339	va_list args, const char *trail)
	340	{
	341	int r = 0;
	342
	343	if (*color)
f26a0012 KH	344	r += fprintf(fp, "%s", color);
f26a0012 KH	345	r += vfprintf(fp, fmt, args);
7c92fe0e	346	if (*color)
dc6ebd4c	347	r += fprintf(fp, "%s", GIT_COLOR_RESET);
7c92fe0e	348	if (trail)
f26a0012	349	r += fprintf(fp, "%s", trail);
7c92fe0e JK	350	return r;
	351	}
	352
	353
	354
f26a0012	355	int color_fprintf(FILE fp, const char color, const char *fmt, ...)
7c92fe0e JK	356	{
	357	va_list args;
	358	int r;
	359	va_start(args, fmt);
f26a0012	360	r = color_vfprintf(fp, color, fmt, args, NULL);
7c92fe0e JK	361	va_end(args);
	362	return r;
	363	}
	364
f26a0012	365	int color_fprintf_ln(FILE fp, const char color, const char *fmt, ...)
7c92fe0e JK	366	{
	367	va_list args;
	368	int r;
	369	va_start(args, fmt);
f26a0012	370	r = color_vfprintf(fp, color, fmt, args, "\n");
7c92fe0e JK	371	va_end(args);
	372	return r;
	373	}
148135fc JK	374
	375	int color_is_nil(const char *c)
	376	{
	377	return !strcmp(c, "NIL");
	378	}