| blob | efab0dec0d1af2c9f2c0589e10a3e5a6e11acbde |
1 ;;; ediff.el --- a comprehensive visual interface to diff & patch
3 ;; Copyright (C) 1994, 95, 96, 97, 98, 99, 2000 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
131 ))
132 ;; end pacifier
138 "A comprehensive visual interface to diff & patch"
144 "*If t, Ediff will use previous directory as default when reading file name."
148 ;; Last directory used by an Ediff command for file-A.
150 ;; Last directory used by an Ediff command for file-B.
152 ;; Last directory used by an Ediff command for file-C.
154 ;; Last directory used by an Ediff command for the ancestor file.
156 ;; Last directory used by an Ediff command as the output directory for merge.
160 ;; Used as a startup hook to set `_orig' patch file read-only.
165 ;; Return a plausible default for ediff's first file:
166 ;; In dired, return the file name under the point, unless it is a directory
167 ;; If the buffer has a file name, return that file name.
172 f)))
175 ))
177 ;;; Compare files/buffers
179 ;;;###autoload
181 "Run Ediff on a pair of files, FILE-A and FILE-B."
184 ediff-last-dir-A
185 default-directory))
186 dir-B f)
188 "File A to compare" dir-A
193 ediff-last-dir-B
200 dir-B))
201 file-name-history))
202 f))
203 )))
208 file-B)
209 nil ; file-C
210 startup-hooks
213 ;;;###autoload
215 "Run Ediff on three files, FILE-A, FILE-B, and FILE-C."
218 ediff-last-dir-A
219 default-directory))
220 dir-B dir-C f ff)
222 "File A to compare" dir-A
227 ediff-last-dir-B
235 dir-B))
236 file-name-history))
237 f)))
240 ediff-last-dir-C
247 dir-C))
248 file-name-history))
249 ff))
250 )))
255 file-B)
259 file-C)
260 startup-hooks
263 ;;;###autoload
267 ;; Visit FILE and arrange its buffer to Ediff's liking.
268 ;; FILE is actually a variable symbol that must contain a true file name.
269 ;; BUFFER-NAME is a variable symbol, which will get the buffer object into
270 ;; which FILE is read.
271 ;; LAST-DIR is the directory variable symbol where FILE's
272 ;; directory name should be returned. HOOKS-VAR is a variable symbol that will
273 ;; be assigned the hook to be executed after `ediff-startup' is finished.
274 ;; `ediff-find-file' arranges that the temp files it might create will be
275 ;; deleted.
285 ;; some of the commands, below, require full file name
288 ;; Record the directory of the file
292 ;; Setup the buffer
298 ;;; ange-ftp-hook-function--arrange for temp file
305 ;; file processed via auto-mode-alist, a la uncompress.el
317 ;; MERGE-BUFFER-FILE is the file to be associated with the merge buffer
322 ;;(sit-for 0)
325 ;;(sit-for 0)
330 ;;(sit-for 0)
337 buf-B file-B
338 buf-C file-C
339 startup-hooks
341 merge-buffer-file)))
344 ;;;###autoload
348 ;;;###autoload
350 "Run Ediff on a pair of buffers, BUFFER-A and BUFFER-B."
357 ;; realign buffers so that two visible bufs will be
358 ;; at the top
361 t))))
365 ;;;###autoload
369 ;;;###autoload
372 "Run Ediff on three buffers, BUFFER-A, BUFFER-B, and BUFFER-C."
379 ;; realign buffers so that two visible
380 ;; bufs will be at the top
383 t))
386 ;; realign buffers so that three visible
387 ;; bufs will be at the top
390 t)
391 )))
395 ;;;###autoload
400 ;; MERGE-BUFFER-FILE is the file to be associated with the merge buffer
408 file-A file-B file-C)
432 file-C
437 startup-hooks)
439 merge-buffer-file)))
442 ;;; Directory and file group operations
444 ;; Get appropriate default name for directory:
445 ;; If ediff-use-last-dir, use ediff-last-dir-A.
446 ;; In dired mode, use the directory that is under the point (if any);
447 ;; otherwise, use default-directory
453 f
454 default-directory)))
458 ;;;###autoload
460 "Run Ediff on a pair of directories, DIR1 and DIR2, comparing files that have
461 the same name in both. The third argument, REGEXP, is a regular expression
462 that can be used to filter out certain file names."
465 f)
469 ediff-last-dir-B
471 nil)
474 )))
477 ))
479 ;;;###autoload
483 ;;;###autoload
485 "Run Ediff on a directory, DIR1, comparing its files with their revisions.
486 The second argument, REGEXP, is a regular expression that filters the file
487 names. Only the files that are under revision control are taken into account."
494 )))
497 ))
499 ;;;###autoload
503 ;;;###autoload
505 "Run Ediff on three directories, DIR1, DIR2, and DIR3, comparing files that
506 have the same name in all three. The last argument, REGEXP, is a regular
507 expression that can be used to filter out certain file names."
510 f)
514 ediff-last-dir-B
516 nil))
519 ediff-last-dir-C
521 nil)
524 )))
527 ))
529 ;;;###autoload
532 ;;;###autoload
534 "Run Ediff on a pair of directories, DIR1 and DIR2, merging files that have
535 the same name in both. The third argument, REGEXP, is a regular expression
536 that can be used to filter out certain file names."
539 f)
543 ediff-last-dir-B
545 nil)
548 )))
551 nil merge-autostore-dir
552 ))
554 ;;;###autoload
557 ;;;###autoload
559 &optional
560 merge-autostore-dir)
561 "Merge files in directories DIR1 and DIR2 using files in ANCESTOR-DIR as ancestors.
562 Ediff merges files that have identical names in DIR1, DIR2. If a pair of files
563 in DIR1 and DIR2 doesn't have an ancestor in ANCESTOR-DIR, Ediff will merge
564 without ancestor. The fourth argument, REGEXP, is a regular expression that
565 can be used to filter out certain file names."
568 f)
572 ediff-last-dir-B
574 nil))
577 ediff-last-dir-C
579 nil)
582 )))
584 dir1 dir2 ancestor-dir regexp
586 nil merge-autostore-dir
587 ))
589 ;;;###autoload
592 "Run Ediff on a directory, DIR1, merging its files with their revisions.
593 The second argument, REGEXP, is a regular expression that filters the file
594 names. Only the files that are under revision control are taken into account."
601 )))
604 nil merge-autostore-dir
605 ))
607 ;;;###autoload
610 ;;;###autoload
612 &optional
613 merge-autostore-dir)
614 "Run Ediff on a directory, DIR1, merging its files with their revisions and ancestors.
615 The second argument, REGEXP, is a regular expression that filters the file
616 names. Only the files that are under revision control are taken into account."
623 )))
625 dir1 regexp 'ediff-merge-revisions-with-ancestor
626 'ediff-merge-directory-revisions-with-ancestor
627 nil merge-autostore-dir
628 ))
630 ;;;###autoload
632 'edir-merge-revisions-with-ancestor
635 ;;;###autoload
638 ;; Run ediff-action (ediff-files, ediff-merge, ediff-merge-with-ancestors)
639 ;; on a pair of directories (three directories, in case of ancestor).
640 ;; The third argument, REGEXP, is a regular expression that can be used to
641 ;; filter out certain file names.
642 ;; JOBNAME is the symbol indicating the meta-job to be performed.
643 ;; MERGE-AUTOSTORE-DIR is the directory in which to store merged files.
645 &optional startup-hooks
646 merge-autostore-dir)
647 ;; ediff-read-file-name is set to attach a previously entered file name if
648 ;; the currently entered file is a directory. This code takes care of that.
667 jobname)))
669 file-list meta-buf)
676 ediff-last-merge-autostore-dir
678 nil
680 ;; verify we are not merging into an orig directory
696 jobname 'diffs
697 regexp dir1 dir2 dir3 merge-autostore-dir))
699 ;; this sets various vars in the meta buffer inside
700 ;; ediff-prepare-meta-buffer
702 ;; tell what to do if the user clicks on a session record
704 ;; set ediff-dir-difference-list
706 startup-hooks))
708 'ediff-filegroup-action
709 file-list
710 "*Ediff Session Group Panel"
711 'ediff-redraw-directory-group-buffer
712 jobname
713 startup-hooks))
715 ))
717 ;; MERGE-AUTOSTORE-DIR can be given to tell ediff where to store the merged
718 ;; files
720 &optional startup-hooks
721 merge-autostore-dir)
727 jobname)))
735 ediff-last-merge-autostore-dir
737 nil
739 ;; verify merge-autostore-dir != dir1
749 jobname regexp dir1 merge-autostore-dir))
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 startup-hooks))
758 'ediff-filegroup-action
759 file-list
760 "*Ediff Session Group Panel"
761 'ediff-redraw-directory-group-buffer
762 jobname
763 startup-hooks))
765 ))
768 ;;; Compare regions and windows
770 ;;;###autoload
772 "Compare WIND-A and WIND-B, which are selected by clicking, wordwise.
773 With prefix argument, DUMB-MODE, or on a non-windowing display, works as
774 follows:
775 If WIND-A is nil, use selected window.
776 If WIND-B is nil, use window next to WIND-A."
781 ;;;###autoload
783 "Compare WIND-A and WIND-B, which are selected by clicking, linewise.
784 With prefix argument, DUMB-MODE, or on a non-windowing display, works as
785 follows:
786 If WIND-A is nil, use selected window.
787 If WIND-B is nil, use window next to WIND-A."
792 ;; Compare WIND-A and WIND-B, which are selected by clicking.
793 ;; With prefix argument, DUMB-MODE, or on a non-windowing display,
794 ;; works as follows:
795 ;; If WIND-A is nil, use selected window.
796 ;; If WIND-B is nil, use window next to WIND-A.
806 beg-A end-A beg-B end-B)
818 buffer-A beg-A end-A buffer-B beg-B end-B
819 startup-hooks job-name word-mode nil)))
821 ;;;###autoload
823 "Run Ediff on a pair of regions in two different buffers.
824 Regions \(i.e., point and mark\) are assumed to be set in advance.
825 This function is effective only for relatively small regions, up to 200
826 lines. For large regions, use `ediff-regions-linewise'."
833 ;; realign buffers so that two visible bufs will be
834 ;; at the top
837 t))))
858 ;;;###autoload
860 "Run Ediff on a pair of regions in two different buffers.
861 Regions \(i.e., point and mark\) are assumed to be set in advance.
862 Each region is enlarged to contain full lines.
863 This function is effective for large regions, over 100-200
864 lines. For small regions, use `ediff-regions-wordwise'."
871 ;; realign buffers so that two visible bufs will be
872 ;; at the top
875 t))))
886 ;; enlarge the region to hold full lines
898 ;; enlarge the region to hold full lines
913 ;; compare region beg-A to end-A of buffer-A
914 ;; to regions beg-B -- end-B in buffer-B.
916 startup-hooks job-name word-mode
917 setup-parameters)
919 overl-A overl-B
920 file-A file-B)
922 ;; in case beg/end-A/B aren't markers--make them into markers
936 You have requested to compare overlapping regions of the same buffer.
938 In this case, Ediff's highlighting may be confusing---in the same window,
939 you may see highlighted regions that belong to different regions.
944 ()
947 ;; make file-A
953 ;; make file-B
962 buffer-B file-B
963 nil nil ; buffer & file C
967 startup-hooks)
972 setup-parameters))
973 ))
976 ;;; Merge files and buffers
978 ;;;###autoload
986 ;;;###autoload
988 ;; MERGE-BUFFER-FILE is the file to be
989 ;; associated with the merge buffer
991 "Merge two files without ancestor."
994 ediff-last-dir-A
995 default-directory))
996 dir-B f)
998 "File A to merge" dir-A
1003 ediff-last-dir-B
1010 dir-B))
1011 file-name-history))
1012 f))
1013 )))
1019 file-B)
1020 nil ; file-C
1021 startup-hooks
1022 'ediff-merge-files
1023 merge-buffer-file))
1025 ;;;###autoload
1027 &optional
1028 startup-hooks
1029 ;; MERGE-BUFFER-FILE is the file
1030 ;; to be associated with the
1031 ;; merge buffer
1032 merge-buffer-file)
1033 "Merge two files with ancestor."
1036 ediff-last-dir-A
1037 default-directory))
1038 dir-B dir-ancestor f ff)
1040 "File A to merge" dir-A
1045 ediff-last-dir-B
1053 dir-B))
1054 file-name-history))
1055 f)))
1059 ediff-last-dir-ancestor
1066 dir-ancestor))
1067 file-name-history))
1068 ff))
1069 )))
1075 file-B)
1076 file-ancestor
1077 startup-hooks
1078 'ediff-merge-files-with-ancestor
1079 merge-buffer-file))
1081 ;;;###autoload
1084 ;;;###autoload
1086 &optional
1087 ;; MERGE-BUFFER-FILE is the file to be
1088 ;; associated with the merge buffer
1089 startup-hooks job-name merge-buffer-file)
1090 "Merge buffers without ancestor."
1097 ;; realign buffers so that two visible bufs will be
1098 ;; at the top
1101 t))))
1106 buffer-A buffer-B nil startup-hooks job-name merge-buffer-file))
1108 ;;;###autoload
1110 &optional
1111 startup-hooks
1112 job-name
1113 ;; MERGE-BUFFER-FILE is the
1114 ;; file to be associated
1115 ;; with the merge buffer
1116 merge-buffer-file)
1117 "Merge buffers with ancestor."
1124 ;; realign buffers so that two visible
1125 ;; bufs will be at the top
1128 t))
1131 ;; realign buffers so that three visible
1132 ;; bufs will be at the top
1135 t)
1136 )))
1141 buffer-A buffer-B buffer-ancestor startup-hooks job-name merge-buffer-file))
1144 ;;;###autoload
1146 ;; MERGE-BUFFER-FILE is the file to be associated with the merge buffer
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."
1156 "Version 1 to merge (default: %s's latest version): "
1159 rev2
1162 "Version 2 to merge (default: %s): "
1166 ;; ancestor-revision=nil
1169 rev1 rev2 nil startup-hooks merge-buffer-file)))
1172 ;;;###autoload
1174 file startup-hooks
1175 ;; MERGE-BUFFER-FILE is the file to
1176 ;; be associated with the merge
1177 ;; buffer
1178 merge-buffer-file)
1179 "Run Ediff by merging two revisions of a file with a common ancestor.
1180 The file is the the optional FILE argument or the file visited by the current
1181 buffer."
1188 "Version 1 to merge (default: %s's latest version): "
1191 rev2
1194 "Version 2 to merge (default: %s): "
1197 ancestor-rev
1200 "Ancestor version (default: %s's base revision): "
1206 rev1 rev2 ancestor-rev startup-hooks merge-buffer-file)))
1208 ;;;###autoload
1210 "Run Ediff-merge on appropriate revisions of the selected file.
1211 First run after `M-x cvs-update'. Then place the cursor on a line describing a
1212 file and then run `run-ediff-from-cvs-buffer'."
1221 ;;; Apply patch
1223 ;;;###autoload
1225 "Run Ediff by patching SOURCE-FILENAME.
1226 If optional PATCH-BUF is given, use the patch in that buffer
1227 and don't ask the user.
1228 If prefix argument, then: if even argument, assume that the patch is in a
1229 buffer. If odd -- assume it is in a file."
1244 ;; the default is the directory, not the visited file name
1246 "File to patch (directory, if multifile patch): "
1250 ;;;###autoload
1252 "Run Ediff by patching BUFFER-NAME."
1259 patch-buf
1261 "Which buffer to patch? "
1265 ;;;###autoload
1267 ;;;###autoload
1272 \f
1273 ;;; Versions Control functions
1275 ;;;###autoload
1277 "Run Ediff by comparing versions of a file.
1278 The file is an optional FILE argument or the file visited by the current
1279 buffer. Use `vc.el' or `rcs.el' depending on `ediff-version-control-package'."
1280 ;; if buffer is non-nil, use that buffer instead of the current buffer
1289 rev2
1297 rev1 rev2 startup-hooks)
1298 ))
1301 ;;;###autoload
1305 ;; Test if version control package is loaded and load if not
1306 ;; Is SILENT is non-nil, don't report error if package is not found.
1316 ediff-version-control-package)))))
1319 ;;;###autoload
1321 "Return string describing the version of Ediff.
1322 When called interactively, displays the version."
1329 ;;;###autoload
1331 "Display Ediff's manual.
1332 With optional NODE, goes to that node."
1357 ;;; Local Variables:
1358 ;;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
1359 ;;; eval: (put 'ediff-with-current-buffer 'lisp-indent-hook 1)
1360 ;;; eval: (put 'ediff-with-current-buffer 'edebug-form-spec '(form body))
1361 ;;; End:
1367 ;;; ediff.el ends here