10 #include "parse-options.h"
16 #define QUOTE_PYTHON 4
19 typedef enum { FIELD_STR
, FIELD_ULONG
, FIELD_TIME
} cmp_type
;
23 unsigned long ul
; /* used for sorting when not FIELD_STR */
27 struct ref_sort
*next
;
28 int atom
; /* index into used_atom array */
34 unsigned char objectname
[20];
35 struct atom_value
*value
;
44 { "objectsize", FIELD_ULONG
},
48 { "numparent", FIELD_ULONG
},
55 { "authordate", FIELD_TIME
},
59 { "committerdate", FIELD_TIME
},
63 { "taggerdate", FIELD_TIME
},
65 { "creatordate", FIELD_TIME
},
72 * An atom is a valid field atom listed above, possibly prefixed with
73 * a "*" to denote deref_tag().
75 * We parse given format string and sort specifiers, and make a list
76 * of properties that we need to extract out of objects. refinfo
77 * structure will hold an array of values extracted that can be
78 * indexed with the "atom number", which is an index into this
81 static const char **used_atom
;
82 static cmp_type
*used_atom_type
;
83 static int used_atom_cnt
, sort_atom_limit
, need_tagged
;
86 * Used to parse format string and sort specifiers
88 static int parse_atom(const char *atom
, const char *ep
)
94 if (*sp
== '*' && sp
< ep
)
97 die("malformed field name: %.*s", (int)(ep
-atom
), atom
);
99 /* Do we have the atom already used elsewhere? */
100 for (i
= 0; i
< used_atom_cnt
; i
++) {
101 int len
= strlen(used_atom
[i
]);
102 if (len
== ep
- atom
&& !memcmp(used_atom
[i
], atom
, len
))
106 /* Is the atom a valid one? */
107 for (i
= 0; i
< ARRAY_SIZE(valid_atom
); i
++) {
108 int len
= strlen(valid_atom
[i
].name
);
110 * If the atom name has a colon, strip it and everything after
111 * it off - it specifies the format for this entry, and
112 * shouldn't be used for checking against the valid_atom
115 const char *formatp
= strchr(sp
, ':');
116 if (!formatp
|| ep
< formatp
)
118 if (len
== formatp
- sp
&& !memcmp(valid_atom
[i
].name
, sp
, len
))
122 if (ARRAY_SIZE(valid_atom
) <= i
)
123 die("unknown field name: %.*s", (int)(ep
-atom
), atom
);
125 /* Add it in, including the deref prefix */
128 used_atom
= xrealloc(used_atom
,
129 (sizeof *used_atom
) * used_atom_cnt
);
130 used_atom_type
= xrealloc(used_atom_type
,
131 (sizeof(*used_atom_type
) * used_atom_cnt
));
132 used_atom
[at
] = xmemdupz(atom
, ep
- atom
);
133 used_atom_type
[at
] = valid_atom
[i
].cmp_type
;
138 * In a format string, find the next occurrence of %(atom).
140 static const char *find_next(const char *cp
)
144 /* %( is the start of an atom;
145 * %% is a quoted per-cent.
149 else if (cp
[1] == '%')
150 cp
++; /* skip over two % */
151 /* otherwise this is a singleton, literal % */
159 * Make sure the format string is well formed, and parse out
162 static int verify_format(const char *format
)
165 for (cp
= format
; *cp
&& (sp
= find_next(cp
)); ) {
166 const char *ep
= strchr(sp
, ')');
168 return error("malformed format string %s", sp
);
169 /* sp points at "%(" and ep points at the closing ")" */
170 parse_atom(sp
+ 2, ep
);
177 * Given an object name, read the object data and size, and return a
178 * "struct object". If the object data we are returning is also borrowed
179 * by the "struct object" representation, set *eaten as well---it is a
180 * signal from parse_object_buffer to us not to free the buffer.
182 static void *get_obj(const unsigned char *sha1
, struct object
**obj
, unsigned long *sz
, int *eaten
)
184 enum object_type type
;
185 void *buf
= read_sha1_file(sha1
, &type
, sz
);
188 *obj
= parse_object_buffer(sha1
, type
, *sz
, buf
, eaten
);
194 /* See grab_values */
195 static void grab_common_values(struct atom_value
*val
, int deref
, struct object
*obj
, void *buf
, unsigned long sz
)
199 for (i
= 0; i
< used_atom_cnt
; i
++) {
200 const char *name
= used_atom
[i
];
201 struct atom_value
*v
= &val
[i
];
202 if (!!deref
!= (*name
== '*'))
206 if (!strcmp(name
, "objecttype"))
207 v
->s
= typename(obj
->type
);
208 else if (!strcmp(name
, "objectsize")) {
209 char *s
= xmalloc(40);
210 sprintf(s
, "%lu", sz
);
214 else if (!strcmp(name
, "objectname")) {
215 char *s
= xmalloc(41);
216 strcpy(s
, sha1_to_hex(obj
->sha1
));
222 /* See grab_values */
223 static void grab_tag_values(struct atom_value
*val
, int deref
, struct object
*obj
, void *buf
, unsigned long sz
)
226 struct tag
*tag
= (struct tag
*) obj
;
228 for (i
= 0; i
< used_atom_cnt
; i
++) {
229 const char *name
= used_atom
[i
];
230 struct atom_value
*v
= &val
[i
];
231 if (!!deref
!= (*name
== '*'))
235 if (!strcmp(name
, "tag"))
237 else if (!strcmp(name
, "type") && tag
->tagged
)
238 v
->s
= typename(tag
->tagged
->type
);
239 else if (!strcmp(name
, "object") && tag
->tagged
) {
240 char *s
= xmalloc(41);
241 strcpy(s
, sha1_to_hex(tag
->tagged
->sha1
));
247 static int num_parents(struct commit
*commit
)
249 struct commit_list
*parents
;
252 for (i
= 0, parents
= commit
->parents
;
254 parents
= parents
->next
)
259 /* See grab_values */
260 static void grab_commit_values(struct atom_value
*val
, int deref
, struct object
*obj
, void *buf
, unsigned long sz
)
263 struct commit
*commit
= (struct commit
*) obj
;
265 for (i
= 0; i
< used_atom_cnt
; i
++) {
266 const char *name
= used_atom
[i
];
267 struct atom_value
*v
= &val
[i
];
268 if (!!deref
!= (*name
== '*'))
272 if (!strcmp(name
, "tree")) {
273 char *s
= xmalloc(41);
274 strcpy(s
, sha1_to_hex(commit
->tree
->object
.sha1
));
277 if (!strcmp(name
, "numparent")) {
278 char *s
= xmalloc(40);
279 v
->ul
= num_parents(commit
);
280 sprintf(s
, "%lu", v
->ul
);
283 else if (!strcmp(name
, "parent")) {
284 int num
= num_parents(commit
);
286 struct commit_list
*parents
;
287 char *s
= xmalloc(41 * num
+ 1);
289 for (i
= 0, parents
= commit
->parents
;
291 parents
= parents
->next
, i
= i
+ 41) {
292 struct commit
*parent
= parents
->item
;
293 strcpy(s
+i
, sha1_to_hex(parent
->object
.sha1
));
303 static const char *find_wholine(const char *who
, int wholen
, const char *buf
, unsigned long sz
)
307 if (!strncmp(buf
, who
, wholen
) &&
309 return buf
+ wholen
+ 1;
310 eol
= strchr(buf
, '\n');
315 return ""; /* end of header */
321 static const char *copy_line(const char *buf
)
323 const char *eol
= strchr(buf
, '\n');
326 return xmemdupz(buf
, eol
- buf
);
329 static const char *copy_name(const char *buf
)
332 for (cp
= buf
; *cp
&& *cp
!= '\n'; cp
++) {
333 if (!strncmp(cp
, " <", 2))
334 return xmemdupz(buf
, cp
- buf
);
339 static const char *copy_email(const char *buf
)
341 const char *email
= strchr(buf
, '<');
342 const char *eoemail
= strchr(email
, '>');
343 if (!email
|| !eoemail
)
345 return xmemdupz(email
, eoemail
+ 1 - email
);
348 static void grab_date(const char *buf
, struct atom_value
*v
, const char *atomname
)
350 const char *eoemail
= strstr(buf
, "> ");
352 unsigned long timestamp
;
354 enum date_mode date_mode
= DATE_NORMAL
;
358 * We got here because atomname ends in "date" or "date<something>";
359 * it's not possible that <something> is not ":<format>" because
360 * parse_atom() wouldn't have allowed it, so we can assume that no
361 * ":" means no format is specified, and use the default.
363 formatp
= strchr(atomname
, ':');
364 if (formatp
!= NULL
) {
366 date_mode
= parse_date_format(formatp
);
371 timestamp
= strtoul(eoemail
+ 2, &zone
, 10);
372 if (timestamp
== ULONG_MAX
)
374 tz
= strtol(zone
, NULL
, 10);
375 if ((tz
== LONG_MIN
|| tz
== LONG_MAX
) && errno
== ERANGE
)
377 v
->s
= xstrdup(show_date(timestamp
, tz
, date_mode
));
385 /* See grab_values */
386 static void grab_person(const char *who
, struct atom_value
*val
, int deref
, struct object
*obj
, void *buf
, unsigned long sz
)
389 int wholen
= strlen(who
);
390 const char *wholine
= NULL
;
392 for (i
= 0; i
< used_atom_cnt
; i
++) {
393 const char *name
= used_atom
[i
];
394 struct atom_value
*v
= &val
[i
];
395 if (!!deref
!= (*name
== '*'))
399 if (strncmp(who
, name
, wholen
))
401 if (name
[wholen
] != 0 &&
402 strcmp(name
+ wholen
, "name") &&
403 strcmp(name
+ wholen
, "email") &&
404 prefixcmp(name
+ wholen
, "date"))
407 wholine
= find_wholine(who
, wholen
, buf
, sz
);
409 return; /* no point looking for it */
410 if (name
[wholen
] == 0)
411 v
->s
= copy_line(wholine
);
412 else if (!strcmp(name
+ wholen
, "name"))
413 v
->s
= copy_name(wholine
);
414 else if (!strcmp(name
+ wholen
, "email"))
415 v
->s
= copy_email(wholine
);
416 else if (!prefixcmp(name
+ wholen
, "date"))
417 grab_date(wholine
, v
, name
);
420 /* For a tag or a commit object, if "creator" or "creatordate" is
421 * requested, do something special.
423 if (strcmp(who
, "tagger") && strcmp(who
, "committer"))
424 return; /* "author" for commit object is not wanted */
426 wholine
= find_wholine(who
, wholen
, buf
, sz
);
429 for (i
= 0; i
< used_atom_cnt
; i
++) {
430 const char *name
= used_atom
[i
];
431 struct atom_value
*v
= &val
[i
];
432 if (!!deref
!= (*name
== '*'))
437 if (!prefixcmp(name
, "creatordate"))
438 grab_date(wholine
, v
, name
);
439 else if (!strcmp(name
, "creator"))
440 v
->s
= copy_line(wholine
);
444 static void find_subpos(const char *buf
, unsigned long sz
, const char **sub
, const char **body
)
447 const char *eol
= strchr(buf
, '\n');
450 if (eol
[1] == '\n') {
452 break; /* found end of header */
460 *sub
= buf
; /* first non-empty line */
461 buf
= strchr(buf
, '\n');
464 return; /* no body */
467 buf
++; /* skip blank between subject and body */
471 /* See grab_values */
472 static void grab_sub_body_contents(struct atom_value
*val
, int deref
, struct object
*obj
, void *buf
, unsigned long sz
)
475 const char *subpos
= NULL
, *bodypos
= NULL
;
477 for (i
= 0; i
< used_atom_cnt
; i
++) {
478 const char *name
= used_atom
[i
];
479 struct atom_value
*v
= &val
[i
];
480 if (!!deref
!= (*name
== '*'))
484 if (strcmp(name
, "subject") &&
485 strcmp(name
, "body") &&
486 strcmp(name
, "contents"))
489 find_subpos(buf
, sz
, &subpos
, &bodypos
);
493 if (!strcmp(name
, "subject"))
494 v
->s
= copy_line(subpos
);
495 else if (!strcmp(name
, "body"))
496 v
->s
= xstrdup(bodypos
);
497 else if (!strcmp(name
, "contents"))
498 v
->s
= xstrdup(subpos
);
502 /* We want to have empty print-string for field requests
503 * that do not apply (e.g. "authordate" for a tag object)
505 static void fill_missing_values(struct atom_value
*val
)
508 for (i
= 0; i
< used_atom_cnt
; i
++) {
509 struct atom_value
*v
= &val
[i
];
516 * val is a list of atom_value to hold returned values. Extract
517 * the values for atoms in used_atom array out of (obj, buf, sz).
518 * when deref is false, (obj, buf, sz) is the object that is
519 * pointed at by the ref itself; otherwise it is the object the
520 * ref (which is a tag) refers to.
522 static void grab_values(struct atom_value
*val
, int deref
, struct object
*obj
, void *buf
, unsigned long sz
)
524 grab_common_values(val
, deref
, obj
, buf
, sz
);
527 grab_tag_values(val
, deref
, obj
, buf
, sz
);
528 grab_sub_body_contents(val
, deref
, obj
, buf
, sz
);
529 grab_person("tagger", val
, deref
, obj
, buf
, sz
);
532 grab_commit_values(val
, deref
, obj
, buf
, sz
);
533 grab_sub_body_contents(val
, deref
, obj
, buf
, sz
);
534 grab_person("author", val
, deref
, obj
, buf
, sz
);
535 grab_person("committer", val
, deref
, obj
, buf
, sz
);
538 // grab_tree_values(val, deref, obj, buf, sz);
541 // grab_blob_values(val, deref, obj, buf, sz);
544 die("Eh? Object of type %d?", obj
->type
);
549 * Parse the object referred by ref, and grab needed value.
551 static void populate_value(struct refinfo
*ref
)
557 const unsigned char *tagged
;
559 ref
->value
= xcalloc(sizeof(struct atom_value
), used_atom_cnt
);
561 buf
= get_obj(ref
->objectname
, &obj
, &size
, &eaten
);
563 die("missing object %s for %s",
564 sha1_to_hex(ref
->objectname
), ref
->refname
);
566 die("parse_object_buffer failed on %s for %s",
567 sha1_to_hex(ref
->objectname
), ref
->refname
);
569 /* Fill in specials first */
570 for (i
= 0; i
< used_atom_cnt
; i
++) {
571 const char *name
= used_atom
[i
];
572 struct atom_value
*v
= &ref
->value
[i
];
573 if (!strcmp(name
, "refname"))
575 else if (!strcmp(name
, "*refname")) {
576 int len
= strlen(ref
->refname
);
577 char *s
= xmalloc(len
+ 4);
578 sprintf(s
, "%s^{}", ref
->refname
);
583 grab_values(ref
->value
, 0, obj
, buf
, size
);
587 /* If there is no atom that wants to know about tagged
588 * object, we are done.
590 if (!need_tagged
|| (obj
->type
!= OBJ_TAG
))
593 /* If it is a tag object, see if we use a value that derefs
594 * the object, and if we do grab the object it refers to.
596 tagged
= ((struct tag
*)obj
)->tagged
->sha1
;
598 /* NEEDSWORK: This derefs tag only once, which
599 * is good to deal with chains of trust, but
600 * is not consistent with what deref_tag() does
601 * which peels the onion to the core.
603 buf
= get_obj(tagged
, &obj
, &size
, &eaten
);
605 die("missing object %s for %s",
606 sha1_to_hex(tagged
), ref
->refname
);
608 die("parse_object_buffer failed on %s for %s",
609 sha1_to_hex(tagged
), ref
->refname
);
610 grab_values(ref
->value
, 1, obj
, buf
, size
);
616 * Given a ref, return the value for the atom. This lazily gets value
617 * out of the object by calling populate value.
619 static void get_value(struct refinfo
*ref
, int atom
, struct atom_value
**v
)
623 fill_missing_values(ref
->value
);
625 *v
= &ref
->value
[atom
];
628 struct grab_ref_cbdata
{
629 struct refinfo
**grab_array
;
630 const char **grab_pattern
;
635 * A call-back given to for_each_ref(). It is unfortunate that we
636 * need to use global variables to pass extra information to this
639 static int grab_single_ref(const char *refname
, const unsigned char *sha1
, int flag
, void *cb_data
)
641 struct grab_ref_cbdata
*cb
= cb_data
;
645 if (*cb
->grab_pattern
) {
646 const char **pattern
;
647 int namelen
= strlen(refname
);
648 for (pattern
= cb
->grab_pattern
; *pattern
; pattern
++) {
649 const char *p
= *pattern
;
650 int plen
= strlen(p
);
652 if ((plen
<= namelen
) &&
653 !strncmp(refname
, p
, plen
) &&
654 (refname
[plen
] == '\0' ||
655 refname
[plen
] == '/'))
657 if (!fnmatch(p
, refname
, FNM_PATHNAME
))
664 /* We do not open the object yet; sort may only need refname
665 * to do its job and the resulting list may yet to be pruned
668 ref
= xcalloc(1, sizeof(*ref
));
669 ref
->refname
= xstrdup(refname
);
670 hashcpy(ref
->objectname
, sha1
);
673 cb
->grab_array
= xrealloc(cb
->grab_array
,
674 sizeof(*cb
->grab_array
) * (cnt
+ 1));
675 cb
->grab_array
[cnt
++] = ref
;
680 static int cmp_ref_sort(struct ref_sort
*s
, struct refinfo
*a
, struct refinfo
*b
)
682 struct atom_value
*va
, *vb
;
684 cmp_type cmp_type
= used_atom_type
[s
->atom
];
686 get_value(a
, s
->atom
, &va
);
687 get_value(b
, s
->atom
, &vb
);
690 cmp
= strcmp(va
->s
, vb
->s
);
695 else if (va
->ul
== vb
->ul
)
701 return (s
->reverse
) ? -cmp
: cmp
;
704 static struct ref_sort
*ref_sort
;
705 static int compare_refs(const void *a_
, const void *b_
)
707 struct refinfo
*a
= *((struct refinfo
**)a_
);
708 struct refinfo
*b
= *((struct refinfo
**)b_
);
711 for (s
= ref_sort
; s
; s
= s
->next
) {
712 int cmp
= cmp_ref_sort(s
, a
, b
);
719 static void sort_refs(struct ref_sort
*sort
, struct refinfo
**refs
, int num_refs
)
722 qsort(refs
, num_refs
, sizeof(struct refinfo
*), compare_refs
);
725 static void print_value(struct refinfo
*ref
, int atom
, int quote_style
)
727 struct atom_value
*v
;
728 get_value(ref
, atom
, &v
);
729 switch (quote_style
) {
734 sq_quote_print(stdout
, v
->s
);
737 perl_quote_print(stdout
, v
->s
);
740 python_quote_print(stdout
, v
->s
);
743 tcl_quote_print(stdout
, v
->s
);
748 static int hex1(char ch
)
750 if ('0' <= ch
&& ch
<= '9')
752 else if ('a' <= ch
&& ch
<= 'f')
753 return ch
- 'a' + 10;
754 else if ('A' <= ch
&& ch
<= 'F')
755 return ch
- 'A' + 10;
758 static int hex2(const char *cp
)
761 return (hex1(cp
[0]) << 4) | hex1(cp
[1]);
766 static void emit(const char *cp
, const char *ep
)
768 while (*cp
&& (!ep
|| cp
< ep
)) {
773 int ch
= hex2(cp
+ 1);
786 static void show_ref(struct refinfo
*info
, const char *format
, int quote_style
)
788 const char *cp
, *sp
, *ep
;
790 for (cp
= format
; *cp
&& (sp
= find_next(cp
)); cp
= ep
+ 1) {
791 ep
= strchr(sp
, ')');
794 print_value(info
, parse_atom(sp
+ 2, ep
), quote_style
);
797 sp
= cp
+ strlen(cp
);
803 static struct ref_sort
*default_sort(void)
805 static const char cstr_name
[] = "refname";
807 struct ref_sort
*sort
= xcalloc(1, sizeof(*sort
));
810 sort
->atom
= parse_atom(cstr_name
, cstr_name
+ strlen(cstr_name
));
814 static int opt_parse_sort(const struct option
*opt
, const char *arg
, int unset
)
816 struct ref_sort
**sort_tail
= opt
->value
;
820 if (!arg
) /* should --no-sort void the list ? */
823 *sort_tail
= s
= xcalloc(1, sizeof(*s
));
824 sort_tail
= &s
->next
;
831 s
->atom
= parse_atom(arg
, arg
+len
);
835 static char const * const for_each_ref_usage
[] = {
836 "git for-each-ref [options] [<pattern>]",
840 int cmd_for_each_ref(int argc
, const char **argv
, const char *prefix
)
843 const char *format
= "%(objectname) %(objecttype)\t%(refname)";
844 struct ref_sort
*sort
= NULL
, **sort_tail
= &sort
;
845 int maxcount
= 0, quote_style
= 0;
846 struct refinfo
**refs
;
847 struct grab_ref_cbdata cbdata
;
849 struct option opts
[] = {
850 OPT_BIT('s', "shell", "e_style
,
851 "quote placeholders suitably for shells", QUOTE_SHELL
),
852 OPT_BIT('p', "perl", "e_style
,
853 "quote placeholders suitably for perl", QUOTE_PERL
),
854 OPT_BIT(0 , "python", "e_style
,
855 "quote placeholders suitably for python", QUOTE_PYTHON
),
856 OPT_BIT(0 , "tcl", "e_style
,
857 "quote placeholders suitably for tcl", QUOTE_TCL
),
860 OPT_INTEGER( 0 , "count", &maxcount
, "show only <n> matched refs"),
861 OPT_STRING( 0 , "format", &format
, "format", "format to use for the output"),
862 OPT_CALLBACK(0 , "sort", sort_tail
, "key",
863 "field name to sort on", &opt_parse_sort
),
867 parse_options(argc
, argv
, opts
, for_each_ref_usage
, 0);
869 error("invalid --count argument: `%d'", maxcount
);
870 usage_with_options(for_each_ref_usage
, opts
);
872 if (HAS_MULTI_BITS(quote_style
)) {
873 error("more than one quoting style?");
874 usage_with_options(for_each_ref_usage
, opts
);
876 if (verify_format(format
))
877 usage_with_options(for_each_ref_usage
, opts
);
880 sort
= default_sort();
881 sort_atom_limit
= used_atom_cnt
;
883 memset(&cbdata
, 0, sizeof(cbdata
));
884 cbdata
.grab_pattern
= argv
;
885 for_each_ref(grab_single_ref
, &cbdata
);
886 refs
= cbdata
.grab_array
;
887 num_refs
= cbdata
.grab_cnt
;
889 for (i
= 0; i
< used_atom_cnt
; i
++) {
890 if (used_atom
[i
][0] == '*') {
896 sort_refs(sort
, refs
, num_refs
);
898 if (!maxcount
|| num_refs
< maxcount
)
900 for (i
= 0; i
< maxcount
; i
++)
901 show_ref(refs
[i
], format
, quote_style
);