packaging: Add contrib installation
[platform/upstream/git.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_FAINT_RED     "\033[2;31m"
40 #define GIT_COLOR_FAINT_GREEN   "\033[2;32m"
41 #define GIT_COLOR_FAINT_YELLOW  "\033[2;33m"
42 #define GIT_COLOR_FAINT_BLUE    "\033[2;34m"
43 #define GIT_COLOR_FAINT_MAGENTA "\033[2;35m"
44 #define GIT_COLOR_FAINT_CYAN    "\033[2;36m"
45 #define GIT_COLOR_BG_RED        "\033[41m"
46 #define GIT_COLOR_BG_GREEN      "\033[42m"
47 #define GIT_COLOR_BG_YELLOW     "\033[43m"
48 #define GIT_COLOR_BG_BLUE       "\033[44m"
49 #define GIT_COLOR_BG_MAGENTA    "\033[45m"
50 #define GIT_COLOR_BG_CYAN       "\033[46m"
51 #define GIT_COLOR_FAINT         "\033[2m"
52 #define GIT_COLOR_FAINT_ITALIC  "\033[2;3m"
53 #define GIT_COLOR_REVERSE       "\033[7m"
54
55 /* A special value meaning "no color selected" */
56 #define GIT_COLOR_NIL "NIL"
57
58 /*
59  * The first three are chosen to match common usage in the code, and what is
60  * returned from git_config_colorbool. The "auto" value can be returned from
61  * config_colorbool, and will be converted by want_color() into either 0 or 1.
62  */
63 #define GIT_COLOR_UNKNOWN -1
64 #define GIT_COLOR_NEVER  0
65 #define GIT_COLOR_ALWAYS 1
66 #define GIT_COLOR_AUTO   2
67
68 /* A default list of colors to use for commit graphs and show-branch output */
69 extern const char *column_colors_ansi[];
70 extern const int column_colors_ansi_max;
71
72 /*
73  * Generally the color code will lazily figure this out itself, but
74  * this provides a mechanism for callers to override autodetection.
75  */
76 extern int color_stdout_is_tty;
77
78 /*
79  * Use the first one if you need only color config; the second is a convenience
80  * if you are just going to change to git_default_config, too.
81  */
82 int git_color_config(const char *var, const char *value, void *cb);
83 int git_color_default_config(const char *var, const char *value, void *cb);
84
85 /*
86  * Parse a config option, which can be a boolean or one of
87  * "never", "auto", "always". Return a constant of
88  * GIT_COLOR_NEVER for "never" or negative boolean,
89  * GIT_COLOR_ALWAYS for "always" or a positive boolean,
90  * and GIT_COLOR_AUTO for "auto".
91  */
92 int git_config_colorbool(const char *var, const char *value);
93
94 /*
95  * Return a boolean whether to use color, where the argument 'var' is
96  * one of GIT_COLOR_UNKNOWN, GIT_COLOR_NEVER, GIT_COLOR_ALWAYS, GIT_COLOR_AUTO.
97  */
98 int want_color_fd(int fd, int var);
99 #define want_color(colorbool) want_color_fd(1, (colorbool))
100 #define want_color_stderr(colorbool) want_color_fd(2, (colorbool))
101
102 /*
103  * Translate a Git color from 'value' into a string that the terminal can
104  * interpret and store it into 'dst'. The Git color values are of the form
105  * "foreground [background] [attr]" where fore- and background can be a color
106  * name ("red"), a RGB code (#0xFF0000) or a 256-color-mode from the terminal.
107  */
108 int color_parse(const char *value, char *dst);
109 int color_parse_mem(const char *value, int len, char *dst);
110
111 /*
112  * Output the formatted string in the specified color (and then reset to normal
113  * color so subsequent output is uncolored). Omits the color encapsulation if
114  * `color` is NULL. The `color_fprintf_ln` prints a new line after resetting
115  * the color.  The `color_print_strbuf` prints the contents of the given
116  * strbuf (BUG: but only up to its first NUL character).
117  */
118 __attribute__((format (printf, 3, 4)))
119 int color_fprintf(FILE *fp, const char *color, const char *fmt, ...);
120 __attribute__((format (printf, 3, 4)))
121 int color_fprintf_ln(FILE *fp, const char *color, const char *fmt, ...);
122 void color_print_strbuf(FILE *fp, const char *color, const struct strbuf *sb);
123
124 /*
125  * Check if the given color is GIT_COLOR_NIL that means "no color selected".
126  * The caller needs to replace the color with the actual desired color.
127  */
128 int color_is_nil(const char *color);
129
130 #endif /* COLOR_H */