t6026-merge-attr: child processes must not inherit index.lock handles
[git] / color.h
1 #ifndef COLOR_H
2 #define COLOR_H
3
4 struct strbuf;
5
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 + ';'                 3 * 10 (e.g. "1;")
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 attr (we only use 5 not 8) and one semicolon
17  * but it is close enough.
18  */
19 #define COLOR_MAXLEN 70
20
21 #define GIT_COLOR_NORMAL        ""
22 #define GIT_COLOR_RESET         "\033[m"
23 #define GIT_COLOR_BOLD          "\033[1m"
24 #define GIT_COLOR_RED           "\033[31m"
25 #define GIT_COLOR_GREEN         "\033[32m"
26 #define GIT_COLOR_YELLOW        "\033[33m"
27 #define GIT_COLOR_BLUE          "\033[34m"
28 #define GIT_COLOR_MAGENTA       "\033[35m"
29 #define GIT_COLOR_CYAN          "\033[36m"
30 #define GIT_COLOR_BOLD_RED      "\033[1;31m"
31 #define GIT_COLOR_BOLD_GREEN    "\033[1;32m"
32 #define GIT_COLOR_BOLD_YELLOW   "\033[1;33m"
33 #define GIT_COLOR_BOLD_BLUE     "\033[1;34m"
34 #define GIT_COLOR_BOLD_MAGENTA  "\033[1;35m"
35 #define GIT_COLOR_BOLD_CYAN     "\033[1;36m"
36 #define GIT_COLOR_BG_RED        "\033[41m"
37 #define GIT_COLOR_BG_GREEN      "\033[42m"
38 #define GIT_COLOR_BG_YELLOW     "\033[43m"
39 #define GIT_COLOR_BG_BLUE       "\033[44m"
40 #define GIT_COLOR_BG_MAGENTA    "\033[45m"
41 #define GIT_COLOR_BG_CYAN       "\033[46m"
42
43 /* A special value meaning "no color selected" */
44 #define GIT_COLOR_NIL "NIL"
45
46 /*
47  * The first three are chosen to match common usage in the code, and what is
48  * returned from git_config_colorbool. The "auto" value can be returned from
49  * config_colorbool, and will be converted by want_color() into either 0 or 1.
50  */
51 #define GIT_COLOR_UNKNOWN -1
52 #define GIT_COLOR_NEVER  0
53 #define GIT_COLOR_ALWAYS 1
54 #define GIT_COLOR_AUTO   2
55
56 /* A default list of colors to use for commit graphs and show-branch output */
57 extern const char *column_colors_ansi[];
58 extern const int column_colors_ansi_max;
59
60 /*
61  * Generally the color code will lazily figure this out itself, but
62  * this provides a mechanism for callers to override autodetection.
63  */
64 extern int color_stdout_is_tty;
65
66 /*
67  * Use the first one if you need only color config; the second is a convenience
68  * if you are just going to change to git_default_config, too.
69  */
70 int git_color_config(const char *var, const char *value, void *cb);
71 int git_color_default_config(const char *var, const char *value, void *cb);
72
73 /*
74  * Set the color buffer (which must be COLOR_MAXLEN bytes)
75  * to the raw color bytes; this is useful for initializing
76  * default color variables.
77  */
78 void color_set(char *dst, const char *color_bytes);
79
80 int git_config_colorbool(const char *var, const char *value);
81 int want_color(int var);
82 int color_parse(const char *value, char *dst);
83 int color_parse_mem(const char *value, int len, char *dst);
84 __attribute__((format (printf, 3, 4)))
85 int color_fprintf(FILE *fp, const char *color, const char *fmt, ...);
86 __attribute__((format (printf, 3, 4)))
87 int color_fprintf_ln(FILE *fp, const char *color, const char *fmt, ...);
88 void color_print_strbuf(FILE *fp, const char *color, const struct strbuf *sb);
89
90 int color_is_nil(const char *color);
91
92 #endif /* COLOR_H */