[thirdparty/git.git] / color.h

#ifndef COLOR_H
#define COLOR_H

struct strbuf;

/*  2 + (2 * num_attrs) + 8 + 1 + 8 + 'm' + NUL */
/* "\033[1;2;4;5;7;38;5;2xx;48;5;2xxm\0" */
/*
 * The maximum length of ANSI color sequence we would generate:
 * - leading ESC '['            2
 * - attr + ';'                 2 * 8 (e.g. "1;")
 * - fg color + ';'             9 (e.g. "38;5;2xx;")
 * - fg color + ';'             9 (e.g. "48;5;2xx;")
 * - terminating 'm' NUL        2
 *
 * The above overcounts attr (we only use 5 not 8) and one semicolon
 * but it is close enough.
 */
#define COLOR_MAXLEN 40

/*
 * IMPORTANT: Due to the way these color codes are emulated on Windows,
 * write them only using printf(), fprintf(), and fputs(). In particular,
 * do not use puts() or write().
 */
#define GIT_COLOR_NORMAL	""
#define GIT_COLOR_RESET		"\033[m"
#define GIT_COLOR_BOLD		"\033[1m"
#define GIT_COLOR_RED		"\033[31m"
#define GIT_COLOR_GREEN		"\033[32m"
#define GIT_COLOR_YELLOW	"\033[33m"
#define GIT_COLOR_BLUE		"\033[34m"
#define GIT_COLOR_MAGENTA	"\033[35m"
#define GIT_COLOR_CYAN		"\033[36m"
#define GIT_COLOR_BOLD_RED	"\033[1;31m"
#define GIT_COLOR_BOLD_GREEN	"\033[1;32m"
#define GIT_COLOR_BOLD_YELLOW	"\033[1;33m"
#define GIT_COLOR_BOLD_BLUE	"\033[1;34m"
#define GIT_COLOR_BOLD_MAGENTA	"\033[1;35m"
#define GIT_COLOR_BOLD_CYAN	"\033[1;36m"
#define GIT_COLOR_BG_RED	"\033[41m"
#define GIT_COLOR_BG_GREEN	"\033[42m"
#define GIT_COLOR_BG_YELLOW	"\033[43m"
#define GIT_COLOR_BG_BLUE	"\033[44m"
#define GIT_COLOR_BG_MAGENTA	"\033[45m"
#define GIT_COLOR_BG_CYAN	"\033[46m"

/* A special value meaning "no color selected" */
#define GIT_COLOR_NIL "NIL"

/*
 * This variable stores the value of color.ui
 */
extern int git_use_color_default;


/*
 * Use this instead of git_default_config if you need the value of color.ui.
 */
int git_color_default_config(const char *var, const char *value, void *cb);

int git_config_colorbool(const char *var, const char *value, int stdout_is_tty);
void color_parse(const char *value, const char *var, char *dst);
void color_parse_mem(const char *value, int len, const char *var, char *dst);
__attribute__((format (printf, 3, 4)))
int color_fprintf(FILE *fp, const char *color, const char *fmt, ...);
__attribute__((format (printf, 3, 4)))
int color_fprintf_ln(FILE *fp, const char *color, const char *fmt, ...);
void color_print_strbuf(FILE *fp, const char *color, const struct strbuf *sb);

int color_is_nil(const char *color);

#endif /* COLOR_H */
Commit	Line	Data
7c92fe0e JK	1	#ifndef COLOR_H
	2	#define COLOR_H
	3
e0335fcd JN	4	struct strbuf;
e0335fcd JN	5
8b124135 JH	6	/* 2 + (2 * num_attrs) + 8 + 1 + 8 + 'm' + NUL */
	7	/* "\033[1;2;4;5;7;38;5;2xx;48;5;2xxm\0" */
	8	/*
	9	* The maximum length of ANSI color sequence we would generate:
	10	* - leading ESC '[' 2
	11	* - attr + ';' 2 * 8 (e.g. "1;")
	12	* - fg color + ';' 9 (e.g. "38;5;2xx;")
	13	* - fg color + ';' 9 (e.g. "48;5;2xx;")
	14	* - terminating 'm' NUL 2
	15	*
	16	* The above overcounts attr (we only use 5 not 8) and one semicolon
	17	* but it is close enough.
	18	*/
	19	#define COLOR_MAXLEN 40
7c92fe0e	20
e7821d73 JS	21	/*
	22	* IMPORTANT: Due to the way these color codes are emulated on Windows,
	23	* write them only using printf(), fprintf(), and fputs(). In particular,
	24	* do not use puts() or write().
	25	*/
dc6ebd4c AL	26	#define GIT_COLOR_NORMAL ""
	27	#define GIT_COLOR_RESET "\033[m"
	28	#define GIT_COLOR_BOLD "\033[1m"
	29	#define GIT_COLOR_RED "\033[31m"
	30	#define GIT_COLOR_GREEN "\033[32m"
	31	#define GIT_COLOR_YELLOW "\033[33m"
	32	#define GIT_COLOR_BLUE "\033[34m"
427fc5b8	33	#define GIT_COLOR_MAGENTA "\033[35m"
dc6ebd4c	34	#define GIT_COLOR_CYAN "\033[36m"
758df17a ML	35	#define GIT_COLOR_BOLD_RED "\033[1;31m"
	36	#define GIT_COLOR_BOLD_GREEN "\033[1;32m"
	37	#define GIT_COLOR_BOLD_YELLOW "\033[1;33m"
	38	#define GIT_COLOR_BOLD_BLUE "\033[1;34m"
	39	#define GIT_COLOR_BOLD_MAGENTA "\033[1;35m"
	40	#define GIT_COLOR_BOLD_CYAN "\033[1;36m"
dc6ebd4c	41	#define GIT_COLOR_BG_RED "\033[41m"
758df17a ML	42	#define GIT_COLOR_BG_GREEN "\033[42m"
	43	#define GIT_COLOR_BG_YELLOW "\033[43m"
	44	#define GIT_COLOR_BG_BLUE "\033[44m"
	45	#define GIT_COLOR_BG_MAGENTA "\033[45m"
	46	#define GIT_COLOR_BG_CYAN "\033[46m"
dc6ebd4c	47
148135fc JK	48	/* A special value meaning "no color selected" */
	49	#define GIT_COLOR_NIL "NIL"
	50
6b2f2d98 MK	51	/*
	52	* This variable stores the value of color.ui
	53	*/
	54	extern int git_use_color_default;
	55
	56
	57	/*
	58	* Use this instead of git_default_config if you need the value of color.ui.
	59	*/
ef90d6d4	60	int git_color_default_config(const char var, const char value, void *cb);
6b2f2d98	61
0f6f5a40	62	int git_config_colorbool(const char var, const char value, int stdout_is_tty);
5ef8d77a JK	63	void color_parse(const char value, const char var, char *dst);
5ef8d77a JK	64	void color_parse_mem(const char value, int len, const char var, char *dst);
28bea9e5	65	__attribute__((format (printf, 3, 4)))
f26a0012	66	int color_fprintf(FILE fp, const char color, const char *fmt, ...);
28bea9e5	67	__attribute__((format (printf, 3, 4)))
f26a0012	68	int color_fprintf_ln(FILE fp, const char color, const char *fmt, ...);
e0335fcd	69	void color_print_strbuf(FILE fp, const char color, const struct strbuf *sb);
7c92fe0e	70
148135fc JK	71	int color_is_nil(const char *color);
148135fc JK	72
7c92fe0e	73	#endif /* COLOR_H */