Merge branch 'sn/doc-update-index-assume-unchanged' into maint-1.7.3
[git] / builtin / rev-parse.c
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
13 #define DO_REVS         1
14 #define DO_NOREV        2
15 #define DO_FLAGS        4
16 #define DO_NONFLAGS     8
17 static int filter = ~0;
18
19 static const char *def;
20
21 #define NORMAL 0
22 #define REVERSED 1
23 static int show_type = NORMAL;
24
25 #define SHOW_SYMBOLIC_ASIS 1
26 #define SHOW_SYMBOLIC_FULL 2
27 static int symbolic;
28 static int abbrev;
29 static int abbrev_ref;
30 static int abbrev_ref_strict;
31 static int output_sq;
32
33 /*
34  * Some arguments are relevant "revision" arguments,
35  * others are about output format or other details.
36  * This sorts it all out.
37  */
38 static int is_rev_argument(const char *arg)
39 {
40         static const char *rev_args[] = {
41                 "--all",
42                 "--bisect",
43                 "--dense",
44                 "--branches=",
45                 "--branches",
46                 "--header",
47                 "--max-age=",
48                 "--max-count=",
49                 "--min-age=",
50                 "--no-merges",
51                 "--objects",
52                 "--objects-edge",
53                 "--parents",
54                 "--pretty",
55                 "--remotes=",
56                 "--remotes",
57                 "--glob=",
58                 "--sparse",
59                 "--tags=",
60                 "--tags",
61                 "--topo-order",
62                 "--date-order",
63                 "--unpacked",
64                 NULL
65         };
66         const char **p = rev_args;
67
68         /* accept -<digit>, like traditional "head" */
69         if ((*arg == '-') && isdigit(arg[1]))
70                 return 1;
71
72         for (;;) {
73                 const char *str = *p++;
74                 int len;
75                 if (!str)
76                         return 0;
77                 len = strlen(str);
78                 if (!strcmp(arg, str) ||
79                     (str[len-1] == '=' && !strncmp(arg, str, len)))
80                         return 1;
81         }
82 }
83
84 /* Output argument as a string, either SQ or normal */
85 static void show(const char *arg)
86 {
87         if (output_sq) {
88                 int sq = '\'', ch;
89
90                 putchar(sq);
91                 while ((ch = *arg++)) {
92                         if (ch == sq)
93                                 fputs("'\\'", stdout);
94                         putchar(ch);
95                 }
96                 putchar(sq);
97                 putchar(' ');
98         }
99         else
100                 puts(arg);
101 }
102
103 /* Like show(), but with a negation prefix according to type */
104 static void show_with_type(int type, const char *arg)
105 {
106         if (type != show_type)
107                 putchar('^');
108         show(arg);
109 }
110
111 /* Output a revision, only if filter allows it */
112 static void show_rev(int type, const unsigned char *sha1, const char *name)
113 {
114         if (!(filter & DO_REVS))
115                 return;
116         def = NULL;
117
118         if ((symbolic || abbrev_ref) && name) {
119                 if (symbolic == SHOW_SYMBOLIC_FULL || abbrev_ref) {
120                         unsigned char discard[20];
121                         char *full;
122
123                         switch (dwim_ref(name, strlen(name), discard, &full)) {
124                         case 0:
125                                 /*
126                                  * Not found -- not a ref.  We could
127                                  * emit "name" here, but symbolic-full
128                                  * users are interested in finding the
129                                  * refs spelled in full, and they would
130                                  * need to filter non-refs if we did so.
131                                  */
132                                 break;
133                         case 1: /* happy */
134                                 if (abbrev_ref)
135                                         full = shorten_unambiguous_ref(full,
136                                                 abbrev_ref_strict);
137                                 show_with_type(type, full);
138                                 break;
139                         default: /* ambiguous */
140                                 error("refname '%s' is ambiguous", name);
141                                 break;
142                         }
143                 } else {
144                         show_with_type(type, name);
145                 }
146         }
147         else if (abbrev)
148                 show_with_type(type, find_unique_abbrev(sha1, abbrev));
149         else
150                 show_with_type(type, sha1_to_hex(sha1));
151 }
152
153 /* Output a flag, only if filter allows it. */
154 static int show_flag(const char *arg)
155 {
156         if (!(filter & DO_FLAGS))
157                 return 0;
158         if (filter & (is_rev_argument(arg) ? DO_REVS : DO_NOREV)) {
159                 show(arg);
160                 return 1;
161         }
162         return 0;
163 }
164
165 static int show_default(void)
166 {
167         const char *s = def;
168
169         if (s) {
170                 unsigned char sha1[20];
171
172                 def = NULL;
173                 if (!get_sha1(s, sha1)) {
174                         show_rev(NORMAL, sha1, s);
175                         return 1;
176                 }
177         }
178         return 0;
179 }
180
181 static int show_reference(const char *refname, const unsigned char *sha1, int flag, void *cb_data)
182 {
183         show_rev(NORMAL, sha1, refname);
184         return 0;
185 }
186
187 static int anti_reference(const char *refname, const unsigned char *sha1, int flag, void *cb_data)
188 {
189         show_rev(REVERSED, sha1, refname);
190         return 0;
191 }
192
193 static void show_datestring(const char *flag, const char *datestr)
194 {
195         static char buffer[100];
196
197         /* date handling requires both flags and revs */
198         if ((filter & (DO_FLAGS | DO_REVS)) != (DO_FLAGS | DO_REVS))
199                 return;
200         snprintf(buffer, sizeof(buffer), "%s%lu", flag, approxidate(datestr));
201         show(buffer);
202 }
203
204 static int show_file(const char *arg)
205 {
206         show_default();
207         if ((filter & (DO_NONFLAGS|DO_NOREV)) == (DO_NONFLAGS|DO_NOREV)) {
208                 show(arg);
209                 return 1;
210         }
211         return 0;
212 }
213
214 static int try_difference(const char *arg)
215 {
216         char *dotdot;
217         unsigned char sha1[20];
218         unsigned char end[20];
219         const char *next;
220         const char *this;
221         int symmetric;
222
223         if (!(dotdot = strstr(arg, "..")))
224                 return 0;
225         next = dotdot + 2;
226         this = arg;
227         symmetric = (*next == '.');
228
229         *dotdot = 0;
230         next += symmetric;
231
232         if (!*next)
233                 next = "HEAD";
234         if (dotdot == arg)
235                 this = "HEAD";
236         if (!get_sha1(this, sha1) && !get_sha1(next, end)) {
237                 show_rev(NORMAL, end, next);
238                 show_rev(symmetric ? NORMAL : REVERSED, sha1, this);
239                 if (symmetric) {
240                         struct commit_list *exclude;
241                         struct commit *a, *b;
242                         a = lookup_commit_reference(sha1);
243                         b = lookup_commit_reference(end);
244                         exclude = get_merge_bases(a, b, 1);
245                         while (exclude) {
246                                 struct commit_list *n = exclude->next;
247                                 show_rev(REVERSED,
248                                          exclude->item->object.sha1,NULL);
249                                 free(exclude);
250                                 exclude = n;
251                         }
252                 }
253                 return 1;
254         }
255         *dotdot = '.';
256         return 0;
257 }
258
259 static int try_parent_shorthands(const char *arg)
260 {
261         char *dotdot;
262         unsigned char sha1[20];
263         struct commit *commit;
264         struct commit_list *parents;
265         int parents_only;
266
267         if ((dotdot = strstr(arg, "^!")))
268                 parents_only = 0;
269         else if ((dotdot = strstr(arg, "^@")))
270                 parents_only = 1;
271
272         if (!dotdot || dotdot[2])
273                 return 0;
274
275         *dotdot = 0;
276         if (get_sha1(arg, sha1))
277                 return 0;
278
279         if (!parents_only)
280                 show_rev(NORMAL, sha1, arg);
281         commit = lookup_commit_reference(sha1);
282         for (parents = commit->parents; parents; parents = parents->next)
283                 show_rev(parents_only ? NORMAL : REVERSED,
284                                 parents->item->object.sha1, arg);
285
286         return 1;
287 }
288
289 static int parseopt_dump(const struct option *o, const char *arg, int unset)
290 {
291         struct strbuf *parsed = o->value;
292         if (unset)
293                 strbuf_addf(parsed, " --no-%s", o->long_name);
294         else if (o->short_name)
295                 strbuf_addf(parsed, " -%c", o->short_name);
296         else
297                 strbuf_addf(parsed, " --%s", o->long_name);
298         if (arg) {
299                 strbuf_addch(parsed, ' ');
300                 sq_quote_buf(parsed, arg);
301         }
302         return 0;
303 }
304
305 static const char *skipspaces(const char *s)
306 {
307         while (isspace(*s))
308                 s++;
309         return s;
310 }
311
312 static int cmd_parseopt(int argc, const char **argv, const char *prefix)
313 {
314         static int keep_dashdash = 0, stop_at_non_option = 0;
315         static char const * const parseopt_usage[] = {
316                 "git rev-parse --parseopt [options] -- [<args>...]",
317                 NULL
318         };
319         static struct option parseopt_opts[] = {
320                 OPT_BOOLEAN(0, "keep-dashdash", &keep_dashdash,
321                                         "keep the `--` passed as an arg"),
322                 OPT_BOOLEAN(0, "stop-at-non-option", &stop_at_non_option,
323                                         "stop parsing after the "
324                                         "first non-option argument"),
325                 OPT_END(),
326         };
327
328         struct strbuf sb = STRBUF_INIT, parsed = STRBUF_INIT;
329         const char **usage = NULL;
330         struct option *opts = NULL;
331         int onb = 0, osz = 0, unb = 0, usz = 0;
332
333         strbuf_addstr(&parsed, "set --");
334         argc = parse_options(argc, argv, prefix, parseopt_opts, parseopt_usage,
335                              PARSE_OPT_KEEP_DASHDASH);
336         if (argc < 1 || strcmp(argv[0], "--"))
337                 usage_with_options(parseopt_usage, parseopt_opts);
338
339         /* get the usage up to the first line with a -- on it */
340         for (;;) {
341                 if (strbuf_getline(&sb, stdin, '\n') == EOF)
342                         die("premature end of input");
343                 ALLOC_GROW(usage, unb + 1, usz);
344                 if (!strcmp("--", sb.buf)) {
345                         if (unb < 1)
346                                 die("no usage string given before the `--' separator");
347                         usage[unb] = NULL;
348                         break;
349                 }
350                 usage[unb++] = strbuf_detach(&sb, NULL);
351         }
352
353         /* parse: (<short>|<short>,<long>|<long>)[=?]? SP+ <help> */
354         while (strbuf_getline(&sb, stdin, '\n') != EOF) {
355                 const char *s;
356                 struct option *o;
357
358                 if (!sb.len)
359                         continue;
360
361                 ALLOC_GROW(opts, onb + 1, osz);
362                 memset(opts + onb, 0, sizeof(opts[onb]));
363
364                 o = &opts[onb++];
365                 s = strchr(sb.buf, ' ');
366                 if (!s || *sb.buf == ' ') {
367                         o->type = OPTION_GROUP;
368                         o->help = xstrdup(skipspaces(sb.buf));
369                         continue;
370                 }
371
372                 o->type = OPTION_CALLBACK;
373                 o->help = xstrdup(skipspaces(s));
374                 o->value = &parsed;
375                 o->flags = PARSE_OPT_NOARG;
376                 o->callback = &parseopt_dump;
377                 while (s > sb.buf && strchr("*=?!", s[-1])) {
378                         switch (*--s) {
379                         case '=':
380                                 o->flags &= ~PARSE_OPT_NOARG;
381                                 break;
382                         case '?':
383                                 o->flags &= ~PARSE_OPT_NOARG;
384                                 o->flags |= PARSE_OPT_OPTARG;
385                                 break;
386                         case '!':
387                                 o->flags |= PARSE_OPT_NONEG;
388                                 break;
389                         case '*':
390                                 o->flags |= PARSE_OPT_HIDDEN;
391                                 break;
392                         }
393                 }
394
395                 if (s - sb.buf == 1) /* short option only */
396                         o->short_name = *sb.buf;
397                 else if (sb.buf[1] != ',') /* long option only */
398                         o->long_name = xmemdupz(sb.buf, s - sb.buf);
399                 else {
400                         o->short_name = *sb.buf;
401                         o->long_name = xmemdupz(sb.buf + 2, s - sb.buf - 2);
402                 }
403         }
404         strbuf_release(&sb);
405
406         /* put an OPT_END() */
407         ALLOC_GROW(opts, onb + 1, osz);
408         memset(opts + onb, 0, sizeof(opts[onb]));
409         argc = parse_options(argc, argv, prefix, opts, usage,
410                         (keep_dashdash ? PARSE_OPT_KEEP_DASHDASH : 0) |
411                         (stop_at_non_option ? PARSE_OPT_STOP_AT_NON_OPTION : 0) |
412                         PARSE_OPT_SHELL_EVAL);
413
414         strbuf_addf(&parsed, " --");
415         sq_quote_argv(&parsed, argv, 0);
416         puts(parsed.buf);
417         return 0;
418 }
419
420 static int cmd_sq_quote(int argc, const char **argv)
421 {
422         struct strbuf buf = STRBUF_INIT;
423
424         if (argc)
425                 sq_quote_argv(&buf, argv, 0);
426         printf("%s\n", buf.buf);
427         strbuf_release(&buf);
428
429         return 0;
430 }
431
432 static void die_no_single_rev(int quiet)
433 {
434         if (quiet)
435                 exit(1);
436         else
437                 die("Needed a single revision");
438 }
439
440 static const char builtin_rev_parse_usage[] =
441 "git rev-parse --parseopt [options] -- [<args>...]\n"
442 "   or: git rev-parse --sq-quote [<arg>...]\n"
443 "   or: git rev-parse [options] [<arg>...]\n"
444 "\n"
445 "Run \"git rev-parse --parseopt -h\" for more information on the first usage.";
446
447 int cmd_rev_parse(int argc, const char **argv, const char *prefix)
448 {
449         int i, as_is = 0, verify = 0, quiet = 0, revs_count = 0, type = 0;
450         unsigned char sha1[20];
451         const char *name = NULL;
452
453         if (argc > 1 && !strcmp("--parseopt", argv[1]))
454                 return cmd_parseopt(argc - 1, argv + 1, prefix);
455
456         if (argc > 1 && !strcmp("--sq-quote", argv[1]))
457                 return cmd_sq_quote(argc - 2, argv + 2);
458
459         if (argc == 2 && !strcmp("--local-env-vars", argv[1])) {
460                 int i;
461                 for (i = 0; local_repo_env[i]; i++)
462                         printf("%s\n", local_repo_env[i]);
463                 return 0;
464         }
465
466         if (argc > 1 && !strcmp("-h", argv[1]))
467                 usage(builtin_rev_parse_usage);
468
469         prefix = setup_git_directory();
470         git_config(git_default_config, NULL);
471         for (i = 1; i < argc; i++) {
472                 const char *arg = argv[i];
473
474                 if (as_is) {
475                         if (show_file(arg) && as_is < 2)
476                                 verify_filename(prefix, arg);
477                         continue;
478                 }
479                 if (!strcmp(arg,"-n")) {
480                         if (++i >= argc)
481                                 die("-n requires an argument");
482                         if ((filter & DO_FLAGS) && (filter & DO_REVS)) {
483                                 show(arg);
484                                 show(argv[i]);
485                         }
486                         continue;
487                 }
488                 if (!prefixcmp(arg, "-n")) {
489                         if ((filter & DO_FLAGS) && (filter & DO_REVS))
490                                 show(arg);
491                         continue;
492                 }
493
494                 if (*arg == '-') {
495                         if (!strcmp(arg, "--")) {
496                                 as_is = 2;
497                                 /* Pass on the "--" if we show anything but files.. */
498                                 if (filter & (DO_FLAGS | DO_REVS))
499                                         show_file(arg);
500                                 continue;
501                         }
502                         if (!strcmp(arg, "--default")) {
503                                 def = argv[i+1];
504                                 i++;
505                                 continue;
506                         }
507                         if (!strcmp(arg, "--revs-only")) {
508                                 filter &= ~DO_NOREV;
509                                 continue;
510                         }
511                         if (!strcmp(arg, "--no-revs")) {
512                                 filter &= ~DO_REVS;
513                                 continue;
514                         }
515                         if (!strcmp(arg, "--flags")) {
516                                 filter &= ~DO_NONFLAGS;
517                                 continue;
518                         }
519                         if (!strcmp(arg, "--no-flags")) {
520                                 filter &= ~DO_FLAGS;
521                                 continue;
522                         }
523                         if (!strcmp(arg, "--verify")) {
524                                 filter &= ~(DO_FLAGS|DO_NOREV);
525                                 verify = 1;
526                                 continue;
527                         }
528                         if (!strcmp(arg, "--quiet") || !strcmp(arg, "-q")) {
529                                 quiet = 1;
530                                 continue;
531                         }
532                         if (!strcmp(arg, "--short") ||
533                             !prefixcmp(arg, "--short=")) {
534                                 filter &= ~(DO_FLAGS|DO_NOREV);
535                                 verify = 1;
536                                 abbrev = DEFAULT_ABBREV;
537                                 if (arg[7] == '=')
538                                         abbrev = strtoul(arg + 8, NULL, 10);
539                                 if (abbrev < MINIMUM_ABBREV)
540                                         abbrev = MINIMUM_ABBREV;
541                                 else if (40 <= abbrev)
542                                         abbrev = 40;
543                                 continue;
544                         }
545                         if (!strcmp(arg, "--sq")) {
546                                 output_sq = 1;
547                                 continue;
548                         }
549                         if (!strcmp(arg, "--not")) {
550                                 show_type ^= REVERSED;
551                                 continue;
552                         }
553                         if (!strcmp(arg, "--symbolic")) {
554                                 symbolic = SHOW_SYMBOLIC_ASIS;
555                                 continue;
556                         }
557                         if (!strcmp(arg, "--symbolic-full-name")) {
558                                 symbolic = SHOW_SYMBOLIC_FULL;
559                                 continue;
560                         }
561                         if (!prefixcmp(arg, "--abbrev-ref") &&
562                             (!arg[12] || arg[12] == '=')) {
563                                 abbrev_ref = 1;
564                                 abbrev_ref_strict = warn_ambiguous_refs;
565                                 if (arg[12] == '=') {
566                                         if (!strcmp(arg + 13, "strict"))
567                                                 abbrev_ref_strict = 1;
568                                         else if (!strcmp(arg + 13, "loose"))
569                                                 abbrev_ref_strict = 0;
570                                         else
571                                                 die("unknown mode for %s", arg);
572                                 }
573                                 continue;
574                         }
575                         if (!strcmp(arg, "--all")) {
576                                 for_each_ref(show_reference, NULL);
577                                 continue;
578                         }
579                         if (!strcmp(arg, "--bisect")) {
580                                 for_each_ref_in("refs/bisect/bad", show_reference, NULL);
581                                 for_each_ref_in("refs/bisect/good", anti_reference, NULL);
582                                 continue;
583                         }
584                         if (!prefixcmp(arg, "--branches=")) {
585                                 for_each_glob_ref_in(show_reference, arg + 11,
586                                         "refs/heads/", NULL);
587                                 continue;
588                         }
589                         if (!strcmp(arg, "--branches")) {
590                                 for_each_branch_ref(show_reference, NULL);
591                                 continue;
592                         }
593                         if (!prefixcmp(arg, "--tags=")) {
594                                 for_each_glob_ref_in(show_reference, arg + 7,
595                                         "refs/tags/", NULL);
596                                 continue;
597                         }
598                         if (!strcmp(arg, "--tags")) {
599                                 for_each_tag_ref(show_reference, NULL);
600                                 continue;
601                         }
602                         if (!prefixcmp(arg, "--glob=")) {
603                                 for_each_glob_ref(show_reference, arg + 7, NULL);
604                                 continue;
605                         }
606                         if (!prefixcmp(arg, "--remotes=")) {
607                                 for_each_glob_ref_in(show_reference, arg + 10,
608                                         "refs/remotes/", NULL);
609                                 continue;
610                         }
611                         if (!strcmp(arg, "--remotes")) {
612                                 for_each_remote_ref(show_reference, NULL);
613                                 continue;
614                         }
615                         if (!strcmp(arg, "--show-toplevel")) {
616                                 const char *work_tree = get_git_work_tree();
617                                 if (work_tree)
618                                         puts(work_tree);
619                                 continue;
620                         }
621                         if (!strcmp(arg, "--show-prefix")) {
622                                 if (prefix)
623                                         puts(prefix);
624                                 continue;
625                         }
626                         if (!strcmp(arg, "--show-cdup")) {
627                                 const char *pfx = prefix;
628                                 if (!is_inside_work_tree()) {
629                                         const char *work_tree =
630                                                 get_git_work_tree();
631                                         if (work_tree)
632                                                 printf("%s\n", work_tree);
633                                         continue;
634                                 }
635                                 while (pfx) {
636                                         pfx = strchr(pfx, '/');
637                                         if (pfx) {
638                                                 pfx++;
639                                                 printf("../");
640                                         }
641                                 }
642                                 putchar('\n');
643                                 continue;
644                         }
645                         if (!strcmp(arg, "--git-dir")) {
646                                 const char *gitdir = getenv(GIT_DIR_ENVIRONMENT);
647                                 static char cwd[PATH_MAX];
648                                 int len;
649                                 if (gitdir) {
650                                         puts(gitdir);
651                                         continue;
652                                 }
653                                 if (!prefix) {
654                                         puts(".git");
655                                         continue;
656                                 }
657                                 if (!getcwd(cwd, PATH_MAX))
658                                         die_errno("unable to get current working directory");
659                                 len = strlen(cwd);
660                                 printf("%s%s.git\n", cwd, len && cwd[len-1] != '/' ? "/" : "");
661                                 continue;
662                         }
663                         if (!strcmp(arg, "--is-inside-git-dir")) {
664                                 printf("%s\n", is_inside_git_dir() ? "true"
665                                                 : "false");
666                                 continue;
667                         }
668                         if (!strcmp(arg, "--is-inside-work-tree")) {
669                                 printf("%s\n", is_inside_work_tree() ? "true"
670                                                 : "false");
671                                 continue;
672                         }
673                         if (!strcmp(arg, "--is-bare-repository")) {
674                                 printf("%s\n", is_bare_repository() ? "true"
675                                                 : "false");
676                                 continue;
677                         }
678                         if (!prefixcmp(arg, "--since=")) {
679                                 show_datestring("--max-age=", arg+8);
680                                 continue;
681                         }
682                         if (!prefixcmp(arg, "--after=")) {
683                                 show_datestring("--max-age=", arg+8);
684                                 continue;
685                         }
686                         if (!prefixcmp(arg, "--before=")) {
687                                 show_datestring("--min-age=", arg+9);
688                                 continue;
689                         }
690                         if (!prefixcmp(arg, "--until=")) {
691                                 show_datestring("--min-age=", arg+8);
692                                 continue;
693                         }
694                         if (show_flag(arg) && verify)
695                                 die_no_single_rev(quiet);
696                         continue;
697                 }
698
699                 /* Not a flag argument */
700                 if (try_difference(arg))
701                         continue;
702                 if (try_parent_shorthands(arg))
703                         continue;
704                 name = arg;
705                 type = NORMAL;
706                 if (*arg == '^') {
707                         name++;
708                         type = REVERSED;
709                 }
710                 if (!get_sha1(name, sha1)) {
711                         if (verify)
712                                 revs_count++;
713                         else
714                                 show_rev(type, sha1, name);
715                         continue;
716                 }
717                 if (verify)
718                         die_no_single_rev(quiet);
719                 as_is = 1;
720                 if (!show_file(arg))
721                         continue;
722                 verify_filename(prefix, arg);
723         }
724         if (verify) {
725                 if (revs_count == 1) {
726                         show_rev(type, sha1, name);
727                         return 0;
728                 } else if (revs_count == 0 && show_default())
729                         return 0;
730                 die_no_single_rev(quiet);
731         } else
732                 show_default();
733         return 0;
734 }