Enumerate revision range specifiers in the documentation
[git/jnareb-git.git] / builtin / diff.c
blob9069dc41be33a362ff04d52c00b4830eed272826
1 /*
2 * Builtin "git diff"
4 * Copyright (c) 2006 Junio C Hamano
5 */
6 #include "cache.h"
7 #include "color.h"
8 #include "commit.h"
9 #include "blob.h"
10 #include "tag.h"
11 #include "diff.h"
12 #include "diffcore.h"
13 #include "revision.h"
14 #include "log-tree.h"
15 #include "builtin.h"
16 #include "submodule.h"
17 #include "sha1-array.h"
19 struct blobinfo {
20 unsigned char sha1[20];
21 const char *name;
22 unsigned mode;
25 static const char builtin_diff_usage[] =
26 "git diff [<options>] [<commit> [<commit>]] [--] [<path>...]";
28 static void stuff_change(struct diff_options *opt,
29 unsigned old_mode, unsigned new_mode,
30 const unsigned char *old_sha1,
31 const unsigned char *new_sha1,
32 const char *old_name,
33 const char *new_name)
35 struct diff_filespec *one, *two;
37 if (!is_null_sha1(old_sha1) && !is_null_sha1(new_sha1) &&
38 !hashcmp(old_sha1, new_sha1) && (old_mode == new_mode))
39 return;
41 if (DIFF_OPT_TST(opt, REVERSE_DIFF)) {
42 unsigned tmp;
43 const unsigned char *tmp_u;
44 const char *tmp_c;
45 tmp = old_mode; old_mode = new_mode; new_mode = tmp;
46 tmp_u = old_sha1; old_sha1 = new_sha1; new_sha1 = tmp_u;
47 tmp_c = old_name; old_name = new_name; new_name = tmp_c;
50 if (opt->prefix &&
51 (strncmp(old_name, opt->prefix, opt->prefix_length) ||
52 strncmp(new_name, opt->prefix, opt->prefix_length)))
53 return;
55 one = alloc_filespec(old_name);
56 two = alloc_filespec(new_name);
57 fill_filespec(one, old_sha1, old_mode);
58 fill_filespec(two, new_sha1, new_mode);
60 diff_queue(&diff_queued_diff, one, two);
63 static int builtin_diff_b_f(struct rev_info *revs,
64 int argc, const char **argv,
65 struct blobinfo *blob,
66 const char *path)
68 /* Blob vs file in the working tree*/
69 struct stat st;
71 if (argc > 1)
72 usage(builtin_diff_usage);
74 if (lstat(path, &st))
75 die_errno(_("failed to stat '%s'"), path);
76 if (!(S_ISREG(st.st_mode) || S_ISLNK(st.st_mode)))
77 die(_("'%s': not a regular file or symlink"), path);
79 diff_set_mnemonic_prefix(&revs->diffopt, "o/", "w/");
81 if (blob[0].mode == S_IFINVALID)
82 blob[0].mode = canon_mode(st.st_mode);
84 stuff_change(&revs->diffopt,
85 blob[0].mode, canon_mode(st.st_mode),
86 blob[0].sha1, null_sha1,
87 path, path);
88 diffcore_std(&revs->diffopt);
89 diff_flush(&revs->diffopt);
90 return 0;
93 static int builtin_diff_blobs(struct rev_info *revs,
94 int argc, const char **argv,
95 struct blobinfo *blob)
97 unsigned mode = canon_mode(S_IFREG | 0644);
99 if (argc > 1)
100 usage(builtin_diff_usage);
102 if (blob[0].mode == S_IFINVALID)
103 blob[0].mode = mode;
105 if (blob[1].mode == S_IFINVALID)
106 blob[1].mode = mode;
108 stuff_change(&revs->diffopt,
109 blob[0].mode, blob[1].mode,
110 blob[0].sha1, blob[1].sha1,
111 blob[0].name, blob[1].name);
112 diffcore_std(&revs->diffopt);
113 diff_flush(&revs->diffopt);
114 return 0;
117 static int builtin_diff_index(struct rev_info *revs,
118 int argc, const char **argv)
120 int cached = 0;
121 while (1 < argc) {
122 const char *arg = argv[1];
123 if (!strcmp(arg, "--cached") || !strcmp(arg, "--staged"))
124 cached = 1;
125 else
126 usage(builtin_diff_usage);
127 argv++; argc--;
129 if (!cached)
130 setup_work_tree();
132 * Make sure there is one revision (i.e. pending object),
133 * and there is no revision filtering parameters.
135 if (revs->pending.nr != 1 ||
136 revs->max_count != -1 || revs->min_age != -1 ||
137 revs->max_age != -1)
138 usage(builtin_diff_usage);
139 if (read_cache_preload(revs->diffopt.pathspec.raw) < 0) {
140 perror("read_cache_preload");
141 return -1;
143 return run_diff_index(revs, cached);
146 static int builtin_diff_tree(struct rev_info *revs,
147 int argc, const char **argv,
148 struct object_array_entry *ent)
150 const unsigned char *(sha1[2]);
151 int swap = 0;
153 if (argc > 1)
154 usage(builtin_diff_usage);
156 /* We saw two trees, ent[0] and ent[1].
157 * if ent[1] is uninteresting, they are swapped
159 if (ent[1].item->flags & UNINTERESTING)
160 swap = 1;
161 sha1[swap] = ent[0].item->sha1;
162 sha1[1-swap] = ent[1].item->sha1;
163 diff_tree_sha1(sha1[0], sha1[1], "", &revs->diffopt);
164 log_tree_diff_flush(revs);
165 return 0;
168 static int builtin_diff_combined(struct rev_info *revs,
169 int argc, const char **argv,
170 struct object_array_entry *ent,
171 int ents)
173 struct sha1_array parents = SHA1_ARRAY_INIT;
174 int i;
176 if (argc > 1)
177 usage(builtin_diff_usage);
179 if (!revs->dense_combined_merges && !revs->combine_merges)
180 revs->dense_combined_merges = revs->combine_merges = 1;
181 for (i = 1; i < ents; i++)
182 sha1_array_append(&parents, ent[i].item->sha1);
183 diff_tree_combined(ent[0].item->sha1, &parents,
184 revs->dense_combined_merges, revs);
185 sha1_array_clear(&parents);
186 return 0;
189 static void refresh_index_quietly(void)
191 struct lock_file *lock_file;
192 int fd;
194 lock_file = xcalloc(1, sizeof(struct lock_file));
195 fd = hold_locked_index(lock_file, 0);
196 if (fd < 0)
197 return;
198 discard_cache();
199 read_cache();
200 refresh_cache(REFRESH_QUIET|REFRESH_UNMERGED);
201 update_index_if_able(&the_index, lock_file);
204 static int builtin_diff_files(struct rev_info *revs, int argc, const char **argv)
206 unsigned int options = 0;
208 while (1 < argc && argv[1][0] == '-') {
209 if (!strcmp(argv[1], "--base"))
210 revs->max_count = 1;
211 else if (!strcmp(argv[1], "--ours"))
212 revs->max_count = 2;
213 else if (!strcmp(argv[1], "--theirs"))
214 revs->max_count = 3;
215 else if (!strcmp(argv[1], "-q"))
216 options |= DIFF_SILENT_ON_REMOVED;
217 else if (!strcmp(argv[1], "-h"))
218 usage(builtin_diff_usage);
219 else
220 return error(_("invalid option: %s"), argv[1]);
221 argv++; argc--;
225 * "diff --base" should not combine merges because it was not
226 * asked to. "diff -c" should not densify (if the user wants
227 * dense one, --cc can be explicitly asked for, or just rely
228 * on the default).
230 if (revs->max_count == -1 && !revs->combine_merges &&
231 (revs->diffopt.output_format & DIFF_FORMAT_PATCH))
232 revs->combine_merges = revs->dense_combined_merges = 1;
234 setup_work_tree();
235 if (read_cache_preload(revs->diffopt.pathspec.raw) < 0) {
236 perror("read_cache_preload");
237 return -1;
239 return run_diff_files(revs, options);
242 int cmd_diff(int argc, const char **argv, const char *prefix)
244 int i;
245 struct rev_info rev;
246 struct object_array_entry ent[100];
247 int ents = 0, blobs = 0, paths = 0;
248 const char *path = NULL;
249 struct blobinfo blob[2];
250 int nongit;
251 int result = 0;
254 * We could get N tree-ish in the rev.pending_objects list.
255 * Also there could be M blobs there, and P pathspecs.
257 * N=0, M=0:
258 * cache vs files (diff-files)
259 * N=0, M=2:
260 * compare two random blobs. P must be zero.
261 * N=0, M=1, P=1:
262 * compare a blob with a working tree file.
264 * N=1, M=0:
265 * tree vs cache (diff-index --cached)
267 * N=2, M=0:
268 * tree vs tree (diff-tree)
270 * N=0, M=0, P=2:
271 * compare two filesystem entities (aka --no-index).
273 * Other cases are errors.
276 prefix = setup_git_directory_gently(&nongit);
277 gitmodules_config();
278 git_config(git_diff_ui_config, NULL);
280 init_revisions(&rev, prefix);
282 /* If this is a no-index diff, just run it and exit there. */
283 diff_no_index(&rev, argc, argv, nongit, prefix);
285 /* Otherwise, we are doing the usual "git" diff */
286 rev.diffopt.skip_stat_unmatch = !!diff_auto_refresh_index;
288 /* Scale to real terminal size and respect statGraphWidth config */
289 rev.diffopt.stat_width = -1;
290 rev.diffopt.stat_graph_width = -1;
292 /* Default to let external and textconv be used */
293 DIFF_OPT_SET(&rev.diffopt, ALLOW_EXTERNAL);
294 DIFF_OPT_SET(&rev.diffopt, ALLOW_TEXTCONV);
296 if (nongit)
297 die(_("Not a git repository"));
298 argc = setup_revisions(argc, argv, &rev, NULL);
299 if (!rev.diffopt.output_format) {
300 rev.diffopt.output_format = DIFF_FORMAT_PATCH;
301 if (diff_setup_done(&rev.diffopt) < 0)
302 die(_("diff_setup_done failed"));
305 DIFF_OPT_SET(&rev.diffopt, RECURSIVE);
308 * If the user asked for our exit code then don't start a
309 * pager or we would end up reporting its exit code instead.
311 if (!DIFF_OPT_TST(&rev.diffopt, EXIT_WITH_STATUS) &&
312 check_pager_config("diff") != 0)
313 setup_pager();
316 * Do we have --cached and not have a pending object, then
317 * default to HEAD by hand. Eek.
319 if (!rev.pending.nr) {
320 int i;
321 for (i = 1; i < argc; i++) {
322 const char *arg = argv[i];
323 if (!strcmp(arg, "--"))
324 break;
325 else if (!strcmp(arg, "--cached") ||
326 !strcmp(arg, "--staged")) {
327 add_head_to_pending(&rev);
328 if (!rev.pending.nr) {
329 struct tree *tree;
330 tree = lookup_tree(EMPTY_TREE_SHA1_BIN);
331 add_pending_object(&rev, &tree->object, "HEAD");
333 break;
338 for (i = 0; i < rev.pending.nr; i++) {
339 struct object_array_entry *list = rev.pending.objects+i;
340 struct object *obj = list->item;
341 const char *name = list->name;
342 int flags = (obj->flags & UNINTERESTING);
343 if (!obj->parsed)
344 obj = parse_object(obj->sha1);
345 obj = deref_tag(obj, NULL, 0);
346 if (!obj)
347 die(_("invalid object '%s' given."), name);
348 if (obj->type == OBJ_COMMIT)
349 obj = &((struct commit *)obj)->tree->object;
350 if (obj->type == OBJ_TREE) {
351 if (ARRAY_SIZE(ent) <= ents)
352 die(_("more than %d trees given: '%s'"),
353 (int) ARRAY_SIZE(ent), name);
354 obj->flags |= flags;
355 ent[ents].item = obj;
356 ent[ents].name = name;
357 ents++;
358 continue;
360 if (obj->type == OBJ_BLOB) {
361 if (2 <= blobs)
362 die(_("more than two blobs given: '%s'"), name);
363 hashcpy(blob[blobs].sha1, obj->sha1);
364 blob[blobs].name = name;
365 blob[blobs].mode = list->mode;
366 blobs++;
367 continue;
370 die(_("unhandled object '%s' given."), name);
372 if (rev.prune_data.nr) {
373 if (!path)
374 path = rev.prune_data.items[0].match;
375 paths += rev.prune_data.nr;
379 * Now, do the arguments look reasonable?
381 if (!ents) {
382 switch (blobs) {
383 case 0:
384 result = builtin_diff_files(&rev, argc, argv);
385 break;
386 case 1:
387 if (paths != 1)
388 usage(builtin_diff_usage);
389 result = builtin_diff_b_f(&rev, argc, argv, blob, path);
390 break;
391 case 2:
392 if (paths)
393 usage(builtin_diff_usage);
394 result = builtin_diff_blobs(&rev, argc, argv, blob);
395 break;
396 default:
397 usage(builtin_diff_usage);
400 else if (blobs)
401 usage(builtin_diff_usage);
402 else if (ents == 1)
403 result = builtin_diff_index(&rev, argc, argv);
404 else if (ents == 2)
405 result = builtin_diff_tree(&rev, argc, argv, ent);
406 else if (ent[0].item->flags & UNINTERESTING) {
408 * diff A...B where there is at least one merge base
409 * between A and B. We have ent[0] == merge-base,
410 * ent[ents-2] == A, and ent[ents-1] == B. Show diff
411 * between the base and B. Note that we pick one
412 * merge base at random if there are more than one.
414 ent[1] = ent[ents-1];
415 result = builtin_diff_tree(&rev, argc, argv, ent);
416 } else
417 result = builtin_diff_combined(&rev, argc, argv,
418 ent, ents);
419 result = diff_result_code(&rev.diffopt, result);
420 if (1 < rev.diffopt.skip_stat_unmatch)
421 refresh_index_quietly();
422 return result;