1 ;;; ediff-init.el --- Macros, variables, and defsubsts used by Ediff
3 ;; Copyright (C) 1994, 1995, 1996 Free Software Foundation, Inc.
5 ;; Author: Michael Kifer <kifer@cs.sunysb.edu>
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software; you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs; see the file COPYING. If not, write to the
21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 ;; Boston, MA 02111-1307, USA.
26 ;; Start compiler pacifier
27 (defvar ediff-metajob-name)
28 (defvar ediff-meta-buffer)
29 (defvar pm-color-alist)
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)
38 (defconst ediff-xemacs-p (string-match "XEmacs" emacs-version))
40 (defconst ediff-emacs-p (not ediff-xemacs-p))
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 ()
51 (device-type (selected-device))))
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 ;; ediff-force-faces is for those devices that support faces, but we don't know
60 (defun ediff-has-face-support-p ()
61 (cond ((ediff-window-display-p))
63 (ediff-emacs-p (memq (ediff-device-type) '(pc)))
64 (ediff-xemacs-p (memq (ediff-device-type) '(tty pc)))))
67 ;; Defines SYMBOL as an advertised local variable.
68 ;; Performs a defvar, then executes `make-variable-buffer-local' on
69 ;; the variable. Also sets the `permanent-local' property,
70 ;; so that `kill-all-local-variables' (called by major-mode setting
71 ;; commands) won't destroy Ediff control variables.
73 ;; Plagiarised from `emerge-defvar-local' for XEmacs.
74 (defmacro ediff-defvar-local (var value doc)
76 (defvar (, var) (, value) (, doc))
77 (make-variable-buffer-local '(, var))
78 (put '(, var) 'permanent-local t))))
82 ;; Variables that control each Ediff session---local to the control buffer.
85 ;; The buffer in which the A variant is stored.
86 (ediff-defvar-local ediff-buffer-A nil "")
87 ;; The buffer in which the B variant is stored.
88 (ediff-defvar-local ediff-buffer-B nil "")
89 ;; The buffer in which the C variant is stored.
90 (ediff-defvar-local ediff-buffer-C nil "")
92 (ediff-defvar-local ediff-ancestor-buffer nil "")
93 ;; The control buffer of ediff.
94 (ediff-defvar-local ediff-control-buffer nil "")
97 (defmacro ediff-odd-p (arg)
98 (` (eq (logand (, arg) 1) 1)))
100 (defmacro ediff-buffer-live-p (buf)
101 (` (and (, buf) (get-buffer (, buf)) (buffer-name (get-buffer (, buf))))))
103 (defmacro ediff-get-buffer (arg)
104 (` (cond ((eq (, arg) 'A) ediff-buffer-A)
105 ((eq (, arg) 'B) ediff-buffer-B)
106 ((eq (, arg) 'C) ediff-buffer-C)
107 ((eq (, arg) 'Ancestor) ediff-ancestor-buffer)
111 (defmacro ediff-get-value-according-to-buffer-type (buf-type list)
112 (` (cond ((eq (, buf-type) 'A) (nth 0 (, list)))
113 ((eq (, buf-type) 'B) (nth 1 (, list)))
114 ((eq (, buf-type) 'C) (nth 2 (, list))))))
116 (defmacro ediff-char-to-buftype (arg)
117 (` (cond ((memq (, arg) '(?a ?A)) 'A)
118 ((memq (, arg) '(?b ?B)) 'B)
119 ((memq (, arg) '(?c ?C)) 'C)
123 (defmacro ediff-get-difference (n buf-type)
126 (intern (format "ediff-difference-vector-%S" (, buf-type)))) (, n))))
128 ;; tell if it has been previously determined that the region has
129 ;; no diffs other than the white space and newlines
130 ;; The argument, N, is the diff region number used by Ediff to index the
131 ;; diff vector. It is 1 less than the number seen by the user.
133 ;; A difference vector has the form:
134 ;; [diff diff diff ...]
135 ;; where each diff has the form:
136 ;; [overlay fine-diff-vector no-fine-diffs-flag]
137 ;; fine-diff-vector is a vector [fine-diff fine-diff fine-diff ...]
138 (defmacro ediff-no-fine-diffs-p (n)
139 (` (aref (ediff-get-difference (, n) 'A) 2)))
141 (defmacro ediff-get-diff-overlay-from-diff-record (diff-rec)
142 (` (aref (, diff-rec) 0)))
144 (defmacro ediff-get-diff-overlay (n buf-type)
145 (` (ediff-get-diff-overlay-from-diff-record
146 (ediff-get-difference (, n) (, buf-type)))))
148 (defmacro ediff-get-fine-diff-vector-from-diff-record (diff-rec)
149 (` (aref (, diff-rec) 1)))
151 (defmacro ediff-set-fine-diff-vector (n buf-type fine-vec)
152 (` (aset (ediff-get-difference (, n) (, buf-type)) 1 (, fine-vec))))
154 (defmacro ediff-get-state-of-diff (n buf-type)
155 (` (if (ediff-buffer-live-p ediff-buffer-C)
156 (aref (ediff-get-difference (, n) (, buf-type)) 3))))
157 (defmacro ediff-set-state-of-diff (n buf-type val)
158 (` (aset (ediff-get-difference (, n) (, buf-type)) 3 (, val))))
159 (defmacro ediff-get-state-of-merge (n)
160 (` (if ediff-state-of-merge
161 (aref (aref ediff-state-of-merge (, n)) 0))))
162 (defmacro ediff-get-state-of-ancestor (n)
163 (` (if ediff-state-of-merge
164 (aref (aref ediff-state-of-merge (, n)) 1))))
165 (defmacro ediff-set-state-of-merge (n val)
166 (` (if ediff-state-of-merge
167 (aset (aref ediff-state-of-merge (, n)) 0 (, val)))))
169 ;; if flag is t, puts a mark on diff region saying that
170 ;; the differences are in white space only. If flag is nil,
171 ;; the region is marked as essential (i.e., differences are
172 ;; not just in the white space and newlines.)
173 (defmacro ediff-mark-diff-as-space-only (n flag)
174 (` (aset (ediff-get-difference (, n) 'A) 2 (, flag))))
176 (defmacro ediff-get-fine-diff-vector (n buf-type)
177 (` (ediff-get-fine-diff-vector-from-diff-record
178 (ediff-get-difference (, n) (, buf-type)))))
180 ;; Macro to switch to BUFFER, evaluate FORMS, returns to original buffer.
181 ;; Differs from `save-excursion' in that it doesn't save the point and mark.
182 ;; This is essentially `emerge-eval-in-buffer' with the test for live buffers."
183 (defmacro ediff-eval-in-buffer (buffer &rest forms)
184 (` (let ((StartBuffer (current-buffer)))
185 (if (ediff-buffer-live-p (, buffer))
188 (set-buffer (, buffer))
190 (set-buffer StartBuffer))
191 (or (eq this-command 'ediff-quit)
192 (error ediff-KILLED-VITAL-BUFFER))
196 (defsubst ediff-multiframe-setup-p ()
197 (and (ediff-window-display-p) ediff-multiframe))
199 (defmacro ediff-narrow-control-frame-p ()
200 (` (and (ediff-multiframe-setup-p)
201 (equal ediff-help-message ediff-brief-message-string))))
203 (defmacro ediff-3way-comparison-job ()
206 '(ediff-files3 ediff-buffers3))))
207 (ediff-defvar-local ediff-3way-comparison-job nil "")
209 (defmacro ediff-merge-job ()
214 ediff-merge-files-with-ancestor
215 ediff-merge-buffers-with-ancestor
216 ediff-merge-revisions
217 ediff-merge-revisions-with-ancestor))))
218 (ediff-defvar-local ediff-merge-job nil "")
220 (defmacro ediff-merge-with-ancestor-job ()
223 '(ediff-merge-files-with-ancestor
224 ediff-merge-buffers-with-ancestor
225 ediff-merge-revisions-with-ancestor))))
226 (ediff-defvar-local ediff-merge-with-ancestor-job nil "")
228 (defmacro ediff-3way-job ()
229 (` (or ediff-3way-comparison-job ediff-merge-job)))
230 (ediff-defvar-local ediff-3way-job nil "")
232 ;; A diff3 job is like a 3way job, but ediff-merge doesn't require the use
234 (defmacro ediff-diff3-job ()
235 (` (or ediff-3way-comparison-job
236 ediff-merge-with-ancestor-job)))
237 (ediff-defvar-local ediff-diff3-job nil "")
239 (defmacro ediff-windows-job ()
240 (` (memq ediff-job-name '(ediff-windows-wordwise ediff-windows-linewise))))
241 (ediff-defvar-local ediff-windows-job nil "")
243 (defmacro ediff-word-mode-job ()
244 (` (memq ediff-job-name '(ediff-windows-wordwise ediff-regions-wordwise))))
245 (ediff-defvar-local ediff-word-mode-job nil "")
247 (defmacro ediff-narrow-job ()
248 (` (memq ediff-job-name '(ediff-windows-wordwise
249 ediff-regions-wordwise
250 ediff-windows-linewise
251 ediff-regions-linewise))))
252 (ediff-defvar-local ediff-narrow-job nil "")
254 ;; Note: ediff-merge-directory-revisions-with-ancestor is not treated as an
255 ;; ancestor metajob, since it behaves differently.
256 (defsubst ediff-ancestor-metajob (&optional metajob)
257 (memq (or metajob ediff-metajob-name)
258 '(ediff-merge-directories-with-ancestor
259 ediff-merge-filegroups-with-ancestor)))
260 (defsubst ediff-revision-metajob (&optional metajob)
261 (memq (or metajob ediff-metajob-name)
262 '(ediff-directory-revisions
263 ediff-merge-directory-revisions
264 ediff-merge-directory-revisions-with-ancestor)))
265 (defsubst ediff-patch-metajob (&optional metajob)
266 (memq (or metajob ediff-metajob-name)
267 '(ediff-multifile-patch)))
268 ;; metajob involving only one group of files, such as multipatch or directory
270 (defsubst ediff-one-filegroup-metajob (&optional metajob)
271 (or (ediff-revision-metajob metajob)
272 (ediff-patch-metajob metajob)
275 (defsubst ediff-collect-diffs-metajob (&optional metajob)
276 (memq (or metajob ediff-metajob-name)
278 ediff-directory-revisions
279 ediff-merge-directories
280 ediff-merge-directories-with-ancestor
281 ediff-merge-directory-revisions
282 ediff-merge-directory-revisions-with-ancestor
285 (defsubst ediff-merge-metajob (&optional metajob)
286 (memq (or metajob ediff-metajob-name)
287 '(ediff-merge-directories
288 ediff-merge-directories-with-ancestor
289 ediff-merge-directory-revisions
290 ediff-merge-directory-revisions-with-ancestor
291 ediff-merge-filegroups-with-ancestor
295 (defsubst ediff-metajob3 (&optional metajob)
296 (memq (or metajob ediff-metajob-name)
297 '(ediff-merge-directories-with-ancestor
298 ediff-merge-filegroups-with-ancestor
301 (defsubst ediff-comparison-metajob3 (&optional metajob)
302 (memq (or metajob ediff-metajob-name)
303 '(ediff-directories3 ediff-filegroups3)))
305 (defsubst ediff-barf-if-not-control-buffer (&optional meta-buf)
306 (or (eq (if meta-buf ediff-meta-buffer ediff-control-buffer)
308 (error "%S: This command runs in Ediff Control Buffer only!"
314 (defvar ediff-before-setup-windows-hook nil
315 "*Hooks to run before Ediff sets its window configuration.
316 This can be used to save the previous window config, which can be restored
317 on ediff-quit or ediff-suspend.")
318 (defvar ediff-after-setup-windows-hook nil
319 "*Hooks to run after Ediff sets its window configuration.
320 This can be used to set up control window or icon in a desired place.")
321 (defvar ediff-before-setup-control-frame-hook nil
322 "*Hooks run before setting up the frame to display Ediff Control Panel.
323 Can be used to change control frame parameters to position it where it
325 (defvar ediff-after-setup-control-frame-hook nil
326 "*Hooks run after setting up the frame to display Ediff Control Panel.
327 Can be used to move the frame where it is desired.")
328 (defvar ediff-startup-hook nil
329 "*Hooks to run in the control buffer after Ediff has been set up.")
330 (defvar ediff-select-hook nil
331 "*Hooks to run after a difference has been selected.")
332 (defvar ediff-unselect-hook nil
333 "*Hooks to run after a difference has been unselected.")
334 (defvar ediff-prepare-buffer-hook nil
335 "*Hooks called after buffers A, B, and C are set up.")
336 (defvar ediff-load-hook nil
337 "*Hook run after Ediff is loaded. Can be used to change defaults.")
339 (defvar ediff-mode-hook nil
340 "*Hook run just after ediff-mode is set up in the control buffer.
341 This is done before any windows or frames are created. One can use it to
342 set local variables that determine how the display looks like.")
343 (defvar ediff-keymap-setup-hook nil
344 "*Hook run just after the default bindings in Ediff keymap are set up.")
346 (defvar ediff-display-help-hook nil
347 "*Hooks run after preparing the help message.")
349 (defvar ediff-suspend-hook (list 'ediff-default-suspend-function)
350 "*Hooks to run in the Ediff control buffer when Ediff is suspended.")
351 (defvar ediff-quit-hook (list 'ediff-cleanup-mess)
352 "*Hooks to run in the Ediff control buffer after finishing Ediff.")
353 (defvar ediff-cleanup-hook nil
354 "*Hooks to run on exiting Ediff but before killing the control buffer.
355 This is a place to do various cleanups, such as deleting the variant buffers.
356 Ediff provides a function, `ediff-janitor', as one such possible hook.")
357 (defvar ediff-quit-merge-hook 'ediff-maybe-save-and-delete-merge
358 "*Hooks to run before quitting a merge job.
359 The most common use is to save and delete the merge buffer.")
363 (defconst ediff-KILLED-VITAL-BUFFER
364 "You have killed a vital Ediff buffer---you must leave Ediff now!")
365 (defconst ediff-NO-DIFFERENCES
366 "Sorry, comparison of identical variants is not what I am made for...")
367 (defconst ediff-BAD-DIFF-NUMBER
368 ;; %S stands for this-command, %d - diff number, %d - max diff
369 "%S: Bad diff region number, %d. Valid numbers are 1 to %d")
370 (defconst ediff-BAD-INFO (format "
371 *** The Info file for Ediff, a part of the standard distribution
372 *** of %sEmacs, does not seem to be properly installed.
374 *** Please contact your system administrator. "
375 (if ediff-xemacs-p "X" "")))
377 ;; Selective browsing
379 (ediff-defvar-local ediff-skip-diff-region-function 'ediff-show-all-diffs
380 "Function that determines the next/previous diff region to show.
381 Should return t for regions to be ignored and nil otherwise.
382 This function gets a region number as an argument. The region number
383 is the one used internally by Ediff. It is 1 less than the number seen
386 (ediff-defvar-local ediff-hide-regexp-matches-function
387 'ediff-hide-regexp-matches
388 "Function to use in determining which regions to hide.
389 See the documentation string of `ediff-hide-regexp-matches' for details.")
390 (ediff-defvar-local ediff-focus-on-regexp-matches-function
391 'ediff-focus-on-regexp-matches
392 "Function to use in determining which regions to focus on.
393 See the documentation string of `ediff-focus-on-regexp-matches' for details.")
395 ;; Regexp that determines buf A regions to focus on when skipping to diff
396 (ediff-defvar-local ediff-regexp-focus-A "" "")
397 ;; Regexp that determines buf B regions to focus on when skipping to diff
398 (ediff-defvar-local ediff-regexp-focus-B "" "")
399 ;; Regexp that determines buf C regions to focus on when skipping to diff
400 (ediff-defvar-local ediff-regexp-focus-C "" "")
401 ;; connective that determines whether to focus regions that match both or
402 ;; one of the regexps
403 (ediff-defvar-local ediff-focus-regexp-connective 'and "")
405 ;; Regexp that determines buf A regions to ignore when skipping to diff
406 (ediff-defvar-local ediff-regexp-hide-A "" "")
407 ;; Regexp that determines buf B regions to ignore when skipping to diff
408 (ediff-defvar-local ediff-regexp-hide-B "" "")
409 ;; Regexp that determines buf C regions to ignore when skipping to diff
410 (ediff-defvar-local ediff-regexp-hide-C "" "")
411 ;; connective that determines whether to hide regions that match both or
412 ;; one of the regexps
413 (ediff-defvar-local ediff-hide-regexp-connective 'and "")
416 ;; Copying difference regions between buffers.
417 (ediff-defvar-local ediff-killed-diffs-alist nil
418 "A list of killed diffs.
419 A diff is saved here if it is replaced by a diff
420 from another buffer. This alist has the form:
421 \((num (buff-object . diff) (buff-object . diff) (buff-object . diff)) ...),
422 where some buffer-objects may be missing.")
426 ;;(defvar ediff-before-flag-bol (if ediff-emacs-p "->>\n" (make-glyph "->>\n"))
427 (defvar ediff-before-flag-bol (if ediff-xemacs-p (make-glyph "->>") "->>")
428 "*Flag placed above the highlighted block of differences.
429 Must end with newline.")
430 ;;(defvar ediff-after-flag-eol (if ediff-emacs-p "<<-\n" (make-glyph "<<-"))
431 (defvar ediff-after-flag-eol (if ediff-xemacs-p (make-glyph "<<-") "<<-")
432 "*Flag placed below the highlighted block of differences.
433 Must end with newline.")
435 (defvar ediff-before-flag-mol (if ediff-xemacs-p (make-glyph "->>") "->>")
436 "*Like ediff-before-flag, used when a difference starts in mid-line.")
437 (defvar ediff-after-flag-mol (if ediff-xemacs-p (make-glyph "<<-") "<<-")
438 "*Like ediff-after-flag, used when a difference starts in mid-line.")
441 (ediff-defvar-local ediff-use-faces t
442 "If t, differences are highlighted using faces, if device supports faces.
443 If nil, differences are highlighted using ASCII flags, ediff-before-flag
444 and ediff-after-flag. On a non-window system, differences are always
445 highlighted using ASCII flags.
446 This variable can be set either in .emacs or toggled interactively.
447 Use `setq-default' if setting it in .emacs")
449 ;; this indicates that diff regions are word-size, so fine diffs are
450 ;; permanently nixed; used in ediff-windows-wordwise and ediff-regions-wordwise
451 (ediff-defvar-local ediff-word-mode nil "")
452 ;; Name of the job (ediff-files, ediff-windows, etc.)
453 (ediff-defvar-local ediff-job-name nil "")
455 ;; Narrowing and ediff-region/windows support
456 ;; This is a list (overlay-A overlay-B overlay-C)
457 ;; If set, Ediff compares only those parts of buffers A/B/C that lie within
458 ;; the bounds of these overlays.
459 (ediff-defvar-local ediff-narrow-bounds nil "")
461 ;; List (overlay-A overlay-B overlay-C), where each overlay spans the
462 ;; entire corresponding buffer.
463 (ediff-defvar-local ediff-wide-bounds nil "")
465 ;; Current visibility boundaries in buffers A, B, and C.
466 ;; This is also a list of overlays. When the user toggles narrow/widen,
467 ;; this list changes from ediff-wide-bounds to ediff-narrow-bounds.
469 (ediff-defvar-local ediff-visible-bounds nil "")
471 (ediff-defvar-local ediff-start-narrowed t
472 "Non-nil means start narrowed, if doing ediff-windows-* or ediff-regions-*")
473 (ediff-defvar-local ediff-quit-widened t
474 "*Non-nil means: when finished, Ediff widens buffers A/B.
475 Actually, Ediff restores the scope of visibility that existed at startup.")
476 (defvar ediff-keep-variants t
477 "*Nil means that non-modified variant buffers should be removed after some
479 Supplying a prefix argument to the quit command `q' temporarily reverses the
480 meaning of this variable.")
482 (ediff-defvar-local ediff-highlight-all-diffs t
483 "If nil, only the selected differences are highlighted.
484 This variable can be set either in .emacs or toggled interactively, using
485 ediff-toggle-hilit. Use `setq-default' to set it.")
487 ;; A var local to each control panel buffer. Indicates highlighting style
488 ;; in effect for this buffer: `face', `ascii', nil -- temporarily
489 ;; unhighlighted, `off' -- turned off \(on a dumb terminal only\).
490 (ediff-defvar-local ediff-highlighting-style nil "")
493 ;; The suffix of the control buffer name.
494 (ediff-defvar-local ediff-control-buffer-suffix nil "")
495 ;; Same as ediff-control-buffer-suffix, but without <,>.
496 ;; It's a number rather than string.
497 (ediff-defvar-local ediff-control-buffer-number nil "")
500 ;; The original values of ediff-protected-variables for buffer A
501 (ediff-defvar-local ediff-buffer-values-orig-A nil "")
502 ;; The original values of ediff-protected-variables for buffer B
503 (ediff-defvar-local ediff-buffer-values-orig-B nil "")
504 ;; The original values of ediff-protected-variables for buffer C
505 (ediff-defvar-local ediff-buffer-values-orig-C nil "")
506 ;; The original values of ediff-protected-variables for buffer Ancestor
507 (ediff-defvar-local ediff-buffer-values-orig-Ancestor nil "")
508 ;; Buffer-local variables to be saved then restored during Ediff sessions
509 ;; Buffer-local variables to be saved then restored during Ediff sessions
510 (defconst ediff-protected-variables '(
514 ;; Vector of differences between the variants. Each difference is
515 ;; represented by a vector of two overlays plus a vector of fine diffs,
516 ;; plus a no-fine-diffs flag. The first overlay spans the
517 ;; difference region in the A buffer and the second overlays the diff in
518 ;; the B buffer. If a difference section is empty, the corresponding
519 ;; overlay's endpoints coincide.
521 ;; The precise form of a difference vector for one buffer is:
522 ;; [diff diff diff ...]
523 ;; where each diff has the form:
524 ;; [diff-overlay fine-diff-vector no-fine-diffs-flag state-of-difference]
525 ;; fine-diff-vector is a vector [fine-diff-overlay fine-diff-overlay ...]
526 ;; no-fine-diffs-flag says if there are fine differences.
527 ;; state-of-difference is A, B, C, or nil, indicating which buffer is
528 ;; different from the other two (used only in 3-way jobs.
529 (ediff-defvar-local ediff-difference-vector-A nil "")
530 (ediff-defvar-local ediff-difference-vector-B nil "")
531 (ediff-defvar-local ediff-difference-vector-C nil "")
532 (ediff-defvar-local ediff-difference-vector-Ancestor nil "")
534 ;; [ status status status ...]
535 ;; Each status: [state-of-merge state-of-ancestor]
536 ;; state-of-merge is default-A, default-B, prefer-A, or prefer-B. It
537 ;; indicates the way a diff region was created in buffer C.
538 ;; state-of-ancestor says if the corresponding region in ancestor buffer is
540 (ediff-defvar-local ediff-state-of-merge nil "")
542 ;; The difference that is currently selected.
543 (ediff-defvar-local ediff-current-difference -1 "")
544 ;; Number of differences found.
545 (ediff-defvar-local ediff-number-of-differences nil "")
547 ;; Buffer containing the output of diff, which is used by Ediff to step
549 (ediff-defvar-local ediff-diff-buffer nil "")
550 ;; Like ediff-diff-buffer, but contains context diff. It is not used by
551 ;; Ediff, but it is saved in a file, if user requests so.
552 (ediff-defvar-local ediff-custom-diff-buffer nil "")
553 ;; Buffer used for diff-style fine differences between regions.
554 (ediff-defvar-local ediff-fine-diff-buffer nil "")
555 ;; Temporary buffer used for computing fine differences.
556 (defconst ediff-tmp-buffer " *ediff-tmp*" "")
557 ;; Buffer used for messages
558 (defconst ediff-msg-buffer " *ediff-message*" "")
559 ;; Buffer containing the output of diff when diff returns errors.
560 (ediff-defvar-local ediff-error-buffer nil "")
561 ;; Buffer to display debug info
562 (ediff-defvar-local ediff-debug-buffer "*ediff-debug*" "")
564 ;; List of ediff control panels associated with each buffer A/B/C/Ancestor.
565 ;; Not used any more, but may be needed in the future.
566 (ediff-defvar-local ediff-this-buffer-ediff-sessions nil "")
568 ;; to be deleted in due time
569 ;; List of difference overlays disturbed by working with the current diff.
570 (defvar ediff-disturbed-overlays nil "")
572 ;; Priority of non-selected overlays.
573 (defvar ediff-shadow-overlay-priority 100 "")
575 (defvar ediff-version-control-package 'vc
576 "Version control package used.
577 Currently, Ediff supports vc.el, rcs.el, pcl-cvs.el, and generic-sc.el. The
578 standard Emacs interface to RCS, CVS, SCCS, etc., is vc.el. However, some
579 people find the other two packages more convenient. Set this variable to the
580 appropriate symbol: `rcs', `pcl-cvs', or `generic-sc' if you so desire.")
585 (fset 'ediff-read-event (symbol-function 'next-command-event))
586 (fset 'ediff-overlayp (symbol-function 'extentp))
587 (fset 'ediff-make-overlay (symbol-function 'make-extent))
588 (fset 'ediff-delete-overlay (symbol-function 'delete-extent)))
589 (fset 'ediff-read-event (symbol-function 'read-event))
590 (fset 'ediff-overlayp (symbol-function 'overlayp))
591 (fset 'ediff-overlayp (symbol-function 'overlayp))
592 (fset 'ediff-make-overlay (symbol-function 'make-overlay))
593 (fset 'ediff-delete-overlay (symbol-function 'delete-overlay)))
595 ;; Check the current version against the major and minor version numbers
596 ;; using op: cur-vers op major.minor If emacs-major-version or
597 ;; emacs-minor-version are not defined, we assume that the current version
598 ;; is hopelessly outdated. We assume that emacs-major-version and
599 ;; emacs-minor-version are defined. Otherwise, for Emacs/XEmacs 19, if the
600 ;; current minor version is < 10 (xemacs) or < 23 (emacs) the return value
601 ;; will be nil (when op is =, >, or >=) and t (when op is <, <=), which may be
602 ;; incorrect. However, this gives correct result in our cases, since we are
603 ;; testing for sufficiently high Emacs versions.
604 (defun ediff-check-version (op major minor &optional type-of-emacs)
605 (if (and (boundp 'emacs-major-version) (boundp 'emacs-minor-version))
606 (and (cond ((eq type-of-emacs 'xemacs) ediff-xemacs-p)
607 ((eq type-of-emacs 'emacs) ediff-emacs-p)
609 (cond ((eq op '=) (and (= emacs-minor-version minor)
610 (= emacs-major-version major)))
611 ((memq op '(> >= < <=))
612 (and (or (funcall op emacs-major-version major)
613 (= emacs-major-version major))
614 (if (= emacs-major-version major)
615 (funcall op emacs-minor-version minor)
618 (error "%S: Invalid op in ediff-check-version" op))))
619 (cond ((memq op '(= > >=)) nil)
620 ((memq op '(< <=)) t))))
623 ;;;; warn if it is a wrong version of emacs
624 ;;(if (or (ediff-check-version '< 19 29 'emacs)
625 ;; (ediff-check-version '< 19 12 'xemacs))
627 ;; (with-output-to-temp-buffer ediff-msg-buffer
628 ;; (switch-to-buffer ediff-msg-buffer)
632 ;;This version of Ediff requires
634 ;;\t Emacs 19.29 and higher
636 ;;\t XEmacs 19.12 and higher
638 ;;It is unlikely to work under Emacs version %s
639 ;;that you are using... " emacs-version))
640 ;; (if noninteractive
644 ;; (insert "\n\nType any key to continue...")
645 ;; (ediff-read-event)))
646 ;; (kill-buffer ediff-msg-buffer)))
648 ;; A fix for NeXT Step
649 ;; Should probably be eliminated in later versions.
650 (if (and (ediff-window-display-p) (eq (ediff-device-type) 'ns))
652 (fset 'x-display-color-p (symbol-function 'ns-display-color-p))
653 (fset 'x-color-defined-p (symbol-function 'ns-color-defined-p))
654 (fset 'x-display-pixel-height (symbol-function 'ns-display-pixel-height))
655 (fset 'x-display-pixel-width (symbol-function 'ns-display-pixel-width))
659 (defsubst ediff-color-display-p ()
662 (eq (device-class (selected-device)) 'color)))
665 (if (ediff-has-face-support-p)
668 (fset 'ediff-valid-color-p (symbol-function 'valid-color-name-p))
669 (fset 'ediff-get-face (symbol-function 'get-face)))
670 ;; Temporary fix for OS/2 port of Emacs
671 ;; pm-win.el in PM-Emacs should be fixed.
672 (if (eq (ediff-device-type) 'pm)
673 (fset 'ediff-valid-color-p
674 (function (lambda (color) (assoc color pm-color-alist))))
675 (fset 'ediff-valid-color-p (symbol-function 'x-color-defined-p)))
676 (fset 'ediff-get-face (symbol-function 'internal-get-face))))
678 (if (ediff-window-display-p)
681 (fset 'ediff-display-pixel-width
682 (symbol-function 'device-pixel-width))
683 (fset 'ediff-display-pixel-height
684 (symbol-function 'device-pixel-height)))
685 (fset 'ediff-display-pixel-width
686 (symbol-function 'x-display-pixel-width))
687 (fset 'ediff-display-pixel-height
688 (symbol-function 'x-display-pixel-height))))
691 (defun ediff-make-current-diff-overlay (type)
692 (if (ediff-has-face-support-p)
693 (let ((overlay (intern (format "ediff-current-diff-overlay-%S" type)))
694 (buffer (ediff-get-buffer type))
697 (intern (format "ediff-current-diff-face-%S" type))))))
699 (ediff-make-bullet-proof-overlay (point-max) (point-max) buffer))
700 (ediff-set-overlay-face (symbol-value overlay) face)
701 (ediff-overlay-put (symbol-value overlay) 'ediff ediff-control-buffer))
704 (defun ediff-set-overlay-face (extent face)
705 (ediff-overlay-put extent 'face face)
706 (ediff-overlay-put extent 'help-echo 'ediff-region-help-echo))
708 ;; This does nothing in Emacs, since overlays there have no help-echo property
709 (defun ediff-region-help-echo (extent)
710 (let ((is-current (ediff-overlay-get extent 'ediff))
711 (face (ediff-overlay-get extent 'face))
712 (diff-num (ediff-overlay-get extent 'ediff-diff-num))
715 ;; This happens only for refinement overlays
716 (setq face-help (and face (get face 'ediff-help-echo)))
718 (cond ((and is-current diff-num) ; current diff region
719 (format "Difference region %S -- current" (1+ diff-num)))
720 (face-help) ; refinement of current diff region
721 (diff-num ; non-current
722 (format "Difference region %S -- non-current" (1+ diff-num)))
726 (defun ediff-set-face (ground face color)
727 "Set face foreground/background."
728 (if (ediff-has-face-support-p)
729 (if (ediff-valid-color-p color)
730 (if (eq ground 'foreground)
731 (set-face-foreground face color)
732 (set-face-background face color))
734 '(ediff-current-diff-face-A
735 ediff-current-diff-face-B
736 ediff-current-diff-face-C
737 ediff-current-diff-face-Ancestor))
738 (copy-face 'highlight face))
740 '(ediff-fine-diff-face-A
741 ediff-fine-diff-face-B
742 ediff-fine-diff-face-C
743 ediff-fine-diff-face-Ancestor))
744 (copy-face 'secondary-selection face)
745 (set-face-underline-p face t))
747 '(ediff-even-diff-face-A
748 ediff-odd-diff-face-A
749 ediff-even-diff-face-B ediff-odd-diff-face-B
750 ediff-even-diff-face-C ediff-odd-diff-face-C
751 ediff-even-diff-face-Ancestor
752 ediff-odd-diff-face-Ancestor))
753 (copy-face 'secondary-selection face))))
756 (defun ediff-set-face-pixmap (face pixmap)
757 "Set face pixmap on a monochrome display."
758 (if (and (ediff-window-display-p) (not (ediff-color-display-p)))
760 (set-face-background-pixmap face pixmap)
762 (message "Pixmap not found for %S: %s" (face-name face) pixmap)
765 (defun ediff-hide-face (face)
766 (if (and (ediff-has-face-support-p) ediff-emacs-p)
767 (add-to-list 'facemenu-unlisted-faces face)))
769 (defvar ediff-current-diff-face-A
770 (if (ediff-has-face-support-p)
772 (make-face 'ediff-current-diff-face-A)
773 (ediff-hide-face 'ediff-current-diff-face-A)
774 (or (face-differs-from-default-p 'ediff-current-diff-face-A)
775 (cond ((ediff-color-display-p)
777 'foreground 'ediff-current-diff-face-A "firebrick")
779 'background 'ediff-current-diff-face-A "pale green"))
782 (copy-face 'modeline 'ediff-current-diff-face-A)
783 (copy-face 'highlight 'ediff-current-diff-face-A))
785 'ediff-current-diff-face-A))
786 "Face for highlighting the selected difference in buffer A.")
788 (defvar ediff-current-diff-face-B
789 (if (ediff-has-face-support-p)
791 (make-face 'ediff-current-diff-face-B)
792 (ediff-hide-face 'ediff-current-diff-face-B)
793 (or (face-differs-from-default-p 'ediff-current-diff-face-B)
794 (cond ((ediff-color-display-p)
796 'foreground 'ediff-current-diff-face-B "DarkOrchid")
798 'background 'ediff-current-diff-face-B "Yellow"))
801 (copy-face 'modeline 'ediff-current-diff-face-B)
802 (copy-face 'highlight 'ediff-current-diff-face-B))
804 'ediff-current-diff-face-B))
805 "Face for highlighting the selected difference in buffer B.")
808 (defvar ediff-current-diff-face-C
809 (if (ediff-has-face-support-p)
811 (make-face 'ediff-current-diff-face-C)
812 (ediff-hide-face 'ediff-current-diff-face-C)
813 (or (face-differs-from-default-p 'ediff-current-diff-face-C)
814 (cond ((ediff-color-display-p)
816 'foreground 'ediff-current-diff-face-C "Navy")
818 'background 'ediff-current-diff-face-C "Pink"))
821 (copy-face 'modeline 'ediff-current-diff-face-C)
822 (copy-face 'highlight 'ediff-current-diff-face-C))
824 'ediff-current-diff-face-C))
825 "Face for highlighting the selected difference in buffer C.")
827 (defvar ediff-current-diff-face-Ancestor
828 (if (ediff-has-face-support-p)
830 (make-face 'ediff-current-diff-face-Ancestor)
831 (ediff-hide-face 'ediff-current-diff-face-Ancestor)
832 (or (face-differs-from-default-p 'ediff-current-diff-face-Ancestor)
834 'ediff-current-diff-face-C 'ediff-current-diff-face-Ancestor))))
835 "Face for highlighting the selected difference in the ancestor buffer.")
837 (defvar ediff-fine-diff-pixmap "gray3"
838 "Pixmap to use for highlighting fine differences.")
839 (defvar ediff-odd-diff-pixmap "gray1"
840 "Pixmap to use for highlighting odd differences.")
841 (defvar ediff-even-diff-pixmap "Stipple"
842 "Pixmap to use for highlighting even differences.")
844 (defvar ediff-fine-diff-face-A
845 (if (ediff-has-face-support-p)
847 (make-face 'ediff-fine-diff-face-A)
848 (ediff-hide-face 'ediff-fine-diff-face-A)
849 (or (face-differs-from-default-p 'ediff-fine-diff-face-A)
850 (cond ((ediff-color-display-p)
851 (ediff-set-face 'foreground 'ediff-fine-diff-face-A
853 (ediff-set-face 'background 'ediff-fine-diff-face-A
856 (set-face-underline-p 'ediff-fine-diff-face-A t)
857 (ediff-set-face-pixmap 'ediff-fine-diff-face-A
858 ediff-fine-diff-pixmap)
860 'ediff-fine-diff-face-A))
861 "Face for highlighting the refinement of the selected diff in buffer A.")
863 (defvar ediff-fine-diff-face-B
864 (if (ediff-has-face-support-p)
866 (make-face 'ediff-fine-diff-face-B)
867 (ediff-hide-face 'ediff-fine-diff-face-B)
868 (or (face-differs-from-default-p 'ediff-fine-diff-face-B)
869 (cond ((ediff-color-display-p)
870 (ediff-set-face 'foreground 'ediff-fine-diff-face-B "Black")
871 (ediff-set-face 'background 'ediff-fine-diff-face-B "cyan"))
873 (set-face-underline-p 'ediff-fine-diff-face-B t)
874 (ediff-set-face-pixmap 'ediff-fine-diff-face-B
875 ediff-fine-diff-pixmap)
877 'ediff-fine-diff-face-B))
878 "Face for highlighting the refinement of the selected diff in buffer B.")
880 (defvar ediff-fine-diff-face-C
881 (if (ediff-has-face-support-p)
883 (make-face 'ediff-fine-diff-face-C)
884 (ediff-hide-face 'ediff-fine-diff-face-C)
885 (or (face-differs-from-default-p 'ediff-fine-diff-face-C)
886 (cond ((ediff-color-display-p)
887 (ediff-set-face 'foreground 'ediff-fine-diff-face-C "black")
889 'background 'ediff-fine-diff-face-C "Turquoise"))
891 (set-face-underline-p 'ediff-fine-diff-face-C t)
892 (ediff-set-face-pixmap 'ediff-fine-diff-face-C
893 ediff-fine-diff-pixmap)
895 'ediff-fine-diff-face-C))
896 "Face for highlighting the refinement of the selected diff in buffer C.")
898 (defvar ediff-fine-diff-face-Ancestor
899 (if (ediff-has-face-support-p)
901 (make-face 'ediff-fine-diff-face-Ancestor)
902 (ediff-hide-face 'ediff-fine-diff-face-Ancestor)
903 (or (face-differs-from-default-p 'ediff-fine-diff-face-Ancestor)
906 'ediff-fine-diff-face-C 'ediff-fine-diff-face-Ancestor)
907 (ediff-set-face-pixmap 'ediff-fine-diff-face-Ancestor
908 ediff-fine-diff-pixmap))
910 "Face highlighting refinements of the selected diff in ancestor buffer.
911 Presently, this is not used, as difference regions are not refined in the
914 (defvar ediff-even-diff-face-A
915 (if (ediff-has-face-support-p)
917 (make-face 'ediff-even-diff-face-A)
918 (ediff-hide-face 'ediff-even-diff-face-A)
919 (or (face-differs-from-default-p 'ediff-even-diff-face-A)
920 (cond ((ediff-color-display-p)
922 'foreground 'ediff-even-diff-face-A "black")
924 'background 'ediff-even-diff-face-A "light grey"))
926 (copy-face 'italic 'ediff-even-diff-face-A)
927 (ediff-set-face-pixmap 'ediff-even-diff-face-A
928 ediff-even-diff-pixmap)
930 'ediff-even-diff-face-A))
931 "Face used to highlight even-numbered differences in buffer A.")
933 (defvar ediff-even-diff-face-B
934 (if (ediff-has-face-support-p)
936 (make-face 'ediff-even-diff-face-B)
937 (ediff-hide-face 'ediff-even-diff-face-B)
938 (or (face-differs-from-default-p 'ediff-even-diff-face-B)
939 (cond ((ediff-color-display-p)
941 'foreground 'ediff-even-diff-face-B "White")
943 'background 'ediff-even-diff-face-B "Gray"))
945 (copy-face 'italic 'ediff-even-diff-face-B)
946 (ediff-set-face-pixmap 'ediff-even-diff-face-B
947 ediff-even-diff-pixmap)
949 'ediff-even-diff-face-B))
950 "Face used to highlight even-numbered differences in buffer B.")
952 (defvar ediff-even-diff-face-C
953 (if (ediff-has-face-support-p)
955 (make-face 'ediff-even-diff-face-C)
956 (ediff-hide-face 'ediff-even-diff-face-C)
957 (or (face-differs-from-default-p 'ediff-even-diff-face-C)
959 (copy-face 'ediff-even-diff-face-A 'ediff-even-diff-face-C)
960 (ediff-set-face-pixmap 'ediff-even-diff-face-C
961 ediff-even-diff-pixmap)))
962 'ediff-even-diff-face-C))
963 "Face used to highlight even-numbered differences in buffer C.")
965 (defvar ediff-even-diff-face-Ancestor
966 (if (ediff-has-face-support-p)
968 (make-face 'ediff-even-diff-face-Ancestor)
969 (ediff-hide-face 'ediff-even-diff-face-Ancestor)
970 (or (face-differs-from-default-p 'ediff-even-diff-face-Ancestor)
973 'ediff-even-diff-face-C 'ediff-even-diff-face-Ancestor)
974 (ediff-set-face-pixmap 'ediff-even-diff-face-Ancestor
975 ediff-even-diff-pixmap)))
976 'ediff-even-diff-face-Ancestor))
977 "Face highlighting even-numbered differences in the ancestor buffer.")
979 (defvar ediff-odd-diff-face-A
980 (if (ediff-has-face-support-p)
982 (make-face 'ediff-odd-diff-face-A)
983 (ediff-hide-face 'ediff-odd-diff-face-A)
984 (or (face-differs-from-default-p 'ediff-odd-diff-face-A)
985 (cond ((ediff-color-display-p)
987 'foreground 'ediff-odd-diff-face-A "White")
989 'background 'ediff-odd-diff-face-A "Gray"))
991 (copy-face 'italic 'ediff-odd-diff-face-A)
992 (ediff-set-face-pixmap 'ediff-odd-diff-face-A
993 ediff-odd-diff-pixmap)
995 'ediff-odd-diff-face-A))
996 "Face used to highlight odd-numbered differences in buffer A.")
998 (defvar ediff-odd-diff-face-B
999 (if (ediff-has-face-support-p)
1001 (make-face 'ediff-odd-diff-face-B)
1002 (ediff-hide-face 'ediff-odd-diff-face-B)
1003 (or (face-differs-from-default-p 'ediff-odd-diff-face-B)
1004 (cond ((ediff-color-display-p)
1006 'foreground 'ediff-odd-diff-face-B "Black")
1008 'background 'ediff-odd-diff-face-B "light grey"))
1010 (copy-face 'italic 'ediff-odd-diff-face-B)
1011 (ediff-set-face-pixmap 'ediff-odd-diff-face-B
1012 ediff-odd-diff-pixmap)
1014 'ediff-odd-diff-face-B))
1015 "Face used to highlight odd-numbered differences in buffer B.")
1017 (defvar ediff-odd-diff-face-C
1018 (if (ediff-has-face-support-p)
1020 (make-face 'ediff-odd-diff-face-C)
1021 (ediff-hide-face 'ediff-odd-diff-face-C)
1022 (or (face-differs-from-default-p 'ediff-odd-diff-face-C)
1024 (copy-face 'ediff-odd-diff-face-A 'ediff-odd-diff-face-C)
1025 (ediff-set-face-pixmap 'ediff-odd-diff-face-C
1026 ediff-odd-diff-pixmap)))
1027 'ediff-odd-diff-face-C))
1028 "Face used to highlight odd-numbered differences in buffer C.")
1030 (defvar ediff-odd-diff-face-Ancestor
1031 (if (ediff-has-face-support-p)
1033 (make-face 'ediff-odd-diff-face-Ancestor)
1034 (ediff-hide-face 'ediff-odd-diff-face-Ancestor)
1035 (or (face-differs-from-default-p 'ediff-odd-diff-face-Ancestor)
1037 (copy-face 'ediff-odd-diff-face-C 'ediff-odd-diff-face-Ancestor)
1038 (ediff-set-face-pixmap 'ediff-odd-diff-face-Ancestor
1039 ediff-odd-diff-pixmap)))
1040 'ediff-odd-diff-face-Ancestor))
1041 "Face used to highlight even-numbered differences in the ancestor buffer.")
1044 (put 'ediff-fine-diff-face-A 'ediff-help-echo
1045 "A `refinement' of the current difference region")
1046 (put 'ediff-fine-diff-face-B 'ediff-help-echo
1047 "A `refinement' of the current difference region")
1048 (put 'ediff-fine-diff-face-C 'ediff-help-echo
1049 "A `refinement' of the current difference region")
1050 (put 'ediff-fine-diff-face-Ancestor 'ediff-help-echo
1051 "A `refinement' of the current difference region")
1056 (ediff-defvar-local ediff-current-diff-overlay-A nil
1057 "Overlay for the current difference region in buffer A.")
1058 (ediff-defvar-local ediff-current-diff-overlay-B nil
1059 "Overlay for the current difference region in buffer B.")
1060 (ediff-defvar-local ediff-current-diff-overlay-C nil
1061 "Overlay for the current difference region in buffer C.")
1062 (ediff-defvar-local ediff-current-diff-overlay-Ancestor nil
1063 "Overlay for the current difference region in the ancestor buffer.")
1065 ;; Compute priority of ediff overlay.
1066 (defun ediff-highest-priority (start end buffer)
1067 (let ((pos (max 1 (1- start)))
1070 (1+ ediff-shadow-overlay-priority)
1071 (ediff-eval-in-buffer buffer
1072 (while (< pos (min (point-max) (1+ end)))
1073 (setq ovr-list (append (overlays-at pos) ovr-list))
1074 (setq pos (next-overlay-change pos)))
1079 (or (ediff-overlay-get ovr 'priority) 0)
1086 (defvar ediff-toggle-read-only-function nil
1087 "*Specifies the function to be used to toggle read-only.
1088 If nil, Ediff tries to deduce the function from the binding of C-x C-q.
1089 Normally, this is the `toggle-read-only' function, but, if version
1090 control is used, it could be `vc-toggle-read-only' or `rcs-toggle-read-only'.")
1095 ;; if nil, this silences some messages
1096 (defconst ediff-verbose-p t)
1098 (ediff-defvar-local ediff-autostore-merges 'group-jobs-only
1099 "*Save the results of merge jobs automatically.
1100 Nil means don't save automatically. t means always save. Anything but nil or t
1101 means save automatically only if the merge job is part of a group of jobs, such
1102 as `ediff-merge-directory' or `ediff-merge-directory-revisions'.")
1104 ;; file where the result of the merge is to be saved. used internally
1105 (ediff-defvar-local ediff-merge-store-file nil "")
1107 (defvar ediff-no-emacs-help-in-control-buffer nil
1108 "*Non-nil means C-h should not invoke Emacs help in control buffer.
1109 Instead, C-h jumps to previous difference.")
1111 (defvar ediff-temp-file-prefix
1112 (let ((env (or (getenv "TMPDIR")
1116 (setq d (if (and env (> (length env) 0))
1118 (cond ((memq system-type '(vax-vms axp-vms)) "SYS$SCRATCH:")
1119 ((eq system-type 'ms-dos) "c:/")
1121 ;; The following is to make sure we get something to which we can
1122 ;; add directory levels on VMS.
1123 (setq d (file-name-as-directory (directory-file-name d)))
1125 "*Prefix to put on Ediff temporary file names.
1126 Do not start with `~/' or `~user-name/'.")
1128 (defvar ediff-temp-file-mode 384 ; u=rw only
1129 "*Mode for Ediff temporary files.")
1131 ;; Metacharacters that have to be protected from the shell when executing
1132 ;; a diff/diff3 command.
1133 (defvar ediff-metachars "[ \t\n!\"#$&'()*;<=>?[\\^`{|~]"
1134 "Characters that must be quoted with \\ when used in a shell command line.
1135 More precisely, a regexp to match any one such character.")
1137 ;; needed to simulate frame-char-width in XEmacs.
1138 (defvar ediff-H-glyph (if ediff-xemacs-p (make-glyph "H")))
1141 (ediff-defvar-local ediff-temp-file-A nil
1142 "Temporary file used for refining difference regions in buffer A.")
1143 (ediff-defvar-local ediff-temp-file-B nil
1144 "Temporary file used for refining difference regions in buffer B.")
1145 (ediff-defvar-local ediff-temp-file-C nil
1146 "Temporary file used for refining difference regions in buffer C.")
1148 ;;; In-line functions
1150 (defsubst ediff-file-remote-p (file-name)
1152 (car (if ediff-xemacs-p
1153 (ange-ftp-ftp-path file-name)
1154 (ange-ftp-ftp-name file-name))))
1157 (defsubst ediff-frame-unsplittable-p (frame)
1158 (cdr (assq 'unsplittable (frame-parameters frame))))
1160 (defsubst ediff-get-next-window (wind prev-wind)
1161 (or (window-live-p wind)
1162 (setq wind (if prev-wind
1164 (selected-window)))))
1167 (defsubst ediff-kill-buffer-carefully (buf)
1168 "Kill buffer BUF if it exists."
1169 (if (ediff-buffer-live-p buf)
1170 (kill-buffer (get-buffer buf))))
1173 ;; activate faces on diff regions in buffer
1174 (defun ediff-paint-background-regions-in-one-buffer (buf-type unhighlight)
1176 (eval (intern (format "ediff-difference-vector-%S" buf-type))))
1180 (setq overl (ediff-get-diff-overlay-from-diff-record rec)
1181 diff-num (ediff-overlay-get overl 'ediff-diff-num))
1182 (ediff-set-overlay-face
1184 (if (not unhighlight)
1185 (ediff-background-face buf-type diff-num))
1190 ;; activate faces on diff regions in all buffers
1191 (defun ediff-paint-background-regions (&optional unhighlight)
1192 (ediff-paint-background-regions-in-one-buffer
1194 (ediff-paint-background-regions-in-one-buffer
1196 (ediff-paint-background-regions-in-one-buffer
1198 (ediff-paint-background-regions-in-one-buffer
1199 'Ancestor unhighlight))
1201 (defun ediff-highlight-diff-in-one-buffer (n buf-type)
1202 (if (ediff-buffer-live-p (ediff-get-buffer buf-type))
1203 (let* ((buff (ediff-get-buffer buf-type))
1204 (last (ediff-eval-in-buffer buff (point-max)))
1205 (begin (ediff-get-diff-posn buf-type 'beg n))
1206 (end (ediff-get-diff-posn buf-type 'end n))
1207 (xtra (if (equal begin end) 1 0))
1208 (end-hilit (min last (+ end xtra)))
1209 (current-diff-overlay
1211 (intern (format "ediff-current-diff-overlay-%S" buf-type)))))
1214 (ediff-move-overlay current-diff-overlay begin end-hilit)
1215 (ediff-move-overlay current-diff-overlay begin end-hilit buff))
1216 (ediff-overlay-put current-diff-overlay 'priority
1217 (ediff-highest-priority begin end-hilit buff))
1218 (ediff-overlay-put current-diff-overlay 'ediff-diff-num n)
1220 ;; unhighlight the background overlay for diff n so it won't
1221 ;; interfere with the current diff overlay
1222 (ediff-set-overlay-face (ediff-get-diff-overlay n buf-type) nil)
1226 (defun ediff-unhighlight-diff-in-one-buffer (buf-type)
1227 (if (ediff-buffer-live-p (ediff-get-buffer buf-type))
1228 (let ((current-diff-overlay
1230 (intern (format "ediff-current-diff-overlay-%S" buf-type))))
1232 (ediff-get-diff-overlay ediff-current-difference buf-type))
1235 (ediff-move-overlay current-diff-overlay 1 1)
1237 ;; rehighlight the overlay in the background of the
1238 ;; current difference region
1239 (ediff-set-overlay-face
1241 (if (and (ediff-has-face-support-p)
1242 ediff-use-faces ediff-highlight-all-diffs)
1243 (ediff-background-face buf-type ediff-current-difference)))
1246 (defun ediff-unhighlight-diffs-totally-in-one-buffer (buf-type)
1247 (ediff-unselect-and-select-difference -1)
1248 (if (and (ediff-has-face-support-p) ediff-use-faces)
1249 (let* ((inhibit-quit t)
1250 (current-diff-overlay-var
1251 (intern (format "ediff-current-diff-overlay-%S" buf-type)))
1252 (current-diff-overlay (symbol-value current-diff-overlay-var)))
1253 (ediff-paint-background-regions 'unhighlight)
1254 (if (ediff-overlayp current-diff-overlay)
1255 (ediff-delete-overlay current-diff-overlay))
1256 (set current-diff-overlay-var nil)
1260 (defsubst ediff-highlight-diff (n)
1261 "Put face on diff N. Invoked for X displays only."
1262 (ediff-highlight-diff-in-one-buffer n 'A)
1263 (ediff-highlight-diff-in-one-buffer n 'B)
1264 (ediff-highlight-diff-in-one-buffer n 'C)
1265 (ediff-highlight-diff-in-one-buffer n 'Ancestor)
1269 (defsubst ediff-unhighlight-diff ()
1270 "Remove overlays from buffers A, B, and C."
1271 (ediff-unhighlight-diff-in-one-buffer 'A)
1272 (ediff-unhighlight-diff-in-one-buffer 'B)
1273 (ediff-unhighlight-diff-in-one-buffer 'C)
1274 (ediff-unhighlight-diff-in-one-buffer 'Ancestor)
1277 ;; delete highlighting overlays, restore faces to their original form
1278 (defsubst ediff-unhighlight-diffs-totally ()
1279 (ediff-unhighlight-diffs-totally-in-one-buffer 'A)
1280 (ediff-unhighlight-diffs-totally-in-one-buffer 'B)
1281 (ediff-unhighlight-diffs-totally-in-one-buffer 'C)
1282 (ediff-unhighlight-diffs-totally-in-one-buffer 'Ancestor)
1285 (defsubst ediff-background-face (buf-type dif-num)
1286 ;; The value of dif-num is always 1- the one that user sees.
1287 ;; This is why even face is used when dif-num is odd.
1288 (intern (format (if (ediff-odd-p dif-num)
1289 "ediff-even-diff-face-%S"
1290 "ediff-odd-diff-face-%S")
1294 ;; arg is a record for a given diff in a difference vector
1295 ;; this record is itself a vector
1296 (defsubst ediff-clear-fine-diff-vector (diff-record)
1298 (mapcar 'ediff-delete-overlay
1299 (ediff-get-fine-diff-vector-from-diff-record diff-record))))
1301 (defsubst ediff-clear-fine-differences-in-one-buffer (n buf-type)
1302 (ediff-clear-fine-diff-vector (ediff-get-difference n buf-type))
1303 (ediff-set-fine-diff-vector n buf-type nil))
1305 (defsubst ediff-clear-fine-differences (n)
1306 (ediff-clear-fine-differences-in-one-buffer n 'A)
1307 (ediff-clear-fine-differences-in-one-buffer n 'B)
1309 (ediff-clear-fine-differences-in-one-buffer n 'C)))
1312 (defsubst ediff-convert-fine-diffs-to-overlays (diff-list region-num)
1313 (ediff-set-fine-overlays-in-one-buffer 'A diff-list region-num)
1314 (ediff-set-fine-overlays-in-one-buffer 'B diff-list region-num)
1316 (ediff-set-fine-overlays-in-one-buffer 'C diff-list region-num)
1319 (defsubst ediff-mouse-event-p (event)
1321 (button-event-p event)
1322 (string-match "mouse" (format "%S" (event-basic-type event)))
1326 (defsubst ediff-key-press-event-p (event)
1328 (key-press-event-p event)
1329 (or (char-or-string-p event) (symbolp event))))
1331 (defun ediff-event-point (event)
1332 (cond ((ediff-mouse-event-p event)
1335 (posn-point (event-start event))))
1336 ((ediff-key-press-event-p event)
1340 (defun ediff-event-buffer (event)
1341 (cond ((ediff-mouse-event-p event)
1343 (event-buffer event)
1344 (window-buffer (posn-window (event-start event)))))
1345 ((ediff-key-press-event-p event)
1350 (defsubst ediff-frame-iconified-p (frame)
1351 (if (and (ediff-window-display-p) (frame-live-p frame))
1353 (frame-iconified-p frame)
1354 (eq (frame-visible-p frame) 'icon))))
1356 (defsubst ediff-window-visible-p (wind)
1357 ;; under TTY, window-live-p also means window is visible
1358 (and (window-live-p wind)
1359 (or (not (ediff-window-display-p))
1360 (frame-visible-p (window-frame wind)))))
1363 (defsubst ediff-frame-char-width (frame)
1365 (/ (frame-pixel-width frame) (frame-width frame))
1366 (frame-char-width frame)))
1368 (defun ediff-reset-mouse (&optional frame do-not-grab-mouse)
1369 (or frame (setq frame (selected-frame)))
1370 (if (ediff-window-display-p)
1371 (let ((frame-or-wind frame))
1373 (setq frame-or-wind (frame-selected-window frame)))
1374 (or do-not-grab-mouse
1375 ;; don't set mouse if the user said to never do this
1376 (not ediff-grab-mouse)
1377 ;; Don't grab on quit, if the user doesn't want to.
1378 ;; If ediff-grab-mouse = t, then mouse won't be grabbed for
1379 ;; sessions that are not part of a group (this is done in
1380 ;; ediff-recenter). The condition below affects only terminating
1381 ;; sessions in session groups (in which case mouse is warped into
1383 (and (eq ediff-grab-mouse 'maybe)
1384 (memq this-command '(ediff-quit ediff-update-diffs)))
1385 (set-mouse-position frame-or-wind 1 0))
1388 (defsubst ediff-spy-after-mouse ()
1389 (setq ediff-mouse-pixel-position (mouse-pixel-position)))
1391 ;; It is not easy to find out when the user grabs the mouse, since emacs and
1392 ;; xemacs behave differently when mouse is not in any frame. Also, this is
1393 ;; sensitive to when the user grabbed mouse. Not used for now.
1394 (defun ediff-user-grabbed-mouse ()
1395 (if ediff-mouse-pixel-position
1396 (cond ((not (eq (car ediff-mouse-pixel-position)
1397 (car (mouse-pixel-position)))))
1398 ((and (car (cdr ediff-mouse-pixel-position))
1399 (car (cdr (mouse-pixel-position)))
1400 (cdr (cdr ediff-mouse-pixel-position))
1401 (cdr (cdr (mouse-pixel-position))))
1402 (not (and (< (abs (- (car (cdr ediff-mouse-pixel-position))
1403 (car (cdr (mouse-pixel-position)))))
1404 ediff-mouse-pixel-threshold)
1405 (< (abs (- (cdr (cdr ediff-mouse-pixel-position))
1406 (cdr (cdr (mouse-pixel-position)))))
1407 ediff-mouse-pixel-threshold))))
1410 (defsubst ediff-frame-char-height (frame)
1412 (glyph-height ediff-H-glyph (selected-window frame))
1413 (frame-char-height frame)))
1415 ;; Some overlay functions
1417 (defsubst ediff-empty-overlay-p (overl)
1418 (= (ediff-overlay-start overl) (ediff-overlay-end overl)))
1420 ;; like overlay-buffer in Emacs. In XEmacs, returns nil if the extent is
1421 ;; dead. Otherwise, works like extent-buffer
1422 (defun ediff-overlay-buffer (overl)
1424 (overlay-buffer overl)
1425 (and (extent-live-p overl) (extent-object overl))))
1427 ;; like overlay-get in Emacs. In XEmacs, returns nil if the extent is
1428 ;; dead. Otherwise, like extent-property
1429 (defun ediff-overlay-get (overl property)
1431 (overlay-get overl property)
1432 (and (extent-live-p overl) (extent-property overl property))))
1435 ;; These two functions are here because XEmacs refuses to
1436 ;; handle overlays whose buffers were deleted.
1437 (defun ediff-move-overlay (overlay beg end &optional buffer)
1438 "Calls `move-overlay' in Emacs and `set-extent-endpoints' in Lemacs.
1439 Checks if overlay's buffer exists before actually doing the move."
1440 (let ((buf (and overlay (ediff-overlay-buffer overlay))))
1441 (if (ediff-buffer-live-p buf)
1443 (set-extent-endpoints overlay beg end)
1444 (move-overlay overlay beg end buffer))
1447 (ediff-delete-overlay overlay)))))
1449 (defun ediff-overlay-put (overlay prop value)
1450 "Calls `overlay-put' or `set-extent-property' depending on Emacs version.
1451 Checks if overlay's buffer exists."
1452 (if (ediff-buffer-live-p (ediff-overlay-buffer overlay))
1454 (set-extent-property overlay prop value)
1455 (overlay-put overlay prop value))
1456 (ediff-delete-overlay overlay)))
1458 ;; Some diff region tests
1460 ;; t if diff region is empty.
1461 ;; In case of buffer C, t also if it is not a 3way
1462 ;; comparison job (merging jobs return t as well).
1463 (defun ediff-empty-diff-region-p (n buf-type)
1464 (if (eq buf-type 'C)
1465 (or (not ediff-3way-comparison-job)
1466 (= (ediff-get-diff-posn 'C 'beg n)
1467 (ediff-get-diff-posn 'C 'end n)))
1468 (= (ediff-get-diff-posn buf-type 'beg n)
1469 (ediff-get-diff-posn buf-type 'end n))))
1471 ;; Test if diff region is white space only.
1472 ;; If 2-way job and buf-type = C, then returns t.
1473 (defun ediff-whitespace-diff-region-p (n buf-type)
1474 (or (and (eq buf-type 'C) (not ediff-3way-job))
1475 (ediff-empty-diff-region-p n buf-type)
1476 (let ((beg (ediff-get-diff-posn buf-type 'beg n))
1477 (end (ediff-get-diff-posn buf-type 'end n)))
1478 (ediff-eval-in-buffer (ediff-get-buffer buf-type)
1481 (skip-chars-forward ediff-whitespace)
1482 (>= (point) end))))))
1484 ;; temporarily uses DIR to abbreviate file name
1485 ;; if DIR is nil, use default-directory
1486 (defun ediff-abbreviate-file-name (file &optional dir)
1487 (cond ((stringp dir)
1488 (let ((directory-abbrev-alist (list (cons dir ""))))
1489 (abbreviate-file-name file)))
1490 (ediff-emacs-p (abbreviate-file-name file))
1491 (t ; XEmacs requires addl argument
1492 (abbreviate-file-name file t))))
1494 ;; Takes a directory and returns the parent directory.
1495 ;; does nothing to `/'. If the ARG is a regular file,
1496 ;; strip the file AND the last dir.
1497 (defun ediff-strip-last-dir (dir)
1498 (if (not (stringp dir)) (setq dir default-directory))
1499 (setq dir (expand-file-name dir))
1500 (or (file-directory-p dir) (setq dir (file-name-directory dir)))
1501 (let* ((pos (1- (length dir)))
1502 (last-char (aref dir pos)))
1503 (if (and (> pos 0) (= last-char ?/))
1504 (setq dir (substring dir 0 pos)))
1505 (ediff-abbreviate-file-name (file-name-directory dir))))
1507 (defun ediff-truncate-string-left (str newlen)
1508 ;; leave space for ... on the left
1509 (let ((len (length str))
1513 (setq newlen (max 0 (- newlen 3)))
1514 (setq substr (substring str (max 0 (- len 1 newlen))))
1515 (concat "..." substr))))
1517 (defun ediff-abbrev-jobname (jobname)
1518 (cond ((eq jobname 'ediff-directories)
1519 "Compare two directories")
1520 ((eq jobname 'ediff-files)
1521 "Compare two files")
1522 ((eq jobname 'ediff-buffers)
1523 "Compare two buffers")
1524 ((eq jobname 'ediff-directories3)
1525 "Compare three directories")
1526 ((eq jobname 'ediff-files3)
1527 "Compare three files")
1528 ((eq jobname 'ediff-buffers3)
1529 "Compare three buffers")
1530 ((eq jobname 'ediff-revision)
1531 "Compare file with a version")
1532 ((eq jobname 'ediff-directory-revisions)
1533 "Compare dir files with versions")
1534 ((eq jobname 'ediff-merge-directory-revisions)
1535 "Merge dir files with versions")
1536 ((eq jobname 'ediff-merge-directory-revisions-with-ancestor)
1537 "Merge dir versions via ancestors")
1539 (let* ((str (substring (symbol-name jobname) 6))
1544 (aset str pos (upcase (aref str pos))))
1545 (if (= (aref str pos) ?-)
1547 (setq pos (1+ pos)))
1552 (defsubst ediff-get-region-contents (n buf-type ctrl-buf &optional start end)
1553 (ediff-eval-in-buffer
1554 (ediff-eval-in-buffer ctrl-buf (ediff-get-buffer buf-type))
1556 (or start (ediff-get-diff-posn buf-type 'beg n ctrl-buf))
1557 (or end (ediff-get-diff-posn buf-type 'end n ctrl-buf)))))
1559 ;; If ediff modified mode line, strip the modification
1560 (defsubst ediff-strip-mode-line-format ()
1561 (if (member (car mode-line-format) '(" A: " " B: " " C: " " Ancestor: "))
1562 (setq mode-line-format (nth 2 mode-line-format))))
1564 ;; Verify that we have a difference selected.
1565 (defsubst ediff-valid-difference-p (&optional n)
1566 (or n (setq n ediff-current-difference))
1567 (and (>= n 0) (< n ediff-number-of-differences)))
1569 (defsubst ediff-show-all-diffs (n)
1570 "Don't skip difference regions."
1574 (or (and a (not b)) (and (not a) b)))
1576 (defsubst ediff-message-if-verbose (string &rest args)
1578 (apply 'message string args)))
1580 (defun ediff-file-attributes (filename attr-number)
1581 (let ((handler (find-file-name-handler filename 'find-file-noselect)))
1582 (if (and handler (string-match "ange-ftp" (format "%S" handler)))
1584 (nth attr-number (file-attributes filename)))))
1585 (defsubst ediff-file-size (filename)
1586 (ediff-file-attributes filename 7))
1587 (defsubst ediff-file-modtime (filename)
1588 (ediff-file-attributes filename 5))
1591 (defun ediff-convert-standard-filename (fname)
1593 (convert-standard-filename fname)
1594 ;; hopefully, XEmacs adds this functionality
1598 ;;; Local Variables:
1599 ;;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
1600 ;;; eval: (put 'ediff-eval-in-buffer 'lisp-indent-hook 1)
1601 ;;; eval: (put 'ediff-eval-in-buffer 'edebug-form-spec '(form body))
1604 (provide 'ediff-init)
1607 ;;; ediff-init.el ends here