3 #include "parse-options.h"
6 #include "object-store.h"
7 #include "repository.h"
13 #include "ref-filter.h"
16 #include "git-compat-util.h"
19 #include "wt-status.h"
20 #include "commit-slab.h"
21 #include "commit-graph.h"
22 #include "commit-reach.h"
27 static struct ref_msg
{
31 const char *ahead_behind
;
33 /* Untranslated plumbing messages: */
40 void setup_ref_filter_porcelain_msg(void)
42 msgs
.gone
= _("gone");
43 msgs
.ahead
= _("ahead %d");
44 msgs
.behind
= _("behind %d");
45 msgs
.ahead_behind
= _("ahead %d, behind %d");
48 typedef enum { FIELD_STR
, FIELD_ULONG
, FIELD_TIME
} cmp_type
;
49 typedef enum { COMPARE_EQUAL
, COMPARE_UNEQUAL
, COMPARE_NONE
} cmp_status
;
50 typedef enum { SOURCE_NONE
= 0, SOURCE_OBJ
, SOURCE_OTHER
} info_source
;
58 cmp_status cmp_status
;
60 unsigned int then_atom_seen
: 1,
62 condition_satisfied
: 1;
66 enum { R_NORMAL
, R_SHORT
, R_LSTRIP
, R_RSTRIP
} option
;
70 static struct ref_trailer_buf
{
71 struct string_list filter_list
;
73 struct strbuf kvsepbuf
;
74 } ref_trailer_buf
= {STRING_LIST_INIT_NODUP
, STRBUF_INIT
, STRBUF_INIT
};
76 static struct expand_data
{
78 enum object_type type
;
81 struct object_id delta_base_oid
;
84 struct object_info info
;
87 struct ref_to_worktree_entry
{
88 struct hashmap_entry ent
;
89 struct worktree
*wt
; /* key is wt->head_ref */
92 static int ref_to_worktree_map_cmpfnc(const void *unused_lookupdata
,
93 const struct hashmap_entry
*eptr
,
94 const struct hashmap_entry
*kptr
,
95 const void *keydata_aka_refname
)
97 const struct ref_to_worktree_entry
*e
, *k
;
99 e
= container_of(eptr
, const struct ref_to_worktree_entry
, ent
);
100 k
= container_of(kptr
, const struct ref_to_worktree_entry
, ent
);
102 return strcmp(e
->wt
->head_ref
,
103 keydata_aka_refname
? keydata_aka_refname
: k
->wt
->head_ref
);
106 static struct ref_to_worktree_map
{
108 struct worktree
**worktrees
;
109 } ref_to_worktree_map
;
112 * The enum atom_type is used as the index of valid_atom array.
113 * In the atom parsing stage, it will be passed to used_atom.atom_type
114 * as the identifier of the atom type. We can check the type of used_atom
115 * entry by `if (used_atom[i].atom_type == ATOM_*)`.
164 * An atom is a valid field atom listed below, possibly prefixed with
165 * a "*" to denote deref_tag().
167 * We parse given format string and sort specifiers, and make a list
168 * of properties that we need to extract out of objects. ref_array_item
169 * structure will hold an array of values extracted that can be
170 * indexed with the "atom number", which is an index into this
173 static struct used_atom
{
174 enum atom_type atom_type
;
179 char color
[COLOR_MAXLEN
];
183 RR_REF
, RR_TRACK
, RR_TRACKSHORT
, RR_REMOTE_NAME
, RR_REMOTE_REF
185 struct refname_atom refname
;
186 unsigned int nobracket
: 1, push
: 1, push_remote
: 1;
189 enum { C_BARE
, C_BODY
, C_BODY_DEP
, C_LENGTH
, C_LINES
,
190 C_SIG
, C_SUB
, C_SUB_SANITIZE
, C_TRAILERS
} option
;
191 struct process_trailer_options trailer_opts
;
195 enum { RAW_BARE
, RAW_LENGTH
} option
;
198 cmp_status cmp_status
;
202 enum { O_FULL
, O_LENGTH
, O_SHORT
} option
;
206 enum { O_SIZE
, O_SIZE_DISK
} option
;
208 struct email_option
{
209 enum { EO_RAW
, EO_TRIM
, EO_LOCALPART
} option
;
211 struct refname_atom refname
;
215 static int used_atom_cnt
, need_tagged
, need_symref
;
218 * Expand string, append it to strbuf *sb, then return error code ret.
219 * Allow to save few lines of code.
221 __attribute__((format (printf
, 3, 4)))
222 static int strbuf_addf_ret(struct strbuf
*sb
, int ret
, const char *fmt
, ...)
226 strbuf_vaddf(sb
, fmt
, ap
);
231 static int color_atom_parser(struct ref_format
*format
, struct used_atom
*atom
,
232 const char *color_value
, struct strbuf
*err
)
235 return strbuf_addf_ret(err
, -1, _("expected format: %%(color:<color>)"));
236 if (color_parse(color_value
, atom
->u
.color
) < 0)
237 return strbuf_addf_ret(err
, -1, _("unrecognized color: %%(color:%s)"),
240 * We check this after we've parsed the color, which lets us complain
241 * about syntactically bogus color names even if they won't be used.
243 if (!want_color(format
->use_color
))
244 color_parse("", atom
->u
.color
);
248 static int refname_atom_parser_internal(struct refname_atom
*atom
, const char *arg
,
249 const char *name
, struct strbuf
*err
)
252 atom
->option
= R_NORMAL
;
253 else if (!strcmp(arg
, "short"))
254 atom
->option
= R_SHORT
;
255 else if (skip_prefix(arg
, "lstrip=", &arg
) ||
256 skip_prefix(arg
, "strip=", &arg
)) {
257 atom
->option
= R_LSTRIP
;
258 if (strtol_i(arg
, 10, &atom
->lstrip
))
259 return strbuf_addf_ret(err
, -1, _("Integer value expected refname:lstrip=%s"), arg
);
260 } else if (skip_prefix(arg
, "rstrip=", &arg
)) {
261 atom
->option
= R_RSTRIP
;
262 if (strtol_i(arg
, 10, &atom
->rstrip
))
263 return strbuf_addf_ret(err
, -1, _("Integer value expected refname:rstrip=%s"), arg
);
265 return strbuf_addf_ret(err
, -1, _("unrecognized %%(%s) argument: %s"), name
, arg
);
269 static int remote_ref_atom_parser(struct ref_format
*format
, struct used_atom
*atom
,
270 const char *arg
, struct strbuf
*err
)
272 struct string_list params
= STRING_LIST_INIT_DUP
;
275 if (!strcmp(atom
->name
, "push") || starts_with(atom
->name
, "push:"))
276 atom
->u
.remote_ref
.push
= 1;
279 atom
->u
.remote_ref
.option
= RR_REF
;
280 return refname_atom_parser_internal(&atom
->u
.remote_ref
.refname
,
281 arg
, atom
->name
, err
);
284 atom
->u
.remote_ref
.nobracket
= 0;
285 string_list_split(¶ms
, arg
, ',', -1);
287 for (i
= 0; i
< params
.nr
; i
++) {
288 const char *s
= params
.items
[i
].string
;
290 if (!strcmp(s
, "track"))
291 atom
->u
.remote_ref
.option
= RR_TRACK
;
292 else if (!strcmp(s
, "trackshort"))
293 atom
->u
.remote_ref
.option
= RR_TRACKSHORT
;
294 else if (!strcmp(s
, "nobracket"))
295 atom
->u
.remote_ref
.nobracket
= 1;
296 else if (!strcmp(s
, "remotename")) {
297 atom
->u
.remote_ref
.option
= RR_REMOTE_NAME
;
298 atom
->u
.remote_ref
.push_remote
= 1;
299 } else if (!strcmp(s
, "remoteref")) {
300 atom
->u
.remote_ref
.option
= RR_REMOTE_REF
;
301 atom
->u
.remote_ref
.push_remote
= 1;
303 atom
->u
.remote_ref
.option
= RR_REF
;
304 if (refname_atom_parser_internal(&atom
->u
.remote_ref
.refname
,
305 arg
, atom
->name
, err
)) {
306 string_list_clear(¶ms
, 0);
312 string_list_clear(¶ms
, 0);
316 static int objecttype_atom_parser(struct ref_format
*format
, struct used_atom
*atom
,
317 const char *arg
, struct strbuf
*err
)
320 return strbuf_addf_ret(err
, -1, _("%%(objecttype) does not take arguments"));
321 if (*atom
->name
== '*')
322 oi_deref
.info
.typep
= &oi_deref
.type
;
324 oi
.info
.typep
= &oi
.type
;
328 static int objectsize_atom_parser(struct ref_format
*format
, struct used_atom
*atom
,
329 const char *arg
, struct strbuf
*err
)
332 atom
->u
.objectsize
.option
= O_SIZE
;
333 if (*atom
->name
== '*')
334 oi_deref
.info
.sizep
= &oi_deref
.size
;
336 oi
.info
.sizep
= &oi
.size
;
337 } else if (!strcmp(arg
, "disk")) {
338 atom
->u
.objectsize
.option
= O_SIZE_DISK
;
339 if (*atom
->name
== '*')
340 oi_deref
.info
.disk_sizep
= &oi_deref
.disk_size
;
342 oi
.info
.disk_sizep
= &oi
.disk_size
;
344 return strbuf_addf_ret(err
, -1, _("unrecognized %%(%s) argument: %s"), "objectsize", arg
);
348 static int deltabase_atom_parser(struct ref_format
*format
, struct used_atom
*atom
,
349 const char *arg
, struct strbuf
*err
)
352 return strbuf_addf_ret(err
, -1, _("%%(deltabase) does not take arguments"));
353 if (*atom
->name
== '*')
354 oi_deref
.info
.delta_base_oid
= &oi_deref
.delta_base_oid
;
356 oi
.info
.delta_base_oid
= &oi
.delta_base_oid
;
360 static int body_atom_parser(struct ref_format
*format
, struct used_atom
*atom
,
361 const char *arg
, struct strbuf
*err
)
364 return strbuf_addf_ret(err
, -1, _("%%(body) does not take arguments"));
365 atom
->u
.contents
.option
= C_BODY_DEP
;
369 static int subject_atom_parser(struct ref_format
*format
, struct used_atom
*atom
,
370 const char *arg
, struct strbuf
*err
)
373 atom
->u
.contents
.option
= C_SUB
;
374 else if (!strcmp(arg
, "sanitize"))
375 atom
->u
.contents
.option
= C_SUB_SANITIZE
;
377 return strbuf_addf_ret(err
, -1, _("unrecognized %%(%s) argument: %s"), "subject", arg
);
381 static int trailers_atom_parser(struct ref_format
*format
, struct used_atom
*atom
,
382 const char *arg
, struct strbuf
*err
)
384 atom
->u
.contents
.trailer_opts
.no_divider
= 1;
387 const char *argbuf
= xstrfmt("%s)", arg
);
388 char *invalid_arg
= NULL
;
390 if (format_set_trailers_options(&atom
->u
.contents
.trailer_opts
,
391 &ref_trailer_buf
.filter_list
,
392 &ref_trailer_buf
.sepbuf
,
393 &ref_trailer_buf
.kvsepbuf
,
394 &argbuf
, &invalid_arg
)) {
396 strbuf_addf(err
, _("expected %%(trailers:key=<value>)"));
398 strbuf_addf(err
, _("unknown %%(trailers) argument: %s"), invalid_arg
);
399 free((char *)invalid_arg
);
403 atom
->u
.contents
.option
= C_TRAILERS
;
407 static int contents_atom_parser(struct ref_format
*format
, struct used_atom
*atom
,
408 const char *arg
, struct strbuf
*err
)
411 atom
->u
.contents
.option
= C_BARE
;
412 else if (!strcmp(arg
, "body"))
413 atom
->u
.contents
.option
= C_BODY
;
414 else if (!strcmp(arg
, "size"))
415 atom
->u
.contents
.option
= C_LENGTH
;
416 else if (!strcmp(arg
, "signature"))
417 atom
->u
.contents
.option
= C_SIG
;
418 else if (!strcmp(arg
, "subject"))
419 atom
->u
.contents
.option
= C_SUB
;
420 else if (!strcmp(arg
, "trailers")) {
421 if (trailers_atom_parser(format
, atom
, NULL
, err
))
423 } else if (skip_prefix(arg
, "trailers:", &arg
)) {
424 if (trailers_atom_parser(format
, atom
, arg
, err
))
426 } else if (skip_prefix(arg
, "lines=", &arg
)) {
427 atom
->u
.contents
.option
= C_LINES
;
428 if (strtoul_ui(arg
, 10, &atom
->u
.contents
.nlines
))
429 return strbuf_addf_ret(err
, -1, _("positive value expected contents:lines=%s"), arg
);
431 return strbuf_addf_ret(err
, -1, _("unrecognized %%(%s) argument: %s"), "contents", arg
);
435 static int raw_atom_parser(struct ref_format
*format
, struct used_atom
*atom
,
436 const char *arg
, struct strbuf
*err
)
439 atom
->u
.raw_data
.option
= RAW_BARE
;
440 else if (!strcmp(arg
, "size"))
441 atom
->u
.raw_data
.option
= RAW_LENGTH
;
443 return strbuf_addf_ret(err
, -1, _("unrecognized %%(%s) argument: %s"), "raw", arg
);
447 static int oid_atom_parser(struct ref_format
*format
, struct used_atom
*atom
,
448 const char *arg
, struct strbuf
*err
)
451 atom
->u
.oid
.option
= O_FULL
;
452 else if (!strcmp(arg
, "short"))
453 atom
->u
.oid
.option
= O_SHORT
;
454 else if (skip_prefix(arg
, "short=", &arg
)) {
455 atom
->u
.oid
.option
= O_LENGTH
;
456 if (strtoul_ui(arg
, 10, &atom
->u
.oid
.length
) ||
457 atom
->u
.oid
.length
== 0)
458 return strbuf_addf_ret(err
, -1, _("positive value expected '%s' in %%(%s)"), arg
, atom
->name
);
459 if (atom
->u
.oid
.length
< MINIMUM_ABBREV
)
460 atom
->u
.oid
.length
= MINIMUM_ABBREV
;
462 return strbuf_addf_ret(err
, -1, _("unrecognized %%(%s) argument: %s"), atom
->name
, arg
);
466 static int person_email_atom_parser(struct ref_format
*format
, struct used_atom
*atom
,
467 const char *arg
, struct strbuf
*err
)
470 atom
->u
.email_option
.option
= EO_RAW
;
471 else if (!strcmp(arg
, "trim"))
472 atom
->u
.email_option
.option
= EO_TRIM
;
473 else if (!strcmp(arg
, "localpart"))
474 atom
->u
.email_option
.option
= EO_LOCALPART
;
476 return strbuf_addf_ret(err
, -1, _("unrecognized email option: %s"), arg
);
480 static int refname_atom_parser(struct ref_format
*format
, struct used_atom
*atom
,
481 const char *arg
, struct strbuf
*err
)
483 return refname_atom_parser_internal(&atom
->u
.refname
, arg
, atom
->name
, err
);
486 static align_type
parse_align_position(const char *s
)
488 if (!strcmp(s
, "right"))
490 else if (!strcmp(s
, "middle"))
492 else if (!strcmp(s
, "left"))
497 static int align_atom_parser(struct ref_format
*format
, struct used_atom
*atom
,
498 const char *arg
, struct strbuf
*err
)
500 struct align
*align
= &atom
->u
.align
;
501 struct string_list params
= STRING_LIST_INIT_DUP
;
503 unsigned int width
= ~0U;
506 return strbuf_addf_ret(err
, -1, _("expected format: %%(align:<width>,<position>)"));
508 align
->position
= ALIGN_LEFT
;
510 string_list_split(¶ms
, arg
, ',', -1);
511 for (i
= 0; i
< params
.nr
; i
++) {
512 const char *s
= params
.items
[i
].string
;
515 if (skip_prefix(s
, "position=", &s
)) {
516 position
= parse_align_position(s
);
518 strbuf_addf(err
, _("unrecognized position:%s"), s
);
519 string_list_clear(¶ms
, 0);
522 align
->position
= position
;
523 } else if (skip_prefix(s
, "width=", &s
)) {
524 if (strtoul_ui(s
, 10, &width
)) {
525 strbuf_addf(err
, _("unrecognized width:%s"), s
);
526 string_list_clear(¶ms
, 0);
529 } else if (!strtoul_ui(s
, 10, &width
))
531 else if ((position
= parse_align_position(s
)) >= 0)
532 align
->position
= position
;
534 strbuf_addf(err
, _("unrecognized %%(%s) argument: %s"), "align", s
);
535 string_list_clear(¶ms
, 0);
541 string_list_clear(¶ms
, 0);
542 return strbuf_addf_ret(err
, -1, _("positive width expected with the %%(align) atom"));
544 align
->width
= width
;
545 string_list_clear(¶ms
, 0);
549 static int if_atom_parser(struct ref_format
*format
, struct used_atom
*atom
,
550 const char *arg
, struct strbuf
*err
)
553 atom
->u
.if_then_else
.cmp_status
= COMPARE_NONE
;
555 } else if (skip_prefix(arg
, "equals=", &atom
->u
.if_then_else
.str
)) {
556 atom
->u
.if_then_else
.cmp_status
= COMPARE_EQUAL
;
557 } else if (skip_prefix(arg
, "notequals=", &atom
->u
.if_then_else
.str
)) {
558 atom
->u
.if_then_else
.cmp_status
= COMPARE_UNEQUAL
;
560 return strbuf_addf_ret(err
, -1, _("unrecognized %%(%s) argument: %s"), "if", arg
);
564 static int rest_atom_parser(struct ref_format
*format
, struct used_atom
*atom
,
565 const char *arg
, struct strbuf
*err
)
568 return strbuf_addf_ret(err
, -1, _("%%(rest) does not take arguments"));
569 format
->use_rest
= 1;
573 static int head_atom_parser(struct ref_format
*format
, struct used_atom
*atom
,
574 const char *arg
, struct strbuf
*unused_err
)
576 atom
->u
.head
= resolve_refdup("HEAD", RESOLVE_REF_READING
, NULL
, NULL
);
584 int (*parser
)(struct ref_format
*format
, struct used_atom
*atom
,
585 const char *arg
, struct strbuf
*err
);
587 [ATOM_REFNAME
] = { "refname", SOURCE_NONE
, FIELD_STR
, refname_atom_parser
},
588 [ATOM_OBJECTTYPE
] = { "objecttype", SOURCE_OTHER
, FIELD_STR
, objecttype_atom_parser
},
589 [ATOM_OBJECTSIZE
] = { "objectsize", SOURCE_OTHER
, FIELD_ULONG
, objectsize_atom_parser
},
590 [ATOM_OBJECTNAME
] = { "objectname", SOURCE_OTHER
, FIELD_STR
, oid_atom_parser
},
591 [ATOM_DELTABASE
] = { "deltabase", SOURCE_OTHER
, FIELD_STR
, deltabase_atom_parser
},
592 [ATOM_TREE
] = { "tree", SOURCE_OBJ
, FIELD_STR
, oid_atom_parser
},
593 [ATOM_PARENT
] = { "parent", SOURCE_OBJ
, FIELD_STR
, oid_atom_parser
},
594 [ATOM_NUMPARENT
] = { "numparent", SOURCE_OBJ
, FIELD_ULONG
},
595 [ATOM_OBJECT
] = { "object", SOURCE_OBJ
},
596 [ATOM_TYPE
] = { "type", SOURCE_OBJ
},
597 [ATOM_TAG
] = { "tag", SOURCE_OBJ
},
598 [ATOM_AUTHOR
] = { "author", SOURCE_OBJ
},
599 [ATOM_AUTHORNAME
] = { "authorname", SOURCE_OBJ
},
600 [ATOM_AUTHOREMAIL
] = { "authoremail", SOURCE_OBJ
, FIELD_STR
, person_email_atom_parser
},
601 [ATOM_AUTHORDATE
] = { "authordate", SOURCE_OBJ
, FIELD_TIME
},
602 [ATOM_COMMITTER
] = { "committer", SOURCE_OBJ
},
603 [ATOM_COMMITTERNAME
] = { "committername", SOURCE_OBJ
},
604 [ATOM_COMMITTEREMAIL
] = { "committeremail", SOURCE_OBJ
, FIELD_STR
, person_email_atom_parser
},
605 [ATOM_COMMITTERDATE
] = { "committerdate", SOURCE_OBJ
, FIELD_TIME
},
606 [ATOM_TAGGER
] = { "tagger", SOURCE_OBJ
},
607 [ATOM_TAGGERNAME
] = { "taggername", SOURCE_OBJ
},
608 [ATOM_TAGGEREMAIL
] = { "taggeremail", SOURCE_OBJ
, FIELD_STR
, person_email_atom_parser
},
609 [ATOM_TAGGERDATE
] = { "taggerdate", SOURCE_OBJ
, FIELD_TIME
},
610 [ATOM_CREATOR
] = { "creator", SOURCE_OBJ
},
611 [ATOM_CREATORDATE
] = { "creatordate", SOURCE_OBJ
, FIELD_TIME
},
612 [ATOM_SUBJECT
] = { "subject", SOURCE_OBJ
, FIELD_STR
, subject_atom_parser
},
613 [ATOM_BODY
] = { "body", SOURCE_OBJ
, FIELD_STR
, body_atom_parser
},
614 [ATOM_TRAILERS
] = { "trailers", SOURCE_OBJ
, FIELD_STR
, trailers_atom_parser
},
615 [ATOM_CONTENTS
] = { "contents", SOURCE_OBJ
, FIELD_STR
, contents_atom_parser
},
616 [ATOM_RAW
] = { "raw", SOURCE_OBJ
, FIELD_STR
, raw_atom_parser
},
617 [ATOM_UPSTREAM
] = { "upstream", SOURCE_NONE
, FIELD_STR
, remote_ref_atom_parser
},
618 [ATOM_PUSH
] = { "push", SOURCE_NONE
, FIELD_STR
, remote_ref_atom_parser
},
619 [ATOM_SYMREF
] = { "symref", SOURCE_NONE
, FIELD_STR
, refname_atom_parser
},
620 [ATOM_FLAG
] = { "flag", SOURCE_NONE
},
621 [ATOM_HEAD
] = { "HEAD", SOURCE_NONE
, FIELD_STR
, head_atom_parser
},
622 [ATOM_COLOR
] = { "color", SOURCE_NONE
, FIELD_STR
, color_atom_parser
},
623 [ATOM_WORKTREEPATH
] = { "worktreepath", SOURCE_NONE
},
624 [ATOM_ALIGN
] = { "align", SOURCE_NONE
, FIELD_STR
, align_atom_parser
},
625 [ATOM_END
] = { "end", SOURCE_NONE
},
626 [ATOM_IF
] = { "if", SOURCE_NONE
, FIELD_STR
, if_atom_parser
},
627 [ATOM_THEN
] = { "then", SOURCE_NONE
},
628 [ATOM_ELSE
] = { "else", SOURCE_NONE
},
629 [ATOM_REST
] = { "rest", SOURCE_NONE
, FIELD_STR
, rest_atom_parser
},
631 * Please update $__git_ref_fieldlist in git-completion.bash
632 * when you add new atoms
636 #define REF_FORMATTING_STATE_INIT { 0 }
638 struct ref_formatting_stack
{
639 struct ref_formatting_stack
*prev
;
640 struct strbuf output
;
641 void (*at_end
)(struct ref_formatting_stack
**stack
);
645 struct ref_formatting_state
{
647 struct ref_formatting_stack
*stack
;
653 int (*handler
)(struct atom_value
*atomv
, struct ref_formatting_state
*state
,
655 uintmax_t value
; /* used for sorting when not FIELD_STR */
656 struct used_atom
*atom
;
659 #define ATOM_SIZE_UNSPECIFIED (-1)
661 #define ATOM_VALUE_INIT { \
662 .s_size = ATOM_SIZE_UNSPECIFIED \
666 * Used to parse format string and sort specifiers
668 static int parse_ref_filter_atom(struct ref_format
*format
,
669 const char *atom
, const char *ep
,
677 if (*sp
== '*' && sp
< ep
)
680 return strbuf_addf_ret(err
, -1, _("malformed field name: %.*s"),
681 (int)(ep
-atom
), atom
);
684 * If the atom name has a colon, strip it and everything after
685 * it off - it specifies the format for this entry, and
686 * shouldn't be used for checking against the valid_atom
689 arg
= memchr(sp
, ':', ep
- sp
);
690 atom_len
= (arg
? arg
: ep
) - sp
;
692 /* Do we have the atom already used elsewhere? */
693 for (i
= 0; i
< used_atom_cnt
; i
++) {
694 int len
= strlen(used_atom
[i
].name
);
695 if (len
== ep
- atom
&& !memcmp(used_atom
[i
].name
, atom
, len
))
699 /* Is the atom a valid one? */
700 for (i
= 0; i
< ARRAY_SIZE(valid_atom
); i
++) {
701 int len
= strlen(valid_atom
[i
].name
);
702 if (len
== atom_len
&& !memcmp(valid_atom
[i
].name
, sp
, len
))
706 if (ARRAY_SIZE(valid_atom
) <= i
)
707 return strbuf_addf_ret(err
, -1, _("unknown field name: %.*s"),
708 (int)(ep
-atom
), atom
);
709 if (valid_atom
[i
].source
!= SOURCE_NONE
&& !have_git_dir())
710 return strbuf_addf_ret(err
, -1,
711 _("not a git repository, but the field '%.*s' requires access to object data"),
712 (int)(ep
-atom
), atom
);
714 /* Add it in, including the deref prefix */
717 REALLOC_ARRAY(used_atom
, used_atom_cnt
);
718 used_atom
[at
].atom_type
= i
;
719 used_atom
[at
].name
= xmemdupz(atom
, ep
- atom
);
720 used_atom
[at
].type
= valid_atom
[i
].cmp_type
;
721 used_atom
[at
].source
= valid_atom
[i
].source
;
722 if (used_atom
[at
].source
== SOURCE_OBJ
) {
724 oi_deref
.info
.contentp
= &oi_deref
.content
;
726 oi
.info
.contentp
= &oi
.content
;
729 arg
= used_atom
[at
].name
+ (arg
- atom
) + 1;
732 * Treat empty sub-arguments list as NULL (i.e.,
733 * "%(atom:)" is equivalent to "%(atom)").
738 memset(&used_atom
[at
].u
, 0, sizeof(used_atom
[at
].u
));
739 if (valid_atom
[i
].parser
&& valid_atom
[i
].parser(format
, &used_atom
[at
], arg
, err
))
743 if (i
== ATOM_SYMREF
)
748 static void quote_formatting(struct strbuf
*s
, const char *str
, ssize_t len
, int quote_style
)
750 switch (quote_style
) {
753 strbuf_addstr(s
, str
);
755 strbuf_add(s
, str
, len
);
758 sq_quote_buf(s
, str
);
762 perl_quote_buf(s
, str
);
764 perl_quote_buf_with_len(s
, str
, len
);
767 python_quote_buf(s
, str
);
770 tcl_quote_buf(s
, str
);
775 static int append_atom(struct atom_value
*v
, struct ref_formatting_state
*state
,
776 struct strbuf
*unused_err
)
779 * Quote formatting is only done when the stack has a single
780 * element. Otherwise quote formatting is done on the
781 * element's entire output strbuf when the %(end) atom is
784 if (!state
->stack
->prev
)
785 quote_formatting(&state
->stack
->output
, v
->s
, v
->s_size
, state
->quote_style
);
786 else if (v
->s_size
< 0)
787 strbuf_addstr(&state
->stack
->output
, v
->s
);
789 strbuf_add(&state
->stack
->output
, v
->s
, v
->s_size
);
793 static void push_stack_element(struct ref_formatting_stack
**stack
)
795 struct ref_formatting_stack
*s
= xcalloc(1, sizeof(struct ref_formatting_stack
));
797 strbuf_init(&s
->output
, 0);
802 static void pop_stack_element(struct ref_formatting_stack
**stack
)
804 struct ref_formatting_stack
*current
= *stack
;
805 struct ref_formatting_stack
*prev
= current
->prev
;
808 strbuf_addbuf(&prev
->output
, ¤t
->output
);
809 strbuf_release(¤t
->output
);
814 static void end_align_handler(struct ref_formatting_stack
**stack
)
816 struct ref_formatting_stack
*cur
= *stack
;
817 struct align
*align
= (struct align
*)cur
->at_end_data
;
818 struct strbuf s
= STRBUF_INIT
;
820 strbuf_utf8_align(&s
, align
->position
, align
->width
, cur
->output
.buf
);
821 strbuf_swap(&cur
->output
, &s
);
825 static int align_atom_handler(struct atom_value
*atomv
, struct ref_formatting_state
*state
,
826 struct strbuf
*unused_err
)
828 struct ref_formatting_stack
*new_stack
;
830 push_stack_element(&state
->stack
);
831 new_stack
= state
->stack
;
832 new_stack
->at_end
= end_align_handler
;
833 new_stack
->at_end_data
= &atomv
->atom
->u
.align
;
837 static void if_then_else_handler(struct ref_formatting_stack
**stack
)
839 struct ref_formatting_stack
*cur
= *stack
;
840 struct ref_formatting_stack
*prev
= cur
->prev
;
841 struct if_then_else
*if_then_else
= (struct if_then_else
*)cur
->at_end_data
;
843 if (!if_then_else
->then_atom_seen
)
844 die(_("format: %%(if) atom used without a %%(then) atom"));
846 if (if_then_else
->else_atom_seen
) {
848 * There is an %(else) atom: we need to drop one state from the
849 * stack, either the %(else) branch if the condition is satisfied, or
850 * the %(then) branch if it isn't.
852 if (if_then_else
->condition_satisfied
) {
853 strbuf_reset(&cur
->output
);
854 pop_stack_element(&cur
);
856 strbuf_swap(&cur
->output
, &prev
->output
);
857 strbuf_reset(&cur
->output
);
858 pop_stack_element(&cur
);
860 } else if (!if_then_else
->condition_satisfied
) {
862 * No %(else) atom: just drop the %(then) branch if the
863 * condition is not satisfied.
865 strbuf_reset(&cur
->output
);
872 static int if_atom_handler(struct atom_value
*atomv
, struct ref_formatting_state
*state
,
873 struct strbuf
*unused_err
)
875 struct ref_formatting_stack
*new_stack
;
876 struct if_then_else
*if_then_else
= xcalloc(1,
877 sizeof(struct if_then_else
));
879 if_then_else
->str
= atomv
->atom
->u
.if_then_else
.str
;
880 if_then_else
->cmp_status
= atomv
->atom
->u
.if_then_else
.cmp_status
;
882 push_stack_element(&state
->stack
);
883 new_stack
= state
->stack
;
884 new_stack
->at_end
= if_then_else_handler
;
885 new_stack
->at_end_data
= if_then_else
;
889 static int is_empty(struct strbuf
*buf
)
891 const char *cur
= buf
->buf
;
892 const char *end
= buf
->buf
+ buf
->len
;
894 while (cur
!= end
&& (isspace(*cur
)))
900 static int then_atom_handler(struct atom_value
*atomv
, struct ref_formatting_state
*state
,
903 struct ref_formatting_stack
*cur
= state
->stack
;
904 struct if_then_else
*if_then_else
= NULL
;
907 if (cur
->at_end
== if_then_else_handler
)
908 if_then_else
= (struct if_then_else
*)cur
->at_end_data
;
910 return strbuf_addf_ret(err
, -1, _("format: %%(then) atom used without an %%(if) atom"));
911 if (if_then_else
->then_atom_seen
)
912 return strbuf_addf_ret(err
, -1, _("format: %%(then) atom used more than once"));
913 if (if_then_else
->else_atom_seen
)
914 return strbuf_addf_ret(err
, -1, _("format: %%(then) atom used after %%(else)"));
915 if_then_else
->then_atom_seen
= 1;
916 if (if_then_else
->str
)
917 str_len
= strlen(if_then_else
->str
);
919 * If the 'equals' or 'notequals' attribute is used then
920 * perform the required comparison. If not, only non-empty
921 * strings satisfy the 'if' condition.
923 if (if_then_else
->cmp_status
== COMPARE_EQUAL
) {
924 if (str_len
== cur
->output
.len
&&
925 !memcmp(if_then_else
->str
, cur
->output
.buf
, cur
->output
.len
))
926 if_then_else
->condition_satisfied
= 1;
927 } else if (if_then_else
->cmp_status
== COMPARE_UNEQUAL
) {
928 if (str_len
!= cur
->output
.len
||
929 memcmp(if_then_else
->str
, cur
->output
.buf
, cur
->output
.len
))
930 if_then_else
->condition_satisfied
= 1;
931 } else if (cur
->output
.len
&& !is_empty(&cur
->output
))
932 if_then_else
->condition_satisfied
= 1;
933 strbuf_reset(&cur
->output
);
937 static int else_atom_handler(struct atom_value
*atomv
, struct ref_formatting_state
*state
,
940 struct ref_formatting_stack
*prev
= state
->stack
;
941 struct if_then_else
*if_then_else
= NULL
;
943 if (prev
->at_end
== if_then_else_handler
)
944 if_then_else
= (struct if_then_else
*)prev
->at_end_data
;
946 return strbuf_addf_ret(err
, -1, _("format: %%(else) atom used without an %%(if) atom"));
947 if (!if_then_else
->then_atom_seen
)
948 return strbuf_addf_ret(err
, -1, _("format: %%(else) atom used without a %%(then) atom"));
949 if (if_then_else
->else_atom_seen
)
950 return strbuf_addf_ret(err
, -1, _("format: %%(else) atom used more than once"));
951 if_then_else
->else_atom_seen
= 1;
952 push_stack_element(&state
->stack
);
953 state
->stack
->at_end_data
= prev
->at_end_data
;
954 state
->stack
->at_end
= prev
->at_end
;
958 static int end_atom_handler(struct atom_value
*atomv
, struct ref_formatting_state
*state
,
961 struct ref_formatting_stack
*current
= state
->stack
;
962 struct strbuf s
= STRBUF_INIT
;
964 if (!current
->at_end
)
965 return strbuf_addf_ret(err
, -1, _("format: %%(end) atom used without corresponding atom"));
966 current
->at_end(&state
->stack
);
968 /* Stack may have been popped within at_end(), hence reset the current pointer */
969 current
= state
->stack
;
972 * Perform quote formatting when the stack element is that of
973 * a supporting atom. If nested then perform quote formatting
974 * only on the topmost supporting atom.
976 if (!current
->prev
->prev
) {
977 quote_formatting(&s
, current
->output
.buf
, current
->output
.len
, state
->quote_style
);
978 strbuf_swap(¤t
->output
, &s
);
981 pop_stack_element(&state
->stack
);
986 * In a format string, find the next occurrence of %(atom).
988 static const char *find_next(const char *cp
)
993 * %( is the start of an atom;
994 * %% is a quoted per-cent.
998 else if (cp
[1] == '%')
999 cp
++; /* skip over two % */
1000 /* otherwise this is a singleton, literal % */
1007 static int reject_atom(enum atom_type atom_type
)
1009 return atom_type
== ATOM_REST
;
1013 * Make sure the format string is well formed, and parse out
1016 int verify_ref_format(struct ref_format
*format
)
1018 const char *cp
, *sp
;
1020 format
->need_color_reset_at_eol
= 0;
1021 for (cp
= format
->format
; *cp
&& (sp
= find_next(cp
)); ) {
1022 struct strbuf err
= STRBUF_INIT
;
1023 const char *color
, *ep
= strchr(sp
, ')');
1027 return error(_("malformed format string %s"), sp
);
1028 /* sp points at "%(" and ep points at the closing ")" */
1029 at
= parse_ref_filter_atom(format
, sp
+ 2, ep
, &err
);
1032 if (reject_atom(used_atom
[at
].atom_type
))
1033 die(_("this command reject atom %%(%.*s)"), (int)(ep
- sp
- 2), sp
+ 2);
1035 if ((format
->quote_style
== QUOTE_PYTHON
||
1036 format
->quote_style
== QUOTE_SHELL
||
1037 format
->quote_style
== QUOTE_TCL
) &&
1038 used_atom
[at
].atom_type
== ATOM_RAW
&&
1039 used_atom
[at
].u
.raw_data
.option
== RAW_BARE
)
1040 die(_("--format=%.*s cannot be used with "
1041 "--python, --shell, --tcl"), (int)(ep
- sp
- 2), sp
+ 2);
1044 if (skip_prefix(used_atom
[at
].name
, "color:", &color
))
1045 format
->need_color_reset_at_eol
= !!strcmp(color
, "reset");
1046 strbuf_release(&err
);
1048 if (format
->need_color_reset_at_eol
&& !want_color(format
->use_color
))
1049 format
->need_color_reset_at_eol
= 0;
1053 static const char *do_grab_oid(const char *field
, const struct object_id
*oid
,
1054 struct used_atom
*atom
)
1056 switch (atom
->u
.oid
.option
) {
1058 return oid_to_hex(oid
);
1060 return find_unique_abbrev(oid
, atom
->u
.oid
.length
);
1062 return find_unique_abbrev(oid
, DEFAULT_ABBREV
);
1064 BUG("unknown %%(%s) option", field
);
1068 static int grab_oid(const char *name
, const char *field
, const struct object_id
*oid
,
1069 struct atom_value
*v
, struct used_atom
*atom
)
1071 if (starts_with(name
, field
)) {
1072 v
->s
= xstrdup(do_grab_oid(field
, oid
, atom
));
1078 /* See grab_values */
1079 static void grab_common_values(struct atom_value
*val
, int deref
, struct expand_data
*oi
)
1083 for (i
= 0; i
< used_atom_cnt
; i
++) {
1084 const char *name
= used_atom
[i
].name
;
1085 enum atom_type atom_type
= used_atom
[i
].atom_type
;
1086 struct atom_value
*v
= &val
[i
];
1087 if (!!deref
!= (*name
== '*'))
1091 if (atom_type
== ATOM_OBJECTTYPE
)
1092 v
->s
= xstrdup(type_name(oi
->type
));
1093 else if (atom_type
== ATOM_OBJECTSIZE
) {
1094 if (used_atom
[i
].u
.objectsize
.option
== O_SIZE_DISK
) {
1095 v
->value
= oi
->disk_size
;
1096 v
->s
= xstrfmt("%"PRIuMAX
, (uintmax_t)oi
->disk_size
);
1097 } else if (used_atom
[i
].u
.objectsize
.option
== O_SIZE
) {
1098 v
->value
= oi
->size
;
1099 v
->s
= xstrfmt("%"PRIuMAX
, (uintmax_t)oi
->size
);
1101 } else if (atom_type
== ATOM_DELTABASE
)
1102 v
->s
= xstrdup(oid_to_hex(&oi
->delta_base_oid
));
1103 else if (atom_type
== ATOM_OBJECTNAME
&& deref
)
1104 grab_oid(name
, "objectname", &oi
->oid
, v
, &used_atom
[i
]);
1108 /* See grab_values */
1109 static void grab_tag_values(struct atom_value
*val
, int deref
, struct object
*obj
)
1112 struct tag
*tag
= (struct tag
*) obj
;
1114 for (i
= 0; i
< used_atom_cnt
; i
++) {
1115 const char *name
= used_atom
[i
].name
;
1116 enum atom_type atom_type
= used_atom
[i
].atom_type
;
1117 struct atom_value
*v
= &val
[i
];
1118 if (!!deref
!= (*name
== '*'))
1122 if (atom_type
== ATOM_TAG
)
1123 v
->s
= xstrdup(tag
->tag
);
1124 else if (atom_type
== ATOM_TYPE
&& tag
->tagged
)
1125 v
->s
= xstrdup(type_name(tag
->tagged
->type
));
1126 else if (atom_type
== ATOM_OBJECT
&& tag
->tagged
)
1127 v
->s
= xstrdup(oid_to_hex(&tag
->tagged
->oid
));
1131 /* See grab_values */
1132 static void grab_commit_values(struct atom_value
*val
, int deref
, struct object
*obj
)
1135 struct commit
*commit
= (struct commit
*) obj
;
1137 for (i
= 0; i
< used_atom_cnt
; i
++) {
1138 const char *name
= used_atom
[i
].name
;
1139 enum atom_type atom_type
= used_atom
[i
].atom_type
;
1140 struct atom_value
*v
= &val
[i
];
1141 if (!!deref
!= (*name
== '*'))
1145 if (atom_type
== ATOM_TREE
&&
1146 grab_oid(name
, "tree", get_commit_tree_oid(commit
), v
, &used_atom
[i
]))
1148 if (atom_type
== ATOM_NUMPARENT
) {
1149 v
->value
= commit_list_count(commit
->parents
);
1150 v
->s
= xstrfmt("%lu", (unsigned long)v
->value
);
1152 else if (atom_type
== ATOM_PARENT
) {
1153 struct commit_list
*parents
;
1154 struct strbuf s
= STRBUF_INIT
;
1155 for (parents
= commit
->parents
; parents
; parents
= parents
->next
) {
1156 struct object_id
*oid
= &parents
->item
->object
.oid
;
1157 if (parents
!= commit
->parents
)
1158 strbuf_addch(&s
, ' ');
1159 strbuf_addstr(&s
, do_grab_oid("parent", oid
, &used_atom
[i
]));
1161 v
->s
= strbuf_detach(&s
, NULL
);
1166 static const char *find_wholine(const char *who
, int wholen
, const char *buf
)
1170 if (!strncmp(buf
, who
, wholen
) &&
1172 return buf
+ wholen
+ 1;
1173 eol
= strchr(buf
, '\n');
1178 return ""; /* end of header */
1184 static const char *copy_line(const char *buf
)
1186 const char *eol
= strchrnul(buf
, '\n');
1187 return xmemdupz(buf
, eol
- buf
);
1190 static const char *copy_name(const char *buf
)
1193 for (cp
= buf
; *cp
&& *cp
!= '\n'; cp
++) {
1194 if (!strncmp(cp
, " <", 2))
1195 return xmemdupz(buf
, cp
- buf
);
1200 static const char *copy_email(const char *buf
, struct used_atom
*atom
)
1202 const char *email
= strchr(buf
, '<');
1203 const char *eoemail
;
1206 switch (atom
->u
.email_option
.option
) {
1208 eoemail
= strchr(email
, '>');
1214 eoemail
= strchr(email
, '>');
1218 eoemail
= strchr(email
, '@');
1220 eoemail
= strchr(email
, '>');
1223 BUG("unknown email option");
1228 return xmemdupz(email
, eoemail
- email
);
1231 static char *copy_subject(const char *buf
, unsigned long len
)
1233 struct strbuf sb
= STRBUF_INIT
;
1236 for (i
= 0; i
< len
; i
++) {
1237 if (buf
[i
] == '\r' && i
+ 1 < len
&& buf
[i
+ 1] == '\n')
1238 continue; /* ignore CR in CRLF */
1241 strbuf_addch(&sb
, ' ');
1243 strbuf_addch(&sb
, buf
[i
]);
1245 return strbuf_detach(&sb
, NULL
);
1248 static void grab_date(const char *buf
, struct atom_value
*v
, const char *atomname
)
1250 const char *eoemail
= strstr(buf
, "> ");
1252 timestamp_t timestamp
;
1254 struct date_mode date_mode
= { DATE_NORMAL
};
1255 const char *formatp
;
1258 * We got here because atomname ends in "date" or "date<something>";
1259 * it's not possible that <something> is not ":<format>" because
1260 * parse_ref_filter_atom() wouldn't have allowed it, so we can assume that no
1261 * ":" means no format is specified, and use the default.
1263 formatp
= strchr(atomname
, ':');
1264 if (formatp
!= NULL
) {
1266 parse_date_format(formatp
, &date_mode
);
1271 timestamp
= parse_timestamp(eoemail
+ 2, &zone
, 10);
1272 if (timestamp
== TIME_MAX
)
1274 tz
= strtol(zone
, NULL
, 10);
1275 if ((tz
== LONG_MIN
|| tz
== LONG_MAX
) && errno
== ERANGE
)
1277 v
->s
= xstrdup(show_date(timestamp
, tz
, &date_mode
));
1278 v
->value
= timestamp
;
1285 /* See grab_values */
1286 static void grab_person(const char *who
, struct atom_value
*val
, int deref
, void *buf
)
1289 int wholen
= strlen(who
);
1290 const char *wholine
= NULL
;
1292 for (i
= 0; i
< used_atom_cnt
; i
++) {
1293 const char *name
= used_atom
[i
].name
;
1294 struct atom_value
*v
= &val
[i
];
1295 if (!!deref
!= (*name
== '*'))
1299 if (strncmp(who
, name
, wholen
))
1301 if (name
[wholen
] != 0 &&
1302 strcmp(name
+ wholen
, "name") &&
1303 !starts_with(name
+ wholen
, "email") &&
1304 !starts_with(name
+ wholen
, "date"))
1307 wholine
= find_wholine(who
, wholen
, buf
);
1309 return; /* no point looking for it */
1310 if (name
[wholen
] == 0)
1311 v
->s
= copy_line(wholine
);
1312 else if (!strcmp(name
+ wholen
, "name"))
1313 v
->s
= copy_name(wholine
);
1314 else if (starts_with(name
+ wholen
, "email"))
1315 v
->s
= copy_email(wholine
, &used_atom
[i
]);
1316 else if (starts_with(name
+ wholen
, "date"))
1317 grab_date(wholine
, v
, name
);
1321 * For a tag or a commit object, if "creator" or "creatordate" is
1322 * requested, do something special.
1324 if (strcmp(who
, "tagger") && strcmp(who
, "committer"))
1325 return; /* "author" for commit object is not wanted */
1327 wholine
= find_wholine(who
, wholen
, buf
);
1330 for (i
= 0; i
< used_atom_cnt
; i
++) {
1331 const char *name
= used_atom
[i
].name
;
1332 enum atom_type atom_type
= used_atom
[i
].atom_type
;
1333 struct atom_value
*v
= &val
[i
];
1334 if (!!deref
!= (*name
== '*'))
1339 if (atom_type
== ATOM_CREATORDATE
)
1340 grab_date(wholine
, v
, name
);
1341 else if (atom_type
== ATOM_CREATOR
)
1342 v
->s
= copy_line(wholine
);
1346 static void find_subpos(const char *buf
,
1347 const char **sub
, size_t *sublen
,
1348 const char **body
, size_t *bodylen
,
1350 const char **sig
, size_t *siglen
)
1352 struct strbuf payload
= STRBUF_INIT
;
1353 struct strbuf signature
= STRBUF_INIT
;
1355 const char *end
= buf
+ strlen(buf
);
1356 const char *sigstart
;
1358 /* parse signature first; we might not even have a subject line */
1359 parse_signature(buf
, end
- buf
, &payload
, &signature
);
1361 /* skip past header until we hit empty line */
1362 while (*buf
&& *buf
!= '\n') {
1363 eol
= strchrnul(buf
, '\n');
1368 /* skip any empty lines */
1369 while (*buf
== '\n')
1371 *sig
= strbuf_detach(&signature
, siglen
);
1372 sigstart
= buf
+ parse_signed_buffer(buf
, strlen(buf
));
1374 /* subject is first non-empty line */
1376 /* subject goes to first empty line before signature begins */
1377 if ((eol
= strstr(*sub
, "\n\n"))) {
1378 eol
= eol
< sigstart
? eol
: sigstart
;
1379 /* check if message uses CRLF */
1380 } else if (! (eol
= strstr(*sub
, "\r\n\r\n"))) {
1381 /* treat whole message as subject */
1382 eol
= strrchr(*sub
, '\0');
1385 *sublen
= buf
- *sub
;
1386 /* drop trailing newline, if present */
1387 while (*sublen
&& ((*sub
)[*sublen
- 1] == '\n' ||
1388 (*sub
)[*sublen
- 1] == '\r'))
1391 /* skip any empty lines */
1392 while (*buf
== '\n' || *buf
== '\r')
1395 *bodylen
= strlen(buf
);
1396 *nonsiglen
= sigstart
- buf
;
1400 * If 'lines' is greater than 0, append that many lines from the given
1401 * 'buf' of length 'size' to the given strbuf.
1403 static void append_lines(struct strbuf
*out
, const char *buf
, unsigned long size
, int lines
)
1406 const char *sp
, *eol
;
1411 for (i
= 0; i
< lines
&& sp
< buf
+ size
; i
++) {
1413 strbuf_addstr(out
, "\n ");
1414 eol
= memchr(sp
, '\n', size
- (sp
- buf
));
1415 len
= eol
? eol
- sp
: size
- (sp
- buf
);
1416 strbuf_add(out
, sp
, len
);
1423 /* See grab_values */
1424 static void grab_sub_body_contents(struct atom_value
*val
, int deref
, struct expand_data
*data
)
1427 const char *subpos
= NULL
, *bodypos
= NULL
, *sigpos
= NULL
;
1428 size_t sublen
= 0, bodylen
= 0, nonsiglen
= 0, siglen
= 0;
1429 void *buf
= data
->content
;
1431 for (i
= 0; i
< used_atom_cnt
; i
++) {
1432 struct used_atom
*atom
= &used_atom
[i
];
1433 const char *name
= atom
->name
;
1434 struct atom_value
*v
= &val
[i
];
1435 enum atom_type atom_type
= atom
->atom_type
;
1437 if (!!deref
!= (*name
== '*'))
1442 if (atom_type
== ATOM_RAW
) {
1443 unsigned long buf_size
= data
->size
;
1445 if (atom
->u
.raw_data
.option
== RAW_BARE
) {
1446 v
->s
= xmemdupz(buf
, buf_size
);
1447 v
->s_size
= buf_size
;
1448 } else if (atom
->u
.raw_data
.option
== RAW_LENGTH
) {
1449 v
->s
= xstrfmt("%"PRIuMAX
, (uintmax_t)buf_size
);
1454 if ((data
->type
!= OBJ_TAG
&&
1455 data
->type
!= OBJ_COMMIT
) ||
1456 (strcmp(name
, "body") &&
1457 !starts_with(name
, "subject") &&
1458 !starts_with(name
, "trailers") &&
1459 !starts_with(name
, "contents")))
1464 &bodypos
, &bodylen
, &nonsiglen
,
1467 if (atom
->u
.contents
.option
== C_SUB
)
1468 v
->s
= copy_subject(subpos
, sublen
);
1469 else if (atom
->u
.contents
.option
== C_SUB_SANITIZE
) {
1470 struct strbuf sb
= STRBUF_INIT
;
1471 format_sanitized_subject(&sb
, subpos
, sublen
);
1472 v
->s
= strbuf_detach(&sb
, NULL
);
1473 } else if (atom
->u
.contents
.option
== C_BODY_DEP
)
1474 v
->s
= xmemdupz(bodypos
, bodylen
);
1475 else if (atom
->u
.contents
.option
== C_LENGTH
)
1476 v
->s
= xstrfmt("%"PRIuMAX
, (uintmax_t)strlen(subpos
));
1477 else if (atom
->u
.contents
.option
== C_BODY
)
1478 v
->s
= xmemdupz(bodypos
, nonsiglen
);
1479 else if (atom
->u
.contents
.option
== C_SIG
)
1480 v
->s
= xmemdupz(sigpos
, siglen
);
1481 else if (atom
->u
.contents
.option
== C_LINES
) {
1482 struct strbuf s
= STRBUF_INIT
;
1483 const char *contents_end
= bodypos
+ nonsiglen
;
1485 /* Size is the length of the message after removing the signature */
1486 append_lines(&s
, subpos
, contents_end
- subpos
, atom
->u
.contents
.nlines
);
1487 v
->s
= strbuf_detach(&s
, NULL
);
1488 } else if (atom
->u
.contents
.option
== C_TRAILERS
) {
1489 struct strbuf s
= STRBUF_INIT
;
1491 /* Format the trailer info according to the trailer_opts given */
1492 format_trailers_from_commit(&s
, subpos
, &atom
->u
.contents
.trailer_opts
);
1494 v
->s
= strbuf_detach(&s
, NULL
);
1495 } else if (atom
->u
.contents
.option
== C_BARE
)
1496 v
->s
= xstrdup(subpos
);
1499 free((void *)sigpos
);
1503 * We want to have empty print-string for field requests
1504 * that do not apply (e.g. "authordate" for a tag object)
1506 static void fill_missing_values(struct atom_value
*val
)
1509 for (i
= 0; i
< used_atom_cnt
; i
++) {
1510 struct atom_value
*v
= &val
[i
];
1517 * val is a list of atom_value to hold returned values. Extract
1518 * the values for atoms in used_atom array out of (obj, buf, sz).
1519 * when deref is false, (obj, buf, sz) is the object that is
1520 * pointed at by the ref itself; otherwise it is the object the
1521 * ref (which is a tag) refers to.
1523 static void grab_values(struct atom_value
*val
, int deref
, struct object
*obj
, struct expand_data
*data
)
1525 void *buf
= data
->content
;
1527 switch (obj
->type
) {
1529 grab_tag_values(val
, deref
, obj
);
1530 grab_sub_body_contents(val
, deref
, data
);
1531 grab_person("tagger", val
, deref
, buf
);
1534 grab_commit_values(val
, deref
, obj
);
1535 grab_sub_body_contents(val
, deref
, data
);
1536 grab_person("author", val
, deref
, buf
);
1537 grab_person("committer", val
, deref
, buf
);
1540 /* grab_tree_values(val, deref, obj, buf, sz); */
1541 grab_sub_body_contents(val
, deref
, data
);
1544 /* grab_blob_values(val, deref, obj, buf, sz); */
1545 grab_sub_body_contents(val
, deref
, data
);
1548 die("Eh? Object of type %d?", obj
->type
);
1552 static inline char *copy_advance(char *dst
, const char *src
)
1559 static const char *lstrip_ref_components(const char *refname
, int len
)
1561 long remaining
= len
;
1562 const char *start
= xstrdup(refname
);
1563 const char *to_free
= start
;
1567 const char *p
= refname
;
1569 /* Find total no of '/' separated path-components */
1570 for (i
= 0; p
[i
]; p
[i
] == '/' ? i
++ : *p
++)
1573 * The number of components we need to strip is now
1574 * the total minus the components to be left (Plus one
1575 * because we count the number of '/', but the number
1576 * of components is one more than the no of '/').
1578 remaining
= i
+ len
+ 1;
1581 while (remaining
> 0) {
1584 free((char *)to_free
);
1592 start
= xstrdup(start
);
1593 free((char *)to_free
);
1597 static const char *rstrip_ref_components(const char *refname
, int len
)
1599 long remaining
= len
;
1600 const char *start
= xstrdup(refname
);
1601 const char *to_free
= start
;
1605 const char *p
= refname
;
1607 /* Find total no of '/' separated path-components */
1608 for (i
= 0; p
[i
]; p
[i
] == '/' ? i
++ : *p
++)
1611 * The number of components we need to strip is now
1612 * the total minus the components to be left (Plus one
1613 * because we count the number of '/', but the number
1614 * of components is one more than the no of '/').
1616 remaining
= i
+ len
+ 1;
1619 while (remaining
-- > 0) {
1620 char *p
= strrchr(start
, '/');
1622 free((char *)to_free
);
1630 static const char *show_ref(struct refname_atom
*atom
, const char *refname
)
1632 if (atom
->option
== R_SHORT
)
1633 return shorten_unambiguous_ref(refname
, warn_ambiguous_refs
);
1634 else if (atom
->option
== R_LSTRIP
)
1635 return lstrip_ref_components(refname
, atom
->lstrip
);
1636 else if (atom
->option
== R_RSTRIP
)
1637 return rstrip_ref_components(refname
, atom
->rstrip
);
1639 return xstrdup(refname
);
1642 static void fill_remote_ref_details(struct used_atom
*atom
, const char *refname
,
1643 struct branch
*branch
, const char **s
)
1645 int num_ours
, num_theirs
;
1646 if (atom
->u
.remote_ref
.option
== RR_REF
)
1647 *s
= show_ref(&atom
->u
.remote_ref
.refname
, refname
);
1648 else if (atom
->u
.remote_ref
.option
== RR_TRACK
) {
1649 if (stat_tracking_info(branch
, &num_ours
, &num_theirs
,
1650 NULL
, atom
->u
.remote_ref
.push
,
1651 AHEAD_BEHIND_FULL
) < 0) {
1652 *s
= xstrdup(msgs
.gone
);
1653 } else if (!num_ours
&& !num_theirs
)
1656 *s
= xstrfmt(msgs
.behind
, num_theirs
);
1657 else if (!num_theirs
)
1658 *s
= xstrfmt(msgs
.ahead
, num_ours
);
1660 *s
= xstrfmt(msgs
.ahead_behind
,
1661 num_ours
, num_theirs
);
1662 if (!atom
->u
.remote_ref
.nobracket
&& *s
[0]) {
1663 const char *to_free
= *s
;
1664 *s
= xstrfmt("[%s]", *s
);
1665 free((void *)to_free
);
1667 } else if (atom
->u
.remote_ref
.option
== RR_TRACKSHORT
) {
1668 if (stat_tracking_info(branch
, &num_ours
, &num_theirs
,
1669 NULL
, atom
->u
.remote_ref
.push
,
1670 AHEAD_BEHIND_FULL
) < 0) {
1674 if (!num_ours
&& !num_theirs
)
1678 else if (!num_theirs
)
1682 } else if (atom
->u
.remote_ref
.option
== RR_REMOTE_NAME
) {
1684 const char *remote
= atom
->u
.remote_ref
.push
?
1685 pushremote_for_branch(branch
, &explicit) :
1686 remote_for_branch(branch
, &explicit);
1687 *s
= xstrdup(explicit ? remote
: "");
1688 } else if (atom
->u
.remote_ref
.option
== RR_REMOTE_REF
) {
1691 merge
= remote_ref_for_branch(branch
, atom
->u
.remote_ref
.push
);
1692 *s
= xstrdup(merge
? merge
: "");
1694 BUG("unhandled RR_* enum");
1697 char *get_head_description(void)
1699 struct strbuf desc
= STRBUF_INIT
;
1700 struct wt_status_state state
;
1701 memset(&state
, 0, sizeof(state
));
1702 wt_status_get_state(the_repository
, &state
, 1);
1703 if (state
.rebase_in_progress
||
1704 state
.rebase_interactive_in_progress
) {
1706 strbuf_addf(&desc
, _("(no branch, rebasing %s)"),
1709 strbuf_addf(&desc
, _("(no branch, rebasing detached HEAD %s)"),
1710 state
.detached_from
);
1711 } else if (state
.bisect_in_progress
)
1712 strbuf_addf(&desc
, _("(no branch, bisect started on %s)"),
1714 else if (state
.detached_from
) {
1715 if (state
.detached_at
)
1716 strbuf_addf(&desc
, _("(HEAD detached at %s)"),
1717 state
.detached_from
);
1719 strbuf_addf(&desc
, _("(HEAD detached from %s)"),
1720 state
.detached_from
);
1722 strbuf_addstr(&desc
, _("(no branch)"));
1724 return strbuf_detach(&desc
, NULL
);
1727 static const char *get_symref(struct used_atom
*atom
, struct ref_array_item
*ref
)
1732 return show_ref(&atom
->u
.refname
, ref
->symref
);
1735 static const char *get_refname(struct used_atom
*atom
, struct ref_array_item
*ref
)
1737 if (ref
->kind
& FILTER_REFS_DETACHED_HEAD
)
1738 return get_head_description();
1739 return show_ref(&atom
->u
.refname
, ref
->refname
);
1742 static int get_object(struct ref_array_item
*ref
, int deref
, struct object
**obj
,
1743 struct expand_data
*oi
, struct strbuf
*err
)
1745 /* parse_object_buffer() will set eaten to 0 if free() will be needed */
1747 if (oi
->info
.contentp
) {
1748 /* We need to know that to use parse_object_buffer properly */
1749 oi
->info
.sizep
= &oi
->size
;
1750 oi
->info
.typep
= &oi
->type
;
1752 if (oid_object_info_extended(the_repository
, &oi
->oid
, &oi
->info
,
1753 OBJECT_INFO_LOOKUP_REPLACE
))
1754 return strbuf_addf_ret(err
, -1, _("missing object %s for %s"),
1755 oid_to_hex(&oi
->oid
), ref
->refname
);
1756 if (oi
->info
.disk_sizep
&& oi
->disk_size
< 0)
1757 BUG("Object size is less than zero.");
1759 if (oi
->info
.contentp
) {
1760 *obj
= parse_object_buffer(the_repository
, &oi
->oid
, oi
->type
, oi
->size
, oi
->content
, &eaten
);
1764 return strbuf_addf_ret(err
, -1, _("parse_object_buffer failed on %s for %s"),
1765 oid_to_hex(&oi
->oid
), ref
->refname
);
1767 grab_values(ref
->value
, deref
, *obj
, oi
);
1770 grab_common_values(ref
->value
, deref
, oi
);
1776 static void populate_worktree_map(struct hashmap
*map
, struct worktree
**worktrees
)
1780 for (i
= 0; worktrees
[i
]; i
++) {
1781 if (worktrees
[i
]->head_ref
) {
1782 struct ref_to_worktree_entry
*entry
;
1783 entry
= xmalloc(sizeof(*entry
));
1784 entry
->wt
= worktrees
[i
];
1785 hashmap_entry_init(&entry
->ent
,
1786 strhash(worktrees
[i
]->head_ref
));
1788 hashmap_add(map
, &entry
->ent
);
1793 static void lazy_init_worktree_map(void)
1795 if (ref_to_worktree_map
.worktrees
)
1798 ref_to_worktree_map
.worktrees
= get_worktrees();
1799 hashmap_init(&(ref_to_worktree_map
.map
), ref_to_worktree_map_cmpfnc
, NULL
, 0);
1800 populate_worktree_map(&(ref_to_worktree_map
.map
), ref_to_worktree_map
.worktrees
);
1803 static char *get_worktree_path(const struct used_atom
*atom
, const struct ref_array_item
*ref
)
1805 struct hashmap_entry entry
, *e
;
1806 struct ref_to_worktree_entry
*lookup_result
;
1808 lazy_init_worktree_map();
1810 hashmap_entry_init(&entry
, strhash(ref
->refname
));
1811 e
= hashmap_get(&(ref_to_worktree_map
.map
), &entry
, ref
->refname
);
1816 lookup_result
= container_of(e
, struct ref_to_worktree_entry
, ent
);
1818 return xstrdup(lookup_result
->wt
->path
);
1822 * Parse the object referred by ref, and grab needed value.
1824 static int populate_value(struct ref_array_item
*ref
, struct strbuf
*err
)
1828 struct object_info empty
= OBJECT_INFO_INIT
;
1830 CALLOC_ARRAY(ref
->value
, used_atom_cnt
);
1832 if (need_symref
&& (ref
->flag
& REF_ISSYMREF
) && !ref
->symref
) {
1833 ref
->symref
= resolve_refdup(ref
->refname
, RESOLVE_REF_READING
,
1836 ref
->symref
= xstrdup("");
1839 /* Fill in specials first */
1840 for (i
= 0; i
< used_atom_cnt
; i
++) {
1841 struct used_atom
*atom
= &used_atom
[i
];
1842 enum atom_type atom_type
= atom
->atom_type
;
1843 const char *name
= used_atom
[i
].name
;
1844 struct atom_value
*v
= &ref
->value
[i
];
1846 const char *refname
;
1847 struct branch
*branch
= NULL
;
1849 v
->s_size
= ATOM_SIZE_UNSPECIFIED
;
1850 v
->handler
= append_atom
;
1858 if (atom_type
== ATOM_REFNAME
)
1859 refname
= get_refname(atom
, ref
);
1860 else if (atom_type
== ATOM_WORKTREEPATH
) {
1861 if (ref
->kind
== FILTER_REFS_BRANCHES
)
1862 v
->s
= get_worktree_path(atom
, ref
);
1867 else if (atom_type
== ATOM_SYMREF
)
1868 refname
= get_symref(atom
, ref
);
1869 else if (atom_type
== ATOM_UPSTREAM
) {
1870 const char *branch_name
;
1871 /* only local branches may have an upstream */
1872 if (!skip_prefix(ref
->refname
, "refs/heads/",
1877 branch
= branch_get(branch_name
);
1879 refname
= branch_get_upstream(branch
, NULL
);
1881 fill_remote_ref_details(atom
, refname
, branch
, &v
->s
);
1885 } else if (atom_type
== ATOM_PUSH
&& atom
->u
.remote_ref
.push
) {
1886 const char *branch_name
;
1888 if (!skip_prefix(ref
->refname
, "refs/heads/",
1891 branch
= branch_get(branch_name
);
1893 if (atom
->u
.remote_ref
.push_remote
)
1896 refname
= branch_get_push(branch
, NULL
);
1900 /* We will definitely re-init v->s on the next line. */
1902 fill_remote_ref_details(atom
, refname
, branch
, &v
->s
);
1904 } else if (atom_type
== ATOM_COLOR
) {
1905 v
->s
= xstrdup(atom
->u
.color
);
1907 } else if (atom_type
== ATOM_FLAG
) {
1908 char buf
[256], *cp
= buf
;
1909 if (ref
->flag
& REF_ISSYMREF
)
1910 cp
= copy_advance(cp
, ",symref");
1911 if (ref
->flag
& REF_ISPACKED
)
1912 cp
= copy_advance(cp
, ",packed");
1917 v
->s
= xstrdup(buf
+ 1);
1920 } else if (!deref
&& atom_type
== ATOM_OBJECTNAME
&&
1921 grab_oid(name
, "objectname", &ref
->objectname
, v
, atom
)) {
1923 } else if (atom_type
== ATOM_HEAD
) {
1924 if (atom
->u
.head
&& !strcmp(ref
->refname
, atom
->u
.head
))
1925 v
->s
= xstrdup("*");
1927 v
->s
= xstrdup(" ");
1929 } else if (atom_type
== ATOM_ALIGN
) {
1930 v
->handler
= align_atom_handler
;
1933 } else if (atom_type
== ATOM_END
) {
1934 v
->handler
= end_atom_handler
;
1937 } else if (atom_type
== ATOM_IF
) {
1939 if (skip_prefix(name
, "if:", &s
))
1943 v
->handler
= if_atom_handler
;
1945 } else if (atom_type
== ATOM_THEN
) {
1946 v
->handler
= then_atom_handler
;
1949 } else if (atom_type
== ATOM_ELSE
) {
1950 v
->handler
= else_atom_handler
;
1953 } else if (atom_type
== ATOM_REST
) {
1955 v
->s
= xstrdup(ref
->rest
);
1963 v
->s
= xstrdup(refname
);
1965 v
->s
= xstrfmt("%s^{}", refname
);
1966 free((char *)refname
);
1969 for (i
= 0; i
< used_atom_cnt
; i
++) {
1970 struct atom_value
*v
= &ref
->value
[i
];
1971 if (v
->s
== NULL
&& used_atom
[i
].source
== SOURCE_NONE
)
1972 return strbuf_addf_ret(err
, -1, _("missing object %s for %s"),
1973 oid_to_hex(&ref
->objectname
), ref
->refname
);
1977 oi
.info
.contentp
= &oi
.content
;
1978 if (!memcmp(&oi
.info
, &empty
, sizeof(empty
)) &&
1979 !memcmp(&oi_deref
.info
, &empty
, sizeof(empty
)))
1983 oi
.oid
= ref
->objectname
;
1984 if (get_object(ref
, 0, &obj
, &oi
, err
))
1988 * If there is no atom that wants to know about tagged
1989 * object, we are done.
1991 if (!need_tagged
|| (obj
->type
!= OBJ_TAG
))
1995 * If it is a tag object, see if we use a value that derefs
1996 * the object, and if we do grab the object it refers to.
1998 oi_deref
.oid
= *get_tagged_oid((struct tag
*)obj
);
2001 * NEEDSWORK: This derefs tag only once, which
2002 * is good to deal with chains of trust, but
2003 * is not consistent with what deref_tag() does
2004 * which peels the onion to the core.
2006 return get_object(ref
, 1, &obj
, &oi_deref
, err
);
2010 * Given a ref, return the value for the atom. This lazily gets value
2011 * out of the object by calling populate value.
2013 static int get_ref_atom_value(struct ref_array_item
*ref
, int atom
,
2014 struct atom_value
**v
, struct strbuf
*err
)
2017 if (populate_value(ref
, err
))
2019 fill_missing_values(ref
->value
);
2021 *v
= &ref
->value
[atom
];
2026 * Return 1 if the refname matches one of the patterns, otherwise 0.
2027 * A pattern can be a literal prefix (e.g. a refname "refs/heads/master"
2028 * matches a pattern "refs/heads/mas") or a wildcard (e.g. the same ref
2029 * matches "refs/heads/mas*", too).
2031 static int match_pattern(const struct ref_filter
*filter
, const char *refname
)
2033 const char **patterns
= filter
->name_patterns
;
2036 if (filter
->ignore_case
)
2037 flags
|= WM_CASEFOLD
;
2040 * When no '--format' option is given we need to skip the prefix
2041 * for matching refs of tags and branches.
2043 (void)(skip_prefix(refname
, "refs/tags/", &refname
) ||
2044 skip_prefix(refname
, "refs/heads/", &refname
) ||
2045 skip_prefix(refname
, "refs/remotes/", &refname
) ||
2046 skip_prefix(refname
, "refs/", &refname
));
2048 for (; *patterns
; patterns
++) {
2049 if (!wildmatch(*patterns
, refname
, flags
))
2056 * Return 1 if the refname matches one of the patterns, otherwise 0.
2057 * A pattern can be path prefix (e.g. a refname "refs/heads/master"
2058 * matches a pattern "refs/heads/" but not "refs/heads/m") or a
2059 * wildcard (e.g. the same ref matches "refs/heads/m*", too).
2061 static int match_name_as_path(const struct ref_filter
*filter
, const char *refname
)
2063 const char **pattern
= filter
->name_patterns
;
2064 int namelen
= strlen(refname
);
2065 unsigned flags
= WM_PATHNAME
;
2067 if (filter
->ignore_case
)
2068 flags
|= WM_CASEFOLD
;
2070 for (; *pattern
; pattern
++) {
2071 const char *p
= *pattern
;
2072 int plen
= strlen(p
);
2074 if ((plen
<= namelen
) &&
2075 !strncmp(refname
, p
, plen
) &&
2076 (refname
[plen
] == '\0' ||
2077 refname
[plen
] == '/' ||
2080 if (!wildmatch(p
, refname
, flags
))
2086 /* Return 1 if the refname matches one of the patterns, otherwise 0. */
2087 static int filter_pattern_match(struct ref_filter
*filter
, const char *refname
)
2089 if (!*filter
->name_patterns
)
2090 return 1; /* No pattern always matches */
2091 if (filter
->match_as_path
)
2092 return match_name_as_path(filter
, refname
);
2093 return match_pattern(filter
, refname
);
2097 * This is the same as for_each_fullref_in(), but it tries to iterate
2098 * only over the patterns we'll care about. Note that it _doesn't_ do a full
2099 * pattern match, so the callback still has to match each ref individually.
2101 static int for_each_fullref_in_pattern(struct ref_filter
*filter
,
2105 if (!filter
->match_as_path
) {
2107 * in this case, the patterns are applied after
2108 * prefixes like "refs/heads/" etc. are stripped off,
2109 * so we have to look at everything:
2111 return for_each_fullref_in("", cb
, cb_data
);
2114 if (filter
->ignore_case
) {
2116 * we can't handle case-insensitive comparisons,
2117 * so just return everything and let the caller
2120 return for_each_fullref_in("", cb
, cb_data
);
2123 if (!filter
->name_patterns
[0]) {
2124 /* no patterns; we have to look at everything */
2125 return for_each_fullref_in("", cb
, cb_data
);
2128 return for_each_fullref_in_prefixes(NULL
, filter
->name_patterns
,
2133 * Given a ref (oid, refname), check if the ref belongs to the array
2134 * of oids. If the given ref is a tag, check if the given tag points
2135 * at one of the oids in the given oid array.
2137 * 1. Only a single level of indirection is obtained, we might want to
2138 * change this to account for multiple levels (e.g. annotated tags
2139 * pointing to annotated tags pointing to a commit.)
2140 * 2. As the refs are cached we might know what refname peels to without
2141 * the need to parse the object via parse_object(). peel_ref() might be a
2142 * more efficient alternative to obtain the pointee.
2144 static const struct object_id
*match_points_at(struct oid_array
*points_at
,
2145 const struct object_id
*oid
,
2146 const char *refname
)
2148 const struct object_id
*tagged_oid
= NULL
;
2151 if (oid_array_lookup(points_at
, oid
) >= 0)
2153 obj
= parse_object(the_repository
, oid
);
2155 die(_("malformed object at '%s'"), refname
);
2156 if (obj
->type
== OBJ_TAG
)
2157 tagged_oid
= get_tagged_oid((struct tag
*)obj
);
2158 if (tagged_oid
&& oid_array_lookup(points_at
, tagged_oid
) >= 0)
2164 * Allocate space for a new ref_array_item and copy the name and oid to it.
2166 * Callers can then fill in other struct members at their leisure.
2168 static struct ref_array_item
*new_ref_array_item(const char *refname
,
2169 const struct object_id
*oid
)
2171 struct ref_array_item
*ref
;
2173 FLEX_ALLOC_STR(ref
, refname
, refname
);
2174 oidcpy(&ref
->objectname
, oid
);
2180 struct ref_array_item
*ref_array_push(struct ref_array
*array
,
2181 const char *refname
,
2182 const struct object_id
*oid
)
2184 struct ref_array_item
*ref
= new_ref_array_item(refname
, oid
);
2186 ALLOC_GROW(array
->items
, array
->nr
+ 1, array
->alloc
);
2187 array
->items
[array
->nr
++] = ref
;
2192 static int ref_kind_from_refname(const char *refname
)
2200 { "refs/heads/" , FILTER_REFS_BRANCHES
},
2201 { "refs/remotes/" , FILTER_REFS_REMOTES
},
2202 { "refs/tags/", FILTER_REFS_TAGS
}
2205 if (!strcmp(refname
, "HEAD"))
2206 return FILTER_REFS_DETACHED_HEAD
;
2208 for (i
= 0; i
< ARRAY_SIZE(ref_kind
); i
++) {
2209 if (starts_with(refname
, ref_kind
[i
].prefix
))
2210 return ref_kind
[i
].kind
;
2213 return FILTER_REFS_OTHERS
;
2216 static int filter_ref_kind(struct ref_filter
*filter
, const char *refname
)
2218 if (filter
->kind
== FILTER_REFS_BRANCHES
||
2219 filter
->kind
== FILTER_REFS_REMOTES
||
2220 filter
->kind
== FILTER_REFS_TAGS
)
2221 return filter
->kind
;
2222 return ref_kind_from_refname(refname
);
2225 struct ref_filter_cbdata
{
2226 struct ref_array
*array
;
2227 struct ref_filter
*filter
;
2228 struct contains_cache contains_cache
;
2229 struct contains_cache no_contains_cache
;
2233 * A call-back given to for_each_ref(). Filter refs and keep them for
2234 * later object processing.
2236 static int ref_filter_handler(const char *refname
, const struct object_id
*oid
, int flag
, void *cb_data
)
2238 struct ref_filter_cbdata
*ref_cbdata
= cb_data
;
2239 struct ref_filter
*filter
= ref_cbdata
->filter
;
2240 struct ref_array_item
*ref
;
2241 struct commit
*commit
= NULL
;
2244 if (flag
& REF_BAD_NAME
) {
2245 warning(_("ignoring ref with broken name %s"), refname
);
2249 if (flag
& REF_ISBROKEN
) {
2250 warning(_("ignoring broken ref %s"), refname
);
2254 /* Obtain the current ref kind from filter_ref_kind() and ignore unwanted refs. */
2255 kind
= filter_ref_kind(filter
, refname
);
2256 if (!(kind
& filter
->kind
))
2259 if (!filter_pattern_match(filter
, refname
))
2262 if (filter
->points_at
.nr
&& !match_points_at(&filter
->points_at
, oid
, refname
))
2266 * A merge filter is applied on refs pointing to commits. Hence
2267 * obtain the commit using the 'oid' available and discard all
2268 * non-commits early. The actual filtering is done later.
2270 if (filter
->reachable_from
|| filter
->unreachable_from
||
2271 filter
->with_commit
|| filter
->no_commit
|| filter
->verbose
) {
2272 commit
= lookup_commit_reference_gently(the_repository
, oid
, 1);
2275 /* We perform the filtering for the '--contains' option... */
2276 if (filter
->with_commit
&&
2277 !commit_contains(filter
, commit
, filter
->with_commit
, &ref_cbdata
->contains_cache
))
2279 /* ...or for the `--no-contains' option */
2280 if (filter
->no_commit
&&
2281 commit_contains(filter
, commit
, filter
->no_commit
, &ref_cbdata
->no_contains_cache
))
2286 * We do not open the object yet; sort may only need refname
2287 * to do its job and the resulting list may yet to be pruned
2288 * by maxcount logic.
2290 ref
= ref_array_push(ref_cbdata
->array
, refname
, oid
);
2291 ref
->commit
= commit
;
2298 /* Free memory allocated for a ref_array_item */
2299 static void free_array_item(struct ref_array_item
*item
)
2301 free((char *)item
->symref
);
2304 for (i
= 0; i
< used_atom_cnt
; i
++)
2305 free((char *)item
->value
[i
].s
);
2311 /* Free all memory allocated for ref_array */
2312 void ref_array_clear(struct ref_array
*array
)
2316 for (i
= 0; i
< array
->nr
; i
++)
2317 free_array_item(array
->items
[i
]);
2318 FREE_AND_NULL(array
->items
);
2319 array
->nr
= array
->alloc
= 0;
2321 for (i
= 0; i
< used_atom_cnt
; i
++) {
2322 struct used_atom
*atom
= &used_atom
[i
];
2323 if (atom
->atom_type
== ATOM_HEAD
)
2325 free((char *)atom
->name
);
2327 FREE_AND_NULL(used_atom
);
2330 if (ref_to_worktree_map
.worktrees
) {
2331 hashmap_clear_and_free(&(ref_to_worktree_map
.map
),
2332 struct ref_to_worktree_entry
, ent
);
2333 free_worktrees(ref_to_worktree_map
.worktrees
);
2334 ref_to_worktree_map
.worktrees
= NULL
;
2338 #define EXCLUDE_REACHED 0
2339 #define INCLUDE_REACHED 1
2340 static void reach_filter(struct ref_array
*array
,
2341 struct commit_list
*check_reachable
,
2342 int include_reached
)
2344 struct rev_info revs
;
2346 struct commit
**to_clear
;
2347 struct commit_list
*cr
;
2349 if (!check_reachable
)
2352 CALLOC_ARRAY(to_clear
, array
->nr
);
2354 repo_init_revisions(the_repository
, &revs
, NULL
);
2356 for (i
= 0; i
< array
->nr
; i
++) {
2357 struct ref_array_item
*item
= array
->items
[i
];
2358 add_pending_object(&revs
, &item
->commit
->object
, item
->refname
);
2359 to_clear
[i
] = item
->commit
;
2362 for (cr
= check_reachable
; cr
; cr
= cr
->next
) {
2363 struct commit
*merge_commit
= cr
->item
;
2364 merge_commit
->object
.flags
|= UNINTERESTING
;
2365 add_pending_object(&revs
, &merge_commit
->object
, "");
2369 if (prepare_revision_walk(&revs
))
2370 die(_("revision walk setup failed"));
2375 for (i
= 0; i
< old_nr
; i
++) {
2376 struct ref_array_item
*item
= array
->items
[i
];
2377 struct commit
*commit
= item
->commit
;
2379 int is_merged
= !!(commit
->object
.flags
& UNINTERESTING
);
2381 if (is_merged
== include_reached
)
2382 array
->items
[array
->nr
++] = array
->items
[i
];
2384 free_array_item(item
);
2387 clear_commit_marks_many(old_nr
, to_clear
, ALL_REV_FLAGS
);
2389 while (check_reachable
) {
2390 struct commit
*merge_commit
= pop_commit(&check_reachable
);
2391 clear_commit_marks(merge_commit
, ALL_REV_FLAGS
);
2398 * API for filtering a set of refs. Based on the type of refs the user
2399 * has requested, we iterate through those refs and apply filters
2400 * as per the given ref_filter structure and finally store the
2401 * filtered refs in the ref_array structure.
2403 int filter_refs(struct ref_array
*array
, struct ref_filter
*filter
, unsigned int type
)
2405 struct ref_filter_cbdata ref_cbdata
;
2408 ref_cbdata
.array
= array
;
2409 ref_cbdata
.filter
= filter
;
2411 filter
->kind
= type
& FILTER_REFS_KIND_MASK
;
2413 init_contains_cache(&ref_cbdata
.contains_cache
);
2414 init_contains_cache(&ref_cbdata
.no_contains_cache
);
2416 /* Simple per-ref filtering */
2418 die("filter_refs: invalid type");
2421 * For common cases where we need only branches or remotes or tags,
2422 * we only iterate through those refs. If a mix of refs is needed,
2423 * we iterate over all refs and filter out required refs with the help
2424 * of filter_ref_kind().
2426 if (filter
->kind
== FILTER_REFS_BRANCHES
)
2427 ret
= for_each_fullref_in("refs/heads/", ref_filter_handler
, &ref_cbdata
);
2428 else if (filter
->kind
== FILTER_REFS_REMOTES
)
2429 ret
= for_each_fullref_in("refs/remotes/", ref_filter_handler
, &ref_cbdata
);
2430 else if (filter
->kind
== FILTER_REFS_TAGS
)
2431 ret
= for_each_fullref_in("refs/tags/", ref_filter_handler
, &ref_cbdata
);
2432 else if (filter
->kind
& FILTER_REFS_ALL
)
2433 ret
= for_each_fullref_in_pattern(filter
, ref_filter_handler
, &ref_cbdata
);
2434 if (!ret
&& (filter
->kind
& FILTER_REFS_DETACHED_HEAD
))
2435 head_ref(ref_filter_handler
, &ref_cbdata
);
2438 clear_contains_cache(&ref_cbdata
.contains_cache
);
2439 clear_contains_cache(&ref_cbdata
.no_contains_cache
);
2441 /* Filters that need revision walking */
2442 reach_filter(array
, filter
->reachable_from
, INCLUDE_REACHED
);
2443 reach_filter(array
, filter
->unreachable_from
, EXCLUDE_REACHED
);
2448 static int compare_detached_head(struct ref_array_item
*a
, struct ref_array_item
*b
)
2450 if (!(a
->kind
^ b
->kind
))
2451 BUG("ref_kind_from_refname() should only mark one ref as HEAD");
2452 if (a
->kind
& FILTER_REFS_DETACHED_HEAD
)
2454 else if (b
->kind
& FILTER_REFS_DETACHED_HEAD
)
2456 BUG("should have died in the xor check above");
2460 static int memcasecmp(const void *vs1
, const void *vs2
, size_t n
)
2462 const char *s1
= vs1
, *s2
= vs2
;
2463 const char *end
= s1
+ n
;
2465 for (; s1
< end
; s1
++, s2
++) {
2466 int diff
= tolower(*s1
) - tolower(*s2
);
2473 struct ref_sorting
{
2474 struct ref_sorting
*next
;
2475 int atom
; /* index into used_atom array (internal) */
2476 enum ref_sorting_order sort_flags
;
2479 static int cmp_ref_sorting(struct ref_sorting
*s
, struct ref_array_item
*a
, struct ref_array_item
*b
)
2481 struct atom_value
*va
, *vb
;
2483 int cmp_detached_head
= 0;
2484 cmp_type cmp_type
= used_atom
[s
->atom
].type
;
2485 struct strbuf err
= STRBUF_INIT
;
2487 if (get_ref_atom_value(a
, s
->atom
, &va
, &err
))
2489 if (get_ref_atom_value(b
, s
->atom
, &vb
, &err
))
2491 strbuf_release(&err
);
2492 if (s
->sort_flags
& REF_SORTING_DETACHED_HEAD_FIRST
&&
2493 ((a
->kind
| b
->kind
) & FILTER_REFS_DETACHED_HEAD
)) {
2494 cmp
= compare_detached_head(a
, b
);
2495 cmp_detached_head
= 1;
2496 } else if (s
->sort_flags
& REF_SORTING_VERSION
) {
2497 cmp
= versioncmp(va
->s
, vb
->s
);
2498 } else if (cmp_type
== FIELD_STR
) {
2499 if (va
->s_size
< 0 && vb
->s_size
< 0) {
2500 int (*cmp_fn
)(const char *, const char *);
2501 cmp_fn
= s
->sort_flags
& REF_SORTING_ICASE
2502 ? strcasecmp
: strcmp
;
2503 cmp
= cmp_fn(va
->s
, vb
->s
);
2505 size_t a_size
= va
->s_size
< 0 ?
2506 strlen(va
->s
) : va
->s_size
;
2507 size_t b_size
= vb
->s_size
< 0 ?
2508 strlen(vb
->s
) : vb
->s_size
;
2509 int (*cmp_fn
)(const void *, const void *, size_t);
2510 cmp_fn
= s
->sort_flags
& REF_SORTING_ICASE
2511 ? memcasecmp
: memcmp
;
2513 cmp
= cmp_fn(va
->s
, vb
->s
, b_size
> a_size
?
2516 if (a_size
> b_size
)
2518 else if (a_size
< b_size
)
2523 if (va
->value
< vb
->value
)
2525 else if (va
->value
== vb
->value
)
2531 return (s
->sort_flags
& REF_SORTING_REVERSE
&& !cmp_detached_head
)
2535 static int compare_refs(const void *a_
, const void *b_
, void *ref_sorting
)
2537 struct ref_array_item
*a
= *((struct ref_array_item
**)a_
);
2538 struct ref_array_item
*b
= *((struct ref_array_item
**)b_
);
2539 struct ref_sorting
*s
;
2541 for (s
= ref_sorting
; s
; s
= s
->next
) {
2542 int cmp
= cmp_ref_sorting(s
, a
, b
);
2547 return s
&& s
->sort_flags
& REF_SORTING_ICASE
?
2548 strcasecmp(a
->refname
, b
->refname
) :
2549 strcmp(a
->refname
, b
->refname
);
2552 void ref_sorting_set_sort_flags_all(struct ref_sorting
*sorting
,
2553 unsigned int mask
, int on
)
2555 for (; sorting
; sorting
= sorting
->next
) {
2557 sorting
->sort_flags
|= mask
;
2559 sorting
->sort_flags
&= ~mask
;
2563 void ref_array_sort(struct ref_sorting
*sorting
, struct ref_array
*array
)
2565 QSORT_S(array
->items
, array
->nr
, compare_refs
, sorting
);
2568 static void append_literal(const char *cp
, const char *ep
, struct ref_formatting_state
*state
)
2570 struct strbuf
*s
= &state
->stack
->output
;
2572 while (*cp
&& (!ep
|| cp
< ep
)) {
2577 int ch
= hex2chr(cp
+ 1);
2579 strbuf_addch(s
, ch
);
2585 strbuf_addch(s
, *cp
);
2590 int format_ref_array_item(struct ref_array_item
*info
,
2591 struct ref_format
*format
,
2592 struct strbuf
*final_buf
,
2593 struct strbuf
*error_buf
)
2595 const char *cp
, *sp
, *ep
;
2596 struct ref_formatting_state state
= REF_FORMATTING_STATE_INIT
;
2598 state
.quote_style
= format
->quote_style
;
2599 push_stack_element(&state
.stack
);
2601 for (cp
= format
->format
; *cp
&& (sp
= find_next(cp
)); cp
= ep
+ 1) {
2602 struct atom_value
*atomv
;
2605 ep
= strchr(sp
, ')');
2607 append_literal(cp
, sp
, &state
);
2608 pos
= parse_ref_filter_atom(format
, sp
+ 2, ep
, error_buf
);
2609 if (pos
< 0 || get_ref_atom_value(info
, pos
, &atomv
, error_buf
) ||
2610 atomv
->handler(atomv
, &state
, error_buf
)) {
2611 pop_stack_element(&state
.stack
);
2616 sp
= cp
+ strlen(cp
);
2617 append_literal(cp
, sp
, &state
);
2619 if (format
->need_color_reset_at_eol
) {
2620 struct atom_value resetv
= ATOM_VALUE_INIT
;
2621 resetv
.s
= GIT_COLOR_RESET
;
2622 if (append_atom(&resetv
, &state
, error_buf
)) {
2623 pop_stack_element(&state
.stack
);
2627 if (state
.stack
->prev
) {
2628 pop_stack_element(&state
.stack
);
2629 return strbuf_addf_ret(error_buf
, -1, _("format: %%(end) atom missing"));
2631 strbuf_addbuf(final_buf
, &state
.stack
->output
);
2632 pop_stack_element(&state
.stack
);
2636 void pretty_print_ref(const char *name
, const struct object_id
*oid
,
2637 struct ref_format
*format
)
2639 struct ref_array_item
*ref_item
;
2640 struct strbuf output
= STRBUF_INIT
;
2641 struct strbuf err
= STRBUF_INIT
;
2643 ref_item
= new_ref_array_item(name
, oid
);
2644 ref_item
->kind
= ref_kind_from_refname(name
);
2645 if (format_ref_array_item(ref_item
, format
, &output
, &err
))
2647 fwrite(output
.buf
, 1, output
.len
, stdout
);
2650 strbuf_release(&err
);
2651 strbuf_release(&output
);
2652 free_array_item(ref_item
);
2655 static int parse_sorting_atom(const char *atom
)
2658 * This parses an atom using a dummy ref_format, since we don't
2659 * actually care about the formatting details.
2661 struct ref_format dummy
= REF_FORMAT_INIT
;
2662 const char *end
= atom
+ strlen(atom
);
2663 struct strbuf err
= STRBUF_INIT
;
2664 int res
= parse_ref_filter_atom(&dummy
, atom
, end
, &err
);
2667 strbuf_release(&err
);
2671 /* If no sorting option is given, use refname to sort as default */
2672 static struct ref_sorting
*ref_default_sorting(void)
2674 static const char cstr_name
[] = "refname";
2676 struct ref_sorting
*sorting
= xcalloc(1, sizeof(*sorting
));
2678 sorting
->next
= NULL
;
2679 sorting
->atom
= parse_sorting_atom(cstr_name
);
2683 static void parse_ref_sorting(struct ref_sorting
**sorting_tail
, const char *arg
)
2685 struct ref_sorting
*s
;
2688 s
->next
= *sorting_tail
;
2692 s
->sort_flags
|= REF_SORTING_REVERSE
;
2695 if (skip_prefix(arg
, "version:", &arg
) ||
2696 skip_prefix(arg
, "v:", &arg
))
2697 s
->sort_flags
|= REF_SORTING_VERSION
;
2698 s
->atom
= parse_sorting_atom(arg
);
2701 struct ref_sorting
*ref_sorting_options(struct string_list
*options
)
2703 struct string_list_item
*item
;
2704 struct ref_sorting
*sorting
= NULL
, **tail
= &sorting
;
2707 sorting
= ref_default_sorting();
2709 for_each_string_list_item(item
, options
)
2710 parse_ref_sorting(tail
, item
->string
);
2714 * From here on, the ref_sorting list should be used to talk
2715 * about the sort order used for the output. The caller
2716 * should not touch the string form anymore.
2718 string_list_clear(options
, 0);
2722 void ref_sorting_release(struct ref_sorting
*sorting
)
2725 struct ref_sorting
*next
= sorting
->next
;
2731 int parse_opt_merge_filter(const struct option
*opt
, const char *arg
, int unset
)
2733 struct ref_filter
*rf
= opt
->value
;
2734 struct object_id oid
;
2735 struct commit
*merge_commit
;
2737 BUG_ON_OPT_NEG(unset
);
2739 if (get_oid(arg
, &oid
))
2740 die(_("malformed object name %s"), arg
);
2742 merge_commit
= lookup_commit_reference_gently(the_repository
, &oid
, 0);
2745 return error(_("option `%s' must point to a commit"), opt
->long_name
);
2747 if (starts_with(opt
->long_name
, "no"))
2748 commit_list_insert(merge_commit
, &rf
->unreachable_from
);
2750 commit_list_insert(merge_commit
, &rf
->reachable_from
);