1 ;;; ediff-util.el --- the core commands and utilities of ediff
2 ;;; Copyright (C) 1994, 1995 Free Software Foundation, Inc.
4 ;; Author: Michael Kifer <kifer@cs.sunysb.edu>
6 ;; This file is part of GNU Emacs.
8 ;; GNU Emacs is free software; you can redistribute it and/or modify
9 ;; it under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; GNU Emacs is distributed in the hope that it will be useful,
14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 ;; GNU General Public License for more details.
18 ;; You should have received a copy of the GNU General Public License
19 ;; along with GNU Emacs; see the file COPYING. If not, write to
20 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
31 "Ediff mode is used by the Ediff file-difference package.
32 It is entered only through one of the following commands:
41 `ediff-merge-files-with-ancestor'
43 `ediff-merge-buffers-with-ancestor'
44 `ediff-merge-revisions'
45 `ediff-merge-revisions-with-ancestor'
46 `ediff-windows-wordwise'
47 `ediff-windows-linewise'
48 `ediff-regions-wordwise'
49 `ediff-regions-linewise'
58 (kill-all-local-variables)
59 (setq major-mode
'ediff-mode
)
60 (setq mode-name
"Ediff")
61 (run-hooks 'ediff-mode-hooks
))
63 (defun ediff-version ()
64 "Return string describing the version of Ediff.
65 When called interactively, displays the version."
68 (message (ediff-version))
69 (format "Ediff %s of %s" ediff-version ediff-date
)))
78 (ediff-defvar-local ediff-mode-map nil
79 "Local keymap used in Ediff mode.
80 This is local to each Ediff Control Panel, so they may vary from invocation
83 ;; Set up the keymap in the control buffer
84 (defun ediff-set-keys ()
85 "Set up Ediff keymap, if necessary."
86 (if (null ediff-mode-map
)
88 (use-local-map ediff-mode-map
))
90 ;; Reload Ediff keymap. For debugging only.
91 (defun ediff-reload-keymap ()
93 (setq ediff-mode-map nil
)
97 (defun ediff-setup-keymap ()
98 "Set up the keymap used in the control buffer of Ediff."
99 (setq ediff-mode-map
(make-sparse-keymap))
100 (suppress-keymap ediff-mode-map
)
102 (define-key ediff-mode-map
"p" 'ediff-previous-difference
)
103 (define-key ediff-mode-map
"\C-?" 'ediff-previous-difference
)
104 (define-key ediff-mode-map
[backspace] 'ediff-previous-difference)
105 (define-key ediff-mode-map [delete] 'ediff-previous-difference)
106 (define-key ediff-mode-map "\C-h" (if ediff-no-emacs-help-in-control-buffer
107 'ediff-previous-difference nil))
108 (define-key ediff-mode-map "n" 'ediff-next-difference)
109 (define-key ediff-mode-map " " 'ediff-next-difference)
110 (define-key ediff-mode-map "j" 'ediff-jump-to-difference)
111 (define-key ediff-mode-map "g" nil)
112 (define-key ediff-mode-map "ga" 'ediff-jump-to-difference-at-point)
113 (define-key ediff-mode-map "gb" 'ediff-jump-to-difference-at-point)
114 (define-key ediff-mode-map "q" 'ediff-quit)
115 (define-key ediff-mode-map "z" 'ediff-suspend)
116 (define-key ediff-mode-map "\C-l" 'ediff-recenter)
117 (define-key ediff-mode-map "|" 'ediff-toggle-split)
118 (define-key ediff-mode-map "h" 'ediff-toggle-hilit)
120 (define-key ediff-mode-map "@" 'ediff-toggle-autorefine))
122 (define-key ediff-mode-map "%" 'ediff-toggle-narrow-region))
123 (define-key ediff-mode-map "~" 'ediff-swap-buffers)
124 (define-key ediff-mode-map "v" 'ediff-scroll-vertically)
125 (define-key ediff-mode-map "\C-v" 'ediff-scroll-vertically)
126 (define-key ediff-mode-map "^" 'ediff-scroll-vertically)
127 (define-key ediff-mode-map "\M-v" 'ediff-scroll-vertically)
128 (define-key ediff-mode-map "V" 'ediff-scroll-vertically)
129 (define-key ediff-mode-map "<" 'ediff-scroll-horizontally)
130 (define-key ediff-mode-map ">" 'ediff-scroll-horizontally)
131 (define-key ediff-mode-map "i" 'ediff-status-info)
132 (define-key ediff-mode-map "D" 'ediff-documentation)
133 (define-key ediff-mode-map "?" 'ediff-toggle-help)
134 (define-key ediff-mode-map "!" 'ediff-update-diffs)
136 (define-key ediff-mode-map "*" 'ediff-make-or-kill-fine-diffs))
137 (define-key ediff-mode-map "a" nil)
138 (define-key ediff-mode-map "b" nil)
139 (define-key ediff-mode-map "r" nil)
140 (cond (ediff-merge-job
141 ;; In merging, we allow only A->C and B->C copying.
142 (define-key ediff-mode-map "a" (function
145 (ediff-diff-to-diff arg "ac"))))
146 (define-key ediff-mode-map "b" (function
149 (ediff-diff-to-diff arg "bc"))))
150 (define-key ediff-mode-map "r" (function
153 (ediff-restore-diff arg ?c))))
154 (define-key ediff-mode-map "s" 'ediff-shrink-window-C)
155 (define-key ediff-mode-map "+" 'ediff-combine-diffs)
156 (define-key ediff-mode-map "$" 'ediff-toggle-show-clashes-only)
157 (define-key ediff-mode-map "&" 'ediff-re-merge))
158 (ediff-3way-comparison-job
159 (define-key ediff-mode-map "ab" 'ediff-diff-to-diff)
160 (define-key ediff-mode-map "ba" 'ediff-diff-to-diff)
161 (define-key ediff-mode-map "ac" 'ediff-diff-to-diff)
162 (define-key ediff-mode-map "bc" 'ediff-diff-to-diff)
163 (define-key ediff-mode-map "c" nil)
164 (define-key ediff-mode-map "ca" 'ediff-diff-to-diff)
165 (define-key ediff-mode-map "cb" 'ediff-diff-to-diff)
166 (define-key ediff-mode-map "ra" 'ediff-restore-diff)
167 (define-key ediff-mode-map "rb" 'ediff-restore-diff)
168 (define-key ediff-mode-map "rc" 'ediff-restore-diff)
169 (define-key ediff-mode-map "C" 'ediff-toggle-read-only))
170 (t ; 2-way comparison
171 (define-key ediff-mode-map "a" (function
174 (ediff-diff-to-diff arg "ab"))))
175 (define-key ediff-mode-map "b" (function
178 (ediff-diff-to-diff arg "ba"))))
179 (define-key ediff-mode-map "ra" 'ediff-restore-diff)
180 (define-key ediff-mode-map "rb" 'ediff-restore-diff))
182 (define-key ediff-mode-map "G" 'ediff-submit-report)
183 (define-key ediff-mode-map "#" nil)
184 (define-key ediff-mode-map "#h" 'ediff-toggle-regexp-match)
185 (define-key ediff-mode-map "#f" 'ediff-toggle-regexp-match)
187 (define-key ediff-mode-map "##" 'ediff-toggle-skip-similar))
188 (define-key ediff-mode-map "o" nil)
189 (define-key ediff-mode-map "A" 'ediff-toggle-read-only)
190 (define-key ediff-mode-map "B" 'ediff-toggle-read-only)
191 (define-key ediff-mode-map "w" nil)
192 (define-key ediff-mode-map "wa" 'ediff-save-buffer)
193 (define-key ediff-mode-map "wb" 'ediff-save-buffer)
194 (define-key ediff-mode-map "wd" 'ediff-save-buffer)
197 (define-key ediff-mode-map "wc" 'ediff-save-buffer)
198 (define-key ediff-mode-map "gc" 'ediff-jump-to-difference-at-point)
201 (define-key ediff-mode-map "m" 'ediff-toggle-wide-display)
203 (define-key ediff-mode-map "k" nil)
204 (define-key ediff-mode-map "kkk" 'ediff-reload-keymap) ; for debugging
206 ;; Allow ediff-mode-map to be referenced indirectly
207 (fset 'ediff-mode-map ediff-mode-map)
208 (run-hooks 'ediff-keymap-setup-hooks))
213 (require 'ediff-wind)
215 ;; Common startup entry for all Ediff functions
216 ;; It now returns control buffer so other functions can do post-processing
217 (defun ediff-setup (buffer-A file-A buffer-B file-B buffer-C file-C
218 startup-hooks setup-parameters)
219 (setq file-A (expand-file-name file-A))
220 (setq file-B (expand-file-name file-B))
222 (setq file-C (expand-file-name file-C)))
223 (let* ((control-buffer-name
224 (ediff-unique-buffer-name "*Ediff Control Panel" "*"))
225 (control-buffer (ediff-eval-in-buffer buffer-A
226 (get-buffer-create control-buffer-name))))
227 (ediff-eval-in-buffer control-buffer
230 ;; unwrap set up parameters passed as argument
231 (while setup-parameters
232 (set (car (car setup-parameters)) (cdr (car setup-parameters)))
233 (setq setup-parameters (cdr setup-parameters)))
235 ;; set variables classifying the current ediff job
236 (setq ediff-3way-comparison-job (ediff-3way-comparison-job)
237 ediff-merge-job (ediff-merge-job)
238 ediff-merge-with-ancestor-job (ediff-merge-with-ancestor-job)
239 ediff-3way-job (ediff-3way-job)
240 ediff-diff3-job (ediff-diff3-job)
241 ediff-narrow-job (ediff-narrow-job)
242 ediff-windows-job (ediff-windows-job)
243 ediff-word-mode-job (ediff-word-mode-job))
245 (make-local-variable 'ediff-prefer-long-help-message)
246 (make-local-variable 'ediff-prefer-iconified-control-frame)
247 (make-local-variable 'ediff-split-window-function)
248 (make-local-variable 'ediff-default-variant)
249 (make-local-variable 'ediff-merge-window-share)
250 (make-local-variable 'ediff-window-setup-function)
252 ;; adjust for merge jobs
255 ;; Use buf A even if `combined'. The right stuff is
256 ;; inserted by ediff-do-merge
257 (if (eq ediff-default-variant 'default-B) buffer-B buffer-A)))
259 (setq ediff-split-window-function
260 ediff-merge-split-window-function)
262 ;; remember the ancestor buffer, if any
263 (setq ediff-ancestor-buffer buffer-C)
267 (ediff-unique-buffer-name "*ediff-merge" "*")))
269 (set-buffer buffer-C)
271 (funcall (ediff-eval-in-buffer buf major-mode))
272 ;; after Stig@hackvan.com
273 (add-hook 'local-write-file-hooks 'ediff-set-merge-mode)
275 (setq buffer-read-only nil
276 ediff-buffer-A buffer-A
277 ediff-buffer-B buffer-B
278 ediff-buffer-C buffer-C
279 ediff-control-buffer control-buffer)
281 (setq ediff-control-buffer-suffix
282 (if (string-match "<[0-9]*>" control-buffer-name)
283 (substring control-buffer-name
284 (match-beginning 0) (match-end 0))
286 ediff-control-buffer-number
292 ediff-control-buffer-suffix
294 (string-match "[0-9]+" ediff-control-buffer-suffix)
297 (setq ediff-error-buffer (get-buffer-create (ediff-unique-buffer-name
298 "*ediff-errors" "*")))
300 (ediff-eval-in-buffer buffer-A (ediff-strip-mode-line-format))
301 (ediff-eval-in-buffer buffer-B (ediff-strip-mode-line-format))
303 (ediff-eval-in-buffer buffer-C (ediff-strip-mode-line-format)))
305 (ediff-save-protected-variables) ; save variables to be restored on exit
307 ;; ediff-setup-diff-regions-function must be set after setup
308 ;; parameters are processed.
309 (setq ediff-setup-diff-regions-function
311 'ediff-setup-diff-regions3
312 'ediff-setup-diff-regions))
314 (setq ediff-wide-bounds
315 (list (ediff-make-bullet-proof-overlay
316 '(point-min) '(point-max) ediff-buffer-A)
317 (ediff-make-bullet-proof-overlay
318 '(point-min) '(point-max) ediff-buffer-B)
319 (ediff-make-bullet-proof-overlay
320 '(point-min) '(point-max) ediff-buffer-C)))
322 ;; This has effect only on ediff-windows/regions
323 ;; In all other cases, ediff-visible-region sets visibility bounds to
324 ;; ediff-wide-bounds, and ediff-narrow-bounds are ignored.
325 (if ediff-start-narrowed
326 (setq ediff-visible-bounds ediff-narrow-bounds)
327 (setq ediff-visible-bounds ediff-wide-bounds))
329 (ediff-set-keys) ; comes after parameter setup
331 ;; set up ediff-narrow-bounds, if not set
332 (or ediff-narrow-bounds
333 (setq ediff-narrow-bounds ediff-wide-bounds))
335 ;; All these must be inside ediff-eval-in-buffer control-buffer,
336 ;; since these vars are local to control-buffer
337 ;; These won't run if there are errors in diff
338 (ediff-eval-in-buffer ediff-buffer-A
339 (ediff-nuke-selective-display)
340 (run-hooks 'ediff-prepare-buffer-hooks)
341 (if (ediff-eval-in-buffer control-buffer ediff-merge-job)
342 (setq buffer-read-only t))
343 ;; add control-buffer to the list of sessions--no longer used, but may
344 ;; be used again in the future
345 (or (memq control-buffer ediff-this-buffer-control-sessions)
346 (setq ediff-this-buffer-control-sessions
347 (cons control-buffer ediff-this-buffer-control-sessions)))
349 (ediff-eval-in-buffer ediff-buffer-B
350 (ediff-nuke-selective-display)
351 (run-hooks 'ediff-prepare-buffer-hooks)
352 (if (ediff-eval-in-buffer control-buffer ediff-merge-job)
353 (setq buffer-read-only t))
354 ;; add control-buffer to the list of sessions
355 (or (memq control-buffer ediff-this-buffer-control-sessions)
356 (setq ediff-this-buffer-control-sessions
357 (cons control-buffer ediff-this-buffer-control-sessions)))
360 (ediff-eval-in-buffer ediff-buffer-C
361 (ediff-nuke-selective-display)
362 (run-hooks 'ediff-prepare-buffer-hooks)
363 ;; add control-buffer to the list of sessions
364 (or (memq control-buffer ediff-this-buffer-control-sessions)
365 (setq ediff-this-buffer-control-sessions
367 ediff-this-buffer-control-sessions)))
370 ;; must come after setting up ediff-narrow-bounds AND after
371 ;; nuking selective display
372 (funcall ediff-setup-diff-regions-function file-A file-B file-C)
373 (setq ediff-number-of-differences (length ediff-difference-vector-A))
374 (setq ediff-current-difference -1)
376 (ediff-make-current-diff-overlay 'A)
377 (ediff-make-current-diff-overlay 'B)
379 (ediff-make-current-diff-overlay 'C))
381 (if (ediff-window-display-p)
382 (ediff-init-var-faces))
384 (ediff-setup-windows buffer-A buffer-B buffer-C control-buffer)
386 (let ((shift-A (ediff-overlay-start
387 (ediff-get-value-according-to-buffer-type
388 'A ediff-narrow-bounds)))
389 (shift-B (ediff-overlay-start
390 (ediff-get-value-according-to-buffer-type
391 'B ediff-narrow-bounds)))
392 (shift-C (ediff-overlay-start
393 (ediff-get-value-according-to-buffer-type
394 'C ediff-narrow-bounds))))
395 ;; position point in buf A
397 (select-window ediff-window-A)
399 ;; position point in buf B
401 (select-window ediff-window-B)
405 (select-window ediff-window-C)
406 (goto-char shift-C)))
409 (select-window ediff-control-window)
410 (ediff-visible-region)
412 ;; The following is a hack to placate OS/2
413 ;; The problem is that OS/2 doesn't let us delete files used by other
414 ;; processes. Thus, in ediff-buffers and other functions, we can't
415 ;; delete temp files because they might be used by the asynchronous
416 ;; process that computes custom diffs. So, under OS/1 we have to wait
417 ;; for some time until custom diffs are done.
418 (if (eq system-type 'emx)
419 (ediff-eval-in-buffer ediff-custom-diff-buffer
420 (let ((proc (get-buffer-process (current-buffer))))
421 (while (and (processp proc)
422 (eq (process-status proc) 'run))
423 (message "Waiting for the diff program to quit")
428 (run-hooks 'startup-hooks 'ediff-startup-hooks)
429 (ediff-refresh-mode-lines)
430 (setq buffer-read-only t))
434 ;; This function assumes that we are in the window where control buffer is
436 (defun ediff-setup-control-buffer (ctl-buf)
437 "Set up window for control buffer."
438 (if (window-dedicated-p (selected-window))
439 (set-buffer ctl-buf) ; we are in control frame but just in case
440 (switch-to-buffer ctl-buf))
441 (let ((window-min-height 2))
443 (ediff-set-help-message)
444 (insert ediff-help-message)
445 (shrink-window-if-larger-than-buffer)
446 (or (ediff-multiframe-setup-p)
447 (ediff-indent-help-message))
448 (set-buffer-modified-p nil)
449 (ediff-refresh-mode-lines)
450 (setq ediff-control-window (selected-window))
451 (setq ediff-window-config-saved
452 (format "%S%S%S%S%S%S%S"
457 ediff-split-window-function
458 (ediff-multiframe-setup-p)
459 ediff-wide-display-p))
460 (goto-char (point-min))
461 (skip-chars-forward ediff-whitespace)))
463 ;; assuming we are in control window, calculate length of the first line in
465 (defun ediff-help-message-line-length ()
467 (goto-char (point-min))
468 (if ediff-prefer-long-help-message
474 (defun ediff-indent-help-message ()
475 (let* ((shift (/ (max 0 (- (window-width (selected-window))
476 (ediff-help-message-line-length)))
478 (str (make-string shift ?\ )))
480 (goto-char (point-min))
481 (while (< (point) (point-max))
487 (defun ediff-set-help-message ()
488 (setq ediff-long-help-message
489 (cond ((and ediff-long-help-message-custom
490 (or (symbolp ediff-long-help-message-custom)
491 (consp ediff-long-help-message-custom)))
492 (funcall ediff-long-help-message-custom))
494 (concat ediff-long-help-message-head
495 ediff-long-help-message-word-mode
496 ediff-long-help-message-tail))
498 (concat ediff-long-help-message-head
499 ediff-long-help-message-narrow2
500 ediff-long-help-message-tail))
502 (concat ediff-long-help-message-head
503 ediff-long-help-message-merge
504 ediff-long-help-message-tail))
506 (concat ediff-long-help-message-head
507 ediff-long-help-message-compare3
508 ediff-long-help-message-tail))
510 (concat ediff-long-help-message-head
511 ediff-long-help-message-compare2
512 ediff-long-help-message-tail))))
513 (setq ediff-brief-help-message
514 (cond ((and ediff-brief-help-message-custom
515 (or (symbolp ediff-brief-help-message-custom)
516 (consp ediff-brief-help-message-custom)))
517 (funcall ediff-brief-help-message-custom))
518 ((stringp ediff-brief-help-message-custom)
519 ediff-brief-help-message-custom)
520 ((ediff-multiframe-setup-p) ediff-brief-message-string)
521 (t ; long brief msg, not multiframe --- put in the middle
522 ediff-brief-message-string)
524 (setq ediff-help-message (if ediff-prefer-long-help-message
525 ediff-long-help-message
526 ediff-brief-help-message))
527 (run-hooks 'ediff-display-help-hooks)
533 ;;; Commands for working with Ediff
535 (defun ediff-update-diffs ()
536 "Recompute difference regions in buffers A, B, and C.
537 Buffers are not synchronized with their respective files, so changes done
538 to these buffers are not saved at this point---the user can do this later,
541 (let ((point-A (ediff-eval-in-buffer ediff-buffer-A (point)))
542 ;;(point-B (ediff-eval-in-buffer ediff-buffer-B (point)))
543 (tmp-buffer (get-buffer-create ediff-tmp-buffer))
545 (file-name-nondirectory (or (buffer-file-name ediff-buffer-A)
546 (buffer-name ediff-buffer-A)
549 (file-name-nondirectory (or (buffer-file-name ediff-buffer-B)
550 (buffer-name ediff-buffer-B)
553 (file-name-nondirectory (or (buffer-file-name ediff-buffer-C)
554 ;; if (null ediff-buffer-C), there is
555 ;; no danger, since we later check if
556 ;; ediff-buffer-C is alive
557 (buffer-name ediff-buffer-C)
559 (overl-A (ediff-get-value-according-to-buffer-type
560 'A ediff-narrow-bounds))
561 (overl-B (ediff-get-value-according-to-buffer-type
562 'B ediff-narrow-bounds))
563 (overl-C (ediff-get-value-according-to-buffer-type
564 'C ediff-narrow-bounds))
565 beg-A end-A beg-B end-B beg-C end-C
566 file-A file-B file-C)
567 (ediff-unselect-and-select-difference -1)
569 (setq beg-A (ediff-overlay-start overl-A)
570 beg-B (ediff-overlay-start overl-B)
571 beg-C (ediff-overlay-start overl-C)
572 end-A (ediff-overlay-end overl-A)
573 end-B (ediff-overlay-end overl-B)
574 end-C (ediff-overlay-end overl-C))
578 (ediff-wordify beg-A end-A ediff-buffer-A tmp-buffer)
579 (ediff-eval-in-buffer tmp-buffer
580 (setq file-A (ediff-make-temp-file "regA")))
581 (ediff-wordify beg-B end-B ediff-buffer-B tmp-buffer)
582 (ediff-eval-in-buffer tmp-buffer
583 (setq file-B (ediff-make-temp-file "regB")))
586 (ediff-wordify beg-C end-C ediff-buffer-C tmp-buffer)
587 (ediff-eval-in-buffer tmp-buffer
588 (setq file-C (ediff-make-temp-file "regC")))))
591 (ediff-eval-in-buffer ediff-buffer-A
592 (setq file-A (ediff-make-temp-file buf-A-file-name)))
593 (ediff-eval-in-buffer ediff-buffer-B
594 (setq file-B (ediff-make-temp-file buf-B-file-name)))
596 (ediff-eval-in-buffer ediff-buffer-C
597 (setq file-C (ediff-make-temp-file buf-C-file-name))))
600 (ediff-clear-diff-vector 'ediff-difference-vector-A 'fine-diffs-also)
601 (ediff-clear-diff-vector 'ediff-difference-vector-B 'fine-diffs-also)
602 (ediff-clear-diff-vector 'ediff-difference-vector-C 'fine-diffs-also)
603 (setq ediff-killed-diffs-alist nil) ; invalidate saved killed diff regions
605 ;; In case of merge job, full it into thinking that it is just doing
607 (let ((ediff-setup-diff-regions-function ediff-setup-diff-regions-function)
608 (ediff-job-name ediff-job-name))
610 (setq ediff-setup-diff-regions-function 'ediff-setup-diff-regions3
611 ediff-job-name 'ediff-files3))
612 (funcall ediff-setup-diff-regions-function file-A file-B file-C))
614 (setq ediff-number-of-differences (length ediff-difference-vector-A))
618 (delete-file file-C))
621 (ediff-set-state-of-all-diffs-in-all-buffers ediff-control-buffer))
623 (ediff-jump-to-difference (ediff-diff-at-point 'A point-A))
627 ;; Not bound to any key---to dangerous. A user can do it if necessary.
628 (defun ediff-revert-buffers-then-recompute-diffs (noconfirm)
629 "Revert buffers A, B and C. Then rerun Ediff on file A and file B."
631 (let ((bufA ediff-buffer-A)
632 (bufB ediff-buffer-B)
633 (bufC ediff-buffer-C)
634 (ctl-buf ediff-control-buffer)
635 (ancestor-buf ediff-ancestor-buffer)
636 (ancestor-job ediff-merge-with-ancestor-job)
637 (merge ediff-merge-job)
638 (comparison ediff-3way-comparison-job))
639 (ediff-eval-in-buffer bufA
640 (revert-buffer t noconfirm))
641 (ediff-eval-in-buffer bufB
642 (revert-buffer t noconfirm))
643 ;; this should only be executed in a 3way comparison, not in merge
645 (ediff-eval-in-buffer bufC
646 (revert-buffer t noconfirm)))
653 (ediff-merge-buffers-with-ancestor bufA bufB ancestor-buf)
654 (ediff-merge-buffers bufA bufB)))
655 (ediff-update-diffs))))
658 ;; optional NO-REHIGHLIGHT says to not rehighlight buffers
659 (defun ediff-recenter (&optional no-rehighlight)
660 "Bring the highlighted region of all buffers being compared into view.
661 Reestablish the default three-window display."
664 ;; force all minibuffer to display ediff's messages.
665 ;; when xemacs implements minibufferless frames, this won't be necessary
666 (if ediff-xemacs-p (setq synchronize-minibuffers t))
668 (setq ediff-disturbed-overlays nil) ; clear after use
669 (let (buffer-read-only)
670 (if (and (ediff-buffer-live-p ediff-buffer-A)
671 (ediff-buffer-live-p ediff-buffer-B)
672 (or (not ediff-3way-job)
673 (ediff-buffer-live-p ediff-buffer-C)))
675 ediff-buffer-A ediff-buffer-B ediff-buffer-C ediff-control-buffer)
676 (or (eq this-command 'ediff-quit)
678 "You've killed an essential Ediff buffer---Please quit Ediff"
682 ;; set visibility range appropriate to this invocation of Ediff.
683 (ediff-visible-region)
686 (if (and (ediff-window-display-p)
687 (symbolp this-command)
688 (symbolp last-command)
689 ;; Either one of the display-changing commands
690 (or (memq this-command
692 ediff-toggle-wide-display ediff-toggle-multiframe))
693 ;; Or one of the movement cmds and prev cmd was an Ediff cmd
694 ;; This avoids rasing frames unnecessarily.
695 (and (memq this-command
696 '(ediff-next-difference
697 ediff-previous-difference
698 ediff-jump-to-difference
699 ediff-jump-to-difference-at-point))
700 (not (string-match "^ediff-" (symbol-name last-command)))
703 (if (window-live-p ediff-window-A)
704 (raise-frame (window-frame ediff-window-A)))
705 (if (window-live-p ediff-window-B)
706 (raise-frame (window-frame ediff-window-B)))
707 (if (window-live-p ediff-window-C)
708 (raise-frame (window-frame ediff-window-C)))))
709 (if (and (ediff-window-display-p)
710 (frame-live-p ediff-control-frame)
711 (not (ediff-frame-iconified-p ediff-control-frame)))
712 (raise-frame ediff-control-frame))
714 ;; Redisplay whatever buffers are showing, if there is a selected difference
715 (let* ((control-frame ediff-control-frame)
716 (control-buf ediff-control-buffer))
717 (if (and (ediff-buffer-live-p ediff-buffer-A)
718 (ediff-buffer-live-p ediff-buffer-B)
719 (or (not ediff-3way-job)
720 (ediff-buffer-live-p ediff-buffer-C))
721 (ediff-valid-difference-p))
724 (ediff-select-difference ediff-current-difference))
726 (ediff-recenter-one-window 'A)
727 (ediff-recenter-one-window 'B)
729 (ediff-recenter-one-window 'C))
731 (if (and (ediff-multiframe-setup-p)
732 (not (ediff-frame-iconified-p ediff-control-frame)))
734 (ediff-reset-mouse control-frame)
736 (cond ((eq (ediff-device-type) 'ns)
737 (unfocus-frame (selected-frame)))
738 (t (unfocus-frame))))
741 (ediff-eval-in-buffer control-buf
742 (ediff-refresh-mode-lines))
745 ;; this function returns to the window it was called from
746 ;; (which was the control window)
747 (defun ediff-recenter-one-window (buf-type)
748 (let* (;; context must be saved before switching to windows A/B/C
749 (ctl-wind (selected-window))
750 (shift (ediff-overlay-start
751 (ediff-get-value-according-to-buffer-type
752 buf-type ediff-narrow-bounds)))
753 (job-name ediff-job-name)
754 (control-buf ediff-control-buffer)
755 (window-name (intern (format "ediff-window-%S" buf-type)))
756 (window (if (window-live-p (symbol-value window-name))
757 (symbol-value window-name))))
759 (if (and window ediff-windows-job)
760 (set-window-start window shift))
763 (select-window window)
764 (ediff-deactivate-mark)
765 (ediff-position-region
766 (ediff-get-diff-posn buf-type 'beg nil control-buf)
767 (ediff-get-diff-posn buf-type 'end nil control-buf)
768 (ediff-get-diff-posn buf-type 'beg nil control-buf)
771 (select-window ctl-wind)
775 ;; This will have to be refined for 3way jobs
776 (defun ediff-toggle-split ()
777 "Toggle vertical/horizontal window split.
778 Does nothing if file-A and file-B are in different frames."
780 (let* ((wind-A (if (window-live-p ediff-window-A) ediff-window-A))
781 (wind-B (if (window-live-p ediff-window-B) ediff-window-B))
782 (wind-C (if (window-live-p ediff-window-C) ediff-window-C))
783 (frame-A (if wind-A (window-frame wind-A)))
784 (frame-B (if wind-B (window-frame wind-B)))
785 (frame-C (if wind-C (window-frame wind-C))))
786 (if (or (eq frame-A frame-B)
787 (not (frame-live-p frame-A))
788 (not (frame-live-p frame-B))
789 (if ediff-3way-comparison-job
790 (or (not (frame-live-p frame-C))
791 (eq frame-A frame-C) (eq frame-B frame-C))))
792 (setq ediff-split-window-function
793 (if (eq ediff-split-window-function 'split-window-vertically)
794 'split-window-horizontally
795 'split-window-vertically))
796 (message "Buffers being compared are in different frames"))
797 (ediff-recenter 'no-rehighlight)))
799 (defun ediff-toggle-hilit ()
800 "Switch between highlighting using ASCII flags and highlighting using faces.
801 On a dumb terminal, switches between ASCII highlighting and no highlighting."
803 (if (not (ediff-window-display-p))
804 (if (eq ediff-highlighting-style 'ascii)
806 (message "ASCII highlighting flags removed")
807 (ediff-unselect-and-select-difference ediff-current-difference
809 (setq ediff-highlighting-style 'off))
810 (ediff-unselect-and-select-difference ediff-current-difference
812 (ediff-unselect-and-select-difference ediff-current-difference
814 ;; cycle through highlighting
815 (cond ((and ediff-use-faces ediff-highlight-all-diffs)
816 (message "Unhighlighting unselected difference regions")
817 (setq ediff-highlight-all-diffs nil))
819 (message "Highlighting with ASCII flags")
820 (setq ediff-use-faces nil))
822 (message "Re-highlighting all difference regions")
823 (setq ediff-use-faces t
824 ediff-highlight-all-diffs t)))
826 (if (and ediff-use-faces ediff-highlight-all-diffs)
827 (if (not (face-differs-from-default-p 'ediff-odd-diff-face-A-var))
829 (copy-face ediff-odd-diff-face-A 'ediff-odd-diff-face-A-var)
830 (copy-face ediff-odd-diff-face-B 'ediff-odd-diff-face-B-var)
831 (copy-face ediff-odd-diff-face-C 'ediff-odd-diff-face-C-var)
832 (copy-face ediff-even-diff-face-A 'ediff-even-diff-face-A-var)
833 (copy-face ediff-even-diff-face-B 'ediff-even-diff-face-B-var)
834 (copy-face ediff-even-diff-face-C 'ediff-even-diff-face-C-var)
836 (copy-face 'default 'ediff-odd-diff-face-A-var)
837 (copy-face 'default 'ediff-odd-diff-face-B-var)
838 (copy-face 'default 'ediff-odd-diff-face-C-var)
839 (copy-face 'default 'ediff-even-diff-face-A-var)
840 (copy-face 'default 'ediff-even-diff-face-B-var)
841 (copy-face 'default 'ediff-even-diff-face-C-var))
843 (ediff-unselect-and-select-difference
844 ediff-current-difference 'select-only))
847 (defun ediff-toggle-autorefine ()
848 "Toggle auto-refine mode."
851 (error "No fine differences in this mode"))
852 (cond ((eq ediff-auto-refine 'nix)
853 (setq ediff-auto-refine 'on)
854 (ediff-make-fine-diffs ediff-current-difference 'noforce)
855 (message "Auto-refining is ON"))
856 ((eq ediff-auto-refine 'on)
857 (message "Auto-refining is OFF")
858 (setq ediff-auto-refine 'off))
860 (ediff-set-fine-diff-properties ediff-current-difference 'default)
861 (message "Refinements are HIDDEN")
862 (setq ediff-auto-refine 'nix))
865 (defun ediff-make-or-kill-fine-diffs (arg)
866 "Compute fine diffs. With negative prefix arg, kill fine diffs.
867 In both cases, operates on the currrent difference region."
870 (ediff-clear-fine-differences ediff-current-difference))
871 ((and (numberp arg) (< arg 0))
872 (ediff-clear-fine-differences ediff-current-difference))
873 (t (ediff-make-fine-diffs))))
876 (defun ediff-toggle-help ()
877 "Toggle short/long help message."
879 (let (buffer-read-only)
881 (setq ediff-prefer-long-help-message (not ediff-prefer-long-help-message))
882 (ediff-set-help-message))
883 ;; remember the icon status of the control frame when the user requested
884 ;; full control message
885 (if (and ediff-prefer-long-help-message (ediff-multiframe-setup-p))
886 (setq ediff-prefer-iconified-control-frame
887 (ediff-frame-iconified-p ediff-control-frame)))
889 (setq ediff-window-config-saved "") ; force redisplay
890 (ediff-recenter 'no-rehighlight))
893 ;; If BUF, this is the buffer to toggle, not current buffer.
894 (defun ediff-toggle-read-only (&optional buf)
895 "Toggle read-only in current buffer.
896 If buffer is under version control and locked, check it out first.
897 If optional argument BUF is specified, toggle read-only in that buffer instead
898 of the current buffer."
900 (let ((ctl-buf (if (null buf) (current-buffer))))
901 (or buf (ediff-recenter))
904 (ediff-get-buffer (ediff-char-to-buftype last-command-char))))
906 (ediff-eval-in-buffer buf ; eval in buf A/B/C
907 (let* ((file (buffer-file-name buf))
908 (file-writable (and file
910 (file-writable-p file)))
911 (toggle-ro-cmd (cond (ediff-toggle-read-only-function)
912 ((ediff-file-checked-out-p file)
914 (file-writable 'toggle-read-only)
915 (t (key-binding "\C-x\C-q")))))
916 ;; If the file is checked in, make sure we don't make buffer modifiable
917 ;; without warning the user. The user can fool our checks by making the
918 ;; buffer non-RO without checking the file out. We regard this as a
920 (if (and (ediff-file-checked-in-p file)
921 ;; If ctl-buf is null, this means we called this
922 ;; non-interactively, in which case don't ask questions
924 (cond ((not buffer-read-only)
925 (setq toggle-ro-cmd 'toggle-read-only))
926 ((and (or (beep 1) t) ; always beep
929 "File %s is under version control. Check it out? "
930 (abbreviate-file-name file))))
931 ;; if we checked the file out, we should also change the
932 ;; original state of buffer-read-only to nil. If we don't
933 ;; do this, the mode line will show %%, since the file was
934 ;; RO before ediff started, so the user will think the file
936 (ediff-eval-in-buffer ctl-buf
937 (ediff-change-saved-variable
938 'buffer-read-only nil
939 (ediff-char-to-buftype last-command-char))))
941 (setq toggle-ro-cmd 'toggle-read-only)
944 "Boy, this is risky! Better don't change this file...")
946 (if (and toggle-ro-cmd
947 (string-match "toggle-read-only" (symbol-name toggle-ro-cmd)))
949 (save-window-excursion
950 (command-execute toggle-ro-cmd)))
951 (error "Don't know how to toggle read-only in buffer %S" buf))
953 ;; Check if we made the current buffer updatable, but its file is RO.
954 ;; Signal a warning in this case.
955 (if (and file (not buffer-read-only)
956 (eq this-command 'ediff-toggle-read-only)
958 (not (file-writable-p file)))
959 (message "Warning: file %s is read-only"
960 (abbreviate-file-name file) (beep 1)))
964 ;; This is a simple-minded check for whether a file is under version control
965 ;; and is checked out.
966 ;; If file,v exists but file doesn't, this file is considered to be not checked
967 ;; in and not checked out for the purpose of patching (since patch won't be
968 ;; able to read such a file anyway).
969 ;; FILE is a string representing file name
970 (defsubst ediff-file-checked-out-p (file)
973 (file-writable-p file)
974 (file-exists-p (concat file ",v"))))
975 (defsubst ediff-file-checked-in-p (file)
978 (not (file-writable-p file))
979 (file-exists-p (concat file ",v"))))
981 (defun ediff-swap-buffers ()
982 "Rotate the display of buffers A, B, and C."
984 (if (and (window-live-p ediff-window-A) (window-live-p ediff-window-B))
985 (let ((buf ediff-buffer-A)
986 (values ediff-buffer-values-orig-A)
987 (diff-vec ediff-difference-vector-A)
988 (hide-regexp ediff-regexp-hide-A)
989 (focus-regexp ediff-regexp-focus-A)
990 (wide-visibility-p (eq ediff-visible-bounds ediff-wide-bounds))
991 (overlay (if (ediff-window-display-p)
992 ediff-current-diff-overlay-A)))
993 (if ediff-3way-comparison-job
995 (set-window-buffer ediff-window-A ediff-buffer-C)
996 (set-window-buffer ediff-window-B ediff-buffer-A)
997 (set-window-buffer ediff-window-C ediff-buffer-B)
999 (set-window-buffer ediff-window-A ediff-buffer-B)
1000 (set-window-buffer ediff-window-B ediff-buffer-A))
1001 ;; swap diff buffers
1002 (if ediff-3way-comparison-job
1003 (setq ediff-buffer-A ediff-buffer-C
1004 ediff-buffer-C ediff-buffer-B
1006 (setq ediff-buffer-A ediff-buffer-B
1007 ediff-buffer-B buf))
1009 ;; swap saved buffer characteristics
1010 (if ediff-3way-comparison-job
1011 (setq ediff-buffer-values-orig-A ediff-buffer-values-orig-C
1012 ediff-buffer-values-orig-C ediff-buffer-values-orig-B
1013 ediff-buffer-values-orig-B values)
1014 (setq ediff-buffer-values-orig-A ediff-buffer-values-orig-B
1015 ediff-buffer-values-orig-B values))
1017 ;; swap diff vectors
1018 (if ediff-3way-comparison-job
1019 (setq ediff-difference-vector-A ediff-difference-vector-C
1020 ediff-difference-vector-C ediff-difference-vector-B
1021 ediff-difference-vector-B diff-vec)
1022 (setq ediff-difference-vector-A ediff-difference-vector-B
1023 ediff-difference-vector-B diff-vec))
1025 ;; swap hide/focus regexp
1026 (if ediff-3way-comparison-job
1027 (setq ediff-regexp-hide-A ediff-regexp-hide-C
1028 ediff-regexp-hide-C ediff-regexp-hide-B
1029 ediff-regexp-hide-B hide-regexp
1030 ediff-regexp-focus-A ediff-regexp-focus-C
1031 ediff-regexp-focus-C ediff-regexp-focus-B
1032 ediff-regexp-focus-B focus-regexp)
1033 (setq ediff-regexp-hide-A ediff-regexp-hide-B
1034 ediff-regexp-hide-B hide-regexp
1035 ediff-regexp-focus-A ediff-regexp-focus-B
1036 ediff-regexp-focus-B focus-regexp))
1038 ;; The following is needed for XEmacs, since there one can't move
1039 ;; overlay to another buffer. In Emacs, this swap is redundant.
1040 (if (ediff-window-display-p)
1041 (if ediff-3way-comparison-job
1042 (setq ediff-current-diff-overlay-A ediff-current-diff-overlay-C
1043 ediff-current-diff-overlay-C ediff-current-diff-overlay-B
1044 ediff-current-diff-overlay-B overlay)
1045 (setq ediff-current-diff-overlay-A ediff-current-diff-overlay-B
1046 ediff-current-diff-overlay-B overlay)))
1049 (setq ediff-wide-bounds
1050 (cond (ediff-3way-comparison-job
1051 (list (nth 2 ediff-wide-bounds)
1052 (nth 0 ediff-wide-bounds)
1053 (nth 1 ediff-wide-bounds)))
1055 (list (nth 1 ediff-wide-bounds)
1056 (nth 0 ediff-wide-bounds)
1057 (nth 2 ediff-wide-bounds)))
1059 (list (nth 1 ediff-wide-bounds)
1060 (nth 0 ediff-wide-bounds)))))
1061 ;; swap narrow bounds
1062 (setq ediff-narrow-bounds
1063 (cond (ediff-3way-comparison-job
1064 (list (nth 2 ediff-narrow-bounds)
1065 (nth 0 ediff-narrow-bounds)
1066 (nth 1 ediff-narrow-bounds)))
1068 (list (nth 1 ediff-narrow-bounds)
1069 (nth 0 ediff-narrow-bounds)
1070 (nth 2 ediff-narrow-bounds)))
1072 (list (nth 1 ediff-narrow-bounds)
1073 (nth 0 ediff-narrow-bounds)))))
1074 (if wide-visibility-p
1075 (setq ediff-visible-bounds ediff-wide-bounds)
1076 (setq ediff-visible-bounds ediff-narrow-bounds))
1079 (ediff-set-state-of-all-diffs-in-all-buffers ediff-control-buffer))
1080 (ediff-recenter 'no-rehighlight)
1084 (defun ediff-toggle-wide-display ()
1085 "Toggle wide/regular display.
1086 This is especially useful when comparing buffers side-by-side."
1088 (or (ediff-window-display-p)
1089 (error "%sEmacs is not running as a window application"
1090 (if ediff-emacs-p "" "X")))
1091 (ediff-recenter 'no-rehighlight) ; make sure buffs are displayed in windows
1092 (let ((ctl-buf ediff-control-buffer))
1093 (setq ediff-wide-display-p (not ediff-wide-display-p))
1094 (if (not ediff-wide-display-p)
1095 (ediff-eval-in-buffer ctl-buf
1096 (modify-frame-parameters
1097 ediff-wide-display-frame ediff-wide-display-orig-parameters)
1098 (sit-for (if ediff-xemacs-p 0.4 0))
1099 ;; restore control buf, since ctl window may have been deleted
1101 (set-buffer ctl-buf)
1102 (setq ediff-wide-display-orig-parameters nil
1103 ediff-window-B nil) ; force update of window config
1104 (ediff-recenter 'no-rehighlight))
1105 (funcall ediff-make-wide-display-function)
1106 (sit-for (if ediff-xemacs-p 0.4 0))
1107 (ediff-eval-in-buffer ctl-buf
1108 (setq ediff-window-B nil) ; force update of window config
1109 (ediff-recenter 'no-rehighlight)))))
1111 (defun ediff-toggle-multiframe ()
1112 "Switch from the multiframe display to single-frame display and back.
1113 This is primarily for debugging, but one can use it for fun, too."
1115 (or (ediff-window-display-p)
1116 (error "%sEmacs is not running as a window application"
1117 (if ediff-emacs-p "" "X")))
1118 (cond ((eq ediff-window-setup-function 'ediff-setup-windows-multiframe)
1119 (setq ediff-window-setup-function 'ediff-setup-windows-plain))
1120 ((eq ediff-window-setup-function 'ediff-setup-windows-plain)
1121 (setq ediff-window-setup-function 'ediff-setup-windows-multiframe)))
1122 (setq ediff-window-B nil)
1123 (ediff-recenter 'no-rehighlight))
1127 (defun ediff-toggle-show-clashes-only ()
1128 "Toggle the mode where only the regions where both buffers differ with the ancestor are shown."
1130 (if (not ediff-merge-with-ancestor-job)
1131 (error "This command makes sense only when merging with an ancestor"))
1132 (setq ediff-show-clashes-only (not ediff-show-clashes-only))
1133 (if ediff-show-clashes-only
1134 (message "Focus on regions where both buffers differ from the ancestor")
1135 (message "Canceling focus on regions where changes clash")))
1137 ;; Widening/narrowing
1139 (defun ediff-toggle-narrow-region ()
1140 "Toggle narrowing in buffers A, B, and C.
1141 Used in ediff-windows/regions only."
1143 (if (eq ediff-buffer-A ediff-buffer-B)
1145 "Buffers A and B are the same. Can't narrow to two different regions"))
1146 (if (eq ediff-visible-bounds ediff-wide-bounds)
1147 (setq ediff-visible-bounds ediff-narrow-bounds)
1148 (setq ediff-visible-bounds ediff-wide-bounds))
1149 (ediff-recenter 'no-rehighlight))
1151 ;; Narrow bufs A/B/C to ediff-visible-bounds. If this is currently set to
1152 ;; ediff-wide-bounds, then this actually widens.
1153 ;; This function does nothing if job-name is not
1154 ;; ediff-regions-wordwise/linewise or ediff-windows-wordwise/linewise.
1155 ;; Does nothing if buffer-A = buffer-B since we can't narrow
1156 ;; to two different regions in one buffer.
1157 (defun ediff-visible-region ()
1158 (if (or (eq ediff-buffer-A ediff-buffer-B)
1159 (eq ediff-buffer-A ediff-buffer-C)
1160 (eq ediff-buffer-C ediff-buffer-B))
1162 ;; If ediff-*-regions/windows, ediff-visible-bounds is already set
1163 ;; Otherwise, always use full range.
1164 (if (not ediff-narrow-job)
1165 (setq ediff-visible-bounds ediff-wide-bounds))
1166 (let ((overl-A (ediff-get-value-according-to-buffer-type
1167 'A ediff-visible-bounds))
1168 (overl-B (ediff-get-value-according-to-buffer-type
1169 'B ediff-visible-bounds))
1170 (overl-C (ediff-get-value-according-to-buffer-type
1171 'C ediff-visible-bounds))
1173 (ediff-eval-in-buffer ediff-buffer-A
1175 (ediff-overlay-start overl-A) (ediff-overlay-end overl-A)))
1176 (ediff-eval-in-buffer ediff-buffer-B
1178 (ediff-overlay-start overl-B) (ediff-overlay-end overl-B)))
1181 (ediff-eval-in-buffer ediff-buffer-C
1183 (ediff-overlay-start overl-C) (ediff-overlay-end overl-C))))
1187 ;; Window scrolling operations
1189 ;; Performs some operation on the two file windows (if they are showing).
1190 ;; Traps all errors on the operation in windows A/B/C.
1191 ;; Usually, errors come from scrolling off the
1192 ;; beginning or end of the buffer, and this gives error messages.
1193 (defun ediff-operate-on-windows (operation arg)
1195 ;; make sure windows aren't dead
1196 (if (not (and (window-live-p ediff-window-A) (window-live-p ediff-window-B)))
1197 (ediff-recenter 'no-rehighlight))
1198 (if (not (and (ediff-buffer-live-p ediff-buffer-A)
1199 (ediff-buffer-live-p ediff-buffer-B)
1200 (or (not ediff-3way-job) ediff-buffer-C)
1202 (error "You've killed an essential Ediff buffer---Please quit Ediff"))
1204 (let* ((wind (selected-window))
1205 (wind-A ediff-window-A)
1206 (wind-B ediff-window-B)
1207 (wind-C ediff-window-C)
1208 (three-way ediff-3way-job))
1210 (select-window wind-A)
1212 (funcall operation arg)
1214 (select-window wind-B)
1216 (funcall operation arg)
1220 (select-window wind-C)
1222 (funcall operation arg)
1225 (select-window wind)))
1227 (defun ediff-scroll-vertically (&optional arg)
1228 "Vertically scroll buffers A, B \(and C if appropriate\).
1229 With optional argument ARG, scroll ARG lines; otherwise scroll by nearly
1230 the height of window-A."
1233 ;; make sure windows aren't dead
1234 (if (not (and (window-live-p ediff-window-A) (window-live-p ediff-window-B)))
1235 (ediff-recenter 'no-rehighlight))
1236 (if (not (and (ediff-buffer-live-p ediff-buffer-A)
1237 (ediff-buffer-live-p ediff-buffer-B)
1238 (or (not ediff-3way-job)
1239 (ediff-buffer-live-p ediff-buffer-C))
1241 (error "You've killed an essential Ediff buffer---Please quit Ediff"))
1243 (ediff-operate-on-windows
1244 (if (memq last-command-char '(?v ?\C-v))
1247 ;; calculate argument to scroll-up/down
1248 ;; if there is an explicit argument
1249 (if (and arg (not (equal arg '-)))
1251 (prefix-numeric-value arg)
1252 ;; if not, see if we can determine a default amount (the window height)
1253 (let* (default-amount)
1254 (setq default-amount
1255 (- (min (window-height ediff-window-A)
1256 (window-height ediff-window-B)
1258 (window-height ediff-window-C)
1259 123) ; some large number
1261 1 next-screen-context-lines))
1264 ;; C-u as argument means half of default amount
1265 (/ default-amount 2)
1266 ;; no argument means default amount
1270 (defun ediff-scroll-horizontally (&optional arg)
1271 "Horizontally scroll buffers A, B \(and C if appropriate\).
1272 If an argument is given, that is how many columns are scrolled, else nearly
1273 the width of the A/B/C windows."
1276 ;; make sure windows aren't dead
1277 (if (not (and (window-live-p ediff-window-A) (window-live-p ediff-window-B)))
1278 (ediff-recenter 'no-rehighlight))
1279 (if (not (and (ediff-buffer-live-p ediff-buffer-A)
1280 (ediff-buffer-live-p ediff-buffer-B)
1281 (or (not ediff-3way-job)
1282 (ediff-buffer-live-p ediff-buffer-C))
1284 (error "You've killed an essential Ediff buffer---Please quit Ediff"))
1286 (ediff-operate-on-windows
1287 (if (= last-command-char ?<)
1290 ;; calculate argument to scroll-left/right
1291 ;; if there is an explicit argument
1292 (if (and arg (not (equal arg '-)))
1294 (prefix-numeric-value arg)
1295 ;; if not, see if we can determine a default amount
1296 ;; (half the window width)
1297 (if (null ediff-control-window)
1298 ;; no control window, use nil
1300 (let ((default-amount
1301 (- (/ (min (window-width ediff-window-A)
1302 (window-width ediff-window-B)
1303 (if ediff-3way-comparison-job
1304 (window-width ediff-window-C)
1305 500) ; some large number
1311 ;; C-u as argument means half of default amount
1312 (/ default-amount 2)
1313 ;; no argument means default amount
1314 default-amount))))))
1317 ;;BEG, END show the region to be positioned.
1318 ;;JOB-NAME holds ediff-job-name. Ediff-windows job positions regions
1320 (defun ediff-position-region (beg end pos job-name)
1321 (if (> end (point-max))
1322 (setq end (point-max)))
1323 (if ediff-windows-job
1324 (if (pos-visible-in-window-p end)
1325 () ; do nothing, wind is already positioned
1326 ;; at this point, windows are positioned at the beginning of the
1327 ;; file regions (not diff-regions) being compared.
1329 (move-to-window-line (- (window-height) 2))
1330 (let ((amount (+ 2 (count-lines (point) end))))
1331 (scroll-up amount))))
1332 (set-window-start (selected-window) beg)
1333 (if (pos-visible-in-window-p end)
1334 ;; Determine the number of lines that the region occupies
1337 (while ( and (> end (progn
1338 (move-to-window-line lines)
1340 ;; `end' may be beyond the window bottom, so check
1341 ;; that we are making progres
1342 (< prev-point (point)))
1343 (setq prev-point (point))
1344 (setq lines (1+ lines)))
1345 ;; And position the beginning on the right line
1347 (recenter (/ (1+ (max (- (1- (window-height (selected-window)))
1356 (defun ediff-next-difference (&optional arg)
1357 "Advance to the next difference.
1358 With a prefix argument, go back that many differences."
1360 (if (< ediff-current-difference ediff-number-of-differences)
1361 (let ((n (min ediff-number-of-differences
1362 (+ ediff-current-difference (if arg arg 1))))
1365 (or (>= n ediff-number-of-differences)
1366 (setq regexp-skip (funcall ediff-skip-diff-region-function n))
1367 (ediff-install-fine-diff-if-necessary n))
1368 (while (and (< n ediff-number-of-differences)
1372 ;; skip clashes, if necessary
1373 (and ediff-show-clashes-only
1374 (string-match "prefer"
1375 (or (ediff-get-state-of-merge n) "")))
1376 ;; skip difference regions that differ in white space
1377 (and ediff-ignore-similar-regions
1378 (ediff-no-fine-diffs-p n))))
1380 (if (= 0 (mod n 20))
1381 (message "Skipped over region %d and counting ..." n))
1382 (or (>= n ediff-number-of-differences)
1383 (setq regexp-skip (funcall ediff-skip-diff-region-function n))
1384 (ediff-install-fine-diff-if-necessary n))
1387 (ediff-unselect-and-select-difference n)
1389 (ediff-visible-region)
1390 (error "At end of the difference list")))
1392 (defun ediff-previous-difference (&optional arg)
1393 "Go to the previous difference.
1394 With a prefix argument, go back that many differences."
1396 (if (> ediff-current-difference -1)
1397 (let ((n (max -1 (- ediff-current-difference (if arg arg 1))))
1401 (setq regexp-skip (funcall ediff-skip-diff-region-function n))
1402 (ediff-install-fine-diff-if-necessary n))
1403 (while (and (> n -1)
1407 ;; skip clashes, if necessary
1408 (and ediff-show-clashes-only
1409 (string-match "prefer"
1410 (or (ediff-get-state-of-merge n) "")))
1411 ;; skip difference regions that differ in white space
1412 (and ediff-ignore-similar-regions
1413 (ediff-no-fine-diffs-p n))))
1414 (if (= 0 (mod (1+ n) 20))
1415 (message "Skipped over region %d and counting ..." (1+ n)))
1418 (setq regexp-skip (funcall ediff-skip-diff-region-function n))
1419 (ediff-install-fine-diff-if-necessary n))
1422 (ediff-unselect-and-select-difference n)
1424 (ediff-visible-region)
1425 (error "At beginning of the difference list")))
1427 (defun ediff-jump-to-difference (difference-number)
1428 "Go to the difference specified as a prefix argument."
1430 (setq difference-number (1- difference-number))
1431 (if (and (>= difference-number -1)
1432 (< difference-number (1+ ediff-number-of-differences)))
1433 (ediff-unselect-and-select-difference difference-number)
1434 (error "Bad difference number, %d" difference-number)))
1436 (defun ediff-jump-to-difference-at-point ()
1437 "Go to difference closest to the point in buffer A, B, or C.
1438 The type of buffer depends on last command character \(a, b, or c\) that
1439 invoked this command."
1441 (let ((buf-type (ediff-char-to-buftype last-command-char)))
1442 (ediff-jump-to-difference (ediff-diff-at-point buf-type))))
1445 ;; find region most related to the current point position (or POS, if given)
1446 (defun ediff-diff-at-point (buf-type &optional pos)
1447 (let ((buffer (ediff-get-buffer buf-type))
1448 (ctl-buffer ediff-control-buffer)
1449 (max-dif-num (1- ediff-number-of-differences))
1456 (ediff-eval-in-buffer buffer
1457 (setq pos (or pos (point)))
1458 (while (and (or (< pos prev-beg) (> pos beg))
1459 (< diff-no max-dif-num))
1460 (setq diff-no (1+ diff-no))
1463 (setq beg (ediff-get-diff-posn buf-type 'beg diff-no ctl-buffer)
1464 end (ediff-get-diff-posn buf-type 'end diff-no ctl-buffer))
1467 (if (< (abs (- pos prev-end))
1470 (1+ diff-no)) ; jump-to-diff works with diff nums higher by 1
1476 (defun ediff-diff-to-diff (arg &optional keys)
1477 "Copy buffer-X'th diff to buffer Y \(X,Y are A, B, or C\).
1478 If numerical prefix argument, copy this diff specified in the arg.
1479 Otherwise, copy the difference given by `ediff-current-difference'.
1480 This command assumes it is bound to a 2-character key sequence, `ab', `ba',
1481 `ac', etc., which is used to determine the types of buffers to be used for
1482 copying difference regions. The first character in the sequence specifies
1483 the source buffer and the second specifies the target.
1485 If the second optional argument, a 2-character string, is given, use it to
1486 determine the source and the target buffers instead of the command keys."
1488 (or keys (setq keys (this-command-keys)))
1490 (ediff-jump-to-difference arg))
1491 (let* ((key1 (aref keys 0))
1492 (key2 (aref keys 1))
1493 (char1 (if (and ediff-xemacs-p (eventp key1)) (event-key key1) key1))
1494 (char2 (if (and ediff-xemacs-p (eventp key1)) (event-key key2) key2)))
1495 (ediff-copy-diff ediff-current-difference
1496 (ediff-char-to-buftype char1)
1497 (ediff-char-to-buftype char2))
1498 (ediff-recenter 'no-rehighlight)))
1501 ;; Copy diff N from FROM-BUF-TYPE \(given as A, B or C\) to TO-BUF-TYPE.
1502 ;; If optional DO-NOT-SAVE is non-nil, do not save the old value of the
1503 ;; target diff. This is used in merging, when constructing the merged
1505 (defun ediff-copy-diff (n from-buf-type to-buf-type
1506 &optional batch-invocation reg-to-copy)
1507 (let* ((to-buf (ediff-get-buffer to-buf-type))
1508 ;;(from-buf (if (not reg-to-copy) (ediff-get-buffer from-buf-type)))
1509 (ctrl-buf ediff-control-buffer)
1511 (three-way ediff-3way-job)
1514 reg-to-delete reg-to-delete-beg reg-to-delete-end)
1516 (setq reg-to-delete-beg
1517 (ediff-get-diff-posn to-buf-type 'beg n ctrl-buf))
1518 (setq reg-to-delete-end
1519 (ediff-get-diff-posn to-buf-type 'end n ctrl-buf))
1522 (setq from-buf-type nil)
1523 (setq reg-to-copy (ediff-get-region-contents n from-buf-type ctrl-buf)))
1525 (setq reg-to-delete (ediff-get-region-contents
1526 n to-buf-type ctrl-buf
1527 reg-to-delete-beg reg-to-delete-end))
1529 (setq ediff-disturbed-overlays nil) ; clear before use
1531 (if (string= reg-to-delete reg-to-copy)
1532 (setq saved-p nil) ; refuse to copy identical buffers
1534 (if (or batch-invocation (ediff-test-save-region n to-buf-type))
1535 (condition-case conds
1537 (ediff-eval-in-buffer to-buf
1538 ;; to prevent flags from interfering if buffer is writable
1539 (let ((inhibit-read-only (null buffer-read-only)))
1540 ;; these two insert a dummy char to overcome a bug in
1541 ;; XEmacs, which sometimes prevents 0-length extents
1542 ;; from sensing insertion at its end-points.
1545 (goto-char reg-to-delete-end)
1546 (insert-before-markers "@")))
1548 (goto-char reg-to-delete-end)
1549 (insert-before-markers reg-to-copy)
1551 ;; delete the dummy char "@"
1556 (if (> reg-to-delete-end reg-to-delete-beg)
1557 (kill-region reg-to-delete-beg
1559 (if (> reg-to-delete-end reg-to-delete-beg)
1560 (kill-region reg-to-delete-beg reg-to-delete-end)
1561 (ediff-move-disturbed-overlays reg-to-delete-beg)
1564 (or batch-invocation
1567 (ediff-save-diff-region n to-buf-type reg-to-delete))))
1568 (error (message "ediff-copy-diff: %s %s"
1570 (mapconcat 'prin1-to-string (cdr conds) " "))
1577 ;; adjust state of difference in case 3-way and diff was copied ok
1578 (if (and saved-p three-way)
1579 (ediff-set-state-of-diff-in-all-buffers n ctrl-buf))
1581 (if batch-invocation
1582 (ediff-clear-fine-differences n)
1583 ;; If diff3 job, we should recompute fine diffs so we clear them
1584 ;; before reinserting flags (and thus before ediff-recenter).
1585 (if (and saved-p three-way)
1586 (ediff-clear-fine-differences n))
1588 (ediff-refresh-mode-lines)
1590 ;; For diff2 jobs, don't recompute fine diffs, since we know there
1591 ;; aren't any. So we clear diffs after ediff-recenter.
1592 (if (and saved-p (not three-way))
1593 (ediff-clear-fine-differences n))
1594 ;; Make sure that the message about saving and how to restore is seen
1599 ;; Save Nth diff of buffer BUF-TYPE \(A, B, or C\).
1600 ;; That is to say, the Nth diff on the `ediff-killed-diffs-alist'. REG
1601 ;; is the region to save. It is redundant here, but is passed anyway, for
1603 (defun ediff-save-diff-region (n buf-type reg)
1604 (let* ((n-th-diff-saved (assoc n ediff-killed-diffs-alist))
1605 (buf (ediff-get-buffer buf-type))
1606 (this-buf-n-th-diff-saved (assoc buf (cdr n-th-diff-saved))))
1608 (if this-buf-n-th-diff-saved
1609 ;; either nothing saved for n-th diff and buffer or we OK'ed
1611 (setcdr this-buf-n-th-diff-saved reg)
1612 (if n-th-diff-saved ;; n-th diff saved, but for another buffer
1613 (nconc n-th-diff-saved (list (cons buf reg)))
1614 (setq ediff-killed-diffs-alist ;; create record for n-th diff
1615 (cons (list n (cons buf reg))
1616 ediff-killed-diffs-alist))))
1617 (message "Saving old diff region #%d of buffer %S. To recover, type `r%s'"
1620 "" (downcase (symbol-name buf-type))))
1623 ;; Test if saving Nth difference region of buffer BUF-TYPE is possible.
1624 (defun ediff-test-save-region (n buf-type)
1625 (let* ((n-th-diff-saved (assoc n ediff-killed-diffs-alist))
1626 (buf (ediff-get-buffer buf-type))
1627 (this-buf-n-th-diff-saved (assoc buf (cdr n-th-diff-saved))))
1629 (if this-buf-n-th-diff-saved
1632 "You've previously copied diff region %d to buffer %S. Confirm "
1638 (defun ediff-pop-diff (n buf-type)
1639 "Pop last killed Nth diff region from buffer BUF-TYPE."
1640 (let* ((n-th-record (assoc n ediff-killed-diffs-alist))
1641 (buf (ediff-get-buffer buf-type))
1642 (saved-rec (assoc buf (cdr n-th-record)))
1643 (three-way ediff-3way-job)
1644 (ctl-buf ediff-control-buffer)
1646 saved-diff reg-beg reg-end recovered)
1649 (setq saved-diff (cdr saved-rec))
1650 (if (> ediff-number-of-differences 0)
1651 (error "Nothing saved for diff %d in buffer %S" (1+ n) buf-type)
1652 (error "No differences found")))
1654 (setq reg-beg (ediff-get-diff-posn buf-type 'beg n ediff-control-buffer))
1655 (setq reg-end (ediff-get-diff-posn buf-type 'end n ediff-control-buffer))
1656 (setq ediff-disturbed-overlays nil) ; clear before use
1658 (condition-case conds
1659 (ediff-eval-in-buffer buf
1660 (let ((inhibit-read-only (null buffer-read-only)))
1661 ;; these two insert a dummy char to overcome a bug in XEmacs,
1662 ;; which sometimes prevents 0-length extents from sensing
1663 ;; insertion at its end-points.
1667 (insert-before-markers "@")))
1670 (insert-before-markers saved-diff)
1672 ;; delete dummy char
1677 (if (> reg-end reg-beg)
1678 (kill-region reg-beg reg-end))
1679 (if (> reg-end reg-beg)
1680 (kill-region reg-beg reg-end)
1681 (ediff-move-disturbed-overlays reg-beg)
1686 (error (message "ediff-pop-diff: %s %s"
1688 (mapconcat 'prin1-to-string (cdr conds) " "))
1691 ;; Clearing fine diffs is necessary for
1692 ;; ediff-unselect-and-select-difference to properly recompute them. We
1693 ;; can't rely on ediff-copy-diff to clear this vector, as the user might
1694 ;; have modified diff regions after copying and, thus, may have recomputed
1697 (ediff-clear-fine-differences n))
1699 ;; adjust state of difference
1700 (if (and three-way recovered)
1701 (ediff-set-state-of-diff-in-all-buffers n ctl-buf))
1703 (ediff-refresh-mode-lines)
1707 (setq n-th-record (delq saved-rec n-th-record))
1708 (message "Diff region %d in buffer %S restored" (1+ n) buf-type)
1712 (defun ediff-restore-diff (arg &optional key)
1713 "Restore ARGth diff from `ediff-killed-diffs-alist'.
1714 ARG is a prefix argument. If ARG is nil, restore current-difference.
1716 If the second optional argument, a character, is given, use it to
1717 determine the target buffer instead of last-command-char"
1720 (ediff-jump-to-difference arg))
1721 (ediff-pop-diff ediff-current-difference
1722 (ediff-char-to-buftype (or key last-command-char)))
1723 (ediff-recenter 'no-rehighlight))
1725 (defun ediff-toggle-regexp-match ()
1726 "Toggle between focusing and hiding of difference regions that match
1727 a regular expression typed in by the user."
1732 msg-connective alt-msg-connective alt-connective)
1734 ((or (and (eq ediff-skip-diff-region-function
1735 'ediff-focus-on-regexp-matches)
1736 (eq last-command-char ?f))
1737 (and (eq ediff-skip-diff-region-function 'ediff-hide-regexp-matches)
1738 (eq last-command-char ?h)))
1739 (message "Selective browsing by regexp turned off")
1740 (setq ediff-skip-diff-region-function 'ediff-show-all-diffs))
1741 ((eq last-command-char ?h)
1742 (setq ediff-skip-diff-region-function 'ediff-hide-regexp-matches
1746 "Ignore A-regions matching this regexp (default \"%s\"): "
1747 ediff-regexp-hide-A))
1751 "Ignore B-regions matching this regexp (default \"%s\"): "
1752 ediff-regexp-hide-B)))
1753 (if ediff-3way-comparison-job
1757 "Ignore C-regions matching this regexp (default \"%s\"): "
1758 ediff-regexp-hide-C))))
1759 (if (eq ediff-hide-regexp-connective 'and)
1760 (setq msg-connective "BOTH"
1761 alt-msg-connective "ONE OF"
1763 (setq msg-connective "ONE OF"
1764 alt-msg-connective "BOTH"
1765 alt-connective 'and))
1768 "Hiding diff regions that match %s regexps. Use %s instead? "
1769 msg-connective alt-msg-connective))
1771 (setq ediff-hide-regexp-connective alt-connective)
1772 (message "Hiding diff regions that match %s regexps"
1773 alt-msg-connective))
1774 (message "Hiding diff regions that match %s regexps" msg-connective))
1775 (or (string= regexp-A "") (setq ediff-regexp-hide-A regexp-A))
1776 (or (string= regexp-B "") (setq ediff-regexp-hide-B regexp-B))
1777 (or (string= regexp-C "") (setq ediff-regexp-hide-C regexp-C)))
1778 ((eq last-command-char ?f)
1779 (setq ediff-skip-diff-region-function 'ediff-focus-on-regexp-matches
1783 "Focus on A-regions matching this regexp (default \"%s\"): "
1784 ediff-regexp-focus-A))
1788 "Focus on B-regions matching this regexp (default \"%s\"): "
1789 ediff-regexp-focus-B)))
1790 (if ediff-3way-comparison-job
1794 "Focus on C-regions matching this regexp (default \"%s\"): "
1795 ediff-regexp-focus-C))))
1796 (if (eq ediff-focus-regexp-connective 'and)
1797 (setq msg-connective "BOTH"
1798 alt-msg-connective "ONE OF"
1800 (setq msg-connective "ONE OF"
1801 alt-msg-connective "BOTH"
1802 alt-connective 'and))
1805 "Focusing on diff regions that match %s regexps. Use %s instead? "
1806 msg-connective alt-msg-connective))
1808 (setq ediff-focus-regexp-connective alt-connective)
1809 (message "Focusing on diff regions that match %s regexps"
1810 alt-msg-connective))
1811 (message "Focusing on diff regions that match %s regexps"
1813 (or (string= regexp-A "") (setq ediff-regexp-focus-A regexp-A))
1814 (or (string= regexp-B "") (setq ediff-regexp-focus-B regexp-B))
1815 (or (string= regexp-C "") (setq ediff-regexp-focus-C regexp-C))))))
1817 (defun ediff-toggle-skip-similar ()
1819 (if (not (eq ediff-auto-refine 'on))
1821 "Can't skip over whitespace regions: first turn auto-refining on"))
1822 (setq ediff-ignore-similar-regions (not ediff-ignore-similar-regions))
1823 (if ediff-ignore-similar-regions
1825 "Skipping regions that differ only in white space & line breaks")
1826 (message "Skipping over white-space differences turned off")))
1828 (defun ediff-focus-on-regexp-matches (n)
1829 "Focus on diffs that match regexp `ediff-regexp-focus-A/B'.
1830 Regions to be ignored according to this function are those where
1831 buf A region doesn't match `ediff-regexp-focus-A' and buf B region
1832 doesn't match `ediff-regexp-focus-B'.
1833 This function returns nil if the region number N (specified as
1834 an argument) is not to be ignored and t if region N is to be ignored.
1836 N is a region number used by Ediff internally. It is 1 less
1837 the number seen by the user."
1838 (if (ediff-valid-difference-p n)
1839 (let* ((ctl-buf ediff-control-buffer)
1840 (regex-A ediff-regexp-focus-A)
1841 (regex-B ediff-regexp-focus-B)
1842 (regex-C ediff-regexp-focus-C)
1843 (reg-A-match (ediff-eval-in-buffer ediff-buffer-A
1844 (goto-char (ediff-get-diff-posn 'A 'beg n ctl-buf))
1847 (ediff-get-diff-posn 'A 'end n ctl-buf)
1849 (reg-B-match (ediff-eval-in-buffer ediff-buffer-B
1850 (goto-char (ediff-get-diff-posn 'B 'beg n ctl-buf))
1853 (ediff-get-diff-posn 'B 'end n ctl-buf)
1855 (reg-C-match (if ediff-3way-comparison-job
1856 (ediff-eval-in-buffer ediff-buffer-C
1858 (ediff-get-diff-posn 'C 'beg n ctl-buf))
1861 (ediff-get-diff-posn 'C 'end n ctl-buf)
1863 (not (eval (if ediff-3way-comparison-job
1864 (list ediff-focus-regexp-connective
1865 reg-A-match reg-B-match reg-C-match)
1866 (list ediff-focus-regexp-connective
1867 reg-A-match reg-B-match))))
1870 (defun ediff-hide-regexp-matches (n)
1871 "Hide diffs that match regexp `ediff-regexp-hide-A/B/C'.
1872 Regions to be ignored are those where buf A region matches
1873 `ediff-regexp-hide-A' and buf B region matches `ediff-regexp-hide-B'.
1874 This function returns nil if the region number N (specified as
1875 an argument) is not to be ignored and t if region N is to be ignored.
1877 N is a region number used by Ediff internally. It is 1 less
1878 the number seen by the user."
1879 (if (ediff-valid-difference-p n)
1880 (let* ((ctl-buf ediff-control-buffer)
1881 (regex-A ediff-regexp-hide-A)
1882 (regex-B ediff-regexp-hide-B)
1883 (regex-C ediff-regexp-hide-C)
1884 (reg-A-match (ediff-eval-in-buffer ediff-buffer-A
1885 (goto-char (ediff-get-diff-posn 'A 'beg n ctl-buf))
1888 (ediff-get-diff-posn 'A 'end n ctl-buf)
1890 (reg-B-match (ediff-eval-in-buffer ediff-buffer-B
1891 (goto-char (ediff-get-diff-posn 'B 'beg n ctl-buf))
1894 (ediff-get-diff-posn 'B 'end n ctl-buf)
1896 (reg-C-match (if ediff-3way-comparison-job
1897 (ediff-eval-in-buffer ediff-buffer-C
1899 (ediff-get-diff-posn 'C 'beg n ctl-buf))
1902 (ediff-get-diff-posn 'C 'end n ctl-buf)
1904 (eval (if ediff-3way-comparison-job
1905 (list ediff-hide-regexp-connective
1906 reg-A-match reg-B-match reg-C-match)
1907 (list ediff-hide-regexp-connective reg-A-match reg-B-match)))
1912 ;;; Quitting, suspending, etc.
1914 (defun ediff-quit ()
1915 "Finish an Ediff session and exit Ediff.
1916 Unselects the selected difference, if any, restores the read-only and modified
1917 flags of the compared file buffers, kills Ediff buffers for this session
1918 \(but not buffers A, B, C\)."
1921 (y-or-n-p "Do you really want to exit Ediff? ")
1923 (ediff-really-quit)))
1926 ;; Perform the quit operations.
1927 (defun ediff-really-quit ()
1928 (ediff-unhighlight-diffs-totally)
1929 (ediff-clear-diff-vector 'ediff-difference-vector-A 'fine-diffs-also)
1930 (ediff-clear-diff-vector 'ediff-difference-vector-B 'fine-diffs-also)
1931 (ediff-clear-diff-vector 'ediff-difference-vector-C 'fine-diffs-also)
1933 (ediff-delete-temp-files)
1935 ;; Restore visibility range. This affects only ediff-*-regions/windows.
1936 ;; Since for other job names ediff-visible-region sets
1937 ;; ediff-visible-bounds to ediff-wide-bounds, the settings below are
1938 ;; ignored for such jobs.
1939 (if ediff-quit-widened
1940 (setq ediff-visible-bounds ediff-wide-bounds)
1941 (setq ediff-visible-bounds ediff-narrow-bounds))
1943 ;; Apply selective display to narrow or widen
1944 (ediff-visible-region)
1945 (mapcar (function (lambda (overl)
1946 (if (ediff-overlayp overl)
1947 (ediff-delete-overlay overl))))
1949 (mapcar (function (lambda (overl)
1950 (if (ediff-overlayp overl)
1951 (ediff-delete-overlay overl))))
1952 ediff-narrow-bounds)
1954 ;; restore buffer mode line id's in buffer-A/B/C
1955 (let ((control-buffer ediff-control-buffer))
1957 (ediff-eval-in-buffer ediff-buffer-A
1958 (setq ediff-this-buffer-control-sessions
1959 (delq control-buffer ediff-this-buffer-control-sessions))
1960 (kill-local-variable 'mode-line-buffer-identification)
1961 (kill-local-variable 'mode-line-format)
1966 (ediff-eval-in-buffer ediff-buffer-B
1967 (setq ediff-this-buffer-control-sessions
1968 (delq control-buffer ediff-this-buffer-control-sessions))
1969 (kill-local-variable 'mode-line-buffer-identification)
1970 (kill-local-variable 'mode-line-format)
1975 (ediff-eval-in-buffer ediff-buffer-C
1976 (kill-local-variable 'mode-line-buffer-identification)
1977 (kill-local-variable 'mode-line-format)
1981 ;; restore state of buffers to what it was before ediff
1982 (ediff-restore-protected-variables)
1983 ;; good place to kill buffers A/B/C
1984 (run-hooks 'ediff-cleanup-hooks)
1985 (run-hooks 'ediff-quit-hooks))
1988 (defun ediff-delete-temp-files ()
1989 (if (stringp ediff-temp-file-A)
1990 (delete-file ediff-temp-file-A))
1991 (if (stringp ediff-temp-file-B)
1992 (delete-file ediff-temp-file-B))
1993 (if (stringp ediff-temp-file-C)
1994 (delete-file ediff-temp-file-C)))
1997 ;; Kill control buffer, other auxiliary Ediff buffers.
1998 ;; Leave one of the frames split between buffers A/B/C
1999 (defun ediff-cleanup-mess ()
2000 (let ((buff-A ediff-buffer-A)
2001 (buff-B ediff-buffer-B)
2002 (buff-C ediff-buffer-C)
2003 (ctl-buf ediff-control-buffer)
2004 (ctl-frame ediff-control-frame)
2005 (three-way-job ediff-3way-job))
2007 (ediff-kill-buffer-carefully ediff-diff-buffer)
2008 (ediff-kill-buffer-carefully ediff-custom-diff-buffer)
2009 (ediff-kill-buffer-carefully ediff-fine-diff-buffer)
2010 (ediff-kill-buffer-carefully ediff-tmp-buffer)
2011 (ediff-kill-buffer-carefully ediff-error-buffer)
2012 (ediff-kill-buffer-carefully ediff-patch-diagnostics)
2013 (ediff-kill-buffer-carefully ediff-msg-buffer)
2014 (ediff-kill-buffer-carefully ediff-debug-buffer)
2017 (if (and (ediff-window-display-p) (frame-live-p ctl-frame))
2018 (delete-frame ctl-frame))
2019 (ediff-kill-buffer-carefully ctl-buf)
2021 (delete-other-windows)
2023 ;; display only if not visible
2025 (or (ediff-get-visible-buffer-window buff-B)
2026 (switch-to-buffer buff-B))
2029 (or (ediff-get-visible-buffer-window buff-A)
2031 (if (ediff-get-visible-buffer-window buff-B)
2032 (split-window-vertically))
2033 (switch-to-buffer buff-A)))
2037 (or (ediff-get-visible-buffer-window buff-C)
2039 (if (or (ediff-get-visible-buffer-window buff-A)
2040 (ediff-get-visible-buffer-window buff-B))
2041 (split-window-vertically))
2042 (switch-to-buffer buff-C)
2048 (defun ediff-janitor ()
2049 "Kill buffers A, B, and, possibly, C, if these buffers aren't modified.
2050 In merge jobs, buffer C is never deleted.
2051 However, the side effect of cleaning up may be that you cannot compare the same
2052 buffer in two separate Ediff sessions: quitting one of them will delete this
2053 buffer in another session as well."
2054 (or (not (ediff-buffer-live-p ediff-buffer-A))
2055 (buffer-modified-p ediff-buffer-A)
2056 (ediff-kill-buffer-carefully ediff-buffer-A))
2057 (or (not (ediff-buffer-live-p ediff-buffer-B))
2058 (buffer-modified-p ediff-buffer-B)
2059 (ediff-kill-buffer-carefully ediff-buffer-B))
2060 (if ediff-merge-job ; don't del buf C if merging--del ancestor buf instead
2061 (or (not (ediff-buffer-live-p ediff-ancestor-buffer))
2062 (buffer-modified-p ediff-ancestor-buffer)
2063 (ediff-kill-buffer-carefully ediff-ancestor-buffer))
2064 (or (not (ediff-buffer-live-p ediff-buffer-C))
2065 (buffer-modified-p ediff-buffer-C)
2066 (ediff-kill-buffer-carefully ediff-buffer-C))))
2068 ;; The default way of suspending Ediff.
2069 ;; Buries Ediff buffers, kills all windows.
2070 (defun ediff-default-suspend-hook ()
2071 (let* ((buf-A ediff-buffer-A)
2072 (buf-B ediff-buffer-B)
2073 (buf-C ediff-buffer-C)
2074 (buf-A-wind (ediff-get-visible-buffer-window buf-A))
2075 (buf-B-wind (ediff-get-visible-buffer-window buf-B))
2076 (buf-C-wind (ediff-get-visible-buffer-window buf-C))
2077 (buf-patch ediff-patch-buf)
2078 (buf-patch-diag ediff-patch-diagnostics)
2079 (buf-err ediff-error-buffer)
2080 (buf-diff ediff-diff-buffer)
2081 (buf-custom-diff ediff-custom-diff-buffer)
2082 (buf-fine-diff ediff-fine-diff-buffer))
2084 ;; hide the control panel
2085 (if (and (ediff-window-display-p) (frame-live-p ediff-control-frame))
2086 (iconify-frame ediff-control-frame)
2088 (if buf-err (bury-buffer buf-err))
2089 (if buf-diff (bury-buffer buf-diff))
2090 (if buf-custom-diff (bury-buffer buf-custom-diff))
2091 (if buf-fine-diff (bury-buffer buf-fine-diff))
2092 (if buf-patch (bury-buffer buf-patch))
2093 (if buf-patch-diag (bury-buffer buf-patch-diag))
2094 (if (window-live-p buf-A-wind)
2096 (select-window buf-A-wind)
2097 (delete-other-windows)
2099 (if (ediff-buffer-live-p buf-A) (bury-buffer buf-A)))
2100 (if (window-live-p buf-B-wind)
2102 (select-window buf-B-wind)
2103 (delete-other-windows)
2105 (if (ediff-buffer-live-p buf-B) (bury-buffer buf-B)))
2106 (if (window-live-p buf-C-wind)
2108 (select-window buf-C-wind)
2109 (delete-other-windows)
2111 (if (ediff-buffer-live-p buf-C) (bury-buffer buf-C)))
2116 (defun ediff-suspend ()
2118 To resume, switch to the appropriate `Ediff Control Panel'
2119 buffer and then type \\[ediff-recenter]. Ediff will automatically set
2120 up an appropriate window config."
2122 (let ((key (substitute-command-keys "\\[ediff-recenter]")))
2123 (run-hooks 'ediff-suspend-hooks)
2125 "To resume, switch to Ediff Control Panel and hit `%s'" key)))
2128 (defun ediff-status-info ()
2129 "Show the names of the buffers or files being operated on by Ediff.
2130 Hit \\[ediff-recenter] to reset the windows afterward."
2132 (with-output-to-temp-buffer " *ediff-info*"
2133 (princ (ediff-version))
2135 (ediff-eval-in-buffer ediff-buffer-A
2136 (if buffer-file-name
2138 (format "File A = %S\n" buffer-file-name))
2140 (format "Buffer A = %S\n" (buffer-name)))))
2141 (ediff-eval-in-buffer ediff-buffer-B
2142 (if buffer-file-name
2144 (format "File B = %S\n" buffer-file-name))
2146 (format "Buffer B = %S\n" (buffer-name)))))
2148 (ediff-eval-in-buffer ediff-buffer-C
2149 (if buffer-file-name
2151 (format "File C = %S\n" buffer-file-name))
2153 (format "Buffer C = %S\n" (buffer-name))))))
2155 (let* ((A-line (ediff-eval-in-buffer ediff-buffer-A
2156 (1+ (count-lines (point-min) (point)))))
2157 (B-line (ediff-eval-in-buffer ediff-buffer-B
2158 (1+ (count-lines (point-min) (point)))))
2160 (princ (format "\Buffer A's point is on line %d\n" A-line))
2161 (princ (format "Buffer B's point is on line %d\n" B-line))
2164 (setq C-line (ediff-eval-in-buffer ediff-buffer-C
2165 (1+ (count-lines (point-min) (point)))))
2166 (princ (format "Buffer C's point is on line %d\n" C-line)))))
2168 (princ (format "\nCurrent difference number = %S\n"
2169 (cond ((< ediff-current-difference 0) 'start)
2170 ((>= ediff-current-difference
2171 ediff-number-of-differences) 'end)
2172 (t (1+ ediff-current-difference)))))
2174 (cond (ediff-ignore-similar-regions
2175 (princ "\nSkipping regions that differ only in white space & line breaks"))
2177 (princ "\nNot skipping regions that differ in white space & line breaks")))
2179 (cond ((eq ediff-skip-diff-region-function 'ediff-show-all-diffs)
2180 (princ "\nSelective browsing by regexp is off.\n"))
2181 ((eq ediff-skip-diff-region-function 'ediff-hide-regexp-matches)
2183 "\nIgnoring regions that match")
2186 "\n\t regexp `%s' in buffer A %S\n\t regexp `%s' in buffer B\n"
2187 ediff-regexp-hide-A ediff-hide-regexp-connective
2188 ediff-regexp-hide-B)))
2189 ((eq ediff-skip-diff-region-function 'ediff-focus-on-regexp-matches)
2191 "\nFocusing on regions that match")
2194 "\n\t regexp `%s' in buffer A %S\n\t regexp `%s' in buffer B\n"
2195 ediff-regexp-focus-A ediff-focus-regexp-connective
2196 ediff-regexp-focus-B)))
2197 (t (princ "\nSelective browsing via a user-defined method.\n")))
2200 (format "\nBugs/suggestions: type `%s' while in Ediff Control Panel."
2201 (substitute-command-keys "\\[ediff-submit-report]")))
2204 (defun ediff-documentation ()
2205 "Jump to Ediff's Info file."
2207 (let ((ctl-window ediff-control-window)
2208 (ctl-buf ediff-control-buffer))
2210 (ediff-skip-unsuitable-frames)
2213 (pop-to-buffer (get-buffer-create "*info*"))
2215 (message "Type `i' to search for a specific topic"))
2217 (with-output-to-temp-buffer " *ediff-info*"
2219 The Info file for Ediff does not seem to be installed.
2221 This file is part of the distribution of %sEmacs.
2222 Please contact your system administrator. "
2223 (if ediff-xemacs-p "X" ""))))
2224 (if (window-live-p ctl-window)
2226 (select-window ctl-window)
2227 (switch-to-buffer ctl-buf)))))))
2232 ;;; Support routines
2234 ;; Select a difference by placing the ASCII flags around the appropriate
2235 ;; group of lines in the A, B buffers
2236 ;; This may have to be modified for buffer C, when it will be supported.
2237 (defun ediff-select-difference (n)
2238 (if (and (ediff-buffer-live-p ediff-buffer-A)
2239 (ediff-buffer-live-p ediff-buffer-B)
2240 (ediff-valid-difference-p n))
2242 (if (and (ediff-window-display-p) ediff-use-faces)
2244 (ediff-highlight-diff n)
2245 (setq ediff-highlighting-style 'face))
2246 (setq ediff-highlighting-style 'ascii)
2247 (ediff-place-flags-in-buffer
2248 'A ediff-buffer-A ediff-control-buffer n)
2249 (ediff-place-flags-in-buffer
2250 'B ediff-buffer-B ediff-control-buffer n)
2252 (ediff-place-flags-in-buffer
2253 'C ediff-buffer-C ediff-control-buffer n))
2256 (ediff-install-fine-diff-if-necessary n)
2257 (run-hooks 'ediff-select-hooks))))
2260 ;; Unselect a difference by removing the ASCII flags in the buffers.
2261 ;; This may have to be modified for buffer C, when it will be supported.
2262 (defun ediff-unselect-difference (n)
2263 (if (ediff-valid-difference-p n)
2265 (cond ((and (ediff-window-display-p) ediff-use-faces)
2266 (ediff-unhighlight-diff))
2267 ((eq ediff-highlighting-style 'ascii)
2268 (ediff-remove-flags-from-buffer
2270 (ediff-get-diff-overlay n 'A))
2271 (ediff-remove-flags-from-buffer
2273 (ediff-get-diff-overlay n 'B))
2275 (ediff-remove-flags-from-buffer
2277 (ediff-get-diff-overlay n 'C)))
2279 (setq ediff-highlighting-style nil)
2281 ;; unhighlight fine diffs
2282 (ediff-set-fine-diff-properties ediff-current-difference 'default)
2283 (run-hooks 'ediff-unselect-hooks))))
2286 ;; Unselects prev diff and selects a new one, if FLAG has value other than
2287 ;; 'select-only or 'unselect-only. If FLAG is 'select-only, the
2288 ;; next difference is selected, but the current selection is not
2289 ;; unselected. If FLAG is 'unselect-only then the current selection is
2290 ;; unselected, but the next one is not selected. If NO-RECENTER is non-nil,
2291 ;; don't recenter buffers after selecting/unselecting.
2293 (defun ediff-unselect-and-select-difference (n &optional flag no-recenter)
2294 (let ((ediff-current-difference n))
2296 (ediff-recenter 'no-rehighlight)))
2298 (let ((control-buf ediff-control-buffer))
2301 (or (eq flag 'select-only)
2302 (ediff-unselect-difference ediff-current-difference))
2304 (or (eq flag 'unselect-only)
2305 (ediff-select-difference n))
2306 (setq ediff-current-difference n)
2307 ) ; end protected section
2309 (ediff-eval-in-buffer control-buf
2310 (ediff-refresh-mode-lines))
2314 (defun ediff-read-file-name (prompt default-dir default-file)
2315 ; This is a modified version of a similar function in `emerge.el'.
2316 ; PROMPT should not have trailing ': ', so that it can be modified
2317 ; according to context.
2318 ; If default-file is set, it should be used as the default value.
2319 ; If default-dir is non-nil, use it as the default directory.
2320 ; Otherwise, use the value of Emacs' variable `default-directory.'
2322 ;; hack default-dir if it is not set
2324 (file-name-as-directory
2325 (abbreviate-file-name
2326 (expand-file-name (or default-dir
2328 (file-name-directory default-file))
2329 default-directory)))))
2331 ;; strip the directory from default-file
2333 (setq default-file (file-name-nondirectory default-file)))
2334 (if (string= default-file "")
2335 (setq default-file nil))
2338 (setq f (expand-file-name
2343 (concat " (default " default-file ")")
2347 t ; must match, no-confirm
2348 (if default-file (file-name-directory default-file))
2352 ;; If user enters a directory name, expand the default file in that
2353 ;; directory. This allows the user to enter a directory name for the
2354 ;; B-file and diff against the default-file in that directory instead
2355 ;; of a DIRED listing!
2356 (if (and (file-directory-p f) default-file)
2357 (setq f (expand-file-name
2358 (file-name-nondirectory default-file) f)))
2361 ;; If `prefix' is given, then it is used as a prefix for the temp file
2362 ;; name. Otherwise, `_buffer-name' is used. If `file' is given, use this
2363 ;; file and don't create a new one.
2364 ;; Also, save buffer from START to END in the file.
2365 ;; START defaults to (point-min), END to (point-max)
2366 (defun ediff-make-temp-file (&optional prefix given-file start end)
2367 (let ((f (or given-file
2368 (make-temp-name (concat
2369 ediff-temp-file-prefix
2374 (write-region (if start start (point-min))
2375 (if end end (point-max))
2377 nil ; don't append---erase
2379 (set-file-modes f ediff-temp-file-mode)
2382 ;; Quote metacharacters (using \) when executing diff in Unix, but not in
2384 (defun ediff-protect-metachars (str)
2385 (or (memq system-type '(emx vax-vms axp-vms))
2387 (while (string-match ediff-metachars str limit)
2388 (setq str (concat (substring str 0 (match-beginning 0))
2390 (substring str (match-beginning 0))))
2391 (setq limit (1+ (match-end 0))))))
2394 ;; Make sure the current buffer (for a file) has the same contents as the
2395 ;; file on disk, and attempt to remedy the situation if not.
2396 ;; Signal an error if we can't make them the same, or the user doesn't want
2397 ;; to do what is necessary to make them the same.
2398 ;; If file has file handlers (indicated by the optional arg), then we
2399 ;; offer to instead of saving. This is one difference with Emerge.
2400 ;; Another is that we always offer to revert obsolete files, whether they
2401 ;; are modified or not.
2402 (defun ediff-verify-file-buffer (&optional file-magic)
2403 ;; First check if the file has been modified since the buffer visited it.
2404 (if (verify-visited-file-modtime (current-buffer))
2405 (if (buffer-modified-p)
2406 ;; If buffer is not obsolete and is modified, offer to save
2408 (format "Buffer out of sync with visited file. %s file %s? "
2409 (if file-magic "Revert" "Save")
2411 (if (not file-magic)
2413 ;; for some reason, file-name-handlers append instead of
2414 ;; replacing, so we have to erase first.
2416 (revert-buffer t t))
2417 (error "Buffer out of sync for file %s" buffer-file-name))
2418 ;; If buffer is not obsolete and is not modified, do nothing
2420 ;; If buffer is obsolete, offer to revert
2422 (format "Buffer out of sync with visited file. Revert file %s? "
2427 (revert-buffer t t))
2428 (error "Buffer out of sync for file %s" buffer-file-name))))
2432 (defun ediff-check-for-ascii-flags ()
2435 (mapcar (function (lambda (buf)
2436 (if (ediff-buffer-live-p buf)
2437 (ediff-eval-in-buffer buf
2438 (eq ediff-highlighting-style 'ascii)))))
2439 ediff-this-buffer-control-sessions))))
2441 ;; It would be nice to use these two functions as hooks instead of
2442 ;; ediff-insert-in-front and ediff-move-disturbed-overlays.
2443 ;; However, Emacs has a bug that causes BEG and END, below, to be
2444 ;; the same, i.e., the end of inserted text is not passed correctly.
2445 ;; Since the overlay doesn't move when these hooks run,
2446 ;; there is no way to correctly determine the new (desired) position of
2448 ;; Either this bug is fixed, or (better) use sticky overlays when they will
2449 ;; be implemented in Emacs, like they are in XEmacs.
2450 ;;(defun ediff-capture-inserts-in-front (overl beg end)
2451 ;; (if (ediff-overlay-get overl 'ediff-diff-num)
2452 ;; (ediff-move-overlay
2453 ;; overl beg (+ (- end beg) (ediff-overlay-end overl)))
2455 ;;(defun ediff-capture-inserts-behind (overl beg end)
2456 ;; (if (ediff-overlay-get overl 'ediff-diff-num)
2457 ;; (ediff-move-overlay overl (ediff-overlay-start overl) end))
2460 ;; to be deleted in due time
2461 ;; Capture overlays that had insertions in the front.
2462 ;; Called when overlay OVERL gets insertion in front.
2463 (defun ediff-insert-in-front (overl &optional flag beg end length)
2464 (if (ediff-overlay-get overl 'ediff-diff-num)
2465 (setq ediff-disturbed-overlays
2466 (cons overl ediff-disturbed-overlays))))
2469 ;; to be deleted in due time
2470 ;; We can't move overlays directly in insert-in-front-hooks
2471 ;; because when diff is highlighted with ascii flags, they will disturb
2472 ;; overlays and so they will be included in them, which we don't want.
2473 (defun ediff-move-disturbed-overlays (posn)
2474 (mapcar (function (lambda (overl)
2475 (ediff-move-overlay overl
2477 (ediff-overlay-end overl))
2479 ediff-disturbed-overlays)
2480 (setq ediff-disturbed-overlays nil))
2483 (defun ediff-save-buffer (arg)
2484 "Safe way of saving buffers A, B, C, and the diff output.
2485 `wa' saves buffer A, `wb' saves buffer B, `wc' saves buffer C,
2486 and `wd' saves the diff output."
2488 (ediff-eval-in-buffer
2489 (cond ((memq last-command-char '(?a ?b ?c))
2491 (ediff-char-to-buftype last-command-char)))
2492 ((eq last-command-char ?d)
2493 (message "Saving diff output ...")(sit-for 1)
2494 (if arg ediff-diff-buffer ediff-custom-diff-buffer)
2499 ;; will simplify it in due time, when emacs acquires before/after strings
2500 (defun ediff-remove-flags-from-buffer (buffer overlay)
2501 (ediff-eval-in-buffer buffer
2502 (let ((inhibit-read-only t))
2504 (ediff-overlay-put overlay 'begin-glyph nil)
2505 ;; before-string is not yet implemented in emacs.
2506 ;; when it will be, I will be able to delete much of the rest of
2508 (ediff-overlay-put overlay 'before-string nil))
2511 (ediff-overlay-put overlay 'end-glyph nil)
2512 ;; after-string is not yet implemented in emacs.
2513 (ediff-overlay-put overlay 'after-string nil))
2518 ;; will simplify it in due time, when emacs acquires before/after strings
2519 (defun ediff-place-flags-in-buffer (buf-type buffer ctl-buffer diff)
2520 (ediff-eval-in-buffer buffer
2521 (ediff-place-flags-in-buffer1 buf-type ctl-buffer diff)))
2524 (defun ediff-place-flags-in-buffer1 (buf-type ctl-buffer diff-no)
2525 (let* ((curr-overl (ediff-eval-in-buffer ctl-buffer
2526 (ediff-get-diff-overlay diff-no buf-type)))
2527 (before (ediff-get-diff-posn buf-type 'beg diff-no ctl-buffer))
2528 after beg-of-line flag)
2530 ;; insert flag before the difference
2532 (setq beg-of-line (bolp))
2534 (setq flag (ediff-eval-in-buffer ctl-buffer
2535 (if (eq ediff-highlighting-style 'ascii)
2537 ediff-before-flag-bol ediff-before-flag-mol))))
2539 ;; insert the flag itself
2541 (ediff-overlay-put curr-overl 'begin-glyph flag)
2542 (ediff-overlay-put curr-overl 'before-string flag))
2544 ;; insert the flag after the difference
2545 ;; `after' must be set here, after the before-flag was inserted
2546 (setq after (ediff-get-diff-posn buf-type 'end diff-no ctl-buffer))
2548 (setq beg-of-line (bolp))
2550 (setq flag (ediff-eval-in-buffer ctl-buffer
2551 (if (eq ediff-highlighting-style 'ascii)
2553 ediff-after-flag-eol ediff-after-flag-mol))))
2555 ;; insert the flag itself
2557 (ediff-overlay-put curr-overl 'end-glyph flag)
2558 (ediff-overlay-put curr-overl 'after-string flag))
2562 (defun ediff-get-diff-posn (buf-type pos &optional n control-buf)
2563 "Returns positions of difference sectors in the BUF-TYPE buffer.
2564 BUF-TYPE should be a symbol--either `A' or `B'.
2565 POS is either `beg' or `end'--it specifies whether you want the position at the
2566 beginning of a difference or at the end.
2568 The optional argument N says which difference \(default:
2569 `ediff-current-difference'\). The optional argument CONTROL-BUF says
2570 which control buffer is in effect in case it is not the current
2574 (setq control-buf (current-buffer)))
2576 (ediff-eval-in-buffer control-buf
2577 (or n (setq n ediff-current-difference))
2578 (if (or (< n 0) (>= n ediff-number-of-differences))
2579 (if (> ediff-number-of-differences 0)
2580 (error "There is no diff %d. Valid diffs are 1 to %d"
2581 (1+ n) ediff-number-of-differences)
2582 (error "No differences found")))
2583 (setq diff-overlay (ediff-get-diff-overlay n buf-type)))
2586 (ediff-overlay-start diff-overlay)
2587 (ediff-overlay-end diff-overlay))
2592 (defun ediff-highlight-diff-in-one-buffer (n buf-type)
2593 (if (ediff-buffer-live-p (ediff-get-buffer buf-type))
2594 (let* ((buff (ediff-get-buffer buf-type))
2595 (last (ediff-eval-in-buffer buff (point-max)))
2596 (begin (ediff-get-diff-posn buf-type 'beg n))
2597 (end (ediff-get-diff-posn buf-type 'end n))
2598 (xtra (if (equal begin end) 1 0))
2599 (end-hilit (min last (+ end xtra)))
2600 (current-diff-overlay
2602 (intern (format "ediff-current-diff-overlay-%S" buf-type))))
2605 (intern (format "ediff-odd-diff-face-%S" buf-type))))
2608 (intern (format "ediff-even-diff-face-%S" buf-type))))
2610 (intern (format "ediff-odd-diff-face-%S-var" buf-type)))
2612 (intern (format "ediff-even-diff-face-%S-var" buf-type)))
2616 (ediff-move-overlay current-diff-overlay begin end-hilit)
2617 (ediff-move-overlay current-diff-overlay begin end-hilit buff))
2618 ;; giving priority of 0 and then changing it may look funny, but
2619 ;; this overcomes an obscure Emacs bug.
2620 (ediff-overlay-put current-diff-overlay 'priority 0)
2621 (ediff-overlay-put current-diff-overlay 'priority
2622 (ediff-highest-priority begin end-hilit buff))
2624 (or (face-differs-from-default-p odd-diff-face-var)
2625 (not ediff-highlight-all-diffs)
2627 (copy-face odd-diff-face odd-diff-face-var)
2628 (copy-face even-diff-face even-diff-face-var)))
2630 ;; unhighlight the background overlay for diff n so they won't
2631 ;; interfere with the current diff overlay
2632 (ediff-overlay-put (ediff-get-diff-overlay n buf-type) 'face nil)
2636 (defun ediff-unhighlight-diff-in-one-buffer (buf-type)
2637 (if (ediff-buffer-live-p (ediff-get-buffer buf-type))
2638 (let ((current-diff-overlay
2640 (intern (format "ediff-current-diff-overlay-%S" buf-type))))
2642 (intern (format "ediff-odd-diff-face-%S-var" buf-type)))
2644 (intern (format "ediff-even-diff-face-%S-var" buf-type)))
2646 (ediff-get-diff-overlay ediff-current-difference buf-type))
2649 (ediff-move-overlay current-diff-overlay 1 1)
2651 ;; rehighlight the overlay in the background of the
2652 ;; current difference region
2653 (ediff-overlay-put overlay
2654 'face (if (ediff-odd-p ediff-current-difference)
2656 even-diff-face-var))
2659 (defun ediff-unhighlight-diffs-totally-in-one-buffer (buf-type)
2660 (ediff-unselect-and-select-difference -1)
2661 (if (and (ediff-window-display-p) ediff-use-faces)
2662 (let* ((inhibit-quit t)
2663 (current-diff-overlay-var
2664 (intern (format "ediff-current-diff-overlay-%S" buf-type)))
2665 (current-diff-overlay (symbol-value current-diff-overlay-var))
2667 (intern (format "ediff-odd-diff-face-%S-var" buf-type)))
2669 (intern (format "ediff-even-diff-face-%S-var" buf-type))))
2670 (if (face-differs-from-default-p odd-diff-face-var)
2672 (copy-face 'default odd-diff-face-var)
2673 (copy-face 'default even-diff-face-var)))
2674 (if (ediff-overlayp current-diff-overlay)
2675 (ediff-delete-overlay current-diff-overlay))
2676 (set current-diff-overlay-var nil)
2680 ;; null out difference overlays so they won't slow down future
2681 ;; editing operations
2682 ;; VEC is either a difference vector or a fine-diff vector
2683 (defun ediff-clear-diff-vector (vec-var &optional fine-diffs-also)
2684 (if (vectorp (symbol-value vec-var))
2687 (ediff-delete-overlay
2688 (ediff-get-diff-overlay-from-diff-record elt))
2690 (ediff-clear-fine-diff-vector elt))
2692 (symbol-value vec-var)))
2693 ;; allow them to be garbage collected
2700 ;; These two functions are here to neutralize XEmacs unwillingless to
2701 ;; handle overlays whose buffers were deleted.
2702 (defun ediff-move-overlay (overlay beg end &optional buffer)
2703 "Calls `move-overlay' in Emacs and `set-extent-endpoints' in Lemacs.
2704 Checks if overlay's buffer exists before actually doing the move."
2705 (let ((buf (and overlay (ediff-overlay-buffer overlay))))
2706 (if (ediff-buffer-live-p buf)
2708 (set-extent-endpoints overlay beg end)
2709 (move-overlay overlay beg end buffer))
2712 (ediff-delete-overlay overlay)))))
2714 (defun ediff-overlay-put (overlay prop value)
2715 "Calls `overlay-put' or `set-extent-property' depending on Emacs version.
2716 Checks if overlay's buffer exists."
2717 (if (ediff-buffer-live-p (ediff-overlay-buffer overlay))
2719 (set-extent-property overlay prop value)
2720 (overlay-put overlay prop value))
2721 (ediff-delete-overlay overlay)))
2724 ;; In Emacs, this just makes overlay. In the future, when Emacs will start
2725 ;; supporting sticky overlays, this function will make a sticky overlay.
2726 ;; BEG and END are expressions telling where overlay starts.
2727 ;; If they are numbers or buffers, then all is well. Otherwise, they must
2728 ;; be expressions to be evaluated in buffer BUF in order to get the overlay
2730 ;; If BUFF is not a live buffer, then return nil; otherwise, return the
2731 ;; newly created overlay.
2732 (defun ediff-make-bullet-proof-overlay (beg end buff)
2733 (if (ediff-buffer-live-p buff)
2735 (ediff-eval-in-buffer buff
2736 (or (number-or-marker-p beg)
2737 (setq beg (eval beg)))
2738 (or (number-or-marker-p end)
2739 (setq end (eval end)))
2740 (setq overl (ediff-make-overlay beg end buff))
2744 ;; take precautions against detached extents
2745 (ediff-overlay-put overl 'detachable nil)
2746 ;; chars inserted at both ends will be inside extent
2747 (ediff-overlay-put overl 'start-open nil)
2748 (ediff-overlay-put overl 'end-open nil))
2749 (ediff-overlay-put overl 'ediff-diff-num 0)
2750 ;;(ediff-overlay-put overl 'insert-in-front-hooks
2751 ;; (list 'ediff-capture-inserts-in-front))
2752 ;;(ediff-overlay-put overl 'insert-behind-hooks
2753 ;; (list 'ediff-capture-inserts-behind))
2754 ;; These two are not yet implemented in Emacs
2755 ;;(ediff-overlay-put overl 'rear-sticky t)
2756 ;;(ediff-overlay-put overl 'front-sticky t)
2760 (defsubst ediff-overlay-start (overl)
2761 (if (ediff-overlayp overl)
2763 (overlay-start overl)
2764 (extent-start-position overl))))
2766 (defsubst ediff-overlay-end (overl)
2767 (if (ediff-overlayp overl)
2770 (extent-end-position overl))))
2773 ;; Like other-buffer, but prefers visible buffers and ignores temporary or
2774 ;; other insignificant buffers (those beginning with "^[ *]").
2775 ;; Gets one arg--buffer name or a list of buffer names (it won't return
2777 (defun ediff-other-buffer (buff)
2778 (if (not (listp buff)) (setq buff (list buff)))
2779 (let* ((frame-buffers (buffer-list))
2780 (significant-buffers
2782 (function (lambda (x)
2783 (cond ((member (buffer-name x) buff)
2785 ((not (ediff-get-visible-buffer-window x))
2787 ((string-match "^ " (buffer-name x))
2791 (buffers (delq nil significant-buffers))
2792 less-significant-buffers)
2794 (cond (buffers (car buffers))
2795 ;; try also buffers that are not displayed in windows
2796 ((setq less-significant-buffers
2801 (cond ((member (buffer-name x) buff) nil)
2802 ((string-match "^[ *]" (buffer-name x)) nil)
2805 (car less-significant-buffers))
2806 (t (other-buffer (current-buffer))))
2810 ;; Construct a unique buffer name.
2811 ;; The first one tried is prefixsuffix, then prefix<2>suffix,
2812 ;; prefix<3>suffix, etc.
2813 (defun ediff-unique-buffer-name (prefix suffix)
2814 (if (null (get-buffer (concat prefix suffix)))
2815 (concat prefix suffix)
2817 (while (get-buffer (format "%s<%d>%s" prefix n suffix))
2819 (format "%s<%d>%s" prefix n suffix))))
2822 (defun ediff-submit-report ()
2823 "Submit bug report on Ediff."
2825 (let ((reporter-prompt-for-summary-p t)
2826 (ctl-buf ediff-control-buffer)
2827 (ediff-device-type (ediff-device-type))
2828 varlist salutation buffer-name)
2829 (setq varlist '(ediff-diff-program ediff-diff-options
2830 ediff-patch-program ediff-patch-options
2833 ediff-auto-refine ediff-highlighting-style
2834 ediff-buffer-A ediff-buffer-B ediff-control-buffer
2835 ediff-forward-word-function
2837 ediff-control-frame-parameters
2838 ediff-control-frame-position-function
2839 ediff-prefer-iconified-control-frame
2840 ediff-window-setup-function
2841 ediff-split-window-function
2848 Congratulations! You may have unearthed a bug in Ediff!
2850 Please make a concise and accurate summary of what happened
2851 and mail it to the address above.
2852 -----------------------------------------------------------
2855 (ediff-skip-unsuitable-frames)
2858 (switch-to-buffer ediff-msg-buffer)
2860 (delete-other-windows)
2862 Please read this first:
2863 ----------------------
2865 Some ``bugs'' may actually be no bugs at all. For instance, if you are
2866 reporting that certain difference regions are not matched as you think they
2867 should, this is most likely due to the way Unix diff program decides what
2868 constitutes a difference region. Ediff is an Emacs interface to diff, and
2869 it has nothing to do with those decisions---it only takes the output from
2870 diff and presents it in a way that is better suited for human browsing and
2873 If Emacs happens to dump core, this is NOT an Ediff problem---it is
2874 an Emacs bug. Report this to Emacs maintainers.
2876 Another popular topic for reports is compilation messages. Because Ediff
2877 interfaces to several other packages and runs under Emacs and XEmacs,
2878 byte-compilation may produce output like this:
2880 While compiling toplevel forms in file ediff.el:
2881 ** reference to free variable pm-color-alist
2882 ........................
2883 While compiling the end of the data:
2884 ** The following functions are not known to be defined:
2885 ediff-valid-color-p, ediff-set-face,
2886 ........................
2888 These are NOT errors, but inevitable warnings, which ought to be ignored.
2890 Please do not report those and similar things. However, comments and
2891 suggestions are always welcome.
2893 Mail anyway? (y or n) ")
2895 (if (y-or-n-p "Mail anyway? ")
2897 (if (ediff-buffer-live-p ctl-buf)
2898 (set-buffer ctl-buf))
2899 (setq buffer-name (buffer-name))
2901 (reporter-submit-bug-report "kifer@cs.sunysb.edu"
2905 'delete-other-windows
2908 (beep 1)(message "Bug report aborted")
2909 (if (ediff-buffer-live-p ctl-buf)
2910 (ediff-eval-in-buffer ctl-buf
2911 (ediff-recenter 'no-rehighlight))))
2915 (defun ediff-union (list1 list2)
2916 "Combine LIST1 and LIST2 using a set-union operation.
2917 The result list contains all items that appear in either LIST1 or LIST2.
2918 This is a non-destructive function; it makes a copy of the data if necessary
2919 to avoid corrupting the original LIST1 and LIST2.
2920 This is a slightly simplified version from `cl-seq.el'. Added here to
2921 avoid loading cl-*."
2922 (cond ((null list1) list2) ((null list2) list1)
2923 ((equal list1 list2) list1)
2925 (or (>= (length list1) (length list2))
2926 (setq list1 (prog1 list2 (setq list2 list1))))
2928 (or (memq (car list2) list1)
2929 (setq list1 (cons (car list2) list1)))
2930 (setq list2 (cdr list2)))
2933 (defun ediff-deactivate-mark ()
2935 (zmacs-deactivate-region)
2938 (cond ((fboundp 'nuke-selective-display)
2939 ;; XEmacs 19.12 has nuke-selective-display
2940 (fset 'ediff-nuke-selective-display 'nuke-selective-display))
2942 (defun ediff-nuke-selective-display ()
2946 (goto-char (point-min))
2947 (let ((mod-p (buffer-modified-p))
2948 buffer-read-only end)
2949 (and (eq t selective-display)
2950 (while (search-forward "\^M" nil t)
2954 (while (search-forward "\^M" end t)
2957 (set-buffer-modified-p mod-p)
2958 (setq selective-display nil)))))
2962 ;; The next two are modified versions from emerge.el.
2963 ;; VARS must be a list of symbols
2964 ;; ediff-save-variables returns an association list: ((var . val) ...)
2965 (defsubst ediff-save-variables (vars)
2966 (mapcar (function (lambda (v) (cons v (symbol-value v))))
2968 ;; VARS is a list of variable symbols.
2969 (defun ediff-restore-variables (vars assoc-list)
2971 (set (car vars) (cdr (assoc (car vars) assoc-list)))
2972 (setq vars (cdr vars))))
2973 (defun ediff-change-saved-variable (var value buf-type)
2975 (symbol-value (intern
2976 (concat "ediff-buffer-values-orig-"
2977 (symbol-name buf-type)))))
2978 (assoc-elt (assoc var assoc-list)))
2980 (setcdr assoc-elt value))))
2983 ;; must execute in control buf
2984 (defun ediff-save-protected-variables ()
2985 (setq ediff-buffer-values-orig-A
2986 (ediff-eval-in-buffer ediff-buffer-A
2987 (ediff-save-variables ediff-protected-variables)))
2988 (setq ediff-buffer-values-orig-B
2989 (ediff-eval-in-buffer ediff-buffer-B
2990 (ediff-save-variables ediff-protected-variables)))
2991 (if ediff-3way-comparison-job
2992 (setq ediff-buffer-values-orig-C
2993 (ediff-eval-in-buffer ediff-buffer-C
2994 (ediff-save-variables ediff-protected-variables)))))
2996 ;; must execute in control buf
2997 (defun ediff-restore-protected-variables ()
2998 (let ((values-A ediff-buffer-values-orig-A)
2999 (values-B ediff-buffer-values-orig-B)
3000 (values-C ediff-buffer-values-orig-C))
3001 (ediff-eval-in-buffer ediff-buffer-A
3002 (ediff-restore-variables ediff-protected-variables values-A))
3003 (ediff-eval-in-buffer ediff-buffer-B
3004 (ediff-restore-variables ediff-protected-variables values-B))
3005 (if ediff-3way-comparison-job
3006 (ediff-eval-in-buffer ediff-buffer-C
3007 (ediff-restore-variables ediff-protected-variables values-C)))))
3012 (ediff-defvar-local ediff-command-begin-time '(0 0 0) "")
3014 ;; calculate time used by command
3015 (defun ediff-calc-command-time ()
3016 (let ((end (current-time))
3019 (if (>= (nth 2 end) (nth 2 ediff-command-begin-time))
3020 (- (nth 2 end) (nth 2 ediff-command-begin-time))
3021 (+ (nth 2 end) (- 1000000 (nth 2 ediff-command-begin-time)))))
3022 (setq sec (- (nth 1 end) (nth 1 ediff-command-begin-time)))
3023 (or (equal ediff-command-begin-time '(0 0 0))
3024 (message "Elapsed time: %d second(s) + %d microsecond(s)" sec micro))))
3026 (defsubst ediff-save-time ()
3027 (setq ediff-command-begin-time (current-time)))
3029 (defun ediff-profile ()
3030 "Toggle profiling Ediff commands."
3032 (or (ediff-buffer-live-p ediff-control-buffer)
3033 (error "This command runs only out of Ediff Control Buffer"))
3034 (make-local-variable 'pre-command-hook)
3035 (make-local-variable 'post-command-hook)
3036 (if (memq 'ediff-save-time pre-command-hook)
3037 (progn (remove-hook 'pre-command-hook 'ediff-save-time)
3038 (remove-hook 'post-command-hook 'ediff-calc-command-time)
3039 (setq ediff-command-begin-time '(0 0 0))
3040 (message "Ediff profiling disabled"))
3041 (add-hook 'pre-command-hook 'ediff-save-time t)
3042 (add-hook 'post-command-hook 'ediff-calc-command-time)
3043 (message "Ediff profiling enabled")))
3045 (defun ediff-print-diff-vector (diff-vector-var)
3046 (princ (format "\n*** %S ***\n" diff-vector-var))
3051 "Diff %d: \tOverlay: %S
3053 \t\tNo-fine-diff-flag: %S
3054 \t\tState-of-diff:\t %S
3055 \t\tState-of-merge:\t %S
3057 (1+ (ediff-overlay-get (aref overl-vec 0) 'ediff-diff-num))
3060 (if (= (length (aref overl-vec 1)) 0)
3062 (mapconcat 'prin1-to-string
3063 (aref overl-vec 1) "\n\t\t\t "))
3064 (aref overl-vec 2) ; no fine diff flag
3065 (aref overl-vec 3) ; state-of-diff
3066 (aref overl-vec 4) ; state-of-merge
3068 (eval diff-vector-var)))
3072 (defun ediff-debug-info ()
3074 (or (ediff-buffer-live-p ediff-control-buffer)
3075 (error "This command runs only out of Ediff Control Buffer"))
3076 (with-output-to-temp-buffer ediff-debug-buffer
3077 (princ (format "\nCtl buffer: %S\n" ediff-control-buffer))
3078 (ediff-print-diff-vector (intern (concat "ediff-difference-vector-" "A")))
3079 (ediff-print-diff-vector (intern (concat "ediff-difference-vector-" "B")))
3080 (ediff-print-diff-vector (intern (concat "ediff-difference-vector-" "C")))
3083 ;; don't report error if version control package wasn't found
3084 ;;(ediff-load-version-control 'silent)
3086 (run-hooks 'ediff-load-hooks)
3089 ;;; Local Variables:
3090 ;;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
3091 ;;; eval: (put 'ediff-eval-in-buffer 'lisp-indent-hook 1)
3094 (provide 'ediff-util)
3096 ;;; ediff-util.el ends here