| blob | 61b51da5702810fc796f7fcae4b21984427744f0 |
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
127 ))
128 ;; end pacifier
134 "A comprehensive visual interface to diff & patch"
139 "*If t, Ediff uses previous directory as default when reading file name."
154 ;; Some defvars to reduce the number of compiler warnings
158 ;; end of compiler pacifier
161 ;; Used as a startup hook to set `_orig' patch file read-only.
166 ;; Return a plausible default for ediff's first file:
167 ;; In dired, return the file name under the point, unless it is a directory
168 ;; If the buffer has a file name, return that file name.
173 f)))
176 ))
178 ;;; Compare files/buffers
180 ;;;###autoload
182 "Run Ediff on a pair of files, FILE-A and FILE-B."
185 ediff-last-dir-A
186 default-directory))
187 dir-B f)
189 "File A to compare" dir-A
194 ediff-last-dir-B
201 dir-B))
202 file-name-history))
203 f))
204 )))
209 file-B)
210 nil ; file-C
211 startup-hooks
214 ;;;###autoload
216 "Run Ediff on three files, FILE-A, FILE-B, and FILE-C."
219 ediff-last-dir-A
220 default-directory))
221 dir-B dir-C f ff)
223 "File A to compare" dir-A
228 ediff-last-dir-B
236 dir-B))
237 file-name-history))
238 f)))
241 ediff-last-dir-C
248 dir-C))
249 file-name-history))
250 ff))
251 )))
256 file-B)
260 file-C)
261 startup-hooks
264 ;;;###autoload
268 ;; Visit FILE and arrange its buffer to Ediff's liking.
269 ;; FILE is actually a variable symbol that must contain a true file name.
270 ;; BUFFER-NAME is a variable symbol, which will get the buffer object into
271 ;; which FILE is read.
272 ;; LAST-DIR is the directory variable symbol where FILE's
273 ;; directory name should be returned. HOOKS-VAR is a variable symbol that will
274 ;; be assigned the hook to be executed after `ediff-startup' is finished.
275 ;; `ediff-find-file' arranges that the temp files it might create will be
276 ;; deleted.
286 ;; some of the commands, below, require full file name
289 ;; Record the directory of the file
293 ;; Setup the buffer
299 ;;; ange-ftp-hook-function--arrange for temp file
306 ;; file processed via auto-mode-alist, a la uncompress.el
321 ;;(sit-for 0)
324 ;;(sit-for 0)
329 ;;(sit-for 0)
336 buf-B file-B
337 buf-C file-C
338 startup-hooks
342 ;;;###autoload
346 ;;;###autoload
348 "Run Ediff on a pair of buffers, BUFFER-A and BUFFER-B."
355 ;; realign buffers so that two visible bufs will be
356 ;; at the top
359 t))))
363 ;;;###autoload
367 ;;;###autoload
370 "Run Ediff on three buffers, BUFFER-A, BUFFER-B, and BUFFER-C."
377 ;; realign buffers so that two visible
378 ;; bufs will be at the top
381 t))
384 ;; realign buffers so that three visible
385 ;; bufs will be at the top
388 t)
389 )))
393 ;;;###autoload
404 file-A file-B file-C)
428 file-C
433 ))
434 startup-hooks)
436 )))
439 ;;; Directory and file group operations
441 ;; Get appropriate default name for directory:
442 ;; If ediff-use-last-dir, use ediff-last-dir-A.
443 ;; In dired mode, use the directory that is under the point (if any);
444 ;; otherwise, use default-directory
450 f
451 default-directory)))
455 ;;;###autoload
457 "Run Ediff on a pair of directories, DIR1 and DIR2, comparing files that have
458 the same name in both. The third argument, REGEXP, is a regular expression that
459 can be used to filter out certain file names."
462 f)
466 ediff-last-dir-B
468 nil)
471 )))
474 ))
476 ;;;###autoload
480 ;;;###autoload
482 "Run Ediff on a directory, DIR1, comparing its files with their revisions.
483 The second argument, REGEXP, is a regular expression that filters the file
484 names. Only the files that are under revision control are taken into account."
491 )))
494 ))
496 ;;;###autoload
500 ;;;###autoload
502 "Run Ediff on three directories, DIR1, DIR2, and DIR3, comparing files that
503 have the same name in all three. The last argument, REGEXP, is a regular
504 expression that can be used to filter out certain file names."
507 f)
511 ediff-last-dir-B
513 nil))
516 ediff-last-dir-C
518 nil)
521 )))
524 ))
526 ;;;###autoload
529 ;;;###autoload
531 "Run Ediff on a pair of directories, DIR1 and DIR2, merging files that have
532 the same name in both. The third argument, REGEXP, is a regular expression that
533 can be used to filter out certain file names."
536 f)
540 ediff-last-dir-B
542 nil)
545 )))
548 ))
550 ;;;###autoload
553 ;;;###autoload
555 "Merge files in directories DIR1 and DIR2 using files in ANCESTOR-DIR as ancestors.
556 Ediff merges files that have identical names in DIR1, DIR2. If a pair of files
557 in DIR1 and DIR2 doesn't have an ancestor in ANCESTOR-DIR, Ediff will merge
558 without ancestor. The fourth argument, REGEXP, is a regular expression that
559 can be used to filter out certain file names."
562 f)
566 ediff-last-dir-B
568 nil))
571 ediff-last-dir-C
573 nil)
576 )))
578 dir1 dir2 ancestor-dir regexp
580 ))
582 ;;;###autoload
584 "Run Ediff on a directory, DIR1, merging its files with their revisions.
585 The second argument, REGEXP, is a regular expression that filters the file
586 names. Only the files that are under revision control are taken into account."
593 )))
596 ))
598 ;;;###autoload
601 ;;;###autoload
603 "Run Ediff on a directory, DIR1, merging its files with their revisions and ancestors.
604 The second argument, REGEXP, is a regular expression that filters the file
605 names. Only the files that are under revision control are taken into account."
612 )))
614 dir1 regexp 'ediff-merge-revisions-with-ancestor
615 'ediff-merge-directory-revisions-with-ancestor
616 ))
618 ;;;###autoload
620 'edir-merge-revisions-with-ancestor
623 ;;;###autoload
626 ;; Run ediff-action (ediff-files, ediff-merge, ediff-merge-with-ancestors)
627 ;; on a pair of directories (three directories, in case of ancestor).
628 ;; The third argument, REGEXP, is a regular expression that can be used to
629 ;; filter out certain file names.
630 ;; JOBNAME is the symbol indicating the meta-job to be performed.
631 ;; MERGE-DIR is the directory in which to store merged files.
634 ;; ediff-read-file-name is set to attach a previously entered file name if
635 ;; the currently entered file is a directory. This code takes care of that.
652 merge-autostore-dir
653 file-list meta-buf)
658 ediff-last-merge-autostore-dir
660 nil)))
661 ;; verify we are not merging into an orig directory
675 jobname 'diffs
676 regexp dir1 dir2 dir3 merge-autostore-dir))
678 ;; this sets various vars in the meta buffer inside
679 ;; ediff-prepare-meta-buffer
681 ;; tell what to do if the user clicks on a session record
683 ;; set ediff-dir-difference-list
685 startup-hooks))
687 'ediff-filegroup-action
688 file-list
689 "*Ediff Session Group Panel"
690 'ediff-redraw-directory-group-buffer
691 jobname
692 startup-hooks))
694 ))
705 ediff-last-merge-autostore-dir
707 nil)))
708 ;; verify merge-autostore-dir != dir1
718 jobname regexp dir1 merge-autostore-dir))
720 ;; this sets various vars in the meta buffer inside
721 ;; ediff-prepare-meta-buffer
723 ;; tell what to do if the user clicks on a session record
725 ))
726 startup-hooks))
728 'ediff-filegroup-action
729 file-list
730 "*Ediff Session Group Panel"
731 'ediff-redraw-directory-group-buffer
732 jobname
733 startup-hooks))
735 ))
738 ;;; Compare regions and windows
740 ;;;###autoload
742 "Compare WIND-A and WIND-B, which are selected by clicking, wordwise.
743 With prefix argument, DUMB-MODE, or on a non-windowing display, works as
744 follows:
745 If WIND-A is nil, use selected window.
746 If WIND-B is nil, use window next to WIND-A."
751 ;;;###autoload
753 "Compare WIND-A and WIND-B, which are selected by clicking, linewise.
754 With prefix argument, DUMB-MODE, or on a non-windowing display, works as
755 follows:
756 If WIND-A is nil, use selected window.
757 If WIND-B is nil, use window next to WIND-A."
762 ;; Compare WIND-A and WIND-B, which are selected by clicking.
763 ;; With prefix argument, DUMB-MODE, or on a non-windowing display,
764 ;; works as follows:
765 ;; If WIND-A is nil, use selected window.
766 ;; If WIND-B is nil, use window next to WIND-A.
776 beg-A end-A beg-B end-B)
788 buffer-A beg-A end-A buffer-B beg-B end-B
789 startup-hooks job-name word-mode nil)))
791 ;;;###autoload
793 "Run Ediff on a pair of regions in two different buffers.
794 Regions \(i.e., point and mark\) are assumed to be set in advance.
795 This function is effective only for relatively small regions, up to 200
796 lines. For large regions, use `ediff-regions-linewise'."
803 ;; realign buffers so that two visible bufs will be
804 ;; at the top
807 t))))
828 ;;;###autoload
830 "Run Ediff on a pair of regions in two different buffers.
831 Regions \(i.e., point and mark\) are assumed to be set in advance.
832 Each region is enlarged to contain full lines.
833 This function is effective for large regions, over 100-200
834 lines. For small regions, use `ediff-regions-wordwise'."
841 ;; realign buffers so that two visible bufs will be
842 ;; at the top
845 t))))
856 ;; enlarge the region to hold full lines
868 ;; enlarge the region to hold full lines
883 ;; compare region beg-A to end-A of buffer-A
884 ;; to regions beg-B -- end-B in buffer-B.
886 startup-hooks job-name word-mode
887 setup-parameters)
889 overl-A overl-B
890 file-A file-B)
892 ;; in case beg/end-A/B aren't markers--make them into markers
906 You have requested to compare overlapping regions of the same buffer.
908 In this case, Ediff's highlighting may be confusing---in the same window,
909 you may see highlighted regions that belong to different regions.
914 ()
917 ;; make file-A
923 ;; make file-B
932 buffer-B file-B
933 nil nil ; buffer & file C
937 startup-hooks)
942 setup-parameters)
943 )
944 ))
947 ;;; Merge files and buffers
949 ;;;###autoload
957 ;;;###autoload
959 "Merge two files without ancestor."
962 ediff-last-dir-A
963 default-directory))
964 dir-B f)
966 "File A to merge" dir-A
971 ediff-last-dir-B
978 dir-B))
979 file-name-history))
980 f))
981 )))
987 file-B)
988 nil ; file-C
989 startup-hooks
992 ;;;###autoload
995 "Merge two files with ancestor."
998 ediff-last-dir-A
999 default-directory))
1000 dir-B dir-ancestor f ff)
1002 "File A to merge" dir-A
1007 ediff-last-dir-B
1015 dir-B))
1016 file-name-history))
1017 f)))
1021 ediff-last-dir-ancestor
1028 dir-ancestor))
1029 file-name-history))
1030 ff))
1031 )))
1037 file-B)
1038 file-ancestor
1039 startup-hooks
1042 ;;;###autoload
1045 ;;;###autoload
1047 "Merge buffers without ancestor."
1054 ;; realign buffers so that two visible bufs will be
1055 ;; at the top
1058 t))))
1063 buffer-A buffer-B nil startup-hooks job-name))
1065 ;;;###autoload
1067 buffer-B buffer-ancestor
1069 "Merge buffers with ancestor."
1076 ;; realign buffers so that two visible
1077 ;; bufs will be at the top
1080 t))
1083 ;; realign buffers so that three visible
1084 ;; bufs will be at the top
1087 t)
1088 )))
1093 buffer-A buffer-B buffer-ancestor startup-hooks job-name))
1096 ;;;###autoload
1098 "Run Ediff by merging two revisions of a file.
1099 The file is the optional FILE argument or the file visited by the current
1100 buffer."
1107 "Version 1 to merge (default: %s's latest version): "
1110 rev2
1113 "Version 2 to merge (default: %s): "
1117 ;; ancestor-revision=nil
1120 rev1 rev2 nil startup-hooks)))
1123 ;;;###autoload
1125 "Run Ediff by merging two revisions of a file with a common ancestor.
1126 The file is the the optional FILE argument or the file visited by the current
1127 buffer."
1134 "Version 1 to merge (default: %s's latest version): "
1137 rev2
1140 "Version 2 to merge (default: %s): "
1143 ancestor-rev
1146 "Ancestor version (default: %s): "
1152 rev1 rev2 ancestor-rev startup-hooks)))
1154 ;;;###autoload
1156 "Run Ediff-merge on appropriate revisions of the selected file.
1157 First run after `M-x cvs-update'. Then place the cursor on a line describing a
1158 file and then run `run-ediff-from-cvs-buffer'."
1167 ;;; Apply patch
1169 ;;;###autoload
1171 "Run Ediff by patching SOURCE-FILENAME."
1172 ;; This now returns the control buffer
1185 ;; the default is the directory, not the visited file name
1189 ;;;###autoload
1191 "Run Ediff by patching BUFFER-NAME."
1197 patch-buf
1204 ;;;###autoload
1206 ;;;###autoload
1211 \f
1212 ;;; Versions Control functions
1214 ;;;###autoload
1216 "Run Ediff by comparing versions of a file.
1217 The file is an optional FILE argument or the file visited by the current
1218 buffer. Use `vc.el' or `rcs.el' depending on `ediff-version-control-package'."
1219 ;; if buffer is non-nil, use that buffer instead of the current buffer
1228 rev2
1236 rev1 rev2 startup-hooks)
1237 ))
1240 ;; Test if version control package is loaded and load if not
1241 ;; Is SILENT is non-nil, don't report error if package is not found.
1251 ediff-version-control-package)))))
1254 ;;;###autoload
1256 "Return string describing the version of Ediff.
1257 When called interactively, displays the version."
1264 ;;;###autoload
1266 "Display Ediff's manual.
1267 With optional NODE, goes to that node."
1292 ;;; Local Variables:
1293 ;;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
1294 ;;; eval: (put 'ediff-eval-in-buffer 'lisp-indent-hook 1)
1295 ;;; eval: (put 'ediff-eval-in-buffer 'edebug-form-spec '(form body))
1296 ;;; End:
1300 ;;; ediff.el ends here