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