| blob | d07075bbac8b53fb8082aa3b142ff3ed94675800 |
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 file-list meta-buf)
699 ediff-last-merge-autostore-dir
701 nil
703 ;; verify we are not merging into an orig directory
719 jobname 'diffs
720 regexp dir1 dir2 dir3 merge-autostore-dir))
722 ;; this sets various vars in the meta buffer inside
723 ;; ediff-prepare-meta-buffer
725 ;; tell what to do if the user clicks on a session record
727 ;; set ediff-dir-difference-list
729 startup-hooks))
731 'ediff-filegroup-action
732 file-list
733 "*Ediff Session Group Panel"
734 'ediff-redraw-directory-group-buffer
735 jobname
736 startup-hooks))
738 ))
740 ;; MERGE-AUTOSTORE-DIR can be given to tell ediff where to store the merged
741 ;; files
743 &optional startup-hooks
744 merge-autostore-dir)
750 jobname)))
758 ediff-last-merge-autostore-dir
760 nil
762 ;; verify merge-autostore-dir != dir1
772 jobname regexp dir1 merge-autostore-dir))
774 ;; this sets various vars in the meta buffer inside
775 ;; ediff-prepare-meta-buffer
777 ;; tell what to do if the user clicks on a session record
779 startup-hooks))
781 'ediff-filegroup-action
782 file-list
783 "*Ediff Session Group Panel"
784 'ediff-redraw-directory-group-buffer
785 jobname
786 startup-hooks))
788 ))
791 ;;; Compare regions and windows
793 ;;;###autoload
795 "Compare WIND-A and WIND-B, which are selected by clicking, wordwise.
796 With prefix argument, DUMB-MODE, or on a non-windowing display, works as
797 follows:
798 If WIND-A is nil, use selected window.
799 If WIND-B is nil, use window next to WIND-A."
804 ;;;###autoload
806 "Compare WIND-A and WIND-B, which are selected by clicking, linewise.
807 With prefix argument, DUMB-MODE, or on a non-windowing display, works as
808 follows:
809 If WIND-A is nil, use selected window.
810 If WIND-B is nil, use window next to WIND-A."
815 ;; Compare WIND-A and WIND-B, which are selected by clicking.
816 ;; With prefix argument, DUMB-MODE, or on a non-windowing display,
817 ;; works as follows:
818 ;; If WIND-A is nil, use selected window.
819 ;; If WIND-B is nil, use window next to WIND-A.
829 beg-A end-A beg-B end-B)
843 buffer-B
847 buffer-A beg-A end-A buffer-B beg-B end-B
848 startup-hooks job-name word-mode nil)))
850 ;; Suggested by Hannu Koivisto <azure@iki.fi>
853 buff-name
863 "Mark a region in buffer %s; then type %s. Use %s to abort."
868 cloned-buff))
872 buff
878 cloned-buff))
884 ))
886 ;;;###autoload
888 "Run Ediff on a pair of regions in specified buffers.
889 Regions \(i.e., point and mark\) are assumed to be set in advance except
890 for the second region in the case both regions are from the same buffer.
891 In such a case the user is asked to interactively establish the second
892 region.
893 This function is effective only for relatively small regions, up to 200
894 lines. For large regions, use `ediff-regions-linewise'."
901 ;; realign buffers so that two visible bufs will be
902 ;; at the top
905 t))))
916 reg-A-beg reg-A-end reg-B-beg reg-B-end)
930 ;;;###autoload
932 "Run Ediff on a pair of regions in specified buffers.
933 Regions \(i.e., point and mark\) are assumed to be set in advance except
934 for the second region in the case both regions are from the same buffer.
935 In such a case the user is asked to interactively establish the second
936 region.
937 Each region is enlarged to contain full lines.
938 This function is effective for large regions, over 100-200
939 lines. For small regions, use `ediff-regions-wordwise'."
946 ;; realign buffers so that two visible bufs will be
947 ;; at the top
950 t))))
960 reg-A-beg reg-A-end reg-B-beg reg-B-end)
965 ;; enlarge the region to hold full lines
977 ;; enlarge the region to hold full lines
992 ;; compare region beg-A to end-A of buffer-A
993 ;; to regions beg-B -- end-B in buffer-B.
995 startup-hooks job-name word-mode
996 setup-parameters)
998 overl-A overl-B
999 file-A file-B)
1001 ;; in case beg/end-A/B aren't markers--make them into markers
1009 ;; make file-A
1015 ;; make file-B
1024 buffer-B file-B
1025 nil nil ; buffer & file C
1029 startup-hooks)
1034 setup-parameters))
1035 ))
1038 ;;; Merge files and buffers
1040 ;;;###autoload
1048 ;;;###autoload
1050 ;; MERGE-BUFFER-FILE is the file to be
1051 ;; associated with the merge buffer
1053 "Merge two files without ancestor."
1056 ediff-last-dir-A
1057 default-directory))
1058 dir-B f)
1060 "File A to merge"
1061 dir-A
1067 ediff-last-dir-B
1074 dir-B))
1075 file-name-history))
1077 )))
1083 file-B)
1084 nil ; file-C
1085 startup-hooks
1086 'ediff-merge-files
1087 merge-buffer-file))
1089 ;;;###autoload
1091 &optional
1092 startup-hooks
1093 ;; MERGE-BUFFER-FILE is the file
1094 ;; to be associated with the
1095 ;; merge buffer
1096 merge-buffer-file)
1097 "Merge two files with ancestor."
1100 ediff-last-dir-A
1101 default-directory))
1102 dir-B dir-ancestor f ff)
1104 "File A to merge"
1105 dir-A
1111 ediff-last-dir-B
1119 dir-B))
1120 file-name-history))
1125 ediff-last-dir-ancestor
1132 dir-ancestor))
1133 file-name-history))
1135 )))
1141 file-B)
1142 file-ancestor
1143 startup-hooks
1144 'ediff-merge-files-with-ancestor
1145 merge-buffer-file))
1147 ;;;###autoload
1150 ;;;###autoload
1152 &optional
1153 ;; MERGE-BUFFER-FILE is the file to be
1154 ;; associated with the merge buffer
1155 startup-hooks job-name merge-buffer-file)
1156 "Merge buffers without ancestor."
1163 ;; realign buffers so that two visible bufs will be
1164 ;; at the top
1167 t))))
1172 buffer-A buffer-B nil startup-hooks job-name merge-buffer-file))
1174 ;;;###autoload
1176 &optional
1177 startup-hooks
1178 job-name
1179 ;; MERGE-BUFFER-FILE is the
1180 ;; file to be associated
1181 ;; with the merge buffer
1182 merge-buffer-file)
1183 "Merge buffers with ancestor."
1190 ;; realign buffers so that two visible
1191 ;; bufs will be at the top
1194 t))
1197 ;; realign buffers so that three visible
1198 ;; bufs will be at the top
1201 t)
1202 )))
1207 buffer-A buffer-B buffer-ancestor startup-hooks job-name merge-buffer-file))
1210 ;;;###autoload
1212 ;; MERGE-BUFFER-FILE is the file to be associated with the merge buffer
1213 "Run Ediff by merging two revisions of a file.
1214 The file is the optional FILE argument or the file visited by the current
1215 buffer."
1222 "Version 1 to merge (default: %s's latest version): "
1225 rev2
1228 "Version 2 to merge (default: %s): "
1232 ;; ancestor-revision=nil
1235 rev1 rev2 nil startup-hooks merge-buffer-file)))
1238 ;;;###autoload
1240 file startup-hooks
1241 ;; MERGE-BUFFER-FILE is the file to
1242 ;; be associated with the merge
1243 ;; buffer
1244 merge-buffer-file)
1245 "Run Ediff by merging two revisions of a file with a common ancestor.
1246 The file is the optional FILE argument or the file visited by the current
1247 buffer."
1254 "Version 1 to merge (default: %s's latest version): "
1257 rev2
1260 "Version 2 to merge (default: %s): "
1263 ancestor-rev
1266 "Ancestor version (default: %s's base revision): "
1272 rev1 rev2 ancestor-rev startup-hooks merge-buffer-file)))
1274 ;; MK: Check. This function doesn't seem to be used any more by pcvs or pcl-cvs
1275 ;;;###autoload
1277 "Run Ediff-merge on appropriate revisions of the selected file.
1278 First run after `M-x cvs-update'. Then place the cursor on a line describing a
1279 file and then run `run-ediff-from-cvs-buffer'."
1288 ;;; Apply patch
1290 ;;;###autoload
1292 "Run Ediff by patching SOURCE-FILENAME.
1293 If optional PATCH-BUF is given, use the patch in that buffer
1294 and don't ask the user.
1295 If prefix argument, then: if even argument, assume that the patch is in a
1296 buffer. If odd -- assume it is in a file."
1312 "File to patch (directory, if multifile patch): "
1313 ;; use an explicit initial file
1317 ;;;###autoload
1319 "Run Ediff by patching BUFFER-NAME.
1320 Without prefix argument: asks if the patch is in some buffer and prompts for
1321 the buffer or a file, depending on the answer.
1322 With prefix arg=1: assumes the patch is in a file and prompts for the file.
1323 With prefix arg=2: assumes the patch is in a buffer and prompts for the buffer."
1330 patch-buf
1332 "Which buffer to patch? "
1336 ;;;###autoload
1338 ;;;###autoload
1343 \f
1344 ;;; Versions Control functions
1346 ;;;###autoload
1348 "Run Ediff by comparing versions of a file.
1349 The file is an optional FILE argument or the file entered at the prompt.
1350 Default: the file visited by the current buffer.
1351 Uses `vc.el' or `rcs.el' depending on `ediff-version-control-package'."
1352 ;; if buffer is non-nil, use that buffer instead of the current buffer
1358 ediff-last-dir-A
1359 default-directory)
1372 rev2
1379 rev1 rev2 startup-hooks)
1380 ))
1383 ;;;###autoload
1387 ;; Test if version control package is loaded and load if not
1388 ;; Is SILENT is non-nil, don't report error if package is not found.
1398 ediff-version-control-package)))))
1401 ;;;###autoload
1403 "Return string describing the version of Ediff.
1404 When called interactively, displays the version."
1411 ;;;###autoload
1413 "Display Ediff's manual.
1414 With optional NODE, goes to that node."
1441 ;;; Local Variables:
1442 ;;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
1443 ;;; eval: (put 'ediff-with-current-buffer 'lisp-indent-hook 1)
1444 ;;; eval: (put 'ediff-with-current-buffer 'edebug-form-spec '(form body))
1445 ;;; End:
1451 ;;; ediff.el ends here