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 if ((dotdot = strstr(arg, "^!")))
305 else if ((dotdot = strstr(arg, "^@")))
308 if (!dotdot || dotdot[2])
312 if (get_sha1_committish(arg, sha1)) {
318 show_rev(NORMAL, sha1, arg);
319 commit = lookup_commit_reference(sha1);
320 for (parents = commit->parents; parents; parents = parents->next)
321 show_rev(parents_only ? NORMAL : REVERSED,
322 parents->item->object.oid.hash, arg);
328 static int parseopt_dump(const struct option *o, const char *arg, int unset)
330 struct strbuf *parsed = o->value;
332 strbuf_addf(parsed, " --no-%s", o->long_name);
333 else if (o->short_name && (o->long_name == NULL || !stuck_long))
334 strbuf_addf(parsed, " -%c", o->short_name);
336 strbuf_addf(parsed, " --%s", o->long_name);
339 strbuf_addch(parsed, ' ');
340 else if (o->long_name)
341 strbuf_addch(parsed, '=');
342 sq_quote_buf(parsed, arg);
347 static const char *skipspaces(const char *s)
354 static int cmd_parseopt(int argc, const char **argv, const char *prefix)
356 static int keep_dashdash = 0, stop_at_non_option = 0;
357 static char const * const parseopt_usage[] = {
358 N_("git rev-parse --parseopt [<options>] -- [<args>...]"),
361 static struct option parseopt_opts[] = {
362 OPT_BOOL(0, "keep-dashdash", &keep_dashdash,
363 N_("keep the `--` passed as an arg")),
364 OPT_BOOL(0, "stop-at-non-option", &stop_at_non_option,
365 N_("stop parsing after the "
366 "first non-option argument")),
367 OPT_BOOL(0, "stuck-long", &stuck_long,
368 N_("output in stuck long form")),
371 static const char * const flag_chars = "*=?!";
373 struct strbuf sb = STRBUF_INIT, parsed = STRBUF_INIT;
374 const char **usage = NULL;
375 struct option *opts = NULL;
376 int onb = 0, osz = 0, unb = 0, usz = 0;
378 strbuf_addstr(&parsed, "set --");
379 argc = parse_options(argc, argv, prefix, parseopt_opts, parseopt_usage,
380 PARSE_OPT_KEEP_DASHDASH);
381 if (argc < 1 || strcmp(argv[0], "--"))
382 usage_with_options(parseopt_usage, parseopt_opts);
384 /* get the usage up to the first line with a -- on it */
386 if (strbuf_getline(&sb, stdin) == EOF)
387 die("premature end of input");
388 ALLOC_GROW(usage, unb + 1, usz);
389 if (!strcmp("--", sb.buf)) {
391 die("no usage string given before the `--' separator");
395 usage[unb++] = strbuf_detach(&sb, NULL);
398 /* parse: (<short>|<short>,<long>|<long>)[*=?!]*<arghint>? SP+ <help> */
399 while (strbuf_getline(&sb, stdin) != EOF) {
407 ALLOC_GROW(opts, onb + 1, osz);
408 memset(opts + onb, 0, sizeof(opts[onb]));
411 help = strchr(sb.buf, ' ');
412 if (!help || *sb.buf == ' ') {
413 o->type = OPTION_GROUP;
414 o->help = xstrdup(skipspaces(sb.buf));
418 o->type = OPTION_CALLBACK;
419 o->help = xstrdup(skipspaces(help));
421 o->flags = PARSE_OPT_NOARG;
422 o->callback = &parseopt_dump;
425 s = strpbrk(sb.buf, flag_chars);
429 if (s - sb.buf == 1) /* short option only */
430 o->short_name = *sb.buf;
431 else if (sb.buf[1] != ',') /* long option only */
432 o->long_name = xmemdupz(sb.buf, s - sb.buf);
434 o->short_name = *sb.buf;
435 o->long_name = xmemdupz(sb.buf + 2, s - sb.buf - 2);
442 o->flags &= ~PARSE_OPT_NOARG;
445 o->flags &= ~PARSE_OPT_NOARG;
446 o->flags |= PARSE_OPT_OPTARG;
449 o->flags |= PARSE_OPT_NONEG;
452 o->flags |= PARSE_OPT_HIDDEN;
460 o->argh = xmemdupz(s, help - s);
464 /* put an OPT_END() */
465 ALLOC_GROW(opts, onb + 1, osz);
466 memset(opts + onb, 0, sizeof(opts[onb]));
467 argc = parse_options(argc, argv, prefix, opts, usage,
468 (keep_dashdash ? PARSE_OPT_KEEP_DASHDASH : 0) |
469 (stop_at_non_option ? PARSE_OPT_STOP_AT_NON_OPTION : 0) |
470 PARSE_OPT_SHELL_EVAL);
472 strbuf_addstr(&parsed, " --");
473 sq_quote_argv(&parsed, argv, 0);
478 static int cmd_sq_quote(int argc, const char **argv)
480 struct strbuf buf = STRBUF_INIT;
483 sq_quote_argv(&buf, argv, 0);
484 printf("%s\n", buf.buf);
485 strbuf_release(&buf);
490 static void die_no_single_rev(int quiet)
495 die("Needed a single revision");
498 static const char builtin_rev_parse_usage[] =
499 N_("git rev-parse --parseopt [<options>] -- [<args>...]\n"
500 " or: git rev-parse --sq-quote [<arg>...]\n"
501 " or: git rev-parse [<options>] [<arg>...]\n"
503 "Run \"git rev-parse --parseopt -h\" for more information on the first usage.");
505 int cmd_rev_parse(int argc, const char **argv, const char *prefix)
507 int i, as_is = 0, verify = 0, quiet = 0, revs_count = 0, type = 0;
508 int did_repo_setup = 0;
509 int has_dashdash = 0;
510 int output_prefix = 0;
511 unsigned char sha1[20];
512 unsigned int flags = 0;
513 const char *name = NULL;
514 struct object_context unused;
516 if (argc > 1 && !strcmp("--parseopt", argv[1]))
517 return cmd_parseopt(argc - 1, argv + 1, prefix);
519 if (argc > 1 && !strcmp("--sq-quote", argv[1]))
520 return cmd_sq_quote(argc - 2, argv + 2);
522 if (argc > 1 && !strcmp("-h", argv[1]))
523 usage(builtin_rev_parse_usage);
525 for (i = 1; i < argc; i++) {
526 if (!strcmp(argv[i], "--")) {
532 /* No options; just report on whether we're in a git repo or not. */
534 setup_git_directory();
535 git_config(git_default_config, NULL);
539 for (i = 1; i < argc; i++) {
540 const char *arg = argv[i];
542 if (!strcmp(arg, "--local-env-vars")) {
544 for (i = 0; local_repo_env[i]; i++)
545 printf("%s\n", local_repo_env[i]);
548 if (!strcmp(arg, "--resolve-git-dir")) {
549 const char *gitdir = argv[++i];
551 die("--resolve-git-dir requires an argument");
552 gitdir = resolve_gitdir(gitdir);
554 die("not a gitdir '%s'", argv[i]);
559 /* The rest of the options require a git repository. */
560 if (!did_repo_setup) {
561 prefix = setup_git_directory();
562 git_config(git_default_config, NULL);
566 if (!strcmp(arg, "--git-path")) {
568 die("--git-path requires an argument");
569 puts(git_path("%s", argv[i + 1]));
574 if (show_file(arg, output_prefix) && as_is < 2)
575 verify_filename(prefix, arg, 0);
578 if (!strcmp(arg,"-n")) {
580 die("-n requires an argument");
581 if ((filter & DO_FLAGS) && (filter & DO_REVS)) {
587 if (starts_with(arg, "-n")) {
588 if ((filter & DO_FLAGS) && (filter & DO_REVS))
594 if (!strcmp(arg, "--")) {
596 /* Pass on the "--" if we show anything but files.. */
597 if (filter & (DO_FLAGS | DO_REVS))
601 if (!strcmp(arg, "--default")) {
604 die("--default requires an argument");
607 if (!strcmp(arg, "--prefix")) {
610 die("--prefix requires an argument");
611 startup_info->prefix = prefix;
615 if (!strcmp(arg, "--revs-only")) {
619 if (!strcmp(arg, "--no-revs")) {
623 if (!strcmp(arg, "--flags")) {
624 filter &= ~DO_NONFLAGS;
627 if (!strcmp(arg, "--no-flags")) {
631 if (!strcmp(arg, "--verify")) {
632 filter &= ~(DO_FLAGS|DO_NOREV);
636 if (!strcmp(arg, "--quiet") || !strcmp(arg, "-q")) {
638 flags |= GET_SHA1_QUIETLY;
641 if (!strcmp(arg, "--short") ||
642 starts_with(arg, "--short=")) {
643 filter &= ~(DO_FLAGS|DO_NOREV);
645 abbrev = DEFAULT_ABBREV;
647 abbrev = strtoul(arg + 8, NULL, 10);
648 if (abbrev < MINIMUM_ABBREV)
649 abbrev = MINIMUM_ABBREV;
650 else if (40 <= abbrev)
654 if (!strcmp(arg, "--sq")) {
658 if (!strcmp(arg, "--not")) {
659 show_type ^= REVERSED;
662 if (!strcmp(arg, "--symbolic")) {
663 symbolic = SHOW_SYMBOLIC_ASIS;
666 if (!strcmp(arg, "--symbolic-full-name")) {
667 symbolic = SHOW_SYMBOLIC_FULL;
670 if (starts_with(arg, "--abbrev-ref") &&
671 (!arg[12] || arg[12] == '=')) {
673 abbrev_ref_strict = warn_ambiguous_refs;
674 if (arg[12] == '=') {
675 if (!strcmp(arg + 13, "strict"))
676 abbrev_ref_strict = 1;
677 else if (!strcmp(arg + 13, "loose"))
678 abbrev_ref_strict = 0;
680 die("unknown mode for %s", arg);
684 if (!strcmp(arg, "--all")) {
685 for_each_ref(show_reference, NULL);
688 if (starts_with(arg, "--disambiguate=")) {
689 for_each_abbrev(arg + 15, show_abbrev, NULL);
692 if (!strcmp(arg, "--bisect")) {
693 for_each_ref_in("refs/bisect/bad", show_reference, NULL);
694 for_each_ref_in("refs/bisect/good", anti_reference, NULL);
697 if (starts_with(arg, "--branches=")) {
698 for_each_glob_ref_in(show_reference, arg + 11,
699 "refs/heads/", NULL);
700 clear_ref_exclusion(&ref_excludes);
703 if (!strcmp(arg, "--branches")) {
704 for_each_branch_ref(show_reference, NULL);
705 clear_ref_exclusion(&ref_excludes);
708 if (starts_with(arg, "--tags=")) {
709 for_each_glob_ref_in(show_reference, arg + 7,
711 clear_ref_exclusion(&ref_excludes);
714 if (!strcmp(arg, "--tags")) {
715 for_each_tag_ref(show_reference, NULL);
716 clear_ref_exclusion(&ref_excludes);
719 if (starts_with(arg, "--glob=")) {
720 for_each_glob_ref(show_reference, arg + 7, NULL);
721 clear_ref_exclusion(&ref_excludes);
724 if (starts_with(arg, "--remotes=")) {
725 for_each_glob_ref_in(show_reference, arg + 10,
726 "refs/remotes/", NULL);
727 clear_ref_exclusion(&ref_excludes);
730 if (!strcmp(arg, "--remotes")) {
731 for_each_remote_ref(show_reference, NULL);
732 clear_ref_exclusion(&ref_excludes);
735 if (starts_with(arg, "--exclude=")) {
736 add_ref_exclusion(&ref_excludes, arg + 10);
739 if (!strcmp(arg, "--show-toplevel")) {
740 const char *work_tree = get_git_work_tree();
745 if (!strcmp(arg, "--show-prefix")) {
752 if (!strcmp(arg, "--show-cdup")) {
753 const char *pfx = prefix;
754 if (!is_inside_work_tree()) {
755 const char *work_tree =
758 printf("%s\n", work_tree);
762 pfx = strchr(pfx, '/');
771 if (!strcmp(arg, "--git-dir")) {
772 const char *gitdir = getenv(GIT_DIR_ENVIRONMENT);
785 printf("%s%s.git\n", cwd, len && cwd[len-1] != '/' ? "/" : "");
789 if (!strcmp(arg, "--git-common-dir")) {
790 const char *pfx = prefix ? prefix : "";
791 puts(prefix_filename(pfx, strlen(pfx), get_git_common_dir()));
794 if (!strcmp(arg, "--is-inside-git-dir")) {
795 printf("%s\n", is_inside_git_dir() ? "true"
799 if (!strcmp(arg, "--is-inside-work-tree")) {
800 printf("%s\n", is_inside_work_tree() ? "true"
804 if (!strcmp(arg, "--is-bare-repository")) {
805 printf("%s\n", is_bare_repository() ? "true"
809 if (!strcmp(arg, "--shared-index-path")) {
810 if (read_cache() < 0)
811 die(_("Could not read the index"));
812 if (the_index.split_index) {
813 const unsigned char *sha1 = the_index.split_index->base_sha1;
814 puts(git_path("sharedindex.%s", sha1_to_hex(sha1)));
818 if (starts_with(arg, "--since=")) {
819 show_datestring("--max-age=", arg+8);
822 if (starts_with(arg, "--after=")) {
823 show_datestring("--max-age=", arg+8);
826 if (starts_with(arg, "--before=")) {
827 show_datestring("--min-age=", arg+9);
830 if (starts_with(arg, "--until=")) {
831 show_datestring("--min-age=", arg+8);
834 if (show_flag(arg) && verify)
835 die_no_single_rev(quiet);
839 /* Not a flag argument */
840 if (try_difference(arg))
842 if (try_parent_shorthands(arg))
850 if (!get_sha1_with_context(name, flags, sha1, &unused)) {
854 show_rev(type, sha1, name);
858 die_no_single_rev(quiet);
860 die("bad revision '%s'", arg);
862 if (!show_file(arg, output_prefix))
864 verify_filename(prefix, arg, 1);
867 if (revs_count == 1) {
868 show_rev(type, sha1, name);
870 } else if (revs_count == 0 && show_default())
872 die_no_single_rev(quiet);