remote.c: introduce branch_get_upstream helper
[git/git.git] / builtin / for-each-ref.c
CommitLineData
baffc0e7 1#include "builtin.h"
9f613ddd
JH
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"
c3428da8 10#include "parse-options.h"
8cae19d9 11#include "remote.h"
fddb74c9 12#include "color.h"
9f613ddd
JH
13
14/* Quoting styles */
15#define QUOTE_NONE 0
16#define QUOTE_SHELL 1
17#define QUOTE_PERL 2
c9ecf4f1
JS
18#define QUOTE_PYTHON 4
19#define QUOTE_TCL 8
9f613ddd
JH
20
21typedef enum { FIELD_STR, FIELD_ULONG, FIELD_TIME } cmp_type;
22
23struct atom_value {
24 const char *s;
25 unsigned long ul; /* used for sorting when not FIELD_STR */
26};
27
28struct ref_sort {
29 struct ref_sort *next;
30 int atom; /* index into used_atom array */
31 unsigned reverse : 1;
32};
33
34struct refinfo {
35 char *refname;
36 unsigned char objectname[20];
5cdd628c
JH
37 int flag;
38 const char *symref;
9f613ddd
JH
39 struct atom_value *value;
40};
41
42static struct {
43 const char *name;
44 cmp_type cmp_type;
45} valid_atom[] = {
46 { "refname" },
47 { "objecttype" },
48 { "objectsize", FIELD_ULONG },
49 { "objectname" },
50 { "tree" },
9e1a2acf 51 { "parent" },
9f613ddd
JH
52 { "numparent", FIELD_ULONG },
53 { "object" },
54 { "type" },
55 { "tag" },
56 { "author" },
57 { "authorname" },
58 { "authoremail" },
59 { "authordate", FIELD_TIME },
60 { "committer" },
61 { "committername" },
62 { "committeremail" },
63 { "committerdate", FIELD_TIME },
64 { "tagger" },
65 { "taggername" },
66 { "taggeremail" },
67 { "taggerdate", FIELD_TIME },
3175aa1e
JH
68 { "creator" },
69 { "creatordate", FIELD_TIME },
9f613ddd
JH
70 { "subject" },
71 { "body" },
72 { "contents" },
e2b23972
MG
73 { "contents:subject" },
74 { "contents:body" },
75 { "contents:signature" },
8cae19d9 76 { "upstream" },
5cdd628c 77 { "symref" },
88fb7f27 78 { "flag" },
7a48b832 79 { "HEAD" },
fddb74c9 80 { "color" },
9f613ddd
JH
81};
82
83/*
84 * An atom is a valid field atom listed above, possibly prefixed with
85 * a "*" to denote deref_tag().
86 *
87 * We parse given format string and sort specifiers, and make a list
88 * of properties that we need to extract out of objects. refinfo
89 * structure will hold an array of values extracted that can be
90 * indexed with the "atom number", which is an index into this
91 * array.
92 */
93static const char **used_atom;
94static cmp_type *used_atom_type;
b9cf14d4 95static int used_atom_cnt, need_tagged, need_symref;
db64eb65 96static int need_color_reset_at_eol;
9f613ddd
JH
97
98/*
99 * Used to parse format string and sort specifiers
100 */
101static int parse_atom(const char *atom, const char *ep)
102{
103 const char *sp;
9f613ddd
JH
104 int i, at;
105
106 sp = atom;
107 if (*sp == '*' && sp < ep)
108 sp++; /* deref */
109 if (ep <= sp)
110 die("malformed field name: %.*s", (int)(ep-atom), atom);
111
112 /* Do we have the atom already used elsewhere? */
113 for (i = 0; i < used_atom_cnt; i++) {
114 int len = strlen(used_atom[i]);
115 if (len == ep - atom && !memcmp(used_atom[i], atom, len))
116 return i;
117 }
118
119 /* Is the atom a valid one? */
120 for (i = 0; i < ARRAY_SIZE(valid_atom); i++) {
121 int len = strlen(valid_atom[i].name);
b64265ca
AP
122 /*
123 * If the atom name has a colon, strip it and everything after
124 * it off - it specifies the format for this entry, and
125 * shouldn't be used for checking against the valid_atom
126 * table.
127 */
128 const char *formatp = strchr(sp, ':');
070f6918 129 if (!formatp || ep < formatp)
b64265ca
AP
130 formatp = ep;
131 if (len == formatp - sp && !memcmp(valid_atom[i].name, sp, len))
9f613ddd
JH
132 break;
133 }
134
135 if (ARRAY_SIZE(valid_atom) <= i)
136 die("unknown field name: %.*s", (int)(ep-atom), atom);
137
138 /* Add it in, including the deref prefix */
139 at = used_atom_cnt;
140 used_atom_cnt++;
2756ca43
RS
141 REALLOC_ARRAY(used_atom, used_atom_cnt);
142 REALLOC_ARRAY(used_atom_type, used_atom_cnt);
182af834 143 used_atom[at] = xmemdupz(atom, ep - atom);
9f613ddd 144 used_atom_type[at] = valid_atom[i].cmp_type;
20322e0b
JH
145 if (*atom == '*')
146 need_tagged = 1;
5cdd628c
JH
147 if (!strcmp(used_atom[at], "symref"))
148 need_symref = 1;
9f613ddd
JH
149 return at;
150}
151
152/*
153 * In a format string, find the next occurrence of %(atom).
154 */
155static const char *find_next(const char *cp)
156{
157 while (*cp) {
158 if (*cp == '%') {
40dae309
JH
159 /*
160 * %( is the start of an atom;
3dff5379 161 * %% is a quoted per-cent.
9f613ddd
JH
162 */
163 if (cp[1] == '(')
164 return cp;
165 else if (cp[1] == '%')
166 cp++; /* skip over two % */
167 /* otherwise this is a singleton, literal % */
168 }
169 cp++;
170 }
171 return NULL;
172}
173
174/*
175 * Make sure the format string is well formed, and parse out
176 * the used atoms.
177 */
c3428da8 178static int verify_format(const char *format)
9f613ddd
JH
179{
180 const char *cp, *sp;
db64eb65
RR
181
182 need_color_reset_at_eol = 0;
9f613ddd 183 for (cp = format; *cp && (sp = find_next(cp)); ) {
008d5d00 184 const char *color, *ep = strchr(sp, ')');
db64eb65
RR
185 int at;
186
9f613ddd 187 if (!ep)
8e0fbe67 188 return error("malformed format string %s", sp);
9f613ddd 189 /* sp points at "%(" and ep points at the closing ")" */
db64eb65 190 at = parse_atom(sp + 2, ep);
9f613ddd 191 cp = ep + 1;
db64eb65 192
008d5d00
RS
193 if (skip_prefix(used_atom[at], "color:", &color))
194 need_color_reset_at_eol = !!strcmp(color, "reset");
9f613ddd 195 }
c3428da8 196 return 0;
9f613ddd
JH
197}
198
199/*
200 * Given an object name, read the object data and size, and return a
201 * "struct object". If the object data we are returning is also borrowed
202 * by the "struct object" representation, set *eaten as well---it is a
203 * signal from parse_object_buffer to us not to free the buffer.
204 */
205static void *get_obj(const unsigned char *sha1, struct object **obj, unsigned long *sz, int *eaten)
206{
21666f1a
NP
207 enum object_type type;
208 void *buf = read_sha1_file(sha1, &type, sz);
9f613ddd
JH
209
210 if (buf)
211 *obj = parse_object_buffer(sha1, type, *sz, buf, eaten);
212 else
213 *obj = NULL;
214 return buf;
215}
216
b74cf648
JK
217static int grab_objectname(const char *name, const unsigned char *sha1,
218 struct atom_value *v)
219{
220 if (!strcmp(name, "objectname")) {
221 char *s = xmalloc(41);
222 strcpy(s, sha1_to_hex(sha1));
223 v->s = s;
224 return 1;
225 }
226 if (!strcmp(name, "objectname:short")) {
227 v->s = xstrdup(find_unique_abbrev(sha1, DEFAULT_ABBREV));
228 return 1;
229 }
230 return 0;
231}
232
9f613ddd
JH
233/* See grab_values */
234static void grab_common_values(struct atom_value *val, int deref, struct object *obj, void *buf, unsigned long sz)
235{
236 int i;
237
238 for (i = 0; i < used_atom_cnt; i++) {
239 const char *name = used_atom[i];
240 struct atom_value *v = &val[i];
241 if (!!deref != (*name == '*'))
242 continue;
243 if (deref)
244 name++;
245 if (!strcmp(name, "objecttype"))
df843662 246 v->s = typename(obj->type);
9f613ddd
JH
247 else if (!strcmp(name, "objectsize")) {
248 char *s = xmalloc(40);
249 sprintf(s, "%lu", sz);
250 v->ul = sz;
251 v->s = s;
252 }
b74cf648
JK
253 else if (deref)
254 grab_objectname(name, obj->sha1, v);
9f613ddd
JH
255 }
256}
257
258/* See grab_values */
259static void grab_tag_values(struct atom_value *val, int deref, struct object *obj, void *buf, unsigned long sz)
260{
261 int i;
262 struct tag *tag = (struct tag *) obj;
263
264 for (i = 0; i < used_atom_cnt; i++) {
265 const char *name = used_atom[i];
266 struct atom_value *v = &val[i];
267 if (!!deref != (*name == '*'))
268 continue;
269 if (deref)
270 name++;
271 if (!strcmp(name, "tag"))
272 v->s = tag->tag;
87412ec1
JK
273 else if (!strcmp(name, "type") && tag->tagged)
274 v->s = typename(tag->tagged->type);
275 else if (!strcmp(name, "object") && tag->tagged) {
276 char *s = xmalloc(41);
277 strcpy(s, sha1_to_hex(tag->tagged->sha1));
278 v->s = s;
279 }
9f613ddd
JH
280 }
281}
282
9f613ddd
JH
283/* See grab_values */
284static void grab_commit_values(struct atom_value *val, int deref, struct object *obj, void *buf, unsigned long sz)
285{
286 int i;
287 struct commit *commit = (struct commit *) obj;
288
289 for (i = 0; i < used_atom_cnt; i++) {
290 const char *name = used_atom[i];
291 struct atom_value *v = &val[i];
292 if (!!deref != (*name == '*'))
293 continue;
294 if (deref)
295 name++;
296 if (!strcmp(name, "tree")) {
297 char *s = xmalloc(41);
298 strcpy(s, sha1_to_hex(commit->tree->object.sha1));
299 v->s = s;
300 }
301 if (!strcmp(name, "numparent")) {
302 char *s = xmalloc(40);
4bbaa1eb 303 v->ul = commit_list_count(commit->parents);
9f613ddd
JH
304 sprintf(s, "%lu", v->ul);
305 v->s = s;
9f613ddd
JH
306 }
307 else if (!strcmp(name, "parent")) {
4bbaa1eb 308 int num = commit_list_count(commit->parents);
9f613ddd
JH
309 int i;
310 struct commit_list *parents;
9e1a2acf 311 char *s = xmalloc(41 * num + 1);
9f613ddd
JH
312 v->s = s;
313 for (i = 0, parents = commit->parents;
314 parents;
9e1a2acf 315 parents = parents->next, i = i + 41) {
9f613ddd
JH
316 struct commit *parent = parents->item;
317 strcpy(s+i, sha1_to_hex(parent->object.sha1));
318 if (parents->next)
319 s[i+40] = ' ';
320 }
9e1a2acf
JH
321 if (!i)
322 *s = '\0';
9f613ddd
JH
323 }
324 }
325}
326
327static const char *find_wholine(const char *who, int wholen, const char *buf, unsigned long sz)
328{
329 const char *eol;
330 while (*buf) {
331 if (!strncmp(buf, who, wholen) &&
332 buf[wholen] == ' ')
333 return buf + wholen + 1;
334 eol = strchr(buf, '\n');
335 if (!eol)
336 return "";
337 eol++;
a74fa110 338 if (*eol == '\n')
9f613ddd
JH
339 return ""; /* end of header */
340 buf = eol;
341 }
342 return "";
343}
344
3a55602e 345static const char *copy_line(const char *buf)
9f613ddd 346{
94e02e7f 347 const char *eol = strchrnul(buf, '\n');
182af834 348 return xmemdupz(buf, eol - buf);
9f613ddd
JH
349}
350
3a55602e 351static const char *copy_name(const char *buf)
9f613ddd 352{
182af834 353 const char *cp;
6b30852d 354 for (cp = buf; *cp && *cp != '\n'; cp++) {
182af834
PH
355 if (!strncmp(cp, " <", 2))
356 return xmemdupz(buf, cp - buf);
357 }
358 return "";
9f613ddd
JH
359}
360
3a55602e 361static const char *copy_email(const char *buf)
9f613ddd
JH
362{
363 const char *email = strchr(buf, '<');
e64c1b00
JK
364 const char *eoemail;
365 if (!email)
366 return "";
367 eoemail = strchr(email, '>');
368 if (!eoemail)
9f613ddd 369 return "";
182af834 370 return xmemdupz(email, eoemail + 1 - email);
9f613ddd
JH
371}
372
7f6e275b
JK
373static char *copy_subject(const char *buf, unsigned long len)
374{
375 char *r = xmemdupz(buf, len);
376 int i;
377
378 for (i = 0; i < len; i++)
379 if (r[i] == '\n')
380 r[i] = ' ';
381
382 return r;
383}
384
d392e712 385static void grab_date(const char *buf, struct atom_value *v, const char *atomname)
9f613ddd
JH
386{
387 const char *eoemail = strstr(buf, "> ");
388 char *zone;
389 unsigned long timestamp;
390 long tz;
d392e712
AP
391 enum date_mode date_mode = DATE_NORMAL;
392 const char *formatp;
393
394 /*
395 * We got here because atomname ends in "date" or "date<something>";
396 * it's not possible that <something> is not ":<format>" because
397 * parse_atom() wouldn't have allowed it, so we can assume that no
398 * ":" means no format is specified, and use the default.
399 */
400 formatp = strchr(atomname, ':');
401 if (formatp != NULL) {
402 formatp++;
403 date_mode = parse_date_format(formatp);
404 }
9f613ddd
JH
405
406 if (!eoemail)
407 goto bad;
408 timestamp = strtoul(eoemail + 2, &zone, 10);
409 if (timestamp == ULONG_MAX)
410 goto bad;
411 tz = strtol(zone, NULL, 10);
412 if ((tz == LONG_MIN || tz == LONG_MAX) && errno == ERANGE)
413 goto bad;
d392e712 414 v->s = xstrdup(show_date(timestamp, tz, date_mode));
9f613ddd
JH
415 v->ul = timestamp;
416 return;
417 bad:
418 v->s = "";
419 v->ul = 0;
420}
421
422/* See grab_values */
423static void grab_person(const char *who, struct atom_value *val, int deref, struct object *obj, void *buf, unsigned long sz)
424{
425 int i;
426 int wholen = strlen(who);
427 const char *wholine = NULL;
428
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++;
436 if (strncmp(who, name, wholen))
437 continue;
438 if (name[wholen] != 0 &&
439 strcmp(name + wholen, "name") &&
440 strcmp(name + wholen, "email") &&
59556548 441 !starts_with(name + wholen, "date"))
9f613ddd
JH
442 continue;
443 if (!wholine)
444 wholine = find_wholine(who, wholen, buf, sz);
445 if (!wholine)
446 return; /* no point looking for it */
447 if (name[wholen] == 0)
448 v->s = copy_line(wholine);
449 else if (!strcmp(name + wholen, "name"))
450 v->s = copy_name(wholine);
451 else if (!strcmp(name + wholen, "email"))
452 v->s = copy_email(wholine);
59556548 453 else if (starts_with(name + wholen, "date"))
d392e712 454 grab_date(wholine, v, name);
9f613ddd 455 }
3175aa1e 456
40dae309
JH
457 /*
458 * For a tag or a commit object, if "creator" or "creatordate" is
3175aa1e
JH
459 * requested, do something special.
460 */
461 if (strcmp(who, "tagger") && strcmp(who, "committer"))
462 return; /* "author" for commit object is not wanted */
463 if (!wholine)
464 wholine = find_wholine(who, wholen, buf, sz);
465 if (!wholine)
466 return;
467 for (i = 0; i < used_atom_cnt; i++) {
468 const char *name = used_atom[i];
469 struct atom_value *v = &val[i];
470 if (!!deref != (*name == '*'))
471 continue;
472 if (deref)
473 name++;
474
59556548 475 if (starts_with(name, "creatordate"))
d392e712 476 grab_date(wholine, v, name);
3175aa1e
JH
477 else if (!strcmp(name, "creator"))
478 v->s = copy_line(wholine);
479 }
9f613ddd
JH
480}
481
7ec0f31e
JK
482static void find_subpos(const char *buf, unsigned long sz,
483 const char **sub, unsigned long *sublen,
e2b23972
MG
484 const char **body, unsigned long *bodylen,
485 unsigned long *nonsiglen,
486 const char **sig, unsigned long *siglen)
9f613ddd 487{
7ec0f31e
JK
488 const char *eol;
489 /* skip past header until we hit empty line */
490 while (*buf && *buf != '\n') {
491 eol = strchrnul(buf, '\n');
492 if (*eol)
493 eol++;
494 buf = eol;
9f613ddd 495 }
7ec0f31e 496 /* skip any empty lines */
9f613ddd
JH
497 while (*buf == '\n')
498 buf++;
7ec0f31e 499
e2b23972
MG
500 /* parse signature first; we might not even have a subject line */
501 *sig = buf + parse_signature(buf, strlen(buf));
502 *siglen = strlen(*sig);
503
7ec0f31e
JK
504 /* subject is first non-empty line */
505 *sub = buf;
7f6e275b 506 /* subject goes to first empty line */
e2b23972 507 while (buf < *sig && *buf && *buf != '\n') {
7f6e275b
JK
508 eol = strchrnul(buf, '\n');
509 if (*eol)
510 eol++;
511 buf = eol;
512 }
513 *sublen = buf - *sub;
514 /* drop trailing newline, if present */
515 if (*sublen && (*sub)[*sublen - 1] == '\n')
516 *sublen -= 1;
7ec0f31e
JK
517
518 /* skip any empty lines */
9f613ddd 519 while (*buf == '\n')
7ec0f31e 520 buf++;
9f613ddd 521 *body = buf;
7ec0f31e 522 *bodylen = strlen(buf);
e2b23972 523 *nonsiglen = *sig - buf;
9f613ddd
JH
524}
525
526/* See grab_values */
527static void grab_sub_body_contents(struct atom_value *val, int deref, struct object *obj, void *buf, unsigned long sz)
528{
529 int i;
e2b23972
MG
530 const char *subpos = NULL, *bodypos = NULL, *sigpos = NULL;
531 unsigned long sublen = 0, bodylen = 0, nonsiglen = 0, siglen = 0;
9f613ddd
JH
532
533 for (i = 0; i < used_atom_cnt; i++) {
534 const char *name = used_atom[i];
535 struct atom_value *v = &val[i];
536 if (!!deref != (*name == '*'))
537 continue;
538 if (deref)
539 name++;
540 if (strcmp(name, "subject") &&
541 strcmp(name, "body") &&
e2b23972
MG
542 strcmp(name, "contents") &&
543 strcmp(name, "contents:subject") &&
544 strcmp(name, "contents:body") &&
545 strcmp(name, "contents:signature"))
9f613ddd
JH
546 continue;
547 if (!subpos)
7ec0f31e
JK
548 find_subpos(buf, sz,
549 &subpos, &sublen,
e2b23972
MG
550 &bodypos, &bodylen, &nonsiglen,
551 &sigpos, &siglen);
9f613ddd
JH
552
553 if (!strcmp(name, "subject"))
7f6e275b 554 v->s = copy_subject(subpos, sublen);
e2b23972
MG
555 else if (!strcmp(name, "contents:subject"))
556 v->s = copy_subject(subpos, sublen);
9f613ddd 557 else if (!strcmp(name, "body"))
7ec0f31e 558 v->s = xmemdupz(bodypos, bodylen);
e2b23972
MG
559 else if (!strcmp(name, "contents:body"))
560 v->s = xmemdupz(bodypos, nonsiglen);
561 else if (!strcmp(name, "contents:signature"))
562 v->s = xmemdupz(sigpos, siglen);
9f613ddd 563 else if (!strcmp(name, "contents"))
f8290630 564 v->s = xstrdup(subpos);
9f613ddd
JH
565 }
566}
567
40dae309
JH
568/*
569 * We want to have empty print-string for field requests
9f613ddd
JH
570 * that do not apply (e.g. "authordate" for a tag object)
571 */
572static void fill_missing_values(struct atom_value *val)
573{
574 int i;
575 for (i = 0; i < used_atom_cnt; i++) {
576 struct atom_value *v = &val[i];
577 if (v->s == NULL)
578 v->s = "";
579 }
580}
581
582/*
583 * val is a list of atom_value to hold returned values. Extract
584 * the values for atoms in used_atom array out of (obj, buf, sz).
585 * when deref is false, (obj, buf, sz) is the object that is
586 * pointed at by the ref itself; otherwise it is the object the
587 * ref (which is a tag) refers to.
588 */
589static void grab_values(struct atom_value *val, int deref, struct object *obj, void *buf, unsigned long sz)
590{
591 grab_common_values(val, deref, obj, buf, sz);
592 switch (obj->type) {
593 case OBJ_TAG:
594 grab_tag_values(val, deref, obj, buf, sz);
595 grab_sub_body_contents(val, deref, obj, buf, sz);
596 grab_person("tagger", val, deref, obj, buf, sz);
597 break;
598 case OBJ_COMMIT:
599 grab_commit_values(val, deref, obj, buf, sz);
600 grab_sub_body_contents(val, deref, obj, buf, sz);
601 grab_person("author", val, deref, obj, buf, sz);
602 grab_person("committer", val, deref, obj, buf, sz);
603 break;
604 case OBJ_TREE:
2543d9b6 605 /* grab_tree_values(val, deref, obj, buf, sz); */
9f613ddd
JH
606 break;
607 case OBJ_BLOB:
2543d9b6 608 /* grab_blob_values(val, deref, obj, buf, sz); */
9f613ddd
JH
609 break;
610 default:
611 die("Eh? Object of type %d?", obj->type);
612 }
613}
614
88fb7f27
JH
615static inline char *copy_advance(char *dst, const char *src)
616{
617 while (*src)
618 *dst++ = *src++;
619 return dst;
620}
621
9f613ddd
JH
622/*
623 * Parse the object referred by ref, and grab needed value.
624 */
625static void populate_value(struct refinfo *ref)
626{
627 void *buf;
628 struct object *obj;
629 int eaten, i;
630 unsigned long size;
631 const unsigned char *tagged;
632
693eb02a 633 ref->value = xcalloc(used_atom_cnt, sizeof(struct atom_value));
9f613ddd 634
5cdd628c
JH
635 if (need_symref && (ref->flag & REF_ISSYMREF) && !ref->symref) {
636 unsigned char unused1[20];
7695d118
RS
637 ref->symref = resolve_refdup(ref->refname, RESOLVE_REF_READING,
638 unused1, NULL);
96ec7b1e 639 if (!ref->symref)
5cdd628c
JH
640 ref->symref = "";
641 }
642
9f613ddd
JH
643 /* Fill in specials first */
644 for (i = 0; i < used_atom_cnt; i++) {
645 const char *name = used_atom[i];
646 struct atom_value *v = &ref->value[i];
7d66f21a 647 int deref = 0;
8db9a4b8
JK
648 const char *refname;
649 const char *formatp;
b28061ce 650 struct branch *branch = NULL;
8db9a4b8 651
7d66f21a
BW
652 if (*name == '*') {
653 deref = 1;
654 name++;
655 }
7d66f21a 656
59556548 657 if (starts_with(name, "refname"))
8db9a4b8 658 refname = ref->refname;
59556548 659 else if (starts_with(name, "symref"))
5cdd628c 660 refname = ref->symref ? ref->symref : "";
59556548 661 else if (starts_with(name, "upstream")) {
8cae19d9 662 /* only local branches may have an upstream */
59556548 663 if (!starts_with(ref->refname, "refs/heads/"))
8cae19d9
JK
664 continue;
665 branch = branch_get(ref->refname + 11);
666
a9f9f8cc
JK
667 refname = branch_get_upstream(branch);
668 if (!refname)
8cae19d9 669 continue;
ad704485 670 } else if (starts_with(name, "color:")) {
fddb74c9
RR
671 char color[COLOR_MAXLEN] = "";
672
f6c5a296
JK
673 if (color_parse(name + 6, color) < 0)
674 die(_("unable to parse format"));
fddb74c9
RR
675 v->s = xstrdup(color);
676 continue;
677 } else if (!strcmp(name, "flag")) {
88fb7f27
JH
678 char buf[256], *cp = buf;
679 if (ref->flag & REF_ISSYMREF)
680 cp = copy_advance(cp, ",symref");
681 if (ref->flag & REF_ISPACKED)
682 cp = copy_advance(cp, ",packed");
683 if (cp == buf)
684 v->s = "";
685 else {
686 *cp = '\0';
687 v->s = xstrdup(buf + 1);
688 }
689 continue;
cb6bd572 690 } else if (!deref && grab_objectname(name, ref->objectname, v)) {
b74cf648 691 continue;
7a48b832
RR
692 } else if (!strcmp(name, "HEAD")) {
693 const char *head;
694 unsigned char sha1[20];
b28061ce 695
7695d118
RS
696 head = resolve_ref_unsafe("HEAD", RESOLVE_REF_READING,
697 sha1, NULL);
7a48b832
RR
698 if (!strcmp(ref->refname, head))
699 v->s = "*";
700 else
701 v->s = " ";
702 continue;
703 } else
8db9a4b8
JK
704 continue;
705
706 formatp = strchr(name, ':');
8db9a4b8 707 if (formatp) {
b28061ce
RR
708 int num_ours, num_theirs;
709
8db9a4b8
JK
710 formatp++;
711 if (!strcmp(formatp, "short"))
2bb98169
BW
712 refname = shorten_unambiguous_ref(refname,
713 warn_ambiguous_refs);
b28061ce 714 else if (!strcmp(formatp, "track") &&
ad704485 715 starts_with(name, "upstream")) {
b28061ce
RR
716 char buf[40];
717
b6160d95
RKC
718 if (stat_tracking_info(branch, &num_ours,
719 &num_theirs) != 1)
720 continue;
721
b28061ce
RR
722 if (!num_ours && !num_theirs)
723 v->s = "";
724 else if (!num_ours) {
725 sprintf(buf, "[behind %d]", num_theirs);
726 v->s = xstrdup(buf);
727 } else if (!num_theirs) {
728 sprintf(buf, "[ahead %d]", num_ours);
729 v->s = xstrdup(buf);
730 } else {
731 sprintf(buf, "[ahead %d, behind %d]",
732 num_ours, num_theirs);
733 v->s = xstrdup(buf);
734 }
735 continue;
736 } else if (!strcmp(formatp, "trackshort") &&
ad704485 737 starts_with(name, "upstream")) {
b28061ce 738 assert(branch);
b6160d95
RKC
739
740 if (stat_tracking_info(branch, &num_ours,
741 &num_theirs) != 1)
742 continue;
743
b28061ce
RR
744 if (!num_ours && !num_theirs)
745 v->s = "=";
746 else if (!num_ours)
747 v->s = "<";
748 else if (!num_theirs)
749 v->s = ">";
750 else
751 v->s = "<>";
752 continue;
753 } else
8db9a4b8
JK
754 die("unknown %.*s format %s",
755 (int)(formatp - name), name, formatp);
756 }
757
758 if (!deref)
759 v->s = refname;
760 else {
761 int len = strlen(refname);
762 char *s = xmalloc(len + 4);
763 sprintf(s, "%s^{}", refname);
764 v->s = s;
9f613ddd
JH
765 }
766 }
767
b7dd2d20
AK
768 for (i = 0; i < used_atom_cnt; i++) {
769 struct atom_value *v = &ref->value[i];
770 if (v->s == NULL)
771 goto need_obj;
772 }
773 return;
774
775 need_obj:
776 buf = get_obj(ref->objectname, &obj, &size, &eaten);
777 if (!buf)
778 die("missing object %s for %s",
779 sha1_to_hex(ref->objectname), ref->refname);
780 if (!obj)
781 die("parse_object_buffer failed on %s for %s",
782 sha1_to_hex(ref->objectname), ref->refname);
783
9f613ddd
JH
784 grab_values(ref->value, 0, obj, buf, size);
785 if (!eaten)
786 free(buf);
787
40dae309
JH
788 /*
789 * If there is no atom that wants to know about tagged
9f613ddd
JH
790 * object, we are done.
791 */
792 if (!need_tagged || (obj->type != OBJ_TAG))
793 return;
794
40dae309
JH
795 /*
796 * If it is a tag object, see if we use a value that derefs
9f613ddd
JH
797 * the object, and if we do grab the object it refers to.
798 */
799 tagged = ((struct tag *)obj)->tagged->sha1;
800
40dae309
JH
801 /*
802 * NEEDSWORK: This derefs tag only once, which
9f613ddd
JH
803 * is good to deal with chains of trust, but
804 * is not consistent with what deref_tag() does
805 * which peels the onion to the core.
806 */
807 buf = get_obj(tagged, &obj, &size, &eaten);
808 if (!buf)
809 die("missing object %s for %s",
810 sha1_to_hex(tagged), ref->refname);
811 if (!obj)
812 die("parse_object_buffer failed on %s for %s",
813 sha1_to_hex(tagged), ref->refname);
814 grab_values(ref->value, 1, obj, buf, size);
815 if (!eaten)
816 free(buf);
817}
818
819/*
820 * Given a ref, return the value for the atom. This lazily gets value
821 * out of the object by calling populate value.
822 */
823static void get_value(struct refinfo *ref, int atom, struct atom_value **v)
824{
825 if (!ref->value) {
826 populate_value(ref);
827 fill_missing_values(ref->value);
828 }
829 *v = &ref->value[atom];
830}
831
340adb8b
JH
832struct grab_ref_cbdata {
833 struct refinfo **grab_array;
834 const char **grab_pattern;
835 int grab_cnt;
836};
9f613ddd
JH
837
838/*
40dae309
JH
839 * A call-back given to for_each_ref(). Filter refs and keep them for
840 * later object processing.
9f613ddd 841 */
340adb8b 842static int grab_single_ref(const char *refname, const unsigned char *sha1, int flag, void *cb_data)
9f613ddd 843{
340adb8b 844 struct grab_ref_cbdata *cb = cb_data;
9f613ddd
JH
845 struct refinfo *ref;
846 int cnt;
847
971c41c7
RS
848 if (flag & REF_BAD_NAME) {
849 warning("ignoring ref with broken name %s", refname);
850 return 0;
851 }
852
340adb8b 853 if (*cb->grab_pattern) {
9f613ddd
JH
854 const char **pattern;
855 int namelen = strlen(refname);
340adb8b 856 for (pattern = cb->grab_pattern; *pattern; pattern++) {
9f613ddd
JH
857 const char *p = *pattern;
858 int plen = strlen(p);
859
860 if ((plen <= namelen) &&
861 !strncmp(refname, p, plen) &&
862 (refname[plen] == '\0' ||
114ef908
BS
863 refname[plen] == '/' ||
864 p[plen-1] == '/'))
9f613ddd 865 break;
eb07894f 866 if (!wildmatch(p, refname, WM_PATHNAME, NULL))
9f613ddd
JH
867 break;
868 }
869 if (!*pattern)
870 return 0;
871 }
872
40dae309
JH
873 /*
874 * We do not open the object yet; sort may only need refname
9f613ddd
JH
875 * to do its job and the resulting list may yet to be pruned
876 * by maxcount logic.
877 */
878 ref = xcalloc(1, sizeof(*ref));
879 ref->refname = xstrdup(refname);
880 hashcpy(ref->objectname, sha1);
5cdd628c 881 ref->flag = flag;
9f613ddd 882
340adb8b 883 cnt = cb->grab_cnt;
2756ca43 884 REALLOC_ARRAY(cb->grab_array, cnt + 1);
340adb8b
JH
885 cb->grab_array[cnt++] = ref;
886 cb->grab_cnt = cnt;
9f613ddd
JH
887 return 0;
888}
889
9f613ddd
JH
890static int cmp_ref_sort(struct ref_sort *s, struct refinfo *a, struct refinfo *b)
891{
892 struct atom_value *va, *vb;
893 int cmp;
894 cmp_type cmp_type = used_atom_type[s->atom];
895
896 get_value(a, s->atom, &va);
897 get_value(b, s->atom, &vb);
898 switch (cmp_type) {
899 case FIELD_STR:
900 cmp = strcmp(va->s, vb->s);
901 break;
902 default:
903 if (va->ul < vb->ul)
904 cmp = -1;
905 else if (va->ul == vb->ul)
906 cmp = 0;
907 else
908 cmp = 1;
909 break;
910 }
911 return (s->reverse) ? -cmp : cmp;
912}
913
914static struct ref_sort *ref_sort;
915static int compare_refs(const void *a_, const void *b_)
916{
917 struct refinfo *a = *((struct refinfo **)a_);
918 struct refinfo *b = *((struct refinfo **)b_);
919 struct ref_sort *s;
920
921 for (s = ref_sort; s; s = s->next) {
922 int cmp = cmp_ref_sort(s, a, b);
923 if (cmp)
924 return cmp;
925 }
926 return 0;
927}
928
929static void sort_refs(struct ref_sort *sort, struct refinfo **refs, int num_refs)
930{
931 ref_sort = sort;
932 qsort(refs, num_refs, sizeof(struct refinfo *), compare_refs);
933}
934
db64eb65 935static void print_value(struct atom_value *v, int quote_style)
9f613ddd 936{
10d0167f 937 struct strbuf sb = STRBUF_INIT;
9f613ddd
JH
938 switch (quote_style) {
939 case QUOTE_NONE:
940 fputs(v->s, stdout);
941 break;
942 case QUOTE_SHELL:
10d0167f 943 sq_quote_buf(&sb, v->s);
9f613ddd
JH
944 break;
945 case QUOTE_PERL:
10d0167f 946 perl_quote_buf(&sb, v->s);
9f613ddd
JH
947 break;
948 case QUOTE_PYTHON:
10d0167f 949 python_quote_buf(&sb, v->s);
9f613ddd 950 break;
5558e55c 951 case QUOTE_TCL:
10d0167f 952 tcl_quote_buf(&sb, v->s);
5558e55c 953 break;
9f613ddd 954 }
10d0167f
NTND
955 if (quote_style != QUOTE_NONE) {
956 fputs(sb.buf, stdout);
957 strbuf_release(&sb);
958 }
9f613ddd
JH
959}
960
961static int hex1(char ch)
962{
963 if ('0' <= ch && ch <= '9')
964 return ch - '0';
965 else if ('a' <= ch && ch <= 'f')
966 return ch - 'a' + 10;
967 else if ('A' <= ch && ch <= 'F')
968 return ch - 'A' + 10;
969 return -1;
970}
971static int hex2(const char *cp)
972{
973 if (cp[0] && cp[1])
974 return (hex1(cp[0]) << 4) | hex1(cp[1]);
975 else
976 return -1;
977}
978
979static void emit(const char *cp, const char *ep)
980{
981 while (*cp && (!ep || cp < ep)) {
982 if (*cp == '%') {
983 if (cp[1] == '%')
984 cp++;
985 else {
986 int ch = hex2(cp + 1);
987 if (0 <= ch) {
988 putchar(ch);
989 cp += 3;
990 continue;
991 }
992 }
993 }
994 putchar(*cp);
995 cp++;
996 }
997}
998
999static void show_ref(struct refinfo *info, const char *format, int quote_style)
1000{
1001 const char *cp, *sp, *ep;
1002
1003 for (cp = format; *cp && (sp = find_next(cp)); cp = ep + 1) {
db64eb65
RR
1004 struct atom_value *atomv;
1005
9f613ddd
JH
1006 ep = strchr(sp, ')');
1007 if (cp < sp)
1008 emit(cp, sp);
db64eb65
RR
1009 get_value(info, parse_atom(sp + 2, ep), &atomv);
1010 print_value(atomv, quote_style);
9f613ddd
JH
1011 }
1012 if (*cp) {
1013 sp = cp + strlen(cp);
1014 emit(cp, sp);
1015 }
db64eb65
RR
1016 if (need_color_reset_at_eol) {
1017 struct atom_value resetv;
1018 char color[COLOR_MAXLEN] = "";
1019
f6c5a296
JK
1020 if (color_parse("reset", color) < 0)
1021 die("BUG: couldn't parse 'reset' as a color");
db64eb65
RR
1022 resetv.s = color;
1023 print_value(&resetv, quote_style);
1024 }
9f613ddd
JH
1025 putchar('\n');
1026}
1027
1028static struct ref_sort *default_sort(void)
1029{
1030 static const char cstr_name[] = "refname";
1031
1032 struct ref_sort *sort = xcalloc(1, sizeof(*sort));
1033
1034 sort->next = NULL;
1035 sort->atom = parse_atom(cstr_name, cstr_name + strlen(cstr_name));
1036 return sort;
1037}
1038
186458b1 1039static int opt_parse_sort(const struct option *opt, const char *arg, int unset)
c3428da8
PH
1040{
1041 struct ref_sort **sort_tail = opt->value;
1042 struct ref_sort *s;
1043 int len;
1044
1045 if (!arg) /* should --no-sort void the list ? */
1046 return -1;
1047
3b51222c
KK
1048 s = xcalloc(1, sizeof(*s));
1049 s->next = *sort_tail;
1050 *sort_tail = s;
c3428da8
PH
1051
1052 if (*arg == '-') {
1053 s->reverse = 1;
1054 arg++;
1055 }
1056 len = strlen(arg);
1057 s->atom = parse_atom(arg, arg+len);
1058 return 0;
1059}
1060
1061static char const * const for_each_ref_usage[] = {
9c9b4f2f 1062 N_("git for-each-ref [<options>] [<pattern>]"),
c3428da8
PH
1063 NULL
1064};
1065
1066int cmd_for_each_ref(int argc, const char **argv, const char *prefix)
9f613ddd
JH
1067{
1068 int i, num_refs;
c3428da8 1069 const char *format = "%(objectname) %(objecttype)\t%(refname)";
9f613ddd 1070 struct ref_sort *sort = NULL, **sort_tail = &sort;
9fac800c 1071 int maxcount = 0, quote_style = 0;
9f613ddd 1072 struct refinfo **refs;
340adb8b 1073 struct grab_ref_cbdata cbdata;
9f613ddd 1074
c3428da8 1075 struct option opts[] = {
9fac800c 1076 OPT_BIT('s', "shell", &quote_style,
18913521 1077 N_("quote placeholders suitably for shells"), QUOTE_SHELL),
9fac800c 1078 OPT_BIT('p', "perl", &quote_style,
18913521 1079 N_("quote placeholders suitably for perl"), QUOTE_PERL),
9fac800c 1080 OPT_BIT(0 , "python", &quote_style,
18913521 1081 N_("quote placeholders suitably for python"), QUOTE_PYTHON),
9fac800c 1082 OPT_BIT(0 , "tcl", &quote_style,
b799a696 1083 N_("quote placeholders suitably for Tcl"), QUOTE_TCL),
c3428da8
PH
1084
1085 OPT_GROUP(""),
18913521
NTND
1086 OPT_INTEGER( 0 , "count", &maxcount, N_("show only <n> matched refs")),
1087 OPT_STRING( 0 , "format", &format, N_("format"), N_("format to use for the output")),
1088 OPT_CALLBACK(0 , "sort", sort_tail, N_("key"),
1089 N_("field name to sort on"), &opt_parse_sort),
c3428da8
PH
1090 OPT_END(),
1091 };
1092
37782920 1093 parse_options(argc, argv, prefix, opts, for_each_ref_usage, 0);
c3428da8
PH
1094 if (maxcount < 0) {
1095 error("invalid --count argument: `%d'", maxcount);
1096 usage_with_options(for_each_ref_usage, opts);
9f613ddd 1097 }
9fac800c 1098 if (HAS_MULTI_BITS(quote_style)) {
c9ecf4f1 1099 error("more than one quoting style?");
c3428da8
PH
1100 usage_with_options(for_each_ref_usage, opts);
1101 }
1102 if (verify_format(format))
1103 usage_with_options(for_each_ref_usage, opts);
9f613ddd
JH
1104
1105 if (!sort)
1106 sort = default_sort();
9f613ddd 1107
2bb98169
BW
1108 /* for warn_ambiguous_refs */
1109 git_config(git_default_config, NULL);
1110
340adb8b 1111 memset(&cbdata, 0, sizeof(cbdata));
c3428da8 1112 cbdata.grab_pattern = argv;
b7dd2d20 1113 for_each_rawref(grab_single_ref, &cbdata);
340adb8b
JH
1114 refs = cbdata.grab_array;
1115 num_refs = cbdata.grab_cnt;
9f613ddd 1116
9f613ddd
JH
1117 sort_refs(sort, refs, num_refs);
1118
1119 if (!maxcount || num_refs < maxcount)
1120 maxcount = num_refs;
1121 for (i = 0; i < maxcount; i++)
1122 show_ref(refs[i], format, quote_style);
1123 return 0;
1124}