1 ;;; ediff.el --- a comprehensive visual interface to diff & patch
3 ;; Copyright (C) 1994, 1995, 1996, 1997 Free Software Foundation, Inc.
5 ;; Author: Michael Kifer <kifer@cs.sunysb.edu>
6 ;; Created: February 2, 1994
7 ;; Keywords: comparing, merging, patching, version control.
9 (defconst ediff-version
"2.65" "The current version of Ediff")
10 (defconst ediff-date
"May 1, 1997" "Date of last update")
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)
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.
32 ;; Never read that diff output again!
33 ;; Apply patch interactively!
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
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
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.
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.)
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
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.
114 (load-library "dired")
115 (load-library "info")
116 (load "pcl-cvs" 'noerror
)))
118 (let ((load-path (cons (expand-file-name ".") load-path
)))
119 (or (featurep 'ediff-init
)
120 (load "ediff-init.el" nil nil
'nosuffix
))
121 (or (featurep 'ediff-mult
)
122 (load "ediff-mult.el" nil nil
'nosuffix
))
123 (or (featurep 'ediff-ptch
)
124 (load "ediff-ptch.el" nil nil
'nosuffix
))
125 (or (featurep 'ediff-vers
)
126 (load "ediff-vers.el" nil nil
'nosuffix
))
130 (require 'ediff-init
)
131 (require 'ediff-mult
) ; required because of the registry stuff
134 "A comprehensive visual interface to diff & patch"
138 (defcustom ediff-use-last-dir nil
139 "*If t, Ediff uses previous directory as default when reading file name."
143 (defvar ediff-last-dir-A nil
144 "Last directory used by an Ediff command for file-A.")
145 (defvar ediff-last-dir-B nil
146 "Last directory used by an Ediff command for file-B.")
147 (defvar ediff-last-dir-C nil
148 "Last directory used by an Ediff command for file-C.")
149 (defvar ediff-last-dir-ancestor nil
150 "Last directory used by an Ediff command for the ancestor file.")
151 (defvar ediff-last-merge-autostore-dir
152 "Last directory used by an Ediff command as the output directory for merge.")
154 ;; Some defvars to reduce the number of compiler warnings
155 (defvar cvs-cookie-handle
)
156 (defvar ediff-last-dir-patch
)
157 (defvar ediff-patch-default-directory
)
158 ;; end of compiler pacifier
161 ;; Used as a startup hook to set `_orig' patch file read-only.
162 (defun ediff-set-read-only-in-buf-A ()
163 (ediff-eval-in-buffer ediff-buffer-A
164 (toggle-read-only 1)))
166 ;; Return a plausible default for ediff's first file:
167 ;; In dired, return the file name under the point, unless it is a directory
168 ;; If the buffer has a file name, return that file name.
169 (defun ediff-get-default-file-name ()
170 (cond ((eq major-mode
'dired-mode
)
171 (let ((f (dired-get-filename nil
'no-error
)))
172 (if (and (stringp f
) (not (file-directory-p f
)))
174 ((buffer-file-name (current-buffer))
175 (file-name-nondirectory (buffer-file-name (current-buffer))))
178 ;;; Compare files/buffers
181 (defun ediff-files (file-A file-B
&optional startup-hooks
)
182 "Run Ediff on a pair of files, FILE-A and FILE-B."
184 (let ((dir-A (if ediff-use-last-dir
188 (list (setq f
(ediff-read-file-name
189 "File A to compare" dir-A
190 (ediff-get-default-file-name)))
191 (ediff-read-file-name "File B to compare"
193 (if ediff-use-last-dir
195 (file-name-directory f
)))
197 (setq file-name-history
198 (cons (ediff-abbreviate-file-name
200 (file-name-nondirectory f
)
205 (ediff-files-internal file-A
206 (if (file-directory-p file-B
)
208 (file-name-nondirectory file-A
) file-B
)
215 (defun ediff-files3 (file-A file-B file-C
&optional startup-hooks
)
216 "Run Ediff on three files, FILE-A, FILE-B, and FILE-C."
218 (let ((dir-A (if ediff-use-last-dir
222 (list (setq f
(ediff-read-file-name
223 "File A to compare" dir-A
224 (ediff-get-default-file-name)))
225 (setq ff
(ediff-read-file-name "File B to compare"
227 (if ediff-use-last-dir
229 (file-name-directory f
)))
231 (setq file-name-history
233 (ediff-abbreviate-file-name
235 (file-name-nondirectory f
)
239 (ediff-read-file-name "File C to compare"
240 (setq dir-C
(if ediff-use-last-dir
242 (file-name-directory ff
)))
244 (setq file-name-history
245 (cons (ediff-abbreviate-file-name
247 (file-name-nondirectory ff
)
252 (ediff-files-internal file-A
253 (if (file-directory-p file-B
)
255 (file-name-nondirectory file-A
) file-B
)
257 (if (file-directory-p file-C
)
259 (file-name-nondirectory file-A
) file-C
)
265 (defalias 'ediff3
'ediff-files3
)
268 ;; Visit FILE and arrange its buffer to Ediff's liking.
269 ;; FILE is actually a variable symbol that must contain a true file name.
270 ;; BUFFER-NAME is a variable symbol, which will get the buffer object into
271 ;; which FILE is read.
272 ;; LAST-DIR is the directory variable symbol where FILE's
273 ;; directory name should be returned. HOOKS-VAR is a variable symbol that will
274 ;; be assigned the hook to be executed after `ediff-startup' is finished.
275 ;; `ediff-find-file' arranges that the temp files it might create will be
277 (defun ediff-find-file (file-var buffer-name
&optional last-dir hooks-var
)
278 (let* ((file (symbol-value file-var
))
279 (file-magic (find-file-name-handler file
'find-file-noselect
))
280 (temp-file-name-prefix (file-name-nondirectory file
)))
281 (cond ((not (file-readable-p file
))
282 (error "File `%s' does not exist or is not readable" file
))
283 ((file-directory-p file
)
284 (error "File `%s' is a directory" file
)))
286 ;; some of the commands, below, require full file name
287 (setq file
(expand-file-name file
))
289 ;; Record the directory of the file
291 (set last-dir
(expand-file-name (file-name-directory file
))))
294 (set buffer-name
(find-file-noselect file
))
296 (ediff-eval-in-buffer (symbol-value buffer-name
)
297 (widen) ; Make sure the entire file is seen
298 (cond (file-magic ; file has a handler, such as jka-compr-handler or
299 ;;; ange-ftp-hook-function--arrange for temp file
300 (ediff-verify-file-buffer 'magic
)
302 (ediff-make-temp-file
303 (current-buffer) temp-file-name-prefix
))
304 (set hooks-var
(cons (` (lambda () (delete-file (, file
))))
305 (symbol-value hooks-var
))))
306 ;; file processed via auto-mode-alist, a la uncompress.el
307 ((not (equal (file-truename file
)
308 (file-truename (buffer-file-name))))
310 (ediff-make-temp-file
311 (current-buffer) temp-file-name-prefix
))
312 (set hooks-var
(cons (` (lambda () (delete-file (, file
))))
313 (symbol-value hooks-var
))))
314 (t ;; plain file---just check that the file matches the buffer
315 (ediff-verify-file-buffer))))
316 (set file-var file
)))
318 (defun ediff-files-internal (file-A file-B file-C startup-hooks job-name
)
319 (let (buf-A buf-B buf-C
)
320 (message "Reading file %s ... " file-A
)
322 (ediff-find-file 'file-A
'buf-A
'ediff-last-dir-A
'startup-hooks
)
323 (message "Reading file %s ... " file-B
)
325 (ediff-find-file 'file-B
'buf-B
'ediff-last-dir-B
'startup-hooks
)
328 (message "Reading file %s ... " file-C
)
332 (if (eq job-name
'ediff-merge-files-with-ancestor
)
333 'ediff-last-dir-ancestor
'ediff-last-dir-C
)
335 (ediff-setup buf-A file-A
339 (list (cons 'ediff-job-name job-name
)))))
343 (defalias 'ediff
'ediff-files
)
347 (defun ediff-buffers (buffer-A buffer-B
&optional startup-hooks job-name
)
348 "Run Ediff on a pair of buffers, BUFFER-A and BUFFER-B."
351 (list (setq bf
(read-buffer "Buffer A to compare: "
352 (ediff-other-buffer "") t
))
353 (read-buffer "Buffer B to compare: "
355 ;; realign buffers so that two visible bufs will be
357 (save-window-excursion (other-window 1))
358 (ediff-other-buffer bf
))
360 (or job-name
(setq job-name
'ediff-buffers
))
361 (ediff-buffers-internal buffer-A buffer-B nil startup-hooks job-name
))
364 (defalias 'ebuffers
'ediff-buffers
)
368 (defun ediff-buffers3 (buffer-A buffer-B buffer-C
369 &optional startup-hooks job-name
)
370 "Run Ediff on three buffers, BUFFER-A, BUFFER-B, and BUFFER-C."
373 (list (setq bf
(read-buffer "Buffer A to compare: "
374 (ediff-other-buffer "") t
))
375 (setq bff
(read-buffer "Buffer B to compare: "
377 ;; realign buffers so that two visible
378 ;; bufs will be at the top
379 (save-window-excursion (other-window 1))
380 (ediff-other-buffer bf
))
382 (read-buffer "Buffer C to compare: "
384 ;; realign buffers so that three visible
385 ;; bufs will be at the top
386 (save-window-excursion (other-window 1))
387 (ediff-other-buffer (list bf bff
)))
390 (or job-name
(setq job-name
'ediff-buffers3
))
391 (ediff-buffers-internal buffer-A buffer-B buffer-C startup-hooks job-name
))
394 (defalias 'ebuffers3
'ediff-buffers3
)
398 (defun ediff-buffers-internal (buf-A buf-B buf-C startup-hooks job-name
)
399 (let* ((buf-A-file-name (buffer-file-name (get-buffer buf-A
)))
400 (buf-B-file-name (buffer-file-name (get-buffer buf-B
)))
401 (buf-C-is-alive (ediff-buffer-live-p buf-C
))
402 (buf-C-file-name (if buf-C-is-alive
403 (buffer-file-name (get-buffer buf-B
))))
404 file-A file-B file-C
)
405 (if (not (ediff-buffer-live-p buf-A
))
406 (error "Buffer %S doesn't exist" buf-A
))
407 (if (not (ediff-buffer-live-p buf-B
))
408 (error "Buffer %S doesn't exist" buf-B
))
409 (let ((ediff-job-name job-name
))
410 (if (and ediff-3way-comparison-job
411 (not buf-C-is-alive
))
412 (error "Buffer %S doesn't exist" buf-C
)))
413 (if (stringp buf-A-file-name
)
414 (setq buf-A-file-name
(file-name-nondirectory buf-A-file-name
)))
415 (if (stringp buf-B-file-name
)
416 (setq buf-B-file-name
(file-name-nondirectory buf-B-file-name
)))
417 (if (stringp buf-C-file-name
)
418 (setq buf-C-file-name
(file-name-nondirectory buf-C-file-name
)))
420 (setq file-A
(ediff-make-temp-file buf-A buf-A-file-name
)
421 file-B
(ediff-make-temp-file buf-B buf-B-file-name
))
423 (setq file-C
(ediff-make-temp-file buf-C buf-C-file-name
)))
425 (ediff-setup (get-buffer buf-A
) file-A
426 (get-buffer buf-B
) file-B
427 (if buf-C-is-alive
(get-buffer buf-C
))
430 (delete-file (, file-A
))
431 (delete-file (, file-B
))
432 (if (stringp (, file-C
)) (delete-file (, file-C
)))
435 (list (cons 'ediff-job-name job-name
))
439 ;;; Directory and file group operations
441 ;; Get appropriate default name for directory:
442 ;; If ediff-use-last-dir, use ediff-last-dir-A.
443 ;; In dired mode, use the directory that is under the point (if any);
444 ;; otherwise, use default-directory
445 (defun ediff-get-default-directory-name ()
446 (cond (ediff-use-last-dir ediff-last-dir-A
)
447 ((eq major-mode
'dired-mode
)
448 (let ((f (dired-get-filename nil
'noerror
)))
449 (if (and (stringp f
) (file-directory-p f
))
452 (t default-directory
)))
456 (defun ediff-directories (dir1 dir2 regexp
)
457 "Run Ediff on a pair of directories, DIR1 and DIR2, comparing files that have
458 the same name in both. The third argument, REGEXP, is a regular expression that
459 can be used to filter out certain file names."
461 (let ((dir-A (ediff-get-default-directory-name))
463 (list (setq f
(ediff-read-file-name "Directory A to compare:" dir-A nil
))
464 (ediff-read-file-name "Directory B to compare:"
465 (if ediff-use-last-dir
467 (ediff-strip-last-dir f
))
469 (read-string "Filter through regular expression: "
470 nil
'ediff-filtering-regexp-history
)
472 (ediff-directories-internal
473 dir1 dir2 nil regexp
'ediff-files
'ediff-directories
477 (defalias 'edirs
'ediff-directories
)
481 (defun ediff-directory-revisions (dir1 regexp
)
482 "Run Ediff on a directory, DIR1, comparing its files with their revisions.
483 The second argument, REGEXP, is a regular expression that filters the file
484 names. Only the files that are under revision control are taken into account."
486 (let ((dir-A (ediff-get-default-directory-name)))
487 (list (ediff-read-file-name
488 "Directory to compare with revision:" dir-A nil
)
489 (read-string "Filter through regular expression: "
490 nil
'ediff-filtering-regexp-history
)
492 (ediff-directory-revisions-internal
493 dir1 regexp
'ediff-revision
'ediff-directory-revisions
497 (defalias 'edir-revisions
'ediff-directory-revisions
)
501 (defun ediff-directories3 (dir1 dir2 dir3 regexp
)
502 "Run Ediff on three directories, DIR1, DIR2, and DIR3, comparing files that
503 have the same name in all three. The last argument, REGEXP, is a regular
504 expression that can be used to filter out certain file names."
506 (let ((dir-A (ediff-get-default-directory-name))
508 (list (setq f
(ediff-read-file-name "Directory A to compare:" dir-A nil
))
509 (setq f
(ediff-read-file-name "Directory B to compare:"
510 (if ediff-use-last-dir
512 (ediff-strip-last-dir f
))
514 (ediff-read-file-name "Directory C to compare:"
515 (if ediff-use-last-dir
517 (ediff-strip-last-dir f
))
519 (read-string "Filter through regular expression: "
520 nil
'ediff-filtering-regexp-history
)
522 (ediff-directories-internal
523 dir1 dir2 dir3 regexp
'ediff-files3
'ediff-directories3
527 (defalias 'edirs3
'ediff-directories3
)
530 (defun ediff-merge-directories (dir1 dir2 regexp
)
531 "Run Ediff on a pair of directories, DIR1 and DIR2, merging files that have
532 the same name in both. The third argument, REGEXP, is a regular expression that
533 can be used to filter out certain file names."
535 (let ((dir-A (ediff-get-default-directory-name))
537 (list (setq f
(ediff-read-file-name "Directory A to merge:" dir-A nil
))
538 (ediff-read-file-name "Directory B to merge:"
539 (if ediff-use-last-dir
541 (ediff-strip-last-dir f
))
543 (read-string "Filter through regular expression: "
544 nil
'ediff-filtering-regexp-history
)
546 (ediff-directories-internal
547 dir1 dir2 nil regexp
'ediff-merge-files
'ediff-merge-directories
551 (defalias 'edirs-merge
'ediff-merge-directories
)
554 (defun ediff-merge-directories-with-ancestor (dir1 dir2 ancestor-dir regexp
)
555 "Merge files in directories DIR1 and DIR2 using files in ANCESTOR-DIR as ancestors.
556 Ediff merges files that have identical names in DIR1, DIR2. If a pair of files
557 in DIR1 and DIR2 doesn't have an ancestor in ANCESTOR-DIR, Ediff will merge
558 without ancestor. The fourth argument, REGEXP, is a regular expression that
559 can be used to filter out certain file names."
561 (let ((dir-A (ediff-get-default-directory-name))
563 (list (setq f
(ediff-read-file-name "Directory A to merge:" dir-A nil
))
564 (setq f
(ediff-read-file-name "Directory B to merge:"
565 (if ediff-use-last-dir
567 (ediff-strip-last-dir f
))
569 (ediff-read-file-name "Ancestor directory:"
570 (if ediff-use-last-dir
572 (ediff-strip-last-dir f
))
574 (read-string "Filter through regular expression: "
575 nil
'ediff-filtering-regexp-history
)
577 (ediff-directories-internal
578 dir1 dir2 ancestor-dir regexp
579 'ediff-merge-files-with-ancestor
'ediff-merge-directories-with-ancestor
583 (defun ediff-merge-directory-revisions (dir1 regexp
)
584 "Run Ediff on a directory, DIR1, merging its files with their revisions.
585 The second argument, REGEXP, is a regular expression that filters the file
586 names. Only the files that are under revision control are taken into account."
588 (let ((dir-A (ediff-get-default-directory-name)))
589 (list (ediff-read-file-name
590 "Directory to merge with revisions:" dir-A nil
)
591 (read-string "Filter through regular expression: "
592 nil
'ediff-filtering-regexp-history
)
594 (ediff-directory-revisions-internal
595 dir1 regexp
'ediff-merge-revisions
'ediff-merge-directory-revisions
599 (defalias 'edir-merge-revisions
'ediff-merge-directory-revisions
)
602 (defun ediff-merge-directory-revisions-with-ancestor (dir1 regexp
)
603 "Run Ediff on a directory, DIR1, merging its files with their revisions and ancestors.
604 The second argument, REGEXP, is a regular expression that filters the file
605 names. Only the files that are under revision control are taken into account."
607 (let ((dir-A (ediff-get-default-directory-name)))
608 (list (ediff-read-file-name
609 "Directory to merge with revisions and ancestors:" dir-A nil
)
610 (read-string "Filter through regular expression: "
611 nil
'ediff-filtering-regexp-history
)
613 (ediff-directory-revisions-internal
614 dir1 regexp
'ediff-merge-revisions-with-ancestor
615 'ediff-merge-directory-revisions-with-ancestor
620 'edir-merge-revisions-with-ancestor
621 'ediff-merge-directory-revisions-with-ancestor
)
624 (defalias 'edirs-merge-with-ancestor
'ediff-merge-directories-with-ancestor
)
626 ;; Run ediff-action (ediff-files, ediff-merge, ediff-merge-with-ancestors)
627 ;; on a pair of directories (three directories, in case of ancestor).
628 ;; The third argument, REGEXP, is a regular expression that can be used to
629 ;; filter out certain file names.
630 ;; JOBNAME is the symbol indicating the meta-job to be performed.
631 ;; MERGE-DIR is the directory in which to store merged files.
632 (defun ediff-directories-internal (dir1 dir2 dir3 regexp action jobname
633 &optional startup-hooks
)
634 ;; ediff-read-file-name is set to attach a previously entered file name if
635 ;; the currently entered file is a directory. This code takes care of that.
636 (setq dir1
(if (file-directory-p dir1
) dir1
(file-name-directory dir1
))
637 dir2
(if (file-directory-p dir2
) dir2
(file-name-directory dir2
)))
640 (setq dir3
(if (file-directory-p dir3
) dir3
(file-name-directory dir3
))))
642 (cond ((string= dir1 dir2
)
643 (error "Directories A and B are the same: %s" dir1
))
644 ((and (eq jobname
'ediff-directories3
)
646 (error "Directories A and C are the same: %s" dir1
))
647 ((and (eq jobname
'ediff-directories3
)
649 (error "Directories B and C are the same: %s" dir1
)))
651 (let (diffs ; var where ediff-intersect-directories returns the diff list
654 (if (and ediff-autostore-merges
(ediff-merge-metajob jobname
))
655 (setq merge-autostore-dir
656 (ediff-read-file-name "Directory to save merged files:"
657 (if ediff-use-last-dir
658 ediff-last-merge-autostore-dir
659 (ediff-strip-last-dir dir1
))
661 ;; verify we are not merging into an orig directory
662 (if (stringp merge-autostore-dir
)
663 (cond ((and (stringp dir1
) (string= merge-autostore-dir dir1
))
664 (or (y-or-n-p "Merge directory same as directory A, sure? ")
665 (error "Directory merge aborted")))
666 ((and (stringp dir2
) (string= merge-autostore-dir dir2
))
667 (or (y-or-n-p "Merge directory same as directory B, sure? ")
668 (error "Directory merge aborted")))
669 ((and (stringp dir3
) (string= merge-autostore-dir dir3
))
671 "Merge directory same as ancestor directory, sure? ")
672 (error "Directory merge aborted")))))
674 (setq file-list
(ediff-intersect-directories
676 regexp dir1 dir2 dir3 merge-autostore-dir
))
678 ;; this sets various vars in the meta buffer inside
679 ;; ediff-prepare-meta-buffer
681 ;; tell what to do if the user clicks on a session record
682 (setq ediff-session-action-function
(quote (, action
)))
683 ;; set ediff-dir-difference-list
684 (setq ediff-dir-difference-list
(quote (, diffs
)))))
686 (setq meta-buf
(ediff-prepare-meta-buffer
687 'ediff-filegroup-action
689 "*Ediff Session Group Panel"
690 'ediff-redraw-directory-group-buffer
693 (ediff-show-meta-buffer meta-buf
)
696 (defun ediff-directory-revisions-internal (dir1 regexp action jobname
697 &optional startup-hooks
)
698 (setq dir1
(if (file-directory-p dir1
) dir1
(file-name-directory dir1
)))
700 (let (file-list meta-buf merge-autostore-dir
)
701 (if (and ediff-autostore-merges
(ediff-merge-metajob jobname
))
702 (setq merge-autostore-dir
703 (ediff-read-file-name "Directory to save merged files:"
704 (if ediff-use-last-dir
705 ediff-last-merge-autostore-dir
706 (ediff-strip-last-dir dir1
))
708 ;; verify merge-autostore-dir != dir1
709 (if (and (stringp merge-autostore-dir
)
711 (string= merge-autostore-dir dir1
))
713 "Directory for saving merges is the same as directory A. Sure? ")
714 (error "Merge of directory revisions aborted")))
717 (ediff-get-directory-files-under-revision
718 jobname regexp dir1 merge-autostore-dir
))
720 ;; this sets various vars in the meta buffer inside
721 ;; ediff-prepare-meta-buffer
723 ;; tell what to do if the user clicks on a session record
724 (setq ediff-session-action-function
(quote (, action
)))
727 (setq meta-buf
(ediff-prepare-meta-buffer
728 'ediff-filegroup-action
730 "*Ediff Session Group Panel"
731 'ediff-redraw-directory-group-buffer
734 (ediff-show-meta-buffer meta-buf
)
738 ;;; Compare regions and windows
741 (defun ediff-windows-wordwise (dumb-mode &optional wind-A wind-B startup-hooks
)
742 "Compare WIND-A and WIND-B, which are selected by clicking, wordwise.
743 With prefix argument, DUMB-MODE, or on a non-windowing display, works as
745 If WIND-A is nil, use selected window.
746 If WIND-B is nil, use window next to WIND-A."
748 (ediff-windows dumb-mode wind-A wind-B
749 startup-hooks
'ediff-windows-wordwise
'word-mode
))
752 (defun ediff-windows-linewise (dumb-mode &optional wind-A wind-B startup-hooks
)
753 "Compare WIND-A and WIND-B, which are selected by clicking, linewise.
754 With prefix argument, DUMB-MODE, or on a non-windowing display, works as
756 If WIND-A is nil, use selected window.
757 If WIND-B is nil, use window next to WIND-A."
759 (ediff-windows dumb-mode wind-A wind-B
760 startup-hooks
'ediff-windows-linewise nil
))
762 ;; Compare WIND-A and WIND-B, which are selected by clicking.
763 ;; With prefix argument, DUMB-MODE, or on a non-windowing display,
765 ;; If WIND-A is nil, use selected window.
766 ;; If WIND-B is nil, use window next to WIND-A.
767 (defun ediff-windows (dumb-mode wind-A wind-B startup-hooks job-name word-mode
)
768 (if (or dumb-mode
(not (ediff-window-display-p)))
769 (setq wind-A
(ediff-get-next-window wind-A nil
)
770 wind-B
(ediff-get-next-window wind-B wind-A
))
771 (setq wind-A
(ediff-get-window-by-clicking wind-A nil
1)
772 wind-B
(ediff-get-window-by-clicking wind-B wind-A
2)))
774 (let ((buffer-A (window-buffer wind-A
))
775 (buffer-B (window-buffer wind-B
))
776 beg-A end-A beg-B end-B
)
779 (save-window-excursion
780 (sit-for 0) ; sync before using window-start/end -- a precaution
781 (select-window wind-A
)
782 (setq beg-A
(window-start)
784 (select-window wind-B
)
785 (setq beg-B
(window-start)
786 end-B
(window-end))))
787 (ediff-regions-internal
788 buffer-A beg-A end-A buffer-B beg-B end-B
789 startup-hooks job-name word-mode nil
)))
792 (defun ediff-regions-wordwise (buffer-A buffer-B
&optional startup-hooks
)
793 "Run Ediff on a pair of regions in two different buffers.
794 Regions \(i.e., point and mark\) are assumed to be set in advance.
795 This function is effective only for relatively small regions, up to 200
796 lines. For large regions, use `ediff-regions-linewise'."
799 (list (setq bf
(read-buffer "Region's A buffer: "
800 (ediff-other-buffer "") t
))
801 (read-buffer "Region's B buffer: "
803 ;; realign buffers so that two visible bufs will be
805 (save-window-excursion (other-window 1))
806 (ediff-other-buffer bf
))
808 (if (not (ediff-buffer-live-p buffer-A
))
809 (error "Buffer %S doesn't exist" buffer-A
))
810 (if (not (ediff-buffer-live-p buffer-B
))
811 (error "Buffer %S doesn't exist" buffer-B
))
814 (let (reg-A-beg reg-A-end reg-B-beg reg-B-end
)
816 (set-buffer buffer-A
)
817 (setq reg-A-beg
(region-beginning)
818 reg-A-end
(region-end))
819 (set-buffer buffer-B
)
820 (setq reg-B-beg
(region-beginning)
821 reg-B-end
(region-end)))
823 (ediff-regions-internal
824 (get-buffer buffer-A
) reg-A-beg reg-A-end
825 (get-buffer buffer-B
) reg-B-beg reg-B-end
826 startup-hooks
'ediff-regions-wordwise
'word-mode nil
)))
829 (defun ediff-regions-linewise (buffer-A buffer-B
&optional startup-hooks
)
830 "Run Ediff on a pair of regions in two different buffers.
831 Regions \(i.e., point and mark\) are assumed to be set in advance.
832 Each region is enlarged to contain full lines.
833 This function is effective for large regions, over 100-200
834 lines. For small regions, use `ediff-regions-wordwise'."
837 (list (setq bf
(read-buffer "Region A's buffer: "
838 (ediff-other-buffer "") t
))
839 (read-buffer "Region B's buffer: "
841 ;; realign buffers so that two visible bufs will be
843 (save-window-excursion (other-window 1))
844 (ediff-other-buffer bf
))
846 (if (not (ediff-buffer-live-p buffer-A
))
847 (error "Buffer %S doesn't exist" buffer-A
))
848 (if (not (ediff-buffer-live-p buffer-B
))
849 (error "Buffer %S doesn't exist" buffer-B
))
851 (let (reg-A-beg reg-A-end reg-B-beg reg-B-end
)
853 (set-buffer buffer-A
)
854 (setq reg-A-beg
(region-beginning)
855 reg-A-end
(region-end))
856 ;; enlarge the region to hold full lines
857 (goto-char reg-A-beg
)
859 (setq reg-A-beg
(point))
860 (goto-char reg-A-end
)
862 (or (eobp) (forward-char)) ; include the newline char
863 (setq reg-A-end
(point))
865 (set-buffer buffer-B
)
866 (setq reg-B-beg
(region-beginning)
867 reg-B-end
(region-end))
868 ;; enlarge the region to hold full lines
869 (goto-char reg-B-beg
)
871 (setq reg-B-beg
(point))
872 (goto-char reg-B-end
)
874 (or (eobp) (forward-char)) ; include the newline char
875 (setq reg-B-end
(point))
878 (ediff-regions-internal
879 (get-buffer buffer-A
) reg-A-beg reg-A-end
880 (get-buffer buffer-B
) reg-B-beg reg-B-end
881 startup-hooks
'ediff-regions-linewise nil
))) ; no word mode
883 ;; compare region beg-A to end-A of buffer-A
884 ;; to regions beg-B -- end-B in buffer-B.
885 (defun ediff-regions-internal (buffer-A beg-A end-A buffer-B beg-B end-B
886 startup-hooks job-name word-mode
888 (let ((tmp-buffer (get-buffer-create ediff-tmp-buffer
))
892 ;; in case beg/end-A/B aren't markers--make them into markers
893 (ediff-eval-in-buffer buffer-A
894 (setq beg-A
(move-marker (make-marker) beg-A
)
895 end-A
(move-marker (make-marker) end-A
)))
896 (ediff-eval-in-buffer buffer-B
897 (setq beg-B
(move-marker (make-marker) beg-B
)
898 end-B
(move-marker (make-marker) end-B
)))
900 (if (and (eq buffer-A buffer-B
)
901 (or (and (< beg-A end-B
) (<= beg-B beg-A
)) ; b-B b-A e-B
902 (and (< beg-B end-A
) (<= end-A end-B
)))) ; b-B e-A e-B
904 (with-output-to-temp-buffer ediff-msg-buffer
906 You have requested to compare overlapping regions of the same buffer.
908 In this case, Ediff's highlighting may be confusing---in the same window,
909 you may see highlighted regions that belong to different regions.
911 Continue anyway? (y/n) "))
913 (if (y-or-n-p "Continue anyway? ")
915 (error "%S aborted" job-name
))))
919 (ediff-wordify beg-A end-A buffer-A tmp-buffer
)
920 (ediff-copy-to-buffer beg-A end-A buffer-A tmp-buffer
))
921 (setq file-A
(ediff-make-temp-file tmp-buffer
"regA"))
925 (ediff-wordify beg-B end-B buffer-B tmp-buffer
)
926 (ediff-copy-to-buffer beg-B end-B buffer-B tmp-buffer
))
927 (setq file-B
(ediff-make-temp-file tmp-buffer
"regB"))
929 (setq overl-A
(ediff-make-bullet-proof-overlay beg-A end-A buffer-A
))
930 (setq overl-B
(ediff-make-bullet-proof-overlay beg-B end-B buffer-B
))
931 (ediff-setup buffer-A file-A
933 nil nil
; buffer & file C
935 (delete-file (, file-A
))
936 (delete-file (, file-B
))))
939 (list (cons 'ediff-word-mode word-mode
)
940 (cons 'ediff-narrow-bounds
(list overl-A overl-B
))
941 (cons 'ediff-job-name job-name
))
947 ;;; Merge files and buffers
950 (defalias 'ediff-merge
'ediff-merge-files
)
952 (defsubst ediff-merge-on-startup
()
954 (ediff-eval-in-buffer ediff-buffer-C
955 (set-buffer-modified-p nil
)))
958 (defun ediff-merge-files (file-A file-B
&optional startup-hooks
)
959 "Merge two files without ancestor."
961 (let ((dir-A (if ediff-use-last-dir
965 (list (setq f
(ediff-read-file-name
966 "File A to merge" dir-A
967 (ediff-get-default-file-name)))
968 (ediff-read-file-name "File B to merge"
970 (if ediff-use-last-dir
972 (file-name-directory f
)))
974 (setq file-name-history
975 (cons (ediff-abbreviate-file-name
977 (file-name-nondirectory f
)
982 (setq startup-hooks
(cons 'ediff-merge-on-startup startup-hooks
))
983 (ediff-files-internal file-A
984 (if (file-directory-p file-B
)
986 (file-name-nondirectory file-A
) file-B
)
993 (defun ediff-merge-files-with-ancestor (file-A file-B file-ancestor
994 &optional startup-hooks
)
995 "Merge two files with ancestor."
997 (let ((dir-A (if ediff-use-last-dir
1000 dir-B dir-ancestor f ff
)
1001 (list (setq f
(ediff-read-file-name
1002 "File A to merge" dir-A
1003 (ediff-get-default-file-name)))
1004 (setq ff
(ediff-read-file-name "File B to merge"
1006 (if ediff-use-last-dir
1008 (file-name-directory f
)))
1010 (setq file-name-history
1012 (ediff-abbreviate-file-name
1014 (file-name-nondirectory f
)
1018 (ediff-read-file-name "Ancestor file"
1020 (if ediff-use-last-dir
1021 ediff-last-dir-ancestor
1022 (file-name-directory ff
)))
1024 (setq file-name-history
1025 (cons (ediff-abbreviate-file-name
1027 (file-name-nondirectory ff
)
1032 (setq startup-hooks
(cons 'ediff-merge-on-startup startup-hooks
))
1033 (ediff-files-internal file-A
1034 (if (file-directory-p file-B
)
1036 (file-name-nondirectory file-A
) file-B
)
1040 'ediff-merge-files-with-ancestor
))
1043 (defalias 'ediff-merge-with-ancestor
'ediff-merge-files-with-ancestor
)
1046 (defun ediff-merge-buffers (buffer-A buffer-B
&optional startup-hooks job-name
)
1047 "Merge buffers without ancestor."
1050 (list (setq bf
(read-buffer "Buffer A to merge: "
1051 (ediff-other-buffer "") t
))
1052 (read-buffer "Buffer B to merge: "
1054 ;; realign buffers so that two visible bufs will be
1056 (save-window-excursion (other-window 1))
1057 (ediff-other-buffer bf
))
1060 (setq startup-hooks
(cons 'ediff-merge-on-startup startup-hooks
))
1061 (or job-name
(setq job-name
'ediff-merge-buffers
))
1062 (ediff-buffers-internal
1063 buffer-A buffer-B nil startup-hooks job-name
))
1066 (defun ediff-merge-buffers-with-ancestor (buffer-A
1067 buffer-B buffer-ancestor
1068 &optional startup-hooks job-name
)
1069 "Merge buffers with ancestor."
1072 (list (setq bf
(read-buffer "Buffer A to merge: "
1073 (ediff-other-buffer "") t
))
1074 (setq bff
(read-buffer "Buffer B to merge: "
1076 ;; realign buffers so that two visible
1077 ;; bufs will be at the top
1078 (save-window-excursion (other-window 1))
1079 (ediff-other-buffer bf
))
1081 (read-buffer "Ancestor buffer: "
1083 ;; realign buffers so that three visible
1084 ;; bufs will be at the top
1085 (save-window-excursion (other-window 1))
1086 (ediff-other-buffer (list bf bff
)))
1090 (setq startup-hooks
(cons 'ediff-merge-on-startup startup-hooks
))
1091 (or job-name
(setq job-name
'ediff-merge-buffers-with-ancestor
))
1092 (ediff-buffers-internal
1093 buffer-A buffer-B buffer-ancestor startup-hooks job-name
))
1097 (defun ediff-merge-revisions (&optional file startup-hooks
)
1098 "Run Ediff by merging two revisions of a file.
1099 The file is the optional FILE argument or the file visited by the current
1102 (if (stringp file
) (find-file file
))
1107 "Version 1 to merge (default: %s's latest version): "
1109 (file-name-nondirectory file
) "current buffer")))
1113 "Version 2 to merge (default: %s): "
1115 (file-name-nondirectory file
) "current buffer"))))
1116 (ediff-load-version-control)
1117 ;; ancestor-revision=nil
1119 (intern (format "ediff-%S-merge-internal" ediff-version-control-package
))
1120 rev1 rev2 nil startup-hooks
)))
1124 (defun ediff-merge-revisions-with-ancestor (&optional file startup-hooks
)
1125 "Run Ediff by merging two revisions of a file with a common ancestor.
1126 The file is the the optional FILE argument or the file visited by the current
1129 (if (stringp file
) (find-file file
))
1130 (let (rev1 rev2 ancestor-rev
)
1134 "Version 1 to merge (default: %s's latest version): "
1136 (file-name-nondirectory file
) "current buffer")))
1140 "Version 2 to merge (default: %s): "
1142 (file-name-nondirectory file
) "current buffer")))
1146 "Ancestor version (default: %s): "
1148 (file-name-nondirectory file
) "current buffer"))))
1149 (ediff-load-version-control)
1151 (intern (format "ediff-%S-merge-internal" ediff-version-control-package
))
1152 rev1 rev2 ancestor-rev startup-hooks
)))
1155 (defun run-ediff-from-cvs-buffer (pos)
1156 "Run Ediff-merge on appropriate revisions of the selected file.
1157 First run after `M-x cvs-update'. Then place the cursor on a line describing a
1158 file and then run `run-ediff-from-cvs-buffer'."
1160 (ediff-load-version-control)
1161 (let ((tin (tin-locate cvs-cookie-handle pos
)))
1163 (cvs-run-ediff-on-file-descriptor tin
)
1164 (error "There is no file to merge"))))
1170 (defun ediff-patch-file ()
1171 "Run Ediff by patching SOURCE-FILENAME."
1172 ;; This now returns the control buffer
1174 (let (source-dir source-file patch-buf
)
1175 (require 'ediff-ptch
)
1176 (setq patch-buf
(ediff-get-patch-buffer))
1177 (setq source-dir
(cond (ediff-use-last-dir ediff-last-dir-patch
)
1178 ((and (not ediff-patch-default-directory
)
1179 (buffer-file-name patch-buf
))
1180 (file-name-directory
1182 (buffer-file-name patch-buf
))))
1183 (t default-directory
)))
1185 ;; the default is the directory, not the visited file name
1186 (ediff-read-file-name "Which file to patch? " source-dir source-dir
))
1187 (ediff-dispatch-file-patching-job patch-buf source-file
)))
1190 (defun ediff-patch-buffer ()
1191 "Run Ediff by patching BUFFER-NAME."
1194 (require 'ediff-ptch
)
1195 (setq patch-buf
(ediff-get-patch-buffer))
1196 (ediff-patch-buffer-internal
1198 (read-buffer "Which buffer to patch? "
1199 (cond ((eq patch-buf
(current-buffer))
1200 (window-buffer (other-window 1)))
1201 (t (current-buffer)))
1205 (defalias 'epatch
'ediff-patch-file
)
1207 (defalias 'epatch-buffer
'ediff-patch-buffer
)
1212 ;;; Versions Control functions
1215 (defun ediff-revision (&optional file startup-hooks
)
1216 "Run Ediff by comparing versions of a file.
1217 The file is an optional FILE argument or the file visited by the current
1218 buffer. Use `vc.el' or `rcs.el' depending on `ediff-version-control-package'."
1219 ;; if buffer is non-nil, use that buffer instead of the current buffer
1221 (if (stringp file
) (find-file file
))
1225 (format "Version 1 to compare (default: %s's latest version): "
1227 (file-name-nondirectory file
) "current buffer")))
1230 (format "Version 2 to compare (default: %s): "
1232 (file-name-nondirectory file
) "current buffer"))))
1233 (ediff-load-version-control)
1235 (intern (format "ediff-%S-internal" ediff-version-control-package
))
1236 rev1 rev2 startup-hooks
)
1240 ;; Test if version control package is loaded and load if not
1241 ;; Is SILENT is non-nil, don't report error if package is not found.
1242 (defun ediff-load-version-control (&optional silent
)
1243 (require 'ediff-vers
)
1244 (or (featurep ediff-version-control-package
)
1245 (if (locate-library (symbol-name ediff-version-control-package
))
1247 (message "") ; kill the message from `locate-library'
1248 (require ediff-version-control-package
))
1250 (error "Version control package %S.el not found. Use vc.el instead"
1251 ediff-version-control-package
)))))
1255 (defun ediff-version ()
1256 "Return string describing the version of Ediff.
1257 When called interactively, displays the version."
1260 (message (ediff-version))
1261 (format "Ediff %s of %s" ediff-version ediff-date
)))
1265 (defun ediff-documentation (&optional node
)
1266 "Display Ediff's manual.
1267 With optional NODE, goes to that node."
1269 (let ((ctl-window ediff-control-window
)
1270 (ctl-buf ediff-control-buffer
))
1272 (ediff-skip-unsuitable-frames)
1275 (pop-to-buffer (get-buffer-create "*info*"))
1276 (info (if ediff-xemacs-p
"ediff.info" "ediff"))
1278 (Info-goto-node node
)
1279 (message "Type `i' to search for a specific topic"))
1280 (raise-frame (selected-frame)))
1282 (with-output-to-temp-buffer ediff-msg-buffer
1283 (princ ediff-BAD-INFO
))
1284 (if (window-live-p ctl-window
)
1286 (select-window ctl-window
)
1287 (set-window-buffer ctl-window ctl-buf
)))))))
1292 ;;; Local Variables:
1293 ;;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
1294 ;;; eval: (put 'ediff-eval-in-buffer 'lisp-indent-hook 1)
1295 ;;; eval: (put 'ediff-eval-in-buffer 'edebug-form-spec '(form body))
1298 (require 'ediff-util
)
1300 ;;; ediff.el ends here