Merge branch 'rs/code-cleaning'
[git.git] / builtin / rev-parse.c
blob8102aaa9248d55055761f9899903cac2a2c7cc1e
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"
12 #include "diff.h"
13 #include "revision.h"
14 #include "split-index.h"
16 #define DO_REVS 1
17 #define DO_NOREV 2
18 #define DO_FLAGS 4
19 #define DO_NONFLAGS 8
20 static int filter = ~0;
22 static const char *def;
24 #define NORMAL 0
25 #define REVERSED 1
26 static int show_type = NORMAL;
28 #define SHOW_SYMBOLIC_ASIS 1
29 #define SHOW_SYMBOLIC_FULL 2
30 static int symbolic;
31 static int abbrev;
32 static int abbrev_ref;
33 static int abbrev_ref_strict;
34 static int output_sq;
36 static int stuck_long;
37 static struct string_list *ref_excludes;
40 * Some arguments are relevant "revision" arguments,
41 * others are about output format or other details.
42 * This sorts it all out.
44 static int is_rev_argument(const char *arg)
46 static const char *rev_args[] = {
47 "--all",
48 "--bisect",
49 "--dense",
50 "--branches=",
51 "--branches",
52 "--header",
53 "--ignore-missing",
54 "--max-age=",
55 "--max-count=",
56 "--min-age=",
57 "--no-merges",
58 "--min-parents=",
59 "--no-min-parents",
60 "--max-parents=",
61 "--no-max-parents",
62 "--objects",
63 "--objects-edge",
64 "--parents",
65 "--pretty",
66 "--remotes=",
67 "--remotes",
68 "--glob=",
69 "--sparse",
70 "--tags=",
71 "--tags",
72 "--topo-order",
73 "--date-order",
74 "--unpacked",
75 NULL
77 const char **p = rev_args;
79 /* accept -<digit>, like traditional "head" */
80 if ((*arg == '-') && isdigit(arg[1]))
81 return 1;
83 for (;;) {
84 const char *str = *p++;
85 int len;
86 if (!str)
87 return 0;
88 len = strlen(str);
89 if (!strcmp(arg, str) ||
90 (str[len-1] == '=' && !strncmp(arg, str, len)))
91 return 1;
95 /* Output argument as a string, either SQ or normal */
96 static void show(const char *arg)
98 if (output_sq) {
99 int sq = '\'', ch;
101 putchar(sq);
102 while ((ch = *arg++)) {
103 if (ch == sq)
104 fputs("'\\'", stdout);
105 putchar(ch);
107 putchar(sq);
108 putchar(' ');
110 else
111 puts(arg);
114 /* Like show(), but with a negation prefix according to type */
115 static void show_with_type(int type, const char *arg)
117 if (type != show_type)
118 putchar('^');
119 show(arg);
122 /* Output a revision, only if filter allows it */
123 static void show_rev(int type, const unsigned char *sha1, const char *name)
125 if (!(filter & DO_REVS))
126 return;
127 def = NULL;
129 if ((symbolic || abbrev_ref) && name) {
130 if (symbolic == SHOW_SYMBOLIC_FULL || abbrev_ref) {
131 unsigned char discard[20];
132 char *full;
134 switch (dwim_ref(name, strlen(name), discard, &full)) {
135 case 0:
137 * Not found -- not a ref. We could
138 * emit "name" here, but symbolic-full
139 * users are interested in finding the
140 * refs spelled in full, and they would
141 * need to filter non-refs if we did so.
143 break;
144 case 1: /* happy */
145 if (abbrev_ref)
146 full = shorten_unambiguous_ref(full,
147 abbrev_ref_strict);
148 show_with_type(type, full);
149 break;
150 default: /* ambiguous */
151 error("refname '%s' is ambiguous", name);
152 break;
154 } else {
155 show_with_type(type, name);
158 else if (abbrev)
159 show_with_type(type, find_unique_abbrev(sha1, abbrev));
160 else
161 show_with_type(type, sha1_to_hex(sha1));
164 /* Output a flag, only if filter allows it. */
165 static int show_flag(const char *arg)
167 if (!(filter & DO_FLAGS))
168 return 0;
169 if (filter & (is_rev_argument(arg) ? DO_REVS : DO_NOREV)) {
170 show(arg);
171 return 1;
173 return 0;
176 static int show_default(void)
178 const char *s = def;
180 if (s) {
181 unsigned char sha1[20];
183 def = NULL;
184 if (!get_sha1(s, sha1)) {
185 show_rev(NORMAL, sha1, s);
186 return 1;
189 return 0;
192 static int show_reference(const char *refname, const unsigned char *sha1, int flag, void *cb_data)
194 if (ref_excluded(ref_excludes, refname))
195 return 0;
196 show_rev(NORMAL, sha1, refname);
197 return 0;
200 static int anti_reference(const char *refname, const unsigned char *sha1, int flag, void *cb_data)
202 show_rev(REVERSED, sha1, refname);
203 return 0;
206 static int show_abbrev(const unsigned char *sha1, void *cb_data)
208 show_rev(NORMAL, sha1, NULL);
209 return 0;
212 static void show_datestring(const char *flag, const char *datestr)
214 static char buffer[100];
216 /* date handling requires both flags and revs */
217 if ((filter & (DO_FLAGS | DO_REVS)) != (DO_FLAGS | DO_REVS))
218 return;
219 snprintf(buffer, sizeof(buffer), "%s%lu", flag, approxidate(datestr));
220 show(buffer);
223 static int show_file(const char *arg, int output_prefix)
225 show_default();
226 if ((filter & (DO_NONFLAGS|DO_NOREV)) == (DO_NONFLAGS|DO_NOREV)) {
227 if (output_prefix) {
228 const char *prefix = startup_info->prefix;
229 show(prefix_filename(prefix,
230 prefix ? strlen(prefix) : 0,
231 arg));
232 } else
233 show(arg);
234 return 1;
236 return 0;
239 static int try_difference(const char *arg)
241 char *dotdot;
242 unsigned char sha1[20];
243 unsigned char end[20];
244 const char *next;
245 const char *this;
246 int symmetric;
247 static const char head_by_default[] = "HEAD";
249 if (!(dotdot = strstr(arg, "..")))
250 return 0;
251 next = dotdot + 2;
252 this = arg;
253 symmetric = (*next == '.');
255 *dotdot = 0;
256 next += symmetric;
258 if (!*next)
259 next = head_by_default;
260 if (dotdot == arg)
261 this = head_by_default;
263 if (this == head_by_default && next == head_by_default &&
264 !symmetric) {
266 * Just ".."? That is not a range but the
267 * pathspec for the parent directory.
269 *dotdot = '.';
270 return 0;
273 if (!get_sha1_committish(this, sha1) && !get_sha1_committish(next, end)) {
274 show_rev(NORMAL, end, next);
275 show_rev(symmetric ? NORMAL : REVERSED, sha1, this);
276 if (symmetric) {
277 struct commit_list *exclude;
278 struct commit *a, *b;
279 a = lookup_commit_reference(sha1);
280 b = lookup_commit_reference(end);
281 exclude = get_merge_bases(a, b, 1);
282 while (exclude) {
283 struct commit_list *n = exclude->next;
284 show_rev(REVERSED,
285 exclude->item->object.sha1,NULL);
286 free(exclude);
287 exclude = n;
290 *dotdot = '.';
291 return 1;
293 *dotdot = '.';
294 return 0;
297 static int try_parent_shorthands(const char *arg)
299 char *dotdot;
300 unsigned char sha1[20];
301 struct commit *commit;
302 struct commit_list *parents;
303 int parents_only;
305 if ((dotdot = strstr(arg, "^!")))
306 parents_only = 0;
307 else if ((dotdot = strstr(arg, "^@")))
308 parents_only = 1;
310 if (!dotdot || dotdot[2])
311 return 0;
313 *dotdot = 0;
314 if (get_sha1_committish(arg, sha1)) {
315 *dotdot = '^';
316 return 0;
319 if (!parents_only)
320 show_rev(NORMAL, sha1, arg);
321 commit = lookup_commit_reference(sha1);
322 for (parents = commit->parents; parents; parents = parents->next)
323 show_rev(parents_only ? NORMAL : REVERSED,
324 parents->item->object.sha1, arg);
326 *dotdot = '^';
327 return 1;
330 static int parseopt_dump(const struct option *o, const char *arg, int unset)
332 struct strbuf *parsed = o->value;
333 if (unset)
334 strbuf_addf(parsed, " --no-%s", o->long_name);
335 else if (o->short_name && (o->long_name == NULL || !stuck_long))
336 strbuf_addf(parsed, " -%c", o->short_name);
337 else
338 strbuf_addf(parsed, " --%s", o->long_name);
339 if (arg) {
340 if (!stuck_long)
341 strbuf_addch(parsed, ' ');
342 else if (o->long_name)
343 strbuf_addch(parsed, '=');
344 sq_quote_buf(parsed, arg);
346 return 0;
349 static const char *skipspaces(const char *s)
351 while (isspace(*s))
352 s++;
353 return s;
356 static int cmd_parseopt(int argc, const char **argv, const char *prefix)
358 static int keep_dashdash = 0, stop_at_non_option = 0;
359 static char const * const parseopt_usage[] = {
360 N_("git rev-parse --parseopt [options] -- [<args>...]"),
361 NULL
363 static struct option parseopt_opts[] = {
364 OPT_BOOL(0, "keep-dashdash", &keep_dashdash,
365 N_("keep the `--` passed as an arg")),
366 OPT_BOOL(0, "stop-at-non-option", &stop_at_non_option,
367 N_("stop parsing after the "
368 "first non-option argument")),
369 OPT_BOOL(0, "stuck-long", &stuck_long,
370 N_("output in stuck long form")),
371 OPT_END(),
374 struct strbuf sb = STRBUF_INIT, parsed = STRBUF_INIT;
375 const char **usage = NULL;
376 struct option *opts = NULL;
377 int onb = 0, osz = 0, unb = 0, usz = 0;
379 strbuf_addstr(&parsed, "set --");
380 argc = parse_options(argc, argv, prefix, parseopt_opts, parseopt_usage,
381 PARSE_OPT_KEEP_DASHDASH);
382 if (argc < 1 || strcmp(argv[0], "--"))
383 usage_with_options(parseopt_usage, parseopt_opts);
385 /* get the usage up to the first line with a -- on it */
386 for (;;) {
387 if (strbuf_getline(&sb, stdin, '\n') == EOF)
388 die("premature end of input");
389 ALLOC_GROW(usage, unb + 1, usz);
390 if (!strcmp("--", sb.buf)) {
391 if (unb < 1)
392 die("no usage string given before the `--' separator");
393 usage[unb] = NULL;
394 break;
396 usage[unb++] = strbuf_detach(&sb, NULL);
399 /* parse: (<short>|<short>,<long>|<long>)[*=?!]*<arghint>? SP+ <help> */
400 while (strbuf_getline(&sb, stdin, '\n') != EOF) {
401 const char *s;
402 const char *end;
403 struct option *o;
405 if (!sb.len)
406 continue;
408 ALLOC_GROW(opts, onb + 1, osz);
409 memset(opts + onb, 0, sizeof(opts[onb]));
411 o = &opts[onb++];
412 s = strchr(sb.buf, ' ');
413 if (!s || *sb.buf == ' ') {
414 o->type = OPTION_GROUP;
415 o->help = xstrdup(skipspaces(sb.buf));
416 continue;
419 o->type = OPTION_CALLBACK;
420 o->help = xstrdup(skipspaces(s));
421 o->value = &parsed;
422 o->flags = PARSE_OPT_NOARG;
423 o->callback = &parseopt_dump;
425 /* Possible argument name hint */
426 end = s;
427 while (s > sb.buf && strchr("*=?!", s[-1]) == NULL)
428 --s;
429 if (s != sb.buf && s != end)
430 o->argh = xmemdupz(s, end - s);
431 if (s == sb.buf)
432 s = end;
434 while (s > sb.buf && strchr("*=?!", s[-1])) {
435 switch (*--s) {
436 case '=':
437 o->flags &= ~PARSE_OPT_NOARG;
438 break;
439 case '?':
440 o->flags &= ~PARSE_OPT_NOARG;
441 o->flags |= PARSE_OPT_OPTARG;
442 break;
443 case '!':
444 o->flags |= PARSE_OPT_NONEG;
445 break;
446 case '*':
447 o->flags |= PARSE_OPT_HIDDEN;
448 break;
452 if (s - sb.buf == 1) /* short option only */
453 o->short_name = *sb.buf;
454 else if (sb.buf[1] != ',') /* long option only */
455 o->long_name = xmemdupz(sb.buf, s - sb.buf);
456 else {
457 o->short_name = *sb.buf;
458 o->long_name = xmemdupz(sb.buf + 2, s - sb.buf - 2);
461 strbuf_release(&sb);
463 /* put an OPT_END() */
464 ALLOC_GROW(opts, onb + 1, osz);
465 memset(opts + onb, 0, sizeof(opts[onb]));
466 argc = parse_options(argc, argv, prefix, opts, usage,
467 (keep_dashdash ? PARSE_OPT_KEEP_DASHDASH : 0) |
468 (stop_at_non_option ? PARSE_OPT_STOP_AT_NON_OPTION : 0) |
469 PARSE_OPT_SHELL_EVAL);
471 strbuf_addf(&parsed, " --");
472 sq_quote_argv(&parsed, argv, 0);
473 puts(parsed.buf);
474 return 0;
477 static int cmd_sq_quote(int argc, const char **argv)
479 struct strbuf buf = STRBUF_INIT;
481 if (argc)
482 sq_quote_argv(&buf, argv, 0);
483 printf("%s\n", buf.buf);
484 strbuf_release(&buf);
486 return 0;
489 static void die_no_single_rev(int quiet)
491 if (quiet)
492 exit(1);
493 else
494 die("Needed a single revision");
497 static const char builtin_rev_parse_usage[] =
498 N_("git rev-parse --parseopt [options] -- [<args>...]\n"
499 " or: git rev-parse --sq-quote [<arg>...]\n"
500 " or: git rev-parse [options] [<arg>...]\n"
501 "\n"
502 "Run \"git rev-parse --parseopt -h\" for more information on the first usage.");
504 int cmd_rev_parse(int argc, const char **argv, const char *prefix)
506 int i, as_is = 0, verify = 0, quiet = 0, revs_count = 0, type = 0;
507 int has_dashdash = 0;
508 int output_prefix = 0;
509 unsigned char sha1[20];
510 const char *name = NULL;
512 if (argc > 1 && !strcmp("--parseopt", argv[1]))
513 return cmd_parseopt(argc - 1, argv + 1, prefix);
515 if (argc > 1 && !strcmp("--sq-quote", argv[1]))
516 return cmd_sq_quote(argc - 2, argv + 2);
518 if (argc > 1 && !strcmp("-h", argv[1]))
519 usage(builtin_rev_parse_usage);
521 for (i = 1; i < argc; i++) {
522 if (!strcmp(argv[i], "--")) {
523 has_dashdash = 1;
524 break;
528 prefix = setup_git_directory();
529 git_config(git_default_config, NULL);
530 for (i = 1; i < argc; i++) {
531 const char *arg = argv[i];
533 if (as_is) {
534 if (show_file(arg, output_prefix) && as_is < 2)
535 verify_filename(prefix, arg, 0);
536 continue;
538 if (!strcmp(arg,"-n")) {
539 if (++i >= argc)
540 die("-n requires an argument");
541 if ((filter & DO_FLAGS) && (filter & DO_REVS)) {
542 show(arg);
543 show(argv[i]);
545 continue;
547 if (starts_with(arg, "-n")) {
548 if ((filter & DO_FLAGS) && (filter & DO_REVS))
549 show(arg);
550 continue;
553 if (*arg == '-') {
554 if (!strcmp(arg, "--")) {
555 as_is = 2;
556 /* Pass on the "--" if we show anything but files.. */
557 if (filter & (DO_FLAGS | DO_REVS))
558 show_file(arg, 0);
559 continue;
561 if (!strcmp(arg, "--default")) {
562 def = argv[++i];
563 if (!def)
564 die("--default requires an argument");
565 continue;
567 if (!strcmp(arg, "--prefix")) {
568 prefix = argv[++i];
569 if (!prefix)
570 die("--prefix requires an argument");
571 startup_info->prefix = prefix;
572 output_prefix = 1;
573 continue;
575 if (!strcmp(arg, "--revs-only")) {
576 filter &= ~DO_NOREV;
577 continue;
579 if (!strcmp(arg, "--no-revs")) {
580 filter &= ~DO_REVS;
581 continue;
583 if (!strcmp(arg, "--flags")) {
584 filter &= ~DO_NONFLAGS;
585 continue;
587 if (!strcmp(arg, "--no-flags")) {
588 filter &= ~DO_FLAGS;
589 continue;
591 if (!strcmp(arg, "--verify")) {
592 filter &= ~(DO_FLAGS|DO_NOREV);
593 verify = 1;
594 continue;
596 if (!strcmp(arg, "--quiet") || !strcmp(arg, "-q")) {
597 quiet = 1;
598 continue;
600 if (!strcmp(arg, "--short") ||
601 starts_with(arg, "--short=")) {
602 filter &= ~(DO_FLAGS|DO_NOREV);
603 verify = 1;
604 abbrev = DEFAULT_ABBREV;
605 if (arg[7] == '=')
606 abbrev = strtoul(arg + 8, NULL, 10);
607 if (abbrev < MINIMUM_ABBREV)
608 abbrev = MINIMUM_ABBREV;
609 else if (40 <= abbrev)
610 abbrev = 40;
611 continue;
613 if (!strcmp(arg, "--sq")) {
614 output_sq = 1;
615 continue;
617 if (!strcmp(arg, "--not")) {
618 show_type ^= REVERSED;
619 continue;
621 if (!strcmp(arg, "--symbolic")) {
622 symbolic = SHOW_SYMBOLIC_ASIS;
623 continue;
625 if (!strcmp(arg, "--symbolic-full-name")) {
626 symbolic = SHOW_SYMBOLIC_FULL;
627 continue;
629 if (starts_with(arg, "--abbrev-ref") &&
630 (!arg[12] || arg[12] == '=')) {
631 abbrev_ref = 1;
632 abbrev_ref_strict = warn_ambiguous_refs;
633 if (arg[12] == '=') {
634 if (!strcmp(arg + 13, "strict"))
635 abbrev_ref_strict = 1;
636 else if (!strcmp(arg + 13, "loose"))
637 abbrev_ref_strict = 0;
638 else
639 die("unknown mode for %s", arg);
641 continue;
643 if (!strcmp(arg, "--all")) {
644 for_each_ref(show_reference, NULL);
645 continue;
647 if (starts_with(arg, "--disambiguate=")) {
648 for_each_abbrev(arg + 15, show_abbrev, NULL);
649 continue;
651 if (!strcmp(arg, "--bisect")) {
652 for_each_ref_in("refs/bisect/bad", show_reference, NULL);
653 for_each_ref_in("refs/bisect/good", anti_reference, NULL);
654 continue;
656 if (starts_with(arg, "--branches=")) {
657 for_each_glob_ref_in(show_reference, arg + 11,
658 "refs/heads/", NULL);
659 clear_ref_exclusion(&ref_excludes);
660 continue;
662 if (!strcmp(arg, "--branches")) {
663 for_each_branch_ref(show_reference, NULL);
664 clear_ref_exclusion(&ref_excludes);
665 continue;
667 if (starts_with(arg, "--tags=")) {
668 for_each_glob_ref_in(show_reference, arg + 7,
669 "refs/tags/", NULL);
670 clear_ref_exclusion(&ref_excludes);
671 continue;
673 if (!strcmp(arg, "--tags")) {
674 for_each_tag_ref(show_reference, NULL);
675 clear_ref_exclusion(&ref_excludes);
676 continue;
678 if (starts_with(arg, "--glob=")) {
679 for_each_glob_ref(show_reference, arg + 7, NULL);
680 clear_ref_exclusion(&ref_excludes);
681 continue;
683 if (starts_with(arg, "--remotes=")) {
684 for_each_glob_ref_in(show_reference, arg + 10,
685 "refs/remotes/", NULL);
686 clear_ref_exclusion(&ref_excludes);
687 continue;
689 if (!strcmp(arg, "--remotes")) {
690 for_each_remote_ref(show_reference, NULL);
691 clear_ref_exclusion(&ref_excludes);
692 continue;
694 if (starts_with(arg, "--exclude=")) {
695 add_ref_exclusion(&ref_excludes, arg + 10);
696 continue;
698 if (!strcmp(arg, "--local-env-vars")) {
699 int i;
700 for (i = 0; local_repo_env[i]; i++)
701 printf("%s\n", local_repo_env[i]);
702 continue;
704 if (!strcmp(arg, "--show-toplevel")) {
705 const char *work_tree = get_git_work_tree();
706 if (work_tree)
707 puts(work_tree);
708 continue;
710 if (!strcmp(arg, "--show-prefix")) {
711 if (prefix)
712 puts(prefix);
713 else
714 putchar('\n');
715 continue;
717 if (!strcmp(arg, "--show-cdup")) {
718 const char *pfx = prefix;
719 if (!is_inside_work_tree()) {
720 const char *work_tree =
721 get_git_work_tree();
722 if (work_tree)
723 printf("%s\n", work_tree);
724 continue;
726 while (pfx) {
727 pfx = strchr(pfx, '/');
728 if (pfx) {
729 pfx++;
730 printf("../");
733 putchar('\n');
734 continue;
736 if (!strcmp(arg, "--git-dir")) {
737 const char *gitdir = getenv(GIT_DIR_ENVIRONMENT);
738 static char cwd[PATH_MAX];
739 int len;
740 if (gitdir) {
741 puts(gitdir);
742 continue;
744 if (!prefix) {
745 puts(".git");
746 continue;
748 if (!getcwd(cwd, PATH_MAX))
749 die_errno("unable to get current working directory");
750 len = strlen(cwd);
751 printf("%s%s.git\n", cwd, len && cwd[len-1] != '/' ? "/" : "");
752 continue;
754 if (!strcmp(arg, "--resolve-git-dir")) {
755 const char *gitdir = argv[++i];
756 if (!gitdir)
757 die("--resolve-git-dir requires an argument");
758 gitdir = resolve_gitdir(gitdir);
759 if (!gitdir)
760 die("not a gitdir '%s'", argv[i]);
761 puts(gitdir);
762 continue;
764 if (!strcmp(arg, "--is-inside-git-dir")) {
765 printf("%s\n", is_inside_git_dir() ? "true"
766 : "false");
767 continue;
769 if (!strcmp(arg, "--is-inside-work-tree")) {
770 printf("%s\n", is_inside_work_tree() ? "true"
771 : "false");
772 continue;
774 if (!strcmp(arg, "--is-bare-repository")) {
775 printf("%s\n", is_bare_repository() ? "true"
776 : "false");
777 continue;
779 if (!strcmp(arg, "--shared-index-path")) {
780 if (read_cache() < 0)
781 die(_("Could not read the index"));
782 if (the_index.split_index) {
783 const unsigned char *sha1 = the_index.split_index->base_sha1;
784 puts(git_path("sharedindex.%s", sha1_to_hex(sha1)));
786 continue;
788 if (starts_with(arg, "--since=")) {
789 show_datestring("--max-age=", arg+8);
790 continue;
792 if (starts_with(arg, "--after=")) {
793 show_datestring("--max-age=", arg+8);
794 continue;
796 if (starts_with(arg, "--before=")) {
797 show_datestring("--min-age=", arg+9);
798 continue;
800 if (starts_with(arg, "--until=")) {
801 show_datestring("--min-age=", arg+8);
802 continue;
804 if (show_flag(arg) && verify)
805 die_no_single_rev(quiet);
806 continue;
809 /* Not a flag argument */
810 if (try_difference(arg))
811 continue;
812 if (try_parent_shorthands(arg))
813 continue;
814 name = arg;
815 type = NORMAL;
816 if (*arg == '^') {
817 name++;
818 type = REVERSED;
820 if (!get_sha1(name, sha1)) {
821 if (verify)
822 revs_count++;
823 else
824 show_rev(type, sha1, name);
825 continue;
827 if (verify)
828 die_no_single_rev(quiet);
829 if (has_dashdash)
830 die("bad revision '%s'", arg);
831 as_is = 1;
832 if (!show_file(arg, output_prefix))
833 continue;
834 verify_filename(prefix, arg, 1);
836 if (verify) {
837 if (revs_count == 1) {
838 show_rev(type, sha1, name);
839 return 0;
840 } else if (revs_count == 0 && show_default())
841 return 0;
842 die_no_single_rev(quiet);
843 } else
844 show_default();
845 return 0;