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