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.67" "The current version of Ediff")
10 (defconst ediff-date
"August 7, 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.
112 (defvar cvs-cookie-handle
)
113 (defvar ediff-last-dir-patch
)
114 (defvar ediff-patch-default-directory
)
118 (load-library "dired")
119 (load-library "info")
120 (load "pcl-cvs" 'noerror
)))
122 (let ((load-path (cons (expand-file-name ".") load-path
)))
123 (or (featurep 'ediff-init
)
124 (load "ediff-init.el" nil nil
'nosuffix
))
125 (or (featurep 'ediff-mult
)
126 (load "ediff-mult.el" nil nil
'nosuffix
))
127 (or (featurep 'ediff-ptch
)
128 (load "ediff-ptch.el" nil nil
'nosuffix
))
129 (or (featurep 'ediff-vers
)
130 (load "ediff-vers.el" nil nil
'nosuffix
))
134 (require 'ediff-init
)
135 (require 'ediff-mult
) ; required because of the registry stuff
138 "A comprehensive visual interface to diff & patch"
143 (defcustom ediff-use-last-dir nil
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.
149 (defvar ediff-last-dir-A nil
)
150 ;; Last directory used by an Ediff command for file-B.
151 (defvar ediff-last-dir-B nil
)
152 ;; Last directory used by an Ediff command for file-C.
153 (defvar ediff-last-dir-C nil
)
154 ;; Last directory used by an Ediff command for the ancestor file.
155 (defvar ediff-last-dir-ancestor nil
)
156 ;; Last directory used by an Ediff command as the output directory for merge.
157 (defvar ediff-last-merge-autostore-dir
)
160 ;; Used as a startup hook to set `_orig' patch file read-only.
161 (defun ediff-set-read-only-in-buf-A ()
162 (ediff-with-current-buffer ediff-buffer-A
163 (toggle-read-only 1)))
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.
168 (defun ediff-get-default-file-name ()
169 (cond ((eq major-mode
'dired-mode
)
170 (let ((f (dired-get-filename nil
'no-error
)))
171 (if (and (stringp f
) (not (file-directory-p f
)))
173 ((buffer-file-name (current-buffer))
174 (file-name-nondirectory (buffer-file-name (current-buffer))))
177 ;;; Compare files/buffers
180 (defun ediff-files (file-A file-B
&optional startup-hooks
)
181 "Run Ediff on a pair of files, FILE-A and FILE-B."
183 (let ((dir-A (if ediff-use-last-dir
187 (list (setq f
(ediff-read-file-name
188 "File A to compare" dir-A
189 (ediff-get-default-file-name)))
190 (ediff-read-file-name "File B to compare"
192 (if ediff-use-last-dir
194 (file-name-directory f
)))
196 (setq file-name-history
197 (cons (ediff-abbreviate-file-name
199 (file-name-nondirectory f
)
204 (ediff-files-internal file-A
205 (if (file-directory-p file-B
)
207 (file-name-nondirectory file-A
) file-B
)
214 (defun ediff-files3 (file-A file-B file-C
&optional startup-hooks
)
215 "Run Ediff on three files, FILE-A, FILE-B, and FILE-C."
217 (let ((dir-A (if ediff-use-last-dir
221 (list (setq f
(ediff-read-file-name
222 "File A to compare" dir-A
223 (ediff-get-default-file-name)))
224 (setq ff
(ediff-read-file-name "File B to compare"
226 (if ediff-use-last-dir
228 (file-name-directory f
)))
230 (setq file-name-history
232 (ediff-abbreviate-file-name
234 (file-name-nondirectory f
)
238 (ediff-read-file-name "File C to compare"
239 (setq dir-C
(if ediff-use-last-dir
241 (file-name-directory ff
)))
243 (setq file-name-history
244 (cons (ediff-abbreviate-file-name
246 (file-name-nondirectory ff
)
251 (ediff-files-internal file-A
252 (if (file-directory-p file-B
)
254 (file-name-nondirectory file-A
) file-B
)
256 (if (file-directory-p file-C
)
258 (file-name-nondirectory file-A
) file-C
)
264 (defalias 'ediff3
'ediff-files3
)
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
276 (defun ediff-find-file (file-var buffer-name
&optional last-dir hooks-var
)
277 (let* ((file (symbol-value file-var
))
278 (file-magic (find-file-name-handler file
'find-file-noselect
))
279 (temp-file-name-prefix (file-name-nondirectory file
)))
280 (cond ((not (file-readable-p file
))
281 (error "File `%s' does not exist or is not readable" file
))
282 ((file-directory-p file
)
283 (error "File `%s' is a directory" file
)))
285 ;; some of the commands, below, require full file name
286 (setq file
(expand-file-name file
))
288 ;; Record the directory of the file
290 (set last-dir
(expand-file-name (file-name-directory file
))))
293 (set buffer-name
(find-file-noselect file
))
295 (ediff-with-current-buffer (symbol-value buffer-name
)
296 (widen) ; Make sure the entire file is seen
297 (cond (file-magic ; file has a handler, such as jka-compr-handler or
298 ;;; ange-ftp-hook-function--arrange for temp file
299 (ediff-verify-file-buffer 'magic
)
301 (ediff-make-temp-file
302 (current-buffer) temp-file-name-prefix
))
303 (set hooks-var
(cons (` (lambda () (delete-file (, file
))))
304 (symbol-value hooks-var
))))
305 ;; file processed via auto-mode-alist, a la uncompress.el
306 ((not (equal (file-truename file
)
307 (file-truename (buffer-file-name))))
309 (ediff-make-temp-file
310 (current-buffer) temp-file-name-prefix
))
311 (set hooks-var
(cons (` (lambda () (delete-file (, file
))))
312 (symbol-value hooks-var
))))
313 (t ;; plain file---just check that the file matches the buffer
314 (ediff-verify-file-buffer))))
315 (set file-var file
)))
317 (defun ediff-files-internal (file-A file-B file-C startup-hooks job-name
)
318 (let (buf-A buf-B buf-C
)
319 (message "Reading file %s ... " file-A
)
321 (ediff-find-file 'file-A
'buf-A
'ediff-last-dir-A
'startup-hooks
)
322 (message "Reading file %s ... " file-B
)
324 (ediff-find-file 'file-B
'buf-B
'ediff-last-dir-B
'startup-hooks
)
327 (message "Reading file %s ... " file-C
)
331 (if (eq job-name
'ediff-merge-files-with-ancestor
)
332 'ediff-last-dir-ancestor
'ediff-last-dir-C
)
334 (ediff-setup buf-A file-A
338 (list (cons 'ediff-job-name job-name
)))))
342 (defalias 'ediff
'ediff-files
)
346 (defun ediff-buffers (buffer-A buffer-B
&optional startup-hooks job-name
)
347 "Run Ediff on a pair of buffers, BUFFER-A and BUFFER-B."
350 (list (setq bf
(read-buffer "Buffer A to compare: "
351 (ediff-other-buffer "") t
))
352 (read-buffer "Buffer B to compare: "
354 ;; realign buffers so that two visible bufs will be
356 (save-window-excursion (other-window 1))
357 (ediff-other-buffer bf
))
359 (or job-name
(setq job-name
'ediff-buffers
))
360 (ediff-buffers-internal buffer-A buffer-B nil startup-hooks job-name
))
363 (defalias 'ebuffers
'ediff-buffers
)
367 (defun ediff-buffers3 (buffer-A buffer-B buffer-C
368 &optional startup-hooks job-name
)
369 "Run Ediff on three buffers, BUFFER-A, BUFFER-B, and BUFFER-C."
372 (list (setq bf
(read-buffer "Buffer A to compare: "
373 (ediff-other-buffer "") t
))
374 (setq bff
(read-buffer "Buffer B to compare: "
376 ;; realign buffers so that two visible
377 ;; bufs will be at the top
378 (save-window-excursion (other-window 1))
379 (ediff-other-buffer bf
))
381 (read-buffer "Buffer C to compare: "
383 ;; realign buffers so that three visible
384 ;; bufs will be at the top
385 (save-window-excursion (other-window 1))
386 (ediff-other-buffer (list bf bff
)))
389 (or job-name
(setq job-name
'ediff-buffers3
))
390 (ediff-buffers-internal buffer-A buffer-B buffer-C startup-hooks job-name
))
393 (defalias 'ebuffers3
'ediff-buffers3
)
397 (defun ediff-buffers-internal (buf-A buf-B buf-C startup-hooks job-name
)
398 (let* ((buf-A-file-name (buffer-file-name (get-buffer buf-A
)))
399 (buf-B-file-name (buffer-file-name (get-buffer buf-B
)))
400 (buf-C-is-alive (ediff-buffer-live-p buf-C
))
401 (buf-C-file-name (if buf-C-is-alive
402 (buffer-file-name (get-buffer buf-B
))))
403 file-A file-B file-C
)
404 (if (not (ediff-buffer-live-p buf-A
))
405 (error "Buffer %S doesn't exist" buf-A
))
406 (if (not (ediff-buffer-live-p buf-B
))
407 (error "Buffer %S doesn't exist" buf-B
))
408 (let ((ediff-job-name job-name
))
409 (if (and ediff-3way-comparison-job
410 (not buf-C-is-alive
))
411 (error "Buffer %S doesn't exist" buf-C
)))
412 (if (stringp buf-A-file-name
)
413 (setq buf-A-file-name
(file-name-nondirectory buf-A-file-name
)))
414 (if (stringp buf-B-file-name
)
415 (setq buf-B-file-name
(file-name-nondirectory buf-B-file-name
)))
416 (if (stringp buf-C-file-name
)
417 (setq buf-C-file-name
(file-name-nondirectory buf-C-file-name
)))
419 (setq file-A
(ediff-make-temp-file buf-A buf-A-file-name
)
420 file-B
(ediff-make-temp-file buf-B buf-B-file-name
))
422 (setq file-C
(ediff-make-temp-file buf-C buf-C-file-name
)))
424 (ediff-setup (get-buffer buf-A
) file-A
425 (get-buffer buf-B
) file-B
426 (if buf-C-is-alive
(get-buffer buf-C
))
429 (delete-file (, file-A
))
430 (delete-file (, file-B
))
431 (if (stringp (, file-C
)) (delete-file (, file-C
)))
434 (list (cons 'ediff-job-name job-name
))
438 ;;; Directory and file group operations
440 ;; Get appropriate default name for directory:
441 ;; If ediff-use-last-dir, use ediff-last-dir-A.
442 ;; In dired mode, use the directory that is under the point (if any);
443 ;; otherwise, use default-directory
444 (defun ediff-get-default-directory-name ()
445 (cond (ediff-use-last-dir ediff-last-dir-A
)
446 ((eq major-mode
'dired-mode
)
447 (let ((f (dired-get-filename nil
'noerror
)))
448 (if (and (stringp f
) (file-directory-p f
))
451 (t default-directory
)))
455 (defun ediff-directories (dir1 dir2 regexp
)
456 "Run Ediff on a pair of directories, DIR1 and DIR2, comparing files that have
457 the same name in both. The third argument, REGEXP, is a regular expression that
458 can be used to filter out certain file names."
460 (let ((dir-A (ediff-get-default-directory-name))
462 (list (setq f
(ediff-read-file-name "Directory A to compare:" dir-A nil
))
463 (ediff-read-file-name "Directory B to compare:"
464 (if ediff-use-last-dir
466 (ediff-strip-last-dir f
))
468 (read-string "Filter through regular expression: "
469 nil
'ediff-filtering-regexp-history
)
471 (ediff-directories-internal
472 dir1 dir2 nil regexp
'ediff-files
'ediff-directories
476 (defalias 'edirs
'ediff-directories
)
480 (defun ediff-directory-revisions (dir1 regexp
)
481 "Run Ediff on a directory, DIR1, comparing its files with their revisions.
482 The second argument, REGEXP, is a regular expression that filters the file
483 names. Only the files that are under revision control are taken into account."
485 (let ((dir-A (ediff-get-default-directory-name)))
486 (list (ediff-read-file-name
487 "Directory to compare with revision:" dir-A nil
)
488 (read-string "Filter through regular expression: "
489 nil
'ediff-filtering-regexp-history
)
491 (ediff-directory-revisions-internal
492 dir1 regexp
'ediff-revision
'ediff-directory-revisions
496 (defalias 'edir-revisions
'ediff-directory-revisions
)
500 (defun ediff-directories3 (dir1 dir2 dir3 regexp
)
501 "Run Ediff on three directories, DIR1, DIR2, and DIR3, comparing files that
502 have the same name in all three. The last argument, REGEXP, is a regular
503 expression that can be used to filter out certain file names."
505 (let ((dir-A (ediff-get-default-directory-name))
507 (list (setq f
(ediff-read-file-name "Directory A to compare:" dir-A nil
))
508 (setq f
(ediff-read-file-name "Directory B to compare:"
509 (if ediff-use-last-dir
511 (ediff-strip-last-dir f
))
513 (ediff-read-file-name "Directory C to compare:"
514 (if ediff-use-last-dir
516 (ediff-strip-last-dir f
))
518 (read-string "Filter through regular expression: "
519 nil
'ediff-filtering-regexp-history
)
521 (ediff-directories-internal
522 dir1 dir2 dir3 regexp
'ediff-files3
'ediff-directories3
526 (defalias 'edirs3
'ediff-directories3
)
529 (defun ediff-merge-directories (dir1 dir2 regexp
)
530 "Run Ediff on a pair of directories, DIR1 and DIR2, merging files that have
531 the same name in both. The third argument, REGEXP, is a regular expression that
532 can be used to filter out certain file names."
534 (let ((dir-A (ediff-get-default-directory-name))
536 (list (setq f
(ediff-read-file-name "Directory A to merge:" dir-A nil
))
537 (ediff-read-file-name "Directory B to merge:"
538 (if ediff-use-last-dir
540 (ediff-strip-last-dir f
))
542 (read-string "Filter through regular expression: "
543 nil
'ediff-filtering-regexp-history
)
545 (ediff-directories-internal
546 dir1 dir2 nil regexp
'ediff-merge-files
'ediff-merge-directories
550 (defalias 'edirs-merge
'ediff-merge-directories
)
553 (defun ediff-merge-directories-with-ancestor (dir1 dir2 ancestor-dir regexp
)
554 "Merge files in directories DIR1 and DIR2 using files in ANCESTOR-DIR as ancestors.
555 Ediff merges files that have identical names in DIR1, DIR2. If a pair of files
556 in DIR1 and DIR2 doesn't have an ancestor in ANCESTOR-DIR, Ediff will merge
557 without ancestor. The fourth argument, REGEXP, is a regular expression that
558 can be used to filter out certain file names."
560 (let ((dir-A (ediff-get-default-directory-name))
562 (list (setq f
(ediff-read-file-name "Directory A to merge:" dir-A nil
))
563 (setq f
(ediff-read-file-name "Directory B to merge:"
564 (if ediff-use-last-dir
566 (ediff-strip-last-dir f
))
568 (ediff-read-file-name "Ancestor directory:"
569 (if ediff-use-last-dir
571 (ediff-strip-last-dir f
))
573 (read-string "Filter through regular expression: "
574 nil
'ediff-filtering-regexp-history
)
576 (ediff-directories-internal
577 dir1 dir2 ancestor-dir regexp
578 'ediff-merge-files-with-ancestor
'ediff-merge-directories-with-ancestor
582 (defun ediff-merge-directory-revisions (dir1 regexp
)
583 "Run Ediff on a directory, DIR1, merging its files with their revisions.
584 The second argument, REGEXP, is a regular expression that filters the file
585 names. Only the files that are under revision control are taken into account."
587 (let ((dir-A (ediff-get-default-directory-name)))
588 (list (ediff-read-file-name
589 "Directory to merge with revisions:" dir-A nil
)
590 (read-string "Filter through regular expression: "
591 nil
'ediff-filtering-regexp-history
)
593 (ediff-directory-revisions-internal
594 dir1 regexp
'ediff-merge-revisions
'ediff-merge-directory-revisions
598 (defalias 'edir-merge-revisions
'ediff-merge-directory-revisions
)
601 (defun ediff-merge-directory-revisions-with-ancestor (dir1 regexp
)
602 "Run Ediff on a directory, DIR1, merging its files with their revisions and ancestors.
603 The second argument, REGEXP, is a regular expression that filters the file
604 names. Only the files that are under revision control are taken into account."
606 (let ((dir-A (ediff-get-default-directory-name)))
607 (list (ediff-read-file-name
608 "Directory to merge with revisions and ancestors:" dir-A nil
)
609 (read-string "Filter through regular expression: "
610 nil
'ediff-filtering-regexp-history
)
612 (ediff-directory-revisions-internal
613 dir1 regexp
'ediff-merge-revisions-with-ancestor
614 'ediff-merge-directory-revisions-with-ancestor
619 'edir-merge-revisions-with-ancestor
620 'ediff-merge-directory-revisions-with-ancestor
)
623 (defalias 'edirs-merge-with-ancestor
'ediff-merge-directories-with-ancestor
)
625 ;; Run ediff-action (ediff-files, ediff-merge, ediff-merge-with-ancestors)
626 ;; on a pair of directories (three directories, in case of ancestor).
627 ;; The third argument, REGEXP, is a regular expression that can be used to
628 ;; filter out certain file names.
629 ;; JOBNAME is the symbol indicating the meta-job to be performed.
630 ;; MERGE-DIR is the directory in which to store merged files.
631 (defun ediff-directories-internal (dir1 dir2 dir3 regexp action jobname
632 &optional startup-hooks
)
633 ;; ediff-read-file-name is set to attach a previously entered file name if
634 ;; the currently entered file is a directory. This code takes care of that.
635 (setq dir1
(if (file-directory-p dir1
) dir1
(file-name-directory dir1
))
636 dir2
(if (file-directory-p dir2
) dir2
(file-name-directory dir2
)))
639 (setq dir3
(if (file-directory-p dir3
) dir3
(file-name-directory dir3
))))
641 (cond ((string= dir1 dir2
)
642 (error "Directories A and B are the same: %s" dir1
))
643 ((and (eq jobname
'ediff-directories3
)
645 (error "Directories A and C are the same: %s" dir1
))
646 ((and (eq jobname
'ediff-directories3
)
648 (error "Directories B and C are the same: %s" dir1
)))
650 (let (diffs ; var where ediff-intersect-directories returns the diff list
653 (if (and ediff-autostore-merges
(ediff-merge-metajob jobname
))
654 (setq merge-autostore-dir
655 (ediff-read-file-name "Directory to save merged files:"
656 (if ediff-use-last-dir
657 ediff-last-merge-autostore-dir
658 (ediff-strip-last-dir dir1
))
660 ;; verify we are not merging into an orig directory
661 (if (stringp merge-autostore-dir
)
662 (cond ((and (stringp dir1
) (string= merge-autostore-dir dir1
))
663 (or (y-or-n-p "Merge directory same as directory A, sure? ")
664 (error "Directory merge aborted")))
665 ((and (stringp dir2
) (string= merge-autostore-dir dir2
))
666 (or (y-or-n-p "Merge directory same as directory B, sure? ")
667 (error "Directory merge aborted")))
668 ((and (stringp dir3
) (string= merge-autostore-dir dir3
))
670 "Merge directory same as ancestor directory, sure? ")
671 (error "Directory merge aborted")))))
673 (setq file-list
(ediff-intersect-directories
675 regexp dir1 dir2 dir3 merge-autostore-dir
))
677 ;; this sets various vars in the meta buffer inside
678 ;; ediff-prepare-meta-buffer
680 ;; tell what to do if the user clicks on a session record
681 (setq ediff-session-action-function
(quote (, action
)))
682 ;; set ediff-dir-difference-list
683 (setq ediff-dir-difference-list
(quote (, diffs
)))))
685 (setq meta-buf
(ediff-prepare-meta-buffer
686 'ediff-filegroup-action
688 "*Ediff Session Group Panel"
689 'ediff-redraw-directory-group-buffer
692 (ediff-show-meta-buffer meta-buf
)
695 (defun ediff-directory-revisions-internal (dir1 regexp action jobname
696 &optional startup-hooks
)
697 (setq dir1
(if (file-directory-p dir1
) dir1
(file-name-directory dir1
)))
699 (let (file-list meta-buf merge-autostore-dir
)
700 (if (and ediff-autostore-merges
(ediff-merge-metajob jobname
))
701 (setq merge-autostore-dir
702 (ediff-read-file-name "Directory to save merged files:"
703 (if ediff-use-last-dir
704 ediff-last-merge-autostore-dir
705 (ediff-strip-last-dir dir1
))
707 ;; verify merge-autostore-dir != dir1
708 (if (and (stringp merge-autostore-dir
)
710 (string= merge-autostore-dir dir1
))
712 "Directory for saving merges is the same as directory A. Sure? ")
713 (error "Merge of directory revisions aborted")))
716 (ediff-get-directory-files-under-revision
717 jobname regexp dir1 merge-autostore-dir
))
719 ;; this sets various vars in the meta buffer inside
720 ;; ediff-prepare-meta-buffer
722 ;; tell what to do if the user clicks on a session record
723 (setq ediff-session-action-function
(quote (, action
)))
726 (setq meta-buf
(ediff-prepare-meta-buffer
727 'ediff-filegroup-action
729 "*Ediff Session Group Panel"
730 'ediff-redraw-directory-group-buffer
733 (ediff-show-meta-buffer meta-buf
)
737 ;;; Compare regions and windows
740 (defun ediff-windows-wordwise (dumb-mode &optional wind-A wind-B startup-hooks
)
741 "Compare WIND-A and WIND-B, which are selected by clicking, wordwise.
742 With prefix argument, DUMB-MODE, or on a non-windowing display, works as
744 If WIND-A is nil, use selected window.
745 If WIND-B is nil, use window next to WIND-A."
747 (ediff-windows dumb-mode wind-A wind-B
748 startup-hooks
'ediff-windows-wordwise
'word-mode
))
751 (defun ediff-windows-linewise (dumb-mode &optional wind-A wind-B startup-hooks
)
752 "Compare WIND-A and WIND-B, which are selected by clicking, linewise.
753 With prefix argument, DUMB-MODE, or on a non-windowing display, works as
755 If WIND-A is nil, use selected window.
756 If WIND-B is nil, use window next to WIND-A."
758 (ediff-windows dumb-mode wind-A wind-B
759 startup-hooks
'ediff-windows-linewise nil
))
761 ;; Compare WIND-A and WIND-B, which are selected by clicking.
762 ;; With prefix argument, DUMB-MODE, or on a non-windowing display,
764 ;; If WIND-A is nil, use selected window.
765 ;; If WIND-B is nil, use window next to WIND-A.
766 (defun ediff-windows (dumb-mode wind-A wind-B startup-hooks job-name word-mode
)
767 (if (or dumb-mode
(not (ediff-window-display-p)))
768 (setq wind-A
(ediff-get-next-window wind-A nil
)
769 wind-B
(ediff-get-next-window wind-B wind-A
))
770 (setq wind-A
(ediff-get-window-by-clicking wind-A nil
1)
771 wind-B
(ediff-get-window-by-clicking wind-B wind-A
2)))
773 (let ((buffer-A (window-buffer wind-A
))
774 (buffer-B (window-buffer wind-B
))
775 beg-A end-A beg-B end-B
)
778 (save-window-excursion
779 (sit-for 0) ; sync before using window-start/end -- a precaution
780 (select-window wind-A
)
781 (setq beg-A
(window-start)
783 (select-window wind-B
)
784 (setq beg-B
(window-start)
785 end-B
(window-end))))
786 (ediff-regions-internal
787 buffer-A beg-A end-A buffer-B beg-B end-B
788 startup-hooks job-name word-mode nil
)))
791 (defun ediff-regions-wordwise (buffer-A buffer-B
&optional startup-hooks
)
792 "Run Ediff on a pair of regions in two different buffers.
793 Regions \(i.e., point and mark\) are assumed to be set in advance.
794 This function is effective only for relatively small regions, up to 200
795 lines. For large regions, use `ediff-regions-linewise'."
798 (list (setq bf
(read-buffer "Region's A buffer: "
799 (ediff-other-buffer "") t
))
800 (read-buffer "Region's B buffer: "
802 ;; realign buffers so that two visible bufs will be
804 (save-window-excursion (other-window 1))
805 (ediff-other-buffer bf
))
807 (if (not (ediff-buffer-live-p buffer-A
))
808 (error "Buffer %S doesn't exist" buffer-A
))
809 (if (not (ediff-buffer-live-p buffer-B
))
810 (error "Buffer %S doesn't exist" buffer-B
))
813 (let (reg-A-beg reg-A-end reg-B-beg reg-B-end
)
815 (set-buffer buffer-A
)
816 (setq reg-A-beg
(region-beginning)
817 reg-A-end
(region-end))
818 (set-buffer buffer-B
)
819 (setq reg-B-beg
(region-beginning)
820 reg-B-end
(region-end)))
822 (ediff-regions-internal
823 (get-buffer buffer-A
) reg-A-beg reg-A-end
824 (get-buffer buffer-B
) reg-B-beg reg-B-end
825 startup-hooks
'ediff-regions-wordwise
'word-mode nil
)))
828 (defun ediff-regions-linewise (buffer-A buffer-B
&optional startup-hooks
)
829 "Run Ediff on a pair of regions in two different buffers.
830 Regions \(i.e., point and mark\) are assumed to be set in advance.
831 Each region is enlarged to contain full lines.
832 This function is effective for large regions, over 100-200
833 lines. For small regions, use `ediff-regions-wordwise'."
836 (list (setq bf
(read-buffer "Region A's buffer: "
837 (ediff-other-buffer "") t
))
838 (read-buffer "Region B's buffer: "
840 ;; realign buffers so that two visible bufs will be
842 (save-window-excursion (other-window 1))
843 (ediff-other-buffer bf
))
845 (if (not (ediff-buffer-live-p buffer-A
))
846 (error "Buffer %S doesn't exist" buffer-A
))
847 (if (not (ediff-buffer-live-p buffer-B
))
848 (error "Buffer %S doesn't exist" buffer-B
))
850 (let (reg-A-beg reg-A-end reg-B-beg reg-B-end
)
852 (set-buffer buffer-A
)
853 (setq reg-A-beg
(region-beginning)
854 reg-A-end
(region-end))
855 ;; enlarge the region to hold full lines
856 (goto-char reg-A-beg
)
858 (setq reg-A-beg
(point))
859 (goto-char reg-A-end
)
861 (or (eobp) (forward-char)) ; include the newline char
862 (setq reg-A-end
(point))
864 (set-buffer buffer-B
)
865 (setq reg-B-beg
(region-beginning)
866 reg-B-end
(region-end))
867 ;; enlarge the region to hold full lines
868 (goto-char reg-B-beg
)
870 (setq reg-B-beg
(point))
871 (goto-char reg-B-end
)
873 (or (eobp) (forward-char)) ; include the newline char
874 (setq reg-B-end
(point))
877 (ediff-regions-internal
878 (get-buffer buffer-A
) reg-A-beg reg-A-end
879 (get-buffer buffer-B
) reg-B-beg reg-B-end
880 startup-hooks
'ediff-regions-linewise nil nil
))) ; no word mode
882 ;; compare region beg-A to end-A of buffer-A
883 ;; to regions beg-B -- end-B in buffer-B.
884 (defun ediff-regions-internal (buffer-A beg-A end-A buffer-B beg-B end-B
885 startup-hooks job-name word-mode
887 (let ((tmp-buffer (get-buffer-create ediff-tmp-buffer
))
891 ;; in case beg/end-A/B aren't markers--make them into markers
892 (ediff-with-current-buffer buffer-A
893 (setq beg-A
(move-marker (make-marker) beg-A
)
894 end-A
(move-marker (make-marker) end-A
)))
895 (ediff-with-current-buffer buffer-B
896 (setq beg-B
(move-marker (make-marker) beg-B
)
897 end-B
(move-marker (make-marker) end-B
)))
899 (if (and (eq buffer-A buffer-B
)
900 (or (and (< beg-A end-B
) (<= beg-B beg-A
)) ; b-B b-A e-B
901 (and (< beg-B end-A
) (<= end-A end-B
)))) ; b-B e-A e-B
903 (with-output-to-temp-buffer ediff-msg-buffer
905 You have requested to compare overlapping regions of the same buffer.
907 In this case, Ediff's highlighting may be confusing---in the same window,
908 you may see highlighted regions that belong to different regions.
910 Continue anyway? (y/n) "))
912 (if (y-or-n-p "Continue anyway? ")
914 (error "%S aborted" job-name
))))
918 (ediff-wordify beg-A end-A buffer-A tmp-buffer
)
919 (ediff-copy-to-buffer beg-A end-A buffer-A tmp-buffer
))
920 (setq file-A
(ediff-make-temp-file tmp-buffer
"regA"))
924 (ediff-wordify beg-B end-B buffer-B tmp-buffer
)
925 (ediff-copy-to-buffer beg-B end-B buffer-B tmp-buffer
))
926 (setq file-B
(ediff-make-temp-file tmp-buffer
"regB"))
928 (setq overl-A
(ediff-make-bullet-proof-overlay beg-A end-A buffer-A
))
929 (setq overl-B
(ediff-make-bullet-proof-overlay beg-B end-B buffer-B
))
930 (ediff-setup buffer-A file-A
932 nil nil
; buffer & file C
934 (delete-file (, file-A
))
935 (delete-file (, file-B
))))
938 (list (cons 'ediff-word-mode word-mode
)
939 (cons 'ediff-narrow-bounds
(list overl-A overl-B
))
940 (cons 'ediff-job-name job-name
))
946 ;;; Merge files and buffers
949 (defalias 'ediff-merge
'ediff-merge-files
)
951 (defsubst ediff-merge-on-startup
()
953 (ediff-with-current-buffer ediff-buffer-C
954 (set-buffer-modified-p nil
)))
957 (defun ediff-merge-files (file-A file-B
&optional startup-hooks
)
958 "Merge two files without ancestor."
960 (let ((dir-A (if ediff-use-last-dir
964 (list (setq f
(ediff-read-file-name
965 "File A to merge" dir-A
966 (ediff-get-default-file-name)))
967 (ediff-read-file-name "File B to merge"
969 (if ediff-use-last-dir
971 (file-name-directory f
)))
973 (setq file-name-history
974 (cons (ediff-abbreviate-file-name
976 (file-name-nondirectory f
)
981 (setq startup-hooks
(cons 'ediff-merge-on-startup startup-hooks
))
982 (ediff-files-internal file-A
983 (if (file-directory-p file-B
)
985 (file-name-nondirectory file-A
) file-B
)
992 (defun ediff-merge-files-with-ancestor (file-A file-B file-ancestor
993 &optional startup-hooks
)
994 "Merge two files with ancestor."
996 (let ((dir-A (if ediff-use-last-dir
999 dir-B dir-ancestor f ff
)
1000 (list (setq f
(ediff-read-file-name
1001 "File A to merge" dir-A
1002 (ediff-get-default-file-name)))
1003 (setq ff
(ediff-read-file-name "File B to merge"
1005 (if ediff-use-last-dir
1007 (file-name-directory f
)))
1009 (setq file-name-history
1011 (ediff-abbreviate-file-name
1013 (file-name-nondirectory f
)
1017 (ediff-read-file-name "Ancestor file"
1019 (if ediff-use-last-dir
1020 ediff-last-dir-ancestor
1021 (file-name-directory ff
)))
1023 (setq file-name-history
1024 (cons (ediff-abbreviate-file-name
1026 (file-name-nondirectory ff
)
1031 (setq startup-hooks
(cons 'ediff-merge-on-startup startup-hooks
))
1032 (ediff-files-internal file-A
1033 (if (file-directory-p file-B
)
1035 (file-name-nondirectory file-A
) file-B
)
1039 'ediff-merge-files-with-ancestor
))
1042 (defalias 'ediff-merge-with-ancestor
'ediff-merge-files-with-ancestor
)
1045 (defun ediff-merge-buffers (buffer-A buffer-B
&optional startup-hooks job-name
)
1046 "Merge buffers without ancestor."
1049 (list (setq bf
(read-buffer "Buffer A to merge: "
1050 (ediff-other-buffer "") t
))
1051 (read-buffer "Buffer B to merge: "
1053 ;; realign buffers so that two visible bufs will be
1055 (save-window-excursion (other-window 1))
1056 (ediff-other-buffer bf
))
1059 (setq startup-hooks
(cons 'ediff-merge-on-startup startup-hooks
))
1060 (or job-name
(setq job-name
'ediff-merge-buffers
))
1061 (ediff-buffers-internal
1062 buffer-A buffer-B nil startup-hooks job-name
))
1065 (defun ediff-merge-buffers-with-ancestor (buffer-A
1066 buffer-B buffer-ancestor
1067 &optional startup-hooks job-name
)
1068 "Merge buffers with ancestor."
1071 (list (setq bf
(read-buffer "Buffer A to merge: "
1072 (ediff-other-buffer "") t
))
1073 (setq bff
(read-buffer "Buffer B to merge: "
1075 ;; realign buffers so that two visible
1076 ;; bufs will be at the top
1077 (save-window-excursion (other-window 1))
1078 (ediff-other-buffer bf
))
1080 (read-buffer "Ancestor buffer: "
1082 ;; realign buffers so that three visible
1083 ;; bufs will be at the top
1084 (save-window-excursion (other-window 1))
1085 (ediff-other-buffer (list bf bff
)))
1089 (setq startup-hooks
(cons 'ediff-merge-on-startup startup-hooks
))
1090 (or job-name
(setq job-name
'ediff-merge-buffers-with-ancestor
))
1091 (ediff-buffers-internal
1092 buffer-A buffer-B buffer-ancestor startup-hooks job-name
))
1096 (defun ediff-merge-revisions (&optional file startup-hooks
)
1097 "Run Ediff by merging two revisions of a file.
1098 The file is the optional FILE argument or the file visited by the current
1101 (if (stringp file
) (find-file file
))
1106 "Version 1 to merge (default: %s's latest version): "
1108 (file-name-nondirectory file
) "current buffer")))
1112 "Version 2 to merge (default: %s): "
1114 (file-name-nondirectory file
) "current buffer"))))
1115 (ediff-load-version-control)
1116 ;; ancestor-revision=nil
1118 (intern (format "ediff-%S-merge-internal" ediff-version-control-package
))
1119 rev1 rev2 nil startup-hooks
)))
1123 (defun ediff-merge-revisions-with-ancestor (&optional file startup-hooks
)
1124 "Run Ediff by merging two revisions of a file with a common ancestor.
1125 The file is the the optional FILE argument or the file visited by the current
1128 (if (stringp file
) (find-file file
))
1129 (let (rev1 rev2 ancestor-rev
)
1133 "Version 1 to merge (default: %s's latest version): "
1135 (file-name-nondirectory file
) "current buffer")))
1139 "Version 2 to merge (default: %s): "
1141 (file-name-nondirectory file
) "current buffer")))
1145 "Ancestor version (default: %s): "
1147 (file-name-nondirectory file
) "current buffer"))))
1148 (ediff-load-version-control)
1150 (intern (format "ediff-%S-merge-internal" ediff-version-control-package
))
1151 rev1 rev2 ancestor-rev startup-hooks
)))
1154 (defun run-ediff-from-cvs-buffer (pos)
1155 "Run Ediff-merge on appropriate revisions of the selected file.
1156 First run after `M-x cvs-update'. Then place the cursor on a line describing a
1157 file and then run `run-ediff-from-cvs-buffer'."
1159 (ediff-load-version-control)
1160 (let ((tin (tin-locate cvs-cookie-handle pos
)))
1162 (cvs-run-ediff-on-file-descriptor tin
)
1163 (error "There is no file to merge"))))
1169 (defun ediff-patch-file ()
1170 "Run Ediff by patching SOURCE-FILENAME."
1171 ;; This now returns the control buffer
1173 (let (source-dir source-file patch-buf
)
1174 (require 'ediff-ptch
)
1175 (setq patch-buf
(ediff-get-patch-buffer))
1176 (setq source-dir
(cond (ediff-use-last-dir ediff-last-dir-patch
)
1177 ((and (not ediff-patch-default-directory
)
1178 (buffer-file-name patch-buf
))
1179 (file-name-directory
1181 (buffer-file-name patch-buf
))))
1182 (t default-directory
)))
1184 ;; the default is the directory, not the visited file name
1185 (ediff-read-file-name "Which file to patch? " source-dir source-dir
))
1186 (ediff-dispatch-file-patching-job patch-buf source-file
)))
1189 (defun ediff-patch-buffer ()
1190 "Run Ediff by patching BUFFER-NAME."
1193 (require 'ediff-ptch
)
1194 (setq patch-buf
(ediff-get-patch-buffer))
1195 (ediff-patch-buffer-internal
1197 (read-buffer "Which buffer to patch? "
1198 (cond ((eq patch-buf
(current-buffer))
1199 (window-buffer (other-window 1)))
1200 (t (current-buffer)))
1204 (defalias 'epatch
'ediff-patch-file
)
1206 (defalias 'epatch-buffer
'ediff-patch-buffer
)
1211 ;;; Versions Control functions
1214 (defun ediff-revision (&optional file startup-hooks
)
1215 "Run Ediff by comparing versions of a file.
1216 The file is an optional FILE argument or the file visited by the current
1217 buffer. Use `vc.el' or `rcs.el' depending on `ediff-version-control-package'."
1218 ;; if buffer is non-nil, use that buffer instead of the current buffer
1220 (if (stringp file
) (find-file file
))
1224 (format "Version 1 to compare (default: %s's latest version): "
1226 (file-name-nondirectory file
) "current buffer")))
1229 (format "Version 2 to compare (default: %s): "
1231 (file-name-nondirectory file
) "current buffer"))))
1232 (ediff-load-version-control)
1234 (intern (format "ediff-%S-internal" ediff-version-control-package
))
1235 rev1 rev2 startup-hooks
)
1240 (defalias 'erevision
'ediff-revision
)
1243 ;; Test if version control package is loaded and load if not
1244 ;; Is SILENT is non-nil, don't report error if package is not found.
1245 (defun ediff-load-version-control (&optional silent
)
1246 (require 'ediff-vers
)
1247 (or (featurep ediff-version-control-package
)
1248 (if (locate-library (symbol-name ediff-version-control-package
))
1250 (message "") ; kill the message from `locate-library'
1251 (require ediff-version-control-package
))
1253 (error "Version control package %S.el not found. Use vc.el instead"
1254 ediff-version-control-package
)))))
1258 (defun ediff-version ()
1259 "Return string describing the version of Ediff.
1260 When called interactively, displays the version."
1263 (message (ediff-version))
1264 (format "Ediff %s of %s" ediff-version ediff-date
)))
1268 (defun ediff-documentation (&optional node
)
1269 "Display Ediff's manual.
1270 With optional NODE, goes to that node."
1272 (let ((ctl-window ediff-control-window
)
1273 (ctl-buf ediff-control-buffer
))
1275 (ediff-skip-unsuitable-frames)
1278 (pop-to-buffer (get-buffer-create "*info*"))
1279 (info (if ediff-xemacs-p
"ediff.info" "ediff"))
1281 (Info-goto-node node
)
1282 (message "Type `i' to search for a specific topic"))
1283 (raise-frame (selected-frame)))
1285 (with-output-to-temp-buffer ediff-msg-buffer
1286 (princ ediff-BAD-INFO
))
1287 (if (window-live-p ctl-window
)
1289 (select-window ctl-window
)
1290 (set-window-buffer ctl-window ctl-buf
)))))))
1295 ;;; Local Variables:
1296 ;;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
1297 ;;; eval: (put 'ediff-with-current-buffer 'lisp-indent-hook 1)
1298 ;;; eval: (put 'ediff-with-current-buffer 'edebug-form-spec '(form body))
1301 (require 'ediff-util
)
1303 ;;; ediff.el ends here