1 ;;; ediff-init.el --- Macros, variables, and defsubsts used by Ediff
3 ;; Copyright (C) 1994, 1995, 1996, 1997, 2000 Free Software Foundation, Inc.
5 ;; Author: Michael Kifer <kifer@cs.sunysb.edu>
7 ;; This file is part of GNU Emacs.
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)
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.
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.
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)
39 (load "ange-ftp" 'noerror)))
43 (defconst ediff-xemacs-p (string-match "XEmacs" emacs-version))
45 (defconst ediff-emacs-p (not ediff-xemacs-p))
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.")
52 ;; Are we running as a window application or on a TTY?
53 (defsubst ediff-device-type ()
56 (device-type (selected-device))))
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)))))
62 ;; test if supports faces
63 (defun ediff-has-face-support-p ()
64 (cond ((ediff-window-display-p))
66 ((ediff-color-display-p))
67 (ediff-emacs-p (memq (ediff-device-type) '(pc)))
68 (ediff-xemacs-p (memq (ediff-device-type) '(tty pc)))))
70 (defun ediff-has-toolbar-support-p ()
73 (console-on-window-system-p)))
75 (defun ediff-use-toolbar-p ()
76 (and (ediff-has-toolbar-support-p) ;Can it do it ?
77 (boundp 'ediff-use-toolbar-p)
78 ediff-use-toolbar-p)) ;Does the user want it ?
80 ;; Defines SYMBOL as an advertised local variable.
81 ;; Performs a defvar, then executes `make-variable-buffer-local' on
82 ;; the variable. Also sets the `permanent-local' property,
83 ;; so that `kill-all-local-variables' (called by major-mode setting
84 ;; commands) won't destroy Ediff control variables.
86 ;; Plagiarised from `emerge-defvar-local' for XEmacs.
87 (defmacro ediff-defvar-local (var value doc)
89 (defvar ,var ,value ,doc)
90 (make-variable-buffer-local ',var)
91 (put ',var 'permanent-local t)))
95 ;; Variables that control each Ediff session---local to the control buffer.
98 ;; The buffer in which the A variant is stored.
99 (ediff-defvar-local ediff-buffer-A nil "")
100 ;; The buffer in which the B variant is stored.
101 (ediff-defvar-local ediff-buffer-B nil "")
102 ;; The buffer in which the C variant is stored or where the merge buffer lives.
103 (ediff-defvar-local ediff-buffer-C nil "")
105 (ediff-defvar-local ediff-ancestor-buffer nil "")
106 ;; The Ediff control buffer
107 (ediff-defvar-local ediff-control-buffer nil "")
110 ;; Association between buff-type and ediff-buffer-*
111 (defconst ediff-buffer-alist
112 '((?A . ediff-buffer-A)
113 (?B . ediff-buffer-B)
114 (?C . ediff-buffer-C)))
117 (defmacro ediff-odd-p (arg)
118 `(eq (logand ,arg 1) 1))
120 (defmacro ediff-buffer-live-p (buf)
121 `(and ,buf (get-buffer ,buf) (buffer-name (get-buffer ,buf))))
123 (defmacro ediff-get-buffer (arg)
124 `(cond ((eq ,arg 'A) ediff-buffer-A)
125 ((eq ,arg 'B) ediff-buffer-B)
126 ((eq ,arg 'C) ediff-buffer-C)
127 ((eq ,arg 'Ancestor) ediff-ancestor-buffer)
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))
136 (defmacro ediff-char-to-buftype (arg)
137 `(cond ((memq ,arg '(?a ?A)) 'A)
138 ((memq ,arg '(?b ?B)) 'B)
139 ((memq ,arg '(?c ?C)) 'C)
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)))
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)))
156 (defmacro ediff-get-difference (n buf-type)
159 (ediff-get-symbol-from-alist
160 ,buf-type ediff-difference-vector-alist))
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.
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
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 state-of-difference]
180 ;; fine-diff-vector is a vector [fine-diff fine-diff fine-diff ...]
181 ;; no-fine-diffs-flag says if there are fine differences.
182 ;; state-of-difference is A, B, C, or nil, indicating which buffer is
183 ;; different from the other two (used only in 3-way jobs).
184 (defmacro ediff-no-fine-diffs-p (n)
185 `(aref (ediff-get-difference ,n 'A) 2))
187 (defmacro ediff-get-diff-overlay-from-diff-record (diff-rec)
190 (defmacro ediff-get-diff-overlay (n buf-type)
191 `(ediff-get-diff-overlay-from-diff-record
192 (ediff-get-difference ,n ,buf-type)))
194 (defmacro ediff-get-fine-diff-vector-from-diff-record (diff-rec)
197 (defmacro ediff-set-fine-diff-vector (n buf-type fine-vec)
198 `(aset (ediff-get-difference ,n ,buf-type) 1 ,fine-vec))
200 (defmacro ediff-get-state-of-diff (n buf-type)
201 `(if (ediff-buffer-live-p ediff-buffer-C)
202 (aref (ediff-get-difference ,n ,buf-type) 3)))
203 (defmacro ediff-set-state-of-diff (n buf-type val)
204 `(aset (ediff-get-difference ,n ,buf-type) 3 ,val))
206 (defmacro ediff-get-state-of-merge (n)
207 `(if ediff-state-of-merge
208 (aref (aref ediff-state-of-merge ,n) 0)))
209 (defmacro ediff-set-state-of-merge (n val)
210 `(if ediff-state-of-merge
211 (aset (aref ediff-state-of-merge ,n) 0 ,val)))
213 (defmacro ediff-get-state-of-ancestor (n)
214 `(if ediff-state-of-merge
215 (aref (aref ediff-state-of-merge ,n) 1)))
217 ;; if flag is t, puts a mark on diff region saying that
218 ;; the differences are in white space only. If flag is nil,
219 ;; the region is marked as essential (i.e., differences are
220 ;; not just in the white space and newlines.)
221 (defmacro ediff-mark-diff-as-space-only (n flag)
222 `(aset (ediff-get-difference ,n 'A) 2 ,flag))
224 (defmacro ediff-get-fine-diff-vector (n buf-type)
225 `(ediff-get-fine-diff-vector-from-diff-record
226 (ediff-get-difference ,n ,buf-type)))
228 ;; Macro to switch to BUFFER, evaluate BODY, returns to original buffer.
229 ;; Doesn't save the point and mark.
230 ;; This is `with-current-buffer' with the added test for live buffers."
231 (defmacro ediff-with-current-buffer (buffer &rest body)
232 `(if (ediff-buffer-live-p ,buffer)
236 (or (eq this-command 'ediff-quit)
237 (error ediff-KILLED-VITAL-BUFFER))
241 (defsubst ediff-multiframe-setup-p ()
242 (and (ediff-window-display-p) ediff-multiframe))
244 (defmacro ediff-narrow-control-frame-p ()
245 `(and (ediff-multiframe-setup-p)
246 (equal ediff-help-message ediff-brief-message-string)))
248 (defmacro ediff-3way-comparison-job ()
251 '(ediff-files3 ediff-buffers3)))
252 (ediff-defvar-local ediff-3way-comparison-job nil "")
254 (defmacro ediff-merge-job ()
259 ediff-merge-files-with-ancestor
260 ediff-merge-buffers-with-ancestor
261 ediff-merge-revisions
262 ediff-merge-revisions-with-ancestor)))
263 (ediff-defvar-local ediff-merge-job nil "")
265 (defmacro ediff-merge-with-ancestor-job ()
268 '(ediff-merge-files-with-ancestor
269 ediff-merge-buffers-with-ancestor
270 ediff-merge-revisions-with-ancestor)))
271 (ediff-defvar-local ediff-merge-with-ancestor-job nil "")
273 (defmacro ediff-3way-job ()
274 `(or ediff-3way-comparison-job ediff-merge-job))
275 (ediff-defvar-local ediff-3way-job nil "")
277 ;; A diff3 job is like a 3way job, but ediff-merge doesn't require the use
279 (defmacro ediff-diff3-job ()
280 `(or ediff-3way-comparison-job
281 ediff-merge-with-ancestor-job))
282 (ediff-defvar-local ediff-diff3-job nil "")
284 (defmacro ediff-windows-job ()
285 `(memq ediff-job-name '(ediff-windows-wordwise ediff-windows-linewise)))
286 (ediff-defvar-local ediff-windows-job nil "")
288 (defmacro ediff-word-mode-job ()
289 `(memq ediff-job-name '(ediff-windows-wordwise ediff-regions-wordwise)))
290 (ediff-defvar-local ediff-word-mode-job nil "")
292 (defmacro ediff-narrow-job ()
293 `(memq ediff-job-name '(ediff-windows-wordwise
294 ediff-regions-wordwise
295 ediff-windows-linewise
296 ediff-regions-linewise)))
297 (ediff-defvar-local ediff-narrow-job nil "")
299 ;; Note: ediff-merge-directory-revisions-with-ancestor is not treated as an
300 ;; ancestor metajob, since it behaves differently.
301 (defsubst ediff-ancestor-metajob (&optional metajob)
302 (memq (or metajob ediff-metajob-name)
303 '(ediff-merge-directories-with-ancestor
304 ediff-merge-filegroups-with-ancestor)))
305 (defsubst ediff-revision-metajob (&optional metajob)
306 (memq (or metajob ediff-metajob-name)
307 '(ediff-directory-revisions
308 ediff-merge-directory-revisions
309 ediff-merge-directory-revisions-with-ancestor)))
310 (defsubst ediff-patch-metajob (&optional metajob)
311 (memq (or metajob ediff-metajob-name)
312 '(ediff-multifile-patch)))
313 ;; metajob involving only one group of files, such as multipatch or directory
315 (defsubst ediff-one-filegroup-metajob (&optional metajob)
316 (or (ediff-revision-metajob metajob)
317 (ediff-patch-metajob metajob)
320 (defsubst ediff-collect-diffs-metajob (&optional metajob)
321 (memq (or metajob ediff-metajob-name)
323 ediff-directory-revisions
324 ediff-merge-directories
325 ediff-merge-directories-with-ancestor
326 ediff-merge-directory-revisions
327 ediff-merge-directory-revisions-with-ancestor
330 (defsubst ediff-merge-metajob (&optional metajob)
331 (memq (or metajob ediff-metajob-name)
332 '(ediff-merge-directories
333 ediff-merge-directories-with-ancestor
334 ediff-merge-directory-revisions
335 ediff-merge-directory-revisions-with-ancestor
336 ediff-merge-filegroups-with-ancestor
340 (defsubst ediff-metajob3 (&optional metajob)
341 (memq (or metajob ediff-metajob-name)
342 '(ediff-merge-directories-with-ancestor
343 ediff-merge-filegroups-with-ancestor
346 (defsubst ediff-comparison-metajob3 (&optional metajob)
347 (memq (or metajob ediff-metajob-name)
348 '(ediff-directories3 ediff-filegroups3)))
350 ;; with no argument, checks if we are in ediff-control-buffer
351 ;; with argument, checks if we are in ediff-meta-buffer
352 (defun ediff-in-control-buffer-p (&optional meta-buf-p)
353 (and (boundp 'ediff-control-buffer)
354 (eq (if meta-buf-p ediff-meta-buffer ediff-control-buffer)
357 (defsubst ediff-barf-if-not-control-buffer (&optional meta-buf-p)
358 (or (ediff-in-control-buffer-p meta-buf-p)
359 (error "%S: This command runs in Ediff Control Buffer only!"
362 (defgroup ediff-highlighting nil
363 "Hilighting of difference regions in Ediff"
367 (defgroup ediff-merge nil
372 (defgroup ediff-hook nil
373 "Hooks called by Ediff"
379 (defcustom ediff-before-setup-hook nil
380 "*Hooks to run before Ediff begins to set up windows and buffers.
381 This hook can be used to save the previous window config, which can be restored
382 on ediff-quit or ediff-suspend."
385 (defcustom ediff-before-setup-windows-hook nil
386 "*Hooks to run before Ediff sets its window configuration.
387 This hook is called every time when Ediff arranges its windows.
388 This happens each time Ediff detects that the windows were messed up by the
392 (defcustom ediff-after-setup-windows-hook nil
393 "*Hooks to run after Ediff sets its window configuration.
394 This can be used to set up control window or icon in a desired place."
397 (defcustom ediff-before-setup-control-frame-hook nil
398 "*Hooks run before setting up the frame to display Ediff Control Panel.
399 Can be used to change control frame parameters to position it where it
403 (defcustom ediff-after-setup-control-frame-hook nil
404 "*Hooks run after setting up the frame to display Ediff Control Panel.
405 Can be used to move the frame where it is desired."
408 (defcustom ediff-startup-hook nil
409 "*Hooks to run in the control buffer after Ediff has been set up and is ready for the job."
412 (defcustom ediff-select-hook nil
413 "*Hooks to run after a difference has been selected."
416 (defcustom ediff-unselect-hook nil
417 "*Hooks to run after a difference has been unselected."
420 (defcustom ediff-prepare-buffer-hook nil
421 "*Hooks called after buffers A, B, and C are set up."
424 (defcustom ediff-load-hook nil
425 "*Hook run after Ediff is loaded. Can be used to change defaults."
429 (defcustom ediff-mode-hook nil
430 "*Hook run just after ediff-mode is set up in the control buffer.
431 This is done before any windows or frames are created. One can use it to
432 set local variables that determine how the display looks like."
435 (defcustom ediff-keymap-setup-hook nil
436 "*Hook run just after the default bindings in Ediff keymap are set up."
440 (defcustom ediff-display-help-hook nil
441 "*Hooks run after preparing the help message."
445 (defcustom ediff-suspend-hook (list 'ediff-default-suspend-function)
446 "*Hooks to run in the Ediff control buffer when Ediff is suspended."
449 (defcustom ediff-quit-hook (list 'ediff-cleanup-mess)
450 "*Hooks to run in the Ediff control buffer after finishing Ediff."
453 (defcustom ediff-cleanup-hook nil
454 "*Hooks to run on exiting Ediff but before killing the control and variant buffers."
459 (defconst ediff-KILLED-VITAL-BUFFER
460 "You have killed a vital Ediff buffer---you must leave Ediff now!")
461 (defconst ediff-NO-DIFFERENCES
462 "Sorry, comparison of identical variants is not what I am made for...")
463 (defconst ediff-BAD-DIFF-NUMBER
464 ;; %S stands for this-command, %d - diff number, %d - max diff
465 "%S: Bad diff region number, %d. Valid numbers are 1 to %d")
466 (defconst ediff-BAD-INFO (format "
467 *** The Info file for Ediff, a part of the standard distribution
468 *** of %sEmacs, does not seem to be properly installed.
470 *** Please contact your system administrator. "
471 (if ediff-xemacs-p "X" "")))
473 ;; Selective browsing
475 (ediff-defvar-local ediff-skip-diff-region-function 'ediff-show-all-diffs
476 "Function that determines the next/previous diff region to show.
477 Should return t for regions to be ignored and nil otherwise.
478 This function gets a region number as an argument. The region number
479 is the one used internally by Ediff. It is 1 less than the number seen
482 (ediff-defvar-local ediff-hide-regexp-matches-function
483 'ediff-hide-regexp-matches
484 "Function to use in determining which regions to hide.
485 See the documentation string of `ediff-hide-regexp-matches' for details.")
486 (ediff-defvar-local ediff-focus-on-regexp-matches-function
487 'ediff-focus-on-regexp-matches
488 "Function to use in determining which regions to focus on.
489 See the documentation string of `ediff-focus-on-regexp-matches' for details.")
491 ;; Regexp that determines buf A regions to focus on when skipping to diff
492 (ediff-defvar-local ediff-regexp-focus-A "" "")
493 ;; Regexp that determines buf B regions to focus on when skipping to diff
494 (ediff-defvar-local ediff-regexp-focus-B "" "")
495 ;; Regexp that determines buf C regions to focus on when skipping to diff
496 (ediff-defvar-local ediff-regexp-focus-C "" "")
497 ;; connective that determines whether to focus regions that match both or
498 ;; one of the regexps
499 (ediff-defvar-local ediff-focus-regexp-connective 'and "")
501 ;; Regexp that determines buf A regions to ignore when skipping to diff
502 (ediff-defvar-local ediff-regexp-hide-A "" "")
503 ;; Regexp that determines buf B regions to ignore when skipping to diff
504 (ediff-defvar-local ediff-regexp-hide-B "" "")
505 ;; Regexp that determines buf C regions to ignore when skipping to diff
506 (ediff-defvar-local ediff-regexp-hide-C "" "")
507 ;; connective that determines whether to hide regions that match both or
508 ;; one of the regexps
509 (ediff-defvar-local ediff-hide-regexp-connective 'and "")
512 ;;; Copying difference regions between buffers.
514 ;; A list of killed diffs.
515 ;; A diff is saved here if it is replaced by a diff
516 ;; from another buffer. This alist has the form:
517 ;; \((num (buff-object . diff) (buff-object . diff) (buff-object . diff)) ...),
518 ;; where some buffer-objects may be missing.
519 (ediff-defvar-local ediff-killed-diffs-alist nil "")
523 (defcustom ediff-before-flag-bol (if ediff-xemacs-p (make-glyph "->>") "->>")
524 "*Flag placed before a highlighted block of differences, if block starts at beginning of a line."
526 :tag "Region before-flag at beginning of line"
529 (defcustom ediff-after-flag-eol (if ediff-xemacs-p (make-glyph "<<-") "<<-")
530 "*Flag placed after a highlighted block of differences, if block ends at end of a line."
532 :tag "Region after-flag at end of line"
535 (defcustom ediff-before-flag-mol (if ediff-xemacs-p (make-glyph "->>") "->>")
536 "*Flag placed before a highlighted block of differences, if block starts in mid-line."
538 :tag "Region before-flag in the middle of line"
540 (defcustom ediff-after-flag-mol (if ediff-xemacs-p (make-glyph "<<-") "<<-")
541 "*Flag placed after a highlighted block of differences, if block ends in mid-line."
543 :tag "Region after-flag in the middle of line"
547 (ediff-defvar-local ediff-use-faces t "")
548 (defcustom ediff-use-faces t
549 "If t, differences are highlighted using faces, if device supports faces.
550 If nil, differences are highlighted using ASCII flags, ediff-before-flag
551 and ediff-after-flag. On a non-window system, differences are always
552 highlighted using ASCII flags."
554 :group 'ediff-highlighting)
556 ;; this indicates that diff regions are word-size, so fine diffs are
557 ;; permanently nixed; used in ediff-windows-wordwise and ediff-regions-wordwise
558 (ediff-defvar-local ediff-word-mode nil "")
559 ;; Name of the job (ediff-files, ediff-windows, etc.)
560 (ediff-defvar-local ediff-job-name nil "")
562 ;; Narrowing and ediff-region/windows support
563 ;; This is a list (overlay-A overlay-B overlay-C)
564 ;; If set, Ediff compares only those parts of buffers A/B/C that lie within
565 ;; the bounds of these overlays.
566 (ediff-defvar-local ediff-narrow-bounds nil "")
568 ;; List (overlay-A overlay-B overlay-C), where each overlay spans the
569 ;; entire corresponding buffer.
570 (ediff-defvar-local ediff-wide-bounds nil "")
572 ;; Current visibility boundaries in buffers A, B, and C.
573 ;; This is also a list of overlays. When the user toggles narrow/widen,
574 ;; this list changes from ediff-wide-bounds to ediff-narrow-bounds.
576 (ediff-defvar-local ediff-visible-bounds nil "")
578 (ediff-defvar-local ediff-start-narrowed t
579 "Non-nil means start narrowed, if doing ediff-windows-* or ediff-regions-*")
580 (ediff-defvar-local ediff-quit-widened t
581 "*Non-nil means: when finished, Ediff widens buffers A/B.
582 Actually, Ediff restores the scope of visibility that existed at startup.")
584 (defcustom ediff-keep-variants t
585 "*Nil means that non-modified variant buffers should be removed at the end of the session after some interrogation.
586 Supplying a prefix argument to the quit command `q' temporarily reverses the
587 meaning of this variable."
591 (ediff-defvar-local ediff-highlight-all-diffs t "")
592 (defcustom ediff-highlight-all-diffs t
593 "If nil, only the selected differences are highlighted.
594 Otherwise, all difference regions are highlighted, but the selected region is
595 shown in brighter colors."
597 :group 'ediff-highlighting)
599 ;; A var local to each control panel buffer. Indicates highlighting style
600 ;; in effect for this buffer: `face', `ascii', nil -- temporarily
601 ;; unhighlighted, `off' -- turned off \(on a dumb terminal only\).
602 (ediff-defvar-local ediff-highlighting-style nil "")
605 ;; The suffix of the control buffer name.
606 (ediff-defvar-local ediff-control-buffer-suffix nil "")
607 ;; Same as ediff-control-buffer-suffix, but without <,>.
608 ;; It's a number rather than string.
609 (ediff-defvar-local ediff-control-buffer-number nil "")
612 ;; The original values of ediff-protected-variables for buffer A
613 (ediff-defvar-local ediff-buffer-values-orig-A nil "")
614 ;; The original values of ediff-protected-variables for buffer B
615 (ediff-defvar-local ediff-buffer-values-orig-B nil "")
616 ;; The original values of ediff-protected-variables for buffer C
617 (ediff-defvar-local ediff-buffer-values-orig-C nil "")
618 ;; The original values of ediff-protected-variables for buffer Ancestor
619 (ediff-defvar-local ediff-buffer-values-orig-Ancestor nil "")
621 ;; association between buff-type and ediff-buffer-values-orig-*
622 (defconst ediff-buffer-values-orig-alist
623 '((A . ediff-buffer-values-orig-A)
624 (B . ediff-buffer-values-orig-B)
625 (C . ediff-buffer-values-orig-C)
626 (Ancestor . ediff-buffer-values-orig-Ancestor)))
628 ;; Buffer-local variables to be saved then restored during Ediff sessions
629 (defconst ediff-protected-variables '(
633 ;; Vector of differences between the variants. Each difference is
634 ;; represented by a vector of two overlays plus a vector of fine diffs,
635 ;; plus a no-fine-diffs flag. The first overlay spans the
636 ;; difference region in the A buffer and the second overlays the diff in
637 ;; the B buffer. If a difference section is empty, the corresponding
638 ;; overlay's endpoints coincide.
640 ;; The precise form of a Difference Vector for one buffer is:
641 ;; [diff diff diff ...]
642 ;; where each diff has the form:
643 ;; [diff-overlay fine-diff-vector no-fine-diffs-flag state-of-diff]
644 ;; fine-diff-vector is a vector [fine-diff-overlay fine-diff-overlay ...]
645 ;; no-fine-diffs-flag says if there are fine differences.
646 ;; state-of-difference is A, B, C, or nil, indicating which buffer is
647 ;; different from the other two (used only in 3-way jobs.
648 (ediff-defvar-local ediff-difference-vector-A nil "")
649 (ediff-defvar-local ediff-difference-vector-B nil "")
650 (ediff-defvar-local ediff-difference-vector-C nil "")
651 (ediff-defvar-local ediff-difference-vector-Ancestor nil "")
652 ;; A-list of diff vector types associated with buffer types
653 (defconst ediff-difference-vector-alist
654 '((A . ediff-difference-vector-A)
655 (B . ediff-difference-vector-B)
656 (C . ediff-difference-vector-C)
657 (Ancestor . ediff-difference-vector-Ancestor)))
659 ;; [ status status status ...]
660 ;; Each status: [state-of-merge state-of-ancestor]
661 ;; state-of-merge is default-A, default-B, prefer-A, or prefer-B. It
662 ;; indicates the way a diff region was created in buffer C.
663 ;; state-of-ancestor says if the corresponding region in ancestor buffer is
665 (ediff-defvar-local ediff-state-of-merge nil "")
667 ;; The difference that is currently selected.
668 (ediff-defvar-local ediff-current-difference -1 "")
669 ;; Number of differences found.
670 (ediff-defvar-local ediff-number-of-differences nil "")
672 ;; Buffer containing the output of diff, which is used by Ediff to step
674 (ediff-defvar-local ediff-diff-buffer nil "")
675 ;; Like ediff-diff-buffer, but contains context diff. It is not used by
676 ;; Ediff, but it is saved in a file, if user requests so.
677 (ediff-defvar-local ediff-custom-diff-buffer nil "")
678 ;; Buffer used for diff-style fine differences between regions.
679 (ediff-defvar-local ediff-fine-diff-buffer nil "")
680 ;; Temporary buffer used for computing fine differences.
681 (defconst ediff-tmp-buffer " *ediff-tmp*" "")
682 ;; Buffer used for messages
683 (defconst ediff-msg-buffer " *ediff-message*" "")
684 ;; Buffer containing the output of diff when diff returns errors.
685 (ediff-defvar-local ediff-error-buffer nil "")
686 ;; Buffer to display debug info
687 (ediff-defvar-local ediff-debug-buffer "*ediff-debug*" "")
689 ;; List of ediff control panels associated with each buffer A/B/C/Ancestor.
690 ;; Not used any more, but may be needed in the future.
691 (ediff-defvar-local ediff-this-buffer-ediff-sessions nil "")
693 ;; to be deleted in due time
694 ;; List of difference overlays disturbed by working with the current diff.
695 (defvar ediff-disturbed-overlays nil "")
697 ;; Priority of non-selected overlays.
698 (defvar ediff-shadow-overlay-priority 100 "")
700 (defcustom ediff-version-control-package 'vc
701 "Version control package used.
702 Currently, Ediff supports vc.el, rcs.el, pcl-cvs.el, and generic-sc.el. The
703 standard Emacs interface to RCS, CVS, SCCS, etc., is vc.el. However, some
704 people find the other two packages more convenient. Set this variable to the
705 appropriate symbol: `rcs', `pcl-cvs', or `generic-sc' if you so desire."
712 (fset 'ediff-read-event (symbol-function 'next-command-event))
713 (fset 'ediff-overlayp (symbol-function 'extentp))
714 (fset 'ediff-make-overlay (symbol-function 'make-extent))
715 (fset 'ediff-delete-overlay (symbol-function 'delete-extent)))
716 (fset 'ediff-read-event (symbol-function 'read-event))
717 (fset 'ediff-overlayp (symbol-function 'overlayp))
718 (fset 'ediff-make-overlay (symbol-function 'make-overlay))
719 (fset 'ediff-delete-overlay (symbol-function 'delete-overlay)))
721 ;; Check the current version against the major and minor version numbers
722 ;; using op: cur-vers op major.minor If emacs-major-version or
723 ;; emacs-minor-version are not defined, we assume that the current version
724 ;; is hopelessly outdated. We assume that emacs-major-version and
725 ;; emacs-minor-version are defined. Otherwise, for Emacs/XEmacs 19, if the
726 ;; current minor version is < 10 (xemacs) or < 23 (emacs) the return value
727 ;; will be nil (when op is =, >, or >=) and t (when op is <, <=), which may be
728 ;; incorrect. However, this gives correct result in our cases, since we are
729 ;; testing for sufficiently high Emacs versions.
730 (defun ediff-check-version (op major minor &optional type-of-emacs)
731 (if (and (boundp 'emacs-major-version) (boundp 'emacs-minor-version))
732 (and (cond ((eq type-of-emacs 'xemacs) ediff-xemacs-p)
733 ((eq type-of-emacs 'emacs) ediff-emacs-p)
735 (cond ((eq op '=) (and (= emacs-minor-version minor)
736 (= emacs-major-version major)))
737 ((memq op '(> >= < <=))
738 (and (or (funcall op emacs-major-version major)
739 (= emacs-major-version major))
740 (if (= emacs-major-version major)
741 (funcall op emacs-minor-version minor)
744 (error "%S: Invalid op in ediff-check-version" op))))
745 (cond ((memq op '(= > >=)) nil)
746 ((memq op '(< <=)) t))))
749 (defun ediff-color-display-p ()
752 (if (fboundp 'display-color-p)
755 (eq (device-class (selected-device)) 'color))
760 (if (ediff-has-face-support-p)
763 (fset 'ediff-valid-color-p (symbol-function 'valid-color-name-p))
764 (fset 'ediff-get-face (symbol-function 'get-face)))
765 (fset 'ediff-valid-color-p (symbol-function
766 (if (fboundp 'color-defined-p)
768 'x-color-defined-p)))
769 (fset 'ediff-get-face (symbol-function 'internal-get-face))))
771 (if (ediff-window-display-p)
774 (fset 'ediff-display-pixel-width
775 (symbol-function 'device-pixel-width))
776 (fset 'ediff-display-pixel-height
777 (symbol-function 'device-pixel-height)))
778 (fset 'ediff-display-pixel-width (symbol-function
779 (if (fboundp 'display-pixel-width)
781 'x-display-pixel-width)))
782 (fset 'ediff-display-pixel-height (symbol-function
783 (if (fboundp 'display-pixel-height)
784 'display-pixel-height
785 'x-display-pixel-height)))))
787 ;; A-list of current-diff-overlay symbols associated with buf types
788 (defconst ediff-current-diff-overlay-alist
789 '((A . ediff-current-diff-overlay-A)
790 (B . ediff-current-diff-overlay-B)
791 (C . ediff-current-diff-overlay-C)
792 (Ancestor . ediff-current-diff-overlay-Ancestor)))
794 ;; A-list of current-diff-face-* symbols associated with buf types
795 (defconst ediff-current-diff-face-alist
796 '((A . ediff-current-diff-face-A)
797 (B . ediff-current-diff-face-B)
798 (C . ediff-current-diff-face-C)
799 (Ancestor . ediff-current-diff-face-Ancestor)))
802 (defun ediff-make-current-diff-overlay (type)
803 (if (ediff-has-face-support-p)
804 (let ((overlay (ediff-get-symbol-from-alist
805 type ediff-current-diff-overlay-alist))
806 (buffer (ediff-get-buffer type))
809 (ediff-get-symbol-from-alist
810 type ediff-current-diff-face-alist)))))
812 (ediff-make-bullet-proof-overlay (point-max) (point-max) buffer))
813 (ediff-set-overlay-face (symbol-value overlay) face)
814 (ediff-overlay-put (symbol-value overlay) 'ediff ediff-control-buffer))
817 (defun ediff-set-overlay-face (extent face)
818 (ediff-overlay-put extent 'face face)
819 (ediff-overlay-put extent 'help-echo 'ediff-region-help-echo))
821 (defun ediff-region-help-echo (extent-or-window &optional overlay point)
823 (setq overlay extent-or-window))
824 (let ((is-current (ediff-overlay-get overlay 'ediff))
825 (face (ediff-overlay-get overlay 'face))
826 (diff-num (ediff-overlay-get overlay 'ediff-diff-num))
829 ;; This happens only for refinement overlays
831 (setq face (intern face)))
832 (setq face-help (and face (get face 'ediff-help-echo)))
834 (cond ((and is-current diff-num) ; current diff region
835 (format "Difference region %S -- current" (1+ diff-num)))
836 (face-help) ; refinement of current diff region
837 (diff-num ; non-current
838 (format "Difference region %S -- non-current" (1+ diff-num)))
843 (defun ediff-set-face-pixmap (face pixmap)
844 "Set face pixmap on a monochrome display."
845 (if (and (ediff-window-display-p) (not (ediff-color-display-p)))
847 (set-face-background-pixmap face pixmap)
849 (message "Pixmap not found for %S: %s" (face-name face) pixmap)
852 (defun ediff-hide-face (face)
853 (if (and (ediff-has-face-support-p) ediff-emacs-p)
854 (add-to-list 'facemenu-unlisted-faces face)))
858 (defface ediff-current-diff-face-A
859 '((((class color)) (:foreground "firebrick" :background "pale green"))
860 (t (:inverse-video t)))
861 "Face for highlighting the selected difference in buffer A."
862 :group 'ediff-highlighting)
863 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
864 ;; this variable is set to nil, then again to the appropriate face.
865 (defvar ediff-current-diff-face-A 'ediff-current-diff-face-A
866 "Face for highlighting the selected difference in buffer A.
867 DO NOT CHANGE this variable. Instead, use the customization
868 widget to customize the actual face object `ediff-current-diff-face-A'
869 this variable represents.")
870 (ediff-hide-face 'ediff-current-diff-face-A)
871 ;; Until custom.el for XEmacs starts supporting :inverse-video we do this.
872 ;; This means that some user customization may be trashed.
873 (if (and ediff-xemacs-p
874 (ediff-has-face-support-p)
875 (not (ediff-color-display-p)))
876 (copy-face 'modeline 'ediff-current-diff-face-A))
880 (defface ediff-current-diff-face-B
881 '((((class color)) (:foreground "DarkOrchid" :background "Yellow"))
882 (t (:inverse-video t)))
883 "Face for highlighting the selected difference in buffer B."
884 :group 'ediff-highlighting)
885 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
886 ;; this variable is set to nil, then again to the appropriate face.
887 (defvar ediff-current-diff-face-B 'ediff-current-diff-face-B
888 "Face for highlighting the selected difference in buffer B.
889 this variable. Instead, use the customization
890 widget to customize the actual face `ediff-current-diff-face-B'
891 this variable represents.")
892 (ediff-hide-face 'ediff-current-diff-face-B)
893 ;; Until custom.el for XEmacs starts supporting :inverse-video we do this.
894 ;; This means that some user customization may be trashed.
895 (if (and ediff-xemacs-p
896 (ediff-has-face-support-p)
897 (not (ediff-color-display-p)))
898 (copy-face 'modeline 'ediff-current-diff-face-B))
901 (defface ediff-current-diff-face-C
902 '((((class color)) (:foreground "Navy" :background "Pink"))
903 (t (:inverse-video t)))
904 "Face for highlighting the selected difference in buffer C."
905 :group 'ediff-highlighting)
906 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
907 ;; this variable is set to nil, then again to the appropriate face.
908 (defvar ediff-current-diff-face-C 'ediff-current-diff-face-C
909 "Face for highlighting the selected difference in buffer C.
910 DO NOT CHANGE this variable. Instead, use the customization
911 widget to customize the actual face object `ediff-current-diff-face-C'
912 this variable represents.")
913 (ediff-hide-face 'ediff-current-diff-face-C)
914 ;; Until custom.el for XEmacs starts supporting :inverse-video we do this.
915 ;; This means that some user customization may be trashed.
916 (if (and ediff-xemacs-p
917 (ediff-has-face-support-p)
918 (not (ediff-color-display-p)))
919 (copy-face 'modeline 'ediff-current-diff-face-C))
922 (defface ediff-current-diff-face-Ancestor
923 '((((class color)) (:foreground "Black" :background "VioletRed"))
924 (t (:inverse-video t)))
925 "Face for highlighting the selected difference in buffer Ancestor."
926 :group 'ediff-highlighting)
927 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
928 ;; this variable is set to nil, then again to the appropriate face.
929 (defvar ediff-current-diff-face-Ancestor 'ediff-current-diff-face-Ancestor
930 "Face for highlighting the selected difference in buffer Ancestor.
931 DO NOT CHANGE this variable. Instead, use the customization
932 widget to customize the actual face object `ediff-current-diff-face-Ancestor'
933 this variable represents.")
934 (ediff-hide-face 'ediff-current-diff-face-Ancestor)
935 ;; Until custom.el for XEmacs starts supporting :inverse-video we do this.
936 ;; This means that some user customization may be trashed.
937 (if (and ediff-xemacs-p
938 (ediff-has-face-support-p)
939 (not (ediff-color-display-p)))
940 (copy-face 'modeline 'ediff-current-diff-face-Ancestor))
943 (defface ediff-fine-diff-face-A
944 '((((class color)) (:foreground "Navy" :background "sky blue"))
945 (t (:underline t :stipple "gray3")))
946 "Face for highlighting the refinement of the selected diff in buffer A."
947 :group 'ediff-highlighting)
948 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
949 ;; this variable is set to nil, then again to the appropriate face.
950 (defvar ediff-fine-diff-face-A 'ediff-fine-diff-face-A
951 "Face for highlighting the fine differences in buffer A.
952 DO NOT CHANGE this variable. Instead, use the customization
953 widget to customize the actual face object `ediff-fine-diff-face-A'
954 this variable represents.")
955 (ediff-hide-face 'ediff-fine-diff-face-A)
957 (defface ediff-fine-diff-face-B
958 '((((class color)) (:foreground "Black" :background "cyan"))
959 (t (:underline t :stipple "gray3")))
960 "Face for highlighting the refinement of the selected diff in buffer B."
961 :group 'ediff-highlighting)
962 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
963 ;; this variable is set to nil, then again to the appropriate face.
964 (defvar ediff-fine-diff-face-B 'ediff-fine-diff-face-B
965 "Face for highlighting the fine differences in buffer B.
966 DO NOT CHANGE this variable. Instead, use the customization
967 widget to customize the actual face object `ediff-fine-diff-face-B'
968 this variable represents.")
969 (ediff-hide-face 'ediff-fine-diff-face-B)
971 (defface ediff-fine-diff-face-C
972 '((((class color)) (:foreground "Black" :background "Turquoise"))
973 (t (:underline t :stipple "gray3")))
974 "Face for highlighting the refinement of the selected diff in buffer C."
975 :group 'ediff-highlighting)
976 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
977 ;; this variable is set to nil, then again to the appropriate face.
978 (defvar ediff-fine-diff-face-C 'ediff-fine-diff-face-C
979 "Face for highlighting the fine differences in buffer C.
980 DO NOT CHANGE this variable. Instead, use the customization
981 widget to customize the actual face object `ediff-fine-diff-face-C'
982 this variable represents.")
983 (ediff-hide-face 'ediff-fine-diff-face-C)
985 (defface ediff-fine-diff-face-Ancestor
986 '((((class color)) (:foreground "Black" :background "Green"))
987 (t (:underline t :stipple "gray3")))
988 "Face for highlighting the refinement of the selected diff in the ancestor buffer.
989 At present, this face is not used and no fine differences are computed for the
991 :group 'ediff-highlighting)
992 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
993 ;; this variable is set to nil, then again to the appropriate face.
994 (defvar ediff-fine-diff-face-Ancestor 'ediff-fine-diff-face-Ancestor
995 "Face for highlighting the fine differences in buffer Ancestor.
996 DO NOT CHANGE this variable. Instead, use the customization
997 widget to customize the actual face object `ediff-fine-diff-face-Ancestor'
998 this variable represents.")
999 (ediff-hide-face 'ediff-fine-diff-face-Ancestor)
1001 ;; Some installs don't have stipple or Stipple. So, try them in turn.
1002 (defvar stipple-pixmap
1003 (cond ((not (ediff-has-face-support-p)) nil)
1004 ((and (boundp 'x-bitmap-file-path)
1005 (locate-library "stipple" t x-bitmap-file-path)) "stipple")
1006 ((and (boundp 'mswindowsx-bitmap-file-path)
1007 (locate-library "stipple" t mswindowsx-bitmap-file-path)) "stipple")
1010 (defface ediff-even-diff-face-A
1011 `((((class color)) (:foreground "Black" :background "light grey"))
1012 (t (:italic t :stipple ,stipple-pixmap)))
1013 "Face for highlighting even-numbered non-current differences in buffer A."
1014 :group 'ediff-highlighting)
1015 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
1016 ;; this variable is set to nil, then again to the appropriate face.
1017 (defvar ediff-even-diff-face-A 'ediff-even-diff-face-A
1018 "Face for highlighting even-numbered non-current differences in buffer A.
1019 DO NOT CHANGE this variable. Instead, use the customization
1020 widget to customize the actual face object `ediff-even-diff-face-A'
1021 this variable represents.")
1022 (ediff-hide-face 'ediff-even-diff-face-A)
1024 (defface ediff-even-diff-face-B
1025 `((((class color)) (:foreground "White" :background "Grey"))
1026 (t (:italic t :stipple ,stipple-pixmap)))
1027 "Face for highlighting even-numbered non-current differences in buffer B."
1028 :group 'ediff-highlighting)
1029 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
1030 ;; this variable is set to nil, then again to the appropriate face.
1031 (defvar ediff-even-diff-face-B 'ediff-even-diff-face-B
1032 "Face for highlighting even-numbered non-current differences in buffer B.
1033 DO NOT CHANGE this variable. Instead, use the customization
1034 widget to customize the actual face object `ediff-even-diff-face-B'
1035 this variable represents.")
1036 (ediff-hide-face 'ediff-even-diff-face-B)
1038 (defface ediff-even-diff-face-C
1039 `((((class color)) (:foreground "Black" :background "light grey"))
1040 (t (:italic t :stipple ,stipple-pixmap)))
1041 "Face for highlighting even-numbered non-current differences in buffer C."
1042 :group 'ediff-highlighting)
1043 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
1044 ;; this variable is set to nil, then again to the appropriate face.
1045 (defvar ediff-even-diff-face-C 'ediff-even-diff-face-C
1046 "Face for highlighting even-numbered non-current differences in buffer C.
1047 DO NOT CHANGE this variable. Instead, use the customization
1048 widget to customize the actual face object `ediff-even-diff-face-C'
1049 this variable represents.")
1050 (ediff-hide-face 'ediff-even-diff-face-C)
1052 (defface ediff-even-diff-face-Ancestor
1053 `((((class color)) (:foreground "White" :background "Grey"))
1054 (t (:italic t :stipple ,stipple-pixmap)))
1055 "Face for highlighting even-numbered non-current differences in the ancestor buffer."
1056 :group 'ediff-highlighting)
1057 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
1058 ;; this variable is set to nil, then again to the appropriate face.
1059 (defvar ediff-even-diff-face-Ancestor 'ediff-even-diff-face-Ancestor
1060 "Face for highlighting even-numbered non-current differences in buffer Ancestor.
1061 DO NOT CHANGE this variable. Instead, use the customization
1062 widget to customize the actual face object `ediff-even-diff-face-Ancestor'
1063 this variable represents.")
1064 (ediff-hide-face 'ediff-even-diff-face-Ancestor)
1066 ;; Association between buffer types and even-diff-face symbols
1067 (defconst ediff-even-diff-face-alist
1068 '((A . ediff-even-diff-face-A)
1069 (B . ediff-even-diff-face-B)
1070 (C . ediff-even-diff-face-C)
1071 (Ancestor . ediff-even-diff-face-Ancestor)))
1073 (defface ediff-odd-diff-face-A
1074 '((((class color)) (:foreground "White" :background "Grey"))
1075 (t (:italic t :stipple "gray1")))
1076 "Face for highlighting odd-numbered non-current differences in buffer A."
1077 :group 'ediff-highlighting)
1078 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
1079 ;; this variable is set to nil, then again to the appropriate face.
1080 (defvar ediff-odd-diff-face-A 'ediff-odd-diff-face-A
1081 "Face for highlighting odd-numbered non-current differences in buffer A.
1082 DO NOT CHANGE this variable. Instead, use the customization
1083 widget to customize the actual face object `ediff-odd-diff-face-A'
1084 this variable represents.")
1085 (ediff-hide-face 'ediff-odd-diff-face-A)
1088 (defface ediff-odd-diff-face-B
1089 '((((class color)) (:foreground "Black" :background "light grey"))
1090 (t (:italic t :stipple "gray1")))
1091 "Face for highlighting odd-numbered non-current differences in buffer B."
1092 :group 'ediff-highlighting)
1093 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
1094 ;; this variable is set to nil, then again to the appropriate face.
1095 (defvar ediff-odd-diff-face-B 'ediff-odd-diff-face-B
1096 "Face for highlighting odd-numbered non-current differences in buffer B.
1097 DO NOT CHANGE this variable. Instead, use the customization
1098 widget to customize the actual face object `ediff-odd-diff-face-B'
1099 this variable represents.")
1100 (ediff-hide-face 'ediff-odd-diff-face-B)
1102 (defface ediff-odd-diff-face-C
1103 '((((class color)) (:foreground "White" :background "Grey"))
1104 (t (:italic t :stipple "gray1")))
1105 "Face for highlighting odd-numbered non-current differences in buffer C."
1106 :group 'ediff-highlighting)
1107 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
1108 ;; this variable is set to nil, then again to the appropriate face.
1109 (defvar ediff-odd-diff-face-C 'ediff-odd-diff-face-C
1110 "Face for highlighting odd-numbered non-current differences in buffer C.
1111 DO NOT CHANGE this variable. Instead, use the customization
1112 widget to customize the actual face object `ediff-odd-diff-face-C'
1113 this variable represents.")
1114 (ediff-hide-face 'ediff-odd-diff-face-C)
1116 (defface ediff-odd-diff-face-Ancestor
1117 '((((class color)) (:foreground "Black" :background "light grey"))
1118 (t (:italic t :stipple "gray1")))
1119 "Face for highlighting odd-numbered non-current differences in the ancestor buffer."
1120 :group 'ediff-highlighting)
1121 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
1122 ;; this variable is set to nil, then again to the appropriate face.
1123 (defvar ediff-odd-diff-face-Ancestor 'ediff-odd-diff-face-Ancestor
1124 "Face for highlighting odd-numbered non-current differences in buffer Ancestor.
1125 DO NOT CHANGE this variable. Instead, use the customization
1126 widget to customize the actual face object `ediff-odd-diff-face-Ancestor'
1127 this variable represents.")
1128 (ediff-hide-face 'ediff-odd-diff-face-Ancestor)
1130 ;; Association between buffer types and odd-diff-face symbols
1131 (defconst ediff-odd-diff-face-alist
1132 '((A . ediff-odd-diff-face-A)
1133 (B . ediff-odd-diff-face-B)
1134 (C . ediff-odd-diff-face-C)
1135 (Ancestor . ediff-odd-diff-face-Ancestor)))
1137 ;; A-list of fine-diff face symbols associated with buffer types
1138 (defconst ediff-fine-diff-face-alist
1139 '((A . ediff-fine-diff-face-A)
1140 (B . ediff-fine-diff-face-B)
1141 (C . ediff-fine-diff-face-C)
1142 (Ancestor . ediff-fine-diff-face-Ancestor)))
1145 (put 'ediff-fine-diff-face-A 'ediff-help-echo
1146 "A `refinement' of the current difference region")
1147 (put 'ediff-fine-diff-face-B 'ediff-help-echo
1148 "A `refinement' of the current difference region")
1149 (put 'ediff-fine-diff-face-C 'ediff-help-echo
1150 "A `refinement' of the current difference region")
1151 (put 'ediff-fine-diff-face-Ancestor 'ediff-help-echo
1152 "A `refinement' of the current difference region")
1157 (ediff-defvar-local ediff-current-diff-overlay-A nil
1158 "Overlay for the current difference region in buffer A.")
1159 (ediff-defvar-local ediff-current-diff-overlay-B nil
1160 "Overlay for the current difference region in buffer B.")
1161 (ediff-defvar-local ediff-current-diff-overlay-C nil
1162 "Overlay for the current difference region in buffer C.")
1163 (ediff-defvar-local ediff-current-diff-overlay-Ancestor nil
1164 "Overlay for the current difference region in the ancestor buffer.")
1166 ;; Compute priority of ediff overlay.
1167 (defun ediff-highest-priority (start end buffer)
1168 (let ((pos (max 1 (1- start)))
1171 (1+ ediff-shadow-overlay-priority)
1172 (ediff-with-current-buffer buffer
1173 (while (< pos (min (point-max) (1+ end)))
1174 (setq ovr-list (append (overlays-at pos) ovr-list))
1175 (setq pos (next-overlay-change pos)))
1177 (mapcar (lambda (ovr)
1179 (or (ediff-overlay-get ovr 'priority) 0)
1186 (defvar ediff-toggle-read-only-function nil
1187 "*Specifies the function to be used to toggle read-only.
1188 If nil, Ediff tries to deduce the function from the binding of C-x C-q.
1189 Normally, this is the `toggle-read-only' function, but, if version
1190 control is used, it could be `vc-toggle-read-only' or `rcs-toggle-read-only'.")
1192 (defcustom ediff-make-buffers-readonly-at-startup nil
1193 "*Make all variant buffers read-only when Ediff starts up.
1194 This property can be toggled interactively."
1201 ;; if nil, this silences some messages
1202 (defconst ediff-verbose-p t)
1204 (defcustom ediff-autostore-merges 'group-jobs-only
1205 "*Save the results of merge jobs automatically.
1206 Nil means don't save automatically. t means always save. Anything but nil or t
1207 means save automatically only if the merge job is part of a group of jobs, such
1208 as `ediff-merge-directory' or `ediff-merge-directory-revisions'."
1209 :type '(choice (const nil) (const t) (const group-jobs-only))
1210 :group 'ediff-merge)
1211 (make-variable-buffer-local 'ediff-autostore-merges)
1213 ;; file where the result of the merge is to be saved. used internally
1214 (ediff-defvar-local ediff-merge-store-file nil "")
1216 (defcustom ediff-merge-filename-prefix "merge_"
1217 "*Prefix to be attached to saved merge buffers."
1219 :group 'ediff-merge)
1221 (defcustom ediff-no-emacs-help-in-control-buffer nil
1222 "*Non-nil means C-h should not invoke Emacs help in control buffer.
1223 Instead, C-h would jump to previous difference."
1227 ;; This is the same as temporary-file-directory from Emacs 20.3.
1228 ;; Copied over here because XEmacs doesn't have this variable.
1229 (defcustom ediff-temp-file-prefix
1230 (file-name-as-directory
1231 (cond ((boundp 'temporary-file-directory) temporary-file-directory)
1232 ((fboundp 'temp-directory) (temp-directory))
1234 ;;; (file-name-as-directory
1235 ;;; (cond ((memq system-type '(ms-dos windows-nt))
1236 ;;; (or (getenv "TEMP") (getenv "TMPDIR") (getenv "TMP") "c:/temp"))
1237 ;;; ((memq system-type '(vax-vms axp-vms))
1238 ;;; (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "SYS$SCRATCH:"))
1240 ;;; (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "/tmp"))))
1241 "*Prefix to put on Ediff temporary file names.
1242 Do not start with `~/' or `~USERNAME/'."
1246 (defcustom ediff-temp-file-mode 384 ; u=rw only
1247 "*Mode for Ediff temporary files."
1251 ;; Metacharacters that have to be protected from the shell when executing
1252 ;; a diff/diff3 command.
1253 (defcustom ediff-metachars "[ \t\n!\"#$&'()*;<=>?[\\^`{|~]"
1254 "Regexp that matches characters that must be quoted with `\\' in shell command line.
1255 This default should work without changes."
1259 ;; needed to simulate frame-char-width in XEmacs.
1260 (defvar ediff-H-glyph (if ediff-xemacs-p (make-glyph "H")))
1263 ;; Temporary file used for refining difference regions in buffer A.
1264 (ediff-defvar-local ediff-temp-file-A nil "")
1265 ;; Temporary file used for refining difference regions in buffer B.
1266 (ediff-defvar-local ediff-temp-file-B nil "")
1267 ;; Temporary file used for refining difference regions in buffer C.
1268 (ediff-defvar-local ediff-temp-file-C nil "")
1271 ;;; In-line functions
1273 (or (fboundp 'ediff-file-remote-p) ; user supplied his own function: use it
1274 (defun ediff-file-remote-p (file-name)
1275 (car (cond ((featurep 'efs-auto) (efs-ftp-path file-name))
1276 ((fboundp 'file-remote-p) (file-remote-p file-name))
1277 (t (require 'ange-ftp)
1278 ;; Can happen only in Emacs, since XEmacs has file-remote-p
1279 (ange-ftp-ftp-name file-name))))))
1282 (defsubst ediff-frame-unsplittable-p (frame)
1283 (cdr (assq 'unsplittable (frame-parameters frame))))
1285 (defsubst ediff-get-next-window (wind prev-wind)
1286 (or (window-live-p wind)
1287 (setq wind (if prev-wind
1289 (selected-window)))))
1292 (defsubst ediff-kill-buffer-carefully (buf)
1293 "Kill buffer BUF if it exists."
1294 (if (ediff-buffer-live-p buf)
1295 (kill-buffer (get-buffer buf))))
1297 (defsubst ediff-background-face (buf-type dif-num)
1298 ;; The value of dif-num is always 1- the one that user sees.
1299 ;; This is why even face is used when dif-num is odd.
1300 (ediff-get-symbol-from-alist
1301 buf-type (if (ediff-odd-p dif-num)
1302 ediff-even-diff-face-alist
1303 ediff-odd-diff-face-alist)
1307 ;; activate faces on diff regions in buffer
1308 (defun ediff-paint-background-regions-in-one-buffer (buf-type unhighlight)
1310 (eval (ediff-get-symbol-from-alist
1311 buf-type ediff-difference-vector-alist)))
1313 (mapcar (lambda (rec)
1314 (setq overl (ediff-get-diff-overlay-from-diff-record rec)
1315 diff-num (ediff-overlay-get overl 'ediff-diff-num))
1316 (if (ediff-overlay-buffer overl)
1317 ;; only if overlay is alive
1318 (ediff-set-overlay-face
1320 (if (not unhighlight)
1321 (ediff-background-face buf-type diff-num))))
1326 ;; activate faces on diff regions in all buffers
1327 (defun ediff-paint-background-regions (&optional unhighlight)
1328 (ediff-paint-background-regions-in-one-buffer
1330 (ediff-paint-background-regions-in-one-buffer
1332 (ediff-paint-background-regions-in-one-buffer
1334 (ediff-paint-background-regions-in-one-buffer
1335 'Ancestor unhighlight))
1337 (defun ediff-highlight-diff-in-one-buffer (n buf-type)
1338 (if (ediff-buffer-live-p (ediff-get-buffer buf-type))
1339 (let* ((buff (ediff-get-buffer buf-type))
1340 (last (ediff-with-current-buffer buff (point-max)))
1341 (begin (ediff-get-diff-posn buf-type 'beg n))
1342 (end (ediff-get-diff-posn buf-type 'end n))
1343 (xtra (if (equal begin end) 1 0))
1344 (end-hilit (min last (+ end xtra)))
1345 (current-diff-overlay
1347 (ediff-get-symbol-from-alist
1348 buf-type ediff-current-diff-overlay-alist))))
1351 (ediff-move-overlay current-diff-overlay begin end-hilit)
1352 (ediff-move-overlay current-diff-overlay begin end-hilit buff))
1353 (ediff-overlay-put current-diff-overlay 'priority
1354 (ediff-highest-priority begin end-hilit buff))
1355 (ediff-overlay-put current-diff-overlay 'ediff-diff-num n)
1357 ;; unhighlight the background overlay for diff n so it won't
1358 ;; interfere with the current diff overlay
1359 (ediff-set-overlay-face (ediff-get-diff-overlay n buf-type) nil)
1363 (defun ediff-unhighlight-diff-in-one-buffer (buf-type)
1364 (if (ediff-buffer-live-p (ediff-get-buffer buf-type))
1365 (let ((current-diff-overlay
1367 (ediff-get-symbol-from-alist
1368 buf-type ediff-current-diff-overlay-alist)))
1370 (ediff-get-diff-overlay ediff-current-difference buf-type))
1373 (ediff-move-overlay current-diff-overlay 1 1)
1375 ;; rehighlight the overlay in the background of the
1376 ;; current difference region
1377 (ediff-set-overlay-face
1379 (if (and (ediff-has-face-support-p)
1380 ediff-use-faces ediff-highlight-all-diffs)
1381 (ediff-background-face buf-type ediff-current-difference)))
1384 (defun ediff-unhighlight-diffs-totally-in-one-buffer (buf-type)
1385 (ediff-unselect-and-select-difference -1)
1386 (if (and (ediff-has-face-support-p) ediff-use-faces)
1387 (let* ((inhibit-quit t)
1388 (current-diff-overlay-var
1389 (ediff-get-symbol-from-alist
1390 buf-type ediff-current-diff-overlay-alist))
1391 (current-diff-overlay (symbol-value current-diff-overlay-var)))
1392 (ediff-paint-background-regions 'unhighlight)
1393 (if (ediff-overlayp current-diff-overlay)
1394 (ediff-delete-overlay current-diff-overlay))
1395 (set current-diff-overlay-var nil)
1399 (defsubst ediff-highlight-diff (n)
1400 "Put face on diff N. Invoked for X displays only."
1401 (ediff-highlight-diff-in-one-buffer n 'A)
1402 (ediff-highlight-diff-in-one-buffer n 'B)
1403 (ediff-highlight-diff-in-one-buffer n 'C)
1404 (ediff-highlight-diff-in-one-buffer n 'Ancestor)
1408 (defsubst ediff-unhighlight-diff ()
1409 "Remove overlays from buffers A, B, and C."
1410 (ediff-unhighlight-diff-in-one-buffer 'A)
1411 (ediff-unhighlight-diff-in-one-buffer 'B)
1412 (ediff-unhighlight-diff-in-one-buffer 'C)
1413 (ediff-unhighlight-diff-in-one-buffer 'Ancestor)
1416 ;; delete highlighting overlays, restore faces to their original form
1417 (defsubst ediff-unhighlight-diffs-totally ()
1418 (ediff-unhighlight-diffs-totally-in-one-buffer 'A)
1419 (ediff-unhighlight-diffs-totally-in-one-buffer 'B)
1420 (ediff-unhighlight-diffs-totally-in-one-buffer 'C)
1421 (ediff-unhighlight-diffs-totally-in-one-buffer 'Ancestor)
1425 ;; arg is a record for a given diff in a difference vector
1426 ;; this record is itself a vector
1427 (defsubst ediff-clear-fine-diff-vector (diff-record)
1429 (mapcar 'ediff-delete-overlay
1430 (ediff-get-fine-diff-vector-from-diff-record diff-record))))
1432 (defsubst ediff-clear-fine-differences-in-one-buffer (n buf-type)
1433 (ediff-clear-fine-diff-vector (ediff-get-difference n buf-type))
1434 (ediff-set-fine-diff-vector n buf-type nil))
1436 (defsubst ediff-clear-fine-differences (n)
1437 (ediff-clear-fine-differences-in-one-buffer n 'A)
1438 (ediff-clear-fine-differences-in-one-buffer n 'B)
1440 (ediff-clear-fine-differences-in-one-buffer n 'C)))
1443 (defsubst ediff-convert-fine-diffs-to-overlays (diff-list region-num)
1444 (ediff-set-fine-overlays-in-one-buffer 'A diff-list region-num)
1445 (ediff-set-fine-overlays-in-one-buffer 'B diff-list region-num)
1447 (ediff-set-fine-overlays-in-one-buffer 'C diff-list region-num)
1450 (defsubst ediff-mouse-event-p (event)
1452 (button-event-p event)
1453 (string-match "mouse" (format "%S" (event-basic-type event)))
1457 (defsubst ediff-key-press-event-p (event)
1459 (key-press-event-p event)
1460 (or (char-or-string-p event) (symbolp event))))
1462 (defun ediff-event-point (event)
1463 (cond ((ediff-mouse-event-p event)
1466 (posn-point (event-start event))))
1467 ((ediff-key-press-event-p event)
1471 (defun ediff-event-buffer (event)
1472 (cond ((ediff-mouse-event-p event)
1474 (event-buffer event)
1475 (window-buffer (posn-window (event-start event)))))
1476 ((ediff-key-press-event-p event)
1481 (defsubst ediff-frame-iconified-p (frame)
1482 (if (and (ediff-window-display-p) (frame-live-p frame))
1484 (frame-iconified-p frame)
1485 (eq (frame-visible-p frame) 'icon))))
1487 (defsubst ediff-window-visible-p (wind)
1488 ;; under TTY, window-live-p also means window is visible
1489 (and (window-live-p wind)
1490 (or (not (ediff-window-display-p))
1491 (frame-visible-p (window-frame wind)))))
1494 (defsubst ediff-frame-char-width (frame)
1496 (/ (frame-pixel-width frame) (frame-width frame))
1497 (frame-char-width frame)))
1499 (defun ediff-reset-mouse (&optional frame do-not-grab-mouse)
1500 (or frame (setq frame (selected-frame)))
1501 (if (ediff-window-display-p)
1502 (let ((frame-or-wind frame))
1504 (setq frame-or-wind (frame-selected-window frame)))
1505 (or do-not-grab-mouse
1506 ;; don't set mouse if the user said to never do this
1507 (not ediff-grab-mouse)
1508 ;; Don't grab on quit, if the user doesn't want to.
1509 ;; If ediff-grab-mouse = t, then mouse won't be grabbed for
1510 ;; sessions that are not part of a group (this is done in
1511 ;; ediff-recenter). The condition below affects only terminating
1512 ;; sessions in session groups (in which case mouse is warped into
1514 (and (eq ediff-grab-mouse 'maybe)
1515 (memq this-command '(ediff-quit ediff-update-diffs)))
1516 (set-mouse-position frame-or-wind 1 0))
1519 (defsubst ediff-spy-after-mouse ()
1520 (setq ediff-mouse-pixel-position (mouse-pixel-position)))
1522 ;; It is not easy to find out when the user grabs the mouse, since emacs and
1523 ;; xemacs behave differently when mouse is not in any frame. Also, this is
1524 ;; sensitive to when the user grabbed mouse. Not used for now.
1525 (defun ediff-user-grabbed-mouse ()
1526 (if ediff-mouse-pixel-position
1527 (cond ((not (eq (car ediff-mouse-pixel-position)
1528 (car (mouse-pixel-position)))))
1529 ((and (car (cdr ediff-mouse-pixel-position))
1530 (car (cdr (mouse-pixel-position)))
1531 (cdr (cdr ediff-mouse-pixel-position))
1532 (cdr (cdr (mouse-pixel-position))))
1533 (not (and (< (abs (- (car (cdr ediff-mouse-pixel-position))
1534 (car (cdr (mouse-pixel-position)))))
1535 ediff-mouse-pixel-threshold)
1536 (< (abs (- (cdr (cdr ediff-mouse-pixel-position))
1537 (cdr (cdr (mouse-pixel-position)))))
1538 ediff-mouse-pixel-threshold))))
1541 (defsubst ediff-frame-char-height (frame)
1543 (glyph-height ediff-H-glyph (selected-window frame))
1544 (frame-char-height frame)))
1546 ;; Some overlay functions
1548 (defsubst ediff-overlay-start (overl)
1549 (if (ediff-overlayp overl)
1551 (overlay-start overl)
1552 (extent-start-position overl))))
1554 (defsubst ediff-overlay-end (overl)
1555 (if (ediff-overlayp overl)
1558 (extent-end-position overl))))
1560 (defsubst ediff-empty-overlay-p (overl)
1561 (= (ediff-overlay-start overl) (ediff-overlay-end overl)))
1563 ;; like overlay-buffer in Emacs. In XEmacs, returns nil if the extent is
1564 ;; dead. Otherwise, works like extent-buffer
1565 (defun ediff-overlay-buffer (overl)
1567 (overlay-buffer overl)
1568 (and (extent-live-p overl) (extent-object overl))))
1570 ;; like overlay-get in Emacs. In XEmacs, returns nil if the extent is
1571 ;; dead. Otherwise, like extent-property
1572 (defun ediff-overlay-get (overl property)
1574 (overlay-get overl property)
1575 (and (extent-live-p overl) (extent-property overl property))))
1578 ;; These two functions are here because XEmacs refuses to
1579 ;; handle overlays whose buffers were deleted.
1580 (defun ediff-move-overlay (overlay beg end &optional buffer)
1581 "Calls `move-overlay' in Emacs and `set-extent-endpoints' in Lemacs.
1582 Checks if overlay's buffer exists before actually doing the move."
1583 (let ((buf (and overlay (ediff-overlay-buffer overlay))))
1584 (if (ediff-buffer-live-p buf)
1586 (set-extent-endpoints overlay beg end)
1587 (move-overlay overlay beg end buffer))
1590 (ediff-delete-overlay overlay)))))
1592 (defun ediff-overlay-put (overlay prop value)
1593 "Calls `overlay-put' or `set-extent-property' depending on Emacs version.
1594 Checks if overlay's buffer exists."
1595 (if (ediff-buffer-live-p (ediff-overlay-buffer overlay))
1597 (set-extent-property overlay prop value)
1598 (overlay-put overlay prop value))
1599 (ediff-delete-overlay overlay)))
1601 ;; Some diff region tests
1603 ;; t if diff region is empty.
1604 ;; In case of buffer C, t also if it is not a 3way
1605 ;; comparison job (merging jobs return t as well).
1606 (defun ediff-empty-diff-region-p (n buf-type)
1607 (if (eq buf-type 'C)
1608 (or (not ediff-3way-comparison-job)
1609 (= (ediff-get-diff-posn 'C 'beg n)
1610 (ediff-get-diff-posn 'C 'end n)))
1611 (= (ediff-get-diff-posn buf-type 'beg n)
1612 (ediff-get-diff-posn buf-type 'end n))))
1614 ;; Test if diff region is white space only.
1615 ;; If 2-way job and buf-type = C, then returns t.
1616 (defun ediff-whitespace-diff-region-p (n buf-type)
1617 (or (and (eq buf-type 'C) (not ediff-3way-job))
1618 (ediff-empty-diff-region-p n buf-type)
1619 (let ((beg (ediff-get-diff-posn buf-type 'beg n))
1620 (end (ediff-get-diff-posn buf-type 'end n)))
1621 (ediff-with-current-buffer (ediff-get-buffer buf-type)
1624 (skip-chars-forward ediff-whitespace)
1625 (>= (point) end))))))
1627 ;; temporarily uses DIR to abbreviate file name
1628 ;; if DIR is nil, use default-directory
1629 (defun ediff-abbreviate-file-name (file &optional dir)
1630 (cond ((stringp dir)
1631 (let ((directory-abbrev-alist (list (cons dir ""))))
1632 (abbreviate-file-name file)))
1633 (ediff-emacs-p (abbreviate-file-name file))
1634 (t ; XEmacs requires addl argument
1635 (abbreviate-file-name file t))))
1637 ;; Takes a directory and returns the parent directory.
1638 ;; does nothing to `/'. If the ARG is a regular file,
1639 ;; strip the file AND the last dir.
1640 (defun ediff-strip-last-dir (dir)
1641 (if (not (stringp dir)) (setq dir default-directory))
1642 (setq dir (expand-file-name dir))
1643 (or (file-directory-p dir) (setq dir (file-name-directory dir)))
1644 (let* ((pos (1- (length dir)))
1645 (last-char (aref dir pos)))
1646 (if (and (> pos 0) (= last-char ?/))
1647 (setq dir (substring dir 0 pos)))
1648 (ediff-abbreviate-file-name (file-name-directory dir))))
1650 (defun ediff-truncate-string-left (str newlen)
1651 ;; leave space for ... on the left
1652 (let ((len (length str))
1656 (setq newlen (max 0 (- newlen 3)))
1657 (setq substr (substring str (max 0 (- len 1 newlen))))
1658 (concat "..." substr))))
1660 (defsubst ediff-nonempty-string-p (string)
1661 (and (stringp string) (not (string= string ""))))
1663 (defun ediff-abbrev-jobname (jobname)
1664 (cond ((eq jobname 'ediff-directories)
1665 "Compare two directories")
1666 ((eq jobname 'ediff-files)
1667 "Compare two files")
1668 ((eq jobname 'ediff-buffers)
1669 "Compare two buffers")
1670 ((eq jobname 'ediff-directories3)
1671 "Compare three directories")
1672 ((eq jobname 'ediff-files3)
1673 "Compare three files")
1674 ((eq jobname 'ediff-buffers3)
1675 "Compare three buffers")
1676 ((eq jobname 'ediff-revision)
1677 "Compare file with a version")
1678 ((eq jobname 'ediff-directory-revisions)
1679 "Compare dir files with versions")
1680 ((eq jobname 'ediff-merge-directory-revisions)
1681 "Merge dir files with versions")
1682 ((eq jobname 'ediff-merge-directory-revisions-with-ancestor)
1683 "Merge dir versions via ancestors")
1685 (let* ((str (substring (symbol-name jobname) 6))
1690 (aset str pos (upcase (aref str pos))))
1691 (if (= (aref str pos) ?-)
1693 (setq pos (1+ pos)))
1698 (defsubst ediff-get-region-contents (n buf-type ctrl-buf &optional start end)
1699 (ediff-with-current-buffer
1700 (ediff-with-current-buffer ctrl-buf (ediff-get-buffer buf-type))
1702 (or start (ediff-get-diff-posn buf-type 'beg n ctrl-buf))
1703 (or end (ediff-get-diff-posn buf-type 'end n ctrl-buf)))))
1705 ;; If ediff modified mode line, strip the modification
1706 (defsubst ediff-strip-mode-line-format ()
1707 (if (member (car mode-line-format) '(" A: " " B: " " C: " " Ancestor: "))
1708 (setq mode-line-format (nth 2 mode-line-format))))
1710 ;; Verify that we have a difference selected.
1711 (defsubst ediff-valid-difference-p (&optional n)
1712 (or n (setq n ediff-current-difference))
1713 (and (>= n 0) (< n ediff-number-of-differences)))
1715 (defsubst ediff-show-all-diffs (n)
1716 "Don't skip difference regions."
1720 (or (and a (not b)) (and (not a) b)))
1722 (defsubst ediff-message-if-verbose (string &rest args)
1724 (apply 'message string args)))
1726 (defun ediff-file-attributes (filename attr-number)
1727 (if (ediff-file-remote-p filename)
1729 (nth attr-number (file-attributes filename))))
1731 (defsubst ediff-file-size (filename)
1732 (ediff-file-attributes filename 7))
1733 (defsubst ediff-file-modtime (filename)
1734 (ediff-file-attributes filename 5))
1737 (defun ediff-convert-standard-filename (fname)
1738 (if (fboundp 'convert-standard-filename)
1739 (convert-standard-filename fname)
1743 ;;; Local Variables:
1744 ;;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
1745 ;;; eval: (put 'ediff-with-current-buffer 'lisp-indent-hook 1)
1746 ;;; eval: (put 'ediff-with-current-buffer 'edebug-form-spec '(form body))
1749 (provide 'ediff-init)
1752 ;;; ediff-init.el ends here