builtin-for-each-ref.con commit help: check early if we have a command, if not try a documentation topic (2dce956)
   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
  12/* Quoting styles */
  13#define QUOTE_NONE 0
  14#define QUOTE_SHELL 1
  15#define QUOTE_PERL 2
  16#define QUOTE_PYTHON 4
  17#define QUOTE_TCL 8
  18
  19typedef enum { FIELD_STR, FIELD_ULONG, FIELD_TIME } cmp_type;
  20
  21struct atom_value {
  22        const char *s;
  23        unsigned long ul; /* used for sorting when not FIELD_STR */
  24};
  25
  26struct ref_sort {
  27        struct ref_sort *next;
  28        int atom; /* index into used_atom array */
  29        unsigned reverse : 1;
  30};
  31
  32struct refinfo {
  33        char *refname;
  34        unsigned char objectname[20];
  35        struct atom_value *value;
  36};
  37
  38static struct {
  39        const char *name;
  40        cmp_type cmp_type;
  41} valid_atom[] = {
  42        { "refname" },
  43        { "objecttype" },
  44        { "objectsize", FIELD_ULONG },
  45        { "objectname" },
  46        { "tree" },
  47        { "parent" },
  48        { "numparent", FIELD_ULONG },
  49        { "object" },
  50        { "type" },
  51        { "tag" },
  52        { "author" },
  53        { "authorname" },
  54        { "authoremail" },
  55        { "authordate", FIELD_TIME },
  56        { "committer" },
  57        { "committername" },
  58        { "committeremail" },
  59        { "committerdate", FIELD_TIME },
  60        { "tagger" },
  61        { "taggername" },
  62        { "taggeremail" },
  63        { "taggerdate", FIELD_TIME },
  64        { "creator" },
  65        { "creatordate", FIELD_TIME },
  66        { "subject" },
  67        { "body" },
  68        { "contents" },
  69};
  70
  71/*
  72 * An atom is a valid field atom listed above, possibly prefixed with
  73 * a "*" to denote deref_tag().
  74 *
  75 * We parse given format string and sort specifiers, and make a list
  76 * of properties that we need to extract out of objects.  refinfo
  77 * structure will hold an array of values extracted that can be
  78 * indexed with the "atom number", which is an index into this
  79 * array.
  80 */
  81static const char **used_atom;
  82static cmp_type *used_atom_type;
  83static int used_atom_cnt, sort_atom_limit, need_tagged;
  84
  85/*
  86 * Used to parse format string and sort specifiers
  87 */
  88static int parse_atom(const char *atom, const char *ep)
  89{
  90        const char *sp;
  91        int i, at;
  92
  93        sp = atom;
  94        if (*sp == '*' && sp < ep)
  95                sp++; /* deref */
  96        if (ep <= sp)
  97                die("malformed field name: %.*s", (int)(ep-atom), atom);
  98
  99        /* Do we have the atom already used elsewhere? */
 100        for (i = 0; i < used_atom_cnt; i++) {
 101                int len = strlen(used_atom[i]);
 102                if (len == ep - atom && !memcmp(used_atom[i], atom, len))
 103                        return i;
 104        }
 105
 106        /* Is the atom a valid one? */
 107        for (i = 0; i < ARRAY_SIZE(valid_atom); i++) {
 108                int len = strlen(valid_atom[i].name);
 109                /*
 110                 * If the atom name has a colon, strip it and everything after
 111                 * it off - it specifies the format for this entry, and
 112                 * shouldn't be used for checking against the valid_atom
 113                 * table.
 114                 */
 115                const char *formatp = strchr(sp, ':');
 116                if (!formatp || ep < formatp)
 117                        formatp = ep;
 118                if (len == formatp - sp && !memcmp(valid_atom[i].name, sp, len))
 119                        break;
 120        }
 121
 122        if (ARRAY_SIZE(valid_atom) <= i)
 123                die("unknown field name: %.*s", (int)(ep-atom), atom);
 124
 125        /* Add it in, including the deref prefix */
 126        at = used_atom_cnt;
 127        used_atom_cnt++;
 128        used_atom = xrealloc(used_atom,
 129                             (sizeof *used_atom) * used_atom_cnt);
 130        used_atom_type = xrealloc(used_atom_type,
 131                                  (sizeof(*used_atom_type) * used_atom_cnt));
 132        used_atom[at] = xmemdupz(atom, ep - atom);
 133        used_atom_type[at] = valid_atom[i].cmp_type;
 134        return at;
 135}
 136
 137/*
 138 * In a format string, find the next occurrence of %(atom).
 139 */
 140static const char *find_next(const char *cp)
 141{
 142        while (*cp) {
 143                if (*cp == '%') {
 144                        /* %( is the start of an atom;
 145                         * %% is a quoted per-cent.
 146                         */
 147                        if (cp[1] == '(')
 148                                return cp;
 149                        else if (cp[1] == '%')
 150                                cp++; /* skip over two % */
 151                        /* otherwise this is a singleton, literal % */
 152                }
 153                cp++;
 154        }
 155        return NULL;
 156}
 157
 158/*
 159 * Make sure the format string is well formed, and parse out
 160 * the used atoms.
 161 */
 162static int verify_format(const char *format)
 163{
 164        const char *cp, *sp;
 165        for (cp = format; *cp && (sp = find_next(cp)); ) {
 166                const char *ep = strchr(sp, ')');
 167                if (!ep)
 168                        return error("malformed format string %s", sp);
 169                /* sp points at "%(" and ep points at the closing ")" */
 170                parse_atom(sp + 2, ep);
 171                cp = ep + 1;
 172        }
 173        return 0;
 174}
 175
 176/*
 177 * Given an object name, read the object data and size, and return a
 178 * "struct object".  If the object data we are returning is also borrowed
 179 * by the "struct object" representation, set *eaten as well---it is a
 180 * signal from parse_object_buffer to us not to free the buffer.
 181 */
 182static void *get_obj(const unsigned char *sha1, struct object **obj, unsigned long *sz, int *eaten)
 183{
 184        enum object_type type;
 185        void *buf = read_sha1_file(sha1, &type, sz);
 186
 187        if (buf)
 188                *obj = parse_object_buffer(sha1, type, *sz, buf, eaten);
 189        else
 190                *obj = NULL;
 191        return buf;
 192}
 193
 194/* See grab_values */
 195static void grab_common_values(struct atom_value *val, int deref, struct object *obj, void *buf, unsigned long sz)
 196{
 197        int i;
 198
 199        for (i = 0; i < used_atom_cnt; i++) {
 200                const char *name = used_atom[i];
 201                struct atom_value *v = &val[i];
 202                if (!!deref != (*name == '*'))
 203                        continue;
 204                if (deref)
 205                        name++;
 206                if (!strcmp(name, "objecttype"))
 207                        v->s = typename(obj->type);
 208                else if (!strcmp(name, "objectsize")) {
 209                        char *s = xmalloc(40);
 210                        sprintf(s, "%lu", sz);
 211                        v->ul = sz;
 212                        v->s = s;
 213                }
 214                else if (!strcmp(name, "objectname")) {
 215                        char *s = xmalloc(41);
 216                        strcpy(s, sha1_to_hex(obj->sha1));
 217                        v->s = s;
 218                }
 219        }
 220}
 221
 222/* See grab_values */
 223static void grab_tag_values(struct atom_value *val, int deref, struct object *obj, void *buf, unsigned long sz)
 224{
 225        int i;
 226        struct tag *tag = (struct tag *) obj;
 227
 228        for (i = 0; i < used_atom_cnt; i++) {
 229                const char *name = used_atom[i];
 230                struct atom_value *v = &val[i];
 231                if (!!deref != (*name == '*'))
 232                        continue;
 233                if (deref)
 234                        name++;
 235                if (!strcmp(name, "tag"))
 236                        v->s = tag->tag;
 237                else if (!strcmp(name, "type") && tag->tagged)
 238                        v->s = typename(tag->tagged->type);
 239                else if (!strcmp(name, "object") && tag->tagged) {
 240                        char *s = xmalloc(41);
 241                        strcpy(s, sha1_to_hex(tag->tagged->sha1));
 242                        v->s = s;
 243                }
 244        }
 245}
 246
 247static int num_parents(struct commit *commit)
 248{
 249        struct commit_list *parents;
 250        int i;
 251
 252        for (i = 0, parents = commit->parents;
 253             parents;
 254             parents = parents->next)
 255                i++;
 256        return i;
 257}
 258
 259/* See grab_values */
 260static void grab_commit_values(struct atom_value *val, int deref, struct object *obj, void *buf, unsigned long sz)
 261{
 262        int i;
 263        struct commit *commit = (struct commit *) 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, "tree")) {
 273                        char *s = xmalloc(41);
 274                        strcpy(s, sha1_to_hex(commit->tree->object.sha1));
 275                        v->s = s;
 276                }
 277                if (!strcmp(name, "numparent")) {
 278                        char *s = xmalloc(40);
 279                        v->ul = num_parents(commit);
 280                        sprintf(s, "%lu", v->ul);
 281                        v->s = s;
 282                }
 283                else if (!strcmp(name, "parent")) {
 284                        int num = num_parents(commit);
 285                        int i;
 286                        struct commit_list *parents;
 287                        char *s = xmalloc(41 * num + 1);
 288                        v->s = s;
 289                        for (i = 0, parents = commit->parents;
 290                             parents;
 291                             parents = parents->next, i = i + 41) {
 292                                struct commit *parent = parents->item;
 293                                strcpy(s+i, sha1_to_hex(parent->object.sha1));
 294                                if (parents->next)
 295                                        s[i+40] = ' ';
 296                        }
 297                        if (!i)
 298                                *s = '\0';
 299                }
 300        }
 301}
 302
 303static const char *find_wholine(const char *who, int wholen, const char *buf, unsigned long sz)
 304{
 305        const char *eol;
 306        while (*buf) {
 307                if (!strncmp(buf, who, wholen) &&
 308                    buf[wholen] == ' ')
 309                        return buf + wholen + 1;
 310                eol = strchr(buf, '\n');
 311                if (!eol)
 312                        return "";
 313                eol++;
 314                if (*eol == '\n')
 315                        return ""; /* end of header */
 316                buf = eol;
 317        }
 318        return "";
 319}
 320
 321static const char *copy_line(const char *buf)
 322{
 323        const char *eol = strchr(buf, '\n');
 324        if (!eol)
 325                return "";
 326        return xmemdupz(buf, eol - buf);
 327}
 328
 329static const char *copy_name(const char *buf)
 330{
 331        const char *cp;
 332        for (cp = buf; *cp && *cp != '\n'; cp++) {
 333                if (!strncmp(cp, " <", 2))
 334                        return xmemdupz(buf, cp - buf);
 335        }
 336        return "";
 337}
 338
 339static const char *copy_email(const char *buf)
 340{
 341        const char *email = strchr(buf, '<');
 342        const char *eoemail = strchr(email, '>');
 343        if (!email || !eoemail)
 344                return "";
 345        return xmemdupz(email, eoemail + 1 - email);
 346}
 347
 348static void grab_date(const char *buf, struct atom_value *v, const char *atomname)
 349{
 350        const char *eoemail = strstr(buf, "> ");
 351        char *zone;
 352        unsigned long timestamp;
 353        long tz;
 354        enum date_mode date_mode = DATE_NORMAL;
 355        const char *formatp;
 356
 357        /*
 358         * We got here because atomname ends in "date" or "date<something>";
 359         * it's not possible that <something> is not ":<format>" because
 360         * parse_atom() wouldn't have allowed it, so we can assume that no
 361         * ":" means no format is specified, and use the default.
 362         */
 363        formatp = strchr(atomname, ':');
 364        if (formatp != NULL) {
 365                formatp++;
 366                date_mode = parse_date_format(formatp);
 367        }
 368
 369        if (!eoemail)
 370                goto bad;
 371        timestamp = strtoul(eoemail + 2, &zone, 10);
 372        if (timestamp == ULONG_MAX)
 373                goto bad;
 374        tz = strtol(zone, NULL, 10);
 375        if ((tz == LONG_MIN || tz == LONG_MAX) && errno == ERANGE)
 376                goto bad;
 377        v->s = xstrdup(show_date(timestamp, tz, date_mode));
 378        v->ul = timestamp;
 379        return;
 380 bad:
 381        v->s = "";
 382        v->ul = 0;
 383}
 384
 385/* See grab_values */
 386static void grab_person(const char *who, struct atom_value *val, int deref, struct object *obj, void *buf, unsigned long sz)
 387{
 388        int i;
 389        int wholen = strlen(who);
 390        const char *wholine = NULL;
 391
 392        for (i = 0; i < used_atom_cnt; i++) {
 393                const char *name = used_atom[i];
 394                struct atom_value *v = &val[i];
 395                if (!!deref != (*name == '*'))
 396                        continue;
 397                if (deref)
 398                        name++;
 399                if (strncmp(who, name, wholen))
 400                        continue;
 401                if (name[wholen] != 0 &&
 402                    strcmp(name + wholen, "name") &&
 403                    strcmp(name + wholen, "email") &&
 404                    prefixcmp(name + wholen, "date"))
 405                        continue;
 406                if (!wholine)
 407                        wholine = find_wholine(who, wholen, buf, sz);
 408                if (!wholine)
 409                        return; /* no point looking for it */
 410                if (name[wholen] == 0)
 411                        v->s = copy_line(wholine);
 412                else if (!strcmp(name + wholen, "name"))
 413                        v->s = copy_name(wholine);
 414                else if (!strcmp(name + wholen, "email"))
 415                        v->s = copy_email(wholine);
 416                else if (!prefixcmp(name + wholen, "date"))
 417                        grab_date(wholine, v, name);
 418        }
 419
 420        /* For a tag or a commit object, if "creator" or "creatordate" is
 421         * requested, do something special.
 422         */
 423        if (strcmp(who, "tagger") && strcmp(who, "committer"))
 424                return; /* "author" for commit object is not wanted */
 425        if (!wholine)
 426                wholine = find_wholine(who, wholen, buf, sz);
 427        if (!wholine)
 428                return;
 429        for (i = 0; i < used_atom_cnt; i++) {
 430                const char *name = used_atom[i];
 431                struct atom_value *v = &val[i];
 432                if (!!deref != (*name == '*'))
 433                        continue;
 434                if (deref)
 435                        name++;
 436
 437                if (!prefixcmp(name, "creatordate"))
 438                        grab_date(wholine, v, name);
 439                else if (!strcmp(name, "creator"))
 440                        v->s = copy_line(wholine);
 441        }
 442}
 443
 444static void find_subpos(const char *buf, unsigned long sz, const char **sub, const char **body)
 445{
 446        while (*buf) {
 447                const char *eol = strchr(buf, '\n');
 448                if (!eol)
 449                        return;
 450                if (eol[1] == '\n') {
 451                        buf = eol + 1;
 452                        break; /* found end of header */
 453                }
 454                buf = eol + 1;
 455        }
 456        while (*buf == '\n')
 457                buf++;
 458        if (!*buf)
 459                return;
 460        *sub = buf; /* first non-empty line */
 461        buf = strchr(buf, '\n');
 462        if (!buf)
 463                return; /* no body */
 464        while (*buf == '\n')
 465                buf++; /* skip blank between subject and body */
 466        *body = buf;
 467}
 468
 469/* See grab_values */
 470static void grab_sub_body_contents(struct atom_value *val, int deref, struct object *obj, void *buf, unsigned long sz)
 471{
 472        int i;
 473        const char *subpos = NULL, *bodypos = NULL;
 474
 475        for (i = 0; i < used_atom_cnt; i++) {
 476                const char *name = used_atom[i];
 477                struct atom_value *v = &val[i];
 478                if (!!deref != (*name == '*'))
 479                        continue;
 480                if (deref)
 481                        name++;
 482                if (strcmp(name, "subject") &&
 483                    strcmp(name, "body") &&
 484                    strcmp(name, "contents"))
 485                        continue;
 486                if (!subpos)
 487                        find_subpos(buf, sz, &subpos, &bodypos);
 488                if (!subpos)
 489                        return;
 490
 491                if (!strcmp(name, "subject"))
 492                        v->s = copy_line(subpos);
 493                else if (!strcmp(name, "body"))
 494                        v->s = xstrdup(bodypos);
 495                else if (!strcmp(name, "contents"))
 496                        v->s = xstrdup(subpos);
 497        }
 498}
 499
 500/* We want to have empty print-string for field requests
 501 * that do not apply (e.g. "authordate" for a tag object)
 502 */
 503static void fill_missing_values(struct atom_value *val)
 504{
 505        int i;
 506        for (i = 0; i < used_atom_cnt; i++) {
 507                struct atom_value *v = &val[i];
 508                if (v->s == NULL)
 509                        v->s = "";
 510        }
 511}
 512
 513/*
 514 * val is a list of atom_value to hold returned values.  Extract
 515 * the values for atoms in used_atom array out of (obj, buf, sz).
 516 * when deref is false, (obj, buf, sz) is the object that is
 517 * pointed at by the ref itself; otherwise it is the object the
 518 * ref (which is a tag) refers to.
 519 */
 520static void grab_values(struct atom_value *val, int deref, struct object *obj, void *buf, unsigned long sz)
 521{
 522        grab_common_values(val, deref, obj, buf, sz);
 523        switch (obj->type) {
 524        case OBJ_TAG:
 525                grab_tag_values(val, deref, obj, buf, sz);
 526                grab_sub_body_contents(val, deref, obj, buf, sz);
 527                grab_person("tagger", val, deref, obj, buf, sz);
 528                break;
 529        case OBJ_COMMIT:
 530                grab_commit_values(val, deref, obj, buf, sz);
 531                grab_sub_body_contents(val, deref, obj, buf, sz);
 532                grab_person("author", val, deref, obj, buf, sz);
 533                grab_person("committer", val, deref, obj, buf, sz);
 534                break;
 535        case OBJ_TREE:
 536                // grab_tree_values(val, deref, obj, buf, sz);
 537                break;
 538        case OBJ_BLOB:
 539                // grab_blob_values(val, deref, obj, buf, sz);
 540                break;
 541        default:
 542                die("Eh?  Object of type %d?", obj->type);
 543        }
 544}
 545
 546/*
 547 * Parse the object referred by ref, and grab needed value.
 548 */
 549static void populate_value(struct refinfo *ref)
 550{
 551        void *buf;
 552        struct object *obj;
 553        int eaten, i;
 554        unsigned long size;
 555        const unsigned char *tagged;
 556
 557        ref->value = xcalloc(sizeof(struct atom_value), used_atom_cnt);
 558
 559        buf = get_obj(ref->objectname, &obj, &size, &eaten);
 560        if (!buf)
 561                die("missing object %s for %s",
 562                    sha1_to_hex(ref->objectname), ref->refname);
 563        if (!obj)
 564                die("parse_object_buffer failed on %s for %s",
 565                    sha1_to_hex(ref->objectname), ref->refname);
 566
 567        /* Fill in specials first */
 568        for (i = 0; i < used_atom_cnt; i++) {
 569                const char *name = used_atom[i];
 570                struct atom_value *v = &ref->value[i];
 571                if (!strcmp(name, "refname"))
 572                        v->s = ref->refname;
 573                else if (!strcmp(name, "*refname")) {
 574                        int len = strlen(ref->refname);
 575                        char *s = xmalloc(len + 4);
 576                        sprintf(s, "%s^{}", ref->refname);
 577                        v->s = s;
 578                }
 579        }
 580
 581        grab_values(ref->value, 0, obj, buf, size);
 582        if (!eaten)
 583                free(buf);
 584
 585        /* If there is no atom that wants to know about tagged
 586         * object, we are done.
 587         */
 588        if (!need_tagged || (obj->type != OBJ_TAG))
 589                return;
 590
 591        /* If it is a tag object, see if we use a value that derefs
 592         * the object, and if we do grab the object it refers to.
 593         */
 594        tagged = ((struct tag *)obj)->tagged->sha1;
 595
 596        /* NEEDSWORK: This derefs tag only once, which
 597         * is good to deal with chains of trust, but
 598         * is not consistent with what deref_tag() does
 599         * which peels the onion to the core.
 600         */
 601        buf = get_obj(tagged, &obj, &size, &eaten);
 602        if (!buf)
 603                die("missing object %s for %s",
 604                    sha1_to_hex(tagged), ref->refname);
 605        if (!obj)
 606                die("parse_object_buffer failed on %s for %s",
 607                    sha1_to_hex(tagged), ref->refname);
 608        grab_values(ref->value, 1, obj, buf, size);
 609        if (!eaten)
 610                free(buf);
 611}
 612
 613/*
 614 * Given a ref, return the value for the atom.  This lazily gets value
 615 * out of the object by calling populate value.
 616 */
 617static void get_value(struct refinfo *ref, int atom, struct atom_value **v)
 618{
 619        if (!ref->value) {
 620                populate_value(ref);
 621                fill_missing_values(ref->value);
 622        }
 623        *v = &ref->value[atom];
 624}
 625
 626struct grab_ref_cbdata {
 627        struct refinfo **grab_array;
 628        const char **grab_pattern;
 629        int grab_cnt;
 630};
 631
 632/*
 633 * A call-back given to for_each_ref().  It is unfortunate that we
 634 * need to use global variables to pass extra information to this
 635 * function.
 636 */
 637static int grab_single_ref(const char *refname, const unsigned char *sha1, int flag, void *cb_data)
 638{
 639        struct grab_ref_cbdata *cb = cb_data;
 640        struct refinfo *ref;
 641        int cnt;
 642
 643        if (*cb->grab_pattern) {
 644                const char **pattern;
 645                int namelen = strlen(refname);
 646                for (pattern = cb->grab_pattern; *pattern; pattern++) {
 647                        const char *p = *pattern;
 648                        int plen = strlen(p);
 649
 650                        if ((plen <= namelen) &&
 651                            !strncmp(refname, p, plen) &&
 652                            (refname[plen] == '\0' ||
 653                             refname[plen] == '/'))
 654                                break;
 655                        if (!fnmatch(p, refname, FNM_PATHNAME))
 656                                break;
 657                }
 658                if (!*pattern)
 659                        return 0;
 660        }
 661
 662        /* We do not open the object yet; sort may only need refname
 663         * to do its job and the resulting list may yet to be pruned
 664         * by maxcount logic.
 665         */
 666        ref = xcalloc(1, sizeof(*ref));
 667        ref->refname = xstrdup(refname);
 668        hashcpy(ref->objectname, sha1);
 669
 670        cnt = cb->grab_cnt;
 671        cb->grab_array = xrealloc(cb->grab_array,
 672                                  sizeof(*cb->grab_array) * (cnt + 1));
 673        cb->grab_array[cnt++] = ref;
 674        cb->grab_cnt = cnt;
 675        return 0;
 676}
 677
 678static int cmp_ref_sort(struct ref_sort *s, struct refinfo *a, struct refinfo *b)
 679{
 680        struct atom_value *va, *vb;
 681        int cmp;
 682        cmp_type cmp_type = used_atom_type[s->atom];
 683
 684        get_value(a, s->atom, &va);
 685        get_value(b, s->atom, &vb);
 686        switch (cmp_type) {
 687        case FIELD_STR:
 688                cmp = strcmp(va->s, vb->s);
 689                break;
 690        default:
 691                if (va->ul < vb->ul)
 692                        cmp = -1;
 693                else if (va->ul == vb->ul)
 694                        cmp = 0;
 695                else
 696                        cmp = 1;
 697                break;
 698        }
 699        return (s->reverse) ? -cmp : cmp;
 700}
 701
 702static struct ref_sort *ref_sort;
 703static int compare_refs(const void *a_, const void *b_)
 704{
 705        struct refinfo *a = *((struct refinfo **)a_);
 706        struct refinfo *b = *((struct refinfo **)b_);
 707        struct ref_sort *s;
 708
 709        for (s = ref_sort; s; s = s->next) {
 710                int cmp = cmp_ref_sort(s, a, b);
 711                if (cmp)
 712                        return cmp;
 713        }
 714        return 0;
 715}
 716
 717static void sort_refs(struct ref_sort *sort, struct refinfo **refs, int num_refs)
 718{
 719        ref_sort = sort;
 720        qsort(refs, num_refs, sizeof(struct refinfo *), compare_refs);
 721}
 722
 723static void print_value(struct refinfo *ref, int atom, int quote_style)
 724{
 725        struct atom_value *v;
 726        get_value(ref, atom, &v);
 727        switch (quote_style) {
 728        case QUOTE_NONE:
 729                fputs(v->s, stdout);
 730                break;
 731        case QUOTE_SHELL:
 732                sq_quote_print(stdout, v->s);
 733                break;
 734        case QUOTE_PERL:
 735                perl_quote_print(stdout, v->s);
 736                break;
 737        case QUOTE_PYTHON:
 738                python_quote_print(stdout, v->s);
 739                break;
 740        case QUOTE_TCL:
 741                tcl_quote_print(stdout, v->s);
 742                break;
 743        }
 744}
 745
 746static int hex1(char ch)
 747{
 748        if ('0' <= ch && ch <= '9')
 749                return ch - '0';
 750        else if ('a' <= ch && ch <= 'f')
 751                return ch - 'a' + 10;
 752        else if ('A' <= ch && ch <= 'F')
 753                return ch - 'A' + 10;
 754        return -1;
 755}
 756static int hex2(const char *cp)
 757{
 758        if (cp[0] && cp[1])
 759                return (hex1(cp[0]) << 4) | hex1(cp[1]);
 760        else
 761                return -1;
 762}
 763
 764static void emit(const char *cp, const char *ep)
 765{
 766        while (*cp && (!ep || cp < ep)) {
 767                if (*cp == '%') {
 768                        if (cp[1] == '%')
 769                                cp++;
 770                        else {
 771                                int ch = hex2(cp + 1);
 772                                if (0 <= ch) {
 773                                        putchar(ch);
 774                                        cp += 3;
 775                                        continue;
 776                                }
 777                        }
 778                }
 779                putchar(*cp);
 780                cp++;
 781        }
 782}
 783
 784static void show_ref(struct refinfo *info, const char *format, int quote_style)
 785{
 786        const char *cp, *sp, *ep;
 787
 788        for (cp = format; *cp && (sp = find_next(cp)); cp = ep + 1) {
 789                ep = strchr(sp, ')');
 790                if (cp < sp)
 791                        emit(cp, sp);
 792                print_value(info, parse_atom(sp + 2, ep), quote_style);
 793        }
 794        if (*cp) {
 795                sp = cp + strlen(cp);
 796                emit(cp, sp);
 797        }
 798        putchar('\n');
 799}
 800
 801static struct ref_sort *default_sort(void)
 802{
 803        static const char cstr_name[] = "refname";
 804
 805        struct ref_sort *sort = xcalloc(1, sizeof(*sort));
 806
 807        sort->next = NULL;
 808        sort->atom = parse_atom(cstr_name, cstr_name + strlen(cstr_name));
 809        return sort;
 810}
 811
 812int opt_parse_sort(const struct option *opt, const char *arg, int unset)
 813{
 814        struct ref_sort **sort_tail = opt->value;
 815        struct ref_sort *s;
 816        int len;
 817
 818        if (!arg) /* should --no-sort void the list ? */
 819                return -1;
 820
 821        *sort_tail = s = xcalloc(1, sizeof(*s));
 822        sort_tail = &s->next;
 823
 824        if (*arg == '-') {
 825                s->reverse = 1;
 826                arg++;
 827        }
 828        len = strlen(arg);
 829        s->atom = parse_atom(arg, arg+len);
 830        return 0;
 831}
 832
 833static char const * const for_each_ref_usage[] = {
 834        "git-for-each-ref [options] [<pattern>]",
 835        NULL
 836};
 837
 838int cmd_for_each_ref(int argc, const char **argv, const char *prefix)
 839{
 840        int i, num_refs;
 841        const char *format = "%(objectname) %(objecttype)\t%(refname)";
 842        struct ref_sort *sort = NULL, **sort_tail = &sort;
 843        int maxcount = 0, quote_style = 0;
 844        struct refinfo **refs;
 845        struct grab_ref_cbdata cbdata;
 846
 847        struct option opts[] = {
 848                OPT_BIT('s', "shell", &quote_style,
 849                        "quote placeholders suitably for shells", QUOTE_SHELL),
 850                OPT_BIT('p', "perl",  &quote_style,
 851                        "quote placeholders suitably for perl", QUOTE_PERL),
 852                OPT_BIT(0 , "python", &quote_style,
 853                        "quote placeholders suitably for python", QUOTE_PYTHON),
 854                OPT_BIT(0 , "tcl",  &quote_style,
 855                        "quote placeholders suitably for tcl", QUOTE_TCL),
 856
 857                OPT_GROUP(""),
 858                OPT_INTEGER( 0 , "count", &maxcount, "show only <n> matched refs"),
 859                OPT_STRING(  0 , "format", &format, "format", "format to use for the output"),
 860                OPT_CALLBACK(0 , "sort", sort_tail, "key",
 861                            "field name to sort on", &opt_parse_sort),
 862                OPT_END(),
 863        };
 864
 865        parse_options(argc, argv, opts, for_each_ref_usage, 0);
 866        if (maxcount < 0) {
 867                error("invalid --count argument: `%d'", maxcount);
 868                usage_with_options(for_each_ref_usage, opts);
 869        }
 870        if (HAS_MULTI_BITS(quote_style)) {
 871                error("more than one quoting style?");
 872                usage_with_options(for_each_ref_usage, opts);
 873        }
 874        if (verify_format(format))
 875                usage_with_options(for_each_ref_usage, opts);
 876
 877        if (!sort)
 878                sort = default_sort();
 879        sort_atom_limit = used_atom_cnt;
 880
 881        memset(&cbdata, 0, sizeof(cbdata));
 882        cbdata.grab_pattern = argv;
 883        for_each_ref(grab_single_ref, &cbdata);
 884        refs = cbdata.grab_array;
 885        num_refs = cbdata.grab_cnt;
 886
 887        for (i = 0; i < used_atom_cnt; i++) {
 888                if (used_atom[i][0] == '*') {
 889                        need_tagged = 1;
 890                        break;
 891                }
 892        }
 893
 894        sort_refs(sort, refs, num_refs);
 895
 896        if (!maxcount || num_refs < maxcount)
 897                maxcount = num_refs;
 898        for (i = 0; i < maxcount; i++)
 899                show_ref(refs[i], format, quote_style);
 900        return 0;
 901}