4 * Copyright (C) Linus Torvalds, 2005
11 #include "parse-options.h"
14 #include "split-index.h"
15 #include "submodule.h"
21 static int filter
= ~0;
23 static const char *def
;
27 static int show_type
= NORMAL
;
29 #define SHOW_SYMBOLIC_ASIS 1
30 #define SHOW_SYMBOLIC_FULL 2
33 static int abbrev_ref
;
34 static int abbrev_ref_strict
;
37 static int stuck_long
;
38 static struct string_list
*ref_excludes
;
41 * Some arguments are relevant "revision" arguments,
42 * others are about output format or other details.
43 * This sorts it all out.
45 static int is_rev_argument(const char *arg
)
47 static const char *rev_args
[] = {
78 const char **p
= rev_args
;
80 /* accept -<digit>, like traditional "head" */
81 if ((*arg
== '-') && isdigit(arg
[1]))
85 const char *str
= *p
++;
90 if (!strcmp(arg
, str
) ||
91 (str
[len
-1] == '=' && !strncmp(arg
, str
, len
)))
96 /* Output argument as a string, either SQ or normal */
97 static void show(const char *arg
)
103 while ((ch
= *arg
++)) {
105 fputs("'\\'", stdout
);
115 /* Like show(), but with a negation prefix according to type */
116 static void show_with_type(int type
, const char *arg
)
118 if (type
!= show_type
)
123 /* Output a revision, only if filter allows it */
124 static void show_rev(int type
, const unsigned char *sha1
, const char *name
)
126 if (!(filter
& DO_REVS
))
130 if ((symbolic
|| abbrev_ref
) && name
) {
131 if (symbolic
== SHOW_SYMBOLIC_FULL
|| abbrev_ref
) {
132 unsigned char discard
[20];
135 switch (dwim_ref(name
, strlen(name
), discard
, &full
)) {
138 * Not found -- not a ref. We could
139 * emit "name" here, but symbolic-full
140 * users are interested in finding the
141 * refs spelled in full, and they would
142 * need to filter non-refs if we did so.
147 full
= shorten_unambiguous_ref(full
,
149 show_with_type(type
, full
);
151 default: /* ambiguous */
152 error("refname '%s' is ambiguous", name
);
157 show_with_type(type
, name
);
161 show_with_type(type
, find_unique_abbrev(sha1
, abbrev
));
163 show_with_type(type
, sha1_to_hex(sha1
));
166 /* Output a flag, only if filter allows it. */
167 static int show_flag(const char *arg
)
169 if (!(filter
& DO_FLAGS
))
171 if (filter
& (is_rev_argument(arg
) ? DO_REVS
: DO_NOREV
)) {
178 static int show_default(void)
183 unsigned char sha1
[20];
186 if (!get_sha1(s
, sha1
)) {
187 show_rev(NORMAL
, sha1
, s
);
194 static int show_reference(const char *refname
, const struct object_id
*oid
, int flag
, void *cb_data
)
196 if (ref_excluded(ref_excludes
, refname
))
198 show_rev(NORMAL
, oid
->hash
, refname
);
202 static int anti_reference(const char *refname
, const struct object_id
*oid
, int flag
, void *cb_data
)
204 show_rev(REVERSED
, oid
->hash
, refname
);
208 static int show_abbrev(const unsigned char *sha1
, void *cb_data
)
210 show_rev(NORMAL
, sha1
, NULL
);
214 static void show_datestring(const char *flag
, const char *datestr
)
216 static char buffer
[100];
218 /* date handling requires both flags and revs */
219 if ((filter
& (DO_FLAGS
| DO_REVS
)) != (DO_FLAGS
| DO_REVS
))
221 snprintf(buffer
, sizeof(buffer
), "%s%lu", flag
, approxidate(datestr
));
225 static int show_file(const char *arg
, int output_prefix
)
228 if ((filter
& (DO_NONFLAGS
|DO_NOREV
)) == (DO_NONFLAGS
|DO_NOREV
)) {
230 const char *prefix
= startup_info
->prefix
;
231 show(prefix_filename(prefix
, arg
));
239 static int try_difference(const char *arg
)
242 unsigned char sha1
[20];
243 unsigned char end
[20];
247 static const char head_by_default
[] = "HEAD";
249 if (!(dotdot
= strstr(arg
, "..")))
253 symmetric
= (*next
== '.');
259 next
= head_by_default
;
261 this = head_by_default
;
263 if (this == head_by_default
&& next
== head_by_default
&&
266 * Just ".."? That is not a range but the
267 * pathspec for the parent directory.
273 if (!get_sha1_committish(this, sha1
) && !get_sha1_committish(next
, end
)) {
274 show_rev(NORMAL
, end
, next
);
275 show_rev(symmetric
? NORMAL
: REVERSED
, sha1
, this);
277 struct commit_list
*exclude
;
278 struct commit
*a
, *b
;
279 a
= lookup_commit_reference(sha1
);
280 b
= lookup_commit_reference(end
);
281 exclude
= get_merge_bases(a
, b
);
283 struct commit
*commit
= pop_commit(&exclude
);
284 show_rev(REVERSED
, commit
->object
.oid
.hash
, NULL
);
294 static int try_parent_shorthands(const char *arg
)
297 unsigned char sha1
[20];
298 struct commit
*commit
;
299 struct commit_list
*parents
;
302 int include_parents
= 0;
303 int exclude_parent
= 0;
305 if ((dotdot
= strstr(arg
, "^!"))) {
309 } else if ((dotdot
= strstr(arg
, "^@"))) {
313 } else if ((dotdot
= strstr(arg
, "^-"))) {
319 exclude_parent
= strtoul(dotdot
+ 2, &end
, 10);
320 if (*end
!= '\0' || !exclude_parent
)
327 if (get_sha1_committish(arg
, sha1
)) {
332 commit
= lookup_commit_reference(sha1
);
333 if (exclude_parent
&&
334 exclude_parent
> commit_list_count(commit
->parents
)) {
340 show_rev(NORMAL
, sha1
, arg
);
341 for (parents
= commit
->parents
, parent_number
= 1;
343 parents
= parents
->next
, parent_number
++) {
346 if (exclude_parent
&& parent_number
!= exclude_parent
)
350 name
= xstrfmt("%s^%d", arg
, parent_number
);
351 show_rev(include_parents
? NORMAL
: REVERSED
,
352 parents
->item
->object
.oid
.hash
, name
);
360 static int parseopt_dump(const struct option
*o
, const char *arg
, int unset
)
362 struct strbuf
*parsed
= o
->value
;
364 strbuf_addf(parsed
, " --no-%s", o
->long_name
);
365 else if (o
->short_name
&& (o
->long_name
== NULL
|| !stuck_long
))
366 strbuf_addf(parsed
, " -%c", o
->short_name
);
368 strbuf_addf(parsed
, " --%s", o
->long_name
);
371 strbuf_addch(parsed
, ' ');
372 else if (o
->long_name
)
373 strbuf_addch(parsed
, '=');
374 sq_quote_buf(parsed
, arg
);
379 static const char *skipspaces(const char *s
)
386 static int cmd_parseopt(int argc
, const char **argv
, const char *prefix
)
388 static int keep_dashdash
= 0, stop_at_non_option
= 0;
389 static char const * const parseopt_usage
[] = {
390 N_("git rev-parse --parseopt [<options>] -- [<args>...]"),
393 static struct option parseopt_opts
[] = {
394 OPT_BOOL(0, "keep-dashdash", &keep_dashdash
,
395 N_("keep the `--` passed as an arg")),
396 OPT_BOOL(0, "stop-at-non-option", &stop_at_non_option
,
397 N_("stop parsing after the "
398 "first non-option argument")),
399 OPT_BOOL(0, "stuck-long", &stuck_long
,
400 N_("output in stuck long form")),
403 static const char * const flag_chars
= "*=?!";
405 struct strbuf sb
= STRBUF_INIT
, parsed
= STRBUF_INIT
;
406 const char **usage
= NULL
;
407 struct option
*opts
= NULL
;
408 int onb
= 0, osz
= 0, unb
= 0, usz
= 0;
410 strbuf_addstr(&parsed
, "set --");
411 argc
= parse_options(argc
, argv
, prefix
, parseopt_opts
, parseopt_usage
,
412 PARSE_OPT_KEEP_DASHDASH
);
413 if (argc
< 1 || strcmp(argv
[0], "--"))
414 usage_with_options(parseopt_usage
, parseopt_opts
);
416 /* get the usage up to the first line with a -- on it */
418 if (strbuf_getline(&sb
, stdin
) == EOF
)
419 die("premature end of input");
420 ALLOC_GROW(usage
, unb
+ 1, usz
);
421 if (!strcmp("--", sb
.buf
)) {
423 die("no usage string given before the `--' separator");
427 usage
[unb
++] = strbuf_detach(&sb
, NULL
);
430 /* parse: (<short>|<short>,<long>|<long>)[*=?!]*<arghint>? SP+ <help> */
431 while (strbuf_getline(&sb
, stdin
) != EOF
) {
439 ALLOC_GROW(opts
, onb
+ 1, osz
);
440 memset(opts
+ onb
, 0, sizeof(opts
[onb
]));
443 help
= strchr(sb
.buf
, ' ');
444 if (!help
|| *sb
.buf
== ' ') {
445 o
->type
= OPTION_GROUP
;
446 o
->help
= xstrdup(skipspaces(sb
.buf
));
450 o
->type
= OPTION_CALLBACK
;
451 o
->help
= xstrdup(skipspaces(help
));
453 o
->flags
= PARSE_OPT_NOARG
;
454 o
->callback
= &parseopt_dump
;
457 s
= strpbrk(sb
.buf
, flag_chars
);
461 if (s
- sb
.buf
== 1) /* short option only */
462 o
->short_name
= *sb
.buf
;
463 else if (sb
.buf
[1] != ',') /* long option only */
464 o
->long_name
= xmemdupz(sb
.buf
, s
- sb
.buf
);
466 o
->short_name
= *sb
.buf
;
467 o
->long_name
= xmemdupz(sb
.buf
+ 2, s
- sb
.buf
- 2);
474 o
->flags
&= ~PARSE_OPT_NOARG
;
477 o
->flags
&= ~PARSE_OPT_NOARG
;
478 o
->flags
|= PARSE_OPT_OPTARG
;
481 o
->flags
|= PARSE_OPT_NONEG
;
484 o
->flags
|= PARSE_OPT_HIDDEN
;
492 o
->argh
= xmemdupz(s
, help
- s
);
496 /* put an OPT_END() */
497 ALLOC_GROW(opts
, onb
+ 1, osz
);
498 memset(opts
+ onb
, 0, sizeof(opts
[onb
]));
499 argc
= parse_options(argc
, argv
, prefix
, opts
, usage
,
500 (keep_dashdash
? PARSE_OPT_KEEP_DASHDASH
: 0) |
501 (stop_at_non_option
? PARSE_OPT_STOP_AT_NON_OPTION
: 0) |
502 PARSE_OPT_SHELL_EVAL
);
504 strbuf_addstr(&parsed
, " --");
505 sq_quote_argv(&parsed
, argv
, 0);
510 static int cmd_sq_quote(int argc
, const char **argv
)
512 struct strbuf buf
= STRBUF_INIT
;
515 sq_quote_argv(&buf
, argv
, 0);
516 printf("%s\n", buf
.buf
);
517 strbuf_release(&buf
);
522 static void die_no_single_rev(int quiet
)
527 die("Needed a single revision");
530 static const char builtin_rev_parse_usage
[] =
531 N_("git rev-parse --parseopt [<options>] -- [<args>...]\n"
532 " or: git rev-parse --sq-quote [<arg>...]\n"
533 " or: git rev-parse [<options>] [<arg>...]\n"
535 "Run \"git rev-parse --parseopt -h\" for more information on the first usage.");
537 int cmd_rev_parse(int argc
, const char **argv
, const char *prefix
)
539 int i
, as_is
= 0, verify
= 0, quiet
= 0, revs_count
= 0, type
= 0;
540 int did_repo_setup
= 0;
541 int has_dashdash
= 0;
542 int output_prefix
= 0;
543 unsigned char sha1
[20];
544 unsigned int flags
= 0;
545 const char *name
= NULL
;
546 struct object_context unused
;
547 struct strbuf buf
= STRBUF_INIT
;
549 if (argc
> 1 && !strcmp("--parseopt", argv
[1]))
550 return cmd_parseopt(argc
- 1, argv
+ 1, prefix
);
552 if (argc
> 1 && !strcmp("--sq-quote", argv
[1]))
553 return cmd_sq_quote(argc
- 2, argv
+ 2);
555 if (argc
> 1 && !strcmp("-h", argv
[1]))
556 usage(builtin_rev_parse_usage
);
558 for (i
= 1; i
< argc
; i
++) {
559 if (!strcmp(argv
[i
], "--")) {
565 /* No options; just report on whether we're in a git repo or not. */
567 setup_git_directory();
568 git_config(git_default_config
, NULL
);
572 for (i
= 1; i
< argc
; i
++) {
573 const char *arg
= argv
[i
];
575 if (!strcmp(arg
, "--local-env-vars")) {
577 for (i
= 0; local_repo_env
[i
]; i
++)
578 printf("%s\n", local_repo_env
[i
]);
581 if (!strcmp(arg
, "--resolve-git-dir")) {
582 const char *gitdir
= argv
[++i
];
584 die("--resolve-git-dir requires an argument");
585 gitdir
= resolve_gitdir(gitdir
);
587 die("not a gitdir '%s'", argv
[i
]);
592 /* The rest of the options require a git repository. */
593 if (!did_repo_setup
) {
594 prefix
= setup_git_directory();
595 git_config(git_default_config
, NULL
);
599 if (!strcmp(arg
, "--git-path")) {
601 die("--git-path requires an argument");
603 puts(relative_path(git_path("%s", argv
[i
+ 1]),
609 if (show_file(arg
, output_prefix
) && as_is
< 2)
610 verify_filename(prefix
, arg
, 0);
613 if (!strcmp(arg
,"-n")) {
615 die("-n requires an argument");
616 if ((filter
& DO_FLAGS
) && (filter
& DO_REVS
)) {
622 if (starts_with(arg
, "-n")) {
623 if ((filter
& DO_FLAGS
) && (filter
& DO_REVS
))
629 if (!strcmp(arg
, "--")) {
631 /* Pass on the "--" if we show anything but files.. */
632 if (filter
& (DO_FLAGS
| DO_REVS
))
636 if (!strcmp(arg
, "--default")) {
639 die("--default requires an argument");
642 if (!strcmp(arg
, "--prefix")) {
645 die("--prefix requires an argument");
646 startup_info
->prefix
= prefix
;
650 if (!strcmp(arg
, "--revs-only")) {
654 if (!strcmp(arg
, "--no-revs")) {
658 if (!strcmp(arg
, "--flags")) {
659 filter
&= ~DO_NONFLAGS
;
662 if (!strcmp(arg
, "--no-flags")) {
666 if (!strcmp(arg
, "--verify")) {
667 filter
&= ~(DO_FLAGS
|DO_NOREV
);
671 if (!strcmp(arg
, "--quiet") || !strcmp(arg
, "-q")) {
673 flags
|= GET_SHA1_QUIETLY
;
676 if (!strcmp(arg
, "--short") ||
677 starts_with(arg
, "--short=")) {
678 filter
&= ~(DO_FLAGS
|DO_NOREV
);
680 abbrev
= DEFAULT_ABBREV
;
683 abbrev
= strtoul(arg
+ 8, NULL
, 10);
684 if (abbrev
< MINIMUM_ABBREV
)
685 abbrev
= MINIMUM_ABBREV
;
686 else if (40 <= abbrev
)
690 if (!strcmp(arg
, "--sq")) {
694 if (!strcmp(arg
, "--not")) {
695 show_type
^= REVERSED
;
698 if (!strcmp(arg
, "--symbolic")) {
699 symbolic
= SHOW_SYMBOLIC_ASIS
;
702 if (!strcmp(arg
, "--symbolic-full-name")) {
703 symbolic
= SHOW_SYMBOLIC_FULL
;
706 if (starts_with(arg
, "--abbrev-ref") &&
707 (!arg
[12] || arg
[12] == '=')) {
709 abbrev_ref_strict
= warn_ambiguous_refs
;
710 if (arg
[12] == '=') {
711 if (!strcmp(arg
+ 13, "strict"))
712 abbrev_ref_strict
= 1;
713 else if (!strcmp(arg
+ 13, "loose"))
714 abbrev_ref_strict
= 0;
716 die("unknown mode for %s", arg
);
720 if (!strcmp(arg
, "--all")) {
721 for_each_ref(show_reference
, NULL
);
724 if (starts_with(arg
, "--disambiguate=")) {
725 for_each_abbrev(arg
+ 15, show_abbrev
, NULL
);
728 if (!strcmp(arg
, "--bisect")) {
729 for_each_ref_in("refs/bisect/bad", show_reference
, NULL
);
730 for_each_ref_in("refs/bisect/good", anti_reference
, NULL
);
733 if (starts_with(arg
, "--branches=")) {
734 for_each_glob_ref_in(show_reference
, arg
+ 11,
735 "refs/heads/", NULL
);
736 clear_ref_exclusion(&ref_excludes
);
739 if (!strcmp(arg
, "--branches")) {
740 for_each_branch_ref(show_reference
, NULL
);
741 clear_ref_exclusion(&ref_excludes
);
744 if (starts_with(arg
, "--tags=")) {
745 for_each_glob_ref_in(show_reference
, arg
+ 7,
747 clear_ref_exclusion(&ref_excludes
);
750 if (!strcmp(arg
, "--tags")) {
751 for_each_tag_ref(show_reference
, NULL
);
752 clear_ref_exclusion(&ref_excludes
);
755 if (starts_with(arg
, "--glob=")) {
756 for_each_glob_ref(show_reference
, arg
+ 7, NULL
);
757 clear_ref_exclusion(&ref_excludes
);
760 if (starts_with(arg
, "--remotes=")) {
761 for_each_glob_ref_in(show_reference
, arg
+ 10,
762 "refs/remotes/", NULL
);
763 clear_ref_exclusion(&ref_excludes
);
766 if (!strcmp(arg
, "--remotes")) {
767 for_each_remote_ref(show_reference
, NULL
);
768 clear_ref_exclusion(&ref_excludes
);
771 if (starts_with(arg
, "--exclude=")) {
772 add_ref_exclusion(&ref_excludes
, arg
+ 10);
775 if (!strcmp(arg
, "--show-toplevel")) {
776 const char *work_tree
= get_git_work_tree();
781 if (!strcmp(arg
, "--show-superproject-working-tree")) {
782 const char *superproject
= get_superproject_working_tree();
787 if (!strcmp(arg
, "--show-prefix")) {
794 if (!strcmp(arg
, "--show-cdup")) {
795 const char *pfx
= prefix
;
796 if (!is_inside_work_tree()) {
797 const char *work_tree
=
800 printf("%s\n", work_tree
);
804 pfx
= strchr(pfx
, '/');
813 if (!strcmp(arg
, "--git-dir") ||
814 !strcmp(arg
, "--absolute-git-dir")) {
815 const char *gitdir
= getenv(GIT_DIR_ENVIRONMENT
);
818 if (arg
[2] == 'g') { /* --git-dir */
827 } else { /* --absolute-git-dir */
828 if (!gitdir
&& !prefix
)
831 puts(real_path(gitdir
));
837 printf("%s%s.git\n", cwd
, len
&& cwd
[len
-1] != '/' ? "/" : "");
841 if (!strcmp(arg
, "--git-common-dir")) {
843 puts(relative_path(get_git_common_dir(),
847 if (!strcmp(arg
, "--is-inside-git-dir")) {
848 printf("%s\n", is_inside_git_dir() ? "true"
852 if (!strcmp(arg
, "--is-inside-work-tree")) {
853 printf("%s\n", is_inside_work_tree() ? "true"
857 if (!strcmp(arg
, "--is-bare-repository")) {
858 printf("%s\n", is_bare_repository() ? "true"
862 if (!strcmp(arg
, "--shared-index-path")) {
863 if (read_cache() < 0)
864 die(_("Could not read the index"));
865 if (the_index
.split_index
) {
866 const unsigned char *sha1
= the_index
.split_index
->base_sha1
;
867 const char *path
= git_path("sharedindex.%s", sha1_to_hex(sha1
));
869 puts(relative_path(path
, prefix
, &buf
));
873 if (starts_with(arg
, "--since=")) {
874 show_datestring("--max-age=", arg
+8);
877 if (starts_with(arg
, "--after=")) {
878 show_datestring("--max-age=", arg
+8);
881 if (starts_with(arg
, "--before=")) {
882 show_datestring("--min-age=", arg
+9);
885 if (starts_with(arg
, "--until=")) {
886 show_datestring("--min-age=", arg
+8);
889 if (show_flag(arg
) && verify
)
890 die_no_single_rev(quiet
);
894 /* Not a flag argument */
895 if (try_difference(arg
))
897 if (try_parent_shorthands(arg
))
905 if (!get_sha1_with_context(name
, flags
, sha1
, &unused
)) {
909 show_rev(type
, sha1
, name
);
913 die_no_single_rev(quiet
);
915 die("bad revision '%s'", arg
);
917 if (!show_file(arg
, output_prefix
))
919 verify_filename(prefix
, arg
, 1);
921 strbuf_release(&buf
);
923 if (revs_count
== 1) {
924 show_rev(type
, sha1
, name
);
926 } else if (revs_count
== 0 && show_default())
928 die_no_single_rev(quiet
);