| blob | d8ecd0f91a5d8d7e84d14a1b1371112ab2a9176d |
1 ;;; ediff.el --- a comprehensive visual interface to diff & patch
3 ;; Copyright (C) 1994, 1995, 1996, 1997 Free Software Foundation, Inc.
5 ;; Author: Michael Kifer <kifer@cs.sunysb.edu>
6 ;; Created: February 2, 1994
7 ;; Keywords: comparing, merging, patching, version control.
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 name under the point, unless it is a directory
167 ;; If the buffer has a file name, return that file name.
172 f)))
175 ))
177 ;;; Compare files/buffers
179 ;;;###autoload
181 "Run Ediff on a pair of files, FILE-A and FILE-B."
184 ediff-last-dir-A
185 default-directory))
186 dir-B f)
188 "File A to compare" dir-A
193 ediff-last-dir-B
200 dir-B))
201 file-name-history))
202 f))
203 )))
208 file-B)
209 nil ; file-C
210 startup-hooks
213 ;;;###autoload
215 "Run Ediff on three files, FILE-A, FILE-B, and FILE-C."
218 ediff-last-dir-A
219 default-directory))
220 dir-B dir-C f ff)
222 "File A to compare" dir-A
227 ediff-last-dir-B
235 dir-B))
236 file-name-history))
237 f)))
240 ediff-last-dir-C
247 dir-C))
248 file-name-history))
249 ff))
250 )))
255 file-B)
259 file-C)
260 startup-hooks
263 ;;;###autoload
267 ;; Visit FILE and arrange its buffer to Ediff's liking.
268 ;; FILE is actually a variable symbol that must contain a true file name.
269 ;; BUFFER-NAME is a variable symbol, which will get the buffer object into
270 ;; which FILE is read.
271 ;; LAST-DIR is the directory variable symbol where FILE's
272 ;; directory name should be returned. HOOKS-VAR is a variable symbol that will
273 ;; be assigned the hook to be executed after `ediff-startup' is finished.
274 ;; `ediff-find-file' arranges that the temp files it might create will be
275 ;; deleted.
285 ;; some of the commands, below, require full file name
288 ;; Record the directory of the file
292 ;; Setup the buffer
298 ;;; ange-ftp-hook-function--arrange for temp file
305 ;; file processed via auto-mode-alist, a la uncompress.el
317 ;; MERGE-BUFFER-FILE is the file to be associated with the merge buffer
322 ;;(sit-for 0)
325 ;;(sit-for 0)
330 ;;(sit-for 0)
337 buf-B file-B
338 buf-C file-C
339 startup-hooks
341 merge-buffer-file)))
344 ;;;###autoload
348 ;;;###autoload
350 "Run Ediff on a pair of buffers, BUFFER-A and BUFFER-B."
357 ;; realign buffers so that two visible bufs will be
358 ;; at the top
361 t))))
365 ;;;###autoload
369 ;;;###autoload
372 "Run Ediff on three buffers, BUFFER-A, BUFFER-B, and BUFFER-C."
379 ;; realign buffers so that two visible
380 ;; bufs will be at the top
383 t))
386 ;; realign buffers so that three visible
387 ;; bufs will be at the top
390 t)
391 )))
395 ;;;###autoload
400 ;; MERGE-BUFFER-FILE is the file to be associated with the merge buffer
408 file-A file-B file-C)
432 file-C
437 ))
438 startup-hooks)
440 merge-buffer-file)))
443 ;;; Directory and file group operations
445 ;; Get appropriate default name for directory:
446 ;; If ediff-use-last-dir, use ediff-last-dir-A.
447 ;; In dired mode, use the directory that is under the point (if any);
448 ;; otherwise, use default-directory
454 f
455 default-directory)))
459 ;;;###autoload
461 "Run Ediff on a pair of directories, DIR1 and DIR2, comparing files that have
462 the same name in both. The third argument, REGEXP, is a regular expression that
463 can be used to filter out certain file names."
466 f)
470 ediff-last-dir-B
472 nil)
475 )))
478 ))
480 ;;;###autoload
484 ;;;###autoload
486 "Run Ediff on a directory, DIR1, comparing its files with their revisions.
487 The second argument, REGEXP, is a regular expression that filters the file
488 names. Only the files that are under revision control are taken into account."
495 )))
498 ))
500 ;;;###autoload
504 ;;;###autoload
506 "Run Ediff on three directories, DIR1, DIR2, and DIR3, comparing files that
507 have the same name in all three. The last argument, REGEXP, is a regular
508 expression that can be used to filter out certain file names."
511 f)
515 ediff-last-dir-B
517 nil))
520 ediff-last-dir-C
522 nil)
525 )))
528 ))
530 ;;;###autoload
533 ;;;###autoload
535 "Run Ediff on a pair of directories, DIR1 and DIR2, merging files that have
536 the same name in both. The third argument, REGEXP, is a regular expression that
537 can be used to filter out certain file names."
540 f)
544 ediff-last-dir-B
546 nil)
549 )))
552 ))
554 ;;;###autoload
557 ;;;###autoload
559 "Merge files in directories DIR1 and DIR2 using files in ANCESTOR-DIR as ancestors.
560 Ediff merges files that have identical names in DIR1, DIR2. If a pair of files
561 in DIR1 and DIR2 doesn't have an ancestor in ANCESTOR-DIR, Ediff will merge
562 without ancestor. The fourth argument, REGEXP, is a regular expression that
563 can be used to filter out certain file names."
566 f)
570 ediff-last-dir-B
572 nil))
575 ediff-last-dir-C
577 nil)
580 )))
582 dir1 dir2 ancestor-dir regexp
584 ))
586 ;;;###autoload
588 "Run Ediff on a directory, DIR1, merging its files with their revisions.
589 The second argument, REGEXP, is a regular expression that filters the file
590 names. Only the files that are under revision control are taken into account."
597 )))
600 ))
602 ;;;###autoload
605 ;;;###autoload
607 "Run Ediff on a directory, DIR1, merging its files with their revisions and ancestors.
608 The second argument, REGEXP, is a regular expression that filters the file
609 names. Only the files that are under revision control are taken into account."
616 )))
618 dir1 regexp 'ediff-merge-revisions-with-ancestor
619 'ediff-merge-directory-revisions-with-ancestor
620 ))
622 ;;;###autoload
624 'edir-merge-revisions-with-ancestor
627 ;;;###autoload
630 ;; Run ediff-action (ediff-files, ediff-merge, ediff-merge-with-ancestors)
631 ;; on a pair of directories (three directories, in case of ancestor).
632 ;; The third argument, REGEXP, is a regular expression that can be used to
633 ;; filter out certain file names.
634 ;; JOBNAME is the symbol indicating the meta-job to be performed.
635 ;; MERGE-DIR is the directory in which to store merged files.
638 ;; ediff-read-file-name is set to attach a previously entered file name if
639 ;; the currently entered file is a directory. This code takes care of that.
656 merge-autostore-dir
657 file-list meta-buf)
662 ediff-last-merge-autostore-dir
664 nil)))
665 ;; verify we are not merging into an orig directory
679 jobname 'diffs
680 regexp dir1 dir2 dir3 merge-autostore-dir))
682 ;; this sets various vars in the meta buffer inside
683 ;; ediff-prepare-meta-buffer
685 ;; tell what to do if the user clicks on a session record
687 ;; set ediff-dir-difference-list
689 startup-hooks))
691 'ediff-filegroup-action
692 file-list
693 "*Ediff Session Group Panel"
694 'ediff-redraw-directory-group-buffer
695 jobname
696 startup-hooks))
698 ))
709 ediff-last-merge-autostore-dir
711 nil)))
712 ;; verify merge-autostore-dir != dir1
722 jobname regexp dir1 merge-autostore-dir))
724 ;; this sets various vars in the meta buffer inside
725 ;; ediff-prepare-meta-buffer
727 ;; tell what to do if the user clicks on a session record
729 ))
730 startup-hooks))
732 'ediff-filegroup-action
733 file-list
734 "*Ediff Session Group Panel"
735 'ediff-redraw-directory-group-buffer
736 jobname
737 startup-hooks))
739 ))
742 ;;; Compare regions and windows
744 ;;;###autoload
746 "Compare WIND-A and WIND-B, which are selected by clicking, wordwise.
747 With prefix argument, DUMB-MODE, or on a non-windowing display, works as
748 follows:
749 If WIND-A is nil, use selected window.
750 If WIND-B is nil, use window next to WIND-A."
755 ;;;###autoload
757 "Compare WIND-A and WIND-B, which are selected by clicking, linewise.
758 With prefix argument, DUMB-MODE, or on a non-windowing display, works as
759 follows:
760 If WIND-A is nil, use selected window.
761 If WIND-B is nil, use window next to WIND-A."
766 ;; Compare WIND-A and WIND-B, which are selected by clicking.
767 ;; With prefix argument, DUMB-MODE, or on a non-windowing display,
768 ;; works as follows:
769 ;; If WIND-A is nil, use selected window.
770 ;; If WIND-B is nil, use window next to WIND-A.
780 beg-A end-A beg-B end-B)
792 buffer-A beg-A end-A buffer-B beg-B end-B
793 startup-hooks job-name word-mode nil)))
795 ;;;###autoload
797 "Run Ediff on a pair of regions in two different buffers.
798 Regions \(i.e., point and mark\) are assumed to be set in advance.
799 This function is effective only for relatively small regions, up to 200
800 lines. For large regions, use `ediff-regions-linewise'."
807 ;; realign buffers so that two visible bufs will be
808 ;; at the top
811 t))))
832 ;;;###autoload
834 "Run Ediff on a pair of regions in two different buffers.
835 Regions \(i.e., point and mark\) are assumed to be set in advance.
836 Each region is enlarged to contain full lines.
837 This function is effective for large regions, over 100-200
838 lines. For small regions, use `ediff-regions-wordwise'."
845 ;; realign buffers so that two visible bufs will be
846 ;; at the top
849 t))))
860 ;; enlarge the region to hold full lines
872 ;; enlarge the region to hold full lines
887 ;; compare region beg-A to end-A of buffer-A
888 ;; to regions beg-B -- end-B in buffer-B.
890 startup-hooks job-name word-mode
891 setup-parameters)
893 overl-A overl-B
894 file-A file-B)
896 ;; in case beg/end-A/B aren't markers--make them into markers
910 You have requested to compare overlapping regions of the same buffer.
912 In this case, Ediff's highlighting may be confusing---in the same window,
913 you may see highlighted regions that belong to different regions.
918 ()
921 ;; make file-A
927 ;; make file-B
936 buffer-B file-B
937 nil nil ; buffer & file C
941 startup-hooks)
946 setup-parameters))
947 ))
950 ;;; Merge files and buffers
952 ;;;###autoload
960 ;;;###autoload
962 ;; MERGE-BUFFER-FILE is the file to be
963 ;; associated with the merge buffer
965 "Merge two files without ancestor."
968 ediff-last-dir-A
969 default-directory))
970 dir-B f)
972 "File A to merge" dir-A
977 ediff-last-dir-B
984 dir-B))
985 file-name-history))
986 f))
987 )))
993 file-B)
994 nil ; file-C
995 startup-hooks
996 'ediff-merge-files
997 merge-buffer-file))
999 ;;;###autoload
1001 &optional
1002 startup-hooks
1003 ;; MERGE-BUFFER-FILE is the file
1004 ;; to be associated with the
1005 ;; merge buffer
1006 merge-buffer-file)
1007 "Merge two files with ancestor."
1010 ediff-last-dir-A
1011 default-directory))
1012 dir-B dir-ancestor f ff)
1014 "File A to merge" dir-A
1019 ediff-last-dir-B
1027 dir-B))
1028 file-name-history))
1029 f)))
1033 ediff-last-dir-ancestor
1040 dir-ancestor))
1041 file-name-history))
1042 ff))
1043 )))
1049 file-B)
1050 file-ancestor
1051 startup-hooks
1052 'ediff-merge-files-with-ancestor
1053 merge-buffer-file))
1055 ;;;###autoload
1058 ;;;###autoload
1060 &optional
1061 ;; MERGE-BUFFER-FILE is the file to be
1062 ;; associated with the merge buffer
1063 startup-hooks job-name merge-buffer-file)
1064 "Merge buffers without ancestor."
1071 ;; realign buffers so that two visible bufs will be
1072 ;; at the top
1075 t))))
1080 buffer-A buffer-B nil startup-hooks job-name merge-buffer-file))
1082 ;;;###autoload
1084 &optional
1085 startup-hooks
1086 job-name
1087 ;; MERGE-BUFFER-FILE is the
1088 ;; file to be associated
1089 ;; with the merge buffer
1090 merge-buffer-file)
1091 "Merge buffers with ancestor."
1098 ;; realign buffers so that two visible
1099 ;; bufs will be at the top
1102 t))
1105 ;; realign buffers so that three visible
1106 ;; bufs will be at the top
1109 t)
1110 )))
1115 buffer-A buffer-B buffer-ancestor startup-hooks job-name merge-buffer-file))
1118 ;;;###autoload
1120 ;; MERGE-BUFFER-FILE is the file to be associated with the merge buffer
1121 "Run Ediff by merging two revisions of a file.
1122 The file is the optional FILE argument or the file visited by the current
1123 buffer."
1130 "Version 1 to merge (default: %s's latest version): "
1133 rev2
1136 "Version 2 to merge (default: %s): "
1140 ;; ancestor-revision=nil
1143 rev1 rev2 nil startup-hooks merge-buffer-file)))
1146 ;;;###autoload
1148 file startup-hooks
1149 ;; MERGE-BUFFER-FILE is the file to
1150 ;; be associated with the merge
1151 ;; buffer
1152 merge-buffer-file)
1153 "Run Ediff by merging two revisions of a file with a common ancestor.
1154 The file is the the optional FILE argument or the file visited by the current
1155 buffer."
1162 "Version 1 to merge (default: %s's latest version): "
1165 rev2
1168 "Version 2 to merge (default: %s): "
1171 ancestor-rev
1174 "Ancestor version (default: %s): "
1180 rev1 rev2 ancestor-rev startup-hooks merge-buffer-file)))
1182 ;;;###autoload
1184 "Run Ediff-merge on appropriate revisions of the selected file.
1185 First run after `M-x cvs-update'. Then place the cursor on a line describing a
1186 file and then run `run-ediff-from-cvs-buffer'."
1195 ;;; Apply patch
1197 ;;;###autoload
1199 "Run Ediff by patching SOURCE-FILENAME."
1200 ;; This now returns the control buffer
1213 ;; the default is the directory, not the visited file name
1218 ;;;###autoload
1220 "Run Ediff by patching BUFFER-NAME."
1226 patch-buf
1233 ;;;###autoload
1235 ;;;###autoload
1240 \f
1241 ;;; Versions Control functions
1243 ;;;###autoload
1245 "Run Ediff by comparing versions of a file.
1246 The file is an optional FILE argument or the file visited by the current
1247 buffer. Use `vc.el' or `rcs.el' depending on `ediff-version-control-package'."
1248 ;; if buffer is non-nil, use that buffer instead of the current buffer
1257 rev2
1265 rev1 rev2 startup-hooks)
1266 ))
1269 ;;;###autoload
1273 ;; Test if version control package is loaded and load if not
1274 ;; Is SILENT is non-nil, don't report error if package is not found.
1284 ediff-version-control-package)))))
1287 ;;;###autoload
1289 "Return string describing the version of Ediff.
1290 When called interactively, displays the version."
1297 ;;;###autoload
1299 "Display Ediff's manual.
1300 With optional NODE, goes to that node."
1325 ;;; Local Variables:
1326 ;;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
1327 ;;; eval: (put 'ediff-with-current-buffer 'lisp-indent-hook 1)
1328 ;;; eval: (put 'ediff-with-current-buffer 'edebug-form-spec '(form body))
1329 ;;; End:
1333 ;;; ediff.el ends here