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 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 ;; Is it XEmacs?
  27 (defconst ediff-xemacs-p (string-match "XEmacs" emacs-version))
  28 ;; Is it Emacs?
  29 (defconst ediff-emacs-p (not ediff-xemacs-p))
  30 ;; Are we running as a window application or on a TTY?
  31 (defsubst ediff-device-type ()
  32   (if ediff-emacs-p
  33       window-system
  34     (device-type (selected-device))))
  35 ;; in XEmacs: device-type is tty on tty and stream in batch.
  36 (defsubst ediff-window-display-p ()
  37   (and (ediff-device-type) (not (memq (ediff-device-type) '(tty stream)))))
  38
  39 ;;; Macros
  40 (defmacro ediff-odd-p (arg)
  41   (` (eq (logand (, arg) 1) 1)))
  42
  43 (defmacro ediff-buffer-live-p (buf)
  44   (` (and (, buf) (get-buffer (, buf)) (buffer-name (get-buffer (, buf))))))
  45
  46 (defmacro ediff-get-buffer (arg)
  47   (` (cond ((eq (, arg) 'A) ediff-buffer-A)
  48            ((eq (, arg) 'B) ediff-buffer-B)
  49            ((eq (, arg) 'C) ediff-buffer-C)
  50            ((eq (, arg) 'Ancestor) ediff-ancestor-buffer)
  51            )
  52   ))
  53
  54 (defmacro ediff-get-value-according-to-buffer-type (buf-type list)
  55   (` (cond ((eq (, buf-type) 'A) (nth 0 (, list)))
  56            ((eq (, buf-type) 'B) (nth 1 (, list)))
  57            ((eq (, buf-type) 'C) (nth 2 (, list))))))
  58
  59 (defmacro ediff-char-to-buftype (arg)
  60   (` (cond ((memq (, arg) '(?a ?A)) 'A)
  61            ((memq (, arg) '(?b ?B)) 'B)
  62            ((memq (, arg) '(?c ?C)) 'C)
  63            )
  64   ))
  65
  66 (defmacro ediff-get-difference (n buf-type)
  67   (` (aref
  68       (symbol-value
  69        (intern (format "ediff-difference-vector-%S" (, buf-type)))) (, n))))
  70
  71 ;; tell if it has been previously determined that the region has
  72 ;; no diffs other than the white space and newlines
  73 ;; The argument, N, is the diff region number used by Ediff to index the
  74 ;; diff vector. It is 1 less than the number seen by the user.
  75 ;;
  76 ;; A difference vector has the form:
  77 ;; [diff diff diff ...]
  78 ;; where each diff has the form:
  79 ;; [overlay fine-diff-vector no-fine-diffs-flag]
  80 ;; fine-diff-vector is a vector [fine-diff fine-diff fine-diff ...]
  81 (defmacro ediff-no-fine-diffs-p (n)
  82   (` (aref (ediff-get-difference (, n) 'A) 2)))
  83
  84 (defmacro ediff-get-diff-overlay-from-diff-record (diff-rec)
  85   (` (aref (, diff-rec) 0)))
  86
  87 (defmacro ediff-get-diff-overlay (n buf-type)
  88   (` (ediff-get-diff-overlay-from-diff-record
  89       (ediff-get-difference (, n) (, buf-type)))))
  90
  91 (defmacro ediff-get-fine-diff-vector-from-diff-record (diff-rec)
  92   (` (aref (, diff-rec) 1)))
  93
  94 (defmacro ediff-set-fine-diff-vector (n buf-type fine-vec)
  95   (` (aset (ediff-get-difference (, n) (, buf-type)) 1 (, fine-vec))))
  96
  97 (defmacro ediff-get-state-of-diff (n buf-type)
  98   (` (if (ediff-buffer-live-p ediff-buffer-C)
  99          (aref (ediff-get-difference (, n) (, buf-type)) 3))))
 100 (defmacro ediff-set-state-of-diff (n buf-type val)
 101   (` (aset (ediff-get-difference (, n) (, buf-type)) 3 (, val))))
 102 (defmacro ediff-get-state-of-merge (n)
 103   (` (if ediff-state-of-merge
 104          (aref (aref ediff-state-of-merge (, n)) 0))))
 105 (defmacro ediff-get-state-of-ancestor (n)
 106   (` (if ediff-state-of-merge
 107          (aref (aref ediff-state-of-merge (, n)) 1))))
 108 (defmacro ediff-set-state-of-merge (n val)
 109   (` (if ediff-state-of-merge
 110          (aset (aref ediff-state-of-merge (, n)) 0 (, val)))))
 111
 112 ;; if flag is t, puts a mark on diff region saying that
 113 ;; the differences are in white space only. If flag is nil,
 114 ;; the region is marked as essential (i.e., differences are
 115 ;; not just in the white space and newlines.)
 116 (defmacro ediff-mark-diff-as-space-only (n flag)
 117   (` (aset (ediff-get-difference (, n) 'A) 2 (, flag))))
 118
 119 (defmacro ediff-get-fine-diff-vector (n buf-type)
 120   (` (ediff-get-fine-diff-vector-from-diff-record
 121       (ediff-get-difference (, n) (, buf-type)))))
 122
 123
 124 ;; Defines SYMBOL as an advertised local variable.
 125 ;; Performs a defvar, then executes `make-variable-buffer-local' on
 126 ;; the variable.  Also sets the `permanent-local' property,
 127 ;; so that `kill-all-local-variables' (called by major-mode setting
 128 ;; commands) won't destroy Ediff control variables.
 129 ;;
 130 ;; Plagiarised from `emerge-defvar-local' for XEmacs.
 131 (defmacro ediff-defvar-local (var value doc)
 132   (` (progn
 133        (defvar (, var) (, value) (, doc))
 134        (make-variable-buffer-local '(, var))
 135        (put '(, var) 'permanent-local t))))
 136
 137 ;; Macro to switch to BUFFER, evaluate FORMS, returns to original buffer.
 138 ;; Differs from `save-excursion' in that it doesn't save the point and mark.
 139 ;; This is essentially `emerge-eval-in-buffer' with the test for live buffers."
 140 (defmacro ediff-eval-in-buffer (buffer &rest forms)
 141   (` (let ((StartBuffer (current-buffer)))
 142        (if (ediff-buffer-live-p (, buffer))
 143            (unwind-protect
 144                (progn
 145                  (set-buffer (, buffer))
 146                  (,@ forms))
 147              (set-buffer StartBuffer))
 148          (or (eq this-command 'ediff-quit)
 149              (error
 150               "You've killed an essential Ediff buffer---Please quit Ediff"))
 151          ))))
 152
 153
 154 (defsubst ediff-multiframe-setup-p ()
 155   (and (ediff-window-display-p) ediff-multiframe))
 156
 157 (defmacro ediff-narrow-control-frame-p ()
 158   (` (and (ediff-multiframe-setup-p)
 159           (equal ediff-help-message ediff-brief-message-string))))
 160
 161 (defmacro ediff-3way-comparison-job ()
 162   (` (memq
 163       ediff-job-name
 164       '(ediff-files3 ediff-buffers3))))
 165 (ediff-defvar-local ediff-3way-comparison-job nil "")
 166
 167 (defmacro ediff-merge-job ()
 168   (` (memq
 169       ediff-job-name
 170       '(ediff-merge-files
 171         ediff-merge-buffers
 172         ediff-merge-files-with-ancestor
 173         ediff-merge-buffers-with-ancestor
 174         ediff-merge-revisions
 175         ediff-merge-revisions-with-ancestor))))
 176 (ediff-defvar-local ediff-merge-job nil "")
 177
 178 (defmacro ediff-merge-with-ancestor-job ()
 179   (` (memq
 180       ediff-job-name
 181       '(ediff-merge-files-with-ancestor
 182         ediff-merge-buffers-with-ancestor
 183         ediff-merge-revisions-with-ancestor))))
 184 (ediff-defvar-local ediff-merge-with-ancestor-job nil "")
 185
 186 (defmacro ediff-3way-job ()
 187   (` (or ediff-3way-comparison-job ediff-merge-job)))
 188 (ediff-defvar-local ediff-3way-job nil "")
 189
 190 ;; A diff3 job is like a 3way job, but ediff-merge doesn't require the use
 191 ;; of diff3.
 192 (defmacro ediff-diff3-job ()
 193   (` (or ediff-3way-comparison-job
 194          ediff-merge-with-ancestor-job)))
 195 (ediff-defvar-local ediff-diff3-job nil "")
 196
 197 (defmacro ediff-windows-job ()
 198   (` (memq ediff-job-name '(ediff-windows-wordwise ediff-windows-linewise))))
 199 (ediff-defvar-local ediff-windows-job nil "")
 200
 201 (defmacro ediff-word-mode-job ()
 202   (` (memq ediff-job-name '(ediff-windows-wordwise  ediff-regions-wordwise))))
 203 (ediff-defvar-local ediff-word-mode-job nil "")
 204
 205 (defmacro ediff-narrow-job ()
 206   (` (memq ediff-job-name '(ediff-windows-wordwise
 207                             ediff-regions-wordwise
 208                             ediff-windows-linewise
 209                             ediff-regions-linewise))))
 210 (ediff-defvar-local ediff-narrow-job nil "")
 211
 212 ;; Note: ediff-merge-directory-revisions-with-ancestor is not treated as an
 213 ;; ancestor metajob, since it behaves differently.
 214 (defsubst ediff-ancestor-metajob (&optional metajob)
 215   (memq (or metajob ediff-metajob-name)
 216         '(ediff-merge-directories-with-ancestor
 217           ediff-merge-filegroups-with-ancestor)))
 218 (defsubst ediff-revision-metajob (&optional metajob)
 219   (memq (or metajob ediff-metajob-name)
 220         '(ediff-directory-revisions
 221           ediff-merge-directory-revisions
 222           ediff-merge-directory-revisions-with-ancestor)))
 223 ;; metajob involving only one directory
 224 (defsubst ediff-dir1-metajob (&optional metajob)
 225   (or (ediff-revision-metajob metajob)
 226       ;; add more here
 227       ))
 228 (defsubst ediff-collect-diffs-metajob (&optional metajob)
 229   (or (ediff-revision-metajob metajob)
 230       (memq ediff-metajob-name
 231             '(ediff-directories
 232               ;; add more here
 233               ediff-directory-revisions))))
 234 (defsubst ediff-metajob3 (&optional metajob)
 235   (memq (or metajob ediff-metajob-name)
 236         '(ediff-merge-directories-with-ancestor
 237           ediff-merge-filegroups-with-ancestor
 238           ediff-directories3
 239           ediff-filegroups3)))
 240 (defsubst ediff-comparison-metajob3 (&optional metajob)
 241   (memq (or metajob ediff-metajob-name)
 242         '(ediff-directories3 ediff-filegroups3)))
 243
 244 (defsubst ediff-barf-if-not-control-buffer (&optional meta-buf)
 245   (or (eq (if meta-buf ediff-meta-buffer ediff-control-buffer)
 246           (current-buffer))
 247       (error "%S: This command runs in Ediff Control Buffer only!"
 248              this-command)))
 249
 250
 251 ;; Hook variables
 252
 253 (defvar ediff-before-setup-windows-hook nil
 254   "*Hooks to run before Ediff sets its window configuration.
 255 This can be used to save the previous window config, which can be restored
 256 on ediff-quit or ediff-suspend.")
 257 (defvar ediff-after-setup-windows-hook nil
 258   "*Hooks to run after Ediff sets its window configuration.
 259 This can be used to set up control window or icon in a desired place.")
 260 (defvar ediff-before-setup-control-frame-hook nil
 261   "*Hooks run before setting up the frame to display Ediff Control Panel.
 262 Can be used to change control frame parameters to position it where it
 263 is desirable.")
 264 (defvar ediff-after-setup-control-frame-hook nil
 265   "*Hooks run after setting up the frame to display Ediff Control Panel.
 266 Can be used to move the frame where it is desired.")
 267 (defvar ediff-startup-hook nil
 268   "*Hooks to run in the control buffer after Ediff has been set up.")
 269 (defvar ediff-select-hook nil
 270   "*Hooks to run after a difference has been selected.")
 271 (defvar ediff-unselect-hook nil
 272   "*Hooks to run after a difference has been unselected.")
 273 (defvar ediff-prepare-buffer-hook  nil
 274   "*Hooks called after buffers A, B, and C are set up.")
 275 (defvar ediff-load-hook nil
 276   "*Hook run after Ediff is loaded.  Can be used to change defaults.")
 277
 278 (defvar ediff-mode-hook nil
 279   "*Hook run just after ediff-mode is set up in the control buffer.
 280 This is done before any windows or frames are created. One can use it to
 281 set local variables that determine how the display looks like.")
 282 (defvar ediff-keymap-setup-hook nil
 283   "*Hook run just after the default bindings in Ediff keymap are set up.")
 284
 285 (defvar ediff-display-help-hook nil
 286   "*Hooks run after preparing the help message.")
 287
 288 (defvar ediff-suspend-hook (list 'ediff-default-suspend-function)
 289   "*Hooks to run in the Ediff control buffer when Ediff is suspended.")
 290 (defvar ediff-quit-hook (list 'ediff-cleanup-mess)
 291   "*Hooks to run in the Ediff control buffer after finishing Ediff.")
 292 (defvar ediff-cleanup-hook nil
 293   "*Hooks to run on exiting Ediff but before killing the control buffer.
 294 This is a place to do various cleanups, such as deleting the variant buffers.
 295 Ediff provides a function, `ediff-janitor', as one such possible hook.")
 296
 297
 298 ;; Help messages
 299
 300 (defconst ediff-long-help-message-head
 301   "   Moving around     |     Toggling features     |       Manipulations
 302 =====================|===========================|============================="
 303   "The head of the full help message.")
 304 (defconst ediff-long-help-message-tail
 305   "=====================|===========================|=============================
 306     R -show registry |                           |  M   -show session group
 307     D -diff output   |     E -browse Ediff manual|  G   -send bug report
 308     i -status info   |     ? -help off           |  z/q -suspend/quit
 309 -------------------------------------------------------------------------------
 310 X,Y (x,y)  on the left are meta-symbols for the keys  A,B,C (a,b,c).
 311 X,Y on the right are meta-symbols for buffers A,B,C.
 312 A,B,C on the right denote the working buffers A,B,C, respectively."
 313   "The tail of the full-help message.")
 314
 315 (defconst ediff-long-help-message-compare3
 316   "
 317 p,DEL -previous diff |     | -vert/horiz split   | xy -copy buf X's region to Y
 318 n,SPC -next diff     |     h -hiliting           | rx -restore buf X's old diff
 319     j -jump to diff  |     @ -auto-refinement    |  * -refine current region
 320    gx -goto X's point|                           |  ! -update diff regions
 321   C-l -recenter      |    ## -ignore whitespace  |
 322   v/V -scroll up/dn  | #f/#h -focus/hide regions | wx -save buf X
 323   </> -scroll lt/rt  |     X -read-only in buf X | wd -save diff output
 324                      |     m -wide display       |  ~ -rotate buffers
 325 "
 326   "Help message usually used for 3-way comparison.
 327 Normally, not a user option. See `ediff-help-message' for details.")
 328
 329 (defconst ediff-long-help-message-compare2
 330   "
 331 p,DEL -previous diff |     | -vert/horiz split   |a/b -copy A/B's region to B/A
 332 n,SPC -next diff     |     h -hiliting           | rx -restore buf X's old diff
 333     j -jump to diff  |     @ -auto-refinement    |  * -refine current region
 334    gx -goto X's point|                           |  ! -update diff regions
 335   C-l -recenter      |    ## -ignore whitespace  |
 336   v/V -scroll up/dn  | #f/#h -focus/hide regions | wx -save buf X
 337   </> -scroll lt/rt  |     X -read-only in buf X | wd -save diff output
 338                      |     m -wide display       |  ~ -swap buffers
 339 "
 340   "Help message usually used for 2-way comparison.
 341 Normally, not a user option. See `ediff-help-message' for details.")
 342
 343 (defconst ediff-long-help-message-narrow2
 344   "
 345 p,DEL -previous diff |     | -vert/horiz split   |a/b -copy A/B's region to B/A
 346 n,SPC -next diff     |     h -hiliting           | rx -restore buf X's old diff
 347     j -jump to diff  |     @ -auto-refinement    |  * -refine current region
 348    gx -goto X's point|     % -narrow/widen buffs |  ! -update diff regions
 349   C-l -recenter      |    ## -ignore whitespace  |
 350   v/V -scroll up/dn  | #f/#h -focus/hide regions | wx -save buf X
 351   </> -scroll lt/rt  |     X -read-only in buf X | wd -save diff output
 352                      |     m -wide display       |  ~ -swap buffers
 353 "
 354   "Help message when comparing windows or regions line-by-line.
 355 Normally, not a user option. See `ediff-help-message' for details.")
 356
 357 (defconst ediff-long-help-message-word-mode
 358   "
 359 p,DEL -previous diff |     | -vert/horiz split   | xy -copy buf X's region to Y
 360 n,SPC -next diff     |     h -hiliting           | rx -restore buf X's old diff
 361     j -jump to diff  |                           |
 362    gx -goto X's point|     % -narrow/widen buffs |  ! -recompute diffs
 363   C-l -recenter      |                           |
 364   v/V -scroll up/dn  | #f/#h -focus/hide regions | wx -save buf X
 365   </> -scroll lt/rt  |     X -read-only in buf X | wd -save diff output
 366                      |     m -wide display       |  ~ -swap buffers
 367 "
 368   "Help message when comparing windows or regions word-by-word.
 369 Normally, not a user option. See `ediff-help-message' for details.")
 370
 371 (defconst ediff-long-help-message-merge
 372   "
 373 p,DEL -previous diff |     | -vert/horiz split   |  x -copy buf X's region to C
 374 n,SPC -next diff     |     h -hiliting           |  r -restore buf C's old diff
 375     j -jump to diff  |     @ -auto-refinement    |  * -refine current region
 376    gx -goto X's point|    ## -ignore whitespace  |  ! -update diff regions
 377   C-l -recenter      | #f/#h -focus/hide regions |  + -combine diff regions
 378   v/V -scroll up/dn  |     X -read-only in buf X | wx -save buf X
 379   </> -scroll lt/rt  |     m -wide display       | wd -save diff output
 380     / -ancestor buff |     s -shrink window C    |  ~ -swap buffers
 381                      |     $ -show clashes only  |  & -merge w/new default
 382 "
 383   "Help message during merging.
 384 Normally, not a user option. See `ediff-help-message' for details.")
 385
 386 ;; The actual long help message.
 387 (ediff-defvar-local ediff-long-help-message ""
 388   "Normally, not a user option. See `ediff-help-message' for details.")
 389
 390 (defconst ediff-brief-message-string
 391   "  ? - help  "
 392   "Contents of the brief help message.")
 393 ;; The actual brief help message
 394 (ediff-defvar-local ediff-brief-help-message ""
 395   "Normally, not a user option. See `ediff-help-message' for details.")
 396
 397 (ediff-defvar-local ediff-brief-help-message-function nil
 398   "The brief help message that the user can customize.
 399 If the user sets this to a parameter-less function, Ediff will use it to
 400 produce the brief help message. This function must return a string.")
 401 (ediff-defvar-local ediff-long-help-message-function nil
 402   "The long help message that the user can customize.
 403 See `ediff-brief-help-message-function' for more.")
 404
 405 (defvar ediff-prefer-long-help-message nil
 406   "*If t, Ediff starts with a long help message. Short help msg otherwise.")
 407
 408 ;; The actual help message.
 409 (ediff-defvar-local ediff-help-message ""
 410   "The actual help message.
 411 Normally, the user shouldn't touch this. However, if you want Ediff to
 412 start up with different help messages for different jobs, you can change
 413 the value of this variable and the variables `ediff-help-message-*' in
 414 `ediff-startup-hook'.")
 415
 416 ;; Selective browsing
 417
 418 (ediff-defvar-local ediff-skip-diff-region-function 'ediff-show-all-diffs
 419   "Function that determines the next/previous diff region to show.
 420 Should return t for regions to be ignored and nil otherwise.
 421 This function gets a region number as an argument. The region number
 422 is the one used internally by Ediff. It is 1 less than the number seen
 423 by the user.")
 424
 425 (ediff-defvar-local ediff-hide-regexp-matches-function
 426   'ediff-hide-regexp-matches
 427   "Function to use in determining which regions to hide.
 428 See the documentation string of `ediff-hide-regexp-matches' for details.")
 429 (ediff-defvar-local ediff-focus-on-regexp-matches-function
 430   'ediff-focus-on-regexp-matches
 431   "Function to use in determining which regions to focus on.
 432 See the documentation string of `ediff-focus-on-regexp-matches' for details.")
 433
 434 ;; Regexp that determines buf A regions to focus on when skipping to diff
 435 (ediff-defvar-local ediff-regexp-focus-A "" "")
 436 ;; Regexp that determines buf B regions to focus on when skipping to diff
 437 (ediff-defvar-local ediff-regexp-focus-B "" "")
 438 ;; Regexp that determines buf C regions to focus on when skipping to diff
 439 (ediff-defvar-local ediff-regexp-focus-C "" "")
 440 ;; connective that determines whether to focus regions that match both or
 441 ;; one of the regexps
 442 (ediff-defvar-local ediff-focus-regexp-connective 'and "")
 443
 444 ;; Regexp that determines buf A regions to ignore when skipping to diff
 445 (ediff-defvar-local ediff-regexp-hide-A "" "")
 446 ;; Regexp that determines buf B regions to ignore when skipping to diff
 447 (ediff-defvar-local ediff-regexp-hide-B "" "")
 448 ;; Regexp that determines buf C regions to ignore when skipping to diff
 449 (ediff-defvar-local ediff-regexp-hide-C "" "")
 450 ;; connective that determines whether to hide regions that match both or
 451 ;; one of the regexps
 452 (ediff-defvar-local ediff-hide-regexp-connective 'and "")
 453
 454
 455 (defvar ediff-ange-ftp-ftp-name (if ediff-xemacs-p
 456                                     'ange-ftp-ftp-path
 457                                   'ange-ftp-ftp-name)
 458   "Function ange-ftp uses to find out if file is remote.")
 459
 460
 461 ;; Copying difference regions between buffers.
 462 (ediff-defvar-local ediff-killed-diffs-alist nil
 463   "A list of killed diffs.
 464 A diff is saved here if it is replaced by a diff
 465 from another buffer.  This alist has the form:
 466 \((num (buff-object . diff) (buff-object . diff) (buff-object . diff)) ...),
 467 where some buffer-objects may be missing.")
 468
 469
 470 ;; Highlighting
 471 ;;(defvar ediff-before-flag-bol (if ediff-emacs-p "->>\n" (make-glyph "->>\n"))
 472 (defvar ediff-before-flag-bol (if ediff-xemacs-p (make-glyph "->>") "->>")
 473   "*Flag placed above the highlighted block of differences.
 474 Must end with newline.")
 475 ;;(defvar ediff-after-flag-eol  (if ediff-emacs-p "<<-\n" (make-glyph "<<-"))
 476 (defvar ediff-after-flag-eol  (if ediff-xemacs-p (make-glyph "<<-") "<<-")
 477   "*Flag placed below the highlighted block of differences.
 478 Must end with newline.")
 479
 480 (defvar ediff-before-flag-mol (if ediff-xemacs-p (make-glyph "->>") "->>")
 481   "*Like ediff-before-flag, used when a difference starts in mid-line.")
 482 (defvar ediff-after-flag-mol  (if ediff-xemacs-p (make-glyph "<<-") "<<-")
 483   "*Like ediff-after-flag, used when a difference starts in mid-line.")
 484
 485
 486 (ediff-defvar-local ediff-use-faces t
 487   "If t, differences are highlighted using faces on a window system.
 488 If nil, they are highlighted using ASCII flags, ediff-before-flag
 489 and ediff-after-flag.  On a non-window system, differences are always
 490 highlighted using ASCII flags.
 491 This variable can be set either in .emacs or toggled interactively.
 492 Use `setq-default' if setting it in .emacs")
 493
 494
 495 ;; this indicates that diff regions are word-size, so fine diffs are
 496 ;; permanently nixed; used in ediff-windows-wordwise and ediff-regions-wordwise
 497 (ediff-defvar-local ediff-word-mode nil "")
 498 ;; Name of the job (ediff-files, ediff-windows, etc.)
 499 (ediff-defvar-local ediff-job-name nil "")
 500
 501 ;; Narrowing and ediff-region/windows support
 502 ;; This is a list (overlay-A overlay-B overlay-C)
 503 ;; If set, Ediff compares only those parts of buffers A/B/C that lie within
 504 ;; the bounds of these overlays.
 505 (ediff-defvar-local ediff-narrow-bounds nil "")
 506
 507 ;; List (overlay-A overlay-B overlay-C), where each overlay spans the
 508 ;; entire corresponding buffer.
 509 (ediff-defvar-local ediff-wide-bounds nil "")
 510
 511 ;; Current visibility boundaries in buffers A, B, and C.
 512 ;; This is also a list of overlays. When the user toggles narrow/widen,
 513 ;; this list changes from ediff-wide-bounds to ediff-narrow-bounds.
 514 ;; and back.
 515 (ediff-defvar-local ediff-visible-bounds nil "")
 516
 517 (ediff-defvar-local ediff-start-narrowed t
 518   "Non-nil means start narrowed, if doing ediff-windows-* or ediff-regions-*")
 519 (ediff-defvar-local ediff-quit-widened t
 520   "*Non-nil means: when finished, Ediff widens buffers A/B.
 521 Actually, Ediff restores the scope of visibility that existed at startup.")
 522 (defvar ediff-keep-variants t
 523   "*Nil means that non-modified variant buffers should be removed after some
 524 interrogation.
 525 Supplying a prefix argument to the quit command `q' temporarily reverses the
 526 meaning of this variable.")
 527
 528 (ediff-defvar-local ediff-highlight-all-diffs t
 529   "If nil, only the selected differences are highlighted.
 530 This variable can be set either in .emacs or toggled interactively, using
 531 ediff-toggle-hilit. Use `setq-default' to set it.")
 532
 533 ;; A var local to each control panel buffer.  Indicates highlighting style
 534 ;; in effect for this buffer: `face', `ascii', nil -- temporarily
 535 ;; unhighlighted, `off' -- turned off \(on a dumb terminal only\).
 536 (ediff-defvar-local ediff-highlighting-style nil "")
 537
 538
 539 ;; Variables that control each Ediff session.  They are local to the
 540 ;; control buffer.
 541
 542 ;; Mode variables
 543 ;; The buffer in which the A variant is stored.
 544 (ediff-defvar-local ediff-buffer-A nil "")
 545 ;; The buffer in which the B variant is stored.
 546 (ediff-defvar-local ediff-buffer-B nil "")
 547 ;; The buffer in which the C variant is stored.
 548 (ediff-defvar-local ediff-buffer-C nil "")
 549 ;; Ancestor buffer
 550 (ediff-defvar-local ediff-ancestor-buffer nil "")
 551 ;; The control buffer of ediff.
 552 (ediff-defvar-local ediff-control-buffer nil "")
 553
 554
 555 ;; The suffix of the control buffer name.
 556 (ediff-defvar-local ediff-control-buffer-suffix nil "")
 557 ;; Same as ediff-control-buffer-suffix, but without <,>.
 558 ;; It's a number rather than string.
 559 (ediff-defvar-local ediff-control-buffer-number nil "")
 560
 561
 562 ;; The original values of ediff-protected-variables for buffer A
 563 (ediff-defvar-local ediff-buffer-values-orig-A nil "")
 564 ;; The original values of ediff-protected-variables for buffer B
 565 (ediff-defvar-local ediff-buffer-values-orig-B nil "")
 566 ;; The original values of ediff-protected-variables for buffer C
 567 (ediff-defvar-local ediff-buffer-values-orig-C nil "")
 568 ;; The original values of ediff-protected-variables for buffer Ancestor
 569 (ediff-defvar-local ediff-buffer-values-orig-Ancestor nil "")
 570 ;; Buffer-local variables to be saved then restored during Ediff sessions
 571 ;; Buffer-local variables to be saved then restored during Ediff sessions
 572 (defconst ediff-protected-variables '(buffer-read-only
 573                                       synchronize-minibuffers
 574                                       mode-line-format))
 575
 576 ;; Vector of differences between the variants.  Each difference is
 577 ;; represented by a vector of two overlays plus a vector of fine diffs,
 578 ;; plus a no-fine-diffs flag.  The first overlay spans the
 579 ;; difference region in the A buffer and the second overlays the diff in
 580 ;; the B buffer. If a difference section is empty, the corresponding
 581 ;; overlay's endpoints coincide.
 582 ;;
 583 ;; The precise form of a difference vector for one buffer is:
 584 ;; [diff diff diff ...]
 585 ;; where each diff has the form:
 586 ;; [diff-overlay fine-diff-vector no-fine-diffs-flag state-of-difference]
 587 ;; fine-diff-vector is a vector [fine-diff-overlay fine-diff-overlay ...]
 588 ;; no-fine-diffs-flag says if there are fine differences.
 589 ;; state-of-difference is A, B, C, or nil, indicating which buffer is
 590 ;; different from the other two (used only in 3-way jobs.
 591 (ediff-defvar-local ediff-difference-vector-A nil "")
 592 (ediff-defvar-local ediff-difference-vector-B nil "")
 593 (ediff-defvar-local ediff-difference-vector-C nil "")
 594 (ediff-defvar-local ediff-difference-vector-Ancestor nil "")
 595
 596 ;; [ status status status ...]
 597 ;; Each status: [state-of-merge state-of-ancestor]
 598 ;; state-of-merge is default-A, default-B, prefer-A, or prefer-B. It
 599 ;; indicates the way a diff region was created in buffer C.
 600 ;; state-of-ancestor says if the corresponding region in ancestor buffer is
 601 ;; empty.
 602 (ediff-defvar-local ediff-state-of-merge nil "")
 603
 604 ;; The difference that is currently selected.
 605 (ediff-defvar-local ediff-current-difference -1 "")
 606 ;; Number of differences found.
 607 (ediff-defvar-local ediff-number-of-differences nil "")
 608
 609 ;; Buffer containing the output of diff, which is used by Ediff to step
 610 ;; through files.
 611 (ediff-defvar-local ediff-diff-buffer nil "")
 612 ;; Like ediff-diff-buffer, but contains context diff. It is not used by
 613 ;; Ediff, but it is saved in a file, if user requests so.
 614 (ediff-defvar-local ediff-custom-diff-buffer nil "")
 615 ;; Buffer used for diff-style fine differences between regions.
 616 (ediff-defvar-local ediff-fine-diff-buffer nil "")
 617 ;; Temporary buffer used for computing fine differences.
 618 (defconst ediff-tmp-buffer " *ediff-tmp*" "")
 619 ;; Buffer used for messages
 620 (defconst ediff-msg-buffer " *ediff-message*" "")
 621 ;; Buffer containing the output of diff when diff returns errors.
 622 (ediff-defvar-local ediff-error-buffer nil "")
 623 ;; Buffer to display debug info
 624 (ediff-defvar-local ediff-debug-buffer "*ediff-debug*" "")
 625
 626 ;; List of ediff control panels associated with each buffer A/B/C/Ancestor.
 627 ;; Not used any more, but may be needed in the future.
 628 (ediff-defvar-local ediff-this-buffer-ediff-sessions  nil "")
 629
 630 ;; to be deleted in due time
 631 ;; List of difference overlays disturbed by working with the current diff.
 632 (defvar ediff-disturbed-overlays nil "")
 633
 634 ;; Priority of non-selected overlays.
 635 (defvar ediff-shadow-overlay-priority  100 "")
 636
 637 (defvar ediff-version-control-package 'vc
 638   "Version control package used.
 639 Currently, Ediff supports vc.el, rcs.el, and generic-sc.el. The standard Emacs
 640 interface to RCS, CVS, SCCS, etc., is vc.el. However, some people find the
 641 other two packages more convenient. Set this variable `rcs' or `generic-sc' if
 642 you are such a person.")
 643
 644
 645 (if ediff-xemacs-p
 646     (progn
 647       (fset 'ediff-read-event (symbol-function 'next-command-event))
 648       (fset 'ediff-overlayp (symbol-function 'extentp))
 649       (fset 'ediff-make-overlay (symbol-function 'make-extent))
 650       (fset 'ediff-delete-overlay (symbol-function 'delete-extent))
 651       (fset 'ediff-overlay-buffer (symbol-function 'extent-buffer))
 652       (fset 'ediff-overlay-get (symbol-function 'extent-property)))
 653   (fset 'ediff-read-event (symbol-function 'read-event))
 654   (fset 'ediff-overlayp (symbol-function 'overlayp))
 655   (fset 'ediff-overlayp (symbol-function 'overlayp))
 656   (fset 'ediff-make-overlay (symbol-function 'make-overlay))
 657   (fset 'ediff-delete-overlay (symbol-function 'delete-overlay))
 658   (fset 'ediff-overlay-buffer (symbol-function 'overlay-buffer))
 659   (fset 'ediff-overlay-get (symbol-function 'overlay-get)))
 660
 661 ;; Check the current version against the major and minor version numbers
 662 ;; using op: cur-vers op major.minor If emacs-major-version or
 663 ;; emacs-minor-version are not defined, we assume that the current version
 664 ;; is hopelessly outdated.  We assume that emacs-major-version and
 665 ;; emacs-minor-version are defined.  Otherwise, for Emacs/XEmacs 19, if the
 666 ;; current minor version is < 10 (xemacs) or < 23 (emacs) the return value
 667 ;; will be nil (when op is =, >, or >=) and t (when op is <, <=), which may be
 668 ;; incorrect. However, this gives correct result in our cases, since we are
 669 ;; testing for sufficiently high Emacs versions.
 670 (defun ediff-check-version (op major minor &optional type-of-emacs)
 671   (if (and (boundp 'emacs-major-version) (boundp 'emacs-minor-version))
 672       (and (cond ((eq type-of-emacs 'xemacs) ediff-xemacs-p)
 673                  ((eq type-of-emacs 'emacs) ediff-emacs-p)
 674                  (t t))
 675            (cond ((eq op '=) (and (= emacs-minor-version minor)
 676                                   (= emacs-major-version major)))
 677                  ((memq op '(> >= < <=))
 678                   (and (or (funcall op emacs-major-version major)
 679                            (= emacs-major-version major))
 680                        (if (= emacs-major-version major)
 681                            (funcall op emacs-minor-version minor)
 682                          t)))
 683                  (t
 684                   (error "%S: Invalid op in ediff-check-version" op))))
 685     (cond ((memq op '(= > >=)) nil)
 686           ((memq op '(< <=)) t))))
 687
 688
 689 ;;;; warn if it is a wrong version of emacs
 690 ;;(if (or (ediff-check-version '< 19 29 'emacs)
 691 ;;      (ediff-check-version '< 19 12 'xemacs))
 692 ;;    (progn
 693 ;;      (with-output-to-temp-buffer ediff-msg-buffer
 694 ;;      (switch-to-buffer ediff-msg-buffer)
 695 ;;      (insert
 696 ;;       (format "
 697 ;;
 698 ;;This version of Ediff requires
 699 ;;
 700 ;;\t Emacs 19.29 and higher
 701 ;;\t OR
 702 ;;\t XEmacs 19.12 and higher
 703 ;;
 704 ;;It is unlikely to work under Emacs version %s
 705 ;;that you are using... " emacs-version))
 706 ;;      (if noninteractive
 707 ;;          ()
 708 ;;        (beep 1)
 709 ;;        (beep 1)
 710 ;;        (insert "\n\nType any key to continue...")
 711 ;;        (ediff-read-event)))
 712 ;;      (kill-buffer ediff-msg-buffer)))
 713
 714 ;; A fix for NeXT Step
 715 ;; Should probably be eliminated in later versions.
 716 (if (and (ediff-window-display-p) (eq (ediff-device-type) 'ns))
 717     (progn
 718       (fset 'x-display-color-p (symbol-function 'ns-display-color-p))
 719       (fset 'x-color-defined-p (symbol-function 'ns-color-defined-p))
 720       (fset 'x-display-pixel-height (symbol-function 'ns-display-pixel-height))
 721       (fset 'x-display-pixel-width (symbol-function 'ns-display-pixel-width))
 722       ))
 723
 724
 725 (defsubst ediff-color-display-p ()
 726   (if ediff-emacs-p
 727       (x-display-color-p)
 728     (eq (device-class (selected-device)) 'color)))
 729
 730
 731 (if (ediff-window-display-p)
 732     (if ediff-xemacs-p
 733         (progn
 734           (fset 'ediff-display-pixel-width
 735                 (symbol-function 'device-pixel-width))
 736           (fset 'ediff-display-pixel-height
 737                 (symbol-function 'device-pixel-height))
 738           (fset 'ediff-valid-color-p (symbol-function 'valid-color-name-p))
 739           (fset 'ediff-get-face (symbol-function 'get-face)))
 740       ;; Temporary fix for OS/2 port of Emacs
 741       ;; pm-win.el in PM-Emacs should be fixed.
 742       (fset 'ediff-display-pixel-width
 743             (symbol-function 'x-display-pixel-width))
 744       (fset 'ediff-display-pixel-height
 745             (symbol-function 'x-display-pixel-height))
 746       (if (eq (ediff-device-type) 'pm)
 747           (fset 'ediff-valid-color-p
 748                 (function (lambda (color) (assoc color pm-color-alist))))
 749         (fset 'ediff-valid-color-p (symbol-function 'x-color-defined-p)))
 750       (fset 'ediff-get-face (symbol-function 'internal-get-face))))
 751
 752
 753 (defun ediff-make-current-diff-overlay (type)
 754   (if (ediff-window-display-p)
 755       (let ((overlay (intern (format "ediff-current-diff-overlay-%S" type)))
 756             (buffer (ediff-get-buffer type))
 757             (face (face-name
 758                    (symbol-value
 759                     (intern (format "ediff-current-diff-face-%S" type))))))
 760         (set overlay
 761              (ediff-make-bullet-proof-overlay (point-max) (point-max) buffer))
 762         (ediff-set-overlay-face (symbol-value overlay) face)
 763         (ediff-overlay-put (symbol-value overlay) 'ediff ediff-control-buffer))
 764     ))
 765
 766 (defun ediff-set-overlay-face (extent face)
 767   (ediff-overlay-put extent 'face face)
 768   (ediff-overlay-put extent 'help-echo 'ediff-region-help-echo))
 769
 770 ;; This does nothing in Emacs, since overlays there have no help-echo property
 771 (defun ediff-region-help-echo (extent)
 772   (let ((is-current (ediff-overlay-get extent 'ediff))
 773         (face (ediff-overlay-get extent 'face))
 774         (diff-num (ediff-overlay-get extent 'ediff-diff-num))
 775         face-help help-msg)
 776
 777     ;; This happens only for refinement overlays
 778     (setq face-help (and face (get face 'ediff-help-echo)))
 779
 780     (setq help-msg
 781           (cond ((and is-current diff-num) ; current diff region
 782                  (format "Difference region %S -- current" (1+ diff-num)))
 783                 (face-help) ; refinement of current diff region
 784                 (diff-num ; non-current
 785                  (format "Difference region %S -- non-current" (1+ diff-num)))
 786                 (t ""))))) ; none
 787
 788 (defun ediff-set-face (ground face color)
 789   "Set face foreground/background."
 790   (if (ediff-window-display-p)
 791       (if (ediff-valid-color-p color)
 792           (if (eq ground 'foreground)
 793               (set-face-foreground face color)
 794             (set-face-background face color))
 795         (cond ((memq face
 796                      '(ediff-current-diff-face-A
 797                        ediff-current-diff-face-B
 798                        ediff-current-diff-face-C
 799                        ediff-current-diff-face-Ancestor))
 800                (copy-face 'highlight face))
 801               ((memq face
 802                      '(ediff-fine-diff-face-A
 803                        ediff-fine-diff-face-B
 804                        ediff-fine-diff-face-C
 805                        ediff-fine-diff-face-Ancestor))
 806                (copy-face 'secondary-selection face)
 807                (set-face-underline-p face t))
 808               ((memq face
 809                      '(ediff-even-diff-face-A
 810                        ediff-odd-diff-face-A
 811                        ediff-even-diff-face-B ediff-odd-diff-face-B
 812                        ediff-even-diff-face-C ediff-odd-diff-face-C
 813                        ediff-even-diff-face-Ancestor
 814                        ediff-odd-diff-face-Ancestor))
 815                (copy-face 'secondary-selection face))))
 816     ))
 817
 818 (or (boundp 'facemenu-unlisted-faces)
 819     (setq facemenu-unlisted-faces nil))
 820
 821 (add-to-list 'facemenu-unlisted-faces 'ediff-current-diff-face-A)
 822 (defvar ediff-current-diff-face-A
 823   (if (ediff-window-display-p)
 824       (progn
 825         (make-face 'ediff-current-diff-face-A)
 826         (or (face-differs-from-default-p 'ediff-current-diff-face-A)
 827             (cond ((ediff-color-display-p)
 828                    (ediff-set-face
 829                     'foreground 'ediff-current-diff-face-A "firebrick")
 830                    (ediff-set-face
 831                     'background 'ediff-current-diff-face-A "pale green"))
 832                   (t
 833                    (if ediff-xemacs-p
 834                        (copy-face 'modeline 'ediff-current-diff-face-A)
 835                      (copy-face 'highlight 'ediff-current-diff-face-A))
 836                    )))
 837         'ediff-current-diff-face-A))
 838   "Face for highlighting the selected difference in buffer A.")
 839
 840 (add-to-list 'facemenu-unlisted-faces 'ediff-current-diff-face-B)
 841 (defvar ediff-current-diff-face-B
 842   (if (ediff-window-display-p)
 843       (progn
 844         (make-face 'ediff-current-diff-face-B)
 845         (or (face-differs-from-default-p 'ediff-current-diff-face-B)
 846             (cond ((ediff-color-display-p)
 847                    (ediff-set-face
 848                     'foreground 'ediff-current-diff-face-B "DarkOrchid")
 849                    (ediff-set-face
 850                     'background 'ediff-current-diff-face-B "Yellow"))
 851                   (t
 852                    (if ediff-xemacs-p
 853                        (copy-face 'modeline 'ediff-current-diff-face-B)
 854                      (copy-face 'highlight 'ediff-current-diff-face-B))
 855                    )))
 856         'ediff-current-diff-face-B))
 857   "Face for highlighting the selected difference in buffer B.")
 858
 859
 860 (add-to-list 'facemenu-unlisted-faces 'ediff-current-diff-face-C)
 861 (defvar ediff-current-diff-face-C
 862   (if (ediff-window-display-p)
 863       (progn
 864         (make-face 'ediff-current-diff-face-C)
 865         (or (face-differs-from-default-p 'ediff-current-diff-face-C)
 866             (cond ((ediff-color-display-p)
 867                    (ediff-set-face
 868                     'foreground 'ediff-current-diff-face-C "Navy")
 869                    (ediff-set-face
 870                     'background 'ediff-current-diff-face-C "Pink"))
 871                   (t
 872                    (if ediff-xemacs-p
 873                        (copy-face 'modeline 'ediff-current-diff-face-C)
 874                      (copy-face 'highlight 'ediff-current-diff-face-C))
 875                    )))
 876         'ediff-current-diff-face-C))
 877   "Face for highlighting the selected difference in buffer C.")
 878
 879 (add-to-list 'facemenu-unlisted-faces 'ediff-current-diff-face-Ancestor)
 880 (defvar ediff-current-diff-face-Ancestor
 881   (if (ediff-window-display-p)
 882       (progn
 883         (make-face 'ediff-current-diff-face-Ancestor)
 884         (or (face-differs-from-default-p 'ediff-current-diff-face-Ancestor)
 885             (copy-face
 886              'ediff-current-diff-face-C 'ediff-current-diff-face-Ancestor))))
 887   "Face for highlighting the selected difference in the ancestor buffer.")
 888
 889 (add-to-list 'facemenu-unlisted-faces 'ediff-fine-diff-face-A)
 890 (defvar ediff-fine-diff-face-A
 891   (if (ediff-window-display-p)
 892       (progn
 893         (make-face 'ediff-fine-diff-face-A)
 894         (or (face-differs-from-default-p 'ediff-fine-diff-face-A)
 895             (cond ((ediff-color-display-p)
 896                    (ediff-set-face 'foreground 'ediff-fine-diff-face-A
 897                                    "Navy")
 898                    (ediff-set-face 'background 'ediff-fine-diff-face-A
 899                                    "sky blue"))
 900                   (t (set-face-underline-p 'ediff-fine-diff-face-A t))))
 901         'ediff-fine-diff-face-A))
 902   "Face for highlighting the refinement of the selected diff in buffer A.")
 903
 904 (add-to-list 'facemenu-unlisted-faces 'ediff-fine-diff-face-B)
 905 (defvar ediff-fine-diff-face-B
 906   (if (ediff-window-display-p)
 907       (progn
 908         (make-face 'ediff-fine-diff-face-B)
 909         (or (face-differs-from-default-p 'ediff-fine-diff-face-B)
 910             (cond ((ediff-color-display-p)
 911                    (ediff-set-face 'foreground 'ediff-fine-diff-face-B "Black")
 912                    (ediff-set-face 'background 'ediff-fine-diff-face-B "cyan"))
 913                   (t (set-face-underline-p 'ediff-fine-diff-face-B t))))
 914         'ediff-fine-diff-face-B))
 915   "Face for highlighting the refinement of the selected diff in buffer B.")
 916
 917 (add-to-list 'facemenu-unlisted-faces 'ediff-fine-diff-face-C)
 918 (defvar ediff-fine-diff-face-C
 919   (if (ediff-window-display-p)
 920       (progn
 921         (make-face 'ediff-fine-diff-face-C)
 922         (or (face-differs-from-default-p 'ediff-fine-diff-face-C)
 923             (cond ((ediff-color-display-p)
 924                    (ediff-set-face 'foreground 'ediff-fine-diff-face-C "black")
 925                    (ediff-set-face
 926                     'background 'ediff-fine-diff-face-C "Turquoise"))
 927                   (t (set-face-underline-p 'ediff-fine-diff-face-C t))))
 928         'ediff-fine-diff-face-C))
 929   "Face for highlighting the refinement of the selected diff in buffer C.")
 930
 931 (add-to-list 'facemenu-unlisted-faces 'ediff-fine-diff-face-Ancestor)
 932 (defvar ediff-fine-diff-face-Ancestor
 933   (if (ediff-window-display-p)
 934       (progn
 935         (make-face 'ediff-fine-diff-face-Ancestor)
 936         (or (face-differs-from-default-p 'ediff-fine-diff-face-Ancestor)
 937             (copy-face
 938              'ediff-fine-diff-face-C 'ediff-fine-diff-face-Ancestor))))
 939   "Face highlighting refinements of the selected diff in ancestor buffer.
 940 Presently, this is not used, as difference regions are not refined in the
 941 ancestor buffer.")
 942
 943 (add-to-list 'facemenu-unlisted-faces 'ediff-even-diff-face-A)
 944 (defvar ediff-even-diff-face-A
 945   (if (ediff-window-display-p)
 946       (progn
 947         (make-face 'ediff-even-diff-face-A)
 948         (or (face-differs-from-default-p 'ediff-even-diff-face-A)
 949             (cond ((ediff-color-display-p)
 950                    (ediff-set-face
 951                     'foreground 'ediff-even-diff-face-A "black")
 952                    (ediff-set-face
 953                     'background 'ediff-even-diff-face-A "light grey"))
 954                   (t
 955                    (copy-face 'italic 'ediff-even-diff-face-A))))
 956         'ediff-even-diff-face-A))
 957   "Face used to highlight even-numbered differences in buffer A.")
 958
 959 (add-to-list 'facemenu-unlisted-faces 'ediff-even-diff-face-B)
 960 (defvar ediff-even-diff-face-B
 961   (if (ediff-window-display-p)
 962       (progn
 963         (make-face 'ediff-even-diff-face-B)
 964         (or (face-differs-from-default-p 'ediff-even-diff-face-B)
 965             (cond ((ediff-color-display-p)
 966                    (ediff-set-face
 967                     'foreground 'ediff-even-diff-face-B "White")
 968                    (ediff-set-face
 969                     'background 'ediff-even-diff-face-B "Gray"))
 970                   (t
 971                    (copy-face 'italic 'ediff-even-diff-face-B))))
 972         'ediff-even-diff-face-B))
 973   "Face used to highlight even-numbered differences in buffer B.")
 974
 975 (add-to-list 'facemenu-unlisted-faces 'ediff-even-diff-face-C)
 976 (defvar ediff-even-diff-face-C
 977   (if (ediff-window-display-p)
 978       (progn
 979         (make-face 'ediff-even-diff-face-C)
 980         (or (face-differs-from-default-p 'ediff-even-diff-face-C)
 981             (copy-face 'ediff-even-diff-face-A 'ediff-even-diff-face-C))
 982         'ediff-even-diff-face-C))
 983   "Face used to highlight even-numbered differences in buffer C.")
 984
 985 (add-to-list 'facemenu-unlisted-faces 'ediff-even-diff-face-Ancestor)
 986 (defvar ediff-even-diff-face-Ancestor
 987   (if (ediff-window-display-p)
 988       (progn
 989         (make-face 'ediff-even-diff-face-Ancestor)
 990         (or (face-differs-from-default-p 'ediff-even-diff-face-Ancestor)
 991             (copy-face 'ediff-even-diff-face-C 'ediff-even-diff-face-Ancestor))
 992         'ediff-even-diff-face-Ancestor))
 993   "Face highlighting even-numbered differences in the ancestor buffer.")
 994
 995 (add-to-list 'facemenu-unlisted-faces 'ediff-odd-diff-face-A)
 996 (defvar ediff-odd-diff-face-A
 997   (if (ediff-window-display-p)
 998       (progn
 999         (make-face 'ediff-odd-diff-face-A)
1000         (or (face-differs-from-default-p 'ediff-odd-diff-face-A)
1001             (cond ((ediff-color-display-p)
1002                    (ediff-set-face
1003                     'foreground 'ediff-odd-diff-face-A "White")
1004                    (ediff-set-face
1005                     'background 'ediff-odd-diff-face-A "Gray"))
1006                   (t
1007                    (copy-face 'italic 'ediff-odd-diff-face-A))))
1008         'ediff-odd-diff-face-A))
1009   "Face used to highlight odd-numbered differences in buffer A.")
1010
1011 (add-to-list 'facemenu-unlisted-faces 'ediff-odd-diff-face-B)
1012 (defvar ediff-odd-diff-face-B
1013   (if (ediff-window-display-p)
1014       (progn
1015         (make-face 'ediff-odd-diff-face-B)
1016         (or (face-differs-from-default-p 'ediff-odd-diff-face-B)
1017             (cond ((ediff-color-display-p)
1018                    (ediff-set-face
1019                     'foreground 'ediff-odd-diff-face-B "Black")
1020                    (ediff-set-face
1021                     'background 'ediff-odd-diff-face-B "light grey"))
1022                   (t
1023                    (copy-face 'italic 'ediff-odd-diff-face-B))))
1024         'ediff-odd-diff-face-B))
1025   "Face used to highlight odd-numbered differences in buffer B.")
1026
1027 (add-to-list 'facemenu-unlisted-faces 'ediff-odd-diff-face-C)
1028 (defvar ediff-odd-diff-face-C
1029   (if (ediff-window-display-p)
1030       (progn
1031         (make-face 'ediff-odd-diff-face-C)
1032         (or (face-differs-from-default-p 'ediff-odd-diff-face-C)
1033             (copy-face 'ediff-odd-diff-face-A 'ediff-odd-diff-face-C))
1034         'ediff-odd-diff-face-C))
1035   "Face used to highlight odd-numbered differences in buffer C.")
1036
1037 (add-to-list 'facemenu-unlisted-faces 'ediff-odd-diff-face-Ancestor )
1038 (defvar ediff-odd-diff-face-Ancestor
1039   (if (ediff-window-display-p)
1040       (progn
1041         (make-face 'ediff-odd-diff-face-Ancestor)
1042         (or (face-differs-from-default-p 'ediff-odd-diff-face-Ancestor)
1043             (copy-face 'ediff-odd-diff-face-C 'ediff-odd-diff-face-Ancestor))
1044         'ediff-odd-diff-face-Ancestor))
1045   "Face used to highlight even-numbered differences in the ancestor buffer.")
1046
1047 ;; Help echo
1048 (put 'ediff-fine-diff-face-A 'ediff-help-echo
1049      "A `refinement' of the current difference region")
1050 (put 'ediff-fine-diff-face-B 'ediff-help-echo
1051      "A `refinement' of the current difference region")
1052 (put 'ediff-fine-diff-face-C 'ediff-help-echo
1053      "A `refinement' of the current difference region")
1054 (put 'ediff-fine-diff-face-Ancestor 'ediff-help-echo
1055      "A `refinement' of the current difference region")
1056
1057
1058 ;;; Overlays
1059
1060 (ediff-defvar-local ediff-current-diff-overlay-A nil
1061   "Overlay for the current difference region in buffer A.")
1062 (ediff-defvar-local ediff-current-diff-overlay-B nil
1063   "Overlay for the current difference region in buffer B.")
1064 (ediff-defvar-local ediff-current-diff-overlay-C nil
1065   "Overlay for the current difference region in buffer C.")
1066 (ediff-defvar-local ediff-current-diff-overlay-Ancestor nil
1067   "Overlay for the current difference region in the ancestor buffer.")
1068
1069 ;; Compute priority of ediff overlay.
1070 (defun ediff-highest-priority (start end buffer)
1071   (let ((pos (max 1 (1- start)))
1072         ovr-list)
1073     (if ediff-xemacs-p
1074         (1+ ediff-shadow-overlay-priority)
1075       (ediff-eval-in-buffer buffer
1076         (while (< pos (min (point-max) (1+ end)))
1077           (setq ovr-list (append (overlays-at pos) ovr-list))
1078           (setq pos (next-overlay-change pos)))
1079         (1+ (apply '+
1080                    (mapcar (function
1081                             (lambda (ovr)
1082                               (if ovr
1083                                   (or (ediff-overlay-get ovr 'priority) 0)
1084                                 0)))
1085                            ovr-list)
1086                    ))
1087         ))))
1088
1089
1090 (defvar ediff-toggle-read-only-function nil
1091   "*Specifies the function to be used to toggle read-only.
1092 If nil, Ediff tries to deduce the function from the binding of C-x C-q.
1093 Normally, this is the `toggle-read-only' function, but, if version
1094 control is used, it could be `vc-toggle-read-only' or `rcs-toggle-read-only'.")
1095
1096
1097 ;;; Misc
1098
1099 ;; if nil, this silences some messages
1100 (defconst ediff-verbose-p t)
1101
1102 (defvar ediff-no-emacs-help-in-control-buffer nil
1103   "*Non-nil means C-h should not invoke Emacs help in control buffer.
1104 Instead, C-h jumps to previous difference.")
1105
1106 (defvar ediff-temp-file-prefix
1107   (let ((env (or (getenv "TMPDIR")
1108                  (getenv "TMP")
1109                  (getenv "TEMP")))
1110         d)
1111     (setq d (if (and env (> (length env) 0))
1112                 env
1113               (if (memq system-type '(vax-vms axp-vms))
1114                   "SYS$SCRATCH:"
1115                 "/tmp")))
1116     ;; The following is to make sure we get something to which we can
1117     ;; add directory levels on VMS.
1118     (setq d (file-name-as-directory (directory-file-name d)))
1119     )
1120   "*Prefix to put on Ediff temporary file names.
1121 Do not start with `~/' or `~user-name/'.")
1122
1123 (defvar ediff-temp-file-mode 384        ; u=rw only
1124   "*Mode for Ediff temporary files.")
1125
1126 ;; Metacharacters that have to be protected from the shell when executing
1127 ;; a diff/diff3 command.
1128 (defvar ediff-metachars "[ \t\n!\"#$&'()*;<=>?[\\^`{|~]"
1129   "Characters that must be quoted with \\ when used in a shell command line.
1130 More precisely, a regexp to match any one such character.")
1131
1132
1133 (ediff-defvar-local ediff-temp-file-A nil
1134   "Temporary file used for refining difference regions in buffer A.")
1135 (ediff-defvar-local ediff-temp-file-B nil
1136   "Temporary file used for refining difference regions in buffer B.")
1137 (ediff-defvar-local ediff-temp-file-C nil
1138   "Temporary file used for refining difference regions in buffer C.")
1139
1140 ;;; In-line functions
1141
1142 (defsubst ediff-file-remote-p (file-name)
1143   (if (fboundp ediff-ange-ftp-ftp-name)
1144       (funcall ediff-ange-ftp-ftp-name file-name)))
1145
1146 ;;(defun ediff-frame-has-menubar ()
1147 ;;  (and (ediff-window-display-p)
1148 ;;       (if ediff-xemacs-p
1149 ;;         current-menubar
1150 ;;       (let ((lines (cdr (assq 'menu-bar-lines
1151 ;;                               (frame-parameters (selected-frame))))))
1152 ;;         (or (eq lines t) (and (numberp lines) (< 0 lines))))
1153 ;;       )))
1154
1155 (defsubst ediff-frame-unsplittable-p (frame)
1156   (cdr (assq 'unsplittable (frame-parameters frame))))
1157
1158 (defsubst ediff-get-next-window (wind prev-wind)
1159   (or (window-live-p wind)
1160       (setq wind (if prev-wind
1161                      (next-window wind)
1162                    (selected-window)))))
1163
1164
1165 (defsubst ediff-kill-buffer-carefully (buf)
1166   "Kill buffer BUF if it exists."
1167   (if (ediff-buffer-live-p buf)
1168       (kill-buffer (get-buffer buf))))
1169
1170
1171 (defsubst ediff-highlight-diff (n)
1172   "Put face on diff N.  Invoked for X displays only."
1173   (ediff-highlight-diff-in-one-buffer n 'A)
1174   (ediff-highlight-diff-in-one-buffer n 'B)
1175   (ediff-highlight-diff-in-one-buffer n 'C)
1176   (ediff-highlight-diff-in-one-buffer n 'Ancestor)
1177   )
1178
1179
1180 (defsubst ediff-unhighlight-diff ()
1181   "Remove overlays from buffers A, B, and C."
1182   (ediff-unhighlight-diff-in-one-buffer 'A)
1183   (ediff-unhighlight-diff-in-one-buffer 'B)
1184   (ediff-unhighlight-diff-in-one-buffer 'C)
1185   (ediff-unhighlight-diff-in-one-buffer 'Ancestor)
1186   )
1187
1188 ;; delete highlighting overlays, restore faces to their original form
1189 (defsubst ediff-unhighlight-diffs-totally ()
1190   (ediff-unhighlight-diffs-totally-in-one-buffer 'A)
1191   (ediff-unhighlight-diffs-totally-in-one-buffer 'B)
1192   (ediff-unhighlight-diffs-totally-in-one-buffer 'C)
1193   (ediff-unhighlight-diffs-totally-in-one-buffer 'Ancestor)
1194   )
1195
1196 (defsubst ediff-background-face (buf-type dif-num)
1197   ;; The value of dif-num is always 1- the one that user sees.
1198   ;; This is why even face is used when dif-num is odd.
1199   (intern (format (if (ediff-odd-p dif-num)
1200                       "ediff-even-diff-face-%S"
1201                     "ediff-odd-diff-face-%S")
1202                   buf-type)))
1203
1204
1205 ;; arg is a record for a given diff in a difference vector
1206 ;; this record is itself a vector
1207 (defsubst ediff-clear-fine-diff-vector (diff-record)
1208   (if diff-record
1209       (mapcar 'ediff-delete-overlay
1210               (ediff-get-fine-diff-vector-from-diff-record diff-record))))
1211
1212 (defsubst ediff-clear-fine-differences-in-one-buffer (n buf-type)
1213   (ediff-clear-fine-diff-vector (ediff-get-difference n buf-type))
1214   (ediff-set-fine-diff-vector n buf-type nil))
1215
1216 (defsubst ediff-clear-fine-differences (n)
1217   (ediff-clear-fine-differences-in-one-buffer n 'A)
1218   (ediff-clear-fine-differences-in-one-buffer n 'B)
1219   (if ediff-3way-job
1220       (ediff-clear-fine-differences-in-one-buffer n 'C)))
1221
1222
1223 (defsubst ediff-convert-fine-diffs-to-overlays (diff-list region-num)
1224   (ediff-set-fine-overlays-in-one-buffer 'A diff-list region-num)
1225   (ediff-set-fine-overlays-in-one-buffer 'B diff-list region-num)
1226   (if ediff-3way-job
1227       (ediff-set-fine-overlays-in-one-buffer 'C diff-list region-num)
1228     ))
1229
1230 (defsubst ediff-mouse-event-p (event)
1231   (if ediff-xemacs-p
1232       (button-event-p event)
1233     (string-match "mouse" (format "%S" (event-basic-type event)))
1234     ))
1235
1236
1237 (defsubst ediff-key-press-event-p (event)
1238   (if ediff-xemacs-p
1239       (key-press-event-p event)
1240     (or (char-or-string-p event) (symbolp event))))
1241
1242 (defun ediff-event-point (event)
1243   (cond ((ediff-mouse-event-p event)
1244          (if ediff-xemacs-p
1245              (event-point event)
1246            (posn-point (event-start event))))
1247         ((ediff-key-press-event-p event)
1248          (point))
1249         (t (error ""))))
1250
1251 (defun ediff-event-buffer (event)
1252   (cond ((ediff-mouse-event-p event)
1253          (if ediff-xemacs-p
1254              (event-buffer event)
1255            (window-buffer (posn-window (event-start event)))))
1256         ((ediff-key-press-event-p event)
1257          (current-buffer))
1258         (t (error ""))))
1259
1260
1261 (defsubst ediff-frame-iconified-p (frame)
1262   (if (and (ediff-window-display-p) (frame-live-p frame))
1263       (if ediff-xemacs-p
1264           (frame-iconified-p frame)
1265         (eq (frame-visible-p frame) 'icon))))
1266
1267 (defsubst ediff-window-visible-p (wind)
1268   ;; under TTY, window-live-p also means window is visible
1269   (and (window-live-p wind)
1270        (or (not (ediff-window-display-p))
1271            (frame-visible-p (window-frame wind)))))
1272
1273
1274 (defsubst ediff-frame-char-width (frame)
1275   (if ediff-xemacs-p
1276       (/ (frame-pixel-width frame) (frame-width frame))
1277     (frame-char-width frame)))
1278
1279 (defun ediff-reset-mouse (&optional frame do-not-grab-mouse)
1280   (or frame (setq frame (selected-frame)))
1281   (if (ediff-window-display-p)
1282       (let ((frame-or-wind frame))
1283         (if ediff-xemacs-p
1284             (setq frame-or-wind (frame-selected-window frame)))
1285         (or do-not-grab-mouse
1286             ;; don't set mouse if the user said to never do this
1287             (not ediff-grab-mouse)
1288             ;; Don't grab on quit, if the user doesn't want to.
1289             ;; If ediff-grab-mouse = t, then mouse won't be grabbed for
1290             ;; sessions that are not part of a group (this is done in
1291             ;; ediff-recenter). The condition below affects only terminating
1292             ;; sessions in session groups (in which case mouse is warped into
1293             ;; a meta buffer).
1294             (and (eq ediff-grab-mouse 'maybe)
1295                  (memq this-command '(ediff-quit ediff-update-diffs)))
1296             (set-mouse-position frame-or-wind 1 0))
1297         )))
1298
1299 (defsubst ediff-spy-after-mouse ()
1300   (setq ediff-mouse-pixel-position (mouse-pixel-position)))
1301
1302 ;; This is actually not easy to find out since emacs and xemacs behave
1303 ;; differently when mouse is not in any frame. Also, this is sensitive to
1304 ;; when the user grabbed mouse.
1305 ;; Not used for now.
1306 (defun ediff-user-grabbed-mouse ()
1307   (if ediff-mouse-pixel-position
1308       (cond ((not (eq (car ediff-mouse-pixel-position)
1309                       (car (mouse-pixel-position)))))
1310             ((and (car (cdr ediff-mouse-pixel-position))
1311                   (car (cdr (mouse-pixel-position)))
1312                   (cdr (cdr ediff-mouse-pixel-position))
1313                   (cdr (cdr (mouse-pixel-position))))
1314              (not (and (< (abs (- (car (cdr ediff-mouse-pixel-position))
1315                                   (car (cdr (mouse-pixel-position)))))
1316                           ediff-mouse-pixel-threshold)
1317                        (< (abs (- (cdr (cdr ediff-mouse-pixel-position))
1318                                   (cdr (cdr (mouse-pixel-position)))))
1319                           ediff-mouse-pixel-threshold))))
1320             (t nil))))
1321
1322 (defsubst ediff-frame-char-height (frame)
1323   (if ediff-xemacs-p
1324       (/ (frame-pixel-height frame) (frame-height frame))
1325     (frame-char-height frame)))
1326
1327
1328 (defsubst ediff-empty-overlay-p (overl)
1329   (= (ediff-overlay-start overl) (ediff-overlay-end overl)))
1330
1331 ;; t if diff region is empty.
1332 ;; In case of buffer C, t also if it is not a 3way
1333 ;; comparison job (merging jobs return t as well).
1334 (defun ediff-empty-diff-region-p (n buf-type)
1335   (if (eq buf-type 'C)
1336       (or (not ediff-3way-comparison-job)
1337           (= (ediff-get-diff-posn 'C 'beg n)
1338              (ediff-get-diff-posn 'C 'end n)))
1339     (= (ediff-get-diff-posn buf-type 'beg n)
1340        (ediff-get-diff-posn buf-type 'end n))))
1341
1342 ;; Test if diff region is white space only.
1343 ;; If 2-way job and buf-type = C, then returns t.
1344 (defun ediff-whitespace-diff-region-p (n buf-type)
1345   (or (and (eq buf-type 'C) (not ediff-3way-job))
1346       (ediff-empty-diff-region-p n buf-type)
1347       (let ((beg (ediff-get-diff-posn buf-type 'beg n))
1348             (end (ediff-get-diff-posn buf-type 'end n)))
1349         (ediff-eval-in-buffer (ediff-get-buffer buf-type)
1350           (save-excursion
1351             (goto-char beg)
1352             (skip-chars-forward ediff-whitespace)
1353             (>= (point) end))))))
1354
1355 ;; temporarily uses DIR to abbreviate file name
1356 ;; if DIR is nil, use default-directory
1357 (defsubst ediff-abbreviate-file-name (file &optional dir)
1358   (cond ((stringp dir)
1359          (let ((directory-abbrev-alist (list (cons dir ""))))
1360            (abbreviate-file-name file)))
1361         (ediff-emacs-p (abbreviate-file-name file))
1362         (t ; XEmacs requires addl argument
1363          (abbreviate-file-name file t))))
1364
1365 ;; Takes a directory and returns the parent directory.
1366 ;; does nothing to `/'. If the ARG is a regular file,
1367 ;; strip the file AND the last dir.
1368 (defun ediff-strip-last-dir (dir)
1369   (if (not (stringp dir)) (setq dir default-directory))
1370   (setq dir (expand-file-name dir))
1371   (or (file-directory-p dir) (setq dir (file-name-directory dir)))
1372   (let* ((pos (1- (length dir)))
1373          (last-char (aref dir pos)))
1374     (if (and (> pos 0) (= last-char ?/))
1375         (setq dir (substring dir 0 pos)))
1376     (ediff-abbreviate-file-name (file-name-directory dir))))
1377
1378 (defun ediff-truncate-string-left (str newlen)
1379   ;; leave space for ... on the left
1380   (let ((len (length str))
1381         substr)
1382     (if (<= len newlen)
1383         str
1384       (setq newlen (max 0 (- newlen 3)))
1385       (setq substr (substring str (max 0 (- len 1 newlen))))
1386       (concat "..." substr))))
1387
1388 (defun ediff-abbrev-jobname (jobname)
1389   (cond ((eq jobname 'ediff-directories)
1390          "Compare two directories")
1391         ((eq jobname 'ediff-files)
1392          "Compare two files")
1393         ((eq jobname 'ediff-buffers)
1394          "Compare two buffers")
1395         ((eq jobname 'ediff-directories3)
1396          "Compare three directories")
1397         ((eq jobname 'ediff-files3)
1398          "Compare three files")
1399         ((eq jobname 'ediff-buffers3)
1400          "Compare three buffers")
1401         ((eq jobname 'ediff-revision)
1402          "Compare file with a version")
1403         ((eq jobname 'ediff-directory-revisions)
1404          "Compare dir files with versions")
1405         ((eq jobname 'ediff-merge-directory-revisions)
1406          "Merge dir files with versions")
1407         ((eq jobname 'ediff-merge-directory-revisions-with-ancestor)
1408          "Merge dir versions via ancestors")
1409         (t
1410          (let* ((str (substring (symbol-name jobname) 6))
1411                 (len (length str))
1412                 (pos 0))
1413            (while (< pos len)
1414              (if (= pos 0)
1415                  (aset str pos (upcase (aref str pos))))
1416              (if (= (aref str pos) ?-)
1417                  (aset str pos ?\ ))
1418              (setq pos (1+ pos)))
1419            str))))
1420
1421
1422
1423 (defsubst ediff-get-region-contents (n buf-type ctrl-buf &optional start end)
1424   (ediff-eval-in-buffer
1425       (ediff-eval-in-buffer ctrl-buf (ediff-get-buffer buf-type))
1426     (buffer-substring
1427      (or start (ediff-get-diff-posn buf-type 'beg n ctrl-buf))
1428      (or end (ediff-get-diff-posn buf-type 'end n ctrl-buf)))))
1429
1430 ;; If ediff modified mode line, strip the modification
1431 (defsubst ediff-strip-mode-line-format ()
1432   (if (member (car mode-line-format) '(" A: " " B: " " C: " " Ancestor: "))
1433       (setq mode-line-format (nth 2 mode-line-format))))
1434
1435 ;; Verify that we have a difference selected.
1436 (defsubst ediff-valid-difference-p (&optional n)
1437   (or n (setq n ediff-current-difference))
1438   (and (>= n 0) (< n ediff-number-of-differences)))
1439
1440 (defsubst ediff-show-all-diffs (n)
1441   "Don't skip difference regions."
1442   nil)
1443
1444 (defsubst Xor (a b)
1445   (or (and a (not b)) (and (not a) b)))
1446
1447 (defsubst ediff-message-if-verbose (string &rest args)
1448   (if ediff-verbose-p
1449       (apply 'message string args)))
1450
1451 (provide 'ediff-init)
1452
1453
1454 ;;; ediff-init.el  ends here