a22d83584211c0c5d2f57b5ffe48b896eabbf904
   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("ul",        4, 24),
 137                ATTR("blink",     5, 25),
 138                ATTR("reverse",   7, 27)
 139#undef ATTR
 140        };
 141        int negate = 0;
 142        int i;
 143
 144        if (skip_prefix_mem(name, len, "no", &name, &len)) {
 145                skip_prefix_mem(name, len, "-", &name, &len);
 146                negate = 1;
 147        }
 148
 149        for (i = 0; i < ARRAY_SIZE(attrs); i++) {
 150                if (attrs[i].len == len && !memcmp(attrs[i].name, name, len))
 151                        return negate ? attrs[i].neg : attrs[i].val;
 152        }
 153        return -1;
 154}
 155
 156int color_parse(const char *value, char *dst)
 157{
 158        return color_parse_mem(value, strlen(value), dst);
 159}
 160
 161/*
 162 * Write the ANSI color codes for "c" to "out"; the string should
 163 * already have the ANSI escape code in it. "out" should have enough
 164 * space in it to fit any color.
 165 */
 166static char *color_output(char *out, const struct color *c, char type)
 167{
 168        switch (c->type) {
 169        case COLOR_UNSPECIFIED:
 170        case COLOR_NORMAL:
 171                break;
 172        case COLOR_ANSI:
 173                *out++ = type;
 174                *out++ = '0' + c->value;
 175                break;
 176        case COLOR_256:
 177                out += sprintf(out, "%c8;5;%d", type, c->value);
 178                break;
 179        case COLOR_RGB:
 180                out += sprintf(out, "%c8;2;%d;%d;%d", type,
 181                               c->red, c->green, c->blue);
 182                break;
 183        }
 184        return out;
 185}
 186
 187static int color_empty(const struct color *c)
 188{
 189        return c->type <= COLOR_NORMAL;
 190}
 191
 192int color_parse_mem(const char *value, int value_len, char *dst)
 193{
 194        const char *ptr = value;
 195        int len = value_len;
 196        unsigned int attr = 0;
 197        struct color fg = { COLOR_UNSPECIFIED };
 198        struct color bg = { COLOR_UNSPECIFIED };
 199
 200        if (!strncasecmp(value, "reset", len)) {
 201                strcpy(dst, GIT_COLOR_RESET);
 202                return 0;
 203        }
 204
 205        /* [fg [bg]] [attr]... */
 206        while (len > 0) {
 207                const char *word = ptr;
 208                struct color c;
 209                int val, wordlen = 0;
 210
 211                while (len > 0 && !isspace(word[wordlen])) {
 212                        wordlen++;
 213                        len--;
 214                }
 215
 216                ptr = word + wordlen;
 217                while (len > 0 && isspace(*ptr)) {
 218                        ptr++;
 219                        len--;
 220                }
 221
 222                if (!parse_color(&c, word, wordlen)) {
 223                        if (fg.type == COLOR_UNSPECIFIED) {
 224                                fg = c;
 225                                continue;
 226                        }
 227                        if (bg.type == COLOR_UNSPECIFIED) {
 228                                bg = c;
 229                                continue;
 230                        }
 231                        goto bad;
 232                }
 233                val = parse_attr(word, wordlen);
 234                if (0 <= val)
 235                        attr |= (1 << val);
 236                else
 237                        goto bad;
 238        }
 239
 240        if (attr || !color_empty(&fg) || !color_empty(&bg)) {
 241                int sep = 0;
 242                int i;
 243
 244                *dst++ = '\033';
 245                *dst++ = '[';
 246
 247                for (i = 0; attr; i++) {
 248                        unsigned bit = (1 << i);
 249                        if (!(attr & bit))
 250                                continue;
 251                        attr &= ~bit;
 252                        if (sep++)
 253                                *dst++ = ';';
 254                        dst += sprintf(dst, "%d", i);
 255                }
 256                if (!color_empty(&fg)) {
 257                        if (sep++)
 258                                *dst++ = ';';
 259                        /* foreground colors are all in the 3x range */
 260                        dst = color_output(dst, &fg, '3');
 261                }
 262                if (!color_empty(&bg)) {
 263                        if (sep++)
 264                                *dst++ = ';';
 265                        /* background colors are all in the 4x range */
 266                        dst = color_output(dst, &bg, '4');
 267                }
 268                *dst++ = 'm';
 269        }
 270        *dst = 0;
 271        return 0;
 272bad:
 273        return error(_("invalid color value: %.*s"), value_len, value);
 274}
 275
 276int git_config_colorbool(const char *var, const char *value)
 277{
 278        if (value) {
 279                if (!strcasecmp(value, "never"))
 280                        return 0;
 281                if (!strcasecmp(value, "always"))
 282                        return 1;
 283                if (!strcasecmp(value, "auto"))
 284                        return GIT_COLOR_AUTO;
 285        }
 286
 287        if (!var)
 288                return -1;
 289
 290        /* Missing or explicit false to turn off colorization */
 291        if (!git_config_bool(var, value))
 292                return 0;
 293
 294        /* any normal truth value defaults to 'auto' */
 295        return GIT_COLOR_AUTO;
 296}
 297
 298static int check_auto_color(void)
 299{
 300        if (color_stdout_is_tty < 0)
 301                color_stdout_is_tty = isatty(1);
 302        if (color_stdout_is_tty || (pager_in_use() && pager_use_color)) {
 303                char *term = getenv("TERM");
 304                if (term && strcmp(term, "dumb"))
 305                        return 1;
 306        }
 307        return 0;
 308}
 309
 310int want_color(int var)
 311{
 312        static int want_auto = -1;
 313
 314        if (var < 0)
 315                var = git_use_color_default;
 316
 317        if (var == GIT_COLOR_AUTO) {
 318                if (want_auto < 0)
 319                        want_auto = check_auto_color();
 320                return want_auto;
 321        }
 322        return var;
 323}
 324
 325int git_color_config(const char *var, const char *value, void *cb)
 326{
 327        if (!strcmp(var, "color.ui")) {
 328                git_use_color_default = git_config_colorbool(var, value);
 329                return 0;
 330        }
 331
 332        return 0;
 333}
 334
 335int git_color_default_config(const char *var, const char *value, void *cb)
 336{
 337        if (git_color_config(var, value, cb) < 0)
 338                return -1;
 339
 340        return git_default_config(var, value, cb);
 341}
 342
 343void color_print_strbuf(FILE *fp, const char *color, const struct strbuf *sb)
 344{
 345        if (*color)
 346                fprintf(fp, "%s", color);
 347        fprintf(fp, "%s", sb->buf);
 348        if (*color)
 349                fprintf(fp, "%s", GIT_COLOR_RESET);
 350}
 351
 352static int color_vfprintf(FILE *fp, const char *color, const char *fmt,
 353                va_list args, const char *trail)
 354{
 355        int r = 0;
 356
 357        if (*color)
 358                r += fprintf(fp, "%s", color);
 359        r += vfprintf(fp, fmt, args);
 360        if (*color)
 361                r += fprintf(fp, "%s", GIT_COLOR_RESET);
 362        if (trail)
 363                r += fprintf(fp, "%s", trail);
 364        return r;
 365}
 366
 367
 368
 369int color_fprintf(FILE *fp, const char *color, const char *fmt, ...)
 370{
 371        va_list args;
 372        int r;
 373        va_start(args, fmt);
 374        r = color_vfprintf(fp, color, fmt, args, NULL);
 375        va_end(args);
 376        return r;
 377}
 378
 379int color_fprintf_ln(FILE *fp, const char *color, const char *fmt, ...)
 380{
 381        va_list args;
 382        int r;
 383        va_start(args, fmt);
 384        r = color_vfprintf(fp, color, fmt, args, "\n");
 385        va_end(args);
 386        return r;
 387}
 388
 389int color_is_nil(const char *c)
 390{
 391        return !strcmp(c, "NIL");
 392}