| blob | d071c72114d1fa6f3d44aae33da703f9e9fa49e5 |
1 ;;; ediff.el --- a comprehensive visual interface to diff & patch
3 ;; Copyright (C) 1994, 1995, 1996 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:
110 ;; ediff-mult is always required, because of the registry stuff
131 ;; Some defvars to reduce the number of compiler warnings
135 ;; end of compiler pacifier
138 ;; Used as a startup hook to set `_orig' patch file read-only.
143 ;; Return a plausible default for ediff's first file:
144 ;; In dired, return the file name under the point, unless it is a directory
145 ;; If the buffer has a file name, return that file name.
150 f)))
153 ))
155 ;;; Compare files/buffers
157 ;;;###autoload
159 "Run Ediff on a pair of files, FILE-A and FILE-B."
162 ediff-last-dir-A
163 default-directory))
164 dir-B f)
166 "File A to compare" dir-A
171 ediff-last-dir-B
178 dir-B))
179 file-name-history))
180 f))
181 )))
186 file-B)
187 nil ; file-C
188 startup-hooks
191 ;;;###autoload
193 "Run Ediff on three files, FILE-A, FILE-B, and FILE-C."
196 ediff-last-dir-A
197 default-directory))
198 dir-B dir-C f ff)
200 "File A to compare" dir-A
205 ediff-last-dir-B
213 dir-B))
214 file-name-history))
215 f)))
218 ediff-last-dir-C
225 dir-C))
226 file-name-history))
227 ff))
228 )))
233 file-B)
237 file-C)
238 startup-hooks
241 ;;;###autoload
245 ;; Visit FILE and arrange its buffer to Ediff's liking.
246 ;; FILE is actually a variable symbol that must contain a true file name.
247 ;; BUFFER-NAME is a variable symbol, which will get the buffer object into
248 ;; which FILE is read.
249 ;; LAST-DIR is the directory variable symbol where FILE's
250 ;; directory name should be returned. HOOKS-VAR is a variable symbol that will
251 ;; be assigned the hook to be executed after `ediff-startup' is finished.
252 ;; `ediff-find-file' arranges that the temp files it might create will be
253 ;; deleted.
263 ;; some of the commands, below, require full file name
266 ;; Record the directory of the file
270 ;; Setup the buffer
276 ;; ange-ftp-hook-function--arrange for temp file
283 ;; file processed via auto-mode-alist, a la uncompress.el
298 ;;(sit-for 0)
301 ;;(sit-for 0)
306 ;;(sit-for 0)
313 buf-B file-B
314 buf-C file-C
315 startup-hooks
319 ;;;###autoload
323 ;;;###autoload
325 "Run Ediff on a pair of buffers, BUFFER-A and BUFFER-B."
332 ;; realign buffers so that two visible bufs will be
333 ;; at the top
336 t))))
340 ;;;###autoload
344 ;;;###autoload
347 "Run Ediff on three buffers, BUFFER-A, BUFFER-B, and BUFFER-C."
354 ;; realign buffers so that two visible
355 ;; bufs will be at the top
358 t))
361 ;; realign buffers so that three visible
362 ;; bufs will be at the top
365 t)
366 )))
370 ;;;###autoload
381 file-A file-B file-C)
405 file-C
410 ))
411 startup-hooks)
413 )))
416 ;;; Directory and file group operations
418 ;; Get appropriate default name for directory:
419 ;; If ediff-use-last-dir, use ediff-last-dir-A.
420 ;; In dired mode, use the directory that is under the point (if any);
421 ;; otherwise, use default-directory
427 f
428 default-directory)))
432 ;;;###autoload
434 "Run Ediff on a pair of directories, DIR1 and DIR2, comparing files that have
435 the same name in both. The third argument, REGEXP, is a regular expression that
436 can be used to filter out certain file names."
439 f)
443 ediff-last-dir-B
445 nil)
448 )))
451 ))
453 ;;;###autoload
457 ;;;###autoload
459 "Run Ediff on a directory, DIR1, comparing its files with their revisions.
460 The second argument, REGEXP, is a regular expression that filters the file
461 names. Only the files that are under revision control are taken into account."
468 )))
471 ))
473 ;;;###autoload
477 ;;;###autoload
479 "Run Ediff on three directories, DIR1, DIR2, and DIR3, comparing files that
480 have the same name in all three. The last argument, REGEXP, is a regular
481 expression that can be used to filter out certain file names."
484 f)
488 ediff-last-dir-B
490 nil))
493 ediff-last-dir-C
495 nil)
498 )))
501 ))
503 ;;;###autoload
506 ;;;###autoload
508 "Run Ediff on a pair of directories, DIR1 and DIR2, merging files that have
509 the same name in both. The third argument, REGEXP, is a regular expression that
510 can be used to filter out certain file names."
513 f)
517 ediff-last-dir-B
519 nil)
522 )))
525 ))
527 ;;;###autoload
530 ;;;###autoload
532 "Merge files in directories DIR1 and DIR2 using files in ANCESTOR-DIR as ancestors.
533 Ediff merges files that have identical names in DIR1, DIR2. If a pair of files
534 in DIR1 and DIR2 doesn't have an ancestor in ANCESTOR-DIR, Ediff will merge
535 without ancestor. The fourth argument, REGEXP, is a regular expression that
536 can be used to filter out certain file names."
539 f)
543 ediff-last-dir-B
545 nil))
548 ediff-last-dir-C
550 nil)
553 )))
555 dir1 dir2 ancestor-dir regexp
557 ))
559 ;;;###autoload
561 "Run Ediff on a directory, DIR1, merging its files with their revisions.
562 The second argument, REGEXP, is a regular expression that filters the file
563 names. Only the files that are under revision control are taken into account."
570 )))
573 ))
575 ;;;###autoload
578 ;;;###autoload
580 "Run Ediff on a directory, DIR1, merging its files with their revisions and ancestors.
581 The second argument, REGEXP, is a regular expression that filters the file
582 names. Only the files that are under revision control are taken into account."
589 )))
591 dir1 regexp 'ediff-merge-revisions-with-ancestor
592 'ediff-merge-directory-revisions-with-ancestor
593 ))
595 ;;;###autoload
597 'edir-merge-revisions-with-ancestor
600 ;;;###autoload
603 ;; Run ediff-action (ediff-files, ediff-merge, ediff-merge-with-ancestors)
604 ;; on a pair of directories (three directories, in case of ancestor).
605 ;; The third argument, REGEXP, is a regular expression that can be used to
606 ;; filter out certain file names.
607 ;; JOBNAME is the symbol indicating the meta-job to be performed.
609 action jobname
611 ;; ediff-read-file-name is set to attach a previously entered file name if
612 ;; the currently entered file is a directory. This code takes care of that.
629 file-list meta-buf)
633 ;; this sets various vars in the meta buffer inside
634 ;; ediff-prepare-meta-buffer
636 ;; tell what to do if the user clicks on a session record
638 ;; set ediff-dir-difference-list
640 startup-hooks))
642 'ediff-filegroup-action
643 file-list
644 "*Ediff Session Group Panel"
645 'ediff-redraw-directory-group-buffer
646 jobname
647 startup-hooks))
649 ))
658 ;; this sets various vars in the meta buffer inside
659 ;; ediff-prepare-meta-buffer
661 ;; tell what to do if the user clicks on a session record
663 ))
664 startup-hooks))
666 'ediff-filegroup-action
667 file-list
668 "*Ediff Session Group Panel"
669 'ediff-redraw-directory-group-buffer
670 jobname
671 startup-hooks))
673 ))
676 ;;; Compare regions and windows
678 ;;;###autoload
680 "Compare WIND-A and WIND-B, which are selected by clicking, wordwise.
681 With prefix argument, DUMB-MODE, or on a non-windowing display, works as
682 follows:
683 If WIND-A is nil, use selected window.
684 If WIND-B is nil, use window next to WIND-A."
689 ;;;###autoload
691 "Compare WIND-A and WIND-B, which are selected by clicking, linewise.
692 With prefix argument, DUMB-MODE, or on a non-windowing display, works as
693 follows:
694 If WIND-A is nil, use selected window.
695 If WIND-B is nil, use window next to WIND-A."
700 ;; Compare WIND-A and WIND-B, which are selected by clicking.
701 ;; With prefix argument, DUMB-MODE, or on a non-windowing display,
702 ;; works as follows:
703 ;; If WIND-A is nil, use selected window.
704 ;; If WIND-B is nil, use window next to WIND-A.
714 beg-A end-A beg-B end-B)
726 buffer-A beg-A end-A buffer-B beg-B end-B
727 startup-hooks job-name word-mode)))
729 ;;;###autoload
731 "Run Ediff on a pair of regions in two different buffers.
732 Regions \(i.e., point and mark\) are assumed to be set in advance.
733 This function is effective only for relatively small regions, up to 200
734 lines. For large regions, use `ediff-regions-linewise'."
741 ;; realign buffers so that two visible bufs will be
742 ;; at the top
745 t))))
766 ;;;###autoload
768 "Run Ediff on a pair of regions in two different buffers.
769 Regions \(i.e., point and mark\) are assumed to be set in advance.
770 Each region is enlarged to contain full lines.
771 This function is effective for large regions, over 100-200
772 lines. For small regions, use `ediff-regions-wordwise'."
779 ;; realign buffers so that two visible bufs will be
780 ;; at the top
783 t))))
794 ;; enlarge the region to hold full lines
806 ;; enlarge the region to hold full lines
822 ;; compare region beg-A to end-A of buffer-A
823 ;; to regions beg-B -- end-B in buffer-B.
825 startup-hooks job-name word-mode)
827 overl-A overl-B
828 file-A file-B)
830 ;; in case beg/end-A/B aren't markers--make them into markers
844 You have requested to compare overlapping regions of the same buffer.
846 In this case, Ediff's highlighting may be confusing---in the same window,
847 you may see highlighted regions that belong to different regions.
852 ()
855 ;; make file-A
861 ;; make file-B
870 buffer-B file-B
871 nil nil ; buffer & file C
875 startup-hooks)
879 )
880 ))
883 ;;; Merge files and buffers
885 ;;;###autoload
893 ;;;###autoload
895 "Merge two files without ancestor."
898 ediff-last-dir-A
899 default-directory))
900 dir-B f)
902 "File A to merge" dir-A
907 ediff-last-dir-B
914 dir-B))
915 file-name-history))
916 f))
917 )))
923 file-B)
924 nil ; file-C
925 startup-hooks
928 ;;;###autoload
931 "Merge two files with ancestor."
934 ediff-last-dir-A
935 default-directory))
936 dir-B dir-ancestor f ff)
938 "File A to merge" dir-A
943 ediff-last-dir-B
951 dir-B))
952 file-name-history))
953 f)))
957 ediff-last-dir-ancestor
964 dir-ancestor))
965 file-name-history))
966 ff))
967 )))
973 file-B)
974 file-ancestor
975 startup-hooks
978 ;;;###autoload
981 ;;;###autoload
983 "Merge buffers without ancestor."
990 ;; realign buffers so that two visible bufs will be
991 ;; at the top
994 t))))
999 buffer-A buffer-B nil startup-hooks job-name))
1001 ;;;###autoload
1003 buffer-B buffer-ancestor
1005 "Merge buffers with ancestor."
1012 ;; realign buffers so that two visible
1013 ;; bufs will be at the top
1016 t))
1019 ;; realign buffers so that three visible
1020 ;; bufs will be at the top
1023 t)
1024 )))
1029 buffer-A buffer-B buffer-ancestor startup-hooks job-name))
1032 ;;;###autoload
1034 "Run Ediff by merging two revisions of a file.
1035 The file is the optional FILE argument or the file visited by the current
1036 buffer."
1043 "Version 1 to merge (default: %s's latest version): "
1046 rev2
1049 "Version 2 to merge (default: %s): "
1053 ;; ancestor-revision=nil
1056 rev1 rev2 nil startup-hooks)))
1059 ;;;###autoload
1061 "Run Ediff by merging two revisions of a file with a common ancestor.
1062 The file is the the optional FILE argument or the file visited by the current
1063 buffer."
1070 "Version 1 to merge (default: %s's latest version): "
1073 rev2
1076 "Version 2 to merge (default: %s): "
1079 ancestor-rev
1082 "Ancestor version (default: %s): "
1088 rev1 rev2 ancestor-rev startup-hooks)))
1090 ;;;###autoload
1092 "Run Ediff-merge on appropriate revisions of the selected file.
1093 First run after `M-x cvs-update'. Then place the cursor on a lide describing a
1094 file and then run `run-ediff-from-cvs-buffer'."
1103 ;;; Apply patch
1105 ;;;###autoload
1107 "Run Ediff by patching SOURCE-FILENAME."
1108 ;; This now returns the control buffer
1121 ;; the default is the directory, not the visited file name
1125 ;;;###autoload
1127 "Run Ediff by patching BUFFER-NAME."
1133 patch-buf
1140 ;;;###autoload
1142 ;;;###autoload
1147 \f
1148 ;;; Versions Control functions
1150 ;;;###autoload
1152 "Run Ediff by comparing versions of a file.
1153 The file is an optional FILE argument or the file visited by the current
1154 buffer. Use `vc.el' or `rcs.el' depending on `ediff-version-control-package'."
1155 ;; if buffer is non-nil, use that buffer instead of the current buffer
1164 rev2
1172 rev1 rev2 startup-hooks)
1173 ))
1176 ;; Test if version control package is loaded and load if not
1177 ;; Is SILENT is non-nil, don't report error if package is not found.
1187 ediff-version-control-package)))))
1190 ;;;###autoload
1192 "Return string describing the version of Ediff.
1193 When called interactively, displays the version."
1200 ;;;###autoload
1202 "Display Ediff's manual."
1216 The Info file for Ediff does not seem to be installed.
1218 This file is part of the distribution of %sEmacs.
1219 Please contact your system administrator. "
1229 ;;; Local Variables:
1230 ;;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
1231 ;;; eval: (put 'ediff-eval-in-buffer 'lisp-indent-hook 1)
1232 ;;; End:
1237 ;;; ediff.el ends here