Andrew's git / gitweb.git / builtin/for-each-ref.c
?
builtin / for-each-ref.con commit Merge branch 'jn/parse-config-slot' (b946576)
   1#include "builtin.h"
   2#include "cache.h"
   3#include "refs.h"
   4#include "object.h"
   5#include "tag.h"
   6#include "commit.h"
   7#include "tree.h"
   8#include "blob.h"
   9#include "quote.h"
  10#include "parse-options.h"
  11#include "remote.h"
  12#include "color.h"
  13
  14/* Quoting styles */
  15#define QUOTE_NONE 0
  16#define QUOTE_SHELL 1
  17#define QUOTE_PERL 2
  18#define QUOTE_PYTHON 4
  19#define QUOTE_TCL 8
  20
  21typedef enum { FIELD_STR, FIELD_ULONG, FIELD_TIME } cmp_type;
  22
  23struct atom_value {
  24        const char *s;
  25        unsigned long ul; /* used for sorting when not FIELD_STR */
  26};
  27
  28struct ref_sort {
  29        struct ref_sort *next;
  30        int atom; /* index into used_atom array */
  31        unsigned reverse : 1;
  32};
  33
  34struct refinfo {
  35        char *refname;
  36        unsigned char objectname[20];
  37        int flag;
  38        const char *symref;
  39        struct atom_value *value;
  40};
  41
  42static struct {
  43        const char *name;
  44        cmp_type cmp_type;
  45} valid_atom[] = {
  46        { "refname" },
  47        { "objecttype" },
  48        { "objectsize", FIELD_ULONG },
  49        { "objectname" },
  50        { "tree" },
  51        { "parent" },
  52        { "numparent", FIELD_ULONG },
  53        { "object" },
  54        { "type" },
  55        { "tag" },
  56        { "author" },
  57        { "authorname" },
  58        { "authoremail" },
  59        { "authordate", FIELD_TIME },
  60        { "committer" },
  61        { "committername" },
  62        { "committeremail" },
  63        { "committerdate", FIELD_TIME },
  64        { "tagger" },
  65        { "taggername" },
  66        { "taggeremail" },
  67        { "taggerdate", FIELD_TIME },
  68        { "creator" },
  69        { "creatordate", FIELD_TIME },
  70        { "subject" },
  71        { "body" },
  72        { "contents" },
  73        { "contents:subject" },
  74        { "contents:body" },
  75        { "contents:signature" },
  76        { "upstream" },
  77        { "symref" },
  78        { "flag" },
  79        { "HEAD" },
  80        { "color" },
  81};
  82
  83/*
  84 * An atom is a valid field atom listed above, possibly prefixed with
  85 * a "*" to denote deref_tag().
  86 *
  87 * We parse given format string and sort specifiers, and make a list
  88 * of properties that we need to extract out of objects.  refinfo
  89 * structure will hold an array of values extracted that can be
  90 * indexed with the "atom number", which is an index into this
  91 * array.
  92 */
  93static const char **used_atom;
  94static cmp_type *used_atom_type;
  95static int used_atom_cnt, need_tagged, need_symref;
  96static int need_color_reset_at_eol;
  97
  98/*
  99 * Used to parse format string and sort specifiers
 100 */
 101static int parse_atom(const char *atom, const char *ep)
 102{
 103        const char *sp;
 104        int i, at;
 105
 106        sp = atom;
 107        if (*sp == '*' && sp < ep)
 108                sp++; /* deref */
 109        if (ep <= sp)
 110                die("malformed field name: %.*s", (int)(ep-atom), atom);
 111
 112        /* Do we have the atom already used elsewhere? */
 113        for (i = 0; i < used_atom_cnt; i++) {
 114                int len = strlen(used_atom[i]);
 115                if (len == ep - atom && !memcmp(used_atom[i], atom, len))
 116                        return i;
 117        }
 118
 119        /* Is the atom a valid one? */
 120        for (i = 0; i < ARRAY_SIZE(valid_atom); i++) {
 121                int len = strlen(valid_atom[i].name);
 122                /*
 123                 * If the atom name has a colon, strip it and everything after
 124                 * it off - it specifies the format for this entry, and
 125                 * shouldn't be used for checking against the valid_atom
 126                 * table.
 127                 */
 128                const char *formatp = strchr(sp, ':');
 129                if (!formatp || ep < formatp)
 130                        formatp = ep;
 131                if (len == formatp - sp && !memcmp(valid_atom[i].name, sp, len))
 132                        break;
 133        }
 134
 135        if (ARRAY_SIZE(valid_atom) <= i)
 136                die("unknown field name: %.*s", (int)(ep-atom), atom);
 137
 138        /* Add it in, including the deref prefix */
 139        at = used_atom_cnt;
 140        used_atom_cnt++;
 141        REALLOC_ARRAY(used_atom, used_atom_cnt);
 142        REALLOC_ARRAY(used_atom_type, used_atom_cnt);
 143        used_atom[at] = xmemdupz(atom, ep - atom);
 144        used_atom_type[at] = valid_atom[i].cmp_type;
 145        if (*atom == '*')
 146                need_tagged = 1;
 147        if (!strcmp(used_atom[at], "symref"))
 148                need_symref = 1;
 149        return at;
 150}
 151
 152/*
 153 * In a format string, find the next occurrence of %(atom).
 154 */
 155static const char *find_next(const char *cp)
 156{
 157        while (*cp) {
 158                if (*cp == '%') {
 159                        /*
 160                         * %( is the start of an atom;
 161                         * %% is a quoted per-cent.
 162                         */
 163                        if (cp[1] == '(')
 164                                return cp;
 165                        else if (cp[1] == '%')
 166                                cp++; /* skip over two % */
 167                        /* otherwise this is a singleton, literal % */
 168                }
 169                cp++;
 170        }
 171        return NULL;
 172}
 173
 174/*
 175 * Make sure the format string is well formed, and parse out
 176 * the used atoms.
 177 */
 178static int verify_format(const char *format)
 179{
 180        const char *cp, *sp;
 181        static const char color_reset[] = "color:reset";
 182
 183        need_color_reset_at_eol = 0;
 184        for (cp = format; *cp && (sp = find_next(cp)); ) {
 185                const char *ep = strchr(sp, ')');
 186                int at;
 187
 188                if (!ep)
 189                        return error("malformed format string %s", sp);
 190                /* sp points at "%(" and ep points at the closing ")" */
 191                at = parse_atom(sp + 2, ep);
 192                cp = ep + 1;
 193
 194                if (starts_with(used_atom[at], "color:"))
 195                        need_color_reset_at_eol = !!strcmp(used_atom[at], color_reset);
 196        }
 197        return 0;
 198}
 199
 200/*
 201 * Given an object name, read the object data and size, and return a
 202 * "struct object".  If the object data we are returning is also borrowed
 203 * by the "struct object" representation, set *eaten as well---it is a
 204 * signal from parse_object_buffer to us not to free the buffer.
 205 */
 206static void *get_obj(const unsigned char *sha1, struct object **obj, unsigned long *sz, int *eaten)
 207{
 208        enum object_type type;
 209        void *buf = read_sha1_file(sha1, &type, sz);
 210
 211        if (buf)
 212                *obj = parse_object_buffer(sha1, type, *sz, buf, eaten);
 213        else
 214                *obj = NULL;
 215        return buf;
 216}
 217
 218static int grab_objectname(const char *name, const unsigned char *sha1,
 219                            struct atom_value *v)
 220{
 221        if (!strcmp(name, "objectname")) {
 222                char *s = xmalloc(41);
 223                strcpy(s, sha1_to_hex(sha1));
 224                v->s = s;
 225                return 1;
 226        }
 227        if (!strcmp(name, "objectname:short")) {
 228                v->s = xstrdup(find_unique_abbrev(sha1, DEFAULT_ABBREV));
 229                return 1;
 230        }
 231        return 0;
 232}
 233
 234/* See grab_values */
 235static void grab_common_values(struct atom_value *val, int deref, struct object *obj, void *buf, unsigned long sz)
 236{
 237        int i;
 238
 239        for (i = 0; i < used_atom_cnt; i++) {
 240                const char *name = used_atom[i];
 241                struct atom_value *v = &val[i];
 242                if (!!deref != (*name == '*'))
 243                        continue;
 244                if (deref)
 245                        name++;
 246                if (!strcmp(name, "objecttype"))
 247                        v->s = typename(obj->type);
 248                else if (!strcmp(name, "objectsize")) {
 249                        char *s = xmalloc(40);
 250                        sprintf(s, "%lu", sz);
 251                        v->ul = sz;
 252                        v->s = s;
 253                }
 254                else if (deref)
 255                        grab_objectname(name, obj->sha1, v);
 256        }
 257}
 258
 259/* See grab_values */
 260static void grab_tag_values(struct atom_value *val, int deref, struct object *obj, void *buf, unsigned long sz)
 261{
 262        int i;
 263        struct tag *tag = (struct tag *) obj;
 264
 265        for (i = 0; i < used_atom_cnt; i++) {
 266                const char *name = used_atom[i];
 267                struct atom_value *v = &val[i];
 268                if (!!deref != (*name == '*'))
 269                        continue;
 270                if (deref)
 271                        name++;
 272                if (!strcmp(name, "tag"))
 273                        v->s = tag->tag;
 274                else if (!strcmp(name, "type") && tag->tagged)
 275                        v->s = typename(tag->tagged->type);
 276                else if (!strcmp(name, "object") && tag->tagged) {
 277                        char *s = xmalloc(41);
 278                        strcpy(s, sha1_to_hex(tag->tagged->sha1));
 279                        v->s = s;
 280                }
 281        }
 282}
 283
 284/* See grab_values */
 285static void grab_commit_values(struct atom_value *val, int deref, struct object *obj, void *buf, unsigned long sz)
 286{
 287        int i;
 288        struct commit *commit = (struct commit *) obj;
 289
 290        for (i = 0; i < used_atom_cnt; i++) {
 291                const char *name = used_atom[i];
 292                struct atom_value *v = &val[i];
 293                if (!!deref != (*name == '*'))
 294                        continue;
 295                if (deref)
 296                        name++;
 297                if (!strcmp(name, "tree")) {
 298                        char *s = xmalloc(41);
 299                        strcpy(s, sha1_to_hex(commit->tree->object.sha1));
 300                        v->s = s;
 301                }
 302                if (!strcmp(name, "numparent")) {
 303                        char *s = xmalloc(40);
 304                        v->ul = commit_list_count(commit->parents);
 305                        sprintf(s, "%lu", v->ul);
 306                        v->s = s;
 307                }
 308                else if (!strcmp(name, "parent")) {
 309                        int num = commit_list_count(commit->parents);
 310                        int i;
 311                        struct commit_list *parents;
 312                        char *s = xmalloc(41 * num + 1);
 313                        v->s = s;
 314                        for (i = 0, parents = commit->parents;
 315                             parents;
 316                             parents = parents->next, i = i + 41) {
 317                                struct commit *parent = parents->item;
 318                                strcpy(s+i, sha1_to_hex(parent->object.sha1));
 319                                if (parents->next)
 320                                        s[i+40] = ' ';
 321                        }
 322                        if (!i)
 323                                *s = '\0';
 324                }
 325        }
 326}
 327
 328static const char *find_wholine(const char *who, int wholen, const char *buf, unsigned long sz)
 329{
 330        const char *eol;
 331        while (*buf) {
 332                if (!strncmp(buf, who, wholen) &&
 333                    buf[wholen] == ' ')
 334                        return buf + wholen + 1;
 335                eol = strchr(buf, '\n');
 336                if (!eol)
 337                        return "";
 338                eol++;
 339                if (*eol == '\n')
 340                        return ""; /* end of header */
 341                buf = eol;
 342        }
 343        return "";
 344}
 345
 346static const char *copy_line(const char *buf)
 347{
 348        const char *eol = strchrnul(buf, '\n');
 349        return xmemdupz(buf, eol - buf);
 350}
 351
 352static const char *copy_name(const char *buf)
 353{
 354        const char *cp;
 355        for (cp = buf; *cp && *cp != '\n'; cp++) {
 356                if (!strncmp(cp, " <", 2))
 357                        return xmemdupz(buf, cp - buf);
 358        }
 359        return "";
 360}
 361
 362static const char *copy_email(const char *buf)
 363{
 364        const char *email = strchr(buf, '<');
 365        const char *eoemail;
 366        if (!email)
 367                return "";
 368        eoemail = strchr(email, '>');
 369        if (!eoemail)
 370                return "";
 371        return xmemdupz(email, eoemail + 1 - email);
 372}
 373
 374static char *copy_subject(const char *buf, unsigned long len)
 375{
 376        char *r = xmemdupz(buf, len);
 377        int i;
 378
 379        for (i = 0; i < len; i++)
 380                if (r[i] == '\n')
 381                        r[i] = ' ';
 382
 383        return r;
 384}
 385
 386static void grab_date(const char *buf, struct atom_value *v, const char *atomname)
 387{
 388        const char *eoemail = strstr(buf, "> ");
 389        char *zone;
 390        unsigned long timestamp;
 391        long tz;
 392        enum date_mode date_mode = DATE_NORMAL;
 393        const char *formatp;
 394
 395        /*
 396         * We got here because atomname ends in "date" or "date<something>";
 397         * it's not possible that <something> is not ":<format>" because
 398         * parse_atom() wouldn't have allowed it, so we can assume that no
 399         * ":" means no format is specified, and use the default.
 400         */
 401        formatp = strchr(atomname, ':');
 402        if (formatp != NULL) {
 403                formatp++;
 404                date_mode = parse_date_format(formatp);
 405        }
 406
 407        if (!eoemail)
 408                goto bad;
 409        timestamp = strtoul(eoemail + 2, &zone, 10);
 410        if (timestamp == ULONG_MAX)
 411                goto bad;
 412        tz = strtol(zone, NULL, 10);
 413        if ((tz == LONG_MIN || tz == LONG_MAX) && errno == ERANGE)
 414                goto bad;
 415        v->s = xstrdup(show_date(timestamp, tz, date_mode));
 416        v->ul = timestamp;
 417        return;
 418 bad:
 419        v->s = "";
 420        v->ul = 0;
 421}
 422
 423/* See grab_values */
 424static void grab_person(const char *who, struct atom_value *val, int deref, struct object *obj, void *buf, unsigned long sz)
 425{
 426        int i;
 427        int wholen = strlen(who);
 428        const char *wholine = NULL;
 429
 430        for (i = 0; i < used_atom_cnt; i++) {
 431                const char *name = used_atom[i];
 432                struct atom_value *v = &val[i];
 433                if (!!deref != (*name == '*'))
 434                        continue;
 435                if (deref)
 436                        name++;
 437                if (strncmp(who, name, wholen))
 438                        continue;
 439                if (name[wholen] != 0 &&
 440                    strcmp(name + wholen, "name") &&
 441                    strcmp(name + wholen, "email") &&
 442                    !starts_with(name + wholen, "date"))
 443                        continue;
 444                if (!wholine)
 445                        wholine = find_wholine(who, wholen, buf, sz);
 446                if (!wholine)
 447                        return; /* no point looking for it */
 448                if (name[wholen] == 0)
 449                        v->s = copy_line(wholine);
 450                else if (!strcmp(name + wholen, "name"))
 451                        v->s = copy_name(wholine);
 452                else if (!strcmp(name + wholen, "email"))
 453                        v->s = copy_email(wholine);
 454                else if (starts_with(name + wholen, "date"))
 455                        grab_date(wholine, v, name);
 456        }
 457
 458        /*
 459         * For a tag or a commit object, if "creator" or "creatordate" is
 460         * requested, do something special.
 461         */
 462        if (strcmp(who, "tagger") && strcmp(who, "committer"))
 463                return; /* "author" for commit object is not wanted */
 464        if (!wholine)
 465                wholine = find_wholine(who, wholen, buf, sz);
 466        if (!wholine)
 467                return;
 468        for (i = 0; i < used_atom_cnt; i++) {
 469                const char *name = used_atom[i];
 470                struct atom_value *v = &val[i];
 471                if (!!deref != (*name == '*'))
 472                        continue;
 473                if (deref)
 474                        name++;
 475
 476                if (starts_with(name, "creatordate"))
 477                        grab_date(wholine, v, name);
 478                else if (!strcmp(name, "creator"))
 479                        v->s = copy_line(wholine);
 480        }
 481}
 482
 483static void find_subpos(const char *buf, unsigned long sz,
 484                        const char **sub, unsigned long *sublen,
 485                        const char **body, unsigned long *bodylen,
 486                        unsigned long *nonsiglen,
 487                        const char **sig, unsigned long *siglen)
 488{
 489        const char *eol;
 490        /* skip past header until we hit empty line */
 491        while (*buf && *buf != '\n') {
 492                eol = strchrnul(buf, '\n');
 493                if (*eol)
 494                        eol++;
 495                buf = eol;
 496        }
 497        /* skip any empty lines */
 498        while (*buf == '\n')
 499                buf++;
 500
 501        /* parse signature first; we might not even have a subject line */
 502        *sig = buf + parse_signature(buf, strlen(buf));
 503        *siglen = strlen(*sig);
 504
 505        /* subject is first non-empty line */
 506        *sub = buf;
 507        /* subject goes to first empty line */
 508        while (buf < *sig && *buf && *buf != '\n') {
 509                eol = strchrnul(buf, '\n');
 510                if (*eol)
 511                        eol++;
 512                buf = eol;
 513        }
 514        *sublen = buf - *sub;
 515        /* drop trailing newline, if present */
 516        if (*sublen && (*sub)[*sublen - 1] == '\n')
 517                *sublen -= 1;
 518
 519        /* skip any empty lines */
 520        while (*buf == '\n')
 521                buf++;
 522        *body = buf;
 523        *bodylen = strlen(buf);
 524        *nonsiglen = *sig - buf;
 525}
 526
 527/* See grab_values */
 528static void grab_sub_body_contents(struct atom_value *val, int deref, struct object *obj, void *buf, unsigned long sz)
 529{
 530        int i;
 531        const char *subpos = NULL, *bodypos = NULL, *sigpos = NULL;
 532        unsigned long sublen = 0, bodylen = 0, nonsiglen = 0, siglen = 0;
 533
 534        for (i = 0; i < used_atom_cnt; i++) {
 535                const char *name = used_atom[i];
 536                struct atom_value *v = &val[i];
 537                if (!!deref != (*name == '*'))
 538                        continue;
 539                if (deref)
 540                        name++;
 541                if (strcmp(name, "subject") &&
 542                    strcmp(name, "body") &&
 543                    strcmp(name, "contents") &&
 544                    strcmp(name, "contents:subject") &&
 545                    strcmp(name, "contents:body") &&
 546                    strcmp(name, "contents:signature"))
 547                        continue;
 548                if (!subpos)
 549                        find_subpos(buf, sz,
 550                                    &subpos, &sublen,
 551                                    &bodypos, &bodylen, &nonsiglen,
 552                                    &sigpos, &siglen);
 553
 554                if (!strcmp(name, "subject"))
 555                        v->s = copy_subject(subpos, sublen);
 556                else if (!strcmp(name, "contents:subject"))
 557                        v->s = copy_subject(subpos, sublen);
 558                else if (!strcmp(name, "body"))
 559                        v->s = xmemdupz(bodypos, bodylen);
 560                else if (!strcmp(name, "contents:body"))
 561                        v->s = xmemdupz(bodypos, nonsiglen);
 562                else if (!strcmp(name, "contents:signature"))
 563                        v->s = xmemdupz(sigpos, siglen);
 564                else if (!strcmp(name, "contents"))
 565                        v->s = xstrdup(subpos);
 566        }
 567}
 568
 569/*
 570 * We want to have empty print-string for field requests
 571 * that do not apply (e.g. "authordate" for a tag object)
 572 */
 573static void fill_missing_values(struct atom_value *val)
 574{
 575        int i;
 576        for (i = 0; i < used_atom_cnt; i++) {
 577                struct atom_value *v = &val[i];
 578                if (v->s == NULL)
 579                        v->s = "";
 580        }
 581}
 582
 583/*
 584 * val is a list of atom_value to hold returned values.  Extract
 585 * the values for atoms in used_atom array out of (obj, buf, sz).
 586 * when deref is false, (obj, buf, sz) is the object that is
 587 * pointed at by the ref itself; otherwise it is the object the
 588 * ref (which is a tag) refers to.
 589 */
 590static void grab_values(struct atom_value *val, int deref, struct object *obj, void *buf, unsigned long sz)
 591{
 592        grab_common_values(val, deref, obj, buf, sz);
 593        switch (obj->type) {
 594        case OBJ_TAG:
 595                grab_tag_values(val, deref, obj, buf, sz);
 596                grab_sub_body_contents(val, deref, obj, buf, sz);
 597                grab_person("tagger", val, deref, obj, buf, sz);
 598                break;
 599        case OBJ_COMMIT:
 600                grab_commit_values(val, deref, obj, buf, sz);
 601                grab_sub_body_contents(val, deref, obj, buf, sz);
 602                grab_person("author", val, deref, obj, buf, sz);
 603                grab_person("committer", val, deref, obj, buf, sz);
 604                break;
 605        case OBJ_TREE:
 606                /* grab_tree_values(val, deref, obj, buf, sz); */
 607                break;
 608        case OBJ_BLOB:
 609                /* grab_blob_values(val, deref, obj, buf, sz); */
 610                break;
 611        default:
 612                die("Eh?  Object of type %d?", obj->type);
 613        }
 614}
 615
 616static inline char *copy_advance(char *dst, const char *src)
 617{
 618        while (*src)
 619                *dst++ = *src++;
 620        return dst;
 621}
 622
 623/*
 624 * Parse the object referred by ref, and grab needed value.
 625 */
 626static void populate_value(struct refinfo *ref)
 627{
 628        void *buf;
 629        struct object *obj;
 630        int eaten, i;
 631        unsigned long size;
 632        const unsigned char *tagged;
 633
 634        ref->value = xcalloc(used_atom_cnt, sizeof(struct atom_value));
 635
 636        if (need_symref && (ref->flag & REF_ISSYMREF) && !ref->symref) {
 637                unsigned char unused1[20];
 638                ref->symref = resolve_refdup(ref->refname, unused1, 1, NULL);
 639                if (!ref->symref)
 640                        ref->symref = "";
 641        }
 642
 643        /* Fill in specials first */
 644        for (i = 0; i < used_atom_cnt; i++) {
 645                const char *name = used_atom[i];
 646                struct atom_value *v = &ref->value[i];
 647                int deref = 0;
 648                const char *refname;
 649                const char *formatp;
 650                struct branch *branch = NULL;
 651
 652                if (*name == '*') {
 653                        deref = 1;
 654                        name++;
 655                }
 656
 657                if (starts_with(name, "refname"))
 658                        refname = ref->refname;
 659                else if (starts_with(name, "symref"))
 660                        refname = ref->symref ? ref->symref : "";
 661                else if (starts_with(name, "upstream")) {
 662                        /* only local branches may have an upstream */
 663                        if (!starts_with(ref->refname, "refs/heads/"))
 664                                continue;
 665                        branch = branch_get(ref->refname + 11);
 666
 667                        if (!branch || !branch->merge || !branch->merge[0] ||
 668                            !branch->merge[0]->dst)
 669                                continue;
 670                        refname = branch->merge[0]->dst;
 671                } else if (starts_with(name, "color:")) {
 672                        char color[COLOR_MAXLEN] = "";
 673
 674                        if (color_parse(name + 6, color) < 0)
 675                                die(_("unable to parse format"));
 676                        v->s = xstrdup(color);
 677                        continue;
 678                } else if (!strcmp(name, "flag")) {
 679                        char buf[256], *cp = buf;
 680                        if (ref->flag & REF_ISSYMREF)
 681                                cp = copy_advance(cp, ",symref");
 682                        if (ref->flag & REF_ISPACKED)
 683                                cp = copy_advance(cp, ",packed");
 684                        if (cp == buf)
 685                                v->s = "";
 686                        else {
 687                                *cp = '\0';
 688                                v->s = xstrdup(buf + 1);
 689                        }
 690                        continue;
 691                } else if (!deref && grab_objectname(name, ref->objectname, v)) {
 692                        continue;
 693                } else if (!strcmp(name, "HEAD")) {
 694                        const char *head;
 695                        unsigned char sha1[20];
 696
 697                        head = resolve_ref_unsafe("HEAD", sha1, 1, NULL);
 698                        if (!strcmp(ref->refname, head))
 699                                v->s = "*";
 700                        else
 701                                v->s = " ";
 702                        continue;
 703                } else
 704                        continue;
 705
 706                formatp = strchr(name, ':');
 707                if (formatp) {
 708                        int num_ours, num_theirs;
 709
 710                        formatp++;
 711                        if (!strcmp(formatp, "short"))
 712                                refname = shorten_unambiguous_ref(refname,
 713                                                      warn_ambiguous_refs);
 714                        else if (!strcmp(formatp, "track") &&
 715                                 starts_with(name, "upstream")) {
 716                                char buf[40];
 717
 718                                stat_tracking_info(branch, &num_ours, &num_theirs);
 719                                if (!num_ours && !num_theirs)
 720                                        v->s = "";
 721                                else if (!num_ours) {
 722                                        sprintf(buf, "[behind %d]", num_theirs);
 723                                        v->s = xstrdup(buf);
 724                                } else if (!num_theirs) {
 725                                        sprintf(buf, "[ahead %d]", num_ours);
 726                                        v->s = xstrdup(buf);
 727                                } else {
 728                                        sprintf(buf, "[ahead %d, behind %d]",
 729                                                num_ours, num_theirs);
 730                                        v->s = xstrdup(buf);
 731                                }
 732                                continue;
 733                        } else if (!strcmp(formatp, "trackshort") &&
 734                                   starts_with(name, "upstream")) {
 735                                assert(branch);
 736                                stat_tracking_info(branch, &num_ours, &num_theirs);
 737                                if (!num_ours && !num_theirs)
 738                                        v->s = "=";
 739                                else if (!num_ours)
 740                                        v->s = "<";
 741                                else if (!num_theirs)
 742                                        v->s = ">";
 743                                else
 744                                        v->s = "<>";
 745                                continue;
 746                        } else
 747                                die("unknown %.*s format %s",
 748                                    (int)(formatp - name), name, formatp);
 749                }
 750
 751                if (!deref)
 752                        v->s = refname;
 753                else {
 754                        int len = strlen(refname);
 755                        char *s = xmalloc(len + 4);
 756                        sprintf(s, "%s^{}", refname);
 757                        v->s = s;
 758                }
 759        }
 760
 761        for (i = 0; i < used_atom_cnt; i++) {
 762                struct atom_value *v = &ref->value[i];
 763                if (v->s == NULL)
 764                        goto need_obj;
 765        }
 766        return;
 767
 768 need_obj:
 769        buf = get_obj(ref->objectname, &obj, &size, &eaten);
 770        if (!buf)
 771                die("missing object %s for %s",
 772                    sha1_to_hex(ref->objectname), ref->refname);
 773        if (!obj)
 774                die("parse_object_buffer failed on %s for %s",
 775                    sha1_to_hex(ref->objectname), ref->refname);
 776
 777        grab_values(ref->value, 0, obj, buf, size);
 778        if (!eaten)
 779                free(buf);
 780
 781        /*
 782         * If there is no atom that wants to know about tagged
 783         * object, we are done.
 784         */
 785        if (!need_tagged || (obj->type != OBJ_TAG))
 786                return;
 787
 788        /*
 789         * If it is a tag object, see if we use a value that derefs
 790         * the object, and if we do grab the object it refers to.
 791         */
 792        tagged = ((struct tag *)obj)->tagged->sha1;
 793
 794        /*
 795         * NEEDSWORK: This derefs tag only once, which
 796         * is good to deal with chains of trust, but
 797         * is not consistent with what deref_tag() does
 798         * which peels the onion to the core.
 799         */
 800        buf = get_obj(tagged, &obj, &size, &eaten);
 801        if (!buf)
 802                die("missing object %s for %s",
 803                    sha1_to_hex(tagged), ref->refname);
 804        if (!obj)
 805                die("parse_object_buffer failed on %s for %s",
 806                    sha1_to_hex(tagged), ref->refname);
 807        grab_values(ref->value, 1, obj, buf, size);
 808        if (!eaten)
 809                free(buf);
 810}
 811
 812/*
 813 * Given a ref, return the value for the atom.  This lazily gets value
 814 * out of the object by calling populate value.
 815 */
 816static void get_value(struct refinfo *ref, int atom, struct atom_value **v)
 817{
 818        if (!ref->value) {
 819                populate_value(ref);
 820                fill_missing_values(ref->value);
 821        }
 822        *v = &ref->value[atom];
 823}
 824
 825struct grab_ref_cbdata {
 826        struct refinfo **grab_array;
 827        const char **grab_pattern;
 828        int grab_cnt;
 829};
 830
 831/*
 832 * A call-back given to for_each_ref().  Filter refs and keep them for
 833 * later object processing.
 834 */
 835static int grab_single_ref(const char *refname, const unsigned char *sha1, int flag, void *cb_data)
 836{
 837        struct grab_ref_cbdata *cb = cb_data;
 838        struct refinfo *ref;
 839        int cnt;
 840
 841        if (*cb->grab_pattern) {
 842                const char **pattern;
 843                int namelen = strlen(refname);
 844                for (pattern = cb->grab_pattern; *pattern; pattern++) {
 845                        const char *p = *pattern;
 846                        int plen = strlen(p);
 847
 848                        if ((plen <= namelen) &&
 849                            !strncmp(refname, p, plen) &&
 850                            (refname[plen] == '\0' ||
 851                             refname[plen] == '/' ||
 852                             p[plen-1] == '/'))
 853                                break;
 854                        if (!wildmatch(p, refname, WM_PATHNAME, NULL))
 855                                break;
 856                }
 857                if (!*pattern)
 858                        return 0;
 859        }
 860
 861        /*
 862         * We do not open the object yet; sort may only need refname
 863         * to do its job and the resulting list may yet to be pruned
 864         * by maxcount logic.
 865         */
 866        ref = xcalloc(1, sizeof(*ref));
 867        ref->refname = xstrdup(refname);
 868        hashcpy(ref->objectname, sha1);
 869        ref->flag = flag;
 870
 871        cnt = cb->grab_cnt;
 872        REALLOC_ARRAY(cb->grab_array, cnt + 1);
 873        cb->grab_array[cnt++] = ref;
 874        cb->grab_cnt = cnt;
 875        return 0;
 876}
 877
 878static int cmp_ref_sort(struct ref_sort *s, struct refinfo *a, struct refinfo *b)
 879{
 880        struct atom_value *va, *vb;
 881        int cmp;
 882        cmp_type cmp_type = used_atom_type[s->atom];
 883
 884        get_value(a, s->atom, &va);
 885        get_value(b, s->atom, &vb);
 886        switch (cmp_type) {
 887        case FIELD_STR:
 888                cmp = strcmp(va->s, vb->s);
 889                break;
 890        default:
 891                if (va->ul < vb->ul)
 892                        cmp = -1;
 893                else if (va->ul == vb->ul)
 894                        cmp = 0;
 895                else
 896                        cmp = 1;
 897                break;
 898        }
 899        return (s->reverse) ? -cmp : cmp;
 900}
 901
 902static struct ref_sort *ref_sort;
 903static int compare_refs(const void *a_, const void *b_)
 904{
 905        struct refinfo *a = *((struct refinfo **)a_);
 906        struct refinfo *b = *((struct refinfo **)b_);
 907        struct ref_sort *s;
 908
 909        for (s = ref_sort; s; s = s->next) {
 910                int cmp = cmp_ref_sort(s, a, b);
 911                if (cmp)
 912                        return cmp;
 913        }
 914        return 0;
 915}
 916
 917static void sort_refs(struct ref_sort *sort, struct refinfo **refs, int num_refs)
 918{
 919        ref_sort = sort;
 920        qsort(refs, num_refs, sizeof(struct refinfo *), compare_refs);
 921}
 922
 923static void print_value(struct atom_value *v, int quote_style)
 924{
 925        struct strbuf sb = STRBUF_INIT;
 926        switch (quote_style) {
 927        case QUOTE_NONE:
 928                fputs(v->s, stdout);
 929                break;
 930        case QUOTE_SHELL:
 931                sq_quote_buf(&sb, v->s);
 932                break;
 933        case QUOTE_PERL:
 934                perl_quote_buf(&sb, v->s);
 935                break;
 936        case QUOTE_PYTHON:
 937                python_quote_buf(&sb, v->s);
 938                break;
 939        case QUOTE_TCL:
 940                tcl_quote_buf(&sb, v->s);
 941                break;
 942        }
 943        if (quote_style != QUOTE_NONE) {
 944                fputs(sb.buf, stdout);
 945                strbuf_release(&sb);
 946        }
 947}
 948
 949static int hex1(char ch)
 950{
 951        if ('0' <= ch && ch <= '9')
 952                return ch - '0';
 953        else if ('a' <= ch && ch <= 'f')
 954                return ch - 'a' + 10;
 955        else if ('A' <= ch && ch <= 'F')
 956                return ch - 'A' + 10;
 957        return -1;
 958}
 959static int hex2(const char *cp)
 960{
 961        if (cp[0] && cp[1])
 962                return (hex1(cp[0]) << 4) | hex1(cp[1]);
 963        else
 964                return -1;
 965}
 966
 967static void emit(const char *cp, const char *ep)
 968{
 969        while (*cp && (!ep || cp < ep)) {
 970                if (*cp == '%') {
 971                        if (cp[1] == '%')
 972                                cp++;
 973                        else {
 974                                int ch = hex2(cp + 1);
 975                                if (0 <= ch) {
 976                                        putchar(ch);
 977                                        cp += 3;
 978                                        continue;
 979                                }
 980                        }
 981                }
 982                putchar(*cp);
 983                cp++;
 984        }
 985}
 986
 987static void show_ref(struct refinfo *info, const char *format, int quote_style)
 988{
 989        const char *cp, *sp, *ep;
 990
 991        for (cp = format; *cp && (sp = find_next(cp)); cp = ep + 1) {
 992                struct atom_value *atomv;
 993
 994                ep = strchr(sp, ')');
 995                if (cp < sp)
 996                        emit(cp, sp);
 997                get_value(info, parse_atom(sp + 2, ep), &atomv);
 998                print_value(atomv, quote_style);
 999        }
1000        if (*cp) {
1001                sp = cp + strlen(cp);
1002                emit(cp, sp);
1003        }
1004        if (need_color_reset_at_eol) {
1005                struct atom_value resetv;
1006                char color[COLOR_MAXLEN] = "";
1007
1008                if (color_parse("reset", color) < 0)
1009                        die("BUG: couldn't parse 'reset' as a color");
1010                resetv.s = color;
1011                print_value(&resetv, quote_style);
1012        }
1013        putchar('\n');
1014}
1015
1016static struct ref_sort *default_sort(void)
1017{
1018        static const char cstr_name[] = "refname";
1019
1020        struct ref_sort *sort = xcalloc(1, sizeof(*sort));
1021
1022        sort->next = NULL;
1023        sort->atom = parse_atom(cstr_name, cstr_name + strlen(cstr_name));
1024        return sort;
1025}
1026
1027static int opt_parse_sort(const struct option *opt, const char *arg, int unset)
1028{
1029        struct ref_sort **sort_tail = opt->value;
1030        struct ref_sort *s;
1031        int len;
1032
1033        if (!arg) /* should --no-sort void the list ? */
1034                return -1;
1035
1036        s = xcalloc(1, sizeof(*s));
1037        s->next = *sort_tail;
1038        *sort_tail = s;
1039
1040        if (*arg == '-') {
1041                s->reverse = 1;
1042                arg++;
1043        }
1044        len = strlen(arg);
1045        s->atom = parse_atom(arg, arg+len);
1046        return 0;
1047}
1048
1049static char const * const for_each_ref_usage[] = {
1050        N_("git for-each-ref [options] [<pattern>]"),
1051        NULL
1052};
1053
1054int cmd_for_each_ref(int argc, const char **argv, const char *prefix)
1055{
1056        int i, num_refs;
1057        const char *format = "%(objectname) %(objecttype)\t%(refname)";
1058        struct ref_sort *sort = NULL, **sort_tail = &sort;
1059        int maxcount = 0, quote_style = 0;
1060        struct refinfo **refs;
1061        struct grab_ref_cbdata cbdata;
1062
1063        struct option opts[] = {
1064                OPT_BIT('s', "shell", &quote_style,
1065                        N_("quote placeholders suitably for shells"), QUOTE_SHELL),
1066                OPT_BIT('p', "perl",  &quote_style,
1067                        N_("quote placeholders suitably for perl"), QUOTE_PERL),
1068                OPT_BIT(0 , "python", &quote_style,
1069                        N_("quote placeholders suitably for python"), QUOTE_PYTHON),
1070                OPT_BIT(0 , "tcl",  &quote_style,
1071                        N_("quote placeholders suitably for tcl"), QUOTE_TCL),
1072
1073                OPT_GROUP(""),
1074                OPT_INTEGER( 0 , "count", &maxcount, N_("show only <n> matched refs")),
1075                OPT_STRING(  0 , "format", &format, N_("format"), N_("format to use for the output")),
1076                OPT_CALLBACK(0 , "sort", sort_tail, N_("key"),
1077                            N_("field name to sort on"), &opt_parse_sort),
1078                OPT_END(),
1079        };
1080
1081        parse_options(argc, argv, prefix, opts, for_each_ref_usage, 0);
1082        if (maxcount < 0) {
1083                error("invalid --count argument: `%d'", maxcount);
1084                usage_with_options(for_each_ref_usage, opts);
1085        }
1086        if (HAS_MULTI_BITS(quote_style)) {
1087                error("more than one quoting style?");
1088                usage_with_options(for_each_ref_usage, opts);
1089        }
1090        if (verify_format(format))
1091                usage_with_options(for_each_ref_usage, opts);
1092
1093        if (!sort)
1094                sort = default_sort();
1095
1096        /* for warn_ambiguous_refs */
1097        git_config(git_default_config, NULL);
1098
1099        memset(&cbdata, 0, sizeof(cbdata));
1100        cbdata.grab_pattern = argv;
1101        for_each_rawref(grab_single_ref, &cbdata);
1102        refs = cbdata.grab_array;
1103        num_refs = cbdata.grab_cnt;
1104
1105        sort_refs(sort, refs, num_refs);
1106
1107        if (!maxcount || num_refs < maxcount)
1108                maxcount = num_refs;
1109        for (i = 0; i < maxcount; i++)
1110                show_ref(refs[i], format, quote_style);
1111        return 0;
1112}