| blob | 78ea48f4a1c8ab0374a48655a7b36bd692fbad83 |
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."
505 f)
509 ediff-last-dir-B
511 nil)
515 default-regexp)
517 nil
518 'ediff-filtering-regexp-history
520 )))
523 ))
525 ;;;###autoload
529 ;;;###autoload
531 "Run Ediff on a directory, DIR1, comparing its files with their revisions.
532 The second argument, REGEXP, is a regular expression that filters the file
533 names. Only the files that are under revision control are taken into account."
537 )
543 default-regexp)
545 nil
546 'ediff-filtering-regexp-history
548 )))
551 ))
553 ;;;###autoload
557 ;;;###autoload
559 "Run Ediff on three directories, DIR1, DIR2, and DIR3, comparing files that
560 have the same name in all three. The last argument, REGEXP, is nil or a
561 regular expression; only file names that match the regexp are considered."
566 f)
570 ediff-last-dir-B
572 nil))
575 ediff-last-dir-C
577 nil)
581 default-regexp)
583 nil
584 'ediff-filtering-regexp-history
586 )))
589 ))
591 ;;;###autoload
594 ;;;###autoload
596 "Run Ediff on a pair of directories, DIR1 and DIR2, merging files that have
597 the same name in both. The third argument, REGEXP, is nil or a regular
598 expression; only file names that match the regexp are considered."
602 f)
606 ediff-last-dir-B
608 nil)
612 default-regexp)
614 nil
615 'ediff-filtering-regexp-history
617 )))
620 nil merge-autostore-dir
621 ))
623 ;;;###autoload
626 ;;;###autoload
628 &optional
629 merge-autostore-dir)
630 "Merge files in directories DIR1 and DIR2 using files in ANCESTOR-DIR as ancestors.
631 Ediff merges files that have identical names in DIR1, DIR2. If a pair of files
632 in DIR1 and DIR2 doesn't have an ancestor in ANCESTOR-DIR, Ediff will merge
633 without ancestor. The fourth argument, REGEXP, is nil or a regular expression;
634 only file names that match the regexp are considered."
638 f)
642 ediff-last-dir-B
644 nil))
647 ediff-last-dir-C
649 nil)
653 default-regexp)
655 nil
656 'ediff-filtering-regexp-history
658 )))
660 dir1 dir2 ancestor-dir regexp
662 nil merge-autostore-dir
663 ))
665 ;;;###autoload
668 "Run Ediff on a directory, DIR1, merging its files with their revisions.
669 The second argument, REGEXP, is a regular expression that filters the file
670 names. Only the files that are under revision control are taken into account."
674 )
680 default-regexp)
682 nil
683 'ediff-filtering-regexp-history
685 )))
688 nil merge-autostore-dir
689 ))
691 ;;;###autoload
694 ;;;###autoload
696 &optional
697 merge-autostore-dir)
698 "Run Ediff on a directory, DIR1, merging its files with their revisions and ancestors.
699 The second argument, REGEXP, is a regular expression that filters the file
700 names. Only the files that are under revision control are taken into account."
704 )
710 default-regexp)
712 nil
713 'ediff-filtering-regexp-history
715 )))
717 dir1 regexp 'ediff-merge-revisions-with-ancestor
718 'ediff-merge-directory-revisions-with-ancestor
719 nil merge-autostore-dir
720 ))
722 ;;;###autoload
724 'edir-merge-revisions-with-ancestor
727 ;;;###autoload
730 ;; Run ediff-action (ediff-files, ediff-merge, ediff-merge-with-ancestors)
731 ;; on a pair of directories (three directories, in case of ancestor).
732 ;; The third argument, REGEXP, is nil or a regular expression;
733 ;; only file names that match the regexp are considered.
734 ;; JOBNAME is the symbol indicating the meta-job to be performed.
735 ;; MERGE-AUTOSTORE-DIR is the directory in which to store merged files.
737 &optional startup-hooks
738 merge-autostore-dir)
739 ;; ediff-read-file-name is set to attach a previously entered file name if
740 ;; the currently entered file is a directory. This code takes care of that.
759 jobname)))
761 ;; It is a structure where ediff-intersect-directories returns
762 ;; commonalities and differences among directories
763 dir-diff-struct
764 meta-buf)
771 ediff-last-merge-autostore-dir
773 nil
775 ;; verify we are not merging into an orig directory
791 jobname
792 regexp dir1 dir2 dir3 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 ;; set ediff-dir-difference-list
802 startup-hooks))
804 'ediff-filegroup-action
806 "*Ediff Session Group Panel"
807 'ediff-redraw-directory-group-buffer
808 jobname
809 startup-hooks))
811 ))
813 ;; MERGE-AUTOSTORE-DIR can be given to tell ediff where to store the merged
814 ;; files
816 &optional startup-hooks
817 merge-autostore-dir)
823 jobname)))
831 ediff-last-merge-autostore-dir
833 nil
835 ;; verify merge-autostore-dir != dir1
845 jobname regexp dir1 merge-autostore-dir))
847 ;; this sets various vars in the meta buffer inside
848 ;; ediff-prepare-meta-buffer
850 ;; tell what to do if the user clicks on a session record
852 startup-hooks))
854 'ediff-filegroup-action
855 file-list
856 "*Ediff Session Group Panel"
857 'ediff-redraw-directory-group-buffer
858 jobname
859 startup-hooks))
861 ))
864 ;;; Compare regions and windows
866 ;;;###autoload
868 "Compare WIND-A and WIND-B, which are selected by clicking, wordwise.
869 With prefix argument, DUMB-MODE, or on a non-windowing display, works as
870 follows:
871 If WIND-A is nil, use selected window.
872 If WIND-B is nil, use window next to WIND-A."
877 ;;;###autoload
879 "Compare WIND-A and WIND-B, which are selected by clicking, linewise.
880 With prefix argument, DUMB-MODE, or on a non-windowing display, works as
881 follows:
882 If WIND-A is nil, use selected window.
883 If WIND-B is nil, use window next to WIND-A."
888 ;; Compare WIND-A and WIND-B, which are selected by clicking.
889 ;; With prefix argument, DUMB-MODE, or on a non-windowing display,
890 ;; works as follows:
891 ;; If WIND-A is nil, use selected window.
892 ;; If WIND-B is nil, use window next to WIND-A.
902 beg-A end-A beg-B end-B)
916 buffer-B
920 buffer-A beg-A end-A buffer-B beg-B end-B
921 startup-hooks job-name word-mode nil)))
924 ;;;###autoload
926 "Run Ediff on a pair of regions in specified buffers.
927 Regions \(i.e., point and mark\) are assumed to be set in advance except
928 for the second region in the case both regions are from the same buffer.
929 In such a case the user is asked to interactively establish the second
930 region.
931 This function is effective only for relatively small regions, up to 200
932 lines. For large regions, use `ediff-regions-linewise'."
939 ;; realign buffers so that two visible bufs will be
940 ;; at the top
943 t))))
954 reg-A-beg reg-A-end reg-B-beg reg-B-end)
968 ;;;###autoload
970 "Run Ediff on a pair of regions in specified buffers.
971 Regions \(i.e., point and mark\) are assumed to be set in advance except
972 for the second region in the case both regions are from the same buffer.
973 In such a case the user is asked to interactively establish the second
974 region.
975 Each region is enlarged to contain full lines.
976 This function is effective for large regions, over 100-200
977 lines. For small regions, use `ediff-regions-wordwise'."
984 ;; realign buffers so that two visible bufs will be
985 ;; at the top
988 t))))
998 reg-A-beg reg-A-end reg-B-beg reg-B-end)
1003 ;; enlarge the region to hold full lines
1015 ;; enlarge the region to hold full lines
1030 ;; compare region beg-A to end-A of buffer-A
1031 ;; to regions beg-B -- end-B in buffer-B.
1033 startup-hooks job-name word-mode
1034 setup-parameters)
1036 overl-A overl-B
1037 file-A file-B)
1039 ;; in case beg/end-A/B aren't markers--make them into markers
1047 ;; make file-A
1053 ;; make file-B
1062 buffer-B file-B
1063 nil nil ; buffer & file C
1067 startup-hooks)
1072 setup-parameters))
1073 ))
1076 ;;; Merge files and buffers
1078 ;;;###autoload
1086 ;;;###autoload
1088 ;; MERGE-BUFFER-FILE is the file to be
1089 ;; associated with the merge buffer
1091 "Merge two files without ancestor."
1094 ediff-last-dir-A
1095 default-directory))
1096 dir-B f)
1098 "File A to merge"
1099 dir-A
1105 ediff-last-dir-B
1112 dir-B))
1113 file-name-history))
1115 )))
1121 file-B)
1122 nil ; file-C
1123 startup-hooks
1124 'ediff-merge-files
1125 merge-buffer-file))
1127 ;;;###autoload
1129 &optional
1130 startup-hooks
1131 ;; MERGE-BUFFER-FILE is the file
1132 ;; to be associated with the
1133 ;; merge buffer
1134 merge-buffer-file)
1135 "Merge two files with ancestor."
1138 ediff-last-dir-A
1139 default-directory))
1140 dir-B dir-ancestor f ff)
1142 "File A to merge"
1143 dir-A
1149 ediff-last-dir-B
1157 dir-B))
1158 file-name-history))
1163 ediff-last-dir-ancestor
1170 dir-ancestor))
1171 file-name-history))
1173 )))
1179 file-B)
1180 file-ancestor
1181 startup-hooks
1182 'ediff-merge-files-with-ancestor
1183 merge-buffer-file))
1185 ;;;###autoload
1188 ;;;###autoload
1190 &optional
1191 ;; MERGE-BUFFER-FILE is the file to be
1192 ;; associated with the merge buffer
1193 startup-hooks job-name merge-buffer-file)
1194 "Merge buffers without ancestor."
1201 ;; realign buffers so that two visible bufs will be
1202 ;; at the top
1205 t))))
1210 buffer-A buffer-B nil startup-hooks job-name merge-buffer-file))
1212 ;;;###autoload
1214 &optional
1215 startup-hooks
1216 job-name
1217 ;; MERGE-BUFFER-FILE is the
1218 ;; file to be associated
1219 ;; with the merge buffer
1220 merge-buffer-file)
1221 "Merge buffers with ancestor."
1228 ;; realign buffers so that two visible
1229 ;; bufs will be at the top
1232 t))
1235 ;; realign buffers so that three visible
1236 ;; bufs will be at the top
1239 t)
1240 )))
1245 buffer-A buffer-B buffer-ancestor startup-hooks job-name merge-buffer-file))
1248 ;;;###autoload
1250 ;; MERGE-BUFFER-FILE is the file to be associated with the merge buffer
1251 "Run Ediff by merging two revisions of a file.
1252 The file is the optional FILE argument or the file visited by the current
1253 buffer."
1260 "Version 1 to merge (default: %s's working version): "
1263 rev2
1266 "Version 2 to merge (default: %s): "
1270 ;; ancestor-revision=nil
1273 rev1 rev2 nil startup-hooks merge-buffer-file)))
1276 ;;;###autoload
1278 file startup-hooks
1279 ;; MERGE-BUFFER-FILE is the file to
1280 ;; be associated with the merge
1281 ;; buffer
1282 merge-buffer-file)
1283 "Run Ediff by merging two revisions of a file with a common ancestor.
1284 The file is the optional FILE argument or the file visited by the current
1285 buffer."
1292 "Version 1 to merge (default: %s's working version): "
1295 rev2
1298 "Version 2 to merge (default: %s): "
1301 ancestor-rev
1304 "Ancestor version (default: %s's base revision): "
1310 rev1 rev2 ancestor-rev startup-hooks merge-buffer-file)))
1312 ;; MK: Check. This function doesn't seem to be used any more by pcvs or pcl-cvs
1313 ;;;###autoload
1315 "Run Ediff-merge on appropriate revisions of the selected file.
1316 First run after `M-x cvs-update'. Then place the cursor on a line describing a
1317 file and then run `run-ediff-from-cvs-buffer'."
1326 ;;; Apply patch
1328 ;;;###autoload
1330 "Run Ediff by patching SOURCE-FILENAME.
1331 If optional PATCH-BUF is given, use the patch in that buffer
1332 and don't ask the user.
1333 If prefix argument, then: if even argument, assume that the patch is in a
1334 buffer. If odd -- assume it is in a file."
1350 "File to patch (directory, if multifile patch): "
1351 ;; use an explicit initial file
1355 ;;;###autoload
1357 "Run Ediff by patching BUFFER-NAME.
1358 Without prefix argument: asks if the patch is in some buffer and prompts for
1359 the buffer or a file, depending on the answer.
1360 With prefix arg=1: assumes the patch is in a file and prompts for the file.
1361 With prefix arg=2: assumes the patch is in a buffer and prompts for the buffer."
1368 patch-buf
1370 "Which buffer to patch? "
1374 ;;;###autoload
1376 ;;;###autoload
1381 \f
1382 ;;; Versions Control functions
1384 ;;;###autoload
1386 "Run Ediff by comparing versions of a file.
1387 The file is an optional FILE argument or the file entered at the prompt.
1388 Default: the file visited by the current buffer.
1389 Uses `vc.el' or `rcs.el' depending on `ediff-version-control-package'."
1390 ;; if buffer is non-nil, use that buffer instead of the current buffer
1396 ediff-last-dir-A
1397 default-directory)
1410 rev2
1417 rev1 rev2 startup-hooks)
1418 ))
1421 ;;;###autoload
1425 ;; Test if version control package is loaded and load if not
1426 ;; Is SILENT is non-nil, don't report error if package is not found.
1436 ediff-version-control-package)))))
1439 ;;;###autoload
1441 "Return string describing the version of Ediff.
1442 When called interactively, displays the version."
1449 ;;;###autoload
1451 "Display Ediff's manual.
1452 With optional NODE, goes to that node."
1479 ;;; Local Variables:
1480 ;;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
1481 ;;; eval: (put 'ediff-with-current-buffer 'lisp-indent-hook 1)
1482 ;;; eval: (put 'ediff-with-current-buffer 'edebug-form-spec '(form body))
1483 ;;; End:
1489 ;;; arch-tag: 97c71396-db02-4f41-8b48-6a51c3348fcc
1490 ;;; ediff.el ends here