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.70.2" "The current version of Ediff")
10 (defconst ediff-date "May 21, 1998" "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 (ediff-filename-magic-p file))
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 ;; MERGE-BUFFER-FILE is the file to be associated with the merge buffer
318 (defun ediff-files-internal (file-A file-B file-C startup-hooks job-name
319 &optional merge-buffer-file)
320 (let (buf-A buf-B buf-C)
321 (message "Reading file %s ... " file-A)
323 (ediff-find-file 'file-A 'buf-A 'ediff-last-dir-A 'startup-hooks)
324 (message "Reading file %s ... " file-B)
326 (ediff-find-file 'file-B 'buf-B 'ediff-last-dir-B 'startup-hooks)
329 (message "Reading file %s ... " file-C)
333 (if (eq job-name 'ediff-merge-files-with-ancestor)
334 'ediff-last-dir-ancestor 'ediff-last-dir-C)
336 (ediff-setup buf-A file-A
340 (list (cons 'ediff-job-name job-name))
345 (defalias 'ediff 'ediff-files)
349 (defun ediff-buffers (buffer-A buffer-B &optional startup-hooks job-name)
350 "Run Ediff on a pair of buffers, BUFFER-A and BUFFER-B."
353 (list (setq bf (read-buffer "Buffer A to compare: "
354 (ediff-other-buffer "") t))
355 (read-buffer "Buffer B to compare: "
357 ;; realign buffers so that two visible bufs will be
359 (save-window-excursion (other-window 1))
360 (ediff-other-buffer bf))
362 (or job-name (setq job-name 'ediff-buffers))
363 (ediff-buffers-internal buffer-A buffer-B nil startup-hooks job-name))
366 (defalias 'ebuffers 'ediff-buffers)
370 (defun ediff-buffers3 (buffer-A buffer-B buffer-C
371 &optional startup-hooks job-name)
372 "Run Ediff on three buffers, BUFFER-A, BUFFER-B, and BUFFER-C."
375 (list (setq bf (read-buffer "Buffer A to compare: "
376 (ediff-other-buffer "") t))
377 (setq bff (read-buffer "Buffer B to compare: "
379 ;; realign buffers so that two visible
380 ;; bufs will be at the top
381 (save-window-excursion (other-window 1))
382 (ediff-other-buffer bf))
384 (read-buffer "Buffer C to compare: "
386 ;; realign buffers so that three visible
387 ;; bufs will be at the top
388 (save-window-excursion (other-window 1))
389 (ediff-other-buffer (list bf bff)))
392 (or job-name (setq job-name 'ediff-buffers3))
393 (ediff-buffers-internal buffer-A buffer-B buffer-C startup-hooks job-name))
396 (defalias 'ebuffers3 'ediff-buffers3)
400 ;; MERGE-BUFFER-FILE is the file to be associated with the merge buffer
401 (defun ediff-buffers-internal (buf-A buf-B buf-C startup-hooks job-name
402 &optional merge-buffer-file)
403 (let* ((buf-A-file-name (buffer-file-name (get-buffer buf-A)))
404 (buf-B-file-name (buffer-file-name (get-buffer buf-B)))
405 (buf-C-is-alive (ediff-buffer-live-p buf-C))
406 (buf-C-file-name (if buf-C-is-alive
407 (buffer-file-name (get-buffer buf-B))))
408 file-A file-B file-C)
409 (if (not (ediff-buffer-live-p buf-A))
410 (error "Buffer %S doesn't exist" buf-A))
411 (if (not (ediff-buffer-live-p buf-B))
412 (error "Buffer %S doesn't exist" buf-B))
413 (let ((ediff-job-name job-name))
414 (if (and ediff-3way-comparison-job
415 (not buf-C-is-alive))
416 (error "Buffer %S doesn't exist" buf-C)))
417 (if (stringp buf-A-file-name)
418 (setq buf-A-file-name (file-name-nondirectory buf-A-file-name)))
419 (if (stringp buf-B-file-name)
420 (setq buf-B-file-name (file-name-nondirectory buf-B-file-name)))
421 (if (stringp buf-C-file-name)
422 (setq buf-C-file-name (file-name-nondirectory buf-C-file-name)))
424 (setq file-A (ediff-make-temp-file buf-A buf-A-file-name)
425 file-B (ediff-make-temp-file buf-B buf-B-file-name))
427 (setq file-C (ediff-make-temp-file buf-C buf-C-file-name)))
429 (ediff-setup (get-buffer buf-A) file-A
430 (get-buffer buf-B) file-B
431 (if buf-C-is-alive (get-buffer buf-C))
434 (delete-file (, file-A))
435 (delete-file (, file-B))
436 (if (stringp (, file-C)) (delete-file (, file-C)))
439 (list (cons 'ediff-job-name job-name))
443 ;;; Directory and file group operations
445 ;; Get appropriate default name for directory:
446 ;; If ediff-use-last-dir, use ediff-last-dir-A.
447 ;; In dired mode, use the directory that is under the point (if any);
448 ;; otherwise, use default-directory
449 (defun ediff-get-default-directory-name ()
450 (cond (ediff-use-last-dir ediff-last-dir-A)
451 ((eq major-mode 'dired-mode)
452 (let ((f (dired-get-filename nil 'noerror)))
453 (if (and (stringp f) (file-directory-p f))
456 (t default-directory)))
460 (defun ediff-directories (dir1 dir2 regexp)
461 "Run Ediff on a pair of directories, DIR1 and DIR2, comparing files that have
462 the same name in both. The third argument, REGEXP, is a regular expression that
463 can be used to filter out certain file names."
465 (let ((dir-A (ediff-get-default-directory-name))
467 (list (setq f (ediff-read-file-name "Directory A to compare:" dir-A nil))
468 (ediff-read-file-name "Directory B to compare:"
469 (if ediff-use-last-dir
471 (ediff-strip-last-dir f))
473 (read-string "Filter through regular expression: "
474 nil 'ediff-filtering-regexp-history)
476 (ediff-directories-internal
477 dir1 dir2 nil regexp 'ediff-files 'ediff-directories
481 (defalias 'edirs 'ediff-directories)
485 (defun ediff-directory-revisions (dir1 regexp)
486 "Run Ediff on a directory, DIR1, comparing its files with their revisions.
487 The second argument, REGEXP, is a regular expression that filters the file
488 names. Only the files that are under revision control are taken into account."
490 (let ((dir-A (ediff-get-default-directory-name)))
491 (list (ediff-read-file-name
492 "Directory to compare with revision:" dir-A nil)
493 (read-string "Filter through regular expression: "
494 nil 'ediff-filtering-regexp-history)
496 (ediff-directory-revisions-internal
497 dir1 regexp 'ediff-revision 'ediff-directory-revisions
501 (defalias 'edir-revisions 'ediff-directory-revisions)
505 (defun ediff-directories3 (dir1 dir2 dir3 regexp)
506 "Run Ediff on three directories, DIR1, DIR2, and DIR3, comparing files that
507 have the same name in all three. The last argument, REGEXP, is a regular
508 expression that can be used to filter out certain file names."
510 (let ((dir-A (ediff-get-default-directory-name))
512 (list (setq f (ediff-read-file-name "Directory A to compare:" dir-A nil))
513 (setq f (ediff-read-file-name "Directory B to compare:"
514 (if ediff-use-last-dir
516 (ediff-strip-last-dir f))
518 (ediff-read-file-name "Directory C to compare:"
519 (if ediff-use-last-dir
521 (ediff-strip-last-dir f))
523 (read-string "Filter through regular expression: "
524 nil 'ediff-filtering-regexp-history)
526 (ediff-directories-internal
527 dir1 dir2 dir3 regexp 'ediff-files3 'ediff-directories3
531 (defalias 'edirs3 'ediff-directories3)
534 (defun ediff-merge-directories (dir1 dir2 regexp)
535 "Run Ediff on a pair of directories, DIR1 and DIR2, merging files that have
536 the same name in both. The third argument, REGEXP, is a regular expression that
537 can be used to filter out certain file names."
539 (let ((dir-A (ediff-get-default-directory-name))
541 (list (setq f (ediff-read-file-name "Directory A to merge:" dir-A nil))
542 (ediff-read-file-name "Directory B to merge:"
543 (if ediff-use-last-dir
545 (ediff-strip-last-dir f))
547 (read-string "Filter through regular expression: "
548 nil 'ediff-filtering-regexp-history)
550 (ediff-directories-internal
551 dir1 dir2 nil regexp 'ediff-merge-files 'ediff-merge-directories
555 (defalias 'edirs-merge 'ediff-merge-directories)
558 (defun ediff-merge-directories-with-ancestor (dir1 dir2 ancestor-dir regexp)
559 "Merge files in directories DIR1 and DIR2 using files in ANCESTOR-DIR as ancestors.
560 Ediff merges files that have identical names in DIR1, DIR2. If a pair of files
561 in DIR1 and DIR2 doesn't have an ancestor in ANCESTOR-DIR, Ediff will merge
562 without ancestor. The fourth argument, REGEXP, is a regular expression that
563 can be used to filter out certain file names."
565 (let ((dir-A (ediff-get-default-directory-name))
567 (list (setq f (ediff-read-file-name "Directory A to merge:" dir-A nil))
568 (setq f (ediff-read-file-name "Directory B to merge:"
569 (if ediff-use-last-dir
571 (ediff-strip-last-dir f))
573 (ediff-read-file-name "Ancestor directory:"
574 (if ediff-use-last-dir
576 (ediff-strip-last-dir f))
578 (read-string "Filter through regular expression: "
579 nil 'ediff-filtering-regexp-history)
581 (ediff-directories-internal
582 dir1 dir2 ancestor-dir regexp
583 'ediff-merge-files-with-ancestor 'ediff-merge-directories-with-ancestor
587 (defun ediff-merge-directory-revisions (dir1 regexp)
588 "Run Ediff on a directory, DIR1, merging its files with their revisions.
589 The second argument, REGEXP, is a regular expression that filters the file
590 names. Only the files that are under revision control are taken into account."
592 (let ((dir-A (ediff-get-default-directory-name)))
593 (list (ediff-read-file-name
594 "Directory to merge with revisions:" dir-A nil)
595 (read-string "Filter through regular expression: "
596 nil 'ediff-filtering-regexp-history)
598 (ediff-directory-revisions-internal
599 dir1 regexp 'ediff-merge-revisions 'ediff-merge-directory-revisions
603 (defalias 'edir-merge-revisions 'ediff-merge-directory-revisions)
606 (defun ediff-merge-directory-revisions-with-ancestor (dir1 regexp)
607 "Run Ediff on a directory, DIR1, merging its files with their revisions and ancestors.
608 The second argument, REGEXP, is a regular expression that filters the file
609 names. Only the files that are under revision control are taken into account."
611 (let ((dir-A (ediff-get-default-directory-name)))
612 (list (ediff-read-file-name
613 "Directory to merge with revisions and ancestors:" dir-A nil)
614 (read-string "Filter through regular expression: "
615 nil 'ediff-filtering-regexp-history)
617 (ediff-directory-revisions-internal
618 dir1 regexp 'ediff-merge-revisions-with-ancestor
619 'ediff-merge-directory-revisions-with-ancestor
624 'edir-merge-revisions-with-ancestor
625 'ediff-merge-directory-revisions-with-ancestor)
628 (defalias 'edirs-merge-with-ancestor 'ediff-merge-directories-with-ancestor)
630 ;; Run ediff-action (ediff-files, ediff-merge, ediff-merge-with-ancestors)
631 ;; on a pair of directories (three directories, in case of ancestor).
632 ;; The third argument, REGEXP, is a regular expression that can be used to
633 ;; filter out certain file names.
634 ;; JOBNAME is the symbol indicating the meta-job to be performed.
635 ;; MERGE-DIR is the directory in which to store merged files.
636 (defun ediff-directories-internal (dir1 dir2 dir3 regexp action jobname
637 &optional startup-hooks)
638 ;; ediff-read-file-name is set to attach a previously entered file name if
639 ;; the currently entered file is a directory. This code takes care of that.
640 (setq dir1 (if (file-directory-p dir1) dir1 (file-name-directory dir1))
641 dir2 (if (file-directory-p dir2) dir2 (file-name-directory dir2)))
644 (setq dir3 (if (file-directory-p dir3) dir3 (file-name-directory dir3))))
646 (cond ((string= dir1 dir2)
647 (error "Directories A and B are the same: %s" dir1))
648 ((and (eq jobname 'ediff-directories3)
650 (error "Directories A and C are the same: %s" dir1))
651 ((and (eq jobname 'ediff-directories3)
653 (error "Directories B and C are the same: %s" dir1)))
655 (let (diffs ; var where ediff-intersect-directories returns the diff list
658 (if (and ediff-autostore-merges (ediff-merge-metajob jobname))
659 (setq merge-autostore-dir
660 (ediff-read-file-name "Directory to save merged files:"
661 (if ediff-use-last-dir
662 ediff-last-merge-autostore-dir
663 (ediff-strip-last-dir dir1))
665 ;; verify we are not merging into an orig directory
666 (if (stringp merge-autostore-dir)
667 (cond ((and (stringp dir1) (string= merge-autostore-dir dir1))
668 (or (y-or-n-p "Merge directory same as directory A, sure? ")
669 (error "Directory merge aborted")))
670 ((and (stringp dir2) (string= merge-autostore-dir dir2))
671 (or (y-or-n-p "Merge directory same as directory B, sure? ")
672 (error "Directory merge aborted")))
673 ((and (stringp dir3) (string= merge-autostore-dir dir3))
675 "Merge directory same as ancestor directory, sure? ")
676 (error "Directory merge aborted")))))
678 (setq file-list (ediff-intersect-directories
680 regexp dir1 dir2 dir3 merge-autostore-dir))
682 ;; this sets various vars in the meta buffer inside
683 ;; ediff-prepare-meta-buffer
685 ;; tell what to do if the user clicks on a session record
686 (setq ediff-session-action-function (quote (, action)))
687 ;; set ediff-dir-difference-list
688 (setq ediff-dir-difference-list (quote (, diffs)))))
690 (setq meta-buf (ediff-prepare-meta-buffer
691 'ediff-filegroup-action
693 "*Ediff Session Group Panel"
694 'ediff-redraw-directory-group-buffer
697 (ediff-show-meta-buffer meta-buf)
700 (defun ediff-directory-revisions-internal (dir1 regexp action jobname
701 &optional startup-hooks)
702 (setq dir1 (if (file-directory-p dir1) dir1 (file-name-directory dir1)))
704 (let (file-list meta-buf merge-autostore-dir)
705 (if (and ediff-autostore-merges (ediff-merge-metajob jobname))
706 (setq merge-autostore-dir
707 (ediff-read-file-name "Directory to save merged files:"
708 (if ediff-use-last-dir
709 ediff-last-merge-autostore-dir
710 (ediff-strip-last-dir dir1))
712 ;; verify merge-autostore-dir != dir1
713 (if (and (stringp merge-autostore-dir)
715 (string= merge-autostore-dir dir1))
717 "Directory for saving merges is the same as directory A. Sure? ")
718 (error "Merge of directory revisions aborted")))
721 (ediff-get-directory-files-under-revision
722 jobname regexp dir1 merge-autostore-dir))
724 ;; this sets various vars in the meta buffer inside
725 ;; ediff-prepare-meta-buffer
727 ;; tell what to do if the user clicks on a session record
728 (setq ediff-session-action-function (quote (, action)))
731 (setq meta-buf (ediff-prepare-meta-buffer
732 'ediff-filegroup-action
734 "*Ediff Session Group Panel"
735 'ediff-redraw-directory-group-buffer
738 (ediff-show-meta-buffer meta-buf)
742 ;;; Compare regions and windows
745 (defun ediff-windows-wordwise (dumb-mode &optional wind-A wind-B startup-hooks)
746 "Compare WIND-A and WIND-B, which are selected by clicking, wordwise.
747 With prefix argument, DUMB-MODE, or on a non-windowing display, works as
749 If WIND-A is nil, use selected window.
750 If WIND-B is nil, use window next to WIND-A."
752 (ediff-windows dumb-mode wind-A wind-B
753 startup-hooks 'ediff-windows-wordwise 'word-mode))
756 (defun ediff-windows-linewise (dumb-mode &optional wind-A wind-B startup-hooks)
757 "Compare WIND-A and WIND-B, which are selected by clicking, linewise.
758 With prefix argument, DUMB-MODE, or on a non-windowing display, works as
760 If WIND-A is nil, use selected window.
761 If WIND-B is nil, use window next to WIND-A."
763 (ediff-windows dumb-mode wind-A wind-B
764 startup-hooks 'ediff-windows-linewise nil))
766 ;; Compare WIND-A and WIND-B, which are selected by clicking.
767 ;; With prefix argument, DUMB-MODE, or on a non-windowing display,
769 ;; If WIND-A is nil, use selected window.
770 ;; If WIND-B is nil, use window next to WIND-A.
771 (defun ediff-windows (dumb-mode wind-A wind-B startup-hooks job-name word-mode)
772 (if (or dumb-mode (not (ediff-window-display-p)))
773 (setq wind-A (ediff-get-next-window wind-A nil)
774 wind-B (ediff-get-next-window wind-B wind-A))
775 (setq wind-A (ediff-get-window-by-clicking wind-A nil 1)
776 wind-B (ediff-get-window-by-clicking wind-B wind-A 2)))
778 (let ((buffer-A (window-buffer wind-A))
779 (buffer-B (window-buffer wind-B))
780 beg-A end-A beg-B end-B)
783 (save-window-excursion
784 (sit-for 0) ; sync before using window-start/end -- a precaution
785 (select-window wind-A)
786 (setq beg-A (window-start)
788 (select-window wind-B)
789 (setq beg-B (window-start)
790 end-B (window-end))))
791 (ediff-regions-internal
792 buffer-A beg-A end-A buffer-B beg-B end-B
793 startup-hooks job-name word-mode nil)))
796 (defun ediff-regions-wordwise (buffer-A buffer-B &optional startup-hooks)
797 "Run Ediff on a pair of regions in two different buffers.
798 Regions \(i.e., point and mark\) are assumed to be set in advance.
799 This function is effective only for relatively small regions, up to 200
800 lines. For large regions, use `ediff-regions-linewise'."
803 (list (setq bf (read-buffer "Region's A buffer: "
804 (ediff-other-buffer "") t))
805 (read-buffer "Region's B buffer: "
807 ;; realign buffers so that two visible bufs will be
809 (save-window-excursion (other-window 1))
810 (ediff-other-buffer bf))
812 (if (not (ediff-buffer-live-p buffer-A))
813 (error "Buffer %S doesn't exist" buffer-A))
814 (if (not (ediff-buffer-live-p buffer-B))
815 (error "Buffer %S doesn't exist" buffer-B))
818 (let (reg-A-beg reg-A-end reg-B-beg reg-B-end)
820 (set-buffer buffer-A)
821 (setq reg-A-beg (region-beginning)
822 reg-A-end (region-end))
823 (set-buffer buffer-B)
824 (setq reg-B-beg (region-beginning)
825 reg-B-end (region-end)))
827 (ediff-regions-internal
828 (get-buffer buffer-A) reg-A-beg reg-A-end
829 (get-buffer buffer-B) reg-B-beg reg-B-end
830 startup-hooks 'ediff-regions-wordwise 'word-mode nil)))
833 (defun ediff-regions-linewise (buffer-A buffer-B &optional startup-hooks)
834 "Run Ediff on a pair of regions in two different buffers.
835 Regions \(i.e., point and mark\) are assumed to be set in advance.
836 Each region is enlarged to contain full lines.
837 This function is effective for large regions, over 100-200
838 lines. For small regions, use `ediff-regions-wordwise'."
841 (list (setq bf (read-buffer "Region A's buffer: "
842 (ediff-other-buffer "") t))
843 (read-buffer "Region B's buffer: "
845 ;; realign buffers so that two visible bufs will be
847 (save-window-excursion (other-window 1))
848 (ediff-other-buffer bf))
850 (if (not (ediff-buffer-live-p buffer-A))
851 (error "Buffer %S doesn't exist" buffer-A))
852 (if (not (ediff-buffer-live-p buffer-B))
853 (error "Buffer %S doesn't exist" buffer-B))
855 (let (reg-A-beg reg-A-end reg-B-beg reg-B-end)
857 (set-buffer buffer-A)
858 (setq reg-A-beg (region-beginning)
859 reg-A-end (region-end))
860 ;; enlarge the region to hold full lines
861 (goto-char reg-A-beg)
863 (setq reg-A-beg (point))
864 (goto-char reg-A-end)
866 (or (eobp) (forward-char)) ; include the newline char
867 (setq reg-A-end (point))
869 (set-buffer buffer-B)
870 (setq reg-B-beg (region-beginning)
871 reg-B-end (region-end))
872 ;; enlarge the region to hold full lines
873 (goto-char reg-B-beg)
875 (setq reg-B-beg (point))
876 (goto-char reg-B-end)
878 (or (eobp) (forward-char)) ; include the newline char
879 (setq reg-B-end (point))
882 (ediff-regions-internal
883 (get-buffer buffer-A) reg-A-beg reg-A-end
884 (get-buffer buffer-B) reg-B-beg reg-B-end
885 startup-hooks 'ediff-regions-linewise nil nil))) ; no word mode
887 ;; compare region beg-A to end-A of buffer-A
888 ;; to regions beg-B -- end-B in buffer-B.
889 (defun ediff-regions-internal (buffer-A beg-A end-A buffer-B beg-B end-B
890 startup-hooks job-name word-mode
892 (let ((tmp-buffer (get-buffer-create ediff-tmp-buffer))
896 ;; in case beg/end-A/B aren't markers--make them into markers
897 (ediff-with-current-buffer buffer-A
898 (setq beg-A (move-marker (make-marker) beg-A)
899 end-A (move-marker (make-marker) end-A)))
900 (ediff-with-current-buffer buffer-B
901 (setq beg-B (move-marker (make-marker) beg-B)
902 end-B (move-marker (make-marker) end-B)))
904 (if (and (eq buffer-A buffer-B)
905 (or (and (< beg-A end-B) (<= beg-B beg-A)) ; b-B b-A e-B
906 (and (< beg-B end-A) (<= end-A end-B)))) ; b-B e-A e-B
908 (with-output-to-temp-buffer ediff-msg-buffer
910 You have requested to compare overlapping regions of the same buffer.
912 In this case, Ediff's highlighting may be confusing---in the same window,
913 you may see highlighted regions that belong to different regions.
915 Continue anyway? (y/n) "))
917 (if (y-or-n-p "Continue anyway? ")
919 (error "%S aborted" job-name))))
923 (ediff-wordify beg-A end-A buffer-A tmp-buffer)
924 (ediff-copy-to-buffer beg-A end-A buffer-A tmp-buffer))
925 (setq file-A (ediff-make-temp-file tmp-buffer "regA"))
929 (ediff-wordify beg-B end-B buffer-B tmp-buffer)
930 (ediff-copy-to-buffer beg-B end-B buffer-B tmp-buffer))
931 (setq file-B (ediff-make-temp-file tmp-buffer "regB"))
933 (setq overl-A (ediff-make-bullet-proof-overlay beg-A end-A buffer-A))
934 (setq overl-B (ediff-make-bullet-proof-overlay beg-B end-B buffer-B))
935 (ediff-setup buffer-A file-A
937 nil nil ; buffer & file C
939 (delete-file (, file-A))
940 (delete-file (, file-B))))
943 (list (cons 'ediff-word-mode word-mode)
944 (cons 'ediff-narrow-bounds (list overl-A overl-B))
945 (cons 'ediff-job-name job-name))
950 ;;; Merge files and buffers
953 (defalias 'ediff-merge 'ediff-merge-files)
955 (defsubst ediff-merge-on-startup ()
957 (ediff-with-current-buffer ediff-buffer-C
958 (set-buffer-modified-p nil)))
961 (defun ediff-merge-files (file-A file-B
962 ;; MERGE-BUFFER-FILE is the file to be
963 ;; associated with the merge buffer
964 &optional startup-hooks merge-buffer-file)
965 "Merge two files without ancestor."
967 (let ((dir-A (if ediff-use-last-dir
971 (list (setq f (ediff-read-file-name
972 "File A to merge" dir-A
973 (ediff-get-default-file-name)))
974 (ediff-read-file-name "File B to merge"
976 (if ediff-use-last-dir
978 (file-name-directory f)))
980 (setq file-name-history
981 (cons (ediff-abbreviate-file-name
983 (file-name-nondirectory f)
988 (setq startup-hooks (cons 'ediff-merge-on-startup startup-hooks))
989 (ediff-files-internal file-A
990 (if (file-directory-p file-B)
992 (file-name-nondirectory file-A) file-B)
1000 (defun ediff-merge-files-with-ancestor (file-A file-B file-ancestor
1003 ;; MERGE-BUFFER-FILE is the file
1004 ;; to be associated with the
1007 "Merge two files with ancestor."
1009 (let ((dir-A (if ediff-use-last-dir
1012 dir-B dir-ancestor f ff)
1013 (list (setq f (ediff-read-file-name
1014 "File A to merge" dir-A
1015 (ediff-get-default-file-name)))
1016 (setq ff (ediff-read-file-name "File B to merge"
1018 (if ediff-use-last-dir
1020 (file-name-directory f)))
1022 (setq file-name-history
1024 (ediff-abbreviate-file-name
1026 (file-name-nondirectory f)
1030 (ediff-read-file-name "Ancestor file"
1032 (if ediff-use-last-dir
1033 ediff-last-dir-ancestor
1034 (file-name-directory ff)))
1036 (setq file-name-history
1037 (cons (ediff-abbreviate-file-name
1039 (file-name-nondirectory ff)
1044 (setq startup-hooks (cons 'ediff-merge-on-startup startup-hooks))
1045 (ediff-files-internal file-A
1046 (if (file-directory-p file-B)
1048 (file-name-nondirectory file-A) file-B)
1052 'ediff-merge-files-with-ancestor
1056 (defalias 'ediff-merge-with-ancestor 'ediff-merge-files-with-ancestor)
1059 (defun ediff-merge-buffers (buffer-A buffer-B
1061 ;; MERGE-BUFFER-FILE is the file to be
1062 ;; associated with the merge buffer
1063 startup-hooks job-name merge-buffer-file)
1064 "Merge buffers without ancestor."
1067 (list (setq bf (read-buffer "Buffer A to merge: "
1068 (ediff-other-buffer "") t))
1069 (read-buffer "Buffer B to merge: "
1071 ;; realign buffers so that two visible bufs will be
1073 (save-window-excursion (other-window 1))
1074 (ediff-other-buffer bf))
1077 (setq startup-hooks (cons 'ediff-merge-on-startup startup-hooks))
1078 (or job-name (setq job-name 'ediff-merge-buffers))
1079 (ediff-buffers-internal
1080 buffer-A buffer-B nil startup-hooks job-name merge-buffer-file))
1083 (defun ediff-merge-buffers-with-ancestor (buffer-A buffer-B buffer-ancestor
1087 ;; MERGE-BUFFER-FILE is the
1088 ;; file to be associated
1089 ;; with the merge buffer
1091 "Merge buffers with ancestor."
1094 (list (setq bf (read-buffer "Buffer A to merge: "
1095 (ediff-other-buffer "") t))
1096 (setq bff (read-buffer "Buffer B to merge: "
1098 ;; realign buffers so that two visible
1099 ;; bufs will be at the top
1100 (save-window-excursion (other-window 1))
1101 (ediff-other-buffer bf))
1103 (read-buffer "Ancestor buffer: "
1105 ;; realign buffers so that three visible
1106 ;; bufs will be at the top
1107 (save-window-excursion (other-window 1))
1108 (ediff-other-buffer (list bf bff)))
1112 (setq startup-hooks (cons 'ediff-merge-on-startup startup-hooks))
1113 (or job-name (setq job-name 'ediff-merge-buffers-with-ancestor))
1114 (ediff-buffers-internal
1115 buffer-A buffer-B buffer-ancestor startup-hooks job-name merge-buffer-file))
1119 (defun ediff-merge-revisions (&optional file startup-hooks merge-buffer-file)
1120 ;; MERGE-BUFFER-FILE is the file to be associated with the merge buffer
1121 "Run Ediff by merging two revisions of a file.
1122 The file is the optional FILE argument or the file visited by the current
1125 (if (stringp file) (find-file file))
1130 "Version 1 to merge (default: %s's latest version): "
1132 (file-name-nondirectory file) "current buffer")))
1136 "Version 2 to merge (default: %s): "
1138 (file-name-nondirectory file) "current buffer"))))
1139 (ediff-load-version-control)
1140 ;; ancestor-revision=nil
1142 (intern (format "ediff-%S-merge-internal" ediff-version-control-package))
1143 rev1 rev2 nil startup-hooks merge-buffer-file)))
1147 (defun ediff-merge-revisions-with-ancestor (&optional
1149 ;; MERGE-BUFFER-FILE is the file to
1150 ;; be associated with the merge
1153 "Run Ediff by merging two revisions of a file with a common ancestor.
1154 The file is the the optional FILE argument or the file visited by the current
1157 (if (stringp file) (find-file file))
1158 (let (rev1 rev2 ancestor-rev)
1162 "Version 1 to merge (default: %s's latest version): "
1164 (file-name-nondirectory file) "current buffer")))
1168 "Version 2 to merge (default: %s): "
1170 (file-name-nondirectory file) "current buffer")))
1174 "Ancestor version (default: %s): "
1176 (file-name-nondirectory file) "current buffer"))))
1177 (ediff-load-version-control)
1179 (intern (format "ediff-%S-merge-internal" ediff-version-control-package))
1180 rev1 rev2 ancestor-rev startup-hooks merge-buffer-file)))
1183 (defun run-ediff-from-cvs-buffer (pos)
1184 "Run Ediff-merge on appropriate revisions of the selected file.
1185 First run after `M-x cvs-update'. Then place the cursor on a line describing a
1186 file and then run `run-ediff-from-cvs-buffer'."
1188 (ediff-load-version-control)
1189 (let ((tin (tin-locate cvs-cookie-handle pos)))
1191 (cvs-run-ediff-on-file-descriptor tin)
1192 (error "There is no file to merge"))))
1198 (defun ediff-patch-file ()
1199 "Run Ediff by patching SOURCE-FILENAME."
1200 ;; This now returns the control buffer
1202 (let (source-dir source-file patch-buf)
1203 (require 'ediff-ptch)
1204 (setq patch-buf (ediff-get-patch-buffer))
1205 (setq source-dir (cond (ediff-use-last-dir ediff-last-dir-patch)
1206 ((and (not ediff-patch-default-directory)
1207 (buffer-file-name patch-buf))
1208 (file-name-directory
1210 (buffer-file-name patch-buf))))
1211 (t default-directory)))
1213 ;; the default is the directory, not the visited file name
1214 (ediff-read-file-name
1215 "Which file to patch? " source-dir (ediff-get-default-file-name)))
1216 (ediff-dispatch-file-patching-job patch-buf source-file)))
1219 (defun ediff-patch-buffer ()
1220 "Run Ediff by patching BUFFER-NAME."
1223 (require 'ediff-ptch)
1224 (setq patch-buf (ediff-get-patch-buffer))
1225 (ediff-patch-buffer-internal
1227 (read-buffer "Which buffer to patch? "
1228 (cond ((eq patch-buf (current-buffer))
1229 (ediff-other-buffer (current-buffer)))
1230 (t (current-buffer)))
1234 (defalias 'epatch 'ediff-patch-file)
1236 (defalias 'epatch-buffer 'ediff-patch-buffer)
1241 ;;; Versions Control functions
1244 (defun ediff-revision (&optional file startup-hooks)
1245 "Run Ediff by comparing versions of a file.
1246 The file is an optional FILE argument or the file visited by the current
1247 buffer. Use `vc.el' or `rcs.el' depending on `ediff-version-control-package'."
1248 ;; if buffer is non-nil, use that buffer instead of the current buffer
1250 (if (stringp file) (find-file file))
1254 (format "Version 1 to compare (default: %s's latest version): "
1256 (file-name-nondirectory file) "current buffer")))
1259 (format "Version 2 to compare (default: %s): "
1261 (file-name-nondirectory file) "current buffer"))))
1262 (ediff-load-version-control)
1264 (intern (format "ediff-%S-internal" ediff-version-control-package))
1265 rev1 rev2 startup-hooks)
1270 (defalias 'erevision 'ediff-revision)
1273 ;; Test if version control package is loaded and load if not
1274 ;; Is SILENT is non-nil, don't report error if package is not found.
1275 (defun ediff-load-version-control (&optional silent)
1276 (require 'ediff-vers)
1277 (or (featurep ediff-version-control-package)
1278 (if (locate-library (symbol-name ediff-version-control-package))
1280 (message "") ; kill the message from `locate-library'
1281 (require ediff-version-control-package))
1283 (error "Version control package %S.el not found. Use vc.el instead"
1284 ediff-version-control-package)))))
1288 (defun ediff-version ()
1289 "Return string describing the version of Ediff.
1290 When called interactively, displays the version."
1293 (message (ediff-version))
1294 (format "Ediff %s of %s" ediff-version ediff-date)))
1298 (defun ediff-documentation (&optional node)
1299 "Display Ediff's manual.
1300 With optional NODE, goes to that node."
1302 (let ((ctl-window ediff-control-window)
1303 (ctl-buf ediff-control-buffer))
1305 (ediff-skip-unsuitable-frames)
1308 (pop-to-buffer (get-buffer-create "*info*"))
1309 (info (if ediff-xemacs-p "ediff.info" "ediff"))
1311 (Info-goto-node node)
1312 (message "Type `i' to search for a specific topic"))
1313 (raise-frame (selected-frame)))
1315 (with-output-to-temp-buffer ediff-msg-buffer
1316 (princ ediff-BAD-INFO))
1317 (if (window-live-p ctl-window)
1319 (select-window ctl-window)
1320 (set-window-buffer ctl-window ctl-buf)))))))
1325 ;;; Local Variables:
1326 ;;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
1327 ;;; eval: (put 'ediff-with-current-buffer 'lisp-indent-hook 1)
1328 ;;; eval: (put 'ediff-with-current-buffer 'edebug-form-spec '(form body))
1331 (require 'ediff-util)
1333 ;;; ediff.el ends here