lisp/ediff.el

   1 ;;; ediff.el --- a comprehensive visual interface to diff & patch
   2
   3 ;; Copyright (C) 1994 -- 1999 Free Software Foundation, Inc.
   4
   5 ;; Author: Michael Kifer <kifer@cs.sunysb.edu>
   6 ;; Created: February 2, 1994
   7 ;; Keywords: comparing, merging, patching, version control.
   8
   9 (defconst ediff-version "2.74" "The current version of Ediff")
  10 (defconst ediff-date "October 31, 1999" "Date of last update")
  11
  12
  13 ;; This file is part of GNU Emacs.
  14
  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)
  18 ;; any later version.
  19
  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.
  24
  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.
  29
  30 ;;; Commentary:
  31
  32 ;; Never read that diff output again!
  33 ;; Apply patch interactively!
  34 ;; Merge with ease!
  35
  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).
  43
  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
  47 ;; directories.
  48
  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
  56 ;; you don't like).
  57
  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.
  61
  62 ;; Finally, Ediff supports directory-level comparison, merging and patching.
  63 ;; See the on-line manual for details.
  64
  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.
  68
  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.
  73
  74
  75
  76 ;;; Bugs:
  77
  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.)
  83 ;;
  84 ;;  If at any point you feel that difference regions are no longer correct,
  85 ;;  you can hit '!' to recompute the differences.
  86
  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
  97 ;;  and on any buffer.
  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 ;;; Code:
 108
 109 (provide 'ediff)
 110
 111 ;; Compiler pacifier
 112 (defvar cvs-cookie-handle)
 113 (defvar ediff-last-dir-patch)
 114 (defvar ediff-patch-default-directory)
 115
 116 (and noninteractive
 117      (eval-when-compile
 118          (load-library "dired")
 119          (load-library "info")
 120          (load "pcl-cvs" 'noerror)))
 121 (eval-when-compile
 122   (let ((load-path (cons (expand-file-name ".") load-path)))
 123     (or (featurep 'ediff-init)
 124         (load "ediff-init.el" nil nil 'nosuffix))
 125     (or (featurep 'ediff-mult)
 126         (load "ediff-mult.el" nil nil 'nosuffix))
 127     (or (featurep 'ediff-ptch)
 128         (load "ediff-ptch.el" nil nil 'nosuffix))
 129     (or (featurep 'ediff-vers)
 130         (load "ediff-vers.el" nil nil 'nosuffix))
 131     ))
 132 ;; end pacifier
 133
 134 (require 'ediff-init)
 135 (require 'ediff-mult)  ; required because of the registry stuff
 136
 137 (defgroup ediff nil
 138   "A comprehensive visual interface to diff & patch"
 139   :tag "Ediff"
 140   :group 'tools)
 141
 142
 143 (defcustom ediff-use-last-dir nil
 144   "*If t, Ediff will use previous directory as default when reading file name."
 145   :type 'boolean
 146   :group 'ediff)
 147
 148 ;; Last directory used by an Ediff command for file-A.
 149 (defvar ediff-last-dir-A nil)
 150 ;; Last directory used by an Ediff command for file-B.
 151 (defvar ediff-last-dir-B nil)
 152 ;; Last directory used by an Ediff command for file-C.
 153 (defvar ediff-last-dir-C nil)
 154 ;; Last directory used by an Ediff command for the ancestor file.
 155 (defvar ediff-last-dir-ancestor nil)
 156 ;; Last directory used by an Ediff command as the output directory for merge.
 157 (defvar ediff-last-merge-autostore-dir)
 158
 159
 160 ;; Used as a startup hook to set `_orig' patch file read-only.
 161 (defun ediff-set-read-only-in-buf-A ()
 162   (ediff-with-current-buffer ediff-buffer-A
 163     (toggle-read-only 1)))
 164
 165 ;; Return a plausible default for ediff's first file:
 166 ;; In dired, return the file name under the point, unless it is a directory
 167 ;; If the buffer has a file name, return that file name.
 168 (defun ediff-get-default-file-name ()
 169   (cond ((eq major-mode 'dired-mode)
 170          (let ((f (dired-get-filename nil 'no-error)))
 171            (if (and (stringp f) (not (file-directory-p f)))
 172                f)))
 173         ((buffer-file-name (current-buffer))
 174          (file-name-nondirectory (buffer-file-name (current-buffer))))
 175         ))
 176
 177 ;;; Compare files/buffers
 178
 179 ;;;###autoload
 180 (defun ediff-files (file-A file-B &optional startup-hooks)
 181   "Run Ediff on a pair of files, FILE-A and FILE-B."
 182   (interactive
 183    (let ((dir-A (if ediff-use-last-dir
 184                     ediff-last-dir-A
 185                   default-directory))
 186          dir-B f)
 187      (list (setq f (ediff-read-file-name
 188                     "File A to compare" dir-A
 189                     (ediff-get-default-file-name)))
 190            (ediff-read-file-name "File B to compare"
 191                                  (setq dir-B
 192                                        (if ediff-use-last-dir
 193                                            ediff-last-dir-B
 194                                          (file-name-directory f)))
 195                                  (progn
 196                                    (setq file-name-history
 197                                          (cons (ediff-abbreviate-file-name
 198                                                 (expand-file-name
 199                                                  (file-name-nondirectory f)
 200                                                  dir-B))
 201                                                file-name-history))
 202                                    f))
 203            )))
 204   (ediff-files-internal file-A
 205                         (if (file-directory-p file-B)
 206                             (expand-file-name
 207                              (file-name-nondirectory file-A) file-B)
 208                           file-B)
 209                         nil ; file-C
 210                         startup-hooks
 211                         'ediff-files))
 212
 213 ;;;###autoload
 214 (defun ediff-files3 (file-A file-B file-C &optional startup-hooks)
 215   "Run Ediff on three files, FILE-A, FILE-B, and FILE-C."
 216   (interactive
 217    (let ((dir-A (if ediff-use-last-dir
 218                     ediff-last-dir-A
 219                   default-directory))
 220          dir-B dir-C f ff)
 221      (list (setq f (ediff-read-file-name
 222                     "File A to compare" dir-A
 223                     (ediff-get-default-file-name)))
 224            (setq ff (ediff-read-file-name "File B to compare"
 225                                           (setq dir-B
 226                                                 (if ediff-use-last-dir
 227                                                     ediff-last-dir-B
 228                                                   (file-name-directory f)))
 229                                           (progn
 230                                             (setq file-name-history
 231                                                   (cons
 232                                                    (ediff-abbreviate-file-name
 233                                                     (expand-file-name
 234                                                      (file-name-nondirectory f)
 235                                                      dir-B))
 236                                                    file-name-history))
 237                                             f)))
 238            (ediff-read-file-name "File C to compare"
 239                                  (setq dir-C (if ediff-use-last-dir
 240                                                  ediff-last-dir-C
 241                                                (file-name-directory ff)))
 242                                  (progn
 243                                    (setq file-name-history
 244                                          (cons (ediff-abbreviate-file-name
 245                                                 (expand-file-name
 246                                                  (file-name-nondirectory ff)
 247                                                  dir-C))
 248                                                file-name-history))
 249                                    ff))
 250            )))
 251   (ediff-files-internal file-A
 252                         (if (file-directory-p file-B)
 253                             (expand-file-name
 254                              (file-name-nondirectory file-A) file-B)
 255                           file-B)
 256                         (if (file-directory-p file-C)
 257                             (expand-file-name
 258                              (file-name-nondirectory file-A) file-C)
 259                           file-C)
 260                         startup-hooks
 261                         'ediff-files3))
 262
 263 ;;;###autoload
 264 (defalias 'ediff3 'ediff-files3)
 265
 266
 267 ;; Visit FILE and arrange its buffer to Ediff's liking.
 268 ;; FILE is actually a variable symbol that must contain a true file name.
 269 ;; BUFFER-NAME is a variable symbol, which will get the buffer object into
 270 ;; which FILE is read.
 271 ;; LAST-DIR is the directory variable symbol where FILE's
 272 ;; directory name should be returned.  HOOKS-VAR is a variable symbol that will
 273 ;; be assigned the hook to be executed after `ediff-startup' is finished.
 274 ;; `ediff-find-file' arranges that the temp files it might create will be
 275 ;; deleted.
 276 (defun ediff-find-file (file-var buffer-name &optional last-dir hooks-var)
 277   (let* ((file (symbol-value file-var))
 278          (file-magic (ediff-filename-magic-p file))
 279          (temp-file-name-prefix (file-name-nondirectory file)))
 280     (cond ((not (file-readable-p file))
 281            (error "File `%s' does not exist or is not readable" file))
 282           ((file-directory-p file)
 283            (error "File `%s' is a directory" file)))
 284
 285     ;; some of the commands, below, require full file name
 286     (setq file (expand-file-name file))
 287
 288     ;; Record the directory of the file
 289     (if last-dir
 290         (set last-dir (expand-file-name (file-name-directory file))))
 291
 292     ;; Setup the buffer
 293     (set buffer-name (find-file-noselect file))
 294
 295     (ediff-with-current-buffer (symbol-value buffer-name)
 296       (widen) ; Make sure the entire file is seen
 297       (cond (file-magic  ;   file has a handler, such as jka-compr-handler or
 298                          ;;; ange-ftp-hook-function--arrange for temp file
 299              (ediff-verify-file-buffer 'magic)
 300              (setq file
 301                    (ediff-make-temp-file
 302                     (current-buffer) temp-file-name-prefix))
 303              (set hooks-var (cons (` (lambda () (delete-file (, file))))
 304                                   (symbol-value hooks-var))))
 305             ;; file processed via auto-mode-alist, a la uncompress.el
 306             ((not (equal (file-truename file)
 307                          (file-truename (buffer-file-name))))
 308              (setq file
 309                    (ediff-make-temp-file
 310                     (current-buffer) temp-file-name-prefix))
 311              (set hooks-var (cons (` (lambda () (delete-file (, file))))
 312                                   (symbol-value hooks-var))))
 313             (t ;; plain file---just check that the file matches the buffer
 314              (ediff-verify-file-buffer))))
 315     (set file-var file)))
 316
 317 ;; MERGE-BUFFER-FILE is the file to be associated with the merge buffer
 318 (defun ediff-files-internal (file-A file-B file-C startup-hooks job-name
 319                                     &optional merge-buffer-file)
 320   (let (buf-A buf-B buf-C)
 321     (message "Reading file %s ... " file-A)
 322     ;;(sit-for 0)
 323     (ediff-find-file 'file-A 'buf-A 'ediff-last-dir-A 'startup-hooks)
 324     (message "Reading file %s ... " file-B)
 325     ;;(sit-for 0)
 326     (ediff-find-file 'file-B 'buf-B 'ediff-last-dir-B 'startup-hooks)
 327     (if (stringp file-C)
 328         (progn
 329           (message "Reading file %s ... " file-C)
 330           ;;(sit-for 0)
 331           (ediff-find-file
 332            'file-C 'buf-C
 333            (if (eq job-name 'ediff-merge-files-with-ancestor)
 334                'ediff-last-dir-ancestor 'ediff-last-dir-C)
 335            'startup-hooks)))
 336     (ediff-setup buf-A file-A
 337                  buf-B file-B
 338                  buf-C file-C
 339                  startup-hooks
 340                  (list (cons 'ediff-job-name job-name))
 341                  merge-buffer-file)))
 342
 343
 344 ;;;###autoload
 345 (defalias 'ediff 'ediff-files)
 346
 347
 348 ;;;###autoload
 349 (defun ediff-buffers (buffer-A buffer-B &optional startup-hooks job-name)
 350   "Run Ediff on a pair of buffers, BUFFER-A and BUFFER-B."
 351   (interactive
 352    (let (bf)
 353      (list (setq bf (read-buffer "Buffer A to compare: "
 354                                  (ediff-other-buffer "") t))
 355            (read-buffer "Buffer B to compare: "
 356                         (progn
 357                           ;; realign buffers so that two visible bufs will be
 358                           ;; at the top
 359                           (save-window-excursion (other-window 1))
 360                           (ediff-other-buffer bf))
 361                         t))))
 362   (or job-name (setq job-name 'ediff-buffers))
 363   (ediff-buffers-internal buffer-A buffer-B nil startup-hooks job-name))
 364
 365 ;;;###autoload
 366 (defalias 'ebuffers 'ediff-buffers)
 367
 368
 369 ;;;###autoload
 370 (defun ediff-buffers3 (buffer-A buffer-B buffer-C
 371                                  &optional startup-hooks job-name)
 372   "Run Ediff on three buffers, BUFFER-A, BUFFER-B, and BUFFER-C."
 373   (interactive
 374    (let (bf bff)
 375      (list (setq bf (read-buffer "Buffer A to compare: "
 376                                  (ediff-other-buffer "") t))
 377            (setq bff (read-buffer "Buffer B to compare: "
 378                                   (progn
 379                                     ;; realign buffers so that two visible
 380                                     ;; bufs will be at the top
 381                                     (save-window-excursion (other-window 1))
 382                                     (ediff-other-buffer bf))
 383                                   t))
 384            (read-buffer "Buffer C to compare: "
 385                                   (progn
 386                                     ;; realign buffers so that three visible
 387                                     ;; bufs will be at the top
 388                                     (save-window-excursion (other-window 1))
 389                                     (ediff-other-buffer (list bf bff)))
 390                                   t)
 391            )))
 392   (or job-name (setq job-name 'ediff-buffers3))
 393   (ediff-buffers-internal buffer-A buffer-B buffer-C startup-hooks job-name))
 394
 395 ;;;###autoload
 396 (defalias 'ebuffers3 'ediff-buffers3)
 397
 398
 399
 400 ;; MERGE-BUFFER-FILE is the file to be associated with the merge buffer
 401 (defun ediff-buffers-internal (buf-A buf-B buf-C startup-hooks job-name
 402                                      &optional merge-buffer-file)
 403   (let* ((buf-A-file-name (buffer-file-name (get-buffer buf-A)))
 404          (buf-B-file-name (buffer-file-name (get-buffer buf-B)))
 405          (buf-C-is-alive (ediff-buffer-live-p buf-C))
 406          (buf-C-file-name (if buf-C-is-alive
 407                               (buffer-file-name (get-buffer buf-B))))
 408          file-A file-B file-C)
 409     (if (not (ediff-buffer-live-p buf-A))
 410         (error "Buffer %S doesn't exist" buf-A))
 411     (if (not (ediff-buffer-live-p buf-B))
 412         (error "Buffer %S doesn't exist" buf-B))
 413     (let ((ediff-job-name job-name))
 414       (if (and ediff-3way-comparison-job
 415                (not buf-C-is-alive))
 416           (error "Buffer %S doesn't exist" buf-C)))
 417     (if (stringp buf-A-file-name)
 418         (setq buf-A-file-name (file-name-nondirectory buf-A-file-name)))
 419     (if (stringp buf-B-file-name)
 420         (setq buf-B-file-name (file-name-nondirectory buf-B-file-name)))
 421     (if (stringp buf-C-file-name)
 422         (setq buf-C-file-name (file-name-nondirectory buf-C-file-name)))
 423
 424     (setq file-A (ediff-make-temp-file buf-A buf-A-file-name)
 425           file-B (ediff-make-temp-file buf-B buf-B-file-name))
 426     (if buf-C-is-alive
 427         (setq file-C (ediff-make-temp-file buf-C buf-C-file-name)))
 428
 429     (ediff-setup (get-buffer buf-A) file-A
 430                  (get-buffer buf-B) file-B
 431                  (if buf-C-is-alive (get-buffer buf-C))
 432                  file-C
 433                  (cons (` (lambda ()
 434                             (delete-file (, file-A))
 435                             (delete-file (, file-B))
 436                             (if (stringp (, file-C)) (delete-file (, file-C)))
 437                             ))
 438                        startup-hooks)
 439                  (list (cons 'ediff-job-name job-name))
 440                  merge-buffer-file)))
 441
 442
 443 ;;; Directory and file group operations
 444
 445 ;; Get appropriate default name for directory:
 446 ;; If ediff-use-last-dir, use ediff-last-dir-A.
 447 ;; In dired mode, use the directory that is under the point (if any);
 448 ;; otherwise, use default-directory
 449 (defun ediff-get-default-directory-name ()
 450   (cond (ediff-use-last-dir ediff-last-dir-A)
 451         ((eq major-mode 'dired-mode)
 452          (let ((f (dired-get-filename nil 'noerror)))
 453            (if (and (stringp f) (file-directory-p f))
 454                f
 455              default-directory)))
 456         (t default-directory)))
 457
 458
 459 ;;;###autoload
 460 (defun ediff-directories (dir1 dir2 regexp)
 461   "Run Ediff on a pair of directories, DIR1 and DIR2, comparing files that have
 462 the same name in both.  The third argument, REGEXP, is a regular expression
 463 that can be used to filter out certain file names."
 464   (interactive
 465    (let ((dir-A (ediff-get-default-directory-name))
 466          f)
 467      (list (setq f (ediff-read-file-name "Directory A to compare:" dir-A nil))
 468            (ediff-read-file-name "Directory B to compare:"
 469                                  (if ediff-use-last-dir
 470                                      ediff-last-dir-B
 471                                    (ediff-strip-last-dir f))
 472                                  nil)
 473            (read-string "Filter through regular expression: "
 474                         nil 'ediff-filtering-regexp-history)
 475            )))
 476   (ediff-directories-internal
 477    dir1 dir2 nil regexp 'ediff-files 'ediff-directories
 478    ))
 479
 480 ;;;###autoload
 481 (defalias 'edirs 'ediff-directories)
 482
 483
 484 ;;;###autoload
 485 (defun ediff-directory-revisions (dir1 regexp)
 486   "Run Ediff on a directory, DIR1, comparing its files with their revisions.
 487 The second argument, REGEXP, is a regular expression that filters the file
 488 names.  Only the files that are under revision control are taken into account."
 489   (interactive
 490    (let ((dir-A (ediff-get-default-directory-name)))
 491      (list (ediff-read-file-name
 492             "Directory to compare with revision:" dir-A nil)
 493            (read-string "Filter through regular expression: "
 494                         nil 'ediff-filtering-regexp-history)
 495            )))
 496   (ediff-directory-revisions-internal
 497    dir1 regexp 'ediff-revision 'ediff-directory-revisions
 498    ))
 499
 500 ;;;###autoload
 501 (defalias 'edir-revisions 'ediff-directory-revisions)
 502
 503
 504 ;;;###autoload
 505 (defun ediff-directories3 (dir1 dir2 dir3 regexp)
 506   "Run Ediff on three directories, DIR1, DIR2, and DIR3, comparing files that
 507 have the same name in all three.  The last argument, REGEXP, is a regular
 508 expression that can be used to filter out certain file names."
 509   (interactive
 510    (let ((dir-A (ediff-get-default-directory-name))
 511          f)
 512      (list (setq f (ediff-read-file-name "Directory A to compare:" dir-A nil))
 513            (setq f (ediff-read-file-name "Directory B to compare:"
 514                                          (if ediff-use-last-dir
 515                                              ediff-last-dir-B
 516                                            (ediff-strip-last-dir f))
 517                                          nil))
 518            (ediff-read-file-name "Directory C to compare:"
 519                                  (if ediff-use-last-dir
 520                                      ediff-last-dir-C
 521                                    (ediff-strip-last-dir f))
 522                                  nil)
 523            (read-string "Filter through regular expression: "
 524                         nil 'ediff-filtering-regexp-history)
 525            )))
 526   (ediff-directories-internal
 527    dir1 dir2 dir3 regexp 'ediff-files3 'ediff-directories3
 528    ))
 529
 530 ;;;###autoload
 531 (defalias 'edirs3 'ediff-directories3)
 532
 533 ;;;###autoload
 534 (defun ediff-merge-directories (dir1 dir2 regexp &optional merge-autostore-dir)
 535   "Run Ediff on a pair of directories, DIR1 and DIR2, merging files that have
 536 the same name in both.  The third argument, REGEXP, is a regular expression
 537 that can be used to filter out certain file names."
 538   (interactive
 539    (let ((dir-A (ediff-get-default-directory-name))
 540          f)
 541      (list (setq f (ediff-read-file-name "Directory A to merge:" dir-A nil))
 542            (ediff-read-file-name "Directory B to merge:"
 543                                  (if ediff-use-last-dir
 544                                      ediff-last-dir-B
 545                                    (ediff-strip-last-dir f))
 546                                  nil)
 547            (read-string "Filter through regular expression: "
 548                         nil 'ediff-filtering-regexp-history)
 549            )))
 550   (ediff-directories-internal
 551    dir1 dir2 nil regexp 'ediff-merge-files 'ediff-merge-directories
 552    nil merge-autostore-dir
 553    ))
 554
 555 ;;;###autoload
 556 (defalias 'edirs-merge 'ediff-merge-directories)
 557
 558 ;;;###autoload
 559 (defun ediff-merge-directories-with-ancestor (dir1 dir2 ancestor-dir regexp
 560                                                    &optional
 561                                                    merge-autostore-dir)
 562   "Merge files in directories DIR1 and DIR2 using files in ANCESTOR-DIR as ancestors.
 563 Ediff merges files that have identical names in DIR1, DIR2.  If a pair of files
 564 in DIR1 and DIR2 doesn't have an ancestor in ANCESTOR-DIR, Ediff will merge
 565 without ancestor.  The fourth argument, REGEXP, is a regular expression that
 566 can be used to filter out certain file names."
 567   (interactive
 568    (let ((dir-A (ediff-get-default-directory-name))
 569          f)
 570      (list (setq f (ediff-read-file-name "Directory A to merge:" dir-A nil))
 571            (setq f (ediff-read-file-name "Directory B to merge:"
 572                                  (if ediff-use-last-dir
 573                                      ediff-last-dir-B
 574                                    (ediff-strip-last-dir f))
 575                                  nil))
 576            (ediff-read-file-name "Ancestor directory:"
 577                                  (if ediff-use-last-dir
 578                                      ediff-last-dir-C
 579                                    (ediff-strip-last-dir f))
 580                                  nil)
 581            (read-string "Filter through regular expression: "
 582                         nil 'ediff-filtering-regexp-history)
 583            )))
 584   (ediff-directories-internal
 585    dir1 dir2 ancestor-dir regexp
 586    'ediff-merge-files-with-ancestor 'ediff-merge-directories-with-ancestor
 587    nil merge-autostore-dir
 588    ))
 589
 590 ;;;###autoload
 591 (defun ediff-merge-directory-revisions (dir1 regexp
 592                                              &optional merge-autostore-dir)
 593   "Run Ediff on a directory, DIR1, merging its files with their revisions.
 594 The second argument, REGEXP, is a regular expression that filters the file
 595 names.  Only the files that are under revision control are taken into account."
 596   (interactive
 597    (let ((dir-A (ediff-get-default-directory-name)))
 598      (list (ediff-read-file-name
 599             "Directory to merge with revisions:" dir-A nil)
 600            (read-string "Filter through regular expression: "
 601                         nil 'ediff-filtering-regexp-history)
 602            )))
 603   (ediff-directory-revisions-internal
 604    dir1 regexp 'ediff-merge-revisions 'ediff-merge-directory-revisions
 605    nil merge-autostore-dir
 606    ))
 607
 608 ;;;###autoload
 609 (defalias 'edir-merge-revisions 'ediff-merge-directory-revisions)
 610
 611 ;;;###autoload
 612 (defun ediff-merge-directory-revisions-with-ancestor (dir1 regexp
 613                                                            &optional
 614                                                            merge-autostore-dir)
 615   "Run Ediff on a directory, DIR1, merging its files with their revisions and ancestors.
 616 The second argument, REGEXP, is a regular expression that filters the file
 617 names.  Only the files that are under revision control are taken into account."
 618   (interactive
 619    (let ((dir-A (ediff-get-default-directory-name)))
 620      (list (ediff-read-file-name
 621             "Directory to merge with revisions and ancestors:" dir-A nil)
 622            (read-string "Filter through regular expression: "
 623                         nil 'ediff-filtering-regexp-history)
 624            )))
 625   (ediff-directory-revisions-internal
 626    dir1 regexp 'ediff-merge-revisions-with-ancestor
 627    'ediff-merge-directory-revisions-with-ancestor
 628    nil merge-autostore-dir
 629    ))
 630
 631 ;;;###autoload
 632 (defalias
 633   'edir-merge-revisions-with-ancestor
 634   'ediff-merge-directory-revisions-with-ancestor)
 635
 636 ;;;###autoload
 637 (defalias 'edirs-merge-with-ancestor 'ediff-merge-directories-with-ancestor)
 638
 639 ;; Run ediff-action (ediff-files, ediff-merge, ediff-merge-with-ancestors)
 640 ;; on a pair of directories (three directories, in case of ancestor).
 641 ;; The third argument, REGEXP, is a regular expression that can be used to
 642 ;; filter out certain file names.
 643 ;; JOBNAME is the symbol indicating the meta-job to be performed.
 644 ;; MERGE-AUTOSTORE-DIR is the directory in which to store merged files.
 645 (defun ediff-directories-internal (dir1 dir2 dir3 regexp action jobname
 646                                         &optional startup-hooks
 647                                         merge-autostore-dir)
 648   ;; ediff-read-file-name is set to attach a previously entered file name if
 649   ;; the currently entered file is a directory.  This code takes care of that.
 650   (setq dir1 (if (file-directory-p dir1) dir1 (file-name-directory dir1))
 651         dir2 (if (file-directory-p dir2) dir2 (file-name-directory dir2)))
 652
 653   (if (stringp dir3)
 654       (setq dir3 (if (file-directory-p dir3) dir3 (file-name-directory dir3))))
 655
 656   (cond ((string= dir1 dir2)
 657          (error "Directories A and B are the same: %s" dir1))
 658         ((and (eq jobname 'ediff-directories3)
 659               (string= dir1 dir3))
 660          (error "Directories A and C are the same: %s" dir1))
 661         ((and (eq jobname 'ediff-directories3)
 662               (string= dir2 dir3))
 663          (error "Directories B and C are the same: %s" dir1)))
 664
 665   (if merge-autostore-dir
 666       (or (stringp merge-autostore-dir)
 667           (error "%s: Directory for storing merged files must be a string"
 668                  jobname)))
 669   (let (diffs ; var where ediff-intersect-directories returns the diff list
 670         file-list meta-buf)
 671     (if (and ediff-autostore-merges
 672              (ediff-merge-metajob jobname)
 673              (not merge-autostore-dir))
 674         (setq merge-autostore-dir
 675               (read-file-name "Save merged files in directory: "
 676                               (if ediff-use-last-dir
 677                                         ediff-last-merge-autostore-dir
 678                                       (ediff-strip-last-dir dir1))
 679                               nil
 680                               'must-match)))
 681     ;; verify we are not merging into an orig directory
 682     (if merge-autostore-dir
 683         (cond ((and (stringp dir1) (string= merge-autostore-dir dir1))
 684                (or (y-or-n-p
 685                     "Directory for saving merged files = Directory A.  Sure? ")
 686                    (error "Directory merge aborted")))
 687               ((and (stringp dir2) (string= merge-autostore-dir dir2))
 688                (or (y-or-n-p
 689                     "Directory for saving merged files = Directory B.  Sure? ")
 690                    (error "Directory merge aborted")))
 691               ((and (stringp dir3) (string= merge-autostore-dir dir3))
 692                (or (y-or-n-p
 693                     "Directory for saving merged files = Ancestor Directory.  Sure? ")
 694                    (error "Directory merge aborted")))))
 695
 696     (setq file-list (ediff-intersect-directories
 697                      jobname 'diffs
 698                      regexp dir1 dir2 dir3 merge-autostore-dir))
 699     (setq startup-hooks
 700           ;; this sets various vars in the meta buffer inside
 701           ;; ediff-prepare-meta-buffer
 702           (cons (` (lambda ()
 703                      ;; tell what to do if the user clicks on a session record
 704                      (setq ediff-session-action-function (quote (, action)))
 705                      ;; set ediff-dir-difference-list
 706                      (setq ediff-dir-difference-list (quote (, diffs)))))
 707                 startup-hooks))
 708     (setq meta-buf (ediff-prepare-meta-buffer
 709                     'ediff-filegroup-action
 710                     file-list
 711                     "*Ediff Session Group Panel"
 712                     'ediff-redraw-directory-group-buffer
 713                     jobname
 714                     startup-hooks))
 715     (ediff-show-meta-buffer meta-buf)
 716     ))
 717
 718 ;; MERGE-AUTOSTORE-DIR can be given to tell ediff where to store the merged
 719 ;; files
 720 (defun ediff-directory-revisions-internal (dir1 regexp action jobname
 721                                                 &optional startup-hooks
 722                                                 merge-autostore-dir)
 723   (setq dir1 (if (file-directory-p dir1) dir1 (file-name-directory dir1)))
 724
 725   (if merge-autostore-dir
 726       (or (stringp merge-autostore-dir)
 727           (error "%S: Directory for storing merged files must be a string"
 728                  jobname)))
 729   (let (file-list meta-buf)
 730     (if (and ediff-autostore-merges
 731              (ediff-merge-metajob jobname)
 732              (not merge-autostore-dir))
 733         (setq merge-autostore-dir
 734               (read-file-name "Save merged files in directory: "
 735                               (if ediff-use-last-dir
 736                                   ediff-last-merge-autostore-dir
 737                                 (ediff-strip-last-dir dir1))
 738                               nil
 739                               'must-match)))
 740     ;; verify merge-autostore-dir != dir1
 741     (if (and merge-autostore-dir
 742              (stringp dir1)
 743              (string= merge-autostore-dir dir1))
 744         (or (y-or-n-p
 745              "Directory for saving merged file = directory A.  Sure? ")
 746             (error "Merge of directory revisions aborted")))
 747
 748     (setq file-list
 749           (ediff-get-directory-files-under-revision
 750            jobname regexp dir1 merge-autostore-dir))
 751     (setq startup-hooks
 752           ;; this sets various vars in the meta buffer inside
 753           ;; ediff-prepare-meta-buffer
 754           (cons (` (lambda ()
 755                      ;; tell what to do if the user clicks on a session record
 756                      (setq ediff-session-action-function (quote (, action)))
 757                      ))
 758                 startup-hooks))
 759     (setq meta-buf (ediff-prepare-meta-buffer
 760                     'ediff-filegroup-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
 770 ;;; Compare regions and windows
 771
 772 ;;;###autoload
 773 (defun ediff-windows-wordwise (dumb-mode &optional wind-A wind-B startup-hooks)
 774   "Compare WIND-A and WIND-B, which are selected by clicking, wordwise.
 775 With prefix argument, DUMB-MODE, or on a non-windowing display, works as
 776 follows:
 777 If WIND-A is nil, use selected window.
 778 If WIND-B is nil, use window next to WIND-A."
 779   (interactive "P")
 780   (ediff-windows dumb-mode wind-A wind-B
 781                  startup-hooks 'ediff-windows-wordwise 'word-mode))
 782
 783 ;;;###autoload
 784 (defun ediff-windows-linewise (dumb-mode &optional wind-A wind-B startup-hooks)
 785   "Compare WIND-A and WIND-B, which are selected by clicking, linewise.
 786 With prefix argument, DUMB-MODE, or on a non-windowing display, works as
 787 follows:
 788 If WIND-A is nil, use selected window.
 789 If WIND-B is nil, use window next to WIND-A."
 790   (interactive "P")
 791   (ediff-windows dumb-mode wind-A wind-B
 792                  startup-hooks 'ediff-windows-linewise nil))
 793
 794 ;; Compare WIND-A and WIND-B, which are selected by clicking.
 795 ;; With prefix argument, DUMB-MODE, or on a non-windowing display,
 796 ;; works as follows:
 797 ;; If WIND-A is nil, use selected window.
 798 ;; If WIND-B is nil, use window next to WIND-A.
 799 (defun ediff-windows (dumb-mode wind-A wind-B startup-hooks job-name word-mode)
 800   (if (or dumb-mode (not (ediff-window-display-p)))
 801       (setq wind-A (ediff-get-next-window wind-A nil)
 802             wind-B (ediff-get-next-window wind-B wind-A))
 803     (setq wind-A (ediff-get-window-by-clicking wind-A nil 1)
 804           wind-B (ediff-get-window-by-clicking wind-B wind-A 2)))
 805
 806   (let ((buffer-A (window-buffer wind-A))
 807         (buffer-B (window-buffer wind-B))
 808         beg-A end-A beg-B end-B)
 809
 810     (save-excursion
 811       (save-window-excursion
 812         (sit-for 0) ; sync before using window-start/end -- a precaution
 813         (select-window wind-A)
 814         (setq beg-A (window-start)
 815               end-A (window-end))
 816         (select-window wind-B)
 817         (setq beg-B (window-start)
 818               end-B (window-end))))
 819     (ediff-regions-internal
 820      buffer-A beg-A end-A buffer-B beg-B end-B
 821      startup-hooks job-name word-mode nil)))
 822
 823 ;;;###autoload
 824 (defun ediff-regions-wordwise (buffer-A buffer-B &optional startup-hooks)
 825   "Run Ediff on a pair of regions in two different buffers.
 826 Regions \(i.e., point and mark\) are assumed to be set in advance.
 827 This function is effective only for relatively small regions, up to 200
 828 lines.  For large regions, use `ediff-regions-linewise'."
 829   (interactive
 830    (let (bf)
 831      (list (setq bf (read-buffer "Region's A buffer: "
 832                                  (ediff-other-buffer "") t))
 833            (read-buffer "Region's B buffer: "
 834                         (progn
 835                           ;; realign buffers so that two visible bufs will be
 836                           ;; at the top
 837                           (save-window-excursion (other-window 1))
 838                           (ediff-other-buffer bf))
 839                         t))))
 840   (if (not (ediff-buffer-live-p buffer-A))
 841       (error "Buffer %S doesn't exist" buffer-A))
 842   (if (not (ediff-buffer-live-p buffer-B))
 843       (error "Buffer %S doesn't exist" buffer-B))
 844
 845
 846   (let (reg-A-beg reg-A-end reg-B-beg reg-B-end)
 847     (save-excursion
 848       (set-buffer buffer-A)
 849       (setq reg-A-beg (region-beginning)
 850             reg-A-end (region-end))
 851       (set-buffer buffer-B)
 852       (setq reg-B-beg (region-beginning)
 853             reg-B-end (region-end)))
 854
 855     (ediff-regions-internal
 856      (get-buffer buffer-A) reg-A-beg reg-A-end
 857      (get-buffer buffer-B) reg-B-beg reg-B-end
 858      startup-hooks 'ediff-regions-wordwise 'word-mode nil)))
 859
 860 ;;;###autoload
 861 (defun ediff-regions-linewise (buffer-A buffer-B &optional startup-hooks)
 862   "Run Ediff on a pair of regions in two different buffers.
 863 Regions \(i.e., point and mark\) are assumed to be set in advance.
 864 Each region is enlarged to contain full lines.
 865 This function is effective for large regions, over 100-200
 866 lines.  For small regions, use `ediff-regions-wordwise'."
 867   (interactive
 868    (let (bf)
 869      (list (setq bf (read-buffer "Region A's buffer: "
 870                                  (ediff-other-buffer "") t))
 871            (read-buffer "Region B's buffer: "
 872                         (progn
 873                           ;; realign buffers so that two visible bufs will be
 874                           ;; at the top
 875                           (save-window-excursion (other-window 1))
 876                           (ediff-other-buffer bf))
 877                         t))))
 878   (if (not (ediff-buffer-live-p buffer-A))
 879       (error "Buffer %S doesn't exist" buffer-A))
 880   (if (not (ediff-buffer-live-p buffer-B))
 881       (error "Buffer %S doesn't exist" buffer-B))
 882
 883   (let (reg-A-beg reg-A-end reg-B-beg reg-B-end)
 884     (save-excursion
 885       (set-buffer buffer-A)
 886       (setq reg-A-beg (region-beginning)
 887             reg-A-end (region-end))
 888       ;; enlarge the region to hold full lines
 889       (goto-char reg-A-beg)
 890       (beginning-of-line)
 891       (setq reg-A-beg (point))
 892       (goto-char reg-A-end)
 893       (end-of-line)
 894       (or (eobp) (forward-char)) ; include the newline char
 895       (setq reg-A-end (point))
 896
 897       (set-buffer buffer-B)
 898       (setq reg-B-beg (region-beginning)
 899             reg-B-end (region-end))
 900       ;; enlarge the region to hold full lines
 901       (goto-char reg-B-beg)
 902       (beginning-of-line)
 903       (setq reg-B-beg (point))
 904       (goto-char reg-B-end)
 905       (end-of-line)
 906       (or (eobp) (forward-char)) ; include the newline char
 907       (setq reg-B-end (point))
 908       ) ; save excursion
 909
 910     (ediff-regions-internal
 911      (get-buffer buffer-A) reg-A-beg reg-A-end
 912      (get-buffer buffer-B) reg-B-beg reg-B-end
 913      startup-hooks 'ediff-regions-linewise nil nil))) ; no word mode
 914
 915 ;; compare region beg-A to end-A of buffer-A
 916 ;; to regions beg-B -- end-B in buffer-B.
 917 (defun ediff-regions-internal (buffer-A beg-A end-A buffer-B beg-B end-B
 918                                         startup-hooks job-name word-mode
 919                                         setup-parameters)
 920   (let ((tmp-buffer (get-buffer-create ediff-tmp-buffer))
 921         overl-A overl-B
 922         file-A file-B)
 923
 924     ;; in case beg/end-A/B aren't markers--make them into markers
 925     (ediff-with-current-buffer buffer-A
 926       (setq beg-A (move-marker (make-marker) beg-A)
 927             end-A (move-marker (make-marker) end-A)))
 928     (ediff-with-current-buffer buffer-B
 929       (setq beg-B (move-marker (make-marker) beg-B)
 930             end-B (move-marker (make-marker) end-B)))
 931
 932     (if (and (eq buffer-A buffer-B)
 933              (or (and (< beg-A end-B) (<= beg-B beg-A))   ; b-B b-A e-B
 934                  (and (< beg-B end-A) (<= end-A end-B)))) ; b-B e-A e-B
 935         (progn
 936           (with-output-to-temp-buffer ediff-msg-buffer
 937             (princ "
 938 You have requested to compare overlapping regions of the same buffer.
 939
 940 In this case, Ediff's highlighting may be confusing---in the same window,
 941 you may see highlighted regions that belong to different regions.
 942
 943 Continue anyway? (y/n) "))
 944
 945           (if (y-or-n-p "Continue anyway? ")
 946               ()
 947             (error "%S aborted" job-name))))
 948
 949     ;; make file-A
 950     (if word-mode
 951         (ediff-wordify beg-A end-A buffer-A tmp-buffer)
 952       (ediff-copy-to-buffer beg-A end-A buffer-A tmp-buffer))
 953     (setq file-A (ediff-make-temp-file tmp-buffer "regA"))
 954
 955     ;; make file-B
 956     (if word-mode
 957         (ediff-wordify beg-B end-B buffer-B tmp-buffer)
 958       (ediff-copy-to-buffer beg-B end-B buffer-B tmp-buffer))
 959     (setq file-B (ediff-make-temp-file tmp-buffer "regB"))
 960
 961     (setq overl-A (ediff-make-bullet-proof-overlay beg-A end-A buffer-A))
 962     (setq overl-B (ediff-make-bullet-proof-overlay beg-B end-B buffer-B))
 963     (ediff-setup buffer-A file-A
 964                  buffer-B file-B
 965                  nil nil            ; buffer & file C
 966                  (cons (` (lambda ()
 967                             (delete-file (, file-A))
 968                             (delete-file (, file-B))))
 969                        startup-hooks)
 970                  (append
 971                   (list (cons 'ediff-word-mode  word-mode)
 972                         (cons 'ediff-narrow-bounds (list overl-A overl-B))
 973                         (cons 'ediff-job-name job-name))
 974                   setup-parameters))
 975     ))
 976
 977
 978 ;;; Merge files and buffers
 979
 980 ;;;###autoload
 981 (defalias 'ediff-merge 'ediff-merge-files)
 982
 983 (defsubst ediff-merge-on-startup ()
 984   (ediff-do-merge 0)
 985   (ediff-with-current-buffer ediff-buffer-C
 986     (set-buffer-modified-p nil)))
 987
 988 ;;;###autoload
 989 (defun ediff-merge-files (file-A file-B
 990                                  ;; MERGE-BUFFER-FILE is the file to be
 991                                  ;; associated with the merge buffer
 992                                  &optional startup-hooks merge-buffer-file)
 993   "Merge two files without ancestor."
 994   (interactive
 995    (let ((dir-A (if ediff-use-last-dir
 996                     ediff-last-dir-A
 997                   default-directory))
 998          dir-B f)
 999      (list (setq f (ediff-read-file-name
1000                     "File A to merge" dir-A
1001                     (ediff-get-default-file-name)))
1002            (ediff-read-file-name "File B to merge"
1003                                  (setq dir-B
1004                                        (if ediff-use-last-dir
1005                                            ediff-last-dir-B
1006                                          (file-name-directory f)))
1007                                  (progn
1008                                    (setq file-name-history
1009                                          (cons (ediff-abbreviate-file-name
1010                                                 (expand-file-name
1011                                                  (file-name-nondirectory f)
1012                                                  dir-B))
1013                                                file-name-history))
1014                                    f))
1015            )))
1016   (setq startup-hooks (cons 'ediff-merge-on-startup startup-hooks))
1017   (ediff-files-internal file-A
1018                         (if (file-directory-p file-B)
1019                             (expand-file-name
1020                              (file-name-nondirectory file-A) file-B)
1021                           file-B)
1022                           nil ; file-C
1023                           startup-hooks
1024                           'ediff-merge-files
1025                           merge-buffer-file))
1026
1027 ;;;###autoload
1028 (defun ediff-merge-files-with-ancestor (file-A file-B file-ancestor
1029                                                &optional
1030                                                startup-hooks
1031                                                ;; MERGE-BUFFER-FILE is the file
1032                                                ;; to be associated with the
1033                                                ;; merge buffer
1034                                                merge-buffer-file)
1035   "Merge two files with ancestor."
1036   (interactive
1037    (let ((dir-A (if ediff-use-last-dir
1038                     ediff-last-dir-A
1039                   default-directory))
1040          dir-B dir-ancestor f ff)
1041      (list (setq f (ediff-read-file-name
1042                     "File A to merge" dir-A
1043                     (ediff-get-default-file-name)))
1044            (setq ff (ediff-read-file-name "File B to merge"
1045                                           (setq dir-B
1046                                                 (if ediff-use-last-dir
1047                                                     ediff-last-dir-B
1048                                                   (file-name-directory f)))
1049                                           (progn
1050                                             (setq file-name-history
1051                                                   (cons
1052                                                    (ediff-abbreviate-file-name
1053                                                     (expand-file-name
1054                                                      (file-name-nondirectory f)
1055                                                      dir-B))
1056                                                    file-name-history))
1057                                             f)))
1058            (ediff-read-file-name "Ancestor file"
1059                                  (setq dir-ancestor
1060                                        (if ediff-use-last-dir
1061                                            ediff-last-dir-ancestor
1062                                          (file-name-directory ff)))
1063                                  (progn
1064                                    (setq file-name-history
1065                                          (cons (ediff-abbreviate-file-name
1066                                                 (expand-file-name
1067                                                  (file-name-nondirectory ff)
1068                                                  dir-ancestor))
1069                                                file-name-history))
1070                                    ff))
1071            )))
1072   (setq startup-hooks (cons 'ediff-merge-on-startup startup-hooks))
1073   (ediff-files-internal file-A
1074                         (if (file-directory-p file-B)
1075                             (expand-file-name
1076                              (file-name-nondirectory file-A) file-B)
1077                           file-B)
1078                           file-ancestor
1079                           startup-hooks
1080                           'ediff-merge-files-with-ancestor
1081                           merge-buffer-file))
1082
1083 ;;;###autoload
1084 (defalias 'ediff-merge-with-ancestor 'ediff-merge-files-with-ancestor)
1085
1086 ;;;###autoload
1087 (defun ediff-merge-buffers (buffer-A buffer-B
1088                                      &optional
1089                                      ;; MERGE-BUFFER-FILE is the file to be
1090                                      ;; associated with the merge buffer
1091                                      startup-hooks job-name merge-buffer-file)
1092   "Merge buffers without ancestor."
1093   (interactive
1094    (let (bf)
1095      (list (setq bf (read-buffer "Buffer A to merge: "
1096                                  (ediff-other-buffer "") t))
1097            (read-buffer "Buffer B to merge: "
1098                         (progn
1099                           ;; realign buffers so that two visible bufs will be
1100                           ;; at the top
1101                           (save-window-excursion (other-window 1))
1102                           (ediff-other-buffer bf))
1103                         t))))
1104
1105   (setq startup-hooks (cons 'ediff-merge-on-startup startup-hooks))
1106   (or job-name (setq job-name 'ediff-merge-buffers))
1107   (ediff-buffers-internal
1108    buffer-A buffer-B nil startup-hooks job-name merge-buffer-file))
1109
1110 ;;;###autoload
1111 (defun ediff-merge-buffers-with-ancestor (buffer-A buffer-B buffer-ancestor
1112                                                    &optional
1113                                                    startup-hooks
1114                                                    job-name
1115                                                    ;; MERGE-BUFFER-FILE is the
1116                                                    ;; file to be associated
1117                                                    ;; with the merge buffer
1118                                                    merge-buffer-file)
1119   "Merge buffers with ancestor."
1120   (interactive
1121    (let (bf bff)
1122      (list (setq bf (read-buffer "Buffer A to merge: "
1123                                  (ediff-other-buffer "") t))
1124            (setq bff (read-buffer "Buffer B to merge: "
1125                                   (progn
1126                                     ;; realign buffers so that two visible
1127                                     ;; bufs will be at the top
1128                                     (save-window-excursion (other-window 1))
1129                                     (ediff-other-buffer bf))
1130                                   t))
1131            (read-buffer "Ancestor buffer: "
1132                                   (progn
1133                                     ;; realign buffers so that three visible
1134                                     ;; bufs will be at the top
1135                                     (save-window-excursion (other-window 1))
1136                                     (ediff-other-buffer (list bf bff)))
1137                                   t)
1138            )))
1139
1140   (setq startup-hooks (cons 'ediff-merge-on-startup startup-hooks))
1141   (or job-name (setq job-name 'ediff-merge-buffers-with-ancestor))
1142   (ediff-buffers-internal
1143    buffer-A buffer-B buffer-ancestor startup-hooks job-name merge-buffer-file))
1144
1145
1146 ;;;###autoload
1147 (defun ediff-merge-revisions (&optional file startup-hooks merge-buffer-file)
1148   ;; MERGE-BUFFER-FILE is the file to be associated with the merge buffer
1149   "Run Ediff by merging two revisions of a file.
1150 The file is the optional FILE argument or the file visited by the current
1151 buffer."
1152   (interactive)
1153   (if (stringp file) (find-file file))
1154   (let (rev1 rev2)
1155     (setq rev1
1156           (read-string
1157            (format
1158             "Version 1 to merge (default: %s's latest version): "
1159             (if (stringp file)
1160                 (file-name-nondirectory file) "current buffer")))
1161           rev2
1162           (read-string
1163            (format
1164             "Version 2 to merge (default: %s): "
1165             (if (stringp file)
1166                 (file-name-nondirectory file) "current buffer"))))
1167     (ediff-load-version-control)
1168     ;; ancestor-revision=nil
1169     (funcall
1170      (intern (format "ediff-%S-merge-internal" ediff-version-control-package))
1171      rev1 rev2 nil startup-hooks merge-buffer-file)))
1172
1173
1174 ;;;###autoload
1175 (defun ediff-merge-revisions-with-ancestor (&optional
1176                                             file startup-hooks
1177                                             ;; MERGE-BUFFER-FILE is the file to
1178                                             ;; be associated with the merge
1179                                             ;; buffer
1180                                             merge-buffer-file)
1181   "Run Ediff by merging two revisions of a file with a common ancestor.
1182 The file is the the optional FILE argument or the file visited by the current
1183 buffer."
1184   (interactive)
1185   (if (stringp file) (find-file file))
1186   (let (rev1 rev2 ancestor-rev)
1187     (setq rev1
1188           (read-string
1189            (format
1190             "Version 1 to merge (default: %s's latest version): "
1191             (if (stringp file)
1192                 (file-name-nondirectory file) "current buffer")))
1193           rev2
1194           (read-string
1195            (format
1196             "Version 2 to merge (default: %s): "
1197             (if (stringp file)
1198                 (file-name-nondirectory file) "current buffer")))
1199           ancestor-rev
1200           (read-string
1201            (format
1202             "Ancestor version (default: %s's base revision): "
1203             (if (stringp file)
1204                 (file-name-nondirectory file) "current buffer"))))
1205     (ediff-load-version-control)
1206     (funcall
1207      (intern (format "ediff-%S-merge-internal" ediff-version-control-package))
1208      rev1 rev2 ancestor-rev startup-hooks merge-buffer-file)))
1209
1210 ;;;###autoload
1211 (defun run-ediff-from-cvs-buffer (pos)
1212   "Run Ediff-merge on appropriate revisions of the selected file.
1213 First run after `M-x cvs-update'.  Then place the cursor on a line describing a
1214 file and then run `run-ediff-from-cvs-buffer'."
1215   (interactive "d")
1216   (ediff-load-version-control)
1217   (let ((tin (tin-locate cvs-cookie-handle pos)))
1218     (if tin
1219         (cvs-run-ediff-on-file-descriptor tin)
1220       (error "There is no file to merge"))))
1221
1222
1223 ;;; Apply patch
1224
1225 ;;;###autoload
1226 (defun ediff-patch-file (&optional arg patch-buf)
1227   "Run Ediff by patching SOURCE-FILENAME.
1228 If optional PATCH-BUF is given, use the patch in that buffer
1229 and don't ask the user.
1230 If prefix argument, then: if even argument, assume that the patch is in a
1231 buffer. If odd -- assume it is in a file."
1232   (interactive "P")
1233   (let (source-dir source-file)
1234     (require 'ediff-ptch)
1235     (setq patch-buf
1236           (ediff-get-patch-buffer
1237            (if arg (prefix-numeric-value arg)) patch-buf))
1238     (setq source-dir (cond (ediff-use-last-dir ediff-last-dir-patch)
1239                            ((and (not ediff-patch-default-directory)
1240                                  (buffer-file-name patch-buf))
1241                             (file-name-directory
1242                              (expand-file-name
1243                               (buffer-file-name patch-buf))))
1244                            (t default-directory)))
1245     (setq source-file
1246           ;; the default is the directory, not the visited file name
1247           (read-file-name
1248            "File to patch (directory, if multifile patch): "
1249            source-dir (ediff-get-default-file-name)))
1250     (ediff-dispatch-file-patching-job patch-buf source-file)))
1251
1252 ;;;###autoload
1253 (defun ediff-patch-buffer (&optional arg patch-buf)
1254   "Run Ediff by patching BUFFER-NAME."
1255   (interactive "P")
1256   (require 'ediff-ptch)
1257   (setq patch-buf
1258         (ediff-get-patch-buffer
1259          (if arg (prefix-numeric-value arg)) patch-buf))
1260   (ediff-patch-buffer-internal
1261    patch-buf
1262    (read-buffer
1263     "Which buffer to patch? "
1264     (ediff-prompt-for-patch-buffer))))
1265
1266
1267 ;;;###autoload
1268 (defalias 'epatch 'ediff-patch-file)
1269 ;;;###autoload
1270 (defalias 'epatch-buffer 'ediff-patch-buffer)
1271
1272
1273
1274 \f
1275 ;;; Versions Control functions
1276
1277 ;;;###autoload
1278 (defun ediff-revision (&optional file startup-hooks)
1279   "Run Ediff by comparing versions of a file.
1280 The file is an optional FILE argument or the file visited by the current
1281 buffer.  Use `vc.el' or `rcs.el' depending on `ediff-version-control-package'."
1282   ;; if buffer is non-nil, use that buffer instead of the current buffer
1283   (interactive "P")
1284   (if (stringp file) (find-file file))
1285   (let (rev1 rev2)
1286     (setq rev1
1287           (read-string
1288            (format "Version 1 to compare (default: %s's latest version): "
1289                    (if (stringp file)
1290                        (file-name-nondirectory file) "current buffer")))
1291           rev2
1292           (read-string
1293            (format "Version 2 to compare (default: %s): "
1294                    (if (stringp file)
1295                        (file-name-nondirectory file) "current buffer"))))
1296     (ediff-load-version-control)
1297     (funcall
1298      (intern (format "ediff-%S-internal" ediff-version-control-package))
1299      rev1 rev2 startup-hooks)
1300     ))
1301
1302
1303 ;;;###autoload
1304 (defalias 'erevision 'ediff-revision)
1305
1306
1307 ;; Test if version control package is loaded and load if not
1308 ;; Is SILENT is non-nil, don't report error if package is not found.
1309 (defun ediff-load-version-control (&optional silent)
1310   (require 'ediff-vers)
1311   (or (featurep ediff-version-control-package)
1312       (if (locate-library (symbol-name ediff-version-control-package))
1313           (progn
1314             (message "") ; kill the message from `locate-library'
1315             (require ediff-version-control-package))
1316         (or silent
1317             (error "Version control package %S.el not found.  Use vc.el instead"
1318                    ediff-version-control-package)))))
1319
1320
1321 ;;;###autoload
1322 (defun ediff-version ()
1323   "Return string describing the version of Ediff.
1324 When called interactively, displays the version."
1325   (interactive)
1326   (if (interactive-p)
1327       (message (ediff-version))
1328     (format "Ediff %s of %s" ediff-version ediff-date)))
1329
1330
1331 ;;;###autoload
1332 (defun ediff-documentation (&optional node)
1333   "Display Ediff's manual.
1334 With optional NODE, goes to that node."
1335   (interactive)
1336   (let ((ctl-window ediff-control-window)
1337         (ctl-buf ediff-control-buffer))
1338
1339     (ediff-skip-unsuitable-frames)
1340     (condition-case nil
1341         (progn
1342           (pop-to-buffer (get-buffer-create "*info*"))
1343           (info (if ediff-xemacs-p "ediff.info" "ediff"))
1344           (if node
1345               (Info-goto-node node)
1346             (message "Type `i' to search for a specific topic"))
1347           (raise-frame (selected-frame)))
1348       (error (beep 1)
1349              (with-output-to-temp-buffer ediff-msg-buffer
1350                (princ ediff-BAD-INFO))
1351              (if (window-live-p ctl-window)
1352                  (progn
1353                    (select-window ctl-window)
1354                    (set-window-buffer ctl-window ctl-buf)))))))
1355
1356
1357
1358
1359 ;;; Local Variables:
1360 ;;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
1361 ;;; eval: (put 'ediff-with-current-buffer 'lisp-indent-hook 1)
1362 ;;; eval: (put 'ediff-with-current-buffer 'edebug-form-spec '(form body))
1363 ;;; End:
1364
1365 (require 'ediff-util)
1366
1367 (run-hooks 'ediff-load-hook)
1368
1369 ;;; ediff.el ends here