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