1 ;;; ediff.el --- a comprehensive visual interface to diff & patch
3 ;; Copyright (C) 1994, 1995, 1996 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.63" "The current version of Ediff")
10 (defconst ediff-date
"September 12, 1996" "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.
109 (require 'ediff-init
)
110 ;; ediff-mult is always required, because of the registry stuff
111 (require 'ediff-mult
)
115 (let ((load-path (cons (expand-file-name ".") load-path
)))
116 (load-library "dired")
117 (load-file "ediff-ptch.el")
118 (load-file "ediff-vers.el")
119 (load "pcl-cvs" 'noerror
))))
121 (defvar ediff-use-last-dir nil
122 "*If t, Ediff uses previous directory as default when reading file name.")
124 (defvar ediff-last-dir-A nil
125 "Last directory used by an Ediff command for file-A.")
126 (defvar ediff-last-dir-B nil
127 "Last directory used by an Ediff command for file-B.")
128 (defvar ediff-last-dir-C nil
129 "Last directory used by an Ediff command for file-C.")
130 (defvar ediff-last-dir-ancestor nil
131 "Last directory used by an Ediff command for the ancestor file.")
132 (defvar ediff-last-merge-autostore-dir
133 "Last directory used by an Ediff command as the output directory for merge.")
135 ;; Some defvars to reduce the number of compiler warnings
136 (defvar cvs-cookie-handle
)
137 (defvar ediff-last-dir-patch
)
138 (defvar ediff-patch-default-directory
)
139 ;; end of compiler pacifier
142 ;; Used as a startup hook to set `_orig' patch file read-only.
143 (defun ediff-set-read-only-in-buf-A ()
144 (ediff-eval-in-buffer ediff-buffer-A
145 (toggle-read-only 1)))
147 ;; Return a plausible default for ediff's first file:
148 ;; In dired, return the file name under the point, unless it is a directory
149 ;; If the buffer has a file name, return that file name.
150 (defun ediff-get-default-file-name ()
151 (cond ((eq major-mode
'dired-mode
)
152 (let ((f (dired-get-filename nil
'no-error
)))
153 (if (and (stringp f
) (not (file-directory-p f
)))
155 ((buffer-file-name (current-buffer))
156 (file-name-nondirectory (buffer-file-name (current-buffer))))
159 ;;; Compare files/buffers
162 (defun ediff-files (file-A file-B
&optional startup-hooks
)
163 "Run Ediff on a pair of files, FILE-A and FILE-B."
165 (let ((dir-A (if ediff-use-last-dir
169 (list (setq f
(ediff-read-file-name
170 "File A to compare" dir-A
171 (ediff-get-default-file-name)))
172 (ediff-read-file-name "File B to compare"
174 (if ediff-use-last-dir
176 (file-name-directory f
)))
178 (setq file-name-history
179 (cons (ediff-abbreviate-file-name
181 (file-name-nondirectory f
)
186 (ediff-files-internal file-A
187 (if (file-directory-p file-B
)
189 (file-name-nondirectory file-A
) file-B
)
196 (defun ediff-files3 (file-A file-B file-C
&optional startup-hooks
)
197 "Run Ediff on three files, FILE-A, FILE-B, and FILE-C."
199 (let ((dir-A (if ediff-use-last-dir
203 (list (setq f
(ediff-read-file-name
204 "File A to compare" dir-A
205 (ediff-get-default-file-name)))
206 (setq ff
(ediff-read-file-name "File B to compare"
208 (if ediff-use-last-dir
210 (file-name-directory f
)))
212 (setq file-name-history
214 (ediff-abbreviate-file-name
216 (file-name-nondirectory f
)
220 (ediff-read-file-name "File C to compare"
221 (setq dir-C
(if ediff-use-last-dir
223 (file-name-directory ff
)))
225 (setq file-name-history
226 (cons (ediff-abbreviate-file-name
228 (file-name-nondirectory ff
)
233 (ediff-files-internal file-A
234 (if (file-directory-p file-B
)
236 (file-name-nondirectory file-A
) file-B
)
238 (if (file-directory-p file-C
)
240 (file-name-nondirectory file-A
) file-C
)
246 (defalias 'ediff3
'ediff-files3
)
249 ;; Visit FILE and arrange its buffer to Ediff's liking.
250 ;; FILE is actually a variable symbol that must contain a true file name.
251 ;; BUFFER-NAME is a variable symbol, which will get the buffer object into
252 ;; which FILE is read.
253 ;; LAST-DIR is the directory variable symbol where FILE's
254 ;; directory name should be returned. HOOKS-VAR is a variable symbol that will
255 ;; be assigned the hook to be executed after `ediff-startup' is finished.
256 ;; `ediff-find-file' arranges that the temp files it might create will be
258 (defun ediff-find-file (file-var buffer-name
&optional last-dir hooks-var
)
259 (let* ((file (symbol-value file-var
))
260 (file-magic (find-file-name-handler file
'find-file-noselect
))
261 (temp-file-name-prefix (file-name-nondirectory file
)))
262 (cond ((not (file-readable-p file
))
263 (error "File `%s' does not exist or is not readable" file
))
264 ((file-directory-p file
)
265 (error "File `%s' is a directory" file
)))
267 ;; some of the commands, below, require full file name
268 (setq file
(expand-file-name file
))
270 ;; Record the directory of the file
272 (set last-dir
(expand-file-name (file-name-directory file
))))
275 (set buffer-name
(find-file-noselect file
))
277 (ediff-eval-in-buffer (symbol-value buffer-name
)
278 (widen) ; Make sure the entire file is seen
279 (cond (file-magic ;; file has handler, such as jka-compr-handler or
280 ;; ange-ftp-hook-function--arrange for temp file
281 (ediff-verify-file-buffer 'magic
)
283 (ediff-make-temp-file
284 (current-buffer) temp-file-name-prefix
))
285 (set hooks-var
(cons (` (lambda () (delete-file (, file
))))
286 (symbol-value hooks-var
))))
287 ;; file processed via auto-mode-alist, a la uncompress.el
288 ((not (equal (file-truename file
)
289 (file-truename (buffer-file-name))))
291 (ediff-make-temp-file
292 (current-buffer) temp-file-name-prefix
))
293 (set hooks-var
(cons (` (lambda () (delete-file (, file
))))
294 (symbol-value hooks-var
))))
295 (t ;; plain file---just check that the file matches the buffer
296 (ediff-verify-file-buffer))))
297 (set file-var file
)))
299 (defun ediff-files-internal (file-A file-B file-C startup-hooks job-name
)
300 (let (buf-A buf-B buf-C
)
301 (message "Reading file %s ... " file-A
)
303 (ediff-find-file 'file-A
'buf-A
'ediff-last-dir-A
'startup-hooks
)
304 (message "Reading file %s ... " file-B
)
306 (ediff-find-file 'file-B
'buf-B
'ediff-last-dir-B
'startup-hooks
)
309 (message "Reading file %s ... " file-C
)
313 (if (eq job-name
'ediff-merge-files-with-ancestor
)
314 'ediff-last-dir-ancestor
'ediff-last-dir-C
)
316 (ediff-setup buf-A file-A
320 (list (cons 'ediff-job-name job-name
)))))
324 (defalias 'ediff
'ediff-files
)
328 (defun ediff-buffers (buffer-A buffer-B
&optional startup-hooks job-name
)
329 "Run Ediff on a pair of buffers, BUFFER-A and BUFFER-B."
332 (list (setq bf
(read-buffer "Buffer A to compare: "
333 (ediff-other-buffer "") t
))
334 (read-buffer "Buffer B to compare: "
336 ;; realign buffers so that two visible bufs will be
338 (save-window-excursion (other-window 1))
339 (ediff-other-buffer bf
))
341 (or job-name
(setq job-name
'ediff-buffers
))
342 (ediff-buffers-internal buffer-A buffer-B nil startup-hooks job-name
))
345 (defalias 'ebuffers
'ediff-buffers
)
349 (defun ediff-buffers3 (buffer-A buffer-B buffer-C
350 &optional startup-hooks job-name
)
351 "Run Ediff on three buffers, BUFFER-A, BUFFER-B, and BUFFER-C."
354 (list (setq bf
(read-buffer "Buffer A to compare: "
355 (ediff-other-buffer "") t
))
356 (setq bff
(read-buffer "Buffer B to compare: "
358 ;; realign buffers so that two visible
359 ;; bufs will be at the top
360 (save-window-excursion (other-window 1))
361 (ediff-other-buffer bf
))
363 (read-buffer "Buffer C to compare: "
365 ;; realign buffers so that three visible
366 ;; bufs will be at the top
367 (save-window-excursion (other-window 1))
368 (ediff-other-buffer (list bf bff
)))
371 (or job-name
(setq job-name
'ediff-buffers3
))
372 (ediff-buffers-internal buffer-A buffer-B buffer-C startup-hooks job-name
))
375 (defalias 'ebuffers3
'ediff-buffers3
)
379 (defun ediff-buffers-internal (buf-A buf-B buf-C startup-hooks job-name
)
380 (let* ((buf-A-file-name (buffer-file-name (get-buffer buf-A
)))
381 (buf-B-file-name (buffer-file-name (get-buffer buf-B
)))
382 (buf-C-is-alive (ediff-buffer-live-p buf-C
))
383 (buf-C-file-name (if buf-C-is-alive
384 (buffer-file-name (get-buffer buf-B
))))
385 file-A file-B file-C
)
386 (if (not (ediff-buffer-live-p buf-A
))
387 (error "Buffer %S doesn't exist" buf-A
))
388 (if (not (ediff-buffer-live-p buf-B
))
389 (error "Buffer %S doesn't exist" buf-B
))
390 (let ((ediff-job-name job-name
))
391 (if (and ediff-3way-comparison-job
392 (not buf-C-is-alive
))
393 (error "Buffer %S doesn't exist" buf-C
)))
394 (if (stringp buf-A-file-name
)
395 (setq buf-A-file-name
(file-name-nondirectory buf-A-file-name
)))
396 (if (stringp buf-B-file-name
)
397 (setq buf-B-file-name
(file-name-nondirectory buf-B-file-name
)))
398 (if (stringp buf-C-file-name
)
399 (setq buf-C-file-name
(file-name-nondirectory buf-C-file-name
)))
401 (setq file-A
(ediff-make-temp-file buf-A buf-A-file-name
)
402 file-B
(ediff-make-temp-file buf-B buf-B-file-name
))
404 (setq file-C
(ediff-make-temp-file buf-C buf-C-file-name
)))
406 (ediff-setup (get-buffer buf-A
) file-A
407 (get-buffer buf-B
) file-B
408 (if buf-C-is-alive
(get-buffer buf-C
))
411 (delete-file (, file-A
))
412 (delete-file (, file-B
))
413 (if (stringp (, file-C
)) (delete-file (, file-C
)))
416 (list (cons 'ediff-job-name job-name
))
420 ;;; Directory and file group operations
422 ;; Get appropriate default name for directory:
423 ;; If ediff-use-last-dir, use ediff-last-dir-A.
424 ;; In dired mode, use the directory that is under the point (if any);
425 ;; otherwise, use default-directory
426 (defun ediff-get-default-directory-name ()
427 (cond (ediff-use-last-dir ediff-last-dir-A
)
428 ((eq major-mode
'dired-mode
)
429 (let ((f (dired-get-filename nil
'noerror
)))
430 (if (and (stringp f
) (file-directory-p f
))
433 (t default-directory
)))
437 (defun ediff-directories (dir1 dir2 regexp
)
438 "Run Ediff on a pair of directories, DIR1 and DIR2, comparing files that have
439 the same name in both. The third argument, REGEXP, is a regular expression that
440 can be used to filter out certain file names."
442 (let ((dir-A (ediff-get-default-directory-name))
444 (list (setq f
(ediff-read-file-name "Directory A to compare:" dir-A nil
))
445 (ediff-read-file-name "Directory B to compare:"
446 (if ediff-use-last-dir
448 (ediff-strip-last-dir f
))
450 (read-string "Filter through regular expression: "
451 nil
'ediff-filtering-regexp-history
)
453 (ediff-directories-internal
454 dir1 dir2 nil regexp
'ediff-files
'ediff-directories
458 (defalias 'edirs
'ediff-directories
)
462 (defun ediff-directory-revisions (dir1 regexp
)
463 "Run Ediff on a directory, DIR1, comparing its files with their revisions.
464 The second argument, REGEXP, is a regular expression that filters the file
465 names. Only the files that are under revision control are taken into account."
467 (let ((dir-A (ediff-get-default-directory-name)))
468 (list (ediff-read-file-name
469 "Directory to compare with revision:" dir-A nil
)
470 (read-string "Filter through regular expression: "
471 nil
'ediff-filtering-regexp-history
)
473 (ediff-directory-revisions-internal
474 dir1 regexp
'ediff-revision
'ediff-directory-revisions
478 (defalias 'edir-revisions
'ediff-directory-revisions
)
482 (defun ediff-directories3 (dir1 dir2 dir3 regexp
)
483 "Run Ediff on three directories, DIR1, DIR2, and DIR3, comparing files that
484 have the same name in all three. The last argument, REGEXP, is a regular
485 expression that can be used to filter out certain file names."
487 (let ((dir-A (ediff-get-default-directory-name))
489 (list (setq f
(ediff-read-file-name "Directory A to compare:" dir-A nil
))
490 (setq f
(ediff-read-file-name "Directory B to compare:"
491 (if ediff-use-last-dir
493 (ediff-strip-last-dir f
))
495 (ediff-read-file-name "Directory C to compare:"
496 (if ediff-use-last-dir
498 (ediff-strip-last-dir f
))
500 (read-string "Filter through regular expression: "
501 nil
'ediff-filtering-regexp-history
)
503 (ediff-directories-internal
504 dir1 dir2 dir3 regexp
'ediff-files3
'ediff-directories3
508 (defalias 'edirs3
'ediff-directories3
)
511 (defun ediff-merge-directories (dir1 dir2 regexp
)
512 "Run Ediff on a pair of directories, DIR1 and DIR2, merging files that have
513 the same name in both. The third argument, REGEXP, is a regular expression that
514 can be used to filter out certain file names."
516 (let ((dir-A (ediff-get-default-directory-name))
518 (list (setq f
(ediff-read-file-name "Directory A to merge:" dir-A nil
))
519 (ediff-read-file-name "Directory B to merge:"
520 (if ediff-use-last-dir
522 (ediff-strip-last-dir f
))
524 (read-string "Filter through regular expression: "
525 nil
'ediff-filtering-regexp-history
)
527 (ediff-directories-internal
528 dir1 dir2 nil regexp
'ediff-merge-files
'ediff-merge-directories
532 (defalias 'edirs-merge
'ediff-merge-directories
)
535 (defun ediff-merge-directories-with-ancestor (dir1 dir2 ancestor-dir regexp
)
536 "Merge files in directories DIR1 and DIR2 using files in ANCESTOR-DIR as ancestors.
537 Ediff merges files that have identical names in DIR1, DIR2. If a pair of files
538 in DIR1 and DIR2 doesn't have an ancestor in ANCESTOR-DIR, Ediff will merge
539 without ancestor. The fourth argument, REGEXP, is a regular expression that
540 can be used to filter out certain file names."
542 (let ((dir-A (ediff-get-default-directory-name))
544 (list (setq f
(ediff-read-file-name "Directory A to merge:" dir-A nil
))
545 (setq f
(ediff-read-file-name "Directory B to merge:"
546 (if ediff-use-last-dir
548 (ediff-strip-last-dir f
))
550 (ediff-read-file-name "Ancestor directory:"
551 (if ediff-use-last-dir
553 (ediff-strip-last-dir f
))
555 (read-string "Filter through regular expression: "
556 nil
'ediff-filtering-regexp-history
)
558 (ediff-directories-internal
559 dir1 dir2 ancestor-dir regexp
560 'ediff-merge-files-with-ancestor
'ediff-merge-directories-with-ancestor
564 (defun ediff-merge-directory-revisions (dir1 regexp
)
565 "Run Ediff on a directory, DIR1, merging its files with their revisions.
566 The second argument, REGEXP, is a regular expression that filters the file
567 names. Only the files that are under revision control are taken into account."
569 (let ((dir-A (ediff-get-default-directory-name)))
570 (list (ediff-read-file-name
571 "Directory to merge with revisions:" dir-A nil
)
572 (read-string "Filter through regular expression: "
573 nil
'ediff-filtering-regexp-history
)
575 (ediff-directory-revisions-internal
576 dir1 regexp
'ediff-merge-revisions
'ediff-merge-directory-revisions
580 (defalias 'edir-merge-revisions
'ediff-merge-directory-revisions
)
583 (defun ediff-merge-directory-revisions-with-ancestor (dir1 regexp
)
584 "Run Ediff on a directory, DIR1, merging its files with their revisions and ancestors.
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 and ancestors:" 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-with-ancestor
596 'ediff-merge-directory-revisions-with-ancestor
601 'edir-merge-revisions-with-ancestor
602 'ediff-merge-directory-revisions-with-ancestor
)
605 (defalias 'edirs-merge-with-ancestor
'ediff-merge-directories-with-ancestor
)
607 ;; Run ediff-action (ediff-files, ediff-merge, ediff-merge-with-ancestors)
608 ;; on a pair of directories (three directories, in case of ancestor).
609 ;; The third argument, REGEXP, is a regular expression that can be used to
610 ;; filter out certain file names.
611 ;; JOBNAME is the symbol indicating the meta-job to be performed.
612 ;; MERGE-DIR is the directory in which to store merged files.
613 (defun ediff-directories-internal (dir1 dir2 dir3 regexp action jobname
614 &optional startup-hooks
)
615 ;; ediff-read-file-name is set to attach a previously entered file name if
616 ;; the currently entered file is a directory. This code takes care of that.
617 (setq dir1
(if (file-directory-p dir1
) dir1
(file-name-directory dir1
))
618 dir2
(if (file-directory-p dir2
) dir2
(file-name-directory dir2
)))
621 (setq dir3
(if (file-directory-p dir3
) dir3
(file-name-directory dir3
))))
623 (cond ((string= dir1 dir2
)
624 (error "Directories A and B are the same: %s" dir1
))
625 ((and (eq jobname
'ediff-directories3
)
627 (error "Directories A and C are the same: %s" dir1
))
628 ((and (eq jobname
'ediff-directories3
)
630 (error "Directories B and C are the same: %s" dir1
)))
632 (let (diffs ; var where ediff-intersect-directories returns the diff list
635 (if (and ediff-autostore-merges
(ediff-merge-metajob jobname
))
636 (setq merge-autostore-dir
637 (ediff-read-file-name "Directory to save merged files:"
638 (if ediff-use-last-dir
639 ediff-last-merge-autostore-dir
640 (ediff-strip-last-dir dir1
))
642 ;; verify we are not merging into an orig directory
643 (if (stringp merge-autostore-dir
)
644 (cond ((and (stringp dir1
) (string= merge-autostore-dir dir1
))
645 (or (y-or-n-p "Merge directory same as directory A, sure? ")
646 (error "Directory merge aborted")))
647 ((and (stringp dir2
) (string= merge-autostore-dir dir2
))
648 (or (y-or-n-p "Merge directory same as directory B, sure? ")
649 (error "Directory merge aborted")))
650 ((and (stringp dir3
) (string= merge-autostore-dir dir3
))
652 "Merge directory same as ancestor directory, sure? ")
653 (error "Directory merge aborted")))))
655 (setq file-list
(ediff-intersect-directories
657 regexp dir1 dir2 dir3 merge-autostore-dir
))
659 ;; this sets various vars in the meta buffer inside
660 ;; ediff-prepare-meta-buffer
662 ;; tell what to do if the user clicks on a session record
663 (setq ediff-session-action-function
(quote (, action
)))
664 ;; set ediff-dir-difference-list
665 (setq ediff-dir-difference-list
(quote (, diffs
)))))
667 (setq meta-buf
(ediff-prepare-meta-buffer
668 'ediff-filegroup-action
670 "*Ediff Session Group Panel"
671 'ediff-redraw-directory-group-buffer
674 (ediff-show-meta-buffer meta-buf
)
677 (defun ediff-directory-revisions-internal (dir1 regexp action jobname
678 &optional startup-hooks
)
679 (setq dir1
(if (file-directory-p dir1
) dir1
(file-name-directory dir1
)))
681 (let (file-list meta-buf merge-autostore-dir
)
682 (if (and ediff-autostore-merges
(ediff-merge-metajob jobname
))
683 (setq merge-autostore-dir
684 (ediff-read-file-name "Directory to save merged files:"
685 (if ediff-use-last-dir
686 ediff-last-merge-autostore-dir
687 (ediff-strip-last-dir dir1
))
689 ;; verify merge-autostore-dir != dir1
690 (if (and (stringp merge-autostore-dir
)
692 (string= merge-autostore-dir dir1
))
694 "Directory for saving merges is the same as directory A. Sure? ")
695 (error "Merge of directory revisions aborted")))
698 (ediff-get-directory-files-under-revision
699 jobname regexp dir1 merge-autostore-dir
))
701 ;; this sets various vars in the meta buffer inside
702 ;; ediff-prepare-meta-buffer
704 ;; tell what to do if the user clicks on a session record
705 (setq ediff-session-action-function
(quote (, action
)))
708 (setq meta-buf
(ediff-prepare-meta-buffer
709 'ediff-filegroup-action
711 "*Ediff Session Group Panel"
712 'ediff-redraw-directory-group-buffer
715 (ediff-show-meta-buffer meta-buf
)
719 ;;; Compare regions and windows
722 (defun ediff-windows-wordwise (dumb-mode &optional wind-A wind-B startup-hooks
)
723 "Compare WIND-A and WIND-B, which are selected by clicking, wordwise.
724 With prefix argument, DUMB-MODE, or on a non-windowing display, works as
726 If WIND-A is nil, use selected window.
727 If WIND-B is nil, use window next to WIND-A."
729 (ediff-windows dumb-mode wind-A wind-B
730 startup-hooks
'ediff-windows-wordwise
'word-mode
))
733 (defun ediff-windows-linewise (dumb-mode &optional wind-A wind-B startup-hooks
)
734 "Compare WIND-A and WIND-B, which are selected by clicking, linewise.
735 With prefix argument, DUMB-MODE, or on a non-windowing display, works as
737 If WIND-A is nil, use selected window.
738 If WIND-B is nil, use window next to WIND-A."
740 (ediff-windows dumb-mode wind-A wind-B
741 startup-hooks
'ediff-windows-linewise nil
))
743 ;; Compare WIND-A and WIND-B, which are selected by clicking.
744 ;; With prefix argument, DUMB-MODE, or on a non-windowing display,
746 ;; If WIND-A is nil, use selected window.
747 ;; If WIND-B is nil, use window next to WIND-A.
748 (defun ediff-windows (dumb-mode wind-A wind-B startup-hooks job-name word-mode
)
749 (if (or dumb-mode
(not (ediff-window-display-p)))
750 (setq wind-A
(ediff-get-next-window wind-A nil
)
751 wind-B
(ediff-get-next-window wind-B wind-A
))
752 (setq wind-A
(ediff-get-window-by-clicking wind-A nil
1)
753 wind-B
(ediff-get-window-by-clicking wind-B wind-A
2)))
755 (let ((buffer-A (window-buffer wind-A
))
756 (buffer-B (window-buffer wind-B
))
757 beg-A end-A beg-B end-B
)
760 (save-window-excursion
761 (sit-for 0) ; sync before using window-start/end -- a precaution
762 (select-window wind-A
)
763 (setq beg-A
(window-start)
765 (select-window wind-B
)
766 (setq beg-B
(window-start)
767 end-B
(window-end))))
768 (ediff-regions-internal
769 buffer-A beg-A end-A buffer-B beg-B end-B
770 startup-hooks job-name word-mode
)))
773 (defun ediff-regions-wordwise (buffer-A buffer-B
&optional startup-hooks
)
774 "Run Ediff on a pair of regions in two different buffers.
775 Regions \(i.e., point and mark\) are assumed to be set in advance.
776 This function is effective only for relatively small regions, up to 200
777 lines. For large regions, use `ediff-regions-linewise'."
780 (list (setq bf
(read-buffer "Region's A buffer: "
781 (ediff-other-buffer "") t
))
782 (read-buffer "Region's B buffer: "
784 ;; realign buffers so that two visible bufs will be
786 (save-window-excursion (other-window 1))
787 (ediff-other-buffer bf
))
789 (if (not (ediff-buffer-live-p buffer-A
))
790 (error "Buffer %S doesn't exist" buffer-A
))
791 (if (not (ediff-buffer-live-p buffer-B
))
792 (error "Buffer %S doesn't exist" buffer-B
))
795 (let (reg-A-beg reg-A-end reg-B-beg reg-B-end
)
797 (set-buffer buffer-A
)
798 (setq reg-A-beg
(region-beginning)
799 reg-A-end
(region-end))
800 (set-buffer buffer-B
)
801 (setq reg-B-beg
(region-beginning)
802 reg-B-end
(region-end)))
804 (ediff-regions-internal
805 (get-buffer buffer-A
) reg-A-beg reg-A-end
806 (get-buffer buffer-B
) reg-B-beg reg-B-end
807 startup-hooks
'ediff-regions-wordwise
'word-mode
)))
810 (defun ediff-regions-linewise (buffer-A buffer-B
&optional startup-hooks
)
811 "Run Ediff on a pair of regions in two different buffers.
812 Regions \(i.e., point and mark\) are assumed to be set in advance.
813 Each region is enlarged to contain full lines.
814 This function is effective for large regions, over 100-200
815 lines. For small regions, use `ediff-regions-wordwise'."
818 (list (setq bf
(read-buffer "Region A's buffer: "
819 (ediff-other-buffer "") t
))
820 (read-buffer "Region B's buffer: "
822 ;; realign buffers so that two visible bufs will be
824 (save-window-excursion (other-window 1))
825 (ediff-other-buffer bf
))
827 (if (not (ediff-buffer-live-p buffer-A
))
828 (error "Buffer %S doesn't exist" buffer-A
))
829 (if (not (ediff-buffer-live-p buffer-B
))
830 (error "Buffer %S doesn't exist" buffer-B
))
832 (let (reg-A-beg reg-A-end reg-B-beg reg-B-end
)
834 (set-buffer buffer-A
)
835 (setq reg-A-beg
(region-beginning)
836 reg-A-end
(region-end))
837 ;; enlarge the region to hold full lines
838 (goto-char reg-A-beg
)
840 (setq reg-A-beg
(point))
841 (goto-char reg-A-end
)
843 (or (eobp) (forward-char)) ; include the newline char
844 (setq reg-A-end
(point))
846 (set-buffer buffer-B
)
847 (setq reg-B-beg
(region-beginning)
848 reg-B-end
(region-end))
849 ;; enlarge the region to hold full lines
850 (goto-char reg-B-beg
)
852 (setq reg-B-beg
(point))
853 (goto-char reg-B-end
)
855 (or (eobp) (forward-char)) ; include the newline char
856 (setq reg-B-end
(point))
859 (ediff-regions-internal
860 (get-buffer buffer-A
) reg-A-beg reg-A-end
861 (get-buffer buffer-B
) reg-B-beg reg-B-end
862 startup-hooks
'ediff-regions-linewise nil
))) ; no word mode
864 ;; compare region beg-A to end-A of buffer-A
865 ;; to regions beg-B -- end-B in buffer-B.
866 (defun ediff-regions-internal (buffer-A beg-A end-A buffer-B beg-B end-B
867 startup-hooks job-name word-mode
)
868 (let ((tmp-buffer (get-buffer-create ediff-tmp-buffer
))
872 ;; in case beg/end-A/B aren't markers--make them into markers
873 (ediff-eval-in-buffer buffer-A
874 (setq beg-A
(move-marker (make-marker) beg-A
)
875 end-A
(move-marker (make-marker) end-A
)))
876 (ediff-eval-in-buffer buffer-B
877 (setq beg-B
(move-marker (make-marker) beg-B
)
878 end-B
(move-marker (make-marker) end-B
)))
880 (if (and (eq buffer-A buffer-B
)
881 (or (and (< beg-A end-B
) (<= beg-B beg-A
)) ; b-B b-A e-B
882 (and (< beg-B end-A
) (<= end-A end-B
)))) ; b-B e-A e-B
884 (with-output-to-temp-buffer ediff-msg-buffer
886 You have requested to compare overlapping regions of the same buffer.
888 In this case, Ediff's highlighting may be confusing---in the same window,
889 you may see highlighted regions that belong to different regions.
891 Continue anyway? (y/n) "))
893 (if (y-or-n-p "Continue anyway? ")
895 (error "%S aborted" job-name
))))
899 (ediff-wordify beg-A end-A buffer-A tmp-buffer
)
900 (ediff-copy-to-buffer beg-A end-A buffer-A tmp-buffer
))
901 (setq file-A
(ediff-make-temp-file tmp-buffer
"regA"))
905 (ediff-wordify beg-B end-B buffer-B tmp-buffer
)
906 (ediff-copy-to-buffer beg-B end-B buffer-B tmp-buffer
))
907 (setq file-B
(ediff-make-temp-file tmp-buffer
"regB"))
909 (setq overl-A
(ediff-make-bullet-proof-overlay beg-A end-A buffer-A
))
910 (setq overl-B
(ediff-make-bullet-proof-overlay beg-B end-B buffer-B
))
911 (ediff-setup buffer-A file-A
913 nil nil
; buffer & file C
915 (delete-file (, file-A
))
916 (delete-file (, file-B
))))
918 (list (cons 'ediff-word-mode word-mode
)
919 (cons 'ediff-narrow-bounds
(list overl-A overl-B
))
920 (cons 'ediff-job-name job-name
))
925 ;;; Merge files and buffers
928 (defalias 'ediff-merge
'ediff-merge-files
)
930 (defsubst ediff-merge-on-startup
()
932 (ediff-eval-in-buffer ediff-buffer-C
933 (set-buffer-modified-p nil
)))
936 (defun ediff-merge-files (file-A file-B
&optional startup-hooks
)
937 "Merge two files without ancestor."
939 (let ((dir-A (if ediff-use-last-dir
943 (list (setq f
(ediff-read-file-name
944 "File A to merge" dir-A
945 (ediff-get-default-file-name)))
946 (ediff-read-file-name "File B to merge"
948 (if ediff-use-last-dir
950 (file-name-directory f
)))
952 (setq file-name-history
953 (cons (ediff-abbreviate-file-name
955 (file-name-nondirectory f
)
960 (setq startup-hooks
(cons 'ediff-merge-on-startup startup-hooks
))
961 (ediff-files-internal file-A
962 (if (file-directory-p file-B
)
964 (file-name-nondirectory file-A
) file-B
)
971 (defun ediff-merge-files-with-ancestor (file-A file-B file-ancestor
972 &optional startup-hooks
)
973 "Merge two files with ancestor."
975 (let ((dir-A (if ediff-use-last-dir
978 dir-B dir-ancestor f ff
)
979 (list (setq f
(ediff-read-file-name
980 "File A to merge" dir-A
981 (ediff-get-default-file-name)))
982 (setq ff
(ediff-read-file-name "File B to merge"
984 (if ediff-use-last-dir
986 (file-name-directory f
)))
988 (setq file-name-history
990 (ediff-abbreviate-file-name
992 (file-name-nondirectory f
)
996 (ediff-read-file-name "Ancestor file"
998 (if ediff-use-last-dir
999 ediff-last-dir-ancestor
1000 (file-name-directory ff
)))
1002 (setq file-name-history
1003 (cons (ediff-abbreviate-file-name
1005 (file-name-nondirectory ff
)
1010 (setq startup-hooks
(cons 'ediff-merge-on-startup startup-hooks
))
1011 (ediff-files-internal file-A
1012 (if (file-directory-p file-B
)
1014 (file-name-nondirectory file-A
) file-B
)
1018 'ediff-merge-files-with-ancestor
))
1021 (defalias 'ediff-merge-with-ancestor
'ediff-merge-files-with-ancestor
)
1024 (defun ediff-merge-buffers (buffer-A buffer-B
&optional startup-hooks job-name
)
1025 "Merge buffers without ancestor."
1028 (list (setq bf
(read-buffer "Buffer A to merge: "
1029 (ediff-other-buffer "") t
))
1030 (read-buffer "Buffer B to merge: "
1032 ;; realign buffers so that two visible bufs will be
1034 (save-window-excursion (other-window 1))
1035 (ediff-other-buffer bf
))
1038 (setq startup-hooks
(cons 'ediff-merge-on-startup startup-hooks
))
1039 (or job-name
(setq job-name
'ediff-merge-buffers
))
1040 (ediff-buffers-internal
1041 buffer-A buffer-B nil startup-hooks job-name
))
1044 (defun ediff-merge-buffers-with-ancestor (buffer-A
1045 buffer-B buffer-ancestor
1046 &optional startup-hooks job-name
)
1047 "Merge buffers with ancestor."
1050 (list (setq bf
(read-buffer "Buffer A to merge: "
1051 (ediff-other-buffer "") t
))
1052 (setq bff
(read-buffer "Buffer B to merge: "
1054 ;; realign buffers so that two visible
1055 ;; bufs will be at the top
1056 (save-window-excursion (other-window 1))
1057 (ediff-other-buffer bf
))
1059 (read-buffer "Ancestor buffer: "
1061 ;; realign buffers so that three visible
1062 ;; bufs will be at the top
1063 (save-window-excursion (other-window 1))
1064 (ediff-other-buffer (list bf bff
)))
1068 (setq startup-hooks
(cons 'ediff-merge-on-startup startup-hooks
))
1069 (or job-name
(setq job-name
'ediff-merge-buffers-with-ancestor
))
1070 (ediff-buffers-internal
1071 buffer-A buffer-B buffer-ancestor startup-hooks job-name
))
1075 (defun ediff-merge-revisions (&optional file startup-hooks
)
1076 "Run Ediff by merging two revisions of a file.
1077 The file is the optional FILE argument or the file visited by the current
1080 (if (stringp file
) (find-file file
))
1085 "Version 1 to merge (default: %s's latest version): "
1087 (file-name-nondirectory file
) "current buffer")))
1091 "Version 2 to merge (default: %s): "
1093 (file-name-nondirectory file
) "current buffer"))))
1094 (ediff-load-version-control)
1095 ;; ancestor-revision=nil
1097 (intern (format "ediff-%S-merge-internal" ediff-version-control-package
))
1098 rev1 rev2 nil startup-hooks
)))
1102 (defun ediff-merge-revisions-with-ancestor (&optional file startup-hooks
)
1103 "Run Ediff by merging two revisions of a file with a common ancestor.
1104 The file is the the optional FILE argument or the file visited by the current
1107 (if (stringp file
) (find-file file
))
1108 (let (rev1 rev2 ancestor-rev
)
1112 "Version 1 to merge (default: %s's latest version): "
1114 (file-name-nondirectory file
) "current buffer")))
1118 "Version 2 to merge (default: %s): "
1120 (file-name-nondirectory file
) "current buffer")))
1124 "Ancestor version (default: %s): "
1126 (file-name-nondirectory file
) "current buffer"))))
1127 (ediff-load-version-control)
1129 (intern (format "ediff-%S-merge-internal" ediff-version-control-package
))
1130 rev1 rev2 ancestor-rev startup-hooks
)))
1133 (defun run-ediff-from-cvs-buffer (pos)
1134 "Run Ediff-merge on appropriate revisions of the selected file.
1135 First run after `M-x cvs-update'. Then place the cursor on a lide describing a
1136 file and then run `run-ediff-from-cvs-buffer'."
1138 (ediff-load-version-control)
1139 (let ((tin (tin-locate cvs-cookie-handle pos
)))
1141 (cvs-run-ediff-on-file-descriptor tin
)
1142 (error "There is no file to merge"))))
1148 (defun ediff-patch-file ()
1149 "Run Ediff by patching SOURCE-FILENAME."
1150 ;; This now returns the control buffer
1152 (let (source-dir source-file patch-buf
)
1153 (require 'ediff-ptch
)
1154 (setq patch-buf
(ediff-get-patch-buffer))
1155 (setq source-dir
(cond (ediff-use-last-dir ediff-last-dir-patch
)
1156 ((and (not ediff-patch-default-directory
)
1157 (buffer-file-name patch-buf
))
1158 (file-name-directory
1160 (buffer-file-name patch-buf
))))
1161 (t default-directory
)))
1163 ;; the default is the directory, not the visited file name
1164 (ediff-read-file-name "Which file to patch? " source-dir source-dir
))
1165 (ediff-dispatch-file-patching-job patch-buf source-file
)))
1168 (defun ediff-patch-buffer ()
1169 "Run Ediff by patching BUFFER-NAME."
1172 (require 'ediff-ptch
)
1173 (setq patch-buf
(ediff-get-patch-buffer))
1174 (ediff-patch-buffer-internal
1176 (read-buffer "Which buffer to patch? "
1177 (cond ((eq patch-buf
(current-buffer))
1178 (window-buffer (other-window 1)))
1179 (t (current-buffer)))
1183 (defalias 'epatch
'ediff-patch-file
)
1185 (defalias 'epatch-buffer
'ediff-patch-buffer
)
1190 ;;; Versions Control functions
1193 (defun ediff-revision (&optional file startup-hooks
)
1194 "Run Ediff by comparing versions of a file.
1195 The file is an optional FILE argument or the file visited by the current
1196 buffer. Use `vc.el' or `rcs.el' depending on `ediff-version-control-package'."
1197 ;; if buffer is non-nil, use that buffer instead of the current buffer
1199 (if (stringp file
) (find-file file
))
1203 (format "Version 1 to compare (default: %s's latest version): "
1205 (file-name-nondirectory file
) "current buffer")))
1208 (format "Version 2 to compare (default: %s): "
1210 (file-name-nondirectory file
) "current buffer"))))
1211 (ediff-load-version-control)
1213 (intern (format "ediff-%S-internal" ediff-version-control-package
))
1214 rev1 rev2 startup-hooks
)
1218 ;; Test if version control package is loaded and load if not
1219 ;; Is SILENT is non-nil, don't report error if package is not found.
1220 (defun ediff-load-version-control (&optional silent
)
1221 (require 'ediff-vers
)
1222 (or (featurep ediff-version-control-package
)
1223 (if (locate-library (symbol-name ediff-version-control-package
))
1225 (message "") ; kill the message from `locate-library'
1226 (require ediff-version-control-package
))
1228 (error "Version control package %S.el not found. Use vc.el instead"
1229 ediff-version-control-package
)))))
1233 (defun ediff-version ()
1234 "Return string describing the version of Ediff.
1235 When called interactively, displays the version."
1238 (message (ediff-version))
1239 (format "Ediff %s of %s" ediff-version ediff-date
)))
1243 (defun ediff-documentation (&optional node
)
1244 "Display Ediff's manual.
1245 With optional NODE, goes to that node."
1247 (let ((ctl-window ediff-control-window
)
1248 (ctl-buf ediff-control-buffer
))
1250 (ediff-skip-unsuitable-frames)
1253 (pop-to-buffer (get-buffer-create "*info*"))
1254 (info (if ediff-xemacs-p
"ediff.info" "ediff"))
1256 (Info-goto-node node
)
1257 (message "Type `i' to search for a specific topic"))
1258 (raise-frame (selected-frame)))
1260 (with-output-to-temp-buffer ediff-msg-buffer
1261 (princ ediff-BAD-INFO
))
1262 (if (window-live-p ctl-window
)
1264 (select-window ctl-window
)
1265 (set-window-buffer ctl-window ctl-buf
)))))))
1270 ;;; Local Variables:
1271 ;;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
1272 ;;; eval: (put 'ediff-eval-in-buffer 'lisp-indent-hook 1)
1273 ;;; eval: (put 'ediff-eval-in-buffer 'edebug-form-spec '(form body))
1277 (require 'ediff-util
)
1279 ;;; ediff.el ends here