]>
Commit | Line | Data |
---|---|---|
7c92fe0e JK |
1 | #ifndef COLOR_H |
2 | #define COLOR_H | |
3 | ||
becbdae8 JN |
4 | struct strbuf; |
5 | ||
8b124135 JH |
6 | /* |
7 | * The maximum length of ANSI color sequence we would generate: | |
8 | * - leading ESC '[' 2 | |
de658515 | 9 | * - reset ';' .................1 |
0111681e JK |
10 | * - attr + ';' 2 * num_attr (e.g. "1;") |
11 | * - no-attr + ';' 3 * num_attr (e.g. "22;") | |
17a4be26 JK |
12 | * - fg color + ';' 17 (e.g. "38;2;255;255;255;") |
13 | * - bg color + ';' 17 (e.g. "48;2;255;255;255;") | |
8b124135 JH |
14 | * - terminating 'm' NUL 2 |
15 | * | |
0111681e JK |
16 | * The above overcounts by one semicolon but it is close enough. |
17 | * | |
18 | * The space for attributes is also slightly overallocated, as | |
19 | * the negation for some attributes is the same (e.g., nobold and nodim). | |
54590a0e | 20 | * |
9dc3515c | 21 | * We allocate space for 7 attributes. |
8b124135 | 22 | */ |
9dc3515c | 23 | #define COLOR_MAXLEN 75 |
7c92fe0e | 24 | |
dc6ebd4c AL |
25 | #define GIT_COLOR_NORMAL "" |
26 | #define GIT_COLOR_RESET "\033[m" | |
27 | #define GIT_COLOR_BOLD "\033[1m" | |
aeefc186 | 28 | #define GIT_COLOR_BLACK "\033[30m" |
dc6ebd4c AL |
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" |
aeefc186 | 35 | #define GIT_COLOR_WHITE "\033[37m" |
05f1f41c | 36 | #define GIT_COLOR_DEFAULT "\033[39m" |
aeefc186 | 37 | #define GIT_COLOR_BOLD_BLACK "\033[1;30m" |
758df17a ML |
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" | |
aeefc186 | 44 | #define GIT_COLOR_BOLD_WHITE "\033[1;37m" |
05f1f41c | 45 | #define GIT_COLOR_BOLD_DEFAULT "\033[1;39m" |
aeefc186 | 46 | #define GIT_COLOR_FAINT_BLACK "\033[2;30m" |
a7be92ac JS |
47 | #define GIT_COLOR_FAINT_RED "\033[2;31m" |
48 | #define GIT_COLOR_FAINT_GREEN "\033[2;32m" | |
49 | #define GIT_COLOR_FAINT_YELLOW "\033[2;33m" | |
50 | #define GIT_COLOR_FAINT_BLUE "\033[2;34m" | |
51 | #define GIT_COLOR_FAINT_MAGENTA "\033[2;35m" | |
52 | #define GIT_COLOR_FAINT_CYAN "\033[2;36m" | |
aeefc186 | 53 | #define GIT_COLOR_FAINT_WHITE "\033[2;37m" |
05f1f41c | 54 | #define GIT_COLOR_FAINT_DEFAULT "\033[2;39m" |
aeefc186 | 55 | #define GIT_COLOR_BG_BLACK "\033[40m" |
dc6ebd4c | 56 | #define GIT_COLOR_BG_RED "\033[41m" |
758df17a ML |
57 | #define GIT_COLOR_BG_GREEN "\033[42m" |
58 | #define GIT_COLOR_BG_YELLOW "\033[43m" | |
59 | #define GIT_COLOR_BG_BLUE "\033[44m" | |
60 | #define GIT_COLOR_BG_MAGENTA "\033[45m" | |
61 | #define GIT_COLOR_BG_CYAN "\033[46m" | |
aeefc186 | 62 | #define GIT_COLOR_BG_WHITE "\033[47m" |
05f1f41c | 63 | #define GIT_COLOR_BG_DEFAULT "\033[49m" |
86b452e2 SB |
64 | #define GIT_COLOR_FAINT "\033[2m" |
65 | #define GIT_COLOR_FAINT_ITALIC "\033[2;3m" | |
7188260d | 66 | #define GIT_COLOR_REVERSE "\033[7m" |
dc6ebd4c | 67 | |
148135fc JK |
68 | /* A special value meaning "no color selected" */ |
69 | #define GIT_COLOR_NIL "NIL" | |
70 | ||
daa0c3d9 JK |
71 | /* |
72 | * The first three are chosen to match common usage in the code, and what is | |
73 | * returned from git_config_colorbool. The "auto" value can be returned from | |
74 | * config_colorbool, and will be converted by want_color() into either 0 or 1. | |
75 | */ | |
76 | #define GIT_COLOR_UNKNOWN -1 | |
77 | #define GIT_COLOR_NEVER 0 | |
78 | #define GIT_COLOR_ALWAYS 1 | |
79 | #define GIT_COLOR_AUTO 2 | |
80 | ||
7cd52b5b DM |
81 | /* A default list of colors to use for commit graphs and show-branch output */ |
82 | extern const char *column_colors_ansi[]; | |
83 | extern const int column_colors_ansi_max; | |
6b2f2d98 | 84 | |
e269eb79 JK |
85 | /* |
86 | * Generally the color code will lazily figure this out itself, but | |
87 | * this provides a mechanism for callers to override autodetection. | |
88 | */ | |
89 | extern int color_stdout_is_tty; | |
90 | ||
97eeeea2 | 91 | /* Parse color config. */ |
3e1dd17a | 92 | int git_color_config(const char *var, const char *value, void *cb); |
6b2f2d98 | 93 | |
7ce4fb94 | 94 | /* |
75e5e9c3 SB |
95 | * Parse a config option, which can be a boolean or one of |
96 | * "never", "auto", "always". Return a constant of | |
97 | * GIT_COLOR_NEVER for "never" or negative boolean, | |
98 | * GIT_COLOR_ALWAYS for "always" or a positive boolean, | |
99 | * and GIT_COLOR_AUTO for "auto". | |
7ce4fb94 | 100 | */ |
e269eb79 | 101 | int git_config_colorbool(const char *var, const char *value); |
75e5e9c3 SB |
102 | |
103 | /* | |
104 | * Return a boolean whether to use color, where the argument 'var' is | |
105 | * one of GIT_COLOR_UNKNOWN, GIT_COLOR_NEVER, GIT_COLOR_ALWAYS, GIT_COLOR_AUTO. | |
106 | */ | |
295d949c JS |
107 | int want_color_fd(int fd, int var); |
108 | #define want_color(colorbool) want_color_fd(1, (colorbool)) | |
109 | #define want_color_stderr(colorbool) want_color_fd(2, (colorbool)) | |
75e5e9c3 SB |
110 | |
111 | /* | |
112 | * Translate a Git color from 'value' into a string that the terminal can | |
113 | * interpret and store it into 'dst'. The Git color values are of the form | |
114 | * "foreground [background] [attr]" where fore- and background can be a color | |
115 | * name ("red"), a RGB code (#0xFF0000) or a 256-color-mode from the terminal. | |
116 | */ | |
f6c5a296 JK |
117 | int color_parse(const char *value, char *dst); |
118 | int color_parse_mem(const char *value, int len, char *dst); | |
75e5e9c3 SB |
119 | |
120 | /* | |
121 | * Output the formatted string in the specified color (and then reset to normal | |
122 | * color so subsequent output is uncolored). Omits the color encapsulation if | |
123 | * `color` is NULL. The `color_fprintf_ln` prints a new line after resetting | |
124 | * the color. The `color_print_strbuf` prints the contents of the given | |
125 | * strbuf (BUG: but only up to its first NUL character). | |
126 | */ | |
28bea9e5 | 127 | __attribute__((format (printf, 3, 4))) |
f26a0012 | 128 | int color_fprintf(FILE *fp, const char *color, const char *fmt, ...); |
28bea9e5 | 129 | __attribute__((format (printf, 3, 4))) |
f26a0012 | 130 | int color_fprintf_ln(FILE *fp, const char *color, const char *fmt, ...); |
becbdae8 | 131 | void color_print_strbuf(FILE *fp, const char *color, const struct strbuf *sb); |
7c92fe0e | 132 | |
75e5e9c3 SB |
133 | /* |
134 | * Check if the given color is GIT_COLOR_NIL that means "no color selected". | |
135 | * The caller needs to replace the color with the actual desired color. | |
136 | */ | |
148135fc JK |
137 | int color_is_nil(const char *color); |
138 | ||
7c92fe0e | 139 | #endif /* COLOR_H */ |