4 * Copyright (C) Linus Torvalds, 2005
11 #include "parse-options.h"
19 static int filter
= ~0;
21 static const char *def
;
25 static int show_type
= NORMAL
;
27 #define SHOW_SYMBOLIC_ASIS 1
28 #define SHOW_SYMBOLIC_FULL 2
31 static int abbrev_ref
;
32 static int abbrev_ref_strict
;
35 static int stuck_long
;
36 static struct string_list
*ref_excludes
;
39 * Some arguments are relevant "revision" arguments,
40 * others are about output format or other details.
41 * This sorts it all out.
43 static int is_rev_argument(const char *arg
)
45 static const char *rev_args
[] = {
76 const char **p
= rev_args
;
78 /* accept -<digit>, like traditional "head" */
79 if ((*arg
== '-') && isdigit(arg
[1]))
83 const char *str
= *p
++;
88 if (!strcmp(arg
, str
) ||
89 (str
[len
-1] == '=' && !strncmp(arg
, str
, len
)))
94 /* Output argument as a string, either SQ or normal */
95 static void show(const char *arg
)
101 while ((ch
= *arg
++)) {
103 fputs("'\\'", stdout
);
113 /* Like show(), but with a negation prefix according to type */
114 static void show_with_type(int type
, const char *arg
)
116 if (type
!= show_type
)
121 /* Output a revision, only if filter allows it */
122 static void show_rev(int type
, const unsigned char *sha1
, const char *name
)
124 if (!(filter
& DO_REVS
))
128 if ((symbolic
|| abbrev_ref
) && name
) {
129 if (symbolic
== SHOW_SYMBOLIC_FULL
|| abbrev_ref
) {
130 unsigned char discard
[20];
133 switch (dwim_ref(name
, strlen(name
), discard
, &full
)) {
136 * Not found -- not a ref. We could
137 * emit "name" here, but symbolic-full
138 * users are interested in finding the
139 * refs spelled in full, and they would
140 * need to filter non-refs if we did so.
145 full
= shorten_unambiguous_ref(full
,
147 show_with_type(type
, full
);
149 default: /* ambiguous */
150 error("refname '%s' is ambiguous", name
);
154 show_with_type(type
, name
);
158 show_with_type(type
, find_unique_abbrev(sha1
, abbrev
));
160 show_with_type(type
, sha1_to_hex(sha1
));
163 /* Output a flag, only if filter allows it. */
164 static int show_flag(const char *arg
)
166 if (!(filter
& DO_FLAGS
))
168 if (filter
& (is_rev_argument(arg
) ? DO_REVS
: DO_NOREV
)) {
175 static int show_default(void)
180 unsigned char sha1
[20];
183 if (!get_sha1(s
, sha1
)) {
184 show_rev(NORMAL
, sha1
, s
);
191 static int show_reference(const char *refname
, const unsigned char *sha1
, int flag
, void *cb_data
)
193 if (ref_excluded(ref_excludes
, refname
))
195 show_rev(NORMAL
, sha1
, refname
);
199 static int anti_reference(const char *refname
, const unsigned char *sha1
, int flag
, void *cb_data
)
201 show_rev(REVERSED
, sha1
, refname
);
205 static int show_abbrev(const unsigned char *sha1
, void *cb_data
)
207 show_rev(NORMAL
, sha1
, NULL
);
211 static void show_datestring(const char *flag
, const char *datestr
)
213 static char buffer
[100];
215 /* date handling requires both flags and revs */
216 if ((filter
& (DO_FLAGS
| DO_REVS
)) != (DO_FLAGS
| DO_REVS
))
218 snprintf(buffer
, sizeof(buffer
), "%s%lu", flag
, approxidate(datestr
));
222 static int show_file(const char *arg
, int output_prefix
)
225 if ((filter
& (DO_NONFLAGS
|DO_NOREV
)) == (DO_NONFLAGS
|DO_NOREV
)) {
227 const char *prefix
= startup_info
->prefix
;
228 show(prefix_filename(prefix
,
229 prefix
? strlen(prefix
) : 0,
238 static int try_difference(const char *arg
)
241 unsigned char sha1
[20];
242 unsigned char end
[20];
246 static const char head_by_default
[] = "HEAD";
248 if (!(dotdot
= strstr(arg
, "..")))
252 symmetric
= (*next
== '.');
258 next
= head_by_default
;
260 this = head_by_default
;
262 if (this == head_by_default
&& next
== head_by_default
&&
265 * Just ".."? That is not a range but the
266 * pathspec for the parent directory.
272 if (!get_sha1_committish(this, sha1
) && !get_sha1_committish(next
, end
)) {
273 show_rev(NORMAL
, end
, next
);
274 show_rev(symmetric
? NORMAL
: REVERSED
, sha1
, this);
276 struct commit_list
*exclude
;
277 struct commit
*a
, *b
;
278 a
= lookup_commit_reference(sha1
);
279 b
= lookup_commit_reference(end
);
280 exclude
= get_merge_bases(a
, b
, 1);
282 struct commit_list
*n
= exclude
->next
;
284 exclude
->item
->object
.sha1
,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 if ((dotdot
= strstr(arg
, "^!")))
305 else if ((dotdot
= strstr(arg
, "^@")))
308 if (!dotdot
|| dotdot
[2])
312 if (get_sha1_committish(arg
, sha1
))
316 show_rev(NORMAL
, sha1
, arg
);
317 commit
= lookup_commit_reference(sha1
);
318 for (parents
= commit
->parents
; parents
; parents
= parents
->next
)
319 show_rev(parents_only
? NORMAL
: REVERSED
,
320 parents
->item
->object
.sha1
, arg
);
325 static int parseopt_dump(const struct option
*o
, const char *arg
, int unset
)
327 struct strbuf
*parsed
= o
->value
;
329 strbuf_addf(parsed
, " --no-%s", o
->long_name
);
330 else if (o
->short_name
&& (o
->long_name
== NULL
|| !stuck_long
))
331 strbuf_addf(parsed
, " -%c", o
->short_name
);
333 strbuf_addf(parsed
, " --%s", o
->long_name
);
336 strbuf_addch(parsed
, ' ');
337 else if (o
->long_name
)
338 strbuf_addch(parsed
, '=');
339 sq_quote_buf(parsed
, arg
);
344 static const char *skipspaces(const char *s
)
351 static int cmd_parseopt(int argc
, const char **argv
, const char *prefix
)
353 static int keep_dashdash
= 0, stop_at_non_option
= 0;
354 static char const * const parseopt_usage
[] = {
355 N_("git rev-parse --parseopt [options] -- [<args>...]"),
358 static struct option parseopt_opts
[] = {
359 OPT_BOOL(0, "keep-dashdash", &keep_dashdash
,
360 N_("keep the `--` passed as an arg")),
361 OPT_BOOL(0, "stop-at-non-option", &stop_at_non_option
,
362 N_("stop parsing after the "
363 "first non-option argument")),
364 OPT_BOOL(0, "stuck-long", &stuck_long
,
365 N_("output in stuck long form")),
369 struct strbuf sb
= STRBUF_INIT
, parsed
= STRBUF_INIT
;
370 const char **usage
= NULL
;
371 struct option
*opts
= NULL
;
372 int onb
= 0, osz
= 0, unb
= 0, usz
= 0;
374 strbuf_addstr(&parsed
, "set --");
375 argc
= parse_options(argc
, argv
, prefix
, parseopt_opts
, parseopt_usage
,
376 PARSE_OPT_KEEP_DASHDASH
);
377 if (argc
< 1 || strcmp(argv
[0], "--"))
378 usage_with_options(parseopt_usage
, parseopt_opts
);
380 /* get the usage up to the first line with a -- on it */
382 if (strbuf_getline(&sb
, stdin
, '\n') == EOF
)
383 die("premature end of input");
384 ALLOC_GROW(usage
, unb
+ 1, usz
);
385 if (!strcmp("--", sb
.buf
)) {
387 die("no usage string given before the `--' separator");
391 usage
[unb
++] = strbuf_detach(&sb
, NULL
);
394 /* parse: (<short>|<short>,<long>|<long>)[=?]? SP+ <help> */
395 while (strbuf_getline(&sb
, stdin
, '\n') != EOF
) {
402 ALLOC_GROW(opts
, onb
+ 1, osz
);
403 memset(opts
+ onb
, 0, sizeof(opts
[onb
]));
406 s
= strchr(sb
.buf
, ' ');
407 if (!s
|| *sb
.buf
== ' ') {
408 o
->type
= OPTION_GROUP
;
409 o
->help
= xstrdup(skipspaces(sb
.buf
));
413 o
->type
= OPTION_CALLBACK
;
414 o
->help
= xstrdup(skipspaces(s
));
416 o
->flags
= PARSE_OPT_NOARG
;
417 o
->callback
= &parseopt_dump
;
418 while (s
> sb
.buf
&& strchr("*=?!", s
[-1])) {
421 o
->flags
&= ~PARSE_OPT_NOARG
;
424 o
->flags
&= ~PARSE_OPT_NOARG
;
425 o
->flags
|= PARSE_OPT_OPTARG
;
428 o
->flags
|= PARSE_OPT_NONEG
;
431 o
->flags
|= PARSE_OPT_HIDDEN
;
436 if (s
- sb
.buf
== 1) /* short option only */
437 o
->short_name
= *sb
.buf
;
438 else if (sb
.buf
[1] != ',') /* long option only */
439 o
->long_name
= xmemdupz(sb
.buf
, s
- sb
.buf
);
441 o
->short_name
= *sb
.buf
;
442 o
->long_name
= xmemdupz(sb
.buf
+ 2, s
- sb
.buf
- 2);
447 /* put an OPT_END() */
448 ALLOC_GROW(opts
, onb
+ 1, osz
);
449 memset(opts
+ onb
, 0, sizeof(opts
[onb
]));
450 argc
= parse_options(argc
, argv
, prefix
, opts
, usage
,
451 (keep_dashdash
? PARSE_OPT_KEEP_DASHDASH
: 0) |
452 (stop_at_non_option
? PARSE_OPT_STOP_AT_NON_OPTION
: 0) |
453 PARSE_OPT_SHELL_EVAL
);
455 strbuf_addf(&parsed
, " --");
456 sq_quote_argv(&parsed
, argv
, 0);
461 static int cmd_sq_quote(int argc
, const char **argv
)
463 struct strbuf buf
= STRBUF_INIT
;
466 sq_quote_argv(&buf
, argv
, 0);
467 printf("%s\n", buf
.buf
);
468 strbuf_release(&buf
);
473 static void die_no_single_rev(int quiet
)
478 die("Needed a single revision");
481 static const char builtin_rev_parse_usage
[] =
482 N_("git rev-parse --parseopt [options] -- [<args>...]\n"
483 " or: git rev-parse --sq-quote [<arg>...]\n"
484 " or: git rev-parse [options] [<arg>...]\n"
486 "Run \"git rev-parse --parseopt -h\" for more information on the first usage.");
488 int cmd_rev_parse(int argc
, const char **argv
, const char *prefix
)
490 int i
, as_is
= 0, verify
= 0, quiet
= 0, revs_count
= 0, type
= 0;
491 int output_prefix
= 0;
492 unsigned char sha1
[20];
493 const char *name
= NULL
;
495 if (argc
> 1 && !strcmp("--parseopt", argv
[1]))
496 return cmd_parseopt(argc
- 1, argv
+ 1, prefix
);
498 if (argc
> 1 && !strcmp("--sq-quote", argv
[1]))
499 return cmd_sq_quote(argc
- 2, argv
+ 2);
501 if (argc
> 1 && !strcmp("-h", argv
[1]))
502 usage(builtin_rev_parse_usage
);
504 prefix
= setup_git_directory();
505 git_config(git_default_config
, NULL
);
506 for (i
= 1; i
< argc
; i
++) {
507 const char *arg
= argv
[i
];
510 if (show_file(arg
, output_prefix
) && as_is
< 2)
511 verify_filename(prefix
, arg
, 0);
514 if (!strcmp(arg
,"-n")) {
516 die("-n requires an argument");
517 if ((filter
& DO_FLAGS
) && (filter
& DO_REVS
)) {
523 if (!prefixcmp(arg
, "-n")) {
524 if ((filter
& DO_FLAGS
) && (filter
& DO_REVS
))
530 if (!strcmp(arg
, "--")) {
532 /* Pass on the "--" if we show anything but files.. */
533 if (filter
& (DO_FLAGS
| DO_REVS
))
537 if (!strcmp(arg
, "--default")) {
542 if (!strcmp(arg
, "--prefix")) {
544 startup_info
->prefix
= prefix
;
549 if (!strcmp(arg
, "--revs-only")) {
553 if (!strcmp(arg
, "--no-revs")) {
557 if (!strcmp(arg
, "--flags")) {
558 filter
&= ~DO_NONFLAGS
;
561 if (!strcmp(arg
, "--no-flags")) {
565 if (!strcmp(arg
, "--verify")) {
566 filter
&= ~(DO_FLAGS
|DO_NOREV
);
570 if (!strcmp(arg
, "--quiet") || !strcmp(arg
, "-q")) {
574 if (!strcmp(arg
, "--short") ||
575 !prefixcmp(arg
, "--short=")) {
576 filter
&= ~(DO_FLAGS
|DO_NOREV
);
578 abbrev
= DEFAULT_ABBREV
;
580 abbrev
= strtoul(arg
+ 8, NULL
, 10);
581 if (abbrev
< MINIMUM_ABBREV
)
582 abbrev
= MINIMUM_ABBREV
;
583 else if (40 <= abbrev
)
587 if (!strcmp(arg
, "--sq")) {
591 if (!strcmp(arg
, "--not")) {
592 show_type
^= REVERSED
;
595 if (!strcmp(arg
, "--symbolic")) {
596 symbolic
= SHOW_SYMBOLIC_ASIS
;
599 if (!strcmp(arg
, "--symbolic-full-name")) {
600 symbolic
= SHOW_SYMBOLIC_FULL
;
603 if (!prefixcmp(arg
, "--abbrev-ref") &&
604 (!arg
[12] || arg
[12] == '=')) {
606 abbrev_ref_strict
= warn_ambiguous_refs
;
607 if (arg
[12] == '=') {
608 if (!strcmp(arg
+ 13, "strict"))
609 abbrev_ref_strict
= 1;
610 else if (!strcmp(arg
+ 13, "loose"))
611 abbrev_ref_strict
= 0;
613 die("unknown mode for %s", arg
);
617 if (!strcmp(arg
, "--all")) {
618 for_each_ref(show_reference
, NULL
);
621 if (!prefixcmp(arg
, "--disambiguate=")) {
622 for_each_abbrev(arg
+ 15, show_abbrev
, NULL
);
625 if (!strcmp(arg
, "--bisect")) {
626 for_each_ref_in("refs/bisect/bad", show_reference
, NULL
);
627 for_each_ref_in("refs/bisect/good", anti_reference
, NULL
);
630 if (!prefixcmp(arg
, "--branches=")) {
631 for_each_glob_ref_in(show_reference
, arg
+ 11,
632 "refs/heads/", NULL
);
633 clear_ref_exclusion(&ref_excludes
);
636 if (!strcmp(arg
, "--branches")) {
637 for_each_branch_ref(show_reference
, NULL
);
638 clear_ref_exclusion(&ref_excludes
);
641 if (!prefixcmp(arg
, "--tags=")) {
642 for_each_glob_ref_in(show_reference
, arg
+ 7,
644 clear_ref_exclusion(&ref_excludes
);
647 if (!strcmp(arg
, "--tags")) {
648 for_each_tag_ref(show_reference
, NULL
);
649 clear_ref_exclusion(&ref_excludes
);
652 if (!prefixcmp(arg
, "--glob=")) {
653 for_each_glob_ref(show_reference
, arg
+ 7, NULL
);
654 clear_ref_exclusion(&ref_excludes
);
657 if (!prefixcmp(arg
, "--remotes=")) {
658 for_each_glob_ref_in(show_reference
, arg
+ 10,
659 "refs/remotes/", NULL
);
660 clear_ref_exclusion(&ref_excludes
);
663 if (!strcmp(arg
, "--remotes")) {
664 for_each_remote_ref(show_reference
, NULL
);
665 clear_ref_exclusion(&ref_excludes
);
668 if (!prefixcmp(arg
, "--exclude=")) {
669 add_ref_exclusion(&ref_excludes
, arg
+ 10);
672 if (!strcmp(arg
, "--local-env-vars")) {
674 for (i
= 0; local_repo_env
[i
]; i
++)
675 printf("%s\n", local_repo_env
[i
]);
678 if (!strcmp(arg
, "--show-toplevel")) {
679 const char *work_tree
= get_git_work_tree();
684 if (!strcmp(arg
, "--show-prefix")) {
691 if (!strcmp(arg
, "--show-cdup")) {
692 const char *pfx
= prefix
;
693 if (!is_inside_work_tree()) {
694 const char *work_tree
=
697 printf("%s\n", work_tree
);
701 pfx
= strchr(pfx
, '/');
710 if (!strcmp(arg
, "--git-dir")) {
711 const char *gitdir
= getenv(GIT_DIR_ENVIRONMENT
);
712 static char cwd
[PATH_MAX
];
722 if (!getcwd(cwd
, PATH_MAX
))
723 die_errno("unable to get current working directory");
725 printf("%s%s.git\n", cwd
, len
&& cwd
[len
-1] != '/' ? "/" : "");
728 if (!strcmp(arg
, "--resolve-git-dir")) {
729 const char *gitdir
= resolve_gitdir(argv
[i
+1]);
731 die("not a gitdir '%s'", argv
[i
+1]);
735 if (!strcmp(arg
, "--is-inside-git-dir")) {
736 printf("%s\n", is_inside_git_dir() ? "true"
740 if (!strcmp(arg
, "--is-inside-work-tree")) {
741 printf("%s\n", is_inside_work_tree() ? "true"
745 if (!strcmp(arg
, "--is-bare-repository")) {
746 printf("%s\n", is_bare_repository() ? "true"
750 if (!prefixcmp(arg
, "--since=")) {
751 show_datestring("--max-age=", arg
+8);
754 if (!prefixcmp(arg
, "--after=")) {
755 show_datestring("--max-age=", arg
+8);
758 if (!prefixcmp(arg
, "--before=")) {
759 show_datestring("--min-age=", arg
+9);
762 if (!prefixcmp(arg
, "--until=")) {
763 show_datestring("--min-age=", arg
+8);
766 if (show_flag(arg
) && verify
)
767 die_no_single_rev(quiet
);
771 /* Not a flag argument */
772 if (try_difference(arg
))
774 if (try_parent_shorthands(arg
))
782 if (!get_sha1(name
, sha1
)) {
786 show_rev(type
, sha1
, name
);
790 die_no_single_rev(quiet
);
792 if (!show_file(arg
, output_prefix
))
794 verify_filename(prefix
, arg
, 1);
797 if (revs_count
== 1) {
798 show_rev(type
, sha1
, name
);
800 } else if (revs_count
== 0 && show_default())
802 die_no_single_rev(quiet
);