Andrew's git / gitweb.git / ref-filter.c
?
ref-filter.con commit travis-ci: build and test Git on Windows (029aeee)
   1#include "builtin.h"
   2#include "cache.h"
   3#include "parse-options.h"
   4#include "refs.h"
   5#include "wildmatch.h"
   6#include "commit.h"
   7#include "remote.h"
   8#include "color.h"
   9#include "tag.h"
  10#include "quote.h"
  11#include "ref-filter.h"
  12#include "revision.h"
  13#include "utf8.h"
  14#include "git-compat-util.h"
  15#include "version.h"
  16#include "trailer.h"
  17#include "wt-status.h"
  18#include "commit-slab.h"
  19
  20static struct ref_msg {
  21        const char *gone;
  22        const char *ahead;
  23        const char *behind;
  24        const char *ahead_behind;
  25} msgs = {
  26         /* Untranslated plumbing messages: */
  27        "gone",
  28        "ahead %d",
  29        "behind %d",
  30        "ahead %d, behind %d"
  31};
  32
  33void setup_ref_filter_porcelain_msg(void)
  34{
  35        msgs.gone = _("gone");
  36        msgs.ahead = _("ahead %d");
  37        msgs.behind = _("behind %d");
  38        msgs.ahead_behind = _("ahead %d, behind %d");
  39}
  40
  41typedef enum { FIELD_STR, FIELD_ULONG, FIELD_TIME } cmp_type;
  42typedef enum { COMPARE_EQUAL, COMPARE_UNEQUAL, COMPARE_NONE } cmp_status;
  43
  44struct align {
  45        align_type position;
  46        unsigned int width;
  47};
  48
  49struct if_then_else {
  50        cmp_status cmp_status;
  51        const char *str;
  52        unsigned int then_atom_seen : 1,
  53                else_atom_seen : 1,
  54                condition_satisfied : 1;
  55};
  56
  57struct refname_atom {
  58        enum { R_NORMAL, R_SHORT, R_LSTRIP, R_RSTRIP } option;
  59        int lstrip, rstrip;
  60};
  61
  62/*
  63 * An atom is a valid field atom listed below, possibly prefixed with
  64 * a "*" to denote deref_tag().
  65 *
  66 * We parse given format string and sort specifiers, and make a list
  67 * of properties that we need to extract out of objects.  ref_array_item
  68 * structure will hold an array of values extracted that can be
  69 * indexed with the "atom number", which is an index into this
  70 * array.
  71 */
  72static struct used_atom {
  73        const char *name;
  74        cmp_type type;
  75        union {
  76                char color[COLOR_MAXLEN];
  77                struct align align;
  78                struct {
  79                        enum { RR_REF, RR_TRACK, RR_TRACKSHORT } option;
  80                        struct refname_atom refname;
  81                        unsigned int nobracket : 1;
  82                } remote_ref;
  83                struct {
  84                        enum { C_BARE, C_BODY, C_BODY_DEP, C_LINES, C_SIG, C_SUB, C_TRAILERS } option;
  85                        unsigned int nlines;
  86                } contents;
  87                struct {
  88                        cmp_status cmp_status;
  89                        const char *str;
  90                } if_then_else;
  91                struct {
  92                        enum { O_FULL, O_LENGTH, O_SHORT } option;
  93                        unsigned int length;
  94                } objectname;
  95                struct refname_atom refname;
  96        } u;
  97} *used_atom;
  98static int used_atom_cnt, need_tagged, need_symref;
  99static int need_color_reset_at_eol;
 100
 101static void color_atom_parser(struct used_atom *atom, const char *color_value)
 102{
 103        if (!color_value)
 104                die(_("expected format: %%(color:<color>)"));
 105        if (color_parse(color_value, atom->u.color) < 0)
 106                die(_("unrecognized color: %%(color:%s)"), color_value);
 107}
 108
 109static void refname_atom_parser_internal(struct refname_atom *atom,
 110                                         const char *arg, const char *name)
 111{
 112        if (!arg)
 113                atom->option = R_NORMAL;
 114        else if (!strcmp(arg, "short"))
 115                atom->option = R_SHORT;
 116        else if (skip_prefix(arg, "lstrip=", &arg) ||
 117                 skip_prefix(arg, "strip=", &arg)) {
 118                atom->option = R_LSTRIP;
 119                if (strtol_i(arg, 10, &atom->lstrip))
 120                        die(_("Integer value expected refname:lstrip=%s"), arg);
 121        } else if (skip_prefix(arg, "rstrip=", &arg)) {
 122                atom->option = R_RSTRIP;
 123                if (strtol_i(arg, 10, &atom->rstrip))
 124                        die(_("Integer value expected refname:rstrip=%s"), arg);
 125        } else
 126                die(_("unrecognized %%(%s) argument: %s"), name, arg);
 127}
 128
 129static void remote_ref_atom_parser(struct used_atom *atom, const char *arg)
 130{
 131        struct string_list params = STRING_LIST_INIT_DUP;
 132        int i;
 133
 134        if (!arg) {
 135                atom->u.remote_ref.option = RR_REF;
 136                refname_atom_parser_internal(&atom->u.remote_ref.refname,
 137                                             arg, atom->name);
 138                return;
 139        }
 140
 141        atom->u.remote_ref.nobracket = 0;
 142        string_list_split(&params, arg, ',', -1);
 143
 144        for (i = 0; i < params.nr; i++) {
 145                const char *s = params.items[i].string;
 146
 147                if (!strcmp(s, "track"))
 148                        atom->u.remote_ref.option = RR_TRACK;
 149                else if (!strcmp(s, "trackshort"))
 150                        atom->u.remote_ref.option = RR_TRACKSHORT;
 151                else if (!strcmp(s, "nobracket"))
 152                        atom->u.remote_ref.nobracket = 1;
 153                else {
 154                        atom->u.remote_ref.option = RR_REF;
 155                        refname_atom_parser_internal(&atom->u.remote_ref.refname,
 156                                                     arg, atom->name);
 157                }
 158        }
 159
 160        string_list_clear(&params, 0);
 161}
 162
 163static void body_atom_parser(struct used_atom *atom, const char *arg)
 164{
 165        if (arg)
 166                die(_("%%(body) does not take arguments"));
 167        atom->u.contents.option = C_BODY_DEP;
 168}
 169
 170static void subject_atom_parser(struct used_atom *atom, const char *arg)
 171{
 172        if (arg)
 173                die(_("%%(subject) does not take arguments"));
 174        atom->u.contents.option = C_SUB;
 175}
 176
 177static void trailers_atom_parser(struct used_atom *atom, const char *arg)
 178{
 179        if (arg)
 180                die(_("%%(trailers) does not take arguments"));
 181        atom->u.contents.option = C_TRAILERS;
 182}
 183
 184static void contents_atom_parser(struct used_atom *atom, const char *arg)
 185{
 186        if (!arg)
 187                atom->u.contents.option = C_BARE;
 188        else if (!strcmp(arg, "body"))
 189                atom->u.contents.option = C_BODY;
 190        else if (!strcmp(arg, "signature"))
 191                atom->u.contents.option = C_SIG;
 192        else if (!strcmp(arg, "subject"))
 193                atom->u.contents.option = C_SUB;
 194        else if (!strcmp(arg, "trailers"))
 195                atom->u.contents.option = C_TRAILERS;
 196        else if (skip_prefix(arg, "lines=", &arg)) {
 197                atom->u.contents.option = C_LINES;
 198                if (strtoul_ui(arg, 10, &atom->u.contents.nlines))
 199                        die(_("positive value expected contents:lines=%s"), arg);
 200        } else
 201                die(_("unrecognized %%(contents) argument: %s"), arg);
 202}
 203
 204static void objectname_atom_parser(struct used_atom *atom, const char *arg)
 205{
 206        if (!arg)
 207                atom->u.objectname.option = O_FULL;
 208        else if (!strcmp(arg, "short"))
 209                atom->u.objectname.option = O_SHORT;
 210        else if (skip_prefix(arg, "short=", &arg)) {
 211                atom->u.objectname.option = O_LENGTH;
 212                if (strtoul_ui(arg, 10, &atom->u.objectname.length) ||
 213                    atom->u.objectname.length == 0)
 214                        die(_("positive value expected objectname:short=%s"), arg);
 215                if (atom->u.objectname.length < MINIMUM_ABBREV)
 216                        atom->u.objectname.length = MINIMUM_ABBREV;
 217        } else
 218                die(_("unrecognized %%(objectname) argument: %s"), arg);
 219}
 220
 221static void refname_atom_parser(struct used_atom *atom, const char *arg)
 222{
 223        return refname_atom_parser_internal(&atom->u.refname, arg, atom->name);
 224}
 225
 226static align_type parse_align_position(const char *s)
 227{
 228        if (!strcmp(s, "right"))
 229                return ALIGN_RIGHT;
 230        else if (!strcmp(s, "middle"))
 231                return ALIGN_MIDDLE;
 232        else if (!strcmp(s, "left"))
 233                return ALIGN_LEFT;
 234        return -1;
 235}
 236
 237static void align_atom_parser(struct used_atom *atom, const char *arg)
 238{
 239        struct align *align = &atom->u.align;
 240        struct string_list params = STRING_LIST_INIT_DUP;
 241        int i;
 242        unsigned int width = ~0U;
 243
 244        if (!arg)
 245                die(_("expected format: %%(align:<width>,<position>)"));
 246
 247        align->position = ALIGN_LEFT;
 248
 249        string_list_split(&params, arg, ',', -1);
 250        for (i = 0; i < params.nr; i++) {
 251                const char *s = params.items[i].string;
 252                int position;
 253
 254                if (skip_prefix(s, "position=", &s)) {
 255                        position = parse_align_position(s);
 256                        if (position < 0)
 257                                die(_("unrecognized position:%s"), s);
 258                        align->position = position;
 259                } else if (skip_prefix(s, "width=", &s)) {
 260                        if (strtoul_ui(s, 10, &width))
 261                                die(_("unrecognized width:%s"), s);
 262                } else if (!strtoul_ui(s, 10, &width))
 263                        ;
 264                else if ((position = parse_align_position(s)) >= 0)
 265                        align->position = position;
 266                else
 267                        die(_("unrecognized %%(align) argument: %s"), s);
 268        }
 269
 270        if (width == ~0U)
 271                die(_("positive width expected with the %%(align) atom"));
 272        align->width = width;
 273        string_list_clear(&params, 0);
 274}
 275
 276static void if_atom_parser(struct used_atom *atom, const char *arg)
 277{
 278        if (!arg) {
 279                atom->u.if_then_else.cmp_status = COMPARE_NONE;
 280                return;
 281        } else if (skip_prefix(arg, "equals=", &atom->u.if_then_else.str)) {
 282                atom->u.if_then_else.cmp_status = COMPARE_EQUAL;
 283        } else if (skip_prefix(arg, "notequals=", &atom->u.if_then_else.str)) {
 284                atom->u.if_then_else.cmp_status = COMPARE_UNEQUAL;
 285        } else {
 286                die(_("unrecognized %%(if) argument: %s"), arg);
 287        }
 288}
 289
 290
 291static struct {
 292        const char *name;
 293        cmp_type cmp_type;
 294        void (*parser)(struct used_atom *atom, const char *arg);
 295} valid_atom[] = {
 296        { "refname" , FIELD_STR, refname_atom_parser },
 297        { "objecttype" },
 298        { "objectsize", FIELD_ULONG },
 299        { "objectname", FIELD_STR, objectname_atom_parser },
 300        { "tree" },
 301        { "parent" },
 302        { "numparent", FIELD_ULONG },
 303        { "object" },
 304        { "type" },
 305        { "tag" },
 306        { "author" },
 307        { "authorname" },
 308        { "authoremail" },
 309        { "authordate", FIELD_TIME },
 310        { "committer" },
 311        { "committername" },
 312        { "committeremail" },
 313        { "committerdate", FIELD_TIME },
 314        { "tagger" },
 315        { "taggername" },
 316        { "taggeremail" },
 317        { "taggerdate", FIELD_TIME },
 318        { "creator" },
 319        { "creatordate", FIELD_TIME },
 320        { "subject", FIELD_STR, subject_atom_parser },
 321        { "body", FIELD_STR, body_atom_parser },
 322        { "trailers", FIELD_STR, trailers_atom_parser },
 323        { "contents", FIELD_STR, contents_atom_parser },
 324        { "upstream", FIELD_STR, remote_ref_atom_parser },
 325        { "push", FIELD_STR, remote_ref_atom_parser },
 326        { "symref", FIELD_STR, refname_atom_parser },
 327        { "flag" },
 328        { "HEAD" },
 329        { "color", FIELD_STR, color_atom_parser },
 330        { "align", FIELD_STR, align_atom_parser },
 331        { "end" },
 332        { "if", FIELD_STR, if_atom_parser },
 333        { "then" },
 334        { "else" },
 335};
 336
 337#define REF_FORMATTING_STATE_INIT  { 0, NULL }
 338
 339struct ref_formatting_stack {
 340        struct ref_formatting_stack *prev;
 341        struct strbuf output;
 342        void (*at_end)(struct ref_formatting_stack **stack);
 343        void *at_end_data;
 344};
 345
 346struct ref_formatting_state {
 347        int quote_style;
 348        struct ref_formatting_stack *stack;
 349};
 350
 351struct atom_value {
 352        const char *s;
 353        void (*handler)(struct atom_value *atomv, struct ref_formatting_state *state);
 354        unsigned long ul; /* used for sorting when not FIELD_STR */
 355        struct used_atom *atom;
 356};
 357
 358/*
 359 * Used to parse format string and sort specifiers
 360 */
 361int parse_ref_filter_atom(const char *atom, const char *ep)
 362{
 363        const char *sp;
 364        const char *arg;
 365        int i, at, atom_len;
 366
 367        sp = atom;
 368        if (*sp == '*' && sp < ep)
 369                sp++; /* deref */
 370        if (ep <= sp)
 371                die(_("malformed field name: %.*s"), (int)(ep-atom), atom);
 372
 373        /* Do we have the atom already used elsewhere? */
 374        for (i = 0; i < used_atom_cnt; i++) {
 375                int len = strlen(used_atom[i].name);
 376                if (len == ep - atom && !memcmp(used_atom[i].name, atom, len))
 377                        return i;
 378        }
 379
 380        /*
 381         * If the atom name has a colon, strip it and everything after
 382         * it off - it specifies the format for this entry, and
 383         * shouldn't be used for checking against the valid_atom
 384         * table.
 385         */
 386        arg = memchr(sp, ':', ep - sp);
 387        atom_len = (arg ? arg : ep) - sp;
 388
 389        /* Is the atom a valid one? */
 390        for (i = 0; i < ARRAY_SIZE(valid_atom); i++) {
 391                int len = strlen(valid_atom[i].name);
 392                if (len == atom_len && !memcmp(valid_atom[i].name, sp, len))
 393                        break;
 394        }
 395
 396        if (ARRAY_SIZE(valid_atom) <= i)
 397                die(_("unknown field name: %.*s"), (int)(ep-atom), atom);
 398
 399        /* Add it in, including the deref prefix */
 400        at = used_atom_cnt;
 401        used_atom_cnt++;
 402        REALLOC_ARRAY(used_atom, used_atom_cnt);
 403        used_atom[at].name = xmemdupz(atom, ep - atom);
 404        used_atom[at].type = valid_atom[i].cmp_type;
 405        if (arg)
 406                arg = used_atom[at].name + (arg - atom) + 1;
 407        memset(&used_atom[at].u, 0, sizeof(used_atom[at].u));
 408        if (valid_atom[i].parser)
 409                valid_atom[i].parser(&used_atom[at], arg);
 410        if (*atom == '*')
 411                need_tagged = 1;
 412        if (!strcmp(valid_atom[i].name, "symref"))
 413                need_symref = 1;
 414        return at;
 415}
 416
 417static void quote_formatting(struct strbuf *s, const char *str, int quote_style)
 418{
 419        switch (quote_style) {
 420        case QUOTE_NONE:
 421                strbuf_addstr(s, str);
 422                break;
 423        case QUOTE_SHELL:
 424                sq_quote_buf(s, str);
 425                break;
 426        case QUOTE_PERL:
 427                perl_quote_buf(s, str);
 428                break;
 429        case QUOTE_PYTHON:
 430                python_quote_buf(s, str);
 431                break;
 432        case QUOTE_TCL:
 433                tcl_quote_buf(s, str);
 434                break;
 435        }
 436}
 437
 438static void append_atom(struct atom_value *v, struct ref_formatting_state *state)
 439{
 440        /*
 441         * Quote formatting is only done when the stack has a single
 442         * element. Otherwise quote formatting is done on the
 443         * element's entire output strbuf when the %(end) atom is
 444         * encountered.
 445         */
 446        if (!state->stack->prev)
 447                quote_formatting(&state->stack->output, v->s, state->quote_style);
 448        else
 449                strbuf_addstr(&state->stack->output, v->s);
 450}
 451
 452static void push_stack_element(struct ref_formatting_stack **stack)
 453{
 454        struct ref_formatting_stack *s = xcalloc(1, sizeof(struct ref_formatting_stack));
 455
 456        strbuf_init(&s->output, 0);
 457        s->prev = *stack;
 458        *stack = s;
 459}
 460
 461static void pop_stack_element(struct ref_formatting_stack **stack)
 462{
 463        struct ref_formatting_stack *current = *stack;
 464        struct ref_formatting_stack *prev = current->prev;
 465
 466        if (prev)
 467                strbuf_addbuf(&prev->output, &current->output);
 468        strbuf_release(&current->output);
 469        free(current);
 470        *stack = prev;
 471}
 472
 473static void end_align_handler(struct ref_formatting_stack **stack)
 474{
 475        struct ref_formatting_stack *cur = *stack;
 476        struct align *align = (struct align *)cur->at_end_data;
 477        struct strbuf s = STRBUF_INIT;
 478
 479        strbuf_utf8_align(&s, align->position, align->width, cur->output.buf);
 480        strbuf_swap(&cur->output, &s);
 481        strbuf_release(&s);
 482}
 483
 484static void align_atom_handler(struct atom_value *atomv, struct ref_formatting_state *state)
 485{
 486        struct ref_formatting_stack *new;
 487
 488        push_stack_element(&state->stack);
 489        new = state->stack;
 490        new->at_end = end_align_handler;
 491        new->at_end_data = &atomv->atom->u.align;
 492}
 493
 494static void if_then_else_handler(struct ref_formatting_stack **stack)
 495{
 496        struct ref_formatting_stack *cur = *stack;
 497        struct ref_formatting_stack *prev = cur->prev;
 498        struct if_then_else *if_then_else = (struct if_then_else *)cur->at_end_data;
 499
 500        if (!if_then_else->then_atom_seen)
 501                die(_("format: %%(if) atom used without a %%(then) atom"));
 502
 503        if (if_then_else->else_atom_seen) {
 504                /*
 505                 * There is an %(else) atom: we need to drop one state from the
 506                 * stack, either the %(else) branch if the condition is satisfied, or
 507                 * the %(then) branch if it isn't.
 508                 */
 509                if (if_then_else->condition_satisfied) {
 510                        strbuf_reset(&cur->output);
 511                        pop_stack_element(&cur);
 512                } else {
 513                        strbuf_swap(&cur->output, &prev->output);
 514                        strbuf_reset(&cur->output);
 515                        pop_stack_element(&cur);
 516                }
 517        } else if (!if_then_else->condition_satisfied) {
 518                /*
 519                 * No %(else) atom: just drop the %(then) branch if the
 520                 * condition is not satisfied.
 521                 */
 522                strbuf_reset(&cur->output);
 523        }
 524
 525        *stack = cur;
 526        free(if_then_else);
 527}
 528
 529static void if_atom_handler(struct atom_value *atomv, struct ref_formatting_state *state)
 530{
 531        struct ref_formatting_stack *new;
 532        struct if_then_else *if_then_else = xcalloc(sizeof(struct if_then_else), 1);
 533
 534        if_then_else->str = atomv->atom->u.if_then_else.str;
 535        if_then_else->cmp_status = atomv->atom->u.if_then_else.cmp_status;
 536
 537        push_stack_element(&state->stack);
 538        new = state->stack;
 539        new->at_end = if_then_else_handler;
 540        new->at_end_data = if_then_else;
 541}
 542
 543static int is_empty(const char *s)
 544{
 545        while (*s != '\0') {
 546                if (!isspace(*s))
 547                        return 0;
 548                s++;
 549        }
 550        return 1;
 551}
 552
 553static void then_atom_handler(struct atom_value *atomv, struct ref_formatting_state *state)
 554{
 555        struct ref_formatting_stack *cur = state->stack;
 556        struct if_then_else *if_then_else = NULL;
 557
 558        if (cur->at_end == if_then_else_handler)
 559                if_then_else = (struct if_then_else *)cur->at_end_data;
 560        if (!if_then_else)
 561                die(_("format: %%(then) atom used without an %%(if) atom"));
 562        if (if_then_else->then_atom_seen)
 563                die(_("format: %%(then) atom used more than once"));
 564        if (if_then_else->else_atom_seen)
 565                die(_("format: %%(then) atom used after %%(else)"));
 566        if_then_else->then_atom_seen = 1;
 567        /*
 568         * If the 'equals' or 'notequals' attribute is used then
 569         * perform the required comparison. If not, only non-empty
 570         * strings satisfy the 'if' condition.
 571         */
 572        if (if_then_else->cmp_status == COMPARE_EQUAL) {
 573                if (!strcmp(if_then_else->str, cur->output.buf))
 574                        if_then_else->condition_satisfied = 1;
 575        } else if (if_then_else->cmp_status == COMPARE_UNEQUAL) {
 576                if (strcmp(if_then_else->str, cur->output.buf))
 577                        if_then_else->condition_satisfied = 1;
 578        } else if (cur->output.len && !is_empty(cur->output.buf))
 579                if_then_else->condition_satisfied = 1;
 580        strbuf_reset(&cur->output);
 581}
 582
 583static void else_atom_handler(struct atom_value *atomv, struct ref_formatting_state *state)
 584{
 585        struct ref_formatting_stack *prev = state->stack;
 586        struct if_then_else *if_then_else = NULL;
 587
 588        if (prev->at_end == if_then_else_handler)
 589                if_then_else = (struct if_then_else *)prev->at_end_data;
 590        if (!if_then_else)
 591                die(_("format: %%(else) atom used without an %%(if) atom"));
 592        if (!if_then_else->then_atom_seen)
 593                die(_("format: %%(else) atom used without a %%(then) atom"));
 594        if (if_then_else->else_atom_seen)
 595                die(_("format: %%(else) atom used more than once"));
 596        if_then_else->else_atom_seen = 1;
 597        push_stack_element(&state->stack);
 598        state->stack->at_end_data = prev->at_end_data;
 599        state->stack->at_end = prev->at_end;
 600}
 601
 602static void end_atom_handler(struct atom_value *atomv, struct ref_formatting_state *state)
 603{
 604        struct ref_formatting_stack *current = state->stack;
 605        struct strbuf s = STRBUF_INIT;
 606
 607        if (!current->at_end)
 608                die(_("format: %%(end) atom used without corresponding atom"));
 609        current->at_end(&state->stack);
 610
 611        /*  Stack may have been popped within at_end(), hence reset the current pointer */
 612        current = state->stack;
 613
 614        /*
 615         * Perform quote formatting when the stack element is that of
 616         * a supporting atom. If nested then perform quote formatting
 617         * only on the topmost supporting atom.
 618         */
 619        if (!current->prev->prev) {
 620                quote_formatting(&s, current->output.buf, state->quote_style);
 621                strbuf_swap(&current->output, &s);
 622        }
 623        strbuf_release(&s);
 624        pop_stack_element(&state->stack);
 625}
 626
 627/*
 628 * In a format string, find the next occurrence of %(atom).
 629 */
 630static const char *find_next(const char *cp)
 631{
 632        while (*cp) {
 633                if (*cp == '%') {
 634                        /*
 635                         * %( is the start of an atom;
 636                         * %% is a quoted per-cent.
 637                         */
 638                        if (cp[1] == '(')
 639                                return cp;
 640                        else if (cp[1] == '%')
 641                                cp++; /* skip over two % */
 642                        /* otherwise this is a singleton, literal % */
 643                }
 644                cp++;
 645        }
 646        return NULL;
 647}
 648
 649/*
 650 * Make sure the format string is well formed, and parse out
 651 * the used atoms.
 652 */
 653int verify_ref_format(const char *format)
 654{
 655        const char *cp, *sp;
 656
 657        need_color_reset_at_eol = 0;
 658        for (cp = format; *cp && (sp = find_next(cp)); ) {
 659                const char *color, *ep = strchr(sp, ')');
 660                int at;
 661
 662                if (!ep)
 663                        return error(_("malformed format string %s"), sp);
 664                /* sp points at "%(" and ep points at the closing ")" */
 665                at = parse_ref_filter_atom(sp + 2, ep);
 666                cp = ep + 1;
 667
 668                if (skip_prefix(used_atom[at].name, "color:", &color))
 669                        need_color_reset_at_eol = !!strcmp(color, "reset");
 670        }
 671        return 0;
 672}
 673
 674/*
 675 * Given an object name, read the object data and size, and return a
 676 * "struct object".  If the object data we are returning is also borrowed
 677 * by the "struct object" representation, set *eaten as well---it is a
 678 * signal from parse_object_buffer to us not to free the buffer.
 679 */
 680static void *get_obj(const unsigned char *sha1, struct object **obj, unsigned long *sz, int *eaten)
 681{
 682        enum object_type type;
 683        void *buf = read_sha1_file(sha1, &type, sz);
 684
 685        if (buf)
 686                *obj = parse_object_buffer(sha1, type, *sz, buf, eaten);
 687        else
 688                *obj = NULL;
 689        return buf;
 690}
 691
 692static int grab_objectname(const char *name, const unsigned char *sha1,
 693                           struct atom_value *v, struct used_atom *atom)
 694{
 695        if (starts_with(name, "objectname")) {
 696                if (atom->u.objectname.option == O_SHORT) {
 697                        v->s = xstrdup(find_unique_abbrev(sha1, DEFAULT_ABBREV));
 698                        return 1;
 699                } else if (atom->u.objectname.option == O_FULL) {
 700                        v->s = xstrdup(sha1_to_hex(sha1));
 701                        return 1;
 702                } else if (atom->u.objectname.option == O_LENGTH) {
 703                        v->s = xstrdup(find_unique_abbrev(sha1, atom->u.objectname.length));
 704                        return 1;
 705                } else
 706                        die("BUG: unknown %%(objectname) option");
 707        }
 708        return 0;
 709}
 710
 711/* See grab_values */
 712static void grab_common_values(struct atom_value *val, int deref, struct object *obj, void *buf, unsigned long sz)
 713{
 714        int i;
 715
 716        for (i = 0; i < used_atom_cnt; i++) {
 717                const char *name = used_atom[i].name;
 718                struct atom_value *v = &val[i];
 719                if (!!deref != (*name == '*'))
 720                        continue;
 721                if (deref)
 722                        name++;
 723                if (!strcmp(name, "objecttype"))
 724                        v->s = typename(obj->type);
 725                else if (!strcmp(name, "objectsize")) {
 726                        v->ul = sz;
 727                        v->s = xstrfmt("%lu", sz);
 728                }
 729                else if (deref)
 730                        grab_objectname(name, obj->oid.hash, v, &used_atom[i]);
 731        }
 732}
 733
 734/* See grab_values */
 735static void grab_tag_values(struct atom_value *val, int deref, struct object *obj, void *buf, unsigned long sz)
 736{
 737        int i;
 738        struct tag *tag = (struct tag *) obj;
 739
 740        for (i = 0; i < used_atom_cnt; i++) {
 741                const char *name = used_atom[i].name;
 742                struct atom_value *v = &val[i];
 743                if (!!deref != (*name == '*'))
 744                        continue;
 745                if (deref)
 746                        name++;
 747                if (!strcmp(name, "tag"))
 748                        v->s = tag->tag;
 749                else if (!strcmp(name, "type") && tag->tagged)
 750                        v->s = typename(tag->tagged->type);
 751                else if (!strcmp(name, "object") && tag->tagged)
 752                        v->s = xstrdup(oid_to_hex(&tag->tagged->oid));
 753        }
 754}
 755
 756/* See grab_values */
 757static void grab_commit_values(struct atom_value *val, int deref, struct object *obj, void *buf, unsigned long sz)
 758{
 759        int i;
 760        struct commit *commit = (struct commit *) obj;
 761
 762        for (i = 0; i < used_atom_cnt; i++) {
 763                const char *name = used_atom[i].name;
 764                struct atom_value *v = &val[i];
 765                if (!!deref != (*name == '*'))
 766                        continue;
 767                if (deref)
 768                        name++;
 769                if (!strcmp(name, "tree")) {
 770                        v->s = xstrdup(oid_to_hex(&commit->tree->object.oid));
 771                }
 772                else if (!strcmp(name, "numparent")) {
 773                        v->ul = commit_list_count(commit->parents);
 774                        v->s = xstrfmt("%lu", v->ul);
 775                }
 776                else if (!strcmp(name, "parent")) {
 777                        struct commit_list *parents;
 778                        struct strbuf s = STRBUF_INIT;
 779                        for (parents = commit->parents; parents; parents = parents->next) {
 780                                struct commit *parent = parents->item;
 781                                if (parents != commit->parents)
 782                                        strbuf_addch(&s, ' ');
 783                                strbuf_addstr(&s, oid_to_hex(&parent->object.oid));
 784                        }
 785                        v->s = strbuf_detach(&s, NULL);
 786                }
 787        }
 788}
 789
 790static const char *find_wholine(const char *who, int wholen, const char *buf, unsigned long sz)
 791{
 792        const char *eol;
 793        while (*buf) {
 794                if (!strncmp(buf, who, wholen) &&
 795                    buf[wholen] == ' ')
 796                        return buf + wholen + 1;
 797                eol = strchr(buf, '\n');
 798                if (!eol)
 799                        return "";
 800                eol++;
 801                if (*eol == '\n')
 802                        return ""; /* end of header */
 803                buf = eol;
 804        }
 805        return "";
 806}
 807
 808static const char *copy_line(const char *buf)
 809{
 810        const char *eol = strchrnul(buf, '\n');
 811        return xmemdupz(buf, eol - buf);
 812}
 813
 814static const char *copy_name(const char *buf)
 815{
 816        const char *cp;
 817        for (cp = buf; *cp && *cp != '\n'; cp++) {
 818                if (!strncmp(cp, " <", 2))
 819                        return xmemdupz(buf, cp - buf);
 820        }
 821        return "";
 822}
 823
 824static const char *copy_email(const char *buf)
 825{
 826        const char *email = strchr(buf, '<');
 827        const char *eoemail;
 828        if (!email)
 829                return "";
 830        eoemail = strchr(email, '>');
 831        if (!eoemail)
 832                return "";
 833        return xmemdupz(email, eoemail + 1 - email);
 834}
 835
 836static char *copy_subject(const char *buf, unsigned long len)
 837{
 838        char *r = xmemdupz(buf, len);
 839        int i;
 840
 841        for (i = 0; i < len; i++)
 842                if (r[i] == '\n')
 843                        r[i] = ' ';
 844
 845        return r;
 846}
 847
 848static void grab_date(const char *buf, struct atom_value *v, const char *atomname)
 849{
 850        const char *eoemail = strstr(buf, "> ");
 851        char *zone;
 852        unsigned long timestamp;
 853        long tz;
 854        struct date_mode date_mode = { DATE_NORMAL };
 855        const char *formatp;
 856
 857        /*
 858         * We got here because atomname ends in "date" or "date<something>";
 859         * it's not possible that <something> is not ":<format>" because
 860         * parse_ref_filter_atom() wouldn't have allowed it, so we can assume that no
 861         * ":" means no format is specified, and use the default.
 862         */
 863        formatp = strchr(atomname, ':');
 864        if (formatp != NULL) {
 865                formatp++;
 866                parse_date_format(formatp, &date_mode);
 867        }
 868
 869        if (!eoemail)
 870                goto bad;
 871        timestamp = strtoul(eoemail + 2, &zone, 10);
 872        if (timestamp == ULONG_MAX)
 873                goto bad;
 874        tz = strtol(zone, NULL, 10);
 875        if ((tz == LONG_MIN || tz == LONG_MAX) && errno == ERANGE)
 876                goto bad;
 877        v->s = xstrdup(show_date(timestamp, tz, &date_mode));
 878        v->ul = timestamp;
 879        return;
 880 bad:
 881        v->s = "";
 882        v->ul = 0;
 883}
 884
 885/* See grab_values */
 886static void grab_person(const char *who, struct atom_value *val, int deref, struct object *obj, void *buf, unsigned long sz)
 887{
 888        int i;
 889        int wholen = strlen(who);
 890        const char *wholine = NULL;
 891
 892        for (i = 0; i < used_atom_cnt; i++) {
 893                const char *name = used_atom[i].name;
 894                struct atom_value *v = &val[i];
 895                if (!!deref != (*name == '*'))
 896                        continue;
 897                if (deref)
 898                        name++;
 899                if (strncmp(who, name, wholen))
 900                        continue;
 901                if (name[wholen] != 0 &&
 902                    strcmp(name + wholen, "name") &&
 903                    strcmp(name + wholen, "email") &&
 904                    !starts_with(name + wholen, "date"))
 905                        continue;
 906                if (!wholine)
 907                        wholine = find_wholine(who, wholen, buf, sz);
 908                if (!wholine)
 909                        return; /* no point looking for it */
 910                if (name[wholen] == 0)
 911                        v->s = copy_line(wholine);
 912                else if (!strcmp(name + wholen, "name"))
 913                        v->s = copy_name(wholine);
 914                else if (!strcmp(name + wholen, "email"))
 915                        v->s = copy_email(wholine);
 916                else if (starts_with(name + wholen, "date"))
 917                        grab_date(wholine, v, name);
 918        }
 919
 920        /*
 921         * For a tag or a commit object, if "creator" or "creatordate" is
 922         * requested, do something special.
 923         */
 924        if (strcmp(who, "tagger") && strcmp(who, "committer"))
 925                return; /* "author" for commit object is not wanted */
 926        if (!wholine)
 927                wholine = find_wholine(who, wholen, buf, sz);
 928        if (!wholine)
 929                return;
 930        for (i = 0; i < used_atom_cnt; i++) {
 931                const char *name = used_atom[i].name;
 932                struct atom_value *v = &val[i];
 933                if (!!deref != (*name == '*'))
 934                        continue;
 935                if (deref)
 936                        name++;
 937
 938                if (starts_with(name, "creatordate"))
 939                        grab_date(wholine, v, name);
 940                else if (!strcmp(name, "creator"))
 941                        v->s = copy_line(wholine);
 942        }
 943}
 944
 945static void find_subpos(const char *buf, unsigned long sz,
 946                        const char **sub, unsigned long *sublen,
 947                        const char **body, unsigned long *bodylen,
 948                        unsigned long *nonsiglen,
 949                        const char **sig, unsigned long *siglen)
 950{
 951        const char *eol;
 952        /* skip past header until we hit empty line */
 953        while (*buf && *buf != '\n') {
 954                eol = strchrnul(buf, '\n');
 955                if (*eol)
 956                        eol++;
 957                buf = eol;
 958        }
 959        /* skip any empty lines */
 960        while (*buf == '\n')
 961                buf++;
 962
 963        /* parse signature first; we might not even have a subject line */
 964        *sig = buf + parse_signature(buf, strlen(buf));
 965        *siglen = strlen(*sig);
 966
 967        /* subject is first non-empty line */
 968        *sub = buf;
 969        /* subject goes to first empty line */
 970        while (buf < *sig && *buf && *buf != '\n') {
 971                eol = strchrnul(buf, '\n');
 972                if (*eol)
 973                        eol++;
 974                buf = eol;
 975        }
 976        *sublen = buf - *sub;
 977        /* drop trailing newline, if present */
 978        if (*sublen && (*sub)[*sublen - 1] == '\n')
 979                *sublen -= 1;
 980
 981        /* skip any empty lines */
 982        while (*buf == '\n')
 983                buf++;
 984        *body = buf;
 985        *bodylen = strlen(buf);
 986        *nonsiglen = *sig - buf;
 987}
 988
 989/*
 990 * If 'lines' is greater than 0, append that many lines from the given
 991 * 'buf' of length 'size' to the given strbuf.
 992 */
 993static void append_lines(struct strbuf *out, const char *buf, unsigned long size, int lines)
 994{
 995        int i;
 996        const char *sp, *eol;
 997        size_t len;
 998
 999        sp = buf;
1000
1001        for (i = 0; i < lines && sp < buf + size; i++) {
1002                if (i)
1003                        strbuf_addstr(out, "\n    ");
1004                eol = memchr(sp, '\n', size - (sp - buf));
1005                len = eol ? eol - sp : size - (sp - buf);
1006                strbuf_add(out, sp, len);
1007                if (!eol)
1008                        break;
1009                sp = eol + 1;
1010        }
1011}
1012
1013/* See grab_values */
1014static void grab_sub_body_contents(struct atom_value *val, int deref, struct object *obj, void *buf, unsigned long sz)
1015{
1016        int i;
1017        const char *subpos = NULL, *bodypos = NULL, *sigpos = NULL;
1018        unsigned long sublen = 0, bodylen = 0, nonsiglen = 0, siglen = 0;
1019
1020        for (i = 0; i < used_atom_cnt; i++) {
1021                struct used_atom *atom = &used_atom[i];
1022                const char *name = atom->name;
1023                struct atom_value *v = &val[i];
1024                if (!!deref != (*name == '*'))
1025                        continue;
1026                if (deref)
1027                        name++;
1028                if (strcmp(name, "subject") &&
1029                    strcmp(name, "body") &&
1030                    strcmp(name, "trailers") &&
1031                    !starts_with(name, "contents"))
1032                        continue;
1033                if (!subpos)
1034                        find_subpos(buf, sz,
1035                                    &subpos, &sublen,
1036                                    &bodypos, &bodylen, &nonsiglen,
1037                                    &sigpos, &siglen);
1038
1039                if (atom->u.contents.option == C_SUB)
1040                        v->s = copy_subject(subpos, sublen);
1041                else if (atom->u.contents.option == C_BODY_DEP)
1042                        v->s = xmemdupz(bodypos, bodylen);
1043                else if (atom->u.contents.option == C_BODY)
1044                        v->s = xmemdupz(bodypos, nonsiglen);
1045                else if (atom->u.contents.option == C_SIG)
1046                        v->s = xmemdupz(sigpos, siglen);
1047                else if (atom->u.contents.option == C_LINES) {
1048                        struct strbuf s = STRBUF_INIT;
1049                        const char *contents_end = bodylen + bodypos - siglen;
1050
1051                        /*  Size is the length of the message after removing the signature */
1052                        append_lines(&s, subpos, contents_end - subpos, atom->u.contents.nlines);
1053                        v->s = strbuf_detach(&s, NULL);
1054                } else if (atom->u.contents.option == C_TRAILERS) {
1055                        struct trailer_info info;
1056
1057                        /* Search for trailer info */
1058                        trailer_info_get(&info, subpos);
1059                        v->s = xmemdupz(info.trailer_start,
1060                                        info.trailer_end - info.trailer_start);
1061                        trailer_info_release(&info);
1062                } else if (atom->u.contents.option == C_BARE)
1063                        v->s = xstrdup(subpos);
1064        }
1065}
1066
1067/*
1068 * We want to have empty print-string for field requests
1069 * that do not apply (e.g. "authordate" for a tag object)
1070 */
1071static void fill_missing_values(struct atom_value *val)
1072{
1073        int i;
1074        for (i = 0; i < used_atom_cnt; i++) {
1075                struct atom_value *v = &val[i];
1076                if (v->s == NULL)
1077                        v->s = "";
1078        }
1079}
1080
1081/*
1082 * val is a list of atom_value to hold returned values.  Extract
1083 * the values for atoms in used_atom array out of (obj, buf, sz).
1084 * when deref is false, (obj, buf, sz) is the object that is
1085 * pointed at by the ref itself; otherwise it is the object the
1086 * ref (which is a tag) refers to.
1087 */
1088static void grab_values(struct atom_value *val, int deref, struct object *obj, void *buf, unsigned long sz)
1089{
1090        grab_common_values(val, deref, obj, buf, sz);
1091        switch (obj->type) {
1092        case OBJ_TAG:
1093                grab_tag_values(val, deref, obj, buf, sz);
1094                grab_sub_body_contents(val, deref, obj, buf, sz);
1095                grab_person("tagger", val, deref, obj, buf, sz);
1096                break;
1097        case OBJ_COMMIT:
1098                grab_commit_values(val, deref, obj, buf, sz);
1099                grab_sub_body_contents(val, deref, obj, buf, sz);
1100                grab_person("author", val, deref, obj, buf, sz);
1101                grab_person("committer", val, deref, obj, buf, sz);
1102                break;
1103        case OBJ_TREE:
1104                /* grab_tree_values(val, deref, obj, buf, sz); */
1105                break;
1106        case OBJ_BLOB:
1107                /* grab_blob_values(val, deref, obj, buf, sz); */
1108                break;
1109        default:
1110                die("Eh?  Object of type %d?", obj->type);
1111        }
1112}
1113
1114static inline char *copy_advance(char *dst, const char *src)
1115{
1116        while (*src)
1117                *dst++ = *src++;
1118        return dst;
1119}
1120
1121static const char *lstrip_ref_components(const char *refname, int len)
1122{
1123        long remaining = len;
1124        const char *start = refname;
1125
1126        if (len < 0) {
1127                int i;
1128                const char *p = refname;
1129
1130                /* Find total no of '/' separated path-components */
1131                for (i = 0; p[i]; p[i] == '/' ? i++ : *p++)
1132                        ;
1133                /*
1134                 * The number of components we need to strip is now
1135                 * the total minus the components to be left (Plus one
1136                 * because we count the number of '/', but the number
1137                 * of components is one more than the no of '/').
1138                 */
1139                remaining = i + len + 1;
1140        }
1141
1142        while (remaining > 0) {
1143                switch (*start++) {
1144                case '\0':
1145                        return "";
1146                case '/':
1147                        remaining--;
1148                        break;
1149                }
1150        }
1151
1152        return start;
1153}
1154
1155static const char *rstrip_ref_components(const char *refname, int len)
1156{
1157        long remaining = len;
1158        char *start = xstrdup(refname);
1159
1160        if (len < 0) {
1161                int i;
1162                const char *p = refname;
1163
1164                /* Find total no of '/' separated path-components */
1165                for (i = 0; p[i]; p[i] == '/' ? i++ : *p++)
1166                        ;
1167                /*
1168                 * The number of components we need to strip is now
1169                 * the total minus the components to be left (Plus one
1170                 * because we count the number of '/', but the number
1171                 * of components is one more than the no of '/').
1172                 */
1173                remaining = i + len + 1;
1174        }
1175
1176        while (remaining-- > 0) {
1177                char *p = strrchr(start, '/');
1178                if (p == NULL)
1179                        return "";
1180                else
1181                        p[0] = '\0';
1182        }
1183        return start;
1184}
1185
1186static const char *show_ref(struct refname_atom *atom, const char *refname)
1187{
1188        if (atom->option == R_SHORT)
1189                return shorten_unambiguous_ref(refname, warn_ambiguous_refs);
1190        else if (atom->option == R_LSTRIP)
1191                return lstrip_ref_components(refname, atom->lstrip);
1192        else if (atom->option == R_RSTRIP)
1193                return rstrip_ref_components(refname, atom->rstrip);
1194        else
1195                return refname;
1196}
1197
1198static void fill_remote_ref_details(struct used_atom *atom, const char *refname,
1199                                    struct branch *branch, const char **s)
1200{
1201        int num_ours, num_theirs;
1202        if (atom->u.remote_ref.option == RR_REF)
1203                *s = show_ref(&atom->u.remote_ref.refname, refname);
1204        else if (atom->u.remote_ref.option == RR_TRACK) {
1205                if (stat_tracking_info(branch, &num_ours,
1206                                       &num_theirs, NULL)) {
1207                        *s = xstrdup(msgs.gone);
1208                } else if (!num_ours && !num_theirs)
1209                        *s = "";
1210                else if (!num_ours)
1211                        *s = xstrfmt(msgs.behind, num_theirs);
1212                else if (!num_theirs)
1213                        *s = xstrfmt(msgs.ahead, num_ours);
1214                else
1215                        *s = xstrfmt(msgs.ahead_behind,
1216                                     num_ours, num_theirs);
1217                if (!atom->u.remote_ref.nobracket && *s[0]) {
1218                        const char *to_free = *s;
1219                        *s = xstrfmt("[%s]", *s);
1220                        free((void *)to_free);
1221                }
1222        } else if (atom->u.remote_ref.option == RR_TRACKSHORT) {
1223                if (stat_tracking_info(branch, &num_ours,
1224                                       &num_theirs, NULL))
1225                        return;
1226
1227                if (!num_ours && !num_theirs)
1228                        *s = "=";
1229                else if (!num_ours)
1230                        *s = "<";
1231                else if (!num_theirs)
1232                        *s = ">";
1233                else
1234                        *s = "<>";
1235        } else
1236                die("BUG: unhandled RR_* enum");
1237}
1238
1239char *get_head_description(void)
1240{
1241        struct strbuf desc = STRBUF_INIT;
1242        struct wt_status_state state;
1243        memset(&state, 0, sizeof(state));
1244        wt_status_get_state(&state, 1);
1245        if (state.rebase_in_progress ||
1246            state.rebase_interactive_in_progress)
1247                strbuf_addf(&desc, _("(no branch, rebasing %s)"),
1248                            state.branch);
1249        else if (state.bisect_in_progress)
1250                strbuf_addf(&desc, _("(no branch, bisect started on %s)"),
1251                            state.branch);
1252        else if (state.detached_from) {
1253                if (state.detached_at)
1254                        /* TRANSLATORS: make sure this matches
1255                           "HEAD detached at " in wt-status.c */
1256                        strbuf_addf(&desc, _("(HEAD detached at %s)"),
1257                                state.detached_from);
1258                else
1259                        /* TRANSLATORS: make sure this matches
1260                           "HEAD detached from " in wt-status.c */
1261                        strbuf_addf(&desc, _("(HEAD detached from %s)"),
1262                                state.detached_from);
1263        }
1264        else
1265                strbuf_addstr(&desc, _("(no branch)"));
1266        free(state.branch);
1267        free(state.onto);
1268        free(state.detached_from);
1269        return strbuf_detach(&desc, NULL);
1270}
1271
1272static const char *get_symref(struct used_atom *atom, struct ref_array_item *ref)
1273{
1274        if (!ref->symref)
1275                return "";
1276        else
1277                return show_ref(&atom->u.refname, ref->symref);
1278}
1279
1280static const char *get_refname(struct used_atom *atom, struct ref_array_item *ref)
1281{
1282        if (ref->kind & FILTER_REFS_DETACHED_HEAD)
1283                return get_head_description();
1284        return show_ref(&atom->u.refname, ref->refname);
1285}
1286
1287/*
1288 * Parse the object referred by ref, and grab needed value.
1289 */
1290static void populate_value(struct ref_array_item *ref)
1291{
1292        void *buf;
1293        struct object *obj;
1294        int eaten, i;
1295        unsigned long size;
1296        const unsigned char *tagged;
1297
1298        ref->value = xcalloc(used_atom_cnt, sizeof(struct atom_value));
1299
1300        if (need_symref && (ref->flag & REF_ISSYMREF) && !ref->symref) {
1301                struct object_id unused1;
1302                ref->symref = resolve_refdup(ref->refname, RESOLVE_REF_READING,
1303                                             unused1.hash, NULL);
1304                if (!ref->symref)
1305                        ref->symref = "";
1306        }
1307
1308        /* Fill in specials first */
1309        for (i = 0; i < used_atom_cnt; i++) {
1310                struct used_atom *atom = &used_atom[i];
1311                const char *name = used_atom[i].name;
1312                struct atom_value *v = &ref->value[i];
1313                int deref = 0;
1314                const char *refname;
1315                struct branch *branch = NULL;
1316
1317                v->handler = append_atom;
1318                v->atom = atom;
1319
1320                if (*name == '*') {
1321                        deref = 1;
1322                        name++;
1323                }
1324
1325                if (starts_with(name, "refname"))
1326                        refname = get_refname(atom, ref);
1327                else if (starts_with(name, "symref"))
1328                        refname = get_symref(atom, ref);
1329                else if (starts_with(name, "upstream")) {
1330                        const char *branch_name;
1331                        /* only local branches may have an upstream */
1332                        if (!skip_prefix(ref->refname, "refs/heads/",
1333                                         &branch_name))
1334                                continue;
1335                        branch = branch_get(branch_name);
1336
1337                        refname = branch_get_upstream(branch, NULL);
1338                        if (refname)
1339                                fill_remote_ref_details(atom, refname, branch, &v->s);
1340                        continue;
1341                } else if (starts_with(name, "push")) {
1342                        const char *branch_name;
1343                        if (!skip_prefix(ref->refname, "refs/heads/",
1344                                         &branch_name))
1345                                continue;
1346                        branch = branch_get(branch_name);
1347
1348                        refname = branch_get_push(branch, NULL);
1349                        if (!refname)
1350                                continue;
1351                        fill_remote_ref_details(atom, refname, branch, &v->s);
1352                        continue;
1353                } else if (starts_with(name, "color:")) {
1354                        v->s = atom->u.color;
1355                        continue;
1356                } else if (!strcmp(name, "flag")) {
1357                        char buf[256], *cp = buf;
1358                        if (ref->flag & REF_ISSYMREF)
1359                                cp = copy_advance(cp, ",symref");
1360                        if (ref->flag & REF_ISPACKED)
1361                                cp = copy_advance(cp, ",packed");
1362                        if (cp == buf)
1363                                v->s = "";
1364                        else {
1365                                *cp = '\0';
1366                                v->s = xstrdup(buf + 1);
1367                        }
1368                        continue;
1369                } else if (!deref && grab_objectname(name, ref->objectname, v, atom)) {
1370                        continue;
1371                } else if (!strcmp(name, "HEAD")) {
1372                        const char *head;
1373                        unsigned char sha1[20];
1374
1375                        head = resolve_ref_unsafe("HEAD", RESOLVE_REF_READING,
1376                                                  sha1, NULL);
1377                        if (head && !strcmp(ref->refname, head))
1378                                v->s = "*";
1379                        else
1380                                v->s = " ";
1381                        continue;
1382                } else if (starts_with(name, "align")) {
1383                        v->handler = align_atom_handler;
1384                        continue;
1385                } else if (!strcmp(name, "end")) {
1386                        v->handler = end_atom_handler;
1387                        continue;
1388                } else if (starts_with(name, "if")) {
1389                        const char *s;
1390
1391                        if (skip_prefix(name, "if:", &s))
1392                                v->s = xstrdup(s);
1393                        v->handler = if_atom_handler;
1394                        continue;
1395                } else if (!strcmp(name, "then")) {
1396                        v->handler = then_atom_handler;
1397                        continue;
1398                } else if (!strcmp(name, "else")) {
1399                        v->handler = else_atom_handler;
1400                        continue;
1401                } else
1402                        continue;
1403
1404                if (!deref)
1405                        v->s = refname;
1406                else
1407                        v->s = xstrfmt("%s^{}", refname);
1408        }
1409
1410        for (i = 0; i < used_atom_cnt; i++) {
1411                struct atom_value *v = &ref->value[i];
1412                if (v->s == NULL)
1413                        goto need_obj;
1414        }
1415        return;
1416
1417 need_obj:
1418        buf = get_obj(ref->objectname, &obj, &size, &eaten);
1419        if (!buf)
1420                die(_("missing object %s for %s"),
1421                    sha1_to_hex(ref->objectname), ref->refname);
1422        if (!obj)
1423                die(_("parse_object_buffer failed on %s for %s"),
1424                    sha1_to_hex(ref->objectname), ref->refname);
1425
1426        grab_values(ref->value, 0, obj, buf, size);
1427        if (!eaten)
1428                free(buf);
1429
1430        /*
1431         * If there is no atom that wants to know about tagged
1432         * object, we are done.
1433         */
1434        if (!need_tagged || (obj->type != OBJ_TAG))
1435                return;
1436
1437        /*
1438         * If it is a tag object, see if we use a value that derefs
1439         * the object, and if we do grab the object it refers to.
1440         */
1441        tagged = ((struct tag *)obj)->tagged->oid.hash;
1442
1443        /*
1444         * NEEDSWORK: This derefs tag only once, which
1445         * is good to deal with chains of trust, but
1446         * is not consistent with what deref_tag() does
1447         * which peels the onion to the core.
1448         */
1449        buf = get_obj(tagged, &obj, &size, &eaten);
1450        if (!buf)
1451                die(_("missing object %s for %s"),
1452                    sha1_to_hex(tagged), ref->refname);
1453        if (!obj)
1454                die(_("parse_object_buffer failed on %s for %s"),
1455                    sha1_to_hex(tagged), ref->refname);
1456        grab_values(ref->value, 1, obj, buf, size);
1457        if (!eaten)
1458                free(buf);
1459}
1460
1461/*
1462 * Given a ref, return the value for the atom.  This lazily gets value
1463 * out of the object by calling populate value.
1464 */
1465static void get_ref_atom_value(struct ref_array_item *ref, int atom, struct atom_value **v)
1466{
1467        if (!ref->value) {
1468                populate_value(ref);
1469                fill_missing_values(ref->value);
1470        }
1471        *v = &ref->value[atom];
1472}
1473
1474/*
1475 * Unknown has to be "0" here, because that's the default value for
1476 * contains_cache slab entries that have not yet been assigned.
1477 */
1478enum contains_result {
1479        CONTAINS_UNKNOWN = 0,
1480        CONTAINS_NO,
1481        CONTAINS_YES
1482};
1483
1484define_commit_slab(contains_cache, enum contains_result);
1485
1486struct ref_filter_cbdata {
1487        struct ref_array *array;
1488        struct ref_filter *filter;
1489        struct contains_cache contains_cache;
1490};
1491
1492/*
1493 * Mimicking the real stack, this stack lives on the heap, avoiding stack
1494 * overflows.
1495 *
1496 * At each recursion step, the stack items points to the commits whose
1497 * ancestors are to be inspected.
1498 */
1499struct contains_stack {
1500        int nr, alloc;
1501        struct contains_stack_entry {
1502                struct commit *commit;
1503                struct commit_list *parents;
1504        } *contains_stack;
1505};
1506
1507static int in_commit_list(const struct commit_list *want, struct commit *c)
1508{
1509        for (; want; want = want->next)
1510                if (!oidcmp(&want->item->object.oid, &c->object.oid))
1511                        return 1;
1512        return 0;
1513}
1514
1515/*
1516 * Test whether the candidate or one of its parents is contained in the list.
1517 * Do not recurse to find out, though, but return -1 if inconclusive.
1518 */
1519static enum contains_result contains_test(struct commit *candidate,
1520                                          const struct commit_list *want,
1521                                          struct contains_cache *cache)
1522{
1523        enum contains_result *cached = contains_cache_at(cache, candidate);
1524
1525        /* If we already have the answer cached, return that. */
1526        if (*cached)
1527                return *cached;
1528
1529        /* or are we it? */
1530        if (in_commit_list(want, candidate)) {
1531                *cached = CONTAINS_YES;
1532                return CONTAINS_YES;
1533        }
1534
1535        /* Otherwise, we don't know; prepare to recurse */
1536        parse_commit_or_die(candidate);
1537        return CONTAINS_UNKNOWN;
1538}
1539
1540static void push_to_contains_stack(struct commit *candidate, struct contains_stack *contains_stack)
1541{
1542        ALLOC_GROW(contains_stack->contains_stack, contains_stack->nr + 1, contains_stack->alloc);
1543        contains_stack->contains_stack[contains_stack->nr].commit = candidate;
1544        contains_stack->contains_stack[contains_stack->nr++].parents = candidate->parents;
1545}
1546
1547static enum contains_result contains_tag_algo(struct commit *candidate,
1548                                              const struct commit_list *want,
1549                                              struct contains_cache *cache)
1550{
1551        struct contains_stack contains_stack = { 0, 0, NULL };
1552        enum contains_result result = contains_test(candidate, want, cache);
1553
1554        if (result != CONTAINS_UNKNOWN)
1555                return result;
1556
1557        push_to_contains_stack(candidate, &contains_stack);
1558        while (contains_stack.nr) {
1559                struct contains_stack_entry *entry = &contains_stack.contains_stack[contains_stack.nr - 1];
1560                struct commit *commit = entry->commit;
1561                struct commit_list *parents = entry->parents;
1562
1563                if (!parents) {
1564                        *contains_cache_at(cache, commit) = CONTAINS_NO;
1565                        contains_stack.nr--;
1566                }
1567                /*
1568                 * If we just popped the stack, parents->item has been marked,
1569                 * therefore contains_test will return a meaningful yes/no.
1570                 */
1571                else switch (contains_test(parents->item, want, cache)) {
1572                case CONTAINS_YES:
1573                        *contains_cache_at(cache, commit) = CONTAINS_YES;
1574                        contains_stack.nr--;
1575                        break;
1576                case CONTAINS_NO:
1577                        entry->parents = parents->next;
1578                        break;
1579                case CONTAINS_UNKNOWN:
1580                        push_to_contains_stack(parents->item, &contains_stack);
1581                        break;
1582                }
1583        }
1584        free(contains_stack.contains_stack);
1585        return contains_test(candidate, want, cache);
1586}
1587
1588static int commit_contains(struct ref_filter *filter, struct commit *commit,
1589                           struct contains_cache *cache)
1590{
1591        if (filter->with_commit_tag_algo)
1592                return contains_tag_algo(commit, filter->with_commit, cache) == CONTAINS_YES;
1593        return is_descendant_of(commit, filter->with_commit);
1594}
1595
1596/*
1597 * Return 1 if the refname matches one of the patterns, otherwise 0.
1598 * A pattern can be a literal prefix (e.g. a refname "refs/heads/master"
1599 * matches a pattern "refs/heads/mas") or a wildcard (e.g. the same ref
1600 * matches "refs/heads/mas*", too).
1601 */
1602static int match_pattern(const struct ref_filter *filter, const char *refname)
1603{
1604        const char **patterns = filter->name_patterns;
1605        unsigned flags = 0;
1606
1607        if (filter->ignore_case)
1608                flags |= WM_CASEFOLD;
1609
1610        /*
1611         * When no '--format' option is given we need to skip the prefix
1612         * for matching refs of tags and branches.
1613         */
1614        (void)(skip_prefix(refname, "refs/tags/", &refname) ||
1615               skip_prefix(refname, "refs/heads/", &refname) ||
1616               skip_prefix(refname, "refs/remotes/", &refname) ||
1617               skip_prefix(refname, "refs/", &refname));
1618
1619        for (; *patterns; patterns++) {
1620                if (!wildmatch(*patterns, refname, flags, NULL))
1621                        return 1;
1622        }
1623        return 0;
1624}
1625
1626/*
1627 * Return 1 if the refname matches one of the patterns, otherwise 0.
1628 * A pattern can be path prefix (e.g. a refname "refs/heads/master"
1629 * matches a pattern "refs/heads/" but not "refs/heads/m") or a
1630 * wildcard (e.g. the same ref matches "refs/heads/m*", too).
1631 */
1632static int match_name_as_path(const struct ref_filter *filter, const char *refname)
1633{
1634        const char **pattern = filter->name_patterns;
1635        int namelen = strlen(refname);
1636        unsigned flags = WM_PATHNAME;
1637
1638        if (filter->ignore_case)
1639                flags |= WM_CASEFOLD;
1640
1641        for (; *pattern; pattern++) {
1642                const char *p = *pattern;
1643                int plen = strlen(p);
1644
1645                if ((plen <= namelen) &&
1646                    !strncmp(refname, p, plen) &&
1647                    (refname[plen] == '\0' ||
1648                     refname[plen] == '/' ||
1649                     p[plen-1] == '/'))
1650                        return 1;
1651                if (!wildmatch(p, refname, WM_PATHNAME, NULL))
1652                        return 1;
1653        }
1654        return 0;
1655}
1656
1657/* Return 1 if the refname matches one of the patterns, otherwise 0. */
1658static int filter_pattern_match(struct ref_filter *filter, const char *refname)
1659{
1660        if (!*filter->name_patterns)
1661                return 1; /* No pattern always matches */
1662        if (filter->match_as_path)
1663                return match_name_as_path(filter, refname);
1664        return match_pattern(filter, refname);
1665}
1666
1667/*
1668 * Given a ref (sha1, refname), check if the ref belongs to the array
1669 * of sha1s. If the given ref is a tag, check if the given tag points
1670 * at one of the sha1s in the given sha1 array.
1671 * the given sha1_array.
1672 * NEEDSWORK:
1673 * 1. Only a single level of inderection is obtained, we might want to
1674 * change this to account for multiple levels (e.g. annotated tags
1675 * pointing to annotated tags pointing to a commit.)
1676 * 2. As the refs are cached we might know what refname peels to without
1677 * the need to parse the object via parse_object(). peel_ref() might be a
1678 * more efficient alternative to obtain the pointee.
1679 */
1680static const unsigned char *match_points_at(struct sha1_array *points_at,
1681                                            const unsigned char *sha1,
1682                                            const char *refname)
1683{
1684        const unsigned char *tagged_sha1 = NULL;
1685        struct object *obj;
1686
1687        if (sha1_array_lookup(points_at, sha1) >= 0)
1688                return sha1;
1689        obj = parse_object(sha1);
1690        if (!obj)
1691                die(_("malformed object at '%s'"), refname);
1692        if (obj->type == OBJ_TAG)
1693                tagged_sha1 = ((struct tag *)obj)->tagged->oid.hash;
1694        if (tagged_sha1 && sha1_array_lookup(points_at, tagged_sha1) >= 0)
1695                return tagged_sha1;
1696        return NULL;
1697}
1698
1699/* Allocate space for a new ref_array_item and copy the objectname and flag to it */
1700static struct ref_array_item *new_ref_array_item(const char *refname,
1701                                                 const unsigned char *objectname,
1702                                                 int flag)
1703{
1704        struct ref_array_item *ref;
1705        FLEX_ALLOC_STR(ref, refname, refname);
1706        hashcpy(ref->objectname, objectname);
1707        ref->flag = flag;
1708
1709        return ref;
1710}
1711
1712static int ref_kind_from_refname(const char *refname)
1713{
1714        unsigned int i;
1715
1716        static struct {
1717                const char *prefix;
1718                unsigned int kind;
1719        } ref_kind[] = {
1720                { "refs/heads/" , FILTER_REFS_BRANCHES },
1721                { "refs/remotes/" , FILTER_REFS_REMOTES },
1722                { "refs/tags/", FILTER_REFS_TAGS}
1723        };
1724
1725        if (!strcmp(refname, "HEAD"))
1726                return FILTER_REFS_DETACHED_HEAD;
1727
1728        for (i = 0; i < ARRAY_SIZE(ref_kind); i++) {
1729                if (starts_with(refname, ref_kind[i].prefix))
1730                        return ref_kind[i].kind;
1731        }
1732
1733        return FILTER_REFS_OTHERS;
1734}
1735
1736static int filter_ref_kind(struct ref_filter *filter, const char *refname)
1737{
1738        if (filter->kind == FILTER_REFS_BRANCHES ||
1739            filter->kind == FILTER_REFS_REMOTES ||
1740            filter->kind == FILTER_REFS_TAGS)
1741                return filter->kind;
1742        return ref_kind_from_refname(refname);
1743}
1744
1745/*
1746 * A call-back given to for_each_ref().  Filter refs and keep them for
1747 * later object processing.
1748 */
1749static int ref_filter_handler(const char *refname, const struct object_id *oid, int flag, void *cb_data)
1750{
1751        struct ref_filter_cbdata *ref_cbdata = cb_data;
1752        struct ref_filter *filter = ref_cbdata->filter;
1753        struct ref_array_item *ref;
1754        struct commit *commit = NULL;
1755        unsigned int kind;
1756
1757        if (flag & REF_BAD_NAME) {
1758                warning(_("ignoring ref with broken name %s"), refname);
1759                return 0;
1760        }
1761
1762        if (flag & REF_ISBROKEN) {
1763                warning(_("ignoring broken ref %s"), refname);
1764                return 0;
1765        }
1766
1767        /* Obtain the current ref kind from filter_ref_kind() and ignore unwanted refs. */
1768        kind = filter_ref_kind(filter, refname);
1769        if (!(kind & filter->kind))
1770                return 0;
1771
1772        if (!filter_pattern_match(filter, refname))
1773                return 0;
1774
1775        if (filter->points_at.nr && !match_points_at(&filter->points_at, oid->hash, refname))
1776                return 0;
1777
1778        /*
1779         * A merge filter is applied on refs pointing to commits. Hence
1780         * obtain the commit using the 'oid' available and discard all
1781         * non-commits early. The actual filtering is done later.
1782         */
1783        if (filter->merge_commit || filter->with_commit || filter->verbose) {
1784                commit = lookup_commit_reference_gently(oid->hash, 1);
1785                if (!commit)
1786                        return 0;
1787                /* We perform the filtering for the '--contains' option */
1788                if (filter->with_commit &&
1789                    !commit_contains(filter, commit, &ref_cbdata->contains_cache))
1790                        return 0;
1791        }
1792
1793        /*
1794         * We do not open the object yet; sort may only need refname
1795         * to do its job and the resulting list may yet to be pruned
1796         * by maxcount logic.
1797         */
1798        ref = new_ref_array_item(refname, oid->hash, flag);
1799        ref->commit = commit;
1800
1801        REALLOC_ARRAY(ref_cbdata->array->items, ref_cbdata->array->nr + 1);
1802        ref_cbdata->array->items[ref_cbdata->array->nr++] = ref;
1803        ref->kind = kind;
1804        return 0;
1805}
1806
1807/*  Free memory allocated for a ref_array_item */
1808static void free_array_item(struct ref_array_item *item)
1809{
1810        free((char *)item->symref);
1811        free(item);
1812}
1813
1814/* Free all memory allocated for ref_array */
1815void ref_array_clear(struct ref_array *array)
1816{
1817        int i;
1818
1819        for (i = 0; i < array->nr; i++)
1820                free_array_item(array->items[i]);
1821        free(array->items);
1822        array->items = NULL;
1823        array->nr = array->alloc = 0;
1824}
1825
1826static void do_merge_filter(struct ref_filter_cbdata *ref_cbdata)
1827{
1828        struct rev_info revs;
1829        int i, old_nr;
1830        struct ref_filter *filter = ref_cbdata->filter;
1831        struct ref_array *array = ref_cbdata->array;
1832        struct commit **to_clear = xcalloc(sizeof(struct commit *), array->nr);
1833
1834        init_revisions(&revs, NULL);
1835
1836        for (i = 0; i < array->nr; i++) {
1837                struct ref_array_item *item = array->items[i];
1838                add_pending_object(&revs, &item->commit->object, item->refname);
1839                to_clear[i] = item->commit;
1840        }
1841
1842        filter->merge_commit->object.flags |= UNINTERESTING;
1843        add_pending_object(&revs, &filter->merge_commit->object, "");
1844
1845        revs.limited = 1;
1846        if (prepare_revision_walk(&revs))
1847                die(_("revision walk setup failed"));
1848
1849        old_nr = array->nr;
1850        array->nr = 0;
1851
1852        for (i = 0; i < old_nr; i++) {
1853                struct ref_array_item *item = array->items[i];
1854                struct commit *commit = item->commit;
1855
1856                int is_merged = !!(commit->object.flags & UNINTERESTING);
1857
1858                if (is_merged == (filter->merge == REF_FILTER_MERGED_INCLUDE))
1859                        array->items[array->nr++] = array->items[i];
1860                else
1861                        free_array_item(item);
1862        }
1863
1864        for (i = 0; i < old_nr; i++)
1865                clear_commit_marks(to_clear[i], ALL_REV_FLAGS);
1866        clear_commit_marks(filter->merge_commit, ALL_REV_FLAGS);
1867        free(to_clear);
1868}
1869
1870/*
1871 * API for filtering a set of refs. Based on the type of refs the user
1872 * has requested, we iterate through those refs and apply filters
1873 * as per the given ref_filter structure and finally store the
1874 * filtered refs in the ref_array structure.
1875 */
1876int filter_refs(struct ref_array *array, struct ref_filter *filter, unsigned int type)
1877{
1878        struct ref_filter_cbdata ref_cbdata;
1879        int ret = 0;
1880        unsigned int broken = 0;
1881
1882        ref_cbdata.array = array;
1883        ref_cbdata.filter = filter;
1884
1885        if (type & FILTER_REFS_INCLUDE_BROKEN)
1886                broken = 1;
1887        filter->kind = type & FILTER_REFS_KIND_MASK;
1888
1889        init_contains_cache(&ref_cbdata.contains_cache);
1890
1891        /*  Simple per-ref filtering */
1892        if (!filter->kind)
1893                die("filter_refs: invalid type");
1894        else {
1895                /*
1896                 * For common cases where we need only branches or remotes or tags,
1897                 * we only iterate through those refs. If a mix of refs is needed,
1898                 * we iterate over all refs and filter out required refs with the help
1899                 * of filter_ref_kind().
1900                 */
1901                if (filter->kind == FILTER_REFS_BRANCHES)
1902                        ret = for_each_fullref_in("refs/heads/", ref_filter_handler, &ref_cbdata, broken);
1903                else if (filter->kind == FILTER_REFS_REMOTES)
1904                        ret = for_each_fullref_in("refs/remotes/", ref_filter_handler, &ref_cbdata, broken);
1905                else if (filter->kind == FILTER_REFS_TAGS)
1906                        ret = for_each_fullref_in("refs/tags/", ref_filter_handler, &ref_cbdata, broken);
1907                else if (filter->kind & FILTER_REFS_ALL)
1908                        ret = for_each_fullref_in("", ref_filter_handler, &ref_cbdata, broken);
1909                if (!ret && (filter->kind & FILTER_REFS_DETACHED_HEAD))
1910                        head_ref(ref_filter_handler, &ref_cbdata);
1911        }
1912
1913        clear_contains_cache(&ref_cbdata.contains_cache);
1914
1915        /*  Filters that need revision walking */
1916        if (filter->merge_commit)
1917                do_merge_filter(&ref_cbdata);
1918
1919        return ret;
1920}
1921
1922static int cmp_ref_sorting(struct ref_sorting *s, struct ref_array_item *a, struct ref_array_item *b)
1923{
1924        struct atom_value *va, *vb;
1925        int cmp;
1926        cmp_type cmp_type = used_atom[s->atom].type;
1927        int (*cmp_fn)(const char *, const char *);
1928
1929        get_ref_atom_value(a, s->atom, &va);
1930        get_ref_atom_value(b, s->atom, &vb);
1931        cmp_fn = s->ignore_case ? strcasecmp : strcmp;
1932        if (s->version)
1933                cmp = versioncmp(va->s, vb->s);
1934        else if (cmp_type == FIELD_STR)
1935                cmp = cmp_fn(va->s, vb->s);
1936        else {
1937                if (va->ul < vb->ul)
1938                        cmp = -1;
1939                else if (va->ul == vb->ul)
1940                        cmp = cmp_fn(a->refname, b->refname);
1941                else
1942                        cmp = 1;
1943        }
1944
1945        return (s->reverse) ? -cmp : cmp;
1946}
1947
1948static int compare_refs(const void *a_, const void *b_, void *ref_sorting)
1949{
1950        struct ref_array_item *a = *((struct ref_array_item **)a_);
1951        struct ref_array_item *b = *((struct ref_array_item **)b_);
1952        struct ref_sorting *s;
1953
1954        for (s = ref_sorting; s; s = s->next) {
1955                int cmp = cmp_ref_sorting(s, a, b);
1956                if (cmp)
1957                        return cmp;
1958        }
1959        return 0;
1960}
1961
1962void ref_array_sort(struct ref_sorting *sorting, struct ref_array *array)
1963{
1964        QSORT_S(array->items, array->nr, compare_refs, sorting);
1965}
1966
1967static void append_literal(const char *cp, const char *ep, struct ref_formatting_state *state)
1968{
1969        struct strbuf *s = &state->stack->output;
1970
1971        while (*cp && (!ep || cp < ep)) {
1972                if (*cp == '%') {
1973                        if (cp[1] == '%')
1974                                cp++;
1975                        else {
1976                                int ch = hex2chr(cp + 1);
1977                                if (0 <= ch) {
1978                                        strbuf_addch(s, ch);
1979                                        cp += 3;
1980                                        continue;
1981                                }
1982                        }
1983                }
1984                strbuf_addch(s, *cp);
1985                cp++;
1986        }
1987}
1988
1989void format_ref_array_item(struct ref_array_item *info, const char *format,
1990                           int quote_style, struct strbuf *final_buf)
1991{
1992        const char *cp, *sp, *ep;
1993        struct ref_formatting_state state = REF_FORMATTING_STATE_INIT;
1994
1995        state.quote_style = quote_style;
1996        push_stack_element(&state.stack);
1997
1998        for (cp = format; *cp && (sp = find_next(cp)); cp = ep + 1) {
1999                struct atom_value *atomv;
2000
2001                ep = strchr(sp, ')');
2002                if (cp < sp)
2003                        append_literal(cp, sp, &state);
2004                get_ref_atom_value(info, parse_ref_filter_atom(sp + 2, ep), &atomv);
2005                atomv->handler(atomv, &state);
2006        }
2007        if (*cp) {
2008                sp = cp + strlen(cp);
2009                append_literal(cp, sp, &state);
2010        }
2011        if (need_color_reset_at_eol) {
2012                struct atom_value resetv;
2013                char color[COLOR_MAXLEN] = "";
2014
2015                if (color_parse("reset", color) < 0)
2016                        die("BUG: couldn't parse 'reset' as a color");
2017                resetv.s = color;
2018                append_atom(&resetv, &state);
2019        }
2020        if (state.stack->prev)
2021                die(_("format: %%(end) atom missing"));
2022        strbuf_addbuf(final_buf, &state.stack->output);
2023        pop_stack_element(&state.stack);
2024}
2025
2026void show_ref_array_item(struct ref_array_item *info, const char *format, int quote_style)
2027{
2028        struct strbuf final_buf = STRBUF_INIT;
2029
2030        format_ref_array_item(info, format, quote_style, &final_buf);
2031        fwrite(final_buf.buf, 1, final_buf.len, stdout);
2032        strbuf_release(&final_buf);
2033        putchar('\n');
2034}
2035
2036void pretty_print_ref(const char *name, const unsigned char *sha1,
2037                const char *format)
2038{
2039        struct ref_array_item *ref_item;
2040        ref_item = new_ref_array_item(name, sha1, 0);
2041        ref_item->kind = ref_kind_from_refname(name);
2042        show_ref_array_item(ref_item, format, 0);
2043        free_array_item(ref_item);
2044}
2045
2046/*  If no sorting option is given, use refname to sort as default */
2047struct ref_sorting *ref_default_sorting(void)
2048{
2049        static const char cstr_name[] = "refname";
2050
2051        struct ref_sorting *sorting = xcalloc(1, sizeof(*sorting));
2052
2053        sorting->next = NULL;
2054        sorting->atom = parse_ref_filter_atom(cstr_name, cstr_name + strlen(cstr_name));
2055        return sorting;
2056}
2057
2058int parse_opt_ref_sorting(const struct option *opt, const char *arg, int unset)
2059{
2060        struct ref_sorting **sorting_tail = opt->value;
2061        struct ref_sorting *s;
2062        int len;
2063
2064        if (!arg) /* should --no-sort void the list ? */
2065                return -1;
2066
2067        s = xcalloc(1, sizeof(*s));
2068        s->next = *sorting_tail;
2069        *sorting_tail = s;
2070
2071        if (*arg == '-') {
2072                s->reverse = 1;
2073                arg++;
2074        }
2075        if (skip_prefix(arg, "version:", &arg) ||
2076            skip_prefix(arg, "v:", &arg))
2077                s->version = 1;
2078        len = strlen(arg);
2079        s->atom = parse_ref_filter_atom(arg, arg+len);
2080        return 0;
2081}
2082
2083int parse_opt_merge_filter(const struct option *opt, const char *arg, int unset)
2084{
2085        struct ref_filter *rf = opt->value;
2086        unsigned char sha1[20];
2087
2088        rf->merge = starts_with(opt->long_name, "no")
2089                ? REF_FILTER_MERGED_OMIT
2090                : REF_FILTER_MERGED_INCLUDE;
2091
2092        if (get_sha1(arg, sha1))
2093                die(_("malformed object name %s"), arg);
2094
2095        rf->merge_commit = lookup_commit_reference_gently(sha1, 0);
2096        if (!rf->merge_commit)
2097                return opterror(opt, "must point to a commit", 0);
2098
2099        return 0;
2100}