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