1/*
2 * rev-parse.c
3 *
4 * Copyright (C) Linus Torvalds, 2005
5 */
6#include "cache.h"
7#include "commit.h"
8#include "refs.h"
9#include "quote.h"
10#include "builtin.h"
11#include "parse-options.h"
12#define DO_REVS 1
14#define DO_NOREV 2
15#define DO_FLAGS 4
16#define DO_NONFLAGS 8
17static int filter = ~0;
18static const char *def;
20#define NORMAL 0
22#define REVERSED 1
23static int show_type = NORMAL;
24#define SHOW_SYMBOLIC_ASIS 1
26#define SHOW_SYMBOLIC_FULL 2
27static int symbolic;
28static int abbrev;
29static int output_sq;
30static int revs_count;
32/*
34 * Some arguments are relevant "revision" arguments,
35 * others are about output format or other details.
36 * This sorts it all out.
37 */
38static int is_rev_argument(const char *arg)
39{
40 static const char *rev_args[] = {
41 "--all",
42 "--bisect",
43 "--dense",
44 "--branches",
45 "--header",
46 "--max-age=",
47 "--max-count=",
48 "--min-age=",
49 "--no-merges",
50 "--objects",
51 "--objects-edge",
52 "--parents",
53 "--pretty",
54 "--remotes",
55 "--sparse",
56 "--tags",
57 "--topo-order",
58 "--date-order",
59 "--unpacked",
60 NULL
61 };
62 const char **p = rev_args;
63 /* accept -<digit>, like traditional "head" */
65 if ((*arg == '-') && isdigit(arg[1]))
66 return 1;
67 for (;;) {
69 const char *str = *p++;
70 int len;
71 if (!str)
72 return 0;
73 len = strlen(str);
74 if (!strcmp(arg, str) ||
75 (str[len-1] == '=' && !strncmp(arg, str, len)))
76 return 1;
77 }
78}
79/* Output argument as a string, either SQ or normal */
81static void show(const char *arg)
82{
83 if (output_sq) {
84 int sq = '\'', ch;
85 putchar(sq);
87 while ((ch = *arg++)) {
88 if (ch == sq)
89 fputs("'\\'", stdout);
90 putchar(ch);
91 }
92 putchar(sq);
93 putchar(' ');
94 }
95 else
96 puts(arg);
97}
98/* Output a revision, only if filter allows it */
100static void show_rev(int type, const unsigned char *sha1, const char *name)
101{
102 if (!(filter & DO_REVS))
103 return;
104 def = NULL;
105 revs_count++;
106 if (type != show_type)
108 putchar('^');
109 if (symbolic && name) {
110 if (symbolic == SHOW_SYMBOLIC_FULL) {
111 unsigned char discard[20];
112 char *full;
113 switch (dwim_ref(name, strlen(name), discard, &full)) {
115 case 0:
116 /*
117 * Not found -- not a ref. We could
118 * emit "name" here, but symbolic-full
119 * users are interested in finding the
120 * refs spelled in full, and they would
121 * need to filter non-refs if we did so.
122 */
123 break;
124 case 1: /* happy */
125 show(full);
126 break;
127 default: /* ambiguous */
128 error("refname '%s' is ambiguous", name);
129 break;
130 }
131 } else {
132 show(name);
133 }
134 }
135 else if (abbrev)
136 show(find_unique_abbrev(sha1, abbrev));
137 else
138 show(sha1_to_hex(sha1));
139}
140/* Output a flag, only if filter allows it. */
142static int show_flag(const char *arg)
143{
144 if (!(filter & DO_FLAGS))
145 return 0;
146 if (filter & (is_rev_argument(arg) ? DO_REVS : DO_NOREV)) {
147 show(arg);
148 return 1;
149 }
150 return 0;
151}
152static void show_default(void)
154{
155 const char *s = def;
156 if (s) {
158 unsigned char sha1[20];
159 def = NULL;
161 if (!get_sha1(s, sha1)) {
162 show_rev(NORMAL, sha1, s);
163 return;
164 }
165 }
166}
167static int show_reference(const char *refname, const unsigned char *sha1, int flag, void *cb_data)
169{
170 show_rev(NORMAL, sha1, refname);
171 return 0;
172}
173static void show_datestring(const char *flag, const char *datestr)
175{
176 static char buffer[100];
177 /* date handling requires both flags and revs */
179 if ((filter & (DO_FLAGS | DO_REVS)) != (DO_FLAGS | DO_REVS))
180 return;
181 snprintf(buffer, sizeof(buffer), "%s%lu", flag, approxidate(datestr));
182 show(buffer);
183}
184static int show_file(const char *arg)
186{
187 show_default();
188 if ((filter & (DO_NONFLAGS|DO_NOREV)) == (DO_NONFLAGS|DO_NOREV)) {
189 show(arg);
190 return 1;
191 }
192 return 0;
193}
194static int try_difference(const char *arg)
196{
197 char *dotdot;
198 unsigned char sha1[20];
199 unsigned char end[20];
200 const char *next;
201 const char *this;
202 int symmetric;
203 if (!(dotdot = strstr(arg, "..")))
205 return 0;
206 next = dotdot + 2;
207 this = arg;
208 symmetric = (*next == '.');
209 *dotdot = 0;
211 next += symmetric;
212 if (!*next)
214 next = "HEAD";
215 if (dotdot == arg)
216 this = "HEAD";
217 if (!get_sha1(this, sha1) && !get_sha1(next, end)) {
218 show_rev(NORMAL, end, next);
219 show_rev(symmetric ? NORMAL : REVERSED, sha1, this);
220 if (symmetric) {
221 struct commit_list *exclude;
222 struct commit *a, *b;
223 a = lookup_commit_reference(sha1);
224 b = lookup_commit_reference(end);
225 exclude = get_merge_bases(a, b, 1);
226 while (exclude) {
227 struct commit_list *n = exclude->next;
228 show_rev(REVERSED,
229 exclude->item->object.sha1,NULL);
230 free(exclude);
231 exclude = n;
232 }
233 }
234 return 1;
235 }
236 *dotdot = '.';
237 return 0;
238}
239static int parseopt_dump(const struct option *o, const char *arg, int unset)
241{
242 struct strbuf *parsed = o->value;
243 if (unset)
244 strbuf_addf(parsed, " --no-%s", o->long_name);
245 else if (o->short_name)
246 strbuf_addf(parsed, " -%c", o->short_name);
247 else
248 strbuf_addf(parsed, " --%s", o->long_name);
249 if (arg) {
250 strbuf_addch(parsed, ' ');
251 sq_quote_buf(parsed, arg);
252 }
253 return 0;
254}
255static const char *skipspaces(const char *s)
257{
258 while (isspace(*s))
259 s++;
260 return s;
261}
262static int cmd_parseopt(int argc, const char **argv, const char *prefix)
264{
265 static int keep_dashdash = 0;
266 static char const * const parseopt_usage[] = {
267 "git-rev-parse --parseopt [options] -- [<args>...]",
268 NULL
269 };
270 static struct option parseopt_opts[] = {
271 OPT_BOOLEAN(0, "keep-dashdash", &keep_dashdash,
272 "keep the `--` passed as an arg"),
273 OPT_END(),
274 };
275 struct strbuf sb, parsed;
277 const char **usage = NULL;
278 struct option *opts = NULL;
279 int onb = 0, osz = 0, unb = 0, usz = 0;
280 strbuf_init(&parsed, 0);
282 strbuf_addstr(&parsed, "set --");
283 argc = parse_options(argc, argv, parseopt_opts, parseopt_usage,
284 PARSE_OPT_KEEP_DASHDASH);
285 if (argc < 1 || strcmp(argv[0], "--"))
286 usage_with_options(parseopt_usage, parseopt_opts);
287 strbuf_init(&sb, 0);
289 /* get the usage up to the first line with a -- on it */
290 for (;;) {
291 if (strbuf_getline(&sb, stdin, '\n') == EOF)
292 die("premature end of input");
293 ALLOC_GROW(usage, unb + 1, usz);
294 if (!strcmp("--", sb.buf)) {
295 if (unb < 1)
296 die("no usage string given before the `--' separator");
297 usage[unb] = NULL;
298 break;
299 }
300 usage[unb++] = strbuf_detach(&sb, NULL);
301 }
302 /* parse: (<short>|<short>,<long>|<long>)[=?]? SP+ <help> */
304 while (strbuf_getline(&sb, stdin, '\n') != EOF) {
305 const char *s;
306 struct option *o;
307 if (!sb.len)
309 continue;
310 ALLOC_GROW(opts, onb + 1, osz);
312 memset(opts + onb, 0, sizeof(opts[onb]));
313 o = &opts[onb++];
315 s = strchr(sb.buf, ' ');
316 if (!s || *sb.buf == ' ') {
317 o->type = OPTION_GROUP;
318 o->help = xstrdup(skipspaces(sb.buf));
319 continue;
320 }
321 o->type = OPTION_CALLBACK;
323 o->help = xstrdup(skipspaces(s));
324 o->value = &parsed;
325 o->flags = PARSE_OPT_NOARG;
326 o->callback = &parseopt_dump;
327 while (s > sb.buf && strchr("*=?!", s[-1])) {
328 switch (*--s) {
329 case '=':
330 o->flags &= ~PARSE_OPT_NOARG;
331 break;
332 case '?':
333 o->flags &= ~PARSE_OPT_NOARG;
334 o->flags |= PARSE_OPT_OPTARG;
335 break;
336 case '!':
337 o->flags |= PARSE_OPT_NONEG;
338 break;
339 case '*':
340 o->flags |= PARSE_OPT_HIDDEN;
341 break;
342 }
343 }
344 if (s - sb.buf == 1) /* short option only */
346 o->short_name = *sb.buf;
347 else if (sb.buf[1] != ',') /* long option only */
348 o->long_name = xmemdupz(sb.buf, s - sb.buf);
349 else {
350 o->short_name = *sb.buf;
351 o->long_name = xmemdupz(sb.buf + 2, s - sb.buf - 2);
352 }
353 }
354 strbuf_release(&sb);
355 /* put an OPT_END() */
357 ALLOC_GROW(opts, onb + 1, osz);
358 memset(opts + onb, 0, sizeof(opts[onb]));
359 argc = parse_options(argc, argv, opts, usage,
360 keep_dashdash ? PARSE_OPT_KEEP_DASHDASH : 0);
361 strbuf_addf(&parsed, " --");
363 sq_quote_argv(&parsed, argv, 0);
364 puts(parsed.buf);
365 return 0;
366}
367int cmd_rev_parse(int argc, const char **argv, const char *prefix)
369{
370 int i, as_is = 0, verify = 0;
371 unsigned char sha1[20];
372 if (argc > 1 && !strcmp("--parseopt", argv[1]))
374 return cmd_parseopt(argc - 1, argv + 1, prefix);
375 prefix = setup_git_directory();
377 git_config(git_default_config);
378 for (i = 1; i < argc; i++) {
379 const char *arg = argv[i];
380 if (as_is) {
382 if (show_file(arg) && as_is < 2)
383 verify_filename(prefix, arg);
384 continue;
385 }
386 if (!strcmp(arg,"-n")) {
387 if (++i >= argc)
388 die("-n requires an argument");
389 if ((filter & DO_FLAGS) && (filter & DO_REVS)) {
390 show(arg);
391 show(argv[i]);
392 }
393 continue;
394 }
395 if (!prefixcmp(arg, "-n")) {
396 if ((filter & DO_FLAGS) && (filter & DO_REVS))
397 show(arg);
398 continue;
399 }
400 if (*arg == '-') {
402 if (!strcmp(arg, "--")) {
403 as_is = 2;
404 /* Pass on the "--" if we show anything but files.. */
405 if (filter & (DO_FLAGS | DO_REVS))
406 show_file(arg);
407 continue;
408 }
409 if (!strcmp(arg, "--default")) {
410 def = argv[i+1];
411 i++;
412 continue;
413 }
414 if (!strcmp(arg, "--revs-only")) {
415 filter &= ~DO_NOREV;
416 continue;
417 }
418 if (!strcmp(arg, "--no-revs")) {
419 filter &= ~DO_REVS;
420 continue;
421 }
422 if (!strcmp(arg, "--flags")) {
423 filter &= ~DO_NONFLAGS;
424 continue;
425 }
426 if (!strcmp(arg, "--no-flags")) {
427 filter &= ~DO_FLAGS;
428 continue;
429 }
430 if (!strcmp(arg, "--verify")) {
431 filter &= ~(DO_FLAGS|DO_NOREV);
432 verify = 1;
433 continue;
434 }
435 if (!strcmp(arg, "--short") ||
436 !prefixcmp(arg, "--short=")) {
437 filter &= ~(DO_FLAGS|DO_NOREV);
438 verify = 1;
439 abbrev = DEFAULT_ABBREV;
440 if (arg[7] == '=')
441 abbrev = strtoul(arg + 8, NULL, 10);
442 if (abbrev < MINIMUM_ABBREV)
443 abbrev = MINIMUM_ABBREV;
444 else if (40 <= abbrev)
445 abbrev = 40;
446 continue;
447 }
448 if (!strcmp(arg, "--sq")) {
449 output_sq = 1;
450 continue;
451 }
452 if (!strcmp(arg, "--not")) {
453 show_type ^= REVERSED;
454 continue;
455 }
456 if (!strcmp(arg, "--symbolic")) {
457 symbolic = SHOW_SYMBOLIC_ASIS;
458 continue;
459 }
460 if (!strcmp(arg, "--symbolic-full-name")) {
461 symbolic = SHOW_SYMBOLIC_FULL;
462 continue;
463 }
464 if (!strcmp(arg, "--all")) {
465 for_each_ref(show_reference, NULL);
466 continue;
467 }
468 if (!strcmp(arg, "--branches")) {
469 for_each_branch_ref(show_reference, NULL);
470 continue;
471 }
472 if (!strcmp(arg, "--tags")) {
473 for_each_tag_ref(show_reference, NULL);
474 continue;
475 }
476 if (!strcmp(arg, "--remotes")) {
477 for_each_remote_ref(show_reference, NULL);
478 continue;
479 }
480 if (!strcmp(arg, "--show-prefix")) {
481 if (prefix)
482 puts(prefix);
483 continue;
484 }
485 if (!strcmp(arg, "--show-cdup")) {
486 const char *pfx = prefix;
487 if (!is_inside_work_tree()) {
488 const char *work_tree =
489 get_git_work_tree();
490 if (work_tree)
491 printf("%s\n", work_tree);
492 continue;
493 }
494 while (pfx) {
495 pfx = strchr(pfx, '/');
496 if (pfx) {
497 pfx++;
498 printf("../");
499 }
500 }
501 putchar('\n');
502 continue;
503 }
504 if (!strcmp(arg, "--git-dir")) {
505 const char *gitdir = getenv(GIT_DIR_ENVIRONMENT);
506 static char cwd[PATH_MAX];
507 if (gitdir) {
508 puts(gitdir);
509 continue;
510 }
511 if (!prefix) {
512 puts(".git");
513 continue;
514 }
515 if (!getcwd(cwd, PATH_MAX))
516 die("unable to get current working directory");
517 printf("%s/.git\n", cwd);
518 continue;
519 }
520 if (!strcmp(arg, "--is-inside-git-dir")) {
521 printf("%s\n", is_inside_git_dir() ? "true"
522 : "false");
523 continue;
524 }
525 if (!strcmp(arg, "--is-inside-work-tree")) {
526 printf("%s\n", is_inside_work_tree() ? "true"
527 : "false");
528 continue;
529 }
530 if (!strcmp(arg, "--is-bare-repository")) {
531 printf("%s\n", is_bare_repository() ? "true"
532 : "false");
533 continue;
534 }
535 if (!prefixcmp(arg, "--since=")) {
536 show_datestring("--max-age=", arg+8);
537 continue;
538 }
539 if (!prefixcmp(arg, "--after=")) {
540 show_datestring("--max-age=", arg+8);
541 continue;
542 }
543 if (!prefixcmp(arg, "--before=")) {
544 show_datestring("--min-age=", arg+9);
545 continue;
546 }
547 if (!prefixcmp(arg, "--until=")) {
548 show_datestring("--min-age=", arg+8);
549 continue;
550 }
551 if (show_flag(arg) && verify)
552 die("Needed a single revision");
553 continue;
554 }
555 /* Not a flag argument */
557 if (try_difference(arg))
558 continue;
559 if (!get_sha1(arg, sha1)) {
560 show_rev(NORMAL, sha1, arg);
561 continue;
562 }
563 if (*arg == '^' && !get_sha1(arg+1, sha1)) {
564 show_rev(REVERSED, sha1, arg+1);
565 continue;
566 }
567 as_is = 1;
568 if (!show_file(arg))
569 continue;
570 if (verify)
571 die("Needed a single revision");
572 verify_filename(prefix, arg);
573 }
574 show_default();
575 if (verify && revs_count != 1)
576 die("Needed a single revision");
577 return 0;
578}