Merge branch 'sg/doc-pretty-formats'
[git] / builtin / diff.c
1 /*
2  * Builtin "git diff"
3  *
4  * Copyright (c) 2006 Junio C Hamano
5  */
6 #include "cache.h"
7 #include "lockfile.h"
8 #include "color.h"
9 #include "commit.h"
10 #include "blob.h"
11 #include "tag.h"
12 #include "diff.h"
13 #include "diffcore.h"
14 #include "revision.h"
15 #include "log-tree.h"
16 #include "builtin.h"
17 #include "submodule.h"
18 #include "sha1-array.h"
19
20 #define DIFF_NO_INDEX_EXPLICIT 1
21 #define DIFF_NO_INDEX_IMPLICIT 2
22
23 static const char builtin_diff_usage[] =
24 "git diff [<options>] [<commit> [<commit>]] [--] [<path>...]";
25
26 static const char *blob_path(struct object_array_entry *entry)
27 {
28         return entry->path ? entry->path : entry->name;
29 }
30
31 static void stuff_change(struct diff_options *opt,
32                          unsigned old_mode, unsigned new_mode,
33                          const struct object_id *old_oid,
34                          const struct object_id *new_oid,
35                          int old_oid_valid,
36                          int new_oid_valid,
37                          const char *old_path,
38                          const char *new_path)
39 {
40         struct diff_filespec *one, *two;
41
42         if (!is_null_oid(old_oid) && !is_null_oid(new_oid) &&
43             !oidcmp(old_oid, new_oid) && (old_mode == new_mode))
44                 return;
45
46         if (DIFF_OPT_TST(opt, REVERSE_DIFF)) {
47                 SWAP(old_mode, new_mode);
48                 SWAP(old_oid, new_oid);
49                 SWAP(old_path, new_path);
50         }
51
52         if (opt->prefix &&
53             (strncmp(old_path, opt->prefix, opt->prefix_length) ||
54              strncmp(new_path, opt->prefix, opt->prefix_length)))
55                 return;
56
57         one = alloc_filespec(old_path);
58         two = alloc_filespec(new_path);
59         fill_filespec(one, old_oid, old_oid_valid, old_mode);
60         fill_filespec(two, new_oid, new_oid_valid, new_mode);
61
62         diff_queue(&diff_queued_diff, one, two);
63 }
64
65 static int builtin_diff_b_f(struct rev_info *revs,
66                             int argc, const char **argv,
67                             struct object_array_entry **blob)
68 {
69         /* Blob vs file in the working tree*/
70         struct stat st;
71         const char *path;
72
73         if (argc > 1)
74                 usage(builtin_diff_usage);
75
76         GUARD_PATHSPEC(&revs->prune_data, PATHSPEC_FROMTOP | PATHSPEC_LITERAL);
77         path = revs->prune_data.items[0].match;
78
79         if (lstat(path, &st))
80                 die_errno(_("failed to stat '%s'"), path);
81         if (!(S_ISREG(st.st_mode) || S_ISLNK(st.st_mode)))
82                 die(_("'%s': not a regular file or symlink"), path);
83
84         diff_set_mnemonic_prefix(&revs->diffopt, "o/", "w/");
85
86         if (blob[0]->mode == S_IFINVALID)
87                 blob[0]->mode = canon_mode(st.st_mode);
88
89         stuff_change(&revs->diffopt,
90                      blob[0]->mode, canon_mode(st.st_mode),
91                      &blob[0]->item->oid, &null_oid,
92                      1, 0,
93                      blob[0]->path ? blob[0]->path : path,
94                      path);
95         diffcore_std(&revs->diffopt);
96         diff_flush(&revs->diffopt);
97         return 0;
98 }
99
100 static int builtin_diff_blobs(struct rev_info *revs,
101                               int argc, const char **argv,
102                               struct object_array_entry **blob)
103 {
104         unsigned mode = canon_mode(S_IFREG | 0644);
105
106         if (argc > 1)
107                 usage(builtin_diff_usage);
108
109         if (blob[0]->mode == S_IFINVALID)
110                 blob[0]->mode = mode;
111
112         if (blob[1]->mode == S_IFINVALID)
113                 blob[1]->mode = mode;
114
115         stuff_change(&revs->diffopt,
116                      blob[0]->mode, blob[1]->mode,
117                      &blob[0]->item->oid, &blob[1]->item->oid,
118                      1, 1,
119                      blob_path(blob[0]), blob_path(blob[1]));
120         diffcore_std(&revs->diffopt);
121         diff_flush(&revs->diffopt);
122         return 0;
123 }
124
125 static int builtin_diff_index(struct rev_info *revs,
126                               int argc, const char **argv)
127 {
128         int cached = 0;
129         while (1 < argc) {
130                 const char *arg = argv[1];
131                 if (!strcmp(arg, "--cached") || !strcmp(arg, "--staged"))
132                         cached = 1;
133                 else
134                         usage(builtin_diff_usage);
135                 argv++; argc--;
136         }
137         /*
138          * Make sure there is one revision (i.e. pending object),
139          * and there is no revision filtering parameters.
140          */
141         if (revs->pending.nr != 1 ||
142             revs->max_count != -1 || revs->min_age != -1 ||
143             revs->max_age != -1)
144                 usage(builtin_diff_usage);
145         if (!cached) {
146                 setup_work_tree();
147                 if (read_cache_preload(&revs->diffopt.pathspec) < 0) {
148                         perror("read_cache_preload");
149                         return -1;
150                 }
151         } else if (read_cache() < 0) {
152                 perror("read_cache");
153                 return -1;
154         }
155         return run_diff_index(revs, cached);
156 }
157
158 static int builtin_diff_tree(struct rev_info *revs,
159                              int argc, const char **argv,
160                              struct object_array_entry *ent0,
161                              struct object_array_entry *ent1)
162 {
163         const struct object_id *(oid[2]);
164         int swap = 0;
165
166         if (argc > 1)
167                 usage(builtin_diff_usage);
168
169         /*
170          * We saw two trees, ent0 and ent1.  If ent1 is uninteresting,
171          * swap them.
172          */
173         if (ent1->item->flags & UNINTERESTING)
174                 swap = 1;
175         oid[swap] = &ent0->item->oid;
176         oid[1 - swap] = &ent1->item->oid;
177         diff_tree_oid(oid[0], oid[1], "", &revs->diffopt);
178         log_tree_diff_flush(revs);
179         return 0;
180 }
181
182 static int builtin_diff_combined(struct rev_info *revs,
183                                  int argc, const char **argv,
184                                  struct object_array_entry *ent,
185                                  int ents)
186 {
187         struct oid_array parents = OID_ARRAY_INIT;
188         int i;
189
190         if (argc > 1)
191                 usage(builtin_diff_usage);
192
193         if (!revs->dense_combined_merges && !revs->combine_merges)
194                 revs->dense_combined_merges = revs->combine_merges = 1;
195         for (i = 1; i < ents; i++)
196                 oid_array_append(&parents, &ent[i].item->oid);
197         diff_tree_combined(&ent[0].item->oid, &parents,
198                            revs->dense_combined_merges, revs);
199         oid_array_clear(&parents);
200         return 0;
201 }
202
203 static void refresh_index_quietly(void)
204 {
205         struct lock_file *lock_file;
206         int fd;
207
208         lock_file = xcalloc(1, sizeof(struct lock_file));
209         fd = hold_locked_index(lock_file, 0);
210         if (fd < 0)
211                 return;
212         discard_cache();
213         read_cache();
214         refresh_cache(REFRESH_QUIET|REFRESH_UNMERGED);
215         update_index_if_able(&the_index, lock_file);
216 }
217
218 static int builtin_diff_files(struct rev_info *revs, int argc, const char **argv)
219 {
220         unsigned int options = 0;
221
222         while (1 < argc && argv[1][0] == '-') {
223                 if (!strcmp(argv[1], "--base"))
224                         revs->max_count = 1;
225                 else if (!strcmp(argv[1], "--ours"))
226                         revs->max_count = 2;
227                 else if (!strcmp(argv[1], "--theirs"))
228                         revs->max_count = 3;
229                 else if (!strcmp(argv[1], "-q"))
230                         options |= DIFF_SILENT_ON_REMOVED;
231                 else if (!strcmp(argv[1], "-h"))
232                         usage(builtin_diff_usage);
233                 else
234                         return error(_("invalid option: %s"), argv[1]);
235                 argv++; argc--;
236         }
237
238         /*
239          * "diff --base" should not combine merges because it was not
240          * asked to.  "diff -c" should not densify (if the user wants
241          * dense one, --cc can be explicitly asked for, or just rely
242          * on the default).
243          */
244         if (revs->max_count == -1 && !revs->combine_merges &&
245             (revs->diffopt.output_format & DIFF_FORMAT_PATCH))
246                 revs->combine_merges = revs->dense_combined_merges = 1;
247
248         setup_work_tree();
249         if (read_cache_preload(&revs->diffopt.pathspec) < 0) {
250                 perror("read_cache_preload");
251                 return -1;
252         }
253         return run_diff_files(revs, options);
254 }
255
256 int cmd_diff(int argc, const char **argv, const char *prefix)
257 {
258         int i;
259         struct rev_info rev;
260         struct object_array ent = OBJECT_ARRAY_INIT;
261         int blobs = 0, paths = 0;
262         struct object_array_entry *blob[2];
263         int nongit = 0, no_index = 0;
264         int result = 0;
265
266         /*
267          * We could get N tree-ish in the rev.pending_objects list.
268          * Also there could be M blobs there, and P pathspecs.
269          *
270          * N=0, M=0:
271          *      cache vs files (diff-files)
272          * N=0, M=2:
273          *      compare two random blobs.  P must be zero.
274          * N=0, M=1, P=1:
275          *      compare a blob with a working tree file.
276          *
277          * N=1, M=0:
278          *      tree vs cache (diff-index --cached)
279          *
280          * N=2, M=0:
281          *      tree vs tree (diff-tree)
282          *
283          * N=0, M=0, P=2:
284          *      compare two filesystem entities (aka --no-index).
285          *
286          * Other cases are errors.
287          */
288
289         /* Were we asked to do --no-index explicitly? */
290         for (i = 1; i < argc; i++) {
291                 if (!strcmp(argv[i], "--")) {
292                         i++;
293                         break;
294                 }
295                 if (!strcmp(argv[i], "--no-index"))
296                         no_index = DIFF_NO_INDEX_EXPLICIT;
297                 if (argv[i][0] != '-')
298                         break;
299         }
300
301         prefix = setup_git_directory_gently(&nongit);
302
303         if (!no_index) {
304                 /*
305                  * Treat git diff with at least one path outside of the
306                  * repo the same as if the command would have been executed
307                  * outside of a git repository.  In this case it behaves
308                  * the same way as "git diff --no-index <a> <b>", which acts
309                  * as a colourful "diff" replacement.
310                  */
311                 if (nongit || ((argc == i + 2) &&
312                                (!path_inside_repo(prefix, argv[i]) ||
313                                 !path_inside_repo(prefix, argv[i + 1]))))
314                         no_index = DIFF_NO_INDEX_IMPLICIT;
315         }
316
317         if (!no_index)
318                 gitmodules_config();
319         init_diff_ui_defaults();
320         git_config(git_diff_ui_config, NULL);
321         precompose_argv(argc, argv);
322
323         init_revisions(&rev, prefix);
324
325         if (no_index && argc != i + 2) {
326                 if (no_index == DIFF_NO_INDEX_IMPLICIT) {
327                         /*
328                          * There was no --no-index and there were not two
329                          * paths. It is possible that the user intended
330                          * to do an inside-repository operation.
331                          */
332                         fprintf(stderr, "Not a git repository\n");
333                         fprintf(stderr,
334                                 "To compare two paths outside a working tree:\n");
335                 }
336                 /* Give the usage message for non-repository usage and exit. */
337                 usagef("git diff %s <path> <path>",
338                        no_index == DIFF_NO_INDEX_EXPLICIT ?
339                        "--no-index" : "[--no-index]");
340
341         }
342         if (no_index)
343                 /* If this is a no-index diff, just run it and exit there. */
344                 diff_no_index(&rev, argc, argv);
345
346         /* Otherwise, we are doing the usual "git" diff */
347         rev.diffopt.skip_stat_unmatch = !!diff_auto_refresh_index;
348
349         /* Scale to real terminal size and respect statGraphWidth config */
350         rev.diffopt.stat_width = -1;
351         rev.diffopt.stat_graph_width = -1;
352
353         /* Default to let external and textconv be used */
354         DIFF_OPT_SET(&rev.diffopt, ALLOW_EXTERNAL);
355         DIFF_OPT_SET(&rev.diffopt, ALLOW_TEXTCONV);
356
357         if (nongit)
358                 die(_("Not a git repository"));
359         argc = setup_revisions(argc, argv, &rev, NULL);
360         if (!rev.diffopt.output_format) {
361                 rev.diffopt.output_format = DIFF_FORMAT_PATCH;
362                 diff_setup_done(&rev.diffopt);
363         }
364
365         DIFF_OPT_SET(&rev.diffopt, RECURSIVE);
366
367         setup_diff_pager(&rev.diffopt);
368
369         /*
370          * Do we have --cached and not have a pending object, then
371          * default to HEAD by hand.  Eek.
372          */
373         if (!rev.pending.nr) {
374                 int i;
375                 for (i = 1; i < argc; i++) {
376                         const char *arg = argv[i];
377                         if (!strcmp(arg, "--"))
378                                 break;
379                         else if (!strcmp(arg, "--cached") ||
380                                  !strcmp(arg, "--staged")) {
381                                 add_head_to_pending(&rev);
382                                 if (!rev.pending.nr) {
383                                         struct tree *tree;
384                                         tree = lookup_tree(&empty_tree_oid);
385                                         add_pending_object(&rev, &tree->object, "HEAD");
386                                 }
387                                 break;
388                         }
389                 }
390         }
391
392         for (i = 0; i < rev.pending.nr; i++) {
393                 struct object_array_entry *entry = &rev.pending.objects[i];
394                 struct object *obj = entry->item;
395                 const char *name = entry->name;
396                 int flags = (obj->flags & UNINTERESTING);
397                 if (!obj->parsed)
398                         obj = parse_object(&obj->oid);
399                 obj = deref_tag(obj, NULL, 0);
400                 if (!obj)
401                         die(_("invalid object '%s' given."), name);
402                 if (obj->type == OBJ_COMMIT)
403                         obj = &((struct commit *)obj)->tree->object;
404
405                 if (obj->type == OBJ_TREE) {
406                         obj->flags |= flags;
407                         add_object_array(obj, name, &ent);
408                 } else if (obj->type == OBJ_BLOB) {
409                         if (2 <= blobs)
410                                 die(_("more than two blobs given: '%s'"), name);
411                         blob[blobs] = entry;
412                         blobs++;
413
414                 } else {
415                         die(_("unhandled object '%s' given."), name);
416                 }
417         }
418         if (rev.prune_data.nr)
419                 paths += rev.prune_data.nr;
420
421         /*
422          * Now, do the arguments look reasonable?
423          */
424         if (!ent.nr) {
425                 switch (blobs) {
426                 case 0:
427                         result = builtin_diff_files(&rev, argc, argv);
428                         break;
429                 case 1:
430                         if (paths != 1)
431                                 usage(builtin_diff_usage);
432                         result = builtin_diff_b_f(&rev, argc, argv, blob);
433                         break;
434                 case 2:
435                         if (paths)
436                                 usage(builtin_diff_usage);
437                         result = builtin_diff_blobs(&rev, argc, argv, blob);
438                         break;
439                 default:
440                         usage(builtin_diff_usage);
441                 }
442         }
443         else if (blobs)
444                 usage(builtin_diff_usage);
445         else if (ent.nr == 1)
446                 result = builtin_diff_index(&rev, argc, argv);
447         else if (ent.nr == 2)
448                 result = builtin_diff_tree(&rev, argc, argv,
449                                            &ent.objects[0], &ent.objects[1]);
450         else if (ent.objects[0].item->flags & UNINTERESTING) {
451                 /*
452                  * diff A...B where there is at least one merge base
453                  * between A and B.  We have ent.objects[0] ==
454                  * merge-base, ent.objects[ents-2] == A, and
455                  * ent.objects[ents-1] == B.  Show diff between the
456                  * base and B.  Note that we pick one merge base at
457                  * random if there are more than one.
458                  */
459                 result = builtin_diff_tree(&rev, argc, argv,
460                                            &ent.objects[0],
461                                            &ent.objects[ent.nr-1]);
462         } else
463                 result = builtin_diff_combined(&rev, argc, argv,
464                                                ent.objects, ent.nr);
465         result = diff_result_code(&rev.diffopt, result);
466         if (1 < rev.diffopt.skip_stat_unmatch)
467                 refresh_index_quietly();
468         return result;
469 }