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 "--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 /* accept -<digit>, like traditional "head" */
69 if ((*arg == '-') && isdigit(arg[1]))
70 return 1;
71 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/* Output argument as a string, either SQ or normal */
85static void show(const char *arg)
86{
87 if (output_sq) {
88 int sq = '\'', ch;
89 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/* Like show(), but with a negation prefix according to type */
104static void show_with_type(int type, const char *arg)
105{
106 if (type != show_type)
107 putchar('^');
108 show(arg);
109}
110/* Output a revision, only if filter allows it */
112static void show_rev(int type, const unsigned char *sha1, const char *name)
113{
114 if (!(filter & DO_REVS))
115 return;
116 def = NULL;
117 if ((symbolic || abbrev_ref) && name) {
119 if (symbolic == SHOW_SYMBOLIC_FULL || abbrev_ref) {
120 unsigned char discard[20];
121 char *full;
122 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/* Output a flag, only if filter allows it. */
154static 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}
164static int show_default(void)
166{
167 const char *s = def;
168 if (s) {
170 unsigned char sha1[20];
171 def = NULL;
173 if (!get_sha1(s, sha1)) {
174 show_rev(NORMAL, sha1, s);
175 return 1;
176 }
177 }
178 return 0;
179}
180static 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}
186static 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}
192static void show_datestring(const char *flag, const char *datestr)
194{
195 static char buffer[100];
196 /* 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}
203static 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}
213static 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 if (!(dotdot = strstr(arg, "..")))
224 return 0;
225 next = dotdot + 2;
226 this = arg;
227 symmetric = (*next == '.');
228 *dotdot = 0;
230 next += symmetric;
231 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}
258static 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 if ((dotdot = strstr(arg, "^!")))
268 parents_only = 0;
269 else if ((dotdot = strstr(arg, "^@")))
270 parents_only = 1;
271 if (!dotdot || dotdot[2])
273 return 0;
274 *dotdot = 0;
276 if (get_sha1(arg, sha1))
277 return 0;
278 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 return 1;
287}
288static 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}
304static const char *skipspaces(const char *s)
306{
307 while (isspace(*s))
308 s++;
309 return s;
310}
311static 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 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 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 /* 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 /* parse: (<short>|<short>,<long>|<long>)[=?]? SP+ <help> */
354 while (strbuf_getline(&sb, stdin, '\n') != EOF) {
355 const char *s;
356 struct option *o;
357 if (!sb.len)
359 continue;
360 ALLOC_GROW(opts, onb + 1, osz);
362 memset(opts + onb, 0, sizeof(opts[onb]));
363 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 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 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 /* 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 strbuf_addf(&parsed, " --");
414 sq_quote_argv(&parsed, argv, 0);
415 puts(parsed.buf);
416 return 0;
417}
418static int cmd_sq_quote(int argc, const char **argv)
420{
421 struct strbuf buf = STRBUF_INIT;
422 if (argc)
424 sq_quote_argv(&buf, argv, 0);
425 printf("%s\n", buf.buf);
426 strbuf_release(&buf);
427 return 0;
429}
430static void die_no_single_rev(int quiet)
432{
433 if (quiet)
434 exit(1);
435 else
436 die("Needed a single revision");
437}
438static 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.";
445int 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 if (argc > 1 && !strcmp("--parseopt", argv[1]))
453 return cmd_parseopt(argc - 1, argv + 1, prefix);
454 if (argc > 1 && !strcmp("--sq-quote", argv[1]))
456 return cmd_sq_quote(argc - 2, argv + 2);
457 if (argc == 2 && !strcmp("--local-env-vars", argv[1])) {
459 int i;
460 for (i = 0; local_repo_env[i]; i++)
461 printf("%s\n", local_repo_env[i]);
462 return 0;
463 }
464 if (argc > 1 && !strcmp("-h", argv[1]))
466 usage(builtin_rev_parse_usage);
467 prefix = setup_git_directory();
469 git_config(git_default_config, NULL);
470 for (i = 1; i < argc; i++) {
471 const char *arg = argv[i];
472 if (as_is) {
474 if (show_file(arg) && as_is < 2)
475 verify_filename(prefix, arg);
476 continue;
477 }
478 if (!strcmp(arg,"-n")) {
479 if (++i >= argc)
480 die("-n requires an argument");
481 if ((filter & DO_FLAGS) && (filter & DO_REVS)) {
482 show(arg);
483 show(argv[i]);
484 }
485 continue;
486 }
487 if (!prefixcmp(arg, "-n")) {
488 if ((filter & DO_FLAGS) && (filter & DO_REVS))
489 show(arg);
490 continue;
491 }
492 if (*arg == '-') {
494 if (!strcmp(arg, "--")) {
495 as_is = 2;
496 /* Pass on the "--" if we show anything but files.. */
497 if (filter & (DO_FLAGS | DO_REVS))
498 show_file(arg);
499 continue;
500 }
501 if (!strcmp(arg, "--default")) {
502 def = argv[i+1];
503 i++;
504 continue;
505 }
506 if (!strcmp(arg, "--revs-only")) {
507 filter &= ~DO_NOREV;
508 continue;
509 }
510 if (!strcmp(arg, "--no-revs")) {
511 filter &= ~DO_REVS;
512 continue;
513 }
514 if (!strcmp(arg, "--flags")) {
515 filter &= ~DO_NONFLAGS;
516 continue;
517 }
518 if (!strcmp(arg, "--no-flags")) {
519 filter &= ~DO_FLAGS;
520 continue;
521 }
522 if (!strcmp(arg, "--verify")) {
523 filter &= ~(DO_FLAGS|DO_NOREV);
524 verify = 1;
525 continue;
526 }
527 if (!strcmp(arg, "--quiet") || !strcmp(arg, "-q")) {
528 quiet = 1;
529 continue;
530 }
531 if (!strcmp(arg, "--short") ||
532 !prefixcmp(arg, "--short=")) {
533 filter &= ~(DO_FLAGS|DO_NOREV);
534 verify = 1;
535 abbrev = DEFAULT_ABBREV;
536 if (arg[7] == '=')
537 abbrev = strtoul(arg + 8, NULL, 10);
538 if (abbrev < MINIMUM_ABBREV)
539 abbrev = MINIMUM_ABBREV;
540 else if (40 <= abbrev)
541 abbrev = 40;
542 continue;
543 }
544 if (!strcmp(arg, "--sq")) {
545 output_sq = 1;
546 continue;
547 }
548 if (!strcmp(arg, "--not")) {
549 show_type ^= REVERSED;
550 continue;
551 }
552 if (!strcmp(arg, "--symbolic")) {
553 symbolic = SHOW_SYMBOLIC_ASIS;
554 continue;
555 }
556 if (!strcmp(arg, "--symbolic-full-name")) {
557 symbolic = SHOW_SYMBOLIC_FULL;
558 continue;
559 }
560 if (!prefixcmp(arg, "--abbrev-ref") &&
561 (!arg[12] || arg[12] == '=')) {
562 abbrev_ref = 1;
563 abbrev_ref_strict = warn_ambiguous_refs;
564 if (arg[12] == '=') {
565 if (!strcmp(arg + 13, "strict"))
566 abbrev_ref_strict = 1;
567 else if (!strcmp(arg + 13, "loose"))
568 abbrev_ref_strict = 0;
569 else
570 die("unknown mode for %s", arg);
571 }
572 continue;
573 }
574 if (!strcmp(arg, "--all")) {
575 for_each_ref(show_reference, NULL);
576 continue;
577 }
578 if (!strcmp(arg, "--bisect")) {
579 for_each_ref_in("refs/bisect/bad", show_reference, NULL);
580 for_each_ref_in("refs/bisect/good", anti_reference, NULL);
581 continue;
582 }
583 if (!prefixcmp(arg, "--branches=")) {
584 for_each_glob_ref_in(show_reference, arg + 11,
585 "refs/heads/", NULL);
586 continue;
587 }
588 if (!strcmp(arg, "--branches")) {
589 for_each_branch_ref(show_reference, NULL);
590 continue;
591 }
592 if (!prefixcmp(arg, "--tags=")) {
593 for_each_glob_ref_in(show_reference, arg + 7,
594 "refs/tags/", NULL);
595 continue;
596 }
597 if (!strcmp(arg, "--tags")) {
598 for_each_tag_ref(show_reference, NULL);
599 continue;
600 }
601 if (!prefixcmp(arg, "--glob=")) {
602 for_each_glob_ref(show_reference, arg + 7, NULL);
603 continue;
604 }
605 if (!prefixcmp(arg, "--remotes=")) {
606 for_each_glob_ref_in(show_reference, arg + 10,
607 "refs/remotes/", NULL);
608 continue;
609 }
610 if (!strcmp(arg, "--remotes")) {
611 for_each_remote_ref(show_reference, NULL);
612 continue;
613 }
614 if (!strcmp(arg, "--show-toplevel")) {
615 const char *work_tree = get_git_work_tree();
616 if (work_tree)
617 puts(work_tree);
618 continue;
619 }
620 if (!strcmp(arg, "--show-prefix")) {
621 if (prefix)
622 puts(prefix);
623 continue;
624 }
625 if (!strcmp(arg, "--show-cdup")) {
626 const char *pfx = prefix;
627 if (!is_inside_work_tree()) {
628 const char *work_tree =
629 get_git_work_tree();
630 if (work_tree)
631 printf("%s\n", work_tree);
632 continue;
633 }
634 while (pfx) {
635 pfx = strchr(pfx, '/');
636 if (pfx) {
637 pfx++;
638 printf("../");
639 }
640 }
641 putchar('\n');
642 continue;
643 }
644 if (!strcmp(arg, "--git-dir")) {
645 const char *gitdir = getenv(GIT_DIR_ENVIRONMENT);
646 static char cwd[PATH_MAX];
647 if (gitdir) {
648 puts(gitdir);
649 continue;
650 }
651 if (!prefix) {
652 puts(".git");
653 continue;
654 }
655 if (!getcwd(cwd, PATH_MAX))
656 die_errno("unable to get current working directory");
657 printf("%s/.git\n", cwd);
658 continue;
659 }
660 if (!strcmp(arg, "--is-inside-git-dir")) {
661 printf("%s\n", is_inside_git_dir() ? "true"
662 : "false");
663 continue;
664 }
665 if (!strcmp(arg, "--is-inside-work-tree")) {
666 printf("%s\n", is_inside_work_tree() ? "true"
667 : "false");
668 continue;
669 }
670 if (!strcmp(arg, "--is-bare-repository")) {
671 printf("%s\n", is_bare_repository() ? "true"
672 : "false");
673 continue;
674 }
675 if (!prefixcmp(arg, "--since=")) {
676 show_datestring("--max-age=", arg+8);
677 continue;
678 }
679 if (!prefixcmp(arg, "--after=")) {
680 show_datestring("--max-age=", arg+8);
681 continue;
682 }
683 if (!prefixcmp(arg, "--before=")) {
684 show_datestring("--min-age=", arg+9);
685 continue;
686 }
687 if (!prefixcmp(arg, "--until=")) {
688 show_datestring("--min-age=", arg+8);
689 continue;
690 }
691 if (show_flag(arg) && verify)
692 die_no_single_rev(quiet);
693 continue;
694 }
695 /* Not a flag argument */
697 if (try_difference(arg))
698 continue;
699 if (try_parent_shorthands(arg))
700 continue;
701 name = arg;
702 type = NORMAL;
703 if (*arg == '^') {
704 name++;
705 type = REVERSED;
706 }
707 if (!get_sha1(name, sha1)) {
708 if (verify)
709 revs_count++;
710 else
711 show_rev(type, sha1, name);
712 continue;
713 }
714 if (verify)
715 die_no_single_rev(quiet);
716 as_is = 1;
717 if (!show_file(arg))
718 continue;
719 verify_filename(prefix, arg);
720 }
721 if (verify) {
722 if (revs_count == 1) {
723 show_rev(type, sha1, name);
724 return 0;
725 } else if (revs_count == 0 && show_default())
726 return 0;
727 die_no_single_rev(quiet);
728 } else
729 show_default();
730 return 0;
731}