color: support strike-through attribute
[git/git.git] / color.h
CommitLineData
7c92fe0e
JK
1#ifndef COLOR_H
2#define COLOR_H
3
becbdae8
JN
4struct strbuf;
5
8b124135
JH
6/*
7 * The maximum length of ANSI color sequence we would generate:
8 * - leading ESC '[' 2
0111681e
JK
9 * - attr + ';' 2 * num_attr (e.g. "1;")
10 * - no-attr + ';' 3 * num_attr (e.g. "22;")
17a4be26
JK
11 * - fg color + ';' 17 (e.g. "38;2;255;255;255;")
12 * - bg color + ';' 17 (e.g. "48;2;255;255;255;")
8b124135
JH
13 * - terminating 'm' NUL 2
14 *
0111681e
JK
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).
54590a0e 19 *
9dc3515c 20 * We allocate space for 7 attributes.
8b124135 21 */
9dc3515c 22#define COLOR_MAXLEN 75
7c92fe0e 23
e7821d73
JS
24/*
25 * IMPORTANT: Due to the way these color codes are emulated on Windows,
26 * write them only using printf(), fprintf(), and fputs(). In particular,
27 * do not use puts() or write().
28 */
dc6ebd4c
AL
29#define GIT_COLOR_NORMAL ""
30#define GIT_COLOR_RESET "\033[m"
31#define GIT_COLOR_BOLD "\033[1m"
32#define GIT_COLOR_RED "\033[31m"
33#define GIT_COLOR_GREEN "\033[32m"
34#define GIT_COLOR_YELLOW "\033[33m"
35#define GIT_COLOR_BLUE "\033[34m"
427fc5b8 36#define GIT_COLOR_MAGENTA "\033[35m"
dc6ebd4c 37#define GIT_COLOR_CYAN "\033[36m"
758df17a
ML
38#define GIT_COLOR_BOLD_RED "\033[1;31m"
39#define GIT_COLOR_BOLD_GREEN "\033[1;32m"
40#define GIT_COLOR_BOLD_YELLOW "\033[1;33m"
41#define GIT_COLOR_BOLD_BLUE "\033[1;34m"
42#define GIT_COLOR_BOLD_MAGENTA "\033[1;35m"
43#define GIT_COLOR_BOLD_CYAN "\033[1;36m"
dc6ebd4c 44#define GIT_COLOR_BG_RED "\033[41m"
758df17a
ML
45#define GIT_COLOR_BG_GREEN "\033[42m"
46#define GIT_COLOR_BG_YELLOW "\033[43m"
47#define GIT_COLOR_BG_BLUE "\033[44m"
48#define GIT_COLOR_BG_MAGENTA "\033[45m"
49#define GIT_COLOR_BG_CYAN "\033[46m"
dc6ebd4c 50
148135fc
JK
51/* A special value meaning "no color selected" */
52#define GIT_COLOR_NIL "NIL"
53
daa0c3d9
JK
54/*
55 * The first three are chosen to match common usage in the code, and what is
56 * returned from git_config_colorbool. The "auto" value can be returned from
57 * config_colorbool, and will be converted by want_color() into either 0 or 1.
58 */
59#define GIT_COLOR_UNKNOWN -1
60#define GIT_COLOR_NEVER 0
61#define GIT_COLOR_ALWAYS 1
62#define GIT_COLOR_AUTO 2
63
7cd52b5b
DM
64/* A default list of colors to use for commit graphs and show-branch output */
65extern const char *column_colors_ansi[];
66extern const int column_colors_ansi_max;
6b2f2d98 67
e269eb79
JK
68/*
69 * Generally the color code will lazily figure this out itself, but
70 * this provides a mechanism for callers to override autodetection.
71 */
72extern int color_stdout_is_tty;
73
6b2f2d98 74/*
3e1dd17a
JK
75 * Use the first one if you need only color config; the second is a convenience
76 * if you are just going to change to git_default_config, too.
6b2f2d98 77 */
3e1dd17a 78int git_color_config(const char *var, const char *value, void *cb);
ef90d6d4 79int git_color_default_config(const char *var, const char *value, void *cb);
6b2f2d98 80
e269eb79 81int git_config_colorbool(const char *var, const char *value);
daa0c3d9 82int want_color(int var);
f6c5a296
JK
83int color_parse(const char *value, char *dst);
84int color_parse_mem(const char *value, int len, char *dst);
28bea9e5 85__attribute__((format (printf, 3, 4)))
f26a0012 86int color_fprintf(FILE *fp, const char *color, const char *fmt, ...);
28bea9e5 87__attribute__((format (printf, 3, 4)))
f26a0012 88int color_fprintf_ln(FILE *fp, const char *color, const char *fmt, ...);
becbdae8 89void color_print_strbuf(FILE *fp, const char *color, const struct strbuf *sb);
7c92fe0e 90
148135fc
JK
91int color_is_nil(const char *color);
92
7c92fe0e 93#endif /* COLOR_H */