rev-parse --branches/--tags/--remotes=pattern
[git/git.git] / builtin-rev-parse.c
1 /*
2 * rev-parse.c
3 *
4 * Copyright (C) Linus Torvalds, 2005
5 */
6 #include "cache.h"
7 #include "commit.h"
8 #include "refs.h"
9 #include "quote.h"
10 #include "builtin.h"
11 #include "parse-options.h"
12
13 #define DO_REVS 1
14 #define DO_NOREV 2
15 #define DO_FLAGS 4
16 #define DO_NONFLAGS 8
17 static int filter = ~0;
18
19 static const char *def;
20
21 #define NORMAL 0
22 #define REVERSED 1
23 static int show_type = NORMAL;
24
25 #define SHOW_SYMBOLIC_ASIS 1
26 #define SHOW_SYMBOLIC_FULL 2
27 static int symbolic;
28 static int abbrev;
29 static int abbrev_ref;
30 static int abbrev_ref_strict;
31 static int output_sq;
32
33 /*
34 * Some arguments are relevant "revision" arguments,
35 * others are about output format or other details.
36 * This sorts it all out.
37 */
38 static int is_rev_argument(const char *arg)
39 {
40 static const char *rev_args[] = {
41 "--all",
42 "--bisect",
43 "--dense",
44 "--branches=",
45 "--branches",
46 "--header",
47 "--max-age=",
48 "--max-count=",
49 "--min-age=",
50 "--no-merges",
51 "--objects",
52 "--objects-edge",
53 "--parents",
54 "--pretty",
55 "--remotes=",
56 "--remotes",
57 "--glob=",
58 "--sparse",
59 "--tags=",
60 "--tags",
61 "--topo-order",
62 "--date-order",
63 "--unpacked",
64 NULL
65 };
66 const char **p = rev_args;
67
68 /* accept -<digit>, like traditional "head" */
69 if ((*arg == '-') && isdigit(arg[1]))
70 return 1;
71
72 for (;;) {
73 const char *str = *p++;
74 int len;
75 if (!str)
76 return 0;
77 len = strlen(str);
78 if (!strcmp(arg, str) ||
79 (str[len-1] == '=' && !strncmp(arg, str, len)))
80 return 1;
81 }
82 }
83
84 /* Output argument as a string, either SQ or normal */
85 static void show(const char *arg)
86 {
87 if (output_sq) {
88 int sq = '\'', ch;
89
90 putchar(sq);
91 while ((ch = *arg++)) {
92 if (ch == sq)
93 fputs("'\\'", stdout);
94 putchar(ch);
95 }
96 putchar(sq);
97 putchar(' ');
98 }
99 else
100 puts(arg);
101 }
102
103 /* Like show(), but with a negation prefix according to type */
104 static void show_with_type(int type, const char *arg)
105 {
106 if (type != show_type)
107 putchar('^');
108 show(arg);
109 }
110
111 /* Output a revision, only if filter allows it */
112 static void show_rev(int type, const unsigned char *sha1, const char *name)
113 {
114 if (!(filter & DO_REVS))
115 return;
116 def = NULL;
117
118 if ((symbolic || abbrev_ref) && name) {
119 if (symbolic == SHOW_SYMBOLIC_FULL || abbrev_ref) {
120 unsigned char discard[20];
121 char *full;
122
123 switch (dwim_ref(name, strlen(name), discard, &full)) {
124 case 0:
125 /*
126 * Not found -- not a ref. We could
127 * emit "name" here, but symbolic-full
128 * users are interested in finding the
129 * refs spelled in full, and they would
130 * need to filter non-refs if we did so.
131 */
132 break;
133 case 1: /* happy */
134 if (abbrev_ref)
135 full = shorten_unambiguous_ref(full,
136 abbrev_ref_strict);
137 show_with_type(type, full);
138 break;
139 default: /* ambiguous */
140 error("refname '%s' is ambiguous", name);
141 break;
142 }
143 } else {
144 show_with_type(type, name);
145 }
146 }
147 else if (abbrev)
148 show_with_type(type, find_unique_abbrev(sha1, abbrev));
149 else
150 show_with_type(type, sha1_to_hex(sha1));
151 }
152
153 /* Output a flag, only if filter allows it. */
154 static int show_flag(const char *arg)
155 {
156 if (!(filter & DO_FLAGS))
157 return 0;
158 if (filter & (is_rev_argument(arg) ? DO_REVS : DO_NOREV)) {
159 show(arg);
160 return 1;
161 }
162 return 0;
163 }
164
165 static int show_default(void)
166 {
167 const char *s = def;
168
169 if (s) {
170 unsigned char sha1[20];
171
172 def = NULL;
173 if (!get_sha1(s, sha1)) {
174 show_rev(NORMAL, sha1, s);
175 return 1;
176 }
177 }
178 return 0;
179 }
180
181 static int show_reference(const char *refname, const unsigned char *sha1, int flag, void *cb_data)
182 {
183 show_rev(NORMAL, sha1, refname);
184 return 0;
185 }
186
187 static int anti_reference(const char *refname, const unsigned char *sha1, int flag, void *cb_data)
188 {
189 show_rev(REVERSED, sha1, refname);
190 return 0;
191 }
192
193 static void show_datestring(const char *flag, const char *datestr)
194 {
195 static char buffer[100];
196
197 /* date handling requires both flags and revs */
198 if ((filter & (DO_FLAGS | DO_REVS)) != (DO_FLAGS | DO_REVS))
199 return;
200 snprintf(buffer, sizeof(buffer), "%s%lu", flag, approxidate(datestr));
201 show(buffer);
202 }
203
204 static int show_file(const char *arg)
205 {
206 show_default();
207 if ((filter & (DO_NONFLAGS|DO_NOREV)) == (DO_NONFLAGS|DO_NOREV)) {
208 show(arg);
209 return 1;
210 }
211 return 0;
212 }
213
214 static int try_difference(const char *arg)
215 {
216 char *dotdot;
217 unsigned char sha1[20];
218 unsigned char end[20];
219 const char *next;
220 const char *this;
221 int symmetric;
222
223 if (!(dotdot = strstr(arg, "..")))
224 return 0;
225 next = dotdot + 2;
226 this = arg;
227 symmetric = (*next == '.');
228
229 *dotdot = 0;
230 next += symmetric;
231
232 if (!*next)
233 next = "HEAD";
234 if (dotdot == arg)
235 this = "HEAD";
236 if (!get_sha1(this, sha1) && !get_sha1(next, end)) {
237 show_rev(NORMAL, end, next);
238 show_rev(symmetric ? NORMAL : REVERSED, sha1, this);
239 if (symmetric) {
240 struct commit_list *exclude;
241 struct commit *a, *b;
242 a = lookup_commit_reference(sha1);
243 b = lookup_commit_reference(end);
244 exclude = get_merge_bases(a, b, 1);
245 while (exclude) {
246 struct commit_list *n = exclude->next;
247 show_rev(REVERSED,
248 exclude->item->object.sha1,NULL);
249 free(exclude);
250 exclude = n;
251 }
252 }
253 return 1;
254 }
255 *dotdot = '.';
256 return 0;
257 }
258
259 static int try_parent_shorthands(const char *arg)
260 {
261 char *dotdot;
262 unsigned char sha1[20];
263 struct commit *commit;
264 struct commit_list *parents;
265 int parents_only;
266
267 if ((dotdot = strstr(arg, "^!")))
268 parents_only = 0;
269 else if ((dotdot = strstr(arg, "^@")))
270 parents_only = 1;
271
272 if (!dotdot || dotdot[2])
273 return 0;
274
275 *dotdot = 0;
276 if (get_sha1(arg, sha1))
277 return 0;
278
279 if (!parents_only)
280 show_rev(NORMAL, sha1, arg);
281 commit = lookup_commit_reference(sha1);
282 for (parents = commit->parents; parents; parents = parents->next)
283 show_rev(parents_only ? NORMAL : REVERSED,
284 parents->item->object.sha1, arg);
285
286 return 1;
287 }
288
289 static int parseopt_dump(const struct option *o, const char *arg, int unset)
290 {
291 struct strbuf *parsed = o->value;
292 if (unset)
293 strbuf_addf(parsed, " --no-%s", o->long_name);
294 else if (o->short_name)
295 strbuf_addf(parsed, " -%c", o->short_name);
296 else
297 strbuf_addf(parsed, " --%s", o->long_name);
298 if (arg) {
299 strbuf_addch(parsed, ' ');
300 sq_quote_buf(parsed, arg);
301 }
302 return 0;
303 }
304
305 static const char *skipspaces(const char *s)
306 {
307 while (isspace(*s))
308 s++;
309 return s;
310 }
311
312 static int cmd_parseopt(int argc, const char **argv, const char *prefix)
313 {
314 static int keep_dashdash = 0, stop_at_non_option = 0;
315 static char const * const parseopt_usage[] = {
316 "git rev-parse --parseopt [options] -- [<args>...]",
317 NULL
318 };
319 static struct option parseopt_opts[] = {
320 OPT_BOOLEAN(0, "keep-dashdash", &keep_dashdash,
321 "keep the `--` passed as an arg"),
322 OPT_BOOLEAN(0, "stop-at-non-option", &stop_at_non_option,
323 "stop parsing after the "
324 "first non-option argument"),
325 OPT_END(),
326 };
327
328 struct strbuf sb = STRBUF_INIT, parsed = STRBUF_INIT;
329 const char **usage = NULL;
330 struct option *opts = NULL;
331 int onb = 0, osz = 0, unb = 0, usz = 0;
332
333 strbuf_addstr(&parsed, "set --");
334 argc = parse_options(argc, argv, prefix, parseopt_opts, parseopt_usage,
335 PARSE_OPT_KEEP_DASHDASH);
336 if (argc < 1 || strcmp(argv[0], "--"))
337 usage_with_options(parseopt_usage, parseopt_opts);
338
339 /* get the usage up to the first line with a -- on it */
340 for (;;) {
341 if (strbuf_getline(&sb, stdin, '\n') == EOF)
342 die("premature end of input");
343 ALLOC_GROW(usage, unb + 1, usz);
344 if (!strcmp("--", sb.buf)) {
345 if (unb < 1)
346 die("no usage string given before the `--' separator");
347 usage[unb] = NULL;
348 break;
349 }
350 usage[unb++] = strbuf_detach(&sb, NULL);
351 }
352
353 /* parse: (<short>|<short>,<long>|<long>)[=?]? SP+ <help> */
354 while (strbuf_getline(&sb, stdin, '\n') != EOF) {
355 const char *s;
356 struct option *o;
357
358 if (!sb.len)
359 continue;
360
361 ALLOC_GROW(opts, onb + 1, osz);
362 memset(opts + onb, 0, sizeof(opts[onb]));
363
364 o = &opts[onb++];
365 s = strchr(sb.buf, ' ');
366 if (!s || *sb.buf == ' ') {
367 o->type = OPTION_GROUP;
368 o->help = xstrdup(skipspaces(sb.buf));
369 continue;
370 }
371
372 o->type = OPTION_CALLBACK;
373 o->help = xstrdup(skipspaces(s));
374 o->value = &parsed;
375 o->flags = PARSE_OPT_NOARG;
376 o->callback = &parseopt_dump;
377 while (s > sb.buf && strchr("*=?!", s[-1])) {
378 switch (*--s) {
379 case '=':
380 o->flags &= ~PARSE_OPT_NOARG;
381 break;
382 case '?':
383 o->flags &= ~PARSE_OPT_NOARG;
384 o->flags |= PARSE_OPT_OPTARG;
385 break;
386 case '!':
387 o->flags |= PARSE_OPT_NONEG;
388 break;
389 case '*':
390 o->flags |= PARSE_OPT_HIDDEN;
391 break;
392 }
393 }
394
395 if (s - sb.buf == 1) /* short option only */
396 o->short_name = *sb.buf;
397 else if (sb.buf[1] != ',') /* long option only */
398 o->long_name = xmemdupz(sb.buf, s - sb.buf);
399 else {
400 o->short_name = *sb.buf;
401 o->long_name = xmemdupz(sb.buf + 2, s - sb.buf - 2);
402 }
403 }
404 strbuf_release(&sb);
405
406 /* put an OPT_END() */
407 ALLOC_GROW(opts, onb + 1, osz);
408 memset(opts + onb, 0, sizeof(opts[onb]));
409 argc = parse_options(argc, argv, prefix, opts, usage,
410 keep_dashdash ? PARSE_OPT_KEEP_DASHDASH : 0 |
411 stop_at_non_option ? PARSE_OPT_STOP_AT_NON_OPTION : 0);
412
413 strbuf_addf(&parsed, " --");
414 sq_quote_argv(&parsed, argv, 0);
415 puts(parsed.buf);
416 return 0;
417 }
418
419 static int cmd_sq_quote(int argc, const char **argv)
420 {
421 struct strbuf buf = STRBUF_INIT;
422
423 if (argc)
424 sq_quote_argv(&buf, argv, 0);
425 printf("%s\n", buf.buf);
426 strbuf_release(&buf);
427
428 return 0;
429 }
430
431 static void die_no_single_rev(int quiet)
432 {
433 if (quiet)
434 exit(1);
435 else
436 die("Needed a single revision");
437 }
438
439 static const char builtin_rev_parse_usage[] =
440 "git rev-parse --parseopt [options] -- [<args>...]\n"
441 " or: git rev-parse --sq-quote [<arg>...]\n"
442 " or: git rev-parse [options] [<arg>...]\n"
443 "\n"
444 "Run \"git rev-parse --parseopt -h\" for more information on the first usage.";
445
446 int cmd_rev_parse(int argc, const char **argv, const char *prefix)
447 {
448 int i, as_is = 0, verify = 0, quiet = 0, revs_count = 0, type = 0;
449 unsigned char sha1[20];
450 const char *name = NULL;
451
452 if (argc > 1 && !strcmp("--parseopt", argv[1]))
453 return cmd_parseopt(argc - 1, argv + 1, prefix);
454
455 if (argc > 1 && !strcmp("--sq-quote", argv[1]))
456 return cmd_sq_quote(argc - 2, argv + 2);
457
458 if (argc > 1 && !strcmp("-h", argv[1]))
459 usage(builtin_rev_parse_usage);
460
461 prefix = setup_git_directory();
462 git_config(git_default_config, NULL);
463 for (i = 1; i < argc; i++) {
464 const char *arg = argv[i];
465
466 if (as_is) {
467 if (show_file(arg) && as_is < 2)
468 verify_filename(prefix, arg);
469 continue;
470 }
471 if (!strcmp(arg,"-n")) {
472 if (++i >= argc)
473 die("-n requires an argument");
474 if ((filter & DO_FLAGS) && (filter & DO_REVS)) {
475 show(arg);
476 show(argv[i]);
477 }
478 continue;
479 }
480 if (!prefixcmp(arg, "-n")) {
481 if ((filter & DO_FLAGS) && (filter & DO_REVS))
482 show(arg);
483 continue;
484 }
485
486 if (*arg == '-') {
487 if (!strcmp(arg, "--")) {
488 as_is = 2;
489 /* Pass on the "--" if we show anything but files.. */
490 if (filter & (DO_FLAGS | DO_REVS))
491 show_file(arg);
492 continue;
493 }
494 if (!strcmp(arg, "--default")) {
495 def = argv[i+1];
496 i++;
497 continue;
498 }
499 if (!strcmp(arg, "--revs-only")) {
500 filter &= ~DO_NOREV;
501 continue;
502 }
503 if (!strcmp(arg, "--no-revs")) {
504 filter &= ~DO_REVS;
505 continue;
506 }
507 if (!strcmp(arg, "--flags")) {
508 filter &= ~DO_NONFLAGS;
509 continue;
510 }
511 if (!strcmp(arg, "--no-flags")) {
512 filter &= ~DO_FLAGS;
513 continue;
514 }
515 if (!strcmp(arg, "--verify")) {
516 filter &= ~(DO_FLAGS|DO_NOREV);
517 verify = 1;
518 continue;
519 }
520 if (!strcmp(arg, "--quiet") || !strcmp(arg, "-q")) {
521 quiet = 1;
522 continue;
523 }
524 if (!strcmp(arg, "--short") ||
525 !prefixcmp(arg, "--short=")) {
526 filter &= ~(DO_FLAGS|DO_NOREV);
527 verify = 1;
528 abbrev = DEFAULT_ABBREV;
529 if (arg[7] == '=')
530 abbrev = strtoul(arg + 8, NULL, 10);
531 if (abbrev < MINIMUM_ABBREV)
532 abbrev = MINIMUM_ABBREV;
533 else if (40 <= abbrev)
534 abbrev = 40;
535 continue;
536 }
537 if (!strcmp(arg, "--sq")) {
538 output_sq = 1;
539 continue;
540 }
541 if (!strcmp(arg, "--not")) {
542 show_type ^= REVERSED;
543 continue;
544 }
545 if (!strcmp(arg, "--symbolic")) {
546 symbolic = SHOW_SYMBOLIC_ASIS;
547 continue;
548 }
549 if (!strcmp(arg, "--symbolic-full-name")) {
550 symbolic = SHOW_SYMBOLIC_FULL;
551 continue;
552 }
553 if (!prefixcmp(arg, "--abbrev-ref") &&
554 (!arg[12] || arg[12] == '=')) {
555 abbrev_ref = 1;
556 abbrev_ref_strict = warn_ambiguous_refs;
557 if (arg[12] == '=') {
558 if (!strcmp(arg + 13, "strict"))
559 abbrev_ref_strict = 1;
560 else if (!strcmp(arg + 13, "loose"))
561 abbrev_ref_strict = 0;
562 else
563 die("unknown mode for %s", arg);
564 }
565 continue;
566 }
567 if (!strcmp(arg, "--all")) {
568 for_each_ref(show_reference, NULL);
569 continue;
570 }
571 if (!strcmp(arg, "--bisect")) {
572 for_each_ref_in("refs/bisect/bad", show_reference, NULL);
573 for_each_ref_in("refs/bisect/good", anti_reference, NULL);
574 continue;
575 }
576 if (!prefixcmp(arg, "--branches=")) {
577 for_each_glob_ref_in(show_reference, arg + 11,
578 "refs/heads/", NULL);
579 continue;
580 }
581 if (!strcmp(arg, "--branches")) {
582 for_each_branch_ref(show_reference, NULL);
583 continue;
584 }
585 if (!prefixcmp(arg, "--tags=")) {
586 for_each_glob_ref_in(show_reference, arg + 7,
587 "refs/tags/", NULL);
588 continue;
589 }
590 if (!strcmp(arg, "--tags")) {
591 for_each_tag_ref(show_reference, NULL);
592 continue;
593 }
594 if (!prefixcmp(arg, "--glob=")) {
595 for_each_glob_ref(show_reference, arg + 7, NULL);
596 continue;
597 }
598 if (!prefixcmp(arg, "--remotes=")) {
599 for_each_glob_ref_in(show_reference, arg + 10,
600 "refs/remotes/", NULL);
601 continue;
602 }
603 if (!strcmp(arg, "--remotes")) {
604 for_each_remote_ref(show_reference, NULL);
605 continue;
606 }
607 if (!strcmp(arg, "--show-prefix")) {
608 if (prefix)
609 puts(prefix);
610 continue;
611 }
612 if (!strcmp(arg, "--show-cdup")) {
613 const char *pfx = prefix;
614 if (!is_inside_work_tree()) {
615 const char *work_tree =
616 get_git_work_tree();
617 if (work_tree)
618 printf("%s\n", work_tree);
619 continue;
620 }
621 while (pfx) {
622 pfx = strchr(pfx, '/');
623 if (pfx) {
624 pfx++;
625 printf("../");
626 }
627 }
628 putchar('\n');
629 continue;
630 }
631 if (!strcmp(arg, "--git-dir")) {
632 const char *gitdir = getenv(GIT_DIR_ENVIRONMENT);
633 static char cwd[PATH_MAX];
634 if (gitdir) {
635 puts(gitdir);
636 continue;
637 }
638 if (!prefix) {
639 puts(".git");
640 continue;
641 }
642 if (!getcwd(cwd, PATH_MAX))
643 die_errno("unable to get current working directory");
644 printf("%s/.git\n", cwd);
645 continue;
646 }
647 if (!strcmp(arg, "--is-inside-git-dir")) {
648 printf("%s\n", is_inside_git_dir() ? "true"
649 : "false");
650 continue;
651 }
652 if (!strcmp(arg, "--is-inside-work-tree")) {
653 printf("%s\n", is_inside_work_tree() ? "true"
654 : "false");
655 continue;
656 }
657 if (!strcmp(arg, "--is-bare-repository")) {
658 printf("%s\n", is_bare_repository() ? "true"
659 : "false");
660 continue;
661 }
662 if (!prefixcmp(arg, "--since=")) {
663 show_datestring("--max-age=", arg+8);
664 continue;
665 }
666 if (!prefixcmp(arg, "--after=")) {
667 show_datestring("--max-age=", arg+8);
668 continue;
669 }
670 if (!prefixcmp(arg, "--before=")) {
671 show_datestring("--min-age=", arg+9);
672 continue;
673 }
674 if (!prefixcmp(arg, "--until=")) {
675 show_datestring("--min-age=", arg+8);
676 continue;
677 }
678 if (show_flag(arg) && verify)
679 die_no_single_rev(quiet);
680 continue;
681 }
682
683 /* Not a flag argument */
684 if (try_difference(arg))
685 continue;
686 if (try_parent_shorthands(arg))
687 continue;
688 name = arg;
689 type = NORMAL;
690 if (*arg == '^') {
691 name++;
692 type = REVERSED;
693 }
694 if (!get_sha1(name, sha1)) {
695 if (verify)
696 revs_count++;
697 else
698 show_rev(type, sha1, name);
699 continue;
700 }
701 if (verify)
702 die_no_single_rev(quiet);
703 as_is = 1;
704 if (!show_file(arg))
705 continue;
706 verify_filename(prefix, arg);
707 }
708 if (verify) {
709 if (revs_count == 1) {
710 show_rev(type, sha1, name);
711 return 0;
712 } else if (revs_count == 0 && show_default())
713 return 0;
714 die_no_single_rev(quiet);
715 } else
716 show_default();
717 return 0;
718 }