4 * Copyright (C) Linus Torvalds, 2005
11 #include "parse-options.h"
17 static int filter
= ~0;
19 static const char *def
;
23 static int show_type
= NORMAL
;
25 #define SHOW_SYMBOLIC_ASIS 1
26 #define SHOW_SYMBOLIC_FULL 2
29 static int abbrev_ref
;
30 static int abbrev_ref_strict
;
34 * Some arguments are relevant "revision" arguments,
35 * others are about output format or other details.
36 * This sorts it all out.
38 static int is_rev_argument(const char *arg
)
40 static const char *rev_args
[] = {
71 const char **p
= rev_args
;
73 /* accept -<digit>, like traditional "head" */
74 if ((*arg
== '-') && isdigit(arg
[1]))
78 const char *str
= *p
++;
83 if (!strcmp(arg
, str
) ||
84 (str
[len
-1] == '=' && !strncmp(arg
, str
, len
)))
89 /* Output argument as a string, either SQ or normal */
90 static void show(const char *arg
)
96 while ((ch
= *arg
++)) {
98 fputs("'\\'", stdout
);
108 /* Like show(), but with a negation prefix according to type */
109 static void show_with_type(int type
, const char *arg
)
111 if (type
!= show_type
)
116 /* Output a revision, only if filter allows it */
117 static void show_rev(int type
, const unsigned char *sha1
, const char *name
)
119 if (!(filter
& DO_REVS
))
123 if ((symbolic
|| abbrev_ref
) && name
) {
124 if (symbolic
== SHOW_SYMBOLIC_FULL
|| abbrev_ref
) {
125 unsigned char discard
[20];
128 switch (dwim_ref(name
, strlen(name
), discard
, &full
)) {
131 * Not found -- not a ref. We could
132 * emit "name" here, but symbolic-full
133 * users are interested in finding the
134 * refs spelled in full, and they would
135 * need to filter non-refs if we did so.
140 full
= shorten_unambiguous_ref(full
,
142 show_with_type(type
, full
);
144 default: /* ambiguous */
145 error("refname '%s' is ambiguous", name
);
149 show_with_type(type
, name
);
153 show_with_type(type
, find_unique_abbrev(sha1
, abbrev
));
155 show_with_type(type
, sha1_to_hex(sha1
));
158 /* Output a flag, only if filter allows it. */
159 static int show_flag(const char *arg
)
161 if (!(filter
& DO_FLAGS
))
163 if (filter
& (is_rev_argument(arg
) ? DO_REVS
: DO_NOREV
)) {
170 static int show_default(void)
175 unsigned char sha1
[20];
178 if (!get_sha1(s
, sha1
)) {
179 show_rev(NORMAL
, sha1
, s
);
186 static int show_reference(const char *refname
, const unsigned char *sha1
, int flag
, void *cb_data
)
188 show_rev(NORMAL
, sha1
, refname
);
192 static int anti_reference(const char *refname
, const unsigned char *sha1
, int flag
, void *cb_data
)
194 show_rev(REVERSED
, sha1
, refname
);
198 static int show_abbrev(const unsigned char *sha1
, void *cb_data
)
200 show_rev(NORMAL
, sha1
, NULL
);
204 static void show_datestring(const char *flag
, const char *datestr
)
206 static char buffer
[100];
208 /* date handling requires both flags and revs */
209 if ((filter
& (DO_FLAGS
| DO_REVS
)) != (DO_FLAGS
| DO_REVS
))
211 snprintf(buffer
, sizeof(buffer
), "%s%lu", flag
, approxidate(datestr
));
215 static int show_file(const char *arg
, int output_prefix
)
218 if ((filter
& (DO_NONFLAGS
|DO_NOREV
)) == (DO_NONFLAGS
|DO_NOREV
)) {
220 const char *prefix
= startup_info
->prefix
;
221 show(prefix_filename(prefix
,
222 prefix
? strlen(prefix
) : 0,
231 static int try_difference(const char *arg
)
234 unsigned char sha1
[20];
235 unsigned char end
[20];
239 static const char head_by_default
[] = "HEAD";
241 if (!(dotdot
= strstr(arg
, "..")))
245 symmetric
= (*next
== '.');
251 next
= head_by_default
;
253 this = head_by_default
;
255 if (this == head_by_default
&& next
== head_by_default
&&
258 * Just ".."? That is not a range but the
259 * pathspec for the parent directory.
265 if (!get_sha1_committish(this, sha1
) && !get_sha1_committish(next
, end
)) {
266 show_rev(NORMAL
, end
, next
);
267 show_rev(symmetric
? NORMAL
: REVERSED
, sha1
, this);
269 struct commit_list
*exclude
;
270 struct commit
*a
, *b
;
271 a
= lookup_commit_reference(sha1
);
272 b
= lookup_commit_reference(end
);
273 exclude
= get_merge_bases(a
, b
, 1);
275 struct commit_list
*n
= exclude
->next
;
277 exclude
->item
->object
.sha1
,NULL
);
288 static int try_parent_shorthands(const char *arg
)
291 unsigned char sha1
[20];
292 struct commit
*commit
;
293 struct commit_list
*parents
;
296 if ((dotdot
= strstr(arg
, "^!")))
298 else if ((dotdot
= strstr(arg
, "^@")))
301 if (!dotdot
|| dotdot
[2])
305 if (get_sha1_committish(arg
, sha1
))
309 show_rev(NORMAL
, sha1
, arg
);
310 commit
= lookup_commit_reference(sha1
);
311 for (parents
= commit
->parents
; parents
; parents
= parents
->next
)
312 show_rev(parents_only
? NORMAL
: REVERSED
,
313 parents
->item
->object
.sha1
, arg
);
318 static int parseopt_dump(const struct option
*o
, const char *arg
, int unset
)
320 struct strbuf
*parsed
= o
->value
;
322 strbuf_addf(parsed
, " --no-%s", o
->long_name
);
323 else if (o
->short_name
)
324 strbuf_addf(parsed
, " -%c", o
->short_name
);
326 strbuf_addf(parsed
, " --%s", o
->long_name
);
328 strbuf_addch(parsed
, ' ');
329 sq_quote_buf(parsed
, arg
);
334 static const char *skipspaces(const char *s
)
341 static int cmd_parseopt(int argc
, const char **argv
, const char *prefix
)
343 static int keep_dashdash
= 0, stop_at_non_option
= 0;
344 static char const * const parseopt_usage
[] = {
345 N_("git rev-parse --parseopt [options] -- [<args>...]"),
348 static struct option parseopt_opts
[] = {
349 OPT_BOOLEAN(0, "keep-dashdash", &keep_dashdash
,
350 N_("keep the `--` passed as an arg")),
351 OPT_BOOLEAN(0, "stop-at-non-option", &stop_at_non_option
,
352 N_("stop parsing after the "
353 "first non-option argument")),
357 struct strbuf sb
= STRBUF_INIT
, parsed
= STRBUF_INIT
;
358 const char **usage
= NULL
;
359 struct option
*opts
= NULL
;
360 int onb
= 0, osz
= 0, unb
= 0, usz
= 0;
362 strbuf_addstr(&parsed
, "set --");
363 argc
= parse_options(argc
, argv
, prefix
, parseopt_opts
, parseopt_usage
,
364 PARSE_OPT_KEEP_DASHDASH
);
365 if (argc
< 1 || strcmp(argv
[0], "--"))
366 usage_with_options(parseopt_usage
, parseopt_opts
);
368 /* get the usage up to the first line with a -- on it */
370 if (strbuf_getline(&sb
, stdin
, '\n') == EOF
)
371 die("premature end of input");
372 ALLOC_GROW(usage
, unb
+ 1, usz
);
373 if (!strcmp("--", sb
.buf
)) {
375 die("no usage string given before the `--' separator");
379 usage
[unb
++] = strbuf_detach(&sb
, NULL
);
382 /* parse: (<short>|<short>,<long>|<long>)[=?]? SP+ <help> */
383 while (strbuf_getline(&sb
, stdin
, '\n') != EOF
) {
390 ALLOC_GROW(opts
, onb
+ 1, osz
);
391 memset(opts
+ onb
, 0, sizeof(opts
[onb
]));
394 s
= strchr(sb
.buf
, ' ');
395 if (!s
|| *sb
.buf
== ' ') {
396 o
->type
= OPTION_GROUP
;
397 o
->help
= xstrdup(skipspaces(sb
.buf
));
401 o
->type
= OPTION_CALLBACK
;
402 o
->help
= xstrdup(skipspaces(s
));
404 o
->flags
= PARSE_OPT_NOARG
;
405 o
->callback
= &parseopt_dump
;
406 while (s
> sb
.buf
&& strchr("*=?!", s
[-1])) {
409 o
->flags
&= ~PARSE_OPT_NOARG
;
412 o
->flags
&= ~PARSE_OPT_NOARG
;
413 o
->flags
|= PARSE_OPT_OPTARG
;
416 o
->flags
|= PARSE_OPT_NONEG
;
419 o
->flags
|= PARSE_OPT_HIDDEN
;
424 if (s
- sb
.buf
== 1) /* short option only */
425 o
->short_name
= *sb
.buf
;
426 else if (sb
.buf
[1] != ',') /* long option only */
427 o
->long_name
= xmemdupz(sb
.buf
, s
- sb
.buf
);
429 o
->short_name
= *sb
.buf
;
430 o
->long_name
= xmemdupz(sb
.buf
+ 2, s
- sb
.buf
- 2);
435 /* put an OPT_END() */
436 ALLOC_GROW(opts
, onb
+ 1, osz
);
437 memset(opts
+ onb
, 0, sizeof(opts
[onb
]));
438 argc
= parse_options(argc
, argv
, prefix
, opts
, usage
,
439 (keep_dashdash
? PARSE_OPT_KEEP_DASHDASH
: 0) |
440 (stop_at_non_option
? PARSE_OPT_STOP_AT_NON_OPTION
: 0) |
441 PARSE_OPT_SHELL_EVAL
);
443 strbuf_addf(&parsed
, " --");
444 sq_quote_argv(&parsed
, argv
, 0);
449 static int cmd_sq_quote(int argc
, const char **argv
)
451 struct strbuf buf
= STRBUF_INIT
;
454 sq_quote_argv(&buf
, argv
, 0);
455 printf("%s\n", buf
.buf
);
456 strbuf_release(&buf
);
461 static void die_no_single_rev(int quiet
)
466 die("Needed a single revision");
469 static const char builtin_rev_parse_usage
[] =
470 N_("git rev-parse --parseopt [options] -- [<args>...]\n"
471 " or: git rev-parse --sq-quote [<arg>...]\n"
472 " or: git rev-parse [options] [<arg>...]\n"
474 "Run \"git rev-parse --parseopt -h\" for more information on the first usage.");
476 int cmd_rev_parse(int argc
, const char **argv
, const char *prefix
)
478 int i
, as_is
= 0, verify
= 0, quiet
= 0, revs_count
= 0, type
= 0;
479 int output_prefix
= 0;
480 unsigned char sha1
[20];
481 const char *name
= NULL
;
483 if (argc
> 1 && !strcmp("--parseopt", argv
[1]))
484 return cmd_parseopt(argc
- 1, argv
+ 1, prefix
);
486 if (argc
> 1 && !strcmp("--sq-quote", argv
[1]))
487 return cmd_sq_quote(argc
- 2, argv
+ 2);
489 if (argc
> 1 && !strcmp("-h", argv
[1]))
490 usage(builtin_rev_parse_usage
);
492 prefix
= setup_git_directory();
493 git_config(git_default_config
, NULL
);
494 for (i
= 1; i
< argc
; i
++) {
495 const char *arg
= argv
[i
];
498 if (show_file(arg
, output_prefix
) && as_is
< 2)
499 verify_filename(prefix
, arg
, 0);
502 if (!strcmp(arg
,"-n")) {
504 die("-n requires an argument");
505 if ((filter
& DO_FLAGS
) && (filter
& DO_REVS
)) {
511 if (!prefixcmp(arg
, "-n")) {
512 if ((filter
& DO_FLAGS
) && (filter
& DO_REVS
))
518 if (!strcmp(arg
, "--")) {
520 /* Pass on the "--" if we show anything but files.. */
521 if (filter
& (DO_FLAGS
| DO_REVS
))
525 if (!strcmp(arg
, "--default")) {
530 if (!strcmp(arg
, "--prefix")) {
532 startup_info
->prefix
= prefix
;
537 if (!strcmp(arg
, "--revs-only")) {
541 if (!strcmp(arg
, "--no-revs")) {
545 if (!strcmp(arg
, "--flags")) {
546 filter
&= ~DO_NONFLAGS
;
549 if (!strcmp(arg
, "--no-flags")) {
553 if (!strcmp(arg
, "--verify")) {
554 filter
&= ~(DO_FLAGS
|DO_NOREV
);
558 if (!strcmp(arg
, "--quiet") || !strcmp(arg
, "-q")) {
562 if (!strcmp(arg
, "--short") ||
563 !prefixcmp(arg
, "--short=")) {
564 filter
&= ~(DO_FLAGS
|DO_NOREV
);
566 abbrev
= DEFAULT_ABBREV
;
568 abbrev
= strtoul(arg
+ 8, NULL
, 10);
569 if (abbrev
< MINIMUM_ABBREV
)
570 abbrev
= MINIMUM_ABBREV
;
571 else if (40 <= abbrev
)
575 if (!strcmp(arg
, "--sq")) {
579 if (!strcmp(arg
, "--not")) {
580 show_type
^= REVERSED
;
583 if (!strcmp(arg
, "--symbolic")) {
584 symbolic
= SHOW_SYMBOLIC_ASIS
;
587 if (!strcmp(arg
, "--symbolic-full-name")) {
588 symbolic
= SHOW_SYMBOLIC_FULL
;
591 if (!prefixcmp(arg
, "--abbrev-ref") &&
592 (!arg
[12] || arg
[12] == '=')) {
594 abbrev_ref_strict
= warn_ambiguous_refs
;
595 if (arg
[12] == '=') {
596 if (!strcmp(arg
+ 13, "strict"))
597 abbrev_ref_strict
= 1;
598 else if (!strcmp(arg
+ 13, "loose"))
599 abbrev_ref_strict
= 0;
601 die("unknown mode for %s", arg
);
605 if (!strcmp(arg
, "--all")) {
606 for_each_ref(show_reference
, NULL
);
609 if (!prefixcmp(arg
, "--disambiguate=")) {
610 for_each_abbrev(arg
+ 15, show_abbrev
, NULL
);
613 if (!strcmp(arg
, "--bisect")) {
614 for_each_ref_in("refs/bisect/bad", show_reference
, NULL
);
615 for_each_ref_in("refs/bisect/good", anti_reference
, NULL
);
618 if (!prefixcmp(arg
, "--branches=")) {
619 for_each_glob_ref_in(show_reference
, arg
+ 11,
620 "refs/heads/", NULL
);
623 if (!strcmp(arg
, "--branches")) {
624 for_each_branch_ref(show_reference
, NULL
);
627 if (!prefixcmp(arg
, "--tags=")) {
628 for_each_glob_ref_in(show_reference
, arg
+ 7,
632 if (!strcmp(arg
, "--tags")) {
633 for_each_tag_ref(show_reference
, NULL
);
636 if (!prefixcmp(arg
, "--glob=")) {
637 for_each_glob_ref(show_reference
, arg
+ 7, NULL
);
640 if (!prefixcmp(arg
, "--remotes=")) {
641 for_each_glob_ref_in(show_reference
, arg
+ 10,
642 "refs/remotes/", NULL
);
645 if (!strcmp(arg
, "--remotes")) {
646 for_each_remote_ref(show_reference
, NULL
);
649 if (!strcmp(arg
, "--local-env-vars")) {
651 for (i
= 0; local_repo_env
[i
]; i
++)
652 printf("%s\n", local_repo_env
[i
]);
655 if (!strcmp(arg
, "--show-toplevel")) {
656 const char *work_tree
= get_git_work_tree();
661 if (!strcmp(arg
, "--show-prefix")) {
668 if (!strcmp(arg
, "--show-cdup")) {
669 const char *pfx
= prefix
;
670 if (!is_inside_work_tree()) {
671 const char *work_tree
=
674 printf("%s\n", work_tree
);
678 pfx
= strchr(pfx
, '/');
687 if (!strcmp(arg
, "--git-dir")) {
688 const char *gitdir
= getenv(GIT_DIR_ENVIRONMENT
);
689 static char cwd
[PATH_MAX
];
699 if (!getcwd(cwd
, PATH_MAX
))
700 die_errno("unable to get current working directory");
702 printf("%s%s.git\n", cwd
, len
&& cwd
[len
-1] != '/' ? "/" : "");
705 if (!strcmp(arg
, "--resolve-git-dir")) {
706 const char *gitdir
= resolve_gitdir(argv
[i
+1]);
708 die("not a gitdir '%s'", argv
[i
+1]);
712 if (!strcmp(arg
, "--is-inside-git-dir")) {
713 printf("%s\n", is_inside_git_dir() ? "true"
717 if (!strcmp(arg
, "--is-inside-work-tree")) {
718 printf("%s\n", is_inside_work_tree() ? "true"
722 if (!strcmp(arg
, "--is-bare-repository")) {
723 printf("%s\n", is_bare_repository() ? "true"
727 if (!prefixcmp(arg
, "--since=")) {
728 show_datestring("--max-age=", arg
+8);
731 if (!prefixcmp(arg
, "--after=")) {
732 show_datestring("--max-age=", arg
+8);
735 if (!prefixcmp(arg
, "--before=")) {
736 show_datestring("--min-age=", arg
+9);
739 if (!prefixcmp(arg
, "--until=")) {
740 show_datestring("--min-age=", arg
+8);
743 if (show_flag(arg
) && verify
)
744 die_no_single_rev(quiet
);
748 /* Not a flag argument */
749 if (try_difference(arg
))
751 if (try_parent_shorthands(arg
))
759 if (!get_sha1(name
, sha1
)) {
763 show_rev(type
, sha1
, name
);
767 die_no_single_rev(quiet
);
769 if (!show_file(arg
, output_prefix
))
771 verify_filename(prefix
, arg
, 1);
774 if (revs_count
== 1) {
775 show_rev(type
, sha1
, name
);
777 } else if (revs_count
== 0 && show_default())
779 die_no_single_rev(quiet
);