docs: give more hints about how "add -e" works
[git/kirr.git] / color.h
blob03ca0647485e8044d4131f2c61c37b4e9408cd2a
1 #ifndef COLOR_H
2 #define COLOR_H
4 /* 2 + (2 * num_attrs) + 8 + 1 + 8 + 'm' + NUL */
5 /* "\033[1;2;4;5;7;38;5;2xx;48;5;2xxm\0" */
6 /*
7 * The maximum length of ANSI color sequence we would generate:
8 * - leading ESC '[' 2
9 * - attr + ';' 2 * 8 (e.g. "1;")
10 * - fg color + ';' 9 (e.g. "38;5;2xx;")
11 * - fg color + ';' 9 (e.g. "48;5;2xx;")
12 * - terminating 'm' NUL 2
14 * The above overcounts attr (we only use 5 not 8) and one semicolon
15 * but it is close enough.
17 #define COLOR_MAXLEN 40
20 * IMPORTANT: Due to the way these color codes are emulated on Windows,
21 * write them only using printf(), fprintf(), and fputs(). In particular,
22 * do not use puts() or write().
24 #define GIT_COLOR_NORMAL ""
25 #define GIT_COLOR_RESET "\033[m"
26 #define GIT_COLOR_BOLD "\033[1m"
27 #define GIT_COLOR_RED "\033[31m"
28 #define GIT_COLOR_GREEN "\033[32m"
29 #define GIT_COLOR_YELLOW "\033[33m"
30 #define GIT_COLOR_BLUE "\033[34m"
31 #define GIT_COLOR_MAGENTA "\033[35m"
32 #define GIT_COLOR_CYAN "\033[36m"
33 #define GIT_COLOR_BOLD_RED "\033[1;31m"
34 #define GIT_COLOR_BOLD_GREEN "\033[1;32m"
35 #define GIT_COLOR_BOLD_YELLOW "\033[1;33m"
36 #define GIT_COLOR_BOLD_BLUE "\033[1;34m"
37 #define GIT_COLOR_BOLD_MAGENTA "\033[1;35m"
38 #define GIT_COLOR_BOLD_CYAN "\033[1;36m"
39 #define GIT_COLOR_BG_RED "\033[41m"
40 #define GIT_COLOR_BG_GREEN "\033[42m"
41 #define GIT_COLOR_BG_YELLOW "\033[43m"
42 #define GIT_COLOR_BG_BLUE "\033[44m"
43 #define GIT_COLOR_BG_MAGENTA "\033[45m"
44 #define GIT_COLOR_BG_CYAN "\033[46m"
47 * This variable stores the value of color.ui
49 extern int git_use_color_default;
53 * Use this instead of git_default_config if you need the value of color.ui.
55 int git_color_default_config(const char *var, const char *value, void *cb);
57 int git_config_colorbool(const char *var, const char *value, int stdout_is_tty);
58 void color_parse(const char *value, const char *var, char *dst);
59 void color_parse_mem(const char *value, int len, const char *var, char *dst);
60 __attribute__((format (printf, 3, 4)))
61 int color_fprintf(FILE *fp, const char *color, const char *fmt, ...);
62 __attribute__((format (printf, 3, 4)))
63 int color_fprintf_ln(FILE *fp, const char *color, const char *fmt, ...);
65 #endif /* COLOR_H */