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 unsigned char *sha1
, int flag
, void *cb_data
)
195 if (ref_excluded(ref_excludes
, refname
))
197 show_rev(NORMAL
, sha1
, refname
);
201 static int anti_reference(const char *refname
, const unsigned char *sha1
, int flag
, void *cb_data
)
203 show_rev(REVERSED
, sha1
, 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
, 1);
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")),
375 struct strbuf sb
= STRBUF_INIT
, parsed
= STRBUF_INIT
;
376 const char **usage
= NULL
;
377 struct option
*opts
= NULL
;
378 int onb
= 0, osz
= 0, unb
= 0, usz
= 0;
380 strbuf_addstr(&parsed
, "set --");
381 argc
= parse_options(argc
, argv
, prefix
, parseopt_opts
, parseopt_usage
,
382 PARSE_OPT_KEEP_DASHDASH
);
383 if (argc
< 1 || strcmp(argv
[0], "--"))
384 usage_with_options(parseopt_usage
, parseopt_opts
);
386 /* get the usage up to the first line with a -- on it */
388 if (strbuf_getline(&sb
, stdin
, '\n') == EOF
)
389 die("premature end of input");
390 ALLOC_GROW(usage
, unb
+ 1, usz
);
391 if (!strcmp("--", sb
.buf
)) {
393 die("no usage string given before the `--' separator");
397 usage
[unb
++] = strbuf_detach(&sb
, NULL
);
400 /* parse: (<short>|<short>,<long>|<long>)[*=?!]*<arghint>? SP+ <help> */
401 while (strbuf_getline(&sb
, stdin
, '\n') != EOF
) {
409 ALLOC_GROW(opts
, onb
+ 1, osz
);
410 memset(opts
+ onb
, 0, sizeof(opts
[onb
]));
413 s
= strchr(sb
.buf
, ' ');
414 if (!s
|| *sb
.buf
== ' ') {
415 o
->type
= OPTION_GROUP
;
416 o
->help
= xstrdup(skipspaces(sb
.buf
));
420 o
->type
= OPTION_CALLBACK
;
421 o
->help
= xstrdup(skipspaces(s
));
423 o
->flags
= PARSE_OPT_NOARG
;
424 o
->callback
= &parseopt_dump
;
426 /* Possible argument name hint */
428 while (s
> sb
.buf
&& strchr("*=?!", s
[-1]) == NULL
)
430 if (s
!= sb
.buf
&& s
!= end
)
431 o
->argh
= xmemdupz(s
, end
- s
);
435 while (s
> sb
.buf
&& strchr("*=?!", s
[-1])) {
438 o
->flags
&= ~PARSE_OPT_NOARG
;
441 o
->flags
&= ~PARSE_OPT_NOARG
;
442 o
->flags
|= PARSE_OPT_OPTARG
;
445 o
->flags
|= PARSE_OPT_NONEG
;
448 o
->flags
|= PARSE_OPT_HIDDEN
;
453 if (s
- sb
.buf
== 1) /* short option only */
454 o
->short_name
= *sb
.buf
;
455 else if (sb
.buf
[1] != ',') /* long option only */
456 o
->long_name
= xmemdupz(sb
.buf
, s
- sb
.buf
);
458 o
->short_name
= *sb
.buf
;
459 o
->long_name
= xmemdupz(sb
.buf
+ 2, s
- sb
.buf
- 2);
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_addf(&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 has_dashdash
= 0;
509 int output_prefix
= 0;
510 unsigned char sha1
[20];
511 const char *name
= NULL
;
513 if (argc
> 1 && !strcmp("--parseopt", argv
[1]))
514 return cmd_parseopt(argc
- 1, argv
+ 1, prefix
);
516 if (argc
> 1 && !strcmp("--sq-quote", argv
[1]))
517 return cmd_sq_quote(argc
- 2, argv
+ 2);
519 if (argc
> 1 && !strcmp("-h", argv
[1]))
520 usage(builtin_rev_parse_usage
);
522 for (i
= 1; i
< argc
; i
++) {
523 if (!strcmp(argv
[i
], "--")) {
529 prefix
= setup_git_directory();
530 git_config(git_default_config
, NULL
);
531 for (i
= 1; i
< argc
; i
++) {
532 const char *arg
= argv
[i
];
535 if (show_file(arg
, output_prefix
) && as_is
< 2)
536 verify_filename(prefix
, arg
, 0);
539 if (!strcmp(arg
,"-n")) {
541 die("-n requires an argument");
542 if ((filter
& DO_FLAGS
) && (filter
& DO_REVS
)) {
548 if (starts_with(arg
, "-n")) {
549 if ((filter
& DO_FLAGS
) && (filter
& DO_REVS
))
555 if (!strcmp(arg
, "--")) {
557 /* Pass on the "--" if we show anything but files.. */
558 if (filter
& (DO_FLAGS
| DO_REVS
))
562 if (!strcmp(arg
, "--default")) {
565 die("--default requires an argument");
568 if (!strcmp(arg
, "--prefix")) {
571 die("--prefix requires an argument");
572 startup_info
->prefix
= prefix
;
576 if (!strcmp(arg
, "--revs-only")) {
580 if (!strcmp(arg
, "--no-revs")) {
584 if (!strcmp(arg
, "--flags")) {
585 filter
&= ~DO_NONFLAGS
;
588 if (!strcmp(arg
, "--no-flags")) {
592 if (!strcmp(arg
, "--verify")) {
593 filter
&= ~(DO_FLAGS
|DO_NOREV
);
597 if (!strcmp(arg
, "--quiet") || !strcmp(arg
, "-q")) {
601 if (!strcmp(arg
, "--short") ||
602 starts_with(arg
, "--short=")) {
603 filter
&= ~(DO_FLAGS
|DO_NOREV
);
605 abbrev
= DEFAULT_ABBREV
;
607 abbrev
= strtoul(arg
+ 8, NULL
, 10);
608 if (abbrev
< MINIMUM_ABBREV
)
609 abbrev
= MINIMUM_ABBREV
;
610 else if (40 <= abbrev
)
614 if (!strcmp(arg
, "--sq")) {
618 if (!strcmp(arg
, "--not")) {
619 show_type
^= REVERSED
;
622 if (!strcmp(arg
, "--symbolic")) {
623 symbolic
= SHOW_SYMBOLIC_ASIS
;
626 if (!strcmp(arg
, "--symbolic-full-name")) {
627 symbolic
= SHOW_SYMBOLIC_FULL
;
630 if (starts_with(arg
, "--abbrev-ref") &&
631 (!arg
[12] || arg
[12] == '=')) {
633 abbrev_ref_strict
= warn_ambiguous_refs
;
634 if (arg
[12] == '=') {
635 if (!strcmp(arg
+ 13, "strict"))
636 abbrev_ref_strict
= 1;
637 else if (!strcmp(arg
+ 13, "loose"))
638 abbrev_ref_strict
= 0;
640 die("unknown mode for %s", arg
);
644 if (!strcmp(arg
, "--all")) {
645 for_each_ref(show_reference
, NULL
);
648 if (starts_with(arg
, "--disambiguate=")) {
649 for_each_abbrev(arg
+ 15, show_abbrev
, NULL
);
652 if (!strcmp(arg
, "--bisect")) {
653 for_each_ref_in("refs/bisect/bad", show_reference
, NULL
);
654 for_each_ref_in("refs/bisect/good", anti_reference
, NULL
);
657 if (starts_with(arg
, "--branches=")) {
658 for_each_glob_ref_in(show_reference
, arg
+ 11,
659 "refs/heads/", NULL
);
660 clear_ref_exclusion(&ref_excludes
);
663 if (!strcmp(arg
, "--branches")) {
664 for_each_branch_ref(show_reference
, NULL
);
665 clear_ref_exclusion(&ref_excludes
);
668 if (starts_with(arg
, "--tags=")) {
669 for_each_glob_ref_in(show_reference
, arg
+ 7,
671 clear_ref_exclusion(&ref_excludes
);
674 if (!strcmp(arg
, "--tags")) {
675 for_each_tag_ref(show_reference
, NULL
);
676 clear_ref_exclusion(&ref_excludes
);
679 if (starts_with(arg
, "--glob=")) {
680 for_each_glob_ref(show_reference
, arg
+ 7, NULL
);
681 clear_ref_exclusion(&ref_excludes
);
684 if (starts_with(arg
, "--remotes=")) {
685 for_each_glob_ref_in(show_reference
, arg
+ 10,
686 "refs/remotes/", NULL
);
687 clear_ref_exclusion(&ref_excludes
);
690 if (!strcmp(arg
, "--remotes")) {
691 for_each_remote_ref(show_reference
, NULL
);
692 clear_ref_exclusion(&ref_excludes
);
695 if (starts_with(arg
, "--exclude=")) {
696 add_ref_exclusion(&ref_excludes
, arg
+ 10);
699 if (!strcmp(arg
, "--local-env-vars")) {
701 for (i
= 0; local_repo_env
[i
]; i
++)
702 printf("%s\n", local_repo_env
[i
]);
705 if (!strcmp(arg
, "--show-toplevel")) {
706 const char *work_tree
= get_git_work_tree();
711 if (!strcmp(arg
, "--show-prefix")) {
718 if (!strcmp(arg
, "--show-cdup")) {
719 const char *pfx
= prefix
;
720 if (!is_inside_work_tree()) {
721 const char *work_tree
=
724 printf("%s\n", work_tree
);
728 pfx
= strchr(pfx
, '/');
737 if (!strcmp(arg
, "--git-dir")) {
738 const char *gitdir
= getenv(GIT_DIR_ENVIRONMENT
);
739 static char cwd
[PATH_MAX
];
749 if (!getcwd(cwd
, PATH_MAX
))
750 die_errno("unable to get current working directory");
752 printf("%s%s.git\n", cwd
, len
&& cwd
[len
-1] != '/' ? "/" : "");
755 if (!strcmp(arg
, "--resolve-git-dir")) {
756 const char *gitdir
= argv
[++i
];
758 die("--resolve-git-dir requires an argument");
759 gitdir
= resolve_gitdir(gitdir
);
761 die("not a gitdir '%s'", argv
[i
]);
765 if (!strcmp(arg
, "--is-inside-git-dir")) {
766 printf("%s\n", is_inside_git_dir() ? "true"
770 if (!strcmp(arg
, "--is-inside-work-tree")) {
771 printf("%s\n", is_inside_work_tree() ? "true"
775 if (!strcmp(arg
, "--is-bare-repository")) {
776 printf("%s\n", is_bare_repository() ? "true"
780 if (!strcmp(arg
, "--shared-index-path")) {
781 if (read_cache() < 0)
782 die(_("Could not read the index"));
783 if (the_index
.split_index
) {
784 const unsigned char *sha1
= the_index
.split_index
->base_sha1
;
785 puts(git_path("sharedindex.%s", sha1_to_hex(sha1
)));
789 if (starts_with(arg
, "--since=")) {
790 show_datestring("--max-age=", arg
+8);
793 if (starts_with(arg
, "--after=")) {
794 show_datestring("--max-age=", arg
+8);
797 if (starts_with(arg
, "--before=")) {
798 show_datestring("--min-age=", arg
+9);
801 if (starts_with(arg
, "--until=")) {
802 show_datestring("--min-age=", arg
+8);
805 if (show_flag(arg
) && verify
)
806 die_no_single_rev(quiet
);
810 /* Not a flag argument */
811 if (try_difference(arg
))
813 if (try_parent_shorthands(arg
))
821 if (!get_sha1(name
, sha1
)) {
825 show_rev(type
, sha1
, name
);
829 die_no_single_rev(quiet
);
831 die("bad revision '%s'", arg
);
833 if (!show_file(arg
, output_prefix
))
835 verify_filename(prefix
, arg
, 1);
838 if (revs_count
== 1) {
839 show_rev(type
, sha1
, name
);
841 } else if (revs_count
== 0 && show_default())
843 die_no_single_rev(quiet
);