4 * Copyright (C) Linus Torvalds, 2005
12 #include "parse-options.h"
15 #include "split-index.h"
16 #include "submodule.h"
22 static int filter = ~0;
24 static const char *def;
28 static int show_type = NORMAL;
30 #define SHOW_SYMBOLIC_ASIS 1
31 #define SHOW_SYMBOLIC_FULL 2
34 static int abbrev_ref;
35 static int abbrev_ref_strict;
38 static int stuck_long;
39 static struct string_list *ref_excludes;
42 * Some arguments are relevant "revision" arguments,
43 * others are about output format or other details.
44 * This sorts it all out.
46 static int is_rev_argument(const char *arg)
48 static const char *rev_args[] = {
79 const char **p = rev_args;
81 /* accept -<digit>, like traditional "head" */
82 if ((*arg == '-') && isdigit(arg[1]))
86 const char *str = *p++;
91 if (!strcmp(arg, str) ||
92 (str[len-1] == '=' && !strncmp(arg, str, len)))
97 /* Output argument as a string, either SQ or normal */
98 static void show(const char *arg)
104 while ((ch = *arg++)) {
106 fputs("'\\'", stdout);
116 /* Like show(), but with a negation prefix according to type */
117 static void show_with_type(int type, const char *arg)
119 if (type != show_type)
124 /* Output a revision, only if filter allows it */
125 static void show_rev(int type, const struct object_id *oid, const char *name)
127 if (!(filter & DO_REVS))
131 if ((symbolic || abbrev_ref) && name) {
132 if (symbolic == SHOW_SYMBOLIC_FULL || abbrev_ref) {
133 struct object_id discard;
136 switch (dwim_ref(name, strlen(name), &discard, &full)) {
139 * Not found -- not a ref. We could
140 * emit "name" here, but symbolic-full
141 * users are interested in finding the
142 * refs spelled in full, and they would
143 * need to filter non-refs if we did so.
148 full = shorten_unambiguous_ref(full,
150 show_with_type(type, full);
152 default: /* ambiguous */
153 error("refname '%s' is ambiguous", name);
158 show_with_type(type, name);
162 show_with_type(type, find_unique_abbrev(oid, abbrev));
164 show_with_type(type, oid_to_hex(oid));
167 /* Output a flag, only if filter allows it. */
168 static int show_flag(const char *arg)
170 if (!(filter & DO_FLAGS))
172 if (filter & (is_rev_argument(arg) ? DO_REVS : DO_NOREV)) {
179 static int show_default(void)
184 struct object_id oid;
187 if (!get_oid(s, &oid)) {
188 show_rev(NORMAL, &oid, s);
195 static int show_reference(const char *refname, const struct object_id *oid, int flag, void *cb_data)
197 if (ref_excluded(ref_excludes, refname))
199 show_rev(NORMAL, oid, refname);
203 static int anti_reference(const char *refname, const struct object_id *oid, int flag, void *cb_data)
205 show_rev(REVERSED, oid, refname);
209 static int show_abbrev(const struct object_id *oid, void *cb_data)
211 show_rev(NORMAL, oid, NULL);
215 static void show_datestring(const char *flag, const char *datestr)
219 /* date handling requires both flags and revs */
220 if ((filter & (DO_FLAGS | DO_REVS)) != (DO_FLAGS | DO_REVS))
222 buffer = xstrfmt("%s%"PRItime, flag, approxidate(datestr));
227 static int show_file(const char *arg, int output_prefix)
230 if ((filter & (DO_NONFLAGS|DO_NOREV)) == (DO_NONFLAGS|DO_NOREV)) {
232 const char *prefix = startup_info->prefix;
233 char *fname = prefix_filename(prefix, arg);
243 static int try_difference(const char *arg)
246 struct object_id start_oid;
247 struct object_id end_oid;
251 static const char head_by_default[] = "HEAD";
253 if (!(dotdot = strstr(arg, "..")))
257 symmetric = (*end == '.');
263 end = head_by_default;
265 start = head_by_default;
267 if (start == head_by_default && end == head_by_default &&
270 * Just ".."? That is not a range but the
271 * pathspec for the parent directory.
277 if (!get_oid_committish(start, &start_oid) && !get_oid_committish(end, &end_oid)) {
278 show_rev(NORMAL, &end_oid, end);
279 show_rev(symmetric ? NORMAL : REVERSED, &start_oid, start);
281 struct commit_list *exclude;
282 struct commit *a, *b;
283 a = lookup_commit_reference(&start_oid);
284 b = lookup_commit_reference(&end_oid);
285 exclude = get_merge_bases(a, b);
287 struct commit *commit = pop_commit(&exclude);
288 show_rev(REVERSED, &commit->object.oid, NULL);
298 static int try_parent_shorthands(const char *arg)
301 struct object_id oid;
302 struct commit *commit;
303 struct commit_list *parents;
306 int include_parents = 0;
307 int exclude_parent = 0;
309 if ((dotdot = strstr(arg, "^!"))) {
313 } else if ((dotdot = strstr(arg, "^@"))) {
317 } else if ((dotdot = strstr(arg, "^-"))) {
323 exclude_parent = strtoul(dotdot + 2, &end, 10);
324 if (*end != '\0' || !exclude_parent)
331 if (get_oid_committish(arg, &oid)) {
336 commit = lookup_commit_reference(&oid);
337 if (exclude_parent &&
338 exclude_parent > commit_list_count(commit->parents)) {
344 show_rev(NORMAL, &oid, arg);
345 for (parents = commit->parents, parent_number = 1;
347 parents = parents->next, parent_number++) {
350 if (exclude_parent && parent_number != exclude_parent)
354 name = xstrfmt("%s^%d", arg, parent_number);
355 show_rev(include_parents ? NORMAL : REVERSED,
356 &parents->item->object.oid, name);
364 static int parseopt_dump(const struct option *o, const char *arg, int unset)
366 struct strbuf *parsed = o->value;
368 strbuf_addf(parsed, " --no-%s", o->long_name);
369 else if (o->short_name && (o->long_name == NULL || !stuck_long))
370 strbuf_addf(parsed, " -%c", o->short_name);
372 strbuf_addf(parsed, " --%s", o->long_name);
375 strbuf_addch(parsed, ' ');
376 else if (o->long_name)
377 strbuf_addch(parsed, '=');
378 sq_quote_buf(parsed, arg);
383 static const char *skipspaces(const char *s)
390 static char *findspace(const char *s)
398 static int cmd_parseopt(int argc, const char **argv, const char *prefix)
400 static int keep_dashdash = 0, stop_at_non_option = 0;
401 static char const * const parseopt_usage[] = {
402 N_("git rev-parse --parseopt [<options>] -- [<args>...]"),
405 static struct option parseopt_opts[] = {
406 OPT_BOOL(0, "keep-dashdash", &keep_dashdash,
407 N_("keep the `--` passed as an arg")),
408 OPT_BOOL(0, "stop-at-non-option", &stop_at_non_option,
409 N_("stop parsing after the "
410 "first non-option argument")),
411 OPT_BOOL(0, "stuck-long", &stuck_long,
412 N_("output in stuck long form")),
415 static const char * const flag_chars = "*=?!";
417 struct strbuf sb = STRBUF_INIT, parsed = STRBUF_INIT;
418 const char **usage = NULL;
419 struct option *opts = NULL;
420 int onb = 0, osz = 0, unb = 0, usz = 0;
422 strbuf_addstr(&parsed, "set --");
423 argc = parse_options(argc, argv, prefix, parseopt_opts, parseopt_usage,
424 PARSE_OPT_KEEP_DASHDASH);
425 if (argc < 1 || strcmp(argv[0], "--"))
426 usage_with_options(parseopt_usage, parseopt_opts);
428 /* get the usage up to the first line with a -- on it */
430 if (strbuf_getline(&sb, stdin) == EOF)
431 die("premature end of input");
432 ALLOC_GROW(usage, unb + 1, usz);
433 if (!strcmp("--", sb.buf)) {
435 die("no usage string given before the `--' separator");
439 usage[unb++] = strbuf_detach(&sb, NULL);
442 /* parse: (<short>|<short>,<long>|<long>)[*=?!]*<arghint>? SP+ <help> */
443 while (strbuf_getline(&sb, stdin) != EOF) {
451 ALLOC_GROW(opts, onb + 1, osz);
452 memset(opts + onb, 0, sizeof(opts[onb]));
455 help = findspace(sb.buf);
456 if (!help || sb.buf == help) {
457 o->type = OPTION_GROUP;
458 o->help = xstrdup(skipspaces(sb.buf));
464 o->type = OPTION_CALLBACK;
465 o->help = xstrdup(skipspaces(help+1));
467 o->flags = PARSE_OPT_NOARG;
468 o->callback = &parseopt_dump;
471 s = strpbrk(sb.buf, flag_chars);
475 if (s - sb.buf == 1) /* short option only */
476 o->short_name = *sb.buf;
477 else if (sb.buf[1] != ',') /* long option only */
478 o->long_name = xmemdupz(sb.buf, s - sb.buf);
480 o->short_name = *sb.buf;
481 o->long_name = xmemdupz(sb.buf + 2, s - sb.buf - 2);
488 o->flags &= ~PARSE_OPT_NOARG;
491 o->flags &= ~PARSE_OPT_NOARG;
492 o->flags |= PARSE_OPT_OPTARG;
495 o->flags |= PARSE_OPT_NONEG;
498 o->flags |= PARSE_OPT_HIDDEN;
506 o->argh = xmemdupz(s, help - s);
510 /* put an OPT_END() */
511 ALLOC_GROW(opts, onb + 1, osz);
512 memset(opts + onb, 0, sizeof(opts[onb]));
513 argc = parse_options(argc, argv, prefix, opts, usage,
514 (keep_dashdash ? PARSE_OPT_KEEP_DASHDASH : 0) |
515 (stop_at_non_option ? PARSE_OPT_STOP_AT_NON_OPTION : 0) |
516 PARSE_OPT_SHELL_EVAL);
518 strbuf_addstr(&parsed, " --");
519 sq_quote_argv(&parsed, argv);
524 static int cmd_sq_quote(int argc, const char **argv)
526 struct strbuf buf = STRBUF_INIT;
529 sq_quote_argv(&buf, argv);
530 printf("%s\n", buf.buf);
531 strbuf_release(&buf);
536 static void die_no_single_rev(int quiet)
541 die("Needed a single revision");
544 static const char builtin_rev_parse_usage[] =
545 N_("git rev-parse --parseopt [<options>] -- [<args>...]\n"
546 " or: git rev-parse --sq-quote [<arg>...]\n"
547 " or: git rev-parse [<options>] [<arg>...]\n"
549 "Run \"git rev-parse --parseopt -h\" for more information on the first usage.");
552 * Parse "opt" or "opt=<value>", setting value respectively to either
553 * NULL or the string after "=".
555 static int opt_with_value(const char *arg, const char *opt, const char **value)
557 if (skip_prefix(arg, opt, &arg)) {
570 static void handle_ref_opt(const char *pattern, const char *prefix)
573 for_each_glob_ref_in(show_reference, pattern, prefix, NULL);
575 for_each_ref_in(prefix, show_reference, NULL);
576 clear_ref_exclusion(&ref_excludes);
579 int cmd_rev_parse(int argc, const char **argv, const char *prefix)
581 int i, as_is = 0, verify = 0, quiet = 0, revs_count = 0, type = 0;
582 int did_repo_setup = 0;
583 int has_dashdash = 0;
584 int output_prefix = 0;
585 struct object_id oid;
586 unsigned int flags = 0;
587 const char *name = NULL;
588 struct object_context unused;
589 struct strbuf buf = STRBUF_INIT;
591 if (argc > 1 && !strcmp("--parseopt", argv[1]))
592 return cmd_parseopt(argc - 1, argv + 1, prefix);
594 if (argc > 1 && !strcmp("--sq-quote", argv[1]))
595 return cmd_sq_quote(argc - 2, argv + 2);
597 if (argc > 1 && !strcmp("-h", argv[1]))
598 usage(builtin_rev_parse_usage);
600 for (i = 1; i < argc; i++) {
601 if (!strcmp(argv[i], "--")) {
607 /* No options; just report on whether we're in a git repo or not. */
609 setup_git_directory();
610 git_config(git_default_config, NULL);
614 for (i = 1; i < argc; i++) {
615 const char *arg = argv[i];
617 if (!strcmp(arg, "--local-env-vars")) {
619 for (i = 0; local_repo_env[i]; i++)
620 printf("%s\n", local_repo_env[i]);
623 if (!strcmp(arg, "--resolve-git-dir")) {
624 const char *gitdir = argv[++i];
626 die("--resolve-git-dir requires an argument");
627 gitdir = resolve_gitdir(gitdir);
629 die("not a gitdir '%s'", argv[i]);
634 /* The rest of the options require a git repository. */
635 if (!did_repo_setup) {
636 prefix = setup_git_directory();
637 git_config(git_default_config, NULL);
641 if (!strcmp(arg, "--git-path")) {
643 die("--git-path requires an argument");
645 puts(relative_path(git_path("%s", argv[i + 1]),
651 if (show_file(arg, output_prefix) && as_is < 2)
652 verify_filename(prefix, arg, 0);
655 if (!strcmp(arg,"-n")) {
657 die("-n requires an argument");
658 if ((filter & DO_FLAGS) && (filter & DO_REVS)) {
664 if (starts_with(arg, "-n")) {
665 if ((filter & DO_FLAGS) && (filter & DO_REVS))
671 if (!strcmp(arg, "--")) {
673 /* Pass on the "--" if we show anything but files.. */
674 if (filter & (DO_FLAGS | DO_REVS))
678 if (!strcmp(arg, "--default")) {
681 die("--default requires an argument");
684 if (!strcmp(arg, "--prefix")) {
687 die("--prefix requires an argument");
688 startup_info->prefix = prefix;
692 if (!strcmp(arg, "--revs-only")) {
696 if (!strcmp(arg, "--no-revs")) {
700 if (!strcmp(arg, "--flags")) {
701 filter &= ~DO_NONFLAGS;
704 if (!strcmp(arg, "--no-flags")) {
708 if (!strcmp(arg, "--verify")) {
709 filter &= ~(DO_FLAGS|DO_NOREV);
713 if (!strcmp(arg, "--quiet") || !strcmp(arg, "-q")) {
715 flags |= GET_OID_QUIETLY;
718 if (opt_with_value(arg, "--short", &arg)) {
719 filter &= ~(DO_FLAGS|DO_NOREV);
721 abbrev = DEFAULT_ABBREV;
724 abbrev = strtoul(arg, NULL, 10);
725 if (abbrev < MINIMUM_ABBREV)
726 abbrev = MINIMUM_ABBREV;
727 else if (40 <= abbrev)
731 if (!strcmp(arg, "--sq")) {
735 if (!strcmp(arg, "--not")) {
736 show_type ^= REVERSED;
739 if (!strcmp(arg, "--symbolic")) {
740 symbolic = SHOW_SYMBOLIC_ASIS;
743 if (!strcmp(arg, "--symbolic-full-name")) {
744 symbolic = SHOW_SYMBOLIC_FULL;
747 if (opt_with_value(arg, "--abbrev-ref", &arg)) {
749 abbrev_ref_strict = warn_ambiguous_refs;
751 if (!strcmp(arg, "strict"))
752 abbrev_ref_strict = 1;
753 else if (!strcmp(arg, "loose"))
754 abbrev_ref_strict = 0;
756 die("unknown mode for --abbrev-ref: %s",
761 if (!strcmp(arg, "--all")) {
762 for_each_ref(show_reference, NULL);
765 if (skip_prefix(arg, "--disambiguate=", &arg)) {
766 for_each_abbrev(arg, show_abbrev, NULL);
769 if (!strcmp(arg, "--bisect")) {
770 for_each_fullref_in("refs/bisect/bad", show_reference, NULL, 0);
771 for_each_fullref_in("refs/bisect/good", anti_reference, NULL, 0);
774 if (opt_with_value(arg, "--branches", &arg)) {
775 handle_ref_opt(arg, "refs/heads/");
778 if (opt_with_value(arg, "--tags", &arg)) {
779 handle_ref_opt(arg, "refs/tags/");
782 if (skip_prefix(arg, "--glob=", &arg)) {
783 handle_ref_opt(arg, NULL);
786 if (opt_with_value(arg, "--remotes", &arg)) {
787 handle_ref_opt(arg, "refs/remotes/");
790 if (skip_prefix(arg, "--exclude=", &arg)) {
791 add_ref_exclusion(&ref_excludes, arg);
794 if (!strcmp(arg, "--show-toplevel")) {
795 const char *work_tree = get_git_work_tree();
800 if (!strcmp(arg, "--show-superproject-working-tree")) {
801 const char *superproject = get_superproject_working_tree();
806 if (!strcmp(arg, "--show-prefix")) {
813 if (!strcmp(arg, "--show-cdup")) {
814 const char *pfx = prefix;
815 if (!is_inside_work_tree()) {
816 const char *work_tree =
819 printf("%s\n", work_tree);
823 pfx = strchr(pfx, '/');
832 if (!strcmp(arg, "--git-dir") ||
833 !strcmp(arg, "--absolute-git-dir")) {
834 const char *gitdir = getenv(GIT_DIR_ENVIRONMENT);
837 if (arg[2] == 'g') { /* --git-dir */
846 } else { /* --absolute-git-dir */
847 if (!gitdir && !prefix)
850 puts(real_path(gitdir));
856 printf("%s%s.git\n", cwd, len && cwd[len-1] != '/' ? "/" : "");
860 if (!strcmp(arg, "--git-common-dir")) {
862 puts(relative_path(get_git_common_dir(),
866 if (!strcmp(arg, "--is-inside-git-dir")) {
867 printf("%s\n", is_inside_git_dir() ? "true"
871 if (!strcmp(arg, "--is-inside-work-tree")) {
872 printf("%s\n", is_inside_work_tree() ? "true"
876 if (!strcmp(arg, "--is-bare-repository")) {
877 printf("%s\n", is_bare_repository() ? "true"
881 if (!strcmp(arg, "--is-shallow-repository")) {
882 printf("%s\n", is_repository_shallow() ? "true"
886 if (!strcmp(arg, "--shared-index-path")) {
887 if (read_cache() < 0)
888 die(_("Could not read the index"));
889 if (the_index.split_index) {
890 const unsigned char *sha1 = the_index.split_index->base_sha1;
891 const char *path = git_path("sharedindex.%s", sha1_to_hex(sha1));
893 puts(relative_path(path, prefix, &buf));
897 if (skip_prefix(arg, "--since=", &arg)) {
898 show_datestring("--max-age=", arg);
901 if (skip_prefix(arg, "--after=", &arg)) {
902 show_datestring("--max-age=", arg);
905 if (skip_prefix(arg, "--before=", &arg)) {
906 show_datestring("--min-age=", arg);
909 if (skip_prefix(arg, "--until=", &arg)) {
910 show_datestring("--min-age=", arg);
913 if (show_flag(arg) && verify)
914 die_no_single_rev(quiet);
918 /* Not a flag argument */
919 if (try_difference(arg))
921 if (try_parent_shorthands(arg))
929 if (!get_oid_with_context(name, flags, &oid, &unused)) {
933 show_rev(type, &oid, name);
937 die_no_single_rev(quiet);
939 die("bad revision '%s'", arg);
941 if (!show_file(arg, output_prefix))
943 verify_filename(prefix, arg, 1);
945 strbuf_release(&buf);
947 if (revs_count == 1) {
948 show_rev(type, &oid, name);
950 } else if (revs_count == 0 && show_default())
952 die_no_single_rev(quiet);