| blob | 44eac2d7abd23a0cea3f4bb1912561588bca1aea |
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 nil or a regular
501 expression; only file names that match the regexp are considered."
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 nil or a
546 regular expression; only file names that match the regexp are considered."
550 f)
554 ediff-last-dir-B
556 nil))
559 ediff-last-dir-C
561 nil)
564 )))
567 ))
569 ;;;###autoload
572 ;;;###autoload
574 "Run Ediff on a pair of directories, DIR1 and DIR2, merging files that have
575 the same name in both. The third argument, REGEXP, is nil or a regular
576 expression; only file names that match the regexp are considered."
579 f)
583 ediff-last-dir-B
585 nil)
588 )))
591 nil merge-autostore-dir
592 ))
594 ;;;###autoload
597 ;;;###autoload
599 &optional
600 merge-autostore-dir)
601 "Merge files in directories DIR1 and DIR2 using files in ANCESTOR-DIR as ancestors.
602 Ediff merges files that have identical names in DIR1, DIR2. If a pair of files
603 in DIR1 and DIR2 doesn't have an ancestor in ANCESTOR-DIR, Ediff will merge
604 without ancestor. The fourth argument, REGEXP, is nil or a regular expression;
605 only file names that match the regexp are considered."
608 f)
612 ediff-last-dir-B
614 nil))
617 ediff-last-dir-C
619 nil)
622 )))
624 dir1 dir2 ancestor-dir regexp
626 nil merge-autostore-dir
627 ))
629 ;;;###autoload
632 "Run Ediff on a directory, DIR1, merging its files with their revisions.
633 The second argument, REGEXP, is a regular expression that filters the file
634 names. Only the files that are under revision control are taken into account."
641 )))
644 nil merge-autostore-dir
645 ))
647 ;;;###autoload
650 ;;;###autoload
652 &optional
653 merge-autostore-dir)
654 "Run Ediff on a directory, DIR1, merging its files with their revisions and ancestors.
655 The second argument, REGEXP, is a regular expression that filters the file
656 names. Only the files that are under revision control are taken into account."
663 )))
665 dir1 regexp 'ediff-merge-revisions-with-ancestor
666 'ediff-merge-directory-revisions-with-ancestor
667 nil merge-autostore-dir
668 ))
670 ;;;###autoload
672 'edir-merge-revisions-with-ancestor
675 ;;;###autoload
678 ;; Run ediff-action (ediff-files, ediff-merge, ediff-merge-with-ancestors)
679 ;; on a pair of directories (three directories, in case of ancestor).
680 ;; The third argument, REGEXP, is nil or a regular expression;
681 ;; only file names that match the regexp are considered.
682 ;; JOBNAME is the symbol indicating the meta-job to be performed.
683 ;; MERGE-AUTOSTORE-DIR is the directory in which to store merged files.
685 &optional startup-hooks
686 merge-autostore-dir)
687 ;; ediff-read-file-name is set to attach a previously entered file name if
688 ;; the currently entered file is a directory. This code takes care of that.
707 jobname)))
709 ;; It is a structure where ediff-intersect-directories returns
710 ;; commonalities and differences among directories
711 dir-diff-struct
712 meta-buf)
719 ediff-last-merge-autostore-dir
721 nil
723 ;; verify we are not merging into an orig directory
739 jobname
740 regexp dir1 dir2 dir3 merge-autostore-dir))
742 ;; this sets various vars in the meta buffer inside
743 ;; ediff-prepare-meta-buffer
745 ;; tell what to do if the user clicks on a session record
747 ;; set ediff-dir-difference-list
750 startup-hooks))
752 'ediff-filegroup-action
754 "*Ediff Session Group Panel"
755 'ediff-redraw-directory-group-buffer
756 jobname
757 startup-hooks))
759 ))
761 ;; MERGE-AUTOSTORE-DIR can be given to tell ediff where to store the merged
762 ;; files
764 &optional startup-hooks
765 merge-autostore-dir)
771 jobname)))
779 ediff-last-merge-autostore-dir
781 nil
783 ;; verify merge-autostore-dir != dir1
793 jobname regexp dir1 merge-autostore-dir))
795 ;; this sets various vars in the meta buffer inside
796 ;; ediff-prepare-meta-buffer
798 ;; tell what to do if the user clicks on a session record
800 startup-hooks))
802 'ediff-filegroup-action
803 file-list
804 "*Ediff Session Group Panel"
805 'ediff-redraw-directory-group-buffer
806 jobname
807 startup-hooks))
809 ))
812 ;;; Compare regions and windows
814 ;;;###autoload
816 "Compare WIND-A and WIND-B, which are selected by clicking, wordwise.
817 With prefix argument, DUMB-MODE, or on a non-windowing display, works as
818 follows:
819 If WIND-A is nil, use selected window.
820 If WIND-B is nil, use window next to WIND-A."
825 ;;;###autoload
827 "Compare WIND-A and WIND-B, which are selected by clicking, linewise.
828 With prefix argument, DUMB-MODE, or on a non-windowing display, works as
829 follows:
830 If WIND-A is nil, use selected window.
831 If WIND-B is nil, use window next to WIND-A."
836 ;; Compare WIND-A and WIND-B, which are selected by clicking.
837 ;; With prefix argument, DUMB-MODE, or on a non-windowing display,
838 ;; works as follows:
839 ;; If WIND-A is nil, use selected window.
840 ;; If WIND-B is nil, use window next to WIND-A.
850 beg-A end-A beg-B end-B)
864 buffer-B
868 buffer-A beg-A end-A buffer-B beg-B end-B
869 startup-hooks job-name word-mode nil)))
872 ;;;###autoload
874 "Run Ediff on a pair of regions in specified buffers.
875 Regions \(i.e., point and mark\) are assumed to be set in advance except
876 for the second region in the case both regions are from the same buffer.
877 In such a case the user is asked to interactively establish the second
878 region.
879 This function is effective only for relatively small regions, up to 200
880 lines. For large regions, use `ediff-regions-linewise'."
887 ;; realign buffers so that two visible bufs will be
888 ;; at the top
891 t))))
902 reg-A-beg reg-A-end reg-B-beg reg-B-end)
916 ;;;###autoload
918 "Run Ediff on a pair of regions in specified buffers.
919 Regions \(i.e., point and mark\) are assumed to be set in advance except
920 for the second region in the case both regions are from the same buffer.
921 In such a case the user is asked to interactively establish the second
922 region.
923 Each region is enlarged to contain full lines.
924 This function is effective for large regions, over 100-200
925 lines. For small regions, use `ediff-regions-wordwise'."
932 ;; realign buffers so that two visible bufs will be
933 ;; at the top
936 t))))
946 reg-A-beg reg-A-end reg-B-beg reg-B-end)
951 ;; enlarge the region to hold full lines
963 ;; enlarge the region to hold full lines
978 ;; compare region beg-A to end-A of buffer-A
979 ;; to regions beg-B -- end-B in buffer-B.
981 startup-hooks job-name word-mode
982 setup-parameters)
984 overl-A overl-B
985 file-A file-B)
987 ;; in case beg/end-A/B aren't markers--make them into markers
995 ;; make file-A
1001 ;; make file-B
1010 buffer-B file-B
1011 nil nil ; buffer & file C
1015 startup-hooks)
1020 setup-parameters))
1021 ))
1024 ;;; Merge files and buffers
1026 ;;;###autoload
1034 ;;;###autoload
1036 ;; MERGE-BUFFER-FILE is the file to be
1037 ;; associated with the merge buffer
1039 "Merge two files without ancestor."
1042 ediff-last-dir-A
1043 default-directory))
1044 dir-B f)
1046 "File A to merge"
1047 dir-A
1053 ediff-last-dir-B
1060 dir-B))
1061 file-name-history))
1063 )))
1069 file-B)
1070 nil ; file-C
1071 startup-hooks
1072 'ediff-merge-files
1073 merge-buffer-file))
1075 ;;;###autoload
1077 &optional
1078 startup-hooks
1079 ;; MERGE-BUFFER-FILE is the file
1080 ;; to be associated with the
1081 ;; merge buffer
1082 merge-buffer-file)
1083 "Merge two files with ancestor."
1086 ediff-last-dir-A
1087 default-directory))
1088 dir-B dir-ancestor f ff)
1090 "File A to merge"
1091 dir-A
1097 ediff-last-dir-B
1105 dir-B))
1106 file-name-history))
1111 ediff-last-dir-ancestor
1118 dir-ancestor))
1119 file-name-history))
1121 )))
1127 file-B)
1128 file-ancestor
1129 startup-hooks
1130 'ediff-merge-files-with-ancestor
1131 merge-buffer-file))
1133 ;;;###autoload
1136 ;;;###autoload
1138 &optional
1139 ;; MERGE-BUFFER-FILE is the file to be
1140 ;; associated with the merge buffer
1141 startup-hooks job-name merge-buffer-file)
1142 "Merge buffers without ancestor."
1149 ;; realign buffers so that two visible bufs will be
1150 ;; at the top
1153 t))))
1158 buffer-A buffer-B nil startup-hooks job-name merge-buffer-file))
1160 ;;;###autoload
1162 &optional
1163 startup-hooks
1164 job-name
1165 ;; MERGE-BUFFER-FILE is the
1166 ;; file to be associated
1167 ;; with the merge buffer
1168 merge-buffer-file)
1169 "Merge buffers with ancestor."
1176 ;; realign buffers so that two visible
1177 ;; bufs will be at the top
1180 t))
1183 ;; realign buffers so that three visible
1184 ;; bufs will be at the top
1187 t)
1188 )))
1193 buffer-A buffer-B buffer-ancestor startup-hooks job-name merge-buffer-file))
1196 ;;;###autoload
1198 ;; MERGE-BUFFER-FILE is the file to be associated with the merge buffer
1199 "Run Ediff by merging two revisions of a file.
1200 The file is the optional FILE argument or the file visited by the current
1201 buffer."
1208 "Version 1 to merge (default: %s's working version): "
1211 rev2
1214 "Version 2 to merge (default: %s): "
1218 ;; ancestor-revision=nil
1221 rev1 rev2 nil startup-hooks merge-buffer-file)))
1224 ;;;###autoload
1226 file startup-hooks
1227 ;; MERGE-BUFFER-FILE is the file to
1228 ;; be associated with the merge
1229 ;; buffer
1230 merge-buffer-file)
1231 "Run Ediff by merging two revisions of a file with a common ancestor.
1232 The file is the optional FILE argument or the file visited by the current
1233 buffer."
1240 "Version 1 to merge (default: %s's working version): "
1243 rev2
1246 "Version 2 to merge (default: %s): "
1249 ancestor-rev
1252 "Ancestor version (default: %s's base revision): "
1258 rev1 rev2 ancestor-rev startup-hooks merge-buffer-file)))
1260 ;; MK: Check. This function doesn't seem to be used any more by pcvs or pcl-cvs
1261 ;;;###autoload
1263 "Run Ediff-merge on appropriate revisions of the selected file.
1264 First run after `M-x cvs-update'. Then place the cursor on a line describing a
1265 file and then run `run-ediff-from-cvs-buffer'."
1274 ;;; Apply patch
1276 ;;;###autoload
1278 "Run Ediff by patching SOURCE-FILENAME.
1279 If optional PATCH-BUF is given, use the patch in that buffer
1280 and don't ask the user.
1281 If prefix argument, then: if even argument, assume that the patch is in a
1282 buffer. If odd -- assume it is in a file."
1298 "File to patch (directory, if multifile patch): "
1299 ;; use an explicit initial file
1303 ;;;###autoload
1305 "Run Ediff by patching BUFFER-NAME.
1306 Without prefix argument: asks if the patch is in some buffer and prompts for
1307 the buffer or a file, depending on the answer.
1308 With prefix arg=1: assumes the patch is in a file and prompts for the file.
1309 With prefix arg=2: assumes the patch is in a buffer and prompts for the buffer."
1316 patch-buf
1318 "Which buffer to patch? "
1322 ;;;###autoload
1324 ;;;###autoload
1329 \f
1330 ;;; Versions Control functions
1332 ;;;###autoload
1334 "Run Ediff by comparing versions of a file.
1335 The file is an optional FILE argument or the file entered at the prompt.
1336 Default: the file visited by the current buffer.
1337 Uses `vc.el' or `rcs.el' depending on `ediff-version-control-package'."
1338 ;; if buffer is non-nil, use that buffer instead of the current buffer
1344 ediff-last-dir-A
1345 default-directory)
1358 rev2
1365 rev1 rev2 startup-hooks)
1366 ))
1369 ;;;###autoload
1373 ;; Test if version control package is loaded and load if not
1374 ;; Is SILENT is non-nil, don't report error if package is not found.
1384 ediff-version-control-package)))))
1387 ;;;###autoload
1389 "Return string describing the version of Ediff.
1390 When called interactively, displays the version."
1397 ;;;###autoload
1399 "Display Ediff's manual.
1400 With optional NODE, goes to that node."
1427 ;;; Local Variables:
1428 ;;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
1429 ;;; eval: (put 'ediff-with-current-buffer 'lisp-indent-hook 1)
1430 ;;; eval: (put 'ediff-with-current-buffer 'edebug-form-spec '(form body))
1431 ;;; End:
1437 ;;; ediff.el ends here