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