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

   1 ;;; ediff-init.el --- Macros, variables, and defsubsts used by Ediff
   2
   3 ;; Copyright (C) 1994, 1995, 1996, 1997 Free Software Foundation, Inc.
   4
   5 ;; Author: Michael Kifer <kifer@cs.sunysb.edu>
   6
   7 ;; This file is part of GNU Emacs.
   8
   9 ;; GNU Emacs is free software; you can redistribute it and/or modify
  10 ;; it under the terms of the GNU General Public License as published by
  11 ;; the Free Software Foundation; either version 2, or (at your option)
  12 ;; any later version.
  13
  14 ;; GNU Emacs is distributed in the hope that it will be useful,
  15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 ;; GNU General Public License for more details.
  18
  19 ;; You should have received a copy of the GNU General Public License
  20 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  22 ;; Boston, MA 02111-1307, USA.
  23
  24 ;;; Code:
  25
  26 ;; Start compiler pacifier
  27 (defvar ediff-metajob-name)
  28 (defvar ediff-meta-buffer)
  29 (defvar pm-color-alist)
  30 (defvar ediff-grab-mouse)
  31 (defvar ediff-mouse-pixel-position)
  32 (defvar ediff-mouse-pixel-threshold)
  33 (defvar ediff-whitespace)
  34 (defvar ediff-multiframe)
  35 (defvar ediff-use-toolbar-p)
  36
  37 (and noninteractive
  38      (eval-when-compile
  39          (load "ange-ftp" 'noerror)))
  40 ;; end pacifier
  41
  42 ;; Is it XEmacs?
  43 (defconst ediff-xemacs-p (string-match "XEmacs" emacs-version))
  44 ;; Is it Emacs?
  45 (defconst ediff-emacs-p (not ediff-xemacs-p))
  46
  47 (defvar ediff-force-faces nil
  48   "If t, Ediff will think that it is running on a display that supports faces.
  49 This is provided as a temporary relief for users of face-capable displays
  50 that Ediff doesn't know about.")
  51
  52 ;; Are we running as a window application or on a TTY?
  53 (defsubst ediff-device-type ()
  54   (if ediff-emacs-p
  55       window-system
  56     (device-type (selected-device))))
  57
  58 ;; in XEmacs: device-type is tty on tty and stream in batch.
  59 (defun ediff-window-display-p ()
  60   (and (ediff-device-type) (not (memq (ediff-device-type) '(tty pc stream)))))
  61
  62 ;; test if supports faces
  63 (defun ediff-has-face-support-p ()
  64   (cond ((ediff-window-display-p))
  65         (ediff-force-faces)
  66         (ediff-emacs-p (memq (ediff-device-type) '(pc)))
  67         (ediff-xemacs-p (memq (ediff-device-type) '(tty pc)))))
  68
  69 (defun ediff-has-toolbar-support-p ()
  70   (and ediff-xemacs-p
  71        (featurep 'toolbar)
  72        (console-on-window-system-p)))
  73
  74 (defun ediff-use-toolbar-p ()
  75   (and (ediff-has-toolbar-support-p)    ;Can it do it ?
  76        (boundp 'ediff-use-toolbar-p)
  77        ediff-use-toolbar-p))            ;Does the user want it ?
  78
  79 ;; Defines SYMBOL as an advertised local variable.
  80 ;; Performs a defvar, then executes `make-variable-buffer-local' on
  81 ;; the variable.  Also sets the `permanent-local' property,
  82 ;; so that `kill-all-local-variables' (called by major-mode setting
  83 ;; commands) won't destroy Ediff control variables.
  84 ;;
  85 ;; Plagiarised from `emerge-defvar-local' for XEmacs.
  86 (defmacro ediff-defvar-local (var value doc)
  87   (` (progn
  88        (defvar (, var) (, value) (, doc))
  89        (make-variable-buffer-local '(, var))
  90        (put '(, var) 'permanent-local t))))
  91
  92
  93
  94 ;; Variables that control each Ediff session---local to the control buffer.
  95
  96 ;; Mode variables
  97 ;; The buffer in which the A variant is stored.
  98 (ediff-defvar-local ediff-buffer-A nil "")
  99 ;; The buffer in which the B variant is stored.
 100 (ediff-defvar-local ediff-buffer-B nil "")
 101 ;; The buffer in which the C variant is stored.
 102 (ediff-defvar-local ediff-buffer-C nil "")
 103 ;; Ancestor buffer
 104 (ediff-defvar-local ediff-ancestor-buffer nil "")
 105 ;; The Ediff control buffer
 106 (ediff-defvar-local ediff-control-buffer nil "")
 107
 108
 109 ;; Association between buff-type and ediff-buffer-*
 110 (defconst ediff-buffer-alist
 111   '((?A . ediff-buffer-A)
 112     (?B . ediff-buffer-B)
 113     (?C . ediff-buffer-C)))
 114
 115 ;;; Macros
 116 (defmacro ediff-odd-p (arg)
 117   (` (eq (logand (, arg) 1) 1)))
 118
 119 (defmacro ediff-buffer-live-p (buf)
 120   (` (and (, buf) (get-buffer (, buf)) (buffer-name (get-buffer (, buf))))))
 121
 122 (defmacro ediff-get-buffer (arg)
 123   (` (cond ((eq (, arg) 'A) ediff-buffer-A)
 124            ((eq (, arg) 'B) ediff-buffer-B)
 125            ((eq (, arg) 'C) ediff-buffer-C)
 126            ((eq (, arg) 'Ancestor) ediff-ancestor-buffer)
 127            )
 128   ))
 129
 130 (defmacro ediff-get-value-according-to-buffer-type (buf-type list)
 131   (` (cond ((eq (, buf-type) 'A) (nth 0 (, list)))
 132            ((eq (, buf-type) 'B) (nth 1 (, list)))
 133            ((eq (, buf-type) 'C) (nth 2 (, list))))))
 134
 135 (defmacro ediff-char-to-buftype (arg)
 136   (` (cond ((memq (, arg) '(?a ?A)) 'A)
 137            ((memq (, arg) '(?b ?B)) 'B)
 138            ((memq (, arg) '(?c ?C)) 'C)
 139            )
 140   ))
 141
 142
 143 ;; A-list is supposed to be of the form (A . symb) (B . symb)...)
 144 ;; where the first part of any association is a buffer type and the second is
 145 ;; an appropriate symbol. Given buffer-type, this function returns the
 146 ;; symbol. This is used to avoid using `intern'
 147 (defsubst ediff-get-symbol-from-alist (buf-type alist)
 148   (cdr (assoc buf-type alist)))
 149
 150 (defconst ediff-difference-vector-alist
 151   '((A . ediff-difference-vector-A)
 152     (B . ediff-difference-vector-B)
 153     (C . ediff-difference-vector-C)
 154     (Ancestor . ediff-difference-vector-Ancestor)))
 155
 156 (defmacro ediff-get-difference (n buf-type)
 157   (` (aref
 158       (symbol-value
 159        (ediff-get-symbol-from-alist
 160         (, buf-type) ediff-difference-vector-alist))
 161       (, n))))
 162
 163 ;; Tell if it has been previously determined that the region has
 164 ;; no diffs other than the white space and newlines
 165 ;; The argument, N, is the diff region number used by Ediff to index the
 166 ;; diff vector. It is 1 less than the number seen by the user.
 167 ;; Returns:
 168 ;;              t  if the diffs are whitespace in all buffers
 169 ;;              'A (in 3-buf comparison only) if there are only whitespace
 170 ;;                 diffs in bufs B and C
 171 ;;              'B (in 3-buf comparison only) if there are only whitespace
 172 ;;                 diffs in bufs A and C
 173 ;;              'C (in 3-buf comparison only) if there are only whitespace
 174 ;;                 diffs in bufs A and B
 175 ;;
 176 ;; A difference vector has the form:
 177 ;; [diff diff diff ...]
 178 ;; where each diff has the form:
 179 ;; [overlay fine-diff-vector no-fine-diffs-flag]
 180 ;; fine-diff-vector is a vector [fine-diff fine-diff fine-diff ...]
 181 (defmacro ediff-no-fine-diffs-p (n)
 182   (` (aref (ediff-get-difference (, n) 'A) 2)))
 183
 184 (defmacro ediff-get-diff-overlay-from-diff-record (diff-rec)
 185   (` (aref (, diff-rec) 0)))
 186
 187 (defmacro ediff-get-diff-overlay (n buf-type)
 188   (` (ediff-get-diff-overlay-from-diff-record
 189       (ediff-get-difference (, n) (, buf-type)))))
 190
 191 (defmacro ediff-get-fine-diff-vector-from-diff-record (diff-rec)
 192   (` (aref (, diff-rec) 1)))
 193
 194 (defmacro ediff-set-fine-diff-vector (n buf-type fine-vec)
 195   (` (aset (ediff-get-difference (, n) (, buf-type)) 1 (, fine-vec))))
 196
 197 (defmacro ediff-get-state-of-diff (n buf-type)
 198   (` (if (ediff-buffer-live-p ediff-buffer-C)
 199          (aref (ediff-get-difference (, n) (, buf-type)) 3))))
 200 (defmacro ediff-set-state-of-diff (n buf-type val)
 201   (` (aset (ediff-get-difference (, n) (, buf-type)) 3 (, val))))
 202 (defmacro ediff-get-state-of-merge (n)
 203   (` (if ediff-state-of-merge
 204          (aref (aref ediff-state-of-merge (, n)) 0))))
 205 (defmacro ediff-get-state-of-ancestor (n)
 206   (` (if ediff-state-of-merge
 207          (aref (aref ediff-state-of-merge (, n)) 1))))
 208 (defmacro ediff-set-state-of-merge (n val)
 209   (` (if ediff-state-of-merge
 210          (aset (aref ediff-state-of-merge (, n)) 0 (, val)))))
 211
 212 ;; if flag is t, puts a mark on diff region saying that
 213 ;; the differences are in white space only. If flag is nil,
 214 ;; the region is marked as essential (i.e., differences are
 215 ;; not just in the white space and newlines.)
 216 (defmacro ediff-mark-diff-as-space-only (n flag)
 217   (` (aset (ediff-get-difference (, n) 'A) 2 (, flag))))
 218
 219 (defmacro ediff-get-fine-diff-vector (n buf-type)
 220   (` (ediff-get-fine-diff-vector-from-diff-record
 221       (ediff-get-difference (, n) (, buf-type)))))
 222
 223 ;; Macro to switch to BUFFER, evaluate BODY, returns to original buffer.
 224 ;; Doesn't save the point and mark.
 225 ;; This is `with-current-buffer' with the added test for live buffers."
 226 (defmacro ediff-with-current-buffer (buffer &rest body)
 227   (` (if (ediff-buffer-live-p (, buffer))
 228        (save-current-buffer
 229          (set-buffer (, buffer))
 230          (,@ body))
 231      (or (eq this-command 'ediff-quit)
 232          (error ediff-KILLED-VITAL-BUFFER))
 233      )))
 234
 235
 236 (defsubst ediff-multiframe-setup-p ()
 237   (and (ediff-window-display-p) ediff-multiframe))
 238
 239 (defmacro ediff-narrow-control-frame-p ()
 240   (` (and (ediff-multiframe-setup-p)
 241           (equal ediff-help-message ediff-brief-message-string))))
 242
 243 (defmacro ediff-3way-comparison-job ()
 244   (` (memq
 245       ediff-job-name
 246       '(ediff-files3 ediff-buffers3))))
 247 (ediff-defvar-local ediff-3way-comparison-job nil "")
 248
 249 (defmacro ediff-merge-job ()
 250   (` (memq
 251       ediff-job-name
 252       '(ediff-merge-files
 253         ediff-merge-buffers
 254         ediff-merge-files-with-ancestor
 255         ediff-merge-buffers-with-ancestor
 256         ediff-merge-revisions
 257         ediff-merge-revisions-with-ancestor))))
 258 (ediff-defvar-local ediff-merge-job nil "")
 259
 260 (defmacro ediff-merge-with-ancestor-job ()
 261   (` (memq
 262       ediff-job-name
 263       '(ediff-merge-files-with-ancestor
 264         ediff-merge-buffers-with-ancestor
 265         ediff-merge-revisions-with-ancestor))))
 266 (ediff-defvar-local ediff-merge-with-ancestor-job nil "")
 267
 268 (defmacro ediff-3way-job ()
 269   (` (or ediff-3way-comparison-job ediff-merge-job)))
 270 (ediff-defvar-local ediff-3way-job nil "")
 271
 272 ;; A diff3 job is like a 3way job, but ediff-merge doesn't require the use
 273 ;; of diff3.
 274 (defmacro ediff-diff3-job ()
 275   (` (or ediff-3way-comparison-job
 276          ediff-merge-with-ancestor-job)))
 277 (ediff-defvar-local ediff-diff3-job nil "")
 278
 279 (defmacro ediff-windows-job ()
 280   (` (memq ediff-job-name '(ediff-windows-wordwise ediff-windows-linewise))))
 281 (ediff-defvar-local ediff-windows-job nil "")
 282
 283 (defmacro ediff-word-mode-job ()
 284   (` (memq ediff-job-name '(ediff-windows-wordwise  ediff-regions-wordwise))))
 285 (ediff-defvar-local ediff-word-mode-job nil "")
 286
 287 (defmacro ediff-narrow-job ()
 288   (` (memq ediff-job-name '(ediff-windows-wordwise
 289                             ediff-regions-wordwise
 290                             ediff-windows-linewise
 291                             ediff-regions-linewise))))
 292 (ediff-defvar-local ediff-narrow-job nil "")
 293
 294 ;; Note: ediff-merge-directory-revisions-with-ancestor is not treated as an
 295 ;; ancestor metajob, since it behaves differently.
 296 (defsubst ediff-ancestor-metajob (&optional metajob)
 297   (memq (or metajob ediff-metajob-name)
 298         '(ediff-merge-directories-with-ancestor
 299           ediff-merge-filegroups-with-ancestor)))
 300 (defsubst ediff-revision-metajob (&optional metajob)
 301   (memq (or metajob ediff-metajob-name)
 302         '(ediff-directory-revisions
 303           ediff-merge-directory-revisions
 304           ediff-merge-directory-revisions-with-ancestor)))
 305 (defsubst ediff-patch-metajob (&optional metajob)
 306   (memq (or metajob ediff-metajob-name)
 307         '(ediff-multifile-patch)))
 308 ;; metajob involving only one group of files, such as multipatch or directory
 309 ;; revision
 310 (defsubst ediff-one-filegroup-metajob (&optional metajob)
 311   (or (ediff-revision-metajob metajob)
 312       (ediff-patch-metajob metajob)
 313       ;; add more here
 314       ))
 315 (defsubst ediff-collect-diffs-metajob (&optional metajob)
 316   (memq (or metajob ediff-metajob-name)
 317         '(ediff-directories
 318           ediff-directory-revisions
 319           ediff-merge-directories
 320           ediff-merge-directories-with-ancestor
 321           ediff-merge-directory-revisions
 322           ediff-merge-directory-revisions-with-ancestor
 323           ;; add more here
 324           )))
 325 (defsubst ediff-merge-metajob (&optional metajob)
 326   (memq (or metajob ediff-metajob-name)
 327         '(ediff-merge-directories
 328           ediff-merge-directories-with-ancestor
 329           ediff-merge-directory-revisions
 330           ediff-merge-directory-revisions-with-ancestor
 331           ediff-merge-filegroups-with-ancestor
 332           ;; add more here
 333           )))
 334
 335 (defsubst ediff-metajob3 (&optional metajob)
 336   (memq (or metajob ediff-metajob-name)
 337         '(ediff-merge-directories-with-ancestor
 338           ediff-merge-filegroups-with-ancestor
 339           ediff-directories3
 340           ediff-filegroups3)))
 341 (defsubst ediff-comparison-metajob3 (&optional metajob)
 342   (memq (or metajob ediff-metajob-name)
 343         '(ediff-directories3 ediff-filegroups3)))
 344
 345 ;; with no argument, checks if we are in ediff-control-buffer
 346 ;; with argument, checks if we are in ediff-meta-buffer
 347 (defun ediff-in-control-buffer-p (&optional meta-buf-p)
 348   (and (boundp 'ediff-control-buffer)
 349        (eq (if meta-buf-p ediff-meta-buffer ediff-control-buffer)
 350            (current-buffer))))
 351
 352 (defsubst ediff-barf-if-not-control-buffer (&optional meta-buf-p)
 353   (or (ediff-in-control-buffer-p meta-buf-p)
 354       (error "%S: This command runs in Ediff Control Buffer only!"
 355              this-command)))
 356
 357 (defgroup ediff-highlighting nil
 358   "Hilighting of difference regions in Ediff"
 359   :prefix "ediff-"
 360   :group 'ediff)
 361
 362 (defgroup ediff-merge nil
 363   "Merging utilities"
 364   :prefix "ediff-"
 365   :group 'ediff)
 366
 367 (defgroup ediff-hook nil
 368   "Hooks called by Ediff"
 369   :prefix "ediff-"
 370   :group 'ediff)
 371
 372 ;; Hook variables
 373
 374 (defcustom ediff-before-setup-windows-hook nil
 375   "*Hooks to run before Ediff sets its window configuration.
 376 This can be used to save the previous window config, which can be restored
 377 on ediff-quit or ediff-suspend."
 378   :type 'hook
 379   :group 'ediff-hook)
 380 (defcustom ediff-after-setup-windows-hook nil
 381   "*Hooks to run after Ediff sets its window configuration.
 382 This can be used to set up control window or icon in a desired place."
 383   :type 'hook
 384   :group 'ediff-hook)
 385 (defcustom ediff-before-setup-control-frame-hook nil
 386   "*Hooks run before setting up the frame to display Ediff Control Panel.
 387 Can be used to change control frame parameters to position it where it
 388 is desirable."
 389   :type 'hook
 390   :group 'ediff-hook)
 391 (defcustom ediff-after-setup-control-frame-hook nil
 392   "*Hooks run after setting up the frame to display Ediff Control Panel.
 393 Can be used to move the frame where it is desired."
 394   :type 'hook
 395   :group 'ediff-hook)
 396 (defcustom ediff-startup-hook nil
 397   "*Hooks to run in the control buffer after Ediff has been set up."
 398   :type 'hook
 399   :group 'ediff-hook)
 400 (defcustom ediff-select-hook nil
 401   "*Hooks to run after a difference has been selected."
 402   :type 'hook
 403   :group 'ediff-hook)
 404 (defcustom ediff-unselect-hook nil
 405   "*Hooks to run after a difference has been unselected."
 406   :type 'hook
 407   :group 'ediff-hook)
 408 (defcustom ediff-prepare-buffer-hook  nil
 409   "*Hooks called after buffers A, B, and C are set up."
 410   :type 'hook
 411   :group 'ediff-hook)
 412 (defcustom ediff-load-hook nil
 413   "*Hook run after Ediff is loaded.  Can be used to change defaults."
 414   :type 'hook
 415   :group 'ediff-hook)
 416
 417 (defcustom ediff-mode-hook nil
 418   "*Hook run just after ediff-mode is set up in the control buffer.
 419 This is done before any windows or frames are created. One can use it to
 420 set local variables that determine how the display looks like."
 421   :type 'hook
 422   :group 'ediff-hook)
 423 (defcustom ediff-keymap-setup-hook nil
 424   "*Hook run just after the default bindings in Ediff keymap are set up."
 425   :type 'hook
 426   :group 'ediff-hook)
 427
 428 (defcustom ediff-display-help-hook nil
 429   "*Hooks run after preparing the help message."
 430   :type 'hook
 431   :group 'ediff-hook)
 432
 433 (defcustom ediff-suspend-hook (list 'ediff-default-suspend-function)
 434   "*Hooks to run in the Ediff control buffer when Ediff is suspended."
 435   :type 'hook
 436   :group 'ediff-hook)
 437 (defcustom ediff-quit-hook (list 'ediff-cleanup-mess)
 438   "*Hooks to run in the Ediff control buffer after finishing Ediff."
 439   :type 'hook
 440   :group 'ediff-hook)
 441 (defcustom ediff-cleanup-hook nil
 442   "*Hooks to run on exiting Ediff but before killing the control buffer.
 443 This is a place to do various cleanups, such as deleting the variant buffers.
 444 Ediff provides a function, `ediff-janitor', as one such possible hook."
 445   :type 'hook
 446   :group 'ediff-hook)
 447
 448 ;; Error messages
 449 (defconst ediff-KILLED-VITAL-BUFFER
 450   "You have killed a vital Ediff buffer---you must leave Ediff now!")
 451 (defconst ediff-NO-DIFFERENCES
 452   "Sorry, comparison of identical variants is not what I am made for...")
 453 (defconst ediff-BAD-DIFF-NUMBER
 454   ;; %S stands for this-command, %d - diff number, %d - max diff
 455   "%S: Bad diff region number, %d. Valid numbers are 1 to %d")
 456 (defconst ediff-BAD-INFO (format "
 457 *** The Info file for Ediff, a part of the standard distribution
 458 *** of %sEmacs, does not seem to be properly installed.
 459 ***
 460 *** Please contact your system administrator. "
 461                                  (if ediff-xemacs-p "X" "")))
 462
 463 ;; Selective browsing
 464
 465 (ediff-defvar-local ediff-skip-diff-region-function 'ediff-show-all-diffs
 466   "Function that determines the next/previous diff region to show.
 467 Should return t for regions to be ignored and nil otherwise.
 468 This function gets a region number as an argument. The region number
 469 is the one used internally by Ediff. It is 1 less than the number seen
 470 by the user.")
 471
 472 (ediff-defvar-local ediff-hide-regexp-matches-function
 473   'ediff-hide-regexp-matches
 474   "Function to use in determining which regions to hide.
 475 See the documentation string of `ediff-hide-regexp-matches' for details.")
 476 (ediff-defvar-local ediff-focus-on-regexp-matches-function
 477   'ediff-focus-on-regexp-matches
 478   "Function to use in determining which regions to focus on.
 479 See the documentation string of `ediff-focus-on-regexp-matches' for details.")
 480
 481 ;; Regexp that determines buf A regions to focus on when skipping to diff
 482 (ediff-defvar-local ediff-regexp-focus-A "" "")
 483 ;; Regexp that determines buf B regions to focus on when skipping to diff
 484 (ediff-defvar-local ediff-regexp-focus-B "" "")
 485 ;; Regexp that determines buf C regions to focus on when skipping to diff
 486 (ediff-defvar-local ediff-regexp-focus-C "" "")
 487 ;; connective that determines whether to focus regions that match both or
 488 ;; one of the regexps
 489 (ediff-defvar-local ediff-focus-regexp-connective 'and "")
 490
 491 ;; Regexp that determines buf A regions to ignore when skipping to diff
 492 (ediff-defvar-local ediff-regexp-hide-A "" "")
 493 ;; Regexp that determines buf B regions to ignore when skipping to diff
 494 (ediff-defvar-local ediff-regexp-hide-B "" "")
 495 ;; Regexp that determines buf C regions to ignore when skipping to diff
 496 (ediff-defvar-local ediff-regexp-hide-C "" "")
 497 ;; connective that determines whether to hide regions that match both or
 498 ;; one of the regexps
 499 (ediff-defvar-local ediff-hide-regexp-connective 'and "")
 500
 501
 502 ;;; Copying difference regions between buffers.
 503
 504 ;; A list of killed diffs.
 505 ;; A diff is saved here if it is replaced by a diff
 506 ;; from another buffer.  This alist has the form:
 507 ;; \((num (buff-object . diff) (buff-object . diff) (buff-object . diff)) ...),
 508 ;; where some buffer-objects may be missing.
 509 (ediff-defvar-local ediff-killed-diffs-alist nil "")
 510
 511
 512 ;; Highlighting
 513 (defcustom ediff-before-flag-bol (if ediff-xemacs-p (make-glyph "->>") "->>")
 514   "*Flag placed before a highlighted block of differences, if block starts at beginning of a line."
 515   :type 'string
 516   :tag  "Region before-flag at beginning of line"
 517   :group 'ediff)
 518
 519 (defcustom ediff-after-flag-eol  (if ediff-xemacs-p (make-glyph "<<-") "<<-")
 520   "*Flag placed after a highlighted block of differences, if block ends at end of a line."
 521   :type 'string
 522   :tag  "Region after-flag at end of line"
 523   :group 'ediff)
 524
 525 (defcustom ediff-before-flag-mol (if ediff-xemacs-p (make-glyph "->>") "->>")
 526   "*Flag placed before a highlighted block of differences, if block starts in mid-line."
 527   :type 'string
 528   :tag  "Region before-flag in the middle of line"
 529   :group 'ediff)
 530 (defcustom ediff-after-flag-mol  (if ediff-xemacs-p (make-glyph "<<-") "<<-")
 531   "*Flag placed after a highlighted block of differences, if block ends in mid-line."
 532   :type 'string
 533   :tag  "Region after-flag in the middle of line"
 534   :group 'ediff)
 535
 536
 537 (ediff-defvar-local ediff-use-faces t "")
 538 (defcustom ediff-use-faces t
 539   "If t, differences are highlighted using faces, if device supports faces.
 540 If nil, differences are highlighted using ASCII flags, ediff-before-flag
 541 and ediff-after-flag.  On a non-window system, differences are always
 542 highlighted using ASCII flags."
 543   :type 'boolean
 544   :group 'ediff-highlighting)
 545
 546 ;; this indicates that diff regions are word-size, so fine diffs are
 547 ;; permanently nixed; used in ediff-windows-wordwise and ediff-regions-wordwise
 548 (ediff-defvar-local ediff-word-mode nil "")
 549 ;; Name of the job (ediff-files, ediff-windows, etc.)
 550 (ediff-defvar-local ediff-job-name nil "")
 551
 552 ;; Narrowing and ediff-region/windows support
 553 ;; This is a list (overlay-A overlay-B overlay-C)
 554 ;; If set, Ediff compares only those parts of buffers A/B/C that lie within
 555 ;; the bounds of these overlays.
 556 (ediff-defvar-local ediff-narrow-bounds nil "")
 557
 558 ;; List (overlay-A overlay-B overlay-C), where each overlay spans the
 559 ;; entire corresponding buffer.
 560 (ediff-defvar-local ediff-wide-bounds nil "")
 561
 562 ;; Current visibility boundaries in buffers A, B, and C.
 563 ;; This is also a list of overlays. When the user toggles narrow/widen,
 564 ;; this list changes from ediff-wide-bounds to ediff-narrow-bounds.
 565 ;; and back.
 566 (ediff-defvar-local ediff-visible-bounds nil "")
 567
 568 (ediff-defvar-local ediff-start-narrowed t
 569   "Non-nil means start narrowed, if doing ediff-windows-* or ediff-regions-*")
 570 (ediff-defvar-local ediff-quit-widened t
 571   "*Non-nil means: when finished, Ediff widens buffers A/B.
 572 Actually, Ediff restores the scope of visibility that existed at startup.")
 573
 574 (defcustom ediff-keep-variants t
 575   "*Nil means that non-modified variant buffers should be removed at the end of the session after some interrogation.
 576 Supplying a prefix argument to the quit command `q' temporarily reverses the
 577 meaning of this variable."
 578   :type 'boolean
 579   :group 'ediff)
 580
 581 (ediff-defvar-local ediff-highlight-all-diffs t "")
 582 (defcustom ediff-highlight-all-diffs t
 583   "If nil, only the selected differences are highlighted.
 584 Otherwise, all difference regions are highlighted, but the selected region is
 585 shown in brighter colors."
 586   :type 'boolean
 587   :group 'ediff-highlighting)
 588
 589 ;; A var local to each control panel buffer.  Indicates highlighting style
 590 ;; in effect for this buffer: `face', `ascii', nil -- temporarily
 591 ;; unhighlighted, `off' -- turned off \(on a dumb terminal only\).
 592 (ediff-defvar-local ediff-highlighting-style nil "")
 593
 594
 595 ;; The suffix of the control buffer name.
 596 (ediff-defvar-local ediff-control-buffer-suffix nil "")
 597 ;; Same as ediff-control-buffer-suffix, but without <,>.
 598 ;; It's a number rather than string.
 599 (ediff-defvar-local ediff-control-buffer-number nil "")
 600
 601
 602 ;; The original values of ediff-protected-variables for buffer A
 603 (ediff-defvar-local ediff-buffer-values-orig-A nil "")
 604 ;; The original values of ediff-protected-variables for buffer B
 605 (ediff-defvar-local ediff-buffer-values-orig-B nil "")
 606 ;; The original values of ediff-protected-variables for buffer C
 607 (ediff-defvar-local ediff-buffer-values-orig-C nil "")
 608 ;; The original values of ediff-protected-variables for buffer Ancestor
 609 (ediff-defvar-local ediff-buffer-values-orig-Ancestor nil "")
 610
 611 ;; association between buff-type and ediff-buffer-values-orig-*
 612 (defconst ediff-buffer-values-orig-alist
 613   '((A . ediff-buffer-values-orig-A)
 614     (B . ediff-buffer-values-orig-B)
 615     (C . ediff-buffer-values-orig-C)
 616     (Ancestor . ediff-buffer-values-orig-Ancestor)))
 617
 618 ;; Buffer-local variables to be saved then restored during Ediff sessions
 619 (defconst ediff-protected-variables '(
 620                                       ;;buffer-read-only
 621                                       mode-line-format))
 622
 623 ;; Vector of differences between the variants.  Each difference is
 624 ;; represented by a vector of two overlays plus a vector of fine diffs,
 625 ;; plus a no-fine-diffs flag.  The first overlay spans the
 626 ;; difference region in the A buffer and the second overlays the diff in
 627 ;; the B buffer. If a difference section is empty, the corresponding
 628 ;; overlay's endpoints coincide.
 629 ;;
 630 ;; The precise form of a difference vector for one buffer is:
 631 ;; [diff diff diff ...]
 632 ;; where each diff has the form:
 633 ;; [diff-overlay fine-diff-vector no-fine-diffs-flag state-of-difference]
 634 ;; fine-diff-vector is a vector [fine-diff-overlay fine-diff-overlay ...]
 635 ;; no-fine-diffs-flag says if there are fine differences.
 636 ;; state-of-difference is A, B, C, or nil, indicating which buffer is
 637 ;; different from the other two (used only in 3-way jobs.
 638 (ediff-defvar-local ediff-difference-vector-A nil "")
 639 (ediff-defvar-local ediff-difference-vector-B nil "")
 640 (ediff-defvar-local ediff-difference-vector-C nil "")
 641 (ediff-defvar-local ediff-difference-vector-Ancestor nil "")
 642 ;; A-list of diff vector types associated with buffer types
 643 (defconst ediff-difference-vector-alist
 644   '((A . ediff-difference-vector-A)
 645     (B . ediff-difference-vector-B)
 646     (C . ediff-difference-vector-C)
 647     (Ancestor . ediff-difference-vector-Ancestor)))
 648
 649 ;; [ status status status ...]
 650 ;; Each status: [state-of-merge state-of-ancestor]
 651 ;; state-of-merge is default-A, default-B, prefer-A, or prefer-B. It
 652 ;; indicates the way a diff region was created in buffer C.
 653 ;; state-of-ancestor says if the corresponding region in ancestor buffer is
 654 ;; empty.
 655 (ediff-defvar-local ediff-state-of-merge nil "")
 656
 657 ;; The difference that is currently selected.
 658 (ediff-defvar-local ediff-current-difference -1 "")
 659 ;; Number of differences found.
 660 (ediff-defvar-local ediff-number-of-differences nil "")
 661
 662 ;; Buffer containing the output of diff, which is used by Ediff to step
 663 ;; through files.
 664 (ediff-defvar-local ediff-diff-buffer nil "")
 665 ;; Like ediff-diff-buffer, but contains context diff. It is not used by
 666 ;; Ediff, but it is saved in a file, if user requests so.
 667 (ediff-defvar-local ediff-custom-diff-buffer nil "")
 668 ;; Buffer used for diff-style fine differences between regions.
 669 (ediff-defvar-local ediff-fine-diff-buffer nil "")
 670 ;; Temporary buffer used for computing fine differences.
 671 (defconst ediff-tmp-buffer " *ediff-tmp*" "")
 672 ;; Buffer used for messages
 673 (defconst ediff-msg-buffer " *ediff-message*" "")
 674 ;; Buffer containing the output of diff when diff returns errors.
 675 (ediff-defvar-local ediff-error-buffer nil "")
 676 ;; Buffer to display debug info
 677 (ediff-defvar-local ediff-debug-buffer "*ediff-debug*" "")
 678
 679 ;; List of ediff control panels associated with each buffer A/B/C/Ancestor.
 680 ;; Not used any more, but may be needed in the future.
 681 (ediff-defvar-local ediff-this-buffer-ediff-sessions  nil "")
 682
 683 ;; to be deleted in due time
 684 ;; List of difference overlays disturbed by working with the current diff.
 685 (defvar ediff-disturbed-overlays nil "")
 686
 687 ;; Priority of non-selected overlays.
 688 (defvar ediff-shadow-overlay-priority  100 "")
 689
 690 (defcustom ediff-version-control-package 'vc
 691   "Version control package used.
 692 Currently, Ediff supports vc.el, rcs.el, pcl-cvs.el, and generic-sc.el. The
 693 standard Emacs interface to RCS, CVS, SCCS, etc., is vc.el. However, some
 694 people find the other two packages more convenient. Set this variable to the
 695 appropriate symbol: `rcs', `pcl-cvs', or `generic-sc' if you so desire."
 696   :type 'symbol
 697   :group 'ediff)
 698
 699
 700 (if ediff-xemacs-p
 701     (progn
 702       (fset 'ediff-read-event (symbol-function 'next-command-event))
 703       (fset 'ediff-overlayp (symbol-function 'extentp))
 704       (fset 'ediff-make-overlay (symbol-function 'make-extent))
 705       (fset 'ediff-delete-overlay (symbol-function 'delete-extent)))
 706   (fset 'ediff-read-event (symbol-function 'read-event))
 707   (fset 'ediff-overlayp (symbol-function 'overlayp))
 708   (fset 'ediff-make-overlay (symbol-function 'make-overlay))
 709   (fset 'ediff-delete-overlay (symbol-function 'delete-overlay)))
 710
 711 ;; Check the current version against the major and minor version numbers
 712 ;; using op: cur-vers op major.minor If emacs-major-version or
 713 ;; emacs-minor-version are not defined, we assume that the current version
 714 ;; is hopelessly outdated.  We assume that emacs-major-version and
 715 ;; emacs-minor-version are defined.  Otherwise, for Emacs/XEmacs 19, if the
 716 ;; current minor version is < 10 (xemacs) or < 23 (emacs) the return value
 717 ;; will be nil (when op is =, >, or >=) and t (when op is <, <=), which may be
 718 ;; incorrect. However, this gives correct result in our cases, since we are
 719 ;; testing for sufficiently high Emacs versions.
 720 (defun ediff-check-version (op major minor &optional type-of-emacs)
 721   (if (and (boundp 'emacs-major-version) (boundp 'emacs-minor-version))
 722       (and (cond ((eq type-of-emacs 'xemacs) ediff-xemacs-p)
 723                  ((eq type-of-emacs 'emacs) ediff-emacs-p)
 724                  (t t))
 725            (cond ((eq op '=) (and (= emacs-minor-version minor)
 726                                   (= emacs-major-version major)))
 727                  ((memq op '(> >= < <=))
 728                   (and (or (funcall op emacs-major-version major)
 729                            (= emacs-major-version major))
 730                        (if (= emacs-major-version major)
 731                            (funcall op emacs-minor-version minor)
 732                          t)))
 733                  (t
 734                   (error "%S: Invalid op in ediff-check-version" op))))
 735     (cond ((memq op '(= > >=)) nil)
 736           ((memq op '(< <=)) t))))
 737
 738
 739
 740 ;; A fix for NeXT Step
 741 ;; Should probably be eliminated in later versions.
 742 (if (and (ediff-window-display-p) (eq (ediff-device-type) 'ns))
 743     (progn
 744       (fset 'x-display-color-p (symbol-function 'ns-display-color-p))
 745       (fset 'x-color-defined-p (symbol-function 'ns-color-defined-p))
 746       (fset 'x-display-pixel-height (symbol-function 'ns-display-pixel-height))
 747       (fset 'x-display-pixel-width (symbol-function 'ns-display-pixel-width))
 748       ))
 749
 750
 751 (defsubst ediff-color-display-p ()
 752   (if ediff-emacs-p
 753       (x-display-color-p)
 754     (eq (device-class (selected-device)) 'color)))
 755
 756
 757 (if (ediff-has-face-support-p)
 758     (if ediff-xemacs-p
 759         (progn
 760           (fset 'ediff-valid-color-p (symbol-function 'valid-color-name-p))
 761           (fset 'ediff-get-face (symbol-function 'get-face)))
 762       ;; Temporary fix for OS/2 port of Emacs
 763       ;; pm-win.el in PM-Emacs should be fixed.
 764       (if (eq (ediff-device-type) 'pm)
 765           (fset 'ediff-valid-color-p
 766                 (function (lambda (color) (assoc color pm-color-alist))))
 767         (fset 'ediff-valid-color-p (symbol-function 'x-color-defined-p)))
 768       (fset 'ediff-get-face (symbol-function 'internal-get-face))))
 769
 770 (if (ediff-window-display-p)
 771     (if ediff-xemacs-p
 772         (progn
 773           (fset 'ediff-display-pixel-width
 774                 (symbol-function 'device-pixel-width))
 775           (fset 'ediff-display-pixel-height
 776                 (symbol-function 'device-pixel-height)))
 777       (fset 'ediff-display-pixel-width
 778             (symbol-function 'x-display-pixel-width))
 779       (fset 'ediff-display-pixel-height
 780             (symbol-function 'x-display-pixel-height))))
 781
 782 ;; A-list of current-diff-overlay symbols asssociated with buf types
 783 (defconst ediff-current-diff-overlay-alist
 784   '((A . ediff-current-diff-overlay-A)
 785     (B . ediff-current-diff-overlay-B)
 786     (C . ediff-current-diff-overlay-C)
 787     (Ancestor . ediff-current-diff-overlay-Ancestor)))
 788
 789 ;; A-list of current-diff-face-* symbols asssociated with buf types
 790 (defconst ediff-current-diff-face-alist
 791   '((A . ediff-current-diff-face-A)
 792     (B . ediff-current-diff-face-B)
 793     (C . ediff-current-diff-face-C)
 794     (Ancestor . ediff-current-diff-face-Ancestor)))
 795
 796
 797 (defun ediff-make-current-diff-overlay (type)
 798   (if (ediff-has-face-support-p)
 799       (let ((overlay (ediff-get-symbol-from-alist
 800                       type ediff-current-diff-overlay-alist))
 801             (buffer (ediff-get-buffer type))
 802             (face (face-name
 803                    (symbol-value
 804                     (ediff-get-symbol-from-alist
 805                      type ediff-current-diff-face-alist)))))
 806         (set overlay
 807              (ediff-make-bullet-proof-overlay (point-max) (point-max) buffer))
 808         (ediff-set-overlay-face (symbol-value overlay) face)
 809         (ediff-overlay-put (symbol-value overlay) 'ediff ediff-control-buffer))
 810     ))
 811
 812 (defun ediff-set-overlay-face (extent face)
 813   (ediff-overlay-put extent 'face face)
 814   (ediff-overlay-put extent 'help-echo 'ediff-region-help-echo))
 815
 816 ;; This does nothing in Emacs, since overlays there have no help-echo property
 817 (defun ediff-region-help-echo (extent)
 818   (let ((is-current (ediff-overlay-get extent 'ediff))
 819         (face (ediff-overlay-get extent 'face))
 820         (diff-num (ediff-overlay-get extent 'ediff-diff-num))
 821         face-help)
 822
 823     ;; This happens only for refinement overlays
 824     (setq face-help (and face (get face 'ediff-help-echo)))
 825
 826     (cond ((and is-current diff-num) ; current diff region
 827            (format "Difference region %S -- current" (1+ diff-num)))
 828           (face-help) ; refinement of current diff region
 829           (diff-num ; non-current
 830            (format "Difference region %S -- non-current" (1+ diff-num)))
 831           (t ""))   ; none
 832     ))
 833
 834
 835 (defun ediff-set-face-pixmap (face pixmap)
 836   "Set face pixmap on a monochrome display."
 837   (if (and (ediff-window-display-p) (not (ediff-color-display-p)))
 838       (condition-case nil
 839           (set-face-background-pixmap face pixmap)
 840         (error
 841          (message "Pixmap not found for %S: %s" (face-name face) pixmap)
 842          (sit-for 1)))))
 843
 844 (defun ediff-hide-face (face)
 845   (if (and (ediff-has-face-support-p) ediff-emacs-p)
 846       (add-to-list 'facemenu-unlisted-faces face)))
 847
 848
 849
 850 (defface ediff-current-diff-face-A
 851   '((((class color)) (:foreground "firebrick" :background "pale green"))
 852     (t (:inverse-video t)))
 853   "Face for highlighting the selected difference in buffer A."
 854   :group 'ediff-highlighting)
 855 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
 856 ;; this variable is set to nil, then again to the appropriate face.
 857 (defvar ediff-current-diff-face-A 'ediff-current-diff-face-A
 858   "Face for highlighting the selected difference in buffer A.
 859 DO NOT CHANGE this variable. Instead, use the customization
 860 widget to customize the actual face object `ediff-current-diff-face-A'
 861 this variable represents.")
 862 (ediff-hide-face 'ediff-current-diff-face-A)
 863 ;; Until custom.el for XEmacs starts supporting :inverse-video we do this.
 864 ;; This means that some user customization may be trashed.
 865 (if (and ediff-xemacs-p
 866          (ediff-has-face-support-p)
 867          (not (ediff-color-display-p)))
 868     (copy-face 'modeline 'ediff-current-diff-face-A))
 869
 870
 871
 872 (defface ediff-current-diff-face-B
 873   '((((class color)) (:foreground "DarkOrchid" :background "Yellow"))
 874     (t (:inverse-video t)))
 875   "Face for highlighting the selected difference in buffer B."
 876   :group 'ediff-highlighting)
 877 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
 878 ;; this variable is set to nil, then again to the appropriate face.
 879 (defvar ediff-current-diff-face-B 'ediff-current-diff-face-B
 880   "Face for highlighting the selected difference in buffer B.
 881  this variable. Instead, use the customization
 882 widget to customize the actual face `ediff-current-diff-face-B'
 883 this variable represents.")
 884 (ediff-hide-face 'ediff-current-diff-face-B)
 885 ;; Until custom.el for XEmacs starts supporting :inverse-video we do this.
 886 ;; This means that some user customization may be trashed.
 887 (if (and ediff-xemacs-p
 888          (ediff-has-face-support-p)
 889          (not (ediff-color-display-p)))
 890     (copy-face 'modeline 'ediff-current-diff-face-B))
 891
 892
 893 (defface ediff-current-diff-face-C
 894   '((((class color)) (:foreground "Navy" :background "Pink"))
 895     (t (:inverse-video t)))
 896   "Face for highlighting the selected difference in buffer C."
 897   :group 'ediff-highlighting)
 898 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
 899 ;; this variable is set to nil, then again to the appropriate face.
 900 (defvar ediff-current-diff-face-C 'ediff-current-diff-face-C
 901   "Face for highlighting the selected difference in buffer C.
 902 DO NOT CHANGE this variable. Instead, use the customization
 903 widget to customize the actual face object `ediff-current-diff-face-C'
 904 this variable represents.")
 905 (ediff-hide-face 'ediff-current-diff-face-C)
 906 ;; Until custom.el for XEmacs starts supporting :inverse-video we do this.
 907 ;; This means that some user customization may be trashed.
 908 (if (and ediff-xemacs-p
 909          (ediff-has-face-support-p)
 910          (not (ediff-color-display-p)))
 911     (copy-face 'modeline 'ediff-current-diff-face-C))
 912
 913
 914 (defface ediff-current-diff-face-Ancestor
 915   '((((class color)) (:foreground "Black" :background "VioletRed"))
 916     (t (:inverse-video t)))
 917   "Face for highlighting the selected difference in buffer Ancestor."
 918   :group 'ediff-highlighting)
 919 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
 920 ;; this variable is set to nil, then again to the appropriate face.
 921 (defvar ediff-current-diff-face-Ancestor 'ediff-current-diff-face-Ancestor
 922   "Face for highlighting the selected difference in buffer Ancestor.
 923 DO NOT CHANGE this variable. Instead, use the customization
 924 widget to customize the actual face object `ediff-current-diff-face-Ancestor'
 925 this variable represents.")
 926 (ediff-hide-face 'ediff-current-diff-face-Ancestor)
 927 ;; Until custom.el for XEmacs starts supporting :inverse-video we do this.
 928 ;; This means that some user customization may be trashed.
 929 (if (and ediff-xemacs-p
 930          (ediff-has-face-support-p)
 931          (not (ediff-color-display-p)))
 932     (copy-face 'modeline 'ediff-current-diff-face-Ancestor))
 933
 934
 935 (defface ediff-fine-diff-face-A
 936   '((((class color)) (:foreground "Navy" :background "sky blue"))
 937     (t (:underline t :stipple "gray3")))
 938   "Face for highlighting the refinement of the selected diff in buffer A."
 939   :group 'ediff-highlighting)
 940 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
 941 ;; this variable is set to nil, then again to the appropriate face.
 942 (defvar ediff-fine-diff-face-A 'ediff-fine-diff-face-A
 943   "Face for highlighting the fine differences in buffer A.
 944 DO NOT CHANGE this variable. Instead, use the customization
 945 widget to customize the actual face object `ediff-fine-diff-face-A'
 946 this variable represents.")
 947 (ediff-hide-face 'ediff-fine-diff-face-A)
 948
 949 (defface ediff-fine-diff-face-B
 950   '((((class color)) (:foreground "Black" :background "cyan"))
 951     (t (:underline t :stipple "gray3")))
 952   "Face for highlighting the refinement of the selected diff in buffer B."
 953   :group 'ediff-highlighting)
 954 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
 955 ;; this variable is set to nil, then again to the appropriate face.
 956 (defvar ediff-fine-diff-face-B 'ediff-fine-diff-face-B
 957   "Face for highlighting the fine differences in buffer B.
 958 DO NOT CHANGE this variable. Instead, use the customization
 959 widget to customize the actual face object `ediff-fine-diff-face-B'
 960 this variable represents.")
 961 (ediff-hide-face 'ediff-fine-diff-face-B)
 962
 963 (defface ediff-fine-diff-face-C
 964   '((((class color)) (:foreground "Black" :background "Turquoise"))
 965     (t (:underline t :stipple "gray3")))
 966   "Face for highlighting the refinement of the selected diff in buffer C."
 967   :group 'ediff-highlighting)
 968 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
 969 ;; this variable is set to nil, then again to the appropriate face.
 970 (defvar ediff-fine-diff-face-C 'ediff-fine-diff-face-C
 971   "Face for highlighting the fine differences in buffer C.
 972 DO NOT CHANGE this variable. Instead, use the customization
 973 widget to customize the actual face object `ediff-fine-diff-face-C'
 974 this variable represents.")
 975 (ediff-hide-face 'ediff-fine-diff-face-C)
 976
 977 (defface ediff-fine-diff-face-Ancestor
 978   '((((class color)) (:foreground "Black" :background "Green"))
 979     (t (:underline t :stipple "gray3")))
 980   "Face for highlighting the refinement of the selected diff in the ancestor buffer.
 981 At present, this face is not used and no fine differences are computed for the
 982 ancestor buffer."
 983   :group 'ediff-highlighting)
 984 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
 985 ;; this variable is set to nil, then again to the appropriate face.
 986 (defvar ediff-fine-diff-face-Ancestor 'ediff-fine-diff-face-Ancestor
 987   "Face for highlighting the fine differences in buffer Ancestor.
 988 DO NOT CHANGE this variable. Instead, use the customization
 989 widget to customize the actual face object `ediff-fine-diff-face-Ancestor'
 990 this variable represents.")
 991 (ediff-hide-face 'ediff-fine-diff-face-Ancestor)
 992
 993 (defface ediff-even-diff-face-A
 994   '((((class color)) (:foreground "Black" :background "light grey"))
 995     (t (:italic t :stipple "stipple")))
 996   "Face for highlighting even-numbered non-current differences in buffer A."
 997   :group 'ediff-highlighting)
 998 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
 999 ;; this variable is set to nil, then again to the appropriate face.
1000 (defvar ediff-even-diff-face-A 'ediff-even-diff-face-A
1001   "Face for highlighting even-numbered non-current differences in buffer A.
1002 DO NOT CHANGE this variable. Instead, use the customization
1003 widget to customize the actual face object `ediff-even-diff-face-A'
1004 this variable represents.")
1005 (ediff-hide-face 'ediff-even-diff-face-A)
1006
1007 (defface ediff-even-diff-face-B
1008   '((((class color)) (:foreground "White" :background "Grey"))
1009     (t (:italic t :stipple "stipple")))
1010   "Face for highlighting even-numbered non-current differences in buffer B."
1011   :group 'ediff-highlighting)
1012 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
1013 ;; this variable is set to nil, then again to the appropriate face.
1014 (defvar ediff-even-diff-face-B 'ediff-even-diff-face-B
1015   "Face for highlighting even-numbered non-current differences in buffer B.
1016 DO NOT CHANGE this variable. Instead, use the customization
1017 widget to customize the actual face object `ediff-even-diff-face-B'
1018 this variable represents.")
1019 (ediff-hide-face 'ediff-even-diff-face-B)
1020
1021 (defface ediff-even-diff-face-C
1022   '((((class color)) (:foreground "Black" :background "light grey"))
1023     (t (:italic t :stipple "stipple")))
1024   "Face for highlighting even-numbered non-current differences in buffer C."
1025   :group 'ediff-highlighting)
1026 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
1027 ;; this variable is set to nil, then again to the appropriate face.
1028 (defvar ediff-even-diff-face-C 'ediff-even-diff-face-C
1029   "Face for highlighting even-numbered non-current differences in buffer C.
1030 DO NOT CHANGE this variable. Instead, use the customization
1031 widget to customize the actual face object `ediff-even-diff-face-C'
1032 this variable represents.")
1033 (ediff-hide-face 'ediff-even-diff-face-C)
1034
1035 (defface ediff-even-diff-face-Ancestor
1036   '((((class color)) (:foreground "White" :background "Grey"))
1037     (t (:italic t :stipple "stipple")))
1038   "Face for highlighting even-numbered non-current differences in the ancestor buffer."
1039   :group 'ediff-highlighting)
1040 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
1041 ;; this variable is set to nil, then again to the appropriate face.
1042 (defvar ediff-even-diff-face-Ancestor 'ediff-even-diff-face-Ancestor
1043   "Face for highlighting even-numbered non-current differences in buffer Ancestor.
1044 DO NOT CHANGE this variable. Instead, use the customization
1045 widget to customize the actual face object `ediff-even-diff-face-Ancestor'
1046 this variable represents.")
1047 (ediff-hide-face 'ediff-even-diff-face-Ancestor)
1048
1049 ;; Association between buffer types and even-diff-face symbols
1050 (defconst ediff-even-diff-face-alist
1051   '((A . ediff-even-diff-face-A)
1052     (B . ediff-even-diff-face-B)
1053     (C . ediff-even-diff-face-C)
1054     (Ancestor . ediff-even-diff-face-Ancestor)))
1055
1056 (defface ediff-odd-diff-face-A
1057   '((((class color)) (:foreground "White" :background "Grey"))
1058     (t (:italic t :stipple "gray1")))
1059   "Face for highlighting odd-numbered non-current differences in buffer A."
1060   :group 'ediff-highlighting)
1061 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
1062 ;; this variable is set to nil, then again to the appropriate face.
1063 (defvar ediff-odd-diff-face-A 'ediff-odd-diff-face-A
1064   "Face for highlighting odd-numbered non-current differences in buffer A.
1065 DO NOT CHANGE this variable. Instead, use the customization
1066 widget to customize the actual face object `ediff-odd-diff-face-A'
1067 this variable represents.")
1068 (ediff-hide-face 'ediff-odd-diff-face-A)
1069
1070
1071 (defface ediff-odd-diff-face-B
1072   '((((class color)) (:foreground "Black" :background "light grey"))
1073     (t (:italic t :stipple "gray1")))
1074   "Face for highlighting odd-numbered non-current differences in buffer B."
1075   :group 'ediff-highlighting)
1076 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
1077 ;; this variable is set to nil, then again to the appropriate face.
1078 (defvar ediff-odd-diff-face-B 'ediff-odd-diff-face-B
1079   "Face for highlighting odd-numbered non-current differences in buffer B.
1080 DO NOT CHANGE this variable. Instead, use the customization
1081 widget to customize the actual face object `ediff-odd-diff-face-B'
1082 this variable represents.")
1083 (ediff-hide-face 'ediff-odd-diff-face-B)
1084
1085 (defface ediff-odd-diff-face-C
1086   '((((class color)) (:foreground "White" :background "Grey"))
1087     (t (:italic t :stipple "gray1")))
1088   "Face for highlighting odd-numbered non-current differences in buffer C."
1089   :group 'ediff-highlighting)
1090 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
1091 ;; this variable is set to nil, then again to the appropriate face.
1092 (defvar ediff-odd-diff-face-C 'ediff-odd-diff-face-C
1093   "Face for highlighting odd-numbered non-current differences in buffer C.
1094 DO NOT CHANGE this variable. Instead, use the customization
1095 widget to customize the actual face object `ediff-odd-diff-face-C'
1096 this variable represents.")
1097 (ediff-hide-face 'ediff-odd-diff-face-C)
1098
1099 (defface ediff-odd-diff-face-Ancestor
1100   '((((class color)) (:foreground "Black" :background "light grey"))
1101     (t (:italic t :stipple "gray1")))
1102   "Face for highlighting odd-numbered non-current differences in the ancestor buffer."
1103   :group 'ediff-highlighting)
1104 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
1105 ;; this variable is set to nil, then again to the appropriate face.
1106 (defvar ediff-odd-diff-face-Ancestor 'ediff-odd-diff-face-Ancestor
1107   "Face for highlighting odd-numbered non-current differences in buffer Ancestor.
1108 DO NOT CHANGE this variable. Instead, use the customization
1109 widget to customize the actual face object `ediff-odd-diff-face-Ancestor'
1110 this variable represents.")
1111 (ediff-hide-face 'ediff-odd-diff-face-Ancestor)
1112
1113 ;; Association between buffer types and odd-diff-face symbols
1114 (defconst ediff-odd-diff-face-alist
1115   '((A . ediff-odd-diff-face-A)
1116     (B . ediff-odd-diff-face-B)
1117     (C . ediff-odd-diff-face-C)
1118     (Ancestor . ediff-odd-diff-face-Ancestor)))
1119
1120 ;; A-list of fine-diff face symbols associated with buffer types
1121 (defconst ediff-fine-diff-face-alist
1122   '((A . ediff-fine-diff-face-A)
1123     (B . ediff-fine-diff-face-B)
1124     (C . ediff-fine-diff-face-C)
1125     (Ancestor . ediff-fine-diff-face-Ancestor)))
1126
1127 ;; Help echo
1128 (put 'ediff-fine-diff-face-A 'ediff-help-echo
1129      "A `refinement' of the current difference region")
1130 (put 'ediff-fine-diff-face-B 'ediff-help-echo
1131      "A `refinement' of the current difference region")
1132 (put 'ediff-fine-diff-face-C 'ediff-help-echo
1133      "A `refinement' of the current difference region")
1134 (put 'ediff-fine-diff-face-Ancestor 'ediff-help-echo
1135      "A `refinement' of the current difference region")
1136
1137
1138 ;;; Overlays
1139
1140 (ediff-defvar-local ediff-current-diff-overlay-A nil
1141   "Overlay for the current difference region in buffer A.")
1142 (ediff-defvar-local ediff-current-diff-overlay-B nil
1143   "Overlay for the current difference region in buffer B.")
1144 (ediff-defvar-local ediff-current-diff-overlay-C nil
1145   "Overlay for the current difference region in buffer C.")
1146 (ediff-defvar-local ediff-current-diff-overlay-Ancestor nil
1147   "Overlay for the current difference region in the ancestor buffer.")
1148
1149 ;; Compute priority of ediff overlay.
1150 (defun ediff-highest-priority (start end buffer)
1151   (let ((pos (max 1 (1- start)))
1152         ovr-list)
1153     (if ediff-xemacs-p
1154         (1+ ediff-shadow-overlay-priority)
1155       (ediff-with-current-buffer buffer
1156         (while (< pos (min (point-max) (1+ end)))
1157           (setq ovr-list (append (overlays-at pos) ovr-list))
1158           (setq pos (next-overlay-change pos)))
1159         (1+ (apply '+
1160                    (mapcar (function
1161                             (lambda (ovr)
1162                               (if ovr
1163                                   (or (ediff-overlay-get ovr 'priority) 0)
1164                                 0)))
1165                            ovr-list)
1166                    ))
1167         ))))
1168
1169
1170 (defvar ediff-toggle-read-only-function nil
1171   "*Specifies the function to be used to toggle read-only.
1172 If nil, Ediff tries to deduce the function from the binding of C-x C-q.
1173 Normally, this is the `toggle-read-only' function, but, if version
1174 control is used, it could be `vc-toggle-read-only' or `rcs-toggle-read-only'.")
1175
1176 (defcustom ediff-make-buffers-readonly-at-startup nil
1177   "*Make all variant buffers read-only when Ediff starts up.
1178 This property can be toggled interactively."
1179   :type 'boolean
1180   :group 'ediff)
1181
1182
1183 ;;; Misc
1184
1185 ;; if nil, this silences some messages
1186 (defconst ediff-verbose-p t)
1187
1188 (defcustom ediff-autostore-merges  'group-jobs-only
1189   "*Save the results of merge jobs automatically.
1190 Nil means don't save automatically. t means always save. Anything but nil or t
1191 means save automatically only if the merge job is part of a group of jobs, such
1192 as `ediff-merge-directory' or `ediff-merge-directory-revisions'."
1193   :type '(choice (const nil) (const t)
1194                  (other :tag "group-jobs-only" group-jobs-only))
1195   :group 'ediff-merge)
1196 (make-variable-buffer-local 'ediff-autostore-merges)
1197
1198 ;; file where the result of the merge is to be saved. used internally
1199 (ediff-defvar-local ediff-merge-store-file nil "")
1200
1201 (defcustom ediff-no-emacs-help-in-control-buffer nil
1202   "*Non-nil means C-h should not invoke Emacs help in control buffer.
1203 Instead, C-h would jump to previous difference."
1204   :type 'boolean
1205   :group 'ediff)
1206
1207 (defcustom ediff-temp-file-prefix
1208   (file-name-as-directory
1209    (or small-temporary-file-directory temporary-file-directory))
1210   "*Prefix to put on Ediff temporary file names.
1211 Do not start with `~/' or `~USERNAME/'."
1212   :type 'string
1213   :group 'ediff)
1214
1215 (defcustom ediff-temp-file-mode 384     ; u=rw only
1216   "*Mode for Ediff temporary files."
1217   :type 'integer
1218   :group 'ediff)
1219
1220 ;; Metacharacters that have to be protected from the shell when executing
1221 ;; a diff/diff3 command.
1222 (defcustom ediff-metachars "[ \t\n!\"#$&'()*;<=>?[\\^`{|~]"
1223   "Regexp that matches characters that must be quoted with `\\' in shell command line.
1224 This default should work without changes."
1225   :type 'string
1226   :group 'ediff)
1227
1228 ;; needed to simulate frame-char-width in XEmacs.
1229 (defvar ediff-H-glyph (if ediff-xemacs-p (make-glyph "H")))
1230
1231
1232 ;; Temporary file used for refining difference regions in buffer A.
1233 (ediff-defvar-local ediff-temp-file-A nil "")
1234 ;; Temporary file used for refining difference regions in buffer B.
1235 (ediff-defvar-local ediff-temp-file-B nil "")
1236 ;; Temporary file used for refining difference regions in buffer C.
1237 (ediff-defvar-local ediff-temp-file-C nil "")
1238
1239
1240 ;;; In-line functions
1241
1242 (or (fboundp 'ediff-file-remote-p) ; user supplied his own function: use it
1243     (defun ediff-file-remote-p (file-name)
1244       (car (cond ((featurep 'efs-auto) (efs-ftp-path file-name))
1245                  ((fboundp 'file-remote-p) (file-remote-p file-name))
1246                  (t (require 'ange-ftp)
1247                     ;; Can happen only in Emacs, since XEmacs has file-remote-p
1248                     (ange-ftp-ftp-name file-name))))))
1249
1250
1251 (defsubst ediff-frame-unsplittable-p (frame)
1252   (cdr (assq 'unsplittable (frame-parameters frame))))
1253
1254 (defsubst ediff-get-next-window (wind prev-wind)
1255   (or (window-live-p wind)
1256       (setq wind (if prev-wind
1257                      (next-window wind)
1258                    (selected-window)))))
1259
1260
1261 (defsubst ediff-kill-buffer-carefully (buf)
1262   "Kill buffer BUF if it exists."
1263   (if (ediff-buffer-live-p buf)
1264       (kill-buffer (get-buffer buf))))
1265
1266 (defsubst ediff-background-face (buf-type dif-num)
1267   ;; The value of dif-num is always 1- the one that user sees.
1268   ;; This is why even face is used when dif-num is odd.
1269   (ediff-get-symbol-from-alist
1270    buf-type (if (ediff-odd-p dif-num)
1271                 ediff-even-diff-face-alist
1272               ediff-odd-diff-face-alist)
1273    ))
1274
1275
1276 ;; activate faces on diff regions in buffer
1277 (defun ediff-paint-background-regions-in-one-buffer (buf-type unhighlight)
1278   (let ((diff-vector
1279          (eval (ediff-get-symbol-from-alist
1280                 buf-type ediff-difference-vector-alist)))
1281         overl diff-num)
1282     (mapcar (function
1283              (lambda (rec)
1284                (setq overl (ediff-get-diff-overlay-from-diff-record rec)
1285                      diff-num (ediff-overlay-get overl 'ediff-diff-num))
1286                (if (ediff-overlay-buffer overl)
1287                    ;; only if overlay is alive
1288                    (ediff-set-overlay-face
1289                     overl
1290                     (if (not unhighlight)
1291                         (ediff-background-face buf-type diff-num))))
1292                ))
1293             diff-vector)))
1294
1295
1296 ;; activate faces on diff regions in all buffers
1297 (defun ediff-paint-background-regions (&optional unhighlight)
1298   (ediff-paint-background-regions-in-one-buffer
1299    'A unhighlight)
1300   (ediff-paint-background-regions-in-one-buffer
1301    'B unhighlight)
1302   (ediff-paint-background-regions-in-one-buffer
1303    'C unhighlight)
1304   (ediff-paint-background-regions-in-one-buffer
1305    'Ancestor unhighlight))
1306
1307 (defun ediff-highlight-diff-in-one-buffer (n buf-type)
1308   (if (ediff-buffer-live-p (ediff-get-buffer buf-type))
1309       (let* ((buff (ediff-get-buffer buf-type))
1310              (last (ediff-with-current-buffer buff (point-max)))
1311              (begin (ediff-get-diff-posn buf-type 'beg n))
1312              (end (ediff-get-diff-posn buf-type 'end n))
1313              (xtra (if (equal begin end) 1 0))
1314              (end-hilit (min last (+ end xtra)))
1315              (current-diff-overlay
1316               (symbol-value
1317                (ediff-get-symbol-from-alist
1318                 buf-type ediff-current-diff-overlay-alist))))
1319
1320         (if ediff-xemacs-p
1321             (ediff-move-overlay current-diff-overlay begin end-hilit)
1322           (ediff-move-overlay current-diff-overlay begin end-hilit buff))
1323         (ediff-overlay-put current-diff-overlay 'priority
1324                            (ediff-highest-priority begin end-hilit buff))
1325         (ediff-overlay-put current-diff-overlay 'ediff-diff-num n)
1326
1327         ;; unhighlight the background overlay for diff n so it won't
1328         ;; interfere with the current diff overlay
1329         (ediff-set-overlay-face (ediff-get-diff-overlay n buf-type) nil)
1330         )))
1331
1332
1333 (defun ediff-unhighlight-diff-in-one-buffer (buf-type)
1334   (if (ediff-buffer-live-p (ediff-get-buffer buf-type))
1335       (let ((current-diff-overlay
1336              (symbol-value
1337               (ediff-get-symbol-from-alist
1338                buf-type ediff-current-diff-overlay-alist)))
1339             (overlay
1340              (ediff-get-diff-overlay ediff-current-difference buf-type))
1341             )
1342
1343         (ediff-move-overlay current-diff-overlay 1 1)
1344
1345         ;; rehighlight the overlay in the background of the
1346         ;; current difference region
1347         (ediff-set-overlay-face
1348          overlay
1349          (if (and (ediff-has-face-support-p)
1350                   ediff-use-faces ediff-highlight-all-diffs)
1351              (ediff-background-face buf-type ediff-current-difference)))
1352         )))
1353
1354 (defun ediff-unhighlight-diffs-totally-in-one-buffer (buf-type)
1355   (ediff-unselect-and-select-difference -1)
1356   (if (and (ediff-has-face-support-p) ediff-use-faces)
1357       (let* ((inhibit-quit t)
1358              (current-diff-overlay-var
1359               (ediff-get-symbol-from-alist
1360                buf-type ediff-current-diff-overlay-alist))
1361              (current-diff-overlay (symbol-value current-diff-overlay-var)))
1362         (ediff-paint-background-regions 'unhighlight)
1363         (if (ediff-overlayp current-diff-overlay)
1364             (ediff-delete-overlay current-diff-overlay))
1365         (set current-diff-overlay-var nil)
1366         )))
1367
1368
1369 (defsubst ediff-highlight-diff (n)
1370   "Put face on diff N.  Invoked for X displays only."
1371   (ediff-highlight-diff-in-one-buffer n 'A)
1372   (ediff-highlight-diff-in-one-buffer n 'B)
1373   (ediff-highlight-diff-in-one-buffer n 'C)
1374   (ediff-highlight-diff-in-one-buffer n 'Ancestor)
1375   )
1376
1377
1378 (defsubst ediff-unhighlight-diff ()
1379   "Remove overlays from buffers A, B, and C."
1380   (ediff-unhighlight-diff-in-one-buffer 'A)
1381   (ediff-unhighlight-diff-in-one-buffer 'B)
1382   (ediff-unhighlight-diff-in-one-buffer 'C)
1383   (ediff-unhighlight-diff-in-one-buffer 'Ancestor)
1384   )
1385
1386 ;; delete highlighting overlays, restore faces to their original form
1387 (defsubst ediff-unhighlight-diffs-totally ()
1388   (ediff-unhighlight-diffs-totally-in-one-buffer 'A)
1389   (ediff-unhighlight-diffs-totally-in-one-buffer 'B)
1390   (ediff-unhighlight-diffs-totally-in-one-buffer 'C)
1391   (ediff-unhighlight-diffs-totally-in-one-buffer 'Ancestor)
1392   )
1393
1394
1395 ;; arg is a record for a given diff in a difference vector
1396 ;; this record is itself a vector
1397 (defsubst ediff-clear-fine-diff-vector (diff-record)
1398   (if diff-record
1399       (mapcar 'ediff-delete-overlay
1400               (ediff-get-fine-diff-vector-from-diff-record diff-record))))
1401
1402 (defsubst ediff-clear-fine-differences-in-one-buffer (n buf-type)
1403   (ediff-clear-fine-diff-vector (ediff-get-difference n buf-type))
1404   (ediff-set-fine-diff-vector n buf-type nil))
1405
1406 (defsubst ediff-clear-fine-differences (n)
1407   (ediff-clear-fine-differences-in-one-buffer n 'A)
1408   (ediff-clear-fine-differences-in-one-buffer n 'B)
1409   (if ediff-3way-job
1410       (ediff-clear-fine-differences-in-one-buffer n 'C)))
1411
1412
1413 (defsubst ediff-convert-fine-diffs-to-overlays (diff-list region-num)
1414   (ediff-set-fine-overlays-in-one-buffer 'A diff-list region-num)
1415   (ediff-set-fine-overlays-in-one-buffer 'B diff-list region-num)
1416   (if ediff-3way-job
1417       (ediff-set-fine-overlays-in-one-buffer 'C diff-list region-num)
1418     ))
1419
1420 (defsubst ediff-mouse-event-p (event)
1421   (if ediff-xemacs-p
1422       (button-event-p event)
1423     (string-match "mouse" (format "%S" (event-basic-type event)))
1424     ))
1425
1426
1427 (defsubst ediff-key-press-event-p (event)
1428   (if ediff-xemacs-p
1429       (key-press-event-p event)
1430     (or (char-or-string-p event) (symbolp event))))
1431
1432 (defun ediff-event-point (event)
1433   (cond ((ediff-mouse-event-p event)
1434          (if ediff-xemacs-p
1435              (event-point event)
1436            (posn-point (event-start event))))
1437         ((ediff-key-press-event-p event)
1438          (point))
1439         (t (error))))
1440
1441 (defun ediff-event-buffer (event)
1442   (cond ((ediff-mouse-event-p event)
1443          (if ediff-xemacs-p
1444              (event-buffer event)
1445            (window-buffer (posn-window (event-start event)))))
1446         ((ediff-key-press-event-p event)
1447          (current-buffer))
1448         (t (error))))
1449
1450
1451 (defsubst ediff-frame-iconified-p (frame)
1452   (if (and (ediff-window-display-p) (frame-live-p frame))
1453       (if ediff-xemacs-p
1454           (frame-iconified-p frame)
1455         (eq (frame-visible-p frame) 'icon))))
1456
1457 (defsubst ediff-window-visible-p (wind)
1458   ;; under TTY, window-live-p also means window is visible
1459   (and (window-live-p wind)
1460        (or (not (ediff-window-display-p))
1461            (frame-visible-p (window-frame wind)))))
1462
1463
1464 (defsubst ediff-frame-char-width (frame)
1465   (if ediff-xemacs-p
1466       (/ (frame-pixel-width frame) (frame-width frame))
1467     (frame-char-width frame)))
1468
1469 (defun ediff-reset-mouse (&optional frame do-not-grab-mouse)
1470   (or frame (setq frame (selected-frame)))
1471   (if (ediff-window-display-p)
1472       (let ((frame-or-wind frame))
1473         (if ediff-xemacs-p
1474             (setq frame-or-wind (frame-selected-window frame)))
1475         (or do-not-grab-mouse
1476             ;; don't set mouse if the user said to never do this
1477             (not ediff-grab-mouse)
1478             ;; Don't grab on quit, if the user doesn't want to.
1479             ;; If ediff-grab-mouse = t, then mouse won't be grabbed for
1480             ;; sessions that are not part of a group (this is done in
1481             ;; ediff-recenter). The condition below affects only terminating
1482             ;; sessions in session groups (in which case mouse is warped into
1483             ;; a meta buffer).
1484             (and (eq ediff-grab-mouse 'maybe)
1485                  (memq this-command '(ediff-quit ediff-update-diffs)))
1486             (set-mouse-position frame-or-wind 1 0))
1487         )))
1488
1489 (defsubst ediff-spy-after-mouse ()
1490   (setq ediff-mouse-pixel-position (mouse-pixel-position)))
1491
1492 ;; It is not easy to find out when the user grabs the mouse, since emacs and
1493 ;; xemacs behave differently when mouse is not in any frame. Also, this is
1494 ;; sensitive to when the user grabbed mouse.  Not used for now.
1495 (defun ediff-user-grabbed-mouse ()
1496   (if ediff-mouse-pixel-position
1497       (cond ((not (eq (car ediff-mouse-pixel-position)
1498                       (car (mouse-pixel-position)))))
1499             ((and (car (cdr ediff-mouse-pixel-position))
1500                   (car (cdr (mouse-pixel-position)))
1501                   (cdr (cdr ediff-mouse-pixel-position))
1502                   (cdr (cdr (mouse-pixel-position))))
1503              (not (and (< (abs (- (car (cdr ediff-mouse-pixel-position))
1504                                   (car (cdr (mouse-pixel-position)))))
1505                           ediff-mouse-pixel-threshold)
1506                        (< (abs (- (cdr (cdr ediff-mouse-pixel-position))
1507                                   (cdr (cdr (mouse-pixel-position)))))
1508                           ediff-mouse-pixel-threshold))))
1509             (t nil))))
1510
1511 (defsubst ediff-frame-char-height (frame)
1512   (if ediff-xemacs-p
1513       (glyph-height ediff-H-glyph (selected-window frame))
1514     (frame-char-height frame)))
1515
1516 ;; Some overlay functions
1517
1518 (defsubst ediff-overlay-start (overl)
1519   (if (ediff-overlayp overl)
1520       (if ediff-emacs-p
1521           (overlay-start overl)
1522         (extent-start-position overl))))
1523
1524 (defsubst ediff-overlay-end  (overl)
1525   (if (ediff-overlayp overl)
1526       (if ediff-emacs-p
1527           (overlay-end overl)
1528         (extent-end-position overl))))
1529
1530 (defsubst ediff-empty-overlay-p (overl)
1531   (= (ediff-overlay-start overl) (ediff-overlay-end overl)))
1532
1533 ;; like overlay-buffer in Emacs. In XEmacs, returns nil if the extent is
1534 ;; dead. Otherwise, works like extent-buffer
1535 (defun ediff-overlay-buffer (overl)
1536   (if ediff-emacs-p
1537       (overlay-buffer overl)
1538     (and (extent-live-p overl) (extent-object overl))))
1539
1540 ;; like overlay-get in Emacs. In XEmacs, returns nil if the extent is
1541 ;; dead. Otherwise, like extent-property
1542 (defun ediff-overlay-get (overl property)
1543   (if ediff-emacs-p
1544       (overlay-get overl property)
1545     (and (extent-live-p overl) (extent-property overl property))))
1546
1547
1548 ;; These two functions are here because XEmacs refuses to
1549 ;; handle overlays whose buffers were deleted.
1550 (defun ediff-move-overlay (overlay beg end &optional buffer)
1551   "Calls `move-overlay' in Emacs and `set-extent-endpoints' in Lemacs.
1552 Checks if overlay's buffer exists before actually doing the move."
1553   (let ((buf (and overlay (ediff-overlay-buffer overlay))))
1554     (if (ediff-buffer-live-p buf)
1555         (if ediff-xemacs-p
1556             (set-extent-endpoints overlay beg end)
1557           (move-overlay overlay beg end buffer))
1558       ;; buffer's dead
1559       (if overlay
1560           (ediff-delete-overlay overlay)))))
1561
1562 (defun ediff-overlay-put (overlay prop value)
1563   "Calls `overlay-put' or `set-extent-property' depending on Emacs version.
1564 Checks if overlay's buffer exists."
1565   (if (ediff-buffer-live-p (ediff-overlay-buffer overlay))
1566       (if ediff-xemacs-p
1567           (set-extent-property overlay prop value)
1568         (overlay-put overlay prop value))
1569     (ediff-delete-overlay overlay)))
1570
1571 ;; Some diff region tests
1572
1573 ;; t if diff region is empty.
1574 ;; In case of buffer C, t also if it is not a 3way
1575 ;; comparison job (merging jobs return t as well).
1576 (defun ediff-empty-diff-region-p (n buf-type)
1577   (if (eq buf-type 'C)
1578       (or (not ediff-3way-comparison-job)
1579           (= (ediff-get-diff-posn 'C 'beg n)
1580              (ediff-get-diff-posn 'C 'end n)))
1581     (= (ediff-get-diff-posn buf-type 'beg n)
1582        (ediff-get-diff-posn buf-type 'end n))))
1583
1584 ;; Test if diff region is white space only.
1585 ;; If 2-way job and buf-type = C, then returns t.
1586 (defun ediff-whitespace-diff-region-p (n buf-type)
1587   (or (and (eq buf-type 'C) (not ediff-3way-job))
1588       (ediff-empty-diff-region-p n buf-type)
1589       (let ((beg (ediff-get-diff-posn buf-type 'beg n))
1590             (end (ediff-get-diff-posn buf-type 'end n)))
1591         (ediff-with-current-buffer (ediff-get-buffer buf-type)
1592           (save-excursion
1593             (goto-char beg)
1594             (skip-chars-forward ediff-whitespace)
1595             (>= (point) end))))))
1596
1597 ;; temporarily uses DIR to abbreviate file name
1598 ;; if DIR is nil, use default-directory
1599 (defun ediff-abbreviate-file-name (file &optional dir)
1600   (cond ((stringp dir)
1601          (let ((directory-abbrev-alist (list (cons dir ""))))
1602            (abbreviate-file-name file)))
1603         (ediff-emacs-p (abbreviate-file-name file))
1604         (t ; XEmacs requires addl argument
1605          (abbreviate-file-name file t))))
1606
1607 ;; Takes a directory and returns the parent directory.
1608 ;; does nothing to `/'. If the ARG is a regular file,
1609 ;; strip the file AND the last dir.
1610 (defun ediff-strip-last-dir (dir)
1611   (if (not (stringp dir)) (setq dir default-directory))
1612   (setq dir (expand-file-name dir))
1613   (or (file-directory-p dir) (setq dir (file-name-directory dir)))
1614   (let* ((pos (1- (length dir)))
1615          (last-char (aref dir pos)))
1616     (if (and (> pos 0) (= last-char ?/))
1617         (setq dir (substring dir 0 pos)))
1618     (ediff-abbreviate-file-name (file-name-directory dir))))
1619
1620 (defun ediff-truncate-string-left (str newlen)
1621   ;; leave space for ... on the left
1622   (let ((len (length str))
1623         substr)
1624     (if (<= len newlen)
1625         str
1626       (setq newlen (max 0 (- newlen 3)))
1627       (setq substr (substring str (max 0 (- len 1 newlen))))
1628       (concat "..." substr))))
1629
1630 (defun ediff-abbrev-jobname (jobname)
1631   (cond ((eq jobname 'ediff-directories)
1632          "Compare two directories")
1633         ((eq jobname 'ediff-files)
1634          "Compare two files")
1635         ((eq jobname 'ediff-buffers)
1636          "Compare two buffers")
1637         ((eq jobname 'ediff-directories3)
1638          "Compare three directories")
1639         ((eq jobname 'ediff-files3)
1640          "Compare three files")
1641         ((eq jobname 'ediff-buffers3)
1642          "Compare three buffers")
1643         ((eq jobname 'ediff-revision)
1644          "Compare file with a version")
1645         ((eq jobname 'ediff-directory-revisions)
1646          "Compare dir files with versions")
1647         ((eq jobname 'ediff-merge-directory-revisions)
1648          "Merge dir files with versions")
1649         ((eq jobname 'ediff-merge-directory-revisions-with-ancestor)
1650          "Merge dir versions via ancestors")
1651         (t
1652          (let* ((str (substring (symbol-name jobname) 6))
1653                 (len (length str))
1654                 (pos 0))
1655            (while (< pos len)
1656              (if (= pos 0)
1657                  (aset str pos (upcase (aref str pos))))
1658              (if (= (aref str pos) ?-)
1659                  (aset str pos ?\ ))
1660              (setq pos (1+ pos)))
1661            str))))
1662
1663
1664
1665 (defsubst ediff-get-region-contents (n buf-type ctrl-buf &optional start end)
1666   (ediff-with-current-buffer
1667       (ediff-with-current-buffer ctrl-buf (ediff-get-buffer buf-type))
1668     (buffer-substring
1669      (or start (ediff-get-diff-posn buf-type 'beg n ctrl-buf))
1670      (or end (ediff-get-diff-posn buf-type 'end n ctrl-buf)))))
1671
1672 ;; If ediff modified mode line, strip the modification
1673 (defsubst ediff-strip-mode-line-format ()
1674   (if (member (car mode-line-format) '(" A: " " B: " " C: " " Ancestor: "))
1675       (setq mode-line-format (nth 2 mode-line-format))))
1676
1677 ;; Verify that we have a difference selected.
1678 (defsubst ediff-valid-difference-p (&optional n)
1679   (or n (setq n ediff-current-difference))
1680   (and (>= n 0) (< n ediff-number-of-differences)))
1681
1682 (defsubst ediff-show-all-diffs (n)
1683   "Don't skip difference regions."
1684   nil)
1685
1686 (defsubst Xor (a b)
1687   (or (and a (not b)) (and (not a) b)))
1688
1689 (defsubst ediff-message-if-verbose (string &rest args)
1690   (if ediff-verbose-p
1691       (apply 'message string args)))
1692
1693 (defun ediff-file-attributes (filename attr-number)
1694   (if (ediff-file-remote-p filename)
1695       -1
1696     (nth attr-number (file-attributes filename))))
1697
1698 (defsubst ediff-file-size (filename)
1699   (ediff-file-attributes filename 7))
1700 (defsubst ediff-file-modtime (filename)
1701   (ediff-file-attributes filename 5))
1702
1703
1704 (defun ediff-convert-standard-filename (fname)
1705   (if (fboundp 'convert-standard-filename)
1706       (convert-standard-filename fname)
1707     fname))
1708
1709
1710 ;;; Local Variables:
1711 ;;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
1712 ;;; eval: (put 'ediff-with-current-buffer 'lisp-indent-hook 1)
1713 ;;; eval: (put 'ediff-with-current-buffer 'edebug-form-spec '(form body))
1714 ;;; End:
1715
1716 (provide 'ediff-init)
1717
1718
1719 ;;; ediff-init.el  ends here