Documentation improvements for the description of short format.
[git/gitweb.git] / color.c
blobe8bcac0a79a27ee093f3d5a92013780cf52eb9da
1 #include "cache.h"
2 #include "color.h"
4 int git_use_color_default = 0;
6 static int parse_color(const char *name, int len)
8 static const char * const color_names[] = {
9 "normal", "black", "red", "green", "yellow",
10 "blue", "magenta", "cyan", "white"
12 char *end;
13 int i;
14 for (i = 0; i < ARRAY_SIZE(color_names); i++) {
15 const char *str = color_names[i];
16 if (!strncasecmp(name, str, len) && !str[len])
17 return i - 1;
19 i = strtol(name, &end, 10);
20 if (end - name == len && i >= -1 && i <= 255)
21 return i;
22 return -2;
25 static int parse_attr(const char *name, int len)
27 static const int attr_values[] = { 1, 2, 4, 5, 7 };
28 static const char * const attr_names[] = {
29 "bold", "dim", "ul", "blink", "reverse"
31 int i;
32 for (i = 0; i < ARRAY_SIZE(attr_names); i++) {
33 const char *str = attr_names[i];
34 if (!strncasecmp(name, str, len) && !str[len])
35 return attr_values[i];
37 return -1;
40 void color_parse(const char *value, const char *var, char *dst)
42 color_parse_mem(value, strlen(value), var, dst);
45 void color_parse_mem(const char *value, int value_len, const char *var,
46 char *dst)
48 const char *ptr = value;
49 int len = value_len;
50 unsigned int attr = 0;
51 int fg = -2;
52 int bg = -2;
54 if (!strncasecmp(value, "reset", len)) {
55 strcpy(dst, GIT_COLOR_RESET);
56 return;
59 /* [fg [bg]] [attr]... */
60 while (len > 0) {
61 const char *word = ptr;
62 int val, wordlen = 0;
64 while (len > 0 && !isspace(word[wordlen])) {
65 wordlen++;
66 len--;
69 ptr = word + wordlen;
70 while (len > 0 && isspace(*ptr)) {
71 ptr++;
72 len--;
75 val = parse_color(word, wordlen);
76 if (val >= -1) {
77 if (fg == -2) {
78 fg = val;
79 continue;
81 if (bg == -2) {
82 bg = val;
83 continue;
85 goto bad;
87 val = parse_attr(word, wordlen);
88 if (0 <= val)
89 attr |= (1 << val);
90 else
91 goto bad;
94 if (attr || fg >= 0 || bg >= 0) {
95 int sep = 0;
96 int i;
98 *dst++ = '\033';
99 *dst++ = '[';
101 for (i = 0; attr; i++) {
102 unsigned bit = (1 << i);
103 if (!(attr & bit))
104 continue;
105 attr &= ~bit;
106 if (sep++)
107 *dst++ = ';';
108 *dst++ = '0' + i;
110 if (fg >= 0) {
111 if (sep++)
112 *dst++ = ';';
113 if (fg < 8) {
114 *dst++ = '3';
115 *dst++ = '0' + fg;
116 } else {
117 dst += sprintf(dst, "38;5;%d", fg);
120 if (bg >= 0) {
121 if (sep++)
122 *dst++ = ';';
123 if (bg < 8) {
124 *dst++ = '4';
125 *dst++ = '0' + bg;
126 } else {
127 dst += sprintf(dst, "48;5;%d", bg);
130 *dst++ = 'm';
132 *dst = 0;
133 return;
134 bad:
135 die("bad color value '%.*s' for variable '%s'", value_len, value, var);
138 int git_config_colorbool(const char *var, const char *value, int stdout_is_tty)
140 if (value) {
141 if (!strcasecmp(value, "never"))
142 return 0;
143 if (!strcasecmp(value, "always"))
144 return 1;
145 if (!strcasecmp(value, "auto"))
146 goto auto_color;
149 /* Missing or explicit false to turn off colorization */
150 if (!git_config_bool(var, value))
151 return 0;
153 /* any normal truth value defaults to 'auto' */
154 auto_color:
155 if (stdout_is_tty < 0)
156 stdout_is_tty = isatty(1);
157 if (stdout_is_tty || (pager_in_use() && pager_use_color)) {
158 char *term = getenv("TERM");
159 if (term && strcmp(term, "dumb"))
160 return 1;
162 return 0;
165 int git_color_default_config(const char *var, const char *value, void *cb)
167 if (!strcmp(var, "color.ui")) {
168 git_use_color_default = git_config_colorbool(var, value, -1);
169 return 0;
172 return git_default_config(var, value, cb);
175 static int color_vfprintf(FILE *fp, const char *color, const char *fmt,
176 va_list args, const char *trail)
178 int r = 0;
180 if (*color)
181 r += fprintf(fp, "%s", color);
182 r += vfprintf(fp, fmt, args);
183 if (*color)
184 r += fprintf(fp, "%s", GIT_COLOR_RESET);
185 if (trail)
186 r += fprintf(fp, "%s", trail);
187 return r;
192 int color_fprintf(FILE *fp, const char *color, const char *fmt, ...)
194 va_list args;
195 int r;
196 va_start(args, fmt);
197 r = color_vfprintf(fp, color, fmt, args, NULL);
198 va_end(args);
199 return r;
202 int color_fprintf_ln(FILE *fp, const char *color, const char *fmt, ...)
204 va_list args;
205 int r;
206 va_start(args, fmt);
207 r = color_vfprintf(fp, color, fmt, args, "\n");
208 va_end(args);
209 return r;
213 * This function splits the buffer by newlines and colors the lines individually.
215 * Returns 0 on success.
217 int color_fwrite_lines(FILE *fp, const char *color,
218 size_t count, const char *buf)
220 if (!*color)
221 return fwrite(buf, count, 1, fp) != 1;
222 while (count) {
223 char *p = memchr(buf, '\n', count);
224 if (p != buf && (fputs(color, fp) < 0 ||
225 fwrite(buf, p ? p - buf : count, 1, fp) != 1 ||
226 fputs(GIT_COLOR_RESET, fp) < 0))
227 return -1;
228 if (!p)
229 return 0;
230 if (fputc('\n', fp) < 0)
231 return -1;
232 count -= p + 1 - buf;
233 buf = p + 1;
235 return 0;