silence gcc array-bounds warning
[git.git] / builtin-for-each-ref.c
blobc8114c8afdb5e5d8a5f0adac2302aa97c384d232
1 #include "builtin.h"
2 #include "cache.h"
3 #include "refs.h"
4 #include "object.h"
5 #include "tag.h"
6 #include "commit.h"
7 #include "tree.h"
8 #include "blob.h"
9 #include "quote.h"
10 #include "parse-options.h"
11 #include "remote.h"
13 /* Quoting styles */
14 #define QUOTE_NONE 0
15 #define QUOTE_SHELL 1
16 #define QUOTE_PERL 2
17 #define QUOTE_PYTHON 4
18 #define QUOTE_TCL 8
20 typedef enum { FIELD_STR, FIELD_ULONG, FIELD_TIME } cmp_type;
22 struct atom_value {
23 const char *s;
24 unsigned long ul; /* used for sorting when not FIELD_STR */
27 struct ref_sort {
28 struct ref_sort *next;
29 int atom; /* index into used_atom array */
30 unsigned reverse : 1;
33 struct refinfo {
34 char *refname;
35 unsigned char objectname[20];
36 struct atom_value *value;
39 static struct {
40 const char *name;
41 cmp_type cmp_type;
42 } valid_atom[] = {
43 { "refname" },
44 { "objecttype" },
45 { "objectsize", FIELD_ULONG },
46 { "objectname" },
47 { "tree" },
48 { "parent" },
49 { "numparent", FIELD_ULONG },
50 { "object" },
51 { "type" },
52 { "tag" },
53 { "author" },
54 { "authorname" },
55 { "authoremail" },
56 { "authordate", FIELD_TIME },
57 { "committer" },
58 { "committername" },
59 { "committeremail" },
60 { "committerdate", FIELD_TIME },
61 { "tagger" },
62 { "taggername" },
63 { "taggeremail" },
64 { "taggerdate", FIELD_TIME },
65 { "creator" },
66 { "creatordate", FIELD_TIME },
67 { "subject" },
68 { "body" },
69 { "contents" },
70 { "upstream" },
74 * An atom is a valid field atom listed above, possibly prefixed with
75 * a "*" to denote deref_tag().
77 * We parse given format string and sort specifiers, and make a list
78 * of properties that we need to extract out of objects. refinfo
79 * structure will hold an array of values extracted that can be
80 * indexed with the "atom number", which is an index into this
81 * array.
83 static const char **used_atom;
84 static cmp_type *used_atom_type;
85 static int used_atom_cnt, sort_atom_limit, need_tagged;
88 * Used to parse format string and sort specifiers
90 static int parse_atom(const char *atom, const char *ep)
92 const char *sp;
93 int i, at;
95 sp = atom;
96 if (*sp == '*' && sp < ep)
97 sp++; /* deref */
98 if (ep <= sp)
99 die("malformed field name: %.*s", (int)(ep-atom), atom);
101 /* Do we have the atom already used elsewhere? */
102 for (i = 0; i < used_atom_cnt; i++) {
103 int len = strlen(used_atom[i]);
104 if (len == ep - atom && !memcmp(used_atom[i], atom, len))
105 return i;
108 /* Is the atom a valid one? */
109 for (i = 0; i < ARRAY_SIZE(valid_atom); i++) {
110 int len = strlen(valid_atom[i].name);
112 * If the atom name has a colon, strip it and everything after
113 * it off - it specifies the format for this entry, and
114 * shouldn't be used for checking against the valid_atom
115 * table.
117 const char *formatp = strchr(sp, ':');
118 if (!formatp || ep < formatp)
119 formatp = ep;
120 if (len == formatp - sp && !memcmp(valid_atom[i].name, sp, len))
121 break;
124 if (ARRAY_SIZE(valid_atom) <= i)
125 die("unknown field name: %.*s", (int)(ep-atom), atom);
127 /* Add it in, including the deref prefix */
128 at = used_atom_cnt;
129 used_atom_cnt++;
130 used_atom = xrealloc(used_atom,
131 (sizeof *used_atom) * used_atom_cnt);
132 used_atom_type = xrealloc(used_atom_type,
133 (sizeof(*used_atom_type) * used_atom_cnt));
134 used_atom[at] = xmemdupz(atom, ep - atom);
135 used_atom_type[at] = valid_atom[i].cmp_type;
136 return at;
140 * In a format string, find the next occurrence of %(atom).
142 static const char *find_next(const char *cp)
144 while (*cp) {
145 if (*cp == '%') {
146 /* %( is the start of an atom;
147 * %% is a quoted per-cent.
149 if (cp[1] == '(')
150 return cp;
151 else if (cp[1] == '%')
152 cp++; /* skip over two % */
153 /* otherwise this is a singleton, literal % */
155 cp++;
157 return NULL;
161 * Make sure the format string is well formed, and parse out
162 * the used atoms.
164 static int verify_format(const char *format)
166 const char *cp, *sp;
167 for (cp = format; *cp && (sp = find_next(cp)); ) {
168 const char *ep = strchr(sp, ')');
169 if (!ep)
170 return error("malformed format string %s", sp);
171 /* sp points at "%(" and ep points at the closing ")" */
172 parse_atom(sp + 2, ep);
173 cp = ep + 1;
175 return 0;
179 * Given an object name, read the object data and size, and return a
180 * "struct object". If the object data we are returning is also borrowed
181 * by the "struct object" representation, set *eaten as well---it is a
182 * signal from parse_object_buffer to us not to free the buffer.
184 static void *get_obj(const unsigned char *sha1, struct object **obj, unsigned long *sz, int *eaten)
186 enum object_type type;
187 void *buf = read_sha1_file(sha1, &type, sz);
189 if (buf)
190 *obj = parse_object_buffer(sha1, type, *sz, buf, eaten);
191 else
192 *obj = NULL;
193 return buf;
196 /* See grab_values */
197 static void grab_common_values(struct atom_value *val, int deref, struct object *obj, void *buf, unsigned long sz)
199 int i;
201 for (i = 0; i < used_atom_cnt; i++) {
202 const char *name = used_atom[i];
203 struct atom_value *v = &val[i];
204 if (!!deref != (*name == '*'))
205 continue;
206 if (deref)
207 name++;
208 if (!strcmp(name, "objecttype"))
209 v->s = typename(obj->type);
210 else if (!strcmp(name, "objectsize")) {
211 char *s = xmalloc(40);
212 sprintf(s, "%lu", sz);
213 v->ul = sz;
214 v->s = s;
216 else if (!strcmp(name, "objectname")) {
217 char *s = xmalloc(41);
218 strcpy(s, sha1_to_hex(obj->sha1));
219 v->s = s;
224 /* See grab_values */
225 static void grab_tag_values(struct atom_value *val, int deref, struct object *obj, void *buf, unsigned long sz)
227 int i;
228 struct tag *tag = (struct tag *) obj;
230 for (i = 0; i < used_atom_cnt; i++) {
231 const char *name = used_atom[i];
232 struct atom_value *v = &val[i];
233 if (!!deref != (*name == '*'))
234 continue;
235 if (deref)
236 name++;
237 if (!strcmp(name, "tag"))
238 v->s = tag->tag;
239 else if (!strcmp(name, "type") && tag->tagged)
240 v->s = typename(tag->tagged->type);
241 else if (!strcmp(name, "object") && tag->tagged) {
242 char *s = xmalloc(41);
243 strcpy(s, sha1_to_hex(tag->tagged->sha1));
244 v->s = s;
249 static int num_parents(struct commit *commit)
251 struct commit_list *parents;
252 int i;
254 for (i = 0, parents = commit->parents;
255 parents;
256 parents = parents->next)
257 i++;
258 return i;
261 /* See grab_values */
262 static void grab_commit_values(struct atom_value *val, int deref, struct object *obj, void *buf, unsigned long sz)
264 int i;
265 struct commit *commit = (struct commit *) obj;
267 for (i = 0; i < used_atom_cnt; i++) {
268 const char *name = used_atom[i];
269 struct atom_value *v = &val[i];
270 if (!!deref != (*name == '*'))
271 continue;
272 if (deref)
273 name++;
274 if (!strcmp(name, "tree")) {
275 char *s = xmalloc(41);
276 strcpy(s, sha1_to_hex(commit->tree->object.sha1));
277 v->s = s;
279 if (!strcmp(name, "numparent")) {
280 char *s = xmalloc(40);
281 v->ul = num_parents(commit);
282 sprintf(s, "%lu", v->ul);
283 v->s = s;
285 else if (!strcmp(name, "parent")) {
286 int num = num_parents(commit);
287 int i;
288 struct commit_list *parents;
289 char *s = xmalloc(41 * num + 1);
290 v->s = s;
291 for (i = 0, parents = commit->parents;
292 parents;
293 parents = parents->next, i = i + 41) {
294 struct commit *parent = parents->item;
295 strcpy(s+i, sha1_to_hex(parent->object.sha1));
296 if (parents->next)
297 s[i+40] = ' ';
299 if (!i)
300 *s = '\0';
305 static const char *find_wholine(const char *who, int wholen, const char *buf, unsigned long sz)
307 const char *eol;
308 while (*buf) {
309 if (!strncmp(buf, who, wholen) &&
310 buf[wholen] == ' ')
311 return buf + wholen + 1;
312 eol = strchr(buf, '\n');
313 if (!eol)
314 return "";
315 eol++;
316 if (*eol == '\n')
317 return ""; /* end of header */
318 buf = eol;
320 return "";
323 static const char *copy_line(const char *buf)
325 const char *eol = strchrnul(buf, '\n');
326 return xmemdupz(buf, eol - buf);
329 static const char *copy_name(const char *buf)
331 const char *cp;
332 for (cp = buf; *cp && *cp != '\n'; cp++) {
333 if (!strncmp(cp, " <", 2))
334 return xmemdupz(buf, cp - buf);
336 return "";
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)
344 return "";
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, "> ");
351 char *zone;
352 unsigned long timestamp;
353 long tz;
354 enum date_mode date_mode = DATE_NORMAL;
355 const char *formatp;
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) {
365 formatp++;
366 date_mode = parse_date_format(formatp);
369 if (!eoemail)
370 goto bad;
371 timestamp = strtoul(eoemail + 2, &zone, 10);
372 if (timestamp == ULONG_MAX)
373 goto bad;
374 tz = strtol(zone, NULL, 10);
375 if ((tz == LONG_MIN || tz == LONG_MAX) && errno == ERANGE)
376 goto bad;
377 v->s = xstrdup(show_date(timestamp, tz, date_mode));
378 v->ul = timestamp;
379 return;
380 bad:
381 v->s = "";
382 v->ul = 0;
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)
388 int i;
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 == '*'))
396 continue;
397 if (deref)
398 name++;
399 if (strncmp(who, name, wholen))
400 continue;
401 if (name[wholen] != 0 &&
402 strcmp(name + wholen, "name") &&
403 strcmp(name + wholen, "email") &&
404 prefixcmp(name + wholen, "date"))
405 continue;
406 if (!wholine)
407 wholine = find_wholine(who, wholen, buf, sz);
408 if (!wholine)
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 */
425 if (!wholine)
426 wholine = find_wholine(who, wholen, buf, sz);
427 if (!wholine)
428 return;
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 == '*'))
433 continue;
434 if (deref)
435 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)
446 while (*buf) {
447 const char *eol = strchr(buf, '\n');
448 if (!eol)
449 return;
450 if (eol[1] == '\n') {
451 buf = eol + 1;
452 break; /* found end of header */
454 buf = eol + 1;
456 while (*buf == '\n')
457 buf++;
458 if (!*buf)
459 return;
460 *sub = buf; /* first non-empty line */
461 buf = strchr(buf, '\n');
462 if (!buf) {
463 *body = "";
464 return; /* no body */
466 while (*buf == '\n')
467 buf++; /* skip blank between subject and body */
468 *body = buf;
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)
474 int i;
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 == '*'))
481 continue;
482 if (deref)
483 name++;
484 if (strcmp(name, "subject") &&
485 strcmp(name, "body") &&
486 strcmp(name, "contents"))
487 continue;
488 if (!subpos)
489 find_subpos(buf, sz, &subpos, &bodypos);
490 if (!subpos)
491 return;
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)
507 int i;
508 for (i = 0; i < used_atom_cnt; i++) {
509 struct atom_value *v = &val[i];
510 if (v->s == NULL)
511 v->s = "";
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);
525 switch (obj->type) {
526 case OBJ_TAG:
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);
530 break;
531 case OBJ_COMMIT:
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);
536 break;
537 case OBJ_TREE:
538 // grab_tree_values(val, deref, obj, buf, sz);
539 break;
540 case OBJ_BLOB:
541 // grab_blob_values(val, deref, obj, buf, sz);
542 break;
543 default:
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)
553 void *buf;
554 struct object *obj;
555 int eaten, i;
556 unsigned long size;
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);
562 if (!buf)
563 die("missing object %s for %s",
564 sha1_to_hex(ref->objectname), ref->refname);
565 if (!obj)
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 int deref = 0;
574 const char *refname;
575 const char *formatp;
577 if (*name == '*') {
578 deref = 1;
579 name++;
582 if (!prefixcmp(name, "refname"))
583 refname = ref->refname;
584 else if(!prefixcmp(name, "upstream")) {
585 struct branch *branch;
586 /* only local branches may have an upstream */
587 if (prefixcmp(ref->refname, "refs/heads/"))
588 continue;
589 branch = branch_get(ref->refname + 11);
591 if (!branch || !branch->merge || !branch->merge[0] ||
592 !branch->merge[0]->dst)
593 continue;
594 refname = branch->merge[0]->dst;
596 else
597 continue;
599 formatp = strchr(name, ':');
600 /* look for "short" refname format */
601 if (formatp) {
602 formatp++;
603 if (!strcmp(formatp, "short"))
604 refname = shorten_unambiguous_ref(refname);
605 else
606 die("unknown %.*s format %s",
607 (int)(formatp - name), name, formatp);
610 if (!deref)
611 v->s = refname;
612 else {
613 int len = strlen(refname);
614 char *s = xmalloc(len + 4);
615 sprintf(s, "%s^{}", refname);
616 v->s = s;
620 grab_values(ref->value, 0, obj, buf, size);
621 if (!eaten)
622 free(buf);
624 /* If there is no atom that wants to know about tagged
625 * object, we are done.
627 if (!need_tagged || (obj->type != OBJ_TAG))
628 return;
630 /* If it is a tag object, see if we use a value that derefs
631 * the object, and if we do grab the object it refers to.
633 tagged = ((struct tag *)obj)->tagged->sha1;
635 /* NEEDSWORK: This derefs tag only once, which
636 * is good to deal with chains of trust, but
637 * is not consistent with what deref_tag() does
638 * which peels the onion to the core.
640 buf = get_obj(tagged, &obj, &size, &eaten);
641 if (!buf)
642 die("missing object %s for %s",
643 sha1_to_hex(tagged), ref->refname);
644 if (!obj)
645 die("parse_object_buffer failed on %s for %s",
646 sha1_to_hex(tagged), ref->refname);
647 grab_values(ref->value, 1, obj, buf, size);
648 if (!eaten)
649 free(buf);
653 * Given a ref, return the value for the atom. This lazily gets value
654 * out of the object by calling populate value.
656 static void get_value(struct refinfo *ref, int atom, struct atom_value **v)
658 if (!ref->value) {
659 populate_value(ref);
660 fill_missing_values(ref->value);
662 *v = &ref->value[atom];
665 struct grab_ref_cbdata {
666 struct refinfo **grab_array;
667 const char **grab_pattern;
668 int grab_cnt;
672 * A call-back given to for_each_ref(). It is unfortunate that we
673 * need to use global variables to pass extra information to this
674 * function.
676 static int grab_single_ref(const char *refname, const unsigned char *sha1, int flag, void *cb_data)
678 struct grab_ref_cbdata *cb = cb_data;
679 struct refinfo *ref;
680 int cnt;
682 if (*cb->grab_pattern) {
683 const char **pattern;
684 int namelen = strlen(refname);
685 for (pattern = cb->grab_pattern; *pattern; pattern++) {
686 const char *p = *pattern;
687 int plen = strlen(p);
689 if ((plen <= namelen) &&
690 !strncmp(refname, p, plen) &&
691 (refname[plen] == '\0' ||
692 refname[plen] == '/' ||
693 p[plen-1] == '/'))
694 break;
695 if (!fnmatch(p, refname, FNM_PATHNAME))
696 break;
698 if (!*pattern)
699 return 0;
702 /* We do not open the object yet; sort may only need refname
703 * to do its job and the resulting list may yet to be pruned
704 * by maxcount logic.
706 ref = xcalloc(1, sizeof(*ref));
707 ref->refname = xstrdup(refname);
708 hashcpy(ref->objectname, sha1);
710 cnt = cb->grab_cnt;
711 cb->grab_array = xrealloc(cb->grab_array,
712 sizeof(*cb->grab_array) * (cnt + 1));
713 cb->grab_array[cnt++] = ref;
714 cb->grab_cnt = cnt;
715 return 0;
718 static int cmp_ref_sort(struct ref_sort *s, struct refinfo *a, struct refinfo *b)
720 struct atom_value *va, *vb;
721 int cmp;
722 cmp_type cmp_type = used_atom_type[s->atom];
724 get_value(a, s->atom, &va);
725 get_value(b, s->atom, &vb);
726 switch (cmp_type) {
727 case FIELD_STR:
728 cmp = strcmp(va->s, vb->s);
729 break;
730 default:
731 if (va->ul < vb->ul)
732 cmp = -1;
733 else if (va->ul == vb->ul)
734 cmp = 0;
735 else
736 cmp = 1;
737 break;
739 return (s->reverse) ? -cmp : cmp;
742 static struct ref_sort *ref_sort;
743 static int compare_refs(const void *a_, const void *b_)
745 struct refinfo *a = *((struct refinfo **)a_);
746 struct refinfo *b = *((struct refinfo **)b_);
747 struct ref_sort *s;
749 for (s = ref_sort; s; s = s->next) {
750 int cmp = cmp_ref_sort(s, a, b);
751 if (cmp)
752 return cmp;
754 return 0;
757 static void sort_refs(struct ref_sort *sort, struct refinfo **refs, int num_refs)
759 ref_sort = sort;
760 qsort(refs, num_refs, sizeof(struct refinfo *), compare_refs);
763 static void print_value(struct refinfo *ref, int atom, int quote_style)
765 struct atom_value *v;
766 get_value(ref, atom, &v);
767 switch (quote_style) {
768 case QUOTE_NONE:
769 fputs(v->s, stdout);
770 break;
771 case QUOTE_SHELL:
772 sq_quote_print(stdout, v->s);
773 break;
774 case QUOTE_PERL:
775 perl_quote_print(stdout, v->s);
776 break;
777 case QUOTE_PYTHON:
778 python_quote_print(stdout, v->s);
779 break;
780 case QUOTE_TCL:
781 tcl_quote_print(stdout, v->s);
782 break;
786 static int hex1(char ch)
788 if ('0' <= ch && ch <= '9')
789 return ch - '0';
790 else if ('a' <= ch && ch <= 'f')
791 return ch - 'a' + 10;
792 else if ('A' <= ch && ch <= 'F')
793 return ch - 'A' + 10;
794 return -1;
796 static int hex2(const char *cp)
798 if (cp[0] && cp[1])
799 return (hex1(cp[0]) << 4) | hex1(cp[1]);
800 else
801 return -1;
804 static void emit(const char *cp, const char *ep)
806 while (*cp && (!ep || cp < ep)) {
807 if (*cp == '%') {
808 if (cp[1] == '%')
809 cp++;
810 else {
811 int ch = hex2(cp + 1);
812 if (0 <= ch) {
813 putchar(ch);
814 cp += 3;
815 continue;
819 putchar(*cp);
820 cp++;
824 static void show_ref(struct refinfo *info, const char *format, int quote_style)
826 const char *cp, *sp, *ep;
828 for (cp = format; *cp && (sp = find_next(cp)); cp = ep + 1) {
829 ep = strchr(sp, ')');
830 if (cp < sp)
831 emit(cp, sp);
832 print_value(info, parse_atom(sp + 2, ep), quote_style);
834 if (*cp) {
835 sp = cp + strlen(cp);
836 emit(cp, sp);
838 putchar('\n');
841 static struct ref_sort *default_sort(void)
843 static const char cstr_name[] = "refname";
845 struct ref_sort *sort = xcalloc(1, sizeof(*sort));
847 sort->next = NULL;
848 sort->atom = parse_atom(cstr_name, cstr_name + strlen(cstr_name));
849 return sort;
852 static int opt_parse_sort(const struct option *opt, const char *arg, int unset)
854 struct ref_sort **sort_tail = opt->value;
855 struct ref_sort *s;
856 int len;
858 if (!arg) /* should --no-sort void the list ? */
859 return -1;
861 *sort_tail = s = xcalloc(1, sizeof(*s));
863 if (*arg == '-') {
864 s->reverse = 1;
865 arg++;
867 len = strlen(arg);
868 s->atom = parse_atom(arg, arg+len);
869 return 0;
872 static char const * const for_each_ref_usage[] = {
873 "git for-each-ref [options] [<pattern>]",
874 NULL
877 int cmd_for_each_ref(int argc, const char **argv, const char *prefix)
879 int i, num_refs;
880 const char *format = "%(objectname) %(objecttype)\t%(refname)";
881 struct ref_sort *sort = NULL, **sort_tail = &sort;
882 int maxcount = 0, quote_style = 0;
883 struct refinfo **refs;
884 struct grab_ref_cbdata cbdata;
886 struct option opts[] = {
887 OPT_BIT('s', "shell", &quote_style,
888 "quote placeholders suitably for shells", QUOTE_SHELL),
889 OPT_BIT('p', "perl", &quote_style,
890 "quote placeholders suitably for perl", QUOTE_PERL),
891 OPT_BIT(0 , "python", &quote_style,
892 "quote placeholders suitably for python", QUOTE_PYTHON),
893 OPT_BIT(0 , "tcl", &quote_style,
894 "quote placeholders suitably for tcl", QUOTE_TCL),
896 OPT_GROUP(""),
897 OPT_INTEGER( 0 , "count", &maxcount, "show only <n> matched refs"),
898 OPT_STRING( 0 , "format", &format, "format", "format to use for the output"),
899 OPT_CALLBACK(0 , "sort", sort_tail, "key",
900 "field name to sort on", &opt_parse_sort),
901 OPT_END(),
904 parse_options(argc, argv, opts, for_each_ref_usage, 0);
905 if (maxcount < 0) {
906 error("invalid --count argument: `%d'", maxcount);
907 usage_with_options(for_each_ref_usage, opts);
909 if (HAS_MULTI_BITS(quote_style)) {
910 error("more than one quoting style?");
911 usage_with_options(for_each_ref_usage, opts);
913 if (verify_format(format))
914 usage_with_options(for_each_ref_usage, opts);
916 if (!sort)
917 sort = default_sort();
918 sort_atom_limit = used_atom_cnt;
920 memset(&cbdata, 0, sizeof(cbdata));
921 cbdata.grab_pattern = argv;
922 for_each_ref(grab_single_ref, &cbdata);
923 refs = cbdata.grab_array;
924 num_refs = cbdata.grab_cnt;
926 for (i = 0; i < used_atom_cnt; i++) {
927 if (used_atom[i][0] == '*') {
928 need_tagged = 1;
929 break;
933 sort_refs(sort, refs, num_refs);
935 if (!maxcount || num_refs < maxcount)
936 maxcount = num_refs;
937 for (i = 0; i < maxcount; i++)
938 show_ref(refs[i], format, quote_style);
939 return 0;