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.");
539 * Parse "opt" or "opt=<value>", setting value respectively to either
540 * NULL or the string after "=".
542 static int opt_with_value(const char *arg
, const char *opt
, const char **value
)
544 if (skip_prefix(arg
, opt
, &arg
)) {
557 static void handle_ref_opt(const char *pattern
, const char *prefix
)
560 for_each_glob_ref_in(show_reference
, pattern
, prefix
, NULL
);
562 for_each_ref_in(prefix
, show_reference
, NULL
);
563 clear_ref_exclusion(&ref_excludes
);
566 int cmd_rev_parse(int argc
, const char **argv
, const char *prefix
)
568 int i
, as_is
= 0, verify
= 0, quiet
= 0, revs_count
= 0, type
= 0;
569 int did_repo_setup
= 0;
570 int has_dashdash
= 0;
571 int output_prefix
= 0;
572 unsigned char sha1
[20];
573 unsigned int flags
= 0;
574 const char *name
= NULL
;
575 struct object_context unused
;
577 if (argc
> 1 && !strcmp("--parseopt", argv
[1]))
578 return cmd_parseopt(argc
- 1, argv
+ 1, prefix
);
580 if (argc
> 1 && !strcmp("--sq-quote", argv
[1]))
581 return cmd_sq_quote(argc
- 2, argv
+ 2);
583 if (argc
> 1 && !strcmp("-h", argv
[1]))
584 usage(builtin_rev_parse_usage
);
586 for (i
= 1; i
< argc
; i
++) {
587 if (!strcmp(argv
[i
], "--")) {
593 /* No options; just report on whether we're in a git repo or not. */
595 setup_git_directory();
596 git_config(git_default_config
, NULL
);
600 for (i
= 1; i
< argc
; i
++) {
601 const char *arg
= argv
[i
];
603 if (!strcmp(arg
, "--local-env-vars")) {
605 for (i
= 0; local_repo_env
[i
]; i
++)
606 printf("%s\n", local_repo_env
[i
]);
609 if (!strcmp(arg
, "--resolve-git-dir")) {
610 const char *gitdir
= argv
[++i
];
612 die("--resolve-git-dir requires an argument");
613 gitdir
= resolve_gitdir(gitdir
);
615 die("not a gitdir '%s'", argv
[i
]);
620 /* The rest of the options require a git repository. */
621 if (!did_repo_setup
) {
622 prefix
= setup_git_directory();
623 git_config(git_default_config
, NULL
);
627 if (!strcmp(arg
, "--git-path")) {
629 die("--git-path requires an argument");
630 puts(git_path("%s", argv
[i
+ 1]));
635 if (show_file(arg
, output_prefix
) && as_is
< 2)
636 verify_filename(prefix
, arg
, 0);
639 if (!strcmp(arg
,"-n")) {
641 die("-n requires an argument");
642 if ((filter
& DO_FLAGS
) && (filter
& DO_REVS
)) {
648 if (starts_with(arg
, "-n")) {
649 if ((filter
& DO_FLAGS
) && (filter
& DO_REVS
))
655 if (!strcmp(arg
, "--")) {
657 /* Pass on the "--" if we show anything but files.. */
658 if (filter
& (DO_FLAGS
| DO_REVS
))
662 if (!strcmp(arg
, "--default")) {
665 die("--default requires an argument");
668 if (!strcmp(arg
, "--prefix")) {
671 die("--prefix requires an argument");
672 startup_info
->prefix
= prefix
;
676 if (!strcmp(arg
, "--revs-only")) {
680 if (!strcmp(arg
, "--no-revs")) {
684 if (!strcmp(arg
, "--flags")) {
685 filter
&= ~DO_NONFLAGS
;
688 if (!strcmp(arg
, "--no-flags")) {
692 if (!strcmp(arg
, "--verify")) {
693 filter
&= ~(DO_FLAGS
|DO_NOREV
);
697 if (!strcmp(arg
, "--quiet") || !strcmp(arg
, "-q")) {
699 flags
|= GET_SHA1_QUIETLY
;
702 if (opt_with_value(arg
, "--short", &arg
)) {
703 filter
&= ~(DO_FLAGS
|DO_NOREV
);
705 abbrev
= DEFAULT_ABBREV
;
708 abbrev
= strtoul(arg
, NULL
, 10);
709 if (abbrev
< MINIMUM_ABBREV
)
710 abbrev
= MINIMUM_ABBREV
;
711 else if (40 <= abbrev
)
715 if (!strcmp(arg
, "--sq")) {
719 if (!strcmp(arg
, "--not")) {
720 show_type
^= REVERSED
;
723 if (!strcmp(arg
, "--symbolic")) {
724 symbolic
= SHOW_SYMBOLIC_ASIS
;
727 if (!strcmp(arg
, "--symbolic-full-name")) {
728 symbolic
= SHOW_SYMBOLIC_FULL
;
731 if (opt_with_value(arg
, "--abbrev-ref", &arg
)) {
733 abbrev_ref_strict
= warn_ambiguous_refs
;
735 if (!strcmp(arg
, "strict"))
736 abbrev_ref_strict
= 1;
737 else if (!strcmp(arg
, "loose"))
738 abbrev_ref_strict
= 0;
740 die("unknown mode for --abbrev-ref: %s",
745 if (!strcmp(arg
, "--all")) {
746 for_each_ref(show_reference
, NULL
);
749 if (skip_prefix(arg
, "--disambiguate=", &arg
)) {
750 for_each_abbrev(arg
, show_abbrev
, NULL
);
753 if (!strcmp(arg
, "--bisect")) {
754 for_each_ref_in("refs/bisect/bad", show_reference
, NULL
);
755 for_each_ref_in("refs/bisect/good", anti_reference
, NULL
);
758 if (opt_with_value(arg
, "--branches", &arg
)) {
759 handle_ref_opt(arg
, "refs/heads/");
762 if (opt_with_value(arg
, "--tags", &arg
)) {
763 handle_ref_opt(arg
, "refs/tags/");
766 if (skip_prefix(arg
, "--glob=", &arg
)) {
767 handle_ref_opt(arg
, NULL
);
770 if (opt_with_value(arg
, "--remotes", &arg
)) {
771 handle_ref_opt(arg
, "refs/remotes/");
774 if (skip_prefix(arg
, "--exclude=", &arg
)) {
775 add_ref_exclusion(&ref_excludes
, arg
);
778 if (!strcmp(arg
, "--show-toplevel")) {
779 const char *work_tree
= get_git_work_tree();
784 if (!strcmp(arg
, "--show-prefix")) {
791 if (!strcmp(arg
, "--show-cdup")) {
792 const char *pfx
= prefix
;
793 if (!is_inside_work_tree()) {
794 const char *work_tree
=
797 printf("%s\n", work_tree
);
801 pfx
= strchr(pfx
, '/');
810 if (!strcmp(arg
, "--git-dir")) {
811 const char *gitdir
= getenv(GIT_DIR_ENVIRONMENT
);
824 printf("%s%s.git\n", cwd
, len
&& cwd
[len
-1] != '/' ? "/" : "");
828 if (!strcmp(arg
, "--git-common-dir")) {
829 const char *pfx
= prefix
? prefix
: "";
830 puts(prefix_filename(pfx
, strlen(pfx
), get_git_common_dir()));
833 if (!strcmp(arg
, "--is-inside-git-dir")) {
834 printf("%s\n", is_inside_git_dir() ? "true"
838 if (!strcmp(arg
, "--is-inside-work-tree")) {
839 printf("%s\n", is_inside_work_tree() ? "true"
843 if (!strcmp(arg
, "--is-bare-repository")) {
844 printf("%s\n", is_bare_repository() ? "true"
848 if (!strcmp(arg
, "--shared-index-path")) {
849 if (read_cache() < 0)
850 die(_("Could not read the index"));
851 if (the_index
.split_index
) {
852 const unsigned char *sha1
= the_index
.split_index
->base_sha1
;
853 puts(git_path("sharedindex.%s", sha1_to_hex(sha1
)));
857 if (skip_prefix(arg
, "--since=", &arg
)) {
858 show_datestring("--max-age=", arg
);
861 if (skip_prefix(arg
, "--after=", &arg
)) {
862 show_datestring("--max-age=", arg
);
865 if (skip_prefix(arg
, "--before=", &arg
)) {
866 show_datestring("--min-age=", arg
);
869 if (skip_prefix(arg
, "--until=", &arg
)) {
870 show_datestring("--min-age=", arg
);
873 if (show_flag(arg
) && verify
)
874 die_no_single_rev(quiet
);
878 /* Not a flag argument */
879 if (try_difference(arg
))
881 if (try_parent_shorthands(arg
))
889 if (!get_sha1_with_context(name
, flags
, sha1
, &unused
)) {
893 show_rev(type
, sha1
, name
);
897 die_no_single_rev(quiet
);
899 die("bad revision '%s'", arg
);
901 if (!show_file(arg
, output_prefix
))
903 verify_filename(prefix
, arg
, 1);
906 if (revs_count
== 1) {
907 show_rev(type
, sha1
, name
);
909 } else if (revs_count
== 0 && show_default())
911 die_no_single_rev(quiet
);