| blob | d824128e4d069da8bd06e738877e6af1afa311ad |
1 ;;; ediff.el --- a comprehensive visual interface to diff & patch
3 ;; Copyright (C) 1994, 95, 96, 97, 98, 99, 2000, 01 Free Software Foundation, Inc.
5 ;; Author: Michael Kifer <kifer@cs.sunysb.edu>
6 ;; Created: February 2, 1994
7 ;; Keywords: comparing, merging, patching, tools, unix
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 number FILENO (or 0) in the list
167 ;; (all-selected-files, filename under the cursor), where directories are
168 ;; ignored. Otherwise, return DEFAULT file name, if non-nil. Else,
169 ;; if the buffer is visiting a file, return that file name.
176 aux-list choices result)
185 default)))
189 ))
191 ;;; Compare files/buffers
193 ;;;###autoload
195 "Run Ediff on a pair of files, FILE-A and FILE-B."
198 ediff-last-dir-A
199 default-directory))
200 dir-B f)
202 "File A to compare" dir-A
207 ediff-last-dir-B
214 dir-B))
215 file-name-history))
217 )))
222 file-B)
223 nil ; file-C
224 startup-hooks
227 ;;;###autoload
229 "Run Ediff on three files, FILE-A, FILE-B, and FILE-C."
232 ediff-last-dir-A
233 default-directory))
234 dir-B dir-C f ff)
236 "File A to compare" dir-A
241 ediff-last-dir-B
249 dir-B))
250 file-name-history))
254 ediff-last-dir-C
261 dir-C))
262 file-name-history))
264 )))
269 file-B)
273 file-C)
274 startup-hooks
277 ;;;###autoload
281 ;; Visit FILE and arrange its buffer to Ediff's liking.
282 ;; FILE is actually a variable symbol that must contain a true file name.
283 ;; BUFFER-NAME is a variable symbol, which will get the buffer object into
284 ;; which FILE is read.
285 ;; LAST-DIR is the directory variable symbol where FILE's
286 ;; directory name should be returned. HOOKS-VAR is a variable symbol that will
287 ;; be assigned the hook to be executed after `ediff-startup' is finished.
288 ;; `ediff-find-file' arranges that the temp files it might create will be
289 ;; deleted.
299 ;; some of the commands, below, require full file name
302 ;; Record the directory of the file
306 ;; Setup the buffer
312 ;;; ange-ftp-hook-function--arrange for temp file
319 ;; file processed via auto-mode-alist, a la uncompress.el
331 ;; MERGE-BUFFER-FILE is the file to be associated with the merge buffer
336 ;;(sit-for 0)
339 ;;(sit-for 0)
344 ;;(sit-for 0)
351 buf-B file-B
352 buf-C file-C
353 startup-hooks
355 merge-buffer-file)))
358 ;;;###autoload
362 ;;;###autoload
364 "Run Ediff on a pair of buffers, BUFFER-A and BUFFER-B."
371 ;; realign buffers so that two visible bufs will be
372 ;; at the top
375 t))))
379 ;;;###autoload
383 ;;;###autoload
386 "Run Ediff on three buffers, BUFFER-A, BUFFER-B, and BUFFER-C."
393 ;; realign buffers so that two visible
394 ;; bufs will be at the top
397 t))
400 ;; realign buffers so that three visible
401 ;; bufs will be at the top
404 t)
405 )))
409 ;;;###autoload
414 ;; MERGE-BUFFER-FILE is the file to be associated with the merge buffer
422 file-A file-B file-C)
446 file-C
451 startup-hooks)
453 merge-buffer-file)))
456 ;;; Directory and file group operations
458 ;; Get appropriate default name for directory:
459 ;; If ediff-use-last-dir, use ediff-last-dir-A.
460 ;; In dired mode, use the directory that is under the point (if any);
461 ;; otherwise, use default-directory
467 f
468 default-directory)))
472 ;;;###autoload
474 "Run Ediff on a pair of directories, DIR1 and DIR2, comparing files that have
475 the same name in both. The third argument, REGEXP, is a regular expression
476 that can be used to filter out certain file names."
479 f)
483 ediff-last-dir-B
485 nil)
488 )))
491 ))
493 ;;;###autoload
497 ;;;###autoload
499 "Run Ediff on a directory, DIR1, comparing its files with their revisions.
500 The second argument, REGEXP, is a regular expression that filters the file
501 names. Only the files that are under revision control are taken into account."
508 )))
511 ))
513 ;;;###autoload
517 ;;;###autoload
519 "Run Ediff on three directories, DIR1, DIR2, and DIR3, comparing files that
520 have the same name in all three. The last argument, REGEXP, is a regular
521 expression that can be used to filter out certain file names."
524 f)
528 ediff-last-dir-B
530 nil))
533 ediff-last-dir-C
535 nil)
538 )))
541 ))
543 ;;;###autoload
546 ;;;###autoload
548 "Run Ediff on a pair of directories, DIR1 and DIR2, merging files that have
549 the same name in both. The third argument, REGEXP, is a regular expression
550 that can be used to filter out certain file names."
553 f)
557 ediff-last-dir-B
559 nil)
562 )))
565 nil merge-autostore-dir
566 ))
568 ;;;###autoload
571 ;;;###autoload
573 &optional
574 merge-autostore-dir)
575 "Merge files in directories DIR1 and DIR2 using files in ANCESTOR-DIR as ancestors.
576 Ediff merges files that have identical names in DIR1, DIR2. If a pair of files
577 in DIR1 and DIR2 doesn't have an ancestor in ANCESTOR-DIR, Ediff will merge
578 without ancestor. The fourth argument, REGEXP, is a regular expression that
579 can be used to filter out certain file names."
582 f)
586 ediff-last-dir-B
588 nil))
591 ediff-last-dir-C
593 nil)
596 )))
598 dir1 dir2 ancestor-dir regexp
600 nil merge-autostore-dir
601 ))
603 ;;;###autoload
606 "Run Ediff on a directory, DIR1, merging its files with their revisions.
607 The second argument, REGEXP, is a regular expression that filters the file
608 names. Only the files that are under revision control are taken into account."
615 )))
618 nil merge-autostore-dir
619 ))
621 ;;;###autoload
624 ;;;###autoload
626 &optional
627 merge-autostore-dir)
628 "Run Ediff on a directory, DIR1, merging its files with their revisions and ancestors.
629 The second argument, REGEXP, is a regular expression that filters the file
630 names. Only the files that are under revision control are taken into account."
637 )))
639 dir1 regexp 'ediff-merge-revisions-with-ancestor
640 'ediff-merge-directory-revisions-with-ancestor
641 nil merge-autostore-dir
642 ))
644 ;;;###autoload
646 'edir-merge-revisions-with-ancestor
649 ;;;###autoload
652 ;; Run ediff-action (ediff-files, ediff-merge, ediff-merge-with-ancestors)
653 ;; on a pair of directories (three directories, in case of ancestor).
654 ;; The third argument, REGEXP, is a regular expression that can be used to
655 ;; filter out certain file names.
656 ;; JOBNAME is the symbol indicating the meta-job to be performed.
657 ;; MERGE-AUTOSTORE-DIR is the directory in which to store merged files.
659 &optional startup-hooks
660 merge-autostore-dir)
661 ;; ediff-read-file-name is set to attach a previously entered file name if
662 ;; the currently entered file is a directory. This code takes care of that.
681 jobname)))
683 file-list meta-buf)
690 ediff-last-merge-autostore-dir
692 nil
694 ;; verify we are not merging into an orig directory
710 jobname 'diffs
711 regexp dir1 dir2 dir3 merge-autostore-dir))
713 ;; this sets various vars in the meta buffer inside
714 ;; ediff-prepare-meta-buffer
716 ;; tell what to do if the user clicks on a session record
718 ;; set ediff-dir-difference-list
720 startup-hooks))
722 'ediff-filegroup-action
723 file-list
724 "*Ediff Session Group Panel"
725 'ediff-redraw-directory-group-buffer
726 jobname
727 startup-hooks))
729 ))
731 ;; MERGE-AUTOSTORE-DIR can be given to tell ediff where to store the merged
732 ;; files
734 &optional startup-hooks
735 merge-autostore-dir)
741 jobname)))
749 ediff-last-merge-autostore-dir
751 nil
753 ;; verify merge-autostore-dir != dir1
763 jobname regexp dir1 merge-autostore-dir))
765 ;; this sets various vars in the meta buffer inside
766 ;; ediff-prepare-meta-buffer
768 ;; tell what to do if the user clicks on a session record
770 startup-hooks))
772 'ediff-filegroup-action
773 file-list
774 "*Ediff Session Group Panel"
775 'ediff-redraw-directory-group-buffer
776 jobname
777 startup-hooks))
779 ))
782 ;;; Compare regions and windows
784 ;;;###autoload
786 "Compare WIND-A and WIND-B, which are selected by clicking, wordwise.
787 With prefix argument, DUMB-MODE, or on a non-windowing display, works as
788 follows:
789 If WIND-A is nil, use selected window.
790 If WIND-B is nil, use window next to WIND-A."
795 ;;;###autoload
797 "Compare WIND-A and WIND-B, which are selected by clicking, linewise.
798 With prefix argument, DUMB-MODE, or on a non-windowing display, works as
799 follows:
800 If WIND-A is nil, use selected window.
801 If WIND-B is nil, use window next to WIND-A."
806 ;; Compare WIND-A and WIND-B, which are selected by clicking.
807 ;; With prefix argument, DUMB-MODE, or on a non-windowing display,
808 ;; works as follows:
809 ;; If WIND-A is nil, use selected window.
810 ;; If WIND-B is nil, use window next to WIND-A.
820 beg-A end-A beg-B end-B)
832 buffer-A beg-A end-A buffer-B beg-B end-B
833 startup-hooks job-name word-mode nil)))
835 ;;;###autoload
837 "Run Ediff on a pair of regions in two different buffers.
838 Regions \(i.e., point and mark\) are assumed to be set in advance.
839 This function is effective only for relatively small regions, up to 200
840 lines. For large regions, use `ediff-regions-linewise'."
847 ;; realign buffers so that two visible bufs will be
848 ;; at the top
851 t))))
872 ;;;###autoload
874 "Run Ediff on a pair of regions in two different buffers.
875 Regions \(i.e., point and mark\) are assumed to be set in advance.
876 Each region is enlarged to contain full lines.
877 This function is effective for large regions, over 100-200
878 lines. For small regions, use `ediff-regions-wordwise'."
885 ;; realign buffers so that two visible bufs will be
886 ;; at the top
889 t))))
900 ;; enlarge the region to hold full lines
912 ;; enlarge the region to hold full lines
927 ;; compare region beg-A to end-A of buffer-A
928 ;; to regions beg-B -- end-B in buffer-B.
930 startup-hooks job-name word-mode
931 setup-parameters)
933 overl-A overl-B
934 file-A file-B)
936 ;; in case beg/end-A/B aren't markers--make them into markers
952 You have requested to compare overlapping regions of the same buffer.
954 In this case, Ediff's highlighting may be confusing---in the same window,
955 you may see highlighted regions that belong to different regions.
960 ()
963 ;; make file-A
969 ;; make file-B
978 buffer-B file-B
979 nil nil ; buffer & file C
983 startup-hooks)
988 setup-parameters))
989 ))
992 ;;; Merge files and buffers
994 ;;;###autoload
1002 ;;;###autoload
1004 ;; MERGE-BUFFER-FILE is the file to be
1005 ;; associated with the merge buffer
1007 "Merge two files without ancestor."
1010 ediff-last-dir-A
1011 default-directory))
1012 dir-B f)
1014 "File A to merge" dir-A
1019 ediff-last-dir-B
1026 dir-B))
1027 file-name-history))
1029 )))
1035 file-B)
1036 nil ; file-C
1037 startup-hooks
1038 'ediff-merge-files
1039 merge-buffer-file))
1041 ;;;###autoload
1043 &optional
1044 startup-hooks
1045 ;; MERGE-BUFFER-FILE is the file
1046 ;; to be associated with the
1047 ;; merge buffer
1048 merge-buffer-file)
1049 "Merge two files with ancestor."
1052 ediff-last-dir-A
1053 default-directory))
1054 dir-B dir-ancestor f ff)
1056 "File A to merge" dir-A
1061 ediff-last-dir-B
1069 dir-B))
1070 file-name-history))
1075 ediff-last-dir-ancestor
1082 dir-ancestor))
1083 file-name-history))
1085 )))
1091 file-B)
1092 file-ancestor
1093 startup-hooks
1094 'ediff-merge-files-with-ancestor
1095 merge-buffer-file))
1097 ;;;###autoload
1100 ;;;###autoload
1102 &optional
1103 ;; MERGE-BUFFER-FILE is the file to be
1104 ;; associated with the merge buffer
1105 startup-hooks job-name merge-buffer-file)
1106 "Merge buffers without ancestor."
1113 ;; realign buffers so that two visible bufs will be
1114 ;; at the top
1117 t))))
1122 buffer-A buffer-B nil startup-hooks job-name merge-buffer-file))
1124 ;;;###autoload
1126 &optional
1127 startup-hooks
1128 job-name
1129 ;; MERGE-BUFFER-FILE is the
1130 ;; file to be associated
1131 ;; with the merge buffer
1132 merge-buffer-file)
1133 "Merge buffers with ancestor."
1140 ;; realign buffers so that two visible
1141 ;; bufs will be at the top
1144 t))
1147 ;; realign buffers so that three visible
1148 ;; bufs will be at the top
1151 t)
1152 )))
1157 buffer-A buffer-B buffer-ancestor startup-hooks job-name merge-buffer-file))
1160 ;;;###autoload
1162 ;; MERGE-BUFFER-FILE is the file to be associated with the merge buffer
1163 "Run Ediff by merging two revisions of a file.
1164 The file is the optional FILE argument or the file visited by the current
1165 buffer."
1172 "Version 1 to merge (default: %s's latest version): "
1175 rev2
1178 "Version 2 to merge (default: %s): "
1182 ;; ancestor-revision=nil
1185 rev1 rev2 nil startup-hooks merge-buffer-file)))
1188 ;;;###autoload
1190 file startup-hooks
1191 ;; MERGE-BUFFER-FILE is the file to
1192 ;; be associated with the merge
1193 ;; buffer
1194 merge-buffer-file)
1195 "Run Ediff by merging two revisions of a file with a common ancestor.
1196 The file is the the optional FILE argument or the file visited by the current
1197 buffer."
1204 "Version 1 to merge (default: %s's latest version): "
1207 rev2
1210 "Version 2 to merge (default: %s): "
1213 ancestor-rev
1216 "Ancestor version (default: %s's base revision): "
1222 rev1 rev2 ancestor-rev startup-hooks merge-buffer-file)))
1224 ;;;###autoload
1226 "Run Ediff-merge on appropriate revisions of the selected file.
1227 First run after `M-x cvs-update'. Then place the cursor on a line describing a
1228 file and then run `run-ediff-from-cvs-buffer'."
1237 ;;; Apply patch
1239 ;;;###autoload
1241 "Run Ediff by patching SOURCE-FILENAME.
1242 If optional PATCH-BUF is given, use the patch in that buffer
1243 and don't ask the user.
1244 If prefix argument, then: if even argument, assume that the patch is in a
1245 buffer. If odd -- assume it is in a file."
1261 "File to patch (directory, if multifile patch): "
1262 ;; use an explicit initial file
1266 ;;;###autoload
1268 "Run Ediff by patching BUFFER-NAME.
1269 Without prefix argument: asks if the patch is in some buffer and prompts for
1270 the buffer or a file, depending on the answer.
1271 With prefix arg=1: assumes the patch is in a file and prompts for the file.
1272 With prefix arg=2: assumes the patch is in a buffer and prompts for the buffer."
1279 patch-buf
1281 "Which buffer to patch? "
1285 ;;;###autoload
1287 ;;;###autoload
1292 \f
1293 ;;; Versions Control functions
1295 ;;;###autoload
1297 "Run Ediff by comparing versions of a file.
1298 The file is an optional FILE argument or the file entered at the prompt.
1299 Default: the file visited by the current buffer.
1300 Uses `vc.el' or `rcs.el' depending on `ediff-version-control-package'."
1301 ;; if buffer is non-nil, use that buffer instead of the current buffer
1307 ediff-last-dir-A
1308 default-directory)
1320 rev2
1327 rev1 rev2 startup-hooks)
1328 ))
1331 ;;;###autoload
1335 ;; Test if version control package is loaded and load if not
1336 ;; Is SILENT is non-nil, don't report error if package is not found.
1346 ediff-version-control-package)))))
1349 ;;;###autoload
1351 "Return string describing the version of Ediff.
1352 When called interactively, displays the version."
1359 ;;;###autoload
1361 "Display Ediff's manual.
1362 With optional NODE, goes to that node."
1389 ;;; Local Variables:
1390 ;;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
1391 ;;; eval: (put 'ediff-with-current-buffer 'lisp-indent-hook 1)
1392 ;;; eval: (put 'ediff-with-current-buffer 'edebug-form-spec '(form body))
1393 ;;; End:
1399 ;;; ediff.el ends here