4 * Copyright (C) Linus Torvalds, 2005
11 #include "parse-options.h"
14 #include "split-index.h"
20 static int filter = ~0;
22 static const char *def;
26 static int show_type = NORMAL;
28 #define SHOW_SYMBOLIC_ASIS 1
29 #define SHOW_SYMBOLIC_FULL 2
32 static int abbrev_ref;
33 static int abbrev_ref_strict;
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[] = {
77 const char **p = rev_args;
79 /* accept -<digit>, like traditional "head" */
80 if ((*arg == '-') && isdigit(arg[1]))
84 const char *str = *p++;
89 if (!strcmp(arg, str) ||
90 (str[len-1] == '=' && !strncmp(arg, str, len)))
95 /* Output argument as a string, either SQ or normal */
96 static void show(const char *arg)
102 while ((ch = *arg++)) {
104 fputs("'\\'", stdout);
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)
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))
129 if ((symbolic || abbrev_ref) && name) {
130 if (symbolic == SHOW_SYMBOLIC_FULL || abbrev_ref) {
131 unsigned char discard[20];
134 switch (dwim_ref(name, strlen(name), discard, &full)) {
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.
146 full = shorten_unambiguous_ref(full,
148 show_with_type(type, full);
150 default: /* ambiguous */
151 error("refname '%s' is ambiguous", name);
156 show_with_type(type, name);
160 show_with_type(type, find_unique_abbrev(sha1, abbrev));
162 show_with_type(type, sha1_to_hex(sha1));
165 /* Output a flag, only if filter allows it. */
166 static int show_flag(const char *arg)
168 if (!(filter & DO_FLAGS))
170 if (filter & (is_rev_argument(arg) ? DO_REVS : DO_NOREV)) {
177 static int show_default(void)
182 unsigned char sha1[20];
185 if (!get_sha1(s, sha1)) {
186 show_rev(NORMAL, sha1, s);
193 static int show_reference(const char *refname, const struct object_id *oid, int flag, void *cb_data)
195 if (ref_excluded(ref_excludes, refname))
197 show_rev(NORMAL, oid->hash, refname);
201 static int anti_reference(const char *refname, const struct object_id *oid, int flag, void *cb_data)
203 show_rev(REVERSED, oid->hash, refname);
207 static int show_abbrev(const unsigned char *sha1, void *cb_data)
209 show_rev(NORMAL, sha1, NULL);
213 static void show_datestring(const char *flag, const char *datestr)
215 static char buffer[100];
217 /* date handling requires both flags and revs */
218 if ((filter & (DO_FLAGS | DO_REVS)) != (DO_FLAGS | DO_REVS))
220 snprintf(buffer, sizeof(buffer), "%s%lu", flag, approxidate(datestr));
224 static int show_file(const char *arg, int output_prefix)
227 if ((filter & (DO_NONFLAGS|DO_NOREV)) == (DO_NONFLAGS|DO_NOREV)) {
229 const char *prefix = startup_info->prefix;
230 show(prefix_filename(prefix,
231 prefix ? strlen(prefix) : 0,
240 static int try_difference(const char *arg)
243 unsigned char sha1[20];
244 unsigned char end[20];
248 static const char head_by_default[] = "HEAD";
250 if (!(dotdot = strstr(arg, "..")))
254 symmetric = (*next == '.');
260 next = head_by_default;
262 this = head_by_default;
264 if (this == head_by_default && next == head_by_default &&
267 * Just ".."? That is not a range but the
268 * pathspec for the parent directory.
274 if (!get_sha1_committish(this, sha1) && !get_sha1_committish(next, end)) {
275 show_rev(NORMAL, end, next);
276 show_rev(symmetric ? NORMAL : REVERSED, sha1, this);
278 struct commit_list *exclude;
279 struct commit *a, *b;
280 a = lookup_commit_reference(sha1);
281 b = lookup_commit_reference(end);
282 exclude = get_merge_bases(a, b);
284 struct commit *commit = pop_commit(&exclude);
285 show_rev(REVERSED, commit->object.oid.hash, NULL);
295 static int try_parent_shorthands(const char *arg)
298 unsigned char sha1[20];
299 struct commit *commit;
300 struct commit_list *parents;
303 int include_parents = 0;
304 int exclude_parent = 0;
306 if ((dotdot = strstr(arg, "^!"))) {
310 } else if ((dotdot = strstr(arg, "^@"))) {
314 } else if ((dotdot = strstr(arg, "^-"))) {
320 exclude_parent = strtoul(dotdot + 2, &end, 10);
321 if (*end != '\0' || !exclude_parent)
328 if (get_sha1_committish(arg, sha1)) {
333 commit = lookup_commit_reference(sha1);
334 if (exclude_parent &&
335 exclude_parent > commit_list_count(commit->parents)) {
341 show_rev(NORMAL, sha1, arg);
342 for (parents = commit->parents, parent_number = 1;
344 parents = parents->next, parent_number++) {
347 if (exclude_parent && parent_number != exclude_parent)
351 name = xstrfmt("%s^%d", arg, parent_number);
352 show_rev(include_parents ? NORMAL : REVERSED,
353 parents->item->object.oid.hash, name);
361 static int parseopt_dump(const struct option *o, const char *arg, int unset)
363 struct strbuf *parsed = o->value;
365 strbuf_addf(parsed, " --no-%s", o->long_name);
366 else if (o->short_name && (o->long_name == NULL || !stuck_long))
367 strbuf_addf(parsed, " -%c", o->short_name);
369 strbuf_addf(parsed, " --%s", o->long_name);
372 strbuf_addch(parsed, ' ');
373 else if (o->long_name)
374 strbuf_addch(parsed, '=');
375 sq_quote_buf(parsed, arg);
380 static const char *skipspaces(const char *s)
387 static int cmd_parseopt(int argc, const char **argv, const char *prefix)
389 static int keep_dashdash = 0, stop_at_non_option = 0;
390 static char const * const parseopt_usage[] = {
391 N_("git rev-parse --parseopt [<options>] -- [<args>...]"),
394 static struct option parseopt_opts[] = {
395 OPT_BOOL(0, "keep-dashdash", &keep_dashdash,
396 N_("keep the `--` passed as an arg")),
397 OPT_BOOL(0, "stop-at-non-option", &stop_at_non_option,
398 N_("stop parsing after the "
399 "first non-option argument")),
400 OPT_BOOL(0, "stuck-long", &stuck_long,
401 N_("output in stuck long form")),
404 static const char * const flag_chars = "*=?!";
406 struct strbuf sb = STRBUF_INIT, parsed = STRBUF_INIT;
407 const char **usage = NULL;
408 struct option *opts = NULL;
409 int onb = 0, osz = 0, unb = 0, usz = 0;
411 strbuf_addstr(&parsed, "set --");
412 argc = parse_options(argc, argv, prefix, parseopt_opts, parseopt_usage,
413 PARSE_OPT_KEEP_DASHDASH);
414 if (argc < 1 || strcmp(argv[0], "--"))
415 usage_with_options(parseopt_usage, parseopt_opts);
417 /* get the usage up to the first line with a -- on it */
419 if (strbuf_getline(&sb, stdin) == EOF)
420 die("premature end of input");
421 ALLOC_GROW(usage, unb + 1, usz);
422 if (!strcmp("--", sb.buf)) {
424 die("no usage string given before the `--' separator");
428 usage[unb++] = strbuf_detach(&sb, NULL);
431 /* parse: (<short>|<short>,<long>|<long>)[*=?!]*<arghint>? SP+ <help> */
432 while (strbuf_getline(&sb, stdin) != EOF) {
440 ALLOC_GROW(opts, onb + 1, osz);
441 memset(opts + onb, 0, sizeof(opts[onb]));
444 help = strchr(sb.buf, ' ');
445 if (!help || *sb.buf == ' ') {
446 o->type = OPTION_GROUP;
447 o->help = xstrdup(skipspaces(sb.buf));
451 o->type = OPTION_CALLBACK;
452 o->help = xstrdup(skipspaces(help));
454 o->flags = PARSE_OPT_NOARG;
455 o->callback = &parseopt_dump;
458 s = strpbrk(sb.buf, flag_chars);
462 if (s - sb.buf == 1) /* short option only */
463 o->short_name = *sb.buf;
464 else if (sb.buf[1] != ',') /* long option only */
465 o->long_name = xmemdupz(sb.buf, s - sb.buf);
467 o->short_name = *sb.buf;
468 o->long_name = xmemdupz(sb.buf + 2, s - sb.buf - 2);
475 o->flags &= ~PARSE_OPT_NOARG;
478 o->flags &= ~PARSE_OPT_NOARG;
479 o->flags |= PARSE_OPT_OPTARG;
482 o->flags |= PARSE_OPT_NONEG;
485 o->flags |= PARSE_OPT_HIDDEN;
493 o->argh = xmemdupz(s, help - s);
497 /* put an OPT_END() */
498 ALLOC_GROW(opts, onb + 1, osz);
499 memset(opts + onb, 0, sizeof(opts[onb]));
500 argc = parse_options(argc, argv, prefix, opts, usage,
501 (keep_dashdash ? PARSE_OPT_KEEP_DASHDASH : 0) |
502 (stop_at_non_option ? PARSE_OPT_STOP_AT_NON_OPTION : 0) |
503 PARSE_OPT_SHELL_EVAL);
505 strbuf_addstr(&parsed, " --");
506 sq_quote_argv(&parsed, argv, 0);
511 static int cmd_sq_quote(int argc, const char **argv)
513 struct strbuf buf = STRBUF_INIT;
516 sq_quote_argv(&buf, argv, 0);
517 printf("%s\n", buf.buf);
518 strbuf_release(&buf);
523 static void die_no_single_rev(int quiet)
528 die("Needed a single revision");
531 static const char builtin_rev_parse_usage[] =
532 N_("git rev-parse --parseopt [<options>] -- [<args>...]\n"
533 " or: git rev-parse --sq-quote [<arg>...]\n"
534 " or: git rev-parse [<options>] [<arg>...]\n"
536 "Run \"git rev-parse --parseopt -h\" for more information on the first usage.");
538 int cmd_rev_parse(int argc, const char **argv, const char *prefix)
540 int i, as_is = 0, verify = 0, quiet = 0, revs_count = 0, type = 0;
541 int did_repo_setup = 0;
542 int has_dashdash = 0;
543 int output_prefix = 0;
544 unsigned char sha1[20];
545 unsigned int flags = 0;
546 const char *name = NULL;
547 struct object_context unused;
548 struct strbuf buf = STRBUF_INIT;
550 if (argc > 1 && !strcmp("--parseopt", argv[1]))
551 return cmd_parseopt(argc - 1, argv + 1, prefix);
553 if (argc > 1 && !strcmp("--sq-quote", argv[1]))
554 return cmd_sq_quote(argc - 2, argv + 2);
556 if (argc > 1 && !strcmp("-h", argv[1]))
557 usage(builtin_rev_parse_usage);
559 for (i = 1; i < argc; i++) {
560 if (!strcmp(argv[i], "--")) {
566 /* No options; just report on whether we're in a git repo or not. */
568 setup_git_directory();
569 git_config(git_default_config, NULL);
573 for (i = 1; i < argc; i++) {
574 const char *arg = argv[i];
576 if (!strcmp(arg, "--local-env-vars")) {
578 for (i = 0; local_repo_env[i]; i++)
579 printf("%s\n", local_repo_env[i]);
582 if (!strcmp(arg, "--resolve-git-dir")) {
583 const char *gitdir = argv[++i];
585 die("--resolve-git-dir requires an argument");
586 gitdir = resolve_gitdir(gitdir);
588 die("not a gitdir '%s'", argv[i]);
593 /* The rest of the options require a git repository. */
594 if (!did_repo_setup) {
595 prefix = setup_git_directory();
596 git_config(git_default_config, NULL);
600 if (!strcmp(arg, "--git-path")) {
602 die("--git-path requires an argument");
604 puts(relative_path(git_path("%s", argv[i + 1]),
610 if (show_file(arg, output_prefix) && as_is < 2)
611 verify_filename(prefix, arg, 0);
614 if (!strcmp(arg,"-n")) {
616 die("-n requires an argument");
617 if ((filter & DO_FLAGS) && (filter & DO_REVS)) {
623 if (starts_with(arg, "-n")) {
624 if ((filter & DO_FLAGS) && (filter & DO_REVS))
630 if (!strcmp(arg, "--")) {
632 /* Pass on the "--" if we show anything but files.. */
633 if (filter & (DO_FLAGS | DO_REVS))
637 if (!strcmp(arg, "--default")) {
640 die("--default requires an argument");
643 if (!strcmp(arg, "--prefix")) {
646 die("--prefix requires an argument");
647 startup_info->prefix = prefix;
651 if (!strcmp(arg, "--revs-only")) {
655 if (!strcmp(arg, "--no-revs")) {
659 if (!strcmp(arg, "--flags")) {
660 filter &= ~DO_NONFLAGS;
663 if (!strcmp(arg, "--no-flags")) {
667 if (!strcmp(arg, "--verify")) {
668 filter &= ~(DO_FLAGS|DO_NOREV);
672 if (!strcmp(arg, "--quiet") || !strcmp(arg, "-q")) {
674 flags |= GET_SHA1_QUIETLY;
677 if (!strcmp(arg, "--short") ||
678 starts_with(arg, "--short=")) {
679 filter &= ~(DO_FLAGS|DO_NOREV);
681 abbrev = DEFAULT_ABBREV;
684 abbrev = strtoul(arg + 8, NULL, 10);
685 if (abbrev < MINIMUM_ABBREV)
686 abbrev = MINIMUM_ABBREV;
687 else if (40 <= abbrev)
691 if (!strcmp(arg, "--sq")) {
695 if (!strcmp(arg, "--not")) {
696 show_type ^= REVERSED;
699 if (!strcmp(arg, "--symbolic")) {
700 symbolic = SHOW_SYMBOLIC_ASIS;
703 if (!strcmp(arg, "--symbolic-full-name")) {
704 symbolic = SHOW_SYMBOLIC_FULL;
707 if (starts_with(arg, "--abbrev-ref") &&
708 (!arg[12] || arg[12] == '=')) {
710 abbrev_ref_strict = warn_ambiguous_refs;
711 if (arg[12] == '=') {
712 if (!strcmp(arg + 13, "strict"))
713 abbrev_ref_strict = 1;
714 else if (!strcmp(arg + 13, "loose"))
715 abbrev_ref_strict = 0;
717 die("unknown mode for %s", arg);
721 if (!strcmp(arg, "--all")) {
722 for_each_ref(show_reference, NULL);
725 if (starts_with(arg, "--disambiguate=")) {
726 for_each_abbrev(arg + 15, show_abbrev, NULL);
729 if (!strcmp(arg, "--bisect")) {
730 for_each_ref_in("refs/bisect/bad", show_reference, NULL);
731 for_each_ref_in("refs/bisect/good", anti_reference, NULL);
734 if (starts_with(arg, "--branches=")) {
735 for_each_glob_ref_in(show_reference, arg + 11,
736 "refs/heads/", NULL);
737 clear_ref_exclusion(&ref_excludes);
740 if (!strcmp(arg, "--branches")) {
741 for_each_branch_ref(show_reference, NULL);
742 clear_ref_exclusion(&ref_excludes);
745 if (starts_with(arg, "--tags=")) {
746 for_each_glob_ref_in(show_reference, arg + 7,
748 clear_ref_exclusion(&ref_excludes);
751 if (!strcmp(arg, "--tags")) {
752 for_each_tag_ref(show_reference, NULL);
753 clear_ref_exclusion(&ref_excludes);
756 if (starts_with(arg, "--glob=")) {
757 for_each_glob_ref(show_reference, arg + 7, NULL);
758 clear_ref_exclusion(&ref_excludes);
761 if (starts_with(arg, "--remotes=")) {
762 for_each_glob_ref_in(show_reference, arg + 10,
763 "refs/remotes/", NULL);
764 clear_ref_exclusion(&ref_excludes);
767 if (!strcmp(arg, "--remotes")) {
768 for_each_remote_ref(show_reference, NULL);
769 clear_ref_exclusion(&ref_excludes);
772 if (starts_with(arg, "--exclude=")) {
773 add_ref_exclusion(&ref_excludes, arg + 10);
776 if (!strcmp(arg, "--show-toplevel")) {
777 const char *work_tree = get_git_work_tree();
782 if (!strcmp(arg, "--show-prefix")) {
789 if (!strcmp(arg, "--show-cdup")) {
790 const char *pfx = prefix;
791 if (!is_inside_work_tree()) {
792 const char *work_tree =
795 printf("%s\n", work_tree);
799 pfx = strchr(pfx, '/');
808 if (!strcmp(arg, "--git-dir") ||
809 !strcmp(arg, "--absolute-git-dir")) {
810 const char *gitdir = getenv(GIT_DIR_ENVIRONMENT);
813 if (arg[2] == 'g') { /* --git-dir */
822 } else { /* --absolute-git-dir */
823 if (!gitdir && !prefix)
826 puts(real_path(gitdir));
832 printf("%s%s.git\n", cwd, len && cwd[len-1] != '/' ? "/" : "");
836 if (!strcmp(arg, "--git-common-dir")) {
838 puts(relative_path(get_git_common_dir(),
842 if (!strcmp(arg, "--is-inside-git-dir")) {
843 printf("%s\n", is_inside_git_dir() ? "true"
847 if (!strcmp(arg, "--is-inside-work-tree")) {
848 printf("%s\n", is_inside_work_tree() ? "true"
852 if (!strcmp(arg, "--is-bare-repository")) {
853 printf("%s\n", is_bare_repository() ? "true"
857 if (!strcmp(arg, "--shared-index-path")) {
858 if (read_cache() < 0)
859 die(_("Could not read the index"));
860 if (the_index.split_index) {
861 const unsigned char *sha1 = the_index.split_index->base_sha1;
862 const char *path = git_path("sharedindex.%s", sha1_to_hex(sha1));
864 puts(relative_path(path, prefix, &buf));
868 if (starts_with(arg, "--since=")) {
869 show_datestring("--max-age=", arg+8);
872 if (starts_with(arg, "--after=")) {
873 show_datestring("--max-age=", arg+8);
876 if (starts_with(arg, "--before=")) {
877 show_datestring("--min-age=", arg+9);
880 if (starts_with(arg, "--until=")) {
881 show_datestring("--min-age=", arg+8);
884 if (show_flag(arg) && verify)
885 die_no_single_rev(quiet);
889 /* Not a flag argument */
890 if (try_difference(arg))
892 if (try_parent_shorthands(arg))
900 if (!get_sha1_with_context(name, flags, sha1, &unused)) {
904 show_rev(type, sha1, name);
908 die_no_single_rev(quiet);
910 die("bad revision '%s'", arg);
912 if (!show_file(arg, output_prefix))
914 verify_filename(prefix, arg, 1);
916 strbuf_release(&buf);
918 if (revs_count == 1) {
919 show_rev(type, sha1, name);
921 } else if (revs_count == 0 && show_default())
923 die_no_single_rev(quiet);