Merge changes from emacs-23 branch.
[bpt/emacs.git] / 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 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-has-face-support-p)
791 (if (featurep 'xemacs)
792 (progn
793 (defalias 'ediff-valid-color-p 'valid-color-name-p)
794 (defalias 'ediff-get-face 'get-face))
795 (defalias 'ediff-valid-color-p (if (fboundp 'color-defined-p)
796 'color-defined-p
797 'x-color-defined-p))
798 (defalias 'ediff-get-face 'internal-get-face)))
799
800 (if (ediff-window-display-p)
801 (if (featurep 'xemacs)
802 (progn
803 (defalias 'ediff-display-pixel-width 'device-pixel-width)
804 (defalias 'ediff-display-pixel-height 'device-pixel-height))
805 (defalias 'ediff-display-pixel-width
806 (if (fboundp 'display-pixel-width)
807 'display-pixel-width
808 'x-display-pixel-width))
809 (defalias 'ediff-display-pixel-height
810 (if (fboundp 'display-pixel-height)
811 'display-pixel-height
812 'x-display-pixel-height))))
813
814 ;; A-list of current-diff-overlay symbols associated with buf types
815 (defconst ediff-current-diff-overlay-alist
816 '((A . ediff-current-diff-overlay-A)
817 (B . ediff-current-diff-overlay-B)
818 (C . ediff-current-diff-overlay-C)
819 (Ancestor . ediff-current-diff-overlay-Ancestor)))
820
821 ;; A-list of current-diff-face-* symbols associated with buf types
822 (defconst ediff-current-diff-face-alist
823 '((A . ediff-current-diff-A)
824 (B . ediff-current-diff-B)
825 (C . ediff-current-diff-C)
826 (Ancestor . ediff-current-diff-Ancestor)))
827
828
829 (defun ediff-set-overlay-face (extent face)
830 (ediff-overlay-put extent 'face face)
831 (ediff-overlay-put extent 'help-echo 'ediff-region-help-echo))
832
833 (defun ediff-region-help-echo (extent-or-window &optional overlay point)
834 (unless overlay
835 (setq overlay extent-or-window))
836 (let ((is-current (ediff-overlay-get overlay 'ediff))
837 (face (ediff-overlay-get overlay 'face))
838 (diff-num (ediff-overlay-get overlay 'ediff-diff-num))
839 face-help)
840
841 ;; This happens only for refinement overlays
842 (if (stringp face)
843 (setq face (intern face)))
844 (setq face-help (and face (get face 'ediff-help-echo)))
845
846 (cond ((and is-current diff-num) ; current diff region
847 (format "Difference region %S -- current" (1+ diff-num)))
848 (face-help) ; refinement of current diff region
849 (diff-num ; non-current
850 (format "Difference region %S -- non-current" (1+ diff-num)))
851 (t "")) ; none
852 ))
853
854
855 (defun ediff-set-face-pixmap (face pixmap)
856 "Set face pixmap on a monochrome display."
857 (if (and (ediff-window-display-p) (not (ediff-color-display-p)))
858 (condition-case nil
859 (set-face-background-pixmap face pixmap)
860 (error
861 (message "Pixmap not found for %S: %s" (face-name face) pixmap)
862 (sit-for 1)))))
863
864 (defun ediff-hide-face (face)
865 (if (and (ediff-has-face-support-p)
866 (boundp 'add-to-list)
867 (boundp 'facemenu-unlisted-faces))
868 (add-to-list 'facemenu-unlisted-faces face)))
869
870
871
872 (defface ediff-current-diff-A
873 (if (featurep 'emacs)
874 '((((class color) (min-colors 16))
875 (:foreground "firebrick" :background "pale green"))
876 (((class color))
877 (:foreground "blue3" :background "yellow3"))
878 (t (:inverse-video t)))
879 '((((type tty)) (:foreground "blue3" :background "yellow3"))
880 (((class color)) (:foreground "firebrick" :background "pale green"))
881 (t (:inverse-video t))))
882 "Face for highlighting the selected difference in buffer A."
883 :group 'ediff-highlighting)
884 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
885 ;; this variable is set to nil, then again to the appropriate face.
886 (defvar ediff-current-diff-face-A 'ediff-current-diff-A
887 "Face for highlighting the selected difference in buffer A.
888 DO NOT CHANGE this variable. Instead, use the customization
889 widget to customize the actual face object `ediff-current-diff-A'
890 this variable represents.")
891 (ediff-hide-face ediff-current-diff-face-A)
892 ;; Until custom.el for XEmacs starts supporting :inverse-video we do this.
893 ;; This means that some user customization may be trashed.
894 (and (featurep 'xemacs)
895 (ediff-has-face-support-p)
896 (not (ediff-color-display-p))
897 (copy-face 'modeline ediff-current-diff-face-A))
898
899
900
901 (defface ediff-current-diff-B
902 (if (featurep 'emacs)
903 '((((class color) (min-colors 16))
904 (:foreground "DarkOrchid" :background "Yellow"))
905 (((class color))
906 (:foreground "magenta3" :background "yellow3"
907 :weight bold))
908 (t (:inverse-video t)))
909 '((((type tty)) (:foreground "magenta3" :background "yellow3"
910 :weight bold))
911 (((class color)) (:foreground "DarkOrchid" :background "Yellow"))
912 (t (:inverse-video t))))
913 "Face for highlighting the selected difference in buffer B."
914 :group 'ediff-highlighting)
915 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
916 ;; this variable is set to nil, then again to the appropriate face.
917 (defvar ediff-current-diff-face-B 'ediff-current-diff-B
918 "Face for highlighting the selected difference in buffer B.
919 this variable. Instead, use the customization
920 widget to customize the actual face `ediff-current-diff-B'
921 this variable represents.")
922 (ediff-hide-face ediff-current-diff-face-B)
923 ;; Until custom.el for XEmacs starts supporting :inverse-video we do this.
924 ;; This means that some user customization may be trashed.
925 (and (featurep 'xemacs)
926 (ediff-has-face-support-p)
927 (not (ediff-color-display-p))
928 (copy-face 'modeline ediff-current-diff-face-B))
929
930
931 (defface ediff-current-diff-C
932 (if (featurep 'emacs)
933 '((((class color) (min-colors 16))
934 (:foreground "Navy" :background "Pink"))
935 (((class color))
936 (:foreground "cyan3" :background "yellow3" :weight bold))
937 (t (:inverse-video t)))
938 '((((type tty)) (:foreground "cyan3" :background "yellow3" :weight bold))
939 (((class color)) (:foreground "Navy" :background "Pink"))
940 (t (:inverse-video t))))
941 "Face for highlighting the selected difference in buffer C."
942 :group 'ediff-highlighting)
943 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
944 ;; this variable is set to nil, then again to the appropriate face.
945 (defvar ediff-current-diff-face-C 'ediff-current-diff-C
946 "Face for highlighting the selected difference in buffer C.
947 DO NOT CHANGE this variable. Instead, use the customization
948 widget to customize the actual face object `ediff-current-diff-C'
949 this variable represents.")
950 (ediff-hide-face ediff-current-diff-face-C)
951 ;; Until custom.el for XEmacs starts supporting :inverse-video we do this.
952 ;; This means that some user customization may be trashed.
953 (and (featurep 'xemacs)
954 (ediff-has-face-support-p)
955 (not (ediff-color-display-p))
956 (copy-face 'modeline ediff-current-diff-face-C))
957
958
959 (defface ediff-current-diff-Ancestor
960 (if (featurep 'emacs)
961 '((((class color) (min-colors 16))
962 (:foreground "Black" :background "VioletRed"))
963 (((class color))
964 (:foreground "black" :background "magenta3"))
965 (t (:inverse-video t)))
966 '((((type tty)) (:foreground "black" :background "magenta3"))
967 (((class color)) (:foreground "Black" :background "VioletRed"))
968 (t (:inverse-video t))))
969 "Face for highlighting the selected difference in buffer Ancestor."
970 :group 'ediff-highlighting)
971 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
972 ;; this variable is set to nil, then again to the appropriate face.
973 (defvar ediff-current-diff-face-Ancestor 'ediff-current-diff-Ancestor
974 "Face for highlighting the selected difference in buffer Ancestor.
975 DO NOT CHANGE this variable. Instead, use the customization
976 widget to customize the actual face object `ediff-current-diff-Ancestor'
977 this variable represents.")
978 (ediff-hide-face ediff-current-diff-face-Ancestor)
979 ;; Until custom.el for XEmacs starts supporting :inverse-video we do this.
980 ;; This means that some user customization may be trashed.
981 (and (featurep 'xemacs)
982 (ediff-has-face-support-p)
983 (not (ediff-color-display-p))
984 (copy-face 'modeline ediff-current-diff-face-Ancestor))
985
986
987 (defface ediff-fine-diff-A
988 (if (featurep 'emacs)
989 '((((class color) (min-colors 16))
990 (:foreground "Navy" :background "sky blue"))
991 (((class color))
992 (:foreground "white" :background "sky blue" :weight bold))
993 (t (:underline t :stipple "gray3")))
994 '((((type tty)) (:foreground "white" :background "sky blue" :weight bold))
995 (((class color)) (:foreground "Navy" :background "sky blue"))
996 (t (:underline t :stipple "gray3"))))
997 "Face for highlighting the refinement of the selected diff in buffer A."
998 :group 'ediff-highlighting)
999 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
1000 ;; this variable is set to nil, then again to the appropriate face.
1001 (defvar ediff-fine-diff-face-A 'ediff-fine-diff-A
1002 "Face for highlighting the fine differences in buffer A.
1003 DO NOT CHANGE this variable. Instead, use the customization
1004 widget to customize the actual face object `ediff-fine-diff-A'
1005 this variable represents.")
1006 (ediff-hide-face ediff-fine-diff-face-A)
1007
1008 (defface ediff-fine-diff-B
1009 (if (featurep 'emacs)
1010 '((((class color) (min-colors 16))
1011 (:foreground "Black" :background "cyan"))
1012 (((class color))
1013 (:foreground "magenta3" :background "cyan3"))
1014 (t (:underline t :stipple "gray3")))
1015 '((((type tty)) (:foreground "magenta3" :background "cyan3"))
1016 (((class color)) (:foreground "Black" :background "cyan"))
1017 (t (:underline t :stipple "gray3"))))
1018 "Face for highlighting the refinement of the selected diff in buffer B."
1019 :group 'ediff-highlighting)
1020 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
1021 ;; this variable is set to nil, then again to the appropriate face.
1022 (defvar ediff-fine-diff-face-B 'ediff-fine-diff-B
1023 "Face for highlighting the fine differences in buffer B.
1024 DO NOT CHANGE this variable. Instead, use the customization
1025 widget to customize the actual face object `ediff-fine-diff-B'
1026 this variable represents.")
1027 (ediff-hide-face ediff-fine-diff-face-B)
1028
1029 (defface ediff-fine-diff-C
1030 (if (featurep 'emacs)
1031 '((((type pc))
1032 (:foreground "white" :background "Turquoise"))
1033 (((class color) (min-colors 16))
1034 (:foreground "Black" :background "Turquoise"))
1035 (((class color))
1036 (:foreground "yellow3" :background "Turquoise"
1037 :weight bold))
1038 (t (:underline t :stipple "gray3")))
1039 '((((type tty)) (:foreground "yellow3" :background "Turquoise"
1040 :weight bold))
1041 (((type pc)) (:foreground "white" :background "Turquoise"))
1042 (((class color)) (:foreground "Black" :background "Turquoise"))
1043 (t (:underline t :stipple "gray3"))))
1044 "Face for highlighting the refinement of the selected diff in buffer C."
1045 :group 'ediff-highlighting)
1046 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
1047 ;; this variable is set to nil, then again to the appropriate face.
1048 (defvar ediff-fine-diff-face-C 'ediff-fine-diff-C
1049 "Face for highlighting the fine differences in buffer C.
1050 DO NOT CHANGE this variable. Instead, use the customization
1051 widget to customize the actual face object `ediff-fine-diff-C'
1052 this variable represents.")
1053 (ediff-hide-face ediff-fine-diff-face-C)
1054
1055 (defface ediff-fine-diff-Ancestor
1056 (if (featurep 'emacs)
1057 '((((class color) (min-colors 16))
1058 (:foreground "Black" :background "Green"))
1059 (((class color))
1060 (:foreground "red3" :background "green"))
1061 (t (:underline t :stipple "gray3")))
1062 '((((type tty)) (:foreground "red3" :background "green"))
1063 (((class color)) (:foreground "Black" :background "Green"))
1064 (t (:underline t :stipple "gray3"))))
1065 "Face for highlighting the refinement of the selected diff in the ancestor buffer.
1066 At present, this face is not used and no fine differences are computed for the
1067 ancestor buffer."
1068 :group 'ediff-highlighting)
1069 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
1070 ;; this variable is set to nil, then again to the appropriate face.
1071 (defvar ediff-fine-diff-face-Ancestor 'ediff-fine-diff-Ancestor
1072 "Face for highlighting the fine differences in buffer Ancestor.
1073 DO NOT CHANGE this variable. Instead, use the customization
1074 widget to customize the actual face object `ediff-fine-diff-Ancestor'
1075 this variable represents.")
1076 (ediff-hide-face ediff-fine-diff-face-Ancestor)
1077
1078 ;; Some installs don't have stipple or Stipple. So, try them in turn.
1079 (defvar stipple-pixmap
1080 (cond ((not (ediff-has-face-support-p)) nil)
1081 ((and (boundp 'x-bitmap-file-path)
1082 (locate-library "stipple" t x-bitmap-file-path)) "stipple")
1083 ((and (boundp 'mswindowsx-bitmap-file-path)
1084 (locate-library "stipple" t mswindowsx-bitmap-file-path)) "stipple")
1085 (t "Stipple")))
1086
1087 (defface ediff-even-diff-A
1088 (if (featurep 'emacs)
1089 `((((type pc))
1090 (:foreground "green3" :background "light grey"))
1091 (((class color) (min-colors 16))
1092 (:foreground "Black" :background "light grey"))
1093 (((class color))
1094 (:foreground "red3" :background "light grey"
1095 :weight bold))
1096 (t (:italic t :stipple ,stipple-pixmap)))
1097 `((((type tty)) (:foreground "red3" :background "light grey"
1098 :weight bold))
1099 (((type pc)) (:foreground "green3" :background "light grey"))
1100 (((class color)) (:foreground "Black" :background "light grey"))
1101 (t (:italic t :stipple ,stipple-pixmap))))
1102 "Face for highlighting even-numbered non-current differences in buffer A."
1103 :group 'ediff-highlighting)
1104 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
1105 ;; this variable is set to nil, then again to the appropriate face.
1106 (defvar ediff-even-diff-face-A 'ediff-even-diff-A
1107 "Face for highlighting even-numbered non-current differences in buffer A.
1108 DO NOT CHANGE this variable. Instead, use the customization
1109 widget to customize the actual face object `ediff-even-diff-A'
1110 this variable represents.")
1111 (ediff-hide-face ediff-even-diff-face-A)
1112
1113 (defface ediff-even-diff-B
1114 (if (featurep 'emacs)
1115 `((((class color) (min-colors 16))
1116 (:foreground "White" :background "Grey"))
1117 (((class color))
1118 (:foreground "blue3" :background "Grey" :weight bold))
1119 (t (:italic t :stipple ,stipple-pixmap)))
1120 `((((type tty)) (:foreground "blue3" :background "Grey" :weight bold))
1121 (((class color)) (:foreground "White" :background "Grey"))
1122 (t (:italic t :stipple ,stipple-pixmap))))
1123 "Face for highlighting even-numbered non-current differences in buffer B."
1124 :group 'ediff-highlighting)
1125 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
1126 ;; this variable is set to nil, then again to the appropriate face.
1127 (defvar ediff-even-diff-face-B 'ediff-even-diff-B
1128 "Face for highlighting even-numbered non-current differences in buffer B.
1129 DO NOT CHANGE this variable. Instead, use the customization
1130 widget to customize the actual face object `ediff-even-diff-B'
1131 this variable represents.")
1132 (ediff-hide-face ediff-even-diff-face-B)
1133
1134 (defface ediff-even-diff-C
1135 (if (featurep 'emacs)
1136 `((((type pc))
1137 (:foreground "yellow3" :background "light grey"))
1138 (((class color) (min-colors 16))
1139 (:foreground "Black" :background "light grey"))
1140 (((class color))
1141 (:foreground "yellow3" :background "light grey"
1142 :weight bold))
1143 (t (:italic t :stipple ,stipple-pixmap)))
1144 `((((type tty)) (:foreground "yellow3" :background "light grey"
1145 :weight bold))
1146 (((type pc)) (:foreground "yellow3" :background "light grey"))
1147 (((class color)) (:foreground "Black" :background "light grey"))
1148 (t (:italic t :stipple ,stipple-pixmap))))
1149 "Face for highlighting even-numbered non-current differences in buffer C."
1150 :group 'ediff-highlighting)
1151 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
1152 ;; this variable is set to nil, then again to the appropriate face.
1153 (defvar ediff-even-diff-face-C 'ediff-even-diff-C
1154 "Face for highlighting even-numbered non-current differences in buffer C.
1155 DO NOT CHANGE this variable. Instead, use the customization
1156 widget to customize the actual face object `ediff-even-diff-C'
1157 this variable represents.")
1158 (ediff-hide-face ediff-even-diff-face-C)
1159
1160 (defface ediff-even-diff-Ancestor
1161 (if (featurep 'emacs)
1162 `((((type pc))
1163 (:foreground "cyan3" :background "light grey"))
1164 (((class color) (min-colors 16))
1165 (:foreground "White" :background "Grey"))
1166 (((class color))
1167 (:foreground "cyan3" :background "light grey"
1168 :weight bold))
1169 (t (:italic t :stipple ,stipple-pixmap)))
1170 `((((type tty)) (:foreground "cyan3" :background "light grey"
1171 :weight bold))
1172 (((type pc)) (:foreground "cyan3" :background "light grey"))
1173 (((class color)) (:foreground "White" :background "Grey"))
1174 (t (:italic t :stipple ,stipple-pixmap))))
1175 "Face for highlighting even-numbered non-current differences in the ancestor buffer."
1176 :group 'ediff-highlighting)
1177 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
1178 ;; this variable is set to nil, then again to the appropriate face.
1179 (defvar ediff-even-diff-face-Ancestor 'ediff-even-diff-Ancestor
1180 "Face for highlighting even-numbered non-current differences in buffer Ancestor.
1181 DO NOT CHANGE this variable. Instead, use the customization
1182 widget to customize the actual face object `ediff-even-diff-Ancestor'
1183 this variable represents.")
1184 (ediff-hide-face ediff-even-diff-face-Ancestor)
1185
1186 ;; Association between buffer types and even-diff-face symbols
1187 (defconst ediff-even-diff-face-alist
1188 '((A . ediff-even-diff-A)
1189 (B . ediff-even-diff-B)
1190 (C . ediff-even-diff-C)
1191 (Ancestor . ediff-even-diff-Ancestor)))
1192
1193 (defface ediff-odd-diff-A
1194 (if (featurep 'emacs)
1195 '((((type pc))
1196 (:foreground "green3" :background "gray40"))
1197 (((class color) (min-colors 16))
1198 (:foreground "White" :background "Grey"))
1199 (((class color))
1200 (:foreground "red3" :background "black" :weight bold))
1201 (t (:italic t :stipple "gray1")))
1202 '((((type tty)) (:foreground "red3" :background "black" :weight bold))
1203 (((type pc)) (:foreground "green3" :background "gray40"))
1204 (((class color)) (:foreground "White" :background "Grey"))
1205 (t (:italic t :stipple "gray1"))))
1206 "Face for highlighting odd-numbered non-current differences in buffer A."
1207 :group 'ediff-highlighting)
1208 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
1209 ;; this variable is set to nil, then again to the appropriate face.
1210 (defvar ediff-odd-diff-face-A 'ediff-odd-diff-A
1211 "Face for highlighting odd-numbered non-current differences in buffer A.
1212 DO NOT CHANGE this variable. Instead, use the customization
1213 widget to customize the actual face object `ediff-odd-diff-A'
1214 this variable represents.")
1215 (ediff-hide-face ediff-odd-diff-face-A)
1216
1217
1218 (defface ediff-odd-diff-B
1219 (if (featurep 'emacs)
1220 '((((type pc))
1221 (:foreground "White" :background "gray40"))
1222 (((class color) (min-colors 16))
1223 (:foreground "Black" :background "light grey"))
1224 (((class color))
1225 (:foreground "cyan3" :background "black" :weight bold))
1226 (t (:italic t :stipple "gray1")))
1227 '((((type tty)) (:foreground "cyan3" :background "black" :weight bold))
1228 (((type pc)) (:foreground "White" :background "gray40"))
1229 (((class color)) (:foreground "Black" :background "light grey"))
1230 (t (:italic t :stipple "gray1"))))
1231 "Face for highlighting odd-numbered non-current differences in buffer B."
1232 :group 'ediff-highlighting)
1233 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
1234 ;; this variable is set to nil, then again to the appropriate face.
1235 (defvar ediff-odd-diff-face-B 'ediff-odd-diff-B
1236 "Face for highlighting odd-numbered non-current differences in buffer B.
1237 DO NOT CHANGE this variable. Instead, use the customization
1238 widget to customize the actual face object `ediff-odd-diff-B'
1239 this variable represents.")
1240 (ediff-hide-face ediff-odd-diff-face-B)
1241
1242 (defface ediff-odd-diff-C
1243 (if (featurep 'emacs)
1244 '((((type pc))
1245 (:foreground "yellow3" :background "gray40"))
1246 (((class color) (min-colors 16))
1247 (:foreground "White" :background "Grey"))
1248 (((class color))
1249 (:foreground "yellow3" :background "black" :weight bold))
1250 (t (:italic t :stipple "gray1")))
1251 '((((type tty)) (:foreground "yellow3" :background "black" :weight bold))
1252 (((type pc)) (:foreground "yellow3" :background "gray40"))
1253 (((class color)) (:foreground "White" :background "Grey"))
1254 (t (:italic t :stipple "gray1"))))
1255 "Face for highlighting odd-numbered non-current differences in buffer C."
1256 :group 'ediff-highlighting)
1257 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
1258 ;; this variable is set to nil, then again to the appropriate face.
1259 (defvar ediff-odd-diff-face-C 'ediff-odd-diff-C
1260 "Face for highlighting odd-numbered non-current differences in buffer C.
1261 DO NOT CHANGE this variable. Instead, use the customization
1262 widget to customize the actual face object `ediff-odd-diff-C'
1263 this variable represents.")
1264 (ediff-hide-face ediff-odd-diff-face-C)
1265
1266 (defface ediff-odd-diff-Ancestor
1267 (if (featurep 'emacs)
1268 '((((class color) (min-colors 16))
1269 (:foreground "cyan3" :background "gray40"))
1270 (((class color))
1271 (:foreground "green3" :background "black" :weight bold))
1272 (t (:italic t :stipple "gray1")))
1273 '((((type tty)) (:foreground "green3" :background "black" :weight bold))
1274 (((class color)) (:foreground "cyan3" :background "gray40"))
1275 (t (:italic t :stipple "gray1"))))
1276 "Face for highlighting odd-numbered non-current differences in the ancestor buffer."
1277 :group 'ediff-highlighting)
1278 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
1279 ;; this variable is set to nil, then again to the appropriate face.
1280 (defvar ediff-odd-diff-face-Ancestor 'ediff-odd-diff-Ancestor
1281 "Face for highlighting odd-numbered non-current differences in buffer Ancestor.
1282 DO NOT CHANGE this variable. Instead, use the customization
1283 widget to customize the actual face object `ediff-odd-diff-Ancestor'
1284 this variable represents.")
1285 (ediff-hide-face ediff-odd-diff-face-Ancestor)
1286
1287 ;; Association between buffer types and odd-diff-face symbols
1288 (defconst ediff-odd-diff-face-alist
1289 '((A . ediff-odd-diff-A)
1290 (B . ediff-odd-diff-B)
1291 (C . ediff-odd-diff-C)
1292 (Ancestor . ediff-odd-diff-Ancestor)))
1293
1294 ;; A-list of fine-diff face symbols associated with buffer types
1295 (defconst ediff-fine-diff-face-alist
1296 '((A . ediff-fine-diff-A)
1297 (B . ediff-fine-diff-B)
1298 (C . ediff-fine-diff-C)
1299 (Ancestor . ediff-fine-diff-Ancestor)))
1300
1301 ;; Help echo
1302 (put ediff-fine-diff-face-A 'ediff-help-echo
1303 "A `refinement' of the current difference region")
1304 (put ediff-fine-diff-face-B 'ediff-help-echo
1305 "A `refinement' of the current difference region")
1306 (put ediff-fine-diff-face-C 'ediff-help-echo
1307 "A `refinement' of the current difference region")
1308 (put ediff-fine-diff-face-Ancestor 'ediff-help-echo
1309 "A `refinement' of the current difference region")
1310
1311 (add-hook 'ediff-quit-hook 'ediff-cleanup-mess)
1312 (add-hook 'ediff-suspend-hook 'ediff-default-suspend-function)
1313
1314
1315 ;;; Overlays
1316
1317 (ediff-defvar-local ediff-current-diff-overlay-A nil
1318 "Overlay for the current difference region in buffer A.")
1319 (ediff-defvar-local ediff-current-diff-overlay-B nil
1320 "Overlay for the current difference region in buffer B.")
1321 (ediff-defvar-local ediff-current-diff-overlay-C nil
1322 "Overlay for the current difference region in buffer C.")
1323 (ediff-defvar-local ediff-current-diff-overlay-Ancestor nil
1324 "Overlay for the current difference region in the ancestor buffer.")
1325
1326 ;; Compute priority of a current ediff overlay.
1327 (defun ediff-highest-priority (start end buffer)
1328 (let ((pos (max 1 (1- start)))
1329 ovr-list)
1330 (if (featurep 'xemacs)
1331 (1+ ediff-shadow-overlay-priority)
1332 (ediff-with-current-buffer buffer
1333 (while (< pos (min (point-max) (1+ end)))
1334 (setq ovr-list (append (overlays-at pos) ovr-list))
1335 (setq pos (next-overlay-change pos)))
1336 (+ 1 ediff-shadow-overlay-priority
1337 (apply 'max
1338 (cons
1339 1
1340 (mapcar
1341 (lambda (ovr)
1342 (if (and ovr
1343 ;; exclude ediff overlays from priority
1344 ;; calculation, or else priority will keep
1345 ;; increasing
1346 (null (ediff-overlay-get ovr 'ediff))
1347 (null (ediff-overlay-get ovr 'ediff-diff-num)))
1348 ;; use the overlay priority or 0
1349 (or (ediff-overlay-get ovr 'priority) 0)
1350 0))
1351 ovr-list))))))))
1352
1353
1354 (defvar ediff-toggle-read-only-function nil
1355 "*Specifies the function to be used to toggle read-only.
1356 If nil, Ediff tries to deduce the function from the binding of C-x C-q.
1357 Normally, this is the `toggle-read-only' function, but, if version
1358 control is used, it could be `vc-toggle-read-only' or `rcs-toggle-read-only'.")
1359
1360 (defcustom ediff-make-buffers-readonly-at-startup nil
1361 "Make all variant buffers read-only when Ediff starts up.
1362 This property can be toggled interactively."
1363 :type 'boolean
1364 :group 'ediff)
1365
1366
1367 ;;; Misc
1368
1369 ;; if nil, this silences some messages
1370 (defvar ediff-verbose-p t)
1371
1372 (defcustom ediff-autostore-merges 'group-jobs-only
1373 "Save the results of merge jobs automatically.
1374 With value nil, don't save automatically. With value t, always
1375 save. Anything else means save automatically only if the merge
1376 job is part of a group of jobs, such as `ediff-merge-directory'
1377 or `ediff-merge-directory-revisions'."
1378 :type '(choice (const nil) (const t) (const group-jobs-only))
1379 :group 'ediff-merge)
1380 (make-variable-buffer-local 'ediff-autostore-merges)
1381
1382 ;; file where the result of the merge is to be saved. used internally
1383 (ediff-defvar-local ediff-merge-store-file nil "")
1384
1385 (defcustom ediff-merge-filename-prefix "merge_"
1386 "Prefix to be attached to saved merge buffers."
1387 :type 'string
1388 :group 'ediff-merge)
1389
1390 (defcustom ediff-no-emacs-help-in-control-buffer nil
1391 "Non-nil means C-h should not invoke Emacs help in control buffer.
1392 Instead, C-h would jump to previous difference."
1393 :type 'boolean
1394 :group 'ediff)
1395
1396 ;; This is the same as temporary-file-directory from Emacs 20.3.
1397 ;; Copied over here because XEmacs doesn't have this variable.
1398 (defcustom ediff-temp-file-prefix
1399 (file-name-as-directory
1400 (cond ((boundp 'temporary-file-directory) temporary-file-directory)
1401 ((fboundp 'temp-directory) (temp-directory))
1402 (t "/tmp/")))
1403 ;;; (file-name-as-directory
1404 ;;; (cond ((memq system-type '(ms-dos windows-nt))
1405 ;;; (or (getenv "TEMP") (getenv "TMPDIR") (getenv "TMP") "c:/temp"))
1406 ;;; (t
1407 ;;; (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "/tmp"))))
1408 "Prefix to put on Ediff temporary file names.
1409 Do not start with `~/' or `~USERNAME/'."
1410 :type 'string
1411 :group 'ediff)
1412
1413 (defcustom ediff-temp-file-mode 384 ; u=rw only
1414 "Mode for Ediff temporary files."
1415 :type 'integer
1416 :group 'ediff)
1417
1418 ;; Metacharacters that have to be protected from the shell when executing
1419 ;; a diff/diff3 command.
1420 (defcustom ediff-metachars "[ \t\n!\"#$&'()*;<=>?[\\^`{|~]"
1421 "Regexp that matches characters that must be quoted with `\\' in shell command line.
1422 This default should work without changes."
1423 :type 'string
1424 :group 'ediff)
1425
1426 ;; needed to simulate frame-char-width in XEmacs.
1427 (defvar ediff-H-glyph (if (featurep 'xemacs) (make-glyph "H")))
1428
1429
1430 ;; Temporary file used for refining difference regions in buffer A.
1431 (ediff-defvar-local ediff-temp-file-A nil "")
1432 ;; Temporary file used for refining difference regions in buffer B.
1433 (ediff-defvar-local ediff-temp-file-B nil "")
1434 ;; Temporary file used for refining difference regions in buffer C.
1435 (ediff-defvar-local ediff-temp-file-C nil "")
1436
1437
1438 (defun ediff-file-remote-p (file-name)
1439 (file-remote-p file-name))
1440
1441 ;; File for which we can get attributes, such as size or date
1442 (defun ediff-listable-file (file-name)
1443 (let ((handler (find-file-name-handler file-name 'file-local-copy)))
1444 (or (null handler) (eq handler 'dired-handler-fn))))
1445
1446
1447 (defsubst ediff-frame-unsplittable-p (frame)
1448 (cdr (assq 'unsplittable (frame-parameters frame))))
1449
1450 (defsubst ediff-get-next-window (wind prev-wind)
1451 (cond ((window-live-p wind) wind)
1452 (prev-wind (next-window wind))
1453 (t (selected-window))
1454 ))
1455
1456
1457 (defsubst ediff-kill-buffer-carefully (buf)
1458 "Kill buffer BUF if it exists."
1459 (if (ediff-buffer-live-p buf)
1460 (kill-buffer (get-buffer buf))))
1461
1462 (defsubst ediff-background-face (buf-type dif-num)
1463 ;; The value of dif-num is always 1- the one that user sees.
1464 ;; This is why even face is used when dif-num is odd.
1465 (ediff-get-symbol-from-alist
1466 buf-type (if (ediff-odd-p dif-num)
1467 ediff-even-diff-face-alist
1468 ediff-odd-diff-face-alist)
1469 ))
1470
1471
1472 ;; activate faces on diff regions in buffer
1473 (defun ediff-paint-background-regions-in-one-buffer (buf-type unhighlight)
1474 (let ((diff-vector
1475 (eval (ediff-get-symbol-from-alist
1476 buf-type ediff-difference-vector-alist)))
1477 overl diff-num)
1478 (mapcar (lambda (rec)
1479 (setq overl (ediff-get-diff-overlay-from-diff-record rec)
1480 diff-num (ediff-overlay-get overl 'ediff-diff-num))
1481 (if (ediff-overlay-buffer overl)
1482 ;; only if overlay is alive
1483 (ediff-set-overlay-face
1484 overl
1485 (if (not unhighlight)
1486 (ediff-background-face buf-type diff-num))))
1487 )
1488 diff-vector)))
1489
1490
1491 ;; activate faces on diff regions in all buffers
1492 (defun ediff-paint-background-regions (&optional unhighlight)
1493 (ediff-paint-background-regions-in-one-buffer
1494 'A unhighlight)
1495 (ediff-paint-background-regions-in-one-buffer
1496 'B unhighlight)
1497 (ediff-paint-background-regions-in-one-buffer
1498 'C unhighlight)
1499 (ediff-paint-background-regions-in-one-buffer
1500 'Ancestor unhighlight))
1501
1502
1503 ;; arg is a record for a given diff in a difference vector
1504 ;; this record is itself a vector
1505 (defsubst ediff-clear-fine-diff-vector (diff-record)
1506 (if diff-record
1507 (mapc 'ediff-delete-overlay
1508 (ediff-get-fine-diff-vector-from-diff-record diff-record))))
1509
1510 (defsubst ediff-clear-fine-differences-in-one-buffer (n buf-type)
1511 (ediff-clear-fine-diff-vector (ediff-get-difference n buf-type))
1512 (ediff-set-fine-diff-vector n buf-type nil))
1513
1514 (defsubst ediff-clear-fine-differences (n)
1515 (ediff-clear-fine-differences-in-one-buffer n 'A)
1516 (ediff-clear-fine-differences-in-one-buffer n 'B)
1517 (if ediff-3way-job
1518 (ediff-clear-fine-differences-in-one-buffer n 'C)))
1519
1520
1521 (defsubst ediff-mouse-event-p (event)
1522 (if (featurep 'xemacs)
1523 (button-event-p event)
1524 (string-match "mouse" (format "%S" (event-basic-type event)))))
1525
1526
1527 (defsubst ediff-key-press-event-p (event)
1528 (if (featurep 'xemacs)
1529 (key-press-event-p event)
1530 (or (char-or-string-p event) (symbolp event))))
1531
1532 (defun ediff-event-point (event)
1533 (cond ((ediff-mouse-event-p event)
1534 (if (featurep 'xemacs)
1535 (event-point event)
1536 (posn-point (event-start event))))
1537 ((ediff-key-press-event-p event)
1538 (point))
1539 (t (error "Error"))))
1540
1541 (defun ediff-event-buffer (event)
1542 (cond ((ediff-mouse-event-p event)
1543 (if (featurep 'xemacs)
1544 (event-buffer event)
1545 (window-buffer (posn-window (event-start event)))))
1546 ((ediff-key-press-event-p event)
1547 (current-buffer))
1548 (t (error "Error"))))
1549
1550 (defun ediff-event-key (event-or-key)
1551 (if (featurep 'xemacs)
1552 ;;(if (eventp event-or-key) (event-key event-or-key) event-or-key)
1553 (if (eventp event-or-key) (event-to-character event-or-key t t) event-or-key)
1554 event-or-key))
1555
1556 (defun ediff-last-command-char ()
1557 (ediff-event-key last-command-event))
1558
1559
1560 (defsubst ediff-frame-iconified-p (frame)
1561 (and (ediff-window-display-p) (frame-live-p frame)
1562 (if (featurep 'xemacs)
1563 (frame-iconified-p frame)
1564 (eq (frame-visible-p frame) 'icon))))
1565
1566 (defsubst ediff-window-visible-p (wind)
1567 ;; under TTY, window-live-p also means window is visible
1568 (and (window-live-p wind)
1569 (or (not (ediff-window-display-p))
1570 (frame-visible-p (window-frame wind)))))
1571
1572
1573 (defsubst ediff-frame-char-width (frame)
1574 (if (featurep 'xemacs)
1575 (/ (frame-pixel-width frame) (frame-width frame))
1576 (frame-char-width frame)))
1577
1578 (defun ediff-reset-mouse (&optional frame do-not-grab-mouse)
1579 (or frame (setq frame (selected-frame)))
1580 (if (ediff-window-display-p)
1581 (let ((frame-or-wind frame))
1582 (if (featurep 'xemacs)
1583 (setq frame-or-wind (frame-selected-window frame)))
1584 (or do-not-grab-mouse
1585 ;; don't set mouse if the user said to never do this
1586 (not ediff-grab-mouse)
1587 ;; Don't grab on quit, if the user doesn't want to.
1588 ;; If ediff-grab-mouse = t, then mouse won't be grabbed for
1589 ;; sessions that are not part of a group (this is done in
1590 ;; ediff-recenter). The condition below affects only terminating
1591 ;; sessions in session groups (in which case mouse is warped into
1592 ;; a meta buffer).
1593 (and (eq ediff-grab-mouse 'maybe)
1594 (memq this-command '(ediff-quit ediff-update-diffs)))
1595 (set-mouse-position frame-or-wind 1 0))
1596 )))
1597
1598 (defsubst ediff-spy-after-mouse ()
1599 (setq ediff-mouse-pixel-position (mouse-pixel-position)))
1600
1601 ;; It is not easy to find out when the user grabs the mouse, since emacs and
1602 ;; xemacs behave differently when mouse is not in any frame. Also, this is
1603 ;; sensitive to when the user grabbed mouse. Not used for now.
1604 (defun ediff-user-grabbed-mouse ()
1605 (if ediff-mouse-pixel-position
1606 (cond ((not (eq (car ediff-mouse-pixel-position)
1607 (car (mouse-pixel-position)))))
1608 ((and (car (cdr ediff-mouse-pixel-position))
1609 (car (cdr (mouse-pixel-position)))
1610 (cdr (cdr ediff-mouse-pixel-position))
1611 (cdr (cdr (mouse-pixel-position))))
1612 (not (and (< (abs (- (car (cdr ediff-mouse-pixel-position))
1613 (car (cdr (mouse-pixel-position)))))
1614 ediff-mouse-pixel-threshold)
1615 (< (abs (- (cdr (cdr ediff-mouse-pixel-position))
1616 (cdr (cdr (mouse-pixel-position)))))
1617 ediff-mouse-pixel-threshold))))
1618 (t nil))))
1619
1620 (defsubst ediff-frame-char-height (frame)
1621 (if (featurep 'xemacs)
1622 (glyph-height ediff-H-glyph (frame-selected-window frame))
1623 (frame-char-height frame)))
1624
1625 ;; Some overlay functions
1626
1627 (defsubst ediff-overlay-start (overl)
1628 (if (ediff-overlayp overl)
1629 (if (featurep 'xemacs)
1630 (extent-start-position overl)
1631 (overlay-start overl))))
1632
1633 (defsubst ediff-overlay-end (overl)
1634 (if (ediff-overlayp overl)
1635 (if (featurep 'xemacs)
1636 (extent-end-position overl)
1637 (overlay-end overl))))
1638
1639 (defsubst ediff-empty-overlay-p (overl)
1640 (= (ediff-overlay-start overl) (ediff-overlay-end overl)))
1641
1642 ;; like overlay-buffer in Emacs. In XEmacs, returns nil if the extent is
1643 ;; dead. Otherwise, works like extent-buffer
1644 (defun ediff-overlay-buffer (overl)
1645 (if (featurep 'xemacs)
1646 (and (extent-live-p overl) (extent-object overl))
1647 (overlay-buffer overl)))
1648
1649 ;; like overlay-get in Emacs. In XEmacs, returns nil if the extent is
1650 ;; dead. Otherwise, like extent-property
1651 (defun ediff-overlay-get (overl property)
1652 (if (featurep 'xemacs)
1653 (and (extent-live-p overl) (extent-property overl property))
1654 (overlay-get overl property)))
1655
1656
1657 ;; These two functions are here because XEmacs refuses to
1658 ;; handle overlays whose buffers were deleted.
1659 (defun ediff-move-overlay (overlay beg end &optional buffer)
1660 "Calls `move-overlay' in Emacs and `set-extent-endpoints' in Lemacs.
1661 Checks if overlay's buffer exists before actually doing the move."
1662 (let ((buf (and overlay (ediff-overlay-buffer overlay))))
1663 (if (ediff-buffer-live-p buf)
1664 (if (featurep 'xemacs)
1665 (set-extent-endpoints overlay beg end)
1666 (move-overlay overlay beg end buffer))
1667 ;; buffer's dead
1668 (if overlay
1669 (ediff-delete-overlay overlay)))))
1670
1671 (defun ediff-overlay-put (overlay prop value)
1672 "Calls `overlay-put' or `set-extent-property' depending on Emacs version.
1673 Checks if overlay's buffer exists."
1674 (if (ediff-buffer-live-p (ediff-overlay-buffer overlay))
1675 (if (featurep 'xemacs)
1676 (set-extent-property overlay prop value)
1677 (overlay-put overlay prop value))
1678 (ediff-delete-overlay overlay)))
1679
1680 ;; temporarily uses DIR to abbreviate file name
1681 ;; if DIR is nil, use default-directory
1682 (defun ediff-abbreviate-file-name (file &optional dir)
1683 (cond ((stringp dir)
1684 (let ((directory-abbrev-alist (list (cons dir ""))))
1685 (abbreviate-file-name file)))
1686 (t
1687 (if (featurep 'xemacs)
1688 ;; XEmacs requires addl argument
1689 (abbreviate-file-name file t)
1690 (abbreviate-file-name file)))))
1691
1692 ;; Takes a directory and returns the parent directory.
1693 ;; does nothing to `/'. If the ARG is a regular file,
1694 ;; strip the file AND the last dir.
1695 (defun ediff-strip-last-dir (dir)
1696 (if (not (stringp dir)) (setq dir default-directory))
1697 (setq dir (expand-file-name dir))
1698 (or (file-directory-p dir) (setq dir (file-name-directory dir)))
1699 (let* ((pos (1- (length dir)))
1700 (last-char (aref dir pos)))
1701 (if (and (> pos 0) (= last-char ?/))
1702 (setq dir (substring dir 0 pos)))
1703 (ediff-abbreviate-file-name (file-name-directory dir))))
1704
1705 (defun ediff-truncate-string-left (str newlen)
1706 ;; leave space for ... on the left
1707 (let ((len (length str))
1708 substr)
1709 (if (<= len newlen)
1710 str
1711 (setq newlen (max 0 (- newlen 3)))
1712 (setq substr (substring str (max 0 (- len 1 newlen))))
1713 (concat "..." substr))))
1714
1715 (defsubst ediff-nonempty-string-p (string)
1716 (and (stringp string) (not (string= string ""))))
1717
1718 (unless (fboundp 'subst-char-in-string)
1719 (defun subst-char-in-string (fromchar tochar string &optional inplace)
1720 "Replace FROMCHAR with TOCHAR in STRING each time it occurs.
1721 Unless optional argument INPLACE is non-nil, return a new string."
1722 (let ((i (length string))
1723 (newstr (if inplace string (copy-sequence string))))
1724 (while (> i 0)
1725 (setq i (1- i))
1726 (if (eq (aref newstr i) fromchar)
1727 (aset newstr i tochar)))
1728 newstr)))
1729
1730 (defun ediff-abbrev-jobname (jobname)
1731 (cond ((eq jobname 'ediff-directories)
1732 "Compare two directories")
1733 ((eq jobname 'ediff-files)
1734 "Compare two files")
1735 ((eq jobname 'ediff-buffers)
1736 "Compare two buffers")
1737 ((eq jobname 'ediff-directories3)
1738 "Compare three directories")
1739 ((eq jobname 'ediff-files3)
1740 "Compare three files")
1741 ((eq jobname 'ediff-buffers3)
1742 "Compare three buffers")
1743 ((eq jobname 'ediff-revision)
1744 "Compare file with a version")
1745 ((eq jobname 'ediff-directory-revisions)
1746 "Compare dir files with versions")
1747 ((eq jobname 'ediff-merge-directory-revisions)
1748 "Merge dir files with versions")
1749 ((eq jobname 'ediff-merge-directory-revisions-with-ancestor)
1750 "Merge dir versions via ancestors")
1751 (t
1752 (capitalize
1753 (subst-char-in-string ?- ?\s (substring (symbol-name jobname) 6))))
1754 ))
1755
1756
1757 ;; If ediff modified mode line, strip the modification
1758 (defsubst ediff-strip-mode-line-format ()
1759 (if (member (car mode-line-format) '(" A: " " B: " " C: " " Ancestor: "))
1760 (setq mode-line-format (nth 2 mode-line-format))))
1761
1762 ;; Verify that we have a difference selected.
1763 (defsubst ediff-valid-difference-p (&optional n)
1764 (or n (setq n ediff-current-difference))
1765 (and (>= n 0) (< n ediff-number-of-differences)))
1766
1767 (defsubst ediff-show-all-diffs (n)
1768 "Don't skip difference regions."
1769 nil)
1770
1771 (defsubst ediff-message-if-verbose (string &rest args)
1772 (if ediff-verbose-p
1773 (apply 'message string args)))
1774
1775 (defun ediff-file-attributes (filename attr-number)
1776 (if (ediff-listable-file filename)
1777 (nth attr-number (file-attributes filename))
1778 -1)
1779 )
1780
1781 (defsubst ediff-file-size (filename)
1782 (ediff-file-attributes filename 7))
1783 (defsubst ediff-file-modtime (filename)
1784 (ediff-file-attributes filename 5))
1785
1786
1787 (defun ediff-convert-standard-filename (fname)
1788 (if (fboundp 'convert-standard-filename)
1789 (convert-standard-filename fname)
1790 fname))
1791
1792 (if (featurep 'emacs)
1793 (defalias 'ediff-with-syntax-table 'with-syntax-table)
1794 (if (fboundp 'with-syntax-table)
1795 (defalias 'ediff-with-syntax-table 'with-syntax-table)
1796 ;; stolen from subr.el in emacs 21
1797 (defmacro ediff-with-syntax-table (table &rest body)
1798 (let ((old-table (make-symbol "table"))
1799 (old-buffer (make-symbol "buffer")))
1800 `(let ((,old-table (syntax-table))
1801 (,old-buffer (current-buffer)))
1802 (unwind-protect
1803 (progn
1804 (set-syntax-table (copy-syntax-table ,table))
1805 ,@body)
1806 (save-current-buffer
1807 (set-buffer ,old-buffer)
1808 (set-syntax-table ,old-table))))))))
1809
1810
1811 (provide 'ediff-init)
1812
1813
1814
1815 ;; Local Variables:
1816 ;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
1817 ;; eval: (put 'ediff-with-current-buffer 'lisp-indent-hook 1)
1818 ;; eval: (put 'ediff-with-current-buffer 'edebug-form-spec '(form body))
1819 ;; End:
1820
1821 ;; arch-tag: fa31d384-1e70-4d4b-82a7-3e96307c46f5
1822 ;;; ediff-init.el ends here