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