| blob | 5b0f85d05cd22e75cbd16da91c2254b7ee5a27f7 |
1 ;;; ediff.el --- a comprehensive visual interface to diff & patch
3 ;; Copyright (C) 1994, 95, 96, 97, 98, 99, 2000, 01, 02 Free Software Foundation, Inc.
5 ;; Author: Michael Kifer <kifer@cs.stonybrook.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"
203 dir-A
209 ediff-last-dir-B
216 dir-B))
217 file-name-history))
219 )))
224 file-B)
225 nil ; file-C
226 startup-hooks
229 ;;;###autoload
231 "Run Ediff on three files, FILE-A, FILE-B, and FILE-C."
234 ediff-last-dir-A
235 default-directory))
236 dir-B dir-C f ff)
238 "File A to compare"
239 dir-A
245 ediff-last-dir-B
253 dir-B))
254 file-name-history))
258 ediff-last-dir-C
265 dir-C))
266 file-name-history))
268 )))
273 file-B)
277 file-C)
278 startup-hooks
281 ;;;###autoload
285 ;; Visit FILE and arrange its buffer to Ediff's liking.
286 ;; FILE is actually a variable symbol that must contain a true file name.
287 ;; BUFFER-NAME is a variable symbol, which will get the buffer object into
288 ;; which FILE is read.
289 ;; LAST-DIR is the directory variable symbol where FILE's
290 ;; directory name should be returned. HOOKS-VAR is a variable symbol that will
291 ;; be assigned the hook to be executed after `ediff-startup' is finished.
292 ;; `ediff-find-file' arranges that the temp files it might create will be
293 ;; deleted.
303 ;; some of the commands, below, require full file name
306 ;; Record the directory of the file
310 ;; Setup the buffer
316 ;;; ange-ftp-hook-function--arrange for temp file
323 ;; file processed via auto-mode-alist, a la uncompress.el
335 ;; MERGE-BUFFER-FILE is the file to be associated with the merge buffer
345 ;;(sit-for 0)
348 ;;(sit-for 0)
353 ;;(sit-for 0)
360 buf-B file-B
361 buf-C file-C
362 startup-hooks
364 merge-buffer-file)))
367 ;;;###autoload
370 ;;;###autoload
372 "Run Ediff on FILE and its backup file.
373 Uses the latest backup, if there are several numerical backups.
374 If this file is a backup, `ediff' it with its original."
376 ;; The code is taken from `diff-backup'.
384 ori file))
387 ;;;###autoload
389 "Run Ediff on a pair of buffers, BUFFER-A and BUFFER-B."
396 ;; realign buffers so that two visible bufs will be
397 ;; at the top
400 t))))
404 ;;;###autoload
408 ;;;###autoload
411 "Run Ediff on three buffers, BUFFER-A, BUFFER-B, and BUFFER-C."
418 ;; realign buffers so that two visible
419 ;; bufs will be at the top
422 t))
425 ;; realign buffers so that three visible
426 ;; bufs will be at the top
429 t)
430 )))
434 ;;;###autoload
439 ;; MERGE-BUFFER-FILE is the file to be associated with the merge buffer
447 file-A file-B file-C)
471 file-C
476 startup-hooks)
478 merge-buffer-file)))
481 ;;; Directory and file group operations
483 ;; Get appropriate default name for directory:
484 ;; If ediff-use-last-dir, use ediff-last-dir-A.
485 ;; In dired mode, use the directory that is under the point (if any);
486 ;; otherwise, use default-directory
492 f
493 default-directory)))
497 ;;;###autoload
499 "Run Ediff on a pair of directories, DIR1 and DIR2, comparing files that have
500 the same name in both. The third argument, REGEXP, is a regular expression
501 that can be used to filter out certain file names."
504 f)
508 ediff-last-dir-B
510 nil)
513 )))
516 ))
518 ;;;###autoload
522 ;;;###autoload
524 "Run Ediff on a directory, DIR1, comparing its files with their revisions.
525 The second argument, REGEXP, is a regular expression that filters the file
526 names. Only the files that are under revision control are taken into account."
533 )))
536 ))
538 ;;;###autoload
542 ;;;###autoload
544 "Run Ediff on three directories, DIR1, DIR2, and DIR3, comparing files that
545 have the same name in all three. The last argument, REGEXP, is a regular
546 expression that can be used to filter out certain file names."
549 f)
553 ediff-last-dir-B
555 nil))
558 ediff-last-dir-C
560 nil)
563 )))
566 ))
568 ;;;###autoload
571 ;;;###autoload
573 "Run Ediff on a pair of directories, DIR1 and DIR2, merging files that have
574 the same name in both. The third argument, REGEXP, is a regular expression
575 that can be used to filter out certain file names."
578 f)
582 ediff-last-dir-B
584 nil)
587 )))
590 nil merge-autostore-dir
591 ))
593 ;;;###autoload
596 ;;;###autoload
598 &optional
599 merge-autostore-dir)
600 "Merge files in directories DIR1 and DIR2 using files in ANCESTOR-DIR as ancestors.
601 Ediff merges files that have identical names in DIR1, DIR2. If a pair of files
602 in DIR1 and DIR2 doesn't have an ancestor in ANCESTOR-DIR, Ediff will merge
603 without ancestor. The fourth argument, REGEXP, is a regular expression that
604 can be used to filter out certain file names."
607 f)
611 ediff-last-dir-B
613 nil))
616 ediff-last-dir-C
618 nil)
621 )))
623 dir1 dir2 ancestor-dir regexp
625 nil merge-autostore-dir
626 ))
628 ;;;###autoload
631 "Run Ediff on a directory, DIR1, merging its files with their revisions.
632 The second argument, REGEXP, is a regular expression that filters the file
633 names. Only the files that are under revision control are taken into account."
640 )))
643 nil merge-autostore-dir
644 ))
646 ;;;###autoload
649 ;;;###autoload
651 &optional
652 merge-autostore-dir)
653 "Run Ediff on a directory, DIR1, merging its files with their revisions and ancestors.
654 The second argument, REGEXP, is a regular expression that filters the file
655 names. Only the files that are under revision control are taken into account."
662 )))
664 dir1 regexp 'ediff-merge-revisions-with-ancestor
665 'ediff-merge-directory-revisions-with-ancestor
666 nil merge-autostore-dir
667 ))
669 ;;;###autoload
671 'edir-merge-revisions-with-ancestor
674 ;;;###autoload
677 ;; Run ediff-action (ediff-files, ediff-merge, ediff-merge-with-ancestors)
678 ;; on a pair of directories (three directories, in case of ancestor).
679 ;; The third argument, REGEXP, is a regular expression that can be used to
680 ;; filter out certain file names.
681 ;; JOBNAME is the symbol indicating the meta-job to be performed.
682 ;; MERGE-AUTOSTORE-DIR is the directory in which to store merged files.
684 &optional startup-hooks
685 merge-autostore-dir)
686 ;; ediff-read-file-name is set to attach a previously entered file name if
687 ;; the currently entered file is a directory. This code takes care of that.
706 jobname)))
708 ;; It is a structure where ediff-intersect-directories returns
709 ;; commonalities and differences among directories
710 dir-diff-struct
711 meta-buf)
718 ediff-last-merge-autostore-dir
720 nil
722 ;; verify we are not merging into an orig directory
738 jobname
739 regexp dir1 dir2 dir3 merge-autostore-dir))
741 ;; this sets various vars in the meta buffer inside
742 ;; ediff-prepare-meta-buffer
744 ;; tell what to do if the user clicks on a session record
746 ;; set ediff-dir-difference-list
749 startup-hooks))
751 'ediff-filegroup-action
753 "*Ediff Session Group Panel"
754 'ediff-redraw-directory-group-buffer
755 jobname
756 startup-hooks))
758 ))
760 ;; MERGE-AUTOSTORE-DIR can be given to tell ediff where to store the merged
761 ;; files
763 &optional startup-hooks
764 merge-autostore-dir)
770 jobname)))
778 ediff-last-merge-autostore-dir
780 nil
782 ;; verify merge-autostore-dir != dir1
792 jobname regexp dir1 merge-autostore-dir))
794 ;; this sets various vars in the meta buffer inside
795 ;; ediff-prepare-meta-buffer
797 ;; tell what to do if the user clicks on a session record
799 startup-hooks))
801 'ediff-filegroup-action
802 file-list
803 "*Ediff Session Group Panel"
804 'ediff-redraw-directory-group-buffer
805 jobname
806 startup-hooks))
808 ))
811 ;;; Compare regions and windows
813 ;;;###autoload
815 "Compare WIND-A and WIND-B, which are selected by clicking, wordwise.
816 With prefix argument, DUMB-MODE, or on a non-windowing display, works as
817 follows:
818 If WIND-A is nil, use selected window.
819 If WIND-B is nil, use window next to WIND-A."
824 ;;;###autoload
826 "Compare WIND-A and WIND-B, which are selected by clicking, linewise.
827 With prefix argument, DUMB-MODE, or on a non-windowing display, works as
828 follows:
829 If WIND-A is nil, use selected window.
830 If WIND-B is nil, use window next to WIND-A."
835 ;; Compare WIND-A and WIND-B, which are selected by clicking.
836 ;; With prefix argument, DUMB-MODE, or on a non-windowing display,
837 ;; works as follows:
838 ;; If WIND-A is nil, use selected window.
839 ;; If WIND-B is nil, use window next to WIND-A.
849 beg-A end-A beg-B end-B)
863 buffer-B
867 buffer-A beg-A end-A buffer-B beg-B end-B
868 startup-hooks job-name word-mode nil)))
871 ;;;###autoload
873 "Run Ediff on a pair of regions in specified buffers.
874 Regions \(i.e., point and mark\) are assumed to be set in advance except
875 for the second region in the case both regions are from the same buffer.
876 In such a case the user is asked to interactively establish the second
877 region.
878 This function is effective only for relatively small regions, up to 200
879 lines. For large regions, use `ediff-regions-linewise'."
886 ;; realign buffers so that two visible bufs will be
887 ;; at the top
890 t))))
901 reg-A-beg reg-A-end reg-B-beg reg-B-end)
915 ;;;###autoload
917 "Run Ediff on a pair of regions in specified buffers.
918 Regions \(i.e., point and mark\) are assumed to be set in advance except
919 for the second region in the case both regions are from the same buffer.
920 In such a case the user is asked to interactively establish the second
921 region.
922 Each region is enlarged to contain full lines.
923 This function is effective for large regions, over 100-200
924 lines. For small regions, use `ediff-regions-wordwise'."
931 ;; realign buffers so that two visible bufs will be
932 ;; at the top
935 t))))
945 reg-A-beg reg-A-end reg-B-beg reg-B-end)
950 ;; enlarge the region to hold full lines
962 ;; enlarge the region to hold full lines
977 ;; compare region beg-A to end-A of buffer-A
978 ;; to regions beg-B -- end-B in buffer-B.
980 startup-hooks job-name word-mode
981 setup-parameters)
983 overl-A overl-B
984 file-A file-B)
986 ;; in case beg/end-A/B aren't markers--make them into markers
994 ;; make file-A
1000 ;; make file-B
1009 buffer-B file-B
1010 nil nil ; buffer & file C
1014 startup-hooks)
1019 setup-parameters))
1020 ))
1023 ;;; Merge files and buffers
1025 ;;;###autoload
1033 ;;;###autoload
1035 ;; MERGE-BUFFER-FILE is the file to be
1036 ;; associated with the merge buffer
1038 "Merge two files without ancestor."
1041 ediff-last-dir-A
1042 default-directory))
1043 dir-B f)
1045 "File A to merge"
1046 dir-A
1052 ediff-last-dir-B
1059 dir-B))
1060 file-name-history))
1062 )))
1068 file-B)
1069 nil ; file-C
1070 startup-hooks
1071 'ediff-merge-files
1072 merge-buffer-file))
1074 ;;;###autoload
1076 &optional
1077 startup-hooks
1078 ;; MERGE-BUFFER-FILE is the file
1079 ;; to be associated with the
1080 ;; merge buffer
1081 merge-buffer-file)
1082 "Merge two files with ancestor."
1085 ediff-last-dir-A
1086 default-directory))
1087 dir-B dir-ancestor f ff)
1089 "File A to merge"
1090 dir-A
1096 ediff-last-dir-B
1104 dir-B))
1105 file-name-history))
1110 ediff-last-dir-ancestor
1117 dir-ancestor))
1118 file-name-history))
1120 )))
1126 file-B)
1127 file-ancestor
1128 startup-hooks
1129 'ediff-merge-files-with-ancestor
1130 merge-buffer-file))
1132 ;;;###autoload
1135 ;;;###autoload
1137 &optional
1138 ;; MERGE-BUFFER-FILE is the file to be
1139 ;; associated with the merge buffer
1140 startup-hooks job-name merge-buffer-file)
1141 "Merge buffers without ancestor."
1148 ;; realign buffers so that two visible bufs will be
1149 ;; at the top
1152 t))))
1157 buffer-A buffer-B nil startup-hooks job-name merge-buffer-file))
1159 ;;;###autoload
1161 &optional
1162 startup-hooks
1163 job-name
1164 ;; MERGE-BUFFER-FILE is the
1165 ;; file to be associated
1166 ;; with the merge buffer
1167 merge-buffer-file)
1168 "Merge buffers with ancestor."
1175 ;; realign buffers so that two visible
1176 ;; bufs will be at the top
1179 t))
1182 ;; realign buffers so that three visible
1183 ;; bufs will be at the top
1186 t)
1187 )))
1192 buffer-A buffer-B buffer-ancestor startup-hooks job-name merge-buffer-file))
1195 ;;;###autoload
1197 ;; MERGE-BUFFER-FILE is the file to be associated with the merge buffer
1198 "Run Ediff by merging two revisions of a file.
1199 The file is the optional FILE argument or the file visited by the current
1200 buffer."
1207 "Version 1 to merge (default: %s's working version): "
1210 rev2
1213 "Version 2 to merge (default: %s): "
1217 ;; ancestor-revision=nil
1220 rev1 rev2 nil startup-hooks merge-buffer-file)))
1223 ;;;###autoload
1225 file startup-hooks
1226 ;; MERGE-BUFFER-FILE is the file to
1227 ;; be associated with the merge
1228 ;; buffer
1229 merge-buffer-file)
1230 "Run Ediff by merging two revisions of a file with a common ancestor.
1231 The file is the optional FILE argument or the file visited by the current
1232 buffer."
1239 "Version 1 to merge (default: %s's working version): "
1242 rev2
1245 "Version 2 to merge (default: %s): "
1248 ancestor-rev
1251 "Ancestor version (default: %s's base revision): "
1257 rev1 rev2 ancestor-rev startup-hooks merge-buffer-file)))
1259 ;; MK: Check. This function doesn't seem to be used any more by pcvs or pcl-cvs
1260 ;;;###autoload
1262 "Run Ediff-merge on appropriate revisions of the selected file.
1263 First run after `M-x cvs-update'. Then place the cursor on a line describing a
1264 file and then run `run-ediff-from-cvs-buffer'."
1273 ;;; Apply patch
1275 ;;;###autoload
1277 "Run Ediff by patching SOURCE-FILENAME.
1278 If optional PATCH-BUF is given, use the patch in that buffer
1279 and don't ask the user.
1280 If prefix argument, then: if even argument, assume that the patch is in a
1281 buffer. If odd -- assume it is in a file."
1297 "File to patch (directory, if multifile patch): "
1298 ;; use an explicit initial file
1302 ;;;###autoload
1304 "Run Ediff by patching BUFFER-NAME.
1305 Without prefix argument: asks if the patch is in some buffer and prompts for
1306 the buffer or a file, depending on the answer.
1307 With prefix arg=1: assumes the patch is in a file and prompts for the file.
1308 With prefix arg=2: assumes the patch is in a buffer and prompts for the buffer."
1315 patch-buf
1317 "Which buffer to patch? "
1321 ;;;###autoload
1323 ;;;###autoload
1328 \f
1329 ;;; Versions Control functions
1331 ;;;###autoload
1333 "Run Ediff by comparing versions of a file.
1334 The file is an optional FILE argument or the file entered at the prompt.
1335 Default: the file visited by the current buffer.
1336 Uses `vc.el' or `rcs.el' depending on `ediff-version-control-package'."
1337 ;; if buffer is non-nil, use that buffer instead of the current buffer
1343 ediff-last-dir-A
1344 default-directory)
1357 rev2
1364 rev1 rev2 startup-hooks)
1365 ))
1368 ;;;###autoload
1372 ;; Test if version control package is loaded and load if not
1373 ;; Is SILENT is non-nil, don't report error if package is not found.
1383 ediff-version-control-package)))))
1386 ;;;###autoload
1388 "Return string describing the version of Ediff.
1389 When called interactively, displays the version."
1396 ;;;###autoload
1398 "Display Ediff's manual.
1399 With optional NODE, goes to that node."
1426 ;;; Local Variables:
1427 ;;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
1428 ;;; eval: (put 'ediff-with-current-buffer 'lisp-indent-hook 1)
1429 ;;; eval: (put 'ediff-with-current-buffer 'edebug-form-spec '(form body))
1430 ;;; End:
1436 ;;; ediff.el ends here