]> code.delx.au - gnu-emacs/blob - lisp/vc/ediff-init.el
7fad799bfaecba7aa819d335318d72527491c88b
[gnu-emacs] / lisp / vc / ediff-init.el
1 ;;; ediff-init.el --- Macros, variables, and defsubsts used by Ediff
2
3 ;; Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
4 ;; 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
5
6 ;; Author: Michael Kifer <kifer@cs.stonybrook.edu>
7 ;; Package: ediff
8
9 ;; This file is part of GNU Emacs.
10
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
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
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23
24 ;;; Commentary:
25
26 ;;; Code:
27
28 ;; Start compiler pacifier
29 (defvar ediff-metajob-name)
30 (defvar ediff-meta-buffer)
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)
36 (defvar ediff-use-toolbar-p)
37 (defvar mswindowsx-bitmap-file-path)
38 ;; end pacifier
39
40 (defvar ediff-force-faces nil
41 "If t, Ediff will think that it is running on a display that supports faces.
42 This is provided as a temporary relief for users of face-capable displays
43 that Ediff doesn't know about.")
44
45 ;; Are we running as a window application or on a TTY?
46 (defsubst ediff-device-type ()
47 (if (featurep 'xemacs)
48 (device-type (selected-device))
49 window-system))
50
51 ;; in XEmacs: device-type is tty on tty and stream in batch.
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
56 (defun ediff-has-face-support-p ()
57 (cond ((ediff-window-display-p))
58 (ediff-force-faces)
59 ((ediff-color-display-p))
60 ((featurep 'emacs) (memq (ediff-device-type) '(pc)))
61 ((featurep 'xemacs) (memq (ediff-device-type) '(tty pc)))
62 ))
63
64 ;; toolbar support for emacs hasn't been implemented in ediff
65 (defun ediff-has-toolbar-support-p ()
66 (if (featurep 'xemacs)
67 (if (featurep 'toolbar) (console-on-window-system-p))))
68
69
70 (defun ediff-has-gutter-support-p ()
71 (if (featurep 'xemacs)
72 (if (featurep 'gutter) (console-on-window-system-p))))
73
74 (defun ediff-use-toolbar-p ()
75 (and (ediff-has-toolbar-support-p) ;Can it do it ?
76 (boundp 'ediff-use-toolbar-p)
77 ediff-use-toolbar-p)) ;Does the user want it ?
78
79 ;; Defines VAR as an advertised local variable.
80 ;; Performs a defvar, then executes `make-variable-buffer-local' on
81 ;; the variable. Also sets the `permanent-local' property,
82 ;; so that `kill-all-local-variables' (called by major-mode setting
83 ;; commands) won't destroy Ediff control variables.
84 ;;
85 ;; Plagiarised from `emerge-defvar-local' for XEmacs.
86 (defmacro ediff-defvar-local (var value doc)
87 "Defines VAR as a local variable."
88 (declare (indent defun))
89 `(progn
90 (defvar ,var ,value ,doc)
91 (make-variable-buffer-local ',var)
92 (put ',var 'permanent-local t)))
93
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 "")
103 ;; The buffer in which the C variant is stored or where the merge buffer lives.
104 (ediff-defvar-local ediff-buffer-C nil "")
105 ;; Ancestor buffer
106 (ediff-defvar-local ediff-ancestor-buffer nil "")
107 ;; The Ediff control buffer
108 (ediff-defvar-local ediff-control-buffer nil "")
109
110 (ediff-defvar-local ediff-temp-indirect-buffer nil
111 "If t, the buffer is a temporary indirect buffer.
112 It needs to be killed when we quit the session.")
113
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
121 ;;; Macros
122 (defmacro ediff-odd-p (arg)
123 `(eq (logand ,arg 1) 1))
124
125 (defmacro ediff-buffer-live-p (buf)
126 `(and ,buf (get-buffer ,buf) (buffer-name (get-buffer ,buf))))
127
128 (defmacro ediff-get-buffer (arg)
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 ))
134
135 (defmacro ediff-get-value-according-to-buffer-type (buf-type list)
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 ))
140
141 (defmacro ediff-char-to-buftype (arg)
142 `(cond ((memq ,arg '(?a ?A)) 'A)
143 ((memq ,arg '(?b ?B)) 'B)
144 ((memq ,arg '(?c ?C)) 'C)
145 ))
146
147
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
150 ;; an appropriate symbol. Given buffer-type, this function returns the
151 ;; symbol. This is used to avoid using `intern'
152 (defsubst ediff-get-symbol-from-alist (buf-type alist)
153 (cdr (assoc buf-type alist)))
154
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
161 (defmacro ediff-get-difference (n buf-type)
162 `(aref
163 (symbol-value
164 (ediff-get-symbol-from-alist
165 ,buf-type ediff-difference-vector-alist))
166 ,n))
167
168 ;; Tell if it has been previously determined that the region has
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
171 ;; diff vector. It is 1 less than the number seen by the user.
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
180 ;;
181 ;; A Difference Vector has the form:
182 ;; [diff diff diff ...]
183 ;; where each diff has the form:
184 ;; [overlay fine-diff-vector no-fine-diffs-flag state-of-difference]
185 ;; fine-diff-vector is a vector [fine-diff fine-diff fine-diff ...]
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).
189 (defmacro ediff-no-fine-diffs-p (n)
190 `(aref (ediff-get-difference ,n 'A) 2))
191
192 (defmacro ediff-get-diff-overlay-from-diff-record (diff-rec)
193 `(aref ,diff-rec 0))
194
195 (defmacro ediff-get-diff-overlay (n buf-type)
196 `(ediff-get-diff-overlay-from-diff-record
197 (ediff-get-difference ,n ,buf-type)))
198
199 (defmacro ediff-get-fine-diff-vector-from-diff-record (diff-rec)
200 `(aref ,diff-rec 1))
201
202 (defmacro ediff-set-fine-diff-vector (n buf-type fine-vec)
203 `(aset (ediff-get-difference ,n ,buf-type) 1 ,fine-vec))
204
205 (defmacro ediff-get-state-of-diff (n buf-type)
206 `(if (ediff-buffer-live-p ediff-buffer-C)
207 (aref (ediff-get-difference ,n ,buf-type) 3)))
208 (defmacro ediff-set-state-of-diff (n buf-type val)
209 `(aset (ediff-get-difference ,n ,buf-type) 3 ,val))
210
211 (defmacro ediff-get-state-of-merge (n)
212 `(if ediff-state-of-merge
213 (aref (aref ediff-state-of-merge ,n) 0)))
214 (defmacro ediff-set-state-of-merge (n val)
215 `(if ediff-state-of-merge
216 (aset (aref ediff-state-of-merge ,n) 0 ,val)))
217
218 (defmacro ediff-get-state-of-ancestor (n)
219 `(if ediff-state-of-merge
220 (aref (aref ediff-state-of-merge ,n) 1)))
221
222 ;; if flag is t, puts a mark on diff region saying that
223 ;; the differences are in white space only. If flag is nil,
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)
227 `(aset (ediff-get-difference ,n 'A) 2 ,flag))
228
229 (defmacro ediff-get-fine-diff-vector (n buf-type)
230 `(ediff-get-fine-diff-vector-from-diff-record
231 (ediff-get-difference ,n ,buf-type)))
232
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)
237 "Evaluates BODY in BUFFER."
238 (declare (indent 1) (debug (form body)))
239 `(if (ediff-buffer-live-p ,buffer)
240 (save-current-buffer
241 (set-buffer ,buffer)
242 ,@body)
243 (or (eq this-command 'ediff-quit)
244 (error ediff-KILLED-VITAL-BUFFER))
245 ))
246
247
248 (defsubst ediff-multiframe-setup-p ()
249 (and (ediff-window-display-p) ediff-multiframe))
250
251 (defmacro ediff-narrow-control-frame-p ()
252 `(and (ediff-multiframe-setup-p)
253 (equal ediff-help-message ediff-brief-message-string)))
254
255 (defmacro ediff-3way-comparison-job ()
256 `(memq
257 ediff-job-name
258 '(ediff-files3 ediff-buffers3)))
259 (ediff-defvar-local ediff-3way-comparison-job nil "")
260
261 (defmacro ediff-merge-job ()
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)))
270 (ediff-defvar-local ediff-merge-job nil "")
271
272 (defmacro ediff-patch-job ()
273 `(eq ediff-job-name 'epatch))
274
275 (defmacro ediff-merge-with-ancestor-job ()
276 `(memq
277 ediff-job-name
278 '(ediff-merge-files-with-ancestor
279 ediff-merge-buffers-with-ancestor
280 ediff-merge-revisions-with-ancestor)))
281 (ediff-defvar-local ediff-merge-with-ancestor-job nil "")
282
283 (defmacro ediff-3way-job ()
284 `(or ediff-3way-comparison-job ediff-merge-job))
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 ()
290 `(or ediff-3way-comparison-job
291 ediff-merge-with-ancestor-job))
292 (ediff-defvar-local ediff-diff3-job nil "")
293
294 (defmacro ediff-windows-job ()
295 `(memq ediff-job-name '(ediff-windows-wordwise ediff-windows-linewise)))
296 (ediff-defvar-local ediff-windows-job nil "")
297
298 (defmacro ediff-word-mode-job ()
299 `(memq ediff-job-name '(ediff-windows-wordwise ediff-regions-wordwise)))
300 (ediff-defvar-local ediff-word-mode-job nil "")
301
302 (defmacro ediff-narrow-job ()
303 `(memq ediff-job-name '(ediff-windows-wordwise
304 ediff-regions-wordwise
305 ediff-windows-linewise
306 ediff-regions-linewise)))
307 (ediff-defvar-local ediff-narrow-job nil "")
308
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)
317 '(ediff-directory-revisions
318 ediff-merge-directory-revisions
319 ediff-merge-directory-revisions-with-ancestor)))
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)
326 (or (ediff-revision-metajob metajob)
327 (ediff-patch-metajob metajob)
328 ;; add more here
329 ))
330 ;; jobs suitable for the operation of collecting diffs into a multifile patch
331 (defsubst ediff-collect-diffs-metajob (&optional metajob)
332 (memq (or metajob ediff-metajob-name)
333 '(ediff-directories
334 ediff-merge-directories
335 ediff-merge-directories-with-ancestor
336 ediff-directory-revisions
337 ediff-merge-directory-revisions
338 ediff-merge-directory-revisions-with-ancestor
339 ;; add more here
340 )))
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
347 ediff-merge-filegroups-with-ancestor
348 ;; add more here
349 )))
350
351 (defsubst ediff-metajob3 (&optional metajob)
352 (memq (or metajob ediff-metajob-name)
353 '(ediff-merge-directories-with-ancestor
354 ediff-merge-filegroups-with-ancestor
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
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)
370 (error "%S: This command runs in Ediff Control Buffer only!"
371 this-command)))
372
373 (defgroup ediff-highlighting nil
374 "Hilighting of difference regions in Ediff."
375 :prefix "ediff-"
376 :group 'ediff)
377
378 (defgroup ediff-merge nil
379 "Merging utilities."
380 :prefix "ediff-"
381 :group 'ediff)
382
383 (defgroup ediff-hook nil
384 "Hooks run by Ediff."
385 :prefix "ediff-"
386 :group 'ediff)
387
388 ;; Hook variables
389
390 (defcustom ediff-before-setup-hook nil
391 "Hooks to run before Ediff begins to set up windows and buffers.
392 This hook can be used to save the previous window config, which can be restored
393 on ediff-quit or ediff-suspend."
394 :type 'hook
395 :group 'ediff-hook)
396 (defcustom ediff-before-setup-windows-hook nil
397 "Hooks to run before Ediff sets its window configuration.
398 This hook is run every time when Ediff arranges its windows.
399 This happens each time Ediff detects that the windows were messed up by the
400 user."
401 :type 'hook
402 :group 'ediff-hook)
403 (defcustom ediff-after-setup-windows-hook nil
404 "Hooks to run after Ediff sets its window configuration.
405 This can be used to set up control window or icon in a desired place."
406 :type 'hook
407 :group 'ediff-hook)
408 (defcustom ediff-before-setup-control-frame-hook nil
409 "Hooks run before setting up the frame to display Ediff Control Panel.
410 Can be used to change control frame parameters to position it where it
411 is desirable."
412 :type 'hook
413 :group 'ediff-hook)
414 (defcustom ediff-after-setup-control-frame-hook nil
415 "Hooks run after setting up the frame to display Ediff Control Panel.
416 Can be used to move the frame where it is desired."
417 :type 'hook
418 :group 'ediff-hook)
419 (defcustom ediff-startup-hook nil
420 "Hooks to run in the control buffer after Ediff has been set up and is ready for the job."
421 :type 'hook
422 :group 'ediff-hook)
423 (defcustom ediff-select-hook nil
424 "Hooks to run after a difference has been selected."
425 :type 'hook
426 :group 'ediff-hook)
427 (defcustom ediff-unselect-hook nil
428 "Hooks to run after a difference has been unselected."
429 :type 'hook
430 :group 'ediff-hook)
431 (defcustom ediff-prepare-buffer-hook nil
432 "Hooks run after buffers A, B, and C are set up.
433 For each buffer, the hooks are run with that buffer made current."
434 :type 'hook
435 :group 'ediff-hook)
436 (defcustom ediff-load-hook nil
437 "Hook run after Ediff is loaded. Can be used to change defaults."
438 :type 'hook
439 :group 'ediff-hook)
440
441 (defcustom ediff-mode-hook nil
442 "Hook run just after ediff-mode is set up in the control buffer.
443 This is done before any windows or frames are created. One can use it to
444 set local variables that determine how the display looks like."
445 :type 'hook
446 :group 'ediff-hook)
447 (defcustom ediff-keymap-setup-hook nil
448 "Hook run just after the default bindings in Ediff keymap are set up."
449 :type 'hook
450 :group 'ediff-hook)
451
452 (defcustom ediff-display-help-hook nil
453 "Hooks run after preparing the help message."
454 :type 'hook
455 :group 'ediff-hook)
456
457 (defcustom ediff-suspend-hook nil
458 "Hooks to run in the Ediff control buffer when Ediff is suspended."
459 :type 'hook
460 :group 'ediff-hook)
461 (defcustom ediff-quit-hook nil
462 "Hooks to run in the Ediff control buffer after finishing Ediff."
463 :type 'hook
464 :group 'ediff-hook)
465 (defcustom ediff-cleanup-hook nil
466 "Hooks to run on exiting Ediff but before killing the control and variant buffers."
467 :type 'hook
468 :group 'ediff-hook)
469
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
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
477 "%S: Bad diff region number, %d. Valid numbers are 1 to %d")
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.
481 ***
482 *** Please contact your system administrator. "
483 (if (featurep 'xemacs) "X" "")))
484
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.
489 Should return t for regions to be ignored and nil otherwise.
490 This function gets a region number as an argument. The region number
491 is the one used internally by Ediff. It is 1 less than the number seen
492 by the user.")
493
494 (ediff-defvar-local ediff-hide-regexp-matches-function
495 'ediff-hide-regexp-matches
496 "Function to use in determining which regions to hide.
497 See 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.
501 See the documentation string of `ediff-focus-on-regexp-matches' for details.")
502
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 "")
512
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 "")
522
523
524 ;;; Copying difference regions between buffers.
525
526 ;; A list of killed diffs.
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 "")
532
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
538
539 ;; Highlighting
540 (defcustom ediff-before-flag-bol (if (featurep 'xemacs) (make-glyph "->>") "->>")
541 "Flag placed before a highlighted block of differences, if block starts at beginning of a line."
542 :type 'string
543 :tag "Region before-flag at beginning of line"
544 :group 'ediff)
545
546 (defcustom ediff-after-flag-eol (if (featurep 'xemacs) (make-glyph "<<-") "<<-")
547 "Flag placed after a highlighted block of differences, if block ends at end of a line."
548 :type 'string
549 :tag "Region after-flag at end of line"
550 :group 'ediff)
551
552 (defcustom ediff-before-flag-mol (if (featurep 'xemacs) (make-glyph "->>") "->>")
553 "Flag placed before a highlighted block of differences, if block starts in mid-line."
554 :type 'string
555 :tag "Region before-flag in the middle of line"
556 :group 'ediff)
557 (defcustom ediff-after-flag-mol (if (featurep 'xemacs) (make-glyph "<<-") "<<-")
558 "Flag placed after a highlighted block of differences, if block ends in mid-line."
559 :type 'string
560 :tag "Region after-flag in the middle of line"
561 :group 'ediff)
562
563
564 (ediff-defvar-local ediff-use-faces t "")
565 (defcustom ediff-use-faces t
566 "If t, differences are highlighted using faces, if device supports faces.
567 If nil, differences are highlighted using ASCII flags, ediff-before-flag
568 and ediff-after-flag. On a non-window system, differences are always
569 highlighted using ASCII flags."
570 :type 'boolean
571 :group 'ediff-highlighting)
572
573 ;; this indicates that diff regions are word-size, so fine diffs are
574 ;; permanently nixed; used in ediff-windows-wordwise and ediff-regions-wordwise
575 (ediff-defvar-local ediff-word-mode nil "")
576 ;; Name of the job (ediff-files, ediff-windows, etc.)
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.
590 ;; This is also a list of overlays. When the user toggles narrow/widen,
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
596 "Non-nil means start narrowed, if doing ediff-windows-* or ediff-regions-*")
597 (ediff-defvar-local ediff-quit-widened t
598 "*Non-nil means: when finished, Ediff widens buffers A/B.
599 Actually, Ediff restores the scope of visibility that existed at startup.")
600
601 (defcustom ediff-keep-variants t
602 "nil means prompt to remove unmodified buffers A/B/C at session end.
603 Supplying a prefix argument to the quit command `q' temporarily reverses the
604 meaning of this variable."
605 :type 'boolean
606 :group 'ediff)
607
608 (ediff-defvar-local ediff-highlight-all-diffs t "")
609 (defcustom ediff-highlight-all-diffs t
610 "If nil, only the selected differences are highlighted.
611 Otherwise, all difference regions are highlighted, but the selected region is
612 shown in brighter colors."
613 :type 'boolean
614 :group 'ediff-highlighting)
615
616
617 ;; The suffix of the control buffer name.
618 (ediff-defvar-local ediff-control-buffer-suffix nil "")
619 ;; Same as ediff-control-buffer-suffix, but without <,>.
620 ;; It's a number rather than string.
621 (ediff-defvar-local ediff-control-buffer-number nil "")
622
623
624 ;; The original values of ediff-protected-variables for buffer A
625 (ediff-defvar-local ediff-buffer-values-orig-A nil "")
626 ;; The original values of ediff-protected-variables for buffer B
627 (ediff-defvar-local ediff-buffer-values-orig-B nil "")
628 ;; The original values of ediff-protected-variables for buffer C
629 (ediff-defvar-local ediff-buffer-values-orig-C nil "")
630 ;; The original values of ediff-protected-variables for buffer Ancestor
631 (ediff-defvar-local ediff-buffer-values-orig-Ancestor nil "")
632
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
640 ;; Buffer-local variables to be saved then restored during Ediff sessions
641 (defconst ediff-protected-variables '(
642 ;;buffer-read-only
643 mode-line-format))
644
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
649 ;; the B buffer. If a difference section is empty, the corresponding
650 ;; overlay's endpoints coincide.
651 ;;
652 ;; The precise form of a Difference Vector for one buffer is:
653 ;; [diff diff diff ...]
654 ;; where each diff has the form:
655 ;; [diff-overlay fine-diff-vector no-fine-diffs-flag state-of-diff]
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
659 ;; different from the other two (used only in 3-way jobs.
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 "")
663 (ediff-defvar-local ediff-difference-vector-Ancestor nil "")
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)))
670
671 ;; [ status status status ...]
672 ;; Each status: [state-of-merge state-of-ancestor]
673 ;; state-of-merge is default-A, default-B, prefer-A, or prefer-B. It
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 "")
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 "")
683
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 "")
687 ;; Like ediff-diff-buffer, but contains context diff. It is not used by
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
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 "")
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 "")
708
709 ;; Priority of non-selected overlays.
710 (defvar ediff-shadow-overlay-priority 100 "")
711
712 (defcustom ediff-version-control-package 'vc
713 "Version control package used.
714 Currently, Ediff supports vc.el, rcs.el, pcl-cvs.el, and generic-sc.el. The
715 standard Emacs interface to RCS, CVS, SCCS, etc., is vc.el. However, some
716 people find the other two packages more convenient. Set this variable to the
717 appropriate symbol: `rcs', `pcl-cvs', or `generic-sc' if you so desire."
718 :type 'symbol
719 :group 'ediff)
720
721 (defcustom ediff-coding-system-for-read 'raw-text
722 "The coding system for read to use when running the diff program as a subprocess.
723 In most cases, the default will do. However, under certain circumstances in
724 MS-Windows you might need to use something like 'raw-text-dos here.
725 So, if the output that your diff program sends to Emacs contains extra ^M's,
726 you might need to experiment here, if the default or 'raw-text-dos doesn't
727 work."
728 :type 'symbol
729 :group 'ediff)
730
731 (defcustom ediff-coding-system-for-write (if (featurep 'xemacs)
732 'escape-quoted
733 'emacs-internal)
734 "The coding system for write to use when writing out difference regions
735 to temp files in buffer jobs and when Ediff needs to find fine differences."
736 :type 'symbol
737 :group 'ediff)
738
739
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))
751
752 ;; Assumes that emacs-major-version and emacs-minor-version are defined.
753 (defun ediff-check-version (op major minor &optional type-of-emacs)
754 "Check the current version against MAJOR and MINOR version numbers.
755 The comparison uses operator OP, which may be any of: =, >, >=, <, <=.
756 TYPE-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")
773
774 (defun ediff-color-display-p ()
775 (condition-case nil
776 (if (featurep 'xemacs)
777 (eq (device-class (selected-device)) 'color) ; xemacs form
778 (display-color-p)) ; emacs form
779 (error nil)))
780
781
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\).
785 (ediff-defvar-local ediff-highlighting-style
786 (if (and (ediff-has-face-support-p) ediff-use-faces) 'face 'ascii)
787 "")
788
789
790 (if (ediff-window-display-p)
791 (if (featurep 'xemacs)
792 (progn
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))))
803
804 ;; A-list of current-diff-overlay symbols associated with buf types
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)))
810
811 ;; A-list of current-diff-face-* symbols associated with buf types
812 (defconst ediff-current-diff-face-alist
813 '((A . ediff-current-diff-A)
814 (B . ediff-current-diff-B)
815 (C . ediff-current-diff-C)
816 (Ancestor . ediff-current-diff-Ancestor)))
817
818
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))
822
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))
828 (diff-num (ediff-overlay-get overlay 'ediff-diff-num))
829 face-help)
830
831 ;; This happens only for refinement overlays
832 (if (stringp face)
833 (setq face (intern face)))
834 (setq face-help (and face (get face 'ediff-help-echo)))
835
836 (cond ((and is-current diff-num) ; current diff region
837 (format "Difference region %S -- current" (1+ diff-num)))
838 (face-help) ; refinement of current diff region
839 (diff-num ; non-current
840 (format "Difference region %S -- non-current" (1+ diff-num)))
841 (t "")) ; none
842 ))
843
844
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
854 (defun ediff-hide-face (face)
855 (if (and (ediff-has-face-support-p)
856 (boundp 'add-to-list)
857 (boundp 'facemenu-unlisted-faces))
858 (add-to-list 'facemenu-unlisted-faces face)))
859
860
861
862 (defface ediff-current-diff-A
863 (if (featurep 'emacs)
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))))
872 "Face for highlighting the selected difference in buffer A."
873 :group 'ediff-highlighting)
874 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
875 ;; this variable is set to nil, then again to the appropriate face.
876 (defvar ediff-current-diff-face-A 'ediff-current-diff-A
877 "Face for highlighting the selected difference in buffer A.
878 DO NOT CHANGE this variable. Instead, use the customization
879 widget to customize the actual face object `ediff-current-diff-A'
880 this variable represents.")
881 (ediff-hide-face ediff-current-diff-face-A)
882 ;; Until custom.el for XEmacs starts supporting :inverse-video we do this.
883 ;; This means that some user customization may be trashed.
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))
888
889
890
891 (defface ediff-current-diff-B
892 (if (featurep 'emacs)
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))))
903 "Face for highlighting the selected difference in buffer B."
904 :group 'ediff-highlighting)
905 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
906 ;; this variable is set to nil, then again to the appropriate face.
907 (defvar ediff-current-diff-face-B 'ediff-current-diff-B
908 "Face for highlighting the selected difference in buffer B.
909 this variable. Instead, use the customization
910 widget to customize the actual face `ediff-current-diff-B'
911 this variable represents.")
912 (ediff-hide-face ediff-current-diff-face-B)
913 ;; Until custom.el for XEmacs starts supporting :inverse-video we do this.
914 ;; This means that some user customization may be trashed.
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))
919
920
921 (defface ediff-current-diff-C
922 (if (featurep 'emacs)
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))))
931 "Face for highlighting the selected difference in buffer C."
932 :group 'ediff-highlighting)
933 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
934 ;; this variable is set to nil, then again to the appropriate face.
935 (defvar ediff-current-diff-face-C 'ediff-current-diff-C
936 "Face for highlighting the selected difference in buffer C.
937 DO NOT CHANGE this variable. Instead, use the customization
938 widget to customize the actual face object `ediff-current-diff-C'
939 this variable represents.")
940 (ediff-hide-face ediff-current-diff-face-C)
941 ;; Until custom.el for XEmacs starts supporting :inverse-video we do this.
942 ;; This means that some user customization may be trashed.
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))
947
948
949 (defface ediff-current-diff-Ancestor
950 (if (featurep 'emacs)
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))))
959 "Face for highlighting the selected difference in buffer Ancestor."
960 :group 'ediff-highlighting)
961 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
962 ;; this variable is set to nil, then again to the appropriate face.
963 (defvar ediff-current-diff-face-Ancestor 'ediff-current-diff-Ancestor
964 "Face for highlighting the selected difference in buffer Ancestor.
965 DO NOT CHANGE this variable. Instead, use the customization
966 widget to customize the actual face object `ediff-current-diff-Ancestor'
967 this variable represents.")
968 (ediff-hide-face ediff-current-diff-face-Ancestor)
969 ;; Until custom.el for XEmacs starts supporting :inverse-video we do this.
970 ;; This means that some user customization may be trashed.
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))
975
976
977 (defface ediff-fine-diff-A
978 (if (featurep 'emacs)
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"))))
987 "Face for highlighting the refinement of the selected diff in buffer A."
988 :group 'ediff-highlighting)
989 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
990 ;; this variable is set to nil, then again to the appropriate face.
991 (defvar ediff-fine-diff-face-A 'ediff-fine-diff-A
992 "Face for highlighting the fine differences in buffer A.
993 DO NOT CHANGE this variable. Instead, use the customization
994 widget to customize the actual face object `ediff-fine-diff-A'
995 this variable represents.")
996 (ediff-hide-face ediff-fine-diff-face-A)
997
998 (defface ediff-fine-diff-B
999 (if (featurep 'emacs)
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"))))
1008 "Face for highlighting the refinement of the selected diff in buffer B."
1009 :group 'ediff-highlighting)
1010 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
1011 ;; this variable is set to nil, then again to the appropriate face.
1012 (defvar ediff-fine-diff-face-B 'ediff-fine-diff-B
1013 "Face for highlighting the fine differences in buffer B.
1014 DO NOT CHANGE this variable. Instead, use the customization
1015 widget to customize the actual face object `ediff-fine-diff-B'
1016 this variable represents.")
1017 (ediff-hide-face ediff-fine-diff-face-B)
1018
1019 (defface ediff-fine-diff-C
1020 (if (featurep 'emacs)
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"))))
1034 "Face for highlighting the refinement of the selected diff in buffer C."
1035 :group 'ediff-highlighting)
1036 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
1037 ;; this variable is set to nil, then again to the appropriate face.
1038 (defvar ediff-fine-diff-face-C 'ediff-fine-diff-C
1039 "Face for highlighting the fine differences in buffer C.
1040 DO NOT CHANGE this variable. Instead, use the customization
1041 widget to customize the actual face object `ediff-fine-diff-C'
1042 this variable represents.")
1043 (ediff-hide-face ediff-fine-diff-face-C)
1044
1045 (defface ediff-fine-diff-Ancestor
1046 (if (featurep 'emacs)
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"))))
1055 "Face for highlighting the refinement of the selected diff in the ancestor buffer.
1056 At present, this face is not used and no fine differences are computed for the
1057 ancestor buffer."
1058 :group 'ediff-highlighting)
1059 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
1060 ;; this variable is set to nil, then again to the appropriate face.
1061 (defvar ediff-fine-diff-face-Ancestor 'ediff-fine-diff-Ancestor
1062 "Face for highlighting the fine differences in buffer Ancestor.
1063 DO NOT CHANGE this variable. Instead, use the customization
1064 widget to customize the actual face object `ediff-fine-diff-Ancestor'
1065 this variable represents.")
1066 (ediff-hide-face ediff-fine-diff-face-Ancestor)
1067
1068 ;; Some installs don't have stipple or Stipple. So, try them in turn.
1069 (defvar stipple-pixmap
1070 (cond ((not (ediff-has-face-support-p)) nil)
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
1077 (defface ediff-even-diff-A
1078 (if (featurep 'emacs)
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))))
1092 "Face for highlighting even-numbered non-current differences in buffer A."
1093 :group 'ediff-highlighting)
1094 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
1095 ;; this variable is set to nil, then again to the appropriate face.
1096 (defvar ediff-even-diff-face-A 'ediff-even-diff-A
1097 "Face for highlighting even-numbered non-current differences in buffer A.
1098 DO NOT CHANGE this variable. Instead, use the customization
1099 widget to customize the actual face object `ediff-even-diff-A'
1100 this variable represents.")
1101 (ediff-hide-face ediff-even-diff-face-A)
1102
1103 (defface ediff-even-diff-B
1104 (if (featurep 'emacs)
1105 `((((class color) (min-colors 16))
1106 (:foreground "White" :background "Grey"))
1107 (((class color))
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))))
1113 "Face for highlighting even-numbered non-current differences in buffer B."
1114 :group 'ediff-highlighting)
1115 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
1116 ;; this variable is set to nil, then again to the appropriate face.
1117 (defvar ediff-even-diff-face-B 'ediff-even-diff-B
1118 "Face for highlighting even-numbered non-current differences in buffer B.
1119 DO NOT CHANGE this variable. Instead, use the customization
1120 widget to customize the actual face object `ediff-even-diff-B'
1121 this variable represents.")
1122 (ediff-hide-face ediff-even-diff-face-B)
1123
1124 (defface ediff-even-diff-C
1125 (if (featurep 'emacs)
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))))
1139 "Face for highlighting even-numbered non-current differences in buffer C."
1140 :group 'ediff-highlighting)
1141 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
1142 ;; this variable is set to nil, then again to the appropriate face.
1143 (defvar ediff-even-diff-face-C 'ediff-even-diff-C
1144 "Face for highlighting even-numbered non-current differences in buffer C.
1145 DO NOT CHANGE this variable. Instead, use the customization
1146 widget to customize the actual face object `ediff-even-diff-C'
1147 this variable represents.")
1148 (ediff-hide-face ediff-even-diff-face-C)
1149
1150 (defface ediff-even-diff-Ancestor
1151 (if (featurep 'emacs)
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))))
1165 "Face for highlighting even-numbered non-current differences in the ancestor buffer."
1166 :group 'ediff-highlighting)
1167 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
1168 ;; this variable is set to nil, then again to the appropriate face.
1169 (defvar ediff-even-diff-face-Ancestor 'ediff-even-diff-Ancestor
1170 "Face for highlighting even-numbered non-current differences in buffer Ancestor.
1171 DO NOT CHANGE this variable. Instead, use the customization
1172 widget to customize the actual face object `ediff-even-diff-Ancestor'
1173 this variable represents.")
1174 (ediff-hide-face ediff-even-diff-face-Ancestor)
1175
1176 ;; Association between buffer types and even-diff-face symbols
1177 (defconst ediff-even-diff-face-alist
1178 '((A . ediff-even-diff-A)
1179 (B . ediff-even-diff-B)
1180 (C . ediff-even-diff-C)
1181 (Ancestor . ediff-even-diff-Ancestor)))
1182
1183 (defface ediff-odd-diff-A
1184 (if (featurep 'emacs)
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"))))
1196 "Face for highlighting odd-numbered non-current differences in buffer A."
1197 :group 'ediff-highlighting)
1198 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
1199 ;; this variable is set to nil, then again to the appropriate face.
1200 (defvar ediff-odd-diff-face-A 'ediff-odd-diff-A
1201 "Face for highlighting odd-numbered non-current differences in buffer A.
1202 DO NOT CHANGE this variable. Instead, use the customization
1203 widget to customize the actual face object `ediff-odd-diff-A'
1204 this variable represents.")
1205 (ediff-hide-face ediff-odd-diff-face-A)
1206
1207
1208 (defface ediff-odd-diff-B
1209 (if (featurep 'emacs)
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"))))
1221 "Face for highlighting odd-numbered non-current differences in buffer B."
1222 :group 'ediff-highlighting)
1223 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
1224 ;; this variable is set to nil, then again to the appropriate face.
1225 (defvar ediff-odd-diff-face-B 'ediff-odd-diff-B
1226 "Face for highlighting odd-numbered non-current differences in buffer B.
1227 DO NOT CHANGE this variable. Instead, use the customization
1228 widget to customize the actual face object `ediff-odd-diff-B'
1229 this variable represents.")
1230 (ediff-hide-face ediff-odd-diff-face-B)
1231
1232 (defface ediff-odd-diff-C
1233 (if (featurep 'emacs)
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"))))
1245 "Face for highlighting odd-numbered non-current differences in buffer C."
1246 :group 'ediff-highlighting)
1247 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
1248 ;; this variable is set to nil, then again to the appropriate face.
1249 (defvar ediff-odd-diff-face-C 'ediff-odd-diff-C
1250 "Face for highlighting odd-numbered non-current differences in buffer C.
1251 DO NOT CHANGE this variable. Instead, use the customization
1252 widget to customize the actual face object `ediff-odd-diff-C'
1253 this variable represents.")
1254 (ediff-hide-face ediff-odd-diff-face-C)
1255
1256 (defface ediff-odd-diff-Ancestor
1257 (if (featurep 'emacs)
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"))))
1266 "Face for highlighting odd-numbered non-current differences in the ancestor buffer."
1267 :group 'ediff-highlighting)
1268 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
1269 ;; this variable is set to nil, then again to the appropriate face.
1270 (defvar ediff-odd-diff-face-Ancestor 'ediff-odd-diff-Ancestor
1271 "Face for highlighting odd-numbered non-current differences in buffer Ancestor.
1272 DO NOT CHANGE this variable. Instead, use the customization
1273 widget to customize the actual face object `ediff-odd-diff-Ancestor'
1274 this variable represents.")
1275 (ediff-hide-face ediff-odd-diff-face-Ancestor)
1276
1277 ;; Association between buffer types and odd-diff-face symbols
1278 (defconst ediff-odd-diff-face-alist
1279 '((A . ediff-odd-diff-A)
1280 (B . ediff-odd-diff-B)
1281 (C . ediff-odd-diff-C)
1282 (Ancestor . ediff-odd-diff-Ancestor)))
1283
1284 ;; A-list of fine-diff face symbols associated with buffer types
1285 (defconst ediff-fine-diff-face-alist
1286 '((A . ediff-fine-diff-A)
1287 (B . ediff-fine-diff-B)
1288 (C . ediff-fine-diff-C)
1289 (Ancestor . ediff-fine-diff-Ancestor)))
1290
1291 ;; Help echo
1292 (put ediff-fine-diff-face-A 'ediff-help-echo
1293 "A `refinement' of the current difference region")
1294 (put ediff-fine-diff-face-B 'ediff-help-echo
1295 "A `refinement' of the current difference region")
1296 (put ediff-fine-diff-face-C 'ediff-help-echo
1297 "A `refinement' of the current difference region")
1298 (put ediff-fine-diff-face-Ancestor 'ediff-help-echo
1299 "A `refinement' of the current difference region")
1300
1301 (add-hook 'ediff-quit-hook 'ediff-cleanup-mess)
1302 (add-hook 'ediff-suspend-hook 'ediff-default-suspend-function)
1303
1304
1305 ;;; Overlays
1306
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.")
1315
1316 ;; Compute priority of a current ediff overlay.
1317 (defun ediff-highest-priority (start end buffer)
1318 (let ((pos (max 1 (1- start)))
1319 ovr-list)
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))))))))
1342
1343
1344 (defvar ediff-toggle-read-only-function nil
1345 "*Specifies the function to be used to toggle read-only.
1346 If nil, Ediff tries to deduce the function from the binding of C-x C-q.
1347 Normally, this is the `toggle-read-only' function, but, if version
1348 control is used, it could be `vc-toggle-read-only' or `rcs-toggle-read-only'.")
1349
1350 (defcustom ediff-make-buffers-readonly-at-startup nil
1351 "Make all variant buffers read-only when Ediff starts up.
1352 This property can be toggled interactively."
1353 :type 'boolean
1354 :group 'ediff)
1355
1356
1357 ;;; Misc
1358
1359 ;; if nil, this silences some messages
1360 (defvar ediff-verbose-p t)
1361
1362 (defcustom ediff-autostore-merges 'group-jobs-only
1363 "Save the results of merge jobs automatically.
1364 With value nil, don't save automatically. With value t, always
1365 save. Anything else means save automatically only if the merge
1366 job is part of a group of jobs, such as `ediff-merge-directory'
1367 or `ediff-merge-directory-revisions'."
1368 :type '(choice (const nil) (const t) (const group-jobs-only))
1369 :group 'ediff-merge)
1370 (make-variable-buffer-local 'ediff-autostore-merges)
1371
1372 ;; file where the result of the merge is to be saved. used internally
1373 (ediff-defvar-local ediff-merge-store-file nil "")
1374
1375 (defcustom ediff-merge-filename-prefix "merge_"
1376 "Prefix to be attached to saved merge buffers."
1377 :type 'string
1378 :group 'ediff-merge)
1379
1380 (defcustom ediff-no-emacs-help-in-control-buffer nil
1381 "Non-nil means C-h should not invoke Emacs help in control buffer.
1382 Instead, C-h would jump to previous difference."
1383 :type 'boolean
1384 :group 'ediff)
1385
1386 ;; This is the same as temporary-file-directory from Emacs 20.3.
1387 ;; Copied over here because XEmacs doesn't have this variable.
1388 (defcustom ediff-temp-file-prefix
1389 (file-name-as-directory
1390 (cond ((boundp 'temporary-file-directory) temporary-file-directory)
1391 ((fboundp 'temp-directory) (temp-directory))
1392 (t "/tmp/")))
1393 ;;; (file-name-as-directory
1394 ;;; (cond ((memq system-type '(ms-dos windows-nt))
1395 ;;; (or (getenv "TEMP") (getenv "TMPDIR") (getenv "TMP") "c:/temp"))
1396 ;;; (t
1397 ;;; (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "/tmp"))))
1398 "Prefix to put on Ediff temporary file names.
1399 Do not start with `~/' or `~USERNAME/'."
1400 :type 'string
1401 :group 'ediff)
1402
1403 (defcustom ediff-temp-file-mode 384 ; u=rw only
1404 "Mode for Ediff temporary files."
1405 :type 'integer
1406 :group 'ediff)
1407
1408 ;; Metacharacters that have to be protected from the shell when executing
1409 ;; a diff/diff3 command.
1410 (defcustom ediff-metachars "[ \t\n!\"#$&'()*;<=>?[\\^`{|~]"
1411 "Regexp that matches characters that must be quoted with `\\' in shell command line.
1412 This default should work without changes."
1413 :type 'string
1414 :group 'ediff)
1415
1416 ;; needed to simulate frame-char-width in XEmacs.
1417 (defvar ediff-H-glyph (if (featurep 'xemacs) (make-glyph "H")))
1418
1419
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
1427
1428 (defun ediff-file-remote-p (file-name)
1429 (file-remote-p file-name))
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))))
1435
1436
1437 (defsubst ediff-frame-unsplittable-p (frame)
1438 (cdr (assq 'unsplittable (frame-parameters frame))))
1439
1440 (defsubst ediff-get-next-window (wind prev-wind)
1441 (cond ((window-live-p wind) wind)
1442 (prev-wind (next-window wind))
1443 (t (selected-window))
1444 ))
1445
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))))
1451
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.
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 ))
1460
1461
1462 ;; activate faces on diff regions in buffer
1463 (defun ediff-paint-background-regions-in-one-buffer (buf-type unhighlight)
1464 (let ((diff-vector
1465 (eval (ediff-get-symbol-from-alist
1466 buf-type ediff-difference-vector-alist)))
1467 overl diff-num)
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 )
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
1492
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
1497 (mapc 'ediff-delete-overlay
1498 (ediff-get-fine-diff-vector-from-diff-record diff-record))))
1499
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))
1503
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)))
1509
1510
1511 (defsubst ediff-mouse-event-p (event)
1512 (if (featurep 'xemacs)
1513 (button-event-p event)
1514 (string-match "mouse" (format "%S" (event-basic-type event)))))
1515
1516
1517 (defsubst ediff-key-press-event-p (event)
1518 (if (featurep 'xemacs)
1519 (key-press-event-p event)
1520 (or (char-or-string-p event) (symbolp event))))
1521
1522 (defun ediff-event-point (event)
1523 (cond ((ediff-mouse-event-p event)
1524 (if (featurep 'xemacs)
1525 (event-point event)
1526 (posn-point (event-start event))))
1527 ((ediff-key-press-event-p event)
1528 (point))
1529 (t (error "Error"))))
1530
1531 (defun ediff-event-buffer (event)
1532 (cond ((ediff-mouse-event-p event)
1533 (if (featurep 'xemacs)
1534 (event-buffer event)
1535 (window-buffer (posn-window (event-start event)))))
1536 ((ediff-key-press-event-p event)
1537 (current-buffer))
1538 (t (error "Error"))))
1539
1540 (defun ediff-event-key (event-or-key)
1541 (if (featurep 'xemacs)
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)
1544 event-or-key))
1545
1546 (defun ediff-last-command-char ()
1547 (ediff-event-key last-command-event))
1548
1549
1550 (defsubst ediff-frame-iconified-p (frame)
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))))
1555
1556 (defsubst ediff-window-visible-p (wind)
1557 ;; under TTY, window-live-p also means window is visible
1558 (and (window-live-p wind)
1559 (or (not (ediff-window-display-p))
1560 (frame-visible-p (window-frame wind)))))
1561
1562
1563 (defsubst ediff-frame-char-width (frame)
1564 (if (featurep 'xemacs)
1565 (/ (frame-pixel-width frame) (frame-width frame))
1566 (frame-char-width frame)))
1567
1568 (defun ediff-reset-mouse (&optional frame do-not-grab-mouse)
1569 (or frame (setq frame (selected-frame)))
1570 (if (ediff-window-display-p)
1571 (let ((frame-or-wind frame))
1572 (if (featurep 'xemacs)
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
1576 (not ediff-grab-mouse)
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
1580 ;; ediff-recenter). The condition below affects only terminating
1581 ;; sessions in session groups (in which case mouse is warped into
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
1591 ;; It is not easy to find out when the user grabs the mouse, since emacs and
1592 ;; xemacs behave differently when mouse is not in any frame. Also, this is
1593 ;; sensitive to when the user grabbed mouse. Not used for now.
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)))))
1604 ediff-mouse-pixel-threshold)
1605 (< (abs (- (cdr (cdr ediff-mouse-pixel-position))
1606 (cdr (cdr (mouse-pixel-position)))))
1607 ediff-mouse-pixel-threshold))))
1608 (t nil))))
1609
1610 (defsubst ediff-frame-char-height (frame)
1611 (if (featurep 'xemacs)
1612 (glyph-height ediff-H-glyph (frame-selected-window frame))
1613 (frame-char-height frame)))
1614
1615 ;; Some overlay functions
1616
1617 (defsubst ediff-overlay-start (overl)
1618 (if (ediff-overlayp overl)
1619 (if (featurep 'xemacs)
1620 (extent-start-position overl)
1621 (overlay-start overl))))
1622
1623 (defsubst ediff-overlay-end (overl)
1624 (if (ediff-overlayp overl)
1625 (if (featurep 'xemacs)
1626 (extent-end-position overl)
1627 (overlay-end overl))))
1628
1629 (defsubst ediff-empty-overlay-p (overl)
1630 (= (ediff-overlay-start overl) (ediff-overlay-end overl)))
1631
1632 ;; like overlay-buffer in Emacs. In XEmacs, returns nil if the extent is
1633 ;; dead. Otherwise, works like extent-buffer
1634 (defun ediff-overlay-buffer (overl)
1635 (if (featurep 'xemacs)
1636 (and (extent-live-p overl) (extent-object overl))
1637 (overlay-buffer overl)))
1638
1639 ;; like overlay-get in Emacs. In XEmacs, returns nil if the extent is
1640 ;; dead. Otherwise, like extent-property
1641 (defun ediff-overlay-get (overl property)
1642 (if (featurep 'xemacs)
1643 (and (extent-live-p overl) (extent-property overl property))
1644 (overlay-get overl property)))
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.
1651 Checks 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)
1654 (if (featurep 'xemacs)
1655 (set-extent-endpoints overlay beg end)
1656 (move-overlay overlay beg end buffer))
1657 ;; buffer's dead
1658 (if overlay
1659 (ediff-delete-overlay overlay)))))
1660
1661 (defun ediff-overlay-put (overlay prop value)
1662 "Calls `overlay-put' or `set-extent-property' depending on Emacs version.
1663 Checks if overlay's buffer exists."
1664 (if (ediff-buffer-live-p (ediff-overlay-buffer overlay))
1665 (if (featurep 'xemacs)
1666 (set-extent-property overlay prop value)
1667 (overlay-put overlay prop value))
1668 (ediff-delete-overlay overlay)))
1669
1670 ;; temporarily uses DIR to abbreviate file name
1671 ;; if DIR is nil, use default-directory
1672 (defun ediff-abbreviate-file-name (file &optional dir)
1673 (cond ((stringp dir)
1674 (let ((directory-abbrev-alist (list (cons dir ""))))
1675 (abbreviate-file-name file)))
1676 (t
1677 (if (featurep 'xemacs)
1678 ;; XEmacs requires addl argument
1679 (abbreviate-file-name file t)
1680 (abbreviate-file-name file)))))
1681
1682 ;; Takes a directory and returns the parent directory.
1683 ;; does nothing to `/'. If the ARG is a regular file,
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
1705 (defsubst ediff-nonempty-string-p (string)
1706 (and (stringp string) (not (string= string ""))))
1707
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.
1711 Unless 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
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
1742 (capitalize
1743 (subst-char-in-string ?- ?\s (substring (symbol-name jobname) 6))))
1744 ))
1745
1746
1747 ;; If ediff modified mode line, strip the modification
1748 (defsubst ediff-strip-mode-line-format ()
1749 (if (member (car mode-line-format) '(" A: " " B: " " C: " " Ancestor: "))
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)))
1756
1757 (defsubst ediff-show-all-diffs (n)
1758 "Don't skip difference regions."
1759 nil)
1760
1761 (defsubst ediff-message-if-verbose (string &rest args)
1762 (if ediff-verbose-p
1763 (apply 'message string args)))
1764
1765 (defun ediff-file-attributes (filename attr-number)
1766 (if (ediff-listable-file filename)
1767 (nth attr-number (file-attributes filename))
1768 -1)
1769 )
1770
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
1777 (defun ediff-convert-standard-filename (fname)
1778 (if (fboundp 'convert-standard-filename)
1779 (convert-standard-filename fname)
1780 fname))
1781
1782 (if (featurep 'emacs)
1783 (defalias 'ediff-with-syntax-table 'with-syntax-table)
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))))))))
1799
1800
1801 (provide 'ediff-init)
1802
1803
1804
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:
1810
1811 ;;; ediff-init.el ends here