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_list *n = exclude->next;
286 exclude->item->object.sha1,NULL);
298 static int try_parent_shorthands(const char *arg)
301 unsigned char sha1[20];
302 struct commit *commit;
303 struct commit_list *parents;
306 if ((dotdot = strstr(arg, "^!")))
308 else if ((dotdot = strstr(arg, "^@")))
311 if (!dotdot || dotdot[2])
315 if (get_sha1_committish(arg, sha1)) {
321 show_rev(NORMAL, sha1, arg);
322 commit = lookup_commit_reference(sha1);
323 for (parents = commit->parents; parents; parents = parents->next)
324 show_rev(parents_only ? NORMAL : REVERSED,
325 parents->item->object.sha1, arg);
331 static int parseopt_dump(const struct option *o, const char *arg, int unset)
333 struct strbuf *parsed = o->value;
335 strbuf_addf(parsed, " --no-%s", o->long_name);
336 else if (o->short_name && (o->long_name == NULL || !stuck_long))
337 strbuf_addf(parsed, " -%c", o->short_name);
339 strbuf_addf(parsed, " --%s", o->long_name);
342 strbuf_addch(parsed, ' ');
343 else if (o->long_name)
344 strbuf_addch(parsed, '=');
345 sq_quote_buf(parsed, arg);
350 static const char *skipspaces(const char *s)
357 static int cmd_parseopt(int argc, const char **argv, const char *prefix)
359 static int keep_dashdash = 0, stop_at_non_option = 0;
360 static char const * const parseopt_usage[] = {
361 N_("git rev-parse --parseopt [<options>] -- [<args>...]"),
364 static struct option parseopt_opts[] = {
365 OPT_BOOL(0, "keep-dashdash", &keep_dashdash,
366 N_("keep the `--` passed as an arg")),
367 OPT_BOOL(0, "stop-at-non-option", &stop_at_non_option,
368 N_("stop parsing after the "
369 "first non-option argument")),
370 OPT_BOOL(0, "stuck-long", &stuck_long,
371 N_("output in stuck long form")),
374 static const char * const flag_chars = "*=?!";
376 struct strbuf sb = STRBUF_INIT, parsed = STRBUF_INIT;
377 const char **usage = NULL;
378 struct option *opts = NULL;
379 int onb = 0, osz = 0, unb = 0, usz = 0;
381 strbuf_addstr(&parsed, "set --");
382 argc = parse_options(argc, argv, prefix, parseopt_opts, parseopt_usage,
383 PARSE_OPT_KEEP_DASHDASH);
384 if (argc < 1 || strcmp(argv[0], "--"))
385 usage_with_options(parseopt_usage, parseopt_opts);
387 /* get the usage up to the first line with a -- on it */
389 if (strbuf_getline(&sb, stdin, '\n') == EOF)
390 die("premature end of input");
391 ALLOC_GROW(usage, unb + 1, usz);
392 if (!strcmp("--", sb.buf)) {
394 die("no usage string given before the `--' separator");
398 usage[unb++] = strbuf_detach(&sb, NULL);
401 /* parse: (<short>|<short>,<long>|<long>)[*=?!]*<arghint>? SP+ <help> */
402 while (strbuf_getline(&sb, stdin, '\n') != EOF) {
410 ALLOC_GROW(opts, onb + 1, osz);
411 memset(opts + onb, 0, sizeof(opts[onb]));
414 help = strchr(sb.buf, ' ');
415 if (!help || *sb.buf == ' ') {
416 o->type = OPTION_GROUP;
417 o->help = xstrdup(skipspaces(sb.buf));
421 o->type = OPTION_CALLBACK;
422 o->help = xstrdup(skipspaces(help));
424 o->flags = PARSE_OPT_NOARG;
425 o->callback = &parseopt_dump;
428 s = strpbrk(sb.buf, flag_chars);
432 if (s - sb.buf == 1) /* short option only */
433 o->short_name = *sb.buf;
434 else if (sb.buf[1] != ',') /* long option only */
435 o->long_name = xmemdupz(sb.buf, s - sb.buf);
437 o->short_name = *sb.buf;
438 o->long_name = xmemdupz(sb.buf + 2, s - sb.buf - 2);
445 o->flags &= ~PARSE_OPT_NOARG;
448 o->flags &= ~PARSE_OPT_NOARG;
449 o->flags |= PARSE_OPT_OPTARG;
452 o->flags |= PARSE_OPT_NONEG;
455 o->flags |= PARSE_OPT_HIDDEN;
463 o->argh = xmemdupz(s, help - s);
467 /* put an OPT_END() */
468 ALLOC_GROW(opts, onb + 1, osz);
469 memset(opts + onb, 0, sizeof(opts[onb]));
470 argc = parse_options(argc, argv, prefix, opts, usage,
471 (keep_dashdash ? PARSE_OPT_KEEP_DASHDASH : 0) |
472 (stop_at_non_option ? PARSE_OPT_STOP_AT_NON_OPTION : 0) |
473 PARSE_OPT_SHELL_EVAL);
475 strbuf_addf(&parsed, " --");
476 sq_quote_argv(&parsed, argv, 0);
481 static int cmd_sq_quote(int argc, const char **argv)
483 struct strbuf buf = STRBUF_INIT;
486 sq_quote_argv(&buf, argv, 0);
487 printf("%s\n", buf.buf);
488 strbuf_release(&buf);
493 static void die_no_single_rev(int quiet)
498 die("Needed a single revision");
501 static const char builtin_rev_parse_usage[] =
502 N_("git rev-parse --parseopt [<options>] -- [<args>...]\n"
503 " or: git rev-parse --sq-quote [<arg>...]\n"
504 " or: git rev-parse [<options>] [<arg>...]\n"
506 "Run \"git rev-parse --parseopt -h\" for more information on the first usage.");
508 int cmd_rev_parse(int argc, const char **argv, const char *prefix)
510 int i, as_is = 0, verify = 0, quiet = 0, revs_count = 0, type = 0;
511 int has_dashdash = 0;
512 int output_prefix = 0;
513 unsigned char sha1[20];
514 unsigned int flags = 0;
515 const char *name = NULL;
516 struct object_context unused;
518 if (argc > 1 && !strcmp("--parseopt", argv[1]))
519 return cmd_parseopt(argc - 1, argv + 1, prefix);
521 if (argc > 1 && !strcmp("--sq-quote", argv[1]))
522 return cmd_sq_quote(argc - 2, argv + 2);
524 if (argc > 1 && !strcmp("-h", argv[1]))
525 usage(builtin_rev_parse_usage);
527 for (i = 1; i < argc; i++) {
528 if (!strcmp(argv[i], "--")) {
534 prefix = setup_git_directory();
535 git_config(git_default_config, NULL);
536 for (i = 1; i < argc; i++) {
537 const char *arg = argv[i];
539 if (!strcmp(arg, "--git-path")) {
541 die("--git-path requires an argument");
542 puts(git_path("%s", argv[i + 1]));
547 if (show_file(arg, output_prefix) && as_is < 2)
548 verify_filename(prefix, arg, 0);
551 if (!strcmp(arg,"-n")) {
553 die("-n requires an argument");
554 if ((filter & DO_FLAGS) && (filter & DO_REVS)) {
560 if (starts_with(arg, "-n")) {
561 if ((filter & DO_FLAGS) && (filter & DO_REVS))
567 if (!strcmp(arg, "--")) {
569 /* Pass on the "--" if we show anything but files.. */
570 if (filter & (DO_FLAGS | DO_REVS))
574 if (!strcmp(arg, "--default")) {
577 die("--default requires an argument");
580 if (!strcmp(arg, "--prefix")) {
583 die("--prefix requires an argument");
584 startup_info->prefix = prefix;
588 if (!strcmp(arg, "--revs-only")) {
592 if (!strcmp(arg, "--no-revs")) {
596 if (!strcmp(arg, "--flags")) {
597 filter &= ~DO_NONFLAGS;
600 if (!strcmp(arg, "--no-flags")) {
604 if (!strcmp(arg, "--verify")) {
605 filter &= ~(DO_FLAGS|DO_NOREV);
609 if (!strcmp(arg, "--quiet") || !strcmp(arg, "-q")) {
611 flags |= GET_SHA1_QUIETLY;
614 if (!strcmp(arg, "--short") ||
615 starts_with(arg, "--short=")) {
616 filter &= ~(DO_FLAGS|DO_NOREV);
618 abbrev = DEFAULT_ABBREV;
620 abbrev = strtoul(arg + 8, NULL, 10);
621 if (abbrev < MINIMUM_ABBREV)
622 abbrev = MINIMUM_ABBREV;
623 else if (40 <= abbrev)
627 if (!strcmp(arg, "--sq")) {
631 if (!strcmp(arg, "--not")) {
632 show_type ^= REVERSED;
635 if (!strcmp(arg, "--symbolic")) {
636 symbolic = SHOW_SYMBOLIC_ASIS;
639 if (!strcmp(arg, "--symbolic-full-name")) {
640 symbolic = SHOW_SYMBOLIC_FULL;
643 if (starts_with(arg, "--abbrev-ref") &&
644 (!arg[12] || arg[12] == '=')) {
646 abbrev_ref_strict = warn_ambiguous_refs;
647 if (arg[12] == '=') {
648 if (!strcmp(arg + 13, "strict"))
649 abbrev_ref_strict = 1;
650 else if (!strcmp(arg + 13, "loose"))
651 abbrev_ref_strict = 0;
653 die("unknown mode for %s", arg);
657 if (!strcmp(arg, "--all")) {
658 for_each_ref(show_reference, NULL);
661 if (starts_with(arg, "--disambiguate=")) {
662 for_each_abbrev(arg + 15, show_abbrev, NULL);
665 if (!strcmp(arg, "--bisect")) {
666 for_each_ref_in("refs/bisect/bad", show_reference, NULL);
667 for_each_ref_in("refs/bisect/good", anti_reference, NULL);
670 if (starts_with(arg, "--branches=")) {
671 for_each_glob_ref_in(show_reference, arg + 11,
672 "refs/heads/", NULL);
673 clear_ref_exclusion(&ref_excludes);
676 if (!strcmp(arg, "--branches")) {
677 for_each_branch_ref(show_reference, NULL);
678 clear_ref_exclusion(&ref_excludes);
681 if (starts_with(arg, "--tags=")) {
682 for_each_glob_ref_in(show_reference, arg + 7,
684 clear_ref_exclusion(&ref_excludes);
687 if (!strcmp(arg, "--tags")) {
688 for_each_tag_ref(show_reference, NULL);
689 clear_ref_exclusion(&ref_excludes);
692 if (starts_with(arg, "--glob=")) {
693 for_each_glob_ref(show_reference, arg + 7, NULL);
694 clear_ref_exclusion(&ref_excludes);
697 if (starts_with(arg, "--remotes=")) {
698 for_each_glob_ref_in(show_reference, arg + 10,
699 "refs/remotes/", NULL);
700 clear_ref_exclusion(&ref_excludes);
703 if (!strcmp(arg, "--remotes")) {
704 for_each_remote_ref(show_reference, NULL);
705 clear_ref_exclusion(&ref_excludes);
708 if (starts_with(arg, "--exclude=")) {
709 add_ref_exclusion(&ref_excludes, arg + 10);
712 if (!strcmp(arg, "--local-env-vars")) {
714 for (i = 0; local_repo_env[i]; i++)
715 printf("%s\n", local_repo_env[i]);
718 if (!strcmp(arg, "--show-toplevel")) {
719 const char *work_tree = get_git_work_tree();
724 if (!strcmp(arg, "--show-prefix")) {
731 if (!strcmp(arg, "--show-cdup")) {
732 const char *pfx = prefix;
733 if (!is_inside_work_tree()) {
734 const char *work_tree =
737 printf("%s\n", work_tree);
741 pfx = strchr(pfx, '/');
750 if (!strcmp(arg, "--git-dir")) {
751 const char *gitdir = getenv(GIT_DIR_ENVIRONMENT);
764 printf("%s%s.git\n", cwd, len && cwd[len-1] != '/' ? "/" : "");
768 if (!strcmp(arg, "--git-common-dir")) {
769 puts(get_git_common_dir());
772 if (!strcmp(arg, "--resolve-git-dir")) {
773 const char *gitdir = argv[++i];
775 die("--resolve-git-dir requires an argument");
776 gitdir = resolve_gitdir(gitdir);
778 die("not a gitdir '%s'", argv[i]);
782 if (!strcmp(arg, "--is-inside-git-dir")) {
783 printf("%s\n", is_inside_git_dir() ? "true"
787 if (!strcmp(arg, "--is-inside-work-tree")) {
788 printf("%s\n", is_inside_work_tree() ? "true"
792 if (!strcmp(arg, "--is-bare-repository")) {
793 printf("%s\n", is_bare_repository() ? "true"
797 if (!strcmp(arg, "--shared-index-path")) {
798 if (read_cache() < 0)
799 die(_("Could not read the index"));
800 if (the_index.split_index) {
801 const unsigned char *sha1 = the_index.split_index->base_sha1;
802 puts(git_path("sharedindex.%s", sha1_to_hex(sha1)));
806 if (starts_with(arg, "--since=")) {
807 show_datestring("--max-age=", arg+8);
810 if (starts_with(arg, "--after=")) {
811 show_datestring("--max-age=", arg+8);
814 if (starts_with(arg, "--before=")) {
815 show_datestring("--min-age=", arg+9);
818 if (starts_with(arg, "--until=")) {
819 show_datestring("--min-age=", arg+8);
822 if (show_flag(arg) && verify)
823 die_no_single_rev(quiet);
827 /* Not a flag argument */
828 if (try_difference(arg))
830 if (try_parent_shorthands(arg))
838 if (!get_sha1_with_context(name, flags, sha1, &unused)) {
842 show_rev(type, sha1, name);
846 die_no_single_rev(quiet);
848 die("bad revision '%s'", arg);
850 if (!show_file(arg, output_prefix))
852 verify_filename(prefix, arg, 1);
855 if (revs_count == 1) {
856 show_rev(type, sha1, name);
858 } else if (revs_count == 0 && show_default())
860 die_no_single_rev(quiet);