[thirdparty/git.git] / color.h

#ifndef COLOR_H
#define COLOR_H

struct strbuf;

/*
 * The maximum length of ANSI color sequence we would generate:
 * - leading ESC '['            2
 * - attr + ';'                 2 * num_attr (e.g. "1;")
 * - no-attr + ';'              3 * num_attr (e.g. "22;")
 * - fg color + ';'             17 (e.g. "38;2;255;255;255;")
 * - bg color + ';'             17 (e.g. "48;2;255;255;255;")
 * - terminating 'm' NUL        2
 *
 * The above overcounts by one semicolon but it is close enough.
 *
 * The space for attributes is also slightly overallocated, as
 * the negation for some attributes is the same (e.g., nobold and nodim).
 *
 * We allocate space for 6 attributes.
 */
#define COLOR_MAXLEN 70

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

/*
 * The first three are chosen to match common usage in the code, and what is
 * returned from git_config_colorbool. The "auto" value can be returned from
 * config_colorbool, and will be converted by want_color() into either 0 or 1.
 */
#define GIT_COLOR_UNKNOWN -1
#define GIT_COLOR_NEVER  0
#define GIT_COLOR_ALWAYS 1
#define GIT_COLOR_AUTO   2

/* A default list of colors to use for commit graphs and show-branch output */
extern const char *column_colors_ansi[];
extern const int column_colors_ansi_max;

/*
 * Generally the color code will lazily figure this out itself, but
 * this provides a mechanism for callers to override autodetection.
 */
extern int color_stdout_is_tty;

/*
 * Use the first one if you need only color config; the second is a convenience
 * if you are just going to change to git_default_config, too.
 */
int git_color_config(const char *var, const char *value, void *cb);
int git_color_default_config(const char *var, const char *value, void *cb);

int git_config_colorbool(const char *var, const char *value);
int want_color(int var);
int color_parse(const char *value, char *dst);
int color_parse_mem(const char *value, int len, 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
	1	#ifndef COLOR_H
	2	#define COLOR_H
	3
	4	struct strbuf;
	5
	6	/*
	7	* The maximum length of ANSI color sequence we would generate:
	8	* - leading ESC '[' 2
	9	* - attr + ';' 2 * num_attr (e.g. "1;")
	10	* - no-attr + ';' 3 * num_attr (e.g. "22;")
	11	* - fg color + ';' 17 (e.g. "38;2;255;255;255;")
	12	* - bg color + ';' 17 (e.g. "48;2;255;255;255;")
	13	* - terminating 'm' NUL 2
	14	*
	15	* The above overcounts by one semicolon but it is close enough.
	16	*
	17	* The space for attributes is also slightly overallocated, as
	18	* the negation for some attributes is the same (e.g., nobold and nodim).
	19	*
	20	* We allocate space for 6 attributes.
	21	*/
	22	#define COLOR_MAXLEN 70
	23
	24	/*
	25	* IMPORTANT: Due to the way these color codes are emulated on Windows,
	26	* write them only using printf(), fprintf(), and fputs(). In particular,
	27	* do not use puts() or write().
	28	*/
	29	#define GIT_COLOR_NORMAL ""
	30	#define GIT_COLOR_RESET "\033[m"
	31	#define GIT_COLOR_BOLD "\033[1m"
	32	#define GIT_COLOR_RED "\033[31m"
	33	#define GIT_COLOR_GREEN "\033[32m"
	34	#define GIT_COLOR_YELLOW "\033[33m"
	35	#define GIT_COLOR_BLUE "\033[34m"
	36	#define GIT_COLOR_MAGENTA "\033[35m"
	37	#define GIT_COLOR_CYAN "\033[36m"
	38	#define GIT_COLOR_BOLD_RED "\033[1;31m"
	39	#define GIT_COLOR_BOLD_GREEN "\033[1;32m"
	40	#define GIT_COLOR_BOLD_YELLOW "\033[1;33m"
	41	#define GIT_COLOR_BOLD_BLUE "\033[1;34m"
	42	#define GIT_COLOR_BOLD_MAGENTA "\033[1;35m"
	43	#define GIT_COLOR_BOLD_CYAN "\033[1;36m"
	44	#define GIT_COLOR_BG_RED "\033[41m"
	45	#define GIT_COLOR_BG_GREEN "\033[42m"
	46	#define GIT_COLOR_BG_YELLOW "\033[43m"
	47	#define GIT_COLOR_BG_BLUE "\033[44m"
	48	#define GIT_COLOR_BG_MAGENTA "\033[45m"
	49	#define GIT_COLOR_BG_CYAN "\033[46m"
	50
	51	/* A special value meaning "no color selected" */
	52	#define GIT_COLOR_NIL "NIL"
	53
	54	/*
	55	* The first three are chosen to match common usage in the code, and what is
	56	* returned from git_config_colorbool. The "auto" value can be returned from
	57	* config_colorbool, and will be converted by want_color() into either 0 or 1.
	58	*/
	59	#define GIT_COLOR_UNKNOWN -1
	60	#define GIT_COLOR_NEVER 0
	61	#define GIT_COLOR_ALWAYS 1
	62	#define GIT_COLOR_AUTO 2
	63
	64	/* A default list of colors to use for commit graphs and show-branch output */
	65	extern const char *column_colors_ansi[];
	66	extern const int column_colors_ansi_max;
	67
	68	/*
	69	* Generally the color code will lazily figure this out itself, but
	70	* this provides a mechanism for callers to override autodetection.
	71	*/
	72	extern int color_stdout_is_tty;
	73
	74	/*
	75	* Use the first one if you need only color config; the second is a convenience
	76	* if you are just going to change to git_default_config, too.
	77	*/
	78	int git_color_config(const char var, const char value, void *cb);
	79	int git_color_default_config(const char var, const char value, void *cb);
	80
	81	int git_config_colorbool(const char var, const char value);
	82	int want_color(int var);
	83	int color_parse(const char value, char dst);
	84	int color_parse_mem(const char value, int len, char dst);
	85	__attribute__((format (printf, 3, 4)))
	86	int color_fprintf(FILE fp, const char color, const char *fmt, ...);
	87	__attribute__((format (printf, 3, 4)))
	88	int color_fprintf_ln(FILE fp, const char color, const char *fmt, ...);
	89	void color_print_strbuf(FILE fp, const char color, const struct strbuf *sb);
	90
	91	int color_is_nil(const char *color);
	92
	93	#endif /* COLOR_H */