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