| blob | edc16265b02dd2ba4fb2542f057d1d23fb570da7 |
1 ;;; ediff.el --- a comprehensive visual interface to diff & patch
3 ;; Copyright (C) 1994, 95, 96, 97, 98, 99, 2000, 01, 02, 03 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)
512 "Filter through regular expression (default %S): "
516 )))
519 ))
521 ;;;###autoload
525 ;;;###autoload
527 "Run Ediff on a directory, DIR1, comparing its files with their revisions.
528 The second argument, REGEXP, is a regular expression that filters the file
529 names. Only the files that are under revision control are taken into account."
535 "Filter through regular expression (default %S): "
539 )))
542 ))
544 ;;;###autoload
548 ;;;###autoload
550 "Run Ediff on three directories, DIR1, DIR2, and DIR3, comparing files that
551 have the same name in all three. The last argument, REGEXP, is nil or a
552 regular expression; only file names that match the regexp are considered."
556 f)
560 ediff-last-dir-B
562 nil))
565 ediff-last-dir-C
567 nil)
569 "Filter through regular expression (default %S): "
573 )))
576 ))
578 ;;;###autoload
581 ;;;###autoload
583 "Run Ediff on a pair of directories, DIR1 and DIR2, merging files that have
584 the same name in both. The third argument, REGEXP, is nil or a regular
585 expression; only file names that match the regexp are considered."
588 f)
592 ediff-last-dir-B
594 nil)
596 "Filter through regular expression (default %S): "
600 )))
603 nil merge-autostore-dir
604 ))
606 ;;;###autoload
609 ;;;###autoload
611 &optional
612 merge-autostore-dir)
613 "Merge files in directories DIR1 and DIR2 using files in ANCESTOR-DIR as ancestors.
614 Ediff merges files that have identical names in DIR1, DIR2. If a pair of files
615 in DIR1 and DIR2 doesn't have an ancestor in ANCESTOR-DIR, Ediff will merge
616 without ancestor. The fourth argument, REGEXP, is nil or a regular expression;
617 only file names that match the regexp are considered."
620 f)
624 ediff-last-dir-B
626 nil))
629 ediff-last-dir-C
631 nil)
633 "Filter through regular expression (default %S): "
637 )))
639 dir1 dir2 ancestor-dir regexp
641 nil merge-autostore-dir
642 ))
644 ;;;###autoload
647 "Run Ediff on a directory, DIR1, merging its files with their revisions.
648 The second argument, REGEXP, is a regular expression that filters the file
649 names. Only the files that are under revision control are taken into account."
655 "Filter through regular expression (default %S): "
659 )))
662 nil merge-autostore-dir
663 ))
665 ;;;###autoload
668 ;;;###autoload
670 &optional
671 merge-autostore-dir)
672 "Run Ediff on a directory, DIR1, merging its files with their revisions and ancestors.
673 The second argument, REGEXP, is a regular expression that filters the file
674 names. Only the files that are under revision control are taken into account."
680 "Filter through regular expression (default %S): "
684 )))
686 dir1 regexp 'ediff-merge-revisions-with-ancestor
687 'ediff-merge-directory-revisions-with-ancestor
688 nil merge-autostore-dir
689 ))
691 ;;;###autoload
693 'edir-merge-revisions-with-ancestor
696 ;;;###autoload
699 ;; Run ediff-action (ediff-files, ediff-merge, ediff-merge-with-ancestors)
700 ;; on a pair of directories (three directories, in case of ancestor).
701 ;; The third argument, REGEXP, is nil or a regular expression;
702 ;; only file names that match the regexp are considered.
703 ;; JOBNAME is the symbol indicating the meta-job to be performed.
704 ;; MERGE-AUTOSTORE-DIR is the directory in which to store merged files.
706 &optional startup-hooks
707 merge-autostore-dir)
708 ;; ediff-read-file-name is set to attach a previously entered file name if
709 ;; the currently entered file is a directory. This code takes care of that.
728 jobname)))
730 ;; It is a structure where ediff-intersect-directories returns
731 ;; commonalities and differences among directories
732 dir-diff-struct
733 meta-buf)
740 ediff-last-merge-autostore-dir
742 nil
744 ;; verify we are not merging into an orig directory
760 jobname
761 regexp dir1 dir2 dir3 merge-autostore-dir))
763 ;; this sets various vars in the meta buffer inside
764 ;; ediff-prepare-meta-buffer
766 ;; tell what to do if the user clicks on a session record
768 ;; set ediff-dir-difference-list
771 startup-hooks))
773 'ediff-filegroup-action
775 "*Ediff Session Group Panel"
776 'ediff-redraw-directory-group-buffer
777 jobname
778 startup-hooks))
780 ))
782 ;; MERGE-AUTOSTORE-DIR can be given to tell ediff where to store the merged
783 ;; files
785 &optional startup-hooks
786 merge-autostore-dir)
792 jobname)))
800 ediff-last-merge-autostore-dir
802 nil
804 ;; verify merge-autostore-dir != dir1
814 jobname regexp dir1 merge-autostore-dir))
816 ;; this sets various vars in the meta buffer inside
817 ;; ediff-prepare-meta-buffer
819 ;; tell what to do if the user clicks on a session record
821 startup-hooks))
823 'ediff-filegroup-action
824 file-list
825 "*Ediff Session Group Panel"
826 'ediff-redraw-directory-group-buffer
827 jobname
828 startup-hooks))
830 ))
833 ;;; Compare regions and windows
835 ;;;###autoload
837 "Compare WIND-A and WIND-B, which are selected by clicking, wordwise.
838 With prefix argument, DUMB-MODE, or on a non-windowing display, works as
839 follows:
840 If WIND-A is nil, use selected window.
841 If WIND-B is nil, use window next to WIND-A."
846 ;;;###autoload
848 "Compare WIND-A and WIND-B, which are selected by clicking, linewise.
849 With prefix argument, DUMB-MODE, or on a non-windowing display, works as
850 follows:
851 If WIND-A is nil, use selected window.
852 If WIND-B is nil, use window next to WIND-A."
857 ;; Compare WIND-A and WIND-B, which are selected by clicking.
858 ;; With prefix argument, DUMB-MODE, or on a non-windowing display,
859 ;; works as follows:
860 ;; If WIND-A is nil, use selected window.
861 ;; If WIND-B is nil, use window next to WIND-A.
871 beg-A end-A beg-B end-B)
885 buffer-B
889 buffer-A beg-A end-A buffer-B beg-B end-B
890 startup-hooks job-name word-mode nil)))
893 ;;;###autoload
895 "Run Ediff on a pair of regions in specified buffers.
896 Regions \(i.e., point and mark\) are assumed to be set in advance except
897 for the second region in the case both regions are from the same buffer.
898 In such a case the user is asked to interactively establish the second
899 region.
900 This function is effective only for relatively small regions, up to 200
901 lines. For large regions, use `ediff-regions-linewise'."
908 ;; realign buffers so that two visible bufs will be
909 ;; at the top
912 t))))
923 reg-A-beg reg-A-end reg-B-beg reg-B-end)
937 ;;;###autoload
939 "Run Ediff on a pair of regions in specified buffers.
940 Regions \(i.e., point and mark\) are assumed to be set in advance except
941 for the second region in the case both regions are from the same buffer.
942 In such a case the user is asked to interactively establish the second
943 region.
944 Each region is enlarged to contain full lines.
945 This function is effective for large regions, over 100-200
946 lines. For small regions, use `ediff-regions-wordwise'."
953 ;; realign buffers so that two visible bufs will be
954 ;; at the top
957 t))))
967 reg-A-beg reg-A-end reg-B-beg reg-B-end)
972 ;; enlarge the region to hold full lines
984 ;; enlarge the region to hold full lines
999 ;; compare region beg-A to end-A of buffer-A
1000 ;; to regions beg-B -- end-B in buffer-B.
1002 startup-hooks job-name word-mode
1003 setup-parameters)
1005 overl-A overl-B
1006 file-A file-B)
1008 ;; in case beg/end-A/B aren't markers--make them into markers
1016 ;; make file-A
1022 ;; make file-B
1031 buffer-B file-B
1032 nil nil ; buffer & file C
1036 startup-hooks)
1041 setup-parameters))
1042 ))
1045 ;;; Merge files and buffers
1047 ;;;###autoload
1055 ;;;###autoload
1057 ;; MERGE-BUFFER-FILE is the file to be
1058 ;; associated with the merge buffer
1060 "Merge two files without ancestor."
1063 ediff-last-dir-A
1064 default-directory))
1065 dir-B f)
1067 "File A to merge"
1068 dir-A
1074 ediff-last-dir-B
1081 dir-B))
1082 file-name-history))
1084 )))
1090 file-B)
1091 nil ; file-C
1092 startup-hooks
1093 'ediff-merge-files
1094 merge-buffer-file))
1096 ;;;###autoload
1098 &optional
1099 startup-hooks
1100 ;; MERGE-BUFFER-FILE is the file
1101 ;; to be associated with the
1102 ;; merge buffer
1103 merge-buffer-file)
1104 "Merge two files with ancestor."
1107 ediff-last-dir-A
1108 default-directory))
1109 dir-B dir-ancestor f ff)
1111 "File A to merge"
1112 dir-A
1118 ediff-last-dir-B
1126 dir-B))
1127 file-name-history))
1132 ediff-last-dir-ancestor
1139 dir-ancestor))
1140 file-name-history))
1142 )))
1148 file-B)
1149 file-ancestor
1150 startup-hooks
1151 'ediff-merge-files-with-ancestor
1152 merge-buffer-file))
1154 ;;;###autoload
1157 ;;;###autoload
1159 &optional
1160 ;; MERGE-BUFFER-FILE is the file to be
1161 ;; associated with the merge buffer
1162 startup-hooks job-name merge-buffer-file)
1163 "Merge buffers without ancestor."
1170 ;; realign buffers so that two visible bufs will be
1171 ;; at the top
1174 t))))
1179 buffer-A buffer-B nil startup-hooks job-name merge-buffer-file))
1181 ;;;###autoload
1183 &optional
1184 startup-hooks
1185 job-name
1186 ;; MERGE-BUFFER-FILE is the
1187 ;; file to be associated
1188 ;; with the merge buffer
1189 merge-buffer-file)
1190 "Merge buffers with ancestor."
1197 ;; realign buffers so that two visible
1198 ;; bufs will be at the top
1201 t))
1204 ;; realign buffers so that three visible
1205 ;; bufs will be at the top
1208 t)
1209 )))
1214 buffer-A buffer-B buffer-ancestor startup-hooks job-name merge-buffer-file))
1217 ;;;###autoload
1219 ;; MERGE-BUFFER-FILE is the file to be associated with the merge buffer
1220 "Run Ediff by merging two revisions of a file.
1221 The file is the optional FILE argument or the file visited by the current
1222 buffer."
1229 "Version 1 to merge (default: %s's working version): "
1232 rev2
1235 "Version 2 to merge (default: %s): "
1239 ;; ancestor-revision=nil
1242 rev1 rev2 nil startup-hooks merge-buffer-file)))
1245 ;;;###autoload
1247 file startup-hooks
1248 ;; MERGE-BUFFER-FILE is the file to
1249 ;; be associated with the merge
1250 ;; buffer
1251 merge-buffer-file)
1252 "Run Ediff by merging two revisions of a file with a common ancestor.
1253 The file is the optional FILE argument or the file visited by the current
1254 buffer."
1261 "Version 1 to merge (default: %s's working version): "
1264 rev2
1267 "Version 2 to merge (default: %s): "
1270 ancestor-rev
1273 "Ancestor version (default: %s's base revision): "
1279 rev1 rev2 ancestor-rev startup-hooks merge-buffer-file)))
1281 ;; MK: Check. This function doesn't seem to be used any more by pcvs or pcl-cvs
1282 ;;;###autoload
1284 "Run Ediff-merge on appropriate revisions of the selected file.
1285 First run after `M-x cvs-update'. Then place the cursor on a line describing a
1286 file and then run `run-ediff-from-cvs-buffer'."
1295 ;;; Apply patch
1297 ;;;###autoload
1299 "Run Ediff by patching SOURCE-FILENAME.
1300 If optional PATCH-BUF is given, use the patch in that buffer
1301 and don't ask the user.
1302 If prefix argument, then: if even argument, assume that the patch is in a
1303 buffer. If odd -- assume it is in a file."
1319 "File to patch (directory, if multifile patch): "
1320 ;; use an explicit initial file
1324 ;;;###autoload
1326 "Run Ediff by patching BUFFER-NAME.
1327 Without prefix argument: asks if the patch is in some buffer and prompts for
1328 the buffer or a file, depending on the answer.
1329 With prefix arg=1: assumes the patch is in a file and prompts for the file.
1330 With prefix arg=2: assumes the patch is in a buffer and prompts for the buffer."
1337 patch-buf
1339 "Which buffer to patch? "
1343 ;;;###autoload
1345 ;;;###autoload
1350 \f
1351 ;;; Versions Control functions
1353 ;;;###autoload
1355 "Run Ediff by comparing versions of a file.
1356 The file is an optional FILE argument or the file entered at the prompt.
1357 Default: the file visited by the current buffer.
1358 Uses `vc.el' or `rcs.el' depending on `ediff-version-control-package'."
1359 ;; if buffer is non-nil, use that buffer instead of the current buffer
1365 ediff-last-dir-A
1366 default-directory)
1379 rev2
1386 rev1 rev2 startup-hooks)
1387 ))
1390 ;;;###autoload
1394 ;; Test if version control package is loaded and load if not
1395 ;; Is SILENT is non-nil, don't report error if package is not found.
1405 ediff-version-control-package)))))
1408 ;;;###autoload
1410 "Return string describing the version of Ediff.
1411 When called interactively, displays the version."
1418 ;;;###autoload
1420 "Display Ediff's manual.
1421 With optional NODE, goes to that node."
1448 ;;; Local Variables:
1449 ;;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
1450 ;;; eval: (put 'ediff-with-current-buffer 'lisp-indent-hook 1)
1451 ;;; eval: (put 'ediff-with-current-buffer 'edebug-form-spec '(form body))
1452 ;;; End:
1458 ;;; ediff.el ends here