| blob | 3bdce5c177a6e81b675a73b55a0304a7287e7e5d |
1 ;;; ediff.el --- a comprehensive visual interface to diff & patch
2 ;;; Copyright (C) 1994, 1995 Free Software Foundation, Inc.
4 ;; Author: Michael Kifer <kifer@cs.sunysb.edu>
5 ;; Created: February 2, 1994
6 ;; Keywords: comparing, merging, patching, version control.
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to
25 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
27 ;;; Commentary:
28 ;; ----------
30 ;; Never read that diff output again!
31 ;; Apply patch selectively, like a pro!
32 ;; Merge with ease!
34 ;; This package provides a convenient way of simultaneous browsing through
35 ;; the differences between a pair (or a triple) of files or buffers. The
36 ;; files being compared, file-A, file-B, and file-C (if applicable) are
37 ;; shown in separate windows (side by side, one above the another, or in
38 ;; separate frames), and the differences are highlighted as you step
39 ;; through them. You can also copy difference regions from one buffer to
40 ;; another (and recover old differences if you change your mind).
42 ;; Ediff also supports merging operations on files and buffers, including
43 ;; merging using ancestor versions. Both comparison and merging operations can
44 ;; be performed on directories, i.e., by pairwise comparison of files in those
45 ;; directories.
47 ;; In addition, Ediff can apply a patch to a file and then let you step
48 ;; though both files, the patched and the original one, simultaneously,
49 ;; difference-by-difference. You can even apply a patch right out of a
50 ;; mail buffer, i.e., patches received by mail don't even have to be saved.
51 ;; Since Ediff lets you copy differences between buffers, you can, in
52 ;; effect, apply patches selectively (i.e., you can copy a difference
53 ;; region from file_orig to file, thereby undoing any particular patch that
54 ;; you don't like).
56 ;; Ediff is aware of version control, which lets the user compare
57 ;; files with their older versions. Ediff can also work with remote and
58 ;; compressed files. Details are given below.
60 ;; Finally, Ediff supports directory-level comparison and merging operations.
61 ;; See the on-line manual for details.
63 ;; This package builds upon the ideas borrowed from emerge.el and several
64 ;; Ediff's functions are adaptations from emerge.el. Much of the functionality
65 ;; Ediff provides is also influenced by emerge.el.
67 ;; The present version of Ediff supersedes Emerge. It provides a superior user
68 ;; interface and has numerous major features not found in Emerge. In
69 ;; particular, it can do patching, and 2-way and 3-way file comparison,
70 ;; merging, and directory operations.
74 ;;; Bugs:
75 ;; -----
77 ;; 1. The undo command doesn't restore deleted regions well. That is, if
78 ;; you delete all characters in a difference region and then invoke
79 ;; `undo', the reinstated text will most likely be inserted outside of
80 ;; what Ediff thinks is the current difference region. (This problem
81 ;; doesn't seem to exist with XEmacs.)
82 ;;
83 ;; If at any point you feel that difference regions are no longer correct,
84 ;; you can hit '!' to recompute the differences.
86 ;; 2. On a monochrome display, the repertoire of faces with which to
87 ;; highlight fine differences is limited. By default, Ediff is using
88 ;; underlining. However, if the region is already underlied by some other
89 ;; overlays, there is no simple way to temporarily remove that residual
90 ;; underlining. This problem occurs when a buffer is highlighted with
91 ;; hilit19.el or font-lock.el packages. If this residual highlighting gets
92 ;; in the way, you can do the following. Both font-lock.el and hilit19.el
93 ;; provide commands for unhighlighting buffers. You can either place these
94 ;; commands in `ediff-prepare-buffer-hook' (which will unhighlight every
95 ;; buffer used by Ediff) or you can execute them interactively, at any time
96 ;; and on any buffer.
97 ;;
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.
108 ;;; Code:
127 ;;; Patching
134 ;;;###autoload
136 "Run Ediff by patching FILE-TP-PATCH."
137 ;; This now returns the control buffer
140 "File to patch"
142 ediff-last-dir-patch
143 default-directory)
150 default-directory)
154 ;; if the user specified a -b option, extract the backup
155 ;; extension from there; else use ediff-backup-extension
162 ;; ediff-find-file may use a temp file to do the patch
163 ;; so, we save source-filename and true-source-filename as a var
164 ;; that initially is source-filename but may be changed to a temp
165 ;; file for the purpose of patching.
168 target-buf buf-to-patch file-name-magic-p ctl-buf)
170 ;; if the user didn't specify a backup extension, use
171 ;; ediff-backup-extension
175 ;; Make a temp file, if source-filename has a magic file handler (or if
176 ;; it is handled via auto-mode-alist and similar magic).
177 ;; Check if there is a buffer visiting source-filename and if they are in
178 ;; synch; arrange for the deletion of temp file.
182 ;; Check if source file name has triggered black magic, such as file name
183 ;; handlers or auto mode alist, and make a note of it.
184 ;; true-source-filename should be either the original name or a
185 ;; temporary file where we put the after-product of the file handler.
189 ;; Checkout orig file, if necessary, so that the patched file could be
190 ;; checked back in.
196 ;;(sit-for 0)
197 ;; always pass patch the -f option, so it won't ask any questions
201 ediff-patch-program ediff-patch-options
202 backup-extension
204 t))
205 ;;(message "Applying patch ... done")(sit-for 0)
212 ;; If black magic is involved, apply patch to a temp copy of the
213 ;; file. Otherwise, apply patch to the orig copy. If patch is applied
214 ;; to temp copy, we name the result old-name_patched for local files
215 ;; and temp-copy_patched for remote files. The orig file name isn't
216 ;; changed, and the temp copy of the original is later deleted.
217 ;; Without magic, the original file is renamed (usually into
218 ;; old-name_orig) and the result of patching will have the same name as
219 ;; the original.
225 ;; Black magic in effect.
226 ;; If orig file was remote, put the patched file in the temp directory.
227 ;; If orig file is local, put the patched file in the directory of
228 ;; the orig file.
232 true-source-filename
233 source-filename)
238 ;; arrange that the temp copy of orig will be deleted
240 true-source-filename t))
242 ;; make orig buffer read-only
246 ;; set up a buf for the patched file
251 buf-to-patch target-buf nil
257 ctl-buf))
260 "Used as a startup hook to set `_orig' patch file read-only."
264 ;; Return a plausible default for ediff's first file:
265 ;; In dired, return the file name under the point, unless it is a directory
266 ;; If the buffer has a file name, return that file name.
271 f)))
274 ))
276 ;;;###autoload
278 ;;;###autoload
281 ;;; Compare files/buffers
283 ;;;###autoload
285 "Run Ediff on a pair of files, FILE-A and FILE-B."
288 ediff-last-dir-A
289 default-directory))
290 dir-B f)
292 "File A to compare" dir-A
297 ediff-last-dir-B
304 dir-B))
305 file-name-history))
306 f))
307 )))
312 file-B)
313 nil ; file-C
314 startup-hooks
317 ;;;###autoload
319 "Run Ediff on three files, FILE-A, FILE-B, and FILE-C."
322 ediff-last-dir-A
323 default-directory))
324 dir-B dir-C f ff)
326 "File A to compare" dir-A
331 ediff-last-dir-B
339 dir-B))
340 file-name-history))
341 f)))
344 ediff-last-dir-C
351 dir-C))
352 file-name-history))
353 ff))
354 )))
359 file-B)
363 file-C)
364 startup-hooks
367 ;;;###autoload
372 "Visit FILE and arrange its buffer to Ediff's liking.
373 FILE is actually a variable symbol that must contain a true file name.
374 BUFFER-NAME is a variable symbol, which will get the buffer object into which
375 FILE is read. LAST-DIR is the directory variable symbol where FILE's
376 directory name should be returned. HOOKS is a variable symbol that will be
377 assigned the hook to be executed after `ediff-startup' is finished.
378 `ediff-find-file' arranges that the temp files it might create will be
379 deleted."
388 ;; some of the command, below, require full file name
391 ;; Record the directory of the file
395 ;; Setup the buffer
401 ;; ange-ftp-hook-function--arrange for temp file
408 ;; file processed via auto-mode-alist, a la uncompress.el
423 ;;(sit-for 0)
426 ;;(sit-for 0)
431 ;;(sit-for 0)
438 buf-B file-B
439 buf-C file-C
440 startup-hooks
444 ;;;###autoload
448 ;;;###autoload
450 "Run Ediff on a pair of buffers, BUFFER-A and BUFFER-B."
457 ;; realign buffers so that two visible bufs will be
458 ;; at the top
461 t))))
466 ;;;###autoload
469 "Run Ediff on three buffers, BUFFER-A, BUFFER-B, and BUFFER-C."
476 ;; realign buffers so that two visible
477 ;; bufs will be at the top
480 t))
483 ;; realign buffers so that three visible
484 ;; bufs will be at the top
487 t)
488 )))
501 file-A file-B file-C)
525 file-C
530 ))
531 startup-hooks)
533 )))
536 ;;; Directory and file group operations
538 ;; Get appropriate default name for directory:
539 ;; If ediff-use-last-dir, use ediff-last-dir-A.
540 ;; In dired mode, use the directory that is under the point (if any);
541 ;; otherwise, use default-directory
547 f
548 default-directory)))
552 ;;;###autoload
554 "Run Ediff on a pair of directories, DIR1 and DIR2, comparing files that have
555 the same name in both. The third argument, REGEXP, is a regular expression that
556 further filters the file names."
559 f)
563 ediff-last-dir-B
565 nil)
567 nil ediff-filtering-regexp-history)
568 )))
571 ))
573 ;;;###autoload
577 ;;;###autoload
579 "Run Ediff on a directory, DIR1, comparing its files with their revisions.
580 The second argument, REGEXP, is a regular expression that filters the file
581 names. Only the files that are under revision control are taken into account."
587 nil ediff-filtering-regexp-history)
588 )))
591 ))
593 ;;;###autoload
597 ;;;###autoload
599 "Run Ediff on three directories, DIR1, DIR2, and DIR3, comparing files that
600 have the same name in all three. The last argument, REGEXP, is a regular
601 expression that further filters the file names."
604 f)
608 ediff-last-dir-B
610 nil))
613 ediff-last-dir-C
615 nil)
617 nil ediff-filtering-regexp-history)
618 )))
621 ))
623 ;;;###autoload
626 ;;;###autoload
628 "Run Ediff on a pair of directories, DIR1 and DIR2, merging files that have
629 the same name in both. The third argument, REGEXP, is a regular expression that
630 further filters the file names."
633 f)
637 ediff-last-dir-B
639 nil)
641 nil ediff-filtering-regexp-history)
642 )))
645 ))
647 ;;;###autoload
650 ;;;###autoload
652 "Run Ediff on a pair of directories, DIR1 and DIR2, merging files that have
653 the same name in both. The third argument, REGEXP, is a regular expression that
654 further filters the file names."
657 f)
661 ediff-last-dir-B
663 nil))
666 ediff-last-dir-C
668 nil)
670 nil ediff-filtering-regexp-history)
671 )))
673 dir1 dir2 dir3 regexp
675 ))
677 ;;;###autoload
679 "Run Ediff on a directory, DIR1, merging its files with their revisions.
680 The second argument, REGEXP, is a regular expression that filters the file
681 names. Only the files that are under revision control are taken into account."
687 nil ediff-filtering-regexp-history)
688 )))
691 ))
693 ;;;###autoload
696 ;;;###autoload
698 "Run Ediff on a directory, DIR1, merging its files with their revisions and ancestors.
699 The second argument, REGEXP, is a regular expression that filters the file
700 names. Only the files that are under revision control are taken into account."
706 nil ediff-filtering-regexp-history)
707 )))
709 dir1 regexp 'ediff-merge-revisions-with-ancestor
710 'ediff-merge-directory-revisions-with-ancestor
711 ))
713 ;;;###autoload
715 'edir-merge-revisions-with-ancestor
718 ;;;###autoload
721 ;; Run ediff-action (ediff-files, ediff-merge, ediff-merge-with-ancestors)
722 ;; on a pair of directories (three directories, in case of ancestor).
723 ;; The third argument, REGEXP, is a regular expression that further filters the
724 ;; file names.
725 ;; JOBNAME is the symbol indicating the meta-job to be performed.
727 action jobname
729 ;; ediff-read-file-name is set to attach a previously entered file name if
730 ;; the currently entered file is a directory. This code takes care of that.
747 file-list meta-buf)
751 ;; this sets various vars in the meta buffer inside
752 ;; ediff-prepare-meta-buffer
754 ;; tell what to do if the user clicks on a session record
756 ;; set ediff-dir-difference-list
758 startup-hooks))
760 'ediff-dir-action
761 file-list
762 "*Ediff Session Group Panel"
763 'ediff-redraw-directory-group-buffer
764 jobname
765 startup-hooks))
767 ))
776 ;; this sets various vars in the meta buffer inside
777 ;; ediff-prepare-meta-buffer
779 ;; tell what to do if the user clicks on a session record
781 ))
782 startup-hooks))
784 'ediff-dir-action
785 file-list
786 "*Ediff Session Group Panel"
787 'ediff-redraw-directory-group-buffer
788 jobname
789 startup-hooks))
791 ))
794 ;;; Compare regions and windows
796 ;;;###autoload
798 "Compare WIND-A and WIND-B, which are selected by clicking, wordwise.
799 With prefix argument, DUMB-MODE, or on a non-windowing display, works as
800 follows:
801 If WIND-A is nil, use selected window.
802 If WIND-B is nil, use window next to WIND-A."
807 ;;;###autoload
809 "Compare WIND-A and WIND-B, which are selected by clicking, linewise.
810 With prefix argument, DUMB-MODE, or on a non-windowing display, works as
811 follows:
812 If WIND-A is nil, use selected window.
813 If WIND-B is nil, use window next to WIND-A."
818 ;; Compare WIND-A and WIND-B, which are selected by clicking.
819 ;; With prefix argument, DUMB-MODE, or on a non-windowing display,
820 ;; works as follows:
821 ;; If WIND-A is nil, use selected window.
822 ;; If WIND-B is nil, use window next to WIND-A.
832 beg-A end-A beg-B end-B)
844 buffer-A beg-A end-A buffer-B beg-B end-B
845 startup-hooks job-name word-mode)))
847 ;;;###autoload
849 "Run Ediff on a pair of regions in two different buffers.
850 Regions \(i.e., point and mark\) are assumed to be set in advance.
851 This function is effective only for relatively small regions, up to 200
852 lines. For large regions, use `ediff-regions-linewise'."
859 ;; realign buffers so that two visible bufs will be
860 ;; at the top
863 t))))
884 ;;;###autoload
886 "Run Ediff on a pair of regions in two different buffers.
887 Regions \(i.e., point and mark\) are assumed to be set in advance.
888 Each region is enlarged to contain full lines.
889 This function is effective for large regions, over 100-200
890 lines. For small regions, use `ediff-regions-wordwise'."
897 ;; realign buffers so that two visible bufs will be
898 ;; at the top
901 t))))
912 ;; enlarge the region to hold full lines
924 ;; enlarge the region to hold full lines
940 ;; compare region beg-A to end-A of buffer-A
941 ;; to regions beg-B -- end-B in buffer-B.
943 startup-hooks job-name word-mode)
945 overl-A overl-B
946 file-A file-B)
948 ;; in case beg/end-A/B aren't markers--make them into markers
962 You have requested to compare overlapping regions of the same buffer.
964 In this case, Ediff's highlighting may be confusing---in the same window,
965 you may see highlighted regions that belong to different regions.
970 ()
973 ;; make file-A
979 ;; make file-B
988 buffer-B file-B
989 nil nil ; buffer & file C
993 startup-hooks)
997 )
998 ))
1001 ;;; Merge files and buffers
1003 ;;;###autoload
1011 ;;;###autoload
1013 "Merge two files without ancestor."
1016 ediff-last-dir-A
1017 default-directory))
1018 dir-B f)
1020 "File A to merge" dir-A
1025 ediff-last-dir-B
1032 dir-B))
1033 file-name-history))
1034 f))
1035 )))
1041 file-B)
1042 nil ; file-C
1043 startup-hooks
1046 ;;;###autoload
1049 "Merge two files with ancestor."
1052 ediff-last-dir-A
1053 default-directory))
1054 dir-B dir-ancestor f ff)
1056 "File A to merge" dir-A
1061 ediff-last-dir-B
1069 dir-B))
1070 file-name-history))
1071 f)))
1075 ediff-last-dir-ancestor
1082 dir-ancestor))
1083 file-name-history))
1084 ff))
1085 )))
1091 file-B)
1092 file-ancestor
1093 startup-hooks
1096 ;;;###autoload
1099 ;;;###autoload
1101 "Merge buffers without ancestor."
1108 ;; realign buffers so that two visible bufs will be
1109 ;; at the top
1112 t))))
1117 buffer-A buffer-B nil startup-hooks job-name))
1119 ;;;###autoload
1121 buffer-B buffer-ancestor
1123 "Merge buffers with ancestor."
1130 ;; realign buffers so that two visible
1131 ;; bufs will be at the top
1134 t))
1137 ;; realign buffers so that three visible
1138 ;; bufs will be at the top
1141 t)
1142 )))
1147 buffer-A buffer-B buffer-ancestor startup-hooks job-name))
1150 ;;;###autoload
1152 "Run Ediff by merging two revisions of a file.
1153 The file is the optional FILE argument or the file visited by the current
1154 buffer."
1162 "Version 1 to merge (default: %s's latest version): "
1165 rev2
1168 "Version 2 to merge (default: %s): "
1185 startup-hooks)))
1205 ;;;###autoload
1207 "Run Ediff by merging two revisions of a file with a common ancestor.
1208 The file is the the optional FILE argument or the file visited by the current
1209 buffer."
1217 "Version 1 to merge (default: %s's latest version): "
1220 rev2
1223 "Version 2 to merge (default: %s): "
1226 ancestor-rev
1229 "Ancestor version (default: %s): "
1252 startup-hooks)))
1277 buf1 buf2 ancestor-buf
1281 ;;; Apply patch
1283 ;;;###autoload
1285 "Run Ediff by patching BUFFER-NAME."
1291 default-dir file-name ctl-buf)
1303 ))
1309 ()
1325 ))
1329 "Obtain patch buffer. If patch is already in a buffer---use it.
1330 Else, read patch file into a new buffer."
1345 \f
1346 ;;; Versions Control functions
1348 ;;;###autoload
1350 "Run Ediff by comparing versions of a file.
1351 The file is an optional FILE argument or the file visited by the current
1352 buffer. Use `vc.el' or `rcs.el' depending on `ediff-version-control-package'."
1353 ;; if buffer is non-nil, use that buffer instead of the current buffer
1362 rev2
1370 rev1 rev2 startup-hooks)
1371 ))
1374 ;; Test if version control package is loaded and load if not
1375 ;; Is SILENT is non-nil, don't report error if package is not found.
1384 ediff-version-control-package)))))
1388 "Run Ediff on versions of the current buffer.
1390 If the current buffer is named `F', the version is named `F.~REV~'.
1391 If `F.~REV~' already exists, it is used instead of being re-created."
1406 ))
1407 startup-hooks))
1409 rev1buf rev2buf
1410 startup-hooks
1414 "View previous RCS revision of current file.
1415 With prefix argument, prompts for a revision name."
1430 ;; -q: quiet (no diagnostics)
1434 buff)))
1437 ;; Get a buffer for RCS output for FILE, make it writable and clean it up.
1438 ;; Optional NAME is name to use instead of `*RCS-output*'.
1439 ;; This is a modified version from rcs.el v1.1. I use it here to make
1440 ;; Ediff immune to changes in rcs.el
1448 buf))
1451 "Run Ediff on versions of the current buffer.
1458 ;; rcs.el doesn't create temp version files, so we don't have to delete
1459 ;; anything in startup hooks to ediff-buffers
1461 ))
1467 )
1470 "Run Ediff on versions of the current buffer.
1472 If the current buffer is named `F', the version is named `F.~REV~'.
1473 If `F.~REV~' already exists, it is used instead of being re-created."
1486 ;;;###autoload
1488 "Return string describing the version of Ediff.
1489 When called interactively, displays the version."
1499 ;;; ediff.el ends here