| blob | eac0157d7924e5f4809be78d9b9f7fef5dcadbd2 |
1 ;;; ediff.el --- a comprehensive visual interface to diff & patch
3 ;; Copyright (C) 1994, 1995 Free Software Foundation, Inc.
5 ;; Author: Michael Kifer <kifer@cs.sunysb.edu>
6 ;; Created: February 2, 1994
7 ;; Keywords: comparing, merging, patching, version control.
12 ;; This file is part of GNU Emacs.
14 ;; GNU Emacs is free software; you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation; either version 2, or (at your option)
17 ;; any later version.
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs; see the file COPYING. If not, write to the
26 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
27 ;; Boston, MA 02111-1307, USA.
29 ;;; Commentary:
31 ;; Never read that diff output again!
32 ;; Apply patch selectively, like a pro!
33 ;; Merge with ease!
35 ;; This package provides a convenient way of simultaneous browsing through
36 ;; the differences between a pair (or a triple) of files or buffers. The
37 ;; files being compared, file-A, file-B, and file-C (if applicable) are
38 ;; shown in separate windows (side by side, one above the another, or in
39 ;; separate frames), and the differences are highlighted as you step
40 ;; through them. You can also copy difference regions from one buffer to
41 ;; another (and recover old differences if you change your mind).
43 ;; Ediff also supports merging operations on files and buffers, including
44 ;; merging using ancestor versions. Both comparison and merging operations can
45 ;; be performed on directories, i.e., by pairwise comparison of files in those
46 ;; directories.
48 ;; In addition, Ediff can apply a patch to a file and then let you step
49 ;; though both files, the patched and the original one, simultaneously,
50 ;; difference-by-difference. You can even apply a patch right out of a
51 ;; mail buffer, i.e., patches received by mail don't even have to be saved.
52 ;; Since Ediff lets you copy differences between buffers, you can, in
53 ;; effect, apply patches selectively (i.e., you can copy a difference
54 ;; region from file_orig to file, thereby undoing any particular patch that
55 ;; you don't like).
57 ;; Ediff is aware of version control, which lets the user compare
58 ;; files with their older versions. Ediff can also work with remote and
59 ;; compressed files. Details are given below.
61 ;; Finally, Ediff supports directory-level comparison and merging operations.
62 ;; See the on-line manual for details.
64 ;; This package builds upon the ideas borrowed from emerge.el and several
65 ;; Ediff's functions are adaptations from emerge.el. Much of the functionality
66 ;; Ediff provides is also influenced by emerge.el.
68 ;; The present version of Ediff supersedes Emerge. It provides a superior user
69 ;; interface and has numerous major features not found in Emerge. In
70 ;; particular, it can do patching, and 2-way and 3-way file comparison,
71 ;; merging, and directory operations.
73 ;;; Bugs:
75 ;; 1. The undo command doesn't restore deleted regions well. That is, if
76 ;; you delete all characters in a difference region and then invoke
77 ;; `undo', the reinstated text will most likely be inserted outside of
78 ;; what Ediff thinks is the current difference region. (This problem
79 ;; doesn't seem to exist with XEmacs.)
80 ;;
81 ;; If at any point you feel that difference regions are no longer correct,
82 ;; you can hit '!' to recompute the differences.
84 ;; 2. On a monochrome display, the repertoire of faces with which to
85 ;; highlight fine differences is limited. By default, Ediff is using
86 ;; underlining. However, if the region is already underlined by some other
87 ;; overlays, there is no simple way to temporarily remove that residual
88 ;; underlining. This problem occurs when a buffer is highlighted with
89 ;; hilit19.el or font-lock.el packages. If this residual highlighting gets
90 ;; in the way, you can do the following. Both font-lock.el and hilit19.el
91 ;; provide commands for unhighlighting buffers. You can either place these
92 ;; commands in `ediff-prepare-buffer-hook' (which will unhighlight every
93 ;; buffer used by Ediff) or you can execute them interactively, at any time
94 ;; and on any buffer.
96 ;;; Acknowledgements:
98 ;; Ediff was inspired by Dale R. Worley's <drw@math.mit.edu> emerge.el.
99 ;; Ediff would not have been possible without the help and encouragement of
100 ;; its many users. See Ediff on-line Info for the full list of those who
101 ;; helped. Improved defaults in Ediff file-name reading commands.
103 ;;; Code:
122 ;;; Patching
129 ;;;###autoload
131 "Run Ediff by patching FILE-TP-PATCH."
132 ;; This now returns the control buffer
135 "File to patch"
137 ediff-last-dir-patch
138 default-directory)
145 default-directory)
149 ;; if the user specified a -b option, extract the backup
150 ;; extension from there; else use ediff-backup-extension
157 ;; ediff-find-file may use a temp file to do the patch
158 ;; so, we save source-filename and true-source-filename as a var
159 ;; that initially is source-filename but may be changed to a temp
160 ;; file for the purpose of patching.
163 target-buf buf-to-patch file-name-magic-p ctl-buf)
165 ;; if the user didn't specify a backup extension, use
166 ;; ediff-backup-extension
170 ;; Make a temp file, if source-filename has a magic file handler (or if
171 ;; it is handled via auto-mode-alist and similar magic).
172 ;; Check if there is a buffer visiting source-filename and if they are in
173 ;; sync; arrange for the deletion of temp file.
177 ;; Check if source file name has triggered black magic, such as file name
178 ;; handlers or auto mode alist, and make a note of it.
179 ;; true-source-filename should be either the original name or a
180 ;; temporary file where we put the after-product of the file handler.
184 ;; Checkout orig file, if necessary, so that the patched file could be
185 ;; checked back in.
191 ;;(sit-for 0)
192 ;; always pass patch the -f option, so it won't ask any questions
196 ediff-patch-program ediff-patch-options
197 backup-extension
199 t))
200 ;;(message "Applying patch ... done")(sit-for 0)
207 ;; If black magic is involved, apply patch to a temp copy of the
208 ;; file. Otherwise, apply patch to the orig copy. If patch is applied
209 ;; to temp copy, we name the result old-name_patched for local files
210 ;; and temp-copy_patched for remote files. The orig file name isn't
211 ;; changed, and the temp copy of the original is later deleted.
212 ;; Without magic, the original file is renamed (usually into
213 ;; old-name_orig) and the result of patching will have the same name as
214 ;; the original.
220 ;; Black magic in effect.
221 ;; If orig file was remote, put the patched file in the temp directory.
222 ;; If orig file is local, put the patched file in the directory of
223 ;; the orig file.
227 true-source-filename
228 source-filename)
233 ;; arrange that the temp copy of orig will be deleted
235 true-source-filename t))
237 ;; make orig buffer read-only
241 ;; set up a buf for the patched file
246 buf-to-patch target-buf nil
252 ctl-buf))
255 "Used as a startup hook to set `_orig' patch file read-only."
259 ;; Return a plausible default for ediff's first file:
260 ;; In dired, return the file name under the point, unless it is a directory
261 ;; If the buffer has a file name, return that file name.
266 f)))
269 ))
271 ;;;###autoload
273 ;;;###autoload
276 ;;; Compare files/buffers
278 ;;;###autoload
280 "Run Ediff on a pair of files, FILE-A and FILE-B."
283 ediff-last-dir-A
284 default-directory))
285 dir-B f)
287 "File A to compare" dir-A
292 ediff-last-dir-B
299 dir-B))
300 file-name-history))
301 f))
302 )))
307 file-B)
308 nil ; file-C
309 startup-hooks
312 ;;;###autoload
314 "Run Ediff on three files, FILE-A, FILE-B, and FILE-C."
317 ediff-last-dir-A
318 default-directory))
319 dir-B dir-C f ff)
321 "File A to compare" dir-A
326 ediff-last-dir-B
334 dir-B))
335 file-name-history))
336 f)))
339 ediff-last-dir-C
346 dir-C))
347 file-name-history))
348 ff))
349 )))
354 file-B)
358 file-C)
359 startup-hooks
362 ;;;###autoload
367 "Visit FILE and arrange its buffer to Ediff's liking.
368 FILE is actually a variable symbol that must contain a true file name.
369 BUFFER-NAME is a variable symbol, which will get the buffer object into which
370 FILE is read. LAST-DIR is the directory variable symbol where FILE's
371 directory name should be returned. HOOKS is a variable symbol that will be
372 assigned the hook to be executed after `ediff-startup' is finished.
373 `ediff-find-file' arranges that the temp files it might create will be
374 deleted."
383 ;; some of the command, below, require full file name
386 ;; Record the directory of the file
390 ;; Setup the buffer
396 ;; ange-ftp-hook-function--arrange for temp file
403 ;; file processed via auto-mode-alist, a la uncompress.el
418 ;;(sit-for 0)
421 ;;(sit-for 0)
426 ;;(sit-for 0)
433 buf-B file-B
434 buf-C file-C
435 startup-hooks
439 ;;;###autoload
443 ;;;###autoload
445 "Run Ediff on a pair of buffers, BUFFER-A and BUFFER-B."
452 ;; realign buffers so that two visible bufs will be
453 ;; at the top
456 t))))
461 ;;;###autoload
464 "Run Ediff on three buffers, BUFFER-A, BUFFER-B, and BUFFER-C."
471 ;; realign buffers so that two visible
472 ;; bufs will be at the top
475 t))
478 ;; realign buffers so that three visible
479 ;; bufs will be at the top
482 t)
483 )))
496 file-A file-B file-C)
520 file-C
525 ))
526 startup-hooks)
528 )))
531 ;;; Directory and file group operations
533 ;; Get appropriate default name for directory:
534 ;; If ediff-use-last-dir, use ediff-last-dir-A.
535 ;; In dired mode, use the directory that is under the point (if any);
536 ;; otherwise, use default-directory
542 f
543 default-directory)))
547 ;;;###autoload
549 "Run Ediff on a pair of directories, DIR1 and DIR2, comparing files that have
550 the same name in both. The third argument, REGEXP, is a regular expression that
551 further filters the file names."
554 f)
558 ediff-last-dir-B
560 nil)
562 nil ediff-filtering-regexp-history)
563 )))
566 ))
568 ;;;###autoload
572 ;;;###autoload
574 "Run Ediff on a directory, DIR1, comparing its files with their revisions.
575 The second argument, REGEXP, is a regular expression that filters the file
576 names. Only the files that are under revision control are taken into account."
582 nil ediff-filtering-regexp-history)
583 )))
586 ))
588 ;;;###autoload
592 ;;;###autoload
594 "Run Ediff on three directories, DIR1, DIR2, and DIR3, comparing files that
595 have the same name in all three. The last argument, REGEXP, is a regular
596 expression that further filters the file names."
599 f)
603 ediff-last-dir-B
605 nil))
608 ediff-last-dir-C
610 nil)
612 nil ediff-filtering-regexp-history)
613 )))
616 ))
618 ;;;###autoload
621 ;;;###autoload
623 "Run Ediff on a pair of directories, DIR1 and DIR2, merging files that have
624 the same name in both. The third argument, REGEXP, is a regular expression that
625 further filters the file names."
628 f)
632 ediff-last-dir-B
634 nil)
636 nil ediff-filtering-regexp-history)
637 )))
640 ))
642 ;;;###autoload
645 ;;;###autoload
647 "Run Ediff on a pair of directories, DIR1 and DIR2, merging files that have
648 the same name in both. The third argument, REGEXP, is a regular expression that
649 further filters the file names."
652 f)
656 ediff-last-dir-B
658 nil))
661 ediff-last-dir-C
663 nil)
665 nil ediff-filtering-regexp-history)
666 )))
668 dir1 dir2 dir3 regexp
670 ))
672 ;;;###autoload
674 "Run Ediff on a directory, DIR1, merging its files with their revisions.
675 The second argument, REGEXP, is a regular expression that filters the file
676 names. Only the files that are under revision control are taken into account."
682 nil ediff-filtering-regexp-history)
683 )))
686 ))
688 ;;;###autoload
691 ;;;###autoload
693 "Run Ediff on a directory, DIR1, merging its files with their revisions and ancestors.
694 The second argument, REGEXP, is a regular expression that filters the file
695 names. Only the files that are under revision control are taken into account."
701 nil ediff-filtering-regexp-history)
702 )))
704 dir1 regexp 'ediff-merge-revisions-with-ancestor
705 'ediff-merge-directory-revisions-with-ancestor
706 ))
708 ;;;###autoload
710 'edir-merge-revisions-with-ancestor
713 ;;;###autoload
716 ;; Run ediff-action (ediff-files, ediff-merge, ediff-merge-with-ancestors)
717 ;; on a pair of directories (three directories, in case of ancestor).
718 ;; The third argument, REGEXP, is a regular expression that further filters the
719 ;; file names.
720 ;; JOBNAME is the symbol indicating the meta-job to be performed.
722 action jobname
724 ;; ediff-read-file-name is set to attach a previously entered file name if
725 ;; the currently entered file is a directory. This code takes care of that.
742 file-list meta-buf)
746 ;; this sets various vars in the meta buffer inside
747 ;; ediff-prepare-meta-buffer
749 ;; tell what to do if the user clicks on a session record
751 ;; set ediff-dir-difference-list
753 startup-hooks))
755 'ediff-dir-action
756 file-list
757 "*Ediff Session Group Panel"
758 'ediff-redraw-directory-group-buffer
759 jobname
760 startup-hooks))
762 ))
771 ;; this sets various vars in the meta buffer inside
772 ;; ediff-prepare-meta-buffer
774 ;; tell what to do if the user clicks on a session record
776 ))
777 startup-hooks))
779 'ediff-dir-action
780 file-list
781 "*Ediff Session Group Panel"
782 'ediff-redraw-directory-group-buffer
783 jobname
784 startup-hooks))
786 ))
789 ;;; Compare regions and windows
791 ;;;###autoload
793 "Compare WIND-A and WIND-B, which are selected by clicking, wordwise.
794 With prefix argument, DUMB-MODE, or on a non-windowing display, works as
795 follows:
796 If WIND-A is nil, use selected window.
797 If WIND-B is nil, use window next to WIND-A."
802 ;;;###autoload
804 "Compare WIND-A and WIND-B, which are selected by clicking, linewise.
805 With prefix argument, DUMB-MODE, or on a non-windowing display, works as
806 follows:
807 If WIND-A is nil, use selected window.
808 If WIND-B is nil, use window next to WIND-A."
813 ;; Compare WIND-A and WIND-B, which are selected by clicking.
814 ;; With prefix argument, DUMB-MODE, or on a non-windowing display,
815 ;; works as follows:
816 ;; If WIND-A is nil, use selected window.
817 ;; If WIND-B is nil, use window next to WIND-A.
827 beg-A end-A beg-B end-B)
839 buffer-A beg-A end-A buffer-B beg-B end-B
840 startup-hooks job-name word-mode)))
842 ;;;###autoload
844 "Run Ediff on a pair of regions in two different buffers.
845 Regions \(i.e., point and mark\) are assumed to be set in advance.
846 This function is effective only for relatively small regions, up to 200
847 lines. For large regions, use `ediff-regions-linewise'."
854 ;; realign buffers so that two visible bufs will be
855 ;; at the top
858 t))))
879 ;;;###autoload
881 "Run Ediff on a pair of regions in two different buffers.
882 Regions \(i.e., point and mark\) are assumed to be set in advance.
883 Each region is enlarged to contain full lines.
884 This function is effective for large regions, over 100-200
885 lines. For small regions, use `ediff-regions-wordwise'."
892 ;; realign buffers so that two visible bufs will be
893 ;; at the top
896 t))))
907 ;; enlarge the region to hold full lines
919 ;; enlarge the region to hold full lines
935 ;; compare region beg-A to end-A of buffer-A
936 ;; to regions beg-B -- end-B in buffer-B.
938 startup-hooks job-name word-mode)
940 overl-A overl-B
941 file-A file-B)
943 ;; in case beg/end-A/B aren't markers--make them into markers
957 You have requested to compare overlapping regions of the same buffer.
959 In this case, Ediff's highlighting may be confusing---in the same window,
960 you may see highlighted regions that belong to different regions.
965 ()
968 ;; make file-A
974 ;; make file-B
983 buffer-B file-B
984 nil nil ; buffer & file C
988 startup-hooks)
992 )
993 ))
996 ;;; Merge files and buffers
998 ;;;###autoload
1006 ;;;###autoload
1008 "Merge two files without ancestor."
1011 ediff-last-dir-A
1012 default-directory))
1013 dir-B f)
1015 "File A to merge" dir-A
1020 ediff-last-dir-B
1027 dir-B))
1028 file-name-history))
1029 f))
1030 )))
1036 file-B)
1037 nil ; file-C
1038 startup-hooks
1041 ;;;###autoload
1044 "Merge two files with ancestor."
1047 ediff-last-dir-A
1048 default-directory))
1049 dir-B dir-ancestor f ff)
1051 "File A to merge" dir-A
1056 ediff-last-dir-B
1064 dir-B))
1065 file-name-history))
1066 f)))
1070 ediff-last-dir-ancestor
1077 dir-ancestor))
1078 file-name-history))
1079 ff))
1080 )))
1086 file-B)
1087 file-ancestor
1088 startup-hooks
1091 ;;;###autoload
1094 ;;;###autoload
1096 "Merge buffers without ancestor."
1103 ;; realign buffers so that two visible bufs will be
1104 ;; at the top
1107 t))))
1112 buffer-A buffer-B nil startup-hooks job-name))
1114 ;;;###autoload
1116 buffer-B buffer-ancestor
1118 "Merge buffers with ancestor."
1125 ;; realign buffers so that two visible
1126 ;; bufs will be at the top
1129 t))
1132 ;; realign buffers so that three visible
1133 ;; bufs will be at the top
1136 t)
1137 )))
1142 buffer-A buffer-B buffer-ancestor startup-hooks job-name))
1145 ;;;###autoload
1147 "Run Ediff by merging two revisions of a file.
1148 The file is the optional FILE argument or the file visited by the current
1149 buffer."
1157 "Version 1 to merge (default: %s's latest version): "
1160 rev2
1163 "Version 2 to merge (default: %s): "
1180 startup-hooks)))
1200 ;;;###autoload
1202 "Run Ediff by merging two revisions of a file with a common ancestor.
1203 The file is the the optional FILE argument or the file visited by the current
1204 buffer."
1212 "Version 1 to merge (default: %s's latest version): "
1215 rev2
1218 "Version 2 to merge (default: %s): "
1221 ancestor-rev
1224 "Ancestor version (default: %s): "
1247 startup-hooks)))
1272 buf1 buf2 ancestor-buf
1276 ;;; Apply patch
1278 ;;;###autoload
1280 "Run Ediff by patching BUFFER-NAME."
1286 default-dir file-name ctl-buf)
1298 ))
1304 ()
1320 ))
1324 "Obtain patch buffer. If patch is already in a buffer---use it.
1325 Else, read patch file into a new buffer."
1340 \f
1341 ;;; Versions Control functions
1343 ;;;###autoload
1345 "Run Ediff by comparing versions of a file.
1346 The file is an optional FILE argument or the file visited by the current
1347 buffer. Use `vc.el' or `rcs.el' depending on `ediff-version-control-package'."
1348 ;; if buffer is non-nil, use that buffer instead of the current buffer
1357 rev2
1365 rev1 rev2 startup-hooks)
1366 ))
1369 ;; Test if version control package is loaded and load if not
1370 ;; Is SILENT is non-nil, don't report error if package is not found.
1379 ediff-version-control-package)))))
1383 "Run Ediff on versions of the current buffer.
1385 If the current buffer is named `F', the version is named `F.~REV~'.
1386 If `F.~REV~' already exists, it is used instead of being re-created."
1401 ))
1402 startup-hooks))
1404 rev1buf rev2buf
1405 startup-hooks
1409 "View previous RCS revision of current file.
1410 With prefix argument, prompts for a revision name."
1425 ;; -q: quiet (no diagnostics)
1429 buff)))
1432 ;; Get a buffer for RCS output for FILE, make it writable and clean it up.
1433 ;; Optional NAME is name to use instead of `*RCS-output*'.
1434 ;; This is a modified version from rcs.el v1.1. I use it here to make
1435 ;; Ediff immune to changes in rcs.el
1443 buf))
1446 "Run Ediff on versions of the current buffer.
1453 ;; rcs.el doesn't create temp version files, so we don't have to delete
1454 ;; anything in startup hooks to ediff-buffers
1456 ))
1462 )
1465 "Run Ediff on versions of the current buffer.
1467 If the current buffer is named `F', the version is named `F.~REV~'.
1468 If `F.~REV~' already exists, it is used instead of being re-created."
1481 ;;;###autoload
1483 "Return string describing the version of Ediff.
1484 When called interactively, displays the version."
1494 ;;; ediff.el ends here