git.oblomov.eu Git - git/blob - ref-filter.c

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