blob: 9a8495bb7ff06eb4e94e190d902b48c23fc021f9 [file] [log] [blame]
Jeff King7c92fe02006-09-08 04:03:18 -04001#ifndef COLOR_H
2#define COLOR_H
3
Jonathan Niederbecbdae2011-02-25 23:09:41 -06004struct strbuf;
5
Junio C Hamano8b124132010-02-27 18:56:38 -08006/* 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
Jeff King7c92fe02006-09-08 04:03:18 -040020
Johannes Sixte7821d72009-11-27 08:42:25 +010021/*
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 */
Arjen Laarhovendc6ebd42009-02-13 22:53:40 +010026#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"
Allan Caffee427fc5b2009-04-13 15:53:41 -040033#define GIT_COLOR_MAGENTA "\033[35m"
Arjen Laarhovendc6ebd42009-02-13 22:53:40 +010034#define GIT_COLOR_CYAN "\033[36m"
Mark Lodato758df172010-03-07 11:52:45 -050035#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"
Arjen Laarhovendc6ebd42009-02-13 22:53:40 +010041#define GIT_COLOR_BG_RED "\033[41m"
Mark Lodato758df172010-03-07 11:52:45 -050042#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"
Arjen Laarhovendc6ebd42009-02-13 22:53:40 +010047
Jeff King148135f2010-12-09 12:27:08 -050048/* A special value meaning "no color selected" */
49#define GIT_COLOR_NIL "NIL"
50
Matthias Kestenholz6b2f2d92008-02-18 08:26:03 +010051/*
Jeff Kingdaa0c3d2011-08-17 22:04:23 -070052 * The first three are chosen to match common usage in the code, and what is
53 * returned from git_config_colorbool. The "auto" value can be returned from
54 * config_colorbool, and will be converted by want_color() into either 0 or 1.
55 */
56#define GIT_COLOR_UNKNOWN -1
57#define GIT_COLOR_NEVER 0
58#define GIT_COLOR_ALWAYS 1
59#define GIT_COLOR_AUTO 2
60
Dan McGee7cd52b52011-04-05 00:40:23 -050061/* A default list of colors to use for commit graphs and show-branch output */
62extern const char *column_colors_ansi[];
63extern const int column_colors_ansi_max;
Matthias Kestenholz6b2f2d92008-02-18 08:26:03 +010064
65/*
Jeff Kinge269eb72011-08-17 22:03:48 -070066 * Generally the color code will lazily figure this out itself, but
67 * this provides a mechanism for callers to override autodetection.
68 */
69extern int color_stdout_is_tty;
70
71/*
Jeff King3e1dd172011-08-17 22:05:08 -070072 * Use the first one if you need only color config; the second is a convenience
73 * if you are just going to change to git_default_config, too.
Matthias Kestenholz6b2f2d92008-02-18 08:26:03 +010074 */
Jeff King3e1dd172011-08-17 22:05:08 -070075int git_color_config(const char *var, const char *value, void *cb);
Johannes Schindelinef90d6d2008-05-14 18:46:53 +010076int git_color_default_config(const char *var, const char *value, void *cb);
Matthias Kestenholz6b2f2d92008-02-18 08:26:03 +010077
Jeff Kinge269eb72011-08-17 22:03:48 -070078int git_config_colorbool(const char *var, const char *value);
Jeff Kingdaa0c3d2011-08-17 22:04:23 -070079int want_color(int var);
Jeff King5ef8d772009-01-17 10:32:30 -050080void color_parse(const char *value, const char *var, char *dst);
81void color_parse_mem(const char *value, int len, const char *var, char *dst);
Tarmigan Casebolt28bea9e2009-11-14 13:33:13 -080082__attribute__((format (printf, 3, 4)))
Kristian Høgsbergf26a0012007-09-17 20:06:42 -040083int color_fprintf(FILE *fp, const char *color, const char *fmt, ...);
Tarmigan Casebolt28bea9e2009-11-14 13:33:13 -080084__attribute__((format (printf, 3, 4)))
Kristian Høgsbergf26a0012007-09-17 20:06:42 -040085int color_fprintf_ln(FILE *fp, const char *color, const char *fmt, ...);
Jonathan Niederbecbdae2011-02-25 23:09:41 -060086void color_print_strbuf(FILE *fp, const char *color, const struct strbuf *sb);
Jeff King7c92fe02006-09-08 04:03:18 -040087
Jeff King148135f2010-12-09 12:27:08 -050088int color_is_nil(const char *color);
89
Jeff King7c92fe02006-09-08 04:03:18 -040090#endif /* COLOR_H */