@leroysheep / LeeRoySheep
Code Commits Pulls CI/CD 82,037
test
bisect jch maint master next seen test todo
h 143 lines 5.17 KB
Raw
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 * - reset ';' .................1
10 * - attr + ';' 2 * num_attr (e.g. "1;")
11 * - no-attr + ';' 3 * num_attr (e.g. "22;")
12 * - fg color + ';' 17 (e.g. "38;2;255;255;255;")
13 * - bg color + ';' 17 (e.g. "48;2;255;255;255;")
14 * - terminating 'm' NUL 2
15 *
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).
20 *
21 * We allocate space for 7 attributes.
22 */
23 #define COLOR_MAXLEN 75
24
25 #define GIT_COLOR_NORMAL ""
26 #define GIT_COLOR_RESET "\033[m"
27 #define GIT_COLOR_BOLD "\033[1m"
28 #define GIT_COLOR_BLACK "\033[30m"
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_WHITE "\033[37m"
36 #define GIT_COLOR_DEFAULT "\033[39m"
37 #define GIT_COLOR_BOLD_BLACK "\033[1;30m"
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_BOLD_WHITE "\033[1;37m"
45 #define GIT_COLOR_BOLD_DEFAULT "\033[1;39m"
46 #define GIT_COLOR_FAINT_BLACK "\033[2;30m"
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"
53 #define GIT_COLOR_FAINT_WHITE "\033[2;37m"
54 #define GIT_COLOR_FAINT_DEFAULT "\033[2;39m"
55 #define GIT_COLOR_BG_BLACK "\033[40m"
56 #define GIT_COLOR_BG_RED "\033[41m"
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"
62 #define GIT_COLOR_BG_WHITE "\033[47m"
63 #define GIT_COLOR_BG_DEFAULT "\033[49m"
64 #define GIT_COLOR_FAINT "\033[2m"
65 #define GIT_COLOR_FAINT_ITALIC "\033[2;3m"
66 #define GIT_COLOR_REVERSE "\033[7m"
67
68 /* A special value meaning "no color selected" */
69 #define GIT_COLOR_NIL "NIL"
70
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 enum git_colorbool {
77 GIT_COLOR_UNKNOWN = -1,
78 GIT_COLOR_NEVER = 0,
79 GIT_COLOR_ALWAYS = 1,
80 GIT_COLOR_AUTO = 2,
81 };
82
83 /* A default list of colors to use for commit graphs and show-branch output */
84 extern const char *column_colors_ansi[];
85 extern const int column_colors_ansi_max;
86
87 /*
88 * Generally the color code will lazily figure this out itself, but
89 * this provides a mechanism for callers to override autodetection.
90 */
91 extern int color_stdout_is_tty;
92
93 /* Parse color config. */
94 int git_color_config(const char *var, const char *value, void *cb);
95
96 /*
97 * Parse a config option, which can be a boolean or one of
98 * "never", "auto", "always". Return a constant of
99 * GIT_COLOR_NEVER for "never" or negative boolean,
100 * GIT_COLOR_ALWAYS for "always" or a positive boolean,
101 * and GIT_COLOR_AUTO for "auto".
102 */
103 enum git_colorbool git_config_colorbool(const char *var, const char *value);
104
105 /*
106 * Return a boolean whether to use color, where the argument 'var' is
107 * one of GIT_COLOR_UNKNOWN, GIT_COLOR_NEVER, GIT_COLOR_ALWAYS, GIT_COLOR_AUTO.
108 */
109 bool want_color_fd(int fd, enum git_colorbool var);
110 #define want_color(colorbool) want_color_fd(1, (colorbool))
111 #define want_color_stderr(colorbool) want_color_fd(2, (colorbool))
112
113 /*
114 * Translate a Git color from 'value' into a string that the terminal can
115 * interpret and store it into 'dst'. The Git color values are of the form
116 * "foreground [background] [attr]" where fore- and background can be a color
117 * name ("red"), a RGB code (#FF0000 or #F00) or a 256-color-mode from the
118 * terminal.
119 */
120 int color_parse(const char *value, char *dst);
121 int color_parse_quietly(const char *value, char *dst);
122 int color_parse_mem(const char *value, int len, char *dst);
123
124 /*
125 * Output the formatted string in the specified color (and then reset to normal
126 * color so subsequent output is uncolored). Omits the color encapsulation if
127 * `color` is NULL. The `color_fprintf_ln` prints a new line after resetting
128 * the color. The `color_print_strbuf` prints the contents of the given
129 * strbuf (BUG: but only up to its first NUL character).
130 */
131 __attribute__((format (printf, 3, 4)))
132 int color_fprintf(FILE *fp, const char *color, const char *fmt, ...);
133 __attribute__((format (printf, 3, 4)))
134 int color_fprintf_ln(FILE *fp, const char *color, const char *fmt, ...);
135 void color_print_strbuf(FILE *fp, const char *color, const struct strbuf *sb);
136
137 /*
138 * Check if the given color is GIT_COLOR_NIL that means "no color selected".
139 * The caller needs to replace the color with the actual desired color.
140 */
141 int color_is_nil(const char *color);
142
143 #endif /* COLOR_H */