Merge branch 'esr/maint-doc-fast-import'
[git.git] / color.h
blob9a8495bb7ff06eb4e94e190d902b48c23fc021f9
1 #ifndef COLOR_H
2 #define COLOR_H
4 struct strbuf;
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
16 * The above overcounts attr (we only use 5 not 8) and one semicolon
17 * but it is close enough.
19 #define COLOR_MAXLEN 40
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().
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"
48 /* A special value meaning "no color selected" */
49 #define GIT_COLOR_NIL "NIL"
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.
56 #define GIT_COLOR_UNKNOWN -1
57 #define GIT_COLOR_NEVER 0
58 #define GIT_COLOR_ALWAYS 1
59 #define GIT_COLOR_AUTO 2
61 /* A default list of colors to use for commit graphs and show-branch output */
62 extern const char *column_colors_ansi[];
63 extern const int column_colors_ansi_max;
66 * Generally the color code will lazily figure this out itself, but
67 * this provides a mechanism for callers to override autodetection.
69 extern int color_stdout_is_tty;
72 * 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.
75 int git_color_config(const char *var, const char *value, void *cb);
76 int git_color_default_config(const char *var, const char *value, void *cb);
78 int git_config_colorbool(const char *var, const char *value);
79 int want_color(int var);
80 void color_parse(const char *value, const char *var, char *dst);
81 void color_parse_mem(const char *value, int len, const char *var, char *dst);
82 __attribute__((format (printf, 3, 4)))
83 int color_fprintf(FILE *fp, const char *color, const char *fmt, ...);
84 __attribute__((format (printf, 3, 4)))
85 int color_fprintf_ln(FILE *fp, const char *color, const char *fmt, ...);
86 void color_print_strbuf(FILE *fp, const char *color, const struct strbuf *sb);
88 int color_is_nil(const char *color);
90 #endif /* COLOR_H */