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"
12/* 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
19typedef enum { FIELD_STR, FIELD_ULONG, FIELD_TIME } cmp_type;
21struct atom_value {
23 const char *s;
24 unsigned long ul; /* used for sorting when not FIELD_STR */
25};
26struct ref_sort {
28 struct ref_sort *next;
29 int atom; /* index into used_atom array */
30 unsigned reverse : 1;
31};
32struct refinfo {
34 char *refname;
35 unsigned char objectname[20];
36 int flag;
37 const char *symref;
38 struct atom_value *value;
39};
40static struct {
42 const char *name;
43 cmp_type cmp_type;
44} valid_atom[] = {
45 { "refname" },
46 { "objecttype" },
47 { "objectsize", FIELD_ULONG },
48 { "objectname" },
49 { "tree" },
50 { "parent" },
51 { "numparent", FIELD_ULONG },
52 { "object" },
53 { "type" },
54 { "tag" },
55 { "author" },
56 { "authorname" },
57 { "authoremail" },
58 { "authordate", FIELD_TIME },
59 { "committer" },
60 { "committername" },
61 { "committeremail" },
62 { "committerdate", FIELD_TIME },
63 { "tagger" },
64 { "taggername" },
65 { "taggeremail" },
66 { "taggerdate", FIELD_TIME },
67 { "creator" },
68 { "creatordate", FIELD_TIME },
69 { "subject" },
70 { "body" },
71 { "contents" },
72 { "upstream" },
73 { "symref" },
74 { "flag" },
75};
76/*
78 * An atom is a valid field atom listed above, possibly prefixed with
79 * a "*" to denote deref_tag().
80 *
81 * We parse given format string and sort specifiers, and make a list
82 * of properties that we need to extract out of objects. refinfo
83 * structure will hold an array of values extracted that can be
84 * indexed with the "atom number", which is an index into this
85 * array.
86 */
87static const char **used_atom;
88static cmp_type *used_atom_type;
89static int used_atom_cnt, sort_atom_limit, need_tagged, need_symref;
90/*
92 * Used to parse format string and sort specifiers
93 */
94static int parse_atom(const char *atom, const char *ep)
95{
96 const char *sp;
97 int i, at;
98 sp = atom;
100 if (*sp == '*' && sp < ep)
101 sp++; /* deref */
102 if (ep <= sp)
103 die("malformed field name: %.*s", (int)(ep-atom), atom);
104 /* Do we have the atom already used elsewhere? */
106 for (i = 0; i < used_atom_cnt; i++) {
107 int len = strlen(used_atom[i]);
108 if (len == ep - atom && !memcmp(used_atom[i], atom, len))
109 return i;
110 }
111 /* Is the atom a valid one? */
113 for (i = 0; i < ARRAY_SIZE(valid_atom); i++) {
114 int len = strlen(valid_atom[i].name);
115 /*
116 * If the atom name has a colon, strip it and everything after
117 * it off - it specifies the format for this entry, and
118 * shouldn't be used for checking against the valid_atom
119 * table.
120 */
121 const char *formatp = strchr(sp, ':');
122 if (!formatp || ep < formatp)
123 formatp = ep;
124 if (len == formatp - sp && !memcmp(valid_atom[i].name, sp, len))
125 break;
126 }
127 if (ARRAY_SIZE(valid_atom) <= i)
129 die("unknown field name: %.*s", (int)(ep-atom), atom);
130 /* Add it in, including the deref prefix */
132 at = used_atom_cnt;
133 used_atom_cnt++;
134 used_atom = xrealloc(used_atom,
135 (sizeof *used_atom) * used_atom_cnt);
136 used_atom_type = xrealloc(used_atom_type,
137 (sizeof(*used_atom_type) * used_atom_cnt));
138 used_atom[at] = xmemdupz(atom, ep - atom);
139 used_atom_type[at] = valid_atom[i].cmp_type;
140 if (*atom == '*')
141 need_tagged = 1;
142 if (!strcmp(used_atom[at], "symref"))
143 need_symref = 1;
144 return at;
145}
146/*
148 * In a format string, find the next occurrence of %(atom).
149 */
150static const char *find_next(const char *cp)
151{
152 while (*cp) {
153 if (*cp == '%') {
154 /*
155 * %( is the start of an atom;
156 * %% is a quoted per-cent.
157 */
158 if (cp[1] == '(')
159 return cp;
160 else if (cp[1] == '%')
161 cp++; /* skip over two % */
162 /* otherwise this is a singleton, literal % */
163 }
164 cp++;
165 }
166 return NULL;
167}
168/*
170 * Make sure the format string is well formed, and parse out
171 * the used atoms.
172 */
173static int verify_format(const char *format)
174{
175 const char *cp, *sp;
176 for (cp = format; *cp && (sp = find_next(cp)); ) {
177 const char *ep = strchr(sp, ')');
178 if (!ep)
179 return error("malformed format string %s", sp);
180 /* sp points at "%(" and ep points at the closing ")" */
181 parse_atom(sp + 2, ep);
182 cp = ep + 1;
183 }
184 return 0;
185}
186/*
188 * Given an object name, read the object data and size, and return a
189 * "struct object". If the object data we are returning is also borrowed
190 * by the "struct object" representation, set *eaten as well---it is a
191 * signal from parse_object_buffer to us not to free the buffer.
192 */
193static void *get_obj(const unsigned char *sha1, struct object **obj, unsigned long *sz, int *eaten)
194{
195 enum object_type type;
196 void *buf = read_sha1_file(sha1, &type, sz);
197 if (buf)
199 *obj = parse_object_buffer(sha1, type, *sz, buf, eaten);
200 else
201 *obj = NULL;
202 return buf;
203}
204/* See grab_values */
206static void grab_common_values(struct atom_value *val, int deref, struct object *obj, void *buf, unsigned long sz)
207{
208 int i;
209 for (i = 0; i < used_atom_cnt; i++) {
211 const char *name = used_atom[i];
212 struct atom_value *v = &val[i];
213 if (!!deref != (*name == '*'))
214 continue;
215 if (deref)
216 name++;
217 if (!strcmp(name, "objecttype"))
218 v->s = typename(obj->type);
219 else if (!strcmp(name, "objectsize")) {
220 char *s = xmalloc(40);
221 sprintf(s, "%lu", sz);
222 v->ul = sz;
223 v->s = s;
224 }
225 else if (!strcmp(name, "objectname")) {
226 char *s = xmalloc(41);
227 strcpy(s, sha1_to_hex(obj->sha1));
228 v->s = s;
229 }
230 else if (!strcmp(name, "objectname:short")) {
231 v->s = xstrdup(find_unique_abbrev(obj->sha1,
232 DEFAULT_ABBREV));
233 }
234 }
235}
236/* See grab_values */
238static void grab_tag_values(struct atom_value *val, int deref, struct object *obj, void *buf, unsigned long sz)
239{
240 int i;
241 struct tag *tag = (struct tag *) obj;
242 for (i = 0; i < used_atom_cnt; i++) {
244 const char *name = used_atom[i];
245 struct atom_value *v = &val[i];
246 if (!!deref != (*name == '*'))
247 continue;
248 if (deref)
249 name++;
250 if (!strcmp(name, "tag"))
251 v->s = tag->tag;
252 else if (!strcmp(name, "type") && tag->tagged)
253 v->s = typename(tag->tagged->type);
254 else if (!strcmp(name, "object") && tag->tagged) {
255 char *s = xmalloc(41);
256 strcpy(s, sha1_to_hex(tag->tagged->sha1));
257 v->s = s;
258 }
259 }
260}
261static int num_parents(struct commit *commit)
263{
264 struct commit_list *parents;
265 int i;
266 for (i = 0, parents = commit->parents;
268 parents;
269 parents = parents->next)
270 i++;
271 return i;
272}
273/* See grab_values */
275static void grab_commit_values(struct atom_value *val, int deref, struct object *obj, void *buf, unsigned long sz)
276{
277 int i;
278 struct commit *commit = (struct commit *) obj;
279 for (i = 0; i < used_atom_cnt; i++) {
281 const char *name = used_atom[i];
282 struct atom_value *v = &val[i];
283 if (!!deref != (*name == '*'))
284 continue;
285 if (deref)
286 name++;
287 if (!strcmp(name, "tree")) {
288 char *s = xmalloc(41);
289 strcpy(s, sha1_to_hex(commit->tree->object.sha1));
290 v->s = s;
291 }
292 if (!strcmp(name, "numparent")) {
293 char *s = xmalloc(40);
294 v->ul = num_parents(commit);
295 sprintf(s, "%lu", v->ul);
296 v->s = s;
297 }
298 else if (!strcmp(name, "parent")) {
299 int num = num_parents(commit);
300 int i;
301 struct commit_list *parents;
302 char *s = xmalloc(41 * num + 1);
303 v->s = s;
304 for (i = 0, parents = commit->parents;
305 parents;
306 parents = parents->next, i = i + 41) {
307 struct commit *parent = parents->item;
308 strcpy(s+i, sha1_to_hex(parent->object.sha1));
309 if (parents->next)
310 s[i+40] = ' ';
311 }
312 if (!i)
313 *s = '\0';
314 }
315 }
316}
317static const char *find_wholine(const char *who, int wholen, const char *buf, unsigned long sz)
319{
320 const char *eol;
321 while (*buf) {
322 if (!strncmp(buf, who, wholen) &&
323 buf[wholen] == ' ')
324 return buf + wholen + 1;
325 eol = strchr(buf, '\n');
326 if (!eol)
327 return "";
328 eol++;
329 if (*eol == '\n')
330 return ""; /* end of header */
331 buf = eol;
332 }
333 return "";
334}
335static const char *copy_line(const char *buf)
337{
338 const char *eol = strchrnul(buf, '\n');
339 return xmemdupz(buf, eol - buf);
340}
341static const char *copy_name(const char *buf)
343{
344 const char *cp;
345 for (cp = buf; *cp && *cp != '\n'; cp++) {
346 if (!strncmp(cp, " <", 2))
347 return xmemdupz(buf, cp - buf);
348 }
349 return "";
350}
351static const char *copy_email(const char *buf)
353{
354 const char *email = strchr(buf, '<');
355 const char *eoemail;
356 if (!email)
357 return "";
358 eoemail = strchr(email, '>');
359 if (!eoemail)
360 return "";
361 return xmemdupz(email, eoemail + 1 - email);
362}
363static void grab_date(const char *buf, struct atom_value *v, const char *atomname)
365{
366 const char *eoemail = strstr(buf, "> ");
367 char *zone;
368 unsigned long timestamp;
369 long tz;
370 enum date_mode date_mode = DATE_NORMAL;
371 const char *formatp;
372 /*
374 * We got here because atomname ends in "date" or "date<something>";
375 * it's not possible that <something> is not ":<format>" because
376 * parse_atom() wouldn't have allowed it, so we can assume that no
377 * ":" means no format is specified, and use the default.
378 */
379 formatp = strchr(atomname, ':');
380 if (formatp != NULL) {
381 formatp++;
382 date_mode = parse_date_format(formatp);
383 }
384 if (!eoemail)
386 goto bad;
387 timestamp = strtoul(eoemail + 2, &zone, 10);
388 if (timestamp == ULONG_MAX)
389 goto bad;
390 tz = strtol(zone, NULL, 10);
391 if ((tz == LONG_MIN || tz == LONG_MAX) && errno == ERANGE)
392 goto bad;
393 v->s = xstrdup(show_date(timestamp, tz, date_mode));
394 v->ul = timestamp;
395 return;
396 bad:
397 v->s = "";
398 v->ul = 0;
399}
400/* See grab_values */
402static void grab_person(const char *who, struct atom_value *val, int deref, struct object *obj, void *buf, unsigned long sz)
403{
404 int i;
405 int wholen = strlen(who);
406 const char *wholine = NULL;
407 for (i = 0; i < used_atom_cnt; i++) {
409 const char *name = used_atom[i];
410 struct atom_value *v = &val[i];
411 if (!!deref != (*name == '*'))
412 continue;
413 if (deref)
414 name++;
415 if (strncmp(who, name, wholen))
416 continue;
417 if (name[wholen] != 0 &&
418 strcmp(name + wholen, "name") &&
419 strcmp(name + wholen, "email") &&
420 prefixcmp(name + wholen, "date"))
421 continue;
422 if (!wholine)
423 wholine = find_wholine(who, wholen, buf, sz);
424 if (!wholine)
425 return; /* no point looking for it */
426 if (name[wholen] == 0)
427 v->s = copy_line(wholine);
428 else if (!strcmp(name + wholen, "name"))
429 v->s = copy_name(wholine);
430 else if (!strcmp(name + wholen, "email"))
431 v->s = copy_email(wholine);
432 else if (!prefixcmp(name + wholen, "date"))
433 grab_date(wholine, v, name);
434 }
435 /*
437 * For a tag or a commit object, if "creator" or "creatordate" is
438 * requested, do something special.
439 */
440 if (strcmp(who, "tagger") && strcmp(who, "committer"))
441 return; /* "author" for commit object is not wanted */
442 if (!wholine)
443 wholine = find_wholine(who, wholen, buf, sz);
444 if (!wholine)
445 return;
446 for (i = 0; i < used_atom_cnt; i++) {
447 const char *name = used_atom[i];
448 struct atom_value *v = &val[i];
449 if (!!deref != (*name == '*'))
450 continue;
451 if (deref)
452 name++;
453 if (!prefixcmp(name, "creatordate"))
455 grab_date(wholine, v, name);
456 else if (!strcmp(name, "creator"))
457 v->s = copy_line(wholine);
458 }
459}
460static void find_subpos(const char *buf, unsigned long sz, const char **sub, const char **body)
462{
463 while (*buf) {
464 const char *eol = strchr(buf, '\n');
465 if (!eol)
466 return;
467 if (eol[1] == '\n') {
468 buf = eol + 1;
469 break; /* found end of header */
470 }
471 buf = eol + 1;
472 }
473 while (*buf == '\n')
474 buf++;
475 if (!*buf)
476 return;
477 *sub = buf; /* first non-empty line */
478 buf = strchr(buf, '\n');
479 if (!buf) {
480 *body = "";
481 return; /* no body */
482 }
483 while (*buf == '\n')
484 buf++; /* skip blank between subject and body */
485 *body = buf;
486}
487/* See grab_values */
489static void grab_sub_body_contents(struct atom_value *val, int deref, struct object *obj, void *buf, unsigned long sz)
490{
491 int i;
492 const char *subpos = NULL, *bodypos = NULL;
493 for (i = 0; i < used_atom_cnt; i++) {
495 const char *name = used_atom[i];
496 struct atom_value *v = &val[i];
497 if (!!deref != (*name == '*'))
498 continue;
499 if (deref)
500 name++;
501 if (strcmp(name, "subject") &&
502 strcmp(name, "body") &&
503 strcmp(name, "contents"))
504 continue;
505 if (!subpos)
506 find_subpos(buf, sz, &subpos, &bodypos);
507 if (!subpos)
508 return;
509 if (!strcmp(name, "subject"))
511 v->s = copy_line(subpos);
512 else if (!strcmp(name, "body"))
513 v->s = xstrdup(bodypos);
514 else if (!strcmp(name, "contents"))
515 v->s = xstrdup(subpos);
516 }
517}
518/*
520 * We want to have empty print-string for field requests
521 * that do not apply (e.g. "authordate" for a tag object)
522 */
523static void fill_missing_values(struct atom_value *val)
524{
525 int i;
526 for (i = 0; i < used_atom_cnt; i++) {
527 struct atom_value *v = &val[i];
528 if (v->s == NULL)
529 v->s = "";
530 }
531}
532/*
534 * val is a list of atom_value to hold returned values. Extract
535 * the values for atoms in used_atom array out of (obj, buf, sz).
536 * when deref is false, (obj, buf, sz) is the object that is
537 * pointed at by the ref itself; otherwise it is the object the
538 * ref (which is a tag) refers to.
539 */
540static void grab_values(struct atom_value *val, int deref, struct object *obj, void *buf, unsigned long sz)
541{
542 grab_common_values(val, deref, obj, buf, sz);
543 switch (obj->type) {
544 case OBJ_TAG:
545 grab_tag_values(val, deref, obj, buf, sz);
546 grab_sub_body_contents(val, deref, obj, buf, sz);
547 grab_person("tagger", val, deref, obj, buf, sz);
548 break;
549 case OBJ_COMMIT:
550 grab_commit_values(val, deref, obj, buf, sz);
551 grab_sub_body_contents(val, deref, obj, buf, sz);
552 grab_person("author", val, deref, obj, buf, sz);
553 grab_person("committer", val, deref, obj, buf, sz);
554 break;
555 case OBJ_TREE:
556 /* grab_tree_values(val, deref, obj, buf, sz); */
557 break;
558 case OBJ_BLOB:
559 /* grab_blob_values(val, deref, obj, buf, sz); */
560 break;
561 default:
562 die("Eh? Object of type %d?", obj->type);
563 }
564}
565static inline char *copy_advance(char *dst, const char *src)
567{
568 while (*src)
569 *dst++ = *src++;
570 return dst;
571}
572/*
574 * Parse the object referred by ref, and grab needed value.
575 */
576static void populate_value(struct refinfo *ref)
577{
578 void *buf;
579 struct object *obj;
580 int eaten, i;
581 unsigned long size;
582 const unsigned char *tagged;
583 ref->value = xcalloc(sizeof(struct atom_value), used_atom_cnt);
585 if (need_symref && (ref->flag & REF_ISSYMREF) && !ref->symref) {
587 unsigned char unused1[20];
588 const char *symref;
589 symref = resolve_ref(ref->refname, unused1, 1, NULL);
590 if (symref)
591 ref->symref = xstrdup(symref);
592 else
593 ref->symref = "";
594 }
595 /* Fill in specials first */
597 for (i = 0; i < used_atom_cnt; i++) {
598 const char *name = used_atom[i];
599 struct atom_value *v = &ref->value[i];
600 int deref = 0;
601 const char *refname;
602 const char *formatp;
603 if (*name == '*') {
605 deref = 1;
606 name++;
607 }
608 if (!prefixcmp(name, "refname"))
610 refname = ref->refname;
611 else if (!prefixcmp(name, "symref"))
612 refname = ref->symref ? ref->symref : "";
613 else if (!prefixcmp(name, "upstream")) {
614 struct branch *branch;
615 /* only local branches may have an upstream */
616 if (prefixcmp(ref->refname, "refs/heads/"))
617 continue;
618 branch = branch_get(ref->refname + 11);
619 if (!branch || !branch->merge || !branch->merge[0] ||
621 !branch->merge[0]->dst)
622 continue;
623 refname = branch->merge[0]->dst;
624 }
625 else if (!strcmp(name, "flag")) {
626 char buf[256], *cp = buf;
627 if (ref->flag & REF_ISSYMREF)
628 cp = copy_advance(cp, ",symref");
629 if (ref->flag & REF_ISPACKED)
630 cp = copy_advance(cp, ",packed");
631 if (cp == buf)
632 v->s = "";
633 else {
634 *cp = '\0';
635 v->s = xstrdup(buf + 1);
636 }
637 continue;
638 }
639 else
640 continue;
641 formatp = strchr(name, ':');
643 /* look for "short" refname format */
644 if (formatp) {
645 formatp++;
646 if (!strcmp(formatp, "short"))
647 refname = shorten_unambiguous_ref(refname,
648 warn_ambiguous_refs);
649 else
650 die("unknown %.*s format %s",
651 (int)(formatp - name), name, formatp);
652 }
653 if (!deref)
655 v->s = refname;
656 else {
657 int len = strlen(refname);
658 char *s = xmalloc(len + 4);
659 sprintf(s, "%s^{}", refname);
660 v->s = s;
661 }
662 }
663 for (i = 0; i < used_atom_cnt; i++) {
665 struct atom_value *v = &ref->value[i];
666 if (v->s == NULL)
667 goto need_obj;
668 }
669 return;
670 need_obj:
672 buf = get_obj(ref->objectname, &obj, &size, &eaten);
673 if (!buf)
674 die("missing object %s for %s",
675 sha1_to_hex(ref->objectname), ref->refname);
676 if (!obj)
677 die("parse_object_buffer failed on %s for %s",
678 sha1_to_hex(ref->objectname), ref->refname);
679 grab_values(ref->value, 0, obj, buf, size);
681 if (!eaten)
682 free(buf);
683 /*
685 * If there is no atom that wants to know about tagged
686 * object, we are done.
687 */
688 if (!need_tagged || (obj->type != OBJ_TAG))
689 return;
690 /*
692 * If it is a tag object, see if we use a value that derefs
693 * the object, and if we do grab the object it refers to.
694 */
695 tagged = ((struct tag *)obj)->tagged->sha1;
696 /*
698 * NEEDSWORK: This derefs tag only once, which
699 * is good to deal with chains of trust, but
700 * is not consistent with what deref_tag() does
701 * which peels the onion to the core.
702 */
703 buf = get_obj(tagged, &obj, &size, &eaten);
704 if (!buf)
705 die("missing object %s for %s",
706 sha1_to_hex(tagged), ref->refname);
707 if (!obj)
708 die("parse_object_buffer failed on %s for %s",
709 sha1_to_hex(tagged), ref->refname);
710 grab_values(ref->value, 1, obj, buf, size);
711 if (!eaten)
712 free(buf);
713}
714/*
716 * Given a ref, return the value for the atom. This lazily gets value
717 * out of the object by calling populate value.
718 */
719static void get_value(struct refinfo *ref, int atom, struct atom_value **v)
720{
721 if (!ref->value) {
722 populate_value(ref);
723 fill_missing_values(ref->value);
724 }
725 *v = &ref->value[atom];
726}
727struct grab_ref_cbdata {
729 struct refinfo **grab_array;
730 const char **grab_pattern;
731 int grab_cnt;
732};
733/*
735 * A call-back given to for_each_ref(). Filter refs and keep them for
736 * later object processing.
737 */
738static int grab_single_ref(const char *refname, const unsigned char *sha1, int flag, void *cb_data)
739{
740 struct grab_ref_cbdata *cb = cb_data;
741 struct refinfo *ref;
742 int cnt;
743 if (*cb->grab_pattern) {
745 const char **pattern;
746 int namelen = strlen(refname);
747 for (pattern = cb->grab_pattern; *pattern; pattern++) {
748 const char *p = *pattern;
749 int plen = strlen(p);
750 if ((plen <= namelen) &&
752 !strncmp(refname, p, plen) &&
753 (refname[plen] == '\0' ||
754 refname[plen] == '/' ||
755 p[plen-1] == '/'))
756 break;
757 if (!fnmatch(p, refname, FNM_PATHNAME))
758 break;
759 }
760 if (!*pattern)
761 return 0;
762 }
763 /*
765 * We do not open the object yet; sort may only need refname
766 * to do its job and the resulting list may yet to be pruned
767 * by maxcount logic.
768 */
769 ref = xcalloc(1, sizeof(*ref));
770 ref->refname = xstrdup(refname);
771 hashcpy(ref->objectname, sha1);
772 ref->flag = flag;
773 cnt = cb->grab_cnt;
775 cb->grab_array = xrealloc(cb->grab_array,
776 sizeof(*cb->grab_array) * (cnt + 1));
777 cb->grab_array[cnt++] = ref;
778 cb->grab_cnt = cnt;
779 return 0;
780}
781static int cmp_ref_sort(struct ref_sort *s, struct refinfo *a, struct refinfo *b)
783{
784 struct atom_value *va, *vb;
785 int cmp;
786 cmp_type cmp_type = used_atom_type[s->atom];
787 get_value(a, s->atom, &va);
789 get_value(b, s->atom, &vb);
790 switch (cmp_type) {
791 case FIELD_STR:
792 cmp = strcmp(va->s, vb->s);
793 break;
794 default:
795 if (va->ul < vb->ul)
796 cmp = -1;
797 else if (va->ul == vb->ul)
798 cmp = 0;
799 else
800 cmp = 1;
801 break;
802 }
803 return (s->reverse) ? -cmp : cmp;
804}
805static struct ref_sort *ref_sort;
807static int compare_refs(const void *a_, const void *b_)
808{
809 struct refinfo *a = *((struct refinfo **)a_);
810 struct refinfo *b = *((struct refinfo **)b_);
811 struct ref_sort *s;
812 for (s = ref_sort; s; s = s->next) {
814 int cmp = cmp_ref_sort(s, a, b);
815 if (cmp)
816 return cmp;
817 }
818 return 0;
819}
820static void sort_refs(struct ref_sort *sort, struct refinfo **refs, int num_refs)
822{
823 ref_sort = sort;
824 qsort(refs, num_refs, sizeof(struct refinfo *), compare_refs);
825}
826static void print_value(struct refinfo *ref, int atom, int quote_style)
828{
829 struct atom_value *v;
830 get_value(ref, atom, &v);
831 switch (quote_style) {
832 case QUOTE_NONE:
833 fputs(v->s, stdout);
834 break;
835 case QUOTE_SHELL:
836 sq_quote_print(stdout, v->s);
837 break;
838 case QUOTE_PERL:
839 perl_quote_print(stdout, v->s);
840 break;
841 case QUOTE_PYTHON:
842 python_quote_print(stdout, v->s);
843 break;
844 case QUOTE_TCL:
845 tcl_quote_print(stdout, v->s);
846 break;
847 }
848}
849static int hex1(char ch)
851{
852 if ('0' <= ch && ch <= '9')
853 return ch - '0';
854 else if ('a' <= ch && ch <= 'f')
855 return ch - 'a' + 10;
856 else if ('A' <= ch && ch <= 'F')
857 return ch - 'A' + 10;
858 return -1;
859}
860static int hex2(const char *cp)
861{
862 if (cp[0] && cp[1])
863 return (hex1(cp[0]) << 4) | hex1(cp[1]);
864 else
865 return -1;
866}
867static void emit(const char *cp, const char *ep)
869{
870 while (*cp && (!ep || cp < ep)) {
871 if (*cp == '%') {
872 if (cp[1] == '%')
873 cp++;
874 else {
875 int ch = hex2(cp + 1);
876 if (0 <= ch) {
877 putchar(ch);
878 cp += 3;
879 continue;
880 }
881 }
882 }
883 putchar(*cp);
884 cp++;
885 }
886}
887static void show_ref(struct refinfo *info, const char *format, int quote_style)
889{
890 const char *cp, *sp, *ep;
891 for (cp = format; *cp && (sp = find_next(cp)); cp = ep + 1) {
893 ep = strchr(sp, ')');
894 if (cp < sp)
895 emit(cp, sp);
896 print_value(info, parse_atom(sp + 2, ep), quote_style);
897 }
898 if (*cp) {
899 sp = cp + strlen(cp);
900 emit(cp, sp);
901 }
902 putchar('\n');
903}
904static struct ref_sort *default_sort(void)
906{
907 static const char cstr_name[] = "refname";
908 struct ref_sort *sort = xcalloc(1, sizeof(*sort));
910 sort->next = NULL;
912 sort->atom = parse_atom(cstr_name, cstr_name + strlen(cstr_name));
913 return sort;
914}
915static int opt_parse_sort(const struct option *opt, const char *arg, int unset)
917{
918 struct ref_sort **sort_tail = opt->value;
919 struct ref_sort *s;
920 int len;
921 if (!arg) /* should --no-sort void the list ? */
923 return -1;
924 *sort_tail = s = xcalloc(1, sizeof(*s));
926 if (*arg == '-') {
928 s->reverse = 1;
929 arg++;
930 }
931 len = strlen(arg);
932 s->atom = parse_atom(arg, arg+len);
933 return 0;
934}
935static char const * const for_each_ref_usage[] = {
937 "git for-each-ref [options] [<pattern>]",
938 NULL
939};
940int cmd_for_each_ref(int argc, const char **argv, const char *prefix)
942{
943 int i, num_refs;
944 const char *format = "%(objectname) %(objecttype)\t%(refname)";
945 struct ref_sort *sort = NULL, **sort_tail = &sort;
946 int maxcount = 0, quote_style = 0;
947 struct refinfo **refs;
948 struct grab_ref_cbdata cbdata;
949 struct option opts[] = {
951 OPT_BIT('s', "shell", "e_style,
952 "quote placeholders suitably for shells", QUOTE_SHELL),
953 OPT_BIT('p', "perl", "e_style,
954 "quote placeholders suitably for perl", QUOTE_PERL),
955 OPT_BIT(0 , "python", "e_style,
956 "quote placeholders suitably for python", QUOTE_PYTHON),
957 OPT_BIT(0 , "tcl", "e_style,
958 "quote placeholders suitably for tcl", QUOTE_TCL),
959 OPT_GROUP(""),
961 OPT_INTEGER( 0 , "count", &maxcount, "show only <n> matched refs"),
962 OPT_STRING( 0 , "format", &format, "format", "format to use for the output"),
963 OPT_CALLBACK(0 , "sort", sort_tail, "key",
964 "field name to sort on", &opt_parse_sort),
965 OPT_END(),
966 };
967 parse_options(argc, argv, prefix, opts, for_each_ref_usage, 0);
969 if (maxcount < 0) {
970 error("invalid --count argument: `%d'", maxcount);
971 usage_with_options(for_each_ref_usage, opts);
972 }
973 if (HAS_MULTI_BITS(quote_style)) {
974 error("more than one quoting style?");
975 usage_with_options(for_each_ref_usage, opts);
976 }
977 if (verify_format(format))
978 usage_with_options(for_each_ref_usage, opts);
979 if (!sort)
981 sort = default_sort();
982 sort_atom_limit = used_atom_cnt;
983 /* for warn_ambiguous_refs */
985 git_config(git_default_config, NULL);
986 memset(&cbdata, 0, sizeof(cbdata));
988 cbdata.grab_pattern = argv;
989 for_each_rawref(grab_single_ref, &cbdata);
990 refs = cbdata.grab_array;
991 num_refs = cbdata.grab_cnt;
992 sort_refs(sort, refs, num_refs);
994 if (!maxcount || num_refs < maxcount)
996 maxcount = num_refs;
997 for (i = 0; i < maxcount; i++)
998 show_ref(refs[i], format, quote_style);
999 return 0;
1000}