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