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