| blob | d629a3e249831472b8def11b91879f2604a52472 |
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.
75 ;;; Bugs:
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 underlined 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.
99 ;;; Acknowledgements:
101 ;; Ediff was inspired by Dale R. Worley's <drw@math.mit.edu> emerge.el.
102 ;; Ediff would not have been possible without the help and encouragement of
103 ;; its many users. See Ediff on-line Info for the full list of those who
104 ;; helped. Improved defaults in Ediff file-name reading commands.
106 ;;; Code:
125 ;;; Patching
132 ;;;###autoload
134 "Run Ediff by patching SOURCE-FILENAME."
135 ;; This now returns the control buffer
138 "File to patch"
140 ediff-last-dir-patch
141 default-directory)
148 default-directory)
152 ;; if the user specified a -b option, extract the backup
153 ;; extension from there; else use ediff-backup-extension
160 ;; ediff-find-file may use a temp file to do the patch
161 ;; so, we save source-filename and true-source-filename as a var
162 ;; that initially is source-filename but may be changed to a temp
163 ;; file for the purpose of patching.
166 target-buf buf-to-patch file-name-magic-p ctl-buf backup-style)
168 ;; if the user didn't specify a backup extension, use
169 ;; ediff-backup-extension
176 ;; Make a temp file, if source-filename has a magic file handler (or if
177 ;; it is handled via auto-mode-alist and similar magic).
178 ;; Check if there is a buffer visiting source-filename and if they are in
179 ;; sync; arrange for the deletion of temp file.
183 ;; Check if source file name has triggered black magic, such as file name
184 ;; handlers or auto mode alist, and make a note of it.
185 ;; true-source-filename should be either the original name or a
186 ;; temporary file where we put the after-product of the file handler.
190 ;; Checkout orig file, if necessary, so that the patched file could be
191 ;; checked back in.
197 ;; fix environment for gnu patch, so it won't make numbered extensions
200 ;; always pass patch the -f option, so it won't ask any questions
204 ediff-patch-program ediff-patch-options
205 backup-extension
207 t)
208 ;; restore environment for gnu patch
210 ;;(message "Applying patch ... done")(sit-for 0)
217 ;; If black magic is involved, apply patch to a temp copy of the
218 ;; file. Otherwise, apply patch to the orig copy. If patch is applied
219 ;; to temp copy, we name the result old-name_patched for local files
220 ;; and temp-copy_patched for remote files. The orig file name isn't
221 ;; changed, and the temp copy of the original is later deleted.
222 ;; Without magic, the original file is renamed (usually into
223 ;; old-name_orig) and the result of patching will have the same name as
224 ;; the original.
230 ;; Black magic in effect.
231 ;; If orig file was remote, put the patched file in the temp directory.
232 ;; If orig file is local, put the patched file in the directory of
233 ;; the orig file.
237 true-source-filename
238 source-filename)
243 ;; arrange that the temp copy of orig will be deleted
245 true-source-filename t))
247 ;; make orig buffer read-only
251 ;; set up a buf for the patched file
256 buf-to-patch target-buf nil
262 ctl-buf))
264 ;; Used as a startup hook to set `_orig' patch file read-only.
269 ;; Return a plausible default for ediff's first file:
270 ;; In dired, return the file name under the point, unless it is a directory
271 ;; If the buffer has a file name, return that file name.
276 f)))
279 ))
281 ;;;###autoload
283 ;;;###autoload
286 ;;; Compare files/buffers
288 ;;;###autoload
290 "Run Ediff on a pair of files, FILE-A and FILE-B."
293 ediff-last-dir-A
294 default-directory))
295 dir-B f)
297 "File A to compare" dir-A
302 ediff-last-dir-B
309 dir-B))
310 file-name-history))
311 f))
312 )))
317 file-B)
318 nil ; file-C
319 startup-hooks
322 ;;;###autoload
324 "Run Ediff on three files, FILE-A, FILE-B, and FILE-C."
327 ediff-last-dir-A
328 default-directory))
329 dir-B dir-C f ff)
331 "File A to compare" dir-A
336 ediff-last-dir-B
344 dir-B))
345 file-name-history))
346 f)))
349 ediff-last-dir-C
356 dir-C))
357 file-name-history))
358 ff))
359 )))
364 file-B)
368 file-C)
369 startup-hooks
372 ;;;###autoload
376 ;; Visit FILE and arrange its buffer to Ediff's liking.
377 ;; FILE is actually a variable symbol that must contain a true file name.
378 ;; BUFFER-NAME is a variable symbol, which will get the buffer object into
379 ;; which FILE is read.
380 ;; LAST-DIR is the directory variable symbol where FILE's
381 ;; directory name should be returned. HOOKS-VAR is a variable symbol that will
382 ;; be assigned the hook to be executed after `ediff-startup' is finished.
383 ;; `ediff-find-file' arranges that the temp files it might create will be
384 ;; deleted.
394 ;; some of the commands, below, require full file name
397 ;; Record the directory of the file
401 ;; Setup the buffer
407 ;; ange-ftp-hook-function--arrange for temp file
414 ;; file processed via auto-mode-alist, a la uncompress.el
429 ;;(sit-for 0)
432 ;;(sit-for 0)
437 ;;(sit-for 0)
444 buf-B file-B
445 buf-C file-C
446 startup-hooks
450 ;;;###autoload
454 ;;;###autoload
456 "Run Ediff on a pair of buffers, BUFFER-A and BUFFER-B."
463 ;; realign buffers so that two visible bufs will be
464 ;; at the top
467 t))))
472 ;;;###autoload
475 "Run Ediff on three buffers, BUFFER-A, BUFFER-B, and BUFFER-C."
482 ;; realign buffers so that two visible
483 ;; bufs will be at the top
486 t))
489 ;; realign buffers so that three visible
490 ;; bufs will be at the top
493 t)
494 )))
507 file-A file-B file-C)
531 file-C
536 ))
537 startup-hooks)
539 )))
542 ;;; Directory and file group operations
544 ;; Get appropriate default name for directory:
545 ;; If ediff-use-last-dir, use ediff-last-dir-A.
546 ;; In dired mode, use the directory that is under the point (if any);
547 ;; otherwise, use default-directory
553 f
554 default-directory)))
558 ;;;###autoload
560 "Run Ediff on a pair of directories, DIR1 and DIR2, comparing files that have
561 the same name in both. The third argument, REGEXP, is a regular expression that
562 further filters the file names."
565 f)
569 ediff-last-dir-B
571 nil)
573 nil ediff-filtering-regexp-history)
574 )))
577 ))
579 ;;;###autoload
583 ;;;###autoload
585 "Run Ediff on a directory, DIR1, comparing its files with their revisions.
586 The second argument, REGEXP, is a regular expression that filters the file
587 names. Only the files that are under revision control are taken into account."
593 nil ediff-filtering-regexp-history)
594 )))
597 ))
599 ;;;###autoload
603 ;;;###autoload
605 "Run Ediff on three directories, DIR1, DIR2, and DIR3, comparing files that
606 have the same name in all three. The last argument, REGEXP, is a regular
607 expression that further filters the file names."
610 f)
614 ediff-last-dir-B
616 nil))
619 ediff-last-dir-C
621 nil)
623 nil ediff-filtering-regexp-history)
624 )))
627 ))
629 ;;;###autoload
632 ;;;###autoload
634 "Run Ediff on a pair of directories, DIR1 and DIR2, merging files that have
635 the same name in both. The third argument, REGEXP, is a regular expression that
636 further filters the file names."
639 f)
643 ediff-last-dir-B
645 nil)
647 nil ediff-filtering-regexp-history)
648 )))
651 ))
653 ;;;###autoload
656 ;;;###autoload
658 "Run Ediff on a pair of directories, DIR1 and DIR2, merging files that have
659 the same name in both. The third argument, REGEXP, is a regular expression that
660 further filters the file names."
663 f)
667 ediff-last-dir-B
669 nil))
672 ediff-last-dir-C
674 nil)
676 nil ediff-filtering-regexp-history)
677 )))
679 dir1 dir2 dir3 regexp
681 ))
683 ;;;###autoload
685 "Run Ediff on a directory, DIR1, merging its files with their revisions.
686 The second argument, REGEXP, is a regular expression that filters the file
687 names. Only the files that are under revision control are taken into account."
693 nil ediff-filtering-regexp-history)
694 )))
697 ))
699 ;;;###autoload
702 ;;;###autoload
704 "Run Ediff on a directory, DIR1, merging its files with their revisions and ancestors.
705 The second argument, REGEXP, is a regular expression that filters the file
706 names. Only the files that are under revision control are taken into account."
712 nil ediff-filtering-regexp-history)
713 )))
715 dir1 regexp 'ediff-merge-revisions-with-ancestor
716 'ediff-merge-directory-revisions-with-ancestor
717 ))
719 ;;;###autoload
721 'edir-merge-revisions-with-ancestor
724 ;;;###autoload
727 ;; Run ediff-action (ediff-files, ediff-merge, ediff-merge-with-ancestors)
728 ;; on a pair of directories (three directories, in case of ancestor).
729 ;; The third argument, REGEXP, is a regular expression that further filters the
730 ;; file names.
731 ;; JOBNAME is the symbol indicating the meta-job to be performed.
733 action jobname
735 ;; ediff-read-file-name is set to attach a previously entered file name if
736 ;; the currently entered file is a directory. This code takes care of that.
753 file-list meta-buf)
757 ;; this sets various vars in the meta buffer inside
758 ;; ediff-prepare-meta-buffer
760 ;; tell what to do if the user clicks on a session record
762 ;; set ediff-dir-difference-list
764 startup-hooks))
766 'ediff-dir-action
767 file-list
768 "*Ediff Session Group Panel"
769 'ediff-redraw-directory-group-buffer
770 jobname
771 startup-hooks))
773 ))
782 ;; this sets various vars in the meta buffer inside
783 ;; ediff-prepare-meta-buffer
785 ;; tell what to do if the user clicks on a session record
787 ))
788 startup-hooks))
790 'ediff-dir-action
791 file-list
792 "*Ediff Session Group Panel"
793 'ediff-redraw-directory-group-buffer
794 jobname
795 startup-hooks))
797 ))
800 ;;; Compare regions and windows
802 ;;;###autoload
804 "Compare WIND-A and WIND-B, which are selected by clicking, wordwise.
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 ;;;###autoload
815 "Compare WIND-A and WIND-B, which are selected by clicking, linewise.
816 With prefix argument, DUMB-MODE, or on a non-windowing display, works as
817 follows:
818 If WIND-A is nil, use selected window.
819 If WIND-B is nil, use window next to WIND-A."
824 ;; Compare WIND-A and WIND-B, which are selected by clicking.
825 ;; With prefix argument, DUMB-MODE, or on a non-windowing display,
826 ;; works as follows:
827 ;; If WIND-A is nil, use selected window.
828 ;; If WIND-B is nil, use window next to WIND-A.
838 beg-A end-A beg-B end-B)
850 buffer-A beg-A end-A buffer-B beg-B end-B
851 startup-hooks job-name word-mode)))
853 ;;;###autoload
855 "Run Ediff on a pair of regions in two different buffers.
856 Regions \(i.e., point and mark\) are assumed to be set in advance.
857 This function is effective only for relatively small regions, up to 200
858 lines. For large regions, use `ediff-regions-linewise'."
865 ;; realign buffers so that two visible bufs will be
866 ;; at the top
869 t))))
890 ;;;###autoload
892 "Run Ediff on a pair of regions in two different buffers.
893 Regions \(i.e., point and mark\) are assumed to be set in advance.
894 Each region is enlarged to contain full lines.
895 This function is effective for large regions, over 100-200
896 lines. For small regions, use `ediff-regions-wordwise'."
903 ;; realign buffers so that two visible bufs will be
904 ;; at the top
907 t))))
918 ;; enlarge the region to hold full lines
930 ;; enlarge the region to hold full lines
946 ;; compare region beg-A to end-A of buffer-A
947 ;; to regions beg-B -- end-B in buffer-B.
949 startup-hooks job-name word-mode)
951 overl-A overl-B
952 file-A file-B)
954 ;; in case beg/end-A/B aren't markers--make them into markers
968 You have requested to compare overlapping regions of the same buffer.
970 In this case, Ediff's highlighting may be confusing---in the same window,
971 you may see highlighted regions that belong to different regions.
976 ()
979 ;; make file-A
985 ;; make file-B
994 buffer-B file-B
995 nil nil ; buffer & file C
999 startup-hooks)
1003 )
1004 ))
1007 ;;; Merge files and buffers
1009 ;;;###autoload
1017 ;;;###autoload
1019 "Merge two files without ancestor."
1022 ediff-last-dir-A
1023 default-directory))
1024 dir-B f)
1026 "File A to merge" dir-A
1031 ediff-last-dir-B
1038 dir-B))
1039 file-name-history))
1040 f))
1041 )))
1047 file-B)
1048 nil ; file-C
1049 startup-hooks
1052 ;;;###autoload
1055 "Merge two files with ancestor."
1058 ediff-last-dir-A
1059 default-directory))
1060 dir-B dir-ancestor f ff)
1062 "File A to merge" dir-A
1067 ediff-last-dir-B
1075 dir-B))
1076 file-name-history))
1077 f)))
1081 ediff-last-dir-ancestor
1088 dir-ancestor))
1089 file-name-history))
1090 ff))
1091 )))
1097 file-B)
1098 file-ancestor
1099 startup-hooks
1102 ;;;###autoload
1105 ;;;###autoload
1107 "Merge buffers without ancestor."
1114 ;; realign buffers so that two visible bufs will be
1115 ;; at the top
1118 t))))
1123 buffer-A buffer-B nil startup-hooks job-name))
1125 ;;;###autoload
1127 buffer-B buffer-ancestor
1129 "Merge buffers with ancestor."
1136 ;; realign buffers so that two visible
1137 ;; bufs will be at the top
1140 t))
1143 ;; realign buffers so that three visible
1144 ;; bufs will be at the top
1147 t)
1148 )))
1153 buffer-A buffer-B buffer-ancestor startup-hooks job-name))
1156 ;;;###autoload
1158 "Run Ediff by merging two revisions of a file.
1159 The file is the optional FILE argument or the file visited by the current
1160 buffer."
1167 "Version 1 to merge (default: %s's latest version): "
1170 rev2
1173 "Version 2 to merge (default: %s): "
1177 ;; ancestor-revision=nil
1180 rev1 rev2 nil startup-hooks)))
1183 ;;;###autoload
1185 "Run Ediff by merging two revisions of a file with a common ancestor.
1186 The file is the the optional FILE argument or the file visited by the current
1187 buffer."
1194 "Version 1 to merge (default: %s's latest version): "
1197 rev2
1200 "Version 2 to merge (default: %s): "
1203 ancestor-rev
1206 "Ancestor version (default: %s): "
1212 rev1 rev2 ancestor-rev startup-hooks)))
1214 ;;;###autoload
1216 "Run Ediff-merge on appropriate revisions of the selected file.
1217 First run after `M-x cvs-update'. Then place the cursor on a lide describing a
1218 file and then run `run-ediff-from-cvs-buffer'."
1227 ;;; Apply patch
1229 ;;;###autoload
1231 "Run Ediff by patching BUFFER-NAME."
1237 default-dir file-name ctl-buf)
1249 ))
1255 ()
1271 ))
1275 "Obtain patch buffer. If patch is already in a buffer---use it.
1276 Else, read patch file into a new buffer."
1291 \f
1292 ;;; Versions Control functions
1294 ;;;###autoload
1296 "Run Ediff by comparing versions of a file.
1297 The file is an optional FILE argument or the file visited by the current
1298 buffer. Use `vc.el' or `rcs.el' depending on `ediff-version-control-package'."
1299 ;; if buffer is non-nil, use that buffer instead of the current buffer
1308 rev2
1316 rev1 rev2 startup-hooks)
1317 ))
1320 ;; Test if version control package is loaded and load if not
1321 ;; Is SILENT is non-nil, don't report error if package is not found.
1331 ediff-version-control-package)))))
1334 ;;;###autoload
1336 "Return string describing the version of Ediff.
1337 When called interactively, displays the version."
1344 ;;;###autoload
1346 "Jump to Ediff's Info file."
1360 The Info file for Ediff does not seem to be installed.
1362 This file is part of the distribution of %sEmacs.
1363 Please contact your system administrator. "
1373 ;;; Local Variables:
1374 ;;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
1375 ;;; eval: (put 'ediff-eval-in-buffer 'lisp-indent-hook 1)
1376 ;;; End:
1381 ;;; ediff.el ends here