| blob | ea7d747a70ae2b43ec77aa5b069d146edce5e32b |
1 ;;; ediff.el --- a comprehensive visual interface to diff & patch
3 ;; Copyright (C) 1994, 1995, 1996, 1997 Free Software Foundation, Inc.
5 ;; Author: Michael Kifer <kifer@cs.sunysb.edu>
6 ;; Created: February 2, 1994
7 ;; Keywords: comparing, merging, patching, version control.
13 ;; This file is part of GNU Emacs.
15 ;; GNU Emacs is free software; you can redistribute it and/or modify
16 ;; it under the terms of the GNU General Public License as published by
17 ;; the Free Software Foundation; either version 2, or (at your option)
18 ;; any later version.
20 ;; GNU Emacs is distributed in the hope that it will be useful,
21 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
22 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 ;; GNU General Public License for more details.
25 ;; You should have received a copy of the GNU General Public License
26 ;; along with GNU Emacs; see the file COPYING. If not, write to the
27 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
28 ;; Boston, MA 02111-1307, USA.
30 ;;; Commentary:
32 ;; Never read that diff output again!
33 ;; Apply patch interactively!
34 ;; Merge with ease!
36 ;; This package provides a convenient way of simultaneous browsing through
37 ;; the differences between a pair (or a triple) of files or buffers. The
38 ;; files being compared, file-A, file-B, and file-C (if applicable) are
39 ;; shown in separate windows (side by side, one above the another, or in
40 ;; separate frames), and the differences are highlighted as you step
41 ;; through them. You can also copy difference regions from one buffer to
42 ;; another (and recover old differences if you change your mind).
44 ;; Ediff also supports merging operations on files and buffers, including
45 ;; merging using ancestor versions. Both comparison and merging operations can
46 ;; be performed on directories, i.e., by pairwise comparison of files in those
47 ;; directories.
49 ;; In addition, Ediff can apply a patch to a file and then let you step
50 ;; though both files, the patched and the original one, simultaneously,
51 ;; difference-by-difference. You can even apply a patch right out of a
52 ;; mail buffer, i.e., patches received by mail don't even have to be saved.
53 ;; Since Ediff lets you copy differences between buffers, you can, in
54 ;; effect, apply patches selectively (i.e., you can copy a difference
55 ;; region from file_orig to file, thereby undoing any particular patch that
56 ;; you don't like).
58 ;; Ediff is aware of version control, which lets the user compare
59 ;; files with their older versions. Ediff can also work with remote and
60 ;; compressed files. Details are given below.
62 ;; Finally, Ediff supports directory-level comparison, merging and patching.
63 ;; See the on-line manual for details.
65 ;; This package builds upon the ideas borrowed from emerge.el and several
66 ;; Ediff's functions are adaptations from emerge.el. Much of the functionality
67 ;; Ediff provides is also influenced by emerge.el.
69 ;; The present version of Ediff supersedes Emerge. It provides a superior user
70 ;; interface and has numerous major features not found in Emerge. In
71 ;; particular, it can do patching, and 2-way and 3-way file comparison,
72 ;; merging, and directory operations.
76 ;;; Bugs:
78 ;; 1. The undo command doesn't restore deleted regions well. That is, if
79 ;; you delete all characters in a difference region and then invoke
80 ;; `undo', the reinstated text will most likely be inserted outside of
81 ;; what Ediff thinks is the current difference region. (This problem
82 ;; doesn't seem to exist with XEmacs.)
83 ;;
84 ;; If at any point you feel that difference regions are no longer correct,
85 ;; you can hit '!' to recompute the differences.
87 ;; 2. On a monochrome display, the repertoire of faces with which to
88 ;; highlight fine differences is limited. By default, Ediff is using
89 ;; underlining. However, if the region is already underlined by some other
90 ;; overlays, there is no simple way to temporarily remove that residual
91 ;; underlining. This problem occurs when a buffer is highlighted with
92 ;; hilit19.el or font-lock.el packages. If this residual highlighting gets
93 ;; in the way, you can do the following. Both font-lock.el and hilit19.el
94 ;; provide commands for unhighlighting buffers. You can either place these
95 ;; commands in `ediff-prepare-buffer-hook' (which will unhighlight every
96 ;; buffer used by Ediff) or you can execute them interactively, at any time
97 ;; and on any buffer.
100 ;;; Acknowledgements:
102 ;; Ediff was inspired by Dale R. Worley's <drw@math.mit.edu> emerge.el.
103 ;; Ediff would not have been possible without the help and encouragement of
104 ;; its many users. See Ediff on-line Info for the full list of those who
105 ;; helped. Improved defaults in Ediff file-name reading commands.
107 ;;; Code:
111 ;; Compiler pacifier
131 ))
132 ;; end pacifier
138 "A comprehensive visual interface to diff & patch"
144 "*If t, Ediff will use previous directory as default when reading file name."
148 ;; Last directory used by an Ediff command for file-A.
150 ;; Last directory used by an Ediff command for file-B.
152 ;; Last directory used by an Ediff command for file-C.
154 ;; Last directory used by an Ediff command for the ancestor file.
156 ;; Last directory used by an Ediff command as the output directory for merge.
160 ;; Used as a startup hook to set `_orig' patch file read-only.
165 ;; Return a plausible default for ediff's first file:
166 ;; In dired, return the file name under the point, unless it is a directory
167 ;; If the buffer has a file name, return that file name.
172 f)))
175 ))
177 ;;; Compare files/buffers
179 ;;;###autoload
181 "Run Ediff on a pair of files, FILE-A and FILE-B."
184 ediff-last-dir-A
185 default-directory))
186 dir-B f)
188 "File A to compare" dir-A
193 ediff-last-dir-B
200 dir-B))
201 file-name-history))
202 f))
203 )))
208 file-B)
209 nil ; file-C
210 startup-hooks
213 ;;;###autoload
215 "Run Ediff on three files, FILE-A, FILE-B, and FILE-C."
218 ediff-last-dir-A
219 default-directory))
220 dir-B dir-C f ff)
222 "File A to compare" dir-A
227 ediff-last-dir-B
235 dir-B))
236 file-name-history))
237 f)))
240 ediff-last-dir-C
247 dir-C))
248 file-name-history))
249 ff))
250 )))
255 file-B)
259 file-C)
260 startup-hooks
263 ;;;###autoload
267 ;; Visit FILE and arrange its buffer to Ediff's liking.
268 ;; FILE is actually a variable symbol that must contain a true file name.
269 ;; BUFFER-NAME is a variable symbol, which will get the buffer object into
270 ;; which FILE is read.
271 ;; LAST-DIR is the directory variable symbol where FILE's
272 ;; directory name should be returned. HOOKS-VAR is a variable symbol that will
273 ;; be assigned the hook to be executed after `ediff-startup' is finished.
274 ;; `ediff-find-file' arranges that the temp files it might create will be
275 ;; deleted.
285 ;; some of the commands, below, require full file name
288 ;; Record the directory of the file
292 ;; Setup the buffer
298 ;;; ange-ftp-hook-function--arrange for temp file
305 ;; file processed via auto-mode-alist, a la uncompress.el
320 ;;(sit-for 0)
323 ;;(sit-for 0)
328 ;;(sit-for 0)
335 buf-B file-B
336 buf-C file-C
337 startup-hooks
341 ;;;###autoload
345 ;;;###autoload
347 "Run Ediff on a pair of buffers, BUFFER-A and BUFFER-B."
354 ;; realign buffers so that two visible bufs will be
355 ;; at the top
358 t))))
362 ;;;###autoload
366 ;;;###autoload
369 "Run Ediff on three buffers, BUFFER-A, BUFFER-B, and BUFFER-C."
376 ;; realign buffers so that two visible
377 ;; bufs will be at the top
380 t))
383 ;; realign buffers so that three visible
384 ;; bufs will be at the top
387 t)
388 )))
392 ;;;###autoload
403 file-A file-B file-C)
427 file-C
432 ))
433 startup-hooks)
435 )))
438 ;;; Directory and file group operations
440 ;; Get appropriate default name for directory:
441 ;; If ediff-use-last-dir, use ediff-last-dir-A.
442 ;; In dired mode, use the directory that is under the point (if any);
443 ;; otherwise, use default-directory
449 f
450 default-directory)))
454 ;;;###autoload
456 "Run Ediff on a pair of directories, DIR1 and DIR2, comparing files that have
457 the same name in both. The third argument, REGEXP, is a regular expression that
458 can be used to filter out certain file names."
461 f)
465 ediff-last-dir-B
467 nil)
470 )))
473 ))
475 ;;;###autoload
479 ;;;###autoload
481 "Run Ediff on a directory, DIR1, comparing its files with their revisions.
482 The second argument, REGEXP, is a regular expression that filters the file
483 names. Only the files that are under revision control are taken into account."
490 )))
493 ))
495 ;;;###autoload
499 ;;;###autoload
501 "Run Ediff on three directories, DIR1, DIR2, and DIR3, comparing files that
502 have the same name in all three. The last argument, REGEXP, is a regular
503 expression that can be used to filter out certain file names."
506 f)
510 ediff-last-dir-B
512 nil))
515 ediff-last-dir-C
517 nil)
520 )))
523 ))
525 ;;;###autoload
528 ;;;###autoload
530 "Run Ediff on a pair of directories, DIR1 and DIR2, merging files that have
531 the same name in both. The third argument, REGEXP, is a regular expression that
532 can be used to filter out certain file names."
535 f)
539 ediff-last-dir-B
541 nil)
544 )))
547 ))
549 ;;;###autoload
552 ;;;###autoload
554 "Merge files in directories DIR1 and DIR2 using files in ANCESTOR-DIR as ancestors.
555 Ediff merges files that have identical names in DIR1, DIR2. If a pair of files
556 in DIR1 and DIR2 doesn't have an ancestor in ANCESTOR-DIR, Ediff will merge
557 without ancestor. The fourth argument, REGEXP, is a regular expression that
558 can be used to filter out certain file names."
561 f)
565 ediff-last-dir-B
567 nil))
570 ediff-last-dir-C
572 nil)
575 )))
577 dir1 dir2 ancestor-dir regexp
579 ))
581 ;;;###autoload
583 "Run Ediff on a directory, DIR1, merging its files with their revisions.
584 The second argument, REGEXP, is a regular expression that filters the file
585 names. Only the files that are under revision control are taken into account."
592 )))
595 ))
597 ;;;###autoload
600 ;;;###autoload
602 "Run Ediff on a directory, DIR1, merging its files with their revisions and ancestors.
603 The second argument, REGEXP, is a regular expression that filters the file
604 names. Only the files that are under revision control are taken into account."
611 )))
613 dir1 regexp 'ediff-merge-revisions-with-ancestor
614 'ediff-merge-directory-revisions-with-ancestor
615 ))
617 ;;;###autoload
619 'edir-merge-revisions-with-ancestor
622 ;;;###autoload
625 ;; Run ediff-action (ediff-files, ediff-merge, ediff-merge-with-ancestors)
626 ;; on a pair of directories (three directories, in case of ancestor).
627 ;; The third argument, REGEXP, is a regular expression that can be used to
628 ;; filter out certain file names.
629 ;; JOBNAME is the symbol indicating the meta-job to be performed.
630 ;; MERGE-DIR is the directory in which to store merged files.
633 ;; ediff-read-file-name is set to attach a previously entered file name if
634 ;; the currently entered file is a directory. This code takes care of that.
651 merge-autostore-dir
652 file-list meta-buf)
657 ediff-last-merge-autostore-dir
659 nil)))
660 ;; verify we are not merging into an orig directory
674 jobname 'diffs
675 regexp dir1 dir2 dir3 merge-autostore-dir))
677 ;; this sets various vars in the meta buffer inside
678 ;; ediff-prepare-meta-buffer
680 ;; tell what to do if the user clicks on a session record
682 ;; set ediff-dir-difference-list
684 startup-hooks))
686 'ediff-filegroup-action
687 file-list
688 "*Ediff Session Group Panel"
689 'ediff-redraw-directory-group-buffer
690 jobname
691 startup-hooks))
693 ))
704 ediff-last-merge-autostore-dir
706 nil)))
707 ;; verify merge-autostore-dir != dir1
717 jobname regexp dir1 merge-autostore-dir))
719 ;; this sets various vars in the meta buffer inside
720 ;; ediff-prepare-meta-buffer
722 ;; tell what to do if the user clicks on a session record
724 ))
725 startup-hooks))
727 'ediff-filegroup-action
728 file-list
729 "*Ediff Session Group Panel"
730 'ediff-redraw-directory-group-buffer
731 jobname
732 startup-hooks))
734 ))
737 ;;; Compare regions and windows
739 ;;;###autoload
741 "Compare WIND-A and WIND-B, which are selected by clicking, wordwise.
742 With prefix argument, DUMB-MODE, or on a non-windowing display, works as
743 follows:
744 If WIND-A is nil, use selected window.
745 If WIND-B is nil, use window next to WIND-A."
750 ;;;###autoload
752 "Compare WIND-A and WIND-B, which are selected by clicking, linewise.
753 With prefix argument, DUMB-MODE, or on a non-windowing display, works as
754 follows:
755 If WIND-A is nil, use selected window.
756 If WIND-B is nil, use window next to WIND-A."
761 ;; Compare WIND-A and WIND-B, which are selected by clicking.
762 ;; With prefix argument, DUMB-MODE, or on a non-windowing display,
763 ;; works as follows:
764 ;; If WIND-A is nil, use selected window.
765 ;; If WIND-B is nil, use window next to WIND-A.
775 beg-A end-A beg-B end-B)
787 buffer-A beg-A end-A buffer-B beg-B end-B
788 startup-hooks job-name word-mode nil)))
790 ;;;###autoload
792 "Run Ediff on a pair of regions in two different buffers.
793 Regions \(i.e., point and mark\) are assumed to be set in advance.
794 This function is effective only for relatively small regions, up to 200
795 lines. For large regions, use `ediff-regions-linewise'."
802 ;; realign buffers so that two visible bufs will be
803 ;; at the top
806 t))))
827 ;;;###autoload
829 "Run Ediff on a pair of regions in two different buffers.
830 Regions \(i.e., point and mark\) are assumed to be set in advance.
831 Each region is enlarged to contain full lines.
832 This function is effective for large regions, over 100-200
833 lines. For small regions, use `ediff-regions-wordwise'."
840 ;; realign buffers so that two visible bufs will be
841 ;; at the top
844 t))))
855 ;; enlarge the region to hold full lines
867 ;; enlarge the region to hold full lines
882 ;; compare region beg-A to end-A of buffer-A
883 ;; to regions beg-B -- end-B in buffer-B.
885 startup-hooks job-name word-mode
886 setup-parameters)
888 overl-A overl-B
889 file-A file-B)
891 ;; in case beg/end-A/B aren't markers--make them into markers
905 You have requested to compare overlapping regions of the same buffer.
907 In this case, Ediff's highlighting may be confusing---in the same window,
908 you may see highlighted regions that belong to different regions.
913 ()
916 ;; make file-A
922 ;; make file-B
931 buffer-B file-B
932 nil nil ; buffer & file C
936 startup-hooks)
941 setup-parameters)
942 )
943 ))
946 ;;; Merge files and buffers
948 ;;;###autoload
956 ;;;###autoload
958 "Merge two files without ancestor."
961 ediff-last-dir-A
962 default-directory))
963 dir-B f)
965 "File A to merge" dir-A
970 ediff-last-dir-B
977 dir-B))
978 file-name-history))
979 f))
980 )))
986 file-B)
987 nil ; file-C
988 startup-hooks
991 ;;;###autoload
994 "Merge two files with ancestor."
997 ediff-last-dir-A
998 default-directory))
999 dir-B dir-ancestor f ff)
1001 "File A to merge" dir-A
1006 ediff-last-dir-B
1014 dir-B))
1015 file-name-history))
1016 f)))
1020 ediff-last-dir-ancestor
1027 dir-ancestor))
1028 file-name-history))
1029 ff))
1030 )))
1036 file-B)
1037 file-ancestor
1038 startup-hooks
1041 ;;;###autoload
1044 ;;;###autoload
1046 "Merge buffers without ancestor."
1053 ;; realign buffers so that two visible bufs will be
1054 ;; at the top
1057 t))))
1062 buffer-A buffer-B nil startup-hooks job-name))
1064 ;;;###autoload
1066 buffer-B buffer-ancestor
1068 "Merge buffers with ancestor."
1075 ;; realign buffers so that two visible
1076 ;; bufs will be at the top
1079 t))
1082 ;; realign buffers so that three visible
1083 ;; bufs will be at the top
1086 t)
1087 )))
1092 buffer-A buffer-B buffer-ancestor startup-hooks job-name))
1095 ;;;###autoload
1097 "Run Ediff by merging two revisions of a file.
1098 The file is the optional FILE argument or the file visited by the current
1099 buffer."
1106 "Version 1 to merge (default: %s's latest version): "
1109 rev2
1112 "Version 2 to merge (default: %s): "
1116 ;; ancestor-revision=nil
1119 rev1 rev2 nil startup-hooks)))
1122 ;;;###autoload
1124 "Run Ediff by merging two revisions of a file with a common ancestor.
1125 The file is the the optional FILE argument or the file visited by the current
1126 buffer."
1133 "Version 1 to merge (default: %s's latest version): "
1136 rev2
1139 "Version 2 to merge (default: %s): "
1142 ancestor-rev
1145 "Ancestor version (default: %s): "
1151 rev1 rev2 ancestor-rev startup-hooks)))
1153 ;;;###autoload
1155 "Run Ediff-merge on appropriate revisions of the selected file.
1156 First run after `M-x cvs-update'. Then place the cursor on a line describing a
1157 file and then run `run-ediff-from-cvs-buffer'."
1166 ;;; Apply patch
1168 ;;;###autoload
1170 "Run Ediff by patching SOURCE-FILENAME."
1171 ;; This now returns the control buffer
1184 ;; the default is the directory, not the visited file name
1188 ;;;###autoload
1190 "Run Ediff by patching BUFFER-NAME."
1196 patch-buf
1203 ;;;###autoload
1205 ;;;###autoload
1210 \f
1211 ;;; Versions Control functions
1213 ;;;###autoload
1215 "Run Ediff by comparing versions of a file.
1216 The file is an optional FILE argument or the file visited by the current
1217 buffer. Use `vc.el' or `rcs.el' depending on `ediff-version-control-package'."
1218 ;; if buffer is non-nil, use that buffer instead of the current buffer
1227 rev2
1235 rev1 rev2 startup-hooks)
1236 ))
1239 ;;;###autoload
1243 ;; Test if version control package is loaded and load if not
1244 ;; Is SILENT is non-nil, don't report error if package is not found.
1254 ediff-version-control-package)))))
1257 ;;;###autoload
1259 "Return string describing the version of Ediff.
1260 When called interactively, displays the version."
1267 ;;;###autoload
1269 "Display Ediff's manual.
1270 With optional NODE, goes to that node."
1295 ;;; Local Variables:
1296 ;;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
1297 ;;; eval: (put 'ediff-with-current-buffer 'lisp-indent-hook 1)
1298 ;;; eval: (put 'ediff-with-current-buffer 'edebug-form-spec '(form body))
1299 ;;; End:
1303 ;;; ediff.el ends here