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
);
155 show_with_type(type
, name
);
159 show_with_type(type
, find_unique_abbrev(sha1
, abbrev
));
161 show_with_type(type
, sha1_to_hex(sha1
));
164 /* Output a flag, only if filter allows it. */
165 static int show_flag(const char *arg
)
167 if (!(filter
& DO_FLAGS
))
169 if (filter
& (is_rev_argument(arg
) ? DO_REVS
: DO_NOREV
)) {
176 static int show_default(void)
181 unsigned char sha1
[20];
184 if (!get_sha1(s
, sha1
)) {
185 show_rev(NORMAL
, sha1
, s
);
192 static int show_reference(const char *refname
, const unsigned char *sha1
, int flag
, void *cb_data
)
194 if (ref_excluded(ref_excludes
, refname
))
196 show_rev(NORMAL
, sha1
, refname
);
200 static int anti_reference(const char *refname
, const unsigned char *sha1
, int flag
, void *cb_data
)
202 show_rev(REVERSED
, sha1
, refname
);
206 static int show_abbrev(const unsigned char *sha1
, void *cb_data
)
208 show_rev(NORMAL
, sha1
, NULL
);
212 static void show_datestring(const char *flag
, const char *datestr
)
214 static char buffer
[100];
216 /* date handling requires both flags and revs */
217 if ((filter
& (DO_FLAGS
| DO_REVS
)) != (DO_FLAGS
| DO_REVS
))
219 snprintf(buffer
, sizeof(buffer
), "%s%lu", flag
, approxidate(datestr
));
223 static int show_file(const char *arg
, int output_prefix
)
226 if ((filter
& (DO_NONFLAGS
|DO_NOREV
)) == (DO_NONFLAGS
|DO_NOREV
)) {
228 const char *prefix
= startup_info
->prefix
;
229 show(prefix_filename(prefix
,
230 prefix
? strlen(prefix
) : 0,
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
, 1);
283 struct commit_list
*n
= exclude
->next
;
285 exclude
->item
->object
.sha1
,NULL
);
297 static int try_parent_shorthands(const char *arg
)
300 unsigned char sha1
[20];
301 struct commit
*commit
;
302 struct commit_list
*parents
;
305 if ((dotdot
= strstr(arg
, "^!")))
307 else if ((dotdot
= strstr(arg
, "^@")))
310 if (!dotdot
|| dotdot
[2])
314 if (get_sha1_committish(arg
, sha1
)) {
320 show_rev(NORMAL
, sha1
, arg
);
321 commit
= lookup_commit_reference(sha1
);
322 for (parents
= commit
->parents
; parents
; parents
= parents
->next
)
323 show_rev(parents_only
? NORMAL
: REVERSED
,
324 parents
->item
->object
.sha1
, arg
);
330 static int parseopt_dump(const struct option
*o
, const char *arg
, int unset
)
332 struct strbuf
*parsed
= o
->value
;
334 strbuf_addf(parsed
, " --no-%s", o
->long_name
);
335 else if (o
->short_name
&& (o
->long_name
== NULL
|| !stuck_long
))
336 strbuf_addf(parsed
, " -%c", o
->short_name
);
338 strbuf_addf(parsed
, " --%s", o
->long_name
);
341 strbuf_addch(parsed
, ' ');
342 else if (o
->long_name
)
343 strbuf_addch(parsed
, '=');
344 sq_quote_buf(parsed
, arg
);
349 static const char *skipspaces(const char *s
)
356 static int cmd_parseopt(int argc
, const char **argv
, const char *prefix
)
358 static int keep_dashdash
= 0, stop_at_non_option
= 0;
359 static char const * const parseopt_usage
[] = {
360 N_("git rev-parse --parseopt [options] -- [<args>...]"),
363 static struct option parseopt_opts
[] = {
364 OPT_BOOL(0, "keep-dashdash", &keep_dashdash
,
365 N_("keep the `--` passed as an arg")),
366 OPT_BOOL(0, "stop-at-non-option", &stop_at_non_option
,
367 N_("stop parsing after the "
368 "first non-option argument")),
369 OPT_BOOL(0, "stuck-long", &stuck_long
,
370 N_("output in stuck long form")),
374 struct strbuf sb
= STRBUF_INIT
, parsed
= STRBUF_INIT
;
375 const char **usage
= NULL
;
376 struct option
*opts
= NULL
;
377 int onb
= 0, osz
= 0, unb
= 0, usz
= 0;
379 strbuf_addstr(&parsed
, "set --");
380 argc
= parse_options(argc
, argv
, prefix
, parseopt_opts
, parseopt_usage
,
381 PARSE_OPT_KEEP_DASHDASH
);
382 if (argc
< 1 || strcmp(argv
[0], "--"))
383 usage_with_options(parseopt_usage
, parseopt_opts
);
385 /* get the usage up to the first line with a -- on it */
387 if (strbuf_getline(&sb
, stdin
, '\n') == EOF
)
388 die("premature end of input");
389 ALLOC_GROW(usage
, unb
+ 1, usz
);
390 if (!strcmp("--", sb
.buf
)) {
392 die("no usage string given before the `--' separator");
396 usage
[unb
++] = strbuf_detach(&sb
, NULL
);
399 /* parse: (<short>|<short>,<long>|<long>)[*=?!]*<arghint>? SP+ <help> */
400 while (strbuf_getline(&sb
, stdin
, '\n') != EOF
) {
408 ALLOC_GROW(opts
, onb
+ 1, osz
);
409 memset(opts
+ onb
, 0, sizeof(opts
[onb
]));
412 s
= strchr(sb
.buf
, ' ');
413 if (!s
|| *sb
.buf
== ' ') {
414 o
->type
= OPTION_GROUP
;
415 o
->help
= xstrdup(skipspaces(sb
.buf
));
419 o
->type
= OPTION_CALLBACK
;
420 o
->help
= xstrdup(skipspaces(s
));
422 o
->flags
= PARSE_OPT_NOARG
;
423 o
->callback
= &parseopt_dump
;
425 /* Possible argument name hint */
427 while (s
> sb
.buf
&& strchr("*=?!", s
[-1]) == NULL
)
429 if (s
!= sb
.buf
&& s
!= end
)
430 o
->argh
= xmemdupz(s
, end
- s
);
434 while (s
> sb
.buf
&& strchr("*=?!", s
[-1])) {
437 o
->flags
&= ~PARSE_OPT_NOARG
;
440 o
->flags
&= ~PARSE_OPT_NOARG
;
441 o
->flags
|= PARSE_OPT_OPTARG
;
444 o
->flags
|= PARSE_OPT_NONEG
;
447 o
->flags
|= PARSE_OPT_HIDDEN
;
452 if (s
- sb
.buf
== 1) /* short option only */
453 o
->short_name
= *sb
.buf
;
454 else if (sb
.buf
[1] != ',') /* long option only */
455 o
->long_name
= xmemdupz(sb
.buf
, s
- sb
.buf
);
457 o
->short_name
= *sb
.buf
;
458 o
->long_name
= xmemdupz(sb
.buf
+ 2, s
- sb
.buf
- 2);
463 /* put an OPT_END() */
464 ALLOC_GROW(opts
, onb
+ 1, osz
);
465 memset(opts
+ onb
, 0, sizeof(opts
[onb
]));
466 argc
= parse_options(argc
, argv
, prefix
, opts
, usage
,
467 (keep_dashdash
? PARSE_OPT_KEEP_DASHDASH
: 0) |
468 (stop_at_non_option
? PARSE_OPT_STOP_AT_NON_OPTION
: 0) |
469 PARSE_OPT_SHELL_EVAL
);
471 strbuf_addf(&parsed
, " --");
472 sq_quote_argv(&parsed
, argv
, 0);
477 static int cmd_sq_quote(int argc
, const char **argv
)
479 struct strbuf buf
= STRBUF_INIT
;
482 sq_quote_argv(&buf
, argv
, 0);
483 printf("%s\n", buf
.buf
);
484 strbuf_release(&buf
);
489 static void die_no_single_rev(int quiet
)
494 die("Needed a single revision");
497 static const char builtin_rev_parse_usage
[] =
498 N_("git rev-parse --parseopt [options] -- [<args>...]\n"
499 " or: git rev-parse --sq-quote [<arg>...]\n"
500 " or: git rev-parse [options] [<arg>...]\n"
502 "Run \"git rev-parse --parseopt -h\" for more information on the first usage.");
504 int cmd_rev_parse(int argc
, const char **argv
, const char *prefix
)
506 int i
, as_is
= 0, verify
= 0, quiet
= 0, revs_count
= 0, type
= 0;
507 int has_dashdash
= 0;
508 int output_prefix
= 0;
509 unsigned char sha1
[20];
510 const char *name
= NULL
;
512 if (argc
> 1 && !strcmp("--parseopt", argv
[1]))
513 return cmd_parseopt(argc
- 1, argv
+ 1, prefix
);
515 if (argc
> 1 && !strcmp("--sq-quote", argv
[1]))
516 return cmd_sq_quote(argc
- 2, argv
+ 2);
518 if (argc
> 1 && !strcmp("-h", argv
[1]))
519 usage(builtin_rev_parse_usage
);
521 for (i
= 1; i
< argc
; i
++) {
522 if (!strcmp(argv
[i
], "--")) {
528 prefix
= setup_git_directory();
529 git_config(git_default_config
, NULL
);
530 for (i
= 1; i
< argc
; i
++) {
531 const char *arg
= argv
[i
];
534 if (show_file(arg
, output_prefix
) && as_is
< 2)
535 verify_filename(prefix
, arg
, 0);
538 if (!strcmp(arg
,"-n")) {
540 die("-n requires an argument");
541 if ((filter
& DO_FLAGS
) && (filter
& DO_REVS
)) {
547 if (starts_with(arg
, "-n")) {
548 if ((filter
& DO_FLAGS
) && (filter
& DO_REVS
))
554 if (!strcmp(arg
, "--")) {
556 /* Pass on the "--" if we show anything but files.. */
557 if (filter
& (DO_FLAGS
| DO_REVS
))
561 if (!strcmp(arg
, "--default")) {
564 die("--default requires an argument");
567 if (!strcmp(arg
, "--prefix")) {
570 die("--prefix requires an argument");
571 startup_info
->prefix
= prefix
;
575 if (!strcmp(arg
, "--revs-only")) {
579 if (!strcmp(arg
, "--no-revs")) {
583 if (!strcmp(arg
, "--flags")) {
584 filter
&= ~DO_NONFLAGS
;
587 if (!strcmp(arg
, "--no-flags")) {
591 if (!strcmp(arg
, "--verify")) {
592 filter
&= ~(DO_FLAGS
|DO_NOREV
);
596 if (!strcmp(arg
, "--quiet") || !strcmp(arg
, "-q")) {
600 if (!strcmp(arg
, "--short") ||
601 starts_with(arg
, "--short=")) {
602 filter
&= ~(DO_FLAGS
|DO_NOREV
);
604 abbrev
= DEFAULT_ABBREV
;
606 abbrev
= strtoul(arg
+ 8, NULL
, 10);
607 if (abbrev
< MINIMUM_ABBREV
)
608 abbrev
= MINIMUM_ABBREV
;
609 else if (40 <= abbrev
)
613 if (!strcmp(arg
, "--sq")) {
617 if (!strcmp(arg
, "--not")) {
618 show_type
^= REVERSED
;
621 if (!strcmp(arg
, "--symbolic")) {
622 symbolic
= SHOW_SYMBOLIC_ASIS
;
625 if (!strcmp(arg
, "--symbolic-full-name")) {
626 symbolic
= SHOW_SYMBOLIC_FULL
;
629 if (starts_with(arg
, "--abbrev-ref") &&
630 (!arg
[12] || arg
[12] == '=')) {
632 abbrev_ref_strict
= warn_ambiguous_refs
;
633 if (arg
[12] == '=') {
634 if (!strcmp(arg
+ 13, "strict"))
635 abbrev_ref_strict
= 1;
636 else if (!strcmp(arg
+ 13, "loose"))
637 abbrev_ref_strict
= 0;
639 die("unknown mode for %s", arg
);
643 if (!strcmp(arg
, "--all")) {
644 for_each_ref(show_reference
, NULL
);
647 if (starts_with(arg
, "--disambiguate=")) {
648 for_each_abbrev(arg
+ 15, show_abbrev
, NULL
);
651 if (!strcmp(arg
, "--bisect")) {
652 for_each_ref_in("refs/bisect/bad", show_reference
, NULL
);
653 for_each_ref_in("refs/bisect/good", anti_reference
, NULL
);
656 if (starts_with(arg
, "--branches=")) {
657 for_each_glob_ref_in(show_reference
, arg
+ 11,
658 "refs/heads/", NULL
);
659 clear_ref_exclusion(&ref_excludes
);
662 if (!strcmp(arg
, "--branches")) {
663 for_each_branch_ref(show_reference
, NULL
);
664 clear_ref_exclusion(&ref_excludes
);
667 if (starts_with(arg
, "--tags=")) {
668 for_each_glob_ref_in(show_reference
, arg
+ 7,
670 clear_ref_exclusion(&ref_excludes
);
673 if (!strcmp(arg
, "--tags")) {
674 for_each_tag_ref(show_reference
, NULL
);
675 clear_ref_exclusion(&ref_excludes
);
678 if (starts_with(arg
, "--glob=")) {
679 for_each_glob_ref(show_reference
, arg
+ 7, NULL
);
680 clear_ref_exclusion(&ref_excludes
);
683 if (starts_with(arg
, "--remotes=")) {
684 for_each_glob_ref_in(show_reference
, arg
+ 10,
685 "refs/remotes/", NULL
);
686 clear_ref_exclusion(&ref_excludes
);
689 if (!strcmp(arg
, "--remotes")) {
690 for_each_remote_ref(show_reference
, NULL
);
691 clear_ref_exclusion(&ref_excludes
);
694 if (starts_with(arg
, "--exclude=")) {
695 add_ref_exclusion(&ref_excludes
, arg
+ 10);
698 if (!strcmp(arg
, "--local-env-vars")) {
700 for (i
= 0; local_repo_env
[i
]; i
++)
701 printf("%s\n", local_repo_env
[i
]);
704 if (!strcmp(arg
, "--show-toplevel")) {
705 const char *work_tree
= get_git_work_tree();
710 if (!strcmp(arg
, "--show-prefix")) {
717 if (!strcmp(arg
, "--show-cdup")) {
718 const char *pfx
= prefix
;
719 if (!is_inside_work_tree()) {
720 const char *work_tree
=
723 printf("%s\n", work_tree
);
727 pfx
= strchr(pfx
, '/');
736 if (!strcmp(arg
, "--git-dir")) {
737 const char *gitdir
= getenv(GIT_DIR_ENVIRONMENT
);
738 static char cwd
[PATH_MAX
];
748 if (!getcwd(cwd
, PATH_MAX
))
749 die_errno("unable to get current working directory");
751 printf("%s%s.git\n", cwd
, len
&& cwd
[len
-1] != '/' ? "/" : "");
754 if (!strcmp(arg
, "--resolve-git-dir")) {
755 const char *gitdir
= argv
[++i
];
757 die("--resolve-git-dir requires an argument");
758 gitdir
= resolve_gitdir(gitdir
);
760 die("not a gitdir '%s'", argv
[i
]);
764 if (!strcmp(arg
, "--is-inside-git-dir")) {
765 printf("%s\n", is_inside_git_dir() ? "true"
769 if (!strcmp(arg
, "--is-inside-work-tree")) {
770 printf("%s\n", is_inside_work_tree() ? "true"
774 if (!strcmp(arg
, "--is-bare-repository")) {
775 printf("%s\n", is_bare_repository() ? "true"
779 if (!strcmp(arg
, "--shared-index-path")) {
780 if (read_cache() < 0)
781 die(_("Could not read the index"));
782 if (the_index
.split_index
) {
783 const unsigned char *sha1
= the_index
.split_index
->base_sha1
;
784 puts(git_path("sharedindex.%s", sha1_to_hex(sha1
)));
788 if (starts_with(arg
, "--since=")) {
789 show_datestring("--max-age=", arg
+8);
792 if (starts_with(arg
, "--after=")) {
793 show_datestring("--max-age=", arg
+8);
796 if (starts_with(arg
, "--before=")) {
797 show_datestring("--min-age=", arg
+9);
800 if (starts_with(arg
, "--until=")) {
801 show_datestring("--min-age=", arg
+8);
804 if (show_flag(arg
) && verify
)
805 die_no_single_rev(quiet
);
809 /* Not a flag argument */
810 if (try_difference(arg
))
812 if (try_parent_shorthands(arg
))
820 if (!get_sha1(name
, sha1
)) {
824 show_rev(type
, sha1
, name
);
828 die_no_single_rev(quiet
);
830 die("bad revision '%s'", arg
);
832 if (!show_file(arg
, output_prefix
))
834 verify_filename(prefix
, arg
, 1);
837 if (revs_count
== 1) {
838 show_rev(type
, sha1
, name
);
840 } else if (revs_count
== 0 && show_default())
842 die_no_single_rev(quiet
);