documentation: remove extraneous words
[git.git] / diff-lib.c
blob5848e4f9ca294052b0e06c7e4d038ebd462ade92
1 /*
2 * Copyright (C) 2005 Junio C Hamano
3 */
4 #include "git-compat-util.h"
5 #include "quote.h"
6 #include "commit.h"
7 #include "diff.h"
8 #include "diffcore.h"
9 #include "gettext.h"
10 #include "hash.h"
11 #include "hex.h"
12 #include "object-name.h"
13 #include "read-cache.h"
14 #include "revision.h"
15 #include "cache-tree.h"
16 #include "unpack-trees.h"
17 #include "refs.h"
18 #include "repository.h"
19 #include "submodule.h"
20 #include "symlinks.h"
21 #include "trace.h"
22 #include "dir.h"
23 #include "fsmonitor.h"
24 #include "commit-reach.h"
27 * diff-files
31 * Has the work tree entity been removed?
33 * Return 1 if it was removed from the work tree, 0 if an entity to be
34 * compared with the cache entry ce still exists (the latter includes
35 * the case where a directory that is not a submodule repository
36 * exists for ce that is a submodule -- it is a submodule that is not
37 * checked out). Return negative for an error.
39 static int check_removed(const struct cache_entry *ce, struct stat *st)
41 if (lstat(ce->name, st) < 0) {
42 if (!is_missing_file_error(errno))
43 return -1;
44 return 1;
47 if (has_symlink_leading_path(ce->name, ce_namelen(ce)))
48 return 1;
49 if (S_ISDIR(st->st_mode)) {
50 struct object_id sub;
53 * If ce is already a gitlink, we can have a plain
54 * directory (i.e. the submodule is not checked out),
55 * or a checked out submodule. Either case this is not
56 * a case where something was removed from the work tree,
57 * so we will return 0.
59 * Otherwise, if the directory is not a submodule
60 * repository, that means ce which was a blob turned into
61 * a directory --- the blob was removed!
63 if (!S_ISGITLINK(ce->ce_mode) &&
64 resolve_gitlink_ref(ce->name, "HEAD", &sub))
65 return 1;
67 return 0;
71 * Has a file changed or has a submodule new commits or a dirty work tree?
73 * Return 1 when changes are detected, 0 otherwise. If the DIRTY_SUBMODULES
74 * option is set, the caller does not only want to know if a submodule is
75 * modified at all but wants to know all the conditions that are met (new
76 * commits, untracked content and/or modified content).
78 static int match_stat_with_submodule(struct diff_options *diffopt,
79 const struct cache_entry *ce,
80 struct stat *st, unsigned ce_option,
81 unsigned *dirty_submodule)
83 int changed = ie_match_stat(diffopt->repo->index, ce, st, ce_option);
84 if (S_ISGITLINK(ce->ce_mode)) {
85 struct diff_flags orig_flags = diffopt->flags;
86 if (!diffopt->flags.override_submodule_config)
87 set_diffopt_flags_from_submodule_config(diffopt, ce->name);
88 if (diffopt->flags.ignore_submodules)
89 changed = 0;
90 else if (!diffopt->flags.ignore_dirty_submodules &&
91 (!changed || diffopt->flags.dirty_submodules))
92 *dirty_submodule = is_submodule_modified(ce->name,
93 diffopt->flags.ignore_untracked_in_submodules);
94 diffopt->flags = orig_flags;
96 return changed;
99 void run_diff_files(struct rev_info *revs, unsigned int option)
101 int entries, i;
102 int diff_unmerged_stage = revs->max_count;
103 unsigned ce_option = ((option & DIFF_RACY_IS_MODIFIED)
104 ? CE_MATCH_RACY_IS_DIRTY : 0);
105 uint64_t start = getnanotime();
106 struct index_state *istate = revs->diffopt.repo->index;
108 diff_set_mnemonic_prefix(&revs->diffopt, "i/", "w/");
110 refresh_fsmonitor(istate);
112 if (diff_unmerged_stage < 0)
113 diff_unmerged_stage = 2;
114 entries = istate->cache_nr;
115 for (i = 0; i < entries; i++) {
116 unsigned int oldmode, newmode;
117 struct cache_entry *ce = istate->cache[i];
118 int changed;
119 unsigned dirty_submodule = 0;
120 const struct object_id *old_oid, *new_oid;
122 if (diff_can_quit_early(&revs->diffopt))
123 break;
125 if (!ce_path_match(istate, ce, &revs->prune_data, NULL))
126 continue;
128 if (revs->diffopt.prefix &&
129 strncmp(ce->name, revs->diffopt.prefix, revs->diffopt.prefix_length))
130 continue;
132 if (ce_stage(ce)) {
133 struct combine_diff_path *dpath;
134 struct diff_filepair *pair;
135 unsigned int wt_mode = 0;
136 int num_compare_stages = 0;
137 size_t path_len;
138 struct stat st;
140 path_len = ce_namelen(ce);
142 dpath = xmalloc(combine_diff_path_size(5, path_len));
143 dpath->path = (char *) &(dpath->parent[5]);
145 dpath->next = NULL;
146 memcpy(dpath->path, ce->name, path_len);
147 dpath->path[path_len] = '\0';
148 oidclr(&dpath->oid);
149 memset(&(dpath->parent[0]), 0,
150 sizeof(struct combine_diff_parent)*5);
152 changed = check_removed(ce, &st);
153 if (!changed)
154 wt_mode = ce_mode_from_stat(ce, st.st_mode);
155 else {
156 if (changed < 0) {
157 perror(ce->name);
158 continue;
160 wt_mode = 0;
162 dpath->mode = wt_mode;
164 while (i < entries) {
165 struct cache_entry *nce = istate->cache[i];
166 int stage;
168 if (strcmp(ce->name, nce->name))
169 break;
171 /* Stage #2 (ours) is the first parent,
172 * stage #3 (theirs) is the second.
174 stage = ce_stage(nce);
175 if (2 <= stage) {
176 int mode = nce->ce_mode;
177 num_compare_stages++;
178 oidcpy(&dpath->parent[stage - 2].oid,
179 &nce->oid);
180 dpath->parent[stage-2].mode = ce_mode_from_stat(nce, mode);
181 dpath->parent[stage-2].status =
182 DIFF_STATUS_MODIFIED;
185 /* diff against the proper unmerged stage */
186 if (stage == diff_unmerged_stage)
187 ce = nce;
188 i++;
191 * Compensate for loop update
193 i--;
195 if (revs->combine_merges && num_compare_stages == 2) {
196 show_combined_diff(dpath, 2, revs);
197 free(dpath);
198 continue;
200 FREE_AND_NULL(dpath);
203 * Show the diff for the 'ce' if we found the one
204 * from the desired stage.
206 pair = diff_unmerge(&revs->diffopt, ce->name);
207 if (wt_mode)
208 pair->two->mode = wt_mode;
209 if (ce_stage(ce) != diff_unmerged_stage)
210 continue;
213 if (ce_uptodate(ce) || ce_skip_worktree(ce))
214 continue;
217 * When CE_VALID is set (via "update-index --assume-unchanged"
218 * or via adding paths while core.ignorestat is set to true),
219 * the user has promised that the working tree file for that
220 * path will not be modified. When CE_FSMONITOR_VALID is true,
221 * the fsmonitor knows that the path hasn't been modified since
222 * we refreshed the cached stat information. In either case,
223 * we do not have to stat to see if the path has been removed
224 * or modified.
226 if (ce->ce_flags & (CE_VALID | CE_FSMONITOR_VALID)) {
227 changed = 0;
228 newmode = ce->ce_mode;
229 } else {
230 struct stat st;
232 changed = check_removed(ce, &st);
233 if (changed) {
234 if (changed < 0) {
235 perror(ce->name);
236 continue;
238 diff_addremove(&revs->diffopt, '-', ce->ce_mode,
239 &ce->oid,
240 !is_null_oid(&ce->oid),
241 ce->name, 0);
242 continue;
243 } else if (revs->diffopt.ita_invisible_in_index &&
244 ce_intent_to_add(ce)) {
245 newmode = ce_mode_from_stat(ce, st.st_mode);
246 diff_addremove(&revs->diffopt, '+', newmode,
247 null_oid(), 0, ce->name, 0);
248 continue;
251 changed = match_stat_with_submodule(&revs->diffopt, ce, &st,
252 ce_option, &dirty_submodule);
253 newmode = ce_mode_from_stat(ce, st.st_mode);
256 if (!changed && !dirty_submodule) {
257 ce_mark_uptodate(ce);
258 mark_fsmonitor_valid(istate, ce);
259 if (!revs->diffopt.flags.find_copies_harder)
260 continue;
262 oldmode = ce->ce_mode;
263 old_oid = &ce->oid;
264 new_oid = changed ? null_oid() : &ce->oid;
265 diff_change(&revs->diffopt, oldmode, newmode,
266 old_oid, new_oid,
267 !is_null_oid(old_oid),
268 !is_null_oid(new_oid),
269 ce->name, 0, dirty_submodule);
272 diffcore_std(&revs->diffopt);
273 diff_flush(&revs->diffopt);
274 trace_performance_since(start, "diff-files");
278 * diff-index
281 /* A file entry went away or appeared */
282 static void diff_index_show_file(struct rev_info *revs,
283 const char *prefix,
284 const struct cache_entry *ce,
285 const struct object_id *oid, int oid_valid,
286 unsigned int mode,
287 unsigned dirty_submodule)
289 diff_addremove(&revs->diffopt, prefix[0], mode,
290 oid, oid_valid, ce->name, dirty_submodule);
293 static int get_stat_data(const struct index_state *istate,
294 const struct cache_entry *ce,
295 const struct object_id **oidp,
296 unsigned int *modep,
297 int cached, int match_missing,
298 unsigned *dirty_submodule, struct diff_options *diffopt)
300 const struct object_id *oid = &ce->oid;
301 unsigned int mode = ce->ce_mode;
303 if (!cached && !ce_uptodate(ce)) {
304 int changed;
305 struct stat st;
306 changed = check_removed(ce, &st);
307 if (changed < 0)
308 return -1;
309 else if (changed) {
310 if (match_missing) {
311 *oidp = oid;
312 *modep = mode;
313 return 0;
315 return -1;
317 changed = match_stat_with_submodule(diffopt, ce, &st,
318 0, dirty_submodule);
319 if (changed) {
320 mode = ce_mode_from_stat(ce, st.st_mode);
321 oid = null_oid();
325 *oidp = oid;
326 *modep = mode;
327 return 0;
330 static void show_new_file(struct rev_info *revs,
331 const struct cache_entry *new_file,
332 int cached, int match_missing)
334 const struct object_id *oid;
335 unsigned int mode;
336 unsigned dirty_submodule = 0;
337 struct index_state *istate = revs->diffopt.repo->index;
339 if (new_file && S_ISSPARSEDIR(new_file->ce_mode)) {
340 diff_tree_oid(NULL, &new_file->oid, new_file->name, &revs->diffopt);
341 return;
345 * New file in the index: it might actually be different in
346 * the working tree.
348 if (get_stat_data(istate, new_file, &oid, &mode, cached, match_missing,
349 &dirty_submodule, &revs->diffopt) < 0)
350 return;
352 diff_index_show_file(revs, "+", new_file, oid, !is_null_oid(oid), mode, dirty_submodule);
355 static int show_modified(struct rev_info *revs,
356 const struct cache_entry *old_entry,
357 const struct cache_entry *new_entry,
358 int report_missing,
359 int cached, int match_missing)
361 unsigned int mode, oldmode;
362 const struct object_id *oid;
363 unsigned dirty_submodule = 0;
364 struct index_state *istate = revs->diffopt.repo->index;
366 assert(S_ISSPARSEDIR(old_entry->ce_mode) ==
367 S_ISSPARSEDIR(new_entry->ce_mode));
370 * If both are sparse directory entries, then expand the
371 * modifications to the file level. If only one was a sparse
372 * directory, then they appear as an add and delete instead of
373 * a modification.
375 if (S_ISSPARSEDIR(new_entry->ce_mode)) {
376 diff_tree_oid(&old_entry->oid, &new_entry->oid, new_entry->name, &revs->diffopt);
377 return 0;
380 if (get_stat_data(istate, new_entry, &oid, &mode, cached, match_missing,
381 &dirty_submodule, &revs->diffopt) < 0) {
382 if (report_missing)
383 diff_index_show_file(revs, "-", old_entry,
384 &old_entry->oid, 1, old_entry->ce_mode,
386 return -1;
389 if (revs->combine_merges && !cached &&
390 (!oideq(oid, &old_entry->oid) || !oideq(&old_entry->oid, &new_entry->oid))) {
391 struct combine_diff_path *p;
392 int pathlen = ce_namelen(new_entry);
394 p = xmalloc(combine_diff_path_size(2, pathlen));
395 p->path = (char *) &p->parent[2];
396 p->next = NULL;
397 memcpy(p->path, new_entry->name, pathlen);
398 p->path[pathlen] = 0;
399 p->mode = mode;
400 oidclr(&p->oid);
401 memset(p->parent, 0, 2 * sizeof(struct combine_diff_parent));
402 p->parent[0].status = DIFF_STATUS_MODIFIED;
403 p->parent[0].mode = new_entry->ce_mode;
404 oidcpy(&p->parent[0].oid, &new_entry->oid);
405 p->parent[1].status = DIFF_STATUS_MODIFIED;
406 p->parent[1].mode = old_entry->ce_mode;
407 oidcpy(&p->parent[1].oid, &old_entry->oid);
408 show_combined_diff(p, 2, revs);
409 free(p);
410 return 0;
413 oldmode = old_entry->ce_mode;
414 if (mode == oldmode && oideq(oid, &old_entry->oid) && !dirty_submodule &&
415 !revs->diffopt.flags.find_copies_harder)
416 return 0;
418 diff_change(&revs->diffopt, oldmode, mode,
419 &old_entry->oid, oid, 1, !is_null_oid(oid),
420 old_entry->name, 0, dirty_submodule);
421 return 0;
425 * This gets a mix of an existing index and a tree, one pathname entry
426 * at a time. The index entry may be a single stage-0 one, but it could
427 * also be multiple unmerged entries (in which case idx_pos/idx_nr will
428 * give you the position and number of entries in the index).
430 static void do_oneway_diff(struct unpack_trees_options *o,
431 const struct cache_entry *idx,
432 const struct cache_entry *tree)
434 struct rev_info *revs = o->unpack_data;
435 int match_missing, cached;
438 * i-t-a entries do not actually exist in the index (if we're
439 * looking at its content)
441 if (o->index_only &&
442 revs->diffopt.ita_invisible_in_index &&
443 idx && ce_intent_to_add(idx)) {
444 idx = NULL;
445 if (!tree)
446 return; /* nothing to diff.. */
449 /* if the entry is not checked out, don't examine work tree */
450 cached = o->index_only ||
451 (idx && ((idx->ce_flags & CE_VALID) || ce_skip_worktree(idx)));
453 match_missing = revs->match_missing;
455 if (cached && idx && ce_stage(idx)) {
456 struct diff_filepair *pair;
457 pair = diff_unmerge(&revs->diffopt, idx->name);
458 if (tree)
459 fill_filespec(pair->one, &tree->oid, 1,
460 tree->ce_mode);
461 return;
465 * Something added to the tree?
467 if (!tree) {
468 show_new_file(revs, idx, cached, match_missing);
469 return;
473 * Something removed from the tree?
475 if (!idx) {
476 if (S_ISSPARSEDIR(tree->ce_mode)) {
477 diff_tree_oid(&tree->oid, NULL, tree->name, &revs->diffopt);
478 return;
481 diff_index_show_file(revs, "-", tree, &tree->oid, 1,
482 tree->ce_mode, 0);
483 return;
486 /* Show difference between old and new */
487 show_modified(revs, tree, idx, 1, cached, match_missing);
491 * The unpack_trees() interface is designed for merging, so
492 * the different source entries are designed primarily for
493 * the source trees, with the old index being really mainly
494 * used for being replaced by the result.
496 * For diffing, the index is more important, and we only have a
497 * single tree.
499 * We're supposed to advance o->pos to skip what we have already processed.
501 * This wrapper makes it all more readable, and takes care of all
502 * the fairly complex unpack_trees() semantic requirements, including
503 * the skipping, the path matching, the type conflict cases etc.
505 static int oneway_diff(const struct cache_entry * const *src,
506 struct unpack_trees_options *o)
508 const struct cache_entry *idx = src[0];
509 const struct cache_entry *tree = src[1];
510 struct rev_info *revs = o->unpack_data;
513 * Unpack-trees generates a DF/conflict entry if
514 * there was a directory in the index and a tree
515 * in the tree. From a diff standpoint, that's a
516 * delete of the tree and a create of the file.
518 if (tree == o->df_conflict_entry)
519 tree = NULL;
521 if (ce_path_match(revs->diffopt.repo->index,
522 idx ? idx : tree,
523 &revs->prune_data, NULL)) {
524 do_oneway_diff(o, idx, tree);
525 if (diff_can_quit_early(&revs->diffopt)) {
526 o->exiting_early = 1;
527 return -1;
531 return 0;
534 static int diff_cache(struct rev_info *revs,
535 const struct object_id *tree_oid,
536 const char *tree_name,
537 int cached)
539 struct tree *tree;
540 struct tree_desc t;
541 struct unpack_trees_options opts;
543 tree = parse_tree_indirect(tree_oid);
544 if (!tree)
545 return error("bad tree object %s",
546 tree_name ? tree_name : oid_to_hex(tree_oid));
547 memset(&opts, 0, sizeof(opts));
548 opts.head_idx = 1;
549 opts.index_only = cached;
550 opts.diff_index_cached = (cached &&
551 !revs->diffopt.flags.find_copies_harder);
552 opts.merge = 1;
553 opts.fn = oneway_diff;
554 opts.unpack_data = revs;
555 opts.src_index = revs->diffopt.repo->index;
556 opts.dst_index = NULL;
557 opts.pathspec = &revs->diffopt.pathspec;
558 opts.pathspec->recursive = 1;
560 init_tree_desc(&t, tree->buffer, tree->size);
561 return unpack_trees(1, &t, &opts);
564 void diff_get_merge_base(const struct rev_info *revs, struct object_id *mb)
566 int i;
567 struct commit *mb_child[2] = {0};
568 struct commit_list *merge_bases;
570 for (i = 0; i < revs->pending.nr; i++) {
571 struct object *obj = revs->pending.objects[i].item;
572 if (obj->flags)
573 die(_("--merge-base does not work with ranges"));
574 if (obj->type != OBJ_COMMIT)
575 die(_("--merge-base only works with commits"));
579 * This check must go after the for loop above because A...B
580 * ranges produce three pending commits, resulting in a
581 * misleading error message.
583 if (revs->pending.nr < 1 || revs->pending.nr > 2)
584 BUG("unexpected revs->pending.nr: %d", revs->pending.nr);
586 for (i = 0; i < revs->pending.nr; i++)
587 mb_child[i] = lookup_commit_reference(the_repository, &revs->pending.objects[i].item->oid);
588 if (revs->pending.nr == 1) {
589 struct object_id oid;
591 if (repo_get_oid(the_repository, "HEAD", &oid))
592 die(_("unable to get HEAD"));
594 mb_child[1] = lookup_commit_reference(the_repository, &oid);
597 merge_bases = repo_get_merge_bases(the_repository, mb_child[0], mb_child[1]);
598 if (!merge_bases)
599 die(_("no merge base found"));
600 if (merge_bases->next)
601 die(_("multiple merge bases found"));
603 oidcpy(mb, &merge_bases->item->object.oid);
605 free_commit_list(merge_bases);
608 void run_diff_index(struct rev_info *revs, unsigned int option)
610 struct object_array_entry *ent;
611 int cached = !!(option & DIFF_INDEX_CACHED);
612 int merge_base = !!(option & DIFF_INDEX_MERGE_BASE);
613 struct object_id oid;
614 const char *name;
615 char merge_base_hex[GIT_MAX_HEXSZ + 1];
616 struct index_state *istate = revs->diffopt.repo->index;
618 if (revs->pending.nr != 1)
619 BUG("run_diff_index must be passed exactly one tree");
621 trace_performance_enter();
622 ent = revs->pending.objects;
624 refresh_fsmonitor(istate);
626 if (merge_base) {
627 diff_get_merge_base(revs, &oid);
628 name = oid_to_hex_r(merge_base_hex, &oid);
629 } else {
630 oidcpy(&oid, &ent->item->oid);
631 name = ent->name;
634 if (diff_cache(revs, &oid, name, cached))
635 exit(128);
637 diff_set_mnemonic_prefix(&revs->diffopt, "c/", cached ? "i/" : "w/");
638 diffcore_fix_diff_index();
639 diffcore_std(&revs->diffopt);
640 diff_flush(&revs->diffopt);
641 trace_performance_leave("diff-index");
644 int do_diff_cache(const struct object_id *tree_oid, struct diff_options *opt)
646 struct rev_info revs;
648 repo_init_revisions(opt->repo, &revs, NULL);
649 copy_pathspec(&revs.prune_data, &opt->pathspec);
650 diff_setup_done(&revs.diffopt);
651 revs.diffopt = *opt;
653 if (diff_cache(&revs, tree_oid, NULL, 1))
654 exit(128);
655 release_revisions(&revs);
656 return 0;
659 int index_differs_from(struct repository *r,
660 const char *def, const struct diff_flags *flags,
661 int ita_invisible_in_index)
663 struct rev_info rev;
664 struct setup_revision_opt opt;
665 unsigned has_changes;
667 repo_init_revisions(r, &rev, NULL);
668 memset(&opt, 0, sizeof(opt));
669 opt.def = def;
670 setup_revisions(0, NULL, &rev, &opt);
671 rev.diffopt.flags.quick = 1;
672 rev.diffopt.flags.exit_with_status = 1;
673 if (flags) {
674 diff_flags_or(&rev.diffopt.flags, flags);
676 * Now that flags are merged, honor override_submodule_config
677 * and ignore_submodules from passed flags.
679 if (flags->override_submodule_config)
680 rev.diffopt.flags.ignore_submodules = flags->ignore_submodules;
682 rev.diffopt.ita_invisible_in_index = ita_invisible_in_index;
683 run_diff_index(&rev, DIFF_INDEX_CACHED);
684 has_changes = rev.diffopt.flags.has_changes;
685 release_revisions(&rev);
686 return (has_changes != 0);
689 static struct strbuf *idiff_prefix_cb(struct diff_options *opt UNUSED, void *data)
691 return data;
694 void show_interdiff(const struct object_id *oid1, const struct object_id *oid2,
695 int indent, struct diff_options *diffopt)
697 struct diff_options opts;
698 struct strbuf prefix = STRBUF_INIT;
700 memcpy(&opts, diffopt, sizeof(opts));
701 opts.output_format = DIFF_FORMAT_PATCH;
702 opts.output_prefix = idiff_prefix_cb;
703 strbuf_addchars(&prefix, ' ', indent);
704 opts.output_prefix_data = &prefix;
705 diff_setup_done(&opts);
707 diff_tree_oid(oid1, oid2, "", &opts);
708 diffcore_std(&opts);
709 diff_flush(&opts);
711 strbuf_release(&prefix);