color: delay auto-color decision until point of use
[git/git.git] / color.h
1 #ifndef COLOR_H
2 #define COLOR_H
3
4 struct strbuf;
5
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
20
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 */
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"
33 #define GIT_COLOR_MAGENTA "\033[35m"
34 #define GIT_COLOR_CYAN "\033[36m"
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"
41 #define GIT_COLOR_BG_RED "\033[41m"
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"
47
48 /* A special value meaning "no color selected" */
49 #define GIT_COLOR_NIL "NIL"
50
51 /*
52 * 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
61 /*
62 * This variable stores the value of color.ui
63 */
64 extern int git_use_color_default;
65
66 /* A default list of colors to use for commit graphs and show-branch output */
67 extern const char *column_colors_ansi[];
68 extern const int column_colors_ansi_max;
69
70 /*
71 * Generally the color code will lazily figure this out itself, but
72 * this provides a mechanism for callers to override autodetection.
73 */
74 extern int color_stdout_is_tty;
75
76 /*
77 * Use this instead of git_default_config if you need the value of color.ui.
78 */
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 void color_parse(const char *value, const char *var, char *dst);
84 void color_parse_mem(const char *value, int len, const char *var, 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 */