b6933a16fe43a6110d04cceb358409a910c5e193
   1#include "cache.h"
   2#include "color.h"
   3
   4static int git_use_color_default = GIT_COLOR_AUTO;
   5int color_stdout_is_tty = -1;
   6
   7/*
   8 * The list of available column colors.
   9 */
  10const char *column_colors_ansi[] = {
  11        GIT_COLOR_RED,
  12        GIT_COLOR_GREEN,
  13        GIT_COLOR_YELLOW,
  14        GIT_COLOR_BLUE,
  15        GIT_COLOR_MAGENTA,
  16        GIT_COLOR_CYAN,
  17        GIT_COLOR_BOLD_RED,
  18        GIT_COLOR_BOLD_GREEN,
  19        GIT_COLOR_BOLD_YELLOW,
  20        GIT_COLOR_BOLD_BLUE,
  21        GIT_COLOR_BOLD_MAGENTA,
  22        GIT_COLOR_BOLD_CYAN,
  23        GIT_COLOR_RESET,
  24};
  25
  26/* Ignore the RESET at the end when giving the size */
  27const int column_colors_ansi_max = ARRAY_SIZE(column_colors_ansi) - 1;
  28
  29/* An individual foreground or background color. */
  30struct color {
  31        enum {
  32                COLOR_UNSPECIFIED = 0,
  33                COLOR_NORMAL,
  34                COLOR_ANSI, /* basic 0-7 ANSI colors */
  35                COLOR_256,
  36                COLOR_RGB
  37        } type;
  38        /* The numeric value for ANSI and 256-color modes */
  39        unsigned char value;
  40        /* 24-bit RGB color values */
  41        unsigned char red, green, blue;
  42};
  43
  44/*
  45 * "word" is a buffer of length "len"; does it match the NUL-terminated
  46 * "match" exactly?
  47 */
  48static int match_word(const char *word, int len, const char *match)
  49{
  50        return !strncasecmp(word, match, len) && !match[len];
  51}
  52
  53static int get_hex_color(const char *in, unsigned char *out)
  54{
  55        unsigned int val;
  56        val = (hexval(in[0]) << 4) | hexval(in[1]);
  57        if (val & ~0xff)
  58                return -1;
  59        *out = val;
  60        return 0;
  61}
  62
  63static int parse_color(struct color *out, const char *name, int len)
  64{
  65        /* Positions in array must match ANSI color codes */
  66        static const char * const color_names[] = {
  67                "black", "red", "green", "yellow",
  68                "blue", "magenta", "cyan", "white"
  69        };
  70        char *end;
  71        int i;
  72        long val;
  73
  74        /* First try the special word "normal"... */
  75        if (match_word(name, len, "normal")) {
  76                out->type = COLOR_NORMAL;
  77                return 0;
  78        }
  79
  80        /* Try a 24-bit RGB value */
  81        if (len == 7 && name[0] == '#') {
  82                if (!get_hex_color(name + 1, &out->red) &&
  83                    !get_hex_color(name + 3, &out->green) &&
  84                    !get_hex_color(name + 5, &out->blue)) {
  85                        out->type = COLOR_RGB;
  86                        return 0;
  87                }
  88        }
  89
  90        /* Then pick from our human-readable color names... */
  91        for (i = 0; i < ARRAY_SIZE(color_names); i++) {
  92                if (match_word(name, len, color_names[i])) {
  93                        out->type = COLOR_ANSI;
  94                        out->value = i;
  95                        return 0;
  96                }
  97        }
  98
  99        /* And finally try a literal 256-color-mode number */
 100        val = strtol(name, &end, 10);
 101        if (end - name == len) {
 102                /*
 103                 * Allow "-1" as an alias for "normal", but other negative
 104                 * numbers are bogus.
 105                 */
 106                if (val < -1)
 107                        ; /* fall through to error */
 108                else if (val < 0) {
 109                        out->type = COLOR_NORMAL;
 110                        return 0;
 111                /* Rewrite low numbers as more-portable standard colors. */
 112                } else if (val < 8) {
 113                        out->type = COLOR_ANSI;
 114                        out->value = val;
 115                        return 0;
 116                } else if (val < 256) {
 117                        out->type = COLOR_256;
 118                        out->value = val;
 119                        return 0;
 120                }
 121        }
 122
 123        return -1;
 124}
 125
 126static int parse_attr(const char *name, size_t len)
 127{
 128        static const struct {
 129                const char *name;
 130                size_t len;
 131                int val, neg;
 132        } attrs[] = {
 133#define ATTR(x, val, neg) { (x), sizeof(x)-1, (val), (neg) }
 134                ATTR("bold",      1, 22),
 135                ATTR("dim",       2, 22),
 136                ATTR("italic",    3, 23),
 137                ATTR("ul",        4, 24),
 138                ATTR("blink",     5, 25),
 139                ATTR("reverse",   7, 27)
 140#undef ATTR
 141        };
 142        int negate = 0;
 143        int i;
 144
 145        if (skip_prefix_mem(name, len, "no", &name, &len)) {
 146                skip_prefix_mem(name, len, "-", &name, &len);
 147                negate = 1;
 148        }
 149
 150        for (i = 0; i < ARRAY_SIZE(attrs); i++) {
 151                if (attrs[i].len == len && !memcmp(attrs[i].name, name, len))
 152                        return negate ? attrs[i].neg : attrs[i].val;
 153        }
 154        return -1;
 155}
 156
 157int color_parse(const char *value, char *dst)
 158{
 159        return color_parse_mem(value, strlen(value), dst);
 160}
 161
 162/*
 163 * Write the ANSI color codes for "c" to "out"; the string should
 164 * already have the ANSI escape code in it. "out" should have enough
 165 * space in it to fit any color.
 166 */
 167static char *color_output(char *out, const struct color *c, char type)
 168{
 169        switch (c->type) {
 170        case COLOR_UNSPECIFIED:
 171        case COLOR_NORMAL:
 172                break;
 173        case COLOR_ANSI:
 174                *out++ = type;
 175                *out++ = '0' + c->value;
 176                break;
 177        case COLOR_256:
 178                out += sprintf(out, "%c8;5;%d", type, c->value);
 179                break;
 180        case COLOR_RGB:
 181                out += sprintf(out, "%c8;2;%d;%d;%d", type,
 182                               c->red, c->green, c->blue);
 183                break;
 184        }
 185        return out;
 186}
 187
 188static int color_empty(const struct color *c)
 189{
 190        return c->type <= COLOR_NORMAL;
 191}
 192
 193int color_parse_mem(const char *value, int value_len, char *dst)
 194{
 195        const char *ptr = value;
 196        int len = value_len;
 197        unsigned int attr = 0;
 198        struct color fg = { COLOR_UNSPECIFIED };
 199        struct color bg = { COLOR_UNSPECIFIED };
 200
 201        if (!strncasecmp(value, "reset", len)) {
 202                strcpy(dst, GIT_COLOR_RESET);
 203                return 0;
 204        }
 205
 206        /* [fg [bg]] [attr]... */
 207        while (len > 0) {
 208                const char *word = ptr;
 209                struct color c;
 210                int val, wordlen = 0;
 211
 212                while (len > 0 && !isspace(word[wordlen])) {
 213                        wordlen++;
 214                        len--;
 215                }
 216
 217                ptr = word + wordlen;
 218                while (len > 0 && isspace(*ptr)) {
 219                        ptr++;
 220                        len--;
 221                }
 222
 223                if (!parse_color(&c, word, wordlen)) {
 224                        if (fg.type == COLOR_UNSPECIFIED) {
 225                                fg = c;
 226                                continue;
 227                        }
 228                        if (bg.type == COLOR_UNSPECIFIED) {
 229                                bg = c;
 230                                continue;
 231                        }
 232                        goto bad;
 233                }
 234                val = parse_attr(word, wordlen);
 235                if (0 <= val)
 236                        attr |= (1 << val);
 237                else
 238                        goto bad;
 239        }
 240
 241        if (attr || !color_empty(&fg) || !color_empty(&bg)) {
 242                int sep = 0;
 243                int i;
 244
 245                *dst++ = '\033';
 246                *dst++ = '[';
 247
 248                for (i = 0; attr; i++) {
 249                        unsigned bit = (1 << i);
 250                        if (!(attr & bit))
 251                                continue;
 252                        attr &= ~bit;
 253                        if (sep++)
 254                                *dst++ = ';';
 255                        dst += sprintf(dst, "%d", i);
 256                }
 257                if (!color_empty(&fg)) {
 258                        if (sep++)
 259                                *dst++ = ';';
 260                        /* foreground colors are all in the 3x range */
 261                        dst = color_output(dst, &fg, '3');
 262                }
 263                if (!color_empty(&bg)) {
 264                        if (sep++)
 265                                *dst++ = ';';
 266                        /* background colors are all in the 4x range */
 267                        dst = color_output(dst, &bg, '4');
 268                }
 269                *dst++ = 'm';
 270        }
 271        *dst = 0;
 272        return 0;
 273bad:
 274        return error(_("invalid color value: %.*s"), value_len, value);
 275}
 276
 277int git_config_colorbool(const char *var, const char *value)
 278{
 279        if (value) {
 280                if (!strcasecmp(value, "never"))
 281                        return 0;
 282                if (!strcasecmp(value, "always"))
 283                        return 1;
 284                if (!strcasecmp(value, "auto"))
 285                        return GIT_COLOR_AUTO;
 286        }
 287
 288        if (!var)
 289                return -1;
 290
 291        /* Missing or explicit false to turn off colorization */
 292        if (!git_config_bool(var, value))
 293                return 0;
 294
 295        /* any normal truth value defaults to 'auto' */
 296        return GIT_COLOR_AUTO;
 297}
 298
 299static int check_auto_color(void)
 300{
 301        if (color_stdout_is_tty < 0)
 302                color_stdout_is_tty = isatty(1);
 303        if (color_stdout_is_tty || (pager_in_use() && pager_use_color)) {
 304                char *term = getenv("TERM");
 305                if (term && strcmp(term, "dumb"))
 306                        return 1;
 307        }
 308        return 0;
 309}
 310
 311int want_color(int var)
 312{
 313        static int want_auto = -1;
 314
 315        if (var < 0)
 316                var = git_use_color_default;
 317
 318        if (var == GIT_COLOR_AUTO) {
 319                if (want_auto < 0)
 320                        want_auto = check_auto_color();
 321                return want_auto;
 322        }
 323        return var;
 324}
 325
 326int git_color_config(const char *var, const char *value, void *cb)
 327{
 328        if (!strcmp(var, "color.ui")) {
 329                git_use_color_default = git_config_colorbool(var, value);
 330                return 0;
 331        }
 332
 333        return 0;
 334}
 335
 336int git_color_default_config(const char *var, const char *value, void *cb)
 337{
 338        if (git_color_config(var, value, cb) < 0)
 339                return -1;
 340
 341        return git_default_config(var, value, cb);
 342}
 343
 344void color_print_strbuf(FILE *fp, const char *color, const struct strbuf *sb)
 345{
 346        if (*color)
 347                fprintf(fp, "%s", color);
 348        fprintf(fp, "%s", sb->buf);
 349        if (*color)
 350                fprintf(fp, "%s", GIT_COLOR_RESET);
 351}
 352
 353static int color_vfprintf(FILE *fp, const char *color, const char *fmt,
 354                va_list args, const char *trail)
 355{
 356        int r = 0;
 357
 358        if (*color)
 359                r += fprintf(fp, "%s", color);
 360        r += vfprintf(fp, fmt, args);
 361        if (*color)
 362                r += fprintf(fp, "%s", GIT_COLOR_RESET);
 363        if (trail)
 364                r += fprintf(fp, "%s", trail);
 365        return r;
 366}
 367
 368
 369
 370int color_fprintf(FILE *fp, const char *color, const char *fmt, ...)
 371{
 372        va_list args;
 373        int r;
 374        va_start(args, fmt);
 375        r = color_vfprintf(fp, color, fmt, args, NULL);
 376        va_end(args);
 377        return r;
 378}
 379
 380int color_fprintf_ln(FILE *fp, const char *color, const char *fmt, ...)
 381{
 382        va_list args;
 383        int r;
 384        va_start(args, fmt);
 385        r = color_vfprintf(fp, color, fmt, args, "\n");
 386        va_end(args);
 387        return r;
 388}
 389
 390int color_is_nil(const char *c)
 391{
 392        return !strcmp(c, "NIL");
 393}