Add copyright-at-end-flag.
[emacs.git] / lisp / ediff-init.el
blobcd7532849fc4b6c855af3ad3af200a8c343febfa
1 ;;; ediff-init.el --- Macros, variables, and defsubsts used by Ediff
3 ;; Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
4 ;; 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
6 ;; Author: Michael Kifer <kifer@cs.stonybrook.edu>
8 ;; This file is part of GNU Emacs.
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, or (at your option)
13 ;; any later version.
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.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
23 ;; Boston, MA 02110-1301, USA.
25 ;;; Commentary:
27 ;;; Code:
29 ;; Start compiler pacifier
30 (defvar ediff-metajob-name)
31 (defvar ediff-meta-buffer)
32 (defvar pm-color-alist)
33 (defvar ediff-grab-mouse)
34 (defvar ediff-mouse-pixel-position)
35 (defvar ediff-mouse-pixel-threshold)
36 (defvar ediff-whitespace)
37 (defvar ediff-multiframe)
38 (defvar ediff-use-toolbar-p)
39 (defvar mswindowsx-bitmap-file-path)
40 ;; end pacifier
42 (defvar ediff-force-faces nil
43 "If t, Ediff will think that it is running on a display that supports faces.
44 This is provided as a temporary relief for users of face-capable displays
45 that Ediff doesn't know about.")
47 ;; Are we running as a window application or on a TTY?
48 (defsubst ediff-device-type ()
49 (if (featurep 'xemacs)
50 (device-type (selected-device))
51 window-system))
53 ;; in XEmacs: device-type is tty on tty and stream in batch.
54 (defun ediff-window-display-p ()
55 (and (ediff-device-type) (not (memq (ediff-device-type) '(tty pc stream)))))
57 ;; test if supports faces
58 (defun ediff-has-face-support-p ()
59 (cond ((ediff-window-display-p))
60 (ediff-force-faces)
61 ((ediff-color-display-p))
62 ((featurep 'emacs) (memq (ediff-device-type) '(pc)))
63 ((featurep 'xemacs) (memq (ediff-device-type) '(tty pc)))
66 ;; toolbar support for emacs hasn't been implemented in ediff
67 (defun ediff-has-toolbar-support-p ()
68 (if (featurep 'xemacs)
69 (if (featurep 'toolbar) (console-on-window-system-p))))
72 (defun ediff-has-gutter-support-p ()
73 (if (featurep 'xemacs)
74 (if (featurep 'gutter) (console-on-window-system-p))))
76 (defun ediff-use-toolbar-p ()
77 (and (ediff-has-toolbar-support-p) ;Can it do it ?
78 (boundp 'ediff-use-toolbar-p)
79 ediff-use-toolbar-p)) ;Does the user want it ?
81 ;; Defines VAR as an advertised local variable.
82 ;; Performs a defvar, then executes `make-variable-buffer-local' on
83 ;; the variable. Also sets the `permanent-local' property,
84 ;; so that `kill-all-local-variables' (called by major-mode setting
85 ;; commands) won't destroy Ediff control variables.
87 ;; Plagiarised from `emerge-defvar-local' for XEmacs.
88 (defmacro ediff-defvar-local (var value doc)
89 "Defines VAR as a local variable."
90 (declare (indent defun))
91 `(progn
92 (defvar ,var ,value ,doc)
93 (make-variable-buffer-local ',var)
94 (put ',var 'permanent-local t)))
98 ;; Variables that control each Ediff session---local to the control buffer.
100 ;; Mode variables
101 ;; The buffer in which the A variant is stored.
102 (ediff-defvar-local ediff-buffer-A nil "")
103 ;; The buffer in which the B variant is stored.
104 (ediff-defvar-local ediff-buffer-B nil "")
105 ;; The buffer in which the C variant is stored or where the merge buffer lives.
106 (ediff-defvar-local ediff-buffer-C nil "")
107 ;; Ancestor buffer
108 (ediff-defvar-local ediff-ancestor-buffer nil "")
109 ;; The Ediff control buffer
110 (ediff-defvar-local ediff-control-buffer nil "")
112 (ediff-defvar-local ediff-temp-indirect-buffer nil
113 "If t, the buffer is a temporary indirect buffer.
114 It needs to be killed when we quit the session.")
117 ;; Association between buff-type and ediff-buffer-*
118 (defconst ediff-buffer-alist
119 '((?A . ediff-buffer-A)
120 (?B . ediff-buffer-B)
121 (?C . ediff-buffer-C)))
123 ;;; Macros
124 (defmacro ediff-odd-p (arg)
125 `(eq (logand ,arg 1) 1))
127 (defmacro ediff-buffer-live-p (buf)
128 `(and ,buf (get-buffer ,buf) (buffer-name (get-buffer ,buf))))
130 (defmacro ediff-get-buffer (arg)
131 `(cond ((eq ,arg 'A) ediff-buffer-A)
132 ((eq ,arg 'B) ediff-buffer-B)
133 ((eq ,arg 'C) ediff-buffer-C)
134 ((eq ,arg 'Ancestor) ediff-ancestor-buffer)
137 (defmacro ediff-get-value-according-to-buffer-type (buf-type list)
138 `(cond ((eq ,buf-type 'A) (nth 0 ,list))
139 ((eq ,buf-type 'B) (nth 1 ,list))
140 ((eq ,buf-type 'C) (nth 2 ,list))
143 (defmacro ediff-char-to-buftype (arg)
144 `(cond ((memq ,arg '(?a ?A)) 'A)
145 ((memq ,arg '(?b ?B)) 'B)
146 ((memq ,arg '(?c ?C)) 'C)
150 ;; A-list is supposed to be of the form (A . symb) (B . symb)...)
151 ;; where the first part of any association is a buffer type and the second is
152 ;; an appropriate symbol. Given buffer-type, this function returns the
153 ;; symbol. This is used to avoid using `intern'
154 (defsubst ediff-get-symbol-from-alist (buf-type alist)
155 (cdr (assoc buf-type alist)))
157 (defconst ediff-difference-vector-alist
158 '((A . ediff-difference-vector-A)
159 (B . ediff-difference-vector-B)
160 (C . ediff-difference-vector-C)
161 (Ancestor . ediff-difference-vector-Ancestor)))
163 (defmacro ediff-get-difference (n buf-type)
164 `(aref
165 (symbol-value
166 (ediff-get-symbol-from-alist
167 ,buf-type ediff-difference-vector-alist))
168 ,n))
170 ;; Tell if it has been previously determined that the region has
171 ;; no diffs other than the white space and newlines
172 ;; The argument, N, is the diff region number used by Ediff to index the
173 ;; diff vector. It is 1 less than the number seen by the user.
174 ;; Returns:
175 ;; t if the diffs are whitespace in all buffers
176 ;; 'A (in 3-buf comparison only) if there are only whitespace
177 ;; diffs in bufs B and C
178 ;; 'B (in 3-buf comparison only) if there are only whitespace
179 ;; diffs in bufs A and C
180 ;; 'C (in 3-buf comparison only) if there are only whitespace
181 ;; diffs in bufs A and B
183 ;; A Difference Vector has the form:
184 ;; [diff diff diff ...]
185 ;; where each diff has the form:
186 ;; [overlay fine-diff-vector no-fine-diffs-flag state-of-difference]
187 ;; fine-diff-vector is a vector [fine-diff fine-diff fine-diff ...]
188 ;; no-fine-diffs-flag says if there are fine differences.
189 ;; state-of-difference is A, B, C, or nil, indicating which buffer is
190 ;; different from the other two (used only in 3-way jobs).
191 (defmacro ediff-no-fine-diffs-p (n)
192 `(aref (ediff-get-difference ,n 'A) 2))
194 (defmacro ediff-get-diff-overlay-from-diff-record (diff-rec)
195 `(aref ,diff-rec 0))
197 (defmacro ediff-get-diff-overlay (n buf-type)
198 `(ediff-get-diff-overlay-from-diff-record
199 (ediff-get-difference ,n ,buf-type)))
201 (defmacro ediff-get-fine-diff-vector-from-diff-record (diff-rec)
202 `(aref ,diff-rec 1))
204 (defmacro ediff-set-fine-diff-vector (n buf-type fine-vec)
205 `(aset (ediff-get-difference ,n ,buf-type) 1 ,fine-vec))
207 (defmacro ediff-get-state-of-diff (n buf-type)
208 `(if (ediff-buffer-live-p ediff-buffer-C)
209 (aref (ediff-get-difference ,n ,buf-type) 3)))
210 (defmacro ediff-set-state-of-diff (n buf-type val)
211 `(aset (ediff-get-difference ,n ,buf-type) 3 ,val))
213 (defmacro ediff-get-state-of-merge (n)
214 `(if ediff-state-of-merge
215 (aref (aref ediff-state-of-merge ,n) 0)))
216 (defmacro ediff-set-state-of-merge (n val)
217 `(if ediff-state-of-merge
218 (aset (aref ediff-state-of-merge ,n) 0 ,val)))
220 (defmacro ediff-get-state-of-ancestor (n)
221 `(if ediff-state-of-merge
222 (aref (aref ediff-state-of-merge ,n) 1)))
224 ;; if flag is t, puts a mark on diff region saying that
225 ;; the differences are in white space only. If flag is nil,
226 ;; the region is marked as essential (i.e., differences are
227 ;; not just in the white space and newlines.)
228 (defmacro ediff-mark-diff-as-space-only (n flag)
229 `(aset (ediff-get-difference ,n 'A) 2 ,flag))
231 (defmacro ediff-get-fine-diff-vector (n buf-type)
232 `(ediff-get-fine-diff-vector-from-diff-record
233 (ediff-get-difference ,n ,buf-type)))
235 ;; Macro to switch to BUFFER, evaluate BODY, returns to original buffer.
236 ;; Doesn't save the point and mark.
237 ;; This is `with-current-buffer' with the added test for live buffers."
238 (defmacro ediff-with-current-buffer (buffer &rest body)
239 "Evaluates BODY in BUFFER."
240 (declare (indent 1) (debug (form body)))
241 `(if (ediff-buffer-live-p ,buffer)
242 (save-current-buffer
243 (set-buffer ,buffer)
244 ,@body)
245 (or (eq this-command 'ediff-quit)
246 (error ediff-KILLED-VITAL-BUFFER))
250 (defsubst ediff-multiframe-setup-p ()
251 (and (ediff-window-display-p) ediff-multiframe))
253 (defmacro ediff-narrow-control-frame-p ()
254 `(and (ediff-multiframe-setup-p)
255 (equal ediff-help-message ediff-brief-message-string)))
257 (defmacro ediff-3way-comparison-job ()
258 `(memq
259 ediff-job-name
260 '(ediff-files3 ediff-buffers3)))
261 (ediff-defvar-local ediff-3way-comparison-job nil "")
263 (defmacro ediff-merge-job ()
264 `(memq
265 ediff-job-name
266 '(ediff-merge-files
267 ediff-merge-buffers
268 ediff-merge-files-with-ancestor
269 ediff-merge-buffers-with-ancestor
270 ediff-merge-revisions
271 ediff-merge-revisions-with-ancestor)))
272 (ediff-defvar-local ediff-merge-job nil "")
274 (defmacro ediff-patch-job ()
275 `(eq ediff-job-name 'epatch))
277 (defmacro ediff-merge-with-ancestor-job ()
278 `(memq
279 ediff-job-name
280 '(ediff-merge-files-with-ancestor
281 ediff-merge-buffers-with-ancestor
282 ediff-merge-revisions-with-ancestor)))
283 (ediff-defvar-local ediff-merge-with-ancestor-job nil "")
285 (defmacro ediff-3way-job ()
286 `(or ediff-3way-comparison-job ediff-merge-job))
287 (ediff-defvar-local ediff-3way-job nil "")
289 ;; A diff3 job is like a 3way job, but ediff-merge doesn't require the use
290 ;; of diff3.
291 (defmacro ediff-diff3-job ()
292 `(or ediff-3way-comparison-job
293 ediff-merge-with-ancestor-job))
294 (ediff-defvar-local ediff-diff3-job nil "")
296 (defmacro ediff-windows-job ()
297 `(memq ediff-job-name '(ediff-windows-wordwise ediff-windows-linewise)))
298 (ediff-defvar-local ediff-windows-job nil "")
300 (defmacro ediff-word-mode-job ()
301 `(memq ediff-job-name '(ediff-windows-wordwise ediff-regions-wordwise)))
302 (ediff-defvar-local ediff-word-mode-job nil "")
304 (defmacro ediff-narrow-job ()
305 `(memq ediff-job-name '(ediff-windows-wordwise
306 ediff-regions-wordwise
307 ediff-windows-linewise
308 ediff-regions-linewise)))
309 (ediff-defvar-local ediff-narrow-job nil "")
311 ;; Note: ediff-merge-directory-revisions-with-ancestor is not treated as an
312 ;; ancestor metajob, since it behaves differently.
313 (defsubst ediff-ancestor-metajob (&optional metajob)
314 (memq (or metajob ediff-metajob-name)
315 '(ediff-merge-directories-with-ancestor
316 ediff-merge-filegroups-with-ancestor)))
317 (defsubst ediff-revision-metajob (&optional metajob)
318 (memq (or metajob ediff-metajob-name)
319 '(ediff-directory-revisions
320 ediff-merge-directory-revisions
321 ediff-merge-directory-revisions-with-ancestor)))
322 (defsubst ediff-patch-metajob (&optional metajob)
323 (memq (or metajob ediff-metajob-name)
324 '(ediff-multifile-patch)))
325 ;; metajob involving only one group of files, such as multipatch or directory
326 ;; revision
327 (defsubst ediff-one-filegroup-metajob (&optional metajob)
328 (or (ediff-revision-metajob metajob)
329 (ediff-patch-metajob metajob)
330 ;; add more here
332 ;; jobs suitable for the operation of collecting diffs into a multifile patch
333 (defsubst ediff-collect-diffs-metajob (&optional metajob)
334 (memq (or metajob ediff-metajob-name)
335 '(ediff-directories
336 ediff-merge-directories
337 ediff-merge-directories-with-ancestor
338 ediff-directory-revisions
339 ediff-merge-directory-revisions
340 ediff-merge-directory-revisions-with-ancestor
341 ;; add more here
343 (defsubst ediff-merge-metajob (&optional metajob)
344 (memq (or metajob ediff-metajob-name)
345 '(ediff-merge-directories
346 ediff-merge-directories-with-ancestor
347 ediff-merge-directory-revisions
348 ediff-merge-directory-revisions-with-ancestor
349 ediff-merge-filegroups-with-ancestor
350 ;; add more here
353 (defsubst ediff-metajob3 (&optional metajob)
354 (memq (or metajob ediff-metajob-name)
355 '(ediff-merge-directories-with-ancestor
356 ediff-merge-filegroups-with-ancestor
357 ediff-directories3
358 ediff-filegroups3)))
359 (defsubst ediff-comparison-metajob3 (&optional metajob)
360 (memq (or metajob ediff-metajob-name)
361 '(ediff-directories3 ediff-filegroups3)))
363 ;; with no argument, checks if we are in ediff-control-buffer
364 ;; with argument, checks if we are in ediff-meta-buffer
365 (defun ediff-in-control-buffer-p (&optional meta-buf-p)
366 (and (boundp 'ediff-control-buffer)
367 (eq (if meta-buf-p ediff-meta-buffer ediff-control-buffer)
368 (current-buffer))))
370 (defsubst ediff-barf-if-not-control-buffer (&optional meta-buf-p)
371 (or (ediff-in-control-buffer-p meta-buf-p)
372 (error "%S: This command runs in Ediff Control Buffer only!"
373 this-command)))
375 (defgroup ediff-highlighting nil
376 "Hilighting of difference regions in Ediff."
377 :prefix "ediff-"
378 :group 'ediff)
380 (defgroup ediff-merge nil
381 "Merging utilities."
382 :prefix "ediff-"
383 :group 'ediff)
385 (defgroup ediff-hook nil
386 "Hooks run by Ediff."
387 :prefix "ediff-"
388 :group 'ediff)
390 ;; Hook variables
392 (defcustom ediff-before-setup-hook nil
393 "*Hooks to run before Ediff begins to set up windows and buffers.
394 This hook can be used to save the previous window config, which can be restored
395 on ediff-quit or ediff-suspend."
396 :type 'hook
397 :group 'ediff-hook)
398 (defcustom ediff-before-setup-windows-hook nil
399 "*Hooks to run before Ediff sets its window configuration.
400 This hook is run every time when Ediff arranges its windows.
401 This happens each time Ediff detects that the windows were messed up by the
402 user."
403 :type 'hook
404 :group 'ediff-hook)
405 (defcustom ediff-after-setup-windows-hook nil
406 "*Hooks to run after Ediff sets its window configuration.
407 This can be used to set up control window or icon in a desired place."
408 :type 'hook
409 :group 'ediff-hook)
410 (defcustom ediff-before-setup-control-frame-hook nil
411 "*Hooks run before setting up the frame to display Ediff Control Panel.
412 Can be used to change control frame parameters to position it where it
413 is desirable."
414 :type 'hook
415 :group 'ediff-hook)
416 (defcustom ediff-after-setup-control-frame-hook nil
417 "*Hooks run after setting up the frame to display Ediff Control Panel.
418 Can be used to move the frame where it is desired."
419 :type 'hook
420 :group 'ediff-hook)
421 (defcustom ediff-startup-hook nil
422 "*Hooks to run in the control buffer after Ediff has been set up and is ready for the job."
423 :type 'hook
424 :group 'ediff-hook)
425 (defcustom ediff-select-hook nil
426 "*Hooks to run after a difference has been selected."
427 :type 'hook
428 :group 'ediff-hook)
429 (defcustom ediff-unselect-hook nil
430 "*Hooks to run after a difference has been unselected."
431 :type 'hook
432 :group 'ediff-hook)
433 (defcustom ediff-prepare-buffer-hook nil
434 "*Hooks run after buffers A, B, and C are set up.
435 For each buffer, the hooks are run with that buffer made current."
436 :type 'hook
437 :group 'ediff-hook)
438 (defcustom ediff-load-hook nil
439 "*Hook run after Ediff is loaded. Can be used to change defaults."
440 :type 'hook
441 :group 'ediff-hook)
443 (defcustom ediff-mode-hook nil
444 "*Hook run just after ediff-mode is set up in the control buffer.
445 This is done before any windows or frames are created. One can use it to
446 set local variables that determine how the display looks like."
447 :type 'hook
448 :group 'ediff-hook)
449 (defcustom ediff-keymap-setup-hook nil
450 "*Hook run just after the default bindings in Ediff keymap are set up."
451 :type 'hook
452 :group 'ediff-hook)
454 (defcustom ediff-display-help-hook nil
455 "*Hooks run after preparing the help message."
456 :type 'hook
457 :group 'ediff-hook)
459 (defcustom ediff-suspend-hook nil
460 "*Hooks to run in the Ediff control buffer when Ediff is suspended."
461 :type 'hook
462 :group 'ediff-hook)
463 (defcustom ediff-quit-hook nil
464 "*Hooks to run in the Ediff control buffer after finishing Ediff."
465 :type 'hook
466 :group 'ediff-hook)
467 (defcustom ediff-cleanup-hook nil
468 "*Hooks to run on exiting Ediff but before killing the control and variant buffers."
469 :type 'hook
470 :group 'ediff-hook)
472 ;; Error messages
473 (defconst ediff-KILLED-VITAL-BUFFER
474 "You have killed a vital Ediff buffer---you must leave Ediff now!")
475 (defconst ediff-NO-DIFFERENCES
476 "Sorry, comparison of identical variants is not what I am made for...")
477 (defconst ediff-BAD-DIFF-NUMBER
478 ;; %S stands for this-command, %d - diff number, %d - max diff
479 "%S: Bad diff region number, %d. Valid numbers are 1 to %d")
480 (defconst ediff-BAD-INFO (format "
481 *** The Info file for Ediff, a part of the standard distribution
482 *** of %sEmacs, does not seem to be properly installed.
484 *** Please contact your system administrator. "
485 (if (featurep 'xemacs) "X" "")))
487 ;; Selective browsing
489 (ediff-defvar-local ediff-skip-diff-region-function 'ediff-show-all-diffs
490 "Function that determines the next/previous diff region to show.
491 Should return t for regions to be ignored and nil otherwise.
492 This function gets a region number as an argument. The region number
493 is the one used internally by Ediff. It is 1 less than the number seen
494 by the user.")
496 (ediff-defvar-local ediff-hide-regexp-matches-function
497 'ediff-hide-regexp-matches
498 "Function to use in determining which regions to hide.
499 See the documentation string of `ediff-hide-regexp-matches' for details.")
500 (ediff-defvar-local ediff-focus-on-regexp-matches-function
501 'ediff-focus-on-regexp-matches
502 "Function to use in determining which regions to focus on.
503 See the documentation string of `ediff-focus-on-regexp-matches' for details.")
505 ;; Regexp that determines buf A regions to focus on when skipping to diff
506 (ediff-defvar-local ediff-regexp-focus-A "" "")
507 ;; Regexp that determines buf B regions to focus on when skipping to diff
508 (ediff-defvar-local ediff-regexp-focus-B "" "")
509 ;; Regexp that determines buf C regions to focus on when skipping to diff
510 (ediff-defvar-local ediff-regexp-focus-C "" "")
511 ;; connective that determines whether to focus regions that match both or
512 ;; one of the regexps
513 (ediff-defvar-local ediff-focus-regexp-connective 'and "")
515 ;; Regexp that determines buf A regions to ignore when skipping to diff
516 (ediff-defvar-local ediff-regexp-hide-A "" "")
517 ;; Regexp that determines buf B regions to ignore when skipping to diff
518 (ediff-defvar-local ediff-regexp-hide-B "" "")
519 ;; Regexp that determines buf C regions to ignore when skipping to diff
520 (ediff-defvar-local ediff-regexp-hide-C "" "")
521 ;; connective that determines whether to hide regions that match both or
522 ;; one of the regexps
523 (ediff-defvar-local ediff-hide-regexp-connective 'and "")
526 ;;; Copying difference regions between buffers.
528 ;; A list of killed diffs.
529 ;; A diff is saved here if it is replaced by a diff
530 ;; from another buffer. This alist has the form:
531 ;; \((num (buff-object . diff) (buff-object . diff) (buff-object . diff)) ...),
532 ;; where some buffer-objects may be missing.
533 (ediff-defvar-local ediff-killed-diffs-alist nil "")
535 ;; Syntax table to use in ediff-forward-word-function
536 ;; This is chosen by a heuristic. The important thing is for all buffers to
537 ;; have the same syntax table. Which is not too important.
538 (ediff-defvar-local ediff-syntax-table nil "")
541 ;; Highlighting
542 (defcustom ediff-before-flag-bol (if (featurep 'xemacs) (make-glyph "->>") "->>")
543 "*Flag placed before a highlighted block of differences, if block starts at beginning of a line."
544 :type 'string
545 :tag "Region before-flag at beginning of line"
546 :group 'ediff)
548 (defcustom ediff-after-flag-eol (if (featurep 'xemacs) (make-glyph "<<-") "<<-")
549 "*Flag placed after a highlighted block of differences, if block ends at end of a line."
550 :type 'string
551 :tag "Region after-flag at end of line"
552 :group 'ediff)
554 (defcustom ediff-before-flag-mol (if (featurep 'xemacs) (make-glyph "->>") "->>")
555 "*Flag placed before a highlighted block of differences, if block starts in mid-line."
556 :type 'string
557 :tag "Region before-flag in the middle of line"
558 :group 'ediff)
559 (defcustom ediff-after-flag-mol (if (featurep 'xemacs) (make-glyph "<<-") "<<-")
560 "*Flag placed after a highlighted block of differences, if block ends in mid-line."
561 :type 'string
562 :tag "Region after-flag in the middle of line"
563 :group 'ediff)
566 (ediff-defvar-local ediff-use-faces t "")
567 (defcustom ediff-use-faces t
568 "If t, differences are highlighted using faces, if device supports faces.
569 If nil, differences are highlighted using ASCII flags, ediff-before-flag
570 and ediff-after-flag. On a non-window system, differences are always
571 highlighted using ASCII flags."
572 :type 'boolean
573 :group 'ediff-highlighting)
575 ;; this indicates that diff regions are word-size, so fine diffs are
576 ;; permanently nixed; used in ediff-windows-wordwise and ediff-regions-wordwise
577 (ediff-defvar-local ediff-word-mode nil "")
578 ;; Name of the job (ediff-files, ediff-windows, etc.)
579 (ediff-defvar-local ediff-job-name nil "")
581 ;; Narrowing and ediff-region/windows support
582 ;; This is a list (overlay-A overlay-B overlay-C)
583 ;; If set, Ediff compares only those parts of buffers A/B/C that lie within
584 ;; the bounds of these overlays.
585 (ediff-defvar-local ediff-narrow-bounds nil "")
587 ;; List (overlay-A overlay-B overlay-C), where each overlay spans the
588 ;; entire corresponding buffer.
589 (ediff-defvar-local ediff-wide-bounds nil "")
591 ;; Current visibility boundaries in buffers A, B, and C.
592 ;; This is also a list of overlays. When the user toggles narrow/widen,
593 ;; this list changes from ediff-wide-bounds to ediff-narrow-bounds.
594 ;; and back.
595 (ediff-defvar-local ediff-visible-bounds nil "")
597 (ediff-defvar-local ediff-start-narrowed t
598 "Non-nil means start narrowed, if doing ediff-windows-* or ediff-regions-*")
599 (ediff-defvar-local ediff-quit-widened t
600 "*Non-nil means: when finished, Ediff widens buffers A/B.
601 Actually, Ediff restores the scope of visibility that existed at startup.")
603 (defcustom ediff-keep-variants t
604 "*nil means prompt to remove unmodified buffers A/B/C at session end.
605 Supplying a prefix argument to the quit command `q' temporarily reverses the
606 meaning of this variable."
607 :type 'boolean
608 :group 'ediff)
610 (ediff-defvar-local ediff-highlight-all-diffs t "")
611 (defcustom ediff-highlight-all-diffs t
612 "If nil, only the selected differences are highlighted.
613 Otherwise, all difference regions are highlighted, but the selected region is
614 shown in brighter colors."
615 :type 'boolean
616 :group 'ediff-highlighting)
619 ;; The suffix of the control buffer name.
620 (ediff-defvar-local ediff-control-buffer-suffix nil "")
621 ;; Same as ediff-control-buffer-suffix, but without <,>.
622 ;; It's a number rather than string.
623 (ediff-defvar-local ediff-control-buffer-number nil "")
626 ;; The original values of ediff-protected-variables for buffer A
627 (ediff-defvar-local ediff-buffer-values-orig-A nil "")
628 ;; The original values of ediff-protected-variables for buffer B
629 (ediff-defvar-local ediff-buffer-values-orig-B nil "")
630 ;; The original values of ediff-protected-variables for buffer C
631 (ediff-defvar-local ediff-buffer-values-orig-C nil "")
632 ;; The original values of ediff-protected-variables for buffer Ancestor
633 (ediff-defvar-local ediff-buffer-values-orig-Ancestor nil "")
635 ;; association between buff-type and ediff-buffer-values-orig-*
636 (defconst ediff-buffer-values-orig-alist
637 '((A . ediff-buffer-values-orig-A)
638 (B . ediff-buffer-values-orig-B)
639 (C . ediff-buffer-values-orig-C)
640 (Ancestor . ediff-buffer-values-orig-Ancestor)))
642 ;; Buffer-local variables to be saved then restored during Ediff sessions
643 (defconst ediff-protected-variables '(
644 ;;buffer-read-only
645 mode-line-format))
647 ;; Vector of differences between the variants. Each difference is
648 ;; represented by a vector of two overlays plus a vector of fine diffs,
649 ;; plus a no-fine-diffs flag. The first overlay spans the
650 ;; difference region in the A buffer and the second overlays the diff in
651 ;; the B buffer. If a difference section is empty, the corresponding
652 ;; overlay's endpoints coincide.
654 ;; The precise form of a Difference Vector for one buffer is:
655 ;; [diff diff diff ...]
656 ;; where each diff has the form:
657 ;; [diff-overlay fine-diff-vector no-fine-diffs-flag state-of-diff]
658 ;; fine-diff-vector is a vector [fine-diff-overlay fine-diff-overlay ...]
659 ;; no-fine-diffs-flag says if there are fine differences.
660 ;; state-of-difference is A, B, C, or nil, indicating which buffer is
661 ;; different from the other two (used only in 3-way jobs.
662 (ediff-defvar-local ediff-difference-vector-A nil "")
663 (ediff-defvar-local ediff-difference-vector-B nil "")
664 (ediff-defvar-local ediff-difference-vector-C nil "")
665 (ediff-defvar-local ediff-difference-vector-Ancestor nil "")
666 ;; A-list of diff vector types associated with buffer types
667 (defconst ediff-difference-vector-alist
668 '((A . ediff-difference-vector-A)
669 (B . ediff-difference-vector-B)
670 (C . ediff-difference-vector-C)
671 (Ancestor . ediff-difference-vector-Ancestor)))
673 ;; [ status status status ...]
674 ;; Each status: [state-of-merge state-of-ancestor]
675 ;; state-of-merge is default-A, default-B, prefer-A, or prefer-B. It
676 ;; indicates the way a diff region was created in buffer C.
677 ;; state-of-ancestor says if the corresponding region in ancestor buffer is
678 ;; empty.
679 (ediff-defvar-local ediff-state-of-merge nil "")
681 ;; The difference that is currently selected.
682 (ediff-defvar-local ediff-current-difference -1 "")
683 ;; Number of differences found.
684 (ediff-defvar-local ediff-number-of-differences nil "")
686 ;; Buffer containing the output of diff, which is used by Ediff to step
687 ;; through files.
688 (ediff-defvar-local ediff-diff-buffer nil "")
689 ;; Like ediff-diff-buffer, but contains context diff. It is not used by
690 ;; Ediff, but it is saved in a file, if user requests so.
691 (ediff-defvar-local ediff-custom-diff-buffer nil "")
692 ;; Buffer used for diff-style fine differences between regions.
693 (ediff-defvar-local ediff-fine-diff-buffer nil "")
694 ;; Temporary buffer used for computing fine differences.
695 (defconst ediff-tmp-buffer " *ediff-tmp*" "")
696 ;; Buffer used for messages
697 (defconst ediff-msg-buffer " *ediff-message*" "")
698 ;; Buffer containing the output of diff when diff returns errors.
699 (ediff-defvar-local ediff-error-buffer nil "")
700 ;; Buffer to display debug info
701 (ediff-defvar-local ediff-debug-buffer "*ediff-debug*" "")
703 ;; List of ediff control panels associated with each buffer A/B/C/Ancestor.
704 ;; Not used any more, but may be needed in the future.
705 (ediff-defvar-local ediff-this-buffer-ediff-sessions nil "")
707 ;; to be deleted in due time
708 ;; List of difference overlays disturbed by working with the current diff.
709 (defvar ediff-disturbed-overlays nil "")
711 ;; Priority of non-selected overlays.
712 (defvar ediff-shadow-overlay-priority 100 "")
714 (defcustom ediff-version-control-package 'vc
715 "Version control package used.
716 Currently, Ediff supports vc.el, rcs.el, pcl-cvs.el, and generic-sc.el. The
717 standard Emacs interface to RCS, CVS, SCCS, etc., is vc.el. However, some
718 people find the other two packages more convenient. Set this variable to the
719 appropriate symbol: `rcs', `pcl-cvs', or `generic-sc' if you so desire."
720 :type 'symbol
721 :group 'ediff)
723 (defcustom ediff-coding-system-for-read 'raw-text
724 "*The coding system for read to use when running the diff program as a subprocess.
725 In most cases, the default will do. However, under certain circumstances in
726 Windows NT/98/95 you might need to use something like 'raw-text-dos here.
727 So, if the output that your diff program sends to Emacs contains extra ^M's,
728 you might need to experiment here, if the default or 'raw-text-dos doesn't
729 work."
730 :type 'symbol
731 :group 'ediff)
733 (defcustom ediff-coding-system-for-write 'no-conversion
734 "*The coding system for write to use when writing out difference regions
735 to temp files when Ediff needs to find fine differences."
736 :type 'symbol
737 :group 'ediff)
740 (defalias 'ediff-read-event
741 (if (featurep 'xemacs) 'next-command-event 'read-event))
743 (defalias 'ediff-overlayp
744 (if (featurep 'xemacs) 'extentp 'overlayp))
746 (defalias 'ediff-make-overlay
747 (if (featurep 'xemacs) 'make-extent 'make-overlay))
749 (defalias 'ediff-delete-overlay
750 (if (featurep 'xemacs) 'delete-extent 'delete-overlay))
752 ;; Check the current version against the major and minor version numbers
753 ;; using op: cur-vers op major.minor If emacs-major-version or
754 ;; emacs-minor-version are not defined, we assume that the current version
755 ;; is hopelessly outdated. We assume that emacs-major-version and
756 ;; emacs-minor-version are defined. Otherwise, for Emacs/XEmacs 19, if the
757 ;; current minor version is < 10 (xemacs) or < 23 (emacs) the return value
758 ;; will be nil (when op is =, >, or >=) and t (when op is <, <=), which may be
759 ;; incorrect. However, this gives correct result in our cases, since we are
760 ;; testing for sufficiently high Emacs versions.
761 (defun ediff-check-version (op major minor &optional type-of-emacs)
762 (if (and (boundp 'emacs-major-version) (boundp 'emacs-minor-version))
763 (and (cond ((eq type-of-emacs 'xemacs) (featurep 'xemacs))
764 ((eq type-of-emacs 'emacs) (featurep 'emacs))
765 (t t))
766 (cond ((eq op '=) (and (= emacs-minor-version minor)
767 (= emacs-major-version major)))
768 ((memq op '(> >= < <=))
769 (and (or (funcall op emacs-major-version major)
770 (= emacs-major-version major))
771 (if (= emacs-major-version major)
772 (funcall op emacs-minor-version minor)
773 t)))
775 (error "%S: Invalid op in ediff-check-version" op))))
776 (cond ((memq op '(= > >=)) nil)
777 ((memq op '(< <=)) t))))
780 (defun ediff-color-display-p ()
781 (condition-case nil
782 (if (featurep 'xemacs)
783 (eq (device-class (selected-device)) 'color) ; xemacs form
784 (display-color-p)) ; emacs form
785 (error nil)))
788 ;; A var local to each control panel buffer. Indicates highlighting style
789 ;; in effect for this buffer: `face', `ascii',
790 ;; `off' -- turned off \(on a dumb terminal only\).
791 (ediff-defvar-local ediff-highlighting-style
792 (if (and (ediff-has-face-support-p) ediff-use-faces) 'face 'ascii)
796 (if (ediff-has-face-support-p)
797 (if (featurep 'xemacs)
798 (progn
799 (defalias 'ediff-valid-color-p 'valid-color-name-p)
800 (defalias 'ediff-get-face 'get-face))
801 (defalias 'ediff-valid-color-p (if (fboundp 'color-defined-p)
802 'color-defined-p
803 'x-color-defined-p))
804 (defalias 'ediff-get-face 'internal-get-face)))
806 (if (ediff-window-display-p)
807 (if (featurep 'xemacs)
808 (progn
809 (defalias 'ediff-display-pixel-width 'device-pixel-width)
810 (defalias 'ediff-display-pixel-height 'device-pixel-height))
811 (defalias 'ediff-display-pixel-width
812 (if (fboundp 'display-pixel-width)
813 'display-pixel-width
814 'x-display-pixel-width))
815 (defalias 'ediff-display-pixel-height
816 (if (fboundp 'display-pixel-height)
817 'display-pixel-height
818 'x-display-pixel-height))))
820 ;; A-list of current-diff-overlay symbols associated with buf types
821 (defconst ediff-current-diff-overlay-alist
822 '((A . ediff-current-diff-overlay-A)
823 (B . ediff-current-diff-overlay-B)
824 (C . ediff-current-diff-overlay-C)
825 (Ancestor . ediff-current-diff-overlay-Ancestor)))
827 ;; A-list of current-diff-face-* symbols associated with buf types
828 (defconst ediff-current-diff-face-alist
829 '((A . ediff-current-diff-A)
830 (B . ediff-current-diff-B)
831 (C . ediff-current-diff-C)
832 (Ancestor . ediff-current-diff-Ancestor)))
835 (defun ediff-set-overlay-face (extent face)
836 (ediff-overlay-put extent 'face face)
837 (ediff-overlay-put extent 'help-echo 'ediff-region-help-echo))
839 (defun ediff-region-help-echo (extent-or-window &optional overlay point)
840 (unless overlay
841 (setq overlay extent-or-window))
842 (let ((is-current (ediff-overlay-get overlay 'ediff))
843 (face (ediff-overlay-get overlay 'face))
844 (diff-num (ediff-overlay-get overlay 'ediff-diff-num))
845 face-help)
847 ;; This happens only for refinement overlays
848 (if (stringp face)
849 (setq face (intern face)))
850 (setq face-help (and face (get face 'ediff-help-echo)))
852 (cond ((and is-current diff-num) ; current diff region
853 (format "Difference region %S -- current" (1+ diff-num)))
854 (face-help) ; refinement of current diff region
855 (diff-num ; non-current
856 (format "Difference region %S -- non-current" (1+ diff-num)))
857 (t "")) ; none
861 (defun ediff-set-face-pixmap (face pixmap)
862 "Set face pixmap on a monochrome display."
863 (if (and (ediff-window-display-p) (not (ediff-color-display-p)))
864 (condition-case nil
865 (set-face-background-pixmap face pixmap)
866 (error
867 (message "Pixmap not found for %S: %s" (face-name face) pixmap)
868 (sit-for 1)))))
870 (defun ediff-hide-face (face)
871 (if (and (ediff-has-face-support-p)
872 (boundp 'add-to-list)
873 (boundp 'facemenu-unlisted-faces))
874 (add-to-list 'facemenu-unlisted-faces face)))
878 (defface ediff-current-diff-A
879 (if (featurep 'emacs)
880 '((((class color) (min-colors 16))
881 (:foreground "firebrick" :background "pale green"))
882 (((class color))
883 (:foreground "blue3" :background "yellow3"))
884 (t (:inverse-video t)))
885 '((((type tty)) (:foreground "blue3" :background "yellow3"))
886 (((class color)) (:foreground "firebrick" :background "pale green"))
887 (t (:inverse-video t))))
888 "Face for highlighting the selected difference in buffer A."
889 :group 'ediff-highlighting)
890 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
891 ;; this variable is set to nil, then again to the appropriate face.
892 (defvar ediff-current-diff-face-A 'ediff-current-diff-A
893 "Face for highlighting the selected difference in buffer A.
894 DO NOT CHANGE this variable. Instead, use the customization
895 widget to customize the actual face object `ediff-current-diff-A'
896 this variable represents.")
897 (ediff-hide-face ediff-current-diff-face-A)
898 ;; Until custom.el for XEmacs starts supporting :inverse-video we do this.
899 ;; This means that some user customization may be trashed.
900 (and (featurep 'xemacs)
901 (ediff-has-face-support-p)
902 (not (ediff-color-display-p))
903 (copy-face 'modeline ediff-current-diff-face-A))
907 (defface ediff-current-diff-B
908 (if (featurep 'emacs)
909 '((((class color) (min-colors 16))
910 (:foreground "DarkOrchid" :background "Yellow"))
911 (((class color))
912 (:foreground "magenta3" :background "yellow3"
913 :weight bold))
914 (t (:inverse-video t)))
915 '((((type tty)) (:foreground "magenta3" :background "yellow3"
916 :weight bold))
917 (((class color)) (:foreground "DarkOrchid" :background "Yellow"))
918 (t (:inverse-video t))))
919 "Face for highlighting the selected difference in buffer B."
920 :group 'ediff-highlighting)
921 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
922 ;; this variable is set to nil, then again to the appropriate face.
923 (defvar ediff-current-diff-face-B 'ediff-current-diff-B
924 "Face for highlighting the selected difference in buffer B.
925 this variable. Instead, use the customization
926 widget to customize the actual face `ediff-current-diff-B'
927 this variable represents.")
928 (ediff-hide-face ediff-current-diff-face-B)
929 ;; Until custom.el for XEmacs starts supporting :inverse-video we do this.
930 ;; This means that some user customization may be trashed.
931 (and (featurep 'xemacs)
932 (ediff-has-face-support-p)
933 (not (ediff-color-display-p))
934 (copy-face 'modeline ediff-current-diff-face-B))
937 (defface ediff-current-diff-C
938 (if (featurep 'emacs)
939 '((((class color) (min-colors 16))
940 (:foreground "Navy" :background "Pink"))
941 (((class color))
942 (:foreground "cyan3" :background "yellow3" :weight bold))
943 (t (:inverse-video t)))
944 '((((type tty)) (:foreground "cyan3" :background "yellow3" :weight bold))
945 (((class color)) (:foreground "Navy" :background "Pink"))
946 (t (:inverse-video t))))
947 "Face for highlighting the selected difference in buffer C."
948 :group 'ediff-highlighting)
949 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
950 ;; this variable is set to nil, then again to the appropriate face.
951 (defvar ediff-current-diff-face-C 'ediff-current-diff-C
952 "Face for highlighting the selected difference in buffer C.
953 DO NOT CHANGE this variable. Instead, use the customization
954 widget to customize the actual face object `ediff-current-diff-C'
955 this variable represents.")
956 (ediff-hide-face ediff-current-diff-face-C)
957 ;; Until custom.el for XEmacs starts supporting :inverse-video we do this.
958 ;; This means that some user customization may be trashed.
959 (and (featurep 'xemacs)
960 (ediff-has-face-support-p)
961 (not (ediff-color-display-p))
962 (copy-face 'modeline ediff-current-diff-face-C))
965 (defface ediff-current-diff-Ancestor
966 (if (featurep 'emacs)
967 '((((class color) (min-colors 16))
968 (:foreground "Black" :background "VioletRed"))
969 (((class color))
970 (:foreground "black" :background "magenta3"))
971 (t (:inverse-video t)))
972 '((((type tty)) (:foreground "black" :background "magenta3"))
973 (((class color)) (:foreground "Black" :background "VioletRed"))
974 (t (:inverse-video t))))
975 "Face for highlighting the selected difference in buffer Ancestor."
976 :group 'ediff-highlighting)
977 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
978 ;; this variable is set to nil, then again to the appropriate face.
979 (defvar ediff-current-diff-face-Ancestor 'ediff-current-diff-Ancestor
980 "Face for highlighting the selected difference in buffer Ancestor.
981 DO NOT CHANGE this variable. Instead, use the customization
982 widget to customize the actual face object `ediff-current-diff-Ancestor'
983 this variable represents.")
984 (ediff-hide-face ediff-current-diff-face-Ancestor)
985 ;; Until custom.el for XEmacs starts supporting :inverse-video we do this.
986 ;; This means that some user customization may be trashed.
987 (and (featurep 'xemacs)
988 (ediff-has-face-support-p)
989 (not (ediff-color-display-p))
990 (copy-face 'modeline ediff-current-diff-face-Ancestor))
993 (defface ediff-fine-diff-A
994 (if (featurep 'emacs)
995 '((((class color) (min-colors 16))
996 (:foreground "Navy" :background "sky blue"))
997 (((class color))
998 (:foreground "white" :background "sky blue" :weight bold))
999 (t (:underline t :stipple "gray3")))
1000 '((((type tty)) (:foreground "white" :background "sky blue" :weight bold))
1001 (((class color)) (:foreground "Navy" :background "sky blue"))
1002 (t (:underline t :stipple "gray3"))))
1003 "Face for highlighting the refinement of the selected diff in buffer A."
1004 :group 'ediff-highlighting)
1005 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
1006 ;; this variable is set to nil, then again to the appropriate face.
1007 (defvar ediff-fine-diff-face-A 'ediff-fine-diff-A
1008 "Face for highlighting the fine differences in buffer A.
1009 DO NOT CHANGE this variable. Instead, use the customization
1010 widget to customize the actual face object `ediff-fine-diff-A'
1011 this variable represents.")
1012 (ediff-hide-face ediff-fine-diff-face-A)
1014 (defface ediff-fine-diff-B
1015 (if (featurep 'emacs)
1016 '((((class color) (min-colors 16))
1017 (:foreground "Black" :background "cyan"))
1018 (((class color))
1019 (:foreground "magenta3" :background "cyan3"))
1020 (t (:underline t :stipple "gray3")))
1021 '((((type tty)) (:foreground "magenta3" :background "cyan3"))
1022 (((class color)) (:foreground "Black" :background "cyan"))
1023 (t (:underline t :stipple "gray3"))))
1024 "Face for highlighting the refinement of the selected diff in buffer B."
1025 :group 'ediff-highlighting)
1026 ;; An internal variable. Ediff takes the face from here. When unhighlighting,
1027 ;; this variable is set to nil, then again to the appropriate face.
1028 (defvar ediff-fine-diff-face-B 'ediff-fine-diff-B
1029 "Face for highlighting the fine differences in buffer B.
1030 DO NOT CHANGE this variable. Instead, use the customization
1031 widget to customize the actual face object `ediff-fine-diff-B'
1032 this variable represents.")
1033 (ediff-hide-face ediff-fine-diff-face-B)
1035 (defface ediff-fine-diff-C
1036 (if (featurep 'emacs)
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)
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)
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")))
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)
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)
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)
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)
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)))
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)
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)
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)
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)
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)))
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)))
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")
1317 (add-hook 'ediff-quit-hook 'ediff-cleanup-mess)
1318 (add-hook 'ediff-suspend-hook 'ediff-default-suspend-function)
1321 ;;; Overlays
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.")
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
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)
1357 ovr-list))))))))
1360 (defvar ediff-toggle-read-only-function nil
1361 "*Specifies the function to be used to toggle read-only.
1362 If nil, Ediff tries to deduce the function from the binding of C-x C-q.
1363 Normally, this is the `toggle-read-only' function, but, if version
1364 control is used, it could be `vc-toggle-read-only' or `rcs-toggle-read-only'.")
1366 (defcustom ediff-make-buffers-readonly-at-startup nil
1367 "*Make all variant buffers read-only when Ediff starts up.
1368 This property can be toggled interactively."
1369 :type 'boolean
1370 :group 'ediff)
1373 ;;; Misc
1375 ;; if nil, this silences some messages
1376 (defvar ediff-verbose-p t)
1378 (defcustom ediff-autostore-merges 'group-jobs-only
1379 "*Save the results of merge jobs automatically.
1380 With value nil, don't save automatically. With value t, always
1381 save. Anything else means save automatically only if the merge
1382 job is part of a group of jobs, such as `ediff-merge-directory'
1383 or `ediff-merge-directory-revisions'."
1384 :type '(choice (const nil) (const t) (const group-jobs-only))
1385 :group 'ediff-merge)
1386 (make-variable-buffer-local 'ediff-autostore-merges)
1388 ;; file where the result of the merge is to be saved. used internally
1389 (ediff-defvar-local ediff-merge-store-file nil "")
1391 (defcustom ediff-merge-filename-prefix "merge_"
1392 "*Prefix to be attached to saved merge buffers."
1393 :type 'string
1394 :group 'ediff-merge)
1396 (defcustom ediff-no-emacs-help-in-control-buffer nil
1397 "*Non-nil means C-h should not invoke Emacs help in control buffer.
1398 Instead, C-h would jump to previous difference."
1399 :type 'boolean
1400 :group 'ediff)
1402 ;; This is the same as temporary-file-directory from Emacs 20.3.
1403 ;; Copied over here because XEmacs doesn't have this variable.
1404 (defcustom ediff-temp-file-prefix
1405 (file-name-as-directory
1406 (cond ((boundp 'temporary-file-directory) temporary-file-directory)
1407 ((fboundp 'temp-directory) (temp-directory))
1408 (t "/tmp/")))
1409 ;;; (file-name-as-directory
1410 ;;; (cond ((memq system-type '(ms-dos windows-nt))
1411 ;;; (or (getenv "TEMP") (getenv "TMPDIR") (getenv "TMP") "c:/temp"))
1412 ;;; ((memq system-type '(vax-vms axp-vms))
1413 ;;; (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "SYS$SCRATCH:"))
1414 ;;; (t
1415 ;;; (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "/tmp"))))
1416 "*Prefix to put on Ediff temporary file names.
1417 Do not start with `~/' or `~USERNAME/'."
1418 :type 'string
1419 :group 'ediff)
1421 (defcustom ediff-temp-file-mode 384 ; u=rw only
1422 "*Mode for Ediff temporary files."
1423 :type 'integer
1424 :group 'ediff)
1426 ;; Metacharacters that have to be protected from the shell when executing
1427 ;; a diff/diff3 command.
1428 (defcustom ediff-metachars "[ \t\n!\"#$&'()*;<=>?[\\^`{|~]"
1429 "Regexp that matches characters that must be quoted with `\\' in shell command line.
1430 This default should work without changes."
1431 :type 'string
1432 :group 'ediff)
1434 ;; needed to simulate frame-char-width in XEmacs.
1435 (defvar ediff-H-glyph (if (featurep 'xemacs) (make-glyph "H")))
1438 ;; Temporary file used for refining difference regions in buffer A.
1439 (ediff-defvar-local ediff-temp-file-A nil "")
1440 ;; Temporary file used for refining difference regions in buffer B.
1441 (ediff-defvar-local ediff-temp-file-B nil "")
1442 ;; Temporary file used for refining difference regions in buffer C.
1443 (ediff-defvar-local ediff-temp-file-C nil "")
1446 (defun ediff-file-remote-p (file-name)
1447 (file-remote-p file-name))
1449 ;; File for which we can get attributes, such as size or date
1450 (defun ediff-listable-file (file-name)
1451 (let ((handler (find-file-name-handler file-name 'file-local-copy)))
1452 (or (null handler) (eq handler 'dired-handler-fn))))
1455 (defsubst ediff-frame-unsplittable-p (frame)
1456 (cdr (assq 'unsplittable (frame-parameters frame))))
1458 (defsubst ediff-get-next-window (wind prev-wind)
1459 (cond ((window-live-p wind) wind)
1460 (prev-wind (next-window wind))
1461 (t (selected-window))
1465 (defsubst ediff-kill-buffer-carefully (buf)
1466 "Kill buffer BUF if it exists."
1467 (if (ediff-buffer-live-p buf)
1468 (kill-buffer (get-buffer buf))))
1470 (defsubst ediff-background-face (buf-type dif-num)
1471 ;; The value of dif-num is always 1- the one that user sees.
1472 ;; This is why even face is used when dif-num is odd.
1473 (ediff-get-symbol-from-alist
1474 buf-type (if (ediff-odd-p dif-num)
1475 ediff-even-diff-face-alist
1476 ediff-odd-diff-face-alist)
1480 ;; activate faces on diff regions in buffer
1481 (defun ediff-paint-background-regions-in-one-buffer (buf-type unhighlight)
1482 (let ((diff-vector
1483 (eval (ediff-get-symbol-from-alist
1484 buf-type ediff-difference-vector-alist)))
1485 overl diff-num)
1486 (mapcar (lambda (rec)
1487 (setq overl (ediff-get-diff-overlay-from-diff-record rec)
1488 diff-num (ediff-overlay-get overl 'ediff-diff-num))
1489 (if (ediff-overlay-buffer overl)
1490 ;; only if overlay is alive
1491 (ediff-set-overlay-face
1492 overl
1493 (if (not unhighlight)
1494 (ediff-background-face buf-type diff-num))))
1496 diff-vector)))
1499 ;; activate faces on diff regions in all buffers
1500 (defun ediff-paint-background-regions (&optional unhighlight)
1501 (ediff-paint-background-regions-in-one-buffer
1502 'A unhighlight)
1503 (ediff-paint-background-regions-in-one-buffer
1504 'B unhighlight)
1505 (ediff-paint-background-regions-in-one-buffer
1506 'C unhighlight)
1507 (ediff-paint-background-regions-in-one-buffer
1508 'Ancestor unhighlight))
1511 ;; arg is a record for a given diff in a difference vector
1512 ;; this record is itself a vector
1513 (defsubst ediff-clear-fine-diff-vector (diff-record)
1514 (if diff-record
1515 (mapc 'ediff-delete-overlay
1516 (ediff-get-fine-diff-vector-from-diff-record diff-record))))
1518 (defsubst ediff-clear-fine-differences-in-one-buffer (n buf-type)
1519 (ediff-clear-fine-diff-vector (ediff-get-difference n buf-type))
1520 (ediff-set-fine-diff-vector n buf-type nil))
1522 (defsubst ediff-clear-fine-differences (n)
1523 (ediff-clear-fine-differences-in-one-buffer n 'A)
1524 (ediff-clear-fine-differences-in-one-buffer n 'B)
1525 (if ediff-3way-job
1526 (ediff-clear-fine-differences-in-one-buffer n 'C)))
1529 (defsubst ediff-mouse-event-p (event)
1530 (if (featurep 'xemacs)
1531 (button-event-p event)
1532 (string-match "mouse" (format "%S" (event-basic-type event)))))
1535 (defsubst ediff-key-press-event-p (event)
1536 (if (featurep 'xemacs)
1537 (key-press-event-p event)
1538 (or (char-or-string-p event) (symbolp event))))
1540 (defun ediff-event-point (event)
1541 (cond ((ediff-mouse-event-p event)
1542 (if (featurep 'xemacs)
1543 (event-point event)
1544 (posn-point (event-start event))))
1545 ((ediff-key-press-event-p event)
1546 (point))
1547 (t (error "Error"))))
1549 (defun ediff-event-buffer (event)
1550 (cond ((ediff-mouse-event-p event)
1551 (if (featurep 'xemacs)
1552 (event-buffer event)
1553 (window-buffer (posn-window (event-start event)))))
1554 ((ediff-key-press-event-p event)
1555 (current-buffer))
1556 (t (error "Error"))))
1558 (defun ediff-event-key (event-or-key)
1559 (if (featurep 'xemacs)
1560 (if (eventp event-or-key) (event-key event-or-key) event-or-key)
1561 event-or-key))
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))))
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)))))
1577 (defsubst ediff-frame-char-width (frame)
1578 (if (featurep 'xemacs)
1579 (/ (frame-pixel-width frame) (frame-width frame))
1580 (frame-char-width frame)))
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))
1602 (defsubst ediff-spy-after-mouse ()
1603 (setq ediff-mouse-pixel-position (mouse-pixel-position)))
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))))
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)))
1629 ;; Some overlay functions
1631 (defsubst ediff-overlay-start (overl)
1632 (if (ediff-overlayp overl)
1633 (if (featurep 'xemacs)
1634 (extent-start-position overl)
1635 (overlay-start overl))))
1637 (defsubst ediff-overlay-end (overl)
1638 (if (ediff-overlayp overl)
1639 (if (featurep 'xemacs)
1640 (extent-end-position overl)
1641 (overlay-end overl))))
1643 (defsubst ediff-empty-overlay-p (overl)
1644 (= (ediff-overlay-start overl) (ediff-overlay-end overl)))
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)))
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)))
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)))))
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)))
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)))
1691 (if (featurep 'xemacs)
1692 ;; XEmacs requires addl argument
1693 (abbreviate-file-name file t)
1694 (abbreviate-file-name file)))))
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))))
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)
1715 (setq newlen (max 0 (- newlen 3)))
1716 (setq substr (substring str (max 0 (- len 1 newlen))))
1717 (concat "..." substr))))
1719 (defsubst ediff-nonempty-string-p (string)
1720 (and (stringp string) (not (string= string ""))))
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)))
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")
1756 (capitalize
1757 (subst-char-in-string ?- ?\s (substring (symbol-name jobname) 6))))
1761 ;; If ediff modified mode line, strip the modification
1762 (defsubst ediff-strip-mode-line-format ()
1763 (if (member (car mode-line-format) '(" A: " " B: " " C: " " Ancestor: "))
1764 (setq mode-line-format (nth 2 mode-line-format))))
1766 ;; Verify that we have a difference selected.
1767 (defsubst ediff-valid-difference-p (&optional n)
1768 (or n (setq n ediff-current-difference))
1769 (and (>= n 0) (< n ediff-number-of-differences)))
1771 (defsubst ediff-show-all-diffs (n)
1772 "Don't skip difference regions."
1773 nil)
1775 (defsubst ediff-message-if-verbose (string &rest args)
1776 (if ediff-verbose-p
1777 (apply 'message string args)))
1779 (defun ediff-file-attributes (filename attr-number)
1780 (if (ediff-listable-file filename)
1781 (nth attr-number (file-attributes filename))
1785 (defsubst ediff-file-size (filename)
1786 (ediff-file-attributes filename 7))
1787 (defsubst ediff-file-modtime (filename)
1788 (ediff-file-attributes filename 5))
1791 (defun ediff-convert-standard-filename (fname)
1792 (if (fboundp 'convert-standard-filename)
1793 (convert-standard-filename fname)
1794 fname))
1796 (if (featurep 'emacs)
1797 (defalias 'ediff-with-syntax-table 'with-syntax-table)
1798 (if (fboundp 'with-syntax-table)
1799 (defalias 'ediff-with-syntax-table 'with-syntax-table)
1800 ;; stolen from subr.el in emacs 21
1801 (defmacro ediff-with-syntax-table (table &rest body)
1802 (let ((old-table (make-symbol "table"))
1803 (old-buffer (make-symbol "buffer")))
1804 `(let ((,old-table (syntax-table))
1805 (,old-buffer (current-buffer)))
1806 (unwind-protect
1807 (progn
1808 (set-syntax-table (copy-syntax-table ,table))
1809 ,@body)
1810 (save-current-buffer
1811 (set-buffer ,old-buffer)
1812 (set-syntax-table ,old-table))))))))
1815 (provide 'ediff-init)
1819 ;; Local Variables:
1820 ;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
1821 ;; eval: (put 'ediff-with-current-buffer 'lisp-indent-hook 1)
1822 ;; eval: (put 'ediff-with-current-buffer 'edebug-form-spec '(form body))
1823 ;; End:
1825 ;; arch-tag: fa31d384-1e70-4d4b-82a7-3e96307c46f5
1826 ;;; ediff-init.el ends here