code.delx.au - gnu-emacs/blob - lisp/ediff.el

   1 ;;; ediff.el --- a comprehensive visual interface to diff & patch
   2 ;;; Copyright (C) 1994, 1995 Free Software Foundation, Inc.
   3
   4 ;; Author: Michael Kifer <kifer@cs.sunysb.edu>
   5 ;; Created: February 2, 1994
   6 ;; Keywords: comparing, merging, patching, version control.
   7
   8 (defconst ediff-version "2.47" "The current version of Ediff")
   9 (defconst ediff-date "October 11, 1995" "Date of last update")
  10
  11 ;; This file is part of GNU Emacs.
  12
  13 ;; GNU Emacs is free software; you can redistribute it and/or modify
  14 ;; it under the terms of the GNU General Public License as published by
  15 ;; the Free Software Foundation; either version 2, or (at your option)
  16 ;; any later version.
  17
  18 ;; GNU Emacs is distributed in the hope that it will be useful,
  19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21 ;; GNU General Public License for more details.
  22
  23 ;; You should have received a copy of the GNU General Public License
  24 ;; along with GNU Emacs; see the file COPYING.  If not, write to
  25 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  26
  27 ;;; Commentary:
  28 ;;  ----------
  29
  30 ;; Never read that diff output again!
  31 ;; Apply patch selectively, like a pro!
  32 ;; Merge with ease!
  33
  34 ;; This package provides a convenient way of simultaneous browsing through
  35 ;; the differences between a pair (or a triple) of files or buffers.  The
  36 ;; files being compared, file-A, file-B, and file-C (if applicable) are
  37 ;; shown in separate windows (side by side, one above the another, or in
  38 ;; separate frames), and the differences are highlighted as you step
  39 ;; through them.  You can also copy difference regions from one buffer to
  40 ;; another (and recover old differences if you change your mind).
  41
  42 ;; Ediff also supports merging operations on files and buffers, including
  43 ;; merging using ancestor versions. Both comparison and merging operations can
  44 ;; be performed on directories, i.e., by pairwise comparison of files in those
  45 ;; directories.
  46
  47 ;; In addition, Ediff can apply a patch to a file and then let you step
  48 ;; though both files, the patched and the original one, simultaneously,
  49 ;; difference-by-difference.  You can even apply a patch right out of a
  50 ;; mail buffer, i.e., patches received by mail don't even have to be saved.
  51 ;; Since Ediff lets you copy differences between buffers, you can, in
  52 ;; effect, apply patches selectively (i.e., you can copy a difference
  53 ;; region from file_orig to file, thereby undoing any particular patch that
  54 ;; you don't like).
  55
  56 ;; Ediff is aware of version control, which lets the user compare
  57 ;; files with their older versions. Ediff can also work with remote and
  58 ;; compressed files. Details are given below.
  59
  60 ;; Finally, Ediff supports directory-level comparison and merging operations.
  61 ;; See the on-line manual for details.
  62
  63 ;; This package builds upon the ideas borrowed from emerge.el and several
  64 ;; Ediff's functions are adaptations from emerge.el. Much of the functionality
  65 ;; Ediff provides is also influenced by emerge.el.
  66
  67 ;; The present version of Ediff supersedes Emerge. It provides a superior user
  68 ;; interface and has numerous major features not found in Emerge. In
  69 ;; particular, it can do patching, and 2-way and 3-way file comparison,
  70 ;; merging, and directory operations.
  71
  72
  73
  74 ;;; Bugs:
  75 ;;  -----
  76
  77 ;;  1. The undo command doesn't restore deleted regions well. That is, if
  78 ;;  you delete all characters in a difference region and then invoke
  79 ;;  `undo', the reinstated text will most likely be inserted outside of
  80 ;;  what Ediff thinks is the current difference region. (This problem
  81 ;;  doesn't seem to exist with XEmacs.)
  82 ;;
  83 ;;  If at any point you feel that difference regions are no longer correct,
  84 ;;  you can hit '!' to recompute the differences.
  85
  86 ;;  2. On a monochrome display, the repertoire of faces with which to
  87 ;;  highlight fine differences is limited. By default, Ediff is using
  88 ;;  underlining. However, if the region is already underlied by some other
  89 ;;  overlays, there is no simple way to temporarily remove that residual
  90 ;;  underlining. This problem occurs when a buffer is highlighted with
  91 ;;  hilit19.el or font-lock.el packages. If this residual highlighting gets
  92 ;;  in the way, you can do the following. Both font-lock.el and hilit19.el
  93 ;;  provide commands for unhighlighting buffers. You can either place these
  94 ;;  commands in `ediff-prepare-buffer-hook' (which will unhighlight every
  95 ;;  buffer used by Ediff) or you can execute them interactively, at any time
  96 ;;  and on any buffer.
  97 ;;
  98
  99
 100 ;;; Acknowledgements:
 101
 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.
 106
 107
 108 ;;; Code:
 109
 110 (require 'ediff-init)
 111 (require 'ediff-mult)
 112
 113 (defvar ediff-use-last-dir nil
 114   "*If t, Ediff uses previous directory as default when reading file name.")
 115
 116 (defvar ediff-last-dir-A nil
 117   "Last directory used by an Ediff command for file-A.")
 118 (defvar ediff-last-dir-B nil
 119   "Last directory used by an Ediff command for file-B.")
 120 (defvar ediff-last-dir-C nil
 121   "Last directory used by an Ediff command for file-C.")
 122 (defvar ediff-last-dir-ancestor nil
 123   "Last directory used by an Ediff command for the ancestor file.")
 124 (defvar ediff-last-dir-patch nil
 125   "Last directory used by an Ediff command for file to patch.")
 126
 127 ;;; Patching
 128
 129 (defvar ediff-backup-extension
 130   (if (memq system-type '(vax-vms axp-vms emx ms-dos windows-nt windows-95))
 131       "_orig" ".orig")
 132   "Default backup extension for the patch program.")
 133
 134 ;;;###autoload
 135 (defun ediff-patch-file (source-filename &optional startup-hooks job-name)
 136   "Run Ediff by patching FILE-TP-PATCH."
 137   ;; This now returns the control buffer
 138   (interactive
 139    (list (ediff-read-file-name
 140           "File to patch"
 141           (if ediff-use-last-dir
 142               ediff-last-dir-patch
 143             default-directory)
 144           (ediff-get-default-file-name))))
 145
 146   (setq source-filename (expand-file-name source-filename))
 147   (ediff-get-patch-buffer
 148    (if (eq job-name 'ediff-patch-buffer)
 149        (ediff-eval-in-buffer (get-file-buffer source-filename)
 150          default-directory)
 151      (file-name-directory source-filename)))
 152
 153   (let* ((backup-extension
 154           ;; if the user specified a -b option, extract the backup
 155           ;; extension from there; else use ediff-backup-extension
 156           (substring ediff-patch-options
 157                      (if (string-match "-b[ \t]+" ediff-patch-options)
 158                          (match-end 0) 0)
 159                      (if (string-match "-b[ \t]+[^ \t]+" ediff-patch-options)
 160                          (match-end 0) 0)))
 161          (shell-file-name ediff-shell)
 162          ;; ediff-find-file may use a temp file to do the patch
 163          ;; so, we save source-filename and true-source-filename as a var
 164          ;; that initially is source-filename but may be changed to a temp
 165          ;; file for the purpose of patching.
 166          (true-source-filename source-filename)
 167          (target-filename source-filename)
 168          target-buf buf-to-patch file-name-magic-p ctl-buf)
 169
 170     ;; if the user didn't specify a backup extension, use
 171     ;; ediff-backup-extension
 172     (if (string= backup-extension "")
 173         (setq backup-extension ediff-backup-extension))
 174
 175     ;; Make a temp file, if source-filename has a magic file handler (or if
 176     ;; it is handled via auto-mode-alist and similar magic).
 177     ;; Check if there is a buffer visiting source-filename and if they are in
 178     ;; synch; arrange for the deletion of temp file.
 179     (ediff-find-file 'true-source-filename 'buf-to-patch
 180                      'ediff-last-dir-patch 'startup-hooks)
 181
 182     ;; Check if source file name has triggered black magic, such as file name
 183     ;; handlers or auto mode alist, and make a note of it.
 184     ;; true-source-filename should be either the original name or a
 185     ;; temporary file where we put the after-product of the file handler.
 186     (setq file-name-magic-p (not (equal (file-truename true-source-filename)
 187                                         (file-truename source-filename))))
 188
 189     ;; Checkout orig file, if necessary, so that the patched file could be
 190     ;; checked back in.
 191     (if (ediff-file-checked-in-p (buffer-file-name buf-to-patch))
 192         (ediff-toggle-read-only buf-to-patch))
 193
 194     (ediff-eval-in-buffer ediff-patch-diagnostics
 195       (message "Applying patch ... ")
 196       ;;(sit-for 0)
 197       ;; always pass patch the -f option, so it won't ask any questions
 198       (shell-command-on-region
 199        (point-min) (point-max)
 200        (format "%s -f %s -b %s %s"
 201                ediff-patch-program ediff-patch-options
 202                backup-extension
 203                (expand-file-name true-source-filename))
 204        t))
 205     ;;(message "Applying patch ... done")(sit-for 0)
 206     (switch-to-buffer ediff-patch-diagnostics)
 207     (sit-for 0) ; synchronize - let the user see diagnostics
 208
 209     (or (file-exists-p (concat true-source-filename backup-extension))
 210         (error "Patch failed or didn't modify the original file"))
 211
 212     ;; If black magic is involved, apply patch to a temp copy of the
 213     ;; file. Otherwise, apply patch to the orig copy.  If patch is applied
 214     ;; to temp copy, we name the result old-name_patched for local files
 215     ;; and temp-copy_patched for remote files. The orig file name isn't
 216     ;; changed, and the temp copy of the original is later deleted.
 217     ;; Without magic, the original file is renamed (usually into
 218     ;; old-name_orig) and the result of patching will have the same name as
 219     ;; the original.
 220     (if (not file-name-magic-p)
 221         (ediff-eval-in-buffer buf-to-patch
 222           (set-visited-file-name (concat source-filename backup-extension))
 223           (set-buffer-modified-p nil))
 224
 225       ;; Black magic in effect.
 226       ;; If orig file was remote, put the patched file in the temp directory.
 227       ;; If orig file is local, put the patched file in the directory of
 228       ;; the orig file.
 229       (setq target-filename
 230             (concat
 231              (if (ediff-file-remote-p (file-truename source-filename))
 232                  true-source-filename
 233                source-filename)
 234              "_patched"))
 235
 236       (rename-file true-source-filename target-filename t)
 237
 238       ;; arrange that the temp copy of orig will be deleted
 239       (rename-file (concat true-source-filename backup-extension)
 240                    true-source-filename t))
 241
 242     ;; make orig buffer read-only
 243     (setq startup-hooks
 244           (cons 'ediff-set-read-only-in-buf-A startup-hooks))
 245
 246     ;; set up a buf for the patched file
 247     (setq target-buf (find-file-noselect target-filename))
 248
 249     (setq ctl-buf
 250           (ediff-buffers-internal
 251            buf-to-patch target-buf nil
 252            startup-hooks (or job-name 'ediff-patch-file)))
 253
 254     (bury-buffer ediff-patch-diagnostics)
 255     (message "Patch diagnostics are available in buffer %s"
 256              (buffer-name ediff-patch-diagnostics))
 257     ctl-buf))
 258
 259 (defun ediff-set-read-only-in-buf-A ()
 260   "Used as a startup hook to set `_orig' patch file read-only."
 261   (ediff-eval-in-buffer ediff-buffer-A
 262     (toggle-read-only 1)))
 263
 264 ;; Return a plausible default for ediff's first file:
 265 ;; In dired, return the file name under the point, unless it is a directory
 266 ;; If the buffer has a file name, return that file name.
 267 (defun ediff-get-default-file-name ()
 268   (cond ((eq major-mode 'dired-mode)
 269          (let ((f (dired-get-filename nil 'no-error)))
 270            (if (and (stringp f) (not (file-directory-p f)))
 271                f)))
 272         ((buffer-file-name (current-buffer))
 273          (file-name-nondirectory (buffer-file-name (current-buffer))))
 274         ))
 275
 276 ;;;###autoload
 277 (defalias 'epatch 'ediff-patch-file)
 278 ;;;###autoload
 279 (defalias 'epatch-buffer 'ediff-patch-buffer)
 280
 281 ;;; Compare files/buffers
 282
 283 ;;;###autoload
 284 (defun ediff-files (file-A file-B &optional startup-hooks)
 285   "Run Ediff on a pair of files, FILE-A and FILE-B."
 286   (interactive
 287    (let ((dir-A (if ediff-use-last-dir
 288                     ediff-last-dir-A
 289                   default-directory))
 290          dir-B f)
 291      (list (setq f (ediff-read-file-name
 292                     "File A to compare" dir-A
 293                     (ediff-get-default-file-name)))
 294            (ediff-read-file-name "File B to compare"
 295                                  (setq dir-B
 296                                        (if ediff-use-last-dir
 297                                            ediff-last-dir-B
 298                                          (file-name-directory f)))
 299                                  (progn
 300                                    (setq file-name-history
 301                                          (cons (ediff-abbreviate-file-name
 302                                                 (expand-file-name
 303                                                  (file-name-nondirectory f)
 304                                                  dir-B))
 305                                                file-name-history))
 306                                    f))
 307            )))
 308   (ediff-files-internal file-A
 309                         (if (file-directory-p file-B)
 310                             (expand-file-name
 311                              (file-name-nondirectory file-A) file-B)
 312                           file-B)
 313                         nil ; file-C
 314                         startup-hooks
 315                         'ediff-files))
 316
 317 ;;;###autoload
 318 (defun ediff-files3 (file-A file-B file-C &optional startup-hooks)
 319   "Run Ediff on three files, FILE-A, FILE-B, and FILE-C."
 320   (interactive
 321    (let ((dir-A (if ediff-use-last-dir
 322                     ediff-last-dir-A
 323                   default-directory))
 324          dir-B dir-C f ff)
 325      (list (setq f (ediff-read-file-name
 326                     "File A to compare" dir-A
 327                     (ediff-get-default-file-name)))
 328            (setq ff (ediff-read-file-name "File B to compare"
 329                                           (setq dir-B
 330                                                 (if ediff-use-last-dir
 331                                                     ediff-last-dir-B
 332                                                   (file-name-directory f)))
 333                                           (progn
 334                                             (setq file-name-history
 335                                                   (cons
 336                                                    (ediff-abbreviate-file-name
 337                                                     (expand-file-name
 338                                                      (file-name-nondirectory f)
 339                                                      dir-B))
 340                                                    file-name-history))
 341                                             f)))
 342            (ediff-read-file-name "File C to compare"
 343                                  (setq dir-C (if ediff-use-last-dir
 344                                                  ediff-last-dir-C
 345                                                (file-name-directory ff)))
 346                                  (progn
 347                                    (setq file-name-history
 348                                          (cons (ediff-abbreviate-file-name
 349                                                 (expand-file-name
 350                                                  (file-name-nondirectory ff)
 351                                                  dir-C))
 352                                                file-name-history))
 353                                    ff))
 354            )))
 355   (ediff-files-internal file-A
 356                         (if (file-directory-p file-B)
 357                             (expand-file-name
 358                              (file-name-nondirectory file-A) file-B)
 359                           file-B)
 360                         (if (file-directory-p file-C)
 361                             (expand-file-name
 362                              (file-name-nondirectory file-A) file-C)
 363                           file-C)
 364                         startup-hooks
 365                         'ediff-files3))
 366
 367 ;;;###autoload
 368 (defalias 'ediff3 'ediff-files3)
 369
 370
 371 (defun ediff-find-file (file-var buffer-name &optional last-dir hooks-var)
 372   "Visit FILE and arrange its buffer to Ediff's liking.
 373 FILE is actually a variable symbol that must contain a true file name.
 374 BUFFER-NAME is a variable symbol, which will get the buffer object into which
 375 FILE is read.  LAST-DIR is the directory variable symbol where FILE's
 376 directory name should be returned. HOOKS is a variable symbol that will be
 377 assigned the hook to be executed after `ediff-startup' is finished.
 378 `ediff-find-file' arranges that the temp files it might create will be
 379 deleted."
 380   (let* ((file (symbol-value file-var))
 381          (file-magic (find-file-name-handler file 'find-file-noselect))
 382          (temp-file-name-prefix (file-name-nondirectory file)))
 383     (cond ((not (file-readable-p file))
 384            (error "File `%s' does not exist or is not readable" file))
 385           ((file-directory-p file)
 386            (error "File `%s' is a directory" file)))
 387
 388     ;; some of the command, below, require full file name
 389     (setq file (expand-file-name file))
 390
 391     ;; Record the directory of the file
 392     (if last-dir
 393         (set last-dir (expand-file-name (file-name-directory file))))
 394
 395     ;; Setup the buffer
 396     (set buffer-name (find-file-noselect file))
 397
 398     (ediff-eval-in-buffer (symbol-value buffer-name)
 399       (widen) ; Make sure the entire file is seen
 400       (cond (file-magic  ;; file has handler, such as jka-compr-handler or
 401              ;; ange-ftp-hook-function--arrange for temp file
 402              (ediff-verify-file-buffer 'magic)
 403              (setq file
 404                    (ediff-make-temp-file
 405                     (current-buffer) temp-file-name-prefix))
 406              (set hooks-var (cons (` (lambda () (delete-file (, file))))
 407                                   (symbol-value hooks-var))))
 408             ;; file processed via auto-mode-alist, a la uncompress.el
 409             ((not (equal (file-truename file)
 410                          (file-truename (buffer-file-name))))
 411              (setq file
 412                    (ediff-make-temp-file
 413                     (current-buffer) temp-file-name-prefix))
 414              (set hooks-var (cons (` (lambda () (delete-file (, file))))
 415                                   (symbol-value hooks-var))))
 416             (t ;; plain file---just check that the file matches the buffer
 417              (ediff-verify-file-buffer))))
 418     (set file-var file)))
 419
 420 (defun ediff-files-internal (file-A file-B file-C startup-hooks job-name)
 421   (let (buf-A buf-B buf-C)
 422     (message "Reading file %s ... " file-A)
 423     ;;(sit-for 0)
 424     (ediff-find-file 'file-A 'buf-A 'ediff-last-dir-A 'startup-hooks)
 425     (message "Reading file %s ... " file-B)
 426     ;;(sit-for 0)
 427     (ediff-find-file 'file-B 'buf-B 'ediff-last-dir-B 'startup-hooks)
 428     (if (stringp file-C)
 429         (progn
 430           (message "Reading file %s ... " file-C)
 431           ;;(sit-for 0)
 432           (ediff-find-file
 433            'file-C 'buf-C
 434            (if (eq job-name 'ediff-merge-files-with-ancestor)
 435                'ediff-last-dir-ancestor 'ediff-last-dir-C)
 436            'startup-hooks)))
 437     (ediff-setup buf-A file-A
 438                  buf-B file-B
 439                  buf-C file-C
 440                  startup-hooks
 441                  (list (cons 'ediff-job-name job-name)))))
 442
 443
 444 ;;;###autoload
 445 (defalias 'ediff 'ediff-files)
 446
 447
 448 ;;;###autoload
 449 (defun ediff-buffers (buffer-A buffer-B &optional startup-hooks job-name)
 450   "Run Ediff on a pair of buffers, BUFFER-A and BUFFER-B."
 451   (interactive
 452    (let (bf)
 453      (list (setq bf (read-buffer "Buffer A to compare: "
 454                                  (ediff-other-buffer "") t))
 455            (read-buffer "Buffer B to compare: "
 456                         (progn
 457                           ;; realign buffers so that two visible bufs will be
 458                           ;; at the top
 459                           (save-window-excursion (other-window 1))
 460                           (ediff-other-buffer bf))
 461                         t))))
 462
 463   (or job-name (setq job-name 'ediff-buffers))
 464   (ediff-buffers-internal buffer-A buffer-B nil startup-hooks job-name))
 465
 466 ;;;###autoload
 467 (defun ediff-buffers3 (buffer-A buffer-B buffer-C
 468                                  &optional startup-hooks job-name)
 469   "Run Ediff on three buffers, BUFFER-A, BUFFER-B, and BUFFER-C."
 470   (interactive
 471    (let (bf bff)
 472      (list (setq bf (read-buffer "Buffer A to compare: "
 473                                  (ediff-other-buffer "") t))
 474            (setq bff (read-buffer "Buffer B to compare: "
 475                                   (progn
 476                                     ;; realign buffers so that two visible
 477                                     ;; bufs will be at the top
 478                                     (save-window-excursion (other-window 1))
 479                                     (ediff-other-buffer bf))
 480                                   t))
 481            (read-buffer "Buffer C to compare: "
 482                                   (progn
 483                                     ;; realign buffers so that three visible
 484                                     ;; bufs will be at the top
 485                                     (save-window-excursion (other-window 1))
 486                                     (ediff-other-buffer (list bf bff)))
 487                                   t)
 488            )))
 489
 490   (or job-name (setq job-name 'ediff-buffers3))
 491   (ediff-buffers-internal buffer-A buffer-B buffer-C startup-hooks job-name))
 492
 493
 494
 495 (defun ediff-buffers-internal (buf-A buf-B buf-C startup-hooks job-name)
 496   (let* ((buf-A-file-name (buffer-file-name (get-buffer buf-A)))
 497          (buf-B-file-name (buffer-file-name (get-buffer buf-B)))
 498          (buf-C-is-alive (ediff-buffer-live-p buf-C))
 499          (buf-C-file-name (if buf-C-is-alive
 500                               (buffer-file-name (get-buffer buf-B))))
 501          file-A file-B file-C)
 502     (if (not (ediff-buffer-live-p buf-A))
 503         (error "Buffer %S doesn't exist" buf-A))
 504     (if (not (ediff-buffer-live-p buf-B))
 505         (error "Buffer %S doesn't exist" buf-B))
 506     (let ((ediff-job-name job-name))
 507       (if (and ediff-3way-comparison-job
 508                (not buf-C-is-alive))
 509           (error "Buffer %S doesn't exist" buf-C)))
 510     (if (stringp buf-A-file-name)
 511         (setq buf-A-file-name (file-name-nondirectory buf-A-file-name)))
 512     (if (stringp buf-B-file-name)
 513         (setq buf-B-file-name (file-name-nondirectory buf-B-file-name)))
 514     (if (stringp buf-C-file-name)
 515         (setq buf-C-file-name (file-name-nondirectory buf-C-file-name)))
 516
 517     (setq file-A (ediff-make-temp-file buf-A buf-A-file-name))
 518     (setq file-B (ediff-make-temp-file buf-B buf-B-file-name))
 519     (if buf-C-is-alive
 520         (setq file-C (ediff-make-temp-file buf-C buf-C-file-name)))
 521
 522     (ediff-setup (get-buffer buf-A) file-A
 523                  (get-buffer buf-B) file-B
 524                  (if buf-C-is-alive (get-buffer buf-C))
 525                  file-C
 526                  (cons (` (lambda ()
 527                             (delete-file (, file-A))
 528                             (delete-file (, file-B))
 529                             (if (stringp (, file-C)) (delete-file (, file-C)))
 530                             ))
 531                        startup-hooks)
 532                  (list (cons 'ediff-job-name job-name))
 533                  )))
 534
 535
 536 ;;; Directory and file group operations
 537
 538 ;; Get appropriate default name for directory:
 539 ;; If ediff-use-last-dir, use ediff-last-dir-A.
 540 ;; In dired mode, use the directory that is under the point (if any);
 541 ;; otherwise, use default-directory
 542 (defun ediff-get-default-directory-name ()
 543   (cond (ediff-use-last-dir ediff-last-dir-A)
 544         ((eq major-mode 'dired-mode)
 545          (let ((f (dired-get-filename nil 'noerror)))
 546            (if (and (stringp f) (file-directory-p f))
 547                f
 548              default-directory)))
 549         (t default-directory)))
 550
 551
 552 ;;;###autoload
 553 (defun ediff-directories (dir1 dir2 regexp)
 554   "Run Ediff on a pair of directories, DIR1 and DIR2, comparing files that have
 555 the same name in both. The third argument, REGEXP, is a regular expression that
 556 further filters the file names."
 557   (interactive
 558    (let ((dir-A (ediff-get-default-directory-name))
 559          f)
 560      (list (setq f (ediff-read-file-name "Directory A to compare" dir-A nil))
 561            (ediff-read-file-name "Directory B to compare"
 562                                  (if ediff-use-last-dir
 563                                      ediff-last-dir-B
 564                                    (ediff-strip-last-dir f))
 565                                  nil)
 566            (read-string "Filter through regular expression: "
 567                         nil ediff-filtering-regexp-history)
 568            )))
 569   (ediff-directories-internal
 570    dir1 dir2 nil regexp 'ediff-files 'ediff-directories
 571    ))
 572
 573 ;;;###autoload
 574 (defalias 'edirs 'ediff-directories)
 575
 576
 577 ;;;###autoload
 578 (defun ediff-directory-revisions (dir1 regexp)
 579   "Run Ediff on a directory, DIR1, comparing its files with their revisions.
 580 The second argument, REGEXP, is a regular expression that filters the file
 581 names. Only the files that are under revision control are taken into account."
 582   (interactive
 583    (let ((dir-A (ediff-get-default-directory-name)))
 584      (list (ediff-read-file-name
 585             "Directory to compare with revision" dir-A nil)
 586            (read-string "Filter through regular expression: "
 587                         nil ediff-filtering-regexp-history)
 588            )))
 589   (ediff-directory-revisions-internal
 590    dir1 regexp 'ediff-revision 'ediff-directory-revisions
 591    ))
 592
 593 ;;;###autoload
 594 (defalias 'edir-revisions 'ediff-directory-revisions)
 595
 596
 597 ;;;###autoload
 598 (defun ediff-directories3 (dir1 dir2 dir3 regexp)
 599   "Run Ediff on three directories, DIR1, DIR2, and DIR3, comparing files that
 600 have the same name in all three. The last argument, REGEXP, is a regular
 601 expression that further filters the file names."
 602   (interactive
 603    (let ((dir-A (ediff-get-default-directory-name))
 604          f)
 605      (list (setq f (ediff-read-file-name "Directory A to compare" dir-A nil))
 606            (setq f (ediff-read-file-name "Directory B to compare"
 607                                          (if ediff-use-last-dir
 608                                              ediff-last-dir-B
 609                                            (ediff-strip-last-dir f))
 610                                          nil))
 611            (ediff-read-file-name "Directory C to compare"
 612                                  (if ediff-use-last-dir
 613                                      ediff-last-dir-C
 614                                    (ediff-strip-last-dir f))
 615                                  nil)
 616            (read-string "Filter through regular expression: "
 617                         nil ediff-filtering-regexp-history)
 618            )))
 619   (ediff-directories-internal
 620    dir1 dir2 dir3 regexp 'ediff-files3 'ediff-directories3
 621    ))
 622
 623 ;;;###autoload
 624 (defalias 'edirs3 'ediff-directories3)
 625
 626 ;;;###autoload
 627 (defun ediff-merge-directories (dir1 dir2 regexp)
 628   "Run Ediff on a pair of directories, DIR1 and DIR2, merging files that have
 629 the same name in both. The third argument, REGEXP, is a regular expression that
 630 further filters the file names."
 631   (interactive
 632    (let ((dir-A (ediff-get-default-directory-name))
 633          f)
 634      (list (setq f (ediff-read-file-name "Directory A to merge" dir-A nil))
 635            (ediff-read-file-name "Directory B to merge"
 636                                  (if ediff-use-last-dir
 637                                      ediff-last-dir-B
 638                                    (ediff-strip-last-dir f))
 639                                  nil)
 640            (read-string "Filter through regular expression: "
 641                         nil ediff-filtering-regexp-history)
 642            )))
 643   (ediff-directories-internal
 644    dir1 dir2 nil regexp 'ediff-merge-files 'ediff-merge-directories
 645    ))
 646
 647 ;;;###autoload
 648 (defalias 'edirs-merge 'ediff-merge-directories)
 649
 650 ;;;###autoload
 651 (defun ediff-merge-directories-with-ancestor (dir1 dir2 dir3 regexp)
 652   "Run Ediff on a pair of directories, DIR1 and DIR2, merging files that have
 653 the same name in both. The third argument, REGEXP, is a regular expression that
 654 further filters the file names."
 655   (interactive
 656    (let ((dir-A (ediff-get-default-directory-name))
 657          f)
 658      (list (setq f (ediff-read-file-name "Directory A to merge" dir-A nil))
 659            (setq f (ediff-read-file-name "Directory B to merge"
 660                                  (if ediff-use-last-dir
 661                                      ediff-last-dir-B
 662                                    (ediff-strip-last-dir f))
 663                                  nil))
 664            (ediff-read-file-name "Ancestor directory: "
 665                                  (if ediff-use-last-dir
 666                                      ediff-last-dir-C
 667                                    (ediff-strip-last-dir f))
 668                                  nil)
 669            (read-string "Filter through regular expression: "
 670                         nil ediff-filtering-regexp-history)
 671            )))
 672   (ediff-directories-internal
 673    dir1 dir2 dir3 regexp
 674    'ediff-merge-files-with-ancestor 'ediff-merge-directories-with-ancestor
 675    ))
 676
 677 ;;;###autoload
 678 (defun ediff-merge-directory-revisions (dir1 regexp)
 679   "Run Ediff on a directory, DIR1, merging its files with their revisions.
 680 The second argument, REGEXP, is a regular expression that filters the file
 681 names. Only the files that are under revision control are taken into account."
 682   (interactive
 683    (let ((dir-A (ediff-get-default-directory-name)))
 684      (list (ediff-read-file-name
 685             "Directory to merge with revisions" dir-A nil)
 686            (read-string "Filter through regular expression: "
 687                         nil ediff-filtering-regexp-history)
 688            )))
 689   (ediff-directory-revisions-internal
 690    dir1 regexp 'ediff-merge-revisions 'ediff-merge-directory-revisions
 691    ))
 692
 693 ;;;###autoload
 694 (defalias 'edir-merge-revisions 'ediff-merge-directory-revisions)
 695
 696 ;;;###autoload
 697 (defun ediff-merge-directory-revisions-with-ancestor (dir1 regexp)
 698   "Run Ediff on a directory, DIR1, merging its files with their revisions and ancestors.
 699 The second argument, REGEXP, is a regular expression that filters the file
 700 names. Only the files that are under revision control are taken into account."
 701   (interactive
 702    (let ((dir-A (ediff-get-default-directory-name)))
 703      (list (ediff-read-file-name
 704             "Directory to merge with revisions and ancestors" dir-A nil)
 705            (read-string "Filter through regular expression: "
 706                         nil ediff-filtering-regexp-history)
 707            )))
 708   (ediff-directory-revisions-internal
 709    dir1 regexp 'ediff-merge-revisions-with-ancestor
 710    'ediff-merge-directory-revisions-with-ancestor
 711    ))
 712
 713 ;;;###autoload
 714 (defalias
 715   'edir-merge-revisions-with-ancestor
 716   'ediff-merge-directory-revisions-with-ancestor)
 717
 718 ;;;###autoload
 719 (defalias 'edirs-merge-with-ancestor 'ediff-merge-directories-with-ancestor)
 720
 721 ;; Run ediff-action (ediff-files, ediff-merge, ediff-merge-with-ancestors)
 722 ;; on a pair of directories (three directories, in case of ancestor).
 723 ;; The third argument, REGEXP, is a regular expression that further filters the
 724 ;; file names.
 725 ;; JOBNAME is the symbol indicating the meta-job to be performed.
 726 (defun ediff-directories-internal (dir1 dir2 dir3 regexp
 727                                         action jobname
 728                                         &optional startup-hooks)
 729   ;; ediff-read-file-name is set to attach a previously entered file name if
 730   ;; the currently entered file is a directory. This code takes care of that.
 731   (setq dir1 (if (file-directory-p dir1) dir1 (file-name-directory dir1))
 732         dir2 (if (file-directory-p dir2) dir2 (file-name-directory dir2)))
 733
 734   (if (stringp dir3)
 735       (setq dir3 (if (file-directory-p dir3) dir3 (file-name-directory dir3))))
 736
 737   (cond ((string= dir1 dir2)
 738          (error "Directories A and B are the same: %s" dir1))
 739         ((and (eq jobname 'ediff-directories3)
 740               (string= dir1 dir3))
 741          (error "Directories A and C are the same: %s" dir1))
 742         ((and (eq jobname 'ediff-directories3)
 743               (string= dir2 dir3))
 744          (error "Directories B and C are the same: %s" dir1)))
 745
 746   (let (diffs ; var where ediff-intersect-directories returns the diff list
 747         file-list meta-buf)
 748     (setq file-list (ediff-intersect-directories
 749                      jobname 'diffs regexp dir1 dir2 dir3))
 750     (setq startup-hooks
 751           ;; this sets various vars in the meta buffer inside
 752           ;; ediff-prepare-meta-buffer
 753           (cons (` (lambda ()
 754                      ;; tell what to do if the user clicks on a session record
 755                      (setq ediff-session-action-function (quote (, action)))
 756                      ;; set ediff-dir-difference-list
 757                      (setq ediff-dir-difference-list (quote (, diffs)))))
 758                 startup-hooks))
 759     (setq meta-buf (ediff-prepare-meta-buffer
 760                     'ediff-dir-action
 761                     file-list
 762                     "*Ediff Session Group Panel"
 763                     'ediff-redraw-directory-group-buffer
 764                     jobname
 765                     startup-hooks))
 766     (ediff-show-meta-buffer meta-buf)
 767     ))
 768
 769 (defun ediff-directory-revisions-internal (dir1 regexp action jobname
 770                                                 &optional startup-hooks)
 771   (setq dir1 (if (file-directory-p dir1) dir1 (file-name-directory dir1)))
 772   (let (file-list meta-buf)
 773     (setq file-list
 774           (ediff-get-directory-files-under-revision jobname regexp dir1))
 775     (setq startup-hooks
 776           ;; this sets various vars in the meta buffer inside
 777           ;; ediff-prepare-meta-buffer
 778           (cons (` (lambda ()
 779                      ;; tell what to do if the user clicks on a session record
 780                      (setq ediff-session-action-function (quote (, action)))
 781                      ))
 782                 startup-hooks))
 783     (setq meta-buf (ediff-prepare-meta-buffer
 784                     'ediff-dir-action
 785                     file-list
 786                     "*Ediff Session Group Panel"
 787                     'ediff-redraw-directory-group-buffer
 788                     jobname
 789                     startup-hooks))
 790     (ediff-show-meta-buffer meta-buf)
 791     ))
 792
 793
 794 ;;; Compare regions and windows
 795
 796 ;;;###autoload
 797 (defun ediff-windows-wordwise (dumb-mode &optional wind-A wind-B startup-hooks)
 798   "Compare WIND-A and WIND-B, which are selected by clicking, wordwise.
 799 With prefix argument, DUMB-MODE, or on a non-windowing display, works as
 800 follows:
 801 If WIND-A is nil, use selected window.
 802 If WIND-B is nil, use window next to WIND-A."
 803   (interactive "P")
 804   (ediff-windows dumb-mode wind-A wind-B
 805                  startup-hooks 'ediff-windows-wordwise 'word-mode))
 806
 807 ;;;###autoload
 808 (defun ediff-windows-linewise (dumb-mode &optional wind-A wind-B startup-hooks)
 809   "Compare WIND-A and WIND-B, which are selected by clicking, linewise.
 810 With prefix argument, DUMB-MODE, or on a non-windowing display, works as
 811 follows:
 812 If WIND-A is nil, use selected window.
 813 If WIND-B is nil, use window next to WIND-A."
 814   (interactive "P")
 815   (ediff-windows dumb-mode wind-A wind-B
 816                  startup-hooks 'ediff-windows-linewise nil))
 817
 818 ;; Compare WIND-A and WIND-B, which are selected by clicking.
 819 ;; With prefix argument, DUMB-MODE, or on a non-windowing display,
 820 ;; works as follows:
 821 ;; If WIND-A is nil, use selected window.
 822 ;; If WIND-B is nil, use window next to WIND-A.
 823 (defun ediff-windows (dumb-mode wind-A wind-B startup-hooks job-name word-mode)
 824   (if (or dumb-mode (not (ediff-window-display-p)))
 825       (setq wind-A (ediff-get-next-window wind-A nil)
 826             wind-B (ediff-get-next-window wind-B wind-A))
 827     (setq wind-A (ediff-get-window-by-clicking wind-A nil 1)
 828           wind-B (ediff-get-window-by-clicking wind-B wind-A 2)))
 829
 830   (let ((buffer-A (window-buffer wind-A))
 831         (buffer-B (window-buffer wind-B))
 832         beg-A end-A beg-B end-B)
 833
 834     (save-excursion
 835       (save-window-excursion
 836         (sit-for 0) ; synch before using window-start/end -- a precaution
 837         (select-window wind-A)
 838         (setq beg-A (window-start)
 839               end-A (window-end))
 840         (select-window wind-B)
 841         (setq beg-B (window-start)
 842               end-B (window-end))))
 843     (ediff-regions-internal
 844      buffer-A beg-A end-A buffer-B beg-B end-B
 845      startup-hooks job-name word-mode)))
 846
 847 ;;;###autoload
 848 (defun ediff-regions-wordwise (buffer-A buffer-B &optional startup-hooks)
 849   "Run Ediff on a pair of regions in two different buffers.
 850 Regions \(i.e., point and mark\) are assumed to be set in advance.
 851 This function is effective only for relatively small regions, up to 200
 852 lines. For large regions, use `ediff-regions-linewise'."
 853   (interactive
 854    (let (bf)
 855      (list (setq bf (read-buffer "Region's A buffer: "
 856                                  (ediff-other-buffer "") t))
 857            (read-buffer "Region's B buffer: "
 858                         (progn
 859                           ;; realign buffers so that two visible bufs will be
 860                           ;; at the top
 861                           (save-window-excursion (other-window 1))
 862                           (ediff-other-buffer bf))
 863                         t))))
 864   (if (not (ediff-buffer-live-p buffer-A))
 865       (error "Buffer %S doesn't exist" buffer-A))
 866   (if (not (ediff-buffer-live-p buffer-B))
 867       (error "Buffer %S doesn't exist" buffer-B))
 868
 869
 870   (let (reg-A-beg reg-A-end reg-B-beg reg-B-end)
 871     (save-excursion
 872       (set-buffer buffer-A)
 873       (setq reg-A-beg (region-beginning)
 874             reg-A-end (region-end))
 875       (set-buffer buffer-B)
 876       (setq reg-B-beg (region-beginning)
 877             reg-B-end (region-end)))
 878
 879     (ediff-regions-internal
 880      (get-buffer buffer-A) reg-A-beg reg-A-end
 881      (get-buffer buffer-B) reg-B-beg reg-B-end
 882      startup-hooks 'ediff-regions-wordwise 'word-mode)))
 883
 884 ;;;###autoload
 885 (defun ediff-regions-linewise (buffer-A buffer-B &optional startup-hooks)
 886   "Run Ediff on a pair of regions in two different buffers.
 887 Regions \(i.e., point and mark\) are assumed to be set in advance.
 888 Each region is enlarged to contain full lines.
 889 This function is effective for large regions, over 100-200
 890 lines. For small regions, use `ediff-regions-wordwise'."
 891   (interactive
 892    (let (bf)
 893      (list (setq bf (read-buffer "Region A's buffer: "
 894                                  (ediff-other-buffer "") t))
 895            (read-buffer "Region B's buffer: "
 896                         (progn
 897                           ;; realign buffers so that two visible bufs will be
 898                           ;; at the top
 899                           (save-window-excursion (other-window 1))
 900                           (ediff-other-buffer bf))
 901                         t))))
 902   (if (not (ediff-buffer-live-p buffer-A))
 903       (error "Buffer %S doesn't exist" buffer-A))
 904   (if (not (ediff-buffer-live-p buffer-B))
 905       (error "Buffer %S doesn't exist" buffer-B))
 906
 907   (let (reg-A-beg reg-A-end reg-B-beg reg-B-end)
 908     (save-excursion
 909       (set-buffer buffer-A)
 910       (setq reg-A-beg (region-beginning)
 911             reg-A-end (region-end))
 912       ;; enlarge the region to hold full lines
 913       (goto-char reg-A-beg)
 914       (beginning-of-line)
 915       (setq reg-A-beg (point))
 916       (goto-char reg-A-end)
 917       (end-of-line)
 918       (or (eobp) (forward-char)) ; include the newline char
 919       (setq reg-A-end (point))
 920
 921       (set-buffer buffer-B)
 922       (setq reg-B-beg (region-beginning)
 923             reg-B-end (region-end))
 924       ;; enlarge the region to hold full lines
 925       (goto-char reg-A-beg)
 926       (goto-char reg-B-beg)
 927       (beginning-of-line)
 928       (setq reg-B-beg (point))
 929       (goto-char reg-B-end)
 930       (end-of-line)
 931       (or (eobp) (forward-char)) ; include the newline char
 932       (setq reg-B-end (point))
 933       ) ; save excursion
 934
 935     (ediff-regions-internal
 936      (get-buffer buffer-A) reg-A-beg reg-A-end
 937      (get-buffer buffer-B) reg-B-beg reg-B-end
 938      startup-hooks 'ediff-regions-linewise nil))) ; no word mode
 939
 940 ;; compare region beg-A to end-A of buffer-A
 941 ;; to regions beg-B -- end-B in buffer-B.
 942 (defun ediff-regions-internal (buffer-A beg-A end-A buffer-B beg-B end-B
 943                                         startup-hooks job-name word-mode)
 944   (let ((tmp-buffer (get-buffer-create ediff-tmp-buffer))
 945         overl-A overl-B
 946         file-A file-B)
 947
 948     ;; in case beg/end-A/B aren't markers--make them into markers
 949     (ediff-eval-in-buffer buffer-A
 950       (setq beg-A (move-marker (make-marker) beg-A)
 951             end-A (move-marker (make-marker) end-A)))
 952     (ediff-eval-in-buffer buffer-B
 953       (setq beg-B (move-marker (make-marker) beg-B)
 954             end-B (move-marker (make-marker) end-B)))
 955
 956     (if (and (eq buffer-A buffer-B)
 957              (or (and (< beg-A end-B) (<= beg-B beg-A))   ; b-B b-A e-B
 958                  (and (< beg-B end-A) (<= end-A end-B)))) ; b-B e-A e-B
 959         (progn
 960           (with-output-to-temp-buffer ediff-msg-buffer
 961             (princ "
 962 You have requested to compare overlapping regions of the same buffer.
 963
 964 In this case, Ediff's highlighting may be confusing---in the same window,
 965 you may see highlighted regions that belong to different regions.
 966
 967 Continue anyway? (y/n) "))
 968
 969           (if (y-or-n-p "Continue anyway? ")
 970               ()
 971             (error "%S aborted" job-name))))
 972
 973     ;; make file-A
 974     (if word-mode
 975         (ediff-wordify beg-A end-A buffer-A tmp-buffer)
 976       (ediff-copy-to-buffer beg-A end-A buffer-A tmp-buffer))
 977     (setq file-A (ediff-make-temp-file tmp-buffer "regA"))
 978
 979     ;; make file-B
 980     (if word-mode
 981         (ediff-wordify beg-B end-B buffer-B tmp-buffer)
 982       (ediff-copy-to-buffer beg-B end-B buffer-B tmp-buffer))
 983     (setq file-B (ediff-make-temp-file tmp-buffer "regB"))
 984
 985     (setq overl-A (ediff-make-bullet-proof-overlay beg-A end-A buffer-A))
 986     (setq overl-B (ediff-make-bullet-proof-overlay beg-B end-B buffer-B))
 987     (ediff-setup buffer-A file-A
 988                  buffer-B file-B
 989                  nil nil            ; buffer & file C
 990                  (cons (` (lambda ()
 991                             (delete-file (, file-A))
 992                             (delete-file (, file-B))))
 993                        startup-hooks)
 994                  (list (cons 'ediff-word-mode  word-mode)
 995                        (cons 'ediff-narrow-bounds (list overl-A overl-B))
 996                        (cons 'ediff-job-name job-name))
 997                  )
 998     ))
 999
1000
1001 ;;; Merge files and buffers
1002
1003 ;;;###autoload
1004 (defalias 'ediff-merge 'ediff-merge-files)
1005
1006 (defsubst ediff-merge-on-startup ()
1007   (ediff-do-merge 0)
1008   (ediff-eval-in-buffer ediff-buffer-C
1009     (set-buffer-modified-p nil)))
1010
1011 ;;;###autoload
1012 (defun ediff-merge-files (file-A file-B &optional startup-hooks)
1013   "Merge two files without ancestor."
1014   (interactive
1015    (let ((dir-A (if ediff-use-last-dir
1016                     ediff-last-dir-A
1017                   default-directory))
1018          dir-B f)
1019      (list (setq f (ediff-read-file-name
1020                     "File A to merge" dir-A
1021                     (ediff-get-default-file-name)))
1022            (ediff-read-file-name "File B to merge"
1023                                  (setq dir-B
1024                                        (if ediff-use-last-dir
1025                                            ediff-last-dir-B
1026                                          (file-name-directory f)))
1027                                  (progn
1028                                    (setq file-name-history
1029                                          (cons (ediff-abbreviate-file-name
1030                                                 (expand-file-name
1031                                                  (file-name-nondirectory f)
1032                                                  dir-B))
1033                                                file-name-history))
1034                                    f))
1035            )))
1036   (setq startup-hooks (cons 'ediff-merge-on-startup startup-hooks))
1037   (ediff-files-internal file-A
1038                         (if (file-directory-p file-B)
1039                             (expand-file-name
1040                              (file-name-nondirectory file-A) file-B)
1041                           file-B)
1042                           nil ; file-C
1043                           startup-hooks
1044                           'ediff-merge-files))
1045
1046 ;;;###autoload
1047 (defun ediff-merge-files-with-ancestor (file-A file-B file-ancestor
1048                                                &optional startup-hooks)
1049   "Merge two files with ancestor."
1050   (interactive
1051    (let ((dir-A (if ediff-use-last-dir
1052                     ediff-last-dir-A
1053                   default-directory))
1054          dir-B dir-ancestor f ff)
1055      (list (setq f (ediff-read-file-name
1056                     "File A to merge" dir-A
1057                     (ediff-get-default-file-name)))
1058            (setq ff (ediff-read-file-name "File B to merge"
1059                                           (setq dir-B
1060                                                 (if ediff-use-last-dir
1061                                                     ediff-last-dir-B
1062                                                   (file-name-directory f)))
1063                                           (progn
1064                                             (setq file-name-history
1065                                                   (cons
1066                                                    (ediff-abbreviate-file-name
1067                                                     (expand-file-name
1068                                                      (file-name-nondirectory f)
1069                                                      dir-B))
1070                                                    file-name-history))
1071                                             f)))
1072            (ediff-read-file-name "Ancestor file"
1073                                  (setq dir-ancestor
1074                                        (if ediff-use-last-dir
1075                                            ediff-last-dir-ancestor
1076                                          (file-name-directory ff)))
1077                                  (progn
1078                                    (setq file-name-history
1079                                          (cons (ediff-abbreviate-file-name
1080                                                 (expand-file-name
1081                                                  (file-name-nondirectory ff)
1082                                                  dir-ancestor))
1083                                                file-name-history))
1084                                    ff))
1085            )))
1086   (setq startup-hooks (cons 'ediff-merge-on-startup startup-hooks))
1087   (ediff-files-internal file-A
1088                         (if (file-directory-p file-B)
1089                             (expand-file-name
1090                              (file-name-nondirectory file-A) file-B)
1091                           file-B)
1092                           file-ancestor
1093                           startup-hooks
1094                           'ediff-merge-files-with-ancestor))
1095
1096 ;;;###autoload
1097 (defalias 'ediff-merge-with-ancestor 'ediff-merge-files-with-ancestor)
1098
1099 ;;;###autoload
1100 (defun ediff-merge-buffers (buffer-A buffer-B &optional startup-hooks job-name)
1101   "Merge buffers without ancestor."
1102   (interactive
1103    (let (bf)
1104      (list (setq bf (read-buffer "Buffer A to merge: "
1105                                  (ediff-other-buffer "") t))
1106            (read-buffer "Buffer B to merge: "
1107                         (progn
1108                           ;; realign buffers so that two visible bufs will be
1109                           ;; at the top
1110                           (save-window-excursion (other-window 1))
1111                           (ediff-other-buffer bf))
1112                         t))))
1113
1114   (setq startup-hooks (cons 'ediff-merge-on-startup startup-hooks))
1115   (or job-name (setq job-name 'ediff-merge-buffers))
1116   (ediff-buffers-internal
1117    buffer-A buffer-B nil startup-hooks job-name))
1118
1119 ;;;###autoload
1120 (defun ediff-merge-buffers-with-ancestor (buffer-A
1121                                           buffer-B buffer-ancestor
1122                                           &optional startup-hooks job-name)
1123   "Merge buffers with ancestor."
1124   (interactive
1125    (let (bf bff)
1126      (list (setq bf (read-buffer "Buffer A to merge: "
1127                                  (ediff-other-buffer "") t))
1128            (setq bff (read-buffer "Buffer B to merge: "
1129                                   (progn
1130                                     ;; realign buffers so that two visible
1131                                     ;; bufs will be at the top
1132                                     (save-window-excursion (other-window 1))
1133                                     (ediff-other-buffer bf))
1134                                   t))
1135            (read-buffer "Ancestor buffer: "
1136                                   (progn
1137                                     ;; realign buffers so that three visible
1138                                     ;; bufs will be at the top
1139                                     (save-window-excursion (other-window 1))
1140                                     (ediff-other-buffer (list bf bff)))
1141                                   t)
1142            )))
1143
1144   (setq startup-hooks (cons 'ediff-merge-on-startup startup-hooks))
1145   (or job-name (setq job-name 'ediff-merge-buffers-with-ancestor))
1146   (ediff-buffers-internal
1147    buffer-A buffer-B buffer-ancestor startup-hooks job-name))
1148
1149
1150 ;;;###autoload
1151 (defun ediff-merge-revisions (&optional file startup-hooks)
1152   "Run Ediff by merging two revisions of a file.
1153 The file is the optional FILE argument or the file visited by the current
1154 buffer."
1155   (interactive)
1156   (ediff-load-version-control)
1157   (if (stringp file) (find-file file))
1158   (let (rev1 rev2 buf1 buf2)
1159     (setq rev1
1160           (read-string
1161            (format
1162             "Version 1 to merge (default: %s's latest version): "
1163             (if (stringp file)
1164                 (file-name-nondirectory file) "current buffer")))
1165           rev2
1166           (read-string
1167            (format
1168             "Version 2 to merge (default: %s): "
1169             (if (stringp file)
1170                 (file-name-nondirectory file) "current buffer"))))
1171     (cond ((eq ediff-version-control-package 'vc)
1172            (save-excursion
1173              (vc-version-other-window rev1)
1174              (setq buf1 (current-buffer)))
1175            (save-excursion
1176              (or (string= rev2 "")
1177                  (vc-version-other-window rev2))
1178              (setq buf2 (current-buffer)))
1179            (setq startup-hooks
1180                  (cons
1181                   (` (lambda ()
1182                        (delete-file (, (buffer-file-name buf1)))
1183                        (or (, (string= rev2 ""))
1184                            (delete-file (, (buffer-file-name buf2))))))
1185                   startup-hooks)))
1186           ((eq ediff-version-control-package 'rcs)
1187            (setq buf1 (rcs-ediff-view-revision rev1)
1188                  buf2 (if (string= rev2 "")
1189                           (current-buffer)
1190                         (rcs-ediff-view-revision rev2))))
1191           ((eq ediff-version-control-package 'generic-sc)
1192            (save-excursion
1193              (if (string= rev1 "")
1194                  (setq rev1 (generic-sc-get-latest-rev)))
1195              (sc-visit-previous-revision rev1)
1196              (setq buf1 (current-buffer)))
1197            (save-excursion
1198              (or (string= rev2 "")
1199                  (sc-visit-previous-revision rev2))
1200              (setq buf2 (current-buffer))))
1201           ) ; cond
1202     (ediff-merge-buffers buf1 buf2 startup-hooks 'ediff-merge-revisions)))
1203
1204
1205 ;;;###autoload
1206 (defun ediff-merge-revisions-with-ancestor (&optional file startup-hooks)
1207   "Run Ediff by merging two revisions of a file with a common ancestor.
1208 The file is the the optional FILE argument or the file visited by the current
1209 buffer."
1210   (interactive)
1211   (ediff-load-version-control)
1212   (if (stringp file) (find-file file))
1213   (let (rev1 rev2 ancestor-rev buf1 buf2 ancestor-buf)
1214     (setq rev1
1215           (read-string
1216            (format
1217             "Version 1 to merge (default: %s's latest version): "
1218             (if (stringp file)
1219                 (file-name-nondirectory file) "current buffer")))
1220           rev2
1221           (read-string
1222            (format
1223             "Version 2 to merge (default: %s): "
1224             (if (stringp file)
1225                 (file-name-nondirectory file) "current buffer")))
1226           ancestor-rev
1227           (read-string
1228            (format
1229             "Ancestor version (default: %s): "
1230             (if (stringp file)
1231                 (file-name-nondirectory file) "current buffer"))))
1232     (cond ((eq ediff-version-control-package 'vc)
1233            (save-excursion
1234              (vc-version-other-window rev1)
1235              (setq buf1 (current-buffer)))
1236            (save-excursion
1237              (or (string= rev2 "")
1238                  (vc-version-other-window rev2))
1239              (setq buf2 (current-buffer)))
1240            (save-excursion
1241              (or (string= ancestor-rev "")
1242                  (vc-version-other-window ancestor-rev))
1243              (setq ancestor-buf (current-buffer)))
1244            (setq startup-hooks
1245                  (cons
1246                   (` (lambda ()
1247                        (delete-file (, (buffer-file-name buf1)))
1248                        (or (, (string= rev2 ""))
1249                            (delete-file (, (buffer-file-name buf2))))
1250                        (or (, (string= ancestor-rev ""))
1251                            (delete-file (, (buffer-file-name ancestor-buf))))))
1252                   startup-hooks)))
1253           ((eq ediff-version-control-package 'rcs)
1254            (setq buf1 (rcs-ediff-view-revision rev1)
1255                  buf2 (if (string= rev2 "")
1256                           (current-buffer)
1257                         (rcs-ediff-view-revision rev2))
1258                  ancestor-buf (if (string= ancestor-rev "")
1259                                   (current-buffer)
1260                                 (rcs-ediff-view-revision ancestor-rev))))
1261           ((eq ediff-version-control-package 'generic-sc)
1262            (save-excursion
1263              (if (string= rev1 "")
1264                  (setq rev1 (generic-sc-get-latest-rev)))
1265              (sc-visit-previous-revision rev1)
1266              (setq buf1 (current-buffer)))
1267            (save-excursion
1268              (or (string= rev2 "")
1269                  (sc-visit-previous-revision rev2))
1270              (setq buf2 (current-buffer)))
1271            (save-excursion
1272              (or (string= ancestor-rev "")
1273                  (sc-visit-previous-revision ancestor-rev))
1274              (setq ancestor-buf (current-buffer))))
1275           ) ; cond
1276     (ediff-merge-buffers-with-ancestor
1277      buf1 buf2 ancestor-buf
1278      startup-hooks 'ediff-merge-revisions-with-ancestor)))
1279
1280
1281 ;;; Apply patch
1282
1283 ;;;###autoload
1284 (defun ediff-patch-buffer (buffer-name &optional startup-hooks)
1285   "Run Ediff by patching BUFFER-NAME."
1286   (interactive "bBuffer to patch: ")
1287
1288   (let* ((buf-to-patch (get-buffer buffer-name))
1289          (file-name-ok (if buf-to-patch (buffer-file-name  buf-to-patch)))
1290          (buf-mod-status (buffer-modified-p buf-to-patch))
1291          default-dir file-name ctl-buf)
1292     (if file-name-ok
1293         (setq file-name file-name-ok)
1294       (ediff-eval-in-buffer buffer-name
1295         (setq default-dir default-directory)
1296         (setq file-name (ediff-make-temp-file buffer-name))
1297         (set-visited-file-name file-name)
1298         (setq buffer-auto-save-file-name nil) ; don't create auto-save file
1299         (rename-buffer buffer-name) ; don't confuse the user with new buf name
1300         (set-buffer-modified-p nil)
1301         (set-visited-file-modtime) ; sync buffer and temp file
1302         (setq default-directory default-dir)
1303         ))
1304
1305     (setq ctl-buf
1306           (ediff-patch-file file-name startup-hooks 'ediff-patch-buffer))
1307
1308     (if file-name-ok
1309         ()
1310       (ediff-eval-in-buffer ctl-buf
1311         (delete-file (buffer-file-name ediff-buffer-A))
1312         (delete-file (buffer-file-name ediff-buffer-B))
1313         (ediff-eval-in-buffer ediff-buffer-A
1314           (if default-dir (setq default-directory default-dir))
1315           (set-visited-file-name nil)
1316           (rename-buffer buffer-name)
1317           (set-buffer-modified-p buf-mod-status))
1318         (ediff-eval-in-buffer ediff-buffer-B
1319           (setq buffer-auto-save-file-name nil) ; don't create auto-save file
1320           (if default-dir (setq default-directory default-dir))
1321           (set-visited-file-name nil)
1322           (rename-buffer (ediff-unique-buffer-name
1323                           (concat buffer-name "_patched") ""))
1324           (set-buffer-modified-p t))))
1325     ))
1326
1327
1328 (defun ediff-get-patch-buffer (dir)
1329   "Obtain patch buffer.  If patch is already in a buffer---use it.
1330 Else, read patch file into a new buffer."
1331   (if (y-or-n-p "Is the patch file already in a buffer? ")
1332       (setq ediff-patch-buf
1333             (get-buffer (read-buffer "Patch buffer name: " nil t))) ;must match
1334     (setq ediff-patch-buf
1335           (find-file-noselect (read-file-name "Patch file name: " dir))))
1336
1337   (setq ediff-patch-diagnostics
1338         (get-buffer-create "*ediff patch diagnostics*"))
1339   (ediff-eval-in-buffer ediff-patch-diagnostics
1340     (insert-buffer ediff-patch-buf)))
1341
1342
1343
1344
1345 \f
1346 ;;; Versions Control functions
1347
1348 ;;;###autoload
1349 (defun ediff-revision (&optional file startup-hooks)
1350   "Run Ediff by comparing versions of a file.
1351 The file is an optional FILE argument or the file visited by the current
1352 buffer. Use `vc.el' or `rcs.el' depending on `ediff-version-control-package'."
1353   ;; if buffer is non-nil, use that buffer instead of the current buffer
1354   (interactive "P")
1355   (if (stringp file) (find-file file))
1356   (let (rev1 rev2)
1357     (setq rev1
1358           (read-string
1359            (format "Version 1 to compare (default: %s's latest version): "
1360                    (if (stringp file)
1361                        (file-name-nondirectory file) "current buffer")))
1362           rev2
1363           (read-string
1364            (format "Version 2 to compare (default: %s): "
1365                    (if (stringp file)
1366                        (file-name-nondirectory file) "current buffer"))))
1367     (ediff-load-version-control)
1368     (funcall
1369      (intern (format "%S-ediff-internal" ediff-version-control-package))
1370      rev1 rev2 startup-hooks)
1371     ))
1372
1373
1374 ;; Test if version control package is loaded and load if not
1375 ;; Is SILENT is non-nil, don't report error if package is not found.
1376 (defun ediff-load-version-control (&optional silent)
1377   (or (featurep ediff-version-control-package)
1378       (if (locate-library (symbol-name ediff-version-control-package))
1379           (progn
1380             (message "") ; kill the message from `locate-library'
1381             (require ediff-version-control-package))
1382         (or silent
1383             (error "Version control package %S.el not found. Use vc.el instead"
1384                    ediff-version-control-package)))))
1385
1386
1387 (defun vc-ediff-internal (rev1 rev2 &optional startup-hooks)
1388   "Run Ediff on versions of the current buffer.
1389 If REV2 is \"\" then compare current buffer with REV1.
1390 If the current buffer is named `F', the version is named `F.~REV~'.
1391 If `F.~REV~' already exists, it is used instead of being re-created."
1392   (let (file1 file2 rev1buf rev2buf)
1393     (save-excursion
1394       (vc-version-other-window rev1)
1395       (setq rev1buf (current-buffer)
1396             file1 (buffer-file-name)))
1397     (save-excursion
1398       (or (string= rev2 "")             ; use current buffer
1399           (vc-version-other-window rev2))
1400       (setq rev2buf (current-buffer)
1401             file2 (buffer-file-name)))
1402     (setq startup-hooks
1403           (cons (` (lambda ()
1404                      (delete-file (, file1))
1405                      (or (, (string= rev2 "")) (delete-file (, file2)))
1406                      ))
1407                 startup-hooks))
1408     (ediff-buffers
1409      rev1buf rev2buf
1410      startup-hooks
1411      'ediff-revision)))
1412
1413 (defun rcs-ediff-view-revision (&optional rev)
1414   "View previous RCS revision of current file.
1415 With prefix argument, prompts for a revision name."
1416   (interactive (list (if current-prefix-arg
1417                          (read-string "Revision: "))))
1418   (let* ((filename (buffer-file-name (current-buffer)))
1419          (switches (append '("-p")
1420                            (if rev (list (concat "-r" rev)) nil)))
1421          (buff (concat (file-name-nondirectory filename) ".~" rev "~")))
1422     (message "Working ...")
1423     (setq filename (expand-file-name filename))
1424     (with-output-to-temp-buffer buff
1425       (let ((output-buffer (ediff-rcs-get-output-buffer filename buff)))
1426         (delete-windows-on output-buffer)
1427         (save-excursion
1428           (set-buffer output-buffer)
1429           (apply 'call-process "co" nil t nil
1430                  ;; -q: quiet (no diagnostics)
1431                  (append switches rcs-default-co-switches
1432                          (list "-q" filename)))))
1433       (message "")
1434       buff)))
1435
1436 (defun ediff-rcs-get-output-buffer (file name)
1437   ;; Get a buffer for RCS output for FILE, make it writable and clean it up.
1438   ;; Optional NAME is name to use instead of `*RCS-output*'.
1439   ;; This is a modified version from rcs.el v1.1. I use it here to make
1440   ;; Ediff immune to changes in rcs.el
1441   (let* ((default-major-mode 'fundamental-mode) ; no frills!
1442          (buf (get-buffer-create name)))
1443     (save-excursion
1444       (set-buffer buf)
1445       (setq buffer-read-only nil
1446             default-directory (file-name-directory (expand-file-name file)))
1447       (erase-buffer))
1448     buf))
1449
1450 (defun rcs-ediff-internal (rev1 rev2 &optional startup-hooks)
1451   "Run Ediff on versions of the current buffer.
1452 If REV2 is \"\" then use current buffer."
1453   (let ((rev2buf (if (string= rev2 "")
1454                      (current-buffer)
1455                    (rcs-ediff-view-revision rev2)))
1456         (rev1buf (rcs-ediff-view-revision rev1)))
1457
1458     ;; rcs.el doesn't create temp version files, so we don't have to delete
1459     ;; anything in startup hooks to ediff-buffers
1460     (ediff-buffers rev1buf rev2buf startup-hooks 'ediff-revision)
1461     ))
1462
1463 (defun generic-sc-get-latest-rev ()
1464   (cond ((eq sc-mode 'CCASE)
1465          (eval "main/LATEST"))
1466         (t (eval "")))
1467   )
1468
1469 (defun generic-sc-ediff-internal (rev1 rev2 &optional startup-hooks)
1470   "Run Ediff on versions of the current buffer.
1471 If REV2 is \"\" then compare current buffer with REV1.
1472 If the current buffer is named `F', the version is named `F.~REV~'.
1473 If `F.~REV~' already exists, it is used instead of being re-created."
1474   (let (rev1buf rev2buf)
1475     (save-excursion
1476       (if (or (not rev1) (string= rev1 ""))
1477           (setq rev1 (generic-sc-get-latest-rev)))
1478       (sc-visit-previous-revision rev1)
1479       (setq rev1buf (current-buffer)))
1480     (save-excursion
1481       (or (string= rev2 "")             ; use current buffer
1482           (sc-visit-previous-revision rev2))
1483       (setq rev2buf (current-buffer)))
1484     (ediff-buffers rev1buf rev2buf startup-hooks 'ediff-revision)))
1485
1486 ;;;###autoload
1487 (defun ediff-version ()
1488   "Return string describing the version of Ediff.
1489 When called interactively, displays the version."
1490   (interactive)
1491   (if (interactive-p)
1492       (message (ediff-version))
1493     (format "Ediff %s of %s" ediff-version ediff-date)))
1494
1495
1496 (provide 'ediff)
1497 (require 'ediff-util)
1498
1499 ;;; ediff.el ends here