help: mark common_guides[] as translatable
[alt-git.git] / builtin / rev-parse.c
blobf267a1d3b57c1f1ab44c83a197f46051f4f13060
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)
217 show_default();
218 if ((filter & (DO_NONFLAGS|DO_NOREV)) == (DO_NONFLAGS|DO_NOREV)) {
219 show(arg);
220 return 1;
222 return 0;
225 static int try_difference(const char *arg)
227 char *dotdot;
228 unsigned char sha1[20];
229 unsigned char end[20];
230 const char *next;
231 const char *this;
232 int symmetric;
233 static const char head_by_default[] = "HEAD";
235 if (!(dotdot = strstr(arg, "..")))
236 return 0;
237 next = dotdot + 2;
238 this = arg;
239 symmetric = (*next == '.');
241 *dotdot = 0;
242 next += symmetric;
244 if (!*next)
245 next = head_by_default;
246 if (dotdot == arg)
247 this = head_by_default;
249 if (this == head_by_default && next == head_by_default &&
250 !symmetric) {
252 * Just ".."? That is not a range but the
253 * pathspec for the parent directory.
255 *dotdot = '.';
256 return 0;
259 if (!get_sha1_committish(this, sha1) && !get_sha1_committish(next, end)) {
260 show_rev(NORMAL, end, next);
261 show_rev(symmetric ? NORMAL : REVERSED, sha1, this);
262 if (symmetric) {
263 struct commit_list *exclude;
264 struct commit *a, *b;
265 a = lookup_commit_reference(sha1);
266 b = lookup_commit_reference(end);
267 exclude = get_merge_bases(a, b, 1);
268 while (exclude) {
269 struct commit_list *n = exclude->next;
270 show_rev(REVERSED,
271 exclude->item->object.sha1,NULL);
272 free(exclude);
273 exclude = n;
276 return 1;
278 *dotdot = '.';
279 return 0;
282 static int try_parent_shorthands(const char *arg)
284 char *dotdot;
285 unsigned char sha1[20];
286 struct commit *commit;
287 struct commit_list *parents;
288 int parents_only;
290 if ((dotdot = strstr(arg, "^!")))
291 parents_only = 0;
292 else if ((dotdot = strstr(arg, "^@")))
293 parents_only = 1;
295 if (!dotdot || dotdot[2])
296 return 0;
298 *dotdot = 0;
299 if (get_sha1_committish(arg, sha1))
300 return 0;
302 if (!parents_only)
303 show_rev(NORMAL, sha1, arg);
304 commit = lookup_commit_reference(sha1);
305 for (parents = commit->parents; parents; parents = parents->next)
306 show_rev(parents_only ? NORMAL : REVERSED,
307 parents->item->object.sha1, arg);
309 return 1;
312 static int parseopt_dump(const struct option *o, const char *arg, int unset)
314 struct strbuf *parsed = o->value;
315 if (unset)
316 strbuf_addf(parsed, " --no-%s", o->long_name);
317 else if (o->short_name)
318 strbuf_addf(parsed, " -%c", o->short_name);
319 else
320 strbuf_addf(parsed, " --%s", o->long_name);
321 if (arg) {
322 strbuf_addch(parsed, ' ');
323 sq_quote_buf(parsed, arg);
325 return 0;
328 static const char *skipspaces(const char *s)
330 while (isspace(*s))
331 s++;
332 return s;
335 static int cmd_parseopt(int argc, const char **argv, const char *prefix)
337 static int keep_dashdash = 0, stop_at_non_option = 0;
338 static char const * const parseopt_usage[] = {
339 N_("git rev-parse --parseopt [options] -- [<args>...]"),
340 NULL
342 static struct option parseopt_opts[] = {
343 OPT_BOOLEAN(0, "keep-dashdash", &keep_dashdash,
344 N_("keep the `--` passed as an arg")),
345 OPT_BOOLEAN(0, "stop-at-non-option", &stop_at_non_option,
346 N_("stop parsing after the "
347 "first non-option argument")),
348 OPT_END(),
351 struct strbuf sb = STRBUF_INIT, parsed = STRBUF_INIT;
352 const char **usage = NULL;
353 struct option *opts = NULL;
354 int onb = 0, osz = 0, unb = 0, usz = 0;
356 strbuf_addstr(&parsed, "set --");
357 argc = parse_options(argc, argv, prefix, parseopt_opts, parseopt_usage,
358 PARSE_OPT_KEEP_DASHDASH);
359 if (argc < 1 || strcmp(argv[0], "--"))
360 usage_with_options(parseopt_usage, parseopt_opts);
362 /* get the usage up to the first line with a -- on it */
363 for (;;) {
364 if (strbuf_getline(&sb, stdin, '\n') == EOF)
365 die("premature end of input");
366 ALLOC_GROW(usage, unb + 1, usz);
367 if (!strcmp("--", sb.buf)) {
368 if (unb < 1)
369 die("no usage string given before the `--' separator");
370 usage[unb] = NULL;
371 break;
373 usage[unb++] = strbuf_detach(&sb, NULL);
376 /* parse: (<short>|<short>,<long>|<long>)[=?]? SP+ <help> */
377 while (strbuf_getline(&sb, stdin, '\n') != EOF) {
378 const char *s;
379 struct option *o;
381 if (!sb.len)
382 continue;
384 ALLOC_GROW(opts, onb + 1, osz);
385 memset(opts + onb, 0, sizeof(opts[onb]));
387 o = &opts[onb++];
388 s = strchr(sb.buf, ' ');
389 if (!s || *sb.buf == ' ') {
390 o->type = OPTION_GROUP;
391 o->help = xstrdup(skipspaces(sb.buf));
392 continue;
395 o->type = OPTION_CALLBACK;
396 o->help = xstrdup(skipspaces(s));
397 o->value = &parsed;
398 o->flags = PARSE_OPT_NOARG;
399 o->callback = &parseopt_dump;
400 while (s > sb.buf && strchr("*=?!", s[-1])) {
401 switch (*--s) {
402 case '=':
403 o->flags &= ~PARSE_OPT_NOARG;
404 break;
405 case '?':
406 o->flags &= ~PARSE_OPT_NOARG;
407 o->flags |= PARSE_OPT_OPTARG;
408 break;
409 case '!':
410 o->flags |= PARSE_OPT_NONEG;
411 break;
412 case '*':
413 o->flags |= PARSE_OPT_HIDDEN;
414 break;
418 if (s - sb.buf == 1) /* short option only */
419 o->short_name = *sb.buf;
420 else if (sb.buf[1] != ',') /* long option only */
421 o->long_name = xmemdupz(sb.buf, s - sb.buf);
422 else {
423 o->short_name = *sb.buf;
424 o->long_name = xmemdupz(sb.buf + 2, s - sb.buf - 2);
427 strbuf_release(&sb);
429 /* put an OPT_END() */
430 ALLOC_GROW(opts, onb + 1, osz);
431 memset(opts + onb, 0, sizeof(opts[onb]));
432 argc = parse_options(argc, argv, prefix, opts, usage,
433 (keep_dashdash ? PARSE_OPT_KEEP_DASHDASH : 0) |
434 (stop_at_non_option ? PARSE_OPT_STOP_AT_NON_OPTION : 0) |
435 PARSE_OPT_SHELL_EVAL);
437 strbuf_addf(&parsed, " --");
438 sq_quote_argv(&parsed, argv, 0);
439 puts(parsed.buf);
440 return 0;
443 static int cmd_sq_quote(int argc, const char **argv)
445 struct strbuf buf = STRBUF_INIT;
447 if (argc)
448 sq_quote_argv(&buf, argv, 0);
449 printf("%s\n", buf.buf);
450 strbuf_release(&buf);
452 return 0;
455 static void die_no_single_rev(int quiet)
457 if (quiet)
458 exit(1);
459 else
460 die("Needed a single revision");
463 static const char builtin_rev_parse_usage[] =
464 N_("git rev-parse --parseopt [options] -- [<args>...]\n"
465 " or: git rev-parse --sq-quote [<arg>...]\n"
466 " or: git rev-parse [options] [<arg>...]\n"
467 "\n"
468 "Run \"git rev-parse --parseopt -h\" for more information on the first usage.");
470 int cmd_rev_parse(int argc, const char **argv, const char *prefix)
472 int i, as_is = 0, verify = 0, quiet = 0, revs_count = 0, type = 0;
473 unsigned char sha1[20];
474 const char *name = NULL;
476 if (argc > 1 && !strcmp("--parseopt", argv[1]))
477 return cmd_parseopt(argc - 1, argv + 1, prefix);
479 if (argc > 1 && !strcmp("--sq-quote", argv[1]))
480 return cmd_sq_quote(argc - 2, argv + 2);
482 if (argc == 2 && !strcmp("--local-env-vars", argv[1])) {
483 int i;
484 for (i = 0; local_repo_env[i]; i++)
485 printf("%s\n", local_repo_env[i]);
486 return 0;
489 if (argc > 2 && !strcmp(argv[1], "--resolve-git-dir")) {
490 const char *gitdir = resolve_gitdir(argv[2]);
491 if (!gitdir)
492 die("not a gitdir '%s'", argv[2]);
493 puts(gitdir);
494 return 0;
497 if (argc > 1 && !strcmp("-h", argv[1]))
498 usage(builtin_rev_parse_usage);
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) && 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);
531 continue;
533 if (!strcmp(arg, "--default")) {
534 def = argv[i+1];
535 i++;
536 continue;
538 if (!strcmp(arg, "--revs-only")) {
539 filter &= ~DO_NOREV;
540 continue;
542 if (!strcmp(arg, "--no-revs")) {
543 filter &= ~DO_REVS;
544 continue;
546 if (!strcmp(arg, "--flags")) {
547 filter &= ~DO_NONFLAGS;
548 continue;
550 if (!strcmp(arg, "--no-flags")) {
551 filter &= ~DO_FLAGS;
552 continue;
554 if (!strcmp(arg, "--verify")) {
555 filter &= ~(DO_FLAGS|DO_NOREV);
556 verify = 1;
557 continue;
559 if (!strcmp(arg, "--quiet") || !strcmp(arg, "-q")) {
560 quiet = 1;
561 continue;
563 if (!strcmp(arg, "--short") ||
564 !prefixcmp(arg, "--short=")) {
565 filter &= ~(DO_FLAGS|DO_NOREV);
566 verify = 1;
567 abbrev = DEFAULT_ABBREV;
568 if (arg[7] == '=')
569 abbrev = strtoul(arg + 8, NULL, 10);
570 if (abbrev < MINIMUM_ABBREV)
571 abbrev = MINIMUM_ABBREV;
572 else if (40 <= abbrev)
573 abbrev = 40;
574 continue;
576 if (!strcmp(arg, "--sq")) {
577 output_sq = 1;
578 continue;
580 if (!strcmp(arg, "--not")) {
581 show_type ^= REVERSED;
582 continue;
584 if (!strcmp(arg, "--symbolic")) {
585 symbolic = SHOW_SYMBOLIC_ASIS;
586 continue;
588 if (!strcmp(arg, "--symbolic-full-name")) {
589 symbolic = SHOW_SYMBOLIC_FULL;
590 continue;
592 if (!prefixcmp(arg, "--abbrev-ref") &&
593 (!arg[12] || arg[12] == '=')) {
594 abbrev_ref = 1;
595 abbrev_ref_strict = warn_ambiguous_refs;
596 if (arg[12] == '=') {
597 if (!strcmp(arg + 13, "strict"))
598 abbrev_ref_strict = 1;
599 else if (!strcmp(arg + 13, "loose"))
600 abbrev_ref_strict = 0;
601 else
602 die("unknown mode for %s", arg);
604 continue;
606 if (!strcmp(arg, "--all")) {
607 for_each_ref(show_reference, NULL);
608 continue;
610 if (!prefixcmp(arg, "--disambiguate=")) {
611 for_each_abbrev(arg + 15, show_abbrev, NULL);
612 continue;
614 if (!strcmp(arg, "--bisect")) {
615 for_each_ref_in("refs/bisect/bad", show_reference, NULL);
616 for_each_ref_in("refs/bisect/good", anti_reference, NULL);
617 continue;
619 if (!prefixcmp(arg, "--branches=")) {
620 for_each_glob_ref_in(show_reference, arg + 11,
621 "refs/heads/", NULL);
622 continue;
624 if (!strcmp(arg, "--branches")) {
625 for_each_branch_ref(show_reference, NULL);
626 continue;
628 if (!prefixcmp(arg, "--tags=")) {
629 for_each_glob_ref_in(show_reference, arg + 7,
630 "refs/tags/", NULL);
631 continue;
633 if (!strcmp(arg, "--tags")) {
634 for_each_tag_ref(show_reference, NULL);
635 continue;
637 if (!prefixcmp(arg, "--glob=")) {
638 for_each_glob_ref(show_reference, arg + 7, NULL);
639 continue;
641 if (!prefixcmp(arg, "--remotes=")) {
642 for_each_glob_ref_in(show_reference, arg + 10,
643 "refs/remotes/", NULL);
644 continue;
646 if (!strcmp(arg, "--remotes")) {
647 for_each_remote_ref(show_reference, NULL);
648 continue;
650 if (!strcmp(arg, "--show-toplevel")) {
651 const char *work_tree = get_git_work_tree();
652 if (work_tree)
653 puts(work_tree);
654 continue;
656 if (!strcmp(arg, "--show-prefix")) {
657 if (prefix)
658 puts(prefix);
659 else
660 putchar('\n');
661 continue;
663 if (!strcmp(arg, "--show-cdup")) {
664 const char *pfx = prefix;
665 if (!is_inside_work_tree()) {
666 const char *work_tree =
667 get_git_work_tree();
668 if (work_tree)
669 printf("%s\n", work_tree);
670 continue;
672 while (pfx) {
673 pfx = strchr(pfx, '/');
674 if (pfx) {
675 pfx++;
676 printf("../");
679 putchar('\n');
680 continue;
682 if (!strcmp(arg, "--git-dir")) {
683 const char *gitdir = getenv(GIT_DIR_ENVIRONMENT);
684 static char cwd[PATH_MAX];
685 int len;
686 if (gitdir) {
687 puts(gitdir);
688 continue;
690 if (!prefix) {
691 puts(".git");
692 continue;
694 if (!getcwd(cwd, PATH_MAX))
695 die_errno("unable to get current working directory");
696 len = strlen(cwd);
697 printf("%s%s.git\n", cwd, len && cwd[len-1] != '/' ? "/" : "");
698 continue;
700 if (!strcmp(arg, "--is-inside-git-dir")) {
701 printf("%s\n", is_inside_git_dir() ? "true"
702 : "false");
703 continue;
705 if (!strcmp(arg, "--is-inside-work-tree")) {
706 printf("%s\n", is_inside_work_tree() ? "true"
707 : "false");
708 continue;
710 if (!strcmp(arg, "--is-bare-repository")) {
711 printf("%s\n", is_bare_repository() ? "true"
712 : "false");
713 continue;
715 if (!prefixcmp(arg, "--since=")) {
716 show_datestring("--max-age=", arg+8);
717 continue;
719 if (!prefixcmp(arg, "--after=")) {
720 show_datestring("--max-age=", arg+8);
721 continue;
723 if (!prefixcmp(arg, "--before=")) {
724 show_datestring("--min-age=", arg+9);
725 continue;
727 if (!prefixcmp(arg, "--until=")) {
728 show_datestring("--min-age=", arg+8);
729 continue;
731 if (show_flag(arg) && verify)
732 die_no_single_rev(quiet);
733 continue;
736 /* Not a flag argument */
737 if (try_difference(arg))
738 continue;
739 if (try_parent_shorthands(arg))
740 continue;
741 name = arg;
742 type = NORMAL;
743 if (*arg == '^') {
744 name++;
745 type = REVERSED;
747 if (!get_sha1(name, sha1)) {
748 if (verify)
749 revs_count++;
750 else
751 show_rev(type, sha1, name);
752 continue;
754 if (verify)
755 die_no_single_rev(quiet);
756 as_is = 1;
757 if (!show_file(arg))
758 continue;
759 verify_filename(prefix, arg, 1);
761 if (verify) {
762 if (revs_count == 1) {
763 show_rev(type, sha1, name);
764 return 0;
765 } else if (revs_count == 0 && show_default())
766 return 0;
767 die_no_single_rev(quiet);
768 } else
769 show_default();
770 return 0;