3 #include "parse-options.h"
11 #include "ref-filter.h"
14 #include "git-compat-util.h"
17 typedef enum { FIELD_STR
, FIELD_ULONG
, FIELD_TIME
} cmp_type
;
25 { "objectsize", FIELD_ULONG
},
29 { "numparent", FIELD_ULONG
},
36 { "authordate", FIELD_TIME
},
40 { "committerdate", FIELD_TIME
},
44 { "taggerdate", FIELD_TIME
},
46 { "creatordate", FIELD_TIME
},
60 #define REF_FORMATTING_STATE_INIT { 0, NULL }
72 struct ref_formatting_stack
{
73 struct ref_formatting_stack
*prev
;
75 void (*at_end
)(struct ref_formatting_stack
*stack
);
79 struct ref_formatting_state
{
81 struct ref_formatting_stack
*stack
;
88 struct contents contents
;
90 void (*handler
)(struct atom_value
*atomv
, struct ref_formatting_state
*state
);
91 unsigned long ul
; /* used for sorting when not FIELD_STR */
95 * An atom is a valid field atom listed above, possibly prefixed with
96 * a "*" to denote deref_tag().
98 * We parse given format string and sort specifiers, and make a list
99 * of properties that we need to extract out of objects. ref_array_item
100 * structure will hold an array of values extracted that can be
101 * indexed with the "atom number", which is an index into this
104 static const char **used_atom
;
105 static cmp_type
*used_atom_type
;
106 static int used_atom_cnt
, need_tagged
, need_symref
;
107 static int need_color_reset_at_eol
;
110 * Used to parse format string and sort specifiers
112 int parse_ref_filter_atom(const char *atom
, const char *ep
)
118 if (*sp
== '*' && sp
< ep
)
121 die("malformed field name: %.*s", (int)(ep
-atom
), atom
);
123 /* Do we have the atom already used elsewhere? */
124 for (i
= 0; i
< used_atom_cnt
; i
++) {
125 int len
= strlen(used_atom
[i
]);
126 if (len
== ep
- atom
&& !memcmp(used_atom
[i
], atom
, len
))
130 /* Is the atom a valid one? */
131 for (i
= 0; i
< ARRAY_SIZE(valid_atom
); i
++) {
132 int len
= strlen(valid_atom
[i
].name
);
134 * If the atom name has a colon, strip it and everything after
135 * it off - it specifies the format for this entry, and
136 * shouldn't be used for checking against the valid_atom
139 const char *formatp
= strchr(sp
, ':');
140 if (!formatp
|| ep
< formatp
)
142 if (len
== formatp
- sp
&& !memcmp(valid_atom
[i
].name
, sp
, len
))
146 if (ARRAY_SIZE(valid_atom
) <= i
)
147 die("unknown field name: %.*s", (int)(ep
-atom
), atom
);
149 /* Add it in, including the deref prefix */
152 REALLOC_ARRAY(used_atom
, used_atom_cnt
);
153 REALLOC_ARRAY(used_atom_type
, used_atom_cnt
);
154 used_atom
[at
] = xmemdupz(atom
, ep
- atom
);
155 used_atom_type
[at
] = valid_atom
[i
].cmp_type
;
158 if (!strcmp(used_atom
[at
], "symref"))
163 static void quote_formatting(struct strbuf
*s
, const char *str
, int quote_style
)
165 switch (quote_style
) {
167 strbuf_addstr(s
, str
);
170 sq_quote_buf(s
, str
);
173 perl_quote_buf(s
, str
);
176 python_quote_buf(s
, str
);
179 tcl_quote_buf(s
, str
);
184 static void append_atom(struct atom_value
*v
, struct ref_formatting_state
*state
)
187 * Quote formatting is only done when the stack has a single
188 * element. Otherwise quote formatting is done on the
189 * element's entire output strbuf when the %(end) atom is
192 if (!state
->stack
->prev
)
193 quote_formatting(&state
->stack
->output
, v
->s
, state
->quote_style
);
195 strbuf_addstr(&state
->stack
->output
, v
->s
);
198 static void push_stack_element(struct ref_formatting_stack
**stack
)
200 struct ref_formatting_stack
*s
= xcalloc(1, sizeof(struct ref_formatting_stack
));
202 strbuf_init(&s
->output
, 0);
207 static void pop_stack_element(struct ref_formatting_stack
**stack
)
209 struct ref_formatting_stack
*current
= *stack
;
210 struct ref_formatting_stack
*prev
= current
->prev
;
213 strbuf_addbuf(&prev
->output
, ¤t
->output
);
214 strbuf_release(¤t
->output
);
219 static void end_align_handler(struct ref_formatting_stack
*stack
)
221 struct align
*align
= (struct align
*)stack
->at_end_data
;
222 struct strbuf s
= STRBUF_INIT
;
224 strbuf_utf8_align(&s
, align
->position
, align
->width
, stack
->output
.buf
);
225 strbuf_swap(&stack
->output
, &s
);
229 static void align_atom_handler(struct atom_value
*atomv
, struct ref_formatting_state
*state
)
231 struct ref_formatting_stack
*new;
233 push_stack_element(&state
->stack
);
235 new->at_end
= end_align_handler
;
236 new->at_end_data
= &atomv
->u
.align
;
239 static void end_atom_handler(struct atom_value
*atomv
, struct ref_formatting_state
*state
)
241 struct ref_formatting_stack
*current
= state
->stack
;
242 struct strbuf s
= STRBUF_INIT
;
244 if (!current
->at_end
)
245 die(_("format: %%(end) atom used without corresponding atom"));
246 current
->at_end(current
);
249 * Perform quote formatting when the stack element is that of
250 * a supporting atom. If nested then perform quote formatting
251 * only on the topmost supporting atom.
253 if (!state
->stack
->prev
->prev
) {
254 quote_formatting(&s
, current
->output
.buf
, state
->quote_style
);
255 strbuf_swap(¤t
->output
, &s
);
258 pop_stack_element(&state
->stack
);
261 static int match_atom_name(const char *name
, const char *atom_name
, const char **val
)
265 if (!skip_prefix(name
, atom_name
, &body
))
266 return 0; /* doesn't even begin with "atom_name" */
268 *val
= NULL
; /* %(atom_name) and no customization */
272 return 0; /* "atom_namefoo" is not "atom_name" or "atom_name:..." */
273 *val
= body
+ 1; /* "atom_name:val" */
278 * In a format string, find the next occurrence of %(atom).
280 static const char *find_next(const char *cp
)
285 * %( is the start of an atom;
286 * %% is a quoted per-cent.
290 else if (cp
[1] == '%')
291 cp
++; /* skip over two % */
292 /* otherwise this is a singleton, literal % */
300 * Make sure the format string is well formed, and parse out
303 int verify_ref_format(const char *format
)
307 need_color_reset_at_eol
= 0;
308 for (cp
= format
; *cp
&& (sp
= find_next(cp
)); ) {
309 const char *color
, *ep
= strchr(sp
, ')');
313 return error("malformed format string %s", sp
);
314 /* sp points at "%(" and ep points at the closing ")" */
315 at
= parse_ref_filter_atom(sp
+ 2, ep
);
318 if (skip_prefix(used_atom
[at
], "color:", &color
))
319 need_color_reset_at_eol
= !!strcmp(color
, "reset");
325 * Given an object name, read the object data and size, and return a
326 * "struct object". If the object data we are returning is also borrowed
327 * by the "struct object" representation, set *eaten as well---it is a
328 * signal from parse_object_buffer to us not to free the buffer.
330 static void *get_obj(const unsigned char *sha1
, struct object
**obj
, unsigned long *sz
, int *eaten
)
332 enum object_type type
;
333 void *buf
= read_sha1_file(sha1
, &type
, sz
);
336 *obj
= parse_object_buffer(sha1
, type
, *sz
, buf
, eaten
);
342 static int grab_objectname(const char *name
, const unsigned char *sha1
,
343 struct atom_value
*v
)
345 if (!strcmp(name
, "objectname")) {
346 v
->s
= xstrdup(sha1_to_hex(sha1
));
349 if (!strcmp(name
, "objectname:short")) {
350 v
->s
= xstrdup(find_unique_abbrev(sha1
, DEFAULT_ABBREV
));
356 /* See grab_values */
357 static void grab_common_values(struct atom_value
*val
, int deref
, struct object
*obj
, void *buf
, unsigned long sz
)
361 for (i
= 0; i
< used_atom_cnt
; i
++) {
362 const char *name
= used_atom
[i
];
363 struct atom_value
*v
= &val
[i
];
364 if (!!deref
!= (*name
== '*'))
368 if (!strcmp(name
, "objecttype"))
369 v
->s
= typename(obj
->type
);
370 else if (!strcmp(name
, "objectsize")) {
372 v
->s
= xstrfmt("%lu", sz
);
375 grab_objectname(name
, obj
->oid
.hash
, v
);
379 /* See grab_values */
380 static void grab_tag_values(struct atom_value
*val
, int deref
, struct object
*obj
, void *buf
, unsigned long sz
)
383 struct tag
*tag
= (struct tag
*) obj
;
385 for (i
= 0; i
< used_atom_cnt
; i
++) {
386 const char *name
= used_atom
[i
];
387 struct atom_value
*v
= &val
[i
];
388 if (!!deref
!= (*name
== '*'))
392 if (!strcmp(name
, "tag"))
394 else if (!strcmp(name
, "type") && tag
->tagged
)
395 v
->s
= typename(tag
->tagged
->type
);
396 else if (!strcmp(name
, "object") && tag
->tagged
)
397 v
->s
= xstrdup(oid_to_hex(&tag
->tagged
->oid
));
401 /* See grab_values */
402 static void grab_commit_values(struct atom_value
*val
, int deref
, struct object
*obj
, void *buf
, unsigned long sz
)
405 struct commit
*commit
= (struct commit
*) obj
;
407 for (i
= 0; i
< used_atom_cnt
; i
++) {
408 const char *name
= used_atom
[i
];
409 struct atom_value
*v
= &val
[i
];
410 if (!!deref
!= (*name
== '*'))
414 if (!strcmp(name
, "tree")) {
415 v
->s
= xstrdup(oid_to_hex(&commit
->tree
->object
.oid
));
417 else if (!strcmp(name
, "numparent")) {
418 v
->ul
= commit_list_count(commit
->parents
);
419 v
->s
= xstrfmt("%lu", v
->ul
);
421 else if (!strcmp(name
, "parent")) {
422 struct commit_list
*parents
;
423 struct strbuf s
= STRBUF_INIT
;
424 for (parents
= commit
->parents
; parents
; parents
= parents
->next
) {
425 struct commit
*parent
= parents
->item
;
426 if (parents
!= commit
->parents
)
427 strbuf_addch(&s
, ' ');
428 strbuf_addstr(&s
, oid_to_hex(&parent
->object
.oid
));
430 v
->s
= strbuf_detach(&s
, NULL
);
435 static const char *find_wholine(const char *who
, int wholen
, const char *buf
, unsigned long sz
)
439 if (!strncmp(buf
, who
, wholen
) &&
441 return buf
+ wholen
+ 1;
442 eol
= strchr(buf
, '\n');
447 return ""; /* end of header */
453 static const char *copy_line(const char *buf
)
455 const char *eol
= strchrnul(buf
, '\n');
456 return xmemdupz(buf
, eol
- buf
);
459 static const char *copy_name(const char *buf
)
462 for (cp
= buf
; *cp
&& *cp
!= '\n'; cp
++) {
463 if (!strncmp(cp
, " <", 2))
464 return xmemdupz(buf
, cp
- buf
);
469 static const char *copy_email(const char *buf
)
471 const char *email
= strchr(buf
, '<');
475 eoemail
= strchr(email
, '>');
478 return xmemdupz(email
, eoemail
+ 1 - email
);
481 static char *copy_subject(const char *buf
, unsigned long len
)
483 char *r
= xmemdupz(buf
, len
);
486 for (i
= 0; i
< len
; i
++)
493 static void grab_date(const char *buf
, struct atom_value
*v
, const char *atomname
)
495 const char *eoemail
= strstr(buf
, "> ");
497 unsigned long timestamp
;
499 struct date_mode date_mode
= { DATE_NORMAL
};
503 * We got here because atomname ends in "date" or "date<something>";
504 * it's not possible that <something> is not ":<format>" because
505 * parse_ref_filter_atom() wouldn't have allowed it, so we can assume that no
506 * ":" means no format is specified, and use the default.
508 formatp
= strchr(atomname
, ':');
509 if (formatp
!= NULL
) {
511 parse_date_format(formatp
, &date_mode
);
516 timestamp
= strtoul(eoemail
+ 2, &zone
, 10);
517 if (timestamp
== ULONG_MAX
)
519 tz
= strtol(zone
, NULL
, 10);
520 if ((tz
== LONG_MIN
|| tz
== LONG_MAX
) && errno
== ERANGE
)
522 v
->s
= xstrdup(show_date(timestamp
, tz
, &date_mode
));
530 /* See grab_values */
531 static void grab_person(const char *who
, struct atom_value
*val
, int deref
, struct object
*obj
, void *buf
, unsigned long sz
)
534 int wholen
= strlen(who
);
535 const char *wholine
= NULL
;
537 for (i
= 0; i
< used_atom_cnt
; i
++) {
538 const char *name
= used_atom
[i
];
539 struct atom_value
*v
= &val
[i
];
540 if (!!deref
!= (*name
== '*'))
544 if (strncmp(who
, name
, wholen
))
546 if (name
[wholen
] != 0 &&
547 strcmp(name
+ wholen
, "name") &&
548 strcmp(name
+ wholen
, "email") &&
549 !starts_with(name
+ wholen
, "date"))
552 wholine
= find_wholine(who
, wholen
, buf
, sz
);
554 return; /* no point looking for it */
555 if (name
[wholen
] == 0)
556 v
->s
= copy_line(wholine
);
557 else if (!strcmp(name
+ wholen
, "name"))
558 v
->s
= copy_name(wholine
);
559 else if (!strcmp(name
+ wholen
, "email"))
560 v
->s
= copy_email(wholine
);
561 else if (starts_with(name
+ wholen
, "date"))
562 grab_date(wholine
, v
, name
);
566 * For a tag or a commit object, if "creator" or "creatordate" is
567 * requested, do something special.
569 if (strcmp(who
, "tagger") && strcmp(who
, "committer"))
570 return; /* "author" for commit object is not wanted */
572 wholine
= find_wholine(who
, wholen
, buf
, sz
);
575 for (i
= 0; i
< used_atom_cnt
; i
++) {
576 const char *name
= used_atom
[i
];
577 struct atom_value
*v
= &val
[i
];
578 if (!!deref
!= (*name
== '*'))
583 if (starts_with(name
, "creatordate"))
584 grab_date(wholine
, v
, name
);
585 else if (!strcmp(name
, "creator"))
586 v
->s
= copy_line(wholine
);
590 static void find_subpos(const char *buf
, unsigned long sz
,
591 const char **sub
, unsigned long *sublen
,
592 const char **body
, unsigned long *bodylen
,
593 unsigned long *nonsiglen
,
594 const char **sig
, unsigned long *siglen
)
597 /* skip past header until we hit empty line */
598 while (*buf
&& *buf
!= '\n') {
599 eol
= strchrnul(buf
, '\n');
604 /* skip any empty lines */
608 /* parse signature first; we might not even have a subject line */
609 *sig
= buf
+ parse_signature(buf
, strlen(buf
));
610 *siglen
= strlen(*sig
);
612 /* subject is first non-empty line */
614 /* subject goes to first empty line */
615 while (buf
< *sig
&& *buf
&& *buf
!= '\n') {
616 eol
= strchrnul(buf
, '\n');
621 *sublen
= buf
- *sub
;
622 /* drop trailing newline, if present */
623 if (*sublen
&& (*sub
)[*sublen
- 1] == '\n')
626 /* skip any empty lines */
630 *bodylen
= strlen(buf
);
631 *nonsiglen
= *sig
- buf
;
635 * If 'lines' is greater than 0, append that many lines from the given
636 * 'buf' of length 'size' to the given strbuf.
638 static void append_lines(struct strbuf
*out
, const char *buf
, unsigned long size
, int lines
)
641 const char *sp
, *eol
;
646 for (i
= 0; i
< lines
&& sp
< buf
+ size
; i
++) {
648 strbuf_addstr(out
, "\n ");
649 eol
= memchr(sp
, '\n', size
- (sp
- buf
));
650 len
= eol
? eol
- sp
: size
- (sp
- buf
);
651 strbuf_add(out
, sp
, len
);
658 /* See grab_values */
659 static void grab_sub_body_contents(struct atom_value
*val
, int deref
, struct object
*obj
, void *buf
, unsigned long sz
)
662 const char *subpos
= NULL
, *bodypos
= NULL
, *sigpos
= NULL
;
663 unsigned long sublen
= 0, bodylen
= 0, nonsiglen
= 0, siglen
= 0;
665 for (i
= 0; i
< used_atom_cnt
; i
++) {
666 const char *name
= used_atom
[i
];
667 struct atom_value
*v
= &val
[i
];
668 const char *valp
= NULL
;
669 if (!!deref
!= (*name
== '*'))
673 if (strcmp(name
, "subject") &&
674 strcmp(name
, "body") &&
675 strcmp(name
, "contents") &&
676 strcmp(name
, "contents:subject") &&
677 strcmp(name
, "contents:body") &&
678 strcmp(name
, "contents:signature") &&
679 !starts_with(name
, "contents:lines="))
684 &bodypos
, &bodylen
, &nonsiglen
,
687 if (!strcmp(name
, "subject"))
688 v
->s
= copy_subject(subpos
, sublen
);
689 else if (!strcmp(name
, "contents:subject"))
690 v
->s
= copy_subject(subpos
, sublen
);
691 else if (!strcmp(name
, "body"))
692 v
->s
= xmemdupz(bodypos
, bodylen
);
693 else if (!strcmp(name
, "contents:body"))
694 v
->s
= xmemdupz(bodypos
, nonsiglen
);
695 else if (!strcmp(name
, "contents:signature"))
696 v
->s
= xmemdupz(sigpos
, siglen
);
697 else if (!strcmp(name
, "contents"))
698 v
->s
= xstrdup(subpos
);
699 else if (skip_prefix(name
, "contents:lines=", &valp
)) {
700 struct strbuf s
= STRBUF_INIT
;
701 const char *contents_end
= bodylen
+ bodypos
- siglen
;
703 if (strtoul_ui(valp
, 10, &v
->u
.contents
.lines
))
704 die(_("positive value expected contents:lines=%s"), valp
);
705 /* Size is the length of the message after removing the signature */
706 append_lines(&s
, subpos
, contents_end
- subpos
, v
->u
.contents
.lines
);
707 v
->s
= strbuf_detach(&s
, NULL
);
713 * We want to have empty print-string for field requests
714 * that do not apply (e.g. "authordate" for a tag object)
716 static void fill_missing_values(struct atom_value
*val
)
719 for (i
= 0; i
< used_atom_cnt
; i
++) {
720 struct atom_value
*v
= &val
[i
];
727 * val is a list of atom_value to hold returned values. Extract
728 * the values for atoms in used_atom array out of (obj, buf, sz).
729 * when deref is false, (obj, buf, sz) is the object that is
730 * pointed at by the ref itself; otherwise it is the object the
731 * ref (which is a tag) refers to.
733 static void grab_values(struct atom_value
*val
, int deref
, struct object
*obj
, void *buf
, unsigned long sz
)
735 grab_common_values(val
, deref
, obj
, buf
, sz
);
738 grab_tag_values(val
, deref
, obj
, buf
, sz
);
739 grab_sub_body_contents(val
, deref
, obj
, buf
, sz
);
740 grab_person("tagger", val
, deref
, obj
, buf
, sz
);
743 grab_commit_values(val
, deref
, obj
, buf
, sz
);
744 grab_sub_body_contents(val
, deref
, obj
, buf
, sz
);
745 grab_person("author", val
, deref
, obj
, buf
, sz
);
746 grab_person("committer", val
, deref
, obj
, buf
, sz
);
749 /* grab_tree_values(val, deref, obj, buf, sz); */
752 /* grab_blob_values(val, deref, obj, buf, sz); */
755 die("Eh? Object of type %d?", obj
->type
);
759 static inline char *copy_advance(char *dst
, const char *src
)
766 static const char *strip_ref_components(const char *refname
, const char *nr_arg
)
769 long nr
= strtol(nr_arg
, &end
, 10);
771 const char *start
= refname
;
773 if (nr
< 1 || *end
!= '\0')
774 die(":strip= requires a positive integer argument");
779 die("ref '%s' does not have %ld components to :strip",
790 * Parse the object referred by ref, and grab needed value.
792 static void populate_value(struct ref_array_item
*ref
)
798 const unsigned char *tagged
;
800 ref
->value
= xcalloc(used_atom_cnt
, sizeof(struct atom_value
));
802 if (need_symref
&& (ref
->flag
& REF_ISSYMREF
) && !ref
->symref
) {
803 unsigned char unused1
[20];
804 ref
->symref
= resolve_refdup(ref
->refname
, RESOLVE_REF_READING
,
810 /* Fill in specials first */
811 for (i
= 0; i
< used_atom_cnt
; i
++) {
812 const char *name
= used_atom
[i
];
813 struct atom_value
*v
= &ref
->value
[i
];
818 struct branch
*branch
= NULL
;
820 v
->handler
= append_atom
;
827 if (starts_with(name
, "refname"))
828 refname
= ref
->refname
;
829 else if (starts_with(name
, "symref"))
830 refname
= ref
->symref
? ref
->symref
: "";
831 else if (starts_with(name
, "upstream")) {
832 const char *branch_name
;
833 /* only local branches may have an upstream */
834 if (!skip_prefix(ref
->refname
, "refs/heads/",
837 branch
= branch_get(branch_name
);
839 refname
= branch_get_upstream(branch
, NULL
);
842 } else if (starts_with(name
, "push")) {
843 const char *branch_name
;
844 if (!skip_prefix(ref
->refname
, "refs/heads/",
847 branch
= branch_get(branch_name
);
849 refname
= branch_get_push(branch
, NULL
);
852 } else if (match_atom_name(name
, "color", &valp
)) {
853 char color
[COLOR_MAXLEN
] = "";
856 die(_("expected format: %%(color:<color>)"));
857 if (color_parse(valp
, color
) < 0)
858 die(_("unable to parse format"));
859 v
->s
= xstrdup(color
);
861 } else if (!strcmp(name
, "flag")) {
862 char buf
[256], *cp
= buf
;
863 if (ref
->flag
& REF_ISSYMREF
)
864 cp
= copy_advance(cp
, ",symref");
865 if (ref
->flag
& REF_ISPACKED
)
866 cp
= copy_advance(cp
, ",packed");
871 v
->s
= xstrdup(buf
+ 1);
874 } else if (!deref
&& grab_objectname(name
, ref
->objectname
, v
)) {
876 } else if (!strcmp(name
, "HEAD")) {
878 unsigned char sha1
[20];
880 head
= resolve_ref_unsafe("HEAD", RESOLVE_REF_READING
,
882 if (!strcmp(ref
->refname
, head
))
887 } else if (match_atom_name(name
, "align", &valp
)) {
888 struct align
*align
= &v
->u
.align
;
889 struct strbuf
**s
, **to_free
;
893 die(_("expected format: %%(align:<width>,<position>)"));
896 * TODO: Implement a function similar to strbuf_split_str()
897 * which would omit the separator from the end of each value.
899 s
= to_free
= strbuf_split_str(valp
, ',', 0);
901 align
->position
= ALIGN_LEFT
;
904 /* Strip trailing comma */
906 strbuf_setlen(s
[0], s
[0]->len
- 1);
907 if (!strtoul_ui(s
[0]->buf
, 10, (unsigned int *)&width
))
909 else if (!strcmp(s
[0]->buf
, "left"))
910 align
->position
= ALIGN_LEFT
;
911 else if (!strcmp(s
[0]->buf
, "right"))
912 align
->position
= ALIGN_RIGHT
;
913 else if (!strcmp(s
[0]->buf
, "middle"))
914 align
->position
= ALIGN_MIDDLE
;
916 die(_("improper format entered align:%s"), s
[0]->buf
);
921 die(_("positive width expected with the %%(align) atom"));
922 align
->width
= width
;
923 strbuf_list_free(to_free
);
924 v
->handler
= align_atom_handler
;
926 } else if (!strcmp(name
, "end")) {
927 v
->handler
= end_atom_handler
;
932 formatp
= strchr(name
, ':');
934 int num_ours
, num_theirs
;
938 if (!strcmp(formatp
, "short"))
939 refname
= shorten_unambiguous_ref(refname
,
940 warn_ambiguous_refs
);
941 else if (skip_prefix(formatp
, "strip=", &arg
))
942 refname
= strip_ref_components(refname
, arg
);
943 else if (!strcmp(formatp
, "track") &&
944 (starts_with(name
, "upstream") ||
945 starts_with(name
, "push"))) {
947 if (stat_tracking_info(branch
, &num_ours
,
951 if (!num_ours
&& !num_theirs
)
954 v
->s
= xstrfmt("[behind %d]", num_theirs
);
955 else if (!num_theirs
)
956 v
->s
= xstrfmt("[ahead %d]", num_ours
);
958 v
->s
= xstrfmt("[ahead %d, behind %d]",
959 num_ours
, num_theirs
);
961 } else if (!strcmp(formatp
, "trackshort") &&
962 (starts_with(name
, "upstream") ||
963 starts_with(name
, "push"))) {
966 if (stat_tracking_info(branch
, &num_ours
,
970 if (!num_ours
&& !num_theirs
)
974 else if (!num_theirs
)
980 die("unknown %.*s format %s",
981 (int)(formatp
- name
), name
, formatp
);
987 v
->s
= xstrfmt("%s^{}", refname
);
990 for (i
= 0; i
< used_atom_cnt
; i
++) {
991 struct atom_value
*v
= &ref
->value
[i
];
998 buf
= get_obj(ref
->objectname
, &obj
, &size
, &eaten
);
1000 die("missing object %s for %s",
1001 sha1_to_hex(ref
->objectname
), ref
->refname
);
1003 die("parse_object_buffer failed on %s for %s",
1004 sha1_to_hex(ref
->objectname
), ref
->refname
);
1006 grab_values(ref
->value
, 0, obj
, buf
, size
);
1011 * If there is no atom that wants to know about tagged
1012 * object, we are done.
1014 if (!need_tagged
|| (obj
->type
!= OBJ_TAG
))
1018 * If it is a tag object, see if we use a value that derefs
1019 * the object, and if we do grab the object it refers to.
1021 tagged
= ((struct tag
*)obj
)->tagged
->oid
.hash
;
1024 * NEEDSWORK: This derefs tag only once, which
1025 * is good to deal with chains of trust, but
1026 * is not consistent with what deref_tag() does
1027 * which peels the onion to the core.
1029 buf
= get_obj(tagged
, &obj
, &size
, &eaten
);
1031 die("missing object %s for %s",
1032 sha1_to_hex(tagged
), ref
->refname
);
1034 die("parse_object_buffer failed on %s for %s",
1035 sha1_to_hex(tagged
), ref
->refname
);
1036 grab_values(ref
->value
, 1, obj
, buf
, size
);
1042 * Given a ref, return the value for the atom. This lazily gets value
1043 * out of the object by calling populate value.
1045 static void get_ref_atom_value(struct ref_array_item
*ref
, int atom
, struct atom_value
**v
)
1048 populate_value(ref
);
1049 fill_missing_values(ref
->value
);
1051 *v
= &ref
->value
[atom
];
1054 enum contains_result
{
1055 CONTAINS_UNKNOWN
= -1,
1061 * Mimicking the real stack, this stack lives on the heap, avoiding stack
1064 * At each recursion step, the stack items points to the commits whose
1065 * ancestors are to be inspected.
1067 struct contains_stack
{
1069 struct contains_stack_entry
{
1070 struct commit
*commit
;
1071 struct commit_list
*parents
;
1075 static int in_commit_list(const struct commit_list
*want
, struct commit
*c
)
1077 for (; want
; want
= want
->next
)
1078 if (!oidcmp(&want
->item
->object
.oid
, &c
->object
.oid
))
1084 * Test whether the candidate or one of its parents is contained in the list.
1085 * Do not recurse to find out, though, but return -1 if inconclusive.
1087 static enum contains_result
contains_test(struct commit
*candidate
,
1088 const struct commit_list
*want
)
1090 /* was it previously marked as containing a want commit? */
1091 if (candidate
->object
.flags
& TMP_MARK
)
1093 /* or marked as not possibly containing a want commit? */
1094 if (candidate
->object
.flags
& UNINTERESTING
)
1097 if (in_commit_list(want
, candidate
)) {
1098 candidate
->object
.flags
|= TMP_MARK
;
1102 if (parse_commit(candidate
) < 0)
1108 static void push_to_contains_stack(struct commit
*candidate
, struct contains_stack
*contains_stack
)
1110 ALLOC_GROW(contains_stack
->contains_stack
, contains_stack
->nr
+ 1, contains_stack
->alloc
);
1111 contains_stack
->contains_stack
[contains_stack
->nr
].commit
= candidate
;
1112 contains_stack
->contains_stack
[contains_stack
->nr
++].parents
= candidate
->parents
;
1115 static enum contains_result
contains_tag_algo(struct commit
*candidate
,
1116 const struct commit_list
*want
)
1118 struct contains_stack contains_stack
= { 0, 0, NULL
};
1119 int result
= contains_test(candidate
, want
);
1121 if (result
!= CONTAINS_UNKNOWN
)
1124 push_to_contains_stack(candidate
, &contains_stack
);
1125 while (contains_stack
.nr
) {
1126 struct contains_stack_entry
*entry
= &contains_stack
.contains_stack
[contains_stack
.nr
- 1];
1127 struct commit
*commit
= entry
->commit
;
1128 struct commit_list
*parents
= entry
->parents
;
1131 commit
->object
.flags
|= UNINTERESTING
;
1132 contains_stack
.nr
--;
1135 * If we just popped the stack, parents->item has been marked,
1136 * therefore contains_test will return a meaningful 0 or 1.
1138 else switch (contains_test(parents
->item
, want
)) {
1140 commit
->object
.flags
|= TMP_MARK
;
1141 contains_stack
.nr
--;
1144 entry
->parents
= parents
->next
;
1146 case CONTAINS_UNKNOWN
:
1147 push_to_contains_stack(parents
->item
, &contains_stack
);
1151 free(contains_stack
.contains_stack
);
1152 return contains_test(candidate
, want
);
1155 static int commit_contains(struct ref_filter
*filter
, struct commit
*commit
)
1157 if (filter
->with_commit_tag_algo
)
1158 return contains_tag_algo(commit
, filter
->with_commit
);
1159 return is_descendant_of(commit
, filter
->with_commit
);
1163 * Return 1 if the refname matches one of the patterns, otherwise 0.
1164 * A pattern can be a literal prefix (e.g. a refname "refs/heads/master"
1165 * matches a pattern "refs/heads/mas") or a wildcard (e.g. the same ref
1166 * matches "refs/heads/mas*", too).
1168 static int match_pattern(const char **patterns
, const char *refname
)
1171 * When no '--format' option is given we need to skip the prefix
1172 * for matching refs of tags and branches.
1174 (void)(skip_prefix(refname
, "refs/tags/", &refname
) ||
1175 skip_prefix(refname
, "refs/heads/", &refname
) ||
1176 skip_prefix(refname
, "refs/remotes/", &refname
) ||
1177 skip_prefix(refname
, "refs/", &refname
));
1179 for (; *patterns
; patterns
++) {
1180 if (!wildmatch(*patterns
, refname
, 0, NULL
))
1187 * Return 1 if the refname matches one of the patterns, otherwise 0.
1188 * A pattern can be path prefix (e.g. a refname "refs/heads/master"
1189 * matches a pattern "refs/heads/" but not "refs/heads/m") or a
1190 * wildcard (e.g. the same ref matches "refs/heads/m*", too).
1192 static int match_name_as_path(const char **pattern
, const char *refname
)
1194 int namelen
= strlen(refname
);
1195 for (; *pattern
; pattern
++) {
1196 const char *p
= *pattern
;
1197 int plen
= strlen(p
);
1199 if ((plen
<= namelen
) &&
1200 !strncmp(refname
, p
, plen
) &&
1201 (refname
[plen
] == '\0' ||
1202 refname
[plen
] == '/' ||
1205 if (!wildmatch(p
, refname
, WM_PATHNAME
, NULL
))
1211 /* Return 1 if the refname matches one of the patterns, otherwise 0. */
1212 static int filter_pattern_match(struct ref_filter
*filter
, const char *refname
)
1214 if (!*filter
->name_patterns
)
1215 return 1; /* No pattern always matches */
1216 if (filter
->match_as_path
)
1217 return match_name_as_path(filter
->name_patterns
, refname
);
1218 return match_pattern(filter
->name_patterns
, refname
);
1222 * Given a ref (sha1, refname), check if the ref belongs to the array
1223 * of sha1s. If the given ref is a tag, check if the given tag points
1224 * at one of the sha1s in the given sha1 array.
1225 * the given sha1_array.
1227 * 1. Only a single level of inderection is obtained, we might want to
1228 * change this to account for multiple levels (e.g. annotated tags
1229 * pointing to annotated tags pointing to a commit.)
1230 * 2. As the refs are cached we might know what refname peels to without
1231 * the need to parse the object via parse_object(). peel_ref() might be a
1232 * more efficient alternative to obtain the pointee.
1234 static const unsigned char *match_points_at(struct sha1_array
*points_at
,
1235 const unsigned char *sha1
,
1236 const char *refname
)
1238 const unsigned char *tagged_sha1
= NULL
;
1241 if (sha1_array_lookup(points_at
, sha1
) >= 0)
1243 obj
= parse_object(sha1
);
1245 die(_("malformed object at '%s'"), refname
);
1246 if (obj
->type
== OBJ_TAG
)
1247 tagged_sha1
= ((struct tag
*)obj
)->tagged
->oid
.hash
;
1248 if (tagged_sha1
&& sha1_array_lookup(points_at
, tagged_sha1
) >= 0)
1253 /* Allocate space for a new ref_array_item and copy the objectname and flag to it */
1254 static struct ref_array_item
*new_ref_array_item(const char *refname
,
1255 const unsigned char *objectname
,
1258 size_t len
= strlen(refname
);
1259 struct ref_array_item
*ref
= xcalloc(1, sizeof(struct ref_array_item
) + len
+ 1);
1260 memcpy(ref
->refname
, refname
, len
);
1261 ref
->refname
[len
] = '\0';
1262 hashcpy(ref
->objectname
, objectname
);
1268 static int filter_ref_kind(struct ref_filter
*filter
, const char *refname
)
1276 { "refs/heads/" , FILTER_REFS_BRANCHES
},
1277 { "refs/remotes/" , FILTER_REFS_REMOTES
},
1278 { "refs/tags/", FILTER_REFS_TAGS
}
1281 if (filter
->kind
== FILTER_REFS_BRANCHES
||
1282 filter
->kind
== FILTER_REFS_REMOTES
||
1283 filter
->kind
== FILTER_REFS_TAGS
)
1284 return filter
->kind
;
1285 else if (!strcmp(refname
, "HEAD"))
1286 return FILTER_REFS_DETACHED_HEAD
;
1288 for (i
= 0; i
< ARRAY_SIZE(ref_kind
); i
++) {
1289 if (starts_with(refname
, ref_kind
[i
].prefix
))
1290 return ref_kind
[i
].kind
;
1293 return FILTER_REFS_OTHERS
;
1297 * A call-back given to for_each_ref(). Filter refs and keep them for
1298 * later object processing.
1300 static int ref_filter_handler(const char *refname
, const struct object_id
*oid
, int flag
, void *cb_data
)
1302 struct ref_filter_cbdata
*ref_cbdata
= cb_data
;
1303 struct ref_filter
*filter
= ref_cbdata
->filter
;
1304 struct ref_array_item
*ref
;
1305 struct commit
*commit
= NULL
;
1308 if (flag
& REF_BAD_NAME
) {
1309 warning("ignoring ref with broken name %s", refname
);
1313 if (flag
& REF_ISBROKEN
) {
1314 warning("ignoring broken ref %s", refname
);
1318 /* Obtain the current ref kind from filter_ref_kind() and ignore unwanted refs. */
1319 kind
= filter_ref_kind(filter
, refname
);
1320 if (!(kind
& filter
->kind
))
1323 if (!filter_pattern_match(filter
, refname
))
1326 if (filter
->points_at
.nr
&& !match_points_at(&filter
->points_at
, oid
->hash
, refname
))
1330 * A merge filter is applied on refs pointing to commits. Hence
1331 * obtain the commit using the 'oid' available and discard all
1332 * non-commits early. The actual filtering is done later.
1334 if (filter
->merge_commit
|| filter
->with_commit
|| filter
->verbose
) {
1335 commit
= lookup_commit_reference_gently(oid
->hash
, 1);
1338 /* We perform the filtering for the '--contains' option */
1339 if (filter
->with_commit
&&
1340 !commit_contains(filter
, commit
))
1345 * We do not open the object yet; sort may only need refname
1346 * to do its job and the resulting list may yet to be pruned
1347 * by maxcount logic.
1349 ref
= new_ref_array_item(refname
, oid
->hash
, flag
);
1350 ref
->commit
= commit
;
1352 REALLOC_ARRAY(ref_cbdata
->array
->items
, ref_cbdata
->array
->nr
+ 1);
1353 ref_cbdata
->array
->items
[ref_cbdata
->array
->nr
++] = ref
;
1358 /* Free memory allocated for a ref_array_item */
1359 static void free_array_item(struct ref_array_item
*item
)
1361 free((char *)item
->symref
);
1365 /* Free all memory allocated for ref_array */
1366 void ref_array_clear(struct ref_array
*array
)
1370 for (i
= 0; i
< array
->nr
; i
++)
1371 free_array_item(array
->items
[i
]);
1373 array
->items
= NULL
;
1374 array
->nr
= array
->alloc
= 0;
1377 static void do_merge_filter(struct ref_filter_cbdata
*ref_cbdata
)
1379 struct rev_info revs
;
1381 struct ref_filter
*filter
= ref_cbdata
->filter
;
1382 struct ref_array
*array
= ref_cbdata
->array
;
1383 struct commit
**to_clear
= xcalloc(sizeof(struct commit
*), array
->nr
);
1385 init_revisions(&revs
, NULL
);
1387 for (i
= 0; i
< array
->nr
; i
++) {
1388 struct ref_array_item
*item
= array
->items
[i
];
1389 add_pending_object(&revs
, &item
->commit
->object
, item
->refname
);
1390 to_clear
[i
] = item
->commit
;
1393 filter
->merge_commit
->object
.flags
|= UNINTERESTING
;
1394 add_pending_object(&revs
, &filter
->merge_commit
->object
, "");
1397 if (prepare_revision_walk(&revs
))
1398 die(_("revision walk setup failed"));
1403 for (i
= 0; i
< old_nr
; i
++) {
1404 struct ref_array_item
*item
= array
->items
[i
];
1405 struct commit
*commit
= item
->commit
;
1407 int is_merged
= !!(commit
->object
.flags
& UNINTERESTING
);
1409 if (is_merged
== (filter
->merge
== REF_FILTER_MERGED_INCLUDE
))
1410 array
->items
[array
->nr
++] = array
->items
[i
];
1412 free_array_item(item
);
1415 for (i
= 0; i
< old_nr
; i
++)
1416 clear_commit_marks(to_clear
[i
], ALL_REV_FLAGS
);
1417 clear_commit_marks(filter
->merge_commit
, ALL_REV_FLAGS
);
1422 * API for filtering a set of refs. Based on the type of refs the user
1423 * has requested, we iterate through those refs and apply filters
1424 * as per the given ref_filter structure and finally store the
1425 * filtered refs in the ref_array structure.
1427 int filter_refs(struct ref_array
*array
, struct ref_filter
*filter
, unsigned int type
)
1429 struct ref_filter_cbdata ref_cbdata
;
1431 unsigned int broken
= 0;
1433 ref_cbdata
.array
= array
;
1434 ref_cbdata
.filter
= filter
;
1436 if (type
& FILTER_REFS_INCLUDE_BROKEN
)
1438 filter
->kind
= type
& FILTER_REFS_KIND_MASK
;
1440 /* Simple per-ref filtering */
1442 die("filter_refs: invalid type");
1445 * For common cases where we need only branches or remotes or tags,
1446 * we only iterate through those refs. If a mix of refs is needed,
1447 * we iterate over all refs and filter out required refs with the help
1448 * of filter_ref_kind().
1450 if (filter
->kind
== FILTER_REFS_BRANCHES
)
1451 ret
= for_each_fullref_in("refs/heads/", ref_filter_handler
, &ref_cbdata
, broken
);
1452 else if (filter
->kind
== FILTER_REFS_REMOTES
)
1453 ret
= for_each_fullref_in("refs/remotes/", ref_filter_handler
, &ref_cbdata
, broken
);
1454 else if (filter
->kind
== FILTER_REFS_TAGS
)
1455 ret
= for_each_fullref_in("refs/tags/", ref_filter_handler
, &ref_cbdata
, broken
);
1456 else if (filter
->kind
& FILTER_REFS_ALL
)
1457 ret
= for_each_fullref_in("", ref_filter_handler
, &ref_cbdata
, broken
);
1458 if (!ret
&& (filter
->kind
& FILTER_REFS_DETACHED_HEAD
))
1459 head_ref(ref_filter_handler
, &ref_cbdata
);
1463 /* Filters that need revision walking */
1464 if (filter
->merge_commit
)
1465 do_merge_filter(&ref_cbdata
);
1470 static int cmp_ref_sorting(struct ref_sorting
*s
, struct ref_array_item
*a
, struct ref_array_item
*b
)
1472 struct atom_value
*va
, *vb
;
1474 cmp_type cmp_type
= used_atom_type
[s
->atom
];
1476 get_ref_atom_value(a
, s
->atom
, &va
);
1477 get_ref_atom_value(b
, s
->atom
, &vb
);
1479 cmp
= versioncmp(va
->s
, vb
->s
);
1480 else if (cmp_type
== FIELD_STR
)
1481 cmp
= strcmp(va
->s
, vb
->s
);
1483 if (va
->ul
< vb
->ul
)
1485 else if (va
->ul
== vb
->ul
)
1486 cmp
= strcmp(a
->refname
, b
->refname
);
1491 return (s
->reverse
) ? -cmp
: cmp
;
1494 static struct ref_sorting
*ref_sorting
;
1495 static int compare_refs(const void *a_
, const void *b_
)
1497 struct ref_array_item
*a
= *((struct ref_array_item
**)a_
);
1498 struct ref_array_item
*b
= *((struct ref_array_item
**)b_
);
1499 struct ref_sorting
*s
;
1501 for (s
= ref_sorting
; s
; s
= s
->next
) {
1502 int cmp
= cmp_ref_sorting(s
, a
, b
);
1509 void ref_array_sort(struct ref_sorting
*sorting
, struct ref_array
*array
)
1511 ref_sorting
= sorting
;
1512 qsort(array
->items
, array
->nr
, sizeof(struct ref_array_item
*), compare_refs
);
1515 static int hex1(char ch
)
1517 if ('0' <= ch
&& ch
<= '9')
1519 else if ('a' <= ch
&& ch
<= 'f')
1520 return ch
- 'a' + 10;
1521 else if ('A' <= ch
&& ch
<= 'F')
1522 return ch
- 'A' + 10;
1525 static int hex2(const char *cp
)
1528 return (hex1(cp
[0]) << 4) | hex1(cp
[1]);
1533 static void append_literal(const char *cp
, const char *ep
, struct ref_formatting_state
*state
)
1535 struct strbuf
*s
= &state
->stack
->output
;
1537 while (*cp
&& (!ep
|| cp
< ep
)) {
1542 int ch
= hex2(cp
+ 1);
1544 strbuf_addch(s
, ch
);
1550 strbuf_addch(s
, *cp
);
1555 void show_ref_array_item(struct ref_array_item
*info
, const char *format
, int quote_style
)
1557 const char *cp
, *sp
, *ep
;
1558 struct strbuf
*final_buf
;
1559 struct ref_formatting_state state
= REF_FORMATTING_STATE_INIT
;
1561 state
.quote_style
= quote_style
;
1562 push_stack_element(&state
.stack
);
1564 for (cp
= format
; *cp
&& (sp
= find_next(cp
)); cp
= ep
+ 1) {
1565 struct atom_value
*atomv
;
1567 ep
= strchr(sp
, ')');
1569 append_literal(cp
, sp
, &state
);
1570 get_ref_atom_value(info
, parse_ref_filter_atom(sp
+ 2, ep
), &atomv
);
1571 atomv
->handler(atomv
, &state
);
1574 sp
= cp
+ strlen(cp
);
1575 append_literal(cp
, sp
, &state
);
1577 if (need_color_reset_at_eol
) {
1578 struct atom_value resetv
;
1579 char color
[COLOR_MAXLEN
] = "";
1581 if (color_parse("reset", color
) < 0)
1582 die("BUG: couldn't parse 'reset' as a color");
1584 append_atom(&resetv
, &state
);
1586 if (state
.stack
->prev
)
1587 die(_("format: %%(end) atom missing"));
1588 final_buf
= &state
.stack
->output
;
1589 fwrite(final_buf
->buf
, 1, final_buf
->len
, stdout
);
1590 pop_stack_element(&state
.stack
);
1594 /* If no sorting option is given, use refname to sort as default */
1595 struct ref_sorting
*ref_default_sorting(void)
1597 static const char cstr_name
[] = "refname";
1599 struct ref_sorting
*sorting
= xcalloc(1, sizeof(*sorting
));
1601 sorting
->next
= NULL
;
1602 sorting
->atom
= parse_ref_filter_atom(cstr_name
, cstr_name
+ strlen(cstr_name
));
1606 int parse_opt_ref_sorting(const struct option
*opt
, const char *arg
, int unset
)
1608 struct ref_sorting
**sorting_tail
= opt
->value
;
1609 struct ref_sorting
*s
;
1612 if (!arg
) /* should --no-sort void the list ? */
1615 s
= xcalloc(1, sizeof(*s
));
1616 s
->next
= *sorting_tail
;
1623 if (skip_prefix(arg
, "version:", &arg
) ||
1624 skip_prefix(arg
, "v:", &arg
))
1627 s
->atom
= parse_ref_filter_atom(arg
, arg
+len
);
1631 int parse_opt_merge_filter(const struct option
*opt
, const char *arg
, int unset
)
1633 struct ref_filter
*rf
= opt
->value
;
1634 unsigned char sha1
[20];
1636 rf
->merge
= starts_with(opt
->long_name
, "no")
1637 ? REF_FILTER_MERGED_OMIT
1638 : REF_FILTER_MERGED_INCLUDE
;
1640 if (get_sha1(arg
, sha1
))
1641 die(_("malformed object name %s"), arg
);
1643 rf
->merge_commit
= lookup_commit_reference_gently(sha1
, 0);
1644 if (!rf
->merge_commit
)
1645 return opterror(opt
, "must point to a commit", 0);