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 void show_datestring(const char *flag, const char *datestr)
199{
200 static char buffer[100];
201
202 /* date handling requires both flags and revs */
203 if ((filter & (DO_FLAGS | DO_REVS)) != (DO_FLAGS | DO_REVS))
204 return;
205 snprintf(buffer, sizeof(buffer), "%s%lu", flag, approxidate(datestr));
206 show(buffer);
207}
208
209static int show_file(const char *arg)
210{
211 show_default();
212 if ((filter & (DO_NONFLAGS|DO_NOREV)) == (DO_NONFLAGS|DO_NOREV)) {
213 show(arg);
214 return 1;
215 }
216 return 0;
217}
218
219static int try_difference(const char *arg)
220{
221 char *dotdot;
222 unsigned char sha1[20];
223 unsigned char end[20];
224 const char *next;
225 const char *this;
226 int symmetric;
227 static const char head_by_default[] = "HEAD";
228
229 if (!(dotdot = strstr(arg, "..")))
230 return 0;
231 next = dotdot + 2;
232 this = arg;
233 symmetric = (*next == '.');
234
235 *dotdot = 0;
236 next += symmetric;
237
238 if (!*next)
239 next = head_by_default;
240 if (dotdot == arg)
241 this = head_by_default;
242
243 if (this == head_by_default && next == head_by_default &&
244 !symmetric) {
245 /*
246 * Just ".."? That is not a range but the
247 * pathspec for the parent directory.
248 */
249 *dotdot = '.';
250 return 0;
251 }
252
253 if (!get_sha1(this, sha1) && !get_sha1(next, end)) {
254 show_rev(NORMAL, end, next);
255 show_rev(symmetric ? NORMAL : REVERSED, sha1, this);
256 if (symmetric) {
257 struct commit_list *exclude;
258 struct commit *a, *b;
259 a = lookup_commit_reference(sha1);
260 b = lookup_commit_reference(end);
261 exclude = get_merge_bases(a, b, 1);
262 while (exclude) {
263 struct commit_list *n = exclude->next;
264 show_rev(REVERSED,
265 exclude->item->object.sha1,NULL);
266 free(exclude);
267 exclude = n;
268 }
269 }
270 return 1;
271 }
272 *dotdot = '.';
273 return 0;
274}
275
276static int try_parent_shorthands(const char *arg)
277{
278 char *dotdot;
279 unsigned char sha1[20];
280 struct commit *commit;
281 struct commit_list *parents;
282 int parents_only;
283
284 if ((dotdot = strstr(arg, "^!")))
285 parents_only = 0;
286 else if ((dotdot = strstr(arg, "^@")))
287 parents_only = 1;
288
289 if (!dotdot || dotdot[2])
290 return 0;
291
292 *dotdot = 0;
293 if (get_sha1(arg, sha1))
294 return 0;
295
296 if (!parents_only)
297 show_rev(NORMAL, sha1, arg);
298 commit = lookup_commit_reference(sha1);
299 for (parents = commit->parents; parents; parents = parents->next)
300 show_rev(parents_only ? NORMAL : REVERSED,
301 parents->item->object.sha1, arg);
302
303 return 1;
304}
305
306static int parseopt_dump(const struct option *o, const char *arg, int unset)
307{
308 struct strbuf *parsed = o->value;
309 if (unset)
310 strbuf_addf(parsed, " --no-%s", o->long_name);
311 else if (o->short_name)
312 strbuf_addf(parsed, " -%c", o->short_name);
313 else
314 strbuf_addf(parsed, " --%s", o->long_name);
315 if (arg) {
316 strbuf_addch(parsed, ' ');
317 sq_quote_buf(parsed, arg);
318 }
319 return 0;
320}
321
322static const char *skipspaces(const char *s)
323{
324 while (isspace(*s))
325 s++;
326 return s;
327}
328
329static int cmd_parseopt(int argc, const char **argv, const char *prefix)
330{
331 static int keep_dashdash = 0, stop_at_non_option = 0;
332 static char const * const parseopt_usage[] = {
333 "git rev-parse --parseopt [options] -- [<args>...]",
334 NULL
335 };
336 static struct option parseopt_opts[] = {
337 OPT_BOOLEAN(0, "keep-dashdash", &keep_dashdash,
338 "keep the `--` passed as an arg"),
339 OPT_BOOLEAN(0, "stop-at-non-option", &stop_at_non_option,
340 "stop parsing after the "
341 "first non-option argument"),
342 OPT_END(),
343 };
344
345 struct strbuf sb = STRBUF_INIT, parsed = STRBUF_INIT;
346 const char **usage = NULL;
347 struct option *opts = NULL;
348 int onb = 0, osz = 0, unb = 0, usz = 0;
349
350 strbuf_addstr(&parsed, "set --");
351 argc = parse_options(argc, argv, prefix, parseopt_opts, parseopt_usage,
352 PARSE_OPT_KEEP_DASHDASH);
353 if (argc < 1 || strcmp(argv[0], "--"))
354 usage_with_options(parseopt_usage, parseopt_opts);
355
356 /* get the usage up to the first line with a -- on it */
357 for (;;) {
358 if (strbuf_getline(&sb, stdin, '\n') == EOF)
359 die("premature end of input");
360 ALLOC_GROW(usage, unb + 1, usz);
361 if (!strcmp("--", sb.buf)) {
362 if (unb < 1)
363 die("no usage string given before the `--' separator");
364 usage[unb] = NULL;
365 break;
366 }
367 usage[unb++] = strbuf_detach(&sb, NULL);
368 }
369
370 /* parse: (<short>|<short>,<long>|<long>)[=?]? SP+ <help> */
371 while (strbuf_getline(&sb, stdin, '\n') != EOF) {
372 const char *s;
373 struct option *o;
374
375 if (!sb.len)
376 continue;
377
378 ALLOC_GROW(opts, onb + 1, osz);
379 memset(opts + onb, 0, sizeof(opts[onb]));
380
381 o = &opts[onb++];
382 s = strchr(sb.buf, ' ');
383 if (!s || *sb.buf == ' ') {
384 o->type = OPTION_GROUP;
385 o->help = xstrdup(skipspaces(sb.buf));
386 continue;
387 }
388
389 o->type = OPTION_CALLBACK;
390 o->help = xstrdup(skipspaces(s));
391 o->value = &parsed;
392 o->flags = PARSE_OPT_NOARG;
393 o->callback = &parseopt_dump;
394 while (s > sb.buf && strchr("*=?!", s[-1])) {
395 switch (*--s) {
396 case '=':
397 o->flags &= ~PARSE_OPT_NOARG;
398 break;
399 case '?':
400 o->flags &= ~PARSE_OPT_NOARG;
401 o->flags |= PARSE_OPT_OPTARG;
402 break;
403 case '!':
404 o->flags |= PARSE_OPT_NONEG;
405 break;
406 case '*':
407 o->flags |= PARSE_OPT_HIDDEN;
408 break;
409 }
410 }
411
412 if (s - sb.buf == 1) /* short option only */
413 o->short_name = *sb.buf;
414 else if (sb.buf[1] != ',') /* long option only */
415 o->long_name = xmemdupz(sb.buf, s - sb.buf);
416 else {
417 o->short_name = *sb.buf;
418 o->long_name = xmemdupz(sb.buf + 2, s - sb.buf - 2);
419 }
420 }
421 strbuf_release(&sb);
422
423 /* put an OPT_END() */
424 ALLOC_GROW(opts, onb + 1, osz);
425 memset(opts + onb, 0, sizeof(opts[onb]));
426 argc = parse_options(argc, argv, prefix, opts, usage,
427 (keep_dashdash ? PARSE_OPT_KEEP_DASHDASH : 0) |
428 (stop_at_non_option ? PARSE_OPT_STOP_AT_NON_OPTION : 0) |
429 PARSE_OPT_SHELL_EVAL);
430
431 strbuf_addf(&parsed, " --");
432 sq_quote_argv(&parsed, argv, 0);
433 puts(parsed.buf);
434 return 0;
435}
436
437static int cmd_sq_quote(int argc, const char **argv)
438{
439 struct strbuf buf = STRBUF_INIT;
440
441 if (argc)
442 sq_quote_argv(&buf, argv, 0);
443 printf("%s\n", buf.buf);
444 strbuf_release(&buf);
445
446 return 0;
447}
448
449static void die_no_single_rev(int quiet)
450{
451 if (quiet)
452 exit(1);
453 else
454 die("Needed a single revision");
455}
456
457static const char builtin_rev_parse_usage[] =
458"git rev-parse --parseopt [options] -- [<args>...]\n"
459" or: git rev-parse --sq-quote [<arg>...]\n"
460" or: git rev-parse [options] [<arg>...]\n"
461"\n"
462"Run \"git rev-parse --parseopt -h\" for more information on the first usage.";
463
464int cmd_rev_parse(int argc, const char **argv, const char *prefix)
465{
466 int i, as_is = 0, verify = 0, quiet = 0, revs_count = 0, type = 0;
467 unsigned char sha1[20];
468 const char *name = NULL;
469
470 if (argc > 1 && !strcmp("--parseopt", argv[1]))
471 return cmd_parseopt(argc - 1, argv + 1, prefix);
472
473 if (argc > 1 && !strcmp("--sq-quote", argv[1]))
474 return cmd_sq_quote(argc - 2, argv + 2);
475
476 if (argc == 2 && !strcmp("--local-env-vars", argv[1])) {
477 int i;
478 for (i = 0; local_repo_env[i]; i++)
479 printf("%s\n", local_repo_env[i]);
480 return 0;
481 }
482
483 if (argc > 2 && !strcmp(argv[1], "--resolve-git-dir")) {
484 const char *gitdir = resolve_gitdir(argv[2]);
485 if (!gitdir)
486 die("not a gitdir '%s'", argv[2]);
487 puts(gitdir);
488 return 0;
489 }
490
491 if (argc > 1 && !strcmp("-h", argv[1]))
492 usage(builtin_rev_parse_usage);
493
494 prefix = setup_git_directory();
495 git_config(git_default_config, NULL);
496 for (i = 1; i < argc; i++) {
497 const char *arg = argv[i];
498
499 if (as_is) {
500 if (show_file(arg) && as_is < 2)
501 verify_filename(prefix, arg, 0);
502 continue;
503 }
504 if (!strcmp(arg,"-n")) {
505 if (++i >= argc)
506 die("-n requires an argument");
507 if ((filter & DO_FLAGS) && (filter & DO_REVS)) {
508 show(arg);
509 show(argv[i]);
510 }
511 continue;
512 }
513 if (!prefixcmp(arg, "-n")) {
514 if ((filter & DO_FLAGS) && (filter & DO_REVS))
515 show(arg);
516 continue;
517 }
518
519 if (*arg == '-') {
520 if (!strcmp(arg, "--")) {
521 as_is = 2;
522 /* Pass on the "--" if we show anything but files.. */
523 if (filter & (DO_FLAGS | DO_REVS))
524 show_file(arg);
525 continue;
526 }
527 if (!strcmp(arg, "--default")) {
528 def = argv[i+1];
529 i++;
530 continue;
531 }
532 if (!strcmp(arg, "--revs-only")) {
533 filter &= ~DO_NOREV;
534 continue;
535 }
536 if (!strcmp(arg, "--no-revs")) {
537 filter &= ~DO_REVS;
538 continue;
539 }
540 if (!strcmp(arg, "--flags")) {
541 filter &= ~DO_NONFLAGS;
542 continue;
543 }
544 if (!strcmp(arg, "--no-flags")) {
545 filter &= ~DO_FLAGS;
546 continue;
547 }
548 if (!strcmp(arg, "--verify")) {
549 filter &= ~(DO_FLAGS|DO_NOREV);
550 verify = 1;
551 continue;
552 }
553 if (!strcmp(arg, "--quiet") || !strcmp(arg, "-q")) {
554 quiet = 1;
555 continue;
556 }
557 if (!strcmp(arg, "--short") ||
558 !prefixcmp(arg, "--short=")) {
559 filter &= ~(DO_FLAGS|DO_NOREV);
560 verify = 1;
561 abbrev = DEFAULT_ABBREV;
562 if (arg[7] == '=')
563 abbrev = strtoul(arg + 8, NULL, 10);
564 if (abbrev < MINIMUM_ABBREV)
565 abbrev = MINIMUM_ABBREV;
566 else if (40 <= abbrev)
567 abbrev = 40;
568 continue;
569 }
570 if (!strcmp(arg, "--sq")) {
571 output_sq = 1;
572 continue;
573 }
574 if (!strcmp(arg, "--not")) {
575 show_type ^= REVERSED;
576 continue;
577 }
578 if (!strcmp(arg, "--symbolic")) {
579 symbolic = SHOW_SYMBOLIC_ASIS;
580 continue;
581 }
582 if (!strcmp(arg, "--symbolic-full-name")) {
583 symbolic = SHOW_SYMBOLIC_FULL;
584 continue;
585 }
586 if (!prefixcmp(arg, "--abbrev-ref") &&
587 (!arg[12] || arg[12] == '=')) {
588 abbrev_ref = 1;
589 abbrev_ref_strict = warn_ambiguous_refs;
590 if (arg[12] == '=') {
591 if (!strcmp(arg + 13, "strict"))
592 abbrev_ref_strict = 1;
593 else if (!strcmp(arg + 13, "loose"))
594 abbrev_ref_strict = 0;
595 else
596 die("unknown mode for %s", arg);
597 }
598 continue;
599 }
600 if (!strcmp(arg, "--all")) {
601 for_each_ref(show_reference, NULL);
602 continue;
603 }
604 if (!strcmp(arg, "--bisect")) {
605 for_each_ref_in("refs/bisect/bad", show_reference, NULL);
606 for_each_ref_in("refs/bisect/good", anti_reference, NULL);
607 continue;
608 }
609 if (!prefixcmp(arg, "--branches=")) {
610 for_each_glob_ref_in(show_reference, arg + 11,
611 "refs/heads/", NULL);
612 continue;
613 }
614 if (!strcmp(arg, "--branches")) {
615 for_each_branch_ref(show_reference, NULL);
616 continue;
617 }
618 if (!prefixcmp(arg, "--tags=")) {
619 for_each_glob_ref_in(show_reference, arg + 7,
620 "refs/tags/", NULL);
621 continue;
622 }
623 if (!strcmp(arg, "--tags")) {
624 for_each_tag_ref(show_reference, NULL);
625 continue;
626 }
627 if (!prefixcmp(arg, "--glob=")) {
628 for_each_glob_ref(show_reference, arg + 7, NULL);
629 continue;
630 }
631 if (!prefixcmp(arg, "--remotes=")) {
632 for_each_glob_ref_in(show_reference, arg + 10,
633 "refs/remotes/", NULL);
634 continue;
635 }
636 if (!strcmp(arg, "--remotes")) {
637 for_each_remote_ref(show_reference, NULL);
638 continue;
639 }
640 if (!strcmp(arg, "--show-toplevel")) {
641 const char *work_tree = get_git_work_tree();
642 if (work_tree)
643 puts(work_tree);
644 continue;
645 }
646 if (!strcmp(arg, "--show-prefix")) {
647 if (prefix)
648 puts(prefix);
649 else
650 putchar('\n');
651 continue;
652 }
653 if (!strcmp(arg, "--show-cdup")) {
654 const char *pfx = prefix;
655 if (!is_inside_work_tree()) {
656 const char *work_tree =
657 get_git_work_tree();
658 if (work_tree)
659 printf("%s\n", work_tree);
660 continue;
661 }
662 while (pfx) {
663 pfx = strchr(pfx, '/');
664 if (pfx) {
665 pfx++;
666 printf("../");
667 }
668 }
669 putchar('\n');
670 continue;
671 }
672 if (!strcmp(arg, "--git-dir")) {
673 const char *gitdir = getenv(GIT_DIR_ENVIRONMENT);
674 static char cwd[PATH_MAX];
675 int len;
676 if (gitdir) {
677 puts(gitdir);
678 continue;
679 }
680 if (!prefix) {
681 puts(".git");
682 continue;
683 }
684 if (!getcwd(cwd, PATH_MAX))
685 die_errno("unable to get current working directory");
686 len = strlen(cwd);
687 printf("%s%s.git\n", cwd, len && cwd[len-1] != '/' ? "/" : "");
688 continue;
689 }
690 if (!strcmp(arg, "--is-inside-git-dir")) {
691 printf("%s\n", is_inside_git_dir() ? "true"
692 : "false");
693 continue;
694 }
695 if (!strcmp(arg, "--is-inside-work-tree")) {
696 printf("%s\n", is_inside_work_tree() ? "true"
697 : "false");
698 continue;
699 }
700 if (!strcmp(arg, "--is-bare-repository")) {
701 printf("%s\n", is_bare_repository() ? "true"
702 : "false");
703 continue;
704 }
705 if (!prefixcmp(arg, "--since=")) {
706 show_datestring("--max-age=", arg+8);
707 continue;
708 }
709 if (!prefixcmp(arg, "--after=")) {
710 show_datestring("--max-age=", arg+8);
711 continue;
712 }
713 if (!prefixcmp(arg, "--before=")) {
714 show_datestring("--min-age=", arg+9);
715 continue;
716 }
717 if (!prefixcmp(arg, "--until=")) {
718 show_datestring("--min-age=", arg+8);
719 continue;
720 }
721 if (show_flag(arg) && verify)
722 die_no_single_rev(quiet);
723 continue;
724 }
725
726 /* Not a flag argument */
727 if (try_difference(arg))
728 continue;
729 if (try_parent_shorthands(arg))
730 continue;
731 name = arg;
732 type = NORMAL;
733 if (*arg == '^') {
734 name++;
735 type = REVERSED;
736 }
737 if (!get_sha1(name, sha1)) {
738 if (verify)
739 revs_count++;
740 else
741 show_rev(type, sha1, name);
742 continue;
743 }
744 if (verify)
745 die_no_single_rev(quiet);
746 as_is = 1;
747 if (!show_file(arg))
748 continue;
749 verify_filename(prefix, arg, 1);
750 }
751 if (verify) {
752 if (revs_count == 1) {
753 show_rev(type, sha1, name);
754 return 0;
755 } else if (revs_count == 0 && show_default())
756 return 0;
757 die_no_single_rev(quiet);
758 } else
759 show_default();
760 return 0;
761}