Sync with maint
[git] / color.h
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  * - attr + ';'                 2 * num_attr (e.g. "1;")
10  * - no-attr + ';'              3 * num_attr (e.g. "22;")
11  * - fg color + ';'             17 (e.g. "38;2;255;255;255;")
12  * - bg color + ';'             17 (e.g. "48;2;255;255;255;")
13  * - terminating 'm' NUL        2
14  *
15  * The above overcounts by one semicolon but it is close enough.
16  *
17  * The space for attributes is also slightly overallocated, as
18  * the negation for some attributes is the same (e.g., nobold and nodim).
19  *
20  * We allocate space for 7 attributes.
21  */
22 #define COLOR_MAXLEN 75
23
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"
45
46 /* A special value meaning "no color selected" */
47 #define GIT_COLOR_NIL "NIL"
48
49 /*
50  * The first three are chosen to match common usage in the code, and what is
51  * returned from git_config_colorbool. The "auto" value can be returned from
52  * config_colorbool, and will be converted by want_color() into either 0 or 1.
53  */
54 #define GIT_COLOR_UNKNOWN -1
55 #define GIT_COLOR_NEVER  0
56 #define GIT_COLOR_ALWAYS 1
57 #define GIT_COLOR_AUTO   2
58
59 /* A default list of colors to use for commit graphs and show-branch output */
60 extern const char *column_colors_ansi[];
61 extern const int column_colors_ansi_max;
62
63 /*
64  * Generally the color code will lazily figure this out itself, but
65  * this provides a mechanism for callers to override autodetection.
66  */
67 extern int color_stdout_is_tty;
68
69 /*
70  * Use the first one if you need only color config; the second is a convenience
71  * if you are just going to change to git_default_config, too.
72  */
73 int git_color_config(const char *var, const char *value, void *cb);
74 int git_color_default_config(const char *var, const char *value, void *cb);
75
76 /*
77  * Set the color buffer (which must be COLOR_MAXLEN bytes)
78  * to the raw color bytes; this is useful for initializing
79  * default color variables.
80  */
81 void color_set(char *dst, const char *color_bytes);
82
83 int git_config_colorbool(const char *var, const char *value);
84 int want_color(int var);
85 int color_parse(const char *value, char *dst);
86 int color_parse_mem(const char *value, int len, char *dst);
87 __attribute__((format (printf, 3, 4)))
88 int color_fprintf(FILE *fp, const char *color, const char *fmt, ...);
89 __attribute__((format (printf, 3, 4)))
90 int color_fprintf_ln(FILE *fp, const char *color, const char *fmt, ...);
91 void color_print_strbuf(FILE *fp, const char *color, const struct strbuf *sb);
92
93 int color_is_nil(const char *color);
94
95 #endif /* COLOR_H */