| blob | 2db82f855476d34592da354a4bbe0dabce7f4346 |
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
371 ;;;###autoload
373 "Run Ediff on a pair of buffers, BUFFER-A and BUFFER-B."
380 ;; realign buffers so that two visible bufs will be
381 ;; at the top
384 t))))
388 ;;;###autoload
392 ;;;###autoload
395 "Run Ediff on three buffers, BUFFER-A, BUFFER-B, and BUFFER-C."
402 ;; realign buffers so that two visible
403 ;; bufs will be at the top
406 t))
409 ;; realign buffers so that three visible
410 ;; bufs will be at the top
413 t)
414 )))
418 ;;;###autoload
423 ;; MERGE-BUFFER-FILE is the file to be associated with the merge buffer
431 file-A file-B file-C)
455 file-C
460 startup-hooks)
462 merge-buffer-file)))
465 ;;; Directory and file group operations
467 ;; Get appropriate default name for directory:
468 ;; If ediff-use-last-dir, use ediff-last-dir-A.
469 ;; In dired mode, use the directory that is under the point (if any);
470 ;; otherwise, use default-directory
476 f
477 default-directory)))
481 ;;;###autoload
483 "Run Ediff on a pair of directories, DIR1 and DIR2, comparing files that have
484 the same name in both. The third argument, REGEXP, is a regular expression
485 that can be used to filter out certain file names."
488 f)
492 ediff-last-dir-B
494 nil)
497 )))
500 ))
502 ;;;###autoload
506 ;;;###autoload
508 "Run Ediff on a directory, DIR1, comparing its files with their revisions.
509 The second argument, REGEXP, is a regular expression that filters the file
510 names. Only the files that are under revision control are taken into account."
517 )))
520 ))
522 ;;;###autoload
526 ;;;###autoload
528 "Run Ediff on three directories, DIR1, DIR2, and DIR3, comparing files that
529 have the same name in all three. The last argument, REGEXP, is a regular
530 expression that can be used to filter out certain file names."
533 f)
537 ediff-last-dir-B
539 nil))
542 ediff-last-dir-C
544 nil)
547 )))
550 ))
552 ;;;###autoload
555 ;;;###autoload
557 "Run Ediff on a pair of directories, DIR1 and DIR2, merging files that have
558 the same name in both. The third argument, REGEXP, is a regular expression
559 that can be used to filter out certain file names."
562 f)
566 ediff-last-dir-B
568 nil)
571 )))
574 nil merge-autostore-dir
575 ))
577 ;;;###autoload
580 ;;;###autoload
582 &optional
583 merge-autostore-dir)
584 "Merge files in directories DIR1 and DIR2 using files in ANCESTOR-DIR as ancestors.
585 Ediff merges files that have identical names in DIR1, DIR2. If a pair of files
586 in DIR1 and DIR2 doesn't have an ancestor in ANCESTOR-DIR, Ediff will merge
587 without ancestor. The fourth argument, REGEXP, is a regular expression that
588 can be used to filter out certain file names."
591 f)
595 ediff-last-dir-B
597 nil))
600 ediff-last-dir-C
602 nil)
605 )))
607 dir1 dir2 ancestor-dir regexp
609 nil merge-autostore-dir
610 ))
612 ;;;###autoload
615 "Run Ediff on a directory, DIR1, merging its files with their revisions.
616 The second argument, REGEXP, is a regular expression that filters the file
617 names. Only the files that are under revision control are taken into account."
624 )))
627 nil merge-autostore-dir
628 ))
630 ;;;###autoload
633 ;;;###autoload
635 &optional
636 merge-autostore-dir)
637 "Run Ediff on a directory, DIR1, merging its files with their revisions and ancestors.
638 The second argument, REGEXP, is a regular expression that filters the file
639 names. Only the files that are under revision control are taken into account."
646 )))
648 dir1 regexp 'ediff-merge-revisions-with-ancestor
649 'ediff-merge-directory-revisions-with-ancestor
650 nil merge-autostore-dir
651 ))
653 ;;;###autoload
655 'edir-merge-revisions-with-ancestor
658 ;;;###autoload
661 ;; Run ediff-action (ediff-files, ediff-merge, ediff-merge-with-ancestors)
662 ;; on a pair of directories (three directories, in case of ancestor).
663 ;; The third argument, REGEXP, is a regular expression that can be used to
664 ;; filter out certain file names.
665 ;; JOBNAME is the symbol indicating the meta-job to be performed.
666 ;; MERGE-AUTOSTORE-DIR is the directory in which to store merged files.
668 &optional startup-hooks
669 merge-autostore-dir)
670 ;; ediff-read-file-name is set to attach a previously entered file name if
671 ;; the currently entered file is a directory. This code takes care of that.
690 jobname)))
692 ;; It is a structure where ediff-intersect-directories returns
693 ;; commonalities and differences among directories
694 dir-diff-struct
695 meta-buf)
702 ediff-last-merge-autostore-dir
704 nil
706 ;; verify we are not merging into an orig directory
722 jobname
723 regexp dir1 dir2 dir3 merge-autostore-dir))
725 ;; this sets various vars in the meta buffer inside
726 ;; ediff-prepare-meta-buffer
728 ;; tell what to do if the user clicks on a session record
730 ;; set ediff-dir-difference-list
733 startup-hooks))
735 'ediff-filegroup-action
737 "*Ediff Session Group Panel"
738 'ediff-redraw-directory-group-buffer
739 jobname
740 startup-hooks))
742 ))
744 ;; MERGE-AUTOSTORE-DIR can be given to tell ediff where to store the merged
745 ;; files
747 &optional startup-hooks
748 merge-autostore-dir)
754 jobname)))
762 ediff-last-merge-autostore-dir
764 nil
766 ;; verify merge-autostore-dir != dir1
776 jobname regexp dir1 merge-autostore-dir))
778 ;; this sets various vars in the meta buffer inside
779 ;; ediff-prepare-meta-buffer
781 ;; tell what to do if the user clicks on a session record
783 startup-hooks))
785 'ediff-filegroup-action
786 file-list
787 "*Ediff Session Group Panel"
788 'ediff-redraw-directory-group-buffer
789 jobname
790 startup-hooks))
792 ))
795 ;;; Compare regions and windows
797 ;;;###autoload
799 "Compare WIND-A and WIND-B, which are selected by clicking, wordwise.
800 With prefix argument, DUMB-MODE, or on a non-windowing display, works as
801 follows:
802 If WIND-A is nil, use selected window.
803 If WIND-B is nil, use window next to WIND-A."
808 ;;;###autoload
810 "Compare WIND-A and WIND-B, which are selected by clicking, linewise.
811 With prefix argument, DUMB-MODE, or on a non-windowing display, works as
812 follows:
813 If WIND-A is nil, use selected window.
814 If WIND-B is nil, use window next to WIND-A."
819 ;; Compare WIND-A and WIND-B, which are selected by clicking.
820 ;; With prefix argument, DUMB-MODE, or on a non-windowing display,
821 ;; works as follows:
822 ;; If WIND-A is nil, use selected window.
823 ;; If WIND-B is nil, use window next to WIND-A.
833 beg-A end-A beg-B end-B)
847 buffer-B
851 buffer-A beg-A end-A buffer-B beg-B end-B
852 startup-hooks job-name word-mode nil)))
855 ;;;###autoload
857 "Run Ediff on a pair of regions in specified buffers.
858 Regions \(i.e., point and mark\) are assumed to be set in advance except
859 for the second region in the case both regions are from the same buffer.
860 In such a case the user is asked to interactively establish the second
861 region.
862 This function is effective only for relatively small regions, up to 200
863 lines. For large regions, use `ediff-regions-linewise'."
870 ;; realign buffers so that two visible bufs will be
871 ;; at the top
874 t))))
885 reg-A-beg reg-A-end reg-B-beg reg-B-end)
899 ;;;###autoload
901 "Run Ediff on a pair of regions in specified buffers.
902 Regions \(i.e., point and mark\) are assumed to be set in advance except
903 for the second region in the case both regions are from the same buffer.
904 In such a case the user is asked to interactively establish the second
905 region.
906 Each region is enlarged to contain full lines.
907 This function is effective for large regions, over 100-200
908 lines. For small regions, use `ediff-regions-wordwise'."
915 ;; realign buffers so that two visible bufs will be
916 ;; at the top
919 t))))
929 reg-A-beg reg-A-end reg-B-beg reg-B-end)
934 ;; enlarge the region to hold full lines
946 ;; enlarge the region to hold full lines
961 ;; compare region beg-A to end-A of buffer-A
962 ;; to regions beg-B -- end-B in buffer-B.
964 startup-hooks job-name word-mode
965 setup-parameters)
967 overl-A overl-B
968 file-A file-B)
970 ;; in case beg/end-A/B aren't markers--make them into markers
978 ;; make file-A
984 ;; make file-B
993 buffer-B file-B
994 nil nil ; buffer & file C
998 startup-hooks)
1003 setup-parameters))
1004 ))
1007 ;;; Merge files and buffers
1009 ;;;###autoload
1017 ;;;###autoload
1019 ;; MERGE-BUFFER-FILE is the file to be
1020 ;; associated with the merge buffer
1022 "Merge two files without ancestor."
1025 ediff-last-dir-A
1026 default-directory))
1027 dir-B f)
1029 "File A to merge"
1030 dir-A
1036 ediff-last-dir-B
1043 dir-B))
1044 file-name-history))
1046 )))
1052 file-B)
1053 nil ; file-C
1054 startup-hooks
1055 'ediff-merge-files
1056 merge-buffer-file))
1058 ;;;###autoload
1060 &optional
1061 startup-hooks
1062 ;; MERGE-BUFFER-FILE is the file
1063 ;; to be associated with the
1064 ;; merge buffer
1065 merge-buffer-file)
1066 "Merge two files with ancestor."
1069 ediff-last-dir-A
1070 default-directory))
1071 dir-B dir-ancestor f ff)
1073 "File A to merge"
1074 dir-A
1080 ediff-last-dir-B
1088 dir-B))
1089 file-name-history))
1094 ediff-last-dir-ancestor
1101 dir-ancestor))
1102 file-name-history))
1104 )))
1110 file-B)
1111 file-ancestor
1112 startup-hooks
1113 'ediff-merge-files-with-ancestor
1114 merge-buffer-file))
1116 ;;;###autoload
1119 ;;;###autoload
1121 &optional
1122 ;; MERGE-BUFFER-FILE is the file to be
1123 ;; associated with the merge buffer
1124 startup-hooks job-name merge-buffer-file)
1125 "Merge buffers without ancestor."
1132 ;; realign buffers so that two visible bufs will be
1133 ;; at the top
1136 t))))
1141 buffer-A buffer-B nil startup-hooks job-name merge-buffer-file))
1143 ;;;###autoload
1145 &optional
1146 startup-hooks
1147 job-name
1148 ;; MERGE-BUFFER-FILE is the
1149 ;; file to be associated
1150 ;; with the merge buffer
1151 merge-buffer-file)
1152 "Merge buffers with ancestor."
1159 ;; realign buffers so that two visible
1160 ;; bufs will be at the top
1163 t))
1166 ;; realign buffers so that three visible
1167 ;; bufs will be at the top
1170 t)
1171 )))
1176 buffer-A buffer-B buffer-ancestor startup-hooks job-name merge-buffer-file))
1179 ;;;###autoload
1181 ;; MERGE-BUFFER-FILE is the file to be associated with the merge buffer
1182 "Run Ediff by merging two revisions of a file.
1183 The file is the optional FILE argument or the file visited by the current
1184 buffer."
1191 "Version 1 to merge (default: %s's working version): "
1194 rev2
1197 "Version 2 to merge (default: %s): "
1201 ;; ancestor-revision=nil
1204 rev1 rev2 nil startup-hooks merge-buffer-file)))
1207 ;;;###autoload
1209 file startup-hooks
1210 ;; MERGE-BUFFER-FILE is the file to
1211 ;; be associated with the merge
1212 ;; buffer
1213 merge-buffer-file)
1214 "Run Ediff by merging two revisions of a file with a common ancestor.
1215 The file is the optional FILE argument or the file visited by the current
1216 buffer."
1223 "Version 1 to merge (default: %s's working version): "
1226 rev2
1229 "Version 2 to merge (default: %s): "
1232 ancestor-rev
1235 "Ancestor version (default: %s's base revision): "
1241 rev1 rev2 ancestor-rev startup-hooks merge-buffer-file)))
1243 ;; MK: Check. This function doesn't seem to be used any more by pcvs or pcl-cvs
1244 ;;;###autoload
1246 "Run Ediff-merge on appropriate revisions of the selected file.
1247 First run after `M-x cvs-update'. Then place the cursor on a line describing a
1248 file and then run `run-ediff-from-cvs-buffer'."
1257 ;;; Apply patch
1259 ;;;###autoload
1261 "Run Ediff by patching SOURCE-FILENAME.
1262 If optional PATCH-BUF is given, use the patch in that buffer
1263 and don't ask the user.
1264 If prefix argument, then: if even argument, assume that the patch is in a
1265 buffer. If odd -- assume it is in a file."
1281 "File to patch (directory, if multifile patch): "
1282 ;; use an explicit initial file
1286 ;;;###autoload
1288 "Run Ediff by patching BUFFER-NAME.
1289 Without prefix argument: asks if the patch is in some buffer and prompts for
1290 the buffer or a file, depending on the answer.
1291 With prefix arg=1: assumes the patch is in a file and prompts for the file.
1292 With prefix arg=2: assumes the patch is in a buffer and prompts for the buffer."
1299 patch-buf
1301 "Which buffer to patch? "
1305 ;;;###autoload
1307 ;;;###autoload
1312 \f
1313 ;;; Versions Control functions
1315 ;;;###autoload
1317 "Run Ediff by comparing versions of a file.
1318 The file is an optional FILE argument or the file entered at the prompt.
1319 Default: the file visited by the current buffer.
1320 Uses `vc.el' or `rcs.el' depending on `ediff-version-control-package'."
1321 ;; if buffer is non-nil, use that buffer instead of the current buffer
1327 ediff-last-dir-A
1328 default-directory)
1341 rev2
1348 rev1 rev2 startup-hooks)
1349 ))
1352 ;;;###autoload
1356 ;; Test if version control package is loaded and load if not
1357 ;; Is SILENT is non-nil, don't report error if package is not found.
1367 ediff-version-control-package)))))
1370 ;;;###autoload
1372 "Return string describing the version of Ediff.
1373 When called interactively, displays the version."
1380 ;;;###autoload
1382 "Display Ediff's manual.
1383 With optional NODE, goes to that node."
1410 ;;; Local Variables:
1411 ;;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
1412 ;;; eval: (put 'ediff-with-current-buffer 'lisp-indent-hook 1)
1413 ;;; eval: (put 'ediff-with-current-buffer 'edebug-form-spec '(form body))
1414 ;;; End:
1420 ;;; ediff.el ends here