Andrew's git - gitweb.git/blob

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