rev-parse: correctly diagnose revision errors before "--"
[git.git] / builtin / rev-parse.c
blob8be641e07793fa247aaa6d7427484285ccfaa965
1 /*
2 * rev-parse.c
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"
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;
19 static const char *def;
21 #define NORMAL 0
22 #define REVERSED 1
23 static int show_type = NORMAL;
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;
34 * Some arguments are relevant "revision" arguments,
35 * others are about output format or other details.
36 * This sorts it all out.
38 static int is_rev_argument(const char *arg)
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
71 const char **p = rev_args;
73 /* accept -<digit>, like traditional "head" */
74 if ((*arg == '-') && isdigit(arg[1]))
75 return 1;
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;
89 /* Output argument as a string, either SQ or normal */
90 static void show(const char *arg)
92 if (output_sq) {
93 int sq = '\'', ch;
95 putchar(sq);
96 while ((ch = *arg++)) {
97 if (ch == sq)
98 fputs("'\\'", stdout);
99 putchar(ch);
101 putchar(sq);
102 putchar(' ');
104 else
105 puts(arg);
108 /* Like show(), but with a negation prefix according to type */
109 static void show_with_type(int type, const char *arg)
111 if (type != show_type)
112 putchar('^');
113 show(arg);
116 /* Output a revision, only if filter allows it */
117 static void show_rev(int type, const unsigned char *sha1, const char *name)
119 if (!(filter & DO_REVS))
120 return;
121 def = NULL;
123 if ((symbolic || abbrev_ref) && name) {
124 if (symbolic == SHOW_SYMBOLIC_FULL || abbrev_ref) {
125 unsigned char discard[20];
126 char *full;
128 switch (dwim_ref(name, strlen(name), discard, &full)) {
129 case 0:
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.
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;
148 } else {
149 show_with_type(type, name);
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));
158 /* Output a flag, only if filter allows it. */
159 static int show_flag(const char *arg)
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;
167 return 0;
170 static int show_default(void)
172 const char *s = def;
174 if (s) {
175 unsigned char sha1[20];
177 def = NULL;
178 if (!get_sha1(s, sha1)) {
179 show_rev(NORMAL, sha1, s);
180 return 1;
183 return 0;
186 static int show_reference(const char *refname, const unsigned char *sha1, int flag, void *cb_data)
188 show_rev(NORMAL, sha1, refname);
189 return 0;
192 static int anti_reference(const char *refname, const unsigned char *sha1, int flag, void *cb_data)
194 show_rev(REVERSED, sha1, refname);
195 return 0;
198 static int show_abbrev(const unsigned char *sha1, void *cb_data)
200 show_rev(NORMAL, sha1, NULL);
201 return 0;
204 static void show_datestring(const char *flag, const char *datestr)
206 static char buffer[100];
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);
215 static int show_file(const char *arg, int output_prefix)
217 show_default();
218 if ((filter & (DO_NONFLAGS|DO_NOREV)) == (DO_NONFLAGS|DO_NOREV)) {
219 if (output_prefix) {
220 const char *prefix = startup_info->prefix;
221 show(prefix_filename(prefix,
222 prefix ? strlen(prefix) : 0,
223 arg));
224 } else
225 show(arg);
226 return 1;
228 return 0;
231 static int try_difference(const char *arg)
233 char *dotdot;
234 unsigned char sha1[20];
235 unsigned char end[20];
236 const char *next;
237 const char *this;
238 int symmetric;
239 static const char head_by_default[] = "HEAD";
241 if (!(dotdot = strstr(arg, "..")))
242 return 0;
243 next = dotdot + 2;
244 this = arg;
245 symmetric = (*next == '.');
247 *dotdot = 0;
248 next += symmetric;
250 if (!*next)
251 next = head_by_default;
252 if (dotdot == arg)
253 this = head_by_default;
255 if (this == head_by_default && next == head_by_default &&
256 !symmetric) {
258 * Just ".."? That is not a range but the
259 * pathspec for the parent directory.
261 *dotdot = '.';
262 return 0;
265 if (!get_sha1_committish(this, sha1) && !get_sha1_committish(next, end)) {
266 show_rev(NORMAL, end, next);
267 show_rev(symmetric ? NORMAL : REVERSED, sha1, this);
268 if (symmetric) {
269 struct commit_list *exclude;
270 struct commit *a, *b;
271 a = lookup_commit_reference(sha1);
272 b = lookup_commit_reference(end);
273 exclude = get_merge_bases(a, b, 1);
274 while (exclude) {
275 struct commit_list *n = exclude->next;
276 show_rev(REVERSED,
277 exclude->item->object.sha1,NULL);
278 free(exclude);
279 exclude = n;
282 return 1;
284 *dotdot = '.';
285 return 0;
288 static int try_parent_shorthands(const char *arg)
290 char *dotdot;
291 unsigned char sha1[20];
292 struct commit *commit;
293 struct commit_list *parents;
294 int parents_only;
296 if ((dotdot = strstr(arg, "^!")))
297 parents_only = 0;
298 else if ((dotdot = strstr(arg, "^@")))
299 parents_only = 1;
301 if (!dotdot || dotdot[2])
302 return 0;
304 *dotdot = 0;
305 if (get_sha1_committish(arg, sha1))
306 return 0;
308 if (!parents_only)
309 show_rev(NORMAL, sha1, arg);
310 commit = lookup_commit_reference(sha1);
311 for (parents = commit->parents; parents; parents = parents->next)
312 show_rev(parents_only ? NORMAL : REVERSED,
313 parents->item->object.sha1, arg);
315 return 1;
318 static int parseopt_dump(const struct option *o, const char *arg, int unset)
320 struct strbuf *parsed = o->value;
321 if (unset)
322 strbuf_addf(parsed, " --no-%s", o->long_name);
323 else if (o->short_name)
324 strbuf_addf(parsed, " -%c", o->short_name);
325 else
326 strbuf_addf(parsed, " --%s", o->long_name);
327 if (arg) {
328 strbuf_addch(parsed, ' ');
329 sq_quote_buf(parsed, arg);
331 return 0;
334 static const char *skipspaces(const char *s)
336 while (isspace(*s))
337 s++;
338 return s;
341 static int cmd_parseopt(int argc, const char **argv, const char *prefix)
343 static int keep_dashdash = 0, stop_at_non_option = 0;
344 static char const * const parseopt_usage[] = {
345 N_("git rev-parse --parseopt [options] -- [<args>...]"),
346 NULL
348 static struct option parseopt_opts[] = {
349 OPT_BOOL(0, "keep-dashdash", &keep_dashdash,
350 N_("keep the `--` passed as an arg")),
351 OPT_BOOL(0, "stop-at-non-option", &stop_at_non_option,
352 N_("stop parsing after the "
353 "first non-option argument")),
354 OPT_END(),
357 struct strbuf sb = STRBUF_INIT, parsed = STRBUF_INIT;
358 const char **usage = NULL;
359 struct option *opts = NULL;
360 int onb = 0, osz = 0, unb = 0, usz = 0;
362 strbuf_addstr(&parsed, "set --");
363 argc = parse_options(argc, argv, prefix, parseopt_opts, parseopt_usage,
364 PARSE_OPT_KEEP_DASHDASH);
365 if (argc < 1 || strcmp(argv[0], "--"))
366 usage_with_options(parseopt_usage, parseopt_opts);
368 /* get the usage up to the first line with a -- on it */
369 for (;;) {
370 if (strbuf_getline(&sb, stdin, '\n') == EOF)
371 die("premature end of input");
372 ALLOC_GROW(usage, unb + 1, usz);
373 if (!strcmp("--", sb.buf)) {
374 if (unb < 1)
375 die("no usage string given before the `--' separator");
376 usage[unb] = NULL;
377 break;
379 usage[unb++] = strbuf_detach(&sb, NULL);
382 /* parse: (<short>|<short>,<long>|<long>)[=?]? SP+ <help> */
383 while (strbuf_getline(&sb, stdin, '\n') != EOF) {
384 const char *s;
385 struct option *o;
387 if (!sb.len)
388 continue;
390 ALLOC_GROW(opts, onb + 1, osz);
391 memset(opts + onb, 0, sizeof(opts[onb]));
393 o = &opts[onb++];
394 s = strchr(sb.buf, ' ');
395 if (!s || *sb.buf == ' ') {
396 o->type = OPTION_GROUP;
397 o->help = xstrdup(skipspaces(sb.buf));
398 continue;
401 o->type = OPTION_CALLBACK;
402 o->help = xstrdup(skipspaces(s));
403 o->value = &parsed;
404 o->flags = PARSE_OPT_NOARG;
405 o->callback = &parseopt_dump;
406 while (s > sb.buf && strchr("*=?!", s[-1])) {
407 switch (*--s) {
408 case '=':
409 o->flags &= ~PARSE_OPT_NOARG;
410 break;
411 case '?':
412 o->flags &= ~PARSE_OPT_NOARG;
413 o->flags |= PARSE_OPT_OPTARG;
414 break;
415 case '!':
416 o->flags |= PARSE_OPT_NONEG;
417 break;
418 case '*':
419 o->flags |= PARSE_OPT_HIDDEN;
420 break;
424 if (s - sb.buf == 1) /* short option only */
425 o->short_name = *sb.buf;
426 else if (sb.buf[1] != ',') /* long option only */
427 o->long_name = xmemdupz(sb.buf, s - sb.buf);
428 else {
429 o->short_name = *sb.buf;
430 o->long_name = xmemdupz(sb.buf + 2, s - sb.buf - 2);
433 strbuf_release(&sb);
435 /* put an OPT_END() */
436 ALLOC_GROW(opts, onb + 1, osz);
437 memset(opts + onb, 0, sizeof(opts[onb]));
438 argc = parse_options(argc, argv, prefix, opts, usage,
439 (keep_dashdash ? PARSE_OPT_KEEP_DASHDASH : 0) |
440 (stop_at_non_option ? PARSE_OPT_STOP_AT_NON_OPTION : 0) |
441 PARSE_OPT_SHELL_EVAL);
443 strbuf_addf(&parsed, " --");
444 sq_quote_argv(&parsed, argv, 0);
445 puts(parsed.buf);
446 return 0;
449 static int cmd_sq_quote(int argc, const char **argv)
451 struct strbuf buf = STRBUF_INIT;
453 if (argc)
454 sq_quote_argv(&buf, argv, 0);
455 printf("%s\n", buf.buf);
456 strbuf_release(&buf);
458 return 0;
461 static void die_no_single_rev(int quiet)
463 if (quiet)
464 exit(1);
465 else
466 die("Needed a single revision");
469 static const char builtin_rev_parse_usage[] =
470 N_("git rev-parse --parseopt [options] -- [<args>...]\n"
471 " or: git rev-parse --sq-quote [<arg>...]\n"
472 " or: git rev-parse [options] [<arg>...]\n"
473 "\n"
474 "Run \"git rev-parse --parseopt -h\" for more information on the first usage.");
476 int cmd_rev_parse(int argc, const char **argv, const char *prefix)
478 int i, as_is = 0, verify = 0, quiet = 0, revs_count = 0, type = 0;
479 int has_dashdash = 0;
480 int output_prefix = 0;
481 unsigned char sha1[20];
482 const char *name = NULL;
484 if (argc > 1 && !strcmp("--parseopt", argv[1]))
485 return cmd_parseopt(argc - 1, argv + 1, prefix);
487 if (argc > 1 && !strcmp("--sq-quote", argv[1]))
488 return cmd_sq_quote(argc - 2, argv + 2);
490 if (argc > 1 && !strcmp("-h", argv[1]))
491 usage(builtin_rev_parse_usage);
493 for (i = 1; i < argc; i++) {
494 if (!strcmp(argv[i], "--")) {
495 has_dashdash = 1;
496 break;
500 prefix = setup_git_directory();
501 git_config(git_default_config, NULL);
502 for (i = 1; i < argc; i++) {
503 const char *arg = argv[i];
505 if (as_is) {
506 if (show_file(arg, output_prefix) && as_is < 2)
507 verify_filename(prefix, arg, 0);
508 continue;
510 if (!strcmp(arg,"-n")) {
511 if (++i >= argc)
512 die("-n requires an argument");
513 if ((filter & DO_FLAGS) && (filter & DO_REVS)) {
514 show(arg);
515 show(argv[i]);
517 continue;
519 if (!prefixcmp(arg, "-n")) {
520 if ((filter & DO_FLAGS) && (filter & DO_REVS))
521 show(arg);
522 continue;
525 if (*arg == '-') {
526 if (!strcmp(arg, "--")) {
527 as_is = 2;
528 /* Pass on the "--" if we show anything but files.. */
529 if (filter & (DO_FLAGS | DO_REVS))
530 show_file(arg, 0);
531 continue;
533 if (!strcmp(arg, "--default")) {
534 def = argv[i+1];
535 i++;
536 continue;
538 if (!strcmp(arg, "--prefix")) {
539 prefix = argv[i+1];
540 startup_info->prefix = prefix;
541 output_prefix = 1;
542 i++;
543 continue;
545 if (!strcmp(arg, "--revs-only")) {
546 filter &= ~DO_NOREV;
547 continue;
549 if (!strcmp(arg, "--no-revs")) {
550 filter &= ~DO_REVS;
551 continue;
553 if (!strcmp(arg, "--flags")) {
554 filter &= ~DO_NONFLAGS;
555 continue;
557 if (!strcmp(arg, "--no-flags")) {
558 filter &= ~DO_FLAGS;
559 continue;
561 if (!strcmp(arg, "--verify")) {
562 filter &= ~(DO_FLAGS|DO_NOREV);
563 verify = 1;
564 continue;
566 if (!strcmp(arg, "--quiet") || !strcmp(arg, "-q")) {
567 quiet = 1;
568 continue;
570 if (!strcmp(arg, "--short") ||
571 !prefixcmp(arg, "--short=")) {
572 filter &= ~(DO_FLAGS|DO_NOREV);
573 verify = 1;
574 abbrev = DEFAULT_ABBREV;
575 if (arg[7] == '=')
576 abbrev = strtoul(arg + 8, NULL, 10);
577 if (abbrev < MINIMUM_ABBREV)
578 abbrev = MINIMUM_ABBREV;
579 else if (40 <= abbrev)
580 abbrev = 40;
581 continue;
583 if (!strcmp(arg, "--sq")) {
584 output_sq = 1;
585 continue;
587 if (!strcmp(arg, "--not")) {
588 show_type ^= REVERSED;
589 continue;
591 if (!strcmp(arg, "--symbolic")) {
592 symbolic = SHOW_SYMBOLIC_ASIS;
593 continue;
595 if (!strcmp(arg, "--symbolic-full-name")) {
596 symbolic = SHOW_SYMBOLIC_FULL;
597 continue;
599 if (!prefixcmp(arg, "--abbrev-ref") &&
600 (!arg[12] || arg[12] == '=')) {
601 abbrev_ref = 1;
602 abbrev_ref_strict = warn_ambiguous_refs;
603 if (arg[12] == '=') {
604 if (!strcmp(arg + 13, "strict"))
605 abbrev_ref_strict = 1;
606 else if (!strcmp(arg + 13, "loose"))
607 abbrev_ref_strict = 0;
608 else
609 die("unknown mode for %s", arg);
611 continue;
613 if (!strcmp(arg, "--all")) {
614 for_each_ref(show_reference, NULL);
615 continue;
617 if (!prefixcmp(arg, "--disambiguate=")) {
618 for_each_abbrev(arg + 15, show_abbrev, NULL);
619 continue;
621 if (!strcmp(arg, "--bisect")) {
622 for_each_ref_in("refs/bisect/bad", show_reference, NULL);
623 for_each_ref_in("refs/bisect/good", anti_reference, NULL);
624 continue;
626 if (!prefixcmp(arg, "--branches=")) {
627 for_each_glob_ref_in(show_reference, arg + 11,
628 "refs/heads/", NULL);
629 continue;
631 if (!strcmp(arg, "--branches")) {
632 for_each_branch_ref(show_reference, NULL);
633 continue;
635 if (!prefixcmp(arg, "--tags=")) {
636 for_each_glob_ref_in(show_reference, arg + 7,
637 "refs/tags/", NULL);
638 continue;
640 if (!strcmp(arg, "--tags")) {
641 for_each_tag_ref(show_reference, NULL);
642 continue;
644 if (!prefixcmp(arg, "--glob=")) {
645 for_each_glob_ref(show_reference, arg + 7, NULL);
646 continue;
648 if (!prefixcmp(arg, "--remotes=")) {
649 for_each_glob_ref_in(show_reference, arg + 10,
650 "refs/remotes/", NULL);
651 continue;
653 if (!strcmp(arg, "--remotes")) {
654 for_each_remote_ref(show_reference, NULL);
655 continue;
657 if (!strcmp(arg, "--local-env-vars")) {
658 int i;
659 for (i = 0; local_repo_env[i]; i++)
660 printf("%s\n", local_repo_env[i]);
661 continue;
663 if (!strcmp(arg, "--show-toplevel")) {
664 const char *work_tree = get_git_work_tree();
665 if (work_tree)
666 puts(work_tree);
667 continue;
669 if (!strcmp(arg, "--show-prefix")) {
670 if (prefix)
671 puts(prefix);
672 else
673 putchar('\n');
674 continue;
676 if (!strcmp(arg, "--show-cdup")) {
677 const char *pfx = prefix;
678 if (!is_inside_work_tree()) {
679 const char *work_tree =
680 get_git_work_tree();
681 if (work_tree)
682 printf("%s\n", work_tree);
683 continue;
685 while (pfx) {
686 pfx = strchr(pfx, '/');
687 if (pfx) {
688 pfx++;
689 printf("../");
692 putchar('\n');
693 continue;
695 if (!strcmp(arg, "--git-dir")) {
696 const char *gitdir = getenv(GIT_DIR_ENVIRONMENT);
697 static char cwd[PATH_MAX];
698 int len;
699 if (gitdir) {
700 puts(gitdir);
701 continue;
703 if (!prefix) {
704 puts(".git");
705 continue;
707 if (!getcwd(cwd, PATH_MAX))
708 die_errno("unable to get current working directory");
709 len = strlen(cwd);
710 printf("%s%s.git\n", cwd, len && cwd[len-1] != '/' ? "/" : "");
711 continue;
713 if (!strcmp(arg, "--resolve-git-dir")) {
714 const char *gitdir = resolve_gitdir(argv[i+1]);
715 if (!gitdir)
716 die("not a gitdir '%s'", argv[i+1]);
717 puts(gitdir);
718 continue;
720 if (!strcmp(arg, "--is-inside-git-dir")) {
721 printf("%s\n", is_inside_git_dir() ? "true"
722 : "false");
723 continue;
725 if (!strcmp(arg, "--is-inside-work-tree")) {
726 printf("%s\n", is_inside_work_tree() ? "true"
727 : "false");
728 continue;
730 if (!strcmp(arg, "--is-bare-repository")) {
731 printf("%s\n", is_bare_repository() ? "true"
732 : "false");
733 continue;
735 if (!prefixcmp(arg, "--since=")) {
736 show_datestring("--max-age=", arg+8);
737 continue;
739 if (!prefixcmp(arg, "--after=")) {
740 show_datestring("--max-age=", arg+8);
741 continue;
743 if (!prefixcmp(arg, "--before=")) {
744 show_datestring("--min-age=", arg+9);
745 continue;
747 if (!prefixcmp(arg, "--until=")) {
748 show_datestring("--min-age=", arg+8);
749 continue;
751 if (show_flag(arg) && verify)
752 die_no_single_rev(quiet);
753 continue;
756 /* Not a flag argument */
757 if (try_difference(arg))
758 continue;
759 if (try_parent_shorthands(arg))
760 continue;
761 name = arg;
762 type = NORMAL;
763 if (*arg == '^') {
764 name++;
765 type = REVERSED;
767 if (!get_sha1(name, sha1)) {
768 if (verify)
769 revs_count++;
770 else
771 show_rev(type, sha1, name);
772 continue;
774 if (verify)
775 die_no_single_rev(quiet);
776 if (has_dashdash)
777 die("bad revision '%s'", arg);
778 as_is = 1;
779 if (!show_file(arg, output_prefix))
780 continue;
781 verify_filename(prefix, arg, 1);
783 if (verify) {
784 if (revs_count == 1) {
785 show_rev(type, sha1, name);
786 return 0;
787 } else if (revs_count == 0 && show_default())
788 return 0;
789 die_no_single_rev(quiet);
790 } else
791 show_default();
792 return 0;